2 * Cleaned up to use existing videodev interface and allow the idea
3 * of multiple teletext decoders on the video4linux iface. Changed i2c
4 * to cover addressing clashes on device busses. It's also rebuilt so
5 * you can add arbitary multiple teletext devices to Linux video4linux
6 * now (well 32 anyway).
8 * Alan Cox <Alan.Cox@linux.org>
10 * The original driver was heavily modified to match the i2c interface
11 * It was truncated to use the WinTV boards, too.
13 * Copyright (c) 1998 Richard Guenther <richard.guenther@student.uni-tuebingen.de>
15 * $Id: saa5249.c,v 1.1 1998/03/30 22:23:23 alan Exp $
20 * This is a loadable character-device-driver for videotext-interfaces
21 * (aka teletext). Please check the Makefile/README for a list of supported
24 * Copyright (c) 1994-97 Martin Buck <martin-2.buck@student.uni-ulm.de>
27 * This program is free software; you can redistribute it and/or modify
28 * it under the terms of the GNU General Public License as published by
29 * the Free Software Foundation; either version 2 of the License, or
30 * (at your option) any later version.
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 * You should have received a copy of the GNU General Public License
38 * along with this program; if not, write to the Free Software
39 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
43 #include <linux/module.h>
44 #include <linux/kernel.h>
45 #include <linux/sched.h>
47 #include <linux/errno.h>
48 #include <linux/delay.h>
49 #include <linux/ioport.h>
50 #include <linux/slab.h>
51 #include <linux/init.h>
53 #include <linux/i2c.h>
54 #include <linux/videotext.h>
55 #include <linux/videodev.h>
58 #include <asm/uaccess.h>
67 #define IF_NAME "SAA5249"
69 static const int disp_modes[8][3] =
71 { 0x46, 0x03, 0x03 }, /* DISPOFF */
72 { 0x46, 0xcc, 0xcc }, /* DISPNORM */
73 { 0x44, 0x0f, 0x0f }, /* DISPTRANS */
74 { 0x46, 0xcc, 0x46 }, /* DISPINS */
75 { 0x44, 0x03, 0x03 }, /* DISPOFF, interlaced */
76 { 0x44, 0xcc, 0xcc }, /* DISPNORM, interlaced */
77 { 0x44, 0x0f, 0x0f }, /* DISPTRANS, interlaced */
78 { 0x44, 0xcc, 0x46 } /* DISPINS, interlaced */
83 #define PAGE_WAIT (300*HZ/1000) /* Time between requesting page and */
84 /* checking status bits */
85 #define PGBUF_EXPIRE (15*HZ) /* Time to wait before retransmitting */
86 /* page regardless of infobits */
88 u8 pgbuf[VTX_VIRTUALSIZE]; /* Page-buffer */
89 u8 laststat[10]; /* Last value of infobits for DAU */
90 u8 sregs[7]; /* Page-request registers */
91 unsigned long expire; /* Time when page will be expired */
92 unsigned clrfound : 1; /* VTXIOCCLRFOUND has been called */
93 unsigned stopped : 1; /* VTXIOCSTOPDAU has been called */
98 vdau_t vdau[NUM_DAUS]; /* Data for virtual DAUs (the 5249 only has one */
99 /* real DAU, so we have to simulate some more) */
101 int is_searching[NUM_DAUS];
104 struct i2c_client *client;
105 struct semaphore lock;
109 #define CCTWR 34 /* I²C write/read-address of vtx-chip */
111 #define NOACK_REPEAT 10 /* Retry access this many times on failure */
112 #define CLEAR_DELAY (HZ/20) /* Time required to clear a page */
113 #define READY_TIMEOUT (30*HZ/1000) /* Time to wait for ready signal of I²C-bus interface */
114 #define INIT_DELAY 500 /* Time in usec to wait at initialization of CEA interface */
115 #define START_DELAY 10 /* Time in usec to wait before starting write-cycle (CEA) */
117 #define VTX_DEV_MINOR 0
119 /* General defines and debugging support */
126 #define RESCHED do { cond_resched(); } while(0)
128 static struct video_device saa_template; /* Declared near bottom */
130 /* Addresses to scan */
131 static unsigned short normal_i2c[] = {34>>1,I2C_CLIENT_END};
132 static unsigned short normal_i2c_range[] = {I2C_CLIENT_END};
133 static unsigned short probe[2] = { I2C_CLIENT_END, I2C_CLIENT_END };
134 static unsigned short probe_range[2] = { I2C_CLIENT_END, I2C_CLIENT_END };
135 static unsigned short ignore[2] = { I2C_CLIENT_END, I2C_CLIENT_END };
136 static unsigned short ignore_range[2] = { I2C_CLIENT_END, I2C_CLIENT_END };
137 static unsigned short force[2] = { I2C_CLIENT_END, I2C_CLIENT_END };
139 static struct i2c_client_address_data addr_data = {
140 normal_i2c, normal_i2c_range,
142 ignore, ignore_range,
146 static struct i2c_client client_template;
148 static int saa5249_attach(struct i2c_adapter *adap, int addr, int kind)
152 struct i2c_client *client;
153 struct video_device *vd;
154 struct saa5249_device *t;
156 printk(KERN_INFO "saa5249: teletext chip found.\n");
157 client=kmalloc(sizeof(*client), GFP_KERNEL);
160 client_template.adapter = adap;
161 client_template.addr = addr;
162 memcpy(client, &client_template, sizeof(*client));
163 t = kmalloc(sizeof(*t), GFP_KERNEL);
169 memset(t, 0, sizeof(*t));
170 strlcpy(client->name, IF_NAME, I2C_NAME_SIZE);
171 init_MUTEX(&t->lock);
174 * Now create a video4linux device
177 vd = (struct video_device *)kmalloc(sizeof(struct video_device), GFP_KERNEL);
184 i2c_set_clientdata(client, vd);
185 memcpy(vd, &saa_template, sizeof(*vd));
187 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++)
189 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
190 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
191 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
192 t->vdau[pgbuf].expire = 0;
193 t->vdau[pgbuf].clrfound = TRUE;
194 t->vdau[pgbuf].stopped = TRUE;
195 t->is_searching[pgbuf] = FALSE;
204 if((err=video_register_device(vd, VFL_TYPE_VTX,-1))<0)
212 i2c_attach_client(client);
217 * We do most of the hard work when we become a device on the i2c.
220 static int saa5249_probe(struct i2c_adapter *adap)
222 if (adap->class & I2C_ADAP_CLASS_TV_ANALOG)
223 return i2c_probe(adap, &addr_data, saa5249_attach);
227 static int saa5249_detach(struct i2c_client *client)
229 struct video_device *vd = i2c_get_clientdata(client);
230 i2c_detach_client(client);
231 video_unregister_device(vd);
238 static int saa5249_command(struct i2c_client *device,
239 unsigned int cmd, void *arg)
244 /* new I2C driver support */
246 static struct i2c_driver i2c_driver_videotext =
248 .owner = THIS_MODULE,
249 .name = IF_NAME, /* name */
250 .id = I2C_DRIVERID_SAA5249, /* in i2c.h */
251 .flags = I2C_DF_NOTIFY,
252 .attach_adapter = saa5249_probe,
253 .detach_client = saa5249_detach,
254 .command = saa5249_command
257 static struct i2c_client client_template = {
259 .driver = &i2c_driver_videotext,
264 * Wait the given number of jiffies (10ms). This calls the scheduler, so the actual
265 * delay may be longer.
268 static void jdelay(unsigned long delay)
270 sigset_t oldblocked = current->blocked;
272 spin_lock_irq(¤t->sighand->siglock);
273 sigfillset(¤t->blocked);
275 spin_unlock_irq(¤t->sighand->siglock);
276 current->state = TASK_INTERRUPTIBLE;
277 schedule_timeout(delay);
279 spin_lock_irq(¤t->sighand->siglock);
280 current->blocked = oldblocked;
282 spin_unlock_irq(¤t->sighand->siglock);
290 static int i2c_sendbuf(struct saa5249_device *t, int reg, int count, u8 *data)
295 memcpy(buf+1, data, count);
297 if(i2c_master_send(t->client, buf, count+1)==count+1)
302 static int i2c_senddata(struct saa5249_device *t, ...)
304 unsigned char buf[64];
310 while((v=va_arg(argp,int))!=-1)
312 return i2c_sendbuf(t, buf[0], ct-1, buf+1);
315 /* Get count number of bytes from I²C-device at address adr, store them in buf. Start & stop
316 * handshaking is done by this routine, ack will be sent after the last byte to inhibit further
317 * sending of data. If uaccess is TRUE, data is written to user-space with put_user.
318 * Returns -1 if I²C-device didn't send acknowledge, 0 otherwise
321 static int i2c_getdata(struct saa5249_device *t, int count, u8 *buf)
323 if(i2c_master_recv(t->client, buf, count)!=count)
330 * Standard character-device-driver functions
333 static int do_saa5249_ioctl(struct inode *inode, struct file *file,
334 unsigned int cmd, void *arg)
336 static int virtual_mode = FALSE;
337 struct video_device *vd = video_devdata(file);
338 struct saa5249_device *t=vd->priv;
344 vtx_info_t *info = arg;
345 info->version_major = VTX_VER_MAJ;
346 info->version_minor = VTX_VER_MIN;
347 info->numpages = NUM_DAUS;
348 /*info->cct_type = CCT_TYPE;*/
354 vtx_pagereq_t *req = arg;
356 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
358 memset(t->vdau[req->pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
359 t->vdau[req->pgbuf].clrfound = TRUE;
365 vtx_pagereq_t *req = arg;
367 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
369 t->vdau[req->pgbuf].clrfound = TRUE;
375 vtx_pagereq_t *req = arg;
376 if (!(req->pagemask & PGMASK_PAGE))
378 if (!(req->pagemask & PGMASK_HOUR))
380 if (!(req->pagemask & PGMASK_MINUTE))
382 if (req->page < 0 || req->page > 0x8ff) /* 7FF ?? */
385 if (req->hour < 0 || req->hour > 0x3f || req->minute < 0 || req->minute > 0x7f ||
386 req->pagemask < 0 || req->pagemask >= PGMASK_MAX || req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
388 t->vdau[req->pgbuf].sregs[0] = (req->pagemask & PG_HUND ? 0x10 : 0) | (req->page / 0x100);
389 t->vdau[req->pgbuf].sregs[1] = (req->pagemask & PG_TEN ? 0x10 : 0) | ((req->page / 0x10) & 0xf);
390 t->vdau[req->pgbuf].sregs[2] = (req->pagemask & PG_UNIT ? 0x10 : 0) | (req->page & 0xf);
391 t->vdau[req->pgbuf].sregs[3] = (req->pagemask & HR_TEN ? 0x10 : 0) | (req->hour / 0x10);
392 t->vdau[req->pgbuf].sregs[4] = (req->pagemask & HR_UNIT ? 0x10 : 0) | (req->hour & 0xf);
393 t->vdau[req->pgbuf].sregs[5] = (req->pagemask & MIN_TEN ? 0x10 : 0) | (req->minute / 0x10);
394 t->vdau[req->pgbuf].sregs[6] = (req->pagemask & MIN_UNIT ? 0x10 : 0) | (req->minute & 0xf);
395 t->vdau[req->pgbuf].stopped = FALSE;
396 t->vdau[req->pgbuf].clrfound = TRUE;
397 t->is_searching[req->pgbuf] = TRUE;
403 vtx_pagereq_t *req = arg;
408 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
410 if (!t->vdau[req->pgbuf].stopped)
412 if (i2c_senddata(t, 2, 0, -1) ||
413 i2c_sendbuf(t, 3, sizeof(t->vdau[0].sregs), t->vdau[req->pgbuf].sregs) ||
414 i2c_senddata(t, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
415 i2c_senddata(t, 2, 0, t->vdau[req->pgbuf].sregs[0] | 8, -1) ||
416 i2c_senddata(t, 8, 0, 25, 0, -1))
419 if (i2c_getdata(t, 10, infobits))
422 if (!(infobits[8] & 0x10) && !(infobits[7] & 0xf0) && /* check FOUND-bit */
423 (memcmp(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits)) ||
424 time_after_eq(jiffies, t->vdau[req->pgbuf].expire)))
425 { /* check if new page arrived */
426 if (i2c_senddata(t, 8, 0, 0, 0, -1) ||
427 i2c_getdata(t, VTX_PAGESIZE, t->vdau[req->pgbuf].pgbuf))
429 t->vdau[req->pgbuf].expire = jiffies + PGBUF_EXPIRE;
430 memset(t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE, ' ', VTX_VIRTUALSIZE - VTX_PAGESIZE);
434 if (i2c_senddata(t, 8, 0, 0x20, 0, -1) ||
435 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 20 * 40))
438 if (i2c_senddata(t, 8, 0, 0x21, 0, -1) ||
439 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 16 * 40))
441 /* Packet 8/30/0...8/30/15
442 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
443 * so we should undo this here.
445 if (i2c_senddata(t, 8, 0, 0x22, 0, -1) ||
446 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 23 * 40))
449 t->vdau[req->pgbuf].clrfound = FALSE;
450 memcpy(t->vdau[req->pgbuf].laststat, infobits, sizeof(infobits));
454 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
459 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
462 info.pagenum = ((infobits[8] << 8) & 0x700) | ((infobits[1] << 4) & 0xf0) | (infobits[0] & 0x0f);
463 if (info.pagenum < 0x100)
464 info.pagenum += 0x800;
465 info.hour = ((infobits[5] << 4) & 0x30) | (infobits[4] & 0x0f);
466 info.minute = ((infobits[3] << 4) & 0x70) | (infobits[2] & 0x0f);
467 info.charset = ((infobits[7] >> 1) & 7);
468 info.delete = !!(infobits[3] & 8);
469 info.headline = !!(infobits[5] & 4);
470 info.subtitle = !!(infobits[5] & 8);
471 info.supp_header = !!(infobits[6] & 1);
472 info.update = !!(infobits[6] & 2);
473 info.inter_seq = !!(infobits[6] & 4);
474 info.dis_disp = !!(infobits[6] & 8);
475 info.serial = !!(infobits[7] & 1);
476 info.notfound = !!(infobits[8] & 0x10);
477 info.pblf = !!(infobits[9] & 0x20);
479 for (a = 0; a <= 7; a++)
481 if (infobits[a] & 0xf0)
487 if (t->vdau[req->pgbuf].clrfound)
489 if(copy_to_user(req->buffer, &info, sizeof(vtx_pageinfo_t)))
491 if (!info.hamming && !info.notfound)
493 t->is_searching[req->pgbuf] = FALSE;
500 vtx_pagereq_t *req = arg;
503 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS || req->start < 0 ||
504 req->start > req->end || req->end >= (virtual_mode ? VTX_VIRTUALSIZE : VTX_PAGESIZE))
506 if(copy_to_user(req->buffer, &t->vdau[req->pgbuf].pgbuf[req->start], req->end - req->start + 1))
510 * Always read the time directly from SAA5249
513 if (req->start <= 39 && req->end >= 32)
517 start = max(req->start, 32);
518 end = min(req->end, 39);
520 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
521 i2c_getdata(t, len, buf))
523 if(copy_to_user(req->buffer+start-req->start, buf, len))
526 /* Insert the current header if DAU is still searching for a page */
527 if (req->start <= 31 && req->end >= 7 && t->is_searching[req->pgbuf])
531 start = max(req->start, 7);
532 end = min(req->end, 31);
534 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
535 i2c_getdata(t, len, buf))
537 if(copy_to_user(req->buffer+start-req->start, buf, len))
545 vtx_pagereq_t *req = arg;
547 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
549 t->vdau[req->pgbuf].stopped = TRUE;
550 t->is_searching[req->pgbuf] = FALSE;
561 if (i2c_senddata(t, 0, NUM_DAUS, 0, 8, -1) || i2c_senddata(t, 11,
562 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',
563 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ', -1))
565 if (i2c_senddata(t, 3, 0x20, -1))
567 jdelay(10 * CLEAR_DELAY); /* I have no idea how long we have to wait here */
573 /* The SAA5249 has virtual-row reception turned on always */
574 t->virtual_mode = (int)(long)arg;
585 static int saa5249_ioctl(struct inode *inode, struct file *file,
586 unsigned int cmd, unsigned long arg)
588 struct video_device *vd = video_devdata(file);
589 struct saa5249_device *t=vd->priv;
593 err = video_usercopy(inode,file,cmd,arg,do_saa5249_ioctl);
598 static int saa5249_open(struct inode *inode, struct file *file)
600 struct video_device *vd = video_devdata(file);
601 struct saa5249_device *t=vd->priv;
604 err = video_exclusive_open(inode,file);
608 if (t->client==NULL) {
613 if (i2c_senddata(t, 0, 0, -1) || /* Select R11 */
614 /* Turn off parity checks (we do this ourselves) */
615 i2c_senddata(t, 1, disp_modes[t->disp_mode][0], 0, -1) ||
616 /* Display TV-picture, no virtual rows */
617 i2c_senddata(t, 4, NUM_DAUS, disp_modes[t->disp_mode][1], disp_modes[t->disp_mode][2], 7, -1)) /* Set display to page 4 */
624 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++)
626 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
627 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
628 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
629 t->vdau[pgbuf].expire = 0;
630 t->vdau[pgbuf].clrfound = TRUE;
631 t->vdau[pgbuf].stopped = TRUE;
632 t->is_searching[pgbuf] = FALSE;
634 t->virtual_mode=FALSE;
638 video_exclusive_release(inode,file);
644 static int saa5249_release(struct inode *inode, struct file *file)
646 struct video_device *vd = video_devdata(file);
647 struct saa5249_device *t=vd->priv;
648 i2c_senddata(t, 1, 0x20, -1); /* Turn off CCT */
649 i2c_senddata(t, 5, 3, 3, -1); /* Turn off TV-display */
650 video_exclusive_release(inode,file);
654 static int __init init_saa_5249 (void)
656 printk(KERN_INFO "SAA5249 driver (" IF_NAME " interface) for VideoText version %d.%d\n",
657 VTX_VER_MAJ, VTX_VER_MIN);
658 return i2c_add_driver(&i2c_driver_videotext);
661 static void __exit cleanup_saa_5249 (void)
663 i2c_del_driver(&i2c_driver_videotext);
666 module_init(init_saa_5249);
667 module_exit(cleanup_saa_5249);
669 static struct file_operations saa_fops = {
670 .owner = THIS_MODULE,
671 .open = saa5249_open,
672 .release = saa5249_release,
673 .ioctl = saa5249_ioctl,
677 static struct video_device saa_template =
679 .owner = THIS_MODULE,
681 .type = VID_TYPE_TELETEXT, /*| VID_TYPE_TUNER ?? */
682 .hardware = VID_HARDWARE_SAA5249,
686 MODULE_LICENSE("GPL");