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 <linux/mutex.h>
63 #include <asm/uaccess.h>
72 #define IF_NAME "SAA5249"
74 static const int disp_modes
[8][3] =
76 { 0x46, 0x03, 0x03 }, /* DISPOFF */
77 { 0x46, 0xcc, 0xcc }, /* DISPNORM */
78 { 0x44, 0x0f, 0x0f }, /* DISPTRANS */
79 { 0x46, 0xcc, 0x46 }, /* DISPINS */
80 { 0x44, 0x03, 0x03 }, /* DISPOFF, interlaced */
81 { 0x44, 0xcc, 0xcc }, /* DISPNORM, interlaced */
82 { 0x44, 0x0f, 0x0f }, /* DISPTRANS, interlaced */
83 { 0x44, 0xcc, 0x46 } /* DISPINS, interlaced */
88 #define PAGE_WAIT (300*HZ/1000) /* Time between requesting page and */
89 /* checking status bits */
90 #define PGBUF_EXPIRE (15*HZ) /* Time to wait before retransmitting */
91 /* page regardless of infobits */
93 u8 pgbuf
[VTX_VIRTUALSIZE
]; /* Page-buffer */
94 u8 laststat
[10]; /* Last value of infobits for DAU */
95 u8 sregs
[7]; /* Page-request registers */
96 unsigned long expire
; /* Time when page will be expired */
97 unsigned clrfound
: 1; /* VTXIOCCLRFOUND has been called */
98 unsigned stopped
: 1; /* VTXIOCSTOPDAU has been called */
101 struct saa5249_device
103 vdau_t vdau
[NUM_DAUS
]; /* Data for virtual DAUs (the 5249 only has one */
104 /* real DAU, so we have to simulate some more) */
106 int is_searching
[NUM_DAUS
];
109 struct i2c_client
*client
;
114 #define CCTWR 34 /* I²C write/read-address of vtx-chip */
116 #define NOACK_REPEAT 10 /* Retry access this many times on failure */
117 #define CLEAR_DELAY (HZ/20) /* Time required to clear a page */
118 #define READY_TIMEOUT (30*HZ/1000) /* Time to wait for ready signal of I²C-bus interface */
119 #define INIT_DELAY 500 /* Time in usec to wait at initialization of CEA interface */
120 #define START_DELAY 10 /* Time in usec to wait before starting write-cycle (CEA) */
122 #define VTX_DEV_MINOR 0
124 /* General defines and debugging support */
131 #define RESCHED do { cond_resched(); } while(0)
133 static struct video_device saa_template
; /* Declared near bottom */
135 /* Addresses to scan */
136 static unsigned short normal_i2c
[] = {34>>1,I2C_CLIENT_END
};
139 static struct i2c_client client_template
;
141 static int saa5249_attach(struct i2c_adapter
*adap
, int addr
, int kind
)
145 struct i2c_client
*client
;
146 struct video_device
*vd
;
147 struct saa5249_device
*t
;
149 printk(KERN_INFO
"saa5249: teletext chip found.\n");
150 client
=kmalloc(sizeof(*client
), GFP_KERNEL
);
153 client_template
.adapter
= adap
;
154 client_template
.addr
= addr
;
155 memcpy(client
, &client_template
, sizeof(*client
));
156 t
= kzalloc(sizeof(*t
), GFP_KERNEL
);
162 strlcpy(client
->name
, IF_NAME
, I2C_NAME_SIZE
);
163 mutex_init(&t
->lock
);
166 * Now create a video4linux device
169 vd
= kmalloc(sizeof(struct video_device
), GFP_KERNEL
);
176 i2c_set_clientdata(client
, vd
);
177 memcpy(vd
, &saa_template
, sizeof(*vd
));
179 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++)
181 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
182 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
183 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
184 t
->vdau
[pgbuf
].expire
= 0;
185 t
->vdau
[pgbuf
].clrfound
= TRUE
;
186 t
->vdau
[pgbuf
].stopped
= TRUE
;
187 t
->is_searching
[pgbuf
] = FALSE
;
196 if((err
=video_register_device(vd
, VFL_TYPE_VTX
,-1))<0)
204 i2c_attach_client(client
);
209 * We do most of the hard work when we become a device on the i2c.
212 static int saa5249_probe(struct i2c_adapter
*adap
)
214 if (adap
->class & I2C_CLASS_TV_ANALOG
)
215 return i2c_probe(adap
, &addr_data
, saa5249_attach
);
219 static int saa5249_detach(struct i2c_client
*client
)
221 struct video_device
*vd
= i2c_get_clientdata(client
);
222 i2c_detach_client(client
);
223 video_unregister_device(vd
);
230 /* new I2C driver support */
232 static struct i2c_driver i2c_driver_videotext
=
235 .name
= IF_NAME
, /* name */
237 .id
= I2C_DRIVERID_SAA5249
, /* in i2c.h */
238 .attach_adapter
= saa5249_probe
,
239 .detach_client
= saa5249_detach
,
242 static struct i2c_client client_template
= {
243 .driver
= &i2c_driver_videotext
,
248 * Wait the given number of jiffies (10ms). This calls the scheduler, so the actual
249 * delay may be longer.
252 static void jdelay(unsigned long delay
)
254 sigset_t oldblocked
= current
->blocked
;
256 spin_lock_irq(¤t
->sighand
->siglock
);
257 sigfillset(¤t
->blocked
);
259 spin_unlock_irq(¤t
->sighand
->siglock
);
260 msleep_interruptible(jiffies_to_msecs(delay
));
262 spin_lock_irq(¤t
->sighand
->siglock
);
263 current
->blocked
= oldblocked
;
265 spin_unlock_irq(¤t
->sighand
->siglock
);
273 static int i2c_sendbuf(struct saa5249_device
*t
, int reg
, int count
, u8
*data
)
278 memcpy(buf
+1, data
, count
);
280 if(i2c_master_send(t
->client
, buf
, count
+1)==count
+1)
285 static int i2c_senddata(struct saa5249_device
*t
, ...)
287 unsigned char buf
[64];
293 while((v
=va_arg(argp
,int))!=-1)
295 return i2c_sendbuf(t
, buf
[0], ct
-1, buf
+1);
298 /* Get count number of bytes from I²C-device at address adr, store them in buf. Start & stop
299 * handshaking is done by this routine, ack will be sent after the last byte to inhibit further
300 * sending of data. If uaccess is TRUE, data is written to user-space with put_user.
301 * Returns -1 if I²C-device didn't send acknowledge, 0 otherwise
304 static int i2c_getdata(struct saa5249_device
*t
, int count
, u8
*buf
)
306 if(i2c_master_recv(t
->client
, buf
, count
)!=count
)
313 * Standard character-device-driver functions
316 static int do_saa5249_ioctl(struct inode
*inode
, struct file
*file
,
317 unsigned int cmd
, void *arg
)
319 static int virtual_mode
= FALSE
;
320 struct video_device
*vd
= video_devdata(file
);
321 struct saa5249_device
*t
=vd
->priv
;
327 vtx_info_t
*info
= arg
;
328 info
->version_major
= VTX_VER_MAJ
;
329 info
->version_minor
= VTX_VER_MIN
;
330 info
->numpages
= NUM_DAUS
;
331 /*info->cct_type = CCT_TYPE;*/
337 vtx_pagereq_t
*req
= arg
;
339 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
341 memset(t
->vdau
[req
->pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
342 t
->vdau
[req
->pgbuf
].clrfound
= TRUE
;
348 vtx_pagereq_t
*req
= arg
;
350 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
352 t
->vdau
[req
->pgbuf
].clrfound
= TRUE
;
358 vtx_pagereq_t
*req
= arg
;
359 if (!(req
->pagemask
& PGMASK_PAGE
))
361 if (!(req
->pagemask
& PGMASK_HOUR
))
363 if (!(req
->pagemask
& PGMASK_MINUTE
))
365 if (req
->page
< 0 || req
->page
> 0x8ff) /* 7FF ?? */
368 if (req
->hour
< 0 || req
->hour
> 0x3f || req
->minute
< 0 || req
->minute
> 0x7f ||
369 req
->pagemask
< 0 || req
->pagemask
>= PGMASK_MAX
|| req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
371 t
->vdau
[req
->pgbuf
].sregs
[0] = (req
->pagemask
& PG_HUND
? 0x10 : 0) | (req
->page
/ 0x100);
372 t
->vdau
[req
->pgbuf
].sregs
[1] = (req
->pagemask
& PG_TEN
? 0x10 : 0) | ((req
->page
/ 0x10) & 0xf);
373 t
->vdau
[req
->pgbuf
].sregs
[2] = (req
->pagemask
& PG_UNIT
? 0x10 : 0) | (req
->page
& 0xf);
374 t
->vdau
[req
->pgbuf
].sregs
[3] = (req
->pagemask
& HR_TEN
? 0x10 : 0) | (req
->hour
/ 0x10);
375 t
->vdau
[req
->pgbuf
].sregs
[4] = (req
->pagemask
& HR_UNIT
? 0x10 : 0) | (req
->hour
& 0xf);
376 t
->vdau
[req
->pgbuf
].sregs
[5] = (req
->pagemask
& MIN_TEN
? 0x10 : 0) | (req
->minute
/ 0x10);
377 t
->vdau
[req
->pgbuf
].sregs
[6] = (req
->pagemask
& MIN_UNIT
? 0x10 : 0) | (req
->minute
& 0xf);
378 t
->vdau
[req
->pgbuf
].stopped
= FALSE
;
379 t
->vdau
[req
->pgbuf
].clrfound
= TRUE
;
380 t
->is_searching
[req
->pgbuf
] = TRUE
;
386 vtx_pagereq_t
*req
= arg
;
391 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
393 if (!t
->vdau
[req
->pgbuf
].stopped
)
395 if (i2c_senddata(t
, 2, 0, -1) ||
396 i2c_sendbuf(t
, 3, sizeof(t
->vdau
[0].sregs
), t
->vdau
[req
->pgbuf
].sregs
) ||
397 i2c_senddata(t
, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
398 i2c_senddata(t
, 2, 0, t
->vdau
[req
->pgbuf
].sregs
[0] | 8, -1) ||
399 i2c_senddata(t
, 8, 0, 25, 0, -1))
402 if (i2c_getdata(t
, 10, infobits
))
405 if (!(infobits
[8] & 0x10) && !(infobits
[7] & 0xf0) && /* check FOUND-bit */
406 (memcmp(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
)) ||
407 time_after_eq(jiffies
, t
->vdau
[req
->pgbuf
].expire
)))
408 { /* check if new page arrived */
409 if (i2c_senddata(t
, 8, 0, 0, 0, -1) ||
410 i2c_getdata(t
, VTX_PAGESIZE
, t
->vdau
[req
->pgbuf
].pgbuf
))
412 t
->vdau
[req
->pgbuf
].expire
= jiffies
+ PGBUF_EXPIRE
;
413 memset(t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
, ' ', VTX_VIRTUALSIZE
- VTX_PAGESIZE
);
417 if (i2c_senddata(t
, 8, 0, 0x20, 0, -1) ||
418 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 20 * 40))
421 if (i2c_senddata(t
, 8, 0, 0x21, 0, -1) ||
422 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 16 * 40))
424 /* Packet 8/30/0...8/30/15
425 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
426 * so we should undo this here.
428 if (i2c_senddata(t
, 8, 0, 0x22, 0, -1) ||
429 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 23 * 40))
432 t
->vdau
[req
->pgbuf
].clrfound
= FALSE
;
433 memcpy(t
->vdau
[req
->pgbuf
].laststat
, infobits
, sizeof(infobits
));
437 memcpy(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
));
442 memcpy(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
));
445 info
.pagenum
= ((infobits
[8] << 8) & 0x700) | ((infobits
[1] << 4) & 0xf0) | (infobits
[0] & 0x0f);
446 if (info
.pagenum
< 0x100)
447 info
.pagenum
+= 0x800;
448 info
.hour
= ((infobits
[5] << 4) & 0x30) | (infobits
[4] & 0x0f);
449 info
.minute
= ((infobits
[3] << 4) & 0x70) | (infobits
[2] & 0x0f);
450 info
.charset
= ((infobits
[7] >> 1) & 7);
451 info
.delete = !!(infobits
[3] & 8);
452 info
.headline
= !!(infobits
[5] & 4);
453 info
.subtitle
= !!(infobits
[5] & 8);
454 info
.supp_header
= !!(infobits
[6] & 1);
455 info
.update
= !!(infobits
[6] & 2);
456 info
.inter_seq
= !!(infobits
[6] & 4);
457 info
.dis_disp
= !!(infobits
[6] & 8);
458 info
.serial
= !!(infobits
[7] & 1);
459 info
.notfound
= !!(infobits
[8] & 0x10);
460 info
.pblf
= !!(infobits
[9] & 0x20);
462 for (a
= 0; a
<= 7; a
++)
464 if (infobits
[a
] & 0xf0)
470 if (t
->vdau
[req
->pgbuf
].clrfound
)
472 if(copy_to_user(req
->buffer
, &info
, sizeof(vtx_pageinfo_t
)))
474 if (!info
.hamming
&& !info
.notfound
)
476 t
->is_searching
[req
->pgbuf
] = FALSE
;
483 vtx_pagereq_t
*req
= arg
;
486 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
|| req
->start
< 0 ||
487 req
->start
> req
->end
|| req
->end
>= (virtual_mode
? VTX_VIRTUALSIZE
: VTX_PAGESIZE
))
489 if(copy_to_user(req
->buffer
, &t
->vdau
[req
->pgbuf
].pgbuf
[req
->start
], req
->end
- req
->start
+ 1))
493 * Always read the time directly from SAA5249
496 if (req
->start
<= 39 && req
->end
>= 32)
500 start
= max(req
->start
, 32);
501 end
= min(req
->end
, 39);
503 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
504 i2c_getdata(t
, len
, buf
))
506 if(copy_to_user(req
->buffer
+start
-req
->start
, buf
, len
))
509 /* Insert the current header if DAU is still searching for a page */
510 if (req
->start
<= 31 && req
->end
>= 7 && t
->is_searching
[req
->pgbuf
])
514 start
= max(req
->start
, 7);
515 end
= min(req
->end
, 31);
517 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
518 i2c_getdata(t
, len
, buf
))
520 if(copy_to_user(req
->buffer
+start
-req
->start
, buf
, len
))
528 vtx_pagereq_t
*req
= arg
;
530 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
532 t
->vdau
[req
->pgbuf
].stopped
= TRUE
;
533 t
->is_searching
[req
->pgbuf
] = FALSE
;
544 if (i2c_senddata(t
, 0, NUM_DAUS
, 0, 8, -1) || i2c_senddata(t
, 11,
545 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',
546 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ', -1))
548 if (i2c_senddata(t
, 3, 0x20, -1))
550 jdelay(10 * CLEAR_DELAY
); /* I have no idea how long we have to wait here */
556 /* The SAA5249 has virtual-row reception turned on always */
557 t
->virtual_mode
= (int)(long)arg
;
565 * Translates old vtx IOCTLs to new ones
567 * This keeps new kernel versions compatible with old userspace programs.
569 static inline unsigned int vtx_fix_command(unsigned int cmd
)
572 case VTXIOCGETINFO_OLD
:
575 case VTXIOCCLRPAGE_OLD
:
578 case VTXIOCCLRFOUND_OLD
:
579 cmd
= VTXIOCCLRFOUND
;
581 case VTXIOCPAGEREQ_OLD
:
584 case VTXIOCGETSTAT_OLD
:
587 case VTXIOCGETPAGE_OLD
:
590 case VTXIOCSTOPDAU_OLD
:
593 case VTXIOCPUTPAGE_OLD
:
596 case VTXIOCSETDISP_OLD
:
599 case VTXIOCPUTSTAT_OLD
:
602 case VTXIOCCLRCACHE_OLD
:
603 cmd
= VTXIOCCLRCACHE
;
605 case VTXIOCSETVIRT_OLD
:
616 static int saa5249_ioctl(struct inode
*inode
, struct file
*file
,
617 unsigned int cmd
, unsigned long arg
)
619 struct video_device
*vd
= video_devdata(file
);
620 struct saa5249_device
*t
=vd
->priv
;
623 cmd
= vtx_fix_command(cmd
);
624 mutex_lock(&t
->lock
);
625 err
= video_usercopy(inode
,file
,cmd
,arg
,do_saa5249_ioctl
);
626 mutex_unlock(&t
->lock
);
630 static int saa5249_open(struct inode
*inode
, struct file
*file
)
632 struct video_device
*vd
= video_devdata(file
);
633 struct saa5249_device
*t
=vd
->priv
;
636 err
= video_exclusive_open(inode
,file
);
640 if (t
->client
==NULL
) {
645 if (i2c_senddata(t
, 0, 0, -1) || /* Select R11 */
646 /* Turn off parity checks (we do this ourselves) */
647 i2c_senddata(t
, 1, disp_modes
[t
->disp_mode
][0], 0, -1) ||
648 /* Display TV-picture, no virtual rows */
649 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 */
656 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++)
658 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
659 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
660 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
661 t
->vdau
[pgbuf
].expire
= 0;
662 t
->vdau
[pgbuf
].clrfound
= TRUE
;
663 t
->vdau
[pgbuf
].stopped
= TRUE
;
664 t
->is_searching
[pgbuf
] = FALSE
;
666 t
->virtual_mode
=FALSE
;
670 video_exclusive_release(inode
,file
);
676 static int saa5249_release(struct inode
*inode
, struct file
*file
)
678 struct video_device
*vd
= video_devdata(file
);
679 struct saa5249_device
*t
=vd
->priv
;
680 i2c_senddata(t
, 1, 0x20, -1); /* Turn off CCT */
681 i2c_senddata(t
, 5, 3, 3, -1); /* Turn off TV-display */
682 video_exclusive_release(inode
,file
);
686 static int __init
init_saa_5249 (void)
688 printk(KERN_INFO
"SAA5249 driver (" IF_NAME
" interface) for VideoText version %d.%d\n",
689 VTX_VER_MAJ
, VTX_VER_MIN
);
690 return i2c_add_driver(&i2c_driver_videotext
);
693 static void __exit
cleanup_saa_5249 (void)
695 i2c_del_driver(&i2c_driver_videotext
);
698 module_init(init_saa_5249
);
699 module_exit(cleanup_saa_5249
);
701 static struct file_operations saa_fops
= {
702 .owner
= THIS_MODULE
,
703 .open
= saa5249_open
,
704 .release
= saa5249_release
,
705 .ioctl
= saa5249_ioctl
,
706 .compat_ioctl
= v4l_compat_ioctl32
,
710 static struct video_device saa_template
=
712 .owner
= THIS_MODULE
,
714 .type
= VID_TYPE_TELETEXT
, /*| VID_TYPE_TUNER ?? */
715 .hardware
= VID_HARDWARE_SAA5249
,
719 MODULE_LICENSE("GPL");