2 * vs6624.c ST VS6624 CMOS image sensor driver
4 * Copyright (c) 2011 Analog Devices Inc.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
16 #include <linux/delay.h>
17 #include <linux/errno.h>
18 #include <linux/gpio.h>
19 #include <linux/i2c.h>
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/types.h>
24 #include <linux/videodev2.h>
26 #include <media/v4l2-ctrls.h>
27 #include <media/v4l2-device.h>
28 #include <media/v4l2-mediabus.h>
29 #include <media/v4l2-image-sizes.h>
31 #include "vs6624_regs.h"
33 #define MAX_FRAME_RATE 30
36 struct v4l2_subdev sd;
37 struct v4l2_ctrl_handler hdl;
38 struct v4l2_fract frame_rate;
39 struct v4l2_mbus_framefmt fmt;
43 static const struct vs6624_format {
45 enum v4l2_colorspace colorspace;
46 } vs6624_formats[] = {
48 .mbus_code = MEDIA_BUS_FMT_UYVY8_2X8,
49 .colorspace = V4L2_COLORSPACE_JPEG,
52 .mbus_code = MEDIA_BUS_FMT_YUYV8_2X8,
53 .colorspace = V4L2_COLORSPACE_JPEG,
56 .mbus_code = MEDIA_BUS_FMT_RGB565_2X8_LE,
57 .colorspace = V4L2_COLORSPACE_SRGB,
61 static const struct v4l2_mbus_framefmt vs6624_default_fmt = {
64 .code = MEDIA_BUS_FMT_UYVY8_2X8,
65 .field = V4L2_FIELD_NONE,
66 .colorspace = V4L2_COLORSPACE_JPEG,
71 static const u16 vs6624_p2[] = {
77 static const u16 vs6624_run_setup[] = {
78 0x1d18, 0x00, /* Enableconstrainedwhitebalance */
79 VS6624_PEAK_MIN_OUT_G_MSB, 0x3c, /* Damper PeakGain Output MSB */
80 VS6624_PEAK_MIN_OUT_G_LSB, 0x66, /* Damper PeakGain Output LSB */
81 VS6624_CM_LOW_THR_MSB, 0x65, /* Damper Low MSB */
82 VS6624_CM_LOW_THR_LSB, 0xd1, /* Damper Low LSB */
83 VS6624_CM_HIGH_THR_MSB, 0x66, /* Damper High MSB */
84 VS6624_CM_HIGH_THR_LSB, 0x62, /* Damper High LSB */
85 VS6624_CM_MIN_OUT_MSB, 0x00, /* Damper Min output MSB */
86 VS6624_CM_MIN_OUT_LSB, 0x00, /* Damper Min output LSB */
87 VS6624_NORA_DISABLE, 0x00, /* Nora fDisable */
88 VS6624_NORA_USAGE, 0x04, /* Nora usage */
89 VS6624_NORA_LOW_THR_MSB, 0x63, /* Damper Low MSB Changed 0x63 to 0x65 */
90 VS6624_NORA_LOW_THR_LSB, 0xd1, /* Damper Low LSB */
91 VS6624_NORA_HIGH_THR_MSB, 0x68, /* Damper High MSB */
92 VS6624_NORA_HIGH_THR_LSB, 0xdd, /* Damper High LSB */
93 VS6624_NORA_MIN_OUT_MSB, 0x3a, /* Damper Min output MSB */
94 VS6624_NORA_MIN_OUT_LSB, 0x00, /* Damper Min output LSB */
95 VS6624_F2B_DISABLE, 0x00, /* Disable */
96 0x1d8a, 0x30, /* MAXWeightHigh */
97 0x1d91, 0x62, /* fpDamperLowThresholdHigh MSB */
98 0x1d92, 0x4a, /* fpDamperLowThresholdHigh LSB */
99 0x1d95, 0x65, /* fpDamperHighThresholdHigh MSB */
100 0x1d96, 0x0e, /* fpDamperHighThresholdHigh LSB */
101 0x1da1, 0x3a, /* fpMinimumDamperOutputLow MSB */
102 0x1da2, 0xb8, /* fpMinimumDamperOutputLow LSB */
103 0x1e08, 0x06, /* MAXWeightLow */
104 0x1e0a, 0x0a, /* MAXWeightHigh */
105 0x1601, 0x3a, /* Red A MSB */
106 0x1602, 0x14, /* Red A LSB */
107 0x1605, 0x3b, /* Blue A MSB */
108 0x1606, 0x85, /* BLue A LSB */
109 0x1609, 0x3b, /* RED B MSB */
110 0x160a, 0x85, /* RED B LSB */
111 0x160d, 0x3a, /* Blue B MSB */
112 0x160e, 0x14, /* Blue B LSB */
113 0x1611, 0x30, /* Max Distance from Locus MSB */
114 0x1612, 0x8f, /* Max Distance from Locus MSB */
115 0x1614, 0x01, /* Enable constrainer */
119 static const u16 vs6624_default[] = {
120 VS6624_CONTRAST0, 0x84,
121 VS6624_SATURATION0, 0x75,
123 VS6624_CONTRAST1, 0x84,
124 VS6624_SATURATION1, 0x75,
130 VS6624_EXPO_COMPENSATION, 0xfe,
131 VS6624_EXPO_METER, 0x0,
132 VS6624_LIGHT_FREQ, 0x64,
133 VS6624_PEAK_GAIN, 0xe,
134 VS6624_PEAK_LOW_THR, 0x28,
135 VS6624_HMIRROR0, 0x0,
137 VS6624_ZOOM_HSTEP0_MSB, 0x0,
138 VS6624_ZOOM_HSTEP0_LSB, 0x1,
139 VS6624_ZOOM_VSTEP0_MSB, 0x0,
140 VS6624_ZOOM_VSTEP0_LSB, 0x1,
141 VS6624_PAN_HSTEP0_MSB, 0x0,
142 VS6624_PAN_HSTEP0_LSB, 0xf,
143 VS6624_PAN_VSTEP0_MSB, 0x0,
144 VS6624_PAN_VSTEP0_LSB, 0xf,
145 VS6624_SENSOR_MODE, 0x1,
146 VS6624_SYNC_CODE_SETUP, 0x21,
147 VS6624_DISABLE_FR_DAMPER, 0x0,
149 VS6624_FR_NUM_LSB, 0xf,
150 VS6624_INIT_PIPE_SETUP, 0x0,
151 VS6624_IMG_FMT0, 0x0,
152 VS6624_YUV_SETUP, 0x1,
153 VS6624_IMAGE_SIZE0, 0x2,
157 static inline struct vs6624 *to_vs6624(struct v4l2_subdev *sd)
159 return container_of(sd, struct vs6624, sd);
161 static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
163 return &container_of(ctrl->handler, struct vs6624, hdl)->sd;
166 #ifdef CONFIG_VIDEO_ADV_DEBUG
167 static int vs6624_read(struct v4l2_subdev *sd, u16 index)
169 struct i2c_client *client = v4l2_get_subdevdata(sd);
174 i2c_master_send(client, buf, 2);
175 i2c_master_recv(client, buf, 1);
181 static int vs6624_write(struct v4l2_subdev *sd, u16 index,
184 struct i2c_client *client = v4l2_get_subdevdata(sd);
191 return i2c_master_send(client, buf, 3);
194 static int vs6624_writeregs(struct v4l2_subdev *sd, const u16 *regs)
199 while (*regs != 0x00) {
203 vs6624_write(sd, reg, data);
208 static int vs6624_s_ctrl(struct v4l2_ctrl *ctrl)
210 struct v4l2_subdev *sd = to_sd(ctrl);
213 case V4L2_CID_CONTRAST:
214 vs6624_write(sd, VS6624_CONTRAST0, ctrl->val);
216 case V4L2_CID_SATURATION:
217 vs6624_write(sd, VS6624_SATURATION0, ctrl->val);
220 vs6624_write(sd, VS6624_HMIRROR0, ctrl->val);
223 vs6624_write(sd, VS6624_VFLIP0, ctrl->val);
232 static int vs6624_enum_mbus_code(struct v4l2_subdev *sd,
233 struct v4l2_subdev_pad_config *cfg,
234 struct v4l2_subdev_mbus_code_enum *code)
236 if (code->pad || code->index >= ARRAY_SIZE(vs6624_formats))
239 code->code = vs6624_formats[code->index].mbus_code;
243 static int vs6624_set_fmt(struct v4l2_subdev *sd,
244 struct v4l2_subdev_pad_config *cfg,
245 struct v4l2_subdev_format *format)
247 struct v4l2_mbus_framefmt *fmt = &format->format;
248 struct vs6624 *sensor = to_vs6624(sd);
254 for (index = 0; index < ARRAY_SIZE(vs6624_formats); index++)
255 if (vs6624_formats[index].mbus_code == fmt->code)
257 if (index >= ARRAY_SIZE(vs6624_formats)) {
258 /* default to first format */
260 fmt->code = vs6624_formats[0].mbus_code;
263 /* sensor mode is VGA */
264 if (fmt->width > VGA_WIDTH)
265 fmt->width = VGA_WIDTH;
266 if (fmt->height > VGA_HEIGHT)
267 fmt->height = VGA_HEIGHT;
268 fmt->width = fmt->width & (~3);
269 fmt->height = fmt->height & (~3);
270 fmt->field = V4L2_FIELD_NONE;
271 fmt->colorspace = vs6624_formats[index].colorspace;
273 if (format->which == V4L2_SUBDEV_FORMAT_TRY) {
278 /* set image format */
280 case MEDIA_BUS_FMT_UYVY8_2X8:
281 vs6624_write(sd, VS6624_IMG_FMT0, 0x0);
282 vs6624_write(sd, VS6624_YUV_SETUP, 0x1);
284 case MEDIA_BUS_FMT_YUYV8_2X8:
285 vs6624_write(sd, VS6624_IMG_FMT0, 0x0);
286 vs6624_write(sd, VS6624_YUV_SETUP, 0x3);
288 case MEDIA_BUS_FMT_RGB565_2X8_LE:
289 vs6624_write(sd, VS6624_IMG_FMT0, 0x4);
290 vs6624_write(sd, VS6624_RGB_SETUP, 0x0);
297 if ((fmt->width == VGA_WIDTH) && (fmt->height == VGA_HEIGHT))
298 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x2);
299 else if ((fmt->width == QVGA_WIDTH) && (fmt->height == QVGA_HEIGHT))
300 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x4);
301 else if ((fmt->width == QQVGA_WIDTH) && (fmt->height == QQVGA_HEIGHT))
302 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x6);
303 else if ((fmt->width == CIF_WIDTH) && (fmt->height == CIF_HEIGHT))
304 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x3);
305 else if ((fmt->width == QCIF_WIDTH) && (fmt->height == QCIF_HEIGHT))
306 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x5);
307 else if ((fmt->width == QQCIF_WIDTH) && (fmt->height == QQCIF_HEIGHT))
308 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x7);
310 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x8);
311 vs6624_write(sd, VS6624_MAN_HSIZE0_MSB, fmt->width >> 8);
312 vs6624_write(sd, VS6624_MAN_HSIZE0_LSB, fmt->width & 0xFF);
313 vs6624_write(sd, VS6624_MAN_VSIZE0_MSB, fmt->height >> 8);
314 vs6624_write(sd, VS6624_MAN_VSIZE0_LSB, fmt->height & 0xFF);
315 vs6624_write(sd, VS6624_CROP_CTRL0, 0x1);
323 static int vs6624_get_fmt(struct v4l2_subdev *sd,
324 struct v4l2_subdev_pad_config *cfg,
325 struct v4l2_subdev_format *format)
327 struct vs6624 *sensor = to_vs6624(sd);
332 format->format = sensor->fmt;
336 static int vs6624_g_frame_interval(struct v4l2_subdev *sd,
337 struct v4l2_subdev_frame_interval *ival)
339 struct vs6624 *sensor = to_vs6624(sd);
341 ival->interval.numerator = sensor->frame_rate.denominator;
342 ival->interval.denominator = sensor->frame_rate.numerator;
346 static int vs6624_s_frame_interval(struct v4l2_subdev *sd,
347 struct v4l2_subdev_frame_interval *ival)
349 struct vs6624 *sensor = to_vs6624(sd);
350 struct v4l2_fract *tpf = &ival->interval;
353 if (tpf->numerator == 0 || tpf->denominator == 0
354 || (tpf->denominator > tpf->numerator * MAX_FRAME_RATE)) {
355 /* reset to max frame rate */
357 tpf->denominator = MAX_FRAME_RATE;
359 sensor->frame_rate.numerator = tpf->denominator;
360 sensor->frame_rate.denominator = tpf->numerator;
361 vs6624_write(sd, VS6624_DISABLE_FR_DAMPER, 0x0);
362 vs6624_write(sd, VS6624_FR_NUM_MSB,
363 sensor->frame_rate.numerator >> 8);
364 vs6624_write(sd, VS6624_FR_NUM_LSB,
365 sensor->frame_rate.numerator & 0xFF);
366 vs6624_write(sd, VS6624_FR_DEN,
367 sensor->frame_rate.denominator & 0xFF);
371 static int vs6624_s_stream(struct v4l2_subdev *sd, int enable)
374 vs6624_write(sd, VS6624_USER_CMD, 0x2);
376 vs6624_write(sd, VS6624_USER_CMD, 0x4);
381 #ifdef CONFIG_VIDEO_ADV_DEBUG
382 static int vs6624_g_register(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg)
384 reg->val = vs6624_read(sd, reg->reg & 0xffff);
389 static int vs6624_s_register(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg)
391 vs6624_write(sd, reg->reg & 0xffff, reg->val & 0xff);
396 static const struct v4l2_ctrl_ops vs6624_ctrl_ops = {
397 .s_ctrl = vs6624_s_ctrl,
400 static const struct v4l2_subdev_core_ops vs6624_core_ops = {
401 #ifdef CONFIG_VIDEO_ADV_DEBUG
402 .g_register = vs6624_g_register,
403 .s_register = vs6624_s_register,
407 static const struct v4l2_subdev_video_ops vs6624_video_ops = {
408 .s_frame_interval = vs6624_s_frame_interval,
409 .g_frame_interval = vs6624_g_frame_interval,
410 .s_stream = vs6624_s_stream,
413 static const struct v4l2_subdev_pad_ops vs6624_pad_ops = {
414 .enum_mbus_code = vs6624_enum_mbus_code,
415 .get_fmt = vs6624_get_fmt,
416 .set_fmt = vs6624_set_fmt,
419 static const struct v4l2_subdev_ops vs6624_ops = {
420 .core = &vs6624_core_ops,
421 .video = &vs6624_video_ops,
422 .pad = &vs6624_pad_ops,
425 static int vs6624_probe(struct i2c_client *client,
426 const struct i2c_device_id *id)
428 struct vs6624 *sensor;
429 struct v4l2_subdev *sd;
430 struct v4l2_ctrl_handler *hdl;
434 /* Check if the adapter supports the needed features */
435 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
438 ce = client->dev.platform_data;
442 ret = devm_gpio_request_one(&client->dev, *ce, GPIOF_OUT_INIT_HIGH,
443 "VS6624 Chip Enable");
445 v4l_err(client, "failed to request GPIO %d\n", *ce);
448 /* wait 100ms before any further i2c writes are performed */
451 sensor = devm_kzalloc(&client->dev, sizeof(*sensor), GFP_KERNEL);
456 v4l2_i2c_subdev_init(sd, client, &vs6624_ops);
459 vs6624_write(sd, VS6624_MICRO_EN, 0x2);
460 vs6624_write(sd, VS6624_DIO_EN, 0x1);
461 usleep_range(10000, 11000);
462 vs6624_writeregs(sd, vs6624_p2);
464 vs6624_writeregs(sd, vs6624_default);
465 vs6624_write(sd, VS6624_HSYNC_SETUP, 0xF);
466 vs6624_writeregs(sd, vs6624_run_setup);
469 sensor->frame_rate.numerator = MAX_FRAME_RATE;
470 sensor->frame_rate.denominator = 1;
471 vs6624_write(sd, VS6624_DISABLE_FR_DAMPER, 0x0);
472 vs6624_write(sd, VS6624_FR_NUM_MSB,
473 sensor->frame_rate.numerator >> 8);
474 vs6624_write(sd, VS6624_FR_NUM_LSB,
475 sensor->frame_rate.numerator & 0xFF);
476 vs6624_write(sd, VS6624_FR_DEN,
477 sensor->frame_rate.denominator & 0xFF);
479 sensor->fmt = vs6624_default_fmt;
480 sensor->ce_pin = *ce;
482 v4l_info(client, "chip found @ 0x%02x (%s)\n",
483 client->addr << 1, client->adapter->name);
486 v4l2_ctrl_handler_init(hdl, 4);
487 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
488 V4L2_CID_CONTRAST, 0, 0xFF, 1, 0x87);
489 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
490 V4L2_CID_SATURATION, 0, 0xFF, 1, 0x78);
491 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
492 V4L2_CID_HFLIP, 0, 1, 1, 0);
493 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
494 V4L2_CID_VFLIP, 0, 1, 1, 0);
495 /* hook the control handler into the driver */
496 sd->ctrl_handler = hdl;
498 int err = hdl->error;
500 v4l2_ctrl_handler_free(hdl);
504 /* initialize the hardware to the default control values */
505 ret = v4l2_ctrl_handler_setup(hdl);
507 v4l2_ctrl_handler_free(hdl);
511 static int vs6624_remove(struct i2c_client *client)
513 struct v4l2_subdev *sd = i2c_get_clientdata(client);
515 v4l2_device_unregister_subdev(sd);
516 v4l2_ctrl_handler_free(sd->ctrl_handler);
520 static const struct i2c_device_id vs6624_id[] = {
525 MODULE_DEVICE_TABLE(i2c, vs6624_id);
527 static struct i2c_driver vs6624_driver = {
531 .probe = vs6624_probe,
532 .remove = vs6624_remove,
533 .id_table = vs6624_id,
536 module_i2c_driver(vs6624_driver);
538 MODULE_DESCRIPTION("VS6624 sensor driver");
539 MODULE_AUTHOR("Scott Jiang <Scott.Jiang.Linux@gmail.com>");
540 MODULE_LICENSE("GPL v2");