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>
34 #include "vs6624_regs.h"
37 #define VGA_HEIGHT 480
38 #define QVGA_WIDTH 320
39 #define QVGA_HEIGHT 240
40 #define QQVGA_WIDTH 160
41 #define QQVGA_HEIGHT 120
43 #define CIF_HEIGHT 288
44 #define QCIF_WIDTH 176
45 #define QCIF_HEIGHT 144
46 #define QQCIF_WIDTH 88
47 #define QQCIF_HEIGHT 72
49 #define MAX_FRAME_RATE 30
52 struct v4l2_subdev sd;
53 struct v4l2_ctrl_handler hdl;
54 struct v4l2_fract frame_rate;
55 struct v4l2_mbus_framefmt fmt;
59 static const struct vs6624_format {
60 enum v4l2_mbus_pixelcode mbus_code;
61 enum v4l2_colorspace colorspace;
62 } vs6624_formats[] = {
64 .mbus_code = V4L2_MBUS_FMT_UYVY8_2X8,
65 .colorspace = V4L2_COLORSPACE_JPEG,
68 .mbus_code = V4L2_MBUS_FMT_YUYV8_2X8,
69 .colorspace = V4L2_COLORSPACE_JPEG,
72 .mbus_code = V4L2_MBUS_FMT_RGB565_2X8_LE,
73 .colorspace = V4L2_COLORSPACE_SRGB,
77 static struct v4l2_mbus_framefmt vs6624_default_fmt = {
80 .code = V4L2_MBUS_FMT_UYVY8_2X8,
81 .field = V4L2_FIELD_NONE,
82 .colorspace = V4L2_COLORSPACE_JPEG,
85 static const u16 vs6624_p1[] = {
411 static const u16 vs6624_p2[] = {
417 static const u16 vs6624_run_setup[] = {
418 0x1d18, 0x00, /* Enableconstrainedwhitebalance */
419 VS6624_PEAK_MIN_OUT_G_MSB, 0x3c, /* Damper PeakGain Output MSB */
420 VS6624_PEAK_MIN_OUT_G_LSB, 0x66, /* Damper PeakGain Output LSB */
421 VS6624_CM_LOW_THR_MSB, 0x65, /* Damper Low MSB */
422 VS6624_CM_LOW_THR_LSB, 0xd1, /* Damper Low LSB */
423 VS6624_CM_HIGH_THR_MSB, 0x66, /* Damper High MSB */
424 VS6624_CM_HIGH_THR_LSB, 0x62, /* Damper High LSB */
425 VS6624_CM_MIN_OUT_MSB, 0x00, /* Damper Min output MSB */
426 VS6624_CM_MIN_OUT_LSB, 0x00, /* Damper Min output LSB */
427 VS6624_NORA_DISABLE, 0x00, /* Nora fDisable */
428 VS6624_NORA_USAGE, 0x04, /* Nora usage */
429 VS6624_NORA_LOW_THR_MSB, 0x63, /* Damper Low MSB Changed 0x63 to 0x65 */
430 VS6624_NORA_LOW_THR_LSB, 0xd1, /* Damper Low LSB */
431 VS6624_NORA_HIGH_THR_MSB, 0x68, /* Damper High MSB */
432 VS6624_NORA_HIGH_THR_LSB, 0xdd, /* Damper High LSB */
433 VS6624_NORA_MIN_OUT_MSB, 0x3a, /* Damper Min output MSB */
434 VS6624_NORA_MIN_OUT_LSB, 0x00, /* Damper Min output LSB */
435 VS6624_F2B_DISABLE, 0x00, /* Disable */
436 0x1d8a, 0x30, /* MAXWeightHigh */
437 0x1d91, 0x62, /* fpDamperLowThresholdHigh MSB */
438 0x1d92, 0x4a, /* fpDamperLowThresholdHigh LSB */
439 0x1d95, 0x65, /* fpDamperHighThresholdHigh MSB */
440 0x1d96, 0x0e, /* fpDamperHighThresholdHigh LSB */
441 0x1da1, 0x3a, /* fpMinimumDamperOutputLow MSB */
442 0x1da2, 0xb8, /* fpMinimumDamperOutputLow LSB */
443 0x1e08, 0x06, /* MAXWeightLow */
444 0x1e0a, 0x0a, /* MAXWeightHigh */
445 0x1601, 0x3a, /* Red A MSB */
446 0x1602, 0x14, /* Red A LSB */
447 0x1605, 0x3b, /* Blue A MSB */
448 0x1606, 0x85, /* BLue A LSB */
449 0x1609, 0x3b, /* RED B MSB */
450 0x160a, 0x85, /* RED B LSB */
451 0x160d, 0x3a, /* Blue B MSB */
452 0x160e, 0x14, /* Blue B LSB */
453 0x1611, 0x30, /* Max Distance from Locus MSB */
454 0x1612, 0x8f, /* Max Distance from Locus MSB */
455 0x1614, 0x01, /* Enable constrainer */
459 static const u16 vs6624_default[] = {
460 VS6624_CONTRAST0, 0x84,
461 VS6624_SATURATION0, 0x75,
463 VS6624_CONTRAST1, 0x84,
464 VS6624_SATURATION1, 0x75,
470 VS6624_EXPO_COMPENSATION, 0xfe,
471 VS6624_EXPO_METER, 0x0,
472 VS6624_LIGHT_FREQ, 0x64,
473 VS6624_PEAK_GAIN, 0xe,
474 VS6624_PEAK_LOW_THR, 0x28,
475 VS6624_HMIRROR0, 0x0,
477 VS6624_ZOOM_HSTEP0_MSB, 0x0,
478 VS6624_ZOOM_HSTEP0_LSB, 0x1,
479 VS6624_ZOOM_VSTEP0_MSB, 0x0,
480 VS6624_ZOOM_VSTEP0_LSB, 0x1,
481 VS6624_PAN_HSTEP0_MSB, 0x0,
482 VS6624_PAN_HSTEP0_LSB, 0xf,
483 VS6624_PAN_VSTEP0_MSB, 0x0,
484 VS6624_PAN_VSTEP0_LSB, 0xf,
485 VS6624_SENSOR_MODE, 0x1,
486 VS6624_SYNC_CODE_SETUP, 0x21,
487 VS6624_DISABLE_FR_DAMPER, 0x0,
489 VS6624_FR_NUM_LSB, 0xf,
490 VS6624_INIT_PIPE_SETUP, 0x0,
491 VS6624_IMG_FMT0, 0x0,
492 VS6624_YUV_SETUP, 0x1,
493 VS6624_IMAGE_SIZE0, 0x2,
497 static inline struct vs6624 *to_vs6624(struct v4l2_subdev *sd)
499 return container_of(sd, struct vs6624, sd);
501 static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
503 return &container_of(ctrl->handler, struct vs6624, hdl)->sd;
506 #ifdef CONFIG_VIDEO_ADV_DEBUG
507 static int vs6624_read(struct v4l2_subdev *sd, u16 index)
509 struct i2c_client *client = v4l2_get_subdevdata(sd);
514 i2c_master_send(client, buf, 2);
515 i2c_master_recv(client, buf, 1);
521 static int vs6624_write(struct v4l2_subdev *sd, u16 index,
524 struct i2c_client *client = v4l2_get_subdevdata(sd);
531 return i2c_master_send(client, buf, 3);
534 static int vs6624_writeregs(struct v4l2_subdev *sd, const u16 *regs)
539 while (*regs != 0x00) {
543 vs6624_write(sd, reg, data);
548 static int vs6624_s_ctrl(struct v4l2_ctrl *ctrl)
550 struct v4l2_subdev *sd = to_sd(ctrl);
553 case V4L2_CID_CONTRAST:
554 vs6624_write(sd, VS6624_CONTRAST0, ctrl->val);
556 case V4L2_CID_SATURATION:
557 vs6624_write(sd, VS6624_SATURATION0, ctrl->val);
560 vs6624_write(sd, VS6624_HMIRROR0, ctrl->val);
563 vs6624_write(sd, VS6624_VFLIP0, ctrl->val);
572 static int vs6624_enum_mbus_fmt(struct v4l2_subdev *sd, unsigned index,
573 enum v4l2_mbus_pixelcode *code)
575 if (index >= ARRAY_SIZE(vs6624_formats))
578 *code = vs6624_formats[index].mbus_code;
582 static int vs6624_try_mbus_fmt(struct v4l2_subdev *sd,
583 struct v4l2_mbus_framefmt *fmt)
587 for (index = 0; index < ARRAY_SIZE(vs6624_formats); index++)
588 if (vs6624_formats[index].mbus_code == fmt->code)
590 if (index >= ARRAY_SIZE(vs6624_formats)) {
591 /* default to first format */
593 fmt->code = vs6624_formats[0].mbus_code;
596 /* sensor mode is VGA */
597 if (fmt->width > VGA_WIDTH)
598 fmt->width = VGA_WIDTH;
599 if (fmt->height > VGA_HEIGHT)
600 fmt->height = VGA_HEIGHT;
601 fmt->width = fmt->width & (~3);
602 fmt->height = fmt->height & (~3);
603 fmt->field = V4L2_FIELD_NONE;
604 fmt->colorspace = vs6624_formats[index].colorspace;
608 static int vs6624_s_mbus_fmt(struct v4l2_subdev *sd,
609 struct v4l2_mbus_framefmt *fmt)
611 struct vs6624 *sensor = to_vs6624(sd);
614 ret = vs6624_try_mbus_fmt(sd, fmt);
618 /* set image format */
620 case V4L2_MBUS_FMT_UYVY8_2X8:
621 vs6624_write(sd, VS6624_IMG_FMT0, 0x0);
622 vs6624_write(sd, VS6624_YUV_SETUP, 0x1);
624 case V4L2_MBUS_FMT_YUYV8_2X8:
625 vs6624_write(sd, VS6624_IMG_FMT0, 0x0);
626 vs6624_write(sd, VS6624_YUV_SETUP, 0x3);
628 case V4L2_MBUS_FMT_RGB565_2X8_LE:
629 vs6624_write(sd, VS6624_IMG_FMT0, 0x4);
630 vs6624_write(sd, VS6624_RGB_SETUP, 0x0);
637 if ((fmt->width == VGA_WIDTH) && (fmt->height == VGA_HEIGHT))
638 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x2);
639 else if ((fmt->width == QVGA_WIDTH) && (fmt->height == QVGA_HEIGHT))
640 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x4);
641 else if ((fmt->width == QQVGA_WIDTH) && (fmt->height == QQVGA_HEIGHT))
642 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x6);
643 else if ((fmt->width == CIF_WIDTH) && (fmt->height == CIF_HEIGHT))
644 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x3);
645 else if ((fmt->width == QCIF_WIDTH) && (fmt->height == QCIF_HEIGHT))
646 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x5);
647 else if ((fmt->width == QQCIF_WIDTH) && (fmt->height == QQCIF_HEIGHT))
648 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x7);
650 vs6624_write(sd, VS6624_IMAGE_SIZE0, 0x8);
651 vs6624_write(sd, VS6624_MAN_HSIZE0_MSB, fmt->width >> 8);
652 vs6624_write(sd, VS6624_MAN_HSIZE0_LSB, fmt->width & 0xFF);
653 vs6624_write(sd, VS6624_MAN_VSIZE0_MSB, fmt->height >> 8);
654 vs6624_write(sd, VS6624_MAN_VSIZE0_LSB, fmt->height & 0xFF);
655 vs6624_write(sd, VS6624_CROP_CTRL0, 0x1);
663 static int vs6624_g_mbus_fmt(struct v4l2_subdev *sd,
664 struct v4l2_mbus_framefmt *fmt)
666 struct vs6624 *sensor = to_vs6624(sd);
672 static int vs6624_g_parm(struct v4l2_subdev *sd, struct v4l2_streamparm *parms)
674 struct vs6624 *sensor = to_vs6624(sd);
675 struct v4l2_captureparm *cp = &parms->parm.capture;
677 if (parms->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
680 memset(cp, 0, sizeof(*cp));
681 cp->capability = V4L2_CAP_TIMEPERFRAME;
682 cp->timeperframe.numerator = sensor->frame_rate.denominator;
683 cp->timeperframe.denominator = sensor->frame_rate.numerator;
687 static int vs6624_s_parm(struct v4l2_subdev *sd, struct v4l2_streamparm *parms)
689 struct vs6624 *sensor = to_vs6624(sd);
690 struct v4l2_captureparm *cp = &parms->parm.capture;
691 struct v4l2_fract *tpf = &cp->timeperframe;
693 if (parms->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
695 if (cp->extendedmode != 0)
698 if (tpf->numerator == 0 || tpf->denominator == 0
699 || (tpf->denominator > tpf->numerator * MAX_FRAME_RATE)) {
700 /* reset to max frame rate */
702 tpf->denominator = MAX_FRAME_RATE;
704 sensor->frame_rate.numerator = tpf->denominator;
705 sensor->frame_rate.denominator = tpf->numerator;
706 vs6624_write(sd, VS6624_DISABLE_FR_DAMPER, 0x0);
707 vs6624_write(sd, VS6624_FR_NUM_MSB,
708 sensor->frame_rate.numerator >> 8);
709 vs6624_write(sd, VS6624_FR_NUM_LSB,
710 sensor->frame_rate.numerator & 0xFF);
711 vs6624_write(sd, VS6624_FR_DEN,
712 sensor->frame_rate.denominator & 0xFF);
716 static int vs6624_s_stream(struct v4l2_subdev *sd, int enable)
719 vs6624_write(sd, VS6624_USER_CMD, 0x2);
721 vs6624_write(sd, VS6624_USER_CMD, 0x4);
726 #ifdef CONFIG_VIDEO_ADV_DEBUG
727 static int vs6624_g_register(struct v4l2_subdev *sd, struct v4l2_dbg_register *reg)
729 reg->val = vs6624_read(sd, reg->reg & 0xffff);
734 static int vs6624_s_register(struct v4l2_subdev *sd, const struct v4l2_dbg_register *reg)
736 vs6624_write(sd, reg->reg & 0xffff, reg->val & 0xff);
741 static const struct v4l2_ctrl_ops vs6624_ctrl_ops = {
742 .s_ctrl = vs6624_s_ctrl,
745 static const struct v4l2_subdev_core_ops vs6624_core_ops = {
746 #ifdef CONFIG_VIDEO_ADV_DEBUG
747 .g_register = vs6624_g_register,
748 .s_register = vs6624_s_register,
752 static const struct v4l2_subdev_video_ops vs6624_video_ops = {
753 .enum_mbus_fmt = vs6624_enum_mbus_fmt,
754 .try_mbus_fmt = vs6624_try_mbus_fmt,
755 .s_mbus_fmt = vs6624_s_mbus_fmt,
756 .g_mbus_fmt = vs6624_g_mbus_fmt,
757 .s_parm = vs6624_s_parm,
758 .g_parm = vs6624_g_parm,
759 .s_stream = vs6624_s_stream,
762 static const struct v4l2_subdev_ops vs6624_ops = {
763 .core = &vs6624_core_ops,
764 .video = &vs6624_video_ops,
767 static int vs6624_probe(struct i2c_client *client,
768 const struct i2c_device_id *id)
770 struct vs6624 *sensor;
771 struct v4l2_subdev *sd;
772 struct v4l2_ctrl_handler *hdl;
776 /* Check if the adapter supports the needed features */
777 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
780 ce = client->dev.platform_data;
784 ret = devm_gpio_request_one(&client->dev, *ce, GPIOF_OUT_INIT_HIGH,
785 "VS6624 Chip Enable");
787 v4l_err(client, "failed to request GPIO %d\n", *ce);
790 /* wait 100ms before any further i2c writes are performed */
793 sensor = devm_kzalloc(&client->dev, sizeof(*sensor), GFP_KERNEL);
798 v4l2_i2c_subdev_init(sd, client, &vs6624_ops);
800 vs6624_writeregs(sd, vs6624_p1);
801 vs6624_write(sd, VS6624_MICRO_EN, 0x2);
802 vs6624_write(sd, VS6624_DIO_EN, 0x1);
804 vs6624_writeregs(sd, vs6624_p2);
806 vs6624_writeregs(sd, vs6624_default);
807 vs6624_write(sd, VS6624_HSYNC_SETUP, 0xF);
808 vs6624_writeregs(sd, vs6624_run_setup);
811 sensor->frame_rate.numerator = MAX_FRAME_RATE;
812 sensor->frame_rate.denominator = 1;
813 vs6624_write(sd, VS6624_DISABLE_FR_DAMPER, 0x0);
814 vs6624_write(sd, VS6624_FR_NUM_MSB,
815 sensor->frame_rate.numerator >> 8);
816 vs6624_write(sd, VS6624_FR_NUM_LSB,
817 sensor->frame_rate.numerator & 0xFF);
818 vs6624_write(sd, VS6624_FR_DEN,
819 sensor->frame_rate.denominator & 0xFF);
821 sensor->fmt = vs6624_default_fmt;
822 sensor->ce_pin = *ce;
824 v4l_info(client, "chip found @ 0x%02x (%s)\n",
825 client->addr << 1, client->adapter->name);
828 v4l2_ctrl_handler_init(hdl, 4);
829 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
830 V4L2_CID_CONTRAST, 0, 0xFF, 1, 0x87);
831 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
832 V4L2_CID_SATURATION, 0, 0xFF, 1, 0x78);
833 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
834 V4L2_CID_HFLIP, 0, 1, 1, 0);
835 v4l2_ctrl_new_std(hdl, &vs6624_ctrl_ops,
836 V4L2_CID_VFLIP, 0, 1, 1, 0);
837 /* hook the control handler into the driver */
838 sd->ctrl_handler = hdl;
840 int err = hdl->error;
842 v4l2_ctrl_handler_free(hdl);
846 /* initialize the hardware to the default control values */
847 ret = v4l2_ctrl_handler_setup(hdl);
849 v4l2_ctrl_handler_free(hdl);
853 static int vs6624_remove(struct i2c_client *client)
855 struct v4l2_subdev *sd = i2c_get_clientdata(client);
857 v4l2_device_unregister_subdev(sd);
858 v4l2_ctrl_handler_free(sd->ctrl_handler);
862 static const struct i2c_device_id vs6624_id[] = {
867 MODULE_DEVICE_TABLE(i2c, vs6624_id);
869 static struct i2c_driver vs6624_driver = {
871 .owner = THIS_MODULE,
874 .probe = vs6624_probe,
875 .remove = vs6624_remove,
876 .id_table = vs6624_id,
879 module_i2c_driver(vs6624_driver);
881 MODULE_DESCRIPTION("VS6624 sensor driver");
883 MODULE_LICENSE("GPL v2");