1 // SPDX-License-Identifier: GPL-2.0
3 * Support for OmniVision OV2680 1080p HD camera sensor.
5 * Copyright (c) 2013 Intel Corporation. All Rights Reserved.
6 * Copyright (c) 2023 Hans de Goede <hdegoede@redhat.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version
10 * 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
19 #include <linux/acpi.h>
20 #include <linux/device.h>
21 #include <linux/gpio/consumer.h>
22 #include <linux/gpio/machine.h>
23 #include <linux/i2c.h>
24 #include <linux/module.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/types.h>
28 #include <media/ov_16bit_addr_reg_helpers.h>
29 #include <media/v4l2-device.h>
33 static int ov2680_write_reg_array(struct i2c_client *client,
34 const struct ov2680_reg *reglist)
36 const struct ov2680_reg *next = reglist;
39 for (; next->reg != 0; next++) {
40 ret = ov_write_reg8(client, next->reg, next->val);
48 static void ov2680_set_bayer_order(struct ov2680_dev *sensor, struct v4l2_mbus_framefmt *fmt)
50 static const int ov2680_hv_flip_bayer_order[] = {
51 MEDIA_BUS_FMT_SBGGR10_1X10,
52 MEDIA_BUS_FMT_SGRBG10_1X10,
53 MEDIA_BUS_FMT_SGBRG10_1X10,
54 MEDIA_BUS_FMT_SRGGB10_1X10,
58 if (sensor->ctrls.vflip->val)
61 if (sensor->ctrls.hflip->val)
64 fmt->code = ov2680_hv_flip_bayer_order[hv_flip];
67 static int ov2680_set_vflip(struct ov2680_dev *sensor, s32 val)
71 if (sensor->is_streaming)
74 ret = ov_update_reg(sensor->client, OV2680_REG_FORMAT1, BIT(2), val ? BIT(2) : 0);
78 ov2680_set_bayer_order(sensor, &sensor->mode.fmt);
82 static int ov2680_set_hflip(struct ov2680_dev *sensor, s32 val)
86 if (sensor->is_streaming)
89 ret = ov_update_reg(sensor->client, OV2680_REG_FORMAT2, BIT(2), val ? BIT(2) : 0);
93 ov2680_set_bayer_order(sensor, &sensor->mode.fmt);
97 static int ov2680_exposure_set(struct ov2680_dev *sensor, u32 exp)
99 return ov_write_reg24(sensor->client, OV2680_REG_EXPOSURE_PK_HIGH, exp << 4);
102 static int ov2680_gain_set(struct ov2680_dev *sensor, u32 gain)
104 return ov_write_reg16(sensor->client, OV2680_REG_GAIN_PK, gain);
107 static int ov2680_test_pattern_set(struct ov2680_dev *sensor, int value)
112 return ov_update_reg(sensor->client, OV2680_REG_ISP_CTRL00, BIT(7), 0);
114 ret = ov_update_reg(sensor->client, OV2680_REG_ISP_CTRL00, 0x03, value - 1);
118 ret = ov_update_reg(sensor->client, OV2680_REG_ISP_CTRL00, BIT(7), BIT(7));
125 static int ov2680_s_ctrl(struct v4l2_ctrl *ctrl)
127 struct v4l2_subdev *sd = ctrl_to_sd(ctrl);
128 struct ov2680_dev *sensor = to_ov2680_sensor(sd);
131 /* Only apply changes to the controls if the device is powered up */
132 if (!pm_runtime_get_if_in_use(sensor->sd.dev)) {
133 ov2680_set_bayer_order(sensor, &sensor->mode.fmt);
139 ret = ov2680_set_vflip(sensor, ctrl->val);
142 ret = ov2680_set_hflip(sensor, ctrl->val);
144 case V4L2_CID_EXPOSURE:
145 ret = ov2680_exposure_set(sensor, ctrl->val);
148 ret = ov2680_gain_set(sensor, ctrl->val);
150 case V4L2_CID_TEST_PATTERN:
151 ret = ov2680_test_pattern_set(sensor, ctrl->val);
157 pm_runtime_put(sensor->sd.dev);
161 static const struct v4l2_ctrl_ops ov2680_ctrl_ops = {
162 .s_ctrl = ov2680_s_ctrl,
165 static int ov2680_init_registers(struct v4l2_subdev *sd)
167 struct i2c_client *client = v4l2_get_subdevdata(sd);
170 ret = ov_write_reg8(client, OV2680_SW_RESET, 0x01);
171 ret |= ov2680_write_reg_array(client, ov2680_global_setting);
176 static struct v4l2_mbus_framefmt *
177 __ov2680_get_pad_format(struct ov2680_dev *sensor,
178 struct v4l2_subdev_state *state,
179 unsigned int pad, enum v4l2_subdev_format_whence which)
181 if (which == V4L2_SUBDEV_FORMAT_TRY)
182 return v4l2_subdev_get_try_format(&sensor->sd, state, pad);
184 return &sensor->mode.fmt;
187 static void ov2680_fill_format(struct ov2680_dev *sensor,
188 struct v4l2_mbus_framefmt *fmt,
189 unsigned int width, unsigned int height)
191 memset(fmt, 0, sizeof(*fmt));
193 fmt->height = height;
194 fmt->field = V4L2_FIELD_NONE;
195 ov2680_set_bayer_order(sensor, fmt);
198 static void ov2680_calc_mode(struct ov2680_dev *sensor, int width, int height)
200 int orig_width = width;
201 int orig_height = height;
203 if (width <= (OV2680_NATIVE_WIDTH / 2) &&
204 height <= (OV2680_NATIVE_HEIGHT / 2)) {
205 sensor->mode.binning = true;
209 sensor->mode.binning = false;
212 sensor->mode.h_start = ((OV2680_NATIVE_WIDTH - width) / 2) & ~1;
213 sensor->mode.v_start = ((OV2680_NATIVE_HEIGHT - height) / 2) & ~1;
214 sensor->mode.h_end = min(sensor->mode.h_start + width + OV2680_END_MARGIN - 1,
215 OV2680_NATIVE_WIDTH - 1);
216 sensor->mode.v_end = min(sensor->mode.v_start + height + OV2680_END_MARGIN - 1,
217 OV2680_NATIVE_HEIGHT - 1);
218 sensor->mode.h_output_size = orig_width;
219 sensor->mode.v_output_size = orig_height;
220 sensor->mode.hts = OV2680_PIXELS_PER_LINE;
221 sensor->mode.vts = OV2680_LINES_PER_FRAME;
224 static int ov2680_set_mode(struct ov2680_dev *sensor)
226 struct i2c_client *client = sensor->client;
227 u8 pll_div, unknown, inc, fmt1, fmt2;
230 if (sensor->mode.binning) {
244 ret = ov_write_reg8(client, 0x3086, pll_div);
248 ret = ov_write_reg8(client, 0x370a, unknown);
252 ret = ov_write_reg16(client, OV2680_HORIZONTAL_START_H, sensor->mode.h_start);
256 ret = ov_write_reg16(client, OV2680_VERTICAL_START_H, sensor->mode.v_start);
260 ret = ov_write_reg16(client, OV2680_HORIZONTAL_END_H, sensor->mode.h_end);
264 ret = ov_write_reg16(client, OV2680_VERTICAL_END_H, sensor->mode.v_end);
268 ret = ov_write_reg16(client, OV2680_HORIZONTAL_OUTPUT_SIZE_H,
269 sensor->mode.h_output_size);
273 ret = ov_write_reg16(client, OV2680_VERTICAL_OUTPUT_SIZE_H,
274 sensor->mode.v_output_size);
278 ret = ov_write_reg16(client, OV2680_HTS, sensor->mode.hts);
282 ret = ov_write_reg16(client, OV2680_VTS, sensor->mode.vts);
286 ret = ov_write_reg16(client, OV2680_ISP_X_WIN, 0);
290 ret = ov_write_reg16(client, OV2680_ISP_Y_WIN, 0);
294 ret = ov_write_reg8(client, OV2680_X_INC, inc);
298 ret = ov_write_reg8(client, OV2680_Y_INC, inc);
302 ret = ov_write_reg16(client, OV2680_X_WIN, sensor->mode.h_output_size);
306 ret = ov_write_reg16(client, OV2680_Y_WIN, sensor->mode.v_output_size);
310 ret = ov_write_reg8(client, OV2680_REG_FORMAT1, fmt1);
314 ret = ov_write_reg8(client, OV2680_REG_FORMAT2, fmt2);
321 static int ov2680_set_fmt(struct v4l2_subdev *sd,
322 struct v4l2_subdev_state *sd_state,
323 struct v4l2_subdev_format *format)
325 struct ov2680_dev *sensor = to_ov2680_sensor(sd);
326 struct v4l2_mbus_framefmt *fmt;
327 unsigned int width, height;
329 width = min_t(unsigned int, ALIGN(format->format.width, 2), OV2680_NATIVE_WIDTH);
330 height = min_t(unsigned int, ALIGN(format->format.height, 2), OV2680_NATIVE_HEIGHT);
332 fmt = __ov2680_get_pad_format(sensor, sd_state, format->pad, format->which);
333 ov2680_fill_format(sensor, fmt, width, height);
335 format->format = *fmt;
337 if (format->which == V4L2_SUBDEV_FORMAT_TRY)
340 mutex_lock(&sensor->input_lock);
341 ov2680_calc_mode(sensor, fmt->width, fmt->height);
342 mutex_unlock(&sensor->input_lock);
346 static int ov2680_get_fmt(struct v4l2_subdev *sd,
347 struct v4l2_subdev_state *sd_state,
348 struct v4l2_subdev_format *format)
350 struct ov2680_dev *sensor = to_ov2680_sensor(sd);
351 struct v4l2_mbus_framefmt *fmt;
353 fmt = __ov2680_get_pad_format(sensor, sd_state, format->pad, format->which);
354 format->format = *fmt;
358 static int ov2680_detect(struct i2c_client *client)
360 struct i2c_adapter *adapter = client->adapter;
361 u32 high = 0, low = 0;
366 if (!i2c_check_functionality(adapter, I2C_FUNC_I2C))
369 ret = ov_read_reg8(client, OV2680_SC_CMMN_CHIP_ID_H, &high);
371 dev_err(&client->dev, "sensor_id_high read failed (%d)\n", ret);
374 ret = ov_read_reg8(client, OV2680_SC_CMMN_CHIP_ID_L, &low);
375 id = ((((u16)high) << 8) | (u16)low);
377 if (id != OV2680_ID) {
378 dev_err(&client->dev, "sensor ID error 0x%x\n", id);
382 ret = ov_read_reg8(client, OV2680_SC_CMMN_SUB_ID, &high);
383 revision = (u8)high & 0x0f;
385 dev_info(&client->dev, "sensor_revision id = 0x%x, rev= %d\n",
391 static int ov2680_s_stream(struct v4l2_subdev *sd, int enable)
393 struct ov2680_dev *sensor = to_ov2680_sensor(sd);
394 struct i2c_client *client = v4l2_get_subdevdata(sd);
397 mutex_lock(&sensor->input_lock);
399 if (sensor->is_streaming == enable) {
400 dev_warn(&client->dev, "stream already %s\n", enable ? "started" : "stopped");
405 ret = pm_runtime_get_sync(sensor->sd.dev);
407 goto error_power_down;
409 ret = ov2680_set_mode(sensor);
411 goto error_power_down;
413 /* Restore value of all ctrls */
414 ret = __v4l2_ctrl_handler_setup(&sensor->ctrls.handler);
416 goto error_power_down;
418 ret = ov_write_reg8(client, OV2680_SW_STREAM, OV2680_START_STREAMING);
420 goto error_power_down;
422 ov_write_reg8(client, OV2680_SW_STREAM, OV2680_STOP_STREAMING);
423 pm_runtime_put(sensor->sd.dev);
426 sensor->is_streaming = enable;
427 v4l2_ctrl_activate(sensor->ctrls.vflip, !enable);
428 v4l2_ctrl_activate(sensor->ctrls.hflip, !enable);
430 mutex_unlock(&sensor->input_lock);
434 pm_runtime_put(sensor->sd.dev);
435 sensor->is_streaming = false;
437 mutex_unlock(&sensor->input_lock);
441 static int ov2680_s_config(struct v4l2_subdev *sd)
443 struct i2c_client *client = v4l2_get_subdevdata(sd);
446 ret = pm_runtime_get_sync(&client->dev);
448 dev_err(&client->dev, "ov2680 power-up err.\n");
452 /* config & detect sensor */
453 ret = ov2680_detect(client);
455 dev_err(&client->dev, "ov2680_detect err s_config.\n");
458 pm_runtime_put(&client->dev);
462 static int ov2680_g_frame_interval(struct v4l2_subdev *sd,
463 struct v4l2_subdev_frame_interval *interval)
465 interval->interval.numerator = 1;
466 interval->interval.denominator = OV2680_FPS;
470 static int ov2680_enum_mbus_code(struct v4l2_subdev *sd,
471 struct v4l2_subdev_state *sd_state,
472 struct v4l2_subdev_mbus_code_enum *code)
474 /* We support only a single format */
478 code->code = MEDIA_BUS_FMT_SBGGR10_1X10;
482 static int ov2680_enum_frame_size(struct v4l2_subdev *sd,
483 struct v4l2_subdev_state *sd_state,
484 struct v4l2_subdev_frame_size_enum *fse)
486 static const struct v4l2_frmsize_discrete ov2680_frame_sizes[] = {
496 int index = fse->index;
498 if (index >= ARRAY_SIZE(ov2680_frame_sizes))
501 fse->min_width = ov2680_frame_sizes[index].width;
502 fse->min_height = ov2680_frame_sizes[index].height;
503 fse->max_width = ov2680_frame_sizes[index].width;
504 fse->max_height = ov2680_frame_sizes[index].height;
509 static int ov2680_enum_frame_interval(struct v4l2_subdev *sd,
510 struct v4l2_subdev_state *sd_state,
511 struct v4l2_subdev_frame_interval_enum *fie)
513 /* Only 1 framerate */
517 fie->interval.numerator = 1;
518 fie->interval.denominator = OV2680_FPS;
522 static int ov2680_g_skip_frames(struct v4l2_subdev *sd, u32 *frames)
524 *frames = OV2680_SKIP_FRAMES;
528 static const struct v4l2_subdev_video_ops ov2680_video_ops = {
529 .s_stream = ov2680_s_stream,
530 .g_frame_interval = ov2680_g_frame_interval,
533 static const struct v4l2_subdev_sensor_ops ov2680_sensor_ops = {
534 .g_skip_frames = ov2680_g_skip_frames,
537 static const struct v4l2_subdev_pad_ops ov2680_pad_ops = {
538 .enum_mbus_code = ov2680_enum_mbus_code,
539 .enum_frame_size = ov2680_enum_frame_size,
540 .enum_frame_interval = ov2680_enum_frame_interval,
541 .get_fmt = ov2680_get_fmt,
542 .set_fmt = ov2680_set_fmt,
545 static const struct v4l2_subdev_ops ov2680_ops = {
546 .video = &ov2680_video_ops,
547 .pad = &ov2680_pad_ops,
548 .sensor = &ov2680_sensor_ops,
551 static int ov2680_init_controls(struct ov2680_dev *sensor)
553 static const char * const test_pattern_menu[] = {
560 const struct v4l2_ctrl_ops *ops = &ov2680_ctrl_ops;
561 struct ov2680_ctrls *ctrls = &sensor->ctrls;
562 struct v4l2_ctrl_handler *hdl = &ctrls->handler;
563 int exp_max = OV2680_LINES_PER_FRAME - OV2680_INTEGRATION_TIME_MARGIN;
565 v4l2_ctrl_handler_init(hdl, 4);
567 hdl->lock = &sensor->input_lock;
569 ctrls->hflip = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_HFLIP, 0, 1, 1, 0);
570 ctrls->vflip = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_VFLIP, 0, 1, 1, 0);
571 ctrls->exposure = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_EXPOSURE,
572 0, exp_max, 1, exp_max);
573 ctrls->gain = v4l2_ctrl_new_std(hdl, ops, V4L2_CID_GAIN, 0, 1023, 1, 250);
574 ctrls->test_pattern =
575 v4l2_ctrl_new_std_menu_items(hdl,
576 &ov2680_ctrl_ops, V4L2_CID_TEST_PATTERN,
577 ARRAY_SIZE(test_pattern_menu) - 1,
578 0, 0, test_pattern_menu);
580 ctrls->hflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
581 ctrls->vflip->flags |= V4L2_CTRL_FLAG_MODIFY_LAYOUT;
586 sensor->sd.ctrl_handler = hdl;
590 static void ov2680_remove(struct i2c_client *client)
592 struct v4l2_subdev *sd = i2c_get_clientdata(client);
593 struct ov2680_dev *sensor = to_ov2680_sensor(sd);
595 dev_dbg(&client->dev, "ov2680_remove...\n");
597 v4l2_async_unregister_subdev(&sensor->sd);
598 media_entity_cleanup(&sensor->sd.entity);
599 v4l2_ctrl_handler_free(&sensor->ctrls.handler);
600 mutex_destroy(&sensor->input_lock);
601 fwnode_handle_put(sensor->ep_fwnode);
602 pm_runtime_disable(&client->dev);
605 static int ov2680_probe(struct i2c_client *client)
607 struct device *dev = &client->dev;
608 struct ov2680_dev *sensor;
611 sensor = devm_kzalloc(dev, sizeof(*sensor), GFP_KERNEL);
615 mutex_init(&sensor->input_lock);
617 sensor->client = client;
618 v4l2_i2c_subdev_init(&sensor->sd, client, &ov2680_ops);
621 * Sometimes the fwnode graph is initialized by the bridge driver.
622 * Bridge drivers doing this may also add GPIO mappings, wait for this.
624 sensor->ep_fwnode = fwnode_graph_get_next_endpoint(dev_fwnode(dev), NULL);
625 if (!sensor->ep_fwnode)
626 return dev_err_probe(dev, -EPROBE_DEFER, "waiting for fwnode graph endpoint\n");
628 sensor->powerdown = devm_gpiod_get_optional(dev, "powerdown", GPIOD_OUT_HIGH);
629 if (IS_ERR(sensor->powerdown)) {
630 fwnode_handle_put(sensor->ep_fwnode);
631 return dev_err_probe(dev, PTR_ERR(sensor->powerdown), "getting powerdown GPIO\n");
634 pm_runtime_set_suspended(dev);
635 pm_runtime_enable(dev);
636 pm_runtime_set_autosuspend_delay(dev, 1000);
637 pm_runtime_use_autosuspend(dev);
639 ret = ov2680_s_config(&sensor->sd);
641 ov2680_remove(client);
645 sensor->sd.flags |= V4L2_SUBDEV_FL_HAS_DEVNODE;
646 sensor->pad.flags = MEDIA_PAD_FL_SOURCE;
647 sensor->sd.entity.function = MEDIA_ENT_F_CAM_SENSOR;
648 sensor->sd.fwnode = sensor->ep_fwnode;
650 ret = ov2680_init_controls(sensor);
652 ov2680_remove(client);
656 ret = media_entity_pads_init(&sensor->sd.entity, 1, &sensor->pad);
658 ov2680_remove(client);
662 ov2680_fill_format(sensor, &sensor->mode.fmt, OV2680_NATIVE_WIDTH, OV2680_NATIVE_HEIGHT);
664 ret = v4l2_async_register_subdev_sensor(&sensor->sd);
666 ov2680_remove(client);
673 static int ov2680_suspend(struct device *dev)
675 struct v4l2_subdev *sd = dev_get_drvdata(dev);
676 struct ov2680_dev *sensor = to_ov2680_sensor(sd);
678 gpiod_set_value_cansleep(sensor->powerdown, 1);
682 static int ov2680_resume(struct device *dev)
684 struct v4l2_subdev *sd = dev_get_drvdata(dev);
685 struct ov2680_dev *sensor = to_ov2680_sensor(sd);
687 /* according to DS, at least 5ms is needed after DOVDD (enabled by ACPI) */
688 usleep_range(5000, 6000);
690 gpiod_set_value_cansleep(sensor->powerdown, 0);
692 /* according to DS, 20ms is needed between PWDN and i2c access */
695 ov2680_init_registers(sd);
699 static DEFINE_RUNTIME_DEV_PM_OPS(ov2680_pm_ops, ov2680_suspend, ov2680_resume, NULL);
701 static const struct acpi_device_id ov2680_acpi_match[] = {
706 MODULE_DEVICE_TABLE(acpi, ov2680_acpi_match);
708 static struct i2c_driver ov2680_driver = {
711 .pm = pm_sleep_ptr(&ov2680_pm_ops),
712 .acpi_match_table = ov2680_acpi_match,
714 .probe = ov2680_probe,
715 .remove = ov2680_remove,
717 module_i2c_driver(ov2680_driver);
719 MODULE_AUTHOR("Jacky Wang <Jacky_wang@ovt.com>");
720 MODULE_DESCRIPTION("A low-level driver for OmniVision 2680 sensors");
721 MODULE_LICENSE("GPL");