1 // SPDX-License-Identifier: GPL-2.0
3 * A V4L2 driver for OmniVision OV5647 cameras.
5 * Based on Samsung S5K6AAFX SXGA 1/6" 1.3M CMOS Image Sensor driver
6 * Copyright (C) 2011 Sylwester Nawrocki <s.nawrocki@samsung.com>
8 * Based on Omnivision OV7670 Camera Driver
9 * Copyright (C) 2006-7 Jonathan Corbet <corbet@lwn.net>
11 * Copyright (C) 2016, Synopsys, Inc.
14 #include <linux/clk.h>
15 #include <linux/delay.h>
16 #include <linux/gpio/consumer.h>
17 #include <linux/i2c.h>
18 #include <linux/init.h>
20 #include <linux/module.h>
21 #include <linux/of_graph.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/slab.h>
24 #include <linux/videodev2.h>
25 #include <media/v4l2-ctrls.h>
26 #include <media/v4l2-device.h>
27 #include <media/v4l2-event.h>
28 #include <media/v4l2-fwnode.h>
29 #include <media/v4l2-image-sizes.h>
30 #include <media/v4l2-mediabus.h>
33 * From the datasheet, "20ms after PWDN goes low or 20ms after RESETB goes
34 * high if reset is inserted after PWDN goes high, host can access sensor's
35 * SCCB to initialize sensor."
37 #define PWDN_ACTIVE_DELAY_MS 20
39 #define MIPI_CTRL00_CLOCK_LANE_GATE BIT(5)
40 #define MIPI_CTRL00_LINE_SYNC_ENABLE BIT(4)
41 #define MIPI_CTRL00_BUS_IDLE BIT(2)
42 #define MIPI_CTRL00_CLOCK_LANE_DISABLE BIT(0)
44 #define OV5647_SW_STANDBY 0x0100
45 #define OV5647_SW_RESET 0x0103
46 #define OV5647_REG_CHIPID_H 0x300a
47 #define OV5647_REG_CHIPID_L 0x300b
48 #define OV5640_REG_PAD_OUT 0x300d
49 #define OV5647_REG_EXP_HI 0x3500
50 #define OV5647_REG_EXP_MID 0x3501
51 #define OV5647_REG_EXP_LO 0x3502
52 #define OV5647_REG_AEC_AGC 0x3503
53 #define OV5647_REG_GAIN_HI 0x350a
54 #define OV5647_REG_GAIN_LO 0x350b
55 #define OV5647_REG_VTS_HI 0x380e
56 #define OV5647_REG_VTS_LO 0x380f
57 #define OV5647_REG_FRAME_OFF_NUMBER 0x4202
58 #define OV5647_REG_MIPI_CTRL00 0x4800
59 #define OV5647_REG_MIPI_CTRL14 0x4814
60 #define OV5647_REG_AWB 0x5001
62 #define REG_TERM 0xfffe
64 #define REG_DLY 0xffff
66 /* OV5647 native and active pixel array size */
67 #define OV5647_NATIVE_WIDTH 2624U
68 #define OV5647_NATIVE_HEIGHT 1956U
70 #define OV5647_PIXEL_ARRAY_LEFT 16U
71 #define OV5647_PIXEL_ARRAY_TOP 16U
72 #define OV5647_PIXEL_ARRAY_WIDTH 2592U
73 #define OV5647_PIXEL_ARRAY_HEIGHT 1944U
75 #define OV5647_VBLANK_MIN 4
76 #define OV5647_VTS_MAX 32767
78 #define OV5647_EXPOSURE_MIN 4
79 #define OV5647_EXPOSURE_STEP 1
80 #define OV5647_EXPOSURE_DEFAULT 1000
81 #define OV5647_EXPOSURE_MAX 65535
89 struct v4l2_mbus_framefmt format;
90 struct v4l2_rect crop;
94 const struct regval_list *reg_list;
95 unsigned int num_regs;
99 struct v4l2_subdev sd;
100 struct media_pad pad;
103 struct gpio_desc *pwdn;
105 struct v4l2_ctrl_handler ctrls;
106 const struct ov5647_mode *mode;
107 struct v4l2_ctrl *pixel_rate;
108 struct v4l2_ctrl *hblank;
109 struct v4l2_ctrl *vblank;
110 struct v4l2_ctrl *exposure;
114 static inline struct ov5647 *to_sensor(struct v4l2_subdev *sd)
116 return container_of(sd, struct ov5647, sd);
119 static const struct regval_list sensor_oe_disable_regs[] = {
125 static const struct regval_list sensor_oe_enable_regs[] = {
131 static struct regval_list ov5647_2592x1944_10bpp[] = {
220 static struct regval_list ov5647_1080p30_10bpp[] = {
309 static struct regval_list ov5647_2x2binned_10bpp[] = {
402 static struct regval_list ov5647_640x480_10bpp[] = {
492 static const struct ov5647_mode ov5647_modes[] = {
493 /* 2592x1944 full resolution full FOV 10-bit mode. */
496 .code = MEDIA_BUS_FMT_SBGGR10_1X10,
497 .colorspace = V4L2_COLORSPACE_SRGB,
498 .field = V4L2_FIELD_NONE,
503 .left = OV5647_PIXEL_ARRAY_LEFT,
504 .top = OV5647_PIXEL_ARRAY_TOP,
508 .pixel_rate = 87500000,
511 .reg_list = ov5647_2592x1944_10bpp,
512 .num_regs = ARRAY_SIZE(ov5647_2592x1944_10bpp)
514 /* 1080p30 10-bit mode. Full resolution centre-cropped down to 1080p. */
517 .code = MEDIA_BUS_FMT_SBGGR10_1X10,
518 .colorspace = V4L2_COLORSPACE_SRGB,
519 .field = V4L2_FIELD_NONE,
524 .left = 348 + OV5647_PIXEL_ARRAY_LEFT,
525 .top = 434 + OV5647_PIXEL_ARRAY_TOP,
529 .pixel_rate = 81666700,
532 .reg_list = ov5647_1080p30_10bpp,
533 .num_regs = ARRAY_SIZE(ov5647_1080p30_10bpp)
535 /* 2x2 binned full FOV 10-bit mode. */
538 .code = MEDIA_BUS_FMT_SBGGR10_1X10,
539 .colorspace = V4L2_COLORSPACE_SRGB,
540 .field = V4L2_FIELD_NONE,
545 .left = OV5647_PIXEL_ARRAY_LEFT,
546 .top = OV5647_PIXEL_ARRAY_TOP,
550 .pixel_rate = 81666700,
553 .reg_list = ov5647_2x2binned_10bpp,
554 .num_regs = ARRAY_SIZE(ov5647_2x2binned_10bpp)
556 /* 10-bit VGA full FOV 60fps. 2x2 binned and subsampled down to VGA. */
559 .code = MEDIA_BUS_FMT_SBGGR10_1X10,
560 .colorspace = V4L2_COLORSPACE_SRGB,
561 .field = V4L2_FIELD_NONE,
566 .left = 16 + OV5647_PIXEL_ARRAY_LEFT,
567 .top = OV5647_PIXEL_ARRAY_TOP,
571 .pixel_rate = 55000000,
574 .reg_list = ov5647_640x480_10bpp,
575 .num_regs = ARRAY_SIZE(ov5647_640x480_10bpp)
579 /* Default sensor mode is 2x2 binned 640x480 SBGGR10_1X10. */
580 #define OV5647_DEFAULT_MODE (&ov5647_modes[3])
581 #define OV5647_DEFAULT_FORMAT (ov5647_modes[3].format)
583 static int ov5647_write16(struct v4l2_subdev *sd, u16 reg, u16 val)
585 unsigned char data[4] = { reg >> 8, reg & 0xff, val >> 8, val & 0xff};
586 struct i2c_client *client = v4l2_get_subdevdata(sd);
589 ret = i2c_master_send(client, data, 4);
591 dev_dbg(&client->dev, "%s: i2c write error, reg: %x\n",
599 static int ov5647_write(struct v4l2_subdev *sd, u16 reg, u8 val)
601 unsigned char data[3] = { reg >> 8, reg & 0xff, val};
602 struct i2c_client *client = v4l2_get_subdevdata(sd);
605 ret = i2c_master_send(client, data, 3);
607 dev_dbg(&client->dev, "%s: i2c write error, reg: %x\n",
615 static int ov5647_read(struct v4l2_subdev *sd, u16 reg, u8 *val)
617 unsigned char data_w[2] = { reg >> 8, reg & 0xff };
618 struct i2c_client *client = v4l2_get_subdevdata(sd);
621 ret = i2c_master_send(client, data_w, 2);
623 dev_dbg(&client->dev, "%s: i2c write error, reg: %x\n",
628 ret = i2c_master_recv(client, val, 1);
630 dev_dbg(&client->dev, "%s: i2c read error, reg: %x\n",
638 static int ov5647_write_array(struct v4l2_subdev *sd,
639 const struct regval_list *regs, int array_size)
643 for (i = 0; i < array_size; i++) {
644 ret = ov5647_write(sd, regs[i].addr, regs[i].data);
652 static int ov5647_set_virtual_channel(struct v4l2_subdev *sd, int channel)
657 ret = ov5647_read(sd, OV5647_REG_MIPI_CTRL14, &channel_id);
661 channel_id &= ~(3 << 6);
663 return ov5647_write(sd, OV5647_REG_MIPI_CTRL14,
664 channel_id | (channel << 6));
667 static int ov5647_set_mode(struct v4l2_subdev *sd)
669 struct i2c_client *client = v4l2_get_subdevdata(sd);
670 struct ov5647 *sensor = to_sensor(sd);
674 ret = ov5647_read(sd, OV5647_SW_STANDBY, &rdval);
678 ret = ov5647_write_array(sd, sensor->mode->reg_list,
679 sensor->mode->num_regs);
681 dev_err(&client->dev, "write sensor default regs error\n");
685 ret = ov5647_set_virtual_channel(sd, 0);
689 ret = ov5647_read(sd, OV5647_SW_STANDBY, &resetval);
693 if (!(resetval & 0x01)) {
694 dev_err(&client->dev, "Device was in SW standby");
695 ret = ov5647_write(sd, OV5647_SW_STANDBY, 0x01);
703 static int ov5647_stream_on(struct v4l2_subdev *sd)
705 struct i2c_client *client = v4l2_get_subdevdata(sd);
706 struct ov5647 *sensor = to_sensor(sd);
707 u8 val = MIPI_CTRL00_BUS_IDLE;
710 ret = ov5647_set_mode(sd);
712 dev_err(&client->dev, "Failed to program sensor mode: %d\n", ret);
716 /* Apply customized values from user when stream starts. */
717 ret = __v4l2_ctrl_handler_setup(sd->ctrl_handler);
721 if (sensor->clock_ncont)
722 val |= MIPI_CTRL00_CLOCK_LANE_GATE |
723 MIPI_CTRL00_LINE_SYNC_ENABLE;
725 ret = ov5647_write(sd, OV5647_REG_MIPI_CTRL00, val);
729 ret = ov5647_write(sd, OV5647_REG_FRAME_OFF_NUMBER, 0x00);
733 return ov5647_write(sd, OV5640_REG_PAD_OUT, 0x00);
736 static int ov5647_stream_off(struct v4l2_subdev *sd)
740 ret = ov5647_write(sd, OV5647_REG_MIPI_CTRL00,
741 MIPI_CTRL00_CLOCK_LANE_GATE | MIPI_CTRL00_BUS_IDLE |
742 MIPI_CTRL00_CLOCK_LANE_DISABLE);
746 ret = ov5647_write(sd, OV5647_REG_FRAME_OFF_NUMBER, 0x0f);
750 return ov5647_write(sd, OV5640_REG_PAD_OUT, 0x01);
753 static int ov5647_power_on(struct device *dev)
755 struct ov5647 *sensor = dev_get_drvdata(dev);
758 dev_dbg(dev, "OV5647 power on\n");
761 gpiod_set_value_cansleep(sensor->pwdn, 0);
762 msleep(PWDN_ACTIVE_DELAY_MS);
765 ret = clk_prepare_enable(sensor->xclk);
767 dev_err(dev, "clk prepare enable failed\n");
771 ret = ov5647_write_array(&sensor->sd, sensor_oe_enable_regs,
772 ARRAY_SIZE(sensor_oe_enable_regs));
774 dev_err(dev, "write sensor_oe_enable_regs error\n");
775 goto error_clk_disable;
778 /* Stream off to coax lanes into LP-11 state. */
779 ret = ov5647_stream_off(&sensor->sd);
781 dev_err(dev, "camera not available, check power\n");
782 goto error_clk_disable;
788 clk_disable_unprepare(sensor->xclk);
790 gpiod_set_value_cansleep(sensor->pwdn, 1);
795 static int ov5647_power_off(struct device *dev)
797 struct ov5647 *sensor = dev_get_drvdata(dev);
801 dev_dbg(dev, "OV5647 power off\n");
803 ret = ov5647_write_array(&sensor->sd, sensor_oe_disable_regs,
804 ARRAY_SIZE(sensor_oe_disable_regs));
806 dev_dbg(dev, "disable oe failed\n");
808 /* Enter software standby */
809 ret = ov5647_read(&sensor->sd, OV5647_SW_STANDBY, &rdval);
811 dev_dbg(dev, "software standby failed\n");
814 ret = ov5647_write(&sensor->sd, OV5647_SW_STANDBY, rdval);
816 dev_dbg(dev, "software standby failed\n");
818 clk_disable_unprepare(sensor->xclk);
819 gpiod_set_value_cansleep(sensor->pwdn, 1);
824 #ifdef CONFIG_VIDEO_ADV_DEBUG
825 static int ov5647_sensor_get_register(struct v4l2_subdev *sd,
826 struct v4l2_dbg_register *reg)
831 ret = ov5647_read(sd, reg->reg & 0xff, &val);
841 static int ov5647_sensor_set_register(struct v4l2_subdev *sd,
842 const struct v4l2_dbg_register *reg)
844 return ov5647_write(sd, reg->reg & 0xff, reg->val & 0xff);
848 /* Subdev core operations registration */
849 static const struct v4l2_subdev_core_ops ov5647_subdev_core_ops = {
850 .subscribe_event = v4l2_ctrl_subdev_subscribe_event,
851 .unsubscribe_event = v4l2_event_subdev_unsubscribe,
852 #ifdef CONFIG_VIDEO_ADV_DEBUG
853 .g_register = ov5647_sensor_get_register,
854 .s_register = ov5647_sensor_set_register,
858 static const struct v4l2_rect *
859 __ov5647_get_pad_crop(struct ov5647 *ov5647,
860 struct v4l2_subdev_state *sd_state,
861 unsigned int pad, enum v4l2_subdev_format_whence which)
864 case V4L2_SUBDEV_FORMAT_TRY:
865 return v4l2_subdev_get_try_crop(&ov5647->sd, sd_state, pad);
866 case V4L2_SUBDEV_FORMAT_ACTIVE:
867 return &ov5647->mode->crop;
873 static int ov5647_s_stream(struct v4l2_subdev *sd, int enable)
875 struct i2c_client *client = v4l2_get_subdevdata(sd);
876 struct ov5647 *sensor = to_sensor(sd);
879 mutex_lock(&sensor->lock);
880 if (sensor->streaming == enable) {
881 mutex_unlock(&sensor->lock);
886 ret = pm_runtime_resume_and_get(&client->dev);
890 ret = ov5647_stream_on(sd);
892 dev_err(&client->dev, "stream start failed: %d\n", ret);
896 ret = ov5647_stream_off(sd);
898 dev_err(&client->dev, "stream stop failed: %d\n", ret);
901 pm_runtime_put(&client->dev);
904 sensor->streaming = enable;
905 mutex_unlock(&sensor->lock);
910 pm_runtime_put(&client->dev);
912 mutex_unlock(&sensor->lock);
917 static const struct v4l2_subdev_video_ops ov5647_subdev_video_ops = {
918 .s_stream = ov5647_s_stream,
921 static int ov5647_enum_mbus_code(struct v4l2_subdev *sd,
922 struct v4l2_subdev_state *sd_state,
923 struct v4l2_subdev_mbus_code_enum *code)
928 code->code = MEDIA_BUS_FMT_SBGGR10_1X10;
933 static int ov5647_enum_frame_size(struct v4l2_subdev *sd,
934 struct v4l2_subdev_state *sd_state,
935 struct v4l2_subdev_frame_size_enum *fse)
937 const struct v4l2_mbus_framefmt *fmt;
939 if (fse->code != MEDIA_BUS_FMT_SBGGR10_1X10 ||
940 fse->index >= ARRAY_SIZE(ov5647_modes))
943 fmt = &ov5647_modes[fse->index].format;
944 fse->min_width = fmt->width;
945 fse->max_width = fmt->width;
946 fse->min_height = fmt->height;
947 fse->max_height = fmt->height;
952 static int ov5647_get_pad_fmt(struct v4l2_subdev *sd,
953 struct v4l2_subdev_state *sd_state,
954 struct v4l2_subdev_format *format)
956 struct v4l2_mbus_framefmt *fmt = &format->format;
957 const struct v4l2_mbus_framefmt *sensor_format;
958 struct ov5647 *sensor = to_sensor(sd);
960 mutex_lock(&sensor->lock);
961 switch (format->which) {
962 case V4L2_SUBDEV_FORMAT_TRY:
963 sensor_format = v4l2_subdev_get_try_format(sd, sd_state,
967 sensor_format = &sensor->mode->format;
971 *fmt = *sensor_format;
972 mutex_unlock(&sensor->lock);
977 static int ov5647_set_pad_fmt(struct v4l2_subdev *sd,
978 struct v4l2_subdev_state *sd_state,
979 struct v4l2_subdev_format *format)
981 struct v4l2_mbus_framefmt *fmt = &format->format;
982 struct ov5647 *sensor = to_sensor(sd);
983 const struct ov5647_mode *mode;
985 mode = v4l2_find_nearest_size(ov5647_modes, ARRAY_SIZE(ov5647_modes),
986 format.width, format.height,
987 fmt->width, fmt->height);
989 /* Update the sensor mode and apply at it at streamon time. */
990 mutex_lock(&sensor->lock);
991 if (format->which == V4L2_SUBDEV_FORMAT_TRY) {
992 *v4l2_subdev_get_try_format(sd, sd_state, format->pad) = mode->format;
994 int exposure_max, exposure_def;
998 __v4l2_ctrl_modify_range(sensor->pixel_rate, mode->pixel_rate,
999 mode->pixel_rate, 1, mode->pixel_rate);
1001 hblank = mode->hts - mode->format.width;
1002 __v4l2_ctrl_modify_range(sensor->hblank, hblank, hblank, 1,
1005 vblank = mode->vts - mode->format.height;
1006 __v4l2_ctrl_modify_range(sensor->vblank, OV5647_VBLANK_MIN,
1007 OV5647_VTS_MAX - mode->format.height,
1009 __v4l2_ctrl_s_ctrl(sensor->vblank, vblank);
1011 exposure_max = mode->vts - 4;
1012 exposure_def = min(exposure_max, OV5647_EXPOSURE_DEFAULT);
1013 __v4l2_ctrl_modify_range(sensor->exposure,
1014 sensor->exposure->minimum,
1015 exposure_max, sensor->exposure->step,
1018 *fmt = mode->format;
1019 mutex_unlock(&sensor->lock);
1024 static int ov5647_get_selection(struct v4l2_subdev *sd,
1025 struct v4l2_subdev_state *sd_state,
1026 struct v4l2_subdev_selection *sel)
1028 switch (sel->target) {
1029 case V4L2_SEL_TGT_CROP: {
1030 struct ov5647 *sensor = to_sensor(sd);
1032 mutex_lock(&sensor->lock);
1033 sel->r = *__ov5647_get_pad_crop(sensor, sd_state, sel->pad,
1035 mutex_unlock(&sensor->lock);
1040 case V4L2_SEL_TGT_NATIVE_SIZE:
1043 sel->r.width = OV5647_NATIVE_WIDTH;
1044 sel->r.height = OV5647_NATIVE_HEIGHT;
1048 case V4L2_SEL_TGT_CROP_DEFAULT:
1049 case V4L2_SEL_TGT_CROP_BOUNDS:
1050 sel->r.top = OV5647_PIXEL_ARRAY_TOP;
1051 sel->r.left = OV5647_PIXEL_ARRAY_LEFT;
1052 sel->r.width = OV5647_PIXEL_ARRAY_WIDTH;
1053 sel->r.height = OV5647_PIXEL_ARRAY_HEIGHT;
1061 static const struct v4l2_subdev_pad_ops ov5647_subdev_pad_ops = {
1062 .enum_mbus_code = ov5647_enum_mbus_code,
1063 .enum_frame_size = ov5647_enum_frame_size,
1064 .set_fmt = ov5647_set_pad_fmt,
1065 .get_fmt = ov5647_get_pad_fmt,
1066 .get_selection = ov5647_get_selection,
1069 static const struct v4l2_subdev_ops ov5647_subdev_ops = {
1070 .core = &ov5647_subdev_core_ops,
1071 .video = &ov5647_subdev_video_ops,
1072 .pad = &ov5647_subdev_pad_ops,
1075 static int ov5647_detect(struct v4l2_subdev *sd)
1077 struct i2c_client *client = v4l2_get_subdevdata(sd);
1081 ret = ov5647_write(sd, OV5647_SW_RESET, 0x01);
1085 ret = ov5647_read(sd, OV5647_REG_CHIPID_H, &read);
1090 dev_err(&client->dev, "ID High expected 0x56 got %x", read);
1094 ret = ov5647_read(sd, OV5647_REG_CHIPID_L, &read);
1099 dev_err(&client->dev, "ID Low expected 0x47 got %x", read);
1103 return ov5647_write(sd, OV5647_SW_RESET, 0x00);
1106 static int ov5647_open(struct v4l2_subdev *sd, struct v4l2_subdev_fh *fh)
1108 struct v4l2_mbus_framefmt *format =
1109 v4l2_subdev_get_try_format(sd, fh->state, 0);
1110 struct v4l2_rect *crop = v4l2_subdev_get_try_crop(sd, fh->state, 0);
1112 crop->left = OV5647_PIXEL_ARRAY_LEFT;
1113 crop->top = OV5647_PIXEL_ARRAY_TOP;
1114 crop->width = OV5647_PIXEL_ARRAY_WIDTH;
1115 crop->height = OV5647_PIXEL_ARRAY_HEIGHT;
1117 *format = OV5647_DEFAULT_FORMAT;
1122 static const struct v4l2_subdev_internal_ops ov5647_subdev_internal_ops = {
1123 .open = ov5647_open,
1126 static int ov5647_s_auto_white_balance(struct v4l2_subdev *sd, u32 val)
1128 return ov5647_write(sd, OV5647_REG_AWB, val ? 1 : 0);
1131 static int ov5647_s_autogain(struct v4l2_subdev *sd, u32 val)
1136 /* Non-zero turns on AGC by clearing bit 1.*/
1137 ret = ov5647_read(sd, OV5647_REG_AEC_AGC, ®);
1141 return ov5647_write(sd, OV5647_REG_AEC_AGC, val ? reg & ~BIT(1)
1145 static int ov5647_s_exposure_auto(struct v4l2_subdev *sd, u32 val)
1151 * Everything except V4L2_EXPOSURE_MANUAL turns on AEC by
1154 ret = ov5647_read(sd, OV5647_REG_AEC_AGC, ®);
1158 return ov5647_write(sd, OV5647_REG_AEC_AGC,
1159 val == V4L2_EXPOSURE_MANUAL ? reg | BIT(0)
1163 static int ov5647_s_analogue_gain(struct v4l2_subdev *sd, u32 val)
1167 /* 10 bits of gain, 2 in the high register. */
1168 ret = ov5647_write(sd, OV5647_REG_GAIN_HI, (val >> 8) & 3);
1172 return ov5647_write(sd, OV5647_REG_GAIN_LO, val & 0xff);
1175 static int ov5647_s_exposure(struct v4l2_subdev *sd, u32 val)
1180 * Sensor has 20 bits, but the bottom 4 bits are fractions of a line
1181 * which we leave as zero (and don't receive in "val").
1183 ret = ov5647_write(sd, OV5647_REG_EXP_HI, (val >> 12) & 0xf);
1187 ret = ov5647_write(sd, OV5647_REG_EXP_MID, (val >> 4) & 0xff);
1191 return ov5647_write(sd, OV5647_REG_EXP_LO, (val & 0xf) << 4);
1194 static int ov5647_s_ctrl(struct v4l2_ctrl *ctrl)
1196 struct ov5647 *sensor = container_of(ctrl->handler,
1197 struct ov5647, ctrls);
1198 struct v4l2_subdev *sd = &sensor->sd;
1199 struct i2c_client *client = v4l2_get_subdevdata(sd);
1203 /* v4l2_ctrl_lock() locks our own mutex */
1205 if (ctrl->id == V4L2_CID_VBLANK) {
1206 int exposure_max, exposure_def;
1208 /* Update max exposure while meeting expected vblanking */
1209 exposure_max = sensor->mode->format.height + ctrl->val - 4;
1210 exposure_def = min(exposure_max, OV5647_EXPOSURE_DEFAULT);
1211 __v4l2_ctrl_modify_range(sensor->exposure,
1212 sensor->exposure->minimum,
1213 exposure_max, sensor->exposure->step,
1218 * If the device is not powered up do not apply any controls
1219 * to H/W at this time. Instead the controls will be restored
1220 * at s_stream(1) time.
1222 if (pm_runtime_get_if_in_use(&client->dev) == 0)
1226 case V4L2_CID_AUTO_WHITE_BALANCE:
1227 ret = ov5647_s_auto_white_balance(sd, ctrl->val);
1229 case V4L2_CID_AUTOGAIN:
1230 ret = ov5647_s_autogain(sd, ctrl->val);
1232 case V4L2_CID_EXPOSURE_AUTO:
1233 ret = ov5647_s_exposure_auto(sd, ctrl->val);
1235 case V4L2_CID_ANALOGUE_GAIN:
1236 ret = ov5647_s_analogue_gain(sd, ctrl->val);
1238 case V4L2_CID_EXPOSURE:
1239 ret = ov5647_s_exposure(sd, ctrl->val);
1241 case V4L2_CID_VBLANK:
1242 ret = ov5647_write16(sd, OV5647_REG_VTS_HI,
1243 sensor->mode->format.height + ctrl->val);
1246 /* Read-only, but we adjust it based on mode. */
1247 case V4L2_CID_PIXEL_RATE:
1248 case V4L2_CID_HBLANK:
1249 /* Read-only, but we adjust it based on mode. */
1253 dev_info(&client->dev,
1254 "Control (id:0x%x, val:0x%x) not supported\n",
1255 ctrl->id, ctrl->val);
1259 pm_runtime_put(&client->dev);
1264 static const struct v4l2_ctrl_ops ov5647_ctrl_ops = {
1265 .s_ctrl = ov5647_s_ctrl,
1268 static int ov5647_init_controls(struct ov5647 *sensor)
1270 struct i2c_client *client = v4l2_get_subdevdata(&sensor->sd);
1271 int hblank, exposure_max, exposure_def;
1273 v4l2_ctrl_handler_init(&sensor->ctrls, 8);
1275 v4l2_ctrl_new_std(&sensor->ctrls, &ov5647_ctrl_ops,
1276 V4L2_CID_AUTOGAIN, 0, 1, 1, 0);
1278 v4l2_ctrl_new_std(&sensor->ctrls, &ov5647_ctrl_ops,
1279 V4L2_CID_AUTO_WHITE_BALANCE, 0, 1, 1, 0);
1281 v4l2_ctrl_new_std_menu(&sensor->ctrls, &ov5647_ctrl_ops,
1282 V4L2_CID_EXPOSURE_AUTO, V4L2_EXPOSURE_MANUAL,
1283 0, V4L2_EXPOSURE_MANUAL);
1285 exposure_max = sensor->mode->vts - 4;
1286 exposure_def = min(exposure_max, OV5647_EXPOSURE_DEFAULT);
1287 sensor->exposure = v4l2_ctrl_new_std(&sensor->ctrls, &ov5647_ctrl_ops,
1289 OV5647_EXPOSURE_MIN,
1290 exposure_max, OV5647_EXPOSURE_STEP,
1293 /* min: 16 = 1.0x; max (10 bits); default: 32 = 2.0x. */
1294 v4l2_ctrl_new_std(&sensor->ctrls, &ov5647_ctrl_ops,
1295 V4L2_CID_ANALOGUE_GAIN, 16, 1023, 1, 32);
1297 /* By default, PIXEL_RATE is read only, but it does change per mode */
1298 sensor->pixel_rate = v4l2_ctrl_new_std(&sensor->ctrls, &ov5647_ctrl_ops,
1299 V4L2_CID_PIXEL_RATE,
1300 sensor->mode->pixel_rate,
1301 sensor->mode->pixel_rate, 1,
1302 sensor->mode->pixel_rate);
1304 /* By default, HBLANK is read only, but it does change per mode. */
1305 hblank = sensor->mode->hts - sensor->mode->format.width;
1306 sensor->hblank = v4l2_ctrl_new_std(&sensor->ctrls, &ov5647_ctrl_ops,
1307 V4L2_CID_HBLANK, hblank, hblank, 1,
1310 sensor->vblank = v4l2_ctrl_new_std(&sensor->ctrls, &ov5647_ctrl_ops,
1311 V4L2_CID_VBLANK, OV5647_VBLANK_MIN,
1313 sensor->mode->format.height, 1,
1315 sensor->mode->format.height);
1317 if (sensor->ctrls.error)
1320 sensor->pixel_rate->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1321 sensor->hblank->flags |= V4L2_CTRL_FLAG_READ_ONLY;
1322 sensor->sd.ctrl_handler = &sensor->ctrls;
1327 dev_err(&client->dev, "%s Controls initialization failed (%d)\n",
1328 __func__, sensor->ctrls.error);
1329 v4l2_ctrl_handler_free(&sensor->ctrls);
1331 return sensor->ctrls.error;
1334 static int ov5647_parse_dt(struct ov5647 *sensor, struct device_node *np)
1336 struct v4l2_fwnode_endpoint bus_cfg = {
1337 .bus_type = V4L2_MBUS_CSI2_DPHY,
1339 struct device_node *ep;
1342 ep = of_graph_get_next_endpoint(np, NULL);
1346 ret = v4l2_fwnode_endpoint_parse(of_fwnode_handle(ep), &bus_cfg);
1350 sensor->clock_ncont = bus_cfg.bus.mipi_csi2.flags &
1351 V4L2_MBUS_CSI2_NONCONTINUOUS_CLOCK;
1359 static int ov5647_probe(struct i2c_client *client)
1361 struct device_node *np = client->dev.of_node;
1362 struct device *dev = &client->dev;
1363 struct ov5647 *sensor;
1364 struct v4l2_subdev *sd;
1368 sensor = devm_kzalloc(dev, sizeof(*sensor), GFP_KERNEL);
1372 if (IS_ENABLED(CONFIG_OF) && np) {
1373 ret = ov5647_parse_dt(sensor, np);
1375 dev_err(dev, "DT parsing error: %d\n", ret);
1380 sensor->xclk = devm_clk_get(dev, NULL);
1381 if (IS_ERR(sensor->xclk)) {
1382 dev_err(dev, "could not get xclk");
1383 return PTR_ERR(sensor->xclk);
1386 xclk_freq = clk_get_rate(sensor->xclk);
1387 if (xclk_freq != 25000000) {
1388 dev_err(dev, "Unsupported clock frequency: %u\n", xclk_freq);
1392 /* Request the power down GPIO asserted. */
1393 sensor->pwdn = devm_gpiod_get_optional(dev, "pwdn", GPIOD_OUT_HIGH);
1394 if (IS_ERR(sensor->pwdn)) {
1395 dev_err(dev, "Failed to get 'pwdn' gpio\n");
1399 mutex_init(&sensor->lock);
1401 sensor->mode = OV5647_DEFAULT_MODE;
1403 ret = ov5647_init_controls(sensor);
1408 v4l2_i2c_subdev_init(sd, client, &ov5647_subdev_ops);
1409 sd->internal_ops = &ov5647_subdev_internal_ops;
1410 sd->flags |= V4L2_SUBDEV_FL_HAS_DEVNODE | V4L2_SUBDEV_FL_HAS_EVENTS;
1412 sensor->pad.flags = MEDIA_PAD_FL_SOURCE;
1413 sd->entity.function = MEDIA_ENT_F_CAM_SENSOR;
1414 ret = media_entity_pads_init(&sd->entity, 1, &sensor->pad);
1416 goto ctrl_handler_free;
1418 ret = ov5647_power_on(dev);
1420 goto entity_cleanup;
1422 ret = ov5647_detect(sd);
1426 ret = v4l2_async_register_subdev(sd);
1430 /* Enable runtime PM and turn off the device */
1431 pm_runtime_set_active(dev);
1432 pm_runtime_enable(dev);
1433 pm_runtime_idle(dev);
1435 dev_dbg(dev, "OmniVision OV5647 camera driver probed\n");
1440 ov5647_power_off(dev);
1442 media_entity_cleanup(&sd->entity);
1444 v4l2_ctrl_handler_free(&sensor->ctrls);
1446 mutex_destroy(&sensor->lock);
1451 static void ov5647_remove(struct i2c_client *client)
1453 struct v4l2_subdev *sd = i2c_get_clientdata(client);
1454 struct ov5647 *sensor = to_sensor(sd);
1456 v4l2_async_unregister_subdev(&sensor->sd);
1457 media_entity_cleanup(&sensor->sd.entity);
1458 v4l2_ctrl_handler_free(&sensor->ctrls);
1459 v4l2_device_unregister_subdev(sd);
1460 pm_runtime_disable(&client->dev);
1461 mutex_destroy(&sensor->lock);
1464 static const struct dev_pm_ops ov5647_pm_ops = {
1465 SET_RUNTIME_PM_OPS(ov5647_power_off, ov5647_power_on, NULL)
1468 static const struct i2c_device_id ov5647_id[] = {
1472 MODULE_DEVICE_TABLE(i2c, ov5647_id);
1474 #if IS_ENABLED(CONFIG_OF)
1475 static const struct of_device_id ov5647_of_match[] = {
1476 { .compatible = "ovti,ov5647" },
1479 MODULE_DEVICE_TABLE(of, ov5647_of_match);
1482 static struct i2c_driver ov5647_driver = {
1484 .of_match_table = of_match_ptr(ov5647_of_match),
1486 .pm = &ov5647_pm_ops,
1488 .probe_new = ov5647_probe,
1489 .remove = ov5647_remove,
1490 .id_table = ov5647_id,
1493 module_i2c_driver(ov5647_driver);
1495 MODULE_AUTHOR("Ramiro Oliveira <roliveir@synopsys.com>");
1496 MODULE_DESCRIPTION("A low-level driver for OmniVision ov5647 sensors");
1497 MODULE_LICENSE("GPL v2");