2 * saa7191.c - Philips SAA7191 video decoder driver
4 * Copyright (C) 2003 Ladislav Michl <ladis@linux-mips.org>
5 * Copyright (C) 2004,2005 Mikael Nousiainen <tmnousia@cc.hut.fi>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/delay.h>
13 #include <linux/errno.h>
15 #include <linux/init.h>
16 #include <linux/kernel.h>
17 #include <linux/major.h>
18 #include <linux/module.h>
20 #include <linux/slab.h>
22 #include <linux/videodev2.h>
23 #include <linux/i2c.h>
24 #include <media/v4l2-device.h>
25 #include <media/v4l2-chip-ident.h>
26 #include <media/v4l2-i2c-drv.h>
30 #define SAA7191_MODULE_VERSION "0.0.5"
32 MODULE_DESCRIPTION("Philips SAA7191 video decoder driver");
33 MODULE_VERSION(SAA7191_MODULE_VERSION);
34 MODULE_AUTHOR("Mikael Nousiainen <tmnousia@cc.hut.fi>");
35 MODULE_LICENSE("GPL");
38 // #define SAA7191_DEBUG
41 #define dprintk(x...) printk("SAA7191: " x);
46 #define SAA7191_SYNC_COUNT 30
47 #define SAA7191_SYNC_DELAY 100 /* milliseconds */
50 struct v4l2_subdev sd;
52 /* the register values are stored here as the actual
53 * I2C-registers are write-only */
60 static inline struct saa7191 *to_saa7191(struct v4l2_subdev *sd)
62 return container_of(sd, struct saa7191, sd);
65 static const u8 initseq[] = {
68 0x50, /* (0x50) SAA7191_REG_IDEL */
70 /* 50 Hz signal timing */
71 0x30, /* (0x30) SAA7191_REG_HSYB */
72 0x00, /* (0x00) SAA7191_REG_HSYS */
73 0xe8, /* (0xe8) SAA7191_REG_HCLB */
74 0xb6, /* (0xb6) SAA7191_REG_HCLS */
75 0xf4, /* (0xf4) SAA7191_REG_HPHI */
78 SAA7191_LUMA_APER_1, /* (0x01) SAA7191_REG_LUMA - CVBS mode */
79 0x00, /* (0x00) SAA7191_REG_HUEC */
80 0xf8, /* (0xf8) SAA7191_REG_CKTQ */
81 0xf8, /* (0xf8) SAA7191_REG_CKTS */
82 0x90, /* (0x90) SAA7191_REG_PLSE */
83 0x90, /* (0x90) SAA7191_REG_SESE */
84 0x00, /* (0x00) SAA7191_REG_GAIN */
85 SAA7191_STDC_NFEN | SAA7191_STDC_HRMV, /* (0x0c) SAA7191_REG_STDC
87 * slow time constant */
88 SAA7191_IOCK_OEDC | SAA7191_IOCK_OEHS | SAA7191_IOCK_OEVS
89 | SAA7191_IOCK_OEDY, /* (0x78) SAA7191_REG_IOCK
90 * - chroma from CVBS, GPSW1 & 2 off */
91 SAA7191_CTL3_AUFD | SAA7191_CTL3_SCEN | SAA7191_CTL3_OFTS
92 | SAA7191_CTL3_YDEL0, /* (0x99) SAA7191_REG_CTL3
93 * - automatic field detection */
94 0x00, /* (0x00) SAA7191_REG_CTL4 */
95 0x2c, /* (0x2c) SAA7191_REG_CHCV - PAL nominal value */
99 /* 60 Hz signal timing */
100 0x34, /* (0x34) SAA7191_REG_HS6B */
101 0x0a, /* (0x0a) SAA7191_REG_HS6S */
102 0xf4, /* (0xf4) SAA7191_REG_HC6B */
103 0xce, /* (0xce) SAA7191_REG_HC6S */
104 0xf4, /* (0xf4) SAA7191_REG_HP6I */
107 /* SAA7191 register handling */
109 static u8 saa7191_read_reg(struct v4l2_subdev *sd, u8 reg)
111 return to_saa7191(sd)->reg[reg];
114 static int saa7191_read_status(struct v4l2_subdev *sd, u8 *value)
116 struct i2c_client *client = v4l2_get_subdevdata(sd);
119 ret = i2c_master_recv(client, value, 1);
121 printk(KERN_ERR "SAA7191: saa7191_read_status(): read failed\n");
129 static int saa7191_write_reg(struct v4l2_subdev *sd, u8 reg, u8 value)
131 struct i2c_client *client = v4l2_get_subdevdata(sd);
133 to_saa7191(sd)->reg[reg] = value;
134 return i2c_smbus_write_byte_data(client, reg, value);
137 /* the first byte of data must be the first subaddress number (register) */
138 static int saa7191_write_block(struct v4l2_subdev *sd,
139 u8 length, const u8 *data)
141 struct i2c_client *client = v4l2_get_subdevdata(sd);
142 struct saa7191 *decoder = to_saa7191(sd);
146 for (i = 0; i < (length - 1); i++) {
147 decoder->reg[data[0] + i] = data[i + 1];
150 ret = i2c_master_send(client, data, length);
152 printk(KERN_ERR "SAA7191: saa7191_write_block(): "
160 /* Helper functions */
162 static int saa7191_s_routing(struct v4l2_subdev *sd,
163 const struct v4l2_routing *route)
165 struct saa7191 *decoder = to_saa7191(sd);
166 u8 luma = saa7191_read_reg(sd, SAA7191_REG_LUMA);
167 u8 iock = saa7191_read_reg(sd, SAA7191_REG_IOCK);
170 switch (route->input) {
171 case SAA7191_INPUT_COMPOSITE: /* Set Composite input */
172 iock &= ~(SAA7191_IOCK_CHRS | SAA7191_IOCK_GPSW1
173 | SAA7191_IOCK_GPSW2);
174 /* Chrominance trap active */
175 luma &= ~SAA7191_LUMA_BYPS;
177 case SAA7191_INPUT_SVIDEO: /* Set S-Video input */
178 iock |= SAA7191_IOCK_CHRS | SAA7191_IOCK_GPSW2;
179 /* Chrominance trap bypassed */
180 luma |= SAA7191_LUMA_BYPS;
186 err = saa7191_write_reg(sd, SAA7191_REG_LUMA, luma);
189 err = saa7191_write_reg(sd, SAA7191_REG_IOCK, iock);
193 decoder->input = route->input;
198 static int saa7191_s_std(struct v4l2_subdev *sd, v4l2_std_id norm)
200 struct saa7191 *decoder = to_saa7191(sd);
201 u8 stdc = saa7191_read_reg(sd, SAA7191_REG_STDC);
202 u8 ctl3 = saa7191_read_reg(sd, SAA7191_REG_CTL3);
203 u8 chcv = saa7191_read_reg(sd, SAA7191_REG_CHCV);
206 if (norm & V4L2_STD_PAL) {
207 stdc &= ~SAA7191_STDC_SECS;
208 ctl3 &= ~(SAA7191_CTL3_AUFD | SAA7191_CTL3_FSEL);
209 chcv = SAA7191_CHCV_PAL;
210 } else if (norm & V4L2_STD_NTSC) {
211 stdc &= ~SAA7191_STDC_SECS;
212 ctl3 &= ~SAA7191_CTL3_AUFD;
213 ctl3 |= SAA7191_CTL3_FSEL;
214 chcv = SAA7191_CHCV_NTSC;
215 } else if (norm & V4L2_STD_SECAM) {
216 stdc |= SAA7191_STDC_SECS;
217 ctl3 &= ~(SAA7191_CTL3_AUFD | SAA7191_CTL3_FSEL);
218 chcv = SAA7191_CHCV_PAL;
223 err = saa7191_write_reg(sd, SAA7191_REG_CTL3, ctl3);
226 err = saa7191_write_reg(sd, SAA7191_REG_STDC, stdc);
229 err = saa7191_write_reg(sd, SAA7191_REG_CHCV, chcv);
233 decoder->norm = norm;
235 dprintk("ctl3: %02x stdc: %02x chcv: %02x\n", ctl3,
237 dprintk("norm: %llx\n", norm);
242 static int saa7191_wait_for_signal(struct v4l2_subdev *sd, u8 *status)
246 dprintk("Checking for signal...\n");
248 for (i = 0; i < SAA7191_SYNC_COUNT; i++) {
249 if (saa7191_read_status(sd, status))
252 if (((*status) & SAA7191_STATUS_HLCK) == 0) {
253 dprintk("Signal found\n");
257 msleep(SAA7191_SYNC_DELAY);
260 dprintk("No signal\n");
265 static int saa7191_querystd(struct v4l2_subdev *sd, v4l2_std_id *norm)
267 struct saa7191 *decoder = to_saa7191(sd);
268 u8 stdc = saa7191_read_reg(sd, SAA7191_REG_STDC);
269 u8 ctl3 = saa7191_read_reg(sd, SAA7191_REG_CTL3);
271 v4l2_std_id old_norm = decoder->norm;
274 dprintk("SAA7191 extended signal auto-detection...\n");
276 *norm = V4L2_STD_NTSC | V4L2_STD_PAL | V4L2_STD_SECAM;
277 stdc &= ~SAA7191_STDC_SECS;
278 ctl3 &= ~(SAA7191_CTL3_FSEL);
280 err = saa7191_write_reg(sd, SAA7191_REG_STDC, stdc);
285 err = saa7191_write_reg(sd, SAA7191_REG_CTL3, ctl3);
291 ctl3 |= SAA7191_CTL3_AUFD;
292 err = saa7191_write_reg(sd, SAA7191_REG_CTL3, ctl3);
298 msleep(SAA7191_SYNC_DELAY);
300 err = saa7191_wait_for_signal(sd, &status);
304 if (status & SAA7191_STATUS_FIDT) {
305 /* 60Hz signal -> NTSC */
306 dprintk("60Hz signal: NTSC\n");
307 *norm = V4L2_STD_NTSC;
312 dprintk("50Hz signal: Trying PAL...\n");
315 err = saa7191_s_std(sd, V4L2_STD_PAL);
319 msleep(SAA7191_SYNC_DELAY);
321 err = saa7191_wait_for_signal(sd, &status);
326 if (status & SAA7191_STATUS_FIDT) {
327 dprintk("No 50Hz signal\n");
328 saa7191_s_std(sd, old_norm);
332 if (status & SAA7191_STATUS_CODE) {
334 *norm = V4L2_STD_PAL;
335 return saa7191_s_std(sd, old_norm);
338 dprintk("No color detected with PAL - Trying SECAM...\n");
340 /* no color detected ? -> try SECAM */
341 err = saa7191_s_std(sd, V4L2_STD_SECAM);
345 msleep(SAA7191_SYNC_DELAY);
347 err = saa7191_wait_for_signal(sd, &status);
352 if (status & SAA7191_STATUS_FIDT) {
353 dprintk("No 50Hz signal\n");
358 if (status & SAA7191_STATUS_CODE) {
359 /* Color detected -> SECAM */
361 *norm = V4L2_STD_SECAM;
362 return saa7191_s_std(sd, old_norm);
365 dprintk("No color detected with SECAM - Going back to PAL.\n");
368 return saa7191_s_std(sd, old_norm);
371 static int saa7191_autodetect_norm(struct v4l2_subdev *sd)
375 dprintk("SAA7191 signal auto-detection...\n");
377 dprintk("Reading status...\n");
379 if (saa7191_read_status(sd, &status))
382 dprintk("Checking for signal...\n");
385 if (status & SAA7191_STATUS_HLCK) {
386 dprintk("No signal\n");
390 dprintk("Signal found\n");
392 if (status & SAA7191_STATUS_FIDT) {
393 /* 60hz signal -> NTSC */
395 return saa7191_s_std(sd, V4L2_STD_NTSC);
397 /* 50hz signal -> PAL */
399 return saa7191_s_std(sd, V4L2_STD_PAL);
403 static int saa7191_g_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
409 case SAA7191_CONTROL_BANDPASS:
410 case SAA7191_CONTROL_BANDPASS_WEIGHT:
411 case SAA7191_CONTROL_CORING:
412 reg = saa7191_read_reg(sd, SAA7191_REG_LUMA);
414 case SAA7191_CONTROL_BANDPASS:
415 ctrl->value = ((s32)reg & SAA7191_LUMA_BPSS_MASK)
416 >> SAA7191_LUMA_BPSS_SHIFT;
418 case SAA7191_CONTROL_BANDPASS_WEIGHT:
419 ctrl->value = ((s32)reg & SAA7191_LUMA_APER_MASK)
420 >> SAA7191_LUMA_APER_SHIFT;
422 case SAA7191_CONTROL_CORING:
423 ctrl->value = ((s32)reg & SAA7191_LUMA_CORI_MASK)
424 >> SAA7191_LUMA_CORI_SHIFT;
428 case SAA7191_CONTROL_FORCE_COLOUR:
429 case SAA7191_CONTROL_CHROMA_GAIN:
430 reg = saa7191_read_reg(sd, SAA7191_REG_GAIN);
431 if (ctrl->id == SAA7191_CONTROL_FORCE_COLOUR)
432 ctrl->value = ((s32)reg & SAA7191_GAIN_COLO) ? 1 : 0;
434 ctrl->value = ((s32)reg & SAA7191_GAIN_LFIS_MASK)
435 >> SAA7191_GAIN_LFIS_SHIFT;
438 reg = saa7191_read_reg(sd, SAA7191_REG_HUEC);
443 ctrl->value = (s32)reg;
445 case SAA7191_CONTROL_VTRC:
446 reg = saa7191_read_reg(sd, SAA7191_REG_STDC);
447 ctrl->value = ((s32)reg & SAA7191_STDC_VTRC) ? 1 : 0;
449 case SAA7191_CONTROL_LUMA_DELAY:
450 reg = saa7191_read_reg(sd, SAA7191_REG_CTL3);
451 ctrl->value = ((s32)reg & SAA7191_CTL3_YDEL_MASK)
452 >> SAA7191_CTL3_YDEL_SHIFT;
453 if (ctrl->value >= 4)
456 case SAA7191_CONTROL_VNR:
457 reg = saa7191_read_reg(sd, SAA7191_REG_CTL4);
458 ctrl->value = ((s32)reg & SAA7191_CTL4_VNOI_MASK)
459 >> SAA7191_CTL4_VNOI_SHIFT;
468 static int saa7191_s_ctrl(struct v4l2_subdev *sd, struct v4l2_control *ctrl)
474 case SAA7191_CONTROL_BANDPASS:
475 case SAA7191_CONTROL_BANDPASS_WEIGHT:
476 case SAA7191_CONTROL_CORING:
477 reg = saa7191_read_reg(sd, SAA7191_REG_LUMA);
479 case SAA7191_CONTROL_BANDPASS:
480 reg &= ~SAA7191_LUMA_BPSS_MASK;
481 reg |= (ctrl->value << SAA7191_LUMA_BPSS_SHIFT)
482 & SAA7191_LUMA_BPSS_MASK;
484 case SAA7191_CONTROL_BANDPASS_WEIGHT:
485 reg &= ~SAA7191_LUMA_APER_MASK;
486 reg |= (ctrl->value << SAA7191_LUMA_APER_SHIFT)
487 & SAA7191_LUMA_APER_MASK;
489 case SAA7191_CONTROL_CORING:
490 reg &= ~SAA7191_LUMA_CORI_MASK;
491 reg |= (ctrl->value << SAA7191_LUMA_CORI_SHIFT)
492 & SAA7191_LUMA_CORI_MASK;
495 ret = saa7191_write_reg(sd, SAA7191_REG_LUMA, reg);
497 case SAA7191_CONTROL_FORCE_COLOUR:
498 case SAA7191_CONTROL_CHROMA_GAIN:
499 reg = saa7191_read_reg(sd, SAA7191_REG_GAIN);
500 if (ctrl->id == SAA7191_CONTROL_FORCE_COLOUR) {
502 reg |= SAA7191_GAIN_COLO;
504 reg &= ~SAA7191_GAIN_COLO;
506 reg &= ~SAA7191_GAIN_LFIS_MASK;
507 reg |= (ctrl->value << SAA7191_GAIN_LFIS_SHIFT)
508 & SAA7191_GAIN_LFIS_MASK;
510 ret = saa7191_write_reg(sd, SAA7191_REG_GAIN, reg);
513 reg = ctrl->value & 0xff;
518 ret = saa7191_write_reg(sd, SAA7191_REG_HUEC, reg);
520 case SAA7191_CONTROL_VTRC:
521 reg = saa7191_read_reg(sd, SAA7191_REG_STDC);
523 reg |= SAA7191_STDC_VTRC;
525 reg &= ~SAA7191_STDC_VTRC;
526 ret = saa7191_write_reg(sd, SAA7191_REG_STDC, reg);
528 case SAA7191_CONTROL_LUMA_DELAY: {
529 s32 value = ctrl->value;
532 reg = saa7191_read_reg(sd, SAA7191_REG_CTL3);
533 reg &= ~SAA7191_CTL3_YDEL_MASK;
534 reg |= (value << SAA7191_CTL3_YDEL_SHIFT)
535 & SAA7191_CTL3_YDEL_MASK;
536 ret = saa7191_write_reg(sd, SAA7191_REG_CTL3, reg);
539 case SAA7191_CONTROL_VNR:
540 reg = saa7191_read_reg(sd, SAA7191_REG_CTL4);
541 reg &= ~SAA7191_CTL4_VNOI_MASK;
542 reg |= (ctrl->value << SAA7191_CTL4_VNOI_SHIFT)
543 & SAA7191_CTL4_VNOI_MASK;
544 ret = saa7191_write_reg(sd, SAA7191_REG_CTL4, reg);
555 static int saa7191_g_input_status(struct v4l2_subdev *sd, u32 *status)
558 int res = V4L2_IN_ST_NO_SIGNAL;
560 if (saa7191_read_status(sd, &status_reg))
562 if ((status_reg & SAA7191_STATUS_HLCK) == 0)
564 if (!(status_reg & SAA7191_STATUS_CODE))
565 res |= V4L2_IN_ST_NO_COLOR;
571 static int saa7191_g_chip_ident(struct v4l2_subdev *sd,
572 struct v4l2_dbg_chip_ident *chip)
574 struct i2c_client *client = v4l2_get_subdevdata(sd);
576 return v4l2_chip_ident_i2c_client(client, chip, V4L2_IDENT_SAA7191, 0);
579 /* ----------------------------------------------------------------------- */
581 static const struct v4l2_subdev_core_ops saa7191_core_ops = {
582 .g_chip_ident = saa7191_g_chip_ident,
583 .g_ctrl = saa7191_g_ctrl,
584 .s_ctrl = saa7191_s_ctrl,
587 static const struct v4l2_subdev_tuner_ops saa7191_tuner_ops = {
588 .s_std = saa7191_s_std,
591 static const struct v4l2_subdev_video_ops saa7191_video_ops = {
592 .s_routing = saa7191_s_routing,
593 .querystd = saa7191_querystd,
594 .g_input_status = saa7191_g_input_status,
597 static const struct v4l2_subdev_ops saa7191_ops = {
598 .core = &saa7191_core_ops,
599 .video = &saa7191_video_ops,
600 .tuner = &saa7191_tuner_ops,
603 static int saa7191_probe(struct i2c_client *client,
604 const struct i2c_device_id *id)
607 struct saa7191 *decoder;
608 struct v4l2_subdev *sd;
610 v4l_info(client, "chip found @ 0x%x (%s)\n",
611 client->addr << 1, client->adapter->name);
613 decoder = kzalloc(sizeof(*decoder), GFP_KERNEL);
618 v4l2_i2c_subdev_init(sd, client, &saa7191_ops);
620 err = saa7191_write_block(sd, sizeof(initseq), initseq);
622 printk(KERN_ERR "SAA7191 initialization failed\n");
627 printk(KERN_INFO "SAA7191 initialized\n");
629 decoder->input = SAA7191_INPUT_COMPOSITE;
630 decoder->norm = V4L2_STD_PAL;
632 err = saa7191_autodetect_norm(sd);
633 if (err && (err != -EBUSY))
634 printk(KERN_ERR "SAA7191: Signal auto-detection failed\n");
639 static int saa7191_remove(struct i2c_client *client)
641 struct v4l2_subdev *sd = i2c_get_clientdata(client);
643 v4l2_device_unregister_subdev(sd);
644 kfree(to_saa7191(sd));
648 static const struct i2c_device_id saa7191_id[] = {
652 MODULE_DEVICE_TABLE(i2c, saa7191_id);
654 static struct v4l2_i2c_driver_data v4l2_i2c_data = {
656 .probe = saa7191_probe,
657 .remove = saa7191_remove,
658 .id_table = saa7191_id,