1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (C) 2018 Intel Corporation
4 #include <linux/acpi.h>
6 #include <linux/delay.h>
8 #include <linux/module.h>
9 #include <linux/pm_runtime.h>
10 #include <media/v4l2-ctrls.h>
11 #include <media/v4l2-device.h>
12 #include <media/v4l2-fwnode.h>
13 #include <asm/unaligned.h>
15 #define IMX258_REG_VALUE_08BIT 1
16 #define IMX258_REG_VALUE_16BIT 2
18 #define IMX258_REG_MODE_SELECT 0x0100
19 #define IMX258_MODE_STANDBY 0x00
20 #define IMX258_MODE_STREAMING 0x01
23 #define IMX258_REG_CHIP_ID 0x0016
24 #define IMX258_CHIP_ID 0x0258
26 /* V_TIMING internal */
27 #define IMX258_VTS_30FPS 0x0c50
28 #define IMX258_VTS_30FPS_2K 0x0638
29 #define IMX258_VTS_30FPS_VGA 0x034c
30 #define IMX258_VTS_MAX 0xffff
33 #define IMX258_FLL_MIN 0x08a6
34 #define IMX258_FLL_MAX 0xffff
35 #define IMX258_FLL_STEP 1
36 #define IMX258_FLL_DEFAULT 0x0c98
38 /* HBLANK control - read only */
39 #define IMX258_PPL_DEFAULT 5352
41 /* Exposure control */
42 #define IMX258_REG_EXPOSURE 0x0202
43 #define IMX258_EXPOSURE_MIN 4
44 #define IMX258_EXPOSURE_STEP 1
45 #define IMX258_EXPOSURE_DEFAULT 0x640
46 #define IMX258_EXPOSURE_MAX 65535
48 /* Analog gain control */
49 #define IMX258_REG_ANALOG_GAIN 0x0204
50 #define IMX258_ANA_GAIN_MIN 0
51 #define IMX258_ANA_GAIN_MAX 480
52 #define IMX258_ANA_GAIN_STEP 1
53 #define IMX258_ANA_GAIN_DEFAULT 0x0
55 /* Digital gain control */
56 #define IMX258_REG_GR_DIGITAL_GAIN 0x020e
57 #define IMX258_REG_R_DIGITAL_GAIN 0x0210
58 #define IMX258_REG_B_DIGITAL_GAIN 0x0212
59 #define IMX258_REG_GB_DIGITAL_GAIN 0x0214
60 #define IMX258_DGTL_GAIN_MIN 0
61 #define IMX258_DGTL_GAIN_MAX 4096 /* Max = 0xFFF */
62 #define IMX258_DGTL_GAIN_DEFAULT 1024
63 #define IMX258_DGTL_GAIN_STEP 1
66 #define IMX258_REG_HDR 0x0220
67 #define IMX258_HDR_ON BIT(0)
68 #define IMX258_REG_HDR_RATIO 0x0222
69 #define IMX258_HDR_RATIO_MIN 0
70 #define IMX258_HDR_RATIO_MAX 5
71 #define IMX258_HDR_RATIO_STEP 1
72 #define IMX258_HDR_RATIO_DEFAULT 0x0
74 /* Test Pattern Control */
75 #define IMX258_REG_TEST_PATTERN 0x0600
78 #define REG_MIRROR_FLIP_CONTROL 0x0101
79 #define REG_CONFIG_MIRROR_FLIP 0x03
80 #define REG_CONFIG_FLIP_TEST_PATTERN 0x02
82 /* Input clock frequency in Hz */
83 #define IMX258_INPUT_CLOCK_FREQ 19200000
90 struct imx258_reg_list {
92 const struct imx258_reg *regs;
95 /* Link frequency config */
96 struct imx258_link_freq_config {
99 /* PLL registers for this link frequency */
100 struct imx258_reg_list reg_list;
103 /* Mode : resolution and related config&values */
114 /* Index of Link frequency config to be used */
116 /* Default register values */
117 struct imx258_reg_list reg_list;
120 /* 4208x3118 needs 1267Mbps/lane, 4 lanes */
121 static const struct imx258_reg mipi_data_rate_1267mbps[] = {
139 static const struct imx258_reg mipi_data_rate_640mbps[] = {
157 static const struct imx258_reg mode_4208x3118_regs[] = {
276 static const struct imx258_reg mode_2104_1560_regs[] = {
395 static const struct imx258_reg mode_1048_780_regs[] = {
514 static const char * const imx258_test_pattern_menu[] = {
517 "Eight Vertical Colour Bars",
518 "Colour Bars With Fade to Grey",
519 "Pseudorandom Sequence (PN9)",
522 /* Configurations for supported link frequencies */
523 #define IMX258_LINK_FREQ_634MHZ 633600000ULL
524 #define IMX258_LINK_FREQ_320MHZ 320000000ULL
527 IMX258_LINK_FREQ_1267MBPS,
528 IMX258_LINK_FREQ_640MBPS,
532 * pixel_rate = link_freq * data-rate * nr_of_lanes / bits_per_sample
533 * data rate => double data rate; number of lanes => 4; bits per pixel => 10
535 static u64 link_freq_to_pixel_rate(u64 f)
543 /* Menu items for LINK_FREQ V4L2 control */
544 static const s64 link_freq_menu_items[] = {
545 IMX258_LINK_FREQ_634MHZ,
546 IMX258_LINK_FREQ_320MHZ,
549 /* Link frequency configs */
550 static const struct imx258_link_freq_config link_freq_configs[] = {
551 [IMX258_LINK_FREQ_1267MBPS] = {
552 .pixels_per_line = IMX258_PPL_DEFAULT,
554 .num_of_regs = ARRAY_SIZE(mipi_data_rate_1267mbps),
555 .regs = mipi_data_rate_1267mbps,
558 [IMX258_LINK_FREQ_640MBPS] = {
559 .pixels_per_line = IMX258_PPL_DEFAULT,
561 .num_of_regs = ARRAY_SIZE(mipi_data_rate_640mbps),
562 .regs = mipi_data_rate_640mbps,
568 static const struct imx258_mode supported_modes[] = {
572 .vts_def = IMX258_VTS_30FPS,
573 .vts_min = IMX258_VTS_30FPS,
575 .num_of_regs = ARRAY_SIZE(mode_4208x3118_regs),
576 .regs = mode_4208x3118_regs,
578 .link_freq_index = IMX258_LINK_FREQ_1267MBPS,
583 .vts_def = IMX258_VTS_30FPS_2K,
584 .vts_min = IMX258_VTS_30FPS_2K,
586 .num_of_regs = ARRAY_SIZE(mode_2104_1560_regs),
587 .regs = mode_2104_1560_regs,
589 .link_freq_index = IMX258_LINK_FREQ_640MBPS,
594 .vts_def = IMX258_VTS_30FPS_VGA,
595 .vts_min = IMX258_VTS_30FPS_VGA,
597 .num_of_regs = ARRAY_SIZE(mode_1048_780_regs),
598 .regs = mode_1048_780_regs,
600 .link_freq_index = IMX258_LINK_FREQ_640MBPS,
605 struct v4l2_subdev sd;
606 struct media_pad pad;
608 struct v4l2_ctrl_handler ctrl_handler;
610 struct v4l2_ctrl *link_freq;
611 struct v4l2_ctrl *pixel_rate;
612 struct v4l2_ctrl *vblank;
613 struct v4l2_ctrl *hblank;
614 struct v4l2_ctrl *exposure;
617 const struct imx258_mode *cur_mode;
620 * Mutex for serialized access:
621 * Protect sensor module set pad format and start/stop streaming safely.
628 static inline struct imx258 *to_imx258(struct v4l2_subdev *_sd)
630 return container_of(_sd, struct imx258, sd);
633 /* Read registers up to 2 at a time */
634 static int imx258_read_reg(struct imx258 *imx258, u16 reg, u32 len, u32 *val)
636 struct i2c_client *client = v4l2_get_subdevdata(&imx258->sd);
637 struct i2c_msg msgs[2];
638 u8 addr_buf[2] = { reg >> 8, reg & 0xff };
639 u8 data_buf[4] = { 0, };
645 /* Write register address */
646 msgs[0].addr = client->addr;
648 msgs[0].len = ARRAY_SIZE(addr_buf);
649 msgs[0].buf = addr_buf;
651 /* Read data from register */
652 msgs[1].addr = client->addr;
653 msgs[1].flags = I2C_M_RD;
655 msgs[1].buf = &data_buf[4 - len];
657 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
658 if (ret != ARRAY_SIZE(msgs))
661 *val = get_unaligned_be32(data_buf);
666 /* Write registers up to 2 at a time */
667 static int imx258_write_reg(struct imx258 *imx258, u16 reg, u32 len, u32 val)
669 struct i2c_client *client = v4l2_get_subdevdata(&imx258->sd);
675 put_unaligned_be16(reg, buf);
676 put_unaligned_be32(val << (8 * (4 - len)), buf + 2);
677 if (i2c_master_send(client, buf, len + 2) != len + 2)
683 /* Write a list of registers */
684 static int imx258_write_regs(struct imx258 *imx258,
685 const struct imx258_reg *regs, u32 len)
687 struct i2c_client *client = v4l2_get_subdevdata(&imx258->sd);
691 for (i = 0; i < len; i++) {
692 ret = imx258_write_reg(imx258, regs[i].address, 1,
697 "Failed to write reg 0x%4.4x. error = %d\n",
698 regs[i].address, ret);
707 /* Open sub-device */
708 static int imx258_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
710 struct v4l2_mbus_framefmt *try_fmt =
711 v4l2_subdev_state_get_format(fh->state, 0);
713 /* Initialize try_fmt */
714 try_fmt->width = supported_modes[0].width;
715 try_fmt->height = supported_modes[0].height;
716 try_fmt->code = MEDIA_BUS_FMT_SGRBG10_1X10;
717 try_fmt->field = V4L2_FIELD_NONE;
722 static int imx258_update_digital_gain(struct imx258 *imx258, u32 len, u32 val)
726 ret = imx258_write_reg(imx258, IMX258_REG_GR_DIGITAL_GAIN,
727 IMX258_REG_VALUE_16BIT,
731 ret = imx258_write_reg(imx258, IMX258_REG_GB_DIGITAL_GAIN,
732 IMX258_REG_VALUE_16BIT,
736 ret = imx258_write_reg(imx258, IMX258_REG_R_DIGITAL_GAIN,
737 IMX258_REG_VALUE_16BIT,
741 ret = imx258_write_reg(imx258, IMX258_REG_B_DIGITAL_GAIN,
742 IMX258_REG_VALUE_16BIT,
749 static int imx258_set_ctrl(struct v4l2_ctrl *ctrl)
751 struct imx258 *imx258 =
752 container_of(ctrl->handler, struct imx258, ctrl_handler);
753 struct i2c_client *client = v4l2_get_subdevdata(&imx258->sd);
757 * Applying V4L2 control value only happens
758 * when power is up for streaming
760 if (pm_runtime_get_if_in_use(&client->dev) == 0)
764 case V4L2_CID_ANALOGUE_GAIN:
765 ret = imx258_write_reg(imx258, IMX258_REG_ANALOG_GAIN,
766 IMX258_REG_VALUE_16BIT,
769 case V4L2_CID_EXPOSURE:
770 ret = imx258_write_reg(imx258, IMX258_REG_EXPOSURE,
771 IMX258_REG_VALUE_16BIT,
774 case V4L2_CID_DIGITAL_GAIN:
775 ret = imx258_update_digital_gain(imx258, IMX258_REG_VALUE_16BIT,
778 case V4L2_CID_TEST_PATTERN:
779 ret = imx258_write_reg(imx258, IMX258_REG_TEST_PATTERN,
780 IMX258_REG_VALUE_16BIT,
782 ret = imx258_write_reg(imx258, REG_MIRROR_FLIP_CONTROL,
783 IMX258_REG_VALUE_08BIT,
784 !ctrl->val ? REG_CONFIG_MIRROR_FLIP :
785 REG_CONFIG_FLIP_TEST_PATTERN);
787 case V4L2_CID_WIDE_DYNAMIC_RANGE:
789 ret = imx258_write_reg(imx258, IMX258_REG_HDR,
790 IMX258_REG_VALUE_08BIT,
791 IMX258_HDR_RATIO_MIN);
793 ret = imx258_write_reg(imx258, IMX258_REG_HDR,
794 IMX258_REG_VALUE_08BIT,
798 ret = imx258_write_reg(imx258, IMX258_REG_HDR_RATIO,
799 IMX258_REG_VALUE_08BIT,
800 BIT(IMX258_HDR_RATIO_MAX));
804 dev_info(&client->dev,
805 "ctrl(id:0x%x,val:0x%x) is not handled\n",
806 ctrl->id, ctrl->val);
811 pm_runtime_put(&client->dev);
816 static const struct v4l2_ctrl_ops imx258_ctrl_ops = {
817 .s_ctrl = imx258_set_ctrl,
820 static int imx258_enum_mbus_code(struct v4l2_subdev *sd,
821 struct v4l2_subdev_state *sd_state,
822 struct v4l2_subdev_mbus_code_enum *code)
824 /* Only one bayer order(GRBG) is supported */
828 code->code = MEDIA_BUS_FMT_SGRBG10_1X10;
833 static int imx258_enum_frame_size(struct v4l2_subdev *sd,
834 struct v4l2_subdev_state *sd_state,
835 struct v4l2_subdev_frame_size_enum *fse)
837 if (fse->index >= ARRAY_SIZE(supported_modes))
840 if (fse->code != MEDIA_BUS_FMT_SGRBG10_1X10)
843 fse->min_width = supported_modes[fse->index].width;
844 fse->max_width = fse->min_width;
845 fse->min_height = supported_modes[fse->index].height;
846 fse->max_height = fse->min_height;
851 static void imx258_update_pad_format(const struct imx258_mode *mode,
852 struct v4l2_subdev_format *fmt)
854 fmt->format.width = mode->width;
855 fmt->format.height = mode->height;
856 fmt->format.code = MEDIA_BUS_FMT_SGRBG10_1X10;
857 fmt->format.field = V4L2_FIELD_NONE;
860 static int __imx258_get_pad_format(struct imx258 *imx258,
861 struct v4l2_subdev_state *sd_state,
862 struct v4l2_subdev_format *fmt)
864 if (fmt->which == V4L2_SUBDEV_FORMAT_TRY)
865 fmt->format = *v4l2_subdev_state_get_format(sd_state,
868 imx258_update_pad_format(imx258->cur_mode, fmt);
873 static int imx258_get_pad_format(struct v4l2_subdev *sd,
874 struct v4l2_subdev_state *sd_state,
875 struct v4l2_subdev_format *fmt)
877 struct imx258 *imx258 = to_imx258(sd);
880 mutex_lock(&imx258->mutex);
881 ret = __imx258_get_pad_format(imx258, sd_state, fmt);
882 mutex_unlock(&imx258->mutex);
887 static int imx258_set_pad_format(struct v4l2_subdev *sd,
888 struct v4l2_subdev_state *sd_state,
889 struct v4l2_subdev_format *fmt)
891 struct imx258 *imx258 = to_imx258(sd);
892 const struct imx258_mode *mode;
893 struct v4l2_mbus_framefmt *framefmt;
900 mutex_lock(&imx258->mutex);
902 /* Only one raw bayer(GBRG) order is supported */
903 fmt->format.code = MEDIA_BUS_FMT_SGRBG10_1X10;
905 mode = v4l2_find_nearest_size(supported_modes,
906 ARRAY_SIZE(supported_modes), width, height,
907 fmt->format.width, fmt->format.height);
908 imx258_update_pad_format(mode, fmt);
909 if (fmt->which == V4L2_SUBDEV_FORMAT_TRY) {
910 framefmt = v4l2_subdev_state_get_format(sd_state, fmt->pad);
911 *framefmt = fmt->format;
913 imx258->cur_mode = mode;
914 __v4l2_ctrl_s_ctrl(imx258->link_freq, mode->link_freq_index);
916 link_freq = link_freq_menu_items[mode->link_freq_index];
917 pixel_rate = link_freq_to_pixel_rate(link_freq);
918 __v4l2_ctrl_s_ctrl_int64(imx258->pixel_rate, pixel_rate);
919 /* Update limits and set FPS to default */
920 vblank_def = imx258->cur_mode->vts_def -
921 imx258->cur_mode->height;
922 vblank_min = imx258->cur_mode->vts_min -
923 imx258->cur_mode->height;
924 __v4l2_ctrl_modify_range(
925 imx258->vblank, vblank_min,
926 IMX258_VTS_MAX - imx258->cur_mode->height, 1,
928 __v4l2_ctrl_s_ctrl(imx258->vblank, vblank_def);
930 link_freq_configs[mode->link_freq_index].pixels_per_line
931 - imx258->cur_mode->width;
932 __v4l2_ctrl_modify_range(imx258->hblank, h_blank,
933 h_blank, 1, h_blank);
936 mutex_unlock(&imx258->mutex);
941 /* Start streaming */
942 static int imx258_start_streaming(struct imx258 *imx258)
944 struct i2c_client *client = v4l2_get_subdevdata(&imx258->sd);
945 const struct imx258_reg_list *reg_list;
946 int ret, link_freq_index;
949 link_freq_index = imx258->cur_mode->link_freq_index;
950 reg_list = &link_freq_configs[link_freq_index].reg_list;
951 ret = imx258_write_regs(imx258, reg_list->regs, reg_list->num_of_regs);
953 dev_err(&client->dev, "%s failed to set plls\n", __func__);
957 /* Apply default values of current mode */
958 reg_list = &imx258->cur_mode->reg_list;
959 ret = imx258_write_regs(imx258, reg_list->regs, reg_list->num_of_regs);
961 dev_err(&client->dev, "%s failed to set mode\n", __func__);
965 /* Set Orientation be 180 degree */
966 ret = imx258_write_reg(imx258, REG_MIRROR_FLIP_CONTROL,
967 IMX258_REG_VALUE_08BIT, REG_CONFIG_MIRROR_FLIP);
969 dev_err(&client->dev, "%s failed to set orientation\n",
974 /* Apply customized values from user */
975 ret = __v4l2_ctrl_handler_setup(imx258->sd.ctrl_handler);
979 /* set stream on register */
980 return imx258_write_reg(imx258, IMX258_REG_MODE_SELECT,
981 IMX258_REG_VALUE_08BIT,
982 IMX258_MODE_STREAMING);
986 static int imx258_stop_streaming(struct imx258 *imx258)
988 struct i2c_client *client = v4l2_get_subdevdata(&imx258->sd);
991 /* set stream off register */
992 ret = imx258_write_reg(imx258, IMX258_REG_MODE_SELECT,
993 IMX258_REG_VALUE_08BIT, IMX258_MODE_STANDBY);
995 dev_err(&client->dev, "%s failed to set stream\n", __func__);
998 * Return success even if it was an error, as there is nothing the
999 * caller can do about it.
1004 static int imx258_power_on(struct device *dev)
1006 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1007 struct imx258 *imx258 = to_imx258(sd);
1010 ret = clk_prepare_enable(imx258->clk);
1012 dev_err(dev, "failed to enable clock\n");
1017 static int imx258_power_off(struct device *dev)
1019 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1020 struct imx258 *imx258 = to_imx258(sd);
1022 clk_disable_unprepare(imx258->clk);
1027 static int imx258_set_stream(struct v4l2_subdev *sd, int enable)
1029 struct imx258 *imx258 = to_imx258(sd);
1030 struct i2c_client *client = v4l2_get_subdevdata(sd);
1033 mutex_lock(&imx258->mutex);
1036 ret = pm_runtime_resume_and_get(&client->dev);
1041 * Apply default & customized values
1042 * and then start streaming.
1044 ret = imx258_start_streaming(imx258);
1048 imx258_stop_streaming(imx258);
1049 pm_runtime_put(&client->dev);
1052 mutex_unlock(&imx258->mutex);
1057 pm_runtime_put(&client->dev);
1059 mutex_unlock(&imx258->mutex);
1064 /* Verify chip ID */
1065 static int imx258_identify_module(struct imx258 *imx258)
1067 struct i2c_client *client = v4l2_get_subdevdata(&imx258->sd);
1071 ret = imx258_read_reg(imx258, IMX258_REG_CHIP_ID,
1072 IMX258_REG_VALUE_16BIT, &val);
1074 dev_err(&client->dev, "failed to read chip id %x\n",
1079 if (val != IMX258_CHIP_ID) {
1080 dev_err(&client->dev, "chip id mismatch: %x!=%x\n",
1081 IMX258_CHIP_ID, val);
1088 static const struct v4l2_subdev_video_ops imx258_video_ops = {
1089 .s_stream = imx258_set_stream,
1092 static const struct v4l2_subdev_pad_ops imx258_pad_ops = {
1093 .enum_mbus_code = imx258_enum_mbus_code,
1094 .get_fmt = imx258_get_pad_format,
1095 .set_fmt = imx258_set_pad_format,
1096 .enum_frame_size = imx258_enum_frame_size,
1099 static const struct v4l2_subdev_ops imx258_subdev_ops = {
1100 .video = &imx258_video_ops,
1101 .pad = &imx258_pad_ops,
1104 static const struct v4l2_subdev_internal_ops imx258_internal_ops = {
1105 .open = imx258_open,
1108 /* Initialize control handlers */
1109 static int imx258_init_controls(struct imx258 *imx258)
1111 struct i2c_client *client = v4l2_get_subdevdata(&imx258->sd);
1112 struct v4l2_fwnode_device_properties props;
1113 struct v4l2_ctrl_handler *ctrl_hdlr;
1114 struct v4l2_ctrl *vflip, *hflip;
1121 ctrl_hdlr = &imx258->ctrl_handler;
1122 ret = v4l2_ctrl_handler_init(ctrl_hdlr, 13);
1126 mutex_init(&imx258->mutex);
1127 ctrl_hdlr->lock = &imx258->mutex;
1128 imx258->link_freq = v4l2_ctrl_new_int_menu(ctrl_hdlr,
1131 ARRAY_SIZE(link_freq_menu_items) - 1,
1133 link_freq_menu_items);
1135 if (imx258->link_freq)
1136 imx258->link_freq->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1138 /* The driver only supports one bayer order and flips by default. */
1139 hflip = v4l2_ctrl_new_std(ctrl_hdlr, &imx258_ctrl_ops,
1140 V4L2_CID_HFLIP, 1, 1, 1, 1);
1142 hflip->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1144 vflip = v4l2_ctrl_new_std(ctrl_hdlr, &imx258_ctrl_ops,
1145 V4L2_CID_VFLIP, 1, 1, 1, 1);
1147 vflip->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1149 pixel_rate_max = link_freq_to_pixel_rate(link_freq_menu_items[0]);
1150 pixel_rate_min = link_freq_to_pixel_rate(link_freq_menu_items[1]);
1151 /* By default, PIXEL_RATE is read only */
1152 imx258->pixel_rate = v4l2_ctrl_new_std(ctrl_hdlr, &imx258_ctrl_ops,
1153 V4L2_CID_PIXEL_RATE,
1154 pixel_rate_min, pixel_rate_max,
1158 vblank_def = imx258->cur_mode->vts_def - imx258->cur_mode->height;
1159 vblank_min = imx258->cur_mode->vts_min - imx258->cur_mode->height;
1160 imx258->vblank = v4l2_ctrl_new_std(
1161 ctrl_hdlr, &imx258_ctrl_ops, V4L2_CID_VBLANK,
1163 IMX258_VTS_MAX - imx258->cur_mode->height, 1,
1167 imx258->vblank->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1169 imx258->hblank = v4l2_ctrl_new_std(
1170 ctrl_hdlr, &imx258_ctrl_ops, V4L2_CID_HBLANK,
1171 IMX258_PPL_DEFAULT - imx258->cur_mode->width,
1172 IMX258_PPL_DEFAULT - imx258->cur_mode->width,
1174 IMX258_PPL_DEFAULT - imx258->cur_mode->width);
1177 imx258->hblank->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1179 imx258->exposure = v4l2_ctrl_new_std(
1180 ctrl_hdlr, &imx258_ctrl_ops,
1181 V4L2_CID_EXPOSURE, IMX258_EXPOSURE_MIN,
1182 IMX258_EXPOSURE_MAX, IMX258_EXPOSURE_STEP,
1183 IMX258_EXPOSURE_DEFAULT);
1185 v4l2_ctrl_new_std(ctrl_hdlr, &imx258_ctrl_ops, V4L2_CID_ANALOGUE_GAIN,
1186 IMX258_ANA_GAIN_MIN, IMX258_ANA_GAIN_MAX,
1187 IMX258_ANA_GAIN_STEP, IMX258_ANA_GAIN_DEFAULT);
1189 v4l2_ctrl_new_std(ctrl_hdlr, &imx258_ctrl_ops, V4L2_CID_DIGITAL_GAIN,
1190 IMX258_DGTL_GAIN_MIN, IMX258_DGTL_GAIN_MAX,
1191 IMX258_DGTL_GAIN_STEP,
1192 IMX258_DGTL_GAIN_DEFAULT);
1194 v4l2_ctrl_new_std(ctrl_hdlr, &imx258_ctrl_ops, V4L2_CID_WIDE_DYNAMIC_RANGE,
1195 0, 1, 1, IMX258_HDR_RATIO_DEFAULT);
1197 v4l2_ctrl_new_std_menu_items(ctrl_hdlr, &imx258_ctrl_ops,
1198 V4L2_CID_TEST_PATTERN,
1199 ARRAY_SIZE(imx258_test_pattern_menu) - 1,
1200 0, 0, imx258_test_pattern_menu);
1202 if (ctrl_hdlr->error) {
1203 ret = ctrl_hdlr->error;
1204 dev_err(&client->dev, "%s control init failed (%d)\n",
1209 ret = v4l2_fwnode_device_parse(&client->dev, &props);
1213 ret = v4l2_ctrl_new_fwnode_properties(ctrl_hdlr, &imx258_ctrl_ops,
1218 imx258->sd.ctrl_handler = ctrl_hdlr;
1223 v4l2_ctrl_handler_free(ctrl_hdlr);
1224 mutex_destroy(&imx258->mutex);
1229 static void imx258_free_controls(struct imx258 *imx258)
1231 v4l2_ctrl_handler_free(imx258->sd.ctrl_handler);
1232 mutex_destroy(&imx258->mutex);
1235 static int imx258_probe(struct i2c_client *client)
1237 struct imx258 *imx258;
1241 imx258 = devm_kzalloc(&client->dev, sizeof(*imx258), GFP_KERNEL);
1245 imx258->clk = devm_clk_get_optional(&client->dev, NULL);
1246 if (IS_ERR(imx258->clk))
1247 return dev_err_probe(&client->dev, PTR_ERR(imx258->clk),
1248 "error getting clock\n");
1250 dev_dbg(&client->dev,
1251 "no clock provided, using clock-frequency property\n");
1253 device_property_read_u32(&client->dev, "clock-frequency", &val);
1255 val = clk_get_rate(imx258->clk);
1257 if (val != IMX258_INPUT_CLOCK_FREQ) {
1258 dev_err(&client->dev, "input clock frequency not supported\n");
1262 /* Initialize subdev */
1263 v4l2_i2c_subdev_init(&imx258->sd, client, &imx258_subdev_ops);
1265 /* Will be powered off via pm_runtime_idle */
1266 ret = imx258_power_on(&client->dev);
1270 /* Check module identity */
1271 ret = imx258_identify_module(imx258);
1273 goto error_identify;
1275 /* Set default mode to max resolution */
1276 imx258->cur_mode = &supported_modes[0];
1278 ret = imx258_init_controls(imx258);
1280 goto error_identify;
1282 /* Initialize subdev */
1283 imx258->sd.internal_ops = &imx258_internal_ops;
1284 imx258->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
1285 imx258->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
1287 /* Initialize source pad */
1288 imx258->pad.flags = MEDIA_PAD_FL_SOURCE;
1290 ret = media_entity_pads_init(&imx258->sd.entity, 1, &imx258->pad);
1292 goto error_handler_free;
1294 ret = v4l2_async_register_subdev_sensor(&imx258->sd);
1296 goto error_media_entity;
1298 pm_runtime_set_active(&client->dev);
1299 pm_runtime_enable(&client->dev);
1300 pm_runtime_idle(&client->dev);
1305 media_entity_cleanup(&imx258->sd.entity);
1308 imx258_free_controls(imx258);
1311 imx258_power_off(&client->dev);
1316 static void imx258_remove(struct i2c_client *client)
1318 struct v4l2_subdev *sd = i2c_get_clientdata(client);
1319 struct imx258 *imx258 = to_imx258(sd);
1321 v4l2_async_unregister_subdev(sd);
1322 media_entity_cleanup(&sd->entity);
1323 imx258_free_controls(imx258);
1325 pm_runtime_disable(&client->dev);
1326 if (!pm_runtime_status_suspended(&client->dev))
1327 imx258_power_off(&client->dev);
1328 pm_runtime_set_suspended(&client->dev);
1331 static const struct dev_pm_ops imx258_pm_ops = {
1332 SET_RUNTIME_PM_OPS(imx258_power_off, imx258_power_on, NULL)
1336 static const struct acpi_device_id imx258_acpi_ids[] = {
1341 MODULE_DEVICE_TABLE(acpi, imx258_acpi_ids);
1344 static const struct of_device_id imx258_dt_ids[] = {
1345 { .compatible = "sony,imx258" },
1348 MODULE_DEVICE_TABLE(of, imx258_dt_ids);
1350 static struct i2c_driver imx258_i2c_driver = {
1353 .pm = &imx258_pm_ops,
1354 .acpi_match_table = ACPI_PTR(imx258_acpi_ids),
1355 .of_match_table = imx258_dt_ids,
1357 .probe = imx258_probe,
1358 .remove = imx258_remove,
1361 module_i2c_driver(imx258_i2c_driver);
1364 MODULE_AUTHOR("Chiang, Alan");
1365 MODULE_AUTHOR("Chen, Jason");
1366 MODULE_DESCRIPTION("Sony IMX258 sensor driver");
1367 MODULE_LICENSE("GPL v2");