1 // SPDX-License-Identifier: GPL-2.0
3 * A V4L2 driver for Sony IMX219 cameras.
4 * Copyright (C) 2019, Raspberry Pi (Trading) Ltd
6 * Based on Sony imx258 camera driver
7 * Copyright (C) 2018 Intel Corporation
9 * DT / fwnode changes, and regulator / GPIO control taken from imx214 driver
10 * Copyright 2018 Qtechnology A/S
12 * Flip handling taken from the Sony IMX319 driver.
13 * Copyright (C) 2018 Intel Corporation
17 #include <linux/clk.h>
18 #include <linux/delay.h>
19 #include <linux/gpio/consumer.h>
20 #include <linux/i2c.h>
21 #include <linux/module.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/regulator/consumer.h>
24 #include <media/v4l2-ctrls.h>
25 #include <media/v4l2-device.h>
26 #include <media/v4l2-event.h>
27 #include <media/v4l2-fwnode.h>
28 #include <media/v4l2-mediabus.h>
29 #include <asm/unaligned.h>
31 #define IMX219_REG_VALUE_08BIT 1
32 #define IMX219_REG_VALUE_16BIT 2
34 #define IMX219_REG_MODE_SELECT 0x0100
35 #define IMX219_MODE_STANDBY 0x00
36 #define IMX219_MODE_STREAMING 0x01
39 #define IMX219_REG_CHIP_ID 0x0000
40 #define IMX219_CHIP_ID 0x0219
42 /* External clock frequency is 24.0M */
43 #define IMX219_XCLK_FREQ 24000000
45 /* Pixel rate is fixed at 182.4M for all the modes */
46 #define IMX219_PIXEL_RATE 182400000
48 #define IMX219_DEFAULT_LINK_FREQ 456000000
50 /* V_TIMING internal */
51 #define IMX219_REG_VTS 0x0160
52 #define IMX219_VTS_15FPS 0x0dc6
53 #define IMX219_VTS_30FPS_1080P 0x06e3
54 #define IMX219_VTS_30FPS_BINNED 0x06e3
55 #define IMX219_VTS_30FPS_640x480 0x06e3
56 #define IMX219_VTS_MAX 0xffff
58 #define IMX219_VBLANK_MIN 4
61 #define IMX219_FLL_MIN 0x08a6
62 #define IMX219_FLL_MAX 0xffff
63 #define IMX219_FLL_STEP 1
64 #define IMX219_FLL_DEFAULT 0x0c98
66 /* HBLANK control - read only */
67 #define IMX219_PPL_DEFAULT 3448
69 /* Exposure control */
70 #define IMX219_REG_EXPOSURE 0x015a
71 #define IMX219_EXPOSURE_MIN 4
72 #define IMX219_EXPOSURE_STEP 1
73 #define IMX219_EXPOSURE_DEFAULT 0x640
74 #define IMX219_EXPOSURE_MAX 65535
76 /* Analog gain control */
77 #define IMX219_REG_ANALOG_GAIN 0x0157
78 #define IMX219_ANA_GAIN_MIN 0
79 #define IMX219_ANA_GAIN_MAX 232
80 #define IMX219_ANA_GAIN_STEP 1
81 #define IMX219_ANA_GAIN_DEFAULT 0x0
83 /* Digital gain control */
84 #define IMX219_REG_DIGITAL_GAIN 0x0158
85 #define IMX219_DGTL_GAIN_MIN 0x0100
86 #define IMX219_DGTL_GAIN_MAX 0x0fff
87 #define IMX219_DGTL_GAIN_DEFAULT 0x0100
88 #define IMX219_DGTL_GAIN_STEP 1
90 #define IMX219_REG_ORIENTATION 0x0172
93 #define IMX219_REG_BINNING_MODE 0x0174
94 #define IMX219_BINNING_NONE 0x0000
95 #define IMX219_BINNING_2X2 0x0101
96 #define IMX219_BINNING_2X2_ANALOG 0x0303
98 /* Test Pattern Control */
99 #define IMX219_REG_TEST_PATTERN 0x0600
100 #define IMX219_TEST_PATTERN_DISABLE 0
101 #define IMX219_TEST_PATTERN_SOLID_COLOR 1
102 #define IMX219_TEST_PATTERN_COLOR_BARS 2
103 #define IMX219_TEST_PATTERN_GREY_COLOR 3
104 #define IMX219_TEST_PATTERN_PN9 4
106 /* Test pattern colour components */
107 #define IMX219_REG_TESTP_RED 0x0602
108 #define IMX219_REG_TESTP_GREENR 0x0604
109 #define IMX219_REG_TESTP_BLUE 0x0606
110 #define IMX219_REG_TESTP_GREENB 0x0608
111 #define IMX219_TESTP_COLOUR_MIN 0
112 #define IMX219_TESTP_COLOUR_MAX 0x03ff
113 #define IMX219_TESTP_COLOUR_STEP 1
114 #define IMX219_TESTP_RED_DEFAULT IMX219_TESTP_COLOUR_MAX
115 #define IMX219_TESTP_GREENR_DEFAULT 0
116 #define IMX219_TESTP_BLUE_DEFAULT 0
117 #define IMX219_TESTP_GREENB_DEFAULT 0
119 /* IMX219 native and active pixel array size. */
120 #define IMX219_NATIVE_WIDTH 3296U
121 #define IMX219_NATIVE_HEIGHT 2480U
122 #define IMX219_PIXEL_ARRAY_LEFT 8U
123 #define IMX219_PIXEL_ARRAY_TOP 8U
124 #define IMX219_PIXEL_ARRAY_WIDTH 3280U
125 #define IMX219_PIXEL_ARRAY_HEIGHT 2464U
132 struct imx219_reg_list {
133 unsigned int num_of_regs;
134 const struct imx219_reg *regs;
137 /* Mode : resolution and related config&values */
144 /* Analog crop rectangle. */
145 struct v4l2_rect crop;
148 unsigned int vts_def;
150 /* Default register values */
151 struct imx219_reg_list reg_list;
153 /* 2x2 binning is used */
157 static const struct imx219_reg imx219_common_regs[] = {
158 {0x0100, 0x00}, /* Mode Select */
160 /* To Access Addresses 3000-5fff, send the following commands */
168 /* PLL Clock Table */
169 {0x0301, 0x05}, /* VTPXCK_DIV */
170 {0x0303, 0x01}, /* VTSYSCK_DIV */
171 {0x0304, 0x03}, /* PREPLLCK_VT_DIV 0x03 = AUTO set */
172 {0x0305, 0x03}, /* PREPLLCK_OP_DIV 0x03 = AUTO set */
173 {0x0306, 0x00}, /* PLL_VT_MPY */
175 {0x030b, 0x01}, /* OP_SYS_CLK_DIV */
176 {0x030c, 0x00}, /* PLL_OP_MPY */
179 /* Undocumented registers */
193 /* Frame Bank Register Group "A" */
194 {0x0162, 0x0d}, /* Line_Length_A */
196 {0x0170, 0x01}, /* X_ODD_INC_A */
197 {0x0171, 0x01}, /* Y_ODD_INC_A */
199 /* Output setup registers */
200 {0x0114, 0x01}, /* CSI 2-Lane Mode */
201 {0x0128, 0x00}, /* DPHY Auto Mode */
202 {0x012a, 0x18}, /* EXCK_Freq */
207 * Register sets lifted off the i2C interface from the Raspberry Pi firmware
209 * 3280x2464 = mode 2, 1920x1080 = mode 1, 1640x1232 = mode 4, 640x480 = mode 7.
211 static const struct imx219_reg mode_3280x2464_regs[] = {
230 static const struct imx219_reg mode_1920_1080_regs[] = {
249 static const struct imx219_reg mode_1640_1232_regs[] = {
268 static const struct imx219_reg mode_640_480_regs[] = {
287 static const struct imx219_reg raw8_framefmt_regs[] = {
293 static const struct imx219_reg raw10_framefmt_regs[] = {
299 static const s64 imx219_link_freq_menu[] = {
300 IMX219_DEFAULT_LINK_FREQ,
303 static const char * const imx219_test_pattern_menu[] = {
311 static const int imx219_test_pattern_val[] = {
312 IMX219_TEST_PATTERN_DISABLE,
313 IMX219_TEST_PATTERN_COLOR_BARS,
314 IMX219_TEST_PATTERN_SOLID_COLOR,
315 IMX219_TEST_PATTERN_GREY_COLOR,
316 IMX219_TEST_PATTERN_PN9,
319 /* regulator supplies */
320 static const char * const imx219_supply_name[] = {
321 /* Supplies can be enabled in any order */
322 "VANA", /* Analog (2.8V) supply */
323 "VDIG", /* Digital Core (1.8V) supply */
324 "VDDL", /* IF (1.2V) supply */
327 #define IMX219_NUM_SUPPLIES ARRAY_SIZE(imx219_supply_name)
330 * The supported formats.
331 * This table MUST contain 4 entries per format, to cover the various flip
332 * combinations in the order
338 static const u32 codes[] = {
339 MEDIA_BUS_FMT_SRGGB10_1X10,
340 MEDIA_BUS_FMT_SGRBG10_1X10,
341 MEDIA_BUS_FMT_SGBRG10_1X10,
342 MEDIA_BUS_FMT_SBGGR10_1X10,
344 MEDIA_BUS_FMT_SRGGB8_1X8,
345 MEDIA_BUS_FMT_SGRBG8_1X8,
346 MEDIA_BUS_FMT_SGBRG8_1X8,
347 MEDIA_BUS_FMT_SBGGR8_1X8,
351 * Initialisation delay between XCLR low->high and the moment when the sensor
352 * can start capture (i.e. can leave software stanby) must be not less than:
353 * t4 + max(t5, t6 + <time to initialize the sensor register over I2C>)
355 * t4 is fixed, and is max 200uS,
356 * t5 is fixed, and is 6000uS,
357 * t6 depends on the sensor external clock, and is max 32000 clock periods.
358 * As per sensor datasheet, the external clock must be from 6MHz to 27MHz.
359 * So for any acceptable external clock t6 is always within the range of
360 * 1185 to 5333 uS, and is always less than t5.
361 * For this reason this is always safe to wait (t4 + t5) = 6200 uS, then
362 * initialize the sensor over I2C, and then exit the software standby.
364 * This start-up time can be optimized a bit more, if we start the writes
365 * over I2C after (t4+t6), but before (t4+t5) expires. But then sensor
366 * initialization over I2C may complete before (t4+t5) expires, and we must
367 * ensure that capture is not started before (t4+t5).
369 * This delay doesn't account for the power supply startup time. If needed,
370 * this should be taken care of via the regulator framework. E.g. in the
371 * case of DT for regulator-fixed one should define the startup-delay-us
374 #define IMX219_XCLR_MIN_DELAY_US 6200
375 #define IMX219_XCLR_DELAY_RANGE_US 1000
378 static const struct imx219_mode supported_modes[] = {
380 /* 8MPix 15fps mode */
384 .left = IMX219_PIXEL_ARRAY_LEFT,
385 .top = IMX219_PIXEL_ARRAY_TOP,
389 .vts_def = IMX219_VTS_15FPS,
391 .num_of_regs = ARRAY_SIZE(mode_3280x2464_regs),
392 .regs = mode_3280x2464_regs,
397 /* 1080P 30fps cropped */
406 .vts_def = IMX219_VTS_30FPS_1080P,
408 .num_of_regs = ARRAY_SIZE(mode_1920_1080_regs),
409 .regs = mode_1920_1080_regs,
414 /* 2x2 binned 30fps mode */
418 .left = IMX219_PIXEL_ARRAY_LEFT,
419 .top = IMX219_PIXEL_ARRAY_TOP,
423 .vts_def = IMX219_VTS_30FPS_BINNED,
425 .num_of_regs = ARRAY_SIZE(mode_1640_1232_regs),
426 .regs = mode_1640_1232_regs,
431 /* 640x480 30fps mode */
440 .vts_def = IMX219_VTS_30FPS_640x480,
442 .num_of_regs = ARRAY_SIZE(mode_640_480_regs),
443 .regs = mode_640_480_regs,
450 struct v4l2_subdev sd;
451 struct media_pad pad;
453 struct v4l2_mbus_framefmt fmt;
455 struct clk *xclk; /* system clock to IMX219 */
458 struct gpio_desc *reset_gpio;
459 struct regulator_bulk_data supplies[IMX219_NUM_SUPPLIES];
461 struct v4l2_ctrl_handler ctrl_handler;
463 struct v4l2_ctrl *pixel_rate;
464 struct v4l2_ctrl *link_freq;
465 struct v4l2_ctrl *exposure;
466 struct v4l2_ctrl *vflip;
467 struct v4l2_ctrl *hflip;
468 struct v4l2_ctrl *vblank;
469 struct v4l2_ctrl *hblank;
472 const struct imx219_mode *mode;
475 * Mutex for serialized access:
476 * Protect sensor module set pad format and start/stop streaming safely.
480 /* Streaming on/off */
484 static inline struct imx219 *to_imx219(struct v4l2_subdev *_sd)
486 return container_of(_sd, struct imx219, sd);
489 /* Read registers up to 2 at a time */
490 static int imx219_read_reg(struct imx219 *imx219, u16 reg, u32 len, u32 *val)
492 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
493 struct i2c_msg msgs[2];
494 u8 addr_buf[2] = { reg >> 8, reg & 0xff };
495 u8 data_buf[4] = { 0, };
501 /* Write register address */
502 msgs[0].addr = client->addr;
504 msgs[0].len = ARRAY_SIZE(addr_buf);
505 msgs[0].buf = addr_buf;
507 /* Read data from register */
508 msgs[1].addr = client->addr;
509 msgs[1].flags = I2C_M_RD;
511 msgs[1].buf = &data_buf[4 - len];
513 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
514 if (ret != ARRAY_SIZE(msgs))
517 *val = get_unaligned_be32(data_buf);
522 /* Write registers up to 2 at a time */
523 static int imx219_write_reg(struct imx219 *imx219, u16 reg, u32 len, u32 val)
525 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
531 put_unaligned_be16(reg, buf);
532 put_unaligned_be32(val << (8 * (4 - len)), buf + 2);
533 if (i2c_master_send(client, buf, len + 2) != len + 2)
539 /* Write a list of registers */
540 static int imx219_write_regs(struct imx219 *imx219,
541 const struct imx219_reg *regs, u32 len)
543 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
547 for (i = 0; i < len; i++) {
548 ret = imx219_write_reg(imx219, regs[i].address, 1, regs[i].val);
550 dev_err_ratelimited(&client->dev,
551 "Failed to write reg 0x%4.4x. error = %d\n",
552 regs[i].address, ret);
561 /* Get bayer order based on flip setting. */
562 static u32 imx219_get_format_code(struct imx219 *imx219, u32 code)
566 lockdep_assert_held(&imx219->mutex);
568 for (i = 0; i < ARRAY_SIZE(codes); i++)
569 if (codes[i] == code)
572 if (i >= ARRAY_SIZE(codes))
575 i = (i & ~3) | (imx219->vflip->val ? 2 : 0) |
576 (imx219->hflip->val ? 1 : 0);
581 static void imx219_set_default_format(struct imx219 *imx219)
583 struct v4l2_mbus_framefmt *fmt;
586 fmt->code = MEDIA_BUS_FMT_SRGGB10_1X10;
587 fmt->colorspace = V4L2_COLORSPACE_SRGB;
588 fmt->ycbcr_enc = V4L2_MAP_YCBCR_ENC_DEFAULT(fmt->colorspace);
589 fmt->quantization = V4L2_MAP_QUANTIZATION_DEFAULT(true,
592 fmt->xfer_func = V4L2_MAP_XFER_FUNC_DEFAULT(fmt->colorspace);
593 fmt->width = supported_modes[0].width;
594 fmt->height = supported_modes[0].height;
595 fmt->field = V4L2_FIELD_NONE;
598 static int imx219_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
600 struct imx219 *imx219 = to_imx219(sd);
601 struct v4l2_mbus_framefmt *try_fmt =
602 v4l2_subdev_get_try_format(sd, fh->state, 0);
603 struct v4l2_rect *try_crop;
605 mutex_lock(&imx219->mutex);
607 /* Initialize try_fmt */
608 try_fmt->width = supported_modes[0].width;
609 try_fmt->height = supported_modes[0].height;
610 try_fmt->code = imx219_get_format_code(imx219,
611 MEDIA_BUS_FMT_SRGGB10_1X10);
612 try_fmt->field = V4L2_FIELD_NONE;
614 /* Initialize try_crop rectangle. */
615 try_crop = v4l2_subdev_get_try_crop(sd, fh->state, 0);
616 try_crop->top = IMX219_PIXEL_ARRAY_TOP;
617 try_crop->left = IMX219_PIXEL_ARRAY_LEFT;
618 try_crop->width = IMX219_PIXEL_ARRAY_WIDTH;
619 try_crop->height = IMX219_PIXEL_ARRAY_HEIGHT;
621 mutex_unlock(&imx219->mutex);
626 static int imx219_set_ctrl(struct v4l2_ctrl *ctrl)
628 struct imx219 *imx219 =
629 container_of(ctrl->handler, struct imx219, ctrl_handler);
630 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
633 if (ctrl->id == V4L2_CID_VBLANK) {
634 int exposure_max, exposure_def;
636 /* Update max exposure while meeting expected vblanking */
637 exposure_max = imx219->mode->height + ctrl->val - 4;
638 exposure_def = (exposure_max < IMX219_EXPOSURE_DEFAULT) ?
639 exposure_max : IMX219_EXPOSURE_DEFAULT;
640 __v4l2_ctrl_modify_range(imx219->exposure,
641 imx219->exposure->minimum,
642 exposure_max, imx219->exposure->step,
647 * Applying V4L2 control value only happens
648 * when power is up for streaming
650 if (pm_runtime_get_if_in_use(&client->dev) == 0)
654 case V4L2_CID_ANALOGUE_GAIN:
655 ret = imx219_write_reg(imx219, IMX219_REG_ANALOG_GAIN,
656 IMX219_REG_VALUE_08BIT, ctrl->val);
658 case V4L2_CID_EXPOSURE:
659 ret = imx219_write_reg(imx219, IMX219_REG_EXPOSURE,
660 IMX219_REG_VALUE_16BIT, ctrl->val);
662 case V4L2_CID_DIGITAL_GAIN:
663 ret = imx219_write_reg(imx219, IMX219_REG_DIGITAL_GAIN,
664 IMX219_REG_VALUE_16BIT, ctrl->val);
666 case V4L2_CID_TEST_PATTERN:
667 ret = imx219_write_reg(imx219, IMX219_REG_TEST_PATTERN,
668 IMX219_REG_VALUE_16BIT,
669 imx219_test_pattern_val[ctrl->val]);
673 ret = imx219_write_reg(imx219, IMX219_REG_ORIENTATION, 1,
675 imx219->vflip->val << 1);
677 case V4L2_CID_VBLANK:
678 ret = imx219_write_reg(imx219, IMX219_REG_VTS,
679 IMX219_REG_VALUE_16BIT,
680 imx219->mode->height + ctrl->val);
682 case V4L2_CID_TEST_PATTERN_RED:
683 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_RED,
684 IMX219_REG_VALUE_16BIT, ctrl->val);
686 case V4L2_CID_TEST_PATTERN_GREENR:
687 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_GREENR,
688 IMX219_REG_VALUE_16BIT, ctrl->val);
690 case V4L2_CID_TEST_PATTERN_BLUE:
691 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_BLUE,
692 IMX219_REG_VALUE_16BIT, ctrl->val);
694 case V4L2_CID_TEST_PATTERN_GREENB:
695 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_GREENB,
696 IMX219_REG_VALUE_16BIT, ctrl->val);
699 dev_info(&client->dev,
700 "ctrl(id:0x%x,val:0x%x) is not handled\n",
701 ctrl->id, ctrl->val);
706 pm_runtime_put(&client->dev);
711 static const struct v4l2_ctrl_ops imx219_ctrl_ops = {
712 .s_ctrl = imx219_set_ctrl,
715 static int imx219_enum_mbus_code(struct v4l2_subdev *sd,
716 struct v4l2_subdev_state *sd_state,
717 struct v4l2_subdev_mbus_code_enum *code)
719 struct imx219 *imx219 = to_imx219(sd);
721 if (code->index >= (ARRAY_SIZE(codes) / 4))
724 mutex_lock(&imx219->mutex);
725 code->code = imx219_get_format_code(imx219, codes[code->index * 4]);
726 mutex_unlock(&imx219->mutex);
731 static int imx219_enum_frame_size(struct v4l2_subdev *sd,
732 struct v4l2_subdev_state *sd_state,
733 struct v4l2_subdev_frame_size_enum *fse)
735 struct imx219 *imx219 = to_imx219(sd);
738 if (fse->index >= ARRAY_SIZE(supported_modes))
741 mutex_lock(&imx219->mutex);
742 code = imx219_get_format_code(imx219, fse->code);
743 mutex_unlock(&imx219->mutex);
744 if (fse->code != code)
747 fse->min_width = supported_modes[fse->index].width;
748 fse->max_width = fse->min_width;
749 fse->min_height = supported_modes[fse->index].height;
750 fse->max_height = fse->min_height;
755 static void imx219_reset_colorspace(struct v4l2_mbus_framefmt *fmt)
757 fmt->colorspace = V4L2_COLORSPACE_SRGB;
758 fmt->ycbcr_enc = V4L2_MAP_YCBCR_ENC_DEFAULT(fmt->colorspace);
759 fmt->quantization = V4L2_MAP_QUANTIZATION_DEFAULT(true,
762 fmt->xfer_func = V4L2_MAP_XFER_FUNC_DEFAULT(fmt->colorspace);
765 static void imx219_update_pad_format(struct imx219 *imx219,
766 const struct imx219_mode *mode,
767 struct v4l2_subdev_format *fmt)
769 fmt->format.width = mode->width;
770 fmt->format.height = mode->height;
771 fmt->format.field = V4L2_FIELD_NONE;
772 imx219_reset_colorspace(&fmt->format);
775 static int __imx219_get_pad_format(struct imx219 *imx219,
776 struct v4l2_subdev_state *sd_state,
777 struct v4l2_subdev_format *fmt)
779 if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
780 struct v4l2_mbus_framefmt *try_fmt =
781 v4l2_subdev_get_try_format(&imx219->sd, sd_state,
783 /* update the code which could change due to vflip or hflip: */
784 try_fmt->code = imx219_get_format_code(imx219, try_fmt->code);
785 fmt->format = *try_fmt;
787 imx219_update_pad_format(imx219, imx219->mode, fmt);
788 fmt->format.code = imx219_get_format_code(imx219,
795 static int imx219_get_pad_format(struct v4l2_subdev *sd,
796 struct v4l2_subdev_state *sd_state,
797 struct v4l2_subdev_format *fmt)
799 struct imx219 *imx219 = to_imx219(sd);
802 mutex_lock(&imx219->mutex);
803 ret = __imx219_get_pad_format(imx219, sd_state, fmt);
804 mutex_unlock(&imx219->mutex);
809 static int imx219_set_pad_format(struct v4l2_subdev *sd,
810 struct v4l2_subdev_state *sd_state,
811 struct v4l2_subdev_format *fmt)
813 struct imx219 *imx219 = to_imx219(sd);
814 const struct imx219_mode *mode;
815 struct v4l2_mbus_framefmt *framefmt;
816 int exposure_max, exposure_def, hblank;
819 mutex_lock(&imx219->mutex);
821 for (i = 0; i < ARRAY_SIZE(codes); i++)
822 if (codes[i] == fmt->format.code)
824 if (i >= ARRAY_SIZE(codes))
827 /* Bayer order varies with flips */
828 fmt->format.code = imx219_get_format_code(imx219, codes[i]);
830 mode = v4l2_find_nearest_size(supported_modes,
831 ARRAY_SIZE(supported_modes),
833 fmt->format.width, fmt->format.height);
834 imx219_update_pad_format(imx219, mode, fmt);
835 if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
836 framefmt = v4l2_subdev_get_try_format(sd, sd_state, fmt->pad);
837 *framefmt = fmt->format;
838 } else if (imx219->mode != mode ||
839 imx219->fmt.code != fmt->format.code) {
840 imx219->fmt = fmt->format;
842 /* Update limits and set FPS to default */
843 __v4l2_ctrl_modify_range(imx219->vblank, IMX219_VBLANK_MIN,
844 IMX219_VTS_MAX - mode->height, 1,
845 mode->vts_def - mode->height);
846 __v4l2_ctrl_s_ctrl(imx219->vblank,
847 mode->vts_def - mode->height);
848 /* Update max exposure while meeting expected vblanking */
849 exposure_max = mode->vts_def - 4;
850 exposure_def = (exposure_max < IMX219_EXPOSURE_DEFAULT) ?
851 exposure_max : IMX219_EXPOSURE_DEFAULT;
852 __v4l2_ctrl_modify_range(imx219->exposure,
853 imx219->exposure->minimum,
854 exposure_max, imx219->exposure->step,
857 * Currently PPL is fixed to IMX219_PPL_DEFAULT, so hblank
858 * depends on mode->width only, and is not changeble in any
859 * way other than changing the mode.
861 hblank = IMX219_PPL_DEFAULT - mode->width;
862 __v4l2_ctrl_modify_range(imx219->hblank, hblank, hblank, 1,
866 mutex_unlock(&imx219->mutex);
871 static int imx219_set_framefmt(struct imx219 *imx219)
873 switch (imx219->fmt.code) {
874 case MEDIA_BUS_FMT_SRGGB8_1X8:
875 case MEDIA_BUS_FMT_SGRBG8_1X8:
876 case MEDIA_BUS_FMT_SGBRG8_1X8:
877 case MEDIA_BUS_FMT_SBGGR8_1X8:
878 return imx219_write_regs(imx219, raw8_framefmt_regs,
879 ARRAY_SIZE(raw8_framefmt_regs));
881 case MEDIA_BUS_FMT_SRGGB10_1X10:
882 case MEDIA_BUS_FMT_SGRBG10_1X10:
883 case MEDIA_BUS_FMT_SGBRG10_1X10:
884 case MEDIA_BUS_FMT_SBGGR10_1X10:
885 return imx219_write_regs(imx219, raw10_framefmt_regs,
886 ARRAY_SIZE(raw10_framefmt_regs));
892 static int imx219_set_binning(struct imx219 *imx219)
894 if (!imx219->mode->binning) {
895 return imx219_write_reg(imx219, IMX219_REG_BINNING_MODE,
896 IMX219_REG_VALUE_16BIT,
897 IMX219_BINNING_NONE);
900 switch (imx219->fmt.code) {
901 case MEDIA_BUS_FMT_SRGGB8_1X8:
902 case MEDIA_BUS_FMT_SGRBG8_1X8:
903 case MEDIA_BUS_FMT_SGBRG8_1X8:
904 case MEDIA_BUS_FMT_SBGGR8_1X8:
905 return imx219_write_reg(imx219, IMX219_REG_BINNING_MODE,
906 IMX219_REG_VALUE_16BIT,
907 IMX219_BINNING_2X2_ANALOG);
909 case MEDIA_BUS_FMT_SRGGB10_1X10:
910 case MEDIA_BUS_FMT_SGRBG10_1X10:
911 case MEDIA_BUS_FMT_SGBRG10_1X10:
912 case MEDIA_BUS_FMT_SBGGR10_1X10:
913 return imx219_write_reg(imx219, IMX219_REG_BINNING_MODE,
914 IMX219_REG_VALUE_16BIT,
921 static const struct v4l2_rect *
922 __imx219_get_pad_crop(struct imx219 *imx219,
923 struct v4l2_subdev_state *sd_state,
924 unsigned int pad, enum v4l2_subdev_format_whence which)
927 case V4L2_SUBDEV_FORMAT_TRY:
928 return v4l2_subdev_get_try_crop(&imx219->sd, sd_state, pad);
929 case V4L2_SUBDEV_FORMAT_ACTIVE:
930 return &imx219->mode->crop;
936 static int imx219_get_selection(struct v4l2_subdev *sd,
937 struct v4l2_subdev_state *sd_state,
938 struct v4l2_subdev_selection *sel)
940 switch (sel->target) {
941 case V4L2_SEL_TGT_CROP: {
942 struct imx219 *imx219 = to_imx219(sd);
944 mutex_lock(&imx219->mutex);
945 sel->r = *__imx219_get_pad_crop(imx219, sd_state, sel->pad,
947 mutex_unlock(&imx219->mutex);
952 case V4L2_SEL_TGT_NATIVE_SIZE:
955 sel->r.width = IMX219_NATIVE_WIDTH;
956 sel->r.height = IMX219_NATIVE_HEIGHT;
960 case V4L2_SEL_TGT_CROP_DEFAULT:
961 case V4L2_SEL_TGT_CROP_BOUNDS:
962 sel->r.top = IMX219_PIXEL_ARRAY_TOP;
963 sel->r.left = IMX219_PIXEL_ARRAY_LEFT;
964 sel->r.width = IMX219_PIXEL_ARRAY_WIDTH;
965 sel->r.height = IMX219_PIXEL_ARRAY_HEIGHT;
973 static int imx219_start_streaming(struct imx219 *imx219)
975 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
976 const struct imx219_reg_list *reg_list;
979 ret = pm_runtime_resume_and_get(&client->dev);
983 /* Send all registers that are common to all modes */
984 ret = imx219_write_regs(imx219, imx219_common_regs, ARRAY_SIZE(imx219_common_regs));
986 dev_err(&client->dev, "%s failed to send mfg header\n", __func__);
990 /* Apply default values of current mode */
991 reg_list = &imx219->mode->reg_list;
992 ret = imx219_write_regs(imx219, reg_list->regs, reg_list->num_of_regs);
994 dev_err(&client->dev, "%s failed to set mode\n", __func__);
998 ret = imx219_set_framefmt(imx219);
1000 dev_err(&client->dev, "%s failed to set frame format: %d\n",
1005 ret = imx219_set_binning(imx219);
1007 dev_err(&client->dev, "%s failed to set binning: %d\n",
1012 /* Apply customized values from user */
1013 ret = __v4l2_ctrl_handler_setup(imx219->sd.ctrl_handler);
1017 /* set stream on register */
1018 ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1019 IMX219_REG_VALUE_08BIT, IMX219_MODE_STREAMING);
1023 /* vflip and hflip cannot change during streaming */
1024 __v4l2_ctrl_grab(imx219->vflip, true);
1025 __v4l2_ctrl_grab(imx219->hflip, true);
1030 pm_runtime_put(&client->dev);
1034 static void imx219_stop_streaming(struct imx219 *imx219)
1036 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1039 /* set stream off register */
1040 ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1041 IMX219_REG_VALUE_08BIT, IMX219_MODE_STANDBY);
1043 dev_err(&client->dev, "%s failed to set stream\n", __func__);
1045 __v4l2_ctrl_grab(imx219->vflip, false);
1046 __v4l2_ctrl_grab(imx219->hflip, false);
1048 pm_runtime_put(&client->dev);
1051 static int imx219_set_stream(struct v4l2_subdev *sd, int enable)
1053 struct imx219 *imx219 = to_imx219(sd);
1056 mutex_lock(&imx219->mutex);
1057 if (imx219->streaming == enable) {
1058 mutex_unlock(&imx219->mutex);
1064 * Apply default & customized values
1065 * and then start streaming.
1067 ret = imx219_start_streaming(imx219);
1071 imx219_stop_streaming(imx219);
1074 imx219->streaming = enable;
1076 mutex_unlock(&imx219->mutex);
1081 mutex_unlock(&imx219->mutex);
1086 /* Power/clock management functions */
1087 static int imx219_power_on(struct device *dev)
1089 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1090 struct imx219 *imx219 = to_imx219(sd);
1093 ret = regulator_bulk_enable(IMX219_NUM_SUPPLIES,
1096 dev_err(dev, "%s: failed to enable regulators\n",
1101 ret = clk_prepare_enable(imx219->xclk);
1103 dev_err(dev, "%s: failed to enable clock\n",
1108 gpiod_set_value_cansleep(imx219->reset_gpio, 1);
1109 usleep_range(IMX219_XCLR_MIN_DELAY_US,
1110 IMX219_XCLR_MIN_DELAY_US + IMX219_XCLR_DELAY_RANGE_US);
1115 regulator_bulk_disable(IMX219_NUM_SUPPLIES, imx219->supplies);
1120 static int imx219_power_off(struct device *dev)
1122 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1123 struct imx219 *imx219 = to_imx219(sd);
1125 gpiod_set_value_cansleep(imx219->reset_gpio, 0);
1126 regulator_bulk_disable(IMX219_NUM_SUPPLIES, imx219->supplies);
1127 clk_disable_unprepare(imx219->xclk);
1132 static int __maybe_unused imx219_suspend(struct device *dev)
1134 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1135 struct imx219 *imx219 = to_imx219(sd);
1137 if (imx219->streaming)
1138 imx219_stop_streaming(imx219);
1143 static int __maybe_unused imx219_resume(struct device *dev)
1145 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1146 struct imx219 *imx219 = to_imx219(sd);
1149 if (imx219->streaming) {
1150 ret = imx219_start_streaming(imx219);
1158 imx219_stop_streaming(imx219);
1159 imx219->streaming = false;
1164 static int imx219_get_regulators(struct imx219 *imx219)
1166 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1169 for (i = 0; i < IMX219_NUM_SUPPLIES; i++)
1170 imx219->supplies[i].supply = imx219_supply_name[i];
1172 return devm_regulator_bulk_get(&client->dev,
1173 IMX219_NUM_SUPPLIES,
1177 /* Verify chip ID */
1178 static int imx219_identify_module(struct imx219 *imx219)
1180 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1184 ret = imx219_read_reg(imx219, IMX219_REG_CHIP_ID,
1185 IMX219_REG_VALUE_16BIT, &val);
1187 dev_err(&client->dev, "failed to read chip id %x\n",
1192 if (val != IMX219_CHIP_ID) {
1193 dev_err(&client->dev, "chip id mismatch: %x!=%x\n",
1194 IMX219_CHIP_ID, val);
1201 static const struct v4l2_subdev_core_ops imx219_core_ops = {
1202 .subscribe_event = v4l2_ctrl_subdev_subscribe_event,
1203 .unsubscribe_event = v4l2_event_subdev_unsubscribe,
1206 static const struct v4l2_subdev_video_ops imx219_video_ops = {
1207 .s_stream = imx219_set_stream,
1210 static const struct v4l2_subdev_pad_ops imx219_pad_ops = {
1211 .enum_mbus_code = imx219_enum_mbus_code,
1212 .get_fmt = imx219_get_pad_format,
1213 .set_fmt = imx219_set_pad_format,
1214 .get_selection = imx219_get_selection,
1215 .enum_frame_size = imx219_enum_frame_size,
1218 static const struct v4l2_subdev_ops imx219_subdev_ops = {
1219 .core = &imx219_core_ops,
1220 .video = &imx219_video_ops,
1221 .pad = &imx219_pad_ops,
1224 static const struct v4l2_subdev_internal_ops imx219_internal_ops = {
1225 .open = imx219_open,
1228 /* Initialize control handlers */
1229 static int imx219_init_controls(struct imx219 *imx219)
1231 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1232 struct v4l2_ctrl_handler *ctrl_hdlr;
1233 unsigned int height = imx219->mode->height;
1234 struct v4l2_fwnode_device_properties props;
1235 int exposure_max, exposure_def, hblank;
1238 ctrl_hdlr = &imx219->ctrl_handler;
1239 ret = v4l2_ctrl_handler_init(ctrl_hdlr, 12);
1243 mutex_init(&imx219->mutex);
1244 ctrl_hdlr->lock = &imx219->mutex;
1246 /* By default, PIXEL_RATE is read only */
1247 imx219->pixel_rate = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1248 V4L2_CID_PIXEL_RATE,
1250 IMX219_PIXEL_RATE, 1,
1254 v4l2_ctrl_new_int_menu(ctrl_hdlr, &imx219_ctrl_ops,
1256 ARRAY_SIZE(imx219_link_freq_menu) - 1, 0,
1257 imx219_link_freq_menu);
1258 if (imx219->link_freq)
1259 imx219->link_freq->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1261 /* Initial vblank/hblank/exposure parameters based on current mode */
1262 imx219->vblank = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1263 V4L2_CID_VBLANK, IMX219_VBLANK_MIN,
1264 IMX219_VTS_MAX - height, 1,
1265 imx219->mode->vts_def - height);
1266 hblank = IMX219_PPL_DEFAULT - imx219->mode->width;
1267 imx219->hblank = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1268 V4L2_CID_HBLANK, hblank, hblank,
1271 imx219->hblank->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1272 exposure_max = imx219->mode->vts_def - 4;
1273 exposure_def = (exposure_max < IMX219_EXPOSURE_DEFAULT) ?
1274 exposure_max : IMX219_EXPOSURE_DEFAULT;
1275 imx219->exposure = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1277 IMX219_EXPOSURE_MIN, exposure_max,
1278 IMX219_EXPOSURE_STEP,
1281 v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops, V4L2_CID_ANALOGUE_GAIN,
1282 IMX219_ANA_GAIN_MIN, IMX219_ANA_GAIN_MAX,
1283 IMX219_ANA_GAIN_STEP, IMX219_ANA_GAIN_DEFAULT);
1285 v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops, V4L2_CID_DIGITAL_GAIN,
1286 IMX219_DGTL_GAIN_MIN, IMX219_DGTL_GAIN_MAX,
1287 IMX219_DGTL_GAIN_STEP, IMX219_DGTL_GAIN_DEFAULT);
1289 imx219->hflip = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1290 V4L2_CID_HFLIP, 0, 1, 1, 0);
1292 imx219->hflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
1294 imx219->vflip = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1295 V4L2_CID_VFLIP, 0, 1, 1, 0);
1297 imx219->vflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
1299 v4l2_ctrl_new_std_menu_items(ctrl_hdlr, &imx219_ctrl_ops,
1300 V4L2_CID_TEST_PATTERN,
1301 ARRAY_SIZE(imx219_test_pattern_menu) - 1,
1302 0, 0, imx219_test_pattern_menu);
1303 for (i = 0; i < 4; i++) {
1305 * The assumption is that
1306 * V4L2_CID_TEST_PATTERN_GREENR == V4L2_CID_TEST_PATTERN_RED + 1
1307 * V4L2_CID_TEST_PATTERN_BLUE == V4L2_CID_TEST_PATTERN_RED + 2
1308 * V4L2_CID_TEST_PATTERN_GREENB == V4L2_CID_TEST_PATTERN_RED + 3
1310 v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1311 V4L2_CID_TEST_PATTERN_RED + i,
1312 IMX219_TESTP_COLOUR_MIN,
1313 IMX219_TESTP_COLOUR_MAX,
1314 IMX219_TESTP_COLOUR_STEP,
1315 IMX219_TESTP_COLOUR_MAX);
1316 /* The "Solid color" pattern is white by default */
1319 if (ctrl_hdlr->error) {
1320 ret = ctrl_hdlr->error;
1321 dev_err(&client->dev, "%s control init failed (%d)\n",
1326 ret = v4l2_fwnode_device_parse(&client->dev, &props);
1330 ret = v4l2_ctrl_new_fwnode_properties(ctrl_hdlr, &imx219_ctrl_ops,
1335 imx219->sd.ctrl_handler = ctrl_hdlr;
1340 v4l2_ctrl_handler_free(ctrl_hdlr);
1341 mutex_destroy(&imx219->mutex);
1346 static void imx219_free_controls(struct imx219 *imx219)
1348 v4l2_ctrl_handler_free(imx219->sd.ctrl_handler);
1349 mutex_destroy(&imx219->mutex);
1352 static int imx219_check_hwcfg(struct device *dev)
1354 struct fwnode_handle *endpoint;
1355 struct v4l2_fwnode_endpoint ep_cfg = {
1356 .bus_type = V4L2_MBUS_CSI2_DPHY
1360 endpoint = fwnode_graph_get_next_endpoint(dev_fwnode(dev), NULL);
1362 dev_err(dev, "endpoint node not found\n");
1366 if (v4l2_fwnode_endpoint_alloc_parse(endpoint, &ep_cfg)) {
1367 dev_err(dev, "could not parse endpoint\n");
1371 /* Check the number of MIPI CSI2 data lanes */
1372 if (ep_cfg.bus.mipi_csi2.num_data_lanes != 2) {
1373 dev_err(dev, "only 2 data lanes are currently supported\n");
1377 /* Check the link frequency set in device tree */
1378 if (!ep_cfg.nr_of_link_frequencies) {
1379 dev_err(dev, "link-frequency property not found in DT\n");
1383 if (ep_cfg.nr_of_link_frequencies != 1 ||
1384 ep_cfg.link_frequencies[0] != IMX219_DEFAULT_LINK_FREQ) {
1385 dev_err(dev, "Link frequency not supported: %lld\n",
1386 ep_cfg.link_frequencies[0]);
1393 v4l2_fwnode_endpoint_free(&ep_cfg);
1394 fwnode_handle_put(endpoint);
1399 static int imx219_probe(struct i2c_client *client)
1401 struct device *dev = &client->dev;
1402 struct imx219 *imx219;
1405 imx219 = devm_kzalloc(&client->dev, sizeof(*imx219), GFP_KERNEL);
1409 v4l2_i2c_subdev_init(&imx219->sd, client, &imx219_subdev_ops);
1411 /* Check the hardware configuration in device tree */
1412 if (imx219_check_hwcfg(dev))
1415 /* Get system clock (xclk) */
1416 imx219->xclk = devm_clk_get(dev, NULL);
1417 if (IS_ERR(imx219->xclk)) {
1418 dev_err(dev, "failed to get xclk\n");
1419 return PTR_ERR(imx219->xclk);
1422 imx219->xclk_freq = clk_get_rate(imx219->xclk);
1423 if (imx219->xclk_freq != IMX219_XCLK_FREQ) {
1424 dev_err(dev, "xclk frequency not supported: %d Hz\n",
1429 ret = imx219_get_regulators(imx219);
1431 dev_err(dev, "failed to get regulators\n");
1435 /* Request optional enable pin */
1436 imx219->reset_gpio = devm_gpiod_get_optional(dev, "reset",
1440 * The sensor must be powered for imx219_identify_module()
1441 * to be able to read the CHIP_ID register
1443 ret = imx219_power_on(dev);
1447 ret = imx219_identify_module(imx219);
1449 goto error_power_off;
1451 /* Set default mode to max resolution */
1452 imx219->mode = &supported_modes[0];
1454 /* sensor doesn't enter LP-11 state upon power up until and unless
1455 * streaming is started, so upon power up switch the modes to:
1456 * streaming -> standby
1458 ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1459 IMX219_REG_VALUE_08BIT, IMX219_MODE_STREAMING);
1461 goto error_power_off;
1462 usleep_range(100, 110);
1464 /* put sensor back to standby mode */
1465 ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1466 IMX219_REG_VALUE_08BIT, IMX219_MODE_STANDBY);
1468 goto error_power_off;
1469 usleep_range(100, 110);
1471 ret = imx219_init_controls(imx219);
1473 goto error_power_off;
1475 /* Initialize subdev */
1476 imx219->sd.internal_ops = &imx219_internal_ops;
1477 imx219->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE |
1478 V4L2_SUBDEV_FL_HAS_EVENTS;
1479 imx219->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
1481 /* Initialize source pad */
1482 imx219->pad.flags = MEDIA_PAD_FL_SOURCE;
1484 /* Initialize default format */
1485 imx219_set_default_format(imx219);
1487 ret = media_entity_pads_init(&imx219->sd.entity, 1, &imx219->pad);
1489 dev_err(dev, "failed to init entity pads: %d\n", ret);
1490 goto error_handler_free;
1493 ret = v4l2_async_register_subdev_sensor(&imx219->sd);
1495 dev_err(dev, "failed to register sensor sub-device: %d\n", ret);
1496 goto error_media_entity;
1499 /* Enable runtime PM and turn off the device */
1500 pm_runtime_set_active(dev);
1501 pm_runtime_enable(dev);
1502 pm_runtime_idle(dev);
1507 media_entity_cleanup(&imx219->sd.entity);
1510 imx219_free_controls(imx219);
1513 imx219_power_off(dev);
1518 static void imx219_remove(struct i2c_client *client)
1520 struct v4l2_subdev *sd = i2c_get_clientdata(client);
1521 struct imx219 *imx219 = to_imx219(sd);
1523 v4l2_async_unregister_subdev(sd);
1524 media_entity_cleanup(&sd->entity);
1525 imx219_free_controls(imx219);
1527 pm_runtime_disable(&client->dev);
1528 if (!pm_runtime_status_suspended(&client->dev))
1529 imx219_power_off(&client->dev);
1530 pm_runtime_set_suspended(&client->dev);
1533 static const struct of_device_id imx219_dt_ids[] = {
1534 { .compatible = "sony,imx219" },
1537 MODULE_DEVICE_TABLE(of, imx219_dt_ids);
1539 static const struct dev_pm_ops imx219_pm_ops = {
1540 SET_SYSTEM_SLEEP_PM_OPS(imx219_suspend, imx219_resume)
1541 SET_RUNTIME_PM_OPS(imx219_power_off, imx219_power_on, NULL)
1544 static struct i2c_driver imx219_i2c_driver = {
1547 .of_match_table = imx219_dt_ids,
1548 .pm = &imx219_pm_ops,
1550 .probe_new = imx219_probe,
1551 .remove = imx219_remove,
1554 module_i2c_driver(imx219_i2c_driver);
1556 MODULE_AUTHOR("Dave Stevenson <dave.stevenson@raspberrypi.com");
1557 MODULE_DESCRIPTION("Sony IMX219 sensor driver");
1558 MODULE_LICENSE("GPL v2");