1 // SPDX-License-Identifier: GPL-2.0-only
3 * Sony imx334 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 IMX334_REG_MODE_SELECT 0x3000
21 #define IMX334_MODE_STANDBY 0x01
22 #define IMX334_MODE_STREAMING 0x00
25 #define IMX334_REG_LPFR 0x3030
28 #define IMX334_REG_ID 0x3044
29 #define IMX334_ID 0x1e
31 /* Exposure control */
32 #define IMX334_REG_SHUTTER 0x3058
33 #define IMX334_EXPOSURE_MIN 1
34 #define IMX334_EXPOSURE_OFFSET 5
35 #define IMX334_EXPOSURE_STEP 1
36 #define IMX334_EXPOSURE_DEFAULT 0x0648
38 /* Analog gain control */
39 #define IMX334_REG_AGAIN 0x30e8
40 #define IMX334_AGAIN_MIN 0
41 #define IMX334_AGAIN_MAX 240
42 #define IMX334_AGAIN_STEP 1
43 #define IMX334_AGAIN_DEFAULT 0
45 /* Group hold register */
46 #define IMX334_REG_HOLD 0x3001
48 /* Input clock rate */
49 #define IMX334_INCLK_RATE 24000000
51 /* CSI2 HW configuration */
52 #define IMX334_LINK_FREQ_891M 891000000
53 #define IMX334_LINK_FREQ_445M 445500000
54 #define IMX334_NUM_DATA_LANES 4
56 #define IMX334_REG_MIN 0x00
57 #define IMX334_REG_MAX 0xfffff
60 * struct imx334_reg - imx334 sensor register
61 * @address: Register address
62 * @val: Register value
70 * struct imx334_reg_list - imx334 sensor register list
71 * @num_of_regs: Number of registers in the list
72 * @regs: Pointer to register list
74 struct imx334_reg_list {
76 const struct imx334_reg *regs;
80 * struct imx334_mode - imx334 sensor mode structure
82 * @height: Frame height
83 * @hblank: Horizontal blanking in lines
84 * @vblank: Vertical blanking in lines
85 * @vblank_min: Minimal vertical blanking in lines
86 * @vblank_max: Maximum vertical blanking in lines
87 * @pclk: Sensor pixel clock
88 * @link_freq_idx: Link frequency index
89 * @reg_list: Register list for sensor mode
100 struct imx334_reg_list reg_list;
104 * struct imx334 - imx334 sensor device structure
105 * @dev: Pointer to generic device
106 * @client: Pointer to i2c client
107 * @sd: V4L2 sub-device
108 * @pad: Media pad. Only one pad supported
109 * @reset_gpio: Sensor reset gpio
110 * @inclk: Sensor input clock
111 * @ctrl_handler: V4L2 control handler
112 * @link_freq_ctrl: Pointer to link frequency control
113 * @pclk_ctrl: Pointer to pixel clock control
114 * @hblank_ctrl: Pointer to horizontal blanking control
115 * @vblank_ctrl: Pointer to vertical blanking control
116 * @exp_ctrl: Pointer to exposure control
117 * @again_ctrl: Pointer to analog gain control
118 * @vblank: Vertical blanking in lines
119 * @cur_mode: Pointer to current selected sensor mode
120 * @mutex: Mutex for serializing sensor controls
121 * @menu_skip_mask: Menu skip mask for link_freq_ctrl
122 * @cur_code: current selected format code
123 * @streaming: Flag indicating streaming state
127 struct i2c_client *client;
128 struct v4l2_subdev sd;
129 struct media_pad pad;
130 struct gpio_desc *reset_gpio;
132 struct v4l2_ctrl_handler ctrl_handler;
133 struct v4l2_ctrl *link_freq_ctrl;
134 struct v4l2_ctrl *pclk_ctrl;
135 struct v4l2_ctrl *hblank_ctrl;
136 struct v4l2_ctrl *vblank_ctrl;
138 struct v4l2_ctrl *exp_ctrl;
139 struct v4l2_ctrl *again_ctrl;
142 const struct imx334_mode *cur_mode;
144 unsigned long menu_skip_mask;
149 static const s64 link_freq[] = {
150 IMX334_LINK_FREQ_891M,
151 IMX334_LINK_FREQ_445M,
154 /* Sensor mode registers for 1920x1080@30fps */
155 static const struct imx334_reg mode_1920x1080_regs[] = {
317 /* Sensor mode registers for 3840x2160@30fps */
318 static const struct imx334_reg mode_3840x2160_regs[] = {
433 static const struct imx334_reg raw10_framefmt_regs[] = {
440 static const struct imx334_reg raw12_framefmt_regs[] = {
447 static const u32 imx334_mbus_codes[] = {
448 MEDIA_BUS_FMT_SRGGB12_1X12,
449 MEDIA_BUS_FMT_SRGGB10_1X10,
452 /* Supported sensor mode configurations */
453 static const struct imx334_mode supported_modes[] = {
460 .vblank_max = 132840,
464 .num_of_regs = ARRAY_SIZE(mode_3840x2160_regs),
465 .regs = mode_3840x2160_regs,
473 .vblank_max = 132840,
477 .num_of_regs = ARRAY_SIZE(mode_1920x1080_regs),
478 .regs = mode_1920x1080_regs,
484 * to_imx334() - imv334 V4L2 sub-device to imx334 device.
485 * @subdev: pointer to imx334 V4L2 sub-device
487 * Return: pointer to imx334 device
489 static inline struct imx334 *to_imx334(struct v4l2_subdev *subdev)
491 return container_of(subdev, struct imx334, sd);
495 * imx334_read_reg() - Read registers.
496 * @imx334: pointer to imx334 device
497 * @reg: register address
498 * @len: length of bytes to read. Max supported bytes is 4
499 * @val: pointer to register value to be filled.
501 * Big endian register addresses with little endian values.
503 * Return: 0 if successful, error code otherwise.
505 static int imx334_read_reg(struct imx334 *imx334, u16 reg, u32 len, u32 *val)
507 struct i2c_client *client = v4l2_get_subdevdata(&imx334->sd);
508 struct i2c_msg msgs[2] = {0};
509 u8 addr_buf[2] = {0};
510 u8 data_buf[4] = {0};
513 if (WARN_ON(len > 4))
516 put_unaligned_be16(reg, addr_buf);
518 /* Write register address */
519 msgs[0].addr = client->addr;
521 msgs[0].len = ARRAY_SIZE(addr_buf);
522 msgs[0].buf = addr_buf;
524 /* Read data from register */
525 msgs[1].addr = client->addr;
526 msgs[1].flags = I2C_M_RD;
528 msgs[1].buf = data_buf;
530 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
531 if (ret != ARRAY_SIZE(msgs))
534 *val = get_unaligned_le32(data_buf);
540 * imx334_write_reg() - Write register
541 * @imx334: pointer to imx334 device
542 * @reg: register address
543 * @len: length of bytes. Max supported bytes is 4
544 * @val: register value
546 * Big endian register addresses with little endian values.
548 * Return: 0 if successful, error code otherwise.
550 static int imx334_write_reg(struct imx334 *imx334, u16 reg, u32 len, u32 val)
552 struct i2c_client *client = v4l2_get_subdevdata(&imx334->sd);
555 if (WARN_ON(len > 4))
558 put_unaligned_be16(reg, buf);
559 put_unaligned_le32(val, buf + 2);
560 if (i2c_master_send(client, buf, len + 2) != len + 2)
567 * imx334_write_regs() - Write a list of registers
568 * @imx334: pointer to imx334 device
569 * @regs: list of registers to be written
570 * @len: length of registers array
572 * Return: 0 if successful, error code otherwise.
574 static int imx334_write_regs(struct imx334 *imx334,
575 const struct imx334_reg *regs, u32 len)
580 for (i = 0; i < len; i++) {
581 ret = imx334_write_reg(imx334, regs[i].address, 1, regs[i].val);
590 * imx334_update_controls() - Update control ranges based on streaming mode
591 * @imx334: pointer to imx334 device
592 * @mode: pointer to imx334_mode sensor mode
594 * Return: 0 if successful, error code otherwise.
596 static int imx334_update_controls(struct imx334 *imx334,
597 const struct imx334_mode *mode)
601 ret = __v4l2_ctrl_s_ctrl(imx334->link_freq_ctrl, mode->link_freq_idx);
605 ret = __v4l2_ctrl_modify_range(imx334->pclk_ctrl, mode->pclk,
606 mode->pclk, 1, mode->pclk);
610 ret = __v4l2_ctrl_modify_range(imx334->hblank_ctrl, mode->hblank,
611 mode->hblank, 1, mode->hblank);
615 ret = __v4l2_ctrl_modify_range(imx334->vblank_ctrl, mode->vblank_min,
616 mode->vblank_max, 1, mode->vblank);
620 return __v4l2_ctrl_s_ctrl(imx334->vblank_ctrl, mode->vblank);
624 * imx334_update_exp_gain() - Set updated exposure and gain
625 * @imx334: pointer to imx334 device
626 * @exposure: updated exposure value
627 * @gain: updated analog gain value
629 * Return: 0 if successful, error code otherwise.
631 static int imx334_update_exp_gain(struct imx334 *imx334, u32 exposure, u32 gain)
636 lpfr = imx334->vblank + imx334->cur_mode->height;
637 shutter = lpfr - exposure;
639 dev_dbg(imx334->dev, "Set long exp %u analog gain %u sh0 %u lpfr %u",
640 exposure, gain, shutter, lpfr);
642 ret = imx334_write_reg(imx334, IMX334_REG_HOLD, 1, 1);
646 ret = imx334_write_reg(imx334, IMX334_REG_LPFR, 3, lpfr);
648 goto error_release_group_hold;
650 ret = imx334_write_reg(imx334, IMX334_REG_SHUTTER, 3, shutter);
652 goto error_release_group_hold;
654 ret = imx334_write_reg(imx334, IMX334_REG_AGAIN, 1, gain);
656 error_release_group_hold:
657 imx334_write_reg(imx334, IMX334_REG_HOLD, 1, 0);
663 * imx334_set_ctrl() - Set subdevice control
664 * @ctrl: pointer to v4l2_ctrl structure
666 * Supported controls:
668 * - cluster controls:
669 * - V4L2_CID_ANALOGUE_GAIN
670 * - V4L2_CID_EXPOSURE
672 * Return: 0 if successful, error code otherwise.
674 static int imx334_set_ctrl(struct v4l2_ctrl *ctrl)
676 struct imx334 *imx334 =
677 container_of(ctrl->handler, struct imx334, ctrl_handler);
683 case V4L2_CID_VBLANK:
684 imx334->vblank = imx334->vblank_ctrl->val;
686 dev_dbg(imx334->dev, "Received vblank %u, new lpfr %u",
688 imx334->vblank + imx334->cur_mode->height);
690 ret = __v4l2_ctrl_modify_range(imx334->exp_ctrl,
693 imx334->cur_mode->height -
694 IMX334_EXPOSURE_OFFSET,
695 1, IMX334_EXPOSURE_DEFAULT);
697 case V4L2_CID_EXPOSURE:
699 /* Set controls only if sensor is in power on state */
700 if (!pm_runtime_get_if_in_use(imx334->dev))
703 exposure = ctrl->val;
704 analog_gain = imx334->again_ctrl->val;
706 dev_dbg(imx334->dev, "Received exp %u analog gain %u",
707 exposure, analog_gain);
709 ret = imx334_update_exp_gain(imx334, exposure, analog_gain);
711 pm_runtime_put(imx334->dev);
714 case V4L2_CID_PIXEL_RATE:
715 case V4L2_CID_LINK_FREQ:
716 case V4L2_CID_HBLANK:
720 dev_err(imx334->dev, "Invalid control %d", ctrl->id);
727 /* V4l2 subdevice control ops*/
728 static const struct v4l2_ctrl_ops imx334_ctrl_ops = {
729 .s_ctrl = imx334_set_ctrl,
732 static int imx334_get_format_code(struct imx334 *imx334, u32 code)
736 for (i = 0; i < ARRAY_SIZE(imx334_mbus_codes); i++) {
737 if (imx334_mbus_codes[i] == code)
738 return imx334_mbus_codes[i];
741 return imx334_mbus_codes[0];
745 * imx334_enum_mbus_code() - Enumerate V4L2 sub-device mbus codes
746 * @sd: pointer to imx334 V4L2 sub-device structure
747 * @sd_state: V4L2 sub-device state
748 * @code: V4L2 sub-device code enumeration need to be filled
750 * Return: 0 if successful, error code otherwise.
752 static int imx334_enum_mbus_code(struct v4l2_subdev *sd,
753 struct v4l2_subdev_state *sd_state,
754 struct v4l2_subdev_mbus_code_enum *code)
756 if (code->index >= ARRAY_SIZE(imx334_mbus_codes))
759 code->code = imx334_mbus_codes[code->index];
765 * imx334_enum_frame_size() - Enumerate V4L2 sub-device frame sizes
766 * @sd: pointer to imx334 V4L2 sub-device structure
767 * @sd_state: V4L2 sub-device state
768 * @fsize: V4L2 sub-device size enumeration need to be filled
770 * Return: 0 if successful, error code otherwise.
772 static int imx334_enum_frame_size(struct v4l2_subdev *sd,
773 struct v4l2_subdev_state *sd_state,
774 struct v4l2_subdev_frame_size_enum *fsize)
776 struct imx334 *imx334 = to_imx334(sd);
779 if (fsize->index >= ARRAY_SIZE(supported_modes))
782 code = imx334_get_format_code(imx334, fsize->code);
784 if (fsize->code != code)
787 fsize->min_width = supported_modes[fsize->index].width;
788 fsize->max_width = fsize->min_width;
789 fsize->min_height = supported_modes[fsize->index].height;
790 fsize->max_height = fsize->min_height;
796 * imx334_fill_pad_format() - Fill subdevice pad format
797 * from selected sensor mode
798 * @imx334: pointer to imx334 device
799 * @mode: pointer to imx334_mode sensor mode
800 * @fmt: V4L2 sub-device format need to be filled
802 static void imx334_fill_pad_format(struct imx334 *imx334,
803 const struct imx334_mode *mode,
804 struct v4l2_subdev_format *fmt)
806 fmt->format.width = mode->width;
807 fmt->format.height = mode->height;
808 fmt->format.field = V4L2_FIELD_NONE;
809 fmt->format.colorspace = V4L2_COLORSPACE_RAW;
810 fmt->format.ycbcr_enc = V4L2_YCBCR_ENC_DEFAULT;
811 fmt->format.quantization = V4L2_QUANTIZATION_DEFAULT;
812 fmt->format.xfer_func = V4L2_XFER_FUNC_NONE;
816 * imx334_get_pad_format() - Get subdevice pad format
817 * @sd: pointer to imx334 V4L2 sub-device structure
818 * @sd_state: V4L2 sub-device state
819 * @fmt: V4L2 sub-device format need to be set
821 * Return: 0 if successful, error code otherwise.
823 static int imx334_get_pad_format(struct v4l2_subdev *sd,
824 struct v4l2_subdev_state *sd_state,
825 struct v4l2_subdev_format *fmt)
827 struct imx334 *imx334 = to_imx334(sd);
829 mutex_lock(&imx334->mutex);
831 if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
832 struct v4l2_mbus_framefmt *framefmt;
834 framefmt = v4l2_subdev_get_try_format(sd, sd_state, fmt->pad);
835 fmt->format = *framefmt;
837 fmt->format.code = imx334->cur_code;
838 imx334_fill_pad_format(imx334, imx334->cur_mode, fmt);
841 mutex_unlock(&imx334->mutex);
847 * imx334_set_pad_format() - Set subdevice pad format
848 * @sd: pointer to imx334 V4L2 sub-device structure
849 * @sd_state: V4L2 sub-device state
850 * @fmt: V4L2 sub-device format need to be set
852 * Return: 0 if successful, error code otherwise.
854 static int imx334_set_pad_format(struct v4l2_subdev *sd,
855 struct v4l2_subdev_state *sd_state,
856 struct v4l2_subdev_format *fmt)
858 struct imx334 *imx334 = to_imx334(sd);
859 const struct imx334_mode *mode;
862 mutex_lock(&imx334->mutex);
864 mode = v4l2_find_nearest_size(supported_modes,
865 ARRAY_SIZE(supported_modes),
867 fmt->format.width, fmt->format.height);
869 imx334_fill_pad_format(imx334, mode, fmt);
870 fmt->format.code = imx334_get_format_code(imx334, fmt->format.code);
872 if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
873 struct v4l2_mbus_framefmt *framefmt;
875 framefmt = v4l2_subdev_get_try_format(sd, sd_state, fmt->pad);
876 *framefmt = fmt->format;
877 } else if (imx334->cur_mode != mode || imx334->cur_code != fmt->format.code) {
878 imx334->cur_code = fmt->format.code;
879 ret = imx334_update_controls(imx334, mode);
881 imx334->cur_mode = mode;
884 mutex_unlock(&imx334->mutex);
890 * imx334_init_pad_cfg() - Initialize sub-device pad configuration
891 * @sd: pointer to imx334 V4L2 sub-device structure
892 * @sd_state: V4L2 sub-device state
894 * Return: 0 if successful, error code otherwise.
896 static int imx334_init_pad_cfg(struct v4l2_subdev *sd,
897 struct v4l2_subdev_state *sd_state)
899 struct imx334 *imx334 = to_imx334(sd);
900 struct v4l2_subdev_format fmt = { 0 };
902 fmt.which = sd_state ? V4L2_SUBDEV_FORMAT_TRY : V4L2_SUBDEV_FORMAT_ACTIVE;
904 mutex_lock(&imx334->mutex);
906 imx334_fill_pad_format(imx334, imx334->cur_mode, &fmt);
908 __v4l2_ctrl_modify_range(imx334->link_freq_ctrl, 0,
909 __fls(imx334->menu_skip_mask),
910 ~(imx334->menu_skip_mask),
911 __ffs(imx334->menu_skip_mask));
913 mutex_unlock(&imx334->mutex);
915 return imx334_set_pad_format(sd, sd_state, &fmt);
918 static int imx334_set_framefmt(struct imx334 *imx334)
920 switch (imx334->cur_code) {
921 case MEDIA_BUS_FMT_SRGGB10_1X10:
922 return imx334_write_regs(imx334, raw10_framefmt_regs,
923 ARRAY_SIZE(raw10_framefmt_regs));
925 case MEDIA_BUS_FMT_SRGGB12_1X12:
926 return imx334_write_regs(imx334, raw12_framefmt_regs,
927 ARRAY_SIZE(raw12_framefmt_regs));
934 * imx334_start_streaming() - Start sensor stream
935 * @imx334: pointer to imx334 device
937 * Return: 0 if successful, error code otherwise.
939 static int imx334_start_streaming(struct imx334 *imx334)
941 const struct imx334_reg_list *reg_list;
944 /* Write sensor mode registers */
945 reg_list = &imx334->cur_mode->reg_list;
946 ret = imx334_write_regs(imx334, reg_list->regs,
947 reg_list->num_of_regs);
949 dev_err(imx334->dev, "fail to write initial registers");
953 ret = imx334_set_framefmt(imx334);
955 dev_err(imx334->dev, "%s failed to set frame format: %d\n",
960 /* Setup handler will write actual exposure and gain */
961 ret = __v4l2_ctrl_handler_setup(imx334->sd.ctrl_handler);
963 dev_err(imx334->dev, "fail to setup handler");
967 /* Start streaming */
968 ret = imx334_write_reg(imx334, IMX334_REG_MODE_SELECT,
969 1, IMX334_MODE_STREAMING);
971 dev_err(imx334->dev, "fail to start streaming");
979 * imx334_stop_streaming() - Stop sensor stream
980 * @imx334: pointer to imx334 device
982 * Return: 0 if successful, error code otherwise.
984 static int imx334_stop_streaming(struct imx334 *imx334)
986 return imx334_write_reg(imx334, IMX334_REG_MODE_SELECT,
987 1, IMX334_MODE_STANDBY);
991 * imx334_set_stream() - Enable sensor streaming
992 * @sd: pointer to imx334 subdevice
993 * @enable: set to enable sensor streaming
995 * Return: 0 if successful, error code otherwise.
997 static int imx334_set_stream(struct v4l2_subdev *sd, int enable)
999 struct imx334 *imx334 = to_imx334(sd);
1002 mutex_lock(&imx334->mutex);
1004 if (imx334->streaming == enable) {
1005 mutex_unlock(&imx334->mutex);
1010 ret = pm_runtime_resume_and_get(imx334->dev);
1014 ret = imx334_start_streaming(imx334);
1016 goto error_power_off;
1018 imx334_stop_streaming(imx334);
1019 pm_runtime_put(imx334->dev);
1022 imx334->streaming = enable;
1024 mutex_unlock(&imx334->mutex);
1029 pm_runtime_put(imx334->dev);
1031 mutex_unlock(&imx334->mutex);
1037 * imx334_detect() - Detect imx334 sensor
1038 * @imx334: pointer to imx334 device
1040 * Return: 0 if successful, -EIO if sensor id does not match
1042 static int imx334_detect(struct imx334 *imx334)
1047 ret = imx334_read_reg(imx334, IMX334_REG_ID, 2, &val);
1051 if (val != IMX334_ID) {
1052 dev_err(imx334->dev, "chip id mismatch: %x!=%x",
1061 * imx334_parse_hw_config() - Parse HW configuration and check if supported
1062 * @imx334: pointer to imx334 device
1064 * Return: 0 if successful, error code otherwise.
1066 static int imx334_parse_hw_config(struct imx334 *imx334)
1068 struct fwnode_handle *fwnode = dev_fwnode(imx334->dev);
1069 struct v4l2_fwnode_endpoint bus_cfg = {
1070 .bus_type = V4L2_MBUS_CSI2_DPHY
1072 struct fwnode_handle *ep;
1080 /* Request optional reset pin */
1081 imx334->reset_gpio = devm_gpiod_get_optional(imx334->dev, "reset",
1083 if (IS_ERR(imx334->reset_gpio)) {
1084 dev_err(imx334->dev, "failed to get reset gpio %ld",
1085 PTR_ERR(imx334->reset_gpio));
1086 return PTR_ERR(imx334->reset_gpio);
1089 /* Get sensor input clock */
1090 imx334->inclk = devm_clk_get(imx334->dev, NULL);
1091 if (IS_ERR(imx334->inclk)) {
1092 dev_err(imx334->dev, "could not get inclk");
1093 return PTR_ERR(imx334->inclk);
1096 rate = clk_get_rate(imx334->inclk);
1097 if (rate != IMX334_INCLK_RATE) {
1098 dev_err(imx334->dev, "inclk frequency mismatch");
1102 ep = fwnode_graph_get_next_endpoint(fwnode, NULL);
1106 ret = v4l2_fwnode_endpoint_alloc_parse(ep, &bus_cfg);
1107 fwnode_handle_put(ep);
1111 if (bus_cfg.bus.mipi_csi2.num_data_lanes != IMX334_NUM_DATA_LANES) {
1112 dev_err(imx334->dev,
1113 "number of CSI2 data lanes %d is not supported",
1114 bus_cfg.bus.mipi_csi2.num_data_lanes);
1116 goto done_endpoint_free;
1119 if (!bus_cfg.nr_of_link_frequencies) {
1120 dev_err(imx334->dev, "no link frequencies defined");
1122 goto done_endpoint_free;
1125 for (i = 0; i < bus_cfg.nr_of_link_frequencies; i++) {
1126 for (j = 0; j < ARRAY_SIZE(link_freq); j++) {
1127 if (bus_cfg.link_frequencies[i] == link_freq[j]) {
1128 set_bit(j, &imx334->menu_skip_mask);
1133 if (j == ARRAY_SIZE(link_freq)) {
1134 ret = dev_err_probe(imx334->dev, -EINVAL,
1135 "no supported link freq found\n");
1136 goto done_endpoint_free;
1141 v4l2_fwnode_endpoint_free(&bus_cfg);
1146 /* V4l2 subdevice ops */
1147 static const struct v4l2_subdev_video_ops imx334_video_ops = {
1148 .s_stream = imx334_set_stream,
1151 static const struct v4l2_subdev_pad_ops imx334_pad_ops = {
1152 .init_cfg = imx334_init_pad_cfg,
1153 .enum_mbus_code = imx334_enum_mbus_code,
1154 .enum_frame_size = imx334_enum_frame_size,
1155 .get_fmt = imx334_get_pad_format,
1156 .set_fmt = imx334_set_pad_format,
1159 static const struct v4l2_subdev_ops imx334_subdev_ops = {
1160 .video = &imx334_video_ops,
1161 .pad = &imx334_pad_ops,
1165 * imx334_power_on() - Sensor power on sequence
1166 * @dev: pointer to i2c device
1168 * Return: 0 if successful, error code otherwise.
1170 static int imx334_power_on(struct device *dev)
1172 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1173 struct imx334 *imx334 = to_imx334(sd);
1176 gpiod_set_value_cansleep(imx334->reset_gpio, 1);
1178 ret = clk_prepare_enable(imx334->inclk);
1180 dev_err(imx334->dev, "fail to enable inclk");
1184 usleep_range(18000, 20000);
1189 gpiod_set_value_cansleep(imx334->reset_gpio, 0);
1195 * imx334_power_off() - Sensor power off sequence
1196 * @dev: pointer to i2c device
1198 * Return: 0 if successful, error code otherwise.
1200 static int imx334_power_off(struct device *dev)
1202 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1203 struct imx334 *imx334 = to_imx334(sd);
1205 gpiod_set_value_cansleep(imx334->reset_gpio, 0);
1207 clk_disable_unprepare(imx334->inclk);
1213 * imx334_init_controls() - Initialize sensor subdevice controls
1214 * @imx334: pointer to imx334 device
1216 * Return: 0 if successful, error code otherwise.
1218 static int imx334_init_controls(struct imx334 *imx334)
1220 struct v4l2_ctrl_handler *ctrl_hdlr = &imx334->ctrl_handler;
1221 const struct imx334_mode *mode = imx334->cur_mode;
1225 ret = v4l2_ctrl_handler_init(ctrl_hdlr, 6);
1229 /* Serialize controls with sensor device */
1230 ctrl_hdlr->lock = &imx334->mutex;
1232 /* Initialize exposure and gain */
1233 lpfr = mode->vblank + mode->height;
1234 imx334->exp_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1237 IMX334_EXPOSURE_MIN,
1238 lpfr - IMX334_EXPOSURE_OFFSET,
1239 IMX334_EXPOSURE_STEP,
1240 IMX334_EXPOSURE_DEFAULT);
1242 imx334->again_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1244 V4L2_CID_ANALOGUE_GAIN,
1248 IMX334_AGAIN_DEFAULT);
1250 v4l2_ctrl_cluster(2, &imx334->exp_ctrl);
1252 imx334->vblank_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1259 /* Read only controls */
1260 imx334->pclk_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1262 V4L2_CID_PIXEL_RATE,
1263 mode->pclk, mode->pclk,
1266 imx334->link_freq_ctrl = v4l2_ctrl_new_int_menu(ctrl_hdlr,
1269 __fls(imx334->menu_skip_mask),
1270 __ffs(imx334->menu_skip_mask),
1273 if (imx334->link_freq_ctrl)
1274 imx334->link_freq_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1276 imx334->hblank_ctrl = v4l2_ctrl_new_std(ctrl_hdlr,
1282 if (imx334->hblank_ctrl)
1283 imx334->hblank_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1285 if (ctrl_hdlr->error) {
1286 dev_err(imx334->dev, "control init failed: %d",
1288 v4l2_ctrl_handler_free(ctrl_hdlr);
1289 return ctrl_hdlr->error;
1292 imx334->sd.ctrl_handler = ctrl_hdlr;
1298 * imx334_probe() - I2C client device binding
1299 * @client: pointer to i2c client device
1301 * Return: 0 if successful, error code otherwise.
1303 static int imx334_probe(struct i2c_client *client)
1305 struct imx334 *imx334;
1308 imx334 = devm_kzalloc(&client->dev, sizeof(*imx334), GFP_KERNEL);
1312 imx334->dev = &client->dev;
1314 /* Initialize subdev */
1315 v4l2_i2c_subdev_init(&imx334->sd, client, &imx334_subdev_ops);
1317 ret = imx334_parse_hw_config(imx334);
1319 dev_err(imx334->dev, "HW configuration is not supported");
1323 mutex_init(&imx334->mutex);
1325 ret = imx334_power_on(imx334->dev);
1327 dev_err(imx334->dev, "failed to power-on the sensor");
1328 goto error_mutex_destroy;
1331 /* Check module identity */
1332 ret = imx334_detect(imx334);
1334 dev_err(imx334->dev, "failed to find sensor: %d", ret);
1335 goto error_power_off;
1338 /* Set default mode to max resolution */
1339 imx334->cur_mode = &supported_modes[__ffs(imx334->menu_skip_mask)];
1340 imx334->cur_code = imx334_mbus_codes[0];
1341 imx334->vblank = imx334->cur_mode->vblank;
1343 ret = imx334_init_controls(imx334);
1345 dev_err(imx334->dev, "failed to init controls: %d", ret);
1346 goto error_power_off;
1349 /* Initialize subdev */
1350 imx334->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
1351 imx334->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
1353 /* Initialize source pad */
1354 imx334->pad.flags = MEDIA_PAD_FL_SOURCE;
1355 ret = media_entity_pads_init(&imx334->sd.entity, 1, &imx334->pad);
1357 dev_err(imx334->dev, "failed to init entity pads: %d", ret);
1358 goto error_handler_free;
1361 ret = v4l2_async_register_subdev_sensor(&imx334->sd);
1363 dev_err(imx334->dev,
1364 "failed to register async subdev: %d", ret);
1365 goto error_media_entity;
1368 pm_runtime_set_active(imx334->dev);
1369 pm_runtime_enable(imx334->dev);
1370 pm_runtime_idle(imx334->dev);
1375 media_entity_cleanup(&imx334->sd.entity);
1377 v4l2_ctrl_handler_free(imx334->sd.ctrl_handler);
1379 imx334_power_off(imx334->dev);
1380 error_mutex_destroy:
1381 mutex_destroy(&imx334->mutex);
1387 * imx334_remove() - I2C client device unbinding
1388 * @client: pointer to I2C client device
1390 * Return: 0 if successful, error code otherwise.
1392 static void imx334_remove(struct i2c_client *client)
1394 struct v4l2_subdev *sd = i2c_get_clientdata(client);
1395 struct imx334 *imx334 = to_imx334(sd);
1397 v4l2_async_unregister_subdev(sd);
1398 media_entity_cleanup(&sd->entity);
1399 v4l2_ctrl_handler_free(sd->ctrl_handler);
1401 pm_runtime_disable(&client->dev);
1402 pm_runtime_suspended(&client->dev);
1404 mutex_destroy(&imx334->mutex);
1407 static const struct dev_pm_ops imx334_pm_ops = {
1408 SET_RUNTIME_PM_OPS(imx334_power_off, imx334_power_on, NULL)
1411 static const struct of_device_id imx334_of_match[] = {
1412 { .compatible = "sony,imx334" },
1416 MODULE_DEVICE_TABLE(of, imx334_of_match);
1418 static struct i2c_driver imx334_driver = {
1419 .probe = imx334_probe,
1420 .remove = imx334_remove,
1423 .pm = &imx334_pm_ops,
1424 .of_match_table = imx334_of_match,
1428 module_i2c_driver(imx334_driver);
1430 MODULE_DESCRIPTION("Sony imx334 sensor driver");
1431 MODULE_LICENSE("GPL");