]> asedeno.scripts.mit.edu Git - linux.git/blob - drivers/media/i2c/tw9910.c
cc5d383fc6b89303825c40b63742ec9f09b55432
[linux.git] / drivers / media / i2c / tw9910.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * tw9910 Video Driver
4  *
5  * Copyright (C) 2017 Jacopo Mondi <jacopo+renesas@jmondi.org>
6  *
7  * Copyright (C) 2008 Renesas Solutions Corp.
8  * Kuninori Morimoto <morimoto.kuninori@renesas.com>
9  *
10  * Based on ov772x driver,
11  *
12  * Copyright (C) 2008 Kuninori Morimoto <morimoto.kuninori@renesas.com>
13  * Copyright 2006-7 Jonathan Corbet <corbet@lwn.net>
14  * Copyright (C) 2008 Magnus Damm
15  * Copyright (C) 2008, Guennadi Liakhovetski <kernel@pengutronix.de>
16  */
17
18 #include <linux/clk.h>
19 #include <linux/gpio/consumer.h>
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/i2c.h>
23 #include <linux/slab.h>
24 #include <linux/kernel.h>
25 #include <linux/delay.h>
26 #include <linux/v4l2-mediabus.h>
27 #include <linux/videodev2.h>
28
29 #include <media/i2c/tw9910.h>
30 #include <media/v4l2-subdev.h>
31
32 #define GET_ID(val)  ((val & 0xF8) >> 3)
33 #define GET_REV(val) (val & 0x07)
34
35 /*
36  * register offset
37  */
38 #define ID              0x00 /* Product ID Code Register */
39 #define STATUS1         0x01 /* Chip Status Register I */
40 #define INFORM          0x02 /* Input Format */
41 #define OPFORM          0x03 /* Output Format Control Register */
42 #define DLYCTR          0x04 /* Hysteresis and HSYNC Delay Control */
43 #define OUTCTR1         0x05 /* Output Control I */
44 #define ACNTL1          0x06 /* Analog Control Register 1 */
45 #define CROP_HI         0x07 /* Cropping Register, High */
46 #define VDELAY_LO       0x08 /* Vertical Delay Register, Low */
47 #define VACTIVE_LO      0x09 /* Vertical Active Register, Low */
48 #define HDELAY_LO       0x0A /* Horizontal Delay Register, Low */
49 #define HACTIVE_LO      0x0B /* Horizontal Active Register, Low */
50 #define CNTRL1          0x0C /* Control Register I */
51 #define VSCALE_LO       0x0D /* Vertical Scaling Register, Low */
52 #define SCALE_HI        0x0E /* Scaling Register, High */
53 #define HSCALE_LO       0x0F /* Horizontal Scaling Register, Low */
54 #define BRIGHT          0x10 /* BRIGHTNESS Control Register */
55 #define CONTRAST        0x11 /* CONTRAST Control Register */
56 #define SHARPNESS       0x12 /* SHARPNESS Control Register I */
57 #define SAT_U           0x13 /* Chroma (U) Gain Register */
58 #define SAT_V           0x14 /* Chroma (V) Gain Register */
59 #define HUE             0x15 /* Hue Control Register */
60 #define CORING1         0x17
61 #define CORING2         0x18 /* Coring and IF compensation */
62 #define VBICNTL         0x19 /* VBI Control Register */
63 #define ACNTL2          0x1A /* Analog Control 2 */
64 #define OUTCTR2         0x1B /* Output Control 2 */
65 #define SDT             0x1C /* Standard Selection */
66 #define SDTR            0x1D /* Standard Recognition */
67 #define TEST            0x1F /* Test Control Register */
68 #define CLMPG           0x20 /* Clamping Gain */
69 #define IAGC            0x21 /* Individual AGC Gain */
70 #define AGCGAIN         0x22 /* AGC Gain */
71 #define PEAKWT          0x23 /* White Peak Threshold */
72 #define CLMPL           0x24 /* Clamp level */
73 #define SYNCT           0x25 /* Sync Amplitude */
74 #define MISSCNT         0x26 /* Sync Miss Count Register */
75 #define PCLAMP          0x27 /* Clamp Position Register */
76 #define VCNTL1          0x28 /* Vertical Control I */
77 #define VCNTL2          0x29 /* Vertical Control II */
78 #define CKILL           0x2A /* Color Killer Level Control */
79 #define COMB            0x2B /* Comb Filter Control */
80 #define LDLY            0x2C /* Luma Delay and H Filter Control */
81 #define MISC1           0x2D /* Miscellaneous Control I */
82 #define LOOP            0x2E /* LOOP Control Register */
83 #define MISC2           0x2F /* Miscellaneous Control II */
84 #define MVSN            0x30 /* Macrovision Detection */
85 #define STATUS2         0x31 /* Chip STATUS II */
86 #define HFREF           0x32 /* H monitor */
87 #define CLMD            0x33 /* CLAMP MODE */
88 #define IDCNTL          0x34 /* ID Detection Control */
89 #define CLCNTL1         0x35 /* Clamp Control I */
90 #define ANAPLLCTL       0x4C
91 #define VBIMIN          0x4D
92 #define HSLOWCTL        0x4E
93 #define WSS3            0x4F
94 #define FILLDATA        0x50
95 #define SDID            0x51
96 #define DID             0x52
97 #define WSS1            0x53
98 #define WSS2            0x54
99 #define VVBI            0x55
100 #define LCTL6           0x56
101 #define LCTL7           0x57
102 #define LCTL8           0x58
103 #define LCTL9           0x59
104 #define LCTL10          0x5A
105 #define LCTL11          0x5B
106 #define LCTL12          0x5C
107 #define LCTL13          0x5D
108 #define LCTL14          0x5E
109 #define LCTL15          0x5F
110 #define LCTL16          0x60
111 #define LCTL17          0x61
112 #define LCTL18          0x62
113 #define LCTL19          0x63
114 #define LCTL20          0x64
115 #define LCTL21          0x65
116 #define LCTL22          0x66
117 #define LCTL23          0x67
118 #define LCTL24          0x68
119 #define LCTL25          0x69
120 #define LCTL26          0x6A
121 #define HSBEGIN         0x6B
122 #define HSEND           0x6C
123 #define OVSDLY          0x6D
124 #define OVSEND          0x6E
125 #define VBIDELAY        0x6F
126
127 /*
128  * register detail
129  */
130
131 /* INFORM */
132 #define FC27_ON     0x40 /* 1 : Input crystal clock frequency is 27MHz */
133 #define FC27_FF     0x00 /* 0 : Square pixel mode. */
134                          /*     Must use 24.54MHz for 60Hz field rate */
135                          /*     source or 29.5MHz for 50Hz field rate */
136 #define IFSEL_S     0x10 /* 01 : S-video decoding */
137 #define IFSEL_C     0x00 /* 00 : Composite video decoding */
138                          /* Y input video selection */
139 #define YSEL_M0     0x00 /*  00 : Mux0 selected */
140 #define YSEL_M1     0x04 /*  01 : Mux1 selected */
141 #define YSEL_M2     0x08 /*  10 : Mux2 selected */
142 #define YSEL_M3     0x10 /*  11 : Mux3 selected */
143
144 /* OPFORM */
145 #define MODE        0x80 /* 0 : CCIR601 compatible YCrCb 4:2:2 format */
146                          /* 1 : ITU-R-656 compatible data sequence format */
147 #define LEN         0x40 /* 0 : 8-bit YCrCb 4:2:2 output format */
148                          /* 1 : 16-bit YCrCb 4:2:2 output format.*/
149 #define LLCMODE     0x20 /* 1 : LLC output mode. */
150                          /* 0 : free-run output mode */
151 #define AINC        0x10 /* Serial interface auto-indexing control */
152                          /* 0 : auto-increment */
153                          /* 1 : non-auto */
154 #define VSCTL       0x08 /* 1 : Vertical out ctrl by DVALID */
155                          /* 0 : Vertical out ctrl by HACTIVE and DVALID */
156 #define OEN_TRI_SEL_MASK        0x07
157 #define OEN_TRI_SEL_ALL_ON      0x00 /* Enable output for Rev0/Rev1 */
158 #define OEN_TRI_SEL_ALL_OFF_r0  0x06 /* All tri-stated for Rev0 */
159 #define OEN_TRI_SEL_ALL_OFF_r1  0x07 /* All tri-stated for Rev1 */
160
161 /* OUTCTR1 */
162 #define VSP_LO      0x00 /* 0 : VS pin output polarity is active low */
163 #define VSP_HI      0x80 /* 1 : VS pin output polarity is active high. */
164                          /* VS pin output control */
165 #define VSSL_VSYNC  0x00 /*   0 : VSYNC  */
166 #define VSSL_VACT   0x10 /*   1 : VACT   */
167 #define VSSL_FIELD  0x20 /*   2 : FIELD  */
168 #define VSSL_VVALID 0x30 /*   3 : VVALID */
169 #define VSSL_ZERO   0x70 /*   7 : 0      */
170 #define HSP_LOW     0x00 /* 0 : HS pin output polarity is active low */
171 #define HSP_HI      0x08 /* 1 : HS pin output polarity is active high.*/
172                          /* HS pin output control */
173 #define HSSL_HACT   0x00 /*   0 : HACT   */
174 #define HSSL_HSYNC  0x01 /*   1 : HSYNC  */
175 #define HSSL_DVALID 0x02 /*   2 : DVALID */
176 #define HSSL_HLOCK  0x03 /*   3 : HLOCK  */
177 #define HSSL_ASYNCW 0x04 /*   4 : ASYNCW */
178 #define HSSL_ZERO   0x07 /*   7 : 0      */
179
180 /* ACNTL1 */
181 #define SRESET      0x80 /* resets the device to its default state
182                           * but all register content remain unchanged.
183                           * This bit is self-resetting.
184                           */
185 #define ACNTL1_PDN_MASK 0x0e
186 #define CLK_PDN         0x08 /* system clock power down */
187 #define Y_PDN           0x04 /* Luma ADC power down */
188 #define C_PDN           0x02 /* Chroma ADC power down */
189
190 /* ACNTL2 */
191 #define ACNTL2_PDN_MASK 0x40
192 #define PLL_PDN         0x40 /* PLL power down */
193
194 /* VBICNTL */
195
196 /* RTSEL : control the real time signal output from the MPOUT pin */
197 #define RTSEL_MASK  0x07
198 #define RTSEL_VLOSS 0x00 /* 0000 = Video loss */
199 #define RTSEL_HLOCK 0x01 /* 0001 = H-lock */
200 #define RTSEL_SLOCK 0x02 /* 0010 = S-lock */
201 #define RTSEL_VLOCK 0x03 /* 0011 = V-lock */
202 #define RTSEL_MONO  0x04 /* 0100 = MONO */
203 #define RTSEL_DET50 0x05 /* 0101 = DET50 */
204 #define RTSEL_FIELD 0x06 /* 0110 = FIELD */
205 #define RTSEL_RTCO  0x07 /* 0111 = RTCO ( Real Time Control ) */
206
207 /* HSYNC start and end are constant for now */
208 #define HSYNC_START     0x0260
209 #define HSYNC_END       0x0300
210
211 /*
212  * structure
213  */
214
215 struct regval_list {
216         unsigned char reg_num;
217         unsigned char value;
218 };
219
220 struct tw9910_scale_ctrl {
221         char           *name;
222         unsigned short  width;
223         unsigned short  height;
224         u16             hscale;
225         u16             vscale;
226 };
227
228 struct tw9910_priv {
229         struct v4l2_subdev              subdev;
230         struct clk                      *clk;
231         struct tw9910_video_info        *info;
232         struct gpio_desc                *pdn_gpio;
233         struct gpio_desc                *rstb_gpio;
234         const struct tw9910_scale_ctrl  *scale;
235         v4l2_std_id                     norm;
236         u32                             revision;
237 };
238
239 static const struct tw9910_scale_ctrl tw9910_ntsc_scales[] = {
240         {
241                 .name   = "NTSC SQ",
242                 .width  = 640,
243                 .height = 480,
244                 .hscale = 0x0100,
245                 .vscale = 0x0100,
246         },
247         {
248                 .name   = "NTSC CCIR601",
249                 .width  = 720,
250                 .height = 480,
251                 .hscale = 0x0100,
252                 .vscale = 0x0100,
253         },
254         {
255                 .name   = "NTSC SQ (CIF)",
256                 .width  = 320,
257                 .height = 240,
258                 .hscale = 0x0200,
259                 .vscale = 0x0200,
260         },
261         {
262                 .name   = "NTSC CCIR601 (CIF)",
263                 .width  = 360,
264                 .height = 240,
265                 .hscale = 0x0200,
266                 .vscale = 0x0200,
267         },
268         {
269                 .name   = "NTSC SQ (QCIF)",
270                 .width  = 160,
271                 .height = 120,
272                 .hscale = 0x0400,
273                 .vscale = 0x0400,
274         },
275         {
276                 .name   = "NTSC CCIR601 (QCIF)",
277                 .width  = 180,
278                 .height = 120,
279                 .hscale = 0x0400,
280                 .vscale = 0x0400,
281         },
282 };
283
284 static const struct tw9910_scale_ctrl tw9910_pal_scales[] = {
285         {
286                 .name   = "PAL SQ",
287                 .width  = 768,
288                 .height = 576,
289                 .hscale = 0x0100,
290                 .vscale = 0x0100,
291         },
292         {
293                 .name   = "PAL CCIR601",
294                 .width  = 720,
295                 .height = 576,
296                 .hscale = 0x0100,
297                 .vscale = 0x0100,
298         },
299         {
300                 .name   = "PAL SQ (CIF)",
301                 .width  = 384,
302                 .height = 288,
303                 .hscale = 0x0200,
304                 .vscale = 0x0200,
305         },
306         {
307                 .name   = "PAL CCIR601 (CIF)",
308                 .width  = 360,
309                 .height = 288,
310                 .hscale = 0x0200,
311                 .vscale = 0x0200,
312         },
313         {
314                 .name   = "PAL SQ (QCIF)",
315                 .width  = 192,
316                 .height = 144,
317                 .hscale = 0x0400,
318                 .vscale = 0x0400,
319         },
320         {
321                 .name   = "PAL CCIR601 (QCIF)",
322                 .width  = 180,
323                 .height = 144,
324                 .hscale = 0x0400,
325                 .vscale = 0x0400,
326         },
327 };
328
329 /*
330  * general function
331  */
332 static struct tw9910_priv *to_tw9910(const struct i2c_client *client)
333 {
334         return container_of(i2c_get_clientdata(client), struct tw9910_priv,
335                             subdev);
336 }
337
338 static int tw9910_mask_set(struct i2c_client *client, u8 command,
339                            u8 mask, u8 set)
340 {
341         s32 val = i2c_smbus_read_byte_data(client, command);
342
343         if (val < 0)
344                 return val;
345
346         val &= ~mask;
347         val |= set & mask;
348
349         return i2c_smbus_write_byte_data(client, command, val);
350 }
351
352 static int tw9910_set_scale(struct i2c_client *client,
353                             const struct tw9910_scale_ctrl *scale)
354 {
355         int ret;
356
357         ret = i2c_smbus_write_byte_data(client, SCALE_HI,
358                                         (scale->vscale & 0x0F00) >> 4 |
359                                         (scale->hscale & 0x0F00) >> 8);
360         if (ret < 0)
361                 return ret;
362
363         ret = i2c_smbus_write_byte_data(client, HSCALE_LO,
364                                         scale->hscale & 0x00FF);
365         if (ret < 0)
366                 return ret;
367
368         ret = i2c_smbus_write_byte_data(client, VSCALE_LO,
369                                         scale->vscale & 0x00FF);
370
371         return ret;
372 }
373
374 static int tw9910_set_hsync(struct i2c_client *client)
375 {
376         struct tw9910_priv *priv = to_tw9910(client);
377         int ret;
378
379         /* bit 10 - 3 */
380         ret = i2c_smbus_write_byte_data(client, HSBEGIN,
381                                         (HSYNC_START & 0x07F8) >> 3);
382         if (ret < 0)
383                 return ret;
384
385         /* bit 10 - 3 */
386         ret = i2c_smbus_write_byte_data(client, HSEND,
387                                         (HSYNC_END & 0x07F8) >> 3);
388         if (ret < 0)
389                 return ret;
390
391         /* So far only revisions 0 and 1 have been seen */
392         /* bit 2 - 0 */
393         if (priv->revision == 1)
394                 ret = tw9910_mask_set(client, HSLOWCTL, 0x77,
395                                       (HSYNC_START & 0x0007) << 4 |
396                                       (HSYNC_END   & 0x0007));
397
398         return ret;
399 }
400
401 static void tw9910_reset(struct i2c_client *client)
402 {
403         tw9910_mask_set(client, ACNTL1, SRESET, SRESET);
404         msleep(1);
405 }
406
407 static int tw9910_power(struct i2c_client *client, int enable)
408 {
409         int ret;
410         u8 acntl1;
411         u8 acntl2;
412
413         if (enable) {
414                 acntl1 = 0;
415                 acntl2 = 0;
416         } else {
417                 acntl1 = CLK_PDN | Y_PDN | C_PDN;
418                 acntl2 = PLL_PDN;
419         }
420
421         ret = tw9910_mask_set(client, ACNTL1, ACNTL1_PDN_MASK, acntl1);
422         if (ret < 0)
423                 return ret;
424
425         return tw9910_mask_set(client, ACNTL2, ACNTL2_PDN_MASK, acntl2);
426 }
427
428 static const struct tw9910_scale_ctrl *tw9910_select_norm(v4l2_std_id norm,
429                                                           u32 width, u32 height)
430 {
431         const struct tw9910_scale_ctrl *scale;
432         const struct tw9910_scale_ctrl *ret = NULL;
433         __u32 diff = 0xffffffff, tmp;
434         int size, i;
435
436         if (norm & V4L2_STD_NTSC) {
437                 scale = tw9910_ntsc_scales;
438                 size = ARRAY_SIZE(tw9910_ntsc_scales);
439         } else if (norm & V4L2_STD_PAL) {
440                 scale = tw9910_pal_scales;
441                 size = ARRAY_SIZE(tw9910_pal_scales);
442         } else {
443                 return NULL;
444         }
445
446         for (i = 0; i < size; i++) {
447                 tmp = abs(width - scale[i].width) +
448                         abs(height - scale[i].height);
449                 if (tmp < diff) {
450                         diff = tmp;
451                         ret = scale + i;
452                 }
453         }
454
455         return ret;
456 }
457
458 /*
459  * subdevice operations
460  */
461 static int tw9910_s_stream(struct v4l2_subdev *sd, int enable)
462 {
463         struct i2c_client *client = v4l2_get_subdevdata(sd);
464         struct tw9910_priv *priv = to_tw9910(client);
465         u8 val;
466         int ret;
467
468         if (!enable) {
469                 switch (priv->revision) {
470                 case 0:
471                         val = OEN_TRI_SEL_ALL_OFF_r0;
472                         break;
473                 case 1:
474                         val = OEN_TRI_SEL_ALL_OFF_r1;
475                         break;
476                 default:
477                         dev_err(&client->dev, "un-supported revision\n");
478                         return -EINVAL;
479                 }
480         } else {
481                 val = OEN_TRI_SEL_ALL_ON;
482
483                 if (!priv->scale) {
484                         dev_err(&client->dev, "norm select error\n");
485                         return -EPERM;
486                 }
487
488                 dev_dbg(&client->dev, "%s %dx%d\n",
489                         priv->scale->name,
490                         priv->scale->width,
491                         priv->scale->height);
492         }
493
494         ret = tw9910_mask_set(client, OPFORM, OEN_TRI_SEL_MASK, val);
495         if (ret < 0)
496                 return ret;
497
498         return tw9910_power(client, enable);
499 }
500
501 static int tw9910_g_std(struct v4l2_subdev *sd, v4l2_std_id *norm)
502 {
503         struct i2c_client *client = v4l2_get_subdevdata(sd);
504         struct tw9910_priv *priv = to_tw9910(client);
505
506         *norm = priv->norm;
507
508         return 0;
509 }
510
511 static int tw9910_s_std(struct v4l2_subdev *sd, v4l2_std_id norm)
512 {
513         struct i2c_client *client = v4l2_get_subdevdata(sd);
514         struct tw9910_priv *priv = to_tw9910(client);
515         const unsigned int hact = 720;
516         const unsigned int hdelay = 15;
517         unsigned int vact;
518         unsigned int vdelay;
519         int ret;
520
521         if (!(norm & (V4L2_STD_NTSC | V4L2_STD_PAL)))
522                 return -EINVAL;
523
524         priv->norm = norm;
525         if (norm & V4L2_STD_525_60) {
526                 vact = 240;
527                 vdelay = 18;
528                 ret = tw9910_mask_set(client, VVBI, 0x10, 0x10);
529         } else {
530                 vact = 288;
531                 vdelay = 24;
532                 ret = tw9910_mask_set(client, VVBI, 0x10, 0x00);
533         }
534         if (!ret)
535                 ret = i2c_smbus_write_byte_data(client, CROP_HI,
536                                                 ((vdelay >> 2) & 0xc0) |
537                         ((vact >> 4) & 0x30) |
538                         ((hdelay >> 6) & 0x0c) |
539                         ((hact >> 8) & 0x03));
540         if (!ret)
541                 ret = i2c_smbus_write_byte_data(client, VDELAY_LO,
542                                                 vdelay & 0xff);
543         if (!ret)
544                 ret = i2c_smbus_write_byte_data(client, VACTIVE_LO,
545                                                 vact & 0xff);
546
547         return ret;
548 }
549
550 #ifdef CONFIG_VIDEO_ADV_DEBUG
551 static int tw9910_g_register(struct v4l2_subdev *sd,
552                              struct v4l2_dbg_register *reg)
553 {
554         struct i2c_client *client = v4l2_get_subdevdata(sd);
555         int ret;
556
557         if (reg->reg > 0xff)
558                 return -EINVAL;
559
560         reg->size = 1;
561         ret = i2c_smbus_read_byte_data(client, reg->reg);
562         if (ret < 0)
563                 return ret;
564
565         /*
566          * ret      = int
567          * reg->val = __u64
568          */
569         reg->val = (__u64)ret;
570
571         return 0;
572 }
573
574 static int tw9910_s_register(struct v4l2_subdev *sd,
575                              const struct v4l2_dbg_register *reg)
576 {
577         struct i2c_client *client = v4l2_get_subdevdata(sd);
578
579         if (reg->reg > 0xff ||
580             reg->val > 0xff)
581                 return -EINVAL;
582
583         return i2c_smbus_write_byte_data(client, reg->reg, reg->val);
584 }
585 #endif
586
587 static int tw9910_power_on(struct tw9910_priv *priv)
588 {
589         struct i2c_client *client = v4l2_get_subdevdata(&priv->subdev);
590         int ret;
591
592         if (priv->clk) {
593                 ret = clk_prepare_enable(priv->clk);
594                 if (ret)
595                         return ret;
596         }
597
598         if (priv->pdn_gpio) {
599                 gpiod_set_value(priv->pdn_gpio, 0);
600                 usleep_range(500, 1000);
601         }
602
603         /*
604          * FIXME: The reset signal is connected to a shared GPIO on some
605          * platforms (namely the SuperH Migo-R). Until a framework becomes
606          * available to handle this cleanly, request the GPIO temporarily
607          * to avoid conflicts.
608          */
609         priv->rstb_gpio = gpiod_get_optional(&client->dev, "rstb",
610                                              GPIOD_OUT_LOW);
611         if (IS_ERR(priv->rstb_gpio)) {
612                 dev_info(&client->dev, "Unable to get GPIO \"rstb\"");
613                 return PTR_ERR(priv->rstb_gpio);
614         }
615
616         if (priv->rstb_gpio) {
617                 gpiod_set_value(priv->rstb_gpio, 1);
618                 usleep_range(500, 1000);
619                 gpiod_set_value(priv->rstb_gpio, 0);
620                 usleep_range(500, 1000);
621
622                 gpiod_put(priv->rstb_gpio);
623         }
624
625         return 0;
626 }
627
628 static int tw9910_power_off(struct tw9910_priv *priv)
629 {
630         clk_disable_unprepare(priv->clk);
631
632         if (priv->pdn_gpio) {
633                 gpiod_set_value(priv->pdn_gpio, 1);
634                 usleep_range(500, 1000);
635         }
636
637         return 0;
638 }
639
640 static int tw9910_s_power(struct v4l2_subdev *sd, int on)
641 {
642         struct i2c_client *client = v4l2_get_subdevdata(sd);
643         struct tw9910_priv *priv = to_tw9910(client);
644
645         return on ? tw9910_power_on(priv) :
646                     tw9910_power_off(priv);
647 }
648
649 static int tw9910_set_frame(struct v4l2_subdev *sd, u32 *width, u32 *height)
650 {
651         struct i2c_client *client = v4l2_get_subdevdata(sd);
652         struct tw9910_priv *priv = to_tw9910(client);
653         int ret = -EINVAL;
654         u8 val;
655
656         /*
657          * select suitable norm
658          */
659         priv->scale = tw9910_select_norm(priv->norm, *width, *height);
660         if (!priv->scale)
661                 goto tw9910_set_fmt_error;
662
663         /*
664          * reset hardware
665          */
666         tw9910_reset(client);
667
668         /*
669          * set bus width
670          */
671         val = 0x00;
672         if (priv->info->buswidth == 16)
673                 val = LEN;
674
675         ret = tw9910_mask_set(client, OPFORM, LEN, val);
676         if (ret < 0)
677                 goto tw9910_set_fmt_error;
678
679         /*
680          * select MPOUT behavior
681          */
682         switch (priv->info->mpout) {
683         case TW9910_MPO_VLOSS:
684                 val = RTSEL_VLOSS; break;
685         case TW9910_MPO_HLOCK:
686                 val = RTSEL_HLOCK; break;
687         case TW9910_MPO_SLOCK:
688                 val = RTSEL_SLOCK; break;
689         case TW9910_MPO_VLOCK:
690                 val = RTSEL_VLOCK; break;
691         case TW9910_MPO_MONO:
692                 val = RTSEL_MONO;  break;
693         case TW9910_MPO_DET50:
694                 val = RTSEL_DET50; break;
695         case TW9910_MPO_FIELD:
696                 val = RTSEL_FIELD; break;
697         case TW9910_MPO_RTCO:
698                 val = RTSEL_RTCO;  break;
699         default:
700                 val = 0;
701         }
702
703         ret = tw9910_mask_set(client, VBICNTL, RTSEL_MASK, val);
704         if (ret < 0)
705                 goto tw9910_set_fmt_error;
706
707         /*
708          * set scale
709          */
710         ret = tw9910_set_scale(client, priv->scale);
711         if (ret < 0)
712                 goto tw9910_set_fmt_error;
713
714         /*
715          * set hsync
716          */
717         ret = tw9910_set_hsync(client);
718         if (ret < 0)
719                 goto tw9910_set_fmt_error;
720
721         *width = priv->scale->width;
722         *height = priv->scale->height;
723
724         return ret;
725
726 tw9910_set_fmt_error:
727
728         tw9910_reset(client);
729         priv->scale = NULL;
730
731         return ret;
732 }
733
734 static int tw9910_get_selection(struct v4l2_subdev *sd,
735                                 struct v4l2_subdev_pad_config *cfg,
736                 struct v4l2_subdev_selection *sel)
737 {
738         struct i2c_client *client = v4l2_get_subdevdata(sd);
739         struct tw9910_priv *priv = to_tw9910(client);
740
741         if (sel->which != V4L2_SUBDEV_FORMAT_ACTIVE)
742                 return -EINVAL;
743         /* Only CROP, CROP_DEFAULT and CROP_BOUNDS are supported */
744         if (sel->target > V4L2_SEL_TGT_CROP_BOUNDS)
745                 return -EINVAL;
746
747         sel->r.left     = 0;
748         sel->r.top      = 0;
749         if (priv->norm & V4L2_STD_NTSC) {
750                 sel->r.width    = 640;
751                 sel->r.height   = 480;
752         } else {
753                 sel->r.width    = 768;
754                 sel->r.height   = 576;
755         }
756         return 0;
757 }
758
759 static int tw9910_get_fmt(struct v4l2_subdev *sd,
760                           struct v4l2_subdev_pad_config *cfg,
761                 struct v4l2_subdev_format *format)
762 {
763         struct v4l2_mbus_framefmt *mf = &format->format;
764         struct i2c_client *client = v4l2_get_subdevdata(sd);
765         struct tw9910_priv *priv = to_tw9910(client);
766
767         if (format->pad)
768                 return -EINVAL;
769
770         if (!priv->scale) {
771                 priv->scale = tw9910_select_norm(priv->norm, 640, 480);
772                 if (!priv->scale)
773                         return -EINVAL;
774         }
775
776         mf->width       = priv->scale->width;
777         mf->height      = priv->scale->height;
778         mf->code        = MEDIA_BUS_FMT_UYVY8_2X8;
779         mf->colorspace  = V4L2_COLORSPACE_SMPTE170M;
780         mf->field       = V4L2_FIELD_INTERLACED_BT;
781
782         return 0;
783 }
784
785 static int tw9910_s_fmt(struct v4l2_subdev *sd,
786                         struct v4l2_mbus_framefmt *mf)
787 {
788         u32 width = mf->width, height = mf->height;
789         int ret;
790
791         WARN_ON(mf->field != V4L2_FIELD_ANY &&
792                 mf->field != V4L2_FIELD_INTERLACED_BT);
793
794         /*
795          * check color format
796          */
797         if (mf->code != MEDIA_BUS_FMT_UYVY8_2X8)
798                 return -EINVAL;
799
800         mf->colorspace = V4L2_COLORSPACE_SMPTE170M;
801
802         ret = tw9910_set_frame(sd, &width, &height);
803         if (!ret) {
804                 mf->width       = width;
805                 mf->height      = height;
806         }
807         return ret;
808 }
809
810 static int tw9910_set_fmt(struct v4l2_subdev *sd,
811                           struct v4l2_subdev_pad_config *cfg,
812                 struct v4l2_subdev_format *format)
813 {
814         struct v4l2_mbus_framefmt *mf = &format->format;
815         struct i2c_client *client = v4l2_get_subdevdata(sd);
816         struct tw9910_priv *priv = to_tw9910(client);
817         const struct tw9910_scale_ctrl *scale;
818
819         if (format->pad)
820                 return -EINVAL;
821
822         if (mf->field == V4L2_FIELD_ANY) {
823                 mf->field = V4L2_FIELD_INTERLACED_BT;
824         } else if (mf->field != V4L2_FIELD_INTERLACED_BT) {
825                 dev_err(&client->dev, "Field type %d invalid.\n", mf->field);
826                 return -EINVAL;
827         }
828
829         mf->code = MEDIA_BUS_FMT_UYVY8_2X8;
830         mf->colorspace = V4L2_COLORSPACE_SMPTE170M;
831
832         /*
833          * select suitable norm
834          */
835         scale = tw9910_select_norm(priv->norm, mf->width, mf->height);
836         if (!scale)
837                 return -EINVAL;
838
839         mf->width       = scale->width;
840         mf->height      = scale->height;
841
842         if (format->which == V4L2_SUBDEV_FORMAT_ACTIVE)
843                 return tw9910_s_fmt(sd, mf);
844         cfg->try_fmt = *mf;
845         return 0;
846 }
847
848 static int tw9910_video_probe(struct i2c_client *client)
849 {
850         struct tw9910_priv *priv = to_tw9910(client);
851         s32 id;
852         int ret;
853
854         /*
855          * tw9910 only use 8 or 16 bit bus width
856          */
857         if (priv->info->buswidth != 16 && priv->info->buswidth != 8) {
858                 dev_err(&client->dev, "bus width error\n");
859                 return -ENODEV;
860         }
861
862         ret = tw9910_s_power(&priv->subdev, 1);
863         if (ret < 0)
864                 return ret;
865
866         /*
867          * check and show Product ID
868          * So far only revisions 0 and 1 have been seen
869          */
870         id = i2c_smbus_read_byte_data(client, ID);
871         priv->revision = GET_REV(id);
872         id = GET_ID(id);
873
874         if (id != 0x0b || priv->revision > 0x01) {
875                 dev_err(&client->dev,
876                         "Product ID error %x:%x\n",
877                         id, priv->revision);
878                 ret = -ENODEV;
879                 goto done;
880         }
881
882         dev_info(&client->dev,
883                  "tw9910 Product ID %0x:%0x\n", id, priv->revision);
884
885         priv->norm = V4L2_STD_NTSC;
886         priv->scale = &tw9910_ntsc_scales[0];
887
888 done:
889         tw9910_s_power(&priv->subdev, 0);
890         return ret;
891 }
892
893 static const struct v4l2_subdev_core_ops tw9910_subdev_core_ops = {
894 #ifdef CONFIG_VIDEO_ADV_DEBUG
895         .g_register     = tw9910_g_register,
896         .s_register     = tw9910_s_register,
897 #endif
898         .s_power        = tw9910_s_power,
899 };
900
901 static int tw9910_enum_mbus_code(struct v4l2_subdev *sd,
902                                  struct v4l2_subdev_pad_config *cfg,
903                 struct v4l2_subdev_mbus_code_enum *code)
904 {
905         if (code->pad || code->index)
906                 return -EINVAL;
907
908         code->code = MEDIA_BUS_FMT_UYVY8_2X8;
909         return 0;
910 }
911
912 static int tw9910_g_tvnorms(struct v4l2_subdev *sd, v4l2_std_id *norm)
913 {
914         *norm = V4L2_STD_NTSC | V4L2_STD_PAL;
915         return 0;
916 }
917
918 static const struct v4l2_subdev_video_ops tw9910_subdev_video_ops = {
919         .s_std          = tw9910_s_std,
920         .g_std          = tw9910_g_std,
921         .s_stream       = tw9910_s_stream,
922         .g_tvnorms      = tw9910_g_tvnorms,
923 };
924
925 static const struct v4l2_subdev_pad_ops tw9910_subdev_pad_ops = {
926         .enum_mbus_code = tw9910_enum_mbus_code,
927         .get_selection  = tw9910_get_selection,
928         .get_fmt        = tw9910_get_fmt,
929         .set_fmt        = tw9910_set_fmt,
930 };
931
932 static const struct v4l2_subdev_ops tw9910_subdev_ops = {
933         .core   = &tw9910_subdev_core_ops,
934         .video  = &tw9910_subdev_video_ops,
935         .pad    = &tw9910_subdev_pad_ops,
936 };
937
938 /*
939  * i2c_driver function
940  */
941
942 static int tw9910_probe(struct i2c_client *client,
943                         const struct i2c_device_id *did)
944
945 {
946         struct tw9910_priv              *priv;
947         struct tw9910_video_info        *info;
948         struct i2c_adapter              *adapter =
949                 to_i2c_adapter(client->dev.parent);
950         int ret;
951
952         if (!client->dev.platform_data) {
953                 dev_err(&client->dev, "TW9910: missing platform data!\n");
954                 return -EINVAL;
955         }
956
957         info = client->dev.platform_data;
958
959         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
960                 dev_err(&client->dev,
961                         "I2C-Adapter doesn't support I2C_FUNC_SMBUS_BYTE_DATA\n");
962                 return -EIO;
963         }
964
965         priv = devm_kzalloc(&client->dev, sizeof(*priv), GFP_KERNEL);
966         if (!priv)
967                 return -ENOMEM;
968
969         priv->info   = info;
970
971         v4l2_i2c_subdev_init(&priv->subdev, client, &tw9910_subdev_ops);
972
973         priv->clk = clk_get(&client->dev, "xti");
974         if (PTR_ERR(priv->clk) == -ENOENT) {
975                 priv->clk = NULL;
976         } else if (IS_ERR(priv->clk)) {
977                 dev_err(&client->dev, "Unable to get xti clock\n");
978                 return PTR_ERR(priv->clk);
979         }
980
981         priv->pdn_gpio = gpiod_get_optional(&client->dev, "pdn",
982                                             GPIOD_OUT_HIGH);
983         if (IS_ERR(priv->pdn_gpio)) {
984                 dev_info(&client->dev, "Unable to get GPIO \"pdn\"");
985                 ret = PTR_ERR(priv->pdn_gpio);
986                 goto error_clk_put;
987         }
988
989         ret = tw9910_video_probe(client);
990         if (ret < 0)
991                 goto error_gpio_put;
992
993         ret = v4l2_async_register_subdev(&priv->subdev);
994         if (ret)
995                 goto error_gpio_put;
996
997         return ret;
998
999 error_gpio_put:
1000         if (priv->pdn_gpio)
1001                 gpiod_put(priv->pdn_gpio);
1002 error_clk_put:
1003         clk_put(priv->clk);
1004
1005         return ret;
1006 }
1007
1008 static int tw9910_remove(struct i2c_client *client)
1009 {
1010         struct tw9910_priv *priv = to_tw9910(client);
1011
1012         if (priv->pdn_gpio)
1013                 gpiod_put(priv->pdn_gpio);
1014         clk_put(priv->clk);
1015         v4l2_device_unregister_subdev(&priv->subdev);
1016
1017         return 0;
1018 }
1019
1020 static const struct i2c_device_id tw9910_id[] = {
1021         { "tw9910", 0 },
1022         { }
1023 };
1024 MODULE_DEVICE_TABLE(i2c, tw9910_id);
1025
1026 static struct i2c_driver tw9910_i2c_driver = {
1027         .driver = {
1028                 .name = "tw9910",
1029         },
1030         .probe    = tw9910_probe,
1031         .remove   = tw9910_remove,
1032         .id_table = tw9910_id,
1033 };
1034
1035 module_i2c_driver(tw9910_i2c_driver);
1036
1037 MODULE_DESCRIPTION("V4L2 driver for TW9910 video decoder");
1038 MODULE_AUTHOR("Kuninori Morimoto");
1039 MODULE_LICENSE("GPL v2");