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/mutex.h>
50 #include <linux/delay.h>
51 #include <linux/videotext.h>
52 #include <linux/videodev2.h>
53 #include <media/v4l2-device.h>
54 #include <media/v4l2-chip-ident.h>
55 #include <media/v4l2-ioctl.h>
56 #include <media/v4l2-i2c-drv.h>
58 MODULE_AUTHOR("Michael Geng <linux@MichaelGeng.de>");
59 MODULE_DESCRIPTION("Philips SAA5249 Teletext decoder driver");
60 MODULE_LICENSE("GPL");
70 static const int disp_modes[8][3] =
72 { 0x46, 0x03, 0x03 }, /* DISPOFF */
73 { 0x46, 0xcc, 0xcc }, /* DISPNORM */
74 { 0x44, 0x0f, 0x0f }, /* DISPTRANS */
75 { 0x46, 0xcc, 0x46 }, /* DISPINS */
76 { 0x44, 0x03, 0x03 }, /* DISPOFF, interlaced */
77 { 0x44, 0xcc, 0xcc }, /* DISPNORM, interlaced */
78 { 0x44, 0x0f, 0x0f }, /* DISPTRANS, interlaced */
79 { 0x44, 0xcc, 0x46 } /* DISPINS, interlaced */
84 #define PAGE_WAIT msecs_to_jiffies(300) /* Time between requesting page and */
85 /* checking status bits */
86 #define PGBUF_EXPIRE msecs_to_jiffies(15000) /* Time to wait before retransmitting */
87 /* page regardless of infobits */
89 u8 pgbuf[VTX_VIRTUALSIZE]; /* Page-buffer */
90 u8 laststat[10]; /* Last value of infobits for DAU */
91 u8 sregs[7]; /* Page-request registers */
92 unsigned long expire; /* Time when page will be expired */
93 unsigned clrfound : 1; /* VTXIOCCLRFOUND has been called */
94 unsigned stopped : 1; /* VTXIOCSTOPDAU has been called */
99 struct v4l2_subdev sd;
100 struct video_device *vdev;
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 unsigned long in_use;
111 static inline struct saa5249_device *to_dev(struct v4l2_subdev *sd)
113 return container_of(sd, struct saa5249_device, sd);
117 #define CCTWR 34 /* I²C write/read-address of vtx-chip */
119 #define NOACK_REPEAT 10 /* Retry access this many times on failure */
120 #define CLEAR_DELAY msecs_to_jiffies(50) /* Time required to clear a page */
121 #define READY_TIMEOUT msecs_to_jiffies(30) /* Time to wait for ready signal of I2C-bus interface */
122 #define INIT_DELAY 500 /* Time in usec to wait at initialization of CEA interface */
123 #define START_DELAY 10 /* Time in usec to wait before starting write-cycle (CEA) */
125 #define VTX_DEV_MINOR 0
127 static struct video_device saa_template; /* Declared near bottom */
130 * Wait the given number of jiffies (10ms). This calls the scheduler, so the actual
131 * delay may be longer.
134 static void jdelay(unsigned long delay)
136 sigset_t oldblocked = current->blocked;
138 spin_lock_irq(¤t->sighand->siglock);
139 sigfillset(¤t->blocked);
141 spin_unlock_irq(¤t->sighand->siglock);
142 msleep_interruptible(jiffies_to_msecs(delay));
144 spin_lock_irq(¤t->sighand->siglock);
145 current->blocked = oldblocked;
147 spin_unlock_irq(¤t->sighand->siglock);
155 static int i2c_sendbuf(struct saa5249_device *t, int reg, int count, u8 *data)
157 struct i2c_client *client = v4l2_get_subdevdata(&t->sd);
161 memcpy(buf+1, data, count);
163 if (i2c_master_send(client, buf, count + 1) == count + 1)
168 static int i2c_senddata(struct saa5249_device *t, ...)
170 unsigned char buf[64];
176 while ((v = va_arg(argp, int)) != -1)
180 return i2c_sendbuf(t, buf[0], ct-1, buf+1);
183 /* Get count number of bytes from I²C-device at address adr, store them in buf. Start & stop
184 * handshaking is done by this routine, ack will be sent after the last byte to inhibit further
185 * sending of data. If uaccess is 'true', data is written to user-space with put_user.
186 * Returns -1 if I²C-device didn't send acknowledge, 0 otherwise
189 static int i2c_getdata(struct saa5249_device *t, int count, u8 *buf)
191 struct i2c_client *client = v4l2_get_subdevdata(&t->sd);
193 if (i2c_master_recv(client, buf, count) != count)
200 * Standard character-device-driver functions
203 static long do_saa5249_ioctl(struct file *file, unsigned int cmd, void *arg)
205 static int virtual_mode = false;
206 struct saa5249_device *t = video_drvdata(file);
211 vtx_info_t *info = arg;
212 info->version_major = VTX_VER_MAJ;
213 info->version_minor = VTX_VER_MIN;
214 info->numpages = NUM_DAUS;
215 /*info->cct_type = CCT_TYPE;*/
221 vtx_pagereq_t *req = arg;
223 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
225 memset(t->vdau[req->pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
226 t->vdau[req->pgbuf].clrfound = true;
232 vtx_pagereq_t *req = arg;
234 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
236 t->vdau[req->pgbuf].clrfound = true;
242 vtx_pagereq_t *req = arg;
243 if (!(req->pagemask & PGMASK_PAGE))
245 if (!(req->pagemask & PGMASK_HOUR))
247 if (!(req->pagemask & PGMASK_MINUTE))
249 if (req->page < 0 || req->page > 0x8ff) /* 7FF ?? */
252 if (req->hour < 0 || req->hour > 0x3f || req->minute < 0 || req->minute > 0x7f ||
253 req->pagemask < 0 || req->pagemask >= PGMASK_MAX || req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
255 t->vdau[req->pgbuf].sregs[0] = (req->pagemask & PG_HUND ? 0x10 : 0) | (req->page / 0x100);
256 t->vdau[req->pgbuf].sregs[1] = (req->pagemask & PG_TEN ? 0x10 : 0) | ((req->page / 0x10) & 0xf);
257 t->vdau[req->pgbuf].sregs[2] = (req->pagemask & PG_UNIT ? 0x10 : 0) | (req->page & 0xf);
258 t->vdau[req->pgbuf].sregs[3] = (req->pagemask & HR_TEN ? 0x10 : 0) | (req->hour / 0x10);
259 t->vdau[req->pgbuf].sregs[4] = (req->pagemask & HR_UNIT ? 0x10 : 0) | (req->hour & 0xf);
260 t->vdau[req->pgbuf].sregs[5] = (req->pagemask & MIN_TEN ? 0x10 : 0) | (req->minute / 0x10);
261 t->vdau[req->pgbuf].sregs[6] = (req->pagemask & MIN_UNIT ? 0x10 : 0) | (req->minute & 0xf);
262 t->vdau[req->pgbuf].stopped = false;
263 t->vdau[req->pgbuf].clrfound = true;
264 t->is_searching[req->pgbuf] = true;
270 vtx_pagereq_t *req = arg;
275 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
277 if (!t->vdau[req->pgbuf].stopped) {
278 if (i2c_senddata(t, 2, 0, -1) ||
279 i2c_sendbuf(t, 3, sizeof(t->vdau[0].sregs), t->vdau[req->pgbuf].sregs) ||
280 i2c_senddata(t, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
281 i2c_senddata(t, 2, 0, t->vdau[req->pgbuf].sregs[0] | 8, -1) ||
282 i2c_senddata(t, 8, 0, 25, 0, -1))
285 if (i2c_getdata(t, 10, infobits))
288 if (!(infobits[8] & 0x10) && !(infobits[7] & 0xf0) && /* check FOUND-bit */
289 (memcmp(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits)) ||
290 time_after_eq(jiffies, t->vdau[req->pgbuf].expire)))
291 { /* check if new page arrived */
292 if (i2c_senddata(t, 8, 0, 0, 0, -1) ||
293 i2c_getdata(t, VTX_PAGESIZE, t->vdau[req->pgbuf].pgbuf))
295 t->vdau[req->pgbuf].expire = jiffies + PGBUF_EXPIRE;
296 memset(t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE, ' ', VTX_VIRTUALSIZE - VTX_PAGESIZE);
297 if (t->virtual_mode) {
299 if (i2c_senddata(t, 8, 0, 0x20, 0, -1) ||
300 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 20 * 40))
303 if (i2c_senddata(t, 8, 0, 0x21, 0, -1) ||
304 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 16 * 40))
306 /* Packet 8/30/0...8/30/15
307 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
308 * so we should undo this here.
310 if (i2c_senddata(t, 8, 0, 0x22, 0, -1) ||
311 i2c_getdata(t, 40, t->vdau[req->pgbuf].pgbuf + VTX_PAGESIZE + 23 * 40))
314 t->vdau[req->pgbuf].clrfound = false;
315 memcpy(t->vdau[req->pgbuf].laststat, infobits, sizeof(infobits));
317 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
320 memcpy(infobits, t->vdau[req->pgbuf].laststat, sizeof(infobits));
323 info.pagenum = ((infobits[8] << 8) & 0x700) | ((infobits[1] << 4) & 0xf0) | (infobits[0] & 0x0f);
324 if (info.pagenum < 0x100)
325 info.pagenum += 0x800;
326 info.hour = ((infobits[5] << 4) & 0x30) | (infobits[4] & 0x0f);
327 info.minute = ((infobits[3] << 4) & 0x70) | (infobits[2] & 0x0f);
328 info.charset = ((infobits[7] >> 1) & 7);
329 info.delete = !!(infobits[3] & 8);
330 info.headline = !!(infobits[5] & 4);
331 info.subtitle = !!(infobits[5] & 8);
332 info.supp_header = !!(infobits[6] & 1);
333 info.update = !!(infobits[6] & 2);
334 info.inter_seq = !!(infobits[6] & 4);
335 info.dis_disp = !!(infobits[6] & 8);
336 info.serial = !!(infobits[7] & 1);
337 info.notfound = !!(infobits[8] & 0x10);
338 info.pblf = !!(infobits[9] & 0x20);
340 for (a = 0; a <= 7; a++) {
341 if (infobits[a] & 0xf0) {
346 if (t->vdau[req->pgbuf].clrfound)
348 if (copy_to_user(req->buffer, &info, sizeof(vtx_pageinfo_t)))
350 if (!info.hamming && !info.notfound)
351 t->is_searching[req->pgbuf] = false;
357 vtx_pagereq_t *req = arg;
360 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS || req->start < 0 ||
361 req->start > req->end || req->end >= (virtual_mode ? VTX_VIRTUALSIZE : VTX_PAGESIZE))
363 if (copy_to_user(req->buffer, &t->vdau[req->pgbuf].pgbuf[req->start], req->end - req->start + 1))
367 * Always read the time directly from SAA5249
370 if (req->start <= 39 && req->end >= 32) {
373 start = max(req->start, 32);
374 end = min(req->end, 39);
375 len = end - start + 1;
376 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
377 i2c_getdata(t, len, buf))
379 if (copy_to_user(req->buffer + start - req->start, buf, len))
382 /* Insert the current header if DAU is still searching for a page */
383 if (req->start <= 31 && req->end >= 7 && t->is_searching[req->pgbuf]) {
387 start = max(req->start, 7);
388 end = min(req->end, 31);
389 len = end - start + 1;
390 if (i2c_senddata(t, 8, 0, 0, start, -1) ||
391 i2c_getdata(t, len, buf))
393 if (copy_to_user(req->buffer + start - req->start, buf, len))
401 vtx_pagereq_t *req = arg;
403 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
405 t->vdau[req->pgbuf].stopped = true;
406 t->is_searching[req->pgbuf] = false;
417 if (i2c_senddata(t, 0, NUM_DAUS, 0, 8, -1) || i2c_senddata(t, 11,
418 ' ', ' ', ' ', ' ', ' ', ' ',
419 ' ', ' ', ' ', ' ', ' ', ' ',
420 ' ', ' ', ' ', ' ', ' ', ' ',
421 ' ', ' ', ' ', ' ', ' ', ' ',
424 if (i2c_senddata(t, 3, 0x20, -1))
426 jdelay(10 * CLEAR_DELAY); /* I have no idea how long we have to wait here */
432 /* The SAA5249 has virtual-row reception turned on always */
433 t->virtual_mode = (int)(long)arg;
441 * Translates old vtx IOCTLs to new ones
443 * This keeps new kernel versions compatible with old userspace programs.
445 static inline unsigned int vtx_fix_command(unsigned int cmd)
448 case VTXIOCGETINFO_OLD:
451 case VTXIOCCLRPAGE_OLD:
454 case VTXIOCCLRFOUND_OLD:
455 cmd = VTXIOCCLRFOUND;
457 case VTXIOCPAGEREQ_OLD:
460 case VTXIOCGETSTAT_OLD:
463 case VTXIOCGETPAGE_OLD:
466 case VTXIOCSTOPDAU_OLD:
469 case VTXIOCPUTPAGE_OLD:
472 case VTXIOCSETDISP_OLD:
475 case VTXIOCPUTSTAT_OLD:
478 case VTXIOCCLRCACHE_OLD:
479 cmd = VTXIOCCLRCACHE;
481 case VTXIOCSETVIRT_OLD:
492 static long saa5249_ioctl(struct file *file,
493 unsigned int cmd, unsigned long arg)
495 struct saa5249_device *t = video_drvdata(file);
498 cmd = vtx_fix_command(cmd);
499 mutex_lock(&t->lock);
500 err = video_usercopy(file, cmd, arg, do_saa5249_ioctl);
501 mutex_unlock(&t->lock);
505 static int saa5249_open(struct file *file)
507 struct saa5249_device *t = video_drvdata(file);
510 if (test_and_set_bit(0, &t->in_use))
513 if (i2c_senddata(t, 0, 0, -1) || /* Select R11 */
514 /* Turn off parity checks (we do this ourselves) */
515 i2c_senddata(t, 1, disp_modes[t->disp_mode][0], 0, -1) ||
516 /* Display TV-picture, no virtual rows */
517 i2c_senddata(t, 4, NUM_DAUS, disp_modes[t->disp_mode][1], disp_modes[t->disp_mode][2], 7, -1))
518 /* Set display to page 4 */
520 clear_bit(0, &t->in_use);
524 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++) {
525 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
526 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
527 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
528 t->vdau[pgbuf].expire = 0;
529 t->vdau[pgbuf].clrfound = true;
530 t->vdau[pgbuf].stopped = true;
531 t->is_searching[pgbuf] = false;
533 t->virtual_mode = false;
539 static int saa5249_release(struct file *file)
541 struct saa5249_device *t = video_drvdata(file);
543 i2c_senddata(t, 1, 0x20, -1); /* Turn off CCT */
544 i2c_senddata(t, 5, 3, 3, -1); /* Turn off TV-display */
545 clear_bit(0, &t->in_use);
549 static const struct v4l2_file_operations saa_fops = {
550 .owner = THIS_MODULE,
551 .open = saa5249_open,
552 .release = saa5249_release,
553 .ioctl = saa5249_ioctl,
556 static struct video_device saa_template =
560 .release = video_device_release,
563 static int saa5249_g_chip_ident(struct v4l2_subdev *sd, struct v4l2_dbg_chip_ident *chip)
565 struct i2c_client *client = v4l2_get_subdevdata(sd);
567 return v4l2_chip_ident_i2c_client(client, chip, V4L2_IDENT_SAA5249, 0);
570 static const struct v4l2_subdev_core_ops saa5249_core_ops = {
571 .g_chip_ident = saa5249_g_chip_ident,
574 static const struct v4l2_subdev_ops saa5249_ops = {
575 .core = &saa5249_core_ops,
578 static int saa5249_probe(struct i2c_client *client,
579 const struct i2c_device_id *id)
583 struct saa5249_device *t;
584 struct v4l2_subdev *sd;
586 v4l_info(client, "chip found @ 0x%x (%s)\n",
587 client->addr << 1, client->adapter->name);
588 v4l_info(client, "VideoText version %d.%d\n",
589 VTX_VER_MAJ, VTX_VER_MIN);
590 t = kzalloc(sizeof(*t), GFP_KERNEL);
594 v4l2_i2c_subdev_init(sd, client, &saa5249_ops);
595 mutex_init(&t->lock);
597 /* Now create a video4linux device */
598 t->vdev = video_device_alloc();
599 if (t->vdev == NULL) {
604 memcpy(t->vdev, &saa_template, sizeof(*t->vdev));
606 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++) {
607 memset(t->vdau[pgbuf].pgbuf, ' ', sizeof(t->vdau[0].pgbuf));
608 memset(t->vdau[pgbuf].sregs, 0, sizeof(t->vdau[0].sregs));
609 memset(t->vdau[pgbuf].laststat, 0, sizeof(t->vdau[0].laststat));
610 t->vdau[pgbuf].expire = 0;
611 t->vdau[pgbuf].clrfound = true;
612 t->vdau[pgbuf].stopped = true;
613 t->is_searching[pgbuf] = false;
615 video_set_drvdata(t->vdev, t);
618 err = video_register_device(t->vdev, VFL_TYPE_VTX, -1);
620 video_device_release(t->vdev);
627 static int saa5249_remove(struct i2c_client *client)
629 struct v4l2_subdev *sd = i2c_get_clientdata(client);
630 struct saa5249_device *t = to_dev(sd);
632 video_unregister_device(t->vdev);
633 v4l2_device_unregister_subdev(sd);
638 static const struct i2c_device_id saa5249_id[] = {
642 MODULE_DEVICE_TABLE(i2c, saa5249_id);
644 static struct v4l2_i2c_driver_data v4l2_i2c_data = {
646 .probe = saa5249_probe,
647 .remove = saa5249_remove,
648 .id_table = saa5249_id,