1 // SPDX-License-Identifier: GPL-2.0-only
3 * vs6624.c ST VS6624 CMOS image sensor driver
5 * Copyright (c) 2011 Analog Devices Inc.
8 #include <linux/delay.h>
9 #include <linux/errno.h>
10 #include <linux/gpio.h>
11 #include <linux/i2c.h>
12 #include <linux/init.h>
13 #include <linux/module.h>
14 #include <linux/slab.h>
15 #include <linux/types.h>
16 #include <linux/videodev2.h>
18 #include <media/v4l2-ctrls.h>
19 #include <media/v4l2-device.h>
20 #include <media/v4l2-mediabus.h>
21 #include <media/v4l2-image-sizes.h>
23 #include "vs6624_regs.h"
25 #define MAX_FRAME_RATE 30
28 struct v4l2_subdev sd;
29 struct v4l2_ctrl_handler hdl;
30 struct v4l2_fract frame_rate;
31 struct v4l2_mbus_framefmt fmt;
35 static const struct vs6624_format {
37 enum v4l2_colorspace colorspace;
38 } vs6624_formats[] = {
40 .mbus_code = MEDIA_BUS_FMT_UYVY8_2X8,
41 .colorspace = V4L2_COLORSPACE_JPEG,
44 .mbus_code = MEDIA_BUS_FMT_YUYV8_2X8,
45 .colorspace = V4L2_COLORSPACE_JPEG,
48 .mbus_code = MEDIA_BUS_FMT_RGB565_2X8_LE,
49 .colorspace = V4L2_COLORSPACE_SRGB,
53 static const struct v4l2_mbus_framefmt vs6624_default_fmt = {
56 .code = MEDIA_BUS_FMT_UYVY8_2X8,
57 .field = V4L2_FIELD_NONE,
58 .colorspace = V4L2_COLORSPACE_JPEG,
63 static const u16 vs6624_p2[] = {
69 static const u16 vs6624_run_setup[] = {
70 0x1d18, 0x00, /* Enableconstrainedwhitebalance */
71 VS6624_PEAK_MIN_OUT_G_MSB, 0x3c, /* Damper PeakGain Output MSB */
72 VS6624_PEAK_MIN_OUT_G_LSB, 0x66, /* Damper PeakGain Output LSB */
73 VS6624_CM_LOW_THR_MSB, 0x65, /* Damper Low MSB */
74 VS6624_CM_LOW_THR_LSB, 0xd1, /* Damper Low LSB */
75 VS6624_CM_HIGH_THR_MSB, 0x66, /* Damper High MSB */
76 VS6624_CM_HIGH_THR_LSB, 0x62, /* Damper High LSB */
77 VS6624_CM_MIN_OUT_MSB, 0x00, /* Damper Min output MSB */
78 VS6624_CM_MIN_OUT_LSB, 0x00, /* Damper Min output LSB */
79 VS6624_NORA_DISABLE, 0x00, /* Nora fDisable */
80 VS6624_NORA_USAGE, 0x04, /* Nora usage */
81 VS6624_NORA_LOW_THR_MSB, 0x63, /* Damper Low MSB Changed 0x63 to 0x65 */
82 VS6624_NORA_LOW_THR_LSB, 0xd1, /* Damper Low LSB */
83 VS6624_NORA_HIGH_THR_MSB, 0x68, /* Damper High MSB */
84 VS6624_NORA_HIGH_THR_LSB, 0xdd, /* Damper High LSB */
85 VS6624_NORA_MIN_OUT_MSB, 0x3a, /* Damper Min output MSB */
86 VS6624_NORA_MIN_OUT_LSB, 0x00, /* Damper Min output LSB */
87 VS6624_F2B_DISABLE, 0x00, /* Disable */
88 0x1d8a, 0x30, /* MAXWeightHigh */
89 0x1d91, 0x62, /* fpDamperLowThresholdHigh MSB */
90 0x1d92, 0x4a, /* fpDamperLowThresholdHigh LSB */
91 0x1d95, 0x65, /* fpDamperHighThresholdHigh MSB */
92 0x1d96, 0x0e, /* fpDamperHighThresholdHigh LSB */
93 0x1da1, 0x3a, /* fpMinimumDamperOutputLow MSB */
94 0x1da2, 0xb8, /* fpMinimumDamperOutputLow LSB */
95 0x1e08, 0x06, /* MAXWeightLow */
96 0x1e0a, 0x0a, /* MAXWeightHigh */
97 0x1601, 0x3a, /* Red A MSB */
98 0x1602, 0x14, /* Red A LSB */
99 0x1605, 0x3b, /* Blue A MSB */
100 0x1606, 0x85, /* BLue A LSB */
101 0x1609, 0x3b, /* RED B MSB */
102 0x160a, 0x85, /* RED B LSB */
103 0x160d, 0x3a, /* Blue B MSB */
104 0x160e, 0x14, /* Blue B LSB */
105 0x1611, 0x30, /* Max Distance from Locus MSB */
106 0x1612, 0x8f, /* Max Distance from Locus MSB */
107 0x1614, 0x01, /* Enable constrainer */
111 static const u16 vs6624_default[] = {
112 VS6624_CONTRAST0, 0x84,
113 VS6624_SATURATION0, 0x75,
115 VS6624_CONTRAST1, 0x84,
116 VS6624_SATURATION1, 0x75,
122 VS6624_EXPO_COMPENSATION, 0xfe,
123 VS6624_EXPO_METER, 0x0,
124 VS6624_LIGHT_FREQ, 0x64,
125 VS6624_PEAK_GAIN, 0xe,
126 VS6624_PEAK_LOW_THR, 0x28,
127 VS6624_HMIRROR0, 0x0,
129 VS6624_ZOOM_HSTEP0_MSB, 0x0,
130 VS6624_ZOOM_HSTEP0_LSB, 0x1,
131 VS6624_ZOOM_VSTEP0_MSB, 0x0,
132 VS6624_ZOOM_VSTEP0_LSB, 0x1,
133 VS6624_PAN_HSTEP0_MSB, 0x0,
134 VS6624_PAN_HSTEP0_LSB, 0xf,
135 VS6624_PAN_VSTEP0_MSB, 0x0,
136 VS6624_PAN_VSTEP0_LSB, 0xf,
137 VS6624_SENSOR_MODE, 0x1,
138 VS6624_SYNC_CODE_SETUP, 0x21,
139 VS6624_DISABLE_FR_DAMPER, 0x0,
141 VS6624_FR_NUM_LSB, 0xf,
142 VS6624_INIT_PIPE_SETUP, 0x0,
143 VS6624_IMG_FMT0, 0x0,
144 VS6624_YUV_SETUP, 0x1,
145 VS6624_IMAGE_SIZE0, 0x2,
149 static inline struct vs6624 *to_vs6624(struct v4l2_subdev *sd)
151 return container_of(sd, struct vs6624, sd);
153 static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
155 return &container_of(ctrl->handler, struct vs6624, hdl)->sd;
158 #ifdef CONFIG_VIDEO_ADV_DEBUG
159 static int vs6624_read(struct v4l2_subdev *sd, u16 index)
161 struct i2c_client *client = v4l2_get_subdevdata(sd);
166 i2c_master_send(client, buf, 2);
167 i2c_master_recv(client, buf, 1);
173 static int vs6624_write(struct v4l2_subdev *sd, u16 index,
176 struct i2c_client *client = v4l2_get_subdevdata(sd);
183 return i2c_master_send(client, buf, 3);
186 static int vs6624_writeregs(struct v4l2_subdev *sd, const u16 *regs)
191 while (*regs != 0x00) {
195 vs6624_write(sd, reg, data);
200 static int vs6624_s_ctrl(struct v4l2_ctrl *ctrl)
202 struct v4l2_subdev *sd = to_sd(ctrl);
205 case V4L2_CID_CONTRAST:
206 vs6624_write(sd, VS6624_CONTRAST0, ctrl->val);
208 case V4L2_CID_SATURATION:
209 vs6624_write(sd, VS6624_SATURATION0, ctrl->val);
212 vs6624_write(sd, VS6624_HMIRROR0, ctrl->val);
215 vs6624_write(sd, VS6624_VFLIP0, ctrl->val);
224 static int vs6624_enum_mbus_code(struct v4l2_subdev *sd,
225 struct v4l2_subdev_pad_config *cfg,
226 struct v4l2_subdev_mbus_code_enum *code)
228 if (code->pad || code->index >= ARRAY_SIZE(vs6624_formats))
231 code->code = vs6624_formats[code->index].mbus_code;
235 static int vs6624_set_fmt(struct v4l2_subdev *sd,
236 struct v4l2_subdev_pad_config *cfg,
237 struct v4l2_subdev_format *format)
239 struct v4l2_mbus_framefmt *fmt = &format->format;
240 struct vs6624 *sensor = to_vs6624(sd);
246 for (index = 0; index < ARRAY_SIZE(vs6624_formats); index++)
247 if (vs6624_formats[index].mbus_code == fmt->code)
249 if (index >= ARRAY_SIZE(vs6624_formats)) {
250 /* default to first format */
252 fmt->code = vs6624_formats[0].mbus_code;
255 /* sensor mode is VGA */
256 if (fmt->width > VGA_WIDTH)
257 fmt->width = VGA_WIDTH;
258 if (fmt->height > VGA_HEIGHT)
259 fmt->height = VGA_HEIGHT;
260 fmt->width = fmt->width & (~3);
261 fmt->height = fmt->height & (~3);
262 fmt->field = V4L2_FIELD_NONE;
263 fmt->colorspace = vs6624_formats[index].colorspace;
265 if (format->which == V4L2_SUBDEV_FORMAT_TRY) {
270 /* set image format */
272 case MEDIA_BUS_FMT_UYVY8_2X8:
273 vs6624_write(sd, VS6624_IMG_FMT0, 0x0);
274 vs6624_write(sd, VS6624_YUV_SETUP, 0x1);
276 case MEDIA_BUS_FMT_YUYV8_2X8:
277 vs6624_write(sd, VS6624_IMG_FMT0, 0x0);
278 vs6624_write(sd, VS6624_YUV_SETUP, 0x3);
280 case MEDIA_BUS_FMT_RGB565_2X8_LE:
281 vs6624_write(sd, VS6624_IMG_FMT0, 0x4);
282 vs6624_write(sd, VS6624_RGB_SETUP, 0x0);
289 if ((fmt->width == VGA_WIDTH) && (fmt->height == VGA_HEIGHT))
290 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x2);
291 else if ((fmt->width == QVGA_WIDTH) && (fmt->height == QVGA_HEIGHT))
292 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x4);
293 else if ((fmt->width == QQVGA_WIDTH) && (fmt->height == QQVGA_HEIGHT))
294 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x6);
295 else if ((fmt->width == CIF_WIDTH) && (fmt->height == CIF_HEIGHT))
296 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x3);
297 else if ((fmt->width == QCIF_WIDTH) && (fmt->height == QCIF_HEIGHT))
298 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x5);
299 else if ((fmt->width == QQCIF_WIDTH) && (fmt->height == QQCIF_HEIGHT))
300 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x7);
302 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x8);
303 vs6624_write(sd, VS6624_MAN_HSIZE0_MSB, fmt->width >> 8);
304 vs6624_write(sd, VS6624_MAN_HSIZE0_LSB, fmt->width & 0xFF);
305 vs6624_write(sd, VS6624_MAN_VSIZE0_MSB, fmt->height >> 8);
306 vs6624_write(sd, VS6624_MAN_VSIZE0_LSB, fmt->height & 0xFF);
307 vs6624_write(sd, VS6624_CROP_CTRL0, 0x1);
315 static int vs6624_get_fmt(struct v4l2_subdev *sd,
316 struct v4l2_subdev_pad_config *cfg,
317 struct v4l2_subdev_format *format)
319 struct vs6624 *sensor = to_vs6624(sd);
324 format->format = sensor->fmt;
328 static int vs6624_g_frame_interval(struct v4l2_subdev *sd,
329 struct v4l2_subdev_frame_interval *ival)
331 struct vs6624 *sensor = to_vs6624(sd);
333 ival->interval.numerator = sensor->frame_rate.denominator;
334 ival->interval.denominator = sensor->frame_rate.numerator;
338 static int vs6624_s_frame_interval(struct v4l2_subdev *sd,
339 struct v4l2_subdev_frame_interval *ival)
341 struct vs6624 *sensor = to_vs6624(sd);
342 struct v4l2_fract *tpf = &ival->interval;
345 if (tpf->numerator == 0 || tpf->denominator == 0
346 || (tpf->denominator > tpf->numerator * MAX_FRAME_RATE)) {
347 /* reset to max frame rate */
349 tpf->denominator = MAX_FRAME_RATE;
351 sensor->frame_rate.numerator = tpf->denominator;
352 sensor->frame_rate.denominator = tpf->numerator;
353 vs6624_write(sd, VS6624_DISABLE_FR_DAMPER, 0x0);
354 vs6624_write(sd, VS6624_FR_NUM_MSB,
355 sensor->frame_rate.numerator >> 8);
356 vs6624_write(sd, VS6624_FR_NUM_LSB,
357 sensor->frame_rate.numerator & 0xFF);
358 vs6624_write(sd, VS6624_FR_DEN,
359 sensor->frame_rate.denominator & 0xFF);
363 static int vs6624_s_stream(struct v4l2_subdev *sd, int enable)
366 vs6624_write(sd, VS6624_USER_CMD, 0x2);
368 vs6624_write(sd, VS6624_USER_CMD, 0x4);
373 #ifdef CONFIG_VIDEO_ADV_DEBUG
374 static int vs6624_g_register(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg)
376 reg->val = vs6624_read(sd, reg->reg & 0xffff);
381 static int vs6624_s_register(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg)
383 vs6624_write(sd, reg->reg & 0xffff, reg->val & 0xff);
388 static const struct v4l2_ctrl_ops vs6624_ctrl_ops = {
389 .s_ctrl = vs6624_s_ctrl,
392 static const struct v4l2_subdev_core_ops vs6624_core_ops = {
393 #ifdef CONFIG_VIDEO_ADV_DEBUG
394 .g_register = vs6624_g_register,
395 .s_register = vs6624_s_register,
399 static const struct v4l2_subdev_video_ops vs6624_video_ops = {
400 .s_frame_interval = vs6624_s_frame_interval,
401 .g_frame_interval = vs6624_g_frame_interval,
402 .s_stream = vs6624_s_stream,
405 static const struct v4l2_subdev_pad_ops vs6624_pad_ops = {
406 .enum_mbus_code = vs6624_enum_mbus_code,
407 .get_fmt = vs6624_get_fmt,
408 .set_fmt = vs6624_set_fmt,
411 static const struct v4l2_subdev_ops vs6624_ops = {
412 .core = &vs6624_core_ops,
413 .video = &vs6624_video_ops,
414 .pad = &vs6624_pad_ops,
417 static int vs6624_probe(struct i2c_client *client,
418 const struct i2c_device_id *id)
420 struct vs6624 *sensor;
421 struct v4l2_subdev *sd;
422 struct v4l2_ctrl_handler *hdl;
426 /* Check if the adapter supports the needed features */
427 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
430 ce = client->dev.platform_data;
434 ret = devm_gpio_request_one(&client->dev, *ce, GPIOF_OUT_INIT_HIGH,
435 "VS6624 Chip Enable");
437 v4l_err(client, "failed to request GPIO %d\n", *ce);
440 /* wait 100ms before any further i2c writes are performed */
443 sensor = devm_kzalloc(&client->dev, sizeof(*sensor), GFP_KERNEL);
448 v4l2_i2c_subdev_init(sd, client, &vs6624_ops);
451 vs6624_write(sd, VS6624_MICRO_EN, 0x2);
452 vs6624_write(sd, VS6624_DIO_EN, 0x1);
453 usleep_range(10000, 11000);
454 vs6624_writeregs(sd, vs6624_p2);
456 vs6624_writeregs(sd, vs6624_default);
457 vs6624_write(sd, VS6624_HSYNC_SETUP, 0xF);
458 vs6624_writeregs(sd, vs6624_run_setup);
461 sensor->frame_rate.numerator = MAX_FRAME_RATE;
462 sensor->frame_rate.denominator = 1;
463 vs6624_write(sd, VS6624_DISABLE_FR_DAMPER, 0x0);
464 vs6624_write(sd, VS6624_FR_NUM_MSB,
465 sensor->frame_rate.numerator >> 8);
466 vs6624_write(sd, VS6624_FR_NUM_LSB,
467 sensor->frame_rate.numerator & 0xFF);
468 vs6624_write(sd, VS6624_FR_DEN,
469 sensor->frame_rate.denominator & 0xFF);
471 sensor->fmt = vs6624_default_fmt;
472 sensor->ce_pin = *ce;
474 v4l_info(client, "chip found @ 0x%02x (%s)\n",
475 client->addr << 1, client->adapter->name);
478 v4l2_ctrl_handler_init(hdl, 4);
479 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
480 V4L2_CID_CONTRAST, 0, 0xFF, 1, 0x87);
481 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
482 V4L2_CID_SATURATION, 0, 0xFF, 1, 0x78);
483 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
484 V4L2_CID_HFLIP, 0, 1, 1, 0);
485 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
486 V4L2_CID_VFLIP, 0, 1, 1, 0);
487 /* hook the control handler into the driver */
488 sd->ctrl_handler = hdl;
490 int err = hdl->error;
492 v4l2_ctrl_handler_free(hdl);
496 /* initialize the hardware to the default control values */
497 ret = v4l2_ctrl_handler_setup(hdl);
499 v4l2_ctrl_handler_free(hdl);
503 static int vs6624_remove(struct i2c_client *client)
505 struct v4l2_subdev *sd = i2c_get_clientdata(client);
507 v4l2_device_unregister_subdev(sd);
508 v4l2_ctrl_handler_free(sd->ctrl_handler);
512 static const struct i2c_device_id vs6624_id[] = {
517 MODULE_DEVICE_TABLE(i2c, vs6624_id);
519 static struct i2c_driver vs6624_driver = {
523 .probe = vs6624_probe,
524 .remove = vs6624_remove,
525 .id_table = vs6624_id,
528 module_i2c_driver(vs6624_driver);
530 MODULE_DESCRIPTION("VS6624 sensor driver");
531 MODULE_AUTHOR("Scott Jiang <Scott.Jiang.Linux@gmail.com>");
532 MODULE_LICENSE("GPL v2");