k8temp: Add documentation
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / media / video / saa7110.c
blob7bb85a7b326ef9bd8955e4beae8c944b015c73f0
1 /*
2 * saa7110 - Philips SAA7110(A) video decoder driver
4 * Copyright (C) 1998 Pauline Middelink <middelin@polyware.nl>
6 * Copyright (C) 1999 Wolfgang Scherr <scherr@net4you.net>
7 * Copyright (C) 2000 Serguei Miridonov <mirsev@cicese.mx>
8 * - some corrections for Pinnacle Systems Inc. DC10plus card.
10 * Changes by Ronald Bultje <rbultje@ronald.bitfreak.net>
11 * - moved over to linux>=2.4.x i2c protocol (1/1/2003)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include <linux/module.h>
29 #include <linux/init.h>
30 #include <linux/types.h>
31 #include <linux/delay.h>
32 #include <linux/slab.h>
33 #include <linux/wait.h>
34 #include <asm/io.h>
35 #include <asm/uaccess.h>
37 MODULE_DESCRIPTION("Philips SAA7110 video decoder driver");
38 MODULE_AUTHOR("Pauline Middelink");
39 MODULE_LICENSE("GPL");
41 #include <linux/i2c.h>
42 #include <linux/i2c-dev.h>
44 #define I2C_NAME(s) (s)->name
46 #include <linux/videodev.h>
47 #include <linux/video_decoder.h>
49 static int debug = 0;
50 module_param(debug, int, 0);
51 MODULE_PARM_DESC(debug, "Debug level (0-1)");
53 #define dprintk(num, format, args...) \
54 do { \
55 if (debug >= num) \
56 printk(format, ##args); \
57 } while (0)
59 #define SAA7110_MAX_INPUT 9 /* 6 CVBS, 3 SVHS */
60 #define SAA7110_MAX_OUTPUT 0 /* its a decoder only */
62 #define I2C_SAA7110 0x9C /* or 0x9E */
64 #define SAA7110_NR_REG 0x35
66 struct saa7110 {
67 u8 reg[SAA7110_NR_REG];
69 int norm;
70 int input;
71 int enable;
72 int bright;
73 int contrast;
74 int hue;
75 int sat;
77 wait_queue_head_t wq;
80 /* ----------------------------------------------------------------------- */
81 /* I2C support functions */
82 /* ----------------------------------------------------------------------- */
84 static int
85 saa7110_write (struct i2c_client *client,
86 u8 reg,
87 u8 value)
89 struct saa7110 *decoder = i2c_get_clientdata(client);
91 decoder->reg[reg] = value;
92 return i2c_smbus_write_byte_data(client, reg, value);
95 static int
96 saa7110_write_block (struct i2c_client *client,
97 const u8 *data,
98 unsigned int len)
100 int ret = -1;
101 u8 reg = *data; /* first register to write to */
103 /* Sanity check */
104 if (reg + (len - 1) > SAA7110_NR_REG)
105 return ret;
107 /* the saa7110 has an autoincrement function, use it if
108 * the adapter understands raw I2C */
109 if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
110 struct saa7110 *decoder = i2c_get_clientdata(client);
111 struct i2c_msg msg;
113 msg.len = len;
114 msg.buf = (char *) data;
115 msg.addr = client->addr;
116 msg.flags = 0;
117 ret = i2c_transfer(client->adapter, &msg, 1);
119 /* Cache the written data */
120 memcpy(decoder->reg + reg, data + 1, len - 1);
121 } else {
122 for (++data, --len; len; len--) {
123 if ((ret = saa7110_write(client, reg++,
124 *data++)) < 0)
125 break;
129 return ret;
132 static inline int
133 saa7110_read (struct i2c_client *client)
135 return i2c_smbus_read_byte(client);
138 /* ----------------------------------------------------------------------- */
139 /* SAA7110 functions */
140 /* ----------------------------------------------------------------------- */
142 #define FRESP_06H_COMPST 0x03 //0x13
143 #define FRESP_06H_SVIDEO 0x83 //0xC0
146 static int
147 saa7110_selmux (struct i2c_client *client,
148 int chan)
150 static const unsigned char modes[9][8] = {
151 /* mode 0 */
152 {FRESP_06H_COMPST, 0xD9, 0x17, 0x40, 0x03,
153 0x44, 0x75, 0x16},
154 /* mode 1 */
155 {FRESP_06H_COMPST, 0xD8, 0x17, 0x40, 0x03,
156 0x44, 0x75, 0x16},
157 /* mode 2 */
158 {FRESP_06H_COMPST, 0xBA, 0x07, 0x91, 0x03,
159 0x60, 0xB5, 0x05},
160 /* mode 3 */
161 {FRESP_06H_COMPST, 0xB8, 0x07, 0x91, 0x03,
162 0x60, 0xB5, 0x05},
163 /* mode 4 */
164 {FRESP_06H_COMPST, 0x7C, 0x07, 0xD2, 0x83,
165 0x60, 0xB5, 0x03},
166 /* mode 5 */
167 {FRESP_06H_COMPST, 0x78, 0x07, 0xD2, 0x83,
168 0x60, 0xB5, 0x03},
169 /* mode 6 */
170 {FRESP_06H_SVIDEO, 0x59, 0x17, 0x42, 0xA3,
171 0x44, 0x75, 0x12},
172 /* mode 7 */
173 {FRESP_06H_SVIDEO, 0x9A, 0x17, 0xB1, 0x13,
174 0x60, 0xB5, 0x14},
175 /* mode 8 */
176 {FRESP_06H_SVIDEO, 0x3C, 0x27, 0xC1, 0x23,
177 0x44, 0x75, 0x21}
179 struct saa7110 *decoder = i2c_get_clientdata(client);
180 const unsigned char *ptr = modes[chan];
182 saa7110_write(client, 0x06, ptr[0]); /* Luminance control */
183 saa7110_write(client, 0x20, ptr[1]); /* Analog Control #1 */
184 saa7110_write(client, 0x21, ptr[2]); /* Analog Control #2 */
185 saa7110_write(client, 0x22, ptr[3]); /* Mixer Control #1 */
186 saa7110_write(client, 0x2C, ptr[4]); /* Mixer Control #2 */
187 saa7110_write(client, 0x30, ptr[5]); /* ADCs gain control */
188 saa7110_write(client, 0x31, ptr[6]); /* Mixer Control #3 */
189 saa7110_write(client, 0x21, ptr[7]); /* Analog Control #2 */
190 decoder->input = chan;
192 return 0;
195 static const unsigned char initseq[1 + SAA7110_NR_REG] = {
196 0, 0x4C, 0x3C, 0x0D, 0xEF, 0xBD, 0xF2, 0x03, 0x00,
197 /* 0x08 */ 0xF8, 0xF8, 0x60, 0x60, 0x00, 0x86, 0x18, 0x90,
198 /* 0x10 */ 0x00, 0x59, 0x40, 0x46, 0x42, 0x1A, 0xFF, 0xDA,
199 /* 0x18 */ 0xF2, 0x8B, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
200 /* 0x20 */ 0xD9, 0x16, 0x40, 0x41, 0x80, 0x41, 0x80, 0x4F,
201 /* 0x28 */ 0xFE, 0x01, 0xCF, 0x0F, 0x03, 0x01, 0x03, 0x0C,
202 /* 0x30 */ 0x44, 0x71, 0x02, 0x8C, 0x02
205 static int
206 determine_norm (struct i2c_client *client)
208 DEFINE_WAIT(wait);
209 struct saa7110 *decoder = i2c_get_clientdata(client);
210 int status;
212 /* mode changed, start automatic detection */
213 saa7110_write_block(client, initseq, sizeof(initseq));
214 saa7110_selmux(client, decoder->input);
215 prepare_to_wait(&decoder->wq, &wait, TASK_UNINTERRUPTIBLE);
216 schedule_timeout(HZ/4);
217 finish_wait(&decoder->wq, &wait);
218 status = saa7110_read(client);
219 if (status & 0x40) {
220 dprintk(1, KERN_INFO "%s: status=0x%02x (no signal)\n",
221 I2C_NAME(client), status);
222 return decoder->norm; // no change
224 if ((status & 3) == 0) {
225 saa7110_write(client, 0x06, 0x83);
226 if (status & 0x20) {
227 dprintk(1,
228 KERN_INFO
229 "%s: status=0x%02x (NTSC/no color)\n",
230 I2C_NAME(client), status);
231 //saa7110_write(client,0x2E,0x81);
232 return VIDEO_MODE_NTSC;
234 dprintk(1, KERN_INFO "%s: status=0x%02x (PAL/no color)\n",
235 I2C_NAME(client), status);
236 //saa7110_write(client,0x2E,0x9A);
237 return VIDEO_MODE_PAL;
239 //saa7110_write(client,0x06,0x03);
240 if (status & 0x20) { /* 60Hz */
241 dprintk(1, KERN_INFO "%s: status=0x%02x (NTSC)\n",
242 I2C_NAME(client), status);
243 saa7110_write(client, 0x0D, 0x86);
244 saa7110_write(client, 0x0F, 0x50);
245 saa7110_write(client, 0x11, 0x2C);
246 //saa7110_write(client,0x2E,0x81);
247 return VIDEO_MODE_NTSC;
250 /* 50Hz -> PAL/SECAM */
251 saa7110_write(client, 0x0D, 0x86);
252 saa7110_write(client, 0x0F, 0x10);
253 saa7110_write(client, 0x11, 0x59);
254 //saa7110_write(client,0x2E,0x9A);
256 prepare_to_wait(&decoder->wq, &wait, TASK_UNINTERRUPTIBLE);
257 schedule_timeout(HZ/4);
258 finish_wait(&decoder->wq, &wait);
260 status = saa7110_read(client);
261 if ((status & 0x03) == 0x01) {
262 dprintk(1, KERN_INFO "%s: status=0x%02x (SECAM)\n",
263 I2C_NAME(client), status);
264 saa7110_write(client, 0x0D, 0x87);
265 return VIDEO_MODE_SECAM;
267 dprintk(1, KERN_INFO "%s: status=0x%02x (PAL)\n", I2C_NAME(client),
268 status);
269 return VIDEO_MODE_PAL;
272 static int
273 saa7110_command (struct i2c_client *client,
274 unsigned int cmd,
275 void *arg)
277 struct saa7110 *decoder = i2c_get_clientdata(client);
278 int v;
280 switch (cmd) {
281 case 0:
282 //saa7110_write_block(client, initseq, sizeof(initseq));
283 break;
285 case DECODER_GET_CAPABILITIES:
287 struct video_decoder_capability *dc = arg;
289 dc->flags =
290 VIDEO_DECODER_PAL | VIDEO_DECODER_NTSC |
291 VIDEO_DECODER_SECAM | VIDEO_DECODER_AUTO;
292 dc->inputs = SAA7110_MAX_INPUT;
293 dc->outputs = SAA7110_MAX_OUTPUT;
295 break;
297 case DECODER_GET_STATUS:
299 int status;
300 int res = 0;
302 status = saa7110_read(client);
303 dprintk(1, KERN_INFO "%s: status=0x%02x norm=%d\n",
304 I2C_NAME(client), status, decoder->norm);
305 if (!(status & 0x40))
306 res |= DECODER_STATUS_GOOD;
307 if (status & 0x03)
308 res |= DECODER_STATUS_COLOR;
310 switch (decoder->norm) {
311 case VIDEO_MODE_NTSC:
312 res |= DECODER_STATUS_NTSC;
313 break;
314 case VIDEO_MODE_PAL:
315 res |= DECODER_STATUS_PAL;
316 break;
317 case VIDEO_MODE_SECAM:
318 res |= DECODER_STATUS_SECAM;
319 break;
321 *(int *) arg = res;
323 break;
325 case DECODER_SET_NORM:
326 v = *(int *) arg;
327 if (decoder->norm != v) {
328 decoder->norm = v;
329 //saa7110_write(client, 0x06, 0x03);
330 switch (v) {
331 case VIDEO_MODE_NTSC:
332 saa7110_write(client, 0x0D, 0x86);
333 saa7110_write(client, 0x0F, 0x50);
334 saa7110_write(client, 0x11, 0x2C);
335 //saa7110_write(client, 0x2E, 0x81);
336 dprintk(1,
337 KERN_INFO "%s: switched to NTSC\n",
338 I2C_NAME(client));
339 break;
340 case VIDEO_MODE_PAL:
341 saa7110_write(client, 0x0D, 0x86);
342 saa7110_write(client, 0x0F, 0x10);
343 saa7110_write(client, 0x11, 0x59);
344 //saa7110_write(client, 0x2E, 0x9A);
345 dprintk(1,
346 KERN_INFO "%s: switched to PAL\n",
347 I2C_NAME(client));
348 break;
349 case VIDEO_MODE_SECAM:
350 saa7110_write(client, 0x0D, 0x87);
351 saa7110_write(client, 0x0F, 0x10);
352 saa7110_write(client, 0x11, 0x59);
353 //saa7110_write(client, 0x2E, 0x9A);
354 dprintk(1,
355 KERN_INFO
356 "%s: switched to SECAM\n",
357 I2C_NAME(client));
358 break;
359 case VIDEO_MODE_AUTO:
360 dprintk(1,
361 KERN_INFO
362 "%s: TV standard detection...\n",
363 I2C_NAME(client));
364 decoder->norm = determine_norm(client);
365 *(int *) arg = decoder->norm;
366 break;
367 default:
368 return -EPERM;
371 break;
373 case DECODER_SET_INPUT:
374 v = *(int *) arg;
375 if (v < 0 || v > SAA7110_MAX_INPUT) {
376 dprintk(1,
377 KERN_INFO "%s: input=%d not available\n",
378 I2C_NAME(client), v);
379 return -EINVAL;
381 if (decoder->input != v) {
382 saa7110_selmux(client, v);
383 dprintk(1, KERN_INFO "%s: switched to input=%d\n",
384 I2C_NAME(client), v);
386 break;
388 case DECODER_SET_OUTPUT:
389 v = *(int *) arg;
390 /* not much choice of outputs */
391 if (v != 0)
392 return -EINVAL;
393 break;
395 case DECODER_ENABLE_OUTPUT:
396 v = *(int *) arg;
397 if (decoder->enable != v) {
398 decoder->enable = v;
399 saa7110_write(client, 0x0E, v ? 0x18 : 0x80);
400 dprintk(1, KERN_INFO "%s: YUV %s\n", I2C_NAME(client),
401 v ? "on" : "off");
403 break;
405 case DECODER_SET_PICTURE:
407 struct video_picture *pic = arg;
409 if (decoder->bright != pic->brightness) {
410 /* We want 0 to 255 we get 0-65535 */
411 decoder->bright = pic->brightness;
412 saa7110_write(client, 0x19, decoder->bright >> 8);
414 if (decoder->contrast != pic->contrast) {
415 /* We want 0 to 127 we get 0-65535 */
416 decoder->contrast = pic->contrast;
417 saa7110_write(client, 0x13,
418 decoder->contrast >> 9);
420 if (decoder->sat != pic->colour) {
421 /* We want 0 to 127 we get 0-65535 */
422 decoder->sat = pic->colour;
423 saa7110_write(client, 0x12, decoder->sat >> 9);
425 if (decoder->hue != pic->hue) {
426 /* We want -128 to 127 we get 0-65535 */
427 decoder->hue = pic->hue;
428 saa7110_write(client, 0x07,
429 (decoder->hue >> 8) - 128);
432 break;
434 case DECODER_DUMP:
435 for (v = 0; v < 0x34; v += 16) {
436 int j;
437 dprintk(1, KERN_INFO "%s: %03x\n", I2C_NAME(client),
439 for (j = 0; j < 16; j++) {
440 dprintk(1, KERN_INFO " %02x",
441 decoder->reg[v + j]);
443 dprintk(1, KERN_INFO "\n");
445 break;
447 default:
448 dprintk(1, KERN_INFO "unknown saa7110_command??(%d)\n",
449 cmd);
450 return -EINVAL;
452 return 0;
455 /* ----------------------------------------------------------------------- */
458 * Generic i2c probe
459 * concerning the addresses: i2c wants 7 bit (without the r/w bit), so '>>1'
461 static unsigned short normal_i2c[] = {
462 I2C_SAA7110 >> 1,
463 (I2C_SAA7110 >> 1) + 1,
464 I2C_CLIENT_END
467 static unsigned short ignore = I2C_CLIENT_END;
469 static struct i2c_client_address_data addr_data = {
470 .normal_i2c = normal_i2c,
471 .probe = &ignore,
472 .ignore = &ignore,
475 static struct i2c_driver i2c_driver_saa7110;
477 static int
478 saa7110_detect_client (struct i2c_adapter *adapter,
479 int address,
480 int kind)
482 struct i2c_client *client;
483 struct saa7110 *decoder;
484 int rv;
486 dprintk(1,
487 KERN_INFO
488 "saa7110.c: detecting saa7110 client on address 0x%x\n",
489 address << 1);
491 /* Check if the adapter supports the needed features */
492 if (!i2c_check_functionality
493 (adapter,
494 I2C_FUNC_SMBUS_READ_BYTE | I2C_FUNC_SMBUS_WRITE_BYTE_DATA))
495 return 0;
497 client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
498 if (client == 0)
499 return -ENOMEM;
500 client->addr = address;
501 client->adapter = adapter;
502 client->driver = &i2c_driver_saa7110;
503 strlcpy(I2C_NAME(client), "saa7110", sizeof(I2C_NAME(client)));
505 decoder = kzalloc(sizeof(struct saa7110), GFP_KERNEL);
506 if (decoder == 0) {
507 kfree(client);
508 return -ENOMEM;
510 decoder->norm = VIDEO_MODE_PAL;
511 decoder->input = 0;
512 decoder->enable = 1;
513 decoder->bright = 32768;
514 decoder->contrast = 32768;
515 decoder->hue = 32768;
516 decoder->sat = 32768;
517 init_waitqueue_head(&decoder->wq);
518 i2c_set_clientdata(client, decoder);
520 rv = i2c_attach_client(client);
521 if (rv) {
522 kfree(client);
523 kfree(decoder);
524 return rv;
527 rv = saa7110_write_block(client, initseq, sizeof(initseq));
528 if (rv < 0)
529 dprintk(1, KERN_ERR "%s_attach: init status %d\n",
530 I2C_NAME(client), rv);
531 else {
532 int ver, status;
533 saa7110_write(client, 0x21, 0x10);
534 saa7110_write(client, 0x0e, 0x18);
535 saa7110_write(client, 0x0D, 0x04);
536 ver = saa7110_read(client);
537 saa7110_write(client, 0x0D, 0x06);
538 //mdelay(150);
539 status = saa7110_read(client);
540 dprintk(1,
541 KERN_INFO
542 "%s_attach: SAA7110A version %x at 0x%02x, status=0x%02x\n",
543 I2C_NAME(client), ver, client->addr << 1, status);
544 saa7110_write(client, 0x0D, 0x86);
545 saa7110_write(client, 0x0F, 0x10);
546 saa7110_write(client, 0x11, 0x59);
547 //saa7110_write(client, 0x2E, 0x9A);
550 //saa7110_selmux(client,0);
551 //determine_norm(client);
552 /* setup and implicit mode 0 select has been performed */
554 return 0;
557 static int
558 saa7110_attach_adapter (struct i2c_adapter *adapter)
560 dprintk(1,
561 KERN_INFO
562 "saa7110.c: starting probe for adapter %s (0x%x)\n",
563 I2C_NAME(adapter), adapter->id);
564 return i2c_probe(adapter, &addr_data, &saa7110_detect_client);
567 static int
568 saa7110_detach_client (struct i2c_client *client)
570 struct saa7110 *decoder = i2c_get_clientdata(client);
571 int err;
573 err = i2c_detach_client(client);
574 if (err) {
575 return err;
578 kfree(decoder);
579 kfree(client);
581 return 0;
584 /* ----------------------------------------------------------------------- */
586 static struct i2c_driver i2c_driver_saa7110 = {
587 .driver = {
588 .name = "saa7110",
591 .id = I2C_DRIVERID_SAA7110,
593 .attach_adapter = saa7110_attach_adapter,
594 .detach_client = saa7110_detach_client,
595 .command = saa7110_command,
598 static int __init
599 saa7110_init (void)
601 return i2c_add_driver(&i2c_driver_saa7110);
604 static void __exit
605 saa7110_exit (void)
607 i2c_del_driver(&i2c_driver_saa7110);
610 module_init(saa7110_init);
611 module_exit(saa7110_exit);