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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include <linux/delay.h>
21 #include <linux/errno.h>
22 #include <linux/gpio.h>
23 #include <linux/i2c.h>
24 #include <linux/init.h>
25 #include <linux/module.h>
26 #include <linux/slab.h>
27 #include <linux/types.h>
28 #include <linux/videodev2.h>
30 #include <media/v4l2-ctrls.h>
31 #include <media/v4l2-device.h>
32 #include <media/v4l2-mediabus.h>
33 #include <media/v4l2-image-sizes.h>
35 #include "vs6624_regs.h"
37 #define MAX_FRAME_RATE 30
40 struct v4l2_subdev sd;
41 struct v4l2_ctrl_handler hdl;
42 struct v4l2_fract frame_rate;
43 struct v4l2_mbus_framefmt fmt;
47 static const struct vs6624_format {
49 enum v4l2_colorspace colorspace;
50 } vs6624_formats[] = {
52 .mbus_code = MEDIA_BUS_FMT_UYVY8_2X8,
53 .colorspace = V4L2_COLORSPACE_JPEG,
56 .mbus_code = MEDIA_BUS_FMT_YUYV8_2X8,
57 .colorspace = V4L2_COLORSPACE_JPEG,
60 .mbus_code = MEDIA_BUS_FMT_RGB565_2X8_LE,
61 .colorspace = V4L2_COLORSPACE_SRGB,
65 static struct v4l2_mbus_framefmt vs6624_default_fmt = {
68 .code = MEDIA_BUS_FMT_UYVY8_2X8,
69 .field = V4L2_FIELD_NONE,
70 .colorspace = V4L2_COLORSPACE_JPEG,
73 static const u16 vs6624_p1[] = {
399 static const u16 vs6624_p2[] = {
405 static const u16 vs6624_run_setup[] = {
406 0x1d18, 0x00, /* Enableconstrainedwhitebalance */
407 VS6624_PEAK_MIN_OUT_G_MSB, 0x3c, /* Damper PeakGain Output MSB */
408 VS6624_PEAK_MIN_OUT_G_LSB, 0x66, /* Damper PeakGain Output LSB */
409 VS6624_CM_LOW_THR_MSB, 0x65, /* Damper Low MSB */
410 VS6624_CM_LOW_THR_LSB, 0xd1, /* Damper Low LSB */
411 VS6624_CM_HIGH_THR_MSB, 0x66, /* Damper High MSB */
412 VS6624_CM_HIGH_THR_LSB, 0x62, /* Damper High LSB */
413 VS6624_CM_MIN_OUT_MSB, 0x00, /* Damper Min output MSB */
414 VS6624_CM_MIN_OUT_LSB, 0x00, /* Damper Min output LSB */
415 VS6624_NORA_DISABLE, 0x00, /* Nora fDisable */
416 VS6624_NORA_USAGE, 0x04, /* Nora usage */
417 VS6624_NORA_LOW_THR_MSB, 0x63, /* Damper Low MSB Changed 0x63 to 0x65 */
418 VS6624_NORA_LOW_THR_LSB, 0xd1, /* Damper Low LSB */
419 VS6624_NORA_HIGH_THR_MSB, 0x68, /* Damper High MSB */
420 VS6624_NORA_HIGH_THR_LSB, 0xdd, /* Damper High LSB */
421 VS6624_NORA_MIN_OUT_MSB, 0x3a, /* Damper Min output MSB */
422 VS6624_NORA_MIN_OUT_LSB, 0x00, /* Damper Min output LSB */
423 VS6624_F2B_DISABLE, 0x00, /* Disable */
424 0x1d8a, 0x30, /* MAXWeightHigh */
425 0x1d91, 0x62, /* fpDamperLowThresholdHigh MSB */
426 0x1d92, 0x4a, /* fpDamperLowThresholdHigh LSB */
427 0x1d95, 0x65, /* fpDamperHighThresholdHigh MSB */
428 0x1d96, 0x0e, /* fpDamperHighThresholdHigh LSB */
429 0x1da1, 0x3a, /* fpMinimumDamperOutputLow MSB */
430 0x1da2, 0xb8, /* fpMinimumDamperOutputLow LSB */
431 0x1e08, 0x06, /* MAXWeightLow */
432 0x1e0a, 0x0a, /* MAXWeightHigh */
433 0x1601, 0x3a, /* Red A MSB */
434 0x1602, 0x14, /* Red A LSB */
435 0x1605, 0x3b, /* Blue A MSB */
436 0x1606, 0x85, /* BLue A LSB */
437 0x1609, 0x3b, /* RED B MSB */
438 0x160a, 0x85, /* RED B LSB */
439 0x160d, 0x3a, /* Blue B MSB */
440 0x160e, 0x14, /* Blue B LSB */
441 0x1611, 0x30, /* Max Distance from Locus MSB */
442 0x1612, 0x8f, /* Max Distance from Locus MSB */
443 0x1614, 0x01, /* Enable constrainer */
447 static const u16 vs6624_default[] = {
448 VS6624_CONTRAST0, 0x84,
449 VS6624_SATURATION0, 0x75,
451 VS6624_CONTRAST1, 0x84,
452 VS6624_SATURATION1, 0x75,
458 VS6624_EXPO_COMPENSATION, 0xfe,
459 VS6624_EXPO_METER, 0x0,
460 VS6624_LIGHT_FREQ, 0x64,
461 VS6624_PEAK_GAIN, 0xe,
462 VS6624_PEAK_LOW_THR, 0x28,
463 VS6624_HMIRROR0, 0x0,
465 VS6624_ZOOM_HSTEP0_MSB, 0x0,
466 VS6624_ZOOM_HSTEP0_LSB, 0x1,
467 VS6624_ZOOM_VSTEP0_MSB, 0x0,
468 VS6624_ZOOM_VSTEP0_LSB, 0x1,
469 VS6624_PAN_HSTEP0_MSB, 0x0,
470 VS6624_PAN_HSTEP0_LSB, 0xf,
471 VS6624_PAN_VSTEP0_MSB, 0x0,
472 VS6624_PAN_VSTEP0_LSB, 0xf,
473 VS6624_SENSOR_MODE, 0x1,
474 VS6624_SYNC_CODE_SETUP, 0x21,
475 VS6624_DISABLE_FR_DAMPER, 0x0,
477 VS6624_FR_NUM_LSB, 0xf,
478 VS6624_INIT_PIPE_SETUP, 0x0,
479 VS6624_IMG_FMT0, 0x0,
480 VS6624_YUV_SETUP, 0x1,
481 VS6624_IMAGE_SIZE0, 0x2,
485 static inline struct vs6624 *to_vs6624(struct v4l2_subdev *sd)
487 return container_of(sd, struct vs6624, sd);
489 static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
491 return &container_of(ctrl->handler, struct vs6624, hdl)->sd;
494 #ifdef CONFIG_VIDEO_ADV_DEBUG
495 static int vs6624_read(struct v4l2_subdev *sd, u16 index)
497 struct i2c_client *client = v4l2_get_subdevdata(sd);
502 i2c_master_send(client, buf, 2);
503 i2c_master_recv(client, buf, 1);
509 static int vs6624_write(struct v4l2_subdev *sd, u16 index,
512 struct i2c_client *client = v4l2_get_subdevdata(sd);
519 return i2c_master_send(client, buf, 3);
522 static int vs6624_writeregs(struct v4l2_subdev *sd, const u16 *regs)
527 while (*regs != 0x00) {
531 vs6624_write(sd, reg, data);
536 static int vs6624_s_ctrl(struct v4l2_ctrl *ctrl)
538 struct v4l2_subdev *sd = to_sd(ctrl);
541 case V4L2_CID_CONTRAST:
542 vs6624_write(sd, VS6624_CONTRAST0, ctrl->val);
544 case V4L2_CID_SATURATION:
545 vs6624_write(sd, VS6624_SATURATION0, ctrl->val);
548 vs6624_write(sd, VS6624_HMIRROR0, ctrl->val);
551 vs6624_write(sd, VS6624_VFLIP0, ctrl->val);
560 static int vs6624_enum_mbus_fmt(struct v4l2_subdev *sd, unsigned index,
563 if (index >= ARRAY_SIZE(vs6624_formats))
566 *code = vs6624_formats[index].mbus_code;
570 static int vs6624_try_mbus_fmt(struct v4l2_subdev *sd,
571 struct v4l2_mbus_framefmt *fmt)
575 for (index = 0; index < ARRAY_SIZE(vs6624_formats); index++)
576 if (vs6624_formats[index].mbus_code == fmt->code)
578 if (index >= ARRAY_SIZE(vs6624_formats)) {
579 /* default to first format */
581 fmt->code = vs6624_formats[0].mbus_code;
584 /* sensor mode is VGA */
585 if (fmt->width > VGA_WIDTH)
586 fmt->width = VGA_WIDTH;
587 if (fmt->height > VGA_HEIGHT)
588 fmt->height = VGA_HEIGHT;
589 fmt->width = fmt->width & (~3);
590 fmt->height = fmt->height & (~3);
591 fmt->field = V4L2_FIELD_NONE;
592 fmt->colorspace = vs6624_formats[index].colorspace;
596 static int vs6624_s_mbus_fmt(struct v4l2_subdev *sd,
597 struct v4l2_mbus_framefmt *fmt)
599 struct vs6624 *sensor = to_vs6624(sd);
602 ret = vs6624_try_mbus_fmt(sd, fmt);
606 /* set image format */
608 case MEDIA_BUS_FMT_UYVY8_2X8:
609 vs6624_write(sd, VS6624_IMG_FMT0, 0x0);
610 vs6624_write(sd, VS6624_YUV_SETUP, 0x1);
612 case MEDIA_BUS_FMT_YUYV8_2X8:
613 vs6624_write(sd, VS6624_IMG_FMT0, 0x0);
614 vs6624_write(sd, VS6624_YUV_SETUP, 0x3);
616 case MEDIA_BUS_FMT_RGB565_2X8_LE:
617 vs6624_write(sd, VS6624_IMG_FMT0, 0x4);
618 vs6624_write(sd, VS6624_RGB_SETUP, 0x0);
625 if ((fmt->width == VGA_WIDTH) && (fmt->height == VGA_HEIGHT))
626 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x2);
627 else if ((fmt->width == QVGA_WIDTH) && (fmt->height == QVGA_HEIGHT))
628 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x4);
629 else if ((fmt->width == QQVGA_WIDTH) && (fmt->height == QQVGA_HEIGHT))
630 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x6);
631 else if ((fmt->width == CIF_WIDTH) && (fmt->height == CIF_HEIGHT))
632 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x3);
633 else if ((fmt->width == QCIF_WIDTH) && (fmt->height == QCIF_HEIGHT))
634 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x5);
635 else if ((fmt->width == QQCIF_WIDTH) && (fmt->height == QQCIF_HEIGHT))
636 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x7);
638 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x8);
639 vs6624_write(sd, VS6624_MAN_HSIZE0_MSB, fmt->width >> 8);
640 vs6624_write(sd, VS6624_MAN_HSIZE0_LSB, fmt->width & 0xFF);
641 vs6624_write(sd, VS6624_MAN_VSIZE0_MSB, fmt->height >> 8);
642 vs6624_write(sd, VS6624_MAN_VSIZE0_LSB, fmt->height & 0xFF);
643 vs6624_write(sd, VS6624_CROP_CTRL0, 0x1);
651 static int vs6624_g_mbus_fmt(struct v4l2_subdev *sd,
652 struct v4l2_mbus_framefmt *fmt)
654 struct vs6624 *sensor = to_vs6624(sd);
660 static int vs6624_g_parm(struct v4l2_subdev *sd, struct v4l2_streamparm *parms)
662 struct vs6624 *sensor = to_vs6624(sd);
663 struct v4l2_captureparm *cp = &parms->parm.capture;
665 if (parms->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
668 memset(cp, 0, sizeof(*cp));
669 cp->capability = V4L2_CAP_TIMEPERFRAME;
670 cp->timeperframe.numerator = sensor->frame_rate.denominator;
671 cp->timeperframe.denominator = sensor->frame_rate.numerator;
675 static int vs6624_s_parm(struct v4l2_subdev *sd, struct v4l2_streamparm *parms)
677 struct vs6624 *sensor = to_vs6624(sd);
678 struct v4l2_captureparm *cp = &parms->parm.capture;
679 struct v4l2_fract *tpf = &cp->timeperframe;
681 if (parms->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
683 if (cp->extendedmode != 0)
686 if (tpf->numerator == 0 || tpf->denominator == 0
687 || (tpf->denominator > tpf->numerator * MAX_FRAME_RATE)) {
688 /* reset to max frame rate */
690 tpf->denominator = MAX_FRAME_RATE;
692 sensor->frame_rate.numerator = tpf->denominator;
693 sensor->frame_rate.denominator = tpf->numerator;
694 vs6624_write(sd, VS6624_DISABLE_FR_DAMPER, 0x0);
695 vs6624_write(sd, VS6624_FR_NUM_MSB,
696 sensor->frame_rate.numerator >> 8);
697 vs6624_write(sd, VS6624_FR_NUM_LSB,
698 sensor->frame_rate.numerator & 0xFF);
699 vs6624_write(sd, VS6624_FR_DEN,
700 sensor->frame_rate.denominator & 0xFF);
704 static int vs6624_s_stream(struct v4l2_subdev *sd, int enable)
707 vs6624_write(sd, VS6624_USER_CMD, 0x2);
709 vs6624_write(sd, VS6624_USER_CMD, 0x4);
714 #ifdef CONFIG_VIDEO_ADV_DEBUG
715 static int vs6624_g_register(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg)
717 reg->val = vs6624_read(sd, reg->reg & 0xffff);
722 static int vs6624_s_register(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg)
724 vs6624_write(sd, reg->reg & 0xffff, reg->val & 0xff);
729 static const struct v4l2_ctrl_ops vs6624_ctrl_ops = {
730 .s_ctrl = vs6624_s_ctrl,
733 static const struct v4l2_subdev_core_ops vs6624_core_ops = {
734 #ifdef CONFIG_VIDEO_ADV_DEBUG
735 .g_register = vs6624_g_register,
736 .s_register = vs6624_s_register,
740 static const struct v4l2_subdev_video_ops vs6624_video_ops = {
741 .enum_mbus_fmt = vs6624_enum_mbus_fmt,
742 .try_mbus_fmt = vs6624_try_mbus_fmt,
743 .s_mbus_fmt = vs6624_s_mbus_fmt,
744 .g_mbus_fmt = vs6624_g_mbus_fmt,
745 .s_parm = vs6624_s_parm,
746 .g_parm = vs6624_g_parm,
747 .s_stream = vs6624_s_stream,
750 static const struct v4l2_subdev_ops vs6624_ops = {
751 .core = &vs6624_core_ops,
752 .video = &vs6624_video_ops,
755 static int vs6624_probe(struct i2c_client *client,
756 const struct i2c_device_id *id)
758 struct vs6624 *sensor;
759 struct v4l2_subdev *sd;
760 struct v4l2_ctrl_handler *hdl;
764 /* Check if the adapter supports the needed features */
765 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
768 ce = client->dev.platform_data;
772 ret = devm_gpio_request_one(&client->dev, *ce, GPIOF_OUT_INIT_HIGH,
773 "VS6624 Chip Enable");
775 v4l_err(client, "failed to request GPIO %d\n", *ce);
778 /* wait 100ms before any further i2c writes are performed */
781 sensor = devm_kzalloc(&client->dev, sizeof(*sensor), GFP_KERNEL);
786 v4l2_i2c_subdev_init(sd, client, &vs6624_ops);
788 vs6624_writeregs(sd, vs6624_p1);
789 vs6624_write(sd, VS6624_MICRO_EN, 0x2);
790 vs6624_write(sd, VS6624_DIO_EN, 0x1);
792 vs6624_writeregs(sd, vs6624_p2);
794 vs6624_writeregs(sd, vs6624_default);
795 vs6624_write(sd, VS6624_HSYNC_SETUP, 0xF);
796 vs6624_writeregs(sd, vs6624_run_setup);
799 sensor->frame_rate.numerator = MAX_FRAME_RATE;
800 sensor->frame_rate.denominator = 1;
801 vs6624_write(sd, VS6624_DISABLE_FR_DAMPER, 0x0);
802 vs6624_write(sd, VS6624_FR_NUM_MSB,
803 sensor->frame_rate.numerator >> 8);
804 vs6624_write(sd, VS6624_FR_NUM_LSB,
805 sensor->frame_rate.numerator & 0xFF);
806 vs6624_write(sd, VS6624_FR_DEN,
807 sensor->frame_rate.denominator & 0xFF);
809 sensor->fmt = vs6624_default_fmt;
810 sensor->ce_pin = *ce;
812 v4l_info(client, "chip found @ 0x%02x (%s)\n",
813 client->addr << 1, client->adapter->name);
816 v4l2_ctrl_handler_init(hdl, 4);
817 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
818 V4L2_CID_CONTRAST, 0, 0xFF, 1, 0x87);
819 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
820 V4L2_CID_SATURATION, 0, 0xFF, 1, 0x78);
821 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
822 V4L2_CID_HFLIP, 0, 1, 1, 0);
823 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
824 V4L2_CID_VFLIP, 0, 1, 1, 0);
825 /* hook the control handler into the driver */
826 sd->ctrl_handler = hdl;
828 int err = hdl->error;
830 v4l2_ctrl_handler_free(hdl);
834 /* initialize the hardware to the default control values */
835 ret = v4l2_ctrl_handler_setup(hdl);
837 v4l2_ctrl_handler_free(hdl);
841 static int vs6624_remove(struct i2c_client *client)
843 struct v4l2_subdev *sd = i2c_get_clientdata(client);
845 v4l2_device_unregister_subdev(sd);
846 v4l2_ctrl_handler_free(sd->ctrl_handler);
850 static const struct i2c_device_id vs6624_id[] = {
855 MODULE_DEVICE_TABLE(i2c, vs6624_id);
857 static struct i2c_driver vs6624_driver = {
859 .owner = THIS_MODULE,
862 .probe = vs6624_probe,
863 .remove = vs6624_remove,
864 .id_table = vs6624_id,
867 module_i2c_driver(vs6624_driver);
869 MODULE_DESCRIPTION("VS6624 sensor driver");
871 MODULE_LICENSE("GPL v2");