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 for all the modes */
46 #define IMX219_PIXEL_RATE 182400000
47 #define IMX219_PIXEL_RATE_4LANE 280800000
49 #define IMX219_DEFAULT_LINK_FREQ 456000000
50 #define IMX219_DEFAULT_LINK_FREQ_4LANE 363000000
52 #define IMX219_REG_CSI_LANE_MODE 0x0114
53 #define IMX219_CSI_2_LANE_MODE 0x01
54 #define IMX219_CSI_4_LANE_MODE 0x03
56 /* V_TIMING internal */
57 #define IMX219_REG_VTS 0x0160
58 #define IMX219_VTS_15FPS 0x0dc6
59 #define IMX219_VTS_30FPS_1080P 0x06e3
60 #define IMX219_VTS_30FPS_BINNED 0x06e3
61 #define IMX219_VTS_30FPS_640x480 0x06e3
62 #define IMX219_VTS_MAX 0xffff
64 #define IMX219_VBLANK_MIN 4
67 #define IMX219_FLL_MIN 0x08a6
68 #define IMX219_FLL_MAX 0xffff
69 #define IMX219_FLL_STEP 1
70 #define IMX219_FLL_DEFAULT 0x0c98
72 /* HBLANK control - read only */
73 #define IMX219_PPL_DEFAULT 3448
75 /* Exposure control */
76 #define IMX219_REG_EXPOSURE 0x015a
77 #define IMX219_EXPOSURE_MIN 4
78 #define IMX219_EXPOSURE_STEP 1
79 #define IMX219_EXPOSURE_DEFAULT 0x640
80 #define IMX219_EXPOSURE_MAX 65535
82 /* Analog gain control */
83 #define IMX219_REG_ANALOG_GAIN 0x0157
84 #define IMX219_ANA_GAIN_MIN 0
85 #define IMX219_ANA_GAIN_MAX 232
86 #define IMX219_ANA_GAIN_STEP 1
87 #define IMX219_ANA_GAIN_DEFAULT 0x0
89 /* Digital gain control */
90 #define IMX219_REG_DIGITAL_GAIN 0x0158
91 #define IMX219_DGTL_GAIN_MIN 0x0100
92 #define IMX219_DGTL_GAIN_MAX 0x0fff
93 #define IMX219_DGTL_GAIN_DEFAULT 0x0100
94 #define IMX219_DGTL_GAIN_STEP 1
96 #define IMX219_REG_ORIENTATION 0x0172
99 #define IMX219_REG_BINNING_MODE 0x0174
100 #define IMX219_BINNING_NONE 0x0000
101 #define IMX219_BINNING_2X2 0x0101
102 #define IMX219_BINNING_2X2_ANALOG 0x0303
104 /* Test Pattern Control */
105 #define IMX219_REG_TEST_PATTERN 0x0600
106 #define IMX219_TEST_PATTERN_DISABLE 0
107 #define IMX219_TEST_PATTERN_SOLID_COLOR 1
108 #define IMX219_TEST_PATTERN_COLOR_BARS 2
109 #define IMX219_TEST_PATTERN_GREY_COLOR 3
110 #define IMX219_TEST_PATTERN_PN9 4
112 /* Test pattern colour components */
113 #define IMX219_REG_TESTP_RED 0x0602
114 #define IMX219_REG_TESTP_GREENR 0x0604
115 #define IMX219_REG_TESTP_BLUE 0x0606
116 #define IMX219_REG_TESTP_GREENB 0x0608
117 #define IMX219_TESTP_COLOUR_MIN 0
118 #define IMX219_TESTP_COLOUR_MAX 0x03ff
119 #define IMX219_TESTP_COLOUR_STEP 1
120 #define IMX219_TESTP_RED_DEFAULT IMX219_TESTP_COLOUR_MAX
121 #define IMX219_TESTP_GREENR_DEFAULT 0
122 #define IMX219_TESTP_BLUE_DEFAULT 0
123 #define IMX219_TESTP_GREENB_DEFAULT 0
125 /* IMX219 native and active pixel array size. */
126 #define IMX219_NATIVE_WIDTH 3296U
127 #define IMX219_NATIVE_HEIGHT 2480U
128 #define IMX219_PIXEL_ARRAY_LEFT 8U
129 #define IMX219_PIXEL_ARRAY_TOP 8U
130 #define IMX219_PIXEL_ARRAY_WIDTH 3280U
131 #define IMX219_PIXEL_ARRAY_HEIGHT 2464U
138 struct imx219_reg_list {
139 unsigned int num_of_regs;
140 const struct imx219_reg *regs;
143 /* Mode : resolution and related config&values */
150 /* Analog crop rectangle. */
151 struct v4l2_rect crop;
154 unsigned int vts_def;
156 /* Default register values */
157 struct imx219_reg_list reg_list;
159 /* 2x2 binning is used */
163 static const struct imx219_reg imx219_common_regs[] = {
164 {0x0100, 0x00}, /* Mode Select */
166 /* To Access Addresses 3000-5fff, send the following commands */
174 /* PLL Clock Table */
175 {0x0301, 0x05}, /* VTPXCK_DIV */
176 {0x0303, 0x01}, /* VTSYSCK_DIV */
177 {0x0304, 0x03}, /* PREPLLCK_VT_DIV 0x03 = AUTO set */
178 {0x0305, 0x03}, /* PREPLLCK_OP_DIV 0x03 = AUTO set */
179 {0x0306, 0x00}, /* PLL_VT_MPY */
181 {0x030b, 0x01}, /* OP_SYS_CLK_DIV */
182 {0x030c, 0x00}, /* PLL_OP_MPY */
185 /* Undocumented registers */
199 /* Frame Bank Register Group "A" */
200 {0x0162, 0x0d}, /* Line_Length_A */
202 {0x0170, 0x01}, /* X_ODD_INC_A */
203 {0x0171, 0x01}, /* Y_ODD_INC_A */
205 /* Output setup registers */
206 {0x0114, 0x01}, /* CSI 2-Lane Mode */
207 {0x0128, 0x00}, /* DPHY Auto Mode */
208 {0x012a, 0x18}, /* EXCK_Freq */
213 * Register sets lifted off the i2C interface from the Raspberry Pi firmware
215 * 3280x2464 = mode 2, 1920x1080 = mode 1, 1640x1232 = mode 4, 640x480 = mode 7.
217 static const struct imx219_reg mode_3280x2464_regs[] = {
236 static const struct imx219_reg mode_1920_1080_regs[] = {
255 static const struct imx219_reg mode_1640_1232_regs[] = {
274 static const struct imx219_reg mode_640_480_regs[] = {
293 static const struct imx219_reg raw8_framefmt_regs[] = {
299 static const struct imx219_reg raw10_framefmt_regs[] = {
305 static const s64 imx219_link_freq_menu[] = {
306 IMX219_DEFAULT_LINK_FREQ,
309 static const s64 imx219_link_freq_4lane_menu[] = {
310 IMX219_DEFAULT_LINK_FREQ_4LANE,
313 static const char * const imx219_test_pattern_menu[] = {
321 static const int imx219_test_pattern_val[] = {
322 IMX219_TEST_PATTERN_DISABLE,
323 IMX219_TEST_PATTERN_COLOR_BARS,
324 IMX219_TEST_PATTERN_SOLID_COLOR,
325 IMX219_TEST_PATTERN_GREY_COLOR,
326 IMX219_TEST_PATTERN_PN9,
329 /* regulator supplies */
330 static const char * const imx219_supply_name[] = {
331 /* Supplies can be enabled in any order */
332 "VANA", /* Analog (2.8V) supply */
333 "VDIG", /* Digital Core (1.8V) supply */
334 "VDDL", /* IF (1.2V) supply */
337 #define IMX219_NUM_SUPPLIES ARRAY_SIZE(imx219_supply_name)
340 * The supported formats.
341 * This table MUST contain 4 entries per format, to cover the various flip
342 * combinations in the order
348 static const u32 imx219_mbus_formats[] = {
349 MEDIA_BUS_FMT_SRGGB10_1X10,
350 MEDIA_BUS_FMT_SGRBG10_1X10,
351 MEDIA_BUS_FMT_SGBRG10_1X10,
352 MEDIA_BUS_FMT_SBGGR10_1X10,
354 MEDIA_BUS_FMT_SRGGB8_1X8,
355 MEDIA_BUS_FMT_SGRBG8_1X8,
356 MEDIA_BUS_FMT_SGBRG8_1X8,
357 MEDIA_BUS_FMT_SBGGR8_1X8,
361 * Initialisation delay between XCLR low->high and the moment when the sensor
362 * can start capture (i.e. can leave software stanby) must be not less than:
363 * t4 + max(t5, t6 + <time to initialize the sensor register over I2C>)
365 * t4 is fixed, and is max 200uS,
366 * t5 is fixed, and is 6000uS,
367 * t6 depends on the sensor external clock, and is max 32000 clock periods.
368 * As per sensor datasheet, the external clock must be from 6MHz to 27MHz.
369 * So for any acceptable external clock t6 is always within the range of
370 * 1185 to 5333 uS, and is always less than t5.
371 * For this reason this is always safe to wait (t4 + t5) = 6200 uS, then
372 * initialize the sensor over I2C, and then exit the software standby.
374 * This start-up time can be optimized a bit more, if we start the writes
375 * over I2C after (t4+t6), but before (t4+t5) expires. But then sensor
376 * initialization over I2C may complete before (t4+t5) expires, and we must
377 * ensure that capture is not started before (t4+t5).
379 * This delay doesn't account for the power supply startup time. If needed,
380 * this should be taken care of via the regulator framework. E.g. in the
381 * case of DT for regulator-fixed one should define the startup-delay-us
384 #define IMX219_XCLR_MIN_DELAY_US 6200
385 #define IMX219_XCLR_DELAY_RANGE_US 1000
388 static const struct imx219_mode supported_modes[] = {
390 /* 8MPix 15fps mode */
394 .left = IMX219_PIXEL_ARRAY_LEFT,
395 .top = IMX219_PIXEL_ARRAY_TOP,
399 .vts_def = IMX219_VTS_15FPS,
401 .num_of_regs = ARRAY_SIZE(mode_3280x2464_regs),
402 .regs = mode_3280x2464_regs,
407 /* 1080P 30fps cropped */
416 .vts_def = IMX219_VTS_30FPS_1080P,
418 .num_of_regs = ARRAY_SIZE(mode_1920_1080_regs),
419 .regs = mode_1920_1080_regs,
424 /* 2x2 binned 30fps mode */
428 .left = IMX219_PIXEL_ARRAY_LEFT,
429 .top = IMX219_PIXEL_ARRAY_TOP,
433 .vts_def = IMX219_VTS_30FPS_BINNED,
435 .num_of_regs = ARRAY_SIZE(mode_1640_1232_regs),
436 .regs = mode_1640_1232_regs,
441 /* 640x480 30fps mode */
450 .vts_def = IMX219_VTS_30FPS_640x480,
452 .num_of_regs = ARRAY_SIZE(mode_640_480_regs),
453 .regs = mode_640_480_regs,
460 struct v4l2_subdev sd;
461 struct media_pad pad;
463 struct clk *xclk; /* system clock to IMX219 */
466 struct gpio_desc *reset_gpio;
467 struct regulator_bulk_data supplies[IMX219_NUM_SUPPLIES];
469 struct v4l2_ctrl_handler ctrl_handler;
471 struct v4l2_ctrl *pixel_rate;
472 struct v4l2_ctrl *link_freq;
473 struct v4l2_ctrl *exposure;
474 struct v4l2_ctrl *vflip;
475 struct v4l2_ctrl *hflip;
476 struct v4l2_ctrl *vblank;
477 struct v4l2_ctrl *hblank;
480 const struct imx219_mode *mode;
482 /* Streaming on/off */
485 /* Two or Four lanes */
489 static inline struct imx219 *to_imx219(struct v4l2_subdev *_sd)
491 return container_of(_sd, struct imx219, sd);
494 /* Read registers up to 2 at a time */
495 static int imx219_read_reg(struct imx219 *imx219, u16 reg, u32 len, u32 *val)
497 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
498 struct i2c_msg msgs[2];
499 u8 addr_buf[2] = { reg >> 8, reg & 0xff };
500 u8 data_buf[4] = { 0, };
506 /* Write register address */
507 msgs[0].addr = client->addr;
509 msgs[0].len = ARRAY_SIZE(addr_buf);
510 msgs[0].buf = addr_buf;
512 /* Read data from register */
513 msgs[1].addr = client->addr;
514 msgs[1].flags = I2C_M_RD;
516 msgs[1].buf = &data_buf[4 - len];
518 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
519 if (ret != ARRAY_SIZE(msgs))
522 *val = get_unaligned_be32(data_buf);
527 /* Write registers up to 2 at a time */
528 static int imx219_write_reg(struct imx219 *imx219, u16 reg, u32 len, u32 val)
530 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
536 put_unaligned_be16(reg, buf);
537 put_unaligned_be32(val << (8 * (4 - len)), buf + 2);
538 if (i2c_master_send(client, buf, len + 2) != len + 2)
544 /* Write a list of registers */
545 static int imx219_write_regs(struct imx219 *imx219,
546 const struct imx219_reg *regs, u32 len)
548 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
552 for (i = 0; i < len; i++) {
553 ret = imx219_write_reg(imx219, regs[i].address, 1, regs[i].val);
555 dev_err_ratelimited(&client->dev,
556 "Failed to write reg 0x%4.4x. error = %d\n",
557 regs[i].address, ret);
566 /* Get bayer order based on flip setting. */
567 static u32 imx219_get_format_code(struct imx219 *imx219, u32 code)
571 for (i = 0; i < ARRAY_SIZE(imx219_mbus_formats); i++)
572 if (imx219_mbus_formats[i] == code)
575 if (i >= ARRAY_SIZE(imx219_mbus_formats))
578 i = (i & ~3) | (imx219->vflip->val ? 2 : 0) |
579 (imx219->hflip->val ? 1 : 0);
581 return imx219_mbus_formats[i];
584 static int imx219_set_ctrl(struct v4l2_ctrl *ctrl)
586 struct imx219 *imx219 =
587 container_of(ctrl->handler, struct imx219, ctrl_handler);
588 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
591 if (ctrl->id == V4L2_CID_VBLANK) {
592 int exposure_max, exposure_def;
594 /* Update max exposure while meeting expected vblanking */
595 exposure_max = imx219->mode->height + ctrl->val - 4;
596 exposure_def = (exposure_max < IMX219_EXPOSURE_DEFAULT) ?
597 exposure_max : IMX219_EXPOSURE_DEFAULT;
598 __v4l2_ctrl_modify_range(imx219->exposure,
599 imx219->exposure->minimum,
600 exposure_max, imx219->exposure->step,
605 * Applying V4L2 control value only happens
606 * when power is up for streaming
608 if (pm_runtime_get_if_in_use(&client->dev) == 0)
612 case V4L2_CID_ANALOGUE_GAIN:
613 ret = imx219_write_reg(imx219, IMX219_REG_ANALOG_GAIN,
614 IMX219_REG_VALUE_08BIT, ctrl->val);
616 case V4L2_CID_EXPOSURE:
617 ret = imx219_write_reg(imx219, IMX219_REG_EXPOSURE,
618 IMX219_REG_VALUE_16BIT, ctrl->val);
620 case V4L2_CID_DIGITAL_GAIN:
621 ret = imx219_write_reg(imx219, IMX219_REG_DIGITAL_GAIN,
622 IMX219_REG_VALUE_16BIT, ctrl->val);
624 case V4L2_CID_TEST_PATTERN:
625 ret = imx219_write_reg(imx219, IMX219_REG_TEST_PATTERN,
626 IMX219_REG_VALUE_16BIT,
627 imx219_test_pattern_val[ctrl->val]);
631 ret = imx219_write_reg(imx219, IMX219_REG_ORIENTATION, 1,
633 imx219->vflip->val << 1);
635 case V4L2_CID_VBLANK:
636 ret = imx219_write_reg(imx219, IMX219_REG_VTS,
637 IMX219_REG_VALUE_16BIT,
638 imx219->mode->height + ctrl->val);
640 case V4L2_CID_TEST_PATTERN_RED:
641 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_RED,
642 IMX219_REG_VALUE_16BIT, ctrl->val);
644 case V4L2_CID_TEST_PATTERN_GREENR:
645 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_GREENR,
646 IMX219_REG_VALUE_16BIT, ctrl->val);
648 case V4L2_CID_TEST_PATTERN_BLUE:
649 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_BLUE,
650 IMX219_REG_VALUE_16BIT, ctrl->val);
652 case V4L2_CID_TEST_PATTERN_GREENB:
653 ret = imx219_write_reg(imx219, IMX219_REG_TESTP_GREENB,
654 IMX219_REG_VALUE_16BIT, ctrl->val);
657 dev_info(&client->dev,
658 "ctrl(id:0x%x,val:0x%x) is not handled\n",
659 ctrl->id, ctrl->val);
664 pm_runtime_put(&client->dev);
669 static const struct v4l2_ctrl_ops imx219_ctrl_ops = {
670 .s_ctrl = imx219_set_ctrl,
673 static void imx219_update_pad_format(struct imx219 *imx219,
674 const struct imx219_mode *mode,
675 struct v4l2_mbus_framefmt *fmt, u32 code)
677 /* Bayer order varies with flips */
678 fmt->code = imx219_get_format_code(imx219, code);
679 fmt->width = mode->width;
680 fmt->height = mode->height;
681 fmt->field = V4L2_FIELD_NONE;
682 fmt->colorspace = V4L2_COLORSPACE_RAW;
683 fmt->quantization = V4L2_QUANTIZATION_FULL_RANGE;
684 fmt->xfer_func = V4L2_XFER_FUNC_NONE;
687 static int imx219_init_cfg(struct v4l2_subdev *sd,
688 struct v4l2_subdev_state *state)
690 struct imx219 *imx219 = to_imx219(sd);
691 struct v4l2_mbus_framefmt *format;
692 struct v4l2_rect *crop;
694 /* Initialize the format. */
695 format = v4l2_subdev_get_pad_format(sd, state, 0);
696 imx219_update_pad_format(imx219, &supported_modes[0], format,
697 MEDIA_BUS_FMT_SRGGB10_1X10);
699 /* Initialize the crop rectangle. */
700 crop = v4l2_subdev_get_pad_crop(sd, state, 0);
701 crop->top = IMX219_PIXEL_ARRAY_TOP;
702 crop->left = IMX219_PIXEL_ARRAY_LEFT;
703 crop->width = IMX219_PIXEL_ARRAY_WIDTH;
704 crop->height = IMX219_PIXEL_ARRAY_HEIGHT;
709 static int imx219_enum_mbus_code(struct v4l2_subdev *sd,
710 struct v4l2_subdev_state *sd_state,
711 struct v4l2_subdev_mbus_code_enum *code)
713 struct imx219 *imx219 = to_imx219(sd);
715 if (code->index >= (ARRAY_SIZE(imx219_mbus_formats) / 4))
718 code->code = imx219_get_format_code(imx219, imx219_mbus_formats[code->index * 4]);
723 static int imx219_enum_frame_size(struct v4l2_subdev *sd,
724 struct v4l2_subdev_state *sd_state,
725 struct v4l2_subdev_frame_size_enum *fse)
727 struct imx219 *imx219 = to_imx219(sd);
730 if (fse->index >= ARRAY_SIZE(supported_modes))
733 code = imx219_get_format_code(imx219, fse->code);
734 if (fse->code != code)
737 fse->min_width = supported_modes[fse->index].width;
738 fse->max_width = fse->min_width;
739 fse->min_height = supported_modes[fse->index].height;
740 fse->max_height = fse->min_height;
745 static int imx219_set_pad_format(struct v4l2_subdev *sd,
746 struct v4l2_subdev_state *sd_state,
747 struct v4l2_subdev_format *fmt)
749 struct imx219 *imx219 = to_imx219(sd);
750 const struct imx219_mode *mode;
751 int exposure_max, exposure_def, hblank;
752 struct v4l2_mbus_framefmt *format;
753 struct v4l2_rect *crop;
755 mode = v4l2_find_nearest_size(supported_modes,
756 ARRAY_SIZE(supported_modes),
758 fmt->format.width, fmt->format.height);
760 imx219_update_pad_format(imx219, mode, &fmt->format, fmt->format.code);
762 format = v4l2_subdev_get_pad_format(sd, sd_state, 0);
763 crop = v4l2_subdev_get_pad_crop(sd, sd_state, 0);
765 *format = fmt->format;
768 if (fmt->which == V4L2_SUBDEV_FORMAT_ACTIVE) {
770 /* Update limits and set FPS to default */
771 __v4l2_ctrl_modify_range(imx219->vblank, IMX219_VBLANK_MIN,
772 IMX219_VTS_MAX - mode->height, 1,
773 mode->vts_def - mode->height);
774 __v4l2_ctrl_s_ctrl(imx219->vblank,
775 mode->vts_def - mode->height);
776 /* Update max exposure while meeting expected vblanking */
777 exposure_max = mode->vts_def - 4;
778 exposure_def = (exposure_max < IMX219_EXPOSURE_DEFAULT) ?
779 exposure_max : IMX219_EXPOSURE_DEFAULT;
780 __v4l2_ctrl_modify_range(imx219->exposure,
781 imx219->exposure->minimum,
782 exposure_max, imx219->exposure->step,
785 * Currently PPL is fixed to IMX219_PPL_DEFAULT, so hblank
786 * depends on mode->width only, and is not changeble in any
787 * way other than changing the mode.
789 hblank = IMX219_PPL_DEFAULT - mode->width;
790 __v4l2_ctrl_modify_range(imx219->hblank, hblank, hblank, 1,
797 static int imx219_set_framefmt(struct imx219 *imx219,
798 const struct v4l2_mbus_framefmt *format)
800 switch (format->code) {
801 case MEDIA_BUS_FMT_SRGGB8_1X8:
802 case MEDIA_BUS_FMT_SGRBG8_1X8:
803 case MEDIA_BUS_FMT_SGBRG8_1X8:
804 case MEDIA_BUS_FMT_SBGGR8_1X8:
805 return imx219_write_regs(imx219, raw8_framefmt_regs,
806 ARRAY_SIZE(raw8_framefmt_regs));
808 case MEDIA_BUS_FMT_SRGGB10_1X10:
809 case MEDIA_BUS_FMT_SGRBG10_1X10:
810 case MEDIA_BUS_FMT_SGBRG10_1X10:
811 case MEDIA_BUS_FMT_SBGGR10_1X10:
812 return imx219_write_regs(imx219, raw10_framefmt_regs,
813 ARRAY_SIZE(raw10_framefmt_regs));
819 static int imx219_set_binning(struct imx219 *imx219,
820 const struct v4l2_mbus_framefmt *format)
822 if (!imx219->mode->binning) {
823 return imx219_write_reg(imx219, IMX219_REG_BINNING_MODE,
824 IMX219_REG_VALUE_16BIT,
825 IMX219_BINNING_NONE);
828 switch (format->code) {
829 case MEDIA_BUS_FMT_SRGGB8_1X8:
830 case MEDIA_BUS_FMT_SGRBG8_1X8:
831 case MEDIA_BUS_FMT_SGBRG8_1X8:
832 case MEDIA_BUS_FMT_SBGGR8_1X8:
833 return imx219_write_reg(imx219, IMX219_REG_BINNING_MODE,
834 IMX219_REG_VALUE_16BIT,
835 IMX219_BINNING_2X2_ANALOG);
837 case MEDIA_BUS_FMT_SRGGB10_1X10:
838 case MEDIA_BUS_FMT_SGRBG10_1X10:
839 case MEDIA_BUS_FMT_SGBRG10_1X10:
840 case MEDIA_BUS_FMT_SBGGR10_1X10:
841 return imx219_write_reg(imx219, IMX219_REG_BINNING_MODE,
842 IMX219_REG_VALUE_16BIT,
849 static int imx219_get_selection(struct v4l2_subdev *sd,
850 struct v4l2_subdev_state *sd_state,
851 struct v4l2_subdev_selection *sel)
853 switch (sel->target) {
854 case V4L2_SEL_TGT_CROP: {
855 sel->r = *v4l2_subdev_get_pad_crop(sd, sd_state, 0);
859 case V4L2_SEL_TGT_NATIVE_SIZE:
862 sel->r.width = IMX219_NATIVE_WIDTH;
863 sel->r.height = IMX219_NATIVE_HEIGHT;
867 case V4L2_SEL_TGT_CROP_DEFAULT:
868 case V4L2_SEL_TGT_CROP_BOUNDS:
869 sel->r.top = IMX219_PIXEL_ARRAY_TOP;
870 sel->r.left = IMX219_PIXEL_ARRAY_LEFT;
871 sel->r.width = IMX219_PIXEL_ARRAY_WIDTH;
872 sel->r.height = IMX219_PIXEL_ARRAY_HEIGHT;
880 static int imx219_configure_lanes(struct imx219 *imx219)
882 return imx219_write_reg(imx219, IMX219_REG_CSI_LANE_MODE,
883 IMX219_REG_VALUE_08BIT, (imx219->lanes == 2) ?
884 IMX219_CSI_2_LANE_MODE : IMX219_CSI_4_LANE_MODE);
887 static int imx219_start_streaming(struct imx219 *imx219,
888 struct v4l2_subdev_state *state)
890 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
891 const struct v4l2_mbus_framefmt *format;
892 const struct imx219_reg_list *reg_list;
895 ret = pm_runtime_resume_and_get(&client->dev);
899 /* Send all registers that are common to all modes */
900 ret = imx219_write_regs(imx219, imx219_common_regs, ARRAY_SIZE(imx219_common_regs));
902 dev_err(&client->dev, "%s failed to send mfg header\n", __func__);
906 /* Configure two or four Lane mode */
907 ret = imx219_configure_lanes(imx219);
909 dev_err(&client->dev, "%s failed to configure lanes\n", __func__);
913 /* Apply default values of current mode */
914 reg_list = &imx219->mode->reg_list;
915 ret = imx219_write_regs(imx219, reg_list->regs, reg_list->num_of_regs);
917 dev_err(&client->dev, "%s failed to set mode\n", __func__);
921 format = v4l2_subdev_get_pad_format(&imx219->sd, state, 0);
922 ret = imx219_set_framefmt(imx219, format);
924 dev_err(&client->dev, "%s failed to set frame format: %d\n",
929 ret = imx219_set_binning(imx219, format);
931 dev_err(&client->dev, "%s failed to set binning: %d\n",
936 /* Apply customized values from user */
937 ret = __v4l2_ctrl_handler_setup(imx219->sd.ctrl_handler);
941 /* set stream on register */
942 ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
943 IMX219_REG_VALUE_08BIT, IMX219_MODE_STREAMING);
947 /* vflip and hflip cannot change during streaming */
948 __v4l2_ctrl_grab(imx219->vflip, true);
949 __v4l2_ctrl_grab(imx219->hflip, true);
954 pm_runtime_put(&client->dev);
958 static void imx219_stop_streaming(struct imx219 *imx219)
960 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
963 /* set stream off register */
964 ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
965 IMX219_REG_VALUE_08BIT, IMX219_MODE_STANDBY);
967 dev_err(&client->dev, "%s failed to set stream\n", __func__);
969 __v4l2_ctrl_grab(imx219->vflip, false);
970 __v4l2_ctrl_grab(imx219->hflip, false);
972 pm_runtime_put(&client->dev);
975 static int imx219_set_stream(struct v4l2_subdev *sd, int enable)
977 struct imx219 *imx219 = to_imx219(sd);
978 struct v4l2_subdev_state *state;
981 state = v4l2_subdev_lock_and_get_active_state(sd);
983 if (imx219->streaming == enable)
988 * Apply default & customized values
989 * and then start streaming.
991 ret = imx219_start_streaming(imx219, state);
995 imx219_stop_streaming(imx219);
998 imx219->streaming = enable;
1001 v4l2_subdev_unlock_state(state);
1005 /* Power/clock management functions */
1006 static int imx219_power_on(struct device *dev)
1008 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1009 struct imx219 *imx219 = to_imx219(sd);
1012 ret = regulator_bulk_enable(IMX219_NUM_SUPPLIES,
1015 dev_err(dev, "%s: failed to enable regulators\n",
1020 ret = clk_prepare_enable(imx219->xclk);
1022 dev_err(dev, "%s: failed to enable clock\n",
1027 gpiod_set_value_cansleep(imx219->reset_gpio, 1);
1028 usleep_range(IMX219_XCLR_MIN_DELAY_US,
1029 IMX219_XCLR_MIN_DELAY_US + IMX219_XCLR_DELAY_RANGE_US);
1034 regulator_bulk_disable(IMX219_NUM_SUPPLIES, imx219->supplies);
1039 static int imx219_power_off(struct device *dev)
1041 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1042 struct imx219 *imx219 = to_imx219(sd);
1044 gpiod_set_value_cansleep(imx219->reset_gpio, 0);
1045 regulator_bulk_disable(IMX219_NUM_SUPPLIES, imx219->supplies);
1046 clk_disable_unprepare(imx219->xclk);
1051 static int __maybe_unused imx219_suspend(struct device *dev)
1053 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1054 struct imx219 *imx219 = to_imx219(sd);
1056 if (imx219->streaming)
1057 imx219_stop_streaming(imx219);
1062 static int __maybe_unused imx219_resume(struct device *dev)
1064 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1065 struct imx219 *imx219 = to_imx219(sd);
1066 struct v4l2_subdev_state *state;
1069 if (imx219->streaming) {
1070 state = v4l2_subdev_lock_and_get_active_state(sd);
1071 ret = imx219_start_streaming(imx219, state);
1072 v4l2_subdev_unlock_state(state);
1080 imx219_stop_streaming(imx219);
1081 imx219->streaming = false;
1086 static int imx219_get_regulators(struct imx219 *imx219)
1088 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1091 for (i = 0; i < IMX219_NUM_SUPPLIES; i++)
1092 imx219->supplies[i].supply = imx219_supply_name[i];
1094 return devm_regulator_bulk_get(&client->dev,
1095 IMX219_NUM_SUPPLIES,
1099 /* Verify chip ID */
1100 static int imx219_identify_module(struct imx219 *imx219)
1102 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1106 ret = imx219_read_reg(imx219, IMX219_REG_CHIP_ID,
1107 IMX219_REG_VALUE_16BIT, &val);
1109 dev_err(&client->dev, "failed to read chip id %x\n",
1114 if (val != IMX219_CHIP_ID) {
1115 dev_err(&client->dev, "chip id mismatch: %x!=%x\n",
1116 IMX219_CHIP_ID, val);
1123 static const struct v4l2_subdev_core_ops imx219_core_ops = {
1124 .subscribe_event = v4l2_ctrl_subdev_subscribe_event,
1125 .unsubscribe_event = v4l2_event_subdev_unsubscribe,
1128 static const struct v4l2_subdev_video_ops imx219_video_ops = {
1129 .s_stream = imx219_set_stream,
1132 static const struct v4l2_subdev_pad_ops imx219_pad_ops = {
1133 .init_cfg = imx219_init_cfg,
1134 .enum_mbus_code = imx219_enum_mbus_code,
1135 .get_fmt = v4l2_subdev_get_fmt,
1136 .set_fmt = imx219_set_pad_format,
1137 .get_selection = imx219_get_selection,
1138 .enum_frame_size = imx219_enum_frame_size,
1141 static const struct v4l2_subdev_ops imx219_subdev_ops = {
1142 .core = &imx219_core_ops,
1143 .video = &imx219_video_ops,
1144 .pad = &imx219_pad_ops,
1148 static unsigned long imx219_get_pixel_rate(struct imx219 *imx219)
1150 return (imx219->lanes == 2) ? IMX219_PIXEL_RATE : IMX219_PIXEL_RATE_4LANE;
1153 /* Initialize control handlers */
1154 static int imx219_init_controls(struct imx219 *imx219)
1156 struct i2c_client *client = v4l2_get_subdevdata(&imx219->sd);
1157 struct v4l2_ctrl_handler *ctrl_hdlr;
1158 unsigned int height = imx219->mode->height;
1159 struct v4l2_fwnode_device_properties props;
1160 int exposure_max, exposure_def, hblank;
1163 ctrl_hdlr = &imx219->ctrl_handler;
1164 ret = v4l2_ctrl_handler_init(ctrl_hdlr, 12);
1168 /* By default, PIXEL_RATE is read only */
1169 imx219->pixel_rate = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1170 V4L2_CID_PIXEL_RATE,
1171 imx219_get_pixel_rate(imx219),
1172 imx219_get_pixel_rate(imx219), 1,
1173 imx219_get_pixel_rate(imx219));
1176 v4l2_ctrl_new_int_menu(ctrl_hdlr, &imx219_ctrl_ops,
1178 ARRAY_SIZE(imx219_link_freq_menu) - 1, 0,
1179 (imx219->lanes == 2) ? imx219_link_freq_menu :
1180 imx219_link_freq_4lane_menu);
1181 if (imx219->link_freq)
1182 imx219->link_freq->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1184 /* Initial vblank/hblank/exposure parameters based on current mode */
1185 imx219->vblank = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1186 V4L2_CID_VBLANK, IMX219_VBLANK_MIN,
1187 IMX219_VTS_MAX - height, 1,
1188 imx219->mode->vts_def - height);
1189 hblank = IMX219_PPL_DEFAULT - imx219->mode->width;
1190 imx219->hblank = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1191 V4L2_CID_HBLANK, hblank, hblank,
1194 imx219->hblank->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1195 exposure_max = imx219->mode->vts_def - 4;
1196 exposure_def = (exposure_max < IMX219_EXPOSURE_DEFAULT) ?
1197 exposure_max : IMX219_EXPOSURE_DEFAULT;
1198 imx219->exposure = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1200 IMX219_EXPOSURE_MIN, exposure_max,
1201 IMX219_EXPOSURE_STEP,
1204 v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops, V4L2_CID_ANALOGUE_GAIN,
1205 IMX219_ANA_GAIN_MIN, IMX219_ANA_GAIN_MAX,
1206 IMX219_ANA_GAIN_STEP, IMX219_ANA_GAIN_DEFAULT);
1208 v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops, V4L2_CID_DIGITAL_GAIN,
1209 IMX219_DGTL_GAIN_MIN, IMX219_DGTL_GAIN_MAX,
1210 IMX219_DGTL_GAIN_STEP, IMX219_DGTL_GAIN_DEFAULT);
1212 imx219->hflip = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1213 V4L2_CID_HFLIP, 0, 1, 1, 0);
1215 imx219->hflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
1217 imx219->vflip = v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1218 V4L2_CID_VFLIP, 0, 1, 1, 0);
1220 imx219->vflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
1222 v4l2_ctrl_new_std_menu_items(ctrl_hdlr, &imx219_ctrl_ops,
1223 V4L2_CID_TEST_PATTERN,
1224 ARRAY_SIZE(imx219_test_pattern_menu) - 1,
1225 0, 0, imx219_test_pattern_menu);
1226 for (i = 0; i < 4; i++) {
1228 * The assumption is that
1229 * V4L2_CID_TEST_PATTERN_GREENR == V4L2_CID_TEST_PATTERN_RED + 1
1230 * V4L2_CID_TEST_PATTERN_BLUE == V4L2_CID_TEST_PATTERN_RED + 2
1231 * V4L2_CID_TEST_PATTERN_GREENB == V4L2_CID_TEST_PATTERN_RED + 3
1233 v4l2_ctrl_new_std(ctrl_hdlr, &imx219_ctrl_ops,
1234 V4L2_CID_TEST_PATTERN_RED + i,
1235 IMX219_TESTP_COLOUR_MIN,
1236 IMX219_TESTP_COLOUR_MAX,
1237 IMX219_TESTP_COLOUR_STEP,
1238 IMX219_TESTP_COLOUR_MAX);
1239 /* The "Solid color" pattern is white by default */
1242 if (ctrl_hdlr->error) {
1243 ret = ctrl_hdlr->error;
1244 dev_err(&client->dev, "%s control init failed (%d)\n",
1249 ret = v4l2_fwnode_device_parse(&client->dev, &props);
1253 ret = v4l2_ctrl_new_fwnode_properties(ctrl_hdlr, &imx219_ctrl_ops,
1258 imx219->sd.ctrl_handler = ctrl_hdlr;
1263 v4l2_ctrl_handler_free(ctrl_hdlr);
1268 static void imx219_free_controls(struct imx219 *imx219)
1270 v4l2_ctrl_handler_free(imx219->sd.ctrl_handler);
1273 static int imx219_check_hwcfg(struct device *dev, struct imx219 *imx219)
1275 struct fwnode_handle *endpoint;
1276 struct v4l2_fwnode_endpoint ep_cfg = {
1277 .bus_type = V4L2_MBUS_CSI2_DPHY
1281 endpoint = fwnode_graph_get_next_endpoint(dev_fwnode(dev), NULL);
1283 dev_err(dev, "endpoint node not found\n");
1287 if (v4l2_fwnode_endpoint_alloc_parse(endpoint, &ep_cfg)) {
1288 dev_err(dev, "could not parse endpoint\n");
1292 /* Check the number of MIPI CSI2 data lanes */
1293 if (ep_cfg.bus.mipi_csi2.num_data_lanes != 2 &&
1294 ep_cfg.bus.mipi_csi2.num_data_lanes != 4) {
1295 dev_err(dev, "only 2 or 4 data lanes are currently supported\n");
1298 imx219->lanes = ep_cfg.bus.mipi_csi2.num_data_lanes;
1300 /* Check the link frequency set in device tree */
1301 if (!ep_cfg.nr_of_link_frequencies) {
1302 dev_err(dev, "link-frequency property not found in DT\n");
1306 if (ep_cfg.nr_of_link_frequencies != 1 ||
1307 (ep_cfg.link_frequencies[0] != ((imx219->lanes == 2) ?
1308 IMX219_DEFAULT_LINK_FREQ : IMX219_DEFAULT_LINK_FREQ_4LANE))) {
1309 dev_err(dev, "Link frequency not supported: %lld\n",
1310 ep_cfg.link_frequencies[0]);
1317 v4l2_fwnode_endpoint_free(&ep_cfg);
1318 fwnode_handle_put(endpoint);
1323 static int imx219_probe(struct i2c_client *client)
1325 struct device *dev = &client->dev;
1326 struct imx219 *imx219;
1329 imx219 = devm_kzalloc(&client->dev, sizeof(*imx219), GFP_KERNEL);
1333 v4l2_i2c_subdev_init(&imx219->sd, client, &imx219_subdev_ops);
1335 /* Check the hardware configuration in device tree */
1336 if (imx219_check_hwcfg(dev, imx219))
1339 /* Get system clock (xclk) */
1340 imx219->xclk = devm_clk_get(dev, NULL);
1341 if (IS_ERR(imx219->xclk)) {
1342 dev_err(dev, "failed to get xclk\n");
1343 return PTR_ERR(imx219->xclk);
1346 imx219->xclk_freq = clk_get_rate(imx219->xclk);
1347 if (imx219->xclk_freq != IMX219_XCLK_FREQ) {
1348 dev_err(dev, "xclk frequency not supported: %d Hz\n",
1353 ret = imx219_get_regulators(imx219);
1355 dev_err(dev, "failed to get regulators\n");
1359 /* Request optional enable pin */
1360 imx219->reset_gpio = devm_gpiod_get_optional(dev, "reset",
1364 * The sensor must be powered for imx219_identify_module()
1365 * to be able to read the CHIP_ID register
1367 ret = imx219_power_on(dev);
1371 ret = imx219_identify_module(imx219);
1373 goto error_power_off;
1375 /* Set default mode to max resolution */
1376 imx219->mode = &supported_modes[0];
1378 /* sensor doesn't enter LP-11 state upon power up until and unless
1379 * streaming is started, so upon power up switch the modes to:
1380 * streaming -> standby
1382 ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1383 IMX219_REG_VALUE_08BIT, IMX219_MODE_STREAMING);
1385 goto error_power_off;
1386 usleep_range(100, 110);
1388 /* put sensor back to standby mode */
1389 ret = imx219_write_reg(imx219, IMX219_REG_MODE_SELECT,
1390 IMX219_REG_VALUE_08BIT, IMX219_MODE_STANDBY);
1392 goto error_power_off;
1393 usleep_range(100, 110);
1395 ret = imx219_init_controls(imx219);
1397 goto error_power_off;
1399 /* Initialize subdev */
1400 imx219->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE |
1401 V4L2_SUBDEV_FL_HAS_EVENTS;
1402 imx219->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
1404 /* Initialize source pad */
1405 imx219->pad.flags = MEDIA_PAD_FL_SOURCE;
1407 ret = media_entity_pads_init(&imx219->sd.entity, 1, &imx219->pad);
1409 dev_err(dev, "failed to init entity pads: %d\n", ret);
1410 goto error_handler_free;
1413 imx219->sd.state_lock = imx219->ctrl_handler.lock;
1414 ret = v4l2_subdev_init_finalize(&imx219->sd);
1416 dev_err(dev, "subdev init error: %d\n", ret);
1417 goto error_media_entity;
1420 ret = v4l2_async_register_subdev_sensor(&imx219->sd);
1422 dev_err(dev, "failed to register sensor sub-device: %d\n", ret);
1423 goto error_subdev_cleanup;
1426 /* Enable runtime PM and turn off the device */
1427 pm_runtime_set_active(dev);
1428 pm_runtime_enable(dev);
1429 pm_runtime_idle(dev);
1433 error_subdev_cleanup:
1434 v4l2_subdev_cleanup(&imx219->sd);
1437 media_entity_cleanup(&imx219->sd.entity);
1440 imx219_free_controls(imx219);
1443 imx219_power_off(dev);
1448 static void imx219_remove(struct i2c_client *client)
1450 struct v4l2_subdev *sd = i2c_get_clientdata(client);
1451 struct imx219 *imx219 = to_imx219(sd);
1453 v4l2_async_unregister_subdev(sd);
1454 v4l2_subdev_cleanup(sd);
1455 media_entity_cleanup(&sd->entity);
1456 imx219_free_controls(imx219);
1458 pm_runtime_disable(&client->dev);
1459 if (!pm_runtime_status_suspended(&client->dev))
1460 imx219_power_off(&client->dev);
1461 pm_runtime_set_suspended(&client->dev);
1464 static const struct of_device_id imx219_dt_ids[] = {
1465 { .compatible = "sony,imx219" },
1468 MODULE_DEVICE_TABLE(of, imx219_dt_ids);
1470 static const struct dev_pm_ops imx219_pm_ops = {
1471 SET_SYSTEM_SLEEP_PM_OPS(imx219_suspend, imx219_resume)
1472 SET_RUNTIME_PM_OPS(imx219_power_off, imx219_power_on, NULL)
1475 static struct i2c_driver imx219_i2c_driver = {
1478 .of_match_table = imx219_dt_ids,
1479 .pm = &imx219_pm_ops,
1481 .probe = imx219_probe,
1482 .remove = imx219_remove,
1485 module_i2c_driver(imx219_i2c_driver);
1487 MODULE_AUTHOR("Dave Stevenson <dave.stevenson@raspberrypi.com");
1488 MODULE_DESCRIPTION("Sony IMX219 sensor driver");
1489 MODULE_LICENSE("GPL v2");