2 * Modified in order to keep it compatible both with new and old videotext IOCTLs by
3 * Michael Geng <linux@MichaelGeng.de>
5 * Cleaned up to use existing videodev interface and allow the idea
6 * of multiple teletext decoders on the video4linux iface. Changed i2c
7 * to cover addressing clashes on device busses. It's also rebuilt so
8 * you can add arbitary multiple teletext devices to Linux video4linux
9 * now (well 32 anyway).
11 * Alan Cox <Alan.Cox@linux.org>
13 * The original driver was heavily modified to match the i2c interface
14 * It was truncated to use the WinTV boards, too.
16 * Copyright (c) 1998 Richard Guenther <richard.guenther@student.uni-tuebingen.de>
18 * $Id: saa5249.c,v 1.1 1998/03/30 22:23:23 alan Exp $
23 * This is a loadable character-device-driver for videotext-interfaces
24 * (aka teletext). Please check the Makefile/README for a list of supported
27 * Copyright (c) 1994-97 Martin Buck <martin-2.buck@student.uni-ulm.de>
30 * This program is free software; you can redistribute it and/or modify
31 * it under the terms of the GNU General Public License as published by
32 * the Free Software Foundation; either version 2 of the License, or
33 * (at your option) any later version.
35 * This program is distributed in the hope that it will be useful,
36 * but WITHOUT ANY WARRANTY; without even the implied warranty of
37 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
38 * GNU General Public License for more details.
40 * You should have received a copy of the GNU General Public License
41 * along with this program; if not, write to the Free Software
42 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
46 #include <linux/module.h>
47 #include <linux/kernel.h>
48 #include <linux/sched.h>
50 #include <linux/errno.h>
51 #include <linux/delay.h>
52 #include <linux/ioport.h>
53 #include <linux/slab.h>
54 #include <linux/init.h>
56 #include <linux/i2c.h>
57 #include <linux/videotext.h>
58 #include <linux/videodev.h>
61 #include <asm/uaccess.h>
70 #define IF_NAME "SAA5249"
72 static const int disp_modes[8][3] =
74 { 0x46, 0x03, 0x03 }, /* DISPOFF */
75 { 0x46, 0xcc, 0xcc }, /* DISPNORM */
76 { 0x44, 0x0f, 0x0f }, /* DISPTRANS */
77 { 0x46, 0xcc, 0x46 }, /* DISPINS */
78 { 0x44, 0x03, 0x03 }, /* DISPOFF, interlaced */
79 { 0x44, 0xcc, 0xcc }, /* DISPNORM, interlaced */
80 { 0x44, 0x0f, 0x0f }, /* DISPTRANS, interlaced */
81 { 0x44, 0xcc, 0x46 } /* DISPINS, interlaced */
86 #define PAGE_WAIT (300*HZ/1000) /* Time between requesting page and */
87 /* checking status bits */
88 #define PGBUF_EXPIRE (15*HZ) /* Time to wait before retransmitting */
89 /* page regardless of infobits */
91 u8 pgbuf[VTX_VIRTUALSIZE]; /* Page-buffer */
92 u8 laststat[10]; /* Last value of infobits for DAU */
93 u8 sregs[7]; /* Page-request registers */
94 unsigned long expire; /* Time when page will be expired */
95 unsigned clrfound : 1; /* VTXIOCCLRFOUND has been called */
96 unsigned stopped : 1; /* VTXIOCSTOPDAU has been called */
101 vdau_t vdau[NUM_DAUS]; /* Data for virtual DAUs (the 5249 only has one */
102 /* real DAU, so we have to simulate some more) */
104 int is_searching[NUM_DAUS];
107 struct i2c_client *client;
108 struct semaphore lock;
112 #define CCTWR 34 /* I²C write/read-address of vtx-chip */
114 #define NOACK_REPEAT 10 /* Retry access this many times on failure */
115 #define CLEAR_DELAY (HZ/20) /* Time required to clear a page */
116 #define READY_TIMEOUT (30*HZ/1000) /* Time to wait for ready signal of I²C-bus interface */
117 #define INIT_DELAY 500 /* Time in usec to wait at initialization of CEA interface */
118 #define START_DELAY 10 /* Time in usec to wait before starting write-cycle (CEA) */
120 #define VTX_DEV_MINOR 0
122 /* General defines and debugging support */
129 #define RESCHED do { cond_resched(); } while(0)
131 static struct video_device saa_template; /* Declared near bottom */
133 /* Addresses to scan */
134 static unsigned short normal_i2c[] = {34>>1,I2C_CLIENT_END};
137 static struct i2c_client client_template;
139 static int saa5249_attach(struct i2c_adapter *adap, int addr, int kind)
143 struct i2c_client *client;
144 struct video_device *vd;
145 struct saa5249_device *t;
147 printk(KERN_INFO "saa5249: teletext chip found.\n");
148 client=kmalloc(sizeof(*client), GFP_KERNEL);
151 client_template.adapter = adap;
152 client_template.addr = addr;
153 memcpy(client, &client_template, sizeof(*client));
154 t = kmalloc(sizeof(*t), GFP_KERNEL);
160 memset(t, 0, sizeof(*t));
161 strlcpy(client->name, IF_NAME, I2C_NAME_SIZE);
162 init_MUTEX(&t->lock);
165 * Now create a video4linux device
168 vd = (struct video_device *)kmalloc(sizeof(struct video_device), GFP_KERNEL);
175 i2c_set_clientdata(client, vd);
176 memcpy(vd, &saa_template, sizeof(*vd));
178 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++)
180 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
181 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
182 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
183 t->vdau[pgbuf].expire = 0;
184 t->vdau[pgbuf].clrfound = TRUE;
185 t->vdau[pgbuf].stopped = TRUE;
186 t->is_searching[pgbuf] = FALSE;
195 if((err=video_register_device(vd, VFL_TYPE_VTX,-1))<0)
203 i2c_attach_client(client);
208 * We do most of the hard work when we become a device on the i2c.
211 static int saa5249_probe(struct i2c_adapter *adap)
213 if (adap->class & I2C_CLASS_TV_ANALOG)
214 return i2c_probe(adap, &addr_data, saa5249_attach);
218 static int saa5249_detach(struct i2c_client *client)
220 struct video_device *vd = i2c_get_clientdata(client);
221 i2c_detach_client(client);
222 video_unregister_device(vd);
229 static int saa5249_command(struct i2c_client *device,
230 unsigned int cmd, void *arg)
235 /* new I2C driver support */
237 static struct i2c_driver i2c_driver_videotext =
239 .owner = THIS_MODULE,
240 .name = IF_NAME, /* name */
241 .id = I2C_DRIVERID_SAA5249, /* in i2c.h */
242 .attach_adapter = saa5249_probe,
243 .detach_client = saa5249_detach,
244 .command = saa5249_command
247 static struct i2c_client client_template = {
248 .driver = &i2c_driver_videotext,
253 * Wait the given number of jiffies (10ms). This calls the scheduler, so the actual
254 * delay may be longer.
257 static void jdelay(unsigned long delay)
259 sigset_t oldblocked = current->blocked;
261 spin_lock_irq(¤t->sighand->siglock);
262 sigfillset(¤t->blocked);
264 spin_unlock_irq(¤t->sighand->siglock);
265 msleep_interruptible(jiffies_to_msecs(delay));
267 spin_lock_irq(¤t->sighand->siglock);
268 current->blocked = oldblocked;
270 spin_unlock_irq(¤t->sighand->siglock);
278 static int i2c_sendbuf(struct saa5249_device *t, int reg, int count, u8 *data)
283 memcpy(buf+1, data, count);
285 if(i2c_master_send(t->client, buf, count+1)==count+1)
290 static int i2c_senddata(struct saa5249_device *t, ...)
292 unsigned char buf[64];
298 while((v=va_arg(argp,int))!=-1)
300 return i2c_sendbuf(t, buf[0], ct-1, buf+1);
303 /* Get count number of bytes from I²C-device at address adr, store them in buf. Start & stop
304 * handshaking is done by this routine, ack will be sent after the last byte to inhibit further
305 * sending of data. If uaccess is TRUE, data is written to user-space with put_user.
306 * Returns -1 if I²C-device didn't send acknowledge, 0 otherwise
309 static int i2c_getdata(struct saa5249_device *t, int count, u8 *buf)
311 if(i2c_master_recv(t->client, buf, count)!=count)
318 * Standard character-device-driver functions
321 static int do_saa5249_ioctl(struct inode *inode, struct file *file,
322 unsigned int cmd, void *arg)
324 static int virtual_mode = FALSE;
325 struct video_device *vd = video_devdata(file);
326 struct saa5249_device *t=vd->priv;
332 vtx_info_t *info = arg;
333 info->version_major = VTX_VER_MAJ;
334 info->version_minor = VTX_VER_MIN;
335 info->numpages = NUM_DAUS;
336 /*info->cct_type = CCT_TYPE;*/
342 vtx_pagereq_t *req = arg;
344 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
346 memset(t->vdau[req->pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
347 t->vdau[req->pgbuf].clrfound = TRUE;
353 vtx_pagereq_t *req = arg;
355 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
357 t->vdau[req->pgbuf].clrfound = TRUE;
363 vtx_pagereq_t *req = arg;
364 if (!(req->pagemask & PGMASK_PAGE))
366 if (!(req->pagemask & PGMASK_HOUR))
368 if (!(req->pagemask & PGMASK_MINUTE))
370 if (req->page < 0 || req->page > 0x8ff) /* 7FF ?? */
373 if (req->hour < 0 || req->hour > 0x3f || req->minute < 0 || req->minute > 0x7f ||
374 req->pagemask < 0 || req->pagemask >= PGMASK_MAX || req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
376 t->vdau[req->pgbuf].sregs[0] = (req->pagemask & PG_HUND ? 0x10 : 0) | (req->page / 0x100);
377 t->vdau[req->pgbuf].sregs[1] = (req->pagemask & PG_TEN ? 0x10 : 0) | ((req->page / 0x10) & 0xf);
378 t->vdau[req->pgbuf].sregs[2] = (req->pagemask & PG_UNIT ? 0x10 : 0) | (req->page & 0xf);
379 t->vdau[req->pgbuf].sregs[3] = (req->pagemask & HR_TEN ? 0x10 : 0) | (req->hour / 0x10);
380 t->vdau[req->pgbuf].sregs[4] = (req->pagemask & HR_UNIT ? 0x10 : 0) | (req->hour & 0xf);
381 t->vdau[req->pgbuf].sregs[5] = (req->pagemask & MIN_TEN ? 0x10 : 0) | (req->minute / 0x10);
382 t->vdau[req->pgbuf].sregs[6] = (req->pagemask & MIN_UNIT ? 0x10 : 0) | (req->minute & 0xf);
383 t->vdau[req->pgbuf].stopped = FALSE;
384 t->vdau[req->pgbuf].clrfound = TRUE;
385 t->is_searching[req->pgbuf] = TRUE;
391 vtx_pagereq_t *req = arg;
396 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
398 if (!t->vdau[req->pgbuf].stopped)
400 if (i2c_senddata(t, 2, 0, -1) ||
401 i2c_sendbuf(t, 3, sizeof(t->vdau[0].sregs), t->vdau[req->pgbuf].sregs) ||
402 i2c_senddata(t, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
403 i2c_senddata(t, 2, 0, t->vdau[req->pgbuf].sregs[0] | 8, -1) ||
404 i2c_senddata(t, 8, 0, 25, 0, -1))
407 if (i2c_getdata(t, 10, infobits))
410 if (!(infobits[8] & 0x10) && !(infobits[7] & 0xf0) && /* check FOUND-bit */
411 (memcmp(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits)) ||
412 time_after_eq(jiffies, t->vdau[req->pgbuf].expire)))
413 { /* check if new page arrived */
414 if (i2c_senddata(t, 8, 0, 0, 0, -1) ||
415 i2c_getdata(t, VTX_PAGESIZE, t->vdau[req->pgbuf].pgbuf))
417 t->vdau[req->pgbuf].expire = jiffies + PGBUF_EXPIRE;
418 memset(t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE, ' ', VTX_VIRTUALSIZE - VTX_PAGESIZE);
422 if (i2c_senddata(t, 8, 0, 0x20, 0, -1) ||
423 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 20 * 40))
426 if (i2c_senddata(t, 8, 0, 0x21, 0, -1) ||
427 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 16 * 40))
429 /* Packet 8/30/0...8/30/15
430 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
431 * so we should undo this here.
433 if (i2c_senddata(t, 8, 0, 0x22, 0, -1) ||
434 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 23 * 40))
437 t->vdau[req->pgbuf].clrfound = FALSE;
438 memcpy(t->vdau[req->pgbuf].laststat, infobits, sizeof(infobits));
442 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
447 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
450 info.pagenum = ((infobits[8] << 8) & 0x700) | ((infobits[1] << 4) & 0xf0) | (infobits[0] & 0x0f);
451 if (info.pagenum < 0x100)
452 info.pagenum += 0x800;
453 info.hour = ((infobits[5] << 4) & 0x30) | (infobits[4] & 0x0f);
454 info.minute = ((infobits[3] << 4) & 0x70) | (infobits[2] & 0x0f);
455 info.charset = ((infobits[7] >> 1) & 7);
456 info.delete = !!(infobits[3] & 8);
457 info.headline = !!(infobits[5] & 4);
458 info.subtitle = !!(infobits[5] & 8);
459 info.supp_header = !!(infobits[6] & 1);
460 info.update = !!(infobits[6] & 2);
461 info.inter_seq = !!(infobits[6] & 4);
462 info.dis_disp = !!(infobits[6] & 8);
463 info.serial = !!(infobits[7] & 1);
464 info.notfound = !!(infobits[8] & 0x10);
465 info.pblf = !!(infobits[9] & 0x20);
467 for (a = 0; a <= 7; a++)
469 if (infobits[a] & 0xf0)
475 if (t->vdau[req->pgbuf].clrfound)
477 if(copy_to_user(req->buffer, &info, sizeof(vtx_pageinfo_t)))
479 if (!info.hamming && !info.notfound)
481 t->is_searching[req->pgbuf] = FALSE;
488 vtx_pagereq_t *req = arg;
491 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS || req->start < 0 ||
492 req->start > req->end || req->end >= (virtual_mode ? VTX_VIRTUALSIZE : VTX_PAGESIZE))
494 if(copy_to_user(req->buffer, &t->vdau[req->pgbuf].pgbuf[req->start], req->end - req->start + 1))
498 * Always read the time directly from SAA5249
501 if (req->start <= 39 && req->end >= 32)
505 start = max(req->start, 32);
506 end = min(req->end, 39);
508 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
509 i2c_getdata(t, len, buf))
511 if(copy_to_user(req->buffer+start-req->start, buf, len))
514 /* Insert the current header if DAU is still searching for a page */
515 if (req->start <= 31 && req->end >= 7 && t->is_searching[req->pgbuf])
519 start = max(req->start, 7);
520 end = min(req->end, 31);
522 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
523 i2c_getdata(t, len, buf))
525 if(copy_to_user(req->buffer+start-req->start, buf, len))
533 vtx_pagereq_t *req = arg;
535 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
537 t->vdau[req->pgbuf].stopped = TRUE;
538 t->is_searching[req->pgbuf] = FALSE;
549 if (i2c_senddata(t, 0, NUM_DAUS, 0, 8, -1) || i2c_senddata(t, 11,
550 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',
551 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ', -1))
553 if (i2c_senddata(t, 3, 0x20, -1))
555 jdelay(10 * CLEAR_DELAY); /* I have no idea how long we have to wait here */
561 /* The SAA5249 has virtual-row reception turned on always */
562 t->virtual_mode = (int)(long)arg;
570 * Translates old vtx IOCTLs to new ones
572 * This keeps new kernel versions compatible with old userspace programs.
574 static inline unsigned int vtx_fix_command(unsigned int cmd)
577 case VTXIOCGETINFO_OLD:
580 case VTXIOCCLRPAGE_OLD:
583 case VTXIOCCLRFOUND_OLD:
584 cmd = VTXIOCCLRFOUND;
586 case VTXIOCPAGEREQ_OLD:
589 case VTXIOCGETSTAT_OLD:
592 case VTXIOCGETPAGE_OLD:
595 case VTXIOCSTOPDAU_OLD:
598 case VTXIOCPUTPAGE_OLD:
601 case VTXIOCSETDISP_OLD:
604 case VTXIOCPUTSTAT_OLD:
607 case VTXIOCCLRCACHE_OLD:
608 cmd = VTXIOCCLRCACHE;
610 case VTXIOCSETVIRT_OLD:
621 static int saa5249_ioctl(struct inode *inode, struct file *file,
622 unsigned int cmd, unsigned long arg)
624 struct video_device *vd = video_devdata(file);
625 struct saa5249_device *t=vd->priv;
628 cmd = vtx_fix_command(cmd);
630 err = video_usercopy(inode,file,cmd,arg,do_saa5249_ioctl);
635 static int saa5249_open(struct inode *inode, struct file *file)
637 struct video_device *vd = video_devdata(file);
638 struct saa5249_device *t=vd->priv;
641 err = video_exclusive_open(inode,file);
645 if (t->client==NULL) {
650 if (i2c_senddata(t, 0, 0, -1) || /* Select R11 */
651 /* Turn off parity checks (we do this ourselves) */
652 i2c_senddata(t, 1, disp_modes[t->disp_mode][0], 0, -1) ||
653 /* Display TV-picture, no virtual rows */
654 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 */
661 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++)
663 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
664 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
665 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
666 t->vdau[pgbuf].expire = 0;
667 t->vdau[pgbuf].clrfound = TRUE;
668 t->vdau[pgbuf].stopped = TRUE;
669 t->is_searching[pgbuf] = FALSE;
671 t->virtual_mode=FALSE;
675 video_exclusive_release(inode,file);
681 static int saa5249_release(struct inode *inode, struct file *file)
683 struct video_device *vd = video_devdata(file);
684 struct saa5249_device *t=vd->priv;
685 i2c_senddata(t, 1, 0x20, -1); /* Turn off CCT */
686 i2c_senddata(t, 5, 3, 3, -1); /* Turn off TV-display */
687 video_exclusive_release(inode,file);
691 static int __init init_saa_5249 (void)
693 printk(KERN_INFO "SAA5249 driver (" IF_NAME " interface) for VideoText version %d.%d\n",
694 VTX_VER_MAJ, VTX_VER_MIN);
695 return i2c_add_driver(&i2c_driver_videotext);
698 static void __exit cleanup_saa_5249 (void)
700 i2c_del_driver(&i2c_driver_videotext);
703 module_init(init_saa_5249);
704 module_exit(cleanup_saa_5249);
706 static struct file_operations saa_fops = {
707 .owner = THIS_MODULE,
708 .open = saa5249_open,
709 .release = saa5249_release,
710 .ioctl = saa5249_ioctl,
714 static struct video_device saa_template =
716 .owner = THIS_MODULE,
718 .type = VID_TYPE_TELETEXT, /*| VID_TYPE_TUNER ?? */
719 .hardware = VID_HARDWARE_SAA5249,
723 MODULE_LICENSE("GPL");