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/videodev.h>
23 #include <linux/video_decoder.h>
24 #include <linux/i2c.h>
25 #include <media/v4l2-common.h>
26 #include <media/v4l2-i2c-drv-legacy.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");
37 static unsigned short normal_i2c
[] = { 0x8a >> 1, 0x8e >> 1, I2C_CLIENT_END
};
41 // #define SAA7191_DEBUG
44 #define dprintk(x...) printk("SAA7191: " x);
49 #define SAA7191_SYNC_COUNT 30
50 #define SAA7191_SYNC_DELAY 100 /* milliseconds */
53 struct i2c_client
*client
;
55 /* the register values are stored here as the actual
56 * I2C-registers are write-only */
63 static const u8 initseq
[] = {
66 0x50, /* (0x50) SAA7191_REG_IDEL */
68 /* 50 Hz signal timing */
69 0x30, /* (0x30) SAA7191_REG_HSYB */
70 0x00, /* (0x00) SAA7191_REG_HSYS */
71 0xe8, /* (0xe8) SAA7191_REG_HCLB */
72 0xb6, /* (0xb6) SAA7191_REG_HCLS */
73 0xf4, /* (0xf4) SAA7191_REG_HPHI */
76 SAA7191_LUMA_APER_1
, /* (0x01) SAA7191_REG_LUMA - CVBS mode */
77 0x00, /* (0x00) SAA7191_REG_HUEC */
78 0xf8, /* (0xf8) SAA7191_REG_CKTQ */
79 0xf8, /* (0xf8) SAA7191_REG_CKTS */
80 0x90, /* (0x90) SAA7191_REG_PLSE */
81 0x90, /* (0x90) SAA7191_REG_SESE */
82 0x00, /* (0x00) SAA7191_REG_GAIN */
83 SAA7191_STDC_NFEN
| SAA7191_STDC_HRMV
, /* (0x0c) SAA7191_REG_STDC
85 * slow time constant */
86 SAA7191_IOCK_OEDC
| SAA7191_IOCK_OEHS
| SAA7191_IOCK_OEVS
87 | SAA7191_IOCK_OEDY
, /* (0x78) SAA7191_REG_IOCK
88 * - chroma from CVBS, GPSW1 & 2 off */
89 SAA7191_CTL3_AUFD
| SAA7191_CTL3_SCEN
| SAA7191_CTL3_OFTS
90 | SAA7191_CTL3_YDEL0
, /* (0x99) SAA7191_REG_CTL3
91 * - automatic field detection */
92 0x00, /* (0x00) SAA7191_REG_CTL4 */
93 0x2c, /* (0x2c) SAA7191_REG_CHCV - PAL nominal value */
97 /* 60 Hz signal timing */
98 0x34, /* (0x34) SAA7191_REG_HS6B */
99 0x0a, /* (0x0a) SAA7191_REG_HS6S */
100 0xf4, /* (0xf4) SAA7191_REG_HC6B */
101 0xce, /* (0xce) SAA7191_REG_HC6S */
102 0xf4, /* (0xf4) SAA7191_REG_HP6I */
105 /* SAA7191 register handling */
107 static u8
saa7191_read_reg(struct i2c_client
*client
,
110 return ((struct saa7191
*)i2c_get_clientdata(client
))->reg
[reg
];
113 static int saa7191_read_status(struct i2c_client
*client
,
118 ret
= i2c_master_recv(client
, value
, 1);
120 printk(KERN_ERR
"SAA7191: saa7191_read_status(): read failed\n");
128 static int saa7191_write_reg(struct i2c_client
*client
, u8 reg
,
131 ((struct saa7191
*)i2c_get_clientdata(client
))->reg
[reg
] = value
;
132 return i2c_smbus_write_byte_data(client
, reg
, value
);
135 /* the first byte of data must be the first subaddress number (register) */
136 static int saa7191_write_block(struct i2c_client
*client
,
137 u8 length
, const u8
*data
)
142 struct saa7191
*decoder
= (struct saa7191
*)i2c_get_clientdata(client
);
143 for (i
= 0; i
< (length
- 1); i
++) {
144 decoder
->reg
[data
[0] + i
] = data
[i
+ 1];
147 ret
= i2c_master_send(client
, data
, length
);
149 printk(KERN_ERR
"SAA7191: saa7191_write_block(): "
157 /* Helper functions */
159 static int saa7191_set_input(struct i2c_client
*client
, int input
)
161 struct saa7191
*decoder
= i2c_get_clientdata(client
);
162 u8 luma
= saa7191_read_reg(client
, SAA7191_REG_LUMA
);
163 u8 iock
= saa7191_read_reg(client
, SAA7191_REG_IOCK
);
167 case SAA7191_INPUT_COMPOSITE
: /* Set Composite input */
168 iock
&= ~(SAA7191_IOCK_CHRS
| SAA7191_IOCK_GPSW1
169 | SAA7191_IOCK_GPSW2
);
170 /* Chrominance trap active */
171 luma
&= ~SAA7191_LUMA_BYPS
;
173 case SAA7191_INPUT_SVIDEO
: /* Set S-Video input */
174 iock
|= SAA7191_IOCK_CHRS
| SAA7191_IOCK_GPSW2
;
175 /* Chrominance trap bypassed */
176 luma
|= SAA7191_LUMA_BYPS
;
182 err
= saa7191_write_reg(client
, SAA7191_REG_LUMA
, luma
);
185 err
= saa7191_write_reg(client
, SAA7191_REG_IOCK
, iock
);
189 decoder
->input
= input
;
194 static int saa7191_set_norm(struct i2c_client
*client
, int norm
)
196 struct saa7191
*decoder
= i2c_get_clientdata(client
);
197 u8 stdc
= saa7191_read_reg(client
, SAA7191_REG_STDC
);
198 u8 ctl3
= saa7191_read_reg(client
, SAA7191_REG_CTL3
);
199 u8 chcv
= saa7191_read_reg(client
, SAA7191_REG_CHCV
);
203 case SAA7191_NORM_PAL
:
204 stdc
&= ~SAA7191_STDC_SECS
;
205 ctl3
&= ~(SAA7191_CTL3_AUFD
| SAA7191_CTL3_FSEL
);
206 chcv
= SAA7191_CHCV_PAL
;
208 case SAA7191_NORM_NTSC
:
209 stdc
&= ~SAA7191_STDC_SECS
;
210 ctl3
&= ~SAA7191_CTL3_AUFD
;
211 ctl3
|= SAA7191_CTL3_FSEL
;
212 chcv
= SAA7191_CHCV_NTSC
;
214 case SAA7191_NORM_SECAM
:
215 stdc
|= SAA7191_STDC_SECS
;
216 ctl3
&= ~(SAA7191_CTL3_AUFD
| SAA7191_CTL3_FSEL
);
217 chcv
= SAA7191_CHCV_PAL
;
223 err
= saa7191_write_reg(client
, SAA7191_REG_CTL3
, ctl3
);
226 err
= saa7191_write_reg(client
, SAA7191_REG_STDC
, stdc
);
229 err
= saa7191_write_reg(client
, SAA7191_REG_CHCV
, chcv
);
233 decoder
->norm
= norm
;
235 dprintk("ctl3: %02x stdc: %02x chcv: %02x\n", ctl3
,
237 dprintk("norm: %d\n", norm
);
242 static int saa7191_wait_for_signal(struct i2c_client
*client
, u8
*status
)
246 dprintk("Checking for signal...\n");
248 for (i
= 0; i
< SAA7191_SYNC_COUNT
; i
++) {
249 if (saa7191_read_status(client
, 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_autodetect_norm_extended(struct i2c_client
*client
)
267 u8 stdc
= saa7191_read_reg(client
, SAA7191_REG_STDC
);
268 u8 ctl3
= saa7191_read_reg(client
, SAA7191_REG_CTL3
);
272 dprintk("SAA7191 extended signal auto-detection...\n");
274 stdc
&= ~SAA7191_STDC_SECS
;
275 ctl3
&= ~(SAA7191_CTL3_FSEL
);
277 err
= saa7191_write_reg(client
, SAA7191_REG_STDC
, stdc
);
282 err
= saa7191_write_reg(client
, SAA7191_REG_CTL3
, ctl3
);
288 ctl3
|= SAA7191_CTL3_AUFD
;
289 err
= saa7191_write_reg(client
, SAA7191_REG_CTL3
, ctl3
);
295 msleep(SAA7191_SYNC_DELAY
);
297 err
= saa7191_wait_for_signal(client
, &status
);
301 if (status
& SAA7191_STATUS_FIDT
) {
302 /* 60Hz signal -> NTSC */
303 dprintk("60Hz signal: NTSC\n");
304 return saa7191_set_norm(client
, SAA7191_NORM_NTSC
);
308 dprintk("50Hz signal: Trying PAL...\n");
311 err
= saa7191_set_norm(client
, SAA7191_NORM_PAL
);
315 msleep(SAA7191_SYNC_DELAY
);
317 err
= saa7191_wait_for_signal(client
, &status
);
322 if (status
& SAA7191_STATUS_FIDT
) {
323 dprintk("No 50Hz signal\n");
328 if (status
& SAA7191_STATUS_CODE
) {
333 dprintk("No color detected with PAL - Trying SECAM...\n");
335 /* no color detected ? -> try SECAM */
336 err
= saa7191_set_norm(client
,
341 msleep(SAA7191_SYNC_DELAY
);
343 err
= saa7191_wait_for_signal(client
, &status
);
348 if (status
& SAA7191_STATUS_FIDT
) {
349 dprintk("No 50Hz signal\n");
354 if (status
& SAA7191_STATUS_CODE
) {
355 /* Color detected -> SECAM */
360 dprintk("No color detected with SECAM - Going back to PAL.\n");
362 /* still no color detected ?
363 * -> set norm back to PAL */
364 err
= saa7191_set_norm(client
,
370 ctl3
= saa7191_read_reg(client
, SAA7191_REG_CTL3
);
371 if (ctl3
& SAA7191_CTL3_AUFD
) {
372 ctl3
&= ~(SAA7191_CTL3_AUFD
);
373 err
= saa7191_write_reg(client
, SAA7191_REG_CTL3
, ctl3
);
382 static int saa7191_autodetect_norm(struct i2c_client
*client
)
386 dprintk("SAA7191 signal auto-detection...\n");
388 dprintk("Reading status...\n");
390 if (saa7191_read_status(client
, &status
))
393 dprintk("Checking for signal...\n");
396 if (status
& SAA7191_STATUS_HLCK
) {
397 dprintk("No signal\n");
401 dprintk("Signal found\n");
403 if (status
& SAA7191_STATUS_FIDT
) {
404 /* 60hz signal -> NTSC */
406 return saa7191_set_norm(client
, SAA7191_NORM_NTSC
);
408 /* 50hz signal -> PAL */
410 return saa7191_set_norm(client
, SAA7191_NORM_PAL
);
414 static int saa7191_get_control(struct i2c_client
*client
,
415 struct saa7191_control
*ctrl
)
420 switch (ctrl
->type
) {
421 case SAA7191_CONTROL_BANDPASS
:
422 case SAA7191_CONTROL_BANDPASS_WEIGHT
:
423 case SAA7191_CONTROL_CORING
:
424 reg
= saa7191_read_reg(client
, SAA7191_REG_LUMA
);
425 switch (ctrl
->type
) {
426 case SAA7191_CONTROL_BANDPASS
:
427 ctrl
->value
= ((s32
)reg
& SAA7191_LUMA_BPSS_MASK
)
428 >> SAA7191_LUMA_BPSS_SHIFT
;
430 case SAA7191_CONTROL_BANDPASS_WEIGHT
:
431 ctrl
->value
= ((s32
)reg
& SAA7191_LUMA_APER_MASK
)
432 >> SAA7191_LUMA_APER_SHIFT
;
434 case SAA7191_CONTROL_CORING
:
435 ctrl
->value
= ((s32
)reg
& SAA7191_LUMA_CORI_MASK
)
436 >> SAA7191_LUMA_CORI_SHIFT
;
440 case SAA7191_CONTROL_FORCE_COLOUR
:
441 case SAA7191_CONTROL_CHROMA_GAIN
:
442 reg
= saa7191_read_reg(client
, SAA7191_REG_GAIN
);
443 if (ctrl
->type
== SAA7191_CONTROL_FORCE_COLOUR
)
444 ctrl
->value
= ((s32
)reg
& SAA7191_GAIN_COLO
) ? 1 : 0;
446 ctrl
->value
= ((s32
)reg
& SAA7191_GAIN_LFIS_MASK
)
447 >> SAA7191_GAIN_LFIS_SHIFT
;
449 case SAA7191_CONTROL_HUE
:
450 reg
= saa7191_read_reg(client
, SAA7191_REG_HUEC
);
455 ctrl
->value
= (s32
)reg
;
457 case SAA7191_CONTROL_VTRC
:
458 reg
= saa7191_read_reg(client
, SAA7191_REG_STDC
);
459 ctrl
->value
= ((s32
)reg
& SAA7191_STDC_VTRC
) ? 1 : 0;
461 case SAA7191_CONTROL_LUMA_DELAY
:
462 reg
= saa7191_read_reg(client
, SAA7191_REG_CTL3
);
463 ctrl
->value
= ((s32
)reg
& SAA7191_CTL3_YDEL_MASK
)
464 >> SAA7191_CTL3_YDEL_SHIFT
;
465 if (ctrl
->value
>= 4)
468 case SAA7191_CONTROL_VNR
:
469 reg
= saa7191_read_reg(client
, SAA7191_REG_CTL4
);
470 ctrl
->value
= ((s32
)reg
& SAA7191_CTL4_VNOI_MASK
)
471 >> SAA7191_CTL4_VNOI_SHIFT
;
480 static int saa7191_set_control(struct i2c_client
*client
,
481 struct saa7191_control
*ctrl
)
486 switch (ctrl
->type
) {
487 case SAA7191_CONTROL_BANDPASS
:
488 case SAA7191_CONTROL_BANDPASS_WEIGHT
:
489 case SAA7191_CONTROL_CORING
:
490 reg
= saa7191_read_reg(client
, SAA7191_REG_LUMA
);
491 switch (ctrl
->type
) {
492 case SAA7191_CONTROL_BANDPASS
:
493 reg
&= ~SAA7191_LUMA_BPSS_MASK
;
494 reg
|= (ctrl
->value
<< SAA7191_LUMA_BPSS_SHIFT
)
495 & SAA7191_LUMA_BPSS_MASK
;
497 case SAA7191_CONTROL_BANDPASS_WEIGHT
:
498 reg
&= ~SAA7191_LUMA_APER_MASK
;
499 reg
|= (ctrl
->value
<< SAA7191_LUMA_APER_SHIFT
)
500 & SAA7191_LUMA_APER_MASK
;
502 case SAA7191_CONTROL_CORING
:
503 reg
&= ~SAA7191_LUMA_CORI_MASK
;
504 reg
|= (ctrl
->value
<< SAA7191_LUMA_CORI_SHIFT
)
505 & SAA7191_LUMA_CORI_MASK
;
508 ret
= saa7191_write_reg(client
, SAA7191_REG_LUMA
, reg
);
510 case SAA7191_CONTROL_FORCE_COLOUR
:
511 case SAA7191_CONTROL_CHROMA_GAIN
:
512 reg
= saa7191_read_reg(client
, SAA7191_REG_GAIN
);
513 if (ctrl
->type
== SAA7191_CONTROL_FORCE_COLOUR
) {
515 reg
|= SAA7191_GAIN_COLO
;
517 reg
&= ~SAA7191_GAIN_COLO
;
519 reg
&= ~SAA7191_GAIN_LFIS_MASK
;
520 reg
|= (ctrl
->value
<< SAA7191_GAIN_LFIS_SHIFT
)
521 & SAA7191_GAIN_LFIS_MASK
;
523 ret
= saa7191_write_reg(client
, SAA7191_REG_GAIN
, reg
);
525 case SAA7191_CONTROL_HUE
:
526 reg
= ctrl
->value
& 0xff;
531 ret
= saa7191_write_reg(client
, SAA7191_REG_HUEC
, reg
);
533 case SAA7191_CONTROL_VTRC
:
534 reg
= saa7191_read_reg(client
, SAA7191_REG_STDC
);
536 reg
|= SAA7191_STDC_VTRC
;
538 reg
&= ~SAA7191_STDC_VTRC
;
539 ret
= saa7191_write_reg(client
, SAA7191_REG_STDC
, reg
);
541 case SAA7191_CONTROL_LUMA_DELAY
: {
542 s32 value
= ctrl
->value
;
545 reg
= saa7191_read_reg(client
, SAA7191_REG_CTL3
);
546 reg
&= ~SAA7191_CTL3_YDEL_MASK
;
547 reg
|= (value
<< SAA7191_CTL3_YDEL_SHIFT
)
548 & SAA7191_CTL3_YDEL_MASK
;
549 ret
= saa7191_write_reg(client
, SAA7191_REG_CTL3
, reg
);
552 case SAA7191_CONTROL_VNR
:
553 reg
= saa7191_read_reg(client
, SAA7191_REG_CTL4
);
554 reg
&= ~SAA7191_CTL4_VNOI_MASK
;
555 reg
|= (ctrl
->value
<< SAA7191_CTL4_VNOI_SHIFT
)
556 & SAA7191_CTL4_VNOI_MASK
;
557 ret
= saa7191_write_reg(client
, SAA7191_REG_CTL4
, reg
);
568 static int saa7191_command(struct i2c_client
*client
, unsigned int cmd
,
571 struct saa7191
*decoder
= i2c_get_clientdata(client
);
574 case DECODER_GET_CAPABILITIES
: {
575 struct video_decoder_capability
*cap
= arg
;
577 cap
->flags
= VIDEO_DECODER_PAL
| VIDEO_DECODER_NTSC
|
578 VIDEO_DECODER_SECAM
| VIDEO_DECODER_AUTO
;
579 cap
->inputs
= (client
->adapter
->id
== I2C_HW_SGI_VINO
) ? 2 : 1;
583 case DECODER_GET_STATUS
: {
588 if (saa7191_read_status(client
, &status
)) {
591 if ((status
& SAA7191_STATUS_HLCK
) == 0)
592 res
|= DECODER_STATUS_GOOD
;
593 if (status
& SAA7191_STATUS_CODE
)
594 res
|= DECODER_STATUS_COLOR
;
595 switch (decoder
->norm
) {
596 case SAA7191_NORM_NTSC
:
597 res
|= DECODER_STATUS_NTSC
;
599 case SAA7191_NORM_PAL
:
600 res
|= DECODER_STATUS_PAL
;
602 case SAA7191_NORM_SECAM
:
603 res
|= DECODER_STATUS_SECAM
;
605 case SAA7191_NORM_AUTO
:
607 if (status
& SAA7191_STATUS_FIDT
)
608 res
|= DECODER_STATUS_NTSC
;
610 res
|= DECODER_STATUS_PAL
;
616 case DECODER_SET_NORM
: {
620 case VIDEO_MODE_AUTO
:
621 return saa7191_autodetect_norm(client
);
623 return saa7191_set_norm(client
, SAA7191_NORM_PAL
);
624 case VIDEO_MODE_NTSC
:
625 return saa7191_set_norm(client
, SAA7191_NORM_NTSC
);
626 case VIDEO_MODE_SECAM
:
627 return saa7191_set_norm(client
, SAA7191_NORM_SECAM
);
633 case DECODER_SET_INPUT
: {
636 switch (client
->adapter
->id
) {
637 case I2C_HW_SGI_VINO
:
638 return saa7191_set_input(client
, *iarg
);
645 case DECODER_SET_OUTPUT
: {
648 /* not much choice of outputs */
653 case DECODER_ENABLE_OUTPUT
: {
657 case DECODER_SET_PICTURE
: {
658 struct video_picture
*pic
= arg
;
662 val
= (pic
->hue
>> 8) - 0x80;
664 err
= saa7191_write_reg(client
, SAA7191_REG_HUEC
, val
);
670 case DECODER_SAA7191_GET_STATUS
: {
671 struct saa7191_status
*status
= arg
;
674 if (saa7191_read_status(client
, &status_reg
))
677 status
->signal
= ((status_reg
& SAA7191_STATUS_HLCK
) == 0)
679 status
->signal_60hz
= (status_reg
& SAA7191_STATUS_FIDT
)
681 status
->color
= (status_reg
& SAA7191_STATUS_CODE
) ? 1 : 0;
683 status
->input
= decoder
->input
;
684 status
->norm
= decoder
->norm
;
688 case DECODER_SAA7191_SET_NORM
: {
692 case SAA7191_NORM_AUTO
:
693 return saa7191_autodetect_norm(client
);
694 case SAA7191_NORM_AUTO_EXT
:
695 return saa7191_autodetect_norm_extended(client
);
697 return saa7191_set_norm(client
, *norm
);
700 case DECODER_SAA7191_GET_CONTROL
: {
701 return saa7191_get_control(client
, arg
);
703 case DECODER_SAA7191_SET_CONTROL
: {
704 return saa7191_set_control(client
, arg
);
713 static int saa7191_probe(struct i2c_client
*client
,
714 const struct i2c_device_id
*id
)
717 struct saa7191
*decoder
;
719 v4l_info(client
, "chip found @ 0x%x (%s)\n",
720 client
->addr
<< 1, client
->adapter
->name
);
722 decoder
= kzalloc(sizeof(*decoder
), GFP_KERNEL
);
726 i2c_set_clientdata(client
, decoder
);
728 decoder
->client
= client
;
730 err
= saa7191_write_block(client
, sizeof(initseq
), initseq
);
732 printk(KERN_ERR
"SAA7191 initialization failed\n");
737 printk(KERN_INFO
"SAA7191 initialized\n");
739 decoder
->input
= SAA7191_INPUT_COMPOSITE
;
740 decoder
->norm
= SAA7191_NORM_PAL
;
742 err
= saa7191_autodetect_norm(client
);
743 if (err
&& (err
!= -EBUSY
))
744 printk(KERN_ERR
"SAA7191: Signal auto-detection failed\n");
749 static int saa7191_remove(struct i2c_client
*client
)
751 struct saa7191
*decoder
= i2c_get_clientdata(client
);
757 static int saa7191_legacy_probe(struct i2c_adapter
*adapter
)
759 return adapter
->id
== I2C_HW_SGI_VINO
;
762 static const struct i2c_device_id saa7191_id
[] = {
766 MODULE_DEVICE_TABLE(i2c
, saa7191_id
);
768 static struct v4l2_i2c_driver_data v4l2_i2c_data
= {
770 .driverid
= I2C_DRIVERID_SAA7191
,
771 .command
= saa7191_command
,
772 .probe
= saa7191_probe
,
773 .remove
= saa7191_remove
,
774 .legacy_probe
= saa7191_legacy_probe
,
775 .id_table
= saa7191_id
,