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>
59 #include <media/v4l2-common.h>
60 #include <linux/mutex.h>
64 #include <asm/uaccess.h>
73 #define IF_NAME "SAA5249"
75 static const int disp_modes[8][3] =
77 { 0x46, 0x03, 0x03 }, /* DISPOFF */
78 { 0x46, 0xcc, 0xcc }, /* DISPNORM */
79 { 0x44, 0x0f, 0x0f }, /* DISPTRANS */
80 { 0x46, 0xcc, 0x46 }, /* DISPINS */
81 { 0x44, 0x03, 0x03 }, /* DISPOFF, interlaced */
82 { 0x44, 0xcc, 0xcc }, /* DISPNORM, interlaced */
83 { 0x44, 0x0f, 0x0f }, /* DISPTRANS, interlaced */
84 { 0x44, 0xcc, 0x46 } /* DISPINS, interlaced */
89 #define PAGE_WAIT msecs_to_jiffies(300) /* Time between requesting page and */
90 /* checking status bits */
91 #define PGBUF_EXPIRE msecs_to_jiffies(15000) /* Time to wait before retransmitting */
92 /* page regardless of infobits */
94 u8 pgbuf[VTX_VIRTUALSIZE]; /* Page-buffer */
95 u8 laststat[10]; /* Last value of infobits for DAU */
96 u8 sregs[7]; /* Page-request registers */
97 unsigned long expire; /* Time when page will be expired */
98 unsigned clrfound : 1; /* VTXIOCCLRFOUND has been called */
99 unsigned stopped : 1; /* VTXIOCSTOPDAU has been called */
102 struct saa5249_device
104 vdau_t vdau[NUM_DAUS]; /* Data for virtual DAUs (the 5249 only has one */
105 /* real DAU, so we have to simulate some more) */
107 int is_searching[NUM_DAUS];
110 struct i2c_client *client;
115 #define CCTWR 34 /* I²C write/read-address of vtx-chip */
117 #define NOACK_REPEAT 10 /* Retry access this many times on failure */
118 #define CLEAR_DELAY msecs_to_jiffies(50) /* Time required to clear a page */
119 #define READY_TIMEOUT msecs_to_jiffies(30) /* Time to wait for ready signal of I2C-bus interface */
120 #define INIT_DELAY 500 /* Time in usec to wait at initialization of CEA interface */
121 #define START_DELAY 10 /* Time in usec to wait before starting write-cycle (CEA) */
123 #define VTX_DEV_MINOR 0
125 /* General defines and debugging support */
127 #define RESCHED do { cond_resched(); } while(0)
129 static struct video_device saa_template; /* Declared near bottom */
131 /* Addresses to scan */
132 static unsigned short normal_i2c[] = {34>>1,I2C_CLIENT_END};
135 static struct i2c_client client_template;
137 static int saa5249_attach(struct i2c_adapter *adap, int addr, int kind)
141 struct i2c_client *client;
142 struct video_device *vd;
143 struct saa5249_device *t;
145 printk(KERN_INFO "saa5249: teletext chip found.\n");
146 client=kmalloc(sizeof(*client), GFP_KERNEL);
149 client_template.adapter = adap;
150 client_template.addr = addr;
151 memcpy(client, &client_template, sizeof(*client));
152 t = kzalloc(sizeof(*t), GFP_KERNEL);
158 strlcpy(client->name, IF_NAME, I2C_NAME_SIZE);
159 mutex_init(&t->lock);
162 * Now create a video4linux device
165 vd = kmalloc(sizeof(struct video_device), GFP_KERNEL);
172 i2c_set_clientdata(client, vd);
173 memcpy(vd, &saa_template, sizeof(*vd));
175 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++)
177 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
178 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
179 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
180 t->vdau[pgbuf].expire = 0;
181 t->vdau[pgbuf].clrfound = true;
182 t->vdau[pgbuf].stopped = true;
183 t->is_searching[pgbuf] = false;
192 if((err=video_register_device(vd, VFL_TYPE_VTX,-1))<0)
200 i2c_attach_client(client);
205 * We do most of the hard work when we become a device on the i2c.
208 static int saa5249_probe(struct i2c_adapter *adap)
210 if (adap->class & I2C_CLASS_TV_ANALOG)
211 return i2c_probe(adap, &addr_data, saa5249_attach);
215 static int saa5249_detach(struct i2c_client *client)
217 struct video_device *vd = i2c_get_clientdata(client);
218 i2c_detach_client(client);
219 video_unregister_device(vd);
226 /* new I2C driver support */
228 static struct i2c_driver i2c_driver_videotext =
231 .name = IF_NAME, /* name */
233 .id = I2C_DRIVERID_SAA5249, /* in i2c.h */
234 .attach_adapter = saa5249_probe,
235 .detach_client = saa5249_detach,
238 static struct i2c_client client_template = {
239 .driver = &i2c_driver_videotext,
244 * Wait the given number of jiffies (10ms). This calls the scheduler, so the actual
245 * delay may be longer.
248 static void jdelay(unsigned long delay)
250 sigset_t oldblocked = current->blocked;
252 spin_lock_irq(¤t->sighand->siglock);
253 sigfillset(¤t->blocked);
255 spin_unlock_irq(¤t->sighand->siglock);
256 msleep_interruptible(jiffies_to_msecs(delay));
258 spin_lock_irq(¤t->sighand->siglock);
259 current->blocked = oldblocked;
261 spin_unlock_irq(¤t->sighand->siglock);
269 static int i2c_sendbuf(struct saa5249_device *t, int reg, int count, u8 *data)
274 memcpy(buf+1, data, count);
276 if(i2c_master_send(t->client, buf, count+1)==count+1)
281 static int i2c_senddata(struct saa5249_device *t, ...)
283 unsigned char buf[64];
289 while((v=va_arg(argp,int))!=-1)
291 return i2c_sendbuf(t, buf[0], ct-1, buf+1);
294 /* Get count number of bytes from I²C-device at address adr, store them in buf. Start & stop
295 * handshaking is done by this routine, ack will be sent after the last byte to inhibit further
296 * sending of data. If uaccess is 'true', data is written to user-space with put_user.
297 * Returns -1 if I²C-device didn't send acknowledge, 0 otherwise
300 static int i2c_getdata(struct saa5249_device *t, int count, u8 *buf)
302 if(i2c_master_recv(t->client, buf, count)!=count)
309 * Standard character-device-driver functions
312 static int do_saa5249_ioctl(struct inode *inode, struct file *file,
313 unsigned int cmd, void *arg)
315 static int virtual_mode = false;
316 struct video_device *vd = video_devdata(file);
317 struct saa5249_device *t=vd->priv;
323 vtx_info_t *info = arg;
324 info->version_major = VTX_VER_MAJ;
325 info->version_minor = VTX_VER_MIN;
326 info->numpages = NUM_DAUS;
327 /*info->cct_type = CCT_TYPE;*/
333 vtx_pagereq_t *req = arg;
335 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
337 memset(t->vdau[req->pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
338 t->vdau[req->pgbuf].clrfound = true;
344 vtx_pagereq_t *req = arg;
346 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
348 t->vdau[req->pgbuf].clrfound = true;
354 vtx_pagereq_t *req = arg;
355 if (!(req->pagemask & PGMASK_PAGE))
357 if (!(req->pagemask & PGMASK_HOUR))
359 if (!(req->pagemask & PGMASK_MINUTE))
361 if (req->page < 0 || req->page > 0x8ff) /* 7FF ?? */
364 if (req->hour < 0 || req->hour > 0x3f || req->minute < 0 || req->minute > 0x7f ||
365 req->pagemask < 0 || req->pagemask >= PGMASK_MAX || req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
367 t->vdau[req->pgbuf].sregs[0] = (req->pagemask & PG_HUND ? 0x10 : 0) | (req->page / 0x100);
368 t->vdau[req->pgbuf].sregs[1] = (req->pagemask & PG_TEN ? 0x10 : 0) | ((req->page / 0x10) & 0xf);
369 t->vdau[req->pgbuf].sregs[2] = (req->pagemask & PG_UNIT ? 0x10 : 0) | (req->page & 0xf);
370 t->vdau[req->pgbuf].sregs[3] = (req->pagemask & HR_TEN ? 0x10 : 0) | (req->hour / 0x10);
371 t->vdau[req->pgbuf].sregs[4] = (req->pagemask & HR_UNIT ? 0x10 : 0) | (req->hour & 0xf);
372 t->vdau[req->pgbuf].sregs[5] = (req->pagemask & MIN_TEN ? 0x10 : 0) | (req->minute / 0x10);
373 t->vdau[req->pgbuf].sregs[6] = (req->pagemask & MIN_UNIT ? 0x10 : 0) | (req->minute & 0xf);
374 t->vdau[req->pgbuf].stopped = false;
375 t->vdau[req->pgbuf].clrfound = true;
376 t->is_searching[req->pgbuf] = true;
382 vtx_pagereq_t *req = arg;
387 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
389 if (!t->vdau[req->pgbuf].stopped)
391 if (i2c_senddata(t, 2, 0, -1) ||
392 i2c_sendbuf(t, 3, sizeof(t->vdau[0].sregs), t->vdau[req->pgbuf].sregs) ||
393 i2c_senddata(t, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
394 i2c_senddata(t, 2, 0, t->vdau[req->pgbuf].sregs[0] | 8, -1) ||
395 i2c_senddata(t, 8, 0, 25, 0, -1))
398 if (i2c_getdata(t, 10, infobits))
401 if (!(infobits[8] & 0x10) && !(infobits[7] & 0xf0) && /* check FOUND-bit */
402 (memcmp(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits)) ||
403 time_after_eq(jiffies, t->vdau[req->pgbuf].expire)))
404 { /* check if new page arrived */
405 if (i2c_senddata(t, 8, 0, 0, 0, -1) ||
406 i2c_getdata(t, VTX_PAGESIZE, t->vdau[req->pgbuf].pgbuf))
408 t->vdau[req->pgbuf].expire = jiffies + PGBUF_EXPIRE;
409 memset(t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE, ' ', VTX_VIRTUALSIZE - VTX_PAGESIZE);
413 if (i2c_senddata(t, 8, 0, 0x20, 0, -1) ||
414 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 20 * 40))
417 if (i2c_senddata(t, 8, 0, 0x21, 0, -1) ||
418 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 16 * 40))
420 /* Packet 8/30/0...8/30/15
421 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
422 * so we should undo this here.
424 if (i2c_senddata(t, 8, 0, 0x22, 0, -1) ||
425 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 23 * 40))
428 t->vdau[req->pgbuf].clrfound = false;
429 memcpy(t->vdau[req->pgbuf].laststat, infobits, sizeof(infobits));
433 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
438 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
441 info.pagenum = ((infobits[8] << 8) & 0x700) | ((infobits[1] << 4) & 0xf0) | (infobits[0] & 0x0f);
442 if (info.pagenum < 0x100)
443 info.pagenum += 0x800;
444 info.hour = ((infobits[5] << 4) & 0x30) | (infobits[4] & 0x0f);
445 info.minute = ((infobits[3] << 4) & 0x70) | (infobits[2] & 0x0f);
446 info.charset = ((infobits[7] >> 1) & 7);
447 info.delete = !!(infobits[3] & 8);
448 info.headline = !!(infobits[5] & 4);
449 info.subtitle = !!(infobits[5] & 8);
450 info.supp_header = !!(infobits[6] & 1);
451 info.update = !!(infobits[6] & 2);
452 info.inter_seq = !!(infobits[6] & 4);
453 info.dis_disp = !!(infobits[6] & 8);
454 info.serial = !!(infobits[7] & 1);
455 info.notfound = !!(infobits[8] & 0x10);
456 info.pblf = !!(infobits[9] & 0x20);
458 for (a = 0; a <= 7; a++)
460 if (infobits[a] & 0xf0)
466 if (t->vdau[req->pgbuf].clrfound)
468 if(copy_to_user(req->buffer, &info, sizeof(vtx_pageinfo_t)))
470 if (!info.hamming && !info.notfound)
472 t->is_searching[req->pgbuf] = false;
479 vtx_pagereq_t *req = arg;
482 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS || req->start < 0 ||
483 req->start > req->end || req->end >= (virtual_mode ? VTX_VIRTUALSIZE : VTX_PAGESIZE))
485 if(copy_to_user(req->buffer, &t->vdau[req->pgbuf].pgbuf[req->start], req->end - req->start + 1))
489 * Always read the time directly from SAA5249
492 if (req->start <= 39 && req->end >= 32)
496 start = max(req->start, 32);
497 end = min(req->end, 39);
499 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
500 i2c_getdata(t, len, buf))
502 if(copy_to_user(req->buffer+start-req->start, buf, len))
505 /* Insert the current header if DAU is still searching for a page */
506 if (req->start <= 31 && req->end >= 7 && t->is_searching[req->pgbuf])
510 start = max(req->start, 7);
511 end = min(req->end, 31);
513 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
514 i2c_getdata(t, len, buf))
516 if(copy_to_user(req->buffer+start-req->start, buf, len))
524 vtx_pagereq_t *req = arg;
526 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
528 t->vdau[req->pgbuf].stopped = true;
529 t->is_searching[req->pgbuf] = false;
540 if (i2c_senddata(t, 0, NUM_DAUS, 0, 8, -1) || i2c_senddata(t, 11,
541 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',
542 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ', -1))
544 if (i2c_senddata(t, 3, 0x20, -1))
546 jdelay(10 * CLEAR_DELAY); /* I have no idea how long we have to wait here */
552 /* The SAA5249 has virtual-row reception turned on always */
553 t->virtual_mode = (int)(long)arg;
561 * Translates old vtx IOCTLs to new ones
563 * This keeps new kernel versions compatible with old userspace programs.
565 static inline unsigned int vtx_fix_command(unsigned int cmd)
568 case VTXIOCGETINFO_OLD:
571 case VTXIOCCLRPAGE_OLD:
574 case VTXIOCCLRFOUND_OLD:
575 cmd = VTXIOCCLRFOUND;
577 case VTXIOCPAGEREQ_OLD:
580 case VTXIOCGETSTAT_OLD:
583 case VTXIOCGETPAGE_OLD:
586 case VTXIOCSTOPDAU_OLD:
589 case VTXIOCPUTPAGE_OLD:
592 case VTXIOCSETDISP_OLD:
595 case VTXIOCPUTSTAT_OLD:
598 case VTXIOCCLRCACHE_OLD:
599 cmd = VTXIOCCLRCACHE;
601 case VTXIOCSETVIRT_OLD:
612 static int saa5249_ioctl(struct inode *inode, struct file *file,
613 unsigned int cmd, unsigned long arg)
615 struct video_device *vd = video_devdata(file);
616 struct saa5249_device *t=vd->priv;
619 cmd = vtx_fix_command(cmd);
620 mutex_lock(&t->lock);
621 err = video_usercopy(inode,file,cmd,arg,do_saa5249_ioctl);
622 mutex_unlock(&t->lock);
626 static int saa5249_open(struct inode *inode, struct file *file)
628 struct video_device *vd = video_devdata(file);
629 struct saa5249_device *t=vd->priv;
632 err = video_exclusive_open(inode,file);
636 if (t->client==NULL) {
641 if (i2c_senddata(t, 0, 0, -1) || /* Select R11 */
642 /* Turn off parity checks (we do this ourselves) */
643 i2c_senddata(t, 1, disp_modes[t->disp_mode][0], 0, -1) ||
644 /* Display TV-picture, no virtual rows */
645 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 */
652 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++)
654 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
655 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
656 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
657 t->vdau[pgbuf].expire = 0;
658 t->vdau[pgbuf].clrfound = true;
659 t->vdau[pgbuf].stopped = true;
660 t->is_searching[pgbuf] = false;
662 t->virtual_mode = false;
666 video_exclusive_release(inode,file);
672 static int saa5249_release(struct inode *inode, struct file *file)
674 struct video_device *vd = video_devdata(file);
675 struct saa5249_device *t=vd->priv;
676 i2c_senddata(t, 1, 0x20, -1); /* Turn off CCT */
677 i2c_senddata(t, 5, 3, 3, -1); /* Turn off TV-display */
678 video_exclusive_release(inode,file);
682 static int __init init_saa_5249 (void)
684 printk(KERN_INFO "SAA5249 driver (" IF_NAME " interface) for VideoText version %d.%d\n",
685 VTX_VER_MAJ, VTX_VER_MIN);
686 return i2c_add_driver(&i2c_driver_videotext);
689 static void __exit cleanup_saa_5249 (void)
691 i2c_del_driver(&i2c_driver_videotext);
694 module_init(init_saa_5249);
695 module_exit(cleanup_saa_5249);
697 static const struct file_operations saa_fops = {
698 .owner = THIS_MODULE,
699 .open = saa5249_open,
700 .release = saa5249_release,
701 .ioctl = saa5249_ioctl,
702 .compat_ioctl = v4l_compat_ioctl32,
706 static struct video_device saa_template =
708 .owner = THIS_MODULE,
710 .type = VID_TYPE_TELETEXT, /*| VID_TYPE_TUNER ?? */
714 MODULE_LICENSE("GPL");