4 * Copyright (C) 2008 Renesas Solutions Corp.
5 * Kuninori Morimoto <morimoto.kuninori@renesas.com>
7 * Based on ov772x driver,
9 * Copyright (C) 2008 Kuninori Morimoto <morimoto.kuninori@renesas.com>
10 * Copyright 2006-7 Jonathan Corbet <corbet@lwn.net>
11 * Copyright (C) 2008 Magnus Damm
12 * Copyright (C) 2008, Guennadi Liakhovetski <kernel@pengutronix.de>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
19 #include <linux/init.h>
20 #include <linux/module.h>
21 #include <linux/i2c.h>
22 #include <linux/slab.h>
23 #include <linux/kernel.h>
24 #include <linux/delay.h>
25 #include <linux/videodev2.h>
26 #include <media/v4l2-chip-ident.h>
27 #include <media/v4l2-common.h>
28 #include <media/soc_camera.h>
29 #include <media/tw9910.h>
31 #define GET_ID(val) ((val & 0xF8) >> 3)
32 #define GET_ReV(val) (val & 0x07)
37 #define ID 0x00 /* Product ID Code Register */
38 #define STATUS1 0x01 /* Chip Status Register I */
39 #define INFORM 0x02 /* Input Format */
40 #define OPFORM 0x03 /* Output Format Control Register */
41 #define DLYCTR 0x04 /* Hysteresis and HSYNC Delay Control */
42 #define OUTCTR1 0x05 /* Output Control I */
43 #define ACNTL1 0x06 /* Analog Control Register 1 */
44 #define CROP_HI 0x07 /* Cropping Register, High */
45 #define VDELAY_LO 0x08 /* Vertical Delay Register, Low */
46 #define VACTIVE_LO 0x09 /* Vertical Active Register, Low */
47 #define HDELAY_LO 0x0A /* Horizontal Delay Register, Low */
48 #define HACTIVE_LO 0x0B /* Horizontal Active Register, Low */
49 #define CNTRL1 0x0C /* Control Register I */
50 #define VSCALE_LO 0x0D /* Vertical Scaling Register, Low */
51 #define SCALE_HI 0x0E /* Scaling Register, High */
52 #define HSCALE_LO 0x0F /* Horizontal Scaling Register, Low */
53 #define BRIGHT 0x10 /* BRIGHTNESS Control Register */
54 #define CONTRAST 0x11 /* CONTRAST Control Register */
55 #define SHARPNESS 0x12 /* SHARPNESS Control Register I */
56 #define SAT_U 0x13 /* Chroma (U) Gain Register */
57 #define SAT_V 0x14 /* Chroma (V) Gain Register */
58 #define HUE 0x15 /* Hue Control Register */
60 #define CORING2 0x18 /* Coring and IF compensation */
61 #define VBICNTL 0x19 /* VBI Control Register */
62 #define ACNTL2 0x1A /* Analog Control 2 */
63 #define OUTCTR2 0x1B /* Output Control 2 */
64 #define SDT 0x1C /* Standard Selection */
65 #define SDTR 0x1D /* Standard Recognition */
66 #define TEST 0x1F /* Test Control Register */
67 #define CLMPG 0x20 /* Clamping Gain */
68 #define IAGC 0x21 /* Individual AGC Gain */
69 #define AGCGAIN 0x22 /* AGC Gain */
70 #define PEAKWT 0x23 /* White Peak Threshold */
71 #define CLMPL 0x24 /* Clamp level */
72 #define SYNCT 0x25 /* Sync Amplitude */
73 #define MISSCNT 0x26 /* Sync Miss Count Register */
74 #define PCLAMP 0x27 /* Clamp Position Register */
75 #define VCNTL1 0x28 /* Vertical Control I */
76 #define VCNTL2 0x29 /* Vertical Control II */
77 #define CKILL 0x2A /* Color Killer Level Control */
78 #define COMB 0x2B /* Comb Filter Control */
79 #define LDLY 0x2C /* Luma Delay and H Filter Control */
80 #define MISC1 0x2D /* Miscellaneous Control I */
81 #define LOOP 0x2E /* LOOP Control Register */
82 #define MISC2 0x2F /* Miscellaneous Control II */
83 #define MVSN 0x30 /* Macrovision Detection */
84 #define STATUS2 0x31 /* Chip STATUS II */
85 #define HFREF 0x32 /* H monitor */
86 #define CLMD 0x33 /* CLAMP MODE */
87 #define IDCNTL 0x34 /* ID Detection Control */
88 #define CLCNTL1 0x35 /* Clamp Control I */
89 #define ANAPLLCTL 0x4C
124 #define VBIDELAY 0x6F
131 #define FC27_ON 0x40 /* 1 : Input crystal clock frequency is 27MHz */
132 #define FC27_FF 0x00 /* 0 : Square pixel mode. */
133 /* Must use 24.54MHz for 60Hz field rate */
134 /* source or 29.5MHz for 50Hz field rate */
135 #define IFSEL_S 0x10 /* 01 : S-video decoding */
136 #define IFSEL_C 0x00 /* 00 : Composite video decoding */
137 /* Y input video selection */
138 #define YSEL_M0 0x00 /* 00 : Mux0 selected */
139 #define YSEL_M1 0x04 /* 01 : Mux1 selected */
140 #define YSEL_M2 0x08 /* 10 : Mux2 selected */
141 #define YSEL_M3 0x10 /* 11 : Mux3 selected */
144 #define MODE 0x80 /* 0 : CCIR601 compatible YCrCb 4:2:2 format */
145 /* 1 : ITU-R-656 compatible data sequence format */
146 #define LEN 0x40 /* 0 : 8-bit YCrCb 4:2:2 output format */
147 /* 1 : 16-bit YCrCb 4:2:2 output format.*/
148 #define LLCMODE 0x20 /* 1 : LLC output mode. */
149 /* 0 : free-run output mode */
150 #define AINC 0x10 /* Serial interface auto-indexing control */
151 /* 0 : auto-increment */
153 #define VSCTL 0x08 /* 1 : Vertical out ctrl by DVALID */
154 /* 0 : Vertical out ctrl by HACTIVE and DVALID */
155 #define OEN 0x04 /* Output Enable together with TRI_SEL. */
158 #define VSP_LO 0x00 /* 0 : VS pin output polarity is active low */
159 #define VSP_HI 0x80 /* 1 : VS pin output polarity is active high. */
160 /* VS pin output control */
161 #define VSSL_VSYNC 0x00 /* 0 : VSYNC */
162 #define VSSL_VACT 0x10 /* 1 : VACT */
163 #define VSSL_FIELD 0x20 /* 2 : FIELD */
164 #define VSSL_VVALID 0x30 /* 3 : VVALID */
165 #define VSSL_ZERO 0x70 /* 7 : 0 */
166 #define HSP_LOW 0x00 /* 0 : HS pin output polarity is active low */
167 #define HSP_HI 0x08 /* 1 : HS pin output polarity is active high.*/
168 /* HS pin output control */
169 #define HSSL_HACT 0x00 /* 0 : HACT */
170 #define HSSL_HSYNC 0x01 /* 1 : HSYNC */
171 #define HSSL_DVALID 0x02 /* 2 : DVALID */
172 #define HSSL_HLOCK 0x03 /* 3 : HLOCK */
173 #define HSSL_ASYNCW 0x04 /* 4 : ASYNCW */
174 #define HSSL_ZERO 0x07 /* 7 : 0 */
177 #define SRESET 0x80 /* resets the device to its default state
178 * but all register content remain unchanged.
179 * This bit is self-resetting.
183 /* RTSEL : control the real time signal
184 * output from the MPOUT pin
186 #define RTSEL_MASK 0x07
187 #define RTSEL_VLOSS 0x00 /* 0000 = Video loss */
188 #define RTSEL_HLOCK 0x01 /* 0001 = H-lock */
189 #define RTSEL_SLOCK 0x02 /* 0010 = S-lock */
190 #define RTSEL_VLOCK 0x03 /* 0011 = V-lock */
191 #define RTSEL_MONO 0x04 /* 0100 = MONO */
192 #define RTSEL_DET50 0x05 /* 0101 = DET50 */
193 #define RTSEL_FIELD 0x06 /* 0110 = FIELD */
194 #define RTSEL_RTCO 0x07 /* 0111 = RTCO ( Real Time Control ) */
201 unsigned char reg_num;
205 struct tw9910_scale_ctrl {
207 unsigned short width;
208 unsigned short height;
213 struct tw9910_cropping_ctrl {
220 struct tw9910_hsync_ctrl {
226 struct tw9910_video_info *info;
227 struct i2c_client *client;
228 struct soc_camera_device icd;
229 const struct tw9910_scale_ctrl *scale;
236 #define ENDMARKER { 0xff, 0xff }
238 static const struct regval_list tw9910_default_regs[] =
241 { OUTCTR1, VSP_LO | VSSL_VVALID | HSP_HI | HSSL_HSYNC },
245 static const struct soc_camera_data_format tw9910_color_fmt[] = {
248 .fourcc = V4L2_PIX_FMT_VYUY,
250 .colorspace = V4L2_COLORSPACE_SMPTE170M,
254 static const struct tw9910_scale_ctrl tw9910_ntsc_scales[] = {
263 .name = "NTSC CCIR601",
270 .name = "NTSC SQ (CIF)",
277 .name = "NTSC CCIR601 (CIF)",
284 .name = "NTSC SQ (QCIF)",
291 .name = "NTSC CCIR601 (QCIF)",
299 static const struct tw9910_scale_ctrl tw9910_pal_scales[] = {
308 .name = "PAL CCIR601",
315 .name = "PAL SQ (CIF)",
322 .name = "PAL CCIR601 (CIF)",
329 .name = "PAL SQ (QCIF)",
336 .name = "PAL CCIR601 (QCIF)",
344 static const struct tw9910_cropping_ctrl tw9910_cropping_ctrl = {
351 static const struct tw9910_hsync_ctrl tw9910_hsync_ctrl = {
359 static int tw9910_set_scale(struct i2c_client *client,
360 const struct tw9910_scale_ctrl *scale)
364 ret = i2c_smbus_write_byte_data(client, SCALE_HI,
365 (scale->vscale & 0x0F00) >> 4 |
366 (scale->hscale & 0x0F00) >> 8);
370 ret = i2c_smbus_write_byte_data(client, HSCALE_LO,
371 scale->hscale & 0x00FF);
375 ret = i2c_smbus_write_byte_data(client, VSCALE_LO,
376 scale->vscale & 0x00FF);
381 static int tw9910_set_cropping(struct i2c_client *client,
382 const struct tw9910_cropping_ctrl *cropping)
386 ret = i2c_smbus_write_byte_data(client, CROP_HI,
387 (cropping->vdelay & 0x0300) >> 2 |
388 (cropping->vactive & 0x0300) >> 4 |
389 (cropping->hdelay & 0x0300) >> 6 |
390 (cropping->hactive & 0x0300) >> 8);
394 ret = i2c_smbus_write_byte_data(client, VDELAY_LO,
395 cropping->vdelay & 0x00FF);
399 ret = i2c_smbus_write_byte_data(client, VACTIVE_LO,
400 cropping->vactive & 0x00FF);
404 ret = i2c_smbus_write_byte_data(client, HDELAY_LO,
405 cropping->hdelay & 0x00FF);
409 ret = i2c_smbus_write_byte_data(client, HACTIVE_LO,
410 cropping->hactive & 0x00FF);
415 static int tw9910_set_hsync(struct i2c_client *client,
416 const struct tw9910_hsync_ctrl *hsync)
421 ret = i2c_smbus_write_byte_data(client, HSGEGIN,
422 (hsync->start & 0x07F8) >> 3);
427 ret = i2c_smbus_write_byte_data(client, HSEND,
428 (hsync->end & 0x07F8) >> 3);
433 ret = i2c_smbus_read_byte_data(client, HSLOWCTL);
437 ret = i2c_smbus_write_byte_data(client, HSLOWCTL,
439 (hsync->start & 0x0007) << 4 |
440 (hsync->end & 0x0007));
445 static int tw9910_write_array(struct i2c_client *client,
446 const struct regval_list *vals)
448 while (vals->reg_num != 0xff) {
449 int ret = i2c_smbus_write_byte_data(client,
459 static int tw9910_mask_set(struct i2c_client *client, u8 command,
462 s32 val = i2c_smbus_read_byte_data(client, command);
467 return i2c_smbus_write_byte_data(client, command, val);
470 static void tw9910_reset(struct i2c_client *client)
472 i2c_smbus_write_byte_data(client, ACNTL1, SRESET);
476 static const struct tw9910_scale_ctrl*
477 tw9910_select_norm(struct soc_camera_device *icd, u32 width, u32 height)
479 const struct tw9910_scale_ctrl *scale;
480 const struct tw9910_scale_ctrl *ret = NULL;
481 v4l2_std_id norm = icd->vdev->current_norm;
482 __u32 diff = 0xffffffff, tmp;
485 if (norm & V4L2_STD_NTSC) {
486 scale = tw9910_ntsc_scales;
487 size = ARRAY_SIZE(tw9910_ntsc_scales);
488 } else if (norm & V4L2_STD_PAL) {
489 scale = tw9910_pal_scales;
490 size = ARRAY_SIZE(tw9910_pal_scales);
495 for (i = 0; i < size; i++) {
496 tmp = abs(width - scale[i].width) +
497 abs(height - scale[i].height);
508 * soc_camera_ops function
510 static int tw9910_init(struct soc_camera_device *icd)
512 struct tw9910_priv *priv = container_of(icd, struct tw9910_priv, icd);
515 if (priv->info->link.power) {
516 ret = priv->info->link.power(&priv->client->dev, 1);
521 if (priv->info->link.reset)
522 ret = priv->info->link.reset(&priv->client->dev);
527 static int tw9910_release(struct soc_camera_device *icd)
529 struct tw9910_priv *priv = container_of(icd, struct tw9910_priv, icd);
532 if (priv->info->link.power)
533 ret = priv->info->link.power(&priv->client->dev, 0);
538 static int tw9910_start_capture(struct soc_camera_device *icd)
540 struct tw9910_priv *priv = container_of(icd, struct tw9910_priv, icd);
543 dev_err(&icd->dev, "norm select error\n");
547 dev_dbg(&icd->dev, "%s %dx%d\n",
550 priv->scale->height);
555 static int tw9910_stop_capture(struct soc_camera_device *icd)
560 static int tw9910_set_bus_param(struct soc_camera_device *icd,
566 static unsigned long tw9910_query_bus_param(struct soc_camera_device *icd)
568 struct tw9910_priv *priv = container_of(icd, struct tw9910_priv, icd);
569 struct soc_camera_link *icl = priv->client->dev.platform_data;
570 unsigned long flags = SOCAM_PCLK_SAMPLE_RISING | SOCAM_MASTER |
571 SOCAM_VSYNC_ACTIVE_HIGH | SOCAM_HSYNC_ACTIVE_HIGH |
572 SOCAM_DATA_ACTIVE_HIGH | priv->info->buswidth;
574 return soc_camera_apply_sensor_flags(icl, flags);
577 static int tw9910_get_chip_id(struct soc_camera_device *icd,
578 struct v4l2_dbg_chip_ident *id)
580 id->ident = V4L2_IDENT_TW9910;
586 static int tw9910_set_std(struct soc_camera_device *icd,
591 if (*a & (V4L2_STD_NTSC | V4L2_STD_PAL))
597 static int tw9910_enum_input(struct soc_camera_device *icd,
598 struct v4l2_input *inp)
600 inp->type = V4L2_INPUT_TYPE_TUNER;
601 inp->std = V4L2_STD_UNKNOWN;
602 strcpy(inp->name, "Video");
607 #ifdef CONFIG_VIDEO_ADV_DEBUG
608 static int tw9910_get_register(struct soc_camera_device *icd,
609 struct v4l2_dbg_register *reg)
611 struct tw9910_priv *priv = container_of(icd, struct tw9910_priv, icd);
617 ret = i2c_smbus_read_byte_data(priv->client, reg->reg);
624 reg->val = (__u64)ret;
629 static int tw9910_set_register(struct soc_camera_device *icd,
630 struct v4l2_dbg_register *reg)
632 struct tw9910_priv *priv = container_of(icd, struct tw9910_priv, icd);
634 if (reg->reg > 0xff ||
638 return i2c_smbus_write_byte_data(priv->client, reg->reg, reg->val);
642 static int tw9910_set_fmt(struct soc_camera_device *icd, __u32 pixfmt,
643 struct v4l2_rect *rect)
645 struct tw9910_priv *priv = container_of(icd, struct tw9910_priv, icd);
650 * select suitable norm
652 priv->scale = tw9910_select_norm(icd, rect->width, rect->height);
654 goto tw9910_set_fmt_error;
659 tw9910_reset(priv->client);
660 ret = tw9910_write_array(priv->client, tw9910_default_regs);
662 goto tw9910_set_fmt_error;
668 if (SOCAM_DATAWIDTH_16 == priv->info->buswidth)
671 ret = tw9910_mask_set(priv->client, OPFORM, LEN, val);
673 goto tw9910_set_fmt_error;
676 * select MPOUT behavior
678 switch (priv->info->mpout) {
679 case TW9910_MPO_VLOSS:
680 val = RTSEL_VLOSS; break;
681 case TW9910_MPO_HLOCK:
682 val = RTSEL_HLOCK; break;
683 case TW9910_MPO_SLOCK:
684 val = RTSEL_SLOCK; break;
685 case TW9910_MPO_VLOCK:
686 val = RTSEL_VLOCK; break;
687 case TW9910_MPO_MONO:
688 val = RTSEL_MONO; break;
689 case TW9910_MPO_DET50:
690 val = RTSEL_DET50; break;
691 case TW9910_MPO_FIELD:
692 val = RTSEL_FIELD; break;
693 case TW9910_MPO_RTCO:
694 val = RTSEL_RTCO; break;
699 ret = tw9910_mask_set(priv->client, VBICNTL, RTSEL_MASK, val);
701 goto tw9910_set_fmt_error;
706 ret = tw9910_set_scale(priv->client, priv->scale);
708 goto tw9910_set_fmt_error;
713 ret = tw9910_set_cropping(priv->client, &tw9910_cropping_ctrl);
715 goto tw9910_set_fmt_error;
720 ret = tw9910_set_hsync(priv->client, &tw9910_hsync_ctrl);
722 goto tw9910_set_fmt_error;
726 tw9910_set_fmt_error:
728 tw9910_reset(priv->client);
734 static int tw9910_try_fmt(struct soc_camera_device *icd,
735 struct v4l2_format *f)
737 struct v4l2_pix_format *pix = &f->fmt.pix;
738 const struct tw9910_scale_ctrl *scale;
740 if (V4L2_FIELD_ANY == pix->field) {
741 pix->field = V4L2_FIELD_INTERLACED;
742 } else if (V4L2_FIELD_INTERLACED != pix->field) {
743 dev_err(&icd->dev, "Field type invalid.\n");
748 * select suitable norm
750 scale = tw9910_select_norm(icd, pix->width, pix->height);
754 pix->width = scale->width;
755 pix->height = scale->height;
760 static int tw9910_video_probe(struct soc_camera_device *icd)
762 struct tw9910_priv *priv = container_of(icd, struct tw9910_priv, icd);
767 * We must have a parent by now. And it cannot be a wrong one.
768 * So this entire test is completely redundant.
770 if (!icd->dev.parent ||
771 to_soc_camera_host(icd->dev.parent)->nr != icd->iface)
775 * tw9910 only use 8 or 16 bit bus width
777 if (SOCAM_DATAWIDTH_16 != priv->info->buswidth &&
778 SOCAM_DATAWIDTH_8 != priv->info->buswidth) {
779 dev_err(&icd->dev, "bus width error\n");
783 icd->formats = tw9910_color_fmt;
784 icd->num_formats = ARRAY_SIZE(tw9910_color_fmt);
787 * check and show Product ID
789 val = i2c_smbus_read_byte_data(priv->client, ID);
790 if (0x0B != GET_ID(val) ||
791 0x00 != GET_ReV(val)) {
793 "Product ID error %x:%x\n", GET_ID(val), GET_ReV(val));
798 "tw9910 Product ID %0x:%0x\n", GET_ID(val), GET_ReV(val));
800 ret = soc_camera_video_start(icd);
804 icd->vdev->tvnorms = V4L2_STD_NTSC | V4L2_STD_PAL;
805 icd->vdev->current_norm = V4L2_STD_NTSC;
810 static void tw9910_video_remove(struct soc_camera_device *icd)
812 soc_camera_video_stop(icd);
815 static struct soc_camera_ops tw9910_ops = {
816 .owner = THIS_MODULE,
817 .probe = tw9910_video_probe,
818 .remove = tw9910_video_remove,
820 .release = tw9910_release,
821 .start_capture = tw9910_start_capture,
822 .stop_capture = tw9910_stop_capture,
823 .set_fmt = tw9910_set_fmt,
824 .try_fmt = tw9910_try_fmt,
825 .set_bus_param = tw9910_set_bus_param,
826 .query_bus_param = tw9910_query_bus_param,
827 .get_chip_id = tw9910_get_chip_id,
828 .set_std = tw9910_set_std,
829 .enum_input = tw9910_enum_input,
830 #ifdef CONFIG_VIDEO_ADV_DEBUG
831 .get_register = tw9910_get_register,
832 .set_register = tw9910_set_register,
837 * i2c_driver function
840 static int tw9910_probe(struct i2c_client *client,
841 const struct i2c_device_id *did)
844 struct tw9910_priv *priv;
845 struct tw9910_video_info *info;
846 struct soc_camera_device *icd;
847 const struct tw9910_scale_ctrl *scale;
850 info = client->dev.platform_data;
854 if (!i2c_check_functionality(to_i2c_adapter(client->dev.parent),
855 I2C_FUNC_SMBUS_BYTE_DATA)) {
856 dev_err(&client->dev,
857 "I2C-Adapter doesn't support "
858 "I2C_FUNC_SMBUS_BYTE_DATA\n");
862 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
867 priv->client = client;
868 i2c_set_clientdata(client, priv);
871 icd->ops = &tw9910_ops;
872 icd->control = &client->dev;
873 icd->iface = info->link.bus_id;
876 * set width and height
878 icd->width_max = tw9910_ntsc_scales[0].width; /* set default */
879 icd->width_min = tw9910_ntsc_scales[0].width;
880 icd->height_max = tw9910_ntsc_scales[0].height;
881 icd->height_min = tw9910_ntsc_scales[0].height;
883 scale = tw9910_ntsc_scales;
884 for (i = 0; i < ARRAY_SIZE(tw9910_ntsc_scales); i++) {
885 icd->width_max = max(scale[i].width, icd->width_max);
886 icd->width_min = min(scale[i].width, icd->width_min);
887 icd->height_max = max(scale[i].height, icd->height_max);
888 icd->height_min = min(scale[i].height, icd->height_min);
890 scale = tw9910_pal_scales;
891 for (i = 0; i < ARRAY_SIZE(tw9910_pal_scales); i++) {
892 icd->width_max = max(scale[i].width, icd->width_max);
893 icd->width_min = min(scale[i].width, icd->width_min);
894 icd->height_max = max(scale[i].height, icd->height_max);
895 icd->height_min = min(scale[i].height, icd->height_min);
898 ret = soc_camera_device_register(icd);
901 i2c_set_clientdata(client, NULL);
908 static int tw9910_remove(struct i2c_client *client)
910 struct tw9910_priv *priv = i2c_get_clientdata(client);
912 soc_camera_device_unregister(&priv->icd);
913 i2c_set_clientdata(client, NULL);
918 static const struct i2c_device_id tw9910_id[] = {
922 MODULE_DEVICE_TABLE(i2c, tw9910_id);
924 static struct i2c_driver tw9910_i2c_driver = {
928 .probe = tw9910_probe,
929 .remove = tw9910_remove,
930 .id_table = tw9910_id,
936 static int __init tw9910_module_init(void)
938 return i2c_add_driver(&tw9910_i2c_driver);
941 static void __exit tw9910_module_exit(void)
943 i2c_del_driver(&tw9910_i2c_driver);
946 module_init(tw9910_module_init);
947 module_exit(tw9910_module_exit);
949 MODULE_DESCRIPTION("SoC Camera driver for tw9910");
950 MODULE_AUTHOR("Kuninori Morimoto");
951 MODULE_LICENSE("GPL v2");