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>
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 int do_saa5249_ioctl(struct inode
*inode
, struct file
*file
,
194 unsigned int cmd
, void *arg
)
196 static int virtual_mode
= false;
197 struct saa5249_device
*t
= video_drvdata(file
);
202 vtx_info_t
*info
= arg
;
203 info
->version_major
= VTX_VER_MAJ
;
204 info
->version_minor
= VTX_VER_MIN
;
205 info
->numpages
= NUM_DAUS
;
206 /*info->cct_type = CCT_TYPE;*/
212 vtx_pagereq_t
*req
= arg
;
214 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
216 memset(t
->vdau
[req
->pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
217 t
->vdau
[req
->pgbuf
].clrfound
= true;
223 vtx_pagereq_t
*req
= arg
;
225 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
227 t
->vdau
[req
->pgbuf
].clrfound
= true;
233 vtx_pagereq_t
*req
= arg
;
234 if (!(req
->pagemask
& PGMASK_PAGE
))
236 if (!(req
->pagemask
& PGMASK_HOUR
))
238 if (!(req
->pagemask
& PGMASK_MINUTE
))
240 if (req
->page
< 0 || req
->page
> 0x8ff) /* 7FF ?? */
243 if (req
->hour
< 0 || req
->hour
> 0x3f || req
->minute
< 0 || req
->minute
> 0x7f ||
244 req
->pagemask
< 0 || req
->pagemask
>= PGMASK_MAX
|| req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
246 t
->vdau
[req
->pgbuf
].sregs
[0] = (req
->pagemask
& PG_HUND
? 0x10 : 0) | (req
->page
/ 0x100);
247 t
->vdau
[req
->pgbuf
].sregs
[1] = (req
->pagemask
& PG_TEN
? 0x10 : 0) | ((req
->page
/ 0x10) & 0xf);
248 t
->vdau
[req
->pgbuf
].sregs
[2] = (req
->pagemask
& PG_UNIT
? 0x10 : 0) | (req
->page
& 0xf);
249 t
->vdau
[req
->pgbuf
].sregs
[3] = (req
->pagemask
& HR_TEN
? 0x10 : 0) | (req
->hour
/ 0x10);
250 t
->vdau
[req
->pgbuf
].sregs
[4] = (req
->pagemask
& HR_UNIT
? 0x10 : 0) | (req
->hour
& 0xf);
251 t
->vdau
[req
->pgbuf
].sregs
[5] = (req
->pagemask
& MIN_TEN
? 0x10 : 0) | (req
->minute
/ 0x10);
252 t
->vdau
[req
->pgbuf
].sregs
[6] = (req
->pagemask
& MIN_UNIT
? 0x10 : 0) | (req
->minute
& 0xf);
253 t
->vdau
[req
->pgbuf
].stopped
= false;
254 t
->vdau
[req
->pgbuf
].clrfound
= true;
255 t
->is_searching
[req
->pgbuf
] = true;
261 vtx_pagereq_t
*req
= arg
;
266 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
268 if (!t
->vdau
[req
->pgbuf
].stopped
) {
269 if (i2c_senddata(t
, 2, 0, -1) ||
270 i2c_sendbuf(t
, 3, sizeof(t
->vdau
[0].sregs
), t
->vdau
[req
->pgbuf
].sregs
) ||
271 i2c_senddata(t
, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
272 i2c_senddata(t
, 2, 0, t
->vdau
[req
->pgbuf
].sregs
[0] | 8, -1) ||
273 i2c_senddata(t
, 8, 0, 25, 0, -1))
276 if (i2c_getdata(t
, 10, infobits
))
279 if (!(infobits
[8] & 0x10) && !(infobits
[7] & 0xf0) && /* check FOUND-bit */
280 (memcmp(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
)) ||
281 time_after_eq(jiffies
, t
->vdau
[req
->pgbuf
].expire
)))
282 { /* check if new page arrived */
283 if (i2c_senddata(t
, 8, 0, 0, 0, -1) ||
284 i2c_getdata(t
, VTX_PAGESIZE
, t
->vdau
[req
->pgbuf
].pgbuf
))
286 t
->vdau
[req
->pgbuf
].expire
= jiffies
+ PGBUF_EXPIRE
;
287 memset(t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
, ' ', VTX_VIRTUALSIZE
- VTX_PAGESIZE
);
288 if (t
->virtual_mode
) {
290 if (i2c_senddata(t
, 8, 0, 0x20, 0, -1) ||
291 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 20 * 40))
294 if (i2c_senddata(t
, 8, 0, 0x21, 0, -1) ||
295 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 16 * 40))
297 /* Packet 8/30/0...8/30/15
298 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
299 * so we should undo this here.
301 if (i2c_senddata(t
, 8, 0, 0x22, 0, -1) ||
302 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 23 * 40))
305 t
->vdau
[req
->pgbuf
].clrfound
= false;
306 memcpy(t
->vdau
[req
->pgbuf
].laststat
, infobits
, sizeof(infobits
));
308 memcpy(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
));
311 memcpy(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
));
314 info
.pagenum
= ((infobits
[8] << 8) & 0x700) | ((infobits
[1] << 4) & 0xf0) | (infobits
[0] & 0x0f);
315 if (info
.pagenum
< 0x100)
316 info
.pagenum
+= 0x800;
317 info
.hour
= ((infobits
[5] << 4) & 0x30) | (infobits
[4] & 0x0f);
318 info
.minute
= ((infobits
[3] << 4) & 0x70) | (infobits
[2] & 0x0f);
319 info
.charset
= ((infobits
[7] >> 1) & 7);
320 info
.delete = !!(infobits
[3] & 8);
321 info
.headline
= !!(infobits
[5] & 4);
322 info
.subtitle
= !!(infobits
[5] & 8);
323 info
.supp_header
= !!(infobits
[6] & 1);
324 info
.update
= !!(infobits
[6] & 2);
325 info
.inter_seq
= !!(infobits
[6] & 4);
326 info
.dis_disp
= !!(infobits
[6] & 8);
327 info
.serial
= !!(infobits
[7] & 1);
328 info
.notfound
= !!(infobits
[8] & 0x10);
329 info
.pblf
= !!(infobits
[9] & 0x20);
331 for (a
= 0; a
<= 7; a
++) {
332 if (infobits
[a
] & 0xf0) {
337 if (t
->vdau
[req
->pgbuf
].clrfound
)
339 if (copy_to_user(req
->buffer
, &info
, sizeof(vtx_pageinfo_t
)))
341 if (!info
.hamming
&& !info
.notfound
)
342 t
->is_searching
[req
->pgbuf
] = false;
348 vtx_pagereq_t
*req
= arg
;
351 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
|| req
->start
< 0 ||
352 req
->start
> req
->end
|| req
->end
>= (virtual_mode
? VTX_VIRTUALSIZE
: VTX_PAGESIZE
))
354 if (copy_to_user(req
->buffer
, &t
->vdau
[req
->pgbuf
].pgbuf
[req
->start
], req
->end
- req
->start
+ 1))
358 * Always read the time directly from SAA5249
361 if (req
->start
<= 39 && req
->end
>= 32) {
364 start
= max(req
->start
, 32);
365 end
= min(req
->end
, 39);
366 len
= end
- start
+ 1;
367 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
368 i2c_getdata(t
, len
, buf
))
370 if (copy_to_user(req
->buffer
+ start
- req
->start
, buf
, len
))
373 /* Insert the current header if DAU is still searching for a page */
374 if (req
->start
<= 31 && req
->end
>= 7 && t
->is_searching
[req
->pgbuf
]) {
378 start
= max(req
->start
, 7);
379 end
= min(req
->end
, 31);
380 len
= end
- start
+ 1;
381 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
382 i2c_getdata(t
, len
, buf
))
384 if (copy_to_user(req
->buffer
+ start
- req
->start
, buf
, len
))
392 vtx_pagereq_t
*req
= arg
;
394 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
396 t
->vdau
[req
->pgbuf
].stopped
= true;
397 t
->is_searching
[req
->pgbuf
] = false;
408 if (i2c_senddata(t
, 0, NUM_DAUS
, 0, 8, -1) || i2c_senddata(t
, 11,
409 ' ', ' ', ' ', ' ', ' ', ' ',
410 ' ', ' ', ' ', ' ', ' ', ' ',
411 ' ', ' ', ' ', ' ', ' ', ' ',
412 ' ', ' ', ' ', ' ', ' ', ' ',
415 if (i2c_senddata(t
, 3, 0x20, -1))
417 jdelay(10 * CLEAR_DELAY
); /* I have no idea how long we have to wait here */
423 /* The SAA5249 has virtual-row reception turned on always */
424 t
->virtual_mode
= (int)(long)arg
;
432 * Translates old vtx IOCTLs to new ones
434 * This keeps new kernel versions compatible with old userspace programs.
436 static inline unsigned int vtx_fix_command(unsigned int cmd
)
439 case VTXIOCGETINFO_OLD
:
442 case VTXIOCCLRPAGE_OLD
:
445 case VTXIOCCLRFOUND_OLD
:
446 cmd
= VTXIOCCLRFOUND
;
448 case VTXIOCPAGEREQ_OLD
:
451 case VTXIOCGETSTAT_OLD
:
454 case VTXIOCGETPAGE_OLD
:
457 case VTXIOCSTOPDAU_OLD
:
460 case VTXIOCPUTPAGE_OLD
:
463 case VTXIOCSETDISP_OLD
:
466 case VTXIOCPUTSTAT_OLD
:
469 case VTXIOCCLRCACHE_OLD
:
470 cmd
= VTXIOCCLRCACHE
;
472 case VTXIOCSETVIRT_OLD
:
483 static int saa5249_ioctl(struct inode
*inode
, struct file
*file
,
484 unsigned int cmd
, unsigned long arg
)
486 struct saa5249_device
*t
= video_drvdata(file
);
489 cmd
= vtx_fix_command(cmd
);
490 mutex_lock(&t
->lock
);
491 err
= video_usercopy(inode
,file
,cmd
,arg
,do_saa5249_ioctl
);
492 mutex_unlock(&t
->lock
);
496 static int saa5249_open(struct inode
*inode
, struct file
*file
)
498 struct saa5249_device
*t
= video_drvdata(file
);
501 if (t
->client
== NULL
)
504 if (test_and_set_bit(0, &t
->in_use
))
507 if (i2c_senddata(t
, 0, 0, -1) || /* Select R11 */
508 /* Turn off parity checks (we do this ourselves) */
509 i2c_senddata(t
, 1, disp_modes
[t
->disp_mode
][0], 0, -1) ||
510 /* Display TV-picture, no virtual rows */
511 i2c_senddata(t
, 4, NUM_DAUS
, disp_modes
[t
->disp_mode
][1], disp_modes
[t
->disp_mode
][2], 7, -1))
512 /* Set display to page 4 */
514 clear_bit(0, &t
->in_use
);
518 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++) {
519 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
520 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
521 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
522 t
->vdau
[pgbuf
].expire
= 0;
523 t
->vdau
[pgbuf
].clrfound
= true;
524 t
->vdau
[pgbuf
].stopped
= true;
525 t
->is_searching
[pgbuf
] = false;
527 t
->virtual_mode
= false;
533 static int saa5249_release(struct inode
*inode
, struct file
*file
)
535 struct saa5249_device
*t
= video_drvdata(file
);
537 i2c_senddata(t
, 1, 0x20, -1); /* Turn off CCT */
538 i2c_senddata(t
, 5, 3, 3, -1); /* Turn off TV-display */
539 clear_bit(0, &t
->in_use
);
543 static const struct file_operations saa_fops
= {
544 .owner
= THIS_MODULE
,
545 .open
= saa5249_open
,
546 .release
= saa5249_release
,
547 .ioctl
= saa5249_ioctl
,
549 .compat_ioctl
= v4l_compat_ioctl32
,
554 static struct video_device saa_template
=
558 .release
= video_device_release
,
561 /* Addresses to scan */
562 static unsigned short normal_i2c
[] = { 0x22 >> 1, I2C_CLIENT_END
};
566 static int saa5249_probe(struct i2c_client
*client
,
567 const struct i2c_device_id
*id
)
571 struct video_device
*vd
;
572 struct saa5249_device
*t
;
574 v4l_info(client
, "chip found @ 0x%x (%s)\n",
575 client
->addr
<< 1, client
->adapter
->name
);
576 v4l_info(client
, "VideoText version %d.%d\n",
577 VTX_VER_MAJ
, VTX_VER_MIN
);
578 t
= kzalloc(sizeof(*t
), GFP_KERNEL
);
581 mutex_init(&t
->lock
);
583 /* Now create a video4linux device */
584 vd
= kmalloc(sizeof(struct video_device
), GFP_KERNEL
);
589 i2c_set_clientdata(client
, vd
);
590 memcpy(vd
, &saa_template
, sizeof(*vd
));
592 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++) {
593 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
594 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
595 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
596 t
->vdau
[pgbuf
].expire
= 0;
597 t
->vdau
[pgbuf
].clrfound
= true;
598 t
->vdau
[pgbuf
].stopped
= true;
599 t
->is_searching
[pgbuf
] = false;
601 video_set_drvdata(vd
, t
);
604 err
= video_register_device(vd
, VFL_TYPE_VTX
, -1);
614 static int saa5249_remove(struct i2c_client
*client
)
616 struct video_device
*vd
= i2c_get_clientdata(client
);
618 video_unregister_device(vd
);
619 kfree(video_get_drvdata(vd
));
624 static const struct i2c_device_id saa5249_id
[] = {
628 MODULE_DEVICE_TABLE(i2c
, saa5249_id
);
630 static struct v4l2_i2c_driver_data v4l2_i2c_data
= {
632 .driverid
= I2C_DRIVERID_SAA5249
,
633 .probe
= saa5249_probe
,
634 .remove
= saa5249_remove
,
635 .id_table
= saa5249_id
,