1 // SPDX-License-Identifier: GPL-2.0
3 * Omnivision OV2680 CMOS Image Sensor driver
5 * Copyright (C) 2018 Linaro Ltd
7 * Based on OV5640 Sensor Driver
8 * Copyright (C) 2011-2013 Freescale Semiconductor, Inc. All Rights Reserved.
9 * Copyright (C) 2014-2017 Mentor Graphics Inc.
13 #include <linux/clk.h>
14 #include <linux/delay.h>
15 #include <linux/err.h>
16 #include <linux/gpio/consumer.h>
17 #include <linux/i2c.h>
18 #include <linux/init.h>
19 #include <linux/mod_devicetable.h>
20 #include <linux/module.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/regmap.h>
23 #include <linux/regulator/consumer.h>
25 #include <media/v4l2-cci.h>
26 #include <media/v4l2-common.h>
27 #include <media/v4l2-ctrls.h>
28 #include <media/v4l2-subdev.h>
30 #define OV2680_CHIP_ID 0x2680
32 #define OV2680_REG_STREAM_CTRL CCI_REG8(0x0100)
33 #define OV2680_REG_SOFT_RESET CCI_REG8(0x0103)
35 #define OV2680_REG_CHIP_ID CCI_REG16(0x300a)
36 #define OV2680_REG_SC_CMMN_SUB_ID CCI_REG8(0x302a)
37 #define OV2680_REG_PLL_MULTIPLIER CCI_REG16(0x3081)
39 #define OV2680_REG_EXPOSURE_PK CCI_REG24(0x3500)
40 #define OV2680_REG_R_MANUAL CCI_REG8(0x3503)
41 #define OV2680_REG_GAIN_PK CCI_REG16(0x350a)
43 #define OV2680_REG_SENSOR_CTRL_0A CCI_REG8(0x370a)
45 #define OV2680_REG_HORIZONTAL_START CCI_REG16(0x3800)
46 #define OV2680_REG_VERTICAL_START CCI_REG16(0x3802)
47 #define OV2680_REG_HORIZONTAL_END CCI_REG16(0x3804)
48 #define OV2680_REG_VERTICAL_END CCI_REG16(0x3806)
49 #define OV2680_REG_HORIZONTAL_OUTPUT_SIZE CCI_REG16(0x3808)
50 #define OV2680_REG_VERTICAL_OUTPUT_SIZE CCI_REG16(0x380a)
51 #define OV2680_REG_TIMING_HTS CCI_REG16(0x380c)
52 #define OV2680_REG_TIMING_VTS CCI_REG16(0x380e)
53 #define OV2680_REG_ISP_X_WIN CCI_REG16(0x3810)
54 #define OV2680_REG_ISP_Y_WIN CCI_REG16(0x3812)
55 #define OV2680_REG_X_INC CCI_REG8(0x3814)
56 #define OV2680_REG_Y_INC CCI_REG8(0x3815)
57 #define OV2680_REG_FORMAT1 CCI_REG8(0x3820)
58 #define OV2680_REG_FORMAT2 CCI_REG8(0x3821)
60 #define OV2680_REG_ISP_CTRL00 CCI_REG8(0x5080)
62 #define OV2680_REG_X_WIN CCI_REG16(0x5704)
63 #define OV2680_REG_Y_WIN CCI_REG16(0x5706)
65 #define OV2680_FRAME_RATE 30
67 #define OV2680_NATIVE_WIDTH 1616
68 #define OV2680_NATIVE_HEIGHT 1216
69 #define OV2680_NATIVE_START_LEFT 0
70 #define OV2680_NATIVE_START_TOP 0
71 #define OV2680_ACTIVE_WIDTH 1600
72 #define OV2680_ACTIVE_HEIGHT 1200
73 #define OV2680_ACTIVE_START_LEFT 8
74 #define OV2680_ACTIVE_START_TOP 8
75 #define OV2680_MIN_CROP_WIDTH 2
76 #define OV2680_MIN_CROP_HEIGHT 2
78 /* Fixed pre-div of 1/2 */
79 #define OV2680_PLL_PREDIV0 2
81 /* Pre-div configurable through reg 0x3080, left at its default of 0x02 : 1/2 */
82 #define OV2680_PLL_PREDIV 2
84 /* 66MHz pixel clock: 66MHz / 1704 * 1294 = 30fps */
85 #define OV2680_PIXELS_PER_LINE 1704
86 #define OV2680_LINES_PER_FRAME 1294
88 /* If possible send 16 extra rows / lines to the ISP as padding */
89 #define OV2680_END_MARGIN 16
91 /* Max exposure time is VTS - 8 */
92 #define OV2680_INTEGRATION_TIME_MARGIN 8
94 #define OV2680_DEFAULT_WIDTH 800
95 #define OV2680_DEFAULT_HEIGHT 600
97 /* For enum_frame_size() full-size + binned-/quarter-size */
98 #define OV2680_FRAME_SIZES 2
100 static const char * const ov2680_supply_name[] = {
106 #define OV2680_NUM_SUPPLIES ARRAY_SIZE(ov2680_supply_name)
113 static const unsigned long ov2680_xvclk_freqs[] = {
114 [OV2680_19_2_MHZ] = 19200000,
115 [OV2680_24_MHZ] = 24000000,
118 static const u8 ov2680_pll_multipliers[] = {
119 [OV2680_19_2_MHZ] = 69,
120 [OV2680_24_MHZ] = 55,
123 struct ov2680_ctrls {
124 struct v4l2_ctrl_handler handler;
125 struct v4l2_ctrl *exposure;
126 struct v4l2_ctrl *gain;
127 struct v4l2_ctrl *hflip;
128 struct v4l2_ctrl *vflip;
129 struct v4l2_ctrl *test_pattern;
130 struct v4l2_ctrl *link_freq;
131 struct v4l2_ctrl *pixel_rate;
135 struct v4l2_rect crop;
136 struct v4l2_mbus_framefmt fmt;
137 struct v4l2_fract frame_interval;
151 struct regmap *regmap;
152 struct v4l2_subdev sd;
154 struct media_pad pad;
160 struct regulator_bulk_data supplies[OV2680_NUM_SUPPLIES];
162 struct gpio_desc *pwdn_gpio;
163 struct mutex lock; /* protect members */
167 struct ov2680_ctrls ctrls;
168 struct ov2680_mode mode;
171 static const struct v4l2_rect ov2680_default_crop = {
172 .left = OV2680_ACTIVE_START_LEFT,
173 .top = OV2680_ACTIVE_START_TOP,
174 .width = OV2680_ACTIVE_WIDTH,
175 .height = OV2680_ACTIVE_HEIGHT,
178 static const char * const test_pattern_menu[] = {
186 static const int ov2680_hv_flip_bayer_order[] = {
187 MEDIA_BUS_FMT_SBGGR10_1X10,
188 MEDIA_BUS_FMT_SGRBG10_1X10,
189 MEDIA_BUS_FMT_SGBRG10_1X10,
190 MEDIA_BUS_FMT_SRGGB10_1X10,
193 static const struct reg_sequence ov2680_global_setting[] = {
194 /* MIPI PHY, 0x10 -> 0x1c enable bp_c_hs_en_lat and bp_d_hs_en_lat */
197 /* R MANUAL set exposure and gain to manual (hw does not do auto) */
200 /* Analog control register tweaks */
201 {0x3603, 0x39}, /* Reset value 0x99 */
202 {0x3604, 0x24}, /* Reset value 0x74 */
203 {0x3621, 0x37}, /* Reset value 0x44 */
205 /* Sensor control register tweaks */
206 {0x3701, 0x64}, /* Reset value 0x61 */
207 {0x3705, 0x3c}, /* Reset value 0x21 */
208 {0x370c, 0x50}, /* Reset value 0x10 */
209 {0x370d, 0xc0}, /* Reset value 0x00 */
210 {0x3718, 0x88}, /* Reset value 0x80 */
213 {0x3781, 0x80}, /* Reset value 0x00 */
214 {0x3784, 0x0c}, /* Reset value 0x00, based on OV2680_R1A_AM10.ovt */
215 {0x3789, 0x60}, /* Reset value 0x50 */
217 /* BLC CTRL00 0x01 -> 0x81 set avg_weight to 8 */
220 /* Set black level compensation range to 0 - 3 (default 0 - 11) */
224 /* VFIFO R2 0x00 -> 0x02 set Frame reset enable */
227 /* MIPI ctrl CLK PREPARE MIN change from 0x26 (38) -> 0x36 (54) */
230 /* MIPI ctrl CLK LPX P MIN change from 0x32 (50) -> 0x36 (54) */
233 /* R ISP CTRL2 0x20 -> 0x30, set sof_sel bit */
237 * Window CONTROL 0x00 -> 0x01, enable manual window control,
238 * this is necessary for full size flip and mirror support.
243 * DPC CTRL0 0x14 -> 0x3e, set enable_tail, enable_3x3_cluster
244 * and enable_general_tail bits based OV2680_R1A_AM10.ovt.
248 /* DPC MORE CONNECTION CASE THRE 0x0c (12) -> 0x02 (2) */
251 /* DPC GAIN LIST1 0x0f (15) -> 0x08 (8) */
254 /* DPC GAIN LIST2 0x3f (63) -> 0x0c (12) */
257 /* DPC THRE RATIO 0x04 (4) -> 0x00 (0) */
261 static struct ov2680_dev *to_ov2680_dev(struct v4l2_subdev *sd)
263 return container_of(sd, struct ov2680_dev, sd);
266 static inline struct v4l2_subdev *ctrl_to_sd(struct v4l2_ctrl *ctrl)
268 return &container_of(ctrl->handler, struct ov2680_dev,
272 static void ov2680_power_up(struct ov2680_dev *sensor)
274 if (!sensor->pwdn_gpio)
277 gpiod_set_value(sensor->pwdn_gpio, 0);
278 usleep_range(5000, 10000);
281 static void ov2680_power_down(struct ov2680_dev *sensor)
283 if (!sensor->pwdn_gpio)
286 gpiod_set_value(sensor->pwdn_gpio, 1);
287 usleep_range(5000, 10000);
290 static void ov2680_set_bayer_order(struct ov2680_dev *sensor,
291 struct v4l2_mbus_framefmt *fmt)
295 if (sensor->ctrls.vflip && sensor->ctrls.vflip->val)
298 if (sensor->ctrls.hflip && sensor->ctrls.hflip->val)
301 fmt->code = ov2680_hv_flip_bayer_order[hv_flip];
304 static struct v4l2_mbus_framefmt *
305 __ov2680_get_pad_format(struct ov2680_dev *sensor,
306 struct v4l2_subdev_state *state,
308 enum v4l2_subdev_format_whence which)
310 if (which == V4L2_SUBDEV_FORMAT_TRY)
311 return v4l2_subdev_get_try_format(&sensor->sd, state, pad);
313 return &sensor->mode.fmt;
316 static struct v4l2_rect *
317 __ov2680_get_pad_crop(struct ov2680_dev *sensor,
318 struct v4l2_subdev_state *state,
320 enum v4l2_subdev_format_whence which)
322 if (which == V4L2_SUBDEV_FORMAT_TRY)
323 return v4l2_subdev_get_try_crop(&sensor->sd, state, pad);
325 return &sensor->mode.crop;
328 static void ov2680_fill_format(struct ov2680_dev *sensor,
329 struct v4l2_mbus_framefmt *fmt,
330 unsigned int width, unsigned int height)
332 memset(fmt, 0, sizeof(*fmt));
334 fmt->height = height;
335 fmt->field = V4L2_FIELD_NONE;
336 fmt->colorspace = V4L2_COLORSPACE_SRGB;
337 ov2680_set_bayer_order(sensor, fmt);
340 static void ov2680_calc_mode(struct ov2680_dev *sensor)
342 int width = sensor->mode.fmt.width;
343 int height = sensor->mode.fmt.height;
344 int orig_width = width;
345 int orig_height = height;
347 if (width <= (sensor->mode.crop.width / 2) &&
348 height <= (sensor->mode.crop.height / 2)) {
349 sensor->mode.binning = true;
353 sensor->mode.binning = false;
356 sensor->mode.h_start = (sensor->mode.crop.left +
357 (sensor->mode.crop.width - width) / 2) & ~1;
358 sensor->mode.v_start = (sensor->mode.crop.top +
359 (sensor->mode.crop.height - height) / 2) & ~1;
361 min(sensor->mode.h_start + width + OV2680_END_MARGIN - 1,
362 OV2680_NATIVE_WIDTH - 1);
364 min(sensor->mode.v_start + height + OV2680_END_MARGIN - 1,
365 OV2680_NATIVE_HEIGHT - 1);
366 sensor->mode.h_output_size = orig_width;
367 sensor->mode.v_output_size = orig_height;
368 sensor->mode.hts = OV2680_PIXELS_PER_LINE;
369 sensor->mode.vts = OV2680_LINES_PER_FRAME;
372 static int ov2680_set_mode(struct ov2680_dev *sensor)
374 u8 sensor_ctrl_0a, inc, fmt1, fmt2;
377 if (sensor->mode.binning) {
378 sensor_ctrl_0a = 0x23;
383 sensor_ctrl_0a = 0x21;
389 cci_write(sensor->regmap, OV2680_REG_SENSOR_CTRL_0A,
390 sensor_ctrl_0a, &ret);
391 cci_write(sensor->regmap, OV2680_REG_HORIZONTAL_START,
392 sensor->mode.h_start, &ret);
393 cci_write(sensor->regmap, OV2680_REG_VERTICAL_START,
394 sensor->mode.v_start, &ret);
395 cci_write(sensor->regmap, OV2680_REG_HORIZONTAL_END,
396 sensor->mode.h_end, &ret);
397 cci_write(sensor->regmap, OV2680_REG_VERTICAL_END,
398 sensor->mode.v_end, &ret);
399 cci_write(sensor->regmap, OV2680_REG_HORIZONTAL_OUTPUT_SIZE,
400 sensor->mode.h_output_size, &ret);
401 cci_write(sensor->regmap, OV2680_REG_VERTICAL_OUTPUT_SIZE,
402 sensor->mode.v_output_size, &ret);
403 cci_write(sensor->regmap, OV2680_REG_TIMING_HTS,
404 sensor->mode.hts, &ret);
405 cci_write(sensor->regmap, OV2680_REG_TIMING_VTS,
406 sensor->mode.vts, &ret);
407 cci_write(sensor->regmap, OV2680_REG_ISP_X_WIN, 0, &ret);
408 cci_write(sensor->regmap, OV2680_REG_ISP_Y_WIN, 0, &ret);
409 cci_write(sensor->regmap, OV2680_REG_X_INC, inc, &ret);
410 cci_write(sensor->regmap, OV2680_REG_Y_INC, inc, &ret);
411 cci_write(sensor->regmap, OV2680_REG_X_WIN,
412 sensor->mode.h_output_size, &ret);
413 cci_write(sensor->regmap, OV2680_REG_Y_WIN,
414 sensor->mode.v_output_size, &ret);
415 cci_write(sensor->regmap, OV2680_REG_FORMAT1, fmt1, &ret);
416 cci_write(sensor->regmap, OV2680_REG_FORMAT2, fmt2, &ret);
421 static int ov2680_set_vflip(struct ov2680_dev *sensor, s32 val)
425 if (sensor->is_streaming)
428 ret = cci_update_bits(sensor->regmap, OV2680_REG_FORMAT1,
429 BIT(2), val ? BIT(2) : 0, NULL);
433 ov2680_set_bayer_order(sensor, &sensor->mode.fmt);
437 static int ov2680_set_hflip(struct ov2680_dev *sensor, s32 val)
441 if (sensor->is_streaming)
444 ret = cci_update_bits(sensor->regmap, OV2680_REG_FORMAT2,
445 BIT(2), val ? BIT(2) : 0, NULL);
449 ov2680_set_bayer_order(sensor, &sensor->mode.fmt);
453 static int ov2680_test_pattern_set(struct ov2680_dev *sensor, int value)
458 return cci_update_bits(sensor->regmap, OV2680_REG_ISP_CTRL00,
461 cci_update_bits(sensor->regmap, OV2680_REG_ISP_CTRL00,
462 0x03, value - 1, &ret);
463 cci_update_bits(sensor->regmap, OV2680_REG_ISP_CTRL00,
464 BIT(7), BIT(7), &ret);
469 static int ov2680_gain_set(struct ov2680_dev *sensor, u32 gain)
471 return cci_write(sensor->regmap, OV2680_REG_GAIN_PK, gain, NULL);
474 static int ov2680_exposure_set(struct ov2680_dev *sensor, u32 exp)
476 return cci_write(sensor->regmap, OV2680_REG_EXPOSURE_PK, exp << 4,
480 static int ov2680_stream_enable(struct ov2680_dev *sensor)
484 ret = cci_write(sensor->regmap, OV2680_REG_PLL_MULTIPLIER,
485 sensor->pll_mult, NULL);
489 ret = regmap_multi_reg_write(sensor->regmap,
490 ov2680_global_setting,
491 ARRAY_SIZE(ov2680_global_setting));
495 ret = ov2680_set_mode(sensor);
499 /* Restore value of all ctrls */
500 ret = __v4l2_ctrl_handler_setup(&sensor->ctrls.handler);
504 return cci_write(sensor->regmap, OV2680_REG_STREAM_CTRL, 1, NULL);
507 static int ov2680_stream_disable(struct ov2680_dev *sensor)
509 return cci_write(sensor->regmap, OV2680_REG_STREAM_CTRL, 0, NULL);
512 static int ov2680_power_off(struct ov2680_dev *sensor)
514 clk_disable_unprepare(sensor->xvclk);
515 ov2680_power_down(sensor);
516 regulator_bulk_disable(OV2680_NUM_SUPPLIES, sensor->supplies);
520 static int ov2680_power_on(struct ov2680_dev *sensor)
524 ret = regulator_bulk_enable(OV2680_NUM_SUPPLIES, sensor->supplies);
526 dev_err(sensor->dev, "failed to enable regulators: %d\n", ret);
530 if (!sensor->pwdn_gpio) {
531 ret = cci_write(sensor->regmap, OV2680_REG_SOFT_RESET, 0x01,
534 dev_err(sensor->dev, "sensor soft reset failed\n");
535 goto err_disable_regulators;
537 usleep_range(1000, 2000);
539 ov2680_power_down(sensor);
540 ov2680_power_up(sensor);
543 ret = clk_prepare_enable(sensor->xvclk);
545 goto err_disable_regulators;
549 err_disable_regulators:
550 regulator_bulk_disable(OV2680_NUM_SUPPLIES, sensor->supplies);
554 static int ov2680_s_g_frame_interval(struct v4l2_subdev *sd,
555 struct v4l2_subdev_frame_interval *fi)
557 struct ov2680_dev *sensor = to_ov2680_dev(sd);
559 mutex_lock(&sensor->lock);
560 fi->interval = sensor->mode.frame_interval;
561 mutex_unlock(&sensor->lock);
566 static int ov2680_s_stream(struct v4l2_subdev *sd, int enable)
568 struct ov2680_dev *sensor = to_ov2680_dev(sd);
571 mutex_lock(&sensor->lock);
573 if (sensor->is_streaming == !!enable)
577 ret = pm_runtime_resume_and_get(sensor->sd.dev);
581 ret = ov2680_stream_enable(sensor);
583 pm_runtime_put(sensor->sd.dev);
587 ret = ov2680_stream_disable(sensor);
588 pm_runtime_put(sensor->sd.dev);
591 sensor->is_streaming = !!enable;
594 mutex_unlock(&sensor->lock);
599 static int ov2680_enum_mbus_code(struct v4l2_subdev *sd,
600 struct v4l2_subdev_state *sd_state,
601 struct v4l2_subdev_mbus_code_enum *code)
603 struct ov2680_dev *sensor = to_ov2680_dev(sd);
605 if (code->index != 0)
608 code->code = sensor->mode.fmt.code;
613 static int ov2680_get_fmt(struct v4l2_subdev *sd,
614 struct v4l2_subdev_state *sd_state,
615 struct v4l2_subdev_format *format)
617 struct ov2680_dev *sensor = to_ov2680_dev(sd);
618 struct v4l2_mbus_framefmt *fmt;
620 fmt = __ov2680_get_pad_format(sensor, sd_state, format->pad,
623 mutex_lock(&sensor->lock);
624 format->format = *fmt;
625 mutex_unlock(&sensor->lock);
630 static int ov2680_set_fmt(struct v4l2_subdev *sd,
631 struct v4l2_subdev_state *sd_state,
632 struct v4l2_subdev_format *format)
634 struct ov2680_dev *sensor = to_ov2680_dev(sd);
635 struct v4l2_mbus_framefmt *try_fmt;
636 const struct v4l2_rect *crop;
637 unsigned int width, height;
640 crop = __ov2680_get_pad_crop(sensor, sd_state, format->pad,
643 /* Limit set_fmt max size to crop width / height */
644 width = clamp_val(ALIGN(format->format.width, 2),
645 OV2680_MIN_CROP_WIDTH, crop->width);
646 height = clamp_val(ALIGN(format->format.height, 2),
647 OV2680_MIN_CROP_HEIGHT, crop->height);
649 ov2680_fill_format(sensor, &format->format, width, height);
651 if (format->which == V4L2_SUBDEV_FORMAT_TRY) {
652 try_fmt = v4l2_subdev_get_try_format(sd, sd_state, 0);
653 *try_fmt = format->format;
657 mutex_lock(&sensor->lock);
659 if (sensor->is_streaming) {
664 sensor->mode.fmt = format->format;
665 ov2680_calc_mode(sensor);
668 mutex_unlock(&sensor->lock);
673 static int ov2680_get_selection(struct v4l2_subdev *sd,
674 struct v4l2_subdev_state *state,
675 struct v4l2_subdev_selection *sel)
677 struct ov2680_dev *sensor = to_ov2680_dev(sd);
679 switch (sel->target) {
680 case V4L2_SEL_TGT_CROP:
681 mutex_lock(&sensor->lock);
682 sel->r = *__ov2680_get_pad_crop(sensor, state, sel->pad,
684 mutex_unlock(&sensor->lock);
686 case V4L2_SEL_TGT_NATIVE_SIZE:
687 case V4L2_SEL_TGT_CROP_BOUNDS:
690 sel->r.width = OV2680_NATIVE_WIDTH;
691 sel->r.height = OV2680_NATIVE_HEIGHT;
693 case V4L2_SEL_TGT_CROP_DEFAULT:
694 sel->r = ov2680_default_crop;
703 static int ov2680_set_selection(struct v4l2_subdev *sd,
704 struct v4l2_subdev_state *state,
705 struct v4l2_subdev_selection *sel)
707 struct ov2680_dev *sensor = to_ov2680_dev(sd);
708 struct v4l2_mbus_framefmt *format;
709 struct v4l2_rect *crop;
710 struct v4l2_rect rect;
712 if (sel->target != V4L2_SEL_TGT_CROP)
716 * Clamp the boundaries of the crop rectangle to the size of the sensor
717 * pixel array. Align to multiples of 2 to ensure Bayer pattern isn't
720 rect.left = clamp_val(ALIGN(sel->r.left, 2),
721 OV2680_NATIVE_START_LEFT, OV2680_NATIVE_WIDTH);
722 rect.top = clamp_val(ALIGN(sel->r.top, 2),
723 OV2680_NATIVE_START_TOP, OV2680_NATIVE_HEIGHT);
724 rect.width = clamp_val(ALIGN(sel->r.width, 2),
725 OV2680_MIN_CROP_WIDTH, OV2680_NATIVE_WIDTH);
726 rect.height = clamp_val(ALIGN(sel->r.height, 2),
727 OV2680_MIN_CROP_HEIGHT, OV2680_NATIVE_HEIGHT);
729 /* Make sure the crop rectangle isn't outside the bounds of the array */
730 rect.width = min_t(unsigned int, rect.width,
731 OV2680_NATIVE_WIDTH - rect.left);
732 rect.height = min_t(unsigned int, rect.height,
733 OV2680_NATIVE_HEIGHT - rect.top);
735 crop = __ov2680_get_pad_crop(sensor, state, sel->pad, sel->which);
737 mutex_lock(&sensor->lock);
738 if (rect.width != crop->width || rect.height != crop->height) {
740 * Reset the output image size if the crop rectangle size has
743 format = __ov2680_get_pad_format(sensor, state, sel->pad,
745 format->width = rect.width;
746 format->height = rect.height;
750 mutex_unlock(&sensor->lock);
757 static int ov2680_init_cfg(struct v4l2_subdev *sd,
758 struct v4l2_subdev_state *sd_state)
760 struct ov2680_dev *sensor = to_ov2680_dev(sd);
762 sd_state->pads[0].try_crop = ov2680_default_crop;
764 ov2680_fill_format(sensor, &sd_state->pads[0].try_fmt,
765 OV2680_DEFAULT_WIDTH, OV2680_DEFAULT_HEIGHT);
769 static int ov2680_enum_frame_size(struct v4l2_subdev *sd,
770 struct v4l2_subdev_state *sd_state,
771 struct v4l2_subdev_frame_size_enum *fse)
773 struct ov2680_dev *sensor = to_ov2680_dev(sd);
774 struct v4l2_rect *crop;
776 if (fse->index >= OV2680_FRAME_SIZES)
779 crop = __ov2680_get_pad_crop(sensor, sd_state, fse->pad, fse->which);
783 fse->min_width = crop->width / (fse->index + 1);
784 fse->min_height = crop->height / (fse->index + 1);
785 fse->max_width = fse->min_width;
786 fse->max_height = fse->min_height;
791 static bool ov2680_valid_frame_size(struct v4l2_subdev *sd,
792 struct v4l2_subdev_state *sd_state,
793 struct v4l2_subdev_frame_interval_enum *fie)
795 struct v4l2_subdev_frame_size_enum fse = {
801 for (i = 0; i < OV2680_FRAME_SIZES; i++) {
804 if (ov2680_enum_frame_size(sd, sd_state, &fse))
807 if (fie->width == fse.min_width &&
808 fie->height == fse.min_height)
815 static int ov2680_enum_frame_interval(struct v4l2_subdev *sd,
816 struct v4l2_subdev_state *sd_state,
817 struct v4l2_subdev_frame_interval_enum *fie)
819 struct ov2680_dev *sensor = to_ov2680_dev(sd);
821 /* Only 1 framerate */
822 if (fie->index || !ov2680_valid_frame_size(sd, sd_state, fie))
825 fie->interval = sensor->mode.frame_interval;
830 static int ov2680_s_ctrl(struct v4l2_ctrl *ctrl)
832 struct v4l2_subdev *sd = ctrl_to_sd(ctrl);
833 struct ov2680_dev *sensor = to_ov2680_dev(sd);
836 /* Only apply changes to the controls if the device is powered up */
837 if (!pm_runtime_get_if_in_use(sensor->sd.dev)) {
838 ov2680_set_bayer_order(sensor, &sensor->mode.fmt);
843 case V4L2_CID_ANALOGUE_GAIN:
844 ret = ov2680_gain_set(sensor, ctrl->val);
846 case V4L2_CID_EXPOSURE:
847 ret = ov2680_exposure_set(sensor, ctrl->val);
850 ret = ov2680_set_vflip(sensor, ctrl->val);
853 ret = ov2680_set_hflip(sensor, ctrl->val);
855 case V4L2_CID_TEST_PATTERN:
856 ret = ov2680_test_pattern_set(sensor, ctrl->val);
863 pm_runtime_put(sensor->sd.dev);
867 static const struct v4l2_ctrl_ops ov2680_ctrl_ops = {
868 .s_ctrl = ov2680_s_ctrl,
871 static const struct v4l2_subdev_video_ops ov2680_video_ops = {
872 .g_frame_interval = ov2680_s_g_frame_interval,
873 .s_frame_interval = ov2680_s_g_frame_interval,
874 .s_stream = ov2680_s_stream,
877 static const struct v4l2_subdev_pad_ops ov2680_pad_ops = {
878 .init_cfg = ov2680_init_cfg,
879 .enum_mbus_code = ov2680_enum_mbus_code,
880 .enum_frame_size = ov2680_enum_frame_size,
881 .enum_frame_interval = ov2680_enum_frame_interval,
882 .get_fmt = ov2680_get_fmt,
883 .set_fmt = ov2680_set_fmt,
884 .get_selection = ov2680_get_selection,
885 .set_selection = ov2680_set_selection,
888 static const struct v4l2_subdev_ops ov2680_subdev_ops = {
889 .video = &ov2680_video_ops,
890 .pad = &ov2680_pad_ops,
893 static int ov2680_mode_init(struct ov2680_dev *sensor)
895 /* set initial mode */
896 sensor->mode.crop = ov2680_default_crop;
897 ov2680_fill_format(sensor, &sensor->mode.fmt,
898 OV2680_DEFAULT_WIDTH, OV2680_DEFAULT_HEIGHT);
899 ov2680_calc_mode(sensor);
901 sensor->mode.frame_interval.denominator = OV2680_FRAME_RATE;
902 sensor->mode.frame_interval.numerator = 1;
907 static int ov2680_v4l2_register(struct ov2680_dev *sensor)
909 struct i2c_client *client = to_i2c_client(sensor->dev);
910 const struct v4l2_ctrl_ops *ops = &ov2680_ctrl_ops;
911 struct ov2680_ctrls *ctrls = &sensor->ctrls;
912 struct v4l2_ctrl_handler *hdl = &ctrls->handler;
913 int exp_max = OV2680_LINES_PER_FRAME - OV2680_INTEGRATION_TIME_MARGIN;
916 v4l2_i2c_subdev_init(&sensor->sd, client, &ov2680_subdev_ops);
918 sensor->sd.flags = V4L2_SUBDEV_FL_HAS_DEVNODE;
919 sensor->pad.flags = MEDIA_PAD_FL_SOURCE;
920 sensor->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
922 ret = media_entity_pads_init(&sensor->sd.entity, 1, &sensor->pad);
926 v4l2_ctrl_handler_init(hdl, 5);
928 hdl->lock = &sensor->lock;
930 ctrls->vflip = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_VFLIP, 0, 1, 1, 0);
931 ctrls->hflip = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_HFLIP, 0, 1, 1, 0);
933 ctrls->test_pattern = v4l2_ctrl_new_std_menu_items(hdl,
934 &ov2680_ctrl_ops, V4L2_CID_TEST_PATTERN,
935 ARRAY_SIZE(test_pattern_menu) - 1,
936 0, 0, test_pattern_menu);
938 ctrls->exposure = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_EXPOSURE,
939 0, exp_max, 1, exp_max);
941 ctrls->gain = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_ANALOGUE_GAIN,
944 ctrls->link_freq = v4l2_ctrl_new_int_menu(hdl, NULL, V4L2_CID_LINK_FREQ,
945 0, 0, sensor->link_freq);
946 ctrls->pixel_rate = v4l2_ctrl_new_std(hdl, NULL, V4L2_CID_PIXEL_RATE,
947 0, sensor->pixel_rate,
948 1, sensor->pixel_rate);
955 ctrls->vflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
956 ctrls->hflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
957 ctrls->link_freq->flags |= V4L2_CTRL_FLAG_READ_ONLY;
959 sensor->sd.ctrl_handler = hdl;
961 ret = v4l2_async_register_subdev(&sensor->sd);
968 media_entity_cleanup(&sensor->sd.entity);
969 v4l2_ctrl_handler_free(hdl);
974 static int ov2680_get_regulators(struct ov2680_dev *sensor)
978 for (i = 0; i < OV2680_NUM_SUPPLIES; i++)
979 sensor->supplies[i].supply = ov2680_supply_name[i];
981 return devm_regulator_bulk_get(sensor->dev,
982 OV2680_NUM_SUPPLIES, sensor->supplies);
985 static int ov2680_check_id(struct ov2680_dev *sensor)
990 cci_read(sensor->regmap, OV2680_REG_CHIP_ID, &chip_id, &ret);
991 cci_read(sensor->regmap, OV2680_REG_SC_CMMN_SUB_ID, &rev, &ret);
993 dev_err(sensor->dev, "failed to read chip id\n");
997 if (chip_id != OV2680_CHIP_ID) {
998 dev_err(sensor->dev, "chip id: 0x%04llx does not match expected 0x%04x\n",
999 chip_id, OV2680_CHIP_ID);
1003 dev_info(sensor->dev, "sensor_revision id = 0x%llx, rev= %lld\n",
1004 chip_id, rev & 0x0f);
1009 static int ov2680_parse_dt(struct ov2680_dev *sensor)
1011 struct device *dev = sensor->dev;
1012 struct fwnode_handle *ep_fwnode;
1013 struct gpio_desc *gpio;
1014 unsigned int rate = 0;
1018 * Sometimes the fwnode graph is initialized by the bridge driver.
1019 * Bridge drivers doing this may also add GPIO mappings, wait for this.
1021 ep_fwnode = fwnode_graph_get_next_endpoint(dev_fwnode(dev), NULL);
1023 return dev_err_probe(dev, -EPROBE_DEFER,
1024 "waiting for fwnode graph endpoint\n");
1026 fwnode_handle_put(ep_fwnode);
1029 * The pin we want is named XSHUTDN in the datasheet. Linux sensor
1030 * drivers have standardized on using "powerdown" as con-id name
1031 * for powerdown or shutdown pins. Older DTB files use "reset",
1032 * so fallback to that if there is no "powerdown" pin.
1034 gpio = devm_gpiod_get_optional(dev, "powerdown", GPIOD_OUT_HIGH);
1036 gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_HIGH);
1038 ret = PTR_ERR_OR_ZERO(gpio);
1040 dev_dbg(dev, "error while getting reset gpio: %d\n", ret);
1044 sensor->pwdn_gpio = gpio;
1046 sensor->xvclk = devm_clk_get_optional(dev, "xvclk");
1047 if (IS_ERR(sensor->xvclk)) {
1048 dev_err(dev, "xvclk clock missing or invalid\n");
1049 return PTR_ERR(sensor->xvclk);
1053 * We could have either a 24MHz or 19.2MHz clock rate from either DT or
1054 * ACPI... but we also need to support the weird IPU3 case which will
1055 * have an external clock AND a clock-frequency property. Check for the
1056 * clock-frequency property and if found, set that rate if we managed
1057 * to acquire a clock. This should cover the ACPI case. If the system
1058 * uses devicetree then the configured rate should already be set, so
1059 * we can just read it.
1061 ret = fwnode_property_read_u32(dev_fwnode(dev), "clock-frequency",
1063 if (ret && !sensor->xvclk)
1064 return dev_err_probe(dev, ret, "invalid clock config\n");
1066 if (!ret && sensor->xvclk) {
1067 ret = clk_set_rate(sensor->xvclk, rate);
1069 return dev_err_probe(dev, ret,
1070 "failed to set clock rate\n");
1073 sensor->xvclk_freq = rate ?: clk_get_rate(sensor->xvclk);
1075 for (i = 0; i < ARRAY_SIZE(ov2680_xvclk_freqs); i++) {
1076 if (sensor->xvclk_freq == ov2680_xvclk_freqs[i])
1080 if (i == ARRAY_SIZE(ov2680_xvclk_freqs))
1081 return dev_err_probe(dev, -EINVAL,
1082 "unsupported xvclk frequency %d Hz\n",
1083 sensor->xvclk_freq);
1085 sensor->pll_mult = ov2680_pll_multipliers[i];
1087 sensor->link_freq[0] = sensor->xvclk_freq / OV2680_PLL_PREDIV0 /
1088 OV2680_PLL_PREDIV * sensor->pll_mult;
1090 /* CSI-2 is double data rate, bus-format is 10 bpp */
1091 sensor->pixel_rate = sensor->link_freq[0] * 2;
1092 do_div(sensor->pixel_rate, 10);
1097 static int ov2680_probe(struct i2c_client *client)
1099 struct device *dev = &client->dev;
1100 struct ov2680_dev *sensor;
1103 sensor = devm_kzalloc(dev, sizeof(*sensor), GFP_KERNEL);
1107 sensor->dev = &client->dev;
1109 sensor->regmap = devm_cci_regmap_init_i2c(client, 16);
1110 if (IS_ERR(sensor->regmap))
1111 return PTR_ERR(sensor->regmap);
1113 ret = ov2680_parse_dt(sensor);
1117 ret = ov2680_mode_init(sensor);
1121 ret = ov2680_get_regulators(sensor);
1123 dev_err(dev, "failed to get regulators\n");
1127 mutex_init(&sensor->lock);
1130 * Power up and verify the chip now, so that if runtime pm is
1131 * disabled the chip is left on and streaming will work.
1133 ret = ov2680_power_on(sensor);
1137 ret = ov2680_check_id(sensor);
1141 pm_runtime_set_active(&client->dev);
1142 pm_runtime_get_noresume(&client->dev);
1143 pm_runtime_enable(&client->dev);
1145 ret = ov2680_v4l2_register(sensor);
1147 goto err_pm_runtime;
1149 pm_runtime_set_autosuspend_delay(&client->dev, 1000);
1150 pm_runtime_use_autosuspend(&client->dev);
1151 pm_runtime_put_autosuspend(&client->dev);
1156 pm_runtime_disable(&client->dev);
1157 pm_runtime_put_noidle(&client->dev);
1159 ov2680_power_off(sensor);
1161 dev_err(dev, "ov2680 init fail: %d\n", ret);
1162 mutex_destroy(&sensor->lock);
1167 static void ov2680_remove(struct i2c_client *client)
1169 struct v4l2_subdev *sd = i2c_get_clientdata(client);
1170 struct ov2680_dev *sensor = to_ov2680_dev(sd);
1172 v4l2_async_unregister_subdev(&sensor->sd);
1173 mutex_destroy(&sensor->lock);
1174 media_entity_cleanup(&sensor->sd.entity);
1175 v4l2_ctrl_handler_free(&sensor->ctrls.handler);
1178 * Disable runtime PM. In case runtime PM is disabled in the kernel,
1179 * make sure to turn power off manually.
1181 pm_runtime_disable(&client->dev);
1182 if (!pm_runtime_status_suspended(&client->dev))
1183 ov2680_power_off(sensor);
1184 pm_runtime_set_suspended(&client->dev);
1187 static int ov2680_suspend(struct device *dev)
1189 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1190 struct ov2680_dev *sensor = to_ov2680_dev(sd);
1192 if (sensor->is_streaming)
1193 ov2680_stream_disable(sensor);
1195 return ov2680_power_off(sensor);
1198 static int ov2680_resume(struct device *dev)
1200 struct v4l2_subdev *sd = dev_get_drvdata(dev);
1201 struct ov2680_dev *sensor = to_ov2680_dev(sd);
1204 ret = ov2680_power_on(sensor);
1206 goto stream_disable;
1208 if (sensor->is_streaming) {
1209 ret = ov2680_stream_enable(sensor);
1211 goto stream_disable;
1217 ov2680_stream_disable(sensor);
1218 sensor->is_streaming = false;
1223 static DEFINE_RUNTIME_DEV_PM_OPS(ov2680_pm_ops, ov2680_suspend, ov2680_resume,
1226 static const struct of_device_id ov2680_dt_ids[] = {
1227 { .compatible = "ovti,ov2680" },
1230 MODULE_DEVICE_TABLE(of, ov2680_dt_ids);
1232 static const struct acpi_device_id ov2680_acpi_ids[] = {
1236 MODULE_DEVICE_TABLE(acpi, ov2680_acpi_ids);
1238 static struct i2c_driver ov2680_i2c_driver = {
1241 .pm = pm_sleep_ptr(&ov2680_pm_ops),
1242 .of_match_table = ov2680_dt_ids,
1243 .acpi_match_table = ov2680_acpi_ids,
1245 .probe = ov2680_probe,
1246 .remove = ov2680_remove,
1248 module_i2c_driver(ov2680_i2c_driver);
1250 MODULE_AUTHOR("Rui Miguel Silva <rui.silva@linaro.org>");
1251 MODULE_DESCRIPTION("OV2680 CMOS Image Sensor driver");
1252 MODULE_LICENSE("GPL v2");