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@lxorguk.ukuu.org.uk>
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>
21 * This is a loadable character-device-driver for videotext-interfaces
22 * (aka teletext). Please check the Makefile/README for a list of supported
25 * Copyright (c) 1994-97 Martin Buck <martin-2.buck@student.uni-ulm.de>
28 * This program is free software; you can redistribute it and/or modify
29 * it under the terms of the GNU General Public License as published by
30 * the Free Software Foundation; either version 2 of the License, or
31 * (at your option) any later version.
33 * This program is distributed in the hope that it will be useful,
34 * but WITHOUT ANY WARRANTY; without even the implied warranty of
35 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36 * GNU General Public License for more details.
38 * You should have received a copy of the GNU General Public License
39 * along with this program; if not, write to the Free Software
40 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
44 #include <linux/module.h>
45 #include <linux/kernel.h>
47 #include <linux/init.h>
48 #include <linux/i2c.h>
49 #include <linux/smp_lock.h>
50 #include <linux/mutex.h>
51 #include <linux/delay.h>
52 #include <linux/videotext.h>
53 #include <linux/videodev.h>
54 #include <media/v4l2-common.h>
55 #include <media/v4l2-ioctl.h>
56 #include <media/v4l2-i2c-drv-legacy.h>
58 MODULE_AUTHOR("Michael Geng <linux@MichaelGeng.de>");
59 MODULE_DESCRIPTION("Philips SAA5249 Teletext decoder driver");
60 MODULE_LICENSE("GPL");
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 msecs_to_jiffies(300) /* Time between requesting page and */
84 /* checking status bits */
85 #define PGBUF_EXPIRE msecs_to_jiffies(15000) /* 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 unsigned long in_use;
110 #define CCTWR 34 /* I²C write/read-address of vtx-chip */
112 #define NOACK_REPEAT 10 /* Retry access this many times on failure */
113 #define CLEAR_DELAY msecs_to_jiffies(50) /* Time required to clear a page */
114 #define READY_TIMEOUT msecs_to_jiffies(30) /* Time to wait for ready signal of I2C-bus interface */
115 #define INIT_DELAY 500 /* Time in usec to wait at initialization of CEA interface */
116 #define START_DELAY 10 /* Time in usec to wait before starting write-cycle (CEA) */
118 #define VTX_DEV_MINOR 0
120 static struct video_device saa_template; /* Declared near bottom */
123 * Wait the given number of jiffies (10ms). This calls the scheduler, so the actual
124 * delay may be longer.
127 static void jdelay(unsigned long delay)
129 sigset_t oldblocked = current->blocked;
131 spin_lock_irq(¤t->sighand->siglock);
132 sigfillset(¤t->blocked);
134 spin_unlock_irq(¤t->sighand->siglock);
135 msleep_interruptible(jiffies_to_msecs(delay));
137 spin_lock_irq(¤t->sighand->siglock);
138 current->blocked = oldblocked;
140 spin_unlock_irq(¤t->sighand->siglock);
148 static int i2c_sendbuf(struct saa5249_device *t, int reg, int count, u8 *data)
153 memcpy(buf+1, data, count);
155 if (i2c_master_send(t->client, buf, count + 1) == count + 1)
160 static int i2c_senddata(struct saa5249_device *t, ...)
162 unsigned char buf[64];
168 while ((v = va_arg(argp, int)) != -1)
172 return i2c_sendbuf(t, buf[0], ct-1, buf+1);
175 /* Get count number of bytes from I²C-device at address adr, store them in buf. Start & stop
176 * handshaking is done by this routine, ack will be sent after the last byte to inhibit further
177 * sending of data. If uaccess is 'true', data is written to user-space with put_user.
178 * Returns -1 if I²C-device didn't send acknowledge, 0 otherwise
181 static int i2c_getdata(struct saa5249_device *t, int count, u8 *buf)
183 if(i2c_master_recv(t->client, buf, count)!=count)
190 * Standard character-device-driver functions
193 static long do_saa5249_ioctl(struct file *file, unsigned int cmd, void *arg)
195 static int virtual_mode = false;
196 struct saa5249_device *t = video_drvdata(file);
201 vtx_info_t *info = arg;
202 info->version_major = VTX_VER_MAJ;
203 info->version_minor = VTX_VER_MIN;
204 info->numpages = NUM_DAUS;
205 /*info->cct_type = CCT_TYPE;*/
211 vtx_pagereq_t *req = arg;
213 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
215 memset(t->vdau[req->pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
216 t->vdau[req->pgbuf].clrfound = true;
222 vtx_pagereq_t *req = arg;
224 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
226 t->vdau[req->pgbuf].clrfound = true;
232 vtx_pagereq_t *req = arg;
233 if (!(req->pagemask & PGMASK_PAGE))
235 if (!(req->pagemask & PGMASK_HOUR))
237 if (!(req->pagemask & PGMASK_MINUTE))
239 if (req->page < 0 || req->page > 0x8ff) /* 7FF ?? */
242 if (req->hour < 0 || req->hour > 0x3f || req->minute < 0 || req->minute > 0x7f ||
243 req->pagemask < 0 || req->pagemask >= PGMASK_MAX || req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
245 t->vdau[req->pgbuf].sregs[0] = (req->pagemask & PG_HUND ? 0x10 : 0) | (req->page / 0x100);
246 t->vdau[req->pgbuf].sregs[1] = (req->pagemask & PG_TEN ? 0x10 : 0) | ((req->page / 0x10) & 0xf);
247 t->vdau[req->pgbuf].sregs[2] = (req->pagemask & PG_UNIT ? 0x10 : 0) | (req->page & 0xf);
248 t->vdau[req->pgbuf].sregs[3] = (req->pagemask & HR_TEN ? 0x10 : 0) | (req->hour / 0x10);
249 t->vdau[req->pgbuf].sregs[4] = (req->pagemask & HR_UNIT ? 0x10 : 0) | (req->hour & 0xf);
250 t->vdau[req->pgbuf].sregs[5] = (req->pagemask & MIN_TEN ? 0x10 : 0) | (req->minute / 0x10);
251 t->vdau[req->pgbuf].sregs[6] = (req->pagemask & MIN_UNIT ? 0x10 : 0) | (req->minute & 0xf);
252 t->vdau[req->pgbuf].stopped = false;
253 t->vdau[req->pgbuf].clrfound = true;
254 t->is_searching[req->pgbuf] = true;
260 vtx_pagereq_t *req = arg;
265 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
267 if (!t->vdau[req->pgbuf].stopped) {
268 if (i2c_senddata(t, 2, 0, -1) ||
269 i2c_sendbuf(t, 3, sizeof(t->vdau[0].sregs), t->vdau[req->pgbuf].sregs) ||
270 i2c_senddata(t, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
271 i2c_senddata(t, 2, 0, t->vdau[req->pgbuf].sregs[0] | 8, -1) ||
272 i2c_senddata(t, 8, 0, 25, 0, -1))
275 if (i2c_getdata(t, 10, infobits))
278 if (!(infobits[8] & 0x10) && !(infobits[7] & 0xf0) && /* check FOUND-bit */
279 (memcmp(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits)) ||
280 time_after_eq(jiffies, t->vdau[req->pgbuf].expire)))
281 { /* check if new page arrived */
282 if (i2c_senddata(t, 8, 0, 0, 0, -1) ||
283 i2c_getdata(t, VTX_PAGESIZE, t->vdau[req->pgbuf].pgbuf))
285 t->vdau[req->pgbuf].expire = jiffies + PGBUF_EXPIRE;
286 memset(t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE, ' ', VTX_VIRTUALSIZE - VTX_PAGESIZE);
287 if (t->virtual_mode) {
289 if (i2c_senddata(t, 8, 0, 0x20, 0, -1) ||
290 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 20 * 40))
293 if (i2c_senddata(t, 8, 0, 0x21, 0, -1) ||
294 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 16 * 40))
296 /* Packet 8/30/0...8/30/15
297 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
298 * so we should undo this here.
300 if (i2c_senddata(t, 8, 0, 0x22, 0, -1) ||
301 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 23 * 40))
304 t->vdau[req->pgbuf].clrfound = false;
305 memcpy(t->vdau[req->pgbuf].laststat, infobits, sizeof(infobits));
307 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
310 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
313 info.pagenum = ((infobits[8] << 8) & 0x700) | ((infobits[1] << 4) & 0xf0) | (infobits[0] & 0x0f);
314 if (info.pagenum < 0x100)
315 info.pagenum += 0x800;
316 info.hour = ((infobits[5] << 4) & 0x30) | (infobits[4] & 0x0f);
317 info.minute = ((infobits[3] << 4) & 0x70) | (infobits[2] & 0x0f);
318 info.charset = ((infobits[7] >> 1) & 7);
319 info.delete = !!(infobits[3] & 8);
320 info.headline = !!(infobits[5] & 4);
321 info.subtitle = !!(infobits[5] & 8);
322 info.supp_header = !!(infobits[6] & 1);
323 info.update = !!(infobits[6] & 2);
324 info.inter_seq = !!(infobits[6] & 4);
325 info.dis_disp = !!(infobits[6] & 8);
326 info.serial = !!(infobits[7] & 1);
327 info.notfound = !!(infobits[8] & 0x10);
328 info.pblf = !!(infobits[9] & 0x20);
330 for (a = 0; a <= 7; a++) {
331 if (infobits[a] & 0xf0) {
336 if (t->vdau[req->pgbuf].clrfound)
338 if (copy_to_user(req->buffer, &info, sizeof(vtx_pageinfo_t)))
340 if (!info.hamming && !info.notfound)
341 t->is_searching[req->pgbuf] = false;
347 vtx_pagereq_t *req = arg;
350 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS || req->start < 0 ||
351 req->start > req->end || req->end >= (virtual_mode ? VTX_VIRTUALSIZE : VTX_PAGESIZE))
353 if (copy_to_user(req->buffer, &t->vdau[req->pgbuf].pgbuf[req->start], req->end - req->start + 1))
357 * Always read the time directly from SAA5249
360 if (req->start <= 39 && req->end >= 32) {
363 start = max(req->start, 32);
364 end = min(req->end, 39);
365 len = end - start + 1;
366 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
367 i2c_getdata(t, len, buf))
369 if (copy_to_user(req->buffer + start - req->start, buf, len))
372 /* Insert the current header if DAU is still searching for a page */
373 if (req->start <= 31 && req->end >= 7 && t->is_searching[req->pgbuf]) {
377 start = max(req->start, 7);
378 end = min(req->end, 31);
379 len = end - start + 1;
380 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
381 i2c_getdata(t, len, buf))
383 if (copy_to_user(req->buffer + start - req->start, buf, len))
391 vtx_pagereq_t *req = arg;
393 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
395 t->vdau[req->pgbuf].stopped = true;
396 t->is_searching[req->pgbuf] = false;
407 if (i2c_senddata(t, 0, NUM_DAUS, 0, 8, -1) || i2c_senddata(t, 11,
408 ' ', ' ', ' ', ' ', ' ', ' ',
409 ' ', ' ', ' ', ' ', ' ', ' ',
410 ' ', ' ', ' ', ' ', ' ', ' ',
411 ' ', ' ', ' ', ' ', ' ', ' ',
414 if (i2c_senddata(t, 3, 0x20, -1))
416 jdelay(10 * CLEAR_DELAY); /* I have no idea how long we have to wait here */
422 /* The SAA5249 has virtual-row reception turned on always */
423 t->virtual_mode = (int)(long)arg;
431 * Translates old vtx IOCTLs to new ones
433 * This keeps new kernel versions compatible with old userspace programs.
435 static inline unsigned int vtx_fix_command(unsigned int cmd)
438 case VTXIOCGETINFO_OLD:
441 case VTXIOCCLRPAGE_OLD:
444 case VTXIOCCLRFOUND_OLD:
445 cmd = VTXIOCCLRFOUND;
447 case VTXIOCPAGEREQ_OLD:
450 case VTXIOCGETSTAT_OLD:
453 case VTXIOCGETPAGE_OLD:
456 case VTXIOCSTOPDAU_OLD:
459 case VTXIOCPUTPAGE_OLD:
462 case VTXIOCSETDISP_OLD:
465 case VTXIOCPUTSTAT_OLD:
468 case VTXIOCCLRCACHE_OLD:
469 cmd = VTXIOCCLRCACHE;
471 case VTXIOCSETVIRT_OLD:
482 static long saa5249_ioctl(struct file *file,
483 unsigned int cmd, unsigned long arg)
485 struct saa5249_device *t = video_drvdata(file);
488 cmd = vtx_fix_command(cmd);
489 mutex_lock(&t->lock);
490 err = video_usercopy(file, cmd, arg, do_saa5249_ioctl);
491 mutex_unlock(&t->lock);
495 static int saa5249_open(struct file *file)
497 struct saa5249_device *t = video_drvdata(file);
500 if (t->client == NULL)
503 if (test_and_set_bit(0, &t->in_use))
506 if (i2c_senddata(t, 0, 0, -1) || /* Select R11 */
507 /* Turn off parity checks (we do this ourselves) */
508 i2c_senddata(t, 1, disp_modes[t->disp_mode][0], 0, -1) ||
509 /* Display TV-picture, no virtual rows */
510 i2c_senddata(t, 4, NUM_DAUS, disp_modes[t->disp_mode][1], disp_modes[t->disp_mode][2], 7, -1))
511 /* Set display to page 4 */
513 clear_bit(0, &t->in_use);
517 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++) {
518 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
519 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
520 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
521 t->vdau[pgbuf].expire = 0;
522 t->vdau[pgbuf].clrfound = true;
523 t->vdau[pgbuf].stopped = true;
524 t->is_searching[pgbuf] = false;
526 t->virtual_mode = false;
532 static int saa5249_release(struct file *file)
534 struct saa5249_device *t = video_drvdata(file);
536 i2c_senddata(t, 1, 0x20, -1); /* Turn off CCT */
537 i2c_senddata(t, 5, 3, 3, -1); /* Turn off TV-display */
538 clear_bit(0, &t->in_use);
542 static const struct v4l2_file_operations saa_fops = {
543 .owner = THIS_MODULE,
544 .open = saa5249_open,
545 .release = saa5249_release,
546 .ioctl = saa5249_ioctl,
549 static struct video_device saa_template =
553 .release = video_device_release,
556 /* Addresses to scan */
557 static unsigned short normal_i2c[] = { 0x22 >> 1, I2C_CLIENT_END };
561 static int saa5249_probe(struct i2c_client *client,
562 const struct i2c_device_id *id)
566 struct video_device *vd;
567 struct saa5249_device *t;
569 v4l_info(client, "chip found @ 0x%x (%s)\n",
570 client->addr << 1, client->adapter->name);
571 v4l_info(client, "VideoText version %d.%d\n",
572 VTX_VER_MAJ, VTX_VER_MIN);
573 t = kzalloc(sizeof(*t), GFP_KERNEL);
576 mutex_init(&t->lock);
578 /* Now create a video4linux device */
579 vd = kmalloc(sizeof(struct video_device), GFP_KERNEL);
584 i2c_set_clientdata(client, vd);
585 memcpy(vd, &saa_template, sizeof(*vd));
587 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++) {
588 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
589 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
590 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
591 t->vdau[pgbuf].expire = 0;
592 t->vdau[pgbuf].clrfound = true;
593 t->vdau[pgbuf].stopped = true;
594 t->is_searching[pgbuf] = false;
596 video_set_drvdata(vd, t);
599 err = video_register_device(vd, VFL_TYPE_VTX, -1);
609 static int saa5249_remove(struct i2c_client *client)
611 struct video_device *vd = i2c_get_clientdata(client);
613 video_unregister_device(vd);
614 kfree(video_get_drvdata(vd));
619 static const struct i2c_device_id saa5249_id[] = {
623 MODULE_DEVICE_TABLE(i2c, saa5249_id);
625 static struct v4l2_i2c_driver_data v4l2_i2c_data = {
627 .driverid = I2C_DRIVERID_SAA5249,
628 .probe = saa5249_probe,
629 .remove = saa5249_remove,
630 .id_table = saa5249_id,