1 // SPDX-License-Identifier: GPL-2.0-only
3 * Sony imx335 Camera Sensor Driver
5 * Copyright (C) 2021 Intel Corporation
7 #include <asm/unaligned.h>
10 #include <linux/delay.h>
11 #include <linux/i2c.h>
12 #include <linux/module.h>
13 #include <linux/pm_runtime.h>
15 #include <media/v4l2-ctrls.h>
16 #include <media/v4l2-fwnode.h>
17 #include <media/v4l2-subdev.h>
20 #define IMX335_REG_MODE_SELECT 0x3000
21 #define IMX335_MODE_STANDBY 0x01
22 #define IMX335_MODE_STREAMING 0x00
25 #define IMX335_REG_LPFR 0x3030
28 #define IMX335_REG_ID 0x3912
29 #define IMX335_ID 0x00
31 /* Exposure control */
32 #define IMX335_REG_SHUTTER 0x3058
33 #define IMX335_EXPOSURE_MIN 1
34 #define IMX335_EXPOSURE_OFFSET 9
35 #define IMX335_EXPOSURE_STEP 1
36 #define IMX335_EXPOSURE_DEFAULT 0x0648
38 /* Analog gain control */
39 #define IMX335_REG_AGAIN 0x30e8
40 #define IMX335_AGAIN_MIN 0
41 #define IMX335_AGAIN_MAX 240
42 #define IMX335_AGAIN_STEP 1
43 #define IMX335_AGAIN_DEFAULT 0
45 /* Group hold register */
46 #define IMX335_REG_HOLD 0x3001
48 /* Test pattern generator */
49 #define IMX335_REG_TPG 0x329e
50 #define IMX335_TPG_ALL_000 0
51 #define IMX335_TPG_ALL_FFF 1
52 #define IMX335_TPG_ALL_555 2
53 #define IMX335_TPG_ALL_AAA 3
54 #define IMX335_TPG_TOG_555_AAA 4
55 #define IMX335_TPG_TOG_AAA_555 5
56 #define IMX335_TPG_TOG_000_555 6
57 #define IMX335_TPG_TOG_555_000 7
58 #define IMX335_TPG_TOG_000_FFF 8
59 #define IMX335_TPG_TOG_FFF_000 9
60 #define IMX335_TPG_H_COLOR_BARS 10
61 #define IMX335_TPG_V_COLOR_BARS 11
63 /* Input clock rate */
64 #define IMX335_INCLK_RATE 24000000
66 /* CSI2 HW configuration */
67 #define IMX335_LINK_FREQ_594MHz 594000000LL
68 #define IMX335_LINK_FREQ_445MHz 445500000LL
70 #define IMX335_NUM_DATA_LANES 4
72 #define IMX335_REG_MIN 0x00
73 #define IMX335_REG_MAX 0xfffff
75 /* IMX335 native and active pixel array size. */
76 #define IMX335_NATIVE_WIDTH 2616U
77 #define IMX335_NATIVE_HEIGHT 1964U
78 #define IMX335_PIXEL_ARRAY_LEFT 12U
79 #define IMX335_PIXEL_ARRAY_TOP 12U
80 #define IMX335_PIXEL_ARRAY_WIDTH 2592U
81 #define IMX335_PIXEL_ARRAY_HEIGHT 1944U
84 * struct imx335_reg - imx335 sensor register
85 * @address: Register address
86 * @val: Register value
94 * struct imx335_reg_list - imx335 sensor register list
95 * @num_of_regs: Number of registers in the list
96 * @regs: Pointer to register list
98 struct imx335_reg_list {
100 const struct imx335_reg *regs;
103 static const char * const imx335_supply_name[] = {
104 "avdd", /* Analog (2.9V) supply */
105 "ovdd", /* Digital I/O (1.8V) supply */
106 "dvdd", /* Digital Core (1.2V) supply */
110 * struct imx335_mode - imx335 sensor mode structure
111 * @width: Frame width
112 * @height: Frame height
114 * @hblank: Horizontal blanking in lines
115 * @vblank: Vertical blanking in lines
116 * @vblank_min: Minimum vertical blanking in lines
117 * @vblank_max: Maximum vertical blanking in lines
118 * @pclk: Sensor pixel clock
119 * @reg_list: Register list for sensor mode
130 struct imx335_reg_list reg_list;
134 * struct imx335 - imx335 sensor device structure
135 * @dev: Pointer to generic device
136 * @client: Pointer to i2c client
137 * @sd: V4L2 sub-device
138 * @pad: Media pad. Only one pad supported
139 * @reset_gpio: Sensor reset gpio
140 * @supplies: Regulator supplies to handle power control
141 * @inclk: Sensor input clock
142 * @ctrl_handler: V4L2 control handler
143 * @link_freq_ctrl: Pointer to link frequency control
144 * @pclk_ctrl: Pointer to pixel clock control
145 * @hblank_ctrl: Pointer to horizontal blanking control
146 * @vblank_ctrl: Pointer to vertical blanking control
147 * @exp_ctrl: Pointer to exposure control
148 * @again_ctrl: Pointer to analog gain control
149 * @vblank: Vertical blanking in lines
150 * @cur_mode: Pointer to current selected sensor mode
151 * @mutex: Mutex for serializing sensor controls
152 * @link_freq_bitmap: Menu bitmap for link_freq_ctrl
153 * @cur_mbus_code: Currently selected media bus format code
157 struct i2c_client *client;
158 struct v4l2_subdev sd;
159 struct media_pad pad;
160 struct gpio_desc *reset_gpio;
161 struct regulator_bulk_data supplies[ARRAY_SIZE(imx335_supply_name)];
164 struct v4l2_ctrl_handler ctrl_handler;
165 struct v4l2_ctrl *link_freq_ctrl;
166 struct v4l2_ctrl *pclk_ctrl;
167 struct v4l2_ctrl *hblank_ctrl;
168 struct v4l2_ctrl *vblank_ctrl;
170 struct v4l2_ctrl *exp_ctrl;
171 struct v4l2_ctrl *again_ctrl;
174 const struct imx335_mode *cur_mode;
176 unsigned long link_freq_bitmap;
180 static const char * const imx335_tpg_menu[] = {
192 "Horizontal color bars",
193 "Vertical color bars",
196 static const int imx335_tpg_val[] = {
202 IMX335_TPG_TOG_555_AAA,
203 IMX335_TPG_TOG_AAA_555,
204 IMX335_TPG_TOG_000_555,
205 IMX335_TPG_TOG_555_000,
206 IMX335_TPG_TOG_000_FFF,
207 IMX335_TPG_TOG_FFF_000,
208 IMX335_TPG_H_COLOR_BARS,
209 IMX335_TPG_V_COLOR_BARS,
212 /* Sensor mode registers */
213 static const struct imx335_reg mode_2592x1940_regs[] = {
294 static const struct imx335_reg raw10_framefmt_regs[] = {
301 static const struct imx335_reg raw12_framefmt_regs[] = {
308 static const struct imx335_reg mipi_data_rate_1188Mbps[] = {
329 static const struct imx335_reg mipi_data_rate_891Mbps[] = {
349 static const s64 link_freq[] = {
350 /* Corresponds to 1188Mbps data lane rate */
351 IMX335_LINK_FREQ_594MHz,
352 /* Corresponds to 891Mbps data lane rate */
353 IMX335_LINK_FREQ_445MHz,
356 static const struct imx335_reg_list link_freq_reglist[] = {
358 .num_of_regs = ARRAY_SIZE(mipi_data_rate_1188Mbps),
359 .regs = mipi_data_rate_1188Mbps,
362 .num_of_regs = ARRAY_SIZE(mipi_data_rate_891Mbps),
363 .regs = mipi_data_rate_891Mbps,
367 static const u32 imx335_mbus_codes[] = {
368 MEDIA_BUS_FMT_SRGGB12_1X12,
369 MEDIA_BUS_FMT_SRGGB10_1X10,
372 /* Supported sensor mode configurations */
373 static const struct imx335_mode supported_mode = {
379 .vblank_max = 133060,
382 .num_of_regs = ARRAY_SIZE(mode_2592x1940_regs),
383 .regs = mode_2592x1940_regs,
388 * to_imx335() - imx335 V4L2 sub-device to imx335 device.
389 * @subdev: pointer to imx335 V4L2 sub-device
391 * Return: pointer to imx335 device
393 static inline struct imx335 *to_imx335(struct v4l2_subdev *subdev)
395 return container_of(subdev, struct imx335, sd);
399 * imx335_read_reg() - Read registers.
400 * @imx335: pointer to imx335 device
401 * @reg: register address
402 * @len: length of bytes to read. Max supported bytes is 4
403 * @val: pointer to register value to be filled.
405 * Big endian register addresses with little endian values.
407 * Return: 0 if successful, error code otherwise.
409 static int imx335_read_reg(struct imx335 *imx335, u16 reg, u32 len, u32 *val)
411 struct i2c_client *client = v4l2_get_subdevdata(&imx335->sd);
412 struct i2c_msg msgs[2] = {0};
413 u8 addr_buf[2] = {0};
414 u8 data_buf[4] = {0};
417 if (WARN_ON(len > 4))
420 put_unaligned_be16(reg, addr_buf);
422 /* Write register address */
423 msgs[0].addr = client->addr;
425 msgs[0].len = ARRAY_SIZE(addr_buf);
426 msgs[0].buf = addr_buf;
428 /* Read data from register */
429 msgs[1].addr = client->addr;
430 msgs[1].flags = I2C_M_RD;
432 msgs[1].buf = data_buf;
434 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
435 if (ret != ARRAY_SIZE(msgs))
438 *val = get_unaligned_le32(data_buf);
444 * imx335_write_reg() - Write register
445 * @imx335: pointer to imx335 device
446 * @reg: register address
447 * @len: length of bytes. Max supported bytes is 4
448 * @val: register value
450 * Big endian register addresses with little endian values.
452 * Return: 0 if successful, error code otherwise.
454 static int imx335_write_reg(struct imx335 *imx335, u16 reg, u32 len, u32 val)
456 struct i2c_client *client = v4l2_get_subdevdata(&imx335->sd);
459 if (WARN_ON(len > 4))
462 put_unaligned_be16(reg, buf);
463 put_unaligned_le32(val, buf + 2);
464 if (i2c_master_send(client, buf, len + 2) != len + 2)
471 * imx335_write_regs() - Write a list of registers
472 * @imx335: pointer to imx335 device
473 * @regs: list of registers to be written
474 * @len: length of registers array
476 * Return: 0 if successful. error code otherwise.
478 static int imx335_write_regs(struct imx335 *imx335,
479 const struct imx335_reg *regs, u32 len)
484 for (i = 0; i < len; i++) {
485 ret = imx335_write_reg(imx335, regs[i].address, 1, regs[i].val);
494 * imx335_update_controls() - Update control ranges based on streaming mode
495 * @imx335: pointer to imx335 device
496 * @mode: pointer to imx335_mode sensor mode
498 * Return: 0 if successful, error code otherwise.
500 static int imx335_update_controls(struct imx335 *imx335,
501 const struct imx335_mode *mode)
505 ret = __v4l2_ctrl_s_ctrl(imx335->link_freq_ctrl,
506 __ffs(imx335->link_freq_bitmap));
510 ret = __v4l2_ctrl_s_ctrl(imx335->hblank_ctrl, mode->hblank);
514 return __v4l2_ctrl_modify_range(imx335->vblank_ctrl, mode->vblank_min,
515 mode->vblank_max, 1, mode->vblank);
519 * imx335_update_exp_gain() - Set updated exposure and gain
520 * @imx335: pointer to imx335 device
521 * @exposure: updated exposure value
522 * @gain: updated analog gain value
524 * Return: 0 if successful, error code otherwise.
526 static int imx335_update_exp_gain(struct imx335 *imx335, u32 exposure, u32 gain)
531 lpfr = imx335->vblank + imx335->cur_mode->height;
532 shutter = lpfr - exposure;
534 dev_dbg(imx335->dev, "Set exp %u, analog gain %u, shutter %u, lpfr %u\n",
535 exposure, gain, shutter, lpfr);
537 ret = imx335_write_reg(imx335, IMX335_REG_HOLD, 1, 1);
541 ret = imx335_write_reg(imx335, IMX335_REG_LPFR, 3, lpfr);
543 goto error_release_group_hold;
545 ret = imx335_write_reg(imx335, IMX335_REG_SHUTTER, 3, shutter);
547 goto error_release_group_hold;
549 ret = imx335_write_reg(imx335, IMX335_REG_AGAIN, 2, gain);
551 error_release_group_hold:
552 imx335_write_reg(imx335, IMX335_REG_HOLD, 1, 0);
557 static int imx335_update_test_pattern(struct imx335 *imx335, u32 pattern_index)
561 if (pattern_index >= ARRAY_SIZE(imx335_tpg_val))
565 const struct imx335_reg tpg_enable_regs[] = {
575 ret = imx335_write_reg(imx335, IMX335_REG_TPG, 1,
576 imx335_tpg_val[pattern_index]);
580 ret = imx335_write_regs(imx335, tpg_enable_regs,
581 ARRAY_SIZE(tpg_enable_regs));
583 const struct imx335_reg tpg_disable_regs[] = {
593 ret = imx335_write_regs(imx335, tpg_disable_regs,
594 ARRAY_SIZE(tpg_disable_regs));
601 * imx335_set_ctrl() - Set subdevice control
602 * @ctrl: pointer to v4l2_ctrl structure
604 * Supported controls:
606 * - cluster controls:
607 * - V4L2_CID_ANALOGUE_GAIN
608 * - V4L2_CID_EXPOSURE
610 * Return: 0 if successful, error code otherwise.
612 static int imx335_set_ctrl(struct v4l2_ctrl *ctrl)
614 struct imx335 *imx335 =
615 container_of(ctrl->handler, struct imx335, ctrl_handler);
620 /* Propagate change of current control to all related controls */
621 if (ctrl->id == V4L2_CID_VBLANK) {
622 imx335->vblank = imx335->vblank_ctrl->val;
624 dev_dbg(imx335->dev, "Received vblank %u, new lpfr %u\n",
626 imx335->vblank + imx335->cur_mode->height);
628 return __v4l2_ctrl_modify_range(imx335->exp_ctrl,
631 imx335->cur_mode->height -
632 IMX335_EXPOSURE_OFFSET,
633 1, IMX335_EXPOSURE_DEFAULT);
637 * Applying V4L2 control value only happens
638 * when power is up for streaming.
640 if (pm_runtime_get_if_in_use(imx335->dev) == 0)
644 case V4L2_CID_EXPOSURE:
645 exposure = ctrl->val;
646 analog_gain = imx335->again_ctrl->val;
648 dev_dbg(imx335->dev, "Received exp %u, analog gain %u\n",
649 exposure, analog_gain);
651 ret = imx335_update_exp_gain(imx335, exposure, analog_gain);
654 case V4L2_CID_TEST_PATTERN:
655 ret = imx335_update_test_pattern(imx335, ctrl->val);
659 dev_err(imx335->dev, "Invalid control %d\n", ctrl->id);
663 pm_runtime_put(imx335->dev);
668 /* V4l2 subdevice control ops*/
669 static const struct v4l2_ctrl_ops imx335_ctrl_ops = {
670 .s_ctrl = imx335_set_ctrl,
673 static int imx335_get_format_code(struct imx335 *imx335, u32 code)
677 for (i = 0; i < ARRAY_SIZE(imx335_mbus_codes); i++) {
678 if (imx335_mbus_codes[i] == code)
679 return imx335_mbus_codes[i];
682 return imx335_mbus_codes[0];
686 * imx335_enum_mbus_code() - Enumerate V4L2 sub-device mbus codes
687 * @sd: pointer to imx335 V4L2 sub-device structure
688 * @sd_state: V4L2 sub-device configuration
689 * @code: V4L2 sub-device code enumeration need to be filled
691 * Return: 0 if successful, error code otherwise.
693 static int imx335_enum_mbus_code(struct v4l2_subdev *sd,
694 struct v4l2_subdev_state *sd_state,
695 struct v4l2_subdev_mbus_code_enum *code)
697 if (code->index >= ARRAY_SIZE(imx335_mbus_codes))
700 code->code = imx335_mbus_codes[code->index];
706 * imx335_enum_frame_size() - Enumerate V4L2 sub-device frame sizes
707 * @sd: pointer to imx335 V4L2 sub-device structure
708 * @sd_state: V4L2 sub-device configuration
709 * @fsize: V4L2 sub-device size enumeration need to be filled
711 * Return: 0 if successful, error code otherwise.
713 static int imx335_enum_frame_size(struct v4l2_subdev *sd,
714 struct v4l2_subdev_state *sd_state,
715 struct v4l2_subdev_frame_size_enum *fsize)
717 struct imx335 *imx335 = to_imx335(sd);
720 if (fsize->index > ARRAY_SIZE(imx335_mbus_codes))
723 code = imx335_get_format_code(imx335, fsize->code);
724 if (fsize->code != code)
727 fsize->min_width = supported_mode.width;
728 fsize->max_width = fsize->min_width;
729 fsize->min_height = supported_mode.height;
730 fsize->max_height = fsize->min_height;
736 * imx335_fill_pad_format() - Fill subdevice pad format
737 * from selected sensor mode
738 * @imx335: pointer to imx335 device
739 * @mode: pointer to imx335_mode sensor mode
740 * @fmt: V4L2 sub-device format need to be filled
742 static void imx335_fill_pad_format(struct imx335 *imx335,
743 const struct imx335_mode *mode,
744 struct v4l2_subdev_format *fmt)
746 fmt->format.width = mode->width;
747 fmt->format.height = mode->height;
748 fmt->format.code = imx335->cur_mbus_code;
749 fmt->format.field = V4L2_FIELD_NONE;
750 fmt->format.colorspace = V4L2_COLORSPACE_RAW;
751 fmt->format.ycbcr_enc = V4L2_YCBCR_ENC_DEFAULT;
752 fmt->format.quantization = V4L2_QUANTIZATION_DEFAULT;
753 fmt->format.xfer_func = V4L2_XFER_FUNC_NONE;
757 * imx335_get_pad_format() - Get subdevice pad format
758 * @sd: pointer to imx335 V4L2 sub-device structure
759 * @sd_state: V4L2 sub-device configuration
760 * @fmt: V4L2 sub-device format need to be set
762 * Return: 0 if successful, error code otherwise.
764 static int imx335_get_pad_format(struct v4l2_subdev *sd,
765 struct v4l2_subdev_state *sd_state,
766 struct v4l2_subdev_format *fmt)
768 struct imx335 *imx335 = to_imx335(sd);
770 mutex_lock(&imx335->mutex);
772 if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
773 struct v4l2_mbus_framefmt *framefmt;
775 framefmt = v4l2_subdev_state_get_format(sd_state, fmt->pad);
776 fmt->format = *framefmt;
778 imx335_fill_pad_format(imx335, imx335->cur_mode, fmt);
781 mutex_unlock(&imx335->mutex);
787 * imx335_set_pad_format() - Set subdevice pad format
788 * @sd: pointer to imx335 V4L2 sub-device structure
789 * @sd_state: V4L2 sub-device configuration
790 * @fmt: V4L2 sub-device format need to be set
792 * Return: 0 if successful, error code otherwise.
794 static int imx335_set_pad_format(struct v4l2_subdev *sd,
795 struct v4l2_subdev_state *sd_state,
796 struct v4l2_subdev_format *fmt)
798 struct imx335 *imx335 = to_imx335(sd);
799 const struct imx335_mode *mode;
802 mutex_lock(&imx335->mutex);
804 mode = &supported_mode;
805 for (i = 0; i < ARRAY_SIZE(imx335_mbus_codes); i++) {
806 if (imx335_mbus_codes[i] == fmt->format.code)
807 imx335->cur_mbus_code = imx335_mbus_codes[i];
810 imx335_fill_pad_format(imx335, mode, fmt);
812 if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
813 struct v4l2_mbus_framefmt *framefmt;
815 framefmt = v4l2_subdev_state_get_format(sd_state, fmt->pad);
816 *framefmt = fmt->format;
818 ret = imx335_update_controls(imx335, mode);
820 imx335->cur_mode = mode;
823 mutex_unlock(&imx335->mutex);
829 * imx335_init_state() - Initialize sub-device state
830 * @sd: pointer to imx335 V4L2 sub-device structure
831 * @sd_state: V4L2 sub-device configuration
833 * Return: 0 if successful, error code otherwise.
835 static int imx335_init_state(struct v4l2_subdev *sd,
836 struct v4l2_subdev_state *sd_state)
838 struct imx335 *imx335 = to_imx335(sd);
839 struct v4l2_subdev_format fmt = { 0 };
841 fmt.which = sd_state ? V4L2_SUBDEV_FORMAT_TRY : V4L2_SUBDEV_FORMAT_ACTIVE;
842 imx335_fill_pad_format(imx335, &supported_mode, &fmt);
844 mutex_lock(&imx335->mutex);
845 __v4l2_ctrl_modify_range(imx335->link_freq_ctrl, 0,
846 __fls(imx335->link_freq_bitmap),
847 ~(imx335->link_freq_bitmap),
848 __ffs(imx335->link_freq_bitmap));
849 mutex_unlock(&imx335->mutex);
851 return imx335_set_pad_format(sd, sd_state, &fmt);
855 * imx335_get_selection() - Selection API
856 * @sd: pointer to imx335 V4L2 sub-device structure
857 * @sd_state: V4L2 sub-device configuration
858 * @sel: V4L2 selection info
860 * Return: 0 if successful, error code otherwise.
862 static int imx335_get_selection(struct v4l2_subdev *sd,
863 struct v4l2_subdev_state *sd_state,
864 struct v4l2_subdev_selection *sel)
866 switch (sel->target) {
867 case V4L2_SEL_TGT_NATIVE_SIZE:
870 sel->r.width = IMX335_NATIVE_WIDTH;
871 sel->r.height = IMX335_NATIVE_HEIGHT;
875 case V4L2_SEL_TGT_CROP:
876 case V4L2_SEL_TGT_CROP_DEFAULT:
877 case V4L2_SEL_TGT_CROP_BOUNDS:
878 sel->r.top = IMX335_PIXEL_ARRAY_TOP;
879 sel->r.left = IMX335_PIXEL_ARRAY_LEFT;
880 sel->r.width = IMX335_PIXEL_ARRAY_WIDTH;
881 sel->r.height = IMX335_PIXEL_ARRAY_HEIGHT;
889 static int imx335_set_framefmt(struct imx335 *imx335)
891 switch (imx335->cur_mbus_code) {
892 case MEDIA_BUS_FMT_SRGGB10_1X10:
893 return imx335_write_regs(imx335, raw10_framefmt_regs,
894 ARRAY_SIZE(raw10_framefmt_regs));
896 case MEDIA_BUS_FMT_SRGGB12_1X12:
897 return imx335_write_regs(imx335, raw12_framefmt_regs,
898 ARRAY_SIZE(raw12_framefmt_regs));
905 * imx335_start_streaming() - Start sensor stream
906 * @imx335: pointer to imx335 device
908 * Return: 0 if successful, error code otherwise.
910 static int imx335_start_streaming(struct imx335 *imx335)
912 const struct imx335_reg_list *reg_list;
916 reg_list = &link_freq_reglist[__ffs(imx335->link_freq_bitmap)];
917 ret = imx335_write_regs(imx335, reg_list->regs, reg_list->num_of_regs);
919 dev_err(imx335->dev, "%s failed to set plls\n", __func__);
923 /* Write sensor mode registers */
924 reg_list = &imx335->cur_mode->reg_list;
925 ret = imx335_write_regs(imx335, reg_list->regs,
926 reg_list->num_of_regs);
928 dev_err(imx335->dev, "fail to write initial registers\n");
932 ret = imx335_set_framefmt(imx335);
934 dev_err(imx335->dev, "%s failed to set frame format: %d\n",
939 /* Setup handler will write actual exposure and gain */
940 ret = __v4l2_ctrl_handler_setup(imx335->sd.ctrl_handler);
942 dev_err(imx335->dev, "fail to setup handler\n");
946 /* Start streaming */
947 ret = imx335_write_reg(imx335, IMX335_REG_MODE_SELECT,
948 1, IMX335_MODE_STREAMING);
950 dev_err(imx335->dev, "fail to start streaming\n");
954 /* Initial regulator stabilization period */
955 usleep_range(18000, 20000);
961 * imx335_stop_streaming() - Stop sensor stream
962 * @imx335: pointer to imx335 device
964 * Return: 0 if successful, error code otherwise.
966 static int imx335_stop_streaming(struct imx335 *imx335)
968 return imx335_write_reg(imx335, IMX335_REG_MODE_SELECT,
969 1, IMX335_MODE_STANDBY);
973 * imx335_set_stream() - Enable sensor streaming
974 * @sd: pointer to imx335 subdevice
975 * @enable: set to enable sensor streaming
977 * Return: 0 if successful, error code otherwise.
979 static int imx335_set_stream(struct v4l2_subdev *sd, int enable)
981 struct imx335 *imx335 = to_imx335(sd);
984 mutex_lock(&imx335->mutex);
987 ret = pm_runtime_resume_and_get(imx335->dev);
991 ret = imx335_start_streaming(imx335);
993 goto error_power_off;
995 imx335_stop_streaming(imx335);
996 pm_runtime_put(imx335->dev);
999 mutex_unlock(&imx335->mutex);
1004 pm_runtime_put(imx335->dev);
1006 mutex_unlock(&imx335->mutex);
1012 * imx335_detect() - Detect imx335 sensor
1013 * @imx335: pointer to imx335 device
1015 * Return: 0 if successful, -EIO if sensor id does not match
1017 static int imx335_detect(struct imx335 *imx335)
1022 ret = imx335_read_reg(imx335, IMX335_REG_ID, 2, &val);
1026 if (val != IMX335_ID) {
1027 dev_err(imx335->dev, "chip id mismatch: %x!=%x\n",
1036 * imx335_parse_hw_config() - Parse HW configuration and check if supported
1037 * @imx335: pointer to imx335 device
1039 * Return: 0 if successful, error code otherwise.
1041 static int imx335_parse_hw_config(struct imx335 *imx335)
1043 struct fwnode_handle *fwnode = dev_fwnode(imx335->dev);
1044 struct v4l2_fwnode_endpoint bus_cfg = {
1045 .bus_type = V4L2_MBUS_CSI2_DPHY
1047 struct fwnode_handle *ep;
1055 /* Request optional reset pin */
1056 imx335->reset_gpio = devm_gpiod_get_optional(imx335->dev, "reset",
1058 if (IS_ERR(imx335->reset_gpio)) {
1059 dev_err(imx335->dev, "failed to get reset gpio %ld\n",
1060 PTR_ERR(imx335->reset_gpio));
1061 return PTR_ERR(imx335->reset_gpio);
1064 for (i = 0; i < ARRAY_SIZE(imx335_supply_name); i++)
1065 imx335->supplies[i].supply = imx335_supply_name[i];
1067 ret = devm_regulator_bulk_get(imx335->dev,
1068 ARRAY_SIZE(imx335_supply_name),
1071 dev_err(imx335->dev, "Failed to get regulators\n");
1075 /* Get sensor input clock */
1076 imx335->inclk = devm_clk_get(imx335->dev, NULL);
1077 if (IS_ERR(imx335->inclk)) {
1078 dev_err(imx335->dev, "could not get inclk\n");
1079 return PTR_ERR(imx335->inclk);
1082 rate = clk_get_rate(imx335->inclk);
1083 if (rate != IMX335_INCLK_RATE) {
1084 dev_err(imx335->dev, "inclk frequency mismatch\n");
1088 ep = fwnode_graph_get_next_endpoint(fwnode, NULL);
1090 dev_err(imx335->dev, "Failed to get next endpoint\n");
1094 ret = v4l2_fwnode_endpoint_alloc_parse(ep, &bus_cfg);
1095 fwnode_handle_put(ep);
1099 if (bus_cfg.bus.mipi_csi2.num_data_lanes != IMX335_NUM_DATA_LANES) {
1100 dev_err(imx335->dev,
1101 "number of CSI2 data lanes %d is not supported\n",
1102 bus_cfg.bus.mipi_csi2.num_data_lanes);
1104 goto done_endpoint_free;
1107 ret = v4l2_link_freq_to_bitmap(imx335->dev, bus_cfg.link_frequencies,
1108 bus_cfg.nr_of_link_frequencies,
1109 link_freq, ARRAY_SIZE(link_freq),
1110 &imx335->link_freq_bitmap);
1113 v4l2_fwnode_endpoint_free(&bus_cfg);
1118 /* V4l2 subdevice ops */
1119 static const struct v4l2_subdev_video_ops imx335_video_ops = {
1120 .s_stream = imx335_set_stream,
1123 static const struct v4l2_subdev_pad_ops imx335_pad_ops = {
1124 .enum_mbus_code = imx335_enum_mbus_code,
1125 .enum_frame_size = imx335_enum_frame_size,
1126 .get_selection = imx335_get_selection,
1127 .set_selection = imx335_get_selection,
1128 .get_fmt = imx335_get_pad_format,
1129 .set_fmt = imx335_set_pad_format,
1132 static const struct v4l2_subdev_ops imx335_subdev_ops = {
1133 .video = &imx335_video_ops,
1134 .pad = &imx335_pad_ops,
1137 static const struct v4l2_subdev_internal_ops imx335_internal_ops = {
1138 .init_state = imx335_init_state,
1142 * imx335_power_on() - Sensor power on sequence
1143 * @dev: pointer to i2c device
1145 * Return: 0 if successful, error code otherwise.
1147 static int imx335_power_on(struct device *dev)
1149 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1150 struct imx335 *imx335 = to_imx335(sd);
1153 ret = regulator_bulk_enable(ARRAY_SIZE(imx335_supply_name),
1156 dev_err(dev, "%s: failed to enable regulators\n",
1161 usleep_range(500, 550); /* Tlow */
1164 gpiod_set_value_cansleep(imx335->reset_gpio, 1);
1166 ret = clk_prepare_enable(imx335->inclk);
1168 dev_err(imx335->dev, "fail to enable inclk\n");
1172 usleep_range(20, 22); /* T4 */
1177 gpiod_set_value_cansleep(imx335->reset_gpio, 0);
1178 regulator_bulk_disable(ARRAY_SIZE(imx335_supply_name), imx335->supplies);
1184 * imx335_power_off() - Sensor power off sequence
1185 * @dev: pointer to i2c device
1187 * Return: 0 if successful, error code otherwise.
1189 static int imx335_power_off(struct device *dev)
1191 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1192 struct imx335 *imx335 = to_imx335(sd);
1194 gpiod_set_value_cansleep(imx335->reset_gpio, 0);
1195 clk_disable_unprepare(imx335->inclk);
1196 regulator_bulk_disable(ARRAY_SIZE(imx335_supply_name), imx335->supplies);
1202 * imx335_init_controls() - Initialize sensor subdevice controls
1203 * @imx335: pointer to imx335 device
1205 * Return: 0 if successful, error code otherwise.
1207 static int imx335_init_controls(struct imx335 *imx335)
1209 struct v4l2_ctrl_handler *ctrl_hdlr = &imx335->ctrl_handler;
1210 const struct imx335_mode *mode = imx335->cur_mode;
1214 ret = v4l2_ctrl_handler_init(ctrl_hdlr, 7);
1218 /* Serialize controls with sensor device */
1219 ctrl_hdlr->lock = &imx335->mutex;
1221 /* Initialize exposure and gain */
1222 lpfr = mode->vblank + mode->height;
1223 imx335->exp_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1226 IMX335_EXPOSURE_MIN,
1227 lpfr - IMX335_EXPOSURE_OFFSET,
1228 IMX335_EXPOSURE_STEP,
1229 IMX335_EXPOSURE_DEFAULT);
1231 imx335->again_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1233 V4L2_CID_ANALOGUE_GAIN,
1237 IMX335_AGAIN_DEFAULT);
1239 v4l2_ctrl_cluster(2, &imx335->exp_ctrl);
1241 imx335->vblank_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1248 v4l2_ctrl_new_std_menu_items(ctrl_hdlr,
1250 V4L2_CID_TEST_PATTERN,
1251 ARRAY_SIZE(imx335_tpg_menu) - 1,
1252 0, 0, imx335_tpg_menu);
1254 /* Read only controls */
1255 imx335->pclk_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1257 V4L2_CID_PIXEL_RATE,
1258 mode->pclk, mode->pclk,
1261 imx335->link_freq_ctrl = v4l2_ctrl_new_int_menu(ctrl_hdlr,
1264 __fls(imx335->link_freq_bitmap),
1265 __ffs(imx335->link_freq_bitmap),
1267 if (imx335->link_freq_ctrl)
1268 imx335->link_freq_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1270 imx335->hblank_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1276 if (imx335->hblank_ctrl)
1277 imx335->hblank_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1279 if (ctrl_hdlr->error) {
1280 dev_err(imx335->dev, "control init failed: %d\n",
1282 v4l2_ctrl_handler_free(ctrl_hdlr);
1283 return ctrl_hdlr->error;
1286 imx335->sd.ctrl_handler = ctrl_hdlr;
1292 * imx335_probe() - I2C client device binding
1293 * @client: pointer to i2c client device
1295 * Return: 0 if successful, error code otherwise.
1297 static int imx335_probe(struct i2c_client *client)
1299 struct imx335 *imx335;
1302 imx335 = devm_kzalloc(&client->dev, sizeof(*imx335), GFP_KERNEL);
1306 imx335->dev = &client->dev;
1308 /* Initialize subdev */
1309 v4l2_i2c_subdev_init(&imx335->sd, client, &imx335_subdev_ops);
1310 imx335->sd.internal_ops = &imx335_internal_ops;
1312 ret = imx335_parse_hw_config(imx335);
1314 dev_err(imx335->dev, "HW configuration is not supported\n");
1318 mutex_init(&imx335->mutex);
1320 ret = imx335_power_on(imx335->dev);
1322 dev_err(imx335->dev, "failed to power-on the sensor\n");
1323 goto error_mutex_destroy;
1326 /* Check module identity */
1327 ret = imx335_detect(imx335);
1329 dev_err(imx335->dev, "failed to find sensor: %d\n", ret);
1330 goto error_power_off;
1333 /* Set default mode to max resolution */
1334 imx335->cur_mode = &supported_mode;
1335 imx335->cur_mbus_code = imx335_mbus_codes[0];
1336 imx335->vblank = imx335->cur_mode->vblank;
1338 ret = imx335_init_controls(imx335);
1340 dev_err(imx335->dev, "failed to init controls: %d\n", ret);
1341 goto error_power_off;
1344 /* Initialize subdev */
1345 imx335->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
1346 imx335->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
1348 /* Initialize source pad */
1349 imx335->pad.flags = MEDIA_PAD_FL_SOURCE;
1350 ret = media_entity_pads_init(&imx335->sd.entity, 1, &imx335->pad);
1352 dev_err(imx335->dev, "failed to init entity pads: %d\n", ret);
1353 goto error_handler_free;
1356 ret = v4l2_async_register_subdev_sensor(&imx335->sd);
1358 dev_err(imx335->dev,
1359 "failed to register async subdev: %d\n", ret);
1360 goto error_media_entity;
1363 pm_runtime_set_active(imx335->dev);
1364 pm_runtime_enable(imx335->dev);
1365 pm_runtime_idle(imx335->dev);
1370 media_entity_cleanup(&imx335->sd.entity);
1372 v4l2_ctrl_handler_free(imx335->sd.ctrl_handler);
1374 imx335_power_off(imx335->dev);
1375 error_mutex_destroy:
1376 mutex_destroy(&imx335->mutex);
1382 * imx335_remove() - I2C client device unbinding
1383 * @client: pointer to I2C client device
1385 * Return: 0 if successful, error code otherwise.
1387 static void imx335_remove(struct i2c_client *client)
1389 struct v4l2_subdev *sd = i2c_get_clientdata(client);
1390 struct imx335 *imx335 = to_imx335(sd);
1392 v4l2_async_unregister_subdev(sd);
1393 media_entity_cleanup(&sd->entity);
1394 v4l2_ctrl_handler_free(sd->ctrl_handler);
1396 pm_runtime_disable(&client->dev);
1397 if (!pm_runtime_status_suspended(&client->dev))
1398 imx335_power_off(&client->dev);
1399 pm_runtime_set_suspended(&client->dev);
1401 mutex_destroy(&imx335->mutex);
1404 static const struct dev_pm_ops imx335_pm_ops = {
1405 SET_RUNTIME_PM_OPS(imx335_power_off, imx335_power_on, NULL)
1408 static const struct of_device_id imx335_of_match[] = {
1409 { .compatible = "sony,imx335" },
1413 MODULE_DEVICE_TABLE(of, imx335_of_match);
1415 static struct i2c_driver imx335_driver = {
1416 .probe = imx335_probe,
1417 .remove = imx335_remove,
1420 .pm = &imx335_pm_ops,
1421 .of_match_table = imx335_of_match,
1425 module_i2c_driver(imx335_driver);
1427 MODULE_DESCRIPTION("Sony imx335 sensor driver");
1428 MODULE_LICENSE("GPL");