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>
61 #include <asm/uaccess.h>
70 #define IF_NAME "SAA5249"
72 static const int disp_modes
[8][3] =
74 { 0x46, 0x03, 0x03 }, /* DISPOFF */
75 { 0x46, 0xcc, 0xcc }, /* DISPNORM */
76 { 0x44, 0x0f, 0x0f }, /* DISPTRANS */
77 { 0x46, 0xcc, 0x46 }, /* DISPINS */
78 { 0x44, 0x03, 0x03 }, /* DISPOFF, interlaced */
79 { 0x44, 0xcc, 0xcc }, /* DISPNORM, interlaced */
80 { 0x44, 0x0f, 0x0f }, /* DISPTRANS, interlaced */
81 { 0x44, 0xcc, 0x46 } /* DISPINS, interlaced */
86 #define PAGE_WAIT (300*HZ/1000) /* Time between requesting page and */
87 /* checking status bits */
88 #define PGBUF_EXPIRE (15*HZ) /* Time to wait before retransmitting */
89 /* page regardless of infobits */
91 u8 pgbuf
[VTX_VIRTUALSIZE
]; /* Page-buffer */
92 u8 laststat
[10]; /* Last value of infobits for DAU */
93 u8 sregs
[7]; /* Page-request registers */
94 unsigned long expire
; /* Time when page will be expired */
95 unsigned clrfound
: 1; /* VTXIOCCLRFOUND has been called */
96 unsigned stopped
: 1; /* VTXIOCSTOPDAU has been called */
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 struct i2c_client
*client
;
108 struct semaphore lock
;
112 #define CCTWR 34 /* I²C write/read-address of vtx-chip */
114 #define NOACK_REPEAT 10 /* Retry access this many times on failure */
115 #define CLEAR_DELAY (HZ/20) /* Time required to clear a page */
116 #define READY_TIMEOUT (30*HZ/1000) /* Time to wait for ready signal of I²C-bus interface */
117 #define INIT_DELAY 500 /* Time in usec to wait at initialization of CEA interface */
118 #define START_DELAY 10 /* Time in usec to wait before starting write-cycle (CEA) */
120 #define VTX_DEV_MINOR 0
122 /* General defines and debugging support */
129 #define RESCHED do { cond_resched(); } while(0)
131 static struct video_device saa_template
; /* Declared near bottom */
133 /* Addresses to scan */
134 static unsigned short normal_i2c
[] = {34>>1,I2C_CLIENT_END
};
137 static struct i2c_client client_template
;
139 static int saa5249_attach(struct i2c_adapter
*adap
, int addr
, int kind
)
143 struct i2c_client
*client
;
144 struct video_device
*vd
;
145 struct saa5249_device
*t
;
147 printk(KERN_INFO
"saa5249: teletext chip found.\n");
148 client
=kmalloc(sizeof(*client
), GFP_KERNEL
);
151 client_template
.adapter
= adap
;
152 client_template
.addr
= addr
;
153 memcpy(client
, &client_template
, sizeof(*client
));
154 t
= kmalloc(sizeof(*t
), GFP_KERNEL
);
160 memset(t
, 0, sizeof(*t
));
161 strlcpy(client
->name
, IF_NAME
, I2C_NAME_SIZE
);
162 init_MUTEX(&t
->lock
);
165 * Now create a video4linux device
168 vd
= (struct video_device
*)kmalloc(sizeof(struct video_device
), GFP_KERNEL
);
175 i2c_set_clientdata(client
, vd
);
176 memcpy(vd
, &saa_template
, sizeof(*vd
));
178 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++)
180 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
181 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
182 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
183 t
->vdau
[pgbuf
].expire
= 0;
184 t
->vdau
[pgbuf
].clrfound
= TRUE
;
185 t
->vdau
[pgbuf
].stopped
= TRUE
;
186 t
->is_searching
[pgbuf
] = FALSE
;
195 if((err
=video_register_device(vd
, VFL_TYPE_VTX
,-1))<0)
203 i2c_attach_client(client
);
208 * We do most of the hard work when we become a device on the i2c.
211 static int saa5249_probe(struct i2c_adapter
*adap
)
213 if (adap
->class & I2C_CLASS_TV_ANALOG
)
214 return i2c_probe(adap
, &addr_data
, saa5249_attach
);
218 static int saa5249_detach(struct i2c_client
*client
)
220 struct video_device
*vd
= i2c_get_clientdata(client
);
221 i2c_detach_client(client
);
222 video_unregister_device(vd
);
229 static int saa5249_command(struct i2c_client
*device
,
230 unsigned int cmd
, void *arg
)
235 /* new I2C driver support */
237 static struct i2c_driver i2c_driver_videotext
=
239 .owner
= THIS_MODULE
,
240 .name
= IF_NAME
, /* name */
241 .id
= I2C_DRIVERID_SAA5249
, /* in i2c.h */
242 .flags
= I2C_DF_NOTIFY
,
243 .attach_adapter
= saa5249_probe
,
244 .detach_client
= saa5249_detach
,
245 .command
= saa5249_command
248 static struct i2c_client client_template
= {
249 .driver
= &i2c_driver_videotext
,
254 * Wait the given number of jiffies (10ms). This calls the scheduler, so the actual
255 * delay may be longer.
258 static void jdelay(unsigned long delay
)
260 sigset_t oldblocked
= current
->blocked
;
262 spin_lock_irq(¤t
->sighand
->siglock
);
263 sigfillset(¤t
->blocked
);
265 spin_unlock_irq(¤t
->sighand
->siglock
);
266 msleep_interruptible(jiffies_to_msecs(delay
));
268 spin_lock_irq(¤t
->sighand
->siglock
);
269 current
->blocked
= oldblocked
;
271 spin_unlock_irq(¤t
->sighand
->siglock
);
279 static int i2c_sendbuf(struct saa5249_device
*t
, int reg
, int count
, u8
*data
)
284 memcpy(buf
+1, data
, count
);
286 if(i2c_master_send(t
->client
, buf
, count
+1)==count
+1)
291 static int i2c_senddata(struct saa5249_device
*t
, ...)
293 unsigned char buf
[64];
299 while((v
=va_arg(argp
,int))!=-1)
301 return i2c_sendbuf(t
, buf
[0], ct
-1, buf
+1);
304 /* Get count number of bytes from I²C-device at address adr, store them in buf. Start & stop
305 * handshaking is done by this routine, ack will be sent after the last byte to inhibit further
306 * sending of data. If uaccess is TRUE, data is written to user-space with put_user.
307 * Returns -1 if I²C-device didn't send acknowledge, 0 otherwise
310 static int i2c_getdata(struct saa5249_device
*t
, int count
, u8
*buf
)
312 if(i2c_master_recv(t
->client
, buf
, count
)!=count
)
319 * Standard character-device-driver functions
322 static int do_saa5249_ioctl(struct inode
*inode
, struct file
*file
,
323 unsigned int cmd
, void *arg
)
325 static int virtual_mode
= FALSE
;
326 struct video_device
*vd
= video_devdata(file
);
327 struct saa5249_device
*t
=vd
->priv
;
333 vtx_info_t
*info
= arg
;
334 info
->version_major
= VTX_VER_MAJ
;
335 info
->version_minor
= VTX_VER_MIN
;
336 info
->numpages
= NUM_DAUS
;
337 /*info->cct_type = CCT_TYPE;*/
343 vtx_pagereq_t
*req
= arg
;
345 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
347 memset(t
->vdau
[req
->pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
348 t
->vdau
[req
->pgbuf
].clrfound
= TRUE
;
354 vtx_pagereq_t
*req
= arg
;
356 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
358 t
->vdau
[req
->pgbuf
].clrfound
= TRUE
;
364 vtx_pagereq_t
*req
= arg
;
365 if (!(req
->pagemask
& PGMASK_PAGE
))
367 if (!(req
->pagemask
& PGMASK_HOUR
))
369 if (!(req
->pagemask
& PGMASK_MINUTE
))
371 if (req
->page
< 0 || req
->page
> 0x8ff) /* 7FF ?? */
374 if (req
->hour
< 0 || req
->hour
> 0x3f || req
->minute
< 0 || req
->minute
> 0x7f ||
375 req
->pagemask
< 0 || req
->pagemask
>= PGMASK_MAX
|| req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
377 t
->vdau
[req
->pgbuf
].sregs
[0] = (req
->pagemask
& PG_HUND
? 0x10 : 0) | (req
->page
/ 0x100);
378 t
->vdau
[req
->pgbuf
].sregs
[1] = (req
->pagemask
& PG_TEN
? 0x10 : 0) | ((req
->page
/ 0x10) & 0xf);
379 t
->vdau
[req
->pgbuf
].sregs
[2] = (req
->pagemask
& PG_UNIT
? 0x10 : 0) | (req
->page
& 0xf);
380 t
->vdau
[req
->pgbuf
].sregs
[3] = (req
->pagemask
& HR_TEN
? 0x10 : 0) | (req
->hour
/ 0x10);
381 t
->vdau
[req
->pgbuf
].sregs
[4] = (req
->pagemask
& HR_UNIT
? 0x10 : 0) | (req
->hour
& 0xf);
382 t
->vdau
[req
->pgbuf
].sregs
[5] = (req
->pagemask
& MIN_TEN
? 0x10 : 0) | (req
->minute
/ 0x10);
383 t
->vdau
[req
->pgbuf
].sregs
[6] = (req
->pagemask
& MIN_UNIT
? 0x10 : 0) | (req
->minute
& 0xf);
384 t
->vdau
[req
->pgbuf
].stopped
= FALSE
;
385 t
->vdau
[req
->pgbuf
].clrfound
= TRUE
;
386 t
->is_searching
[req
->pgbuf
] = TRUE
;
392 vtx_pagereq_t
*req
= arg
;
397 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
399 if (!t
->vdau
[req
->pgbuf
].stopped
)
401 if (i2c_senddata(t
, 2, 0, -1) ||
402 i2c_sendbuf(t
, 3, sizeof(t
->vdau
[0].sregs
), t
->vdau
[req
->pgbuf
].sregs
) ||
403 i2c_senddata(t
, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
404 i2c_senddata(t
, 2, 0, t
->vdau
[req
->pgbuf
].sregs
[0] | 8, -1) ||
405 i2c_senddata(t
, 8, 0, 25, 0, -1))
408 if (i2c_getdata(t
, 10, infobits
))
411 if (!(infobits
[8] & 0x10) && !(infobits
[7] & 0xf0) && /* check FOUND-bit */
412 (memcmp(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
)) ||
413 time_after_eq(jiffies
, t
->vdau
[req
->pgbuf
].expire
)))
414 { /* check if new page arrived */
415 if (i2c_senddata(t
, 8, 0, 0, 0, -1) ||
416 i2c_getdata(t
, VTX_PAGESIZE
, t
->vdau
[req
->pgbuf
].pgbuf
))
418 t
->vdau
[req
->pgbuf
].expire
= jiffies
+ PGBUF_EXPIRE
;
419 memset(t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
, ' ', VTX_VIRTUALSIZE
- VTX_PAGESIZE
);
423 if (i2c_senddata(t
, 8, 0, 0x20, 0, -1) ||
424 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 20 * 40))
427 if (i2c_senddata(t
, 8, 0, 0x21, 0, -1) ||
428 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 16 * 40))
430 /* Packet 8/30/0...8/30/15
431 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
432 * so we should undo this here.
434 if (i2c_senddata(t
, 8, 0, 0x22, 0, -1) ||
435 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 23 * 40))
438 t
->vdau
[req
->pgbuf
].clrfound
= FALSE
;
439 memcpy(t
->vdau
[req
->pgbuf
].laststat
, infobits
, sizeof(infobits
));
443 memcpy(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
));
448 memcpy(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
));
451 info
.pagenum
= ((infobits
[8] << 8) & 0x700) | ((infobits
[1] << 4) & 0xf0) | (infobits
[0] & 0x0f);
452 if (info
.pagenum
< 0x100)
453 info
.pagenum
+= 0x800;
454 info
.hour
= ((infobits
[5] << 4) & 0x30) | (infobits
[4] & 0x0f);
455 info
.minute
= ((infobits
[3] << 4) & 0x70) | (infobits
[2] & 0x0f);
456 info
.charset
= ((infobits
[7] >> 1) & 7);
457 info
.delete = !!(infobits
[3] & 8);
458 info
.headline
= !!(infobits
[5] & 4);
459 info
.subtitle
= !!(infobits
[5] & 8);
460 info
.supp_header
= !!(infobits
[6] & 1);
461 info
.update
= !!(infobits
[6] & 2);
462 info
.inter_seq
= !!(infobits
[6] & 4);
463 info
.dis_disp
= !!(infobits
[6] & 8);
464 info
.serial
= !!(infobits
[7] & 1);
465 info
.notfound
= !!(infobits
[8] & 0x10);
466 info
.pblf
= !!(infobits
[9] & 0x20);
468 for (a
= 0; a
<= 7; a
++)
470 if (infobits
[a
] & 0xf0)
476 if (t
->vdau
[req
->pgbuf
].clrfound
)
478 if(copy_to_user(req
->buffer
, &info
, sizeof(vtx_pageinfo_t
)))
480 if (!info
.hamming
&& !info
.notfound
)
482 t
->is_searching
[req
->pgbuf
] = FALSE
;
489 vtx_pagereq_t
*req
= arg
;
492 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
|| req
->start
< 0 ||
493 req
->start
> req
->end
|| req
->end
>= (virtual_mode
? VTX_VIRTUALSIZE
: VTX_PAGESIZE
))
495 if(copy_to_user(req
->buffer
, &t
->vdau
[req
->pgbuf
].pgbuf
[req
->start
], req
->end
- req
->start
+ 1))
499 * Always read the time directly from SAA5249
502 if (req
->start
<= 39 && req
->end
>= 32)
506 start
= max(req
->start
, 32);
507 end
= min(req
->end
, 39);
509 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
510 i2c_getdata(t
, len
, buf
))
512 if(copy_to_user(req
->buffer
+start
-req
->start
, buf
, len
))
515 /* Insert the current header if DAU is still searching for a page */
516 if (req
->start
<= 31 && req
->end
>= 7 && t
->is_searching
[req
->pgbuf
])
520 start
= max(req
->start
, 7);
521 end
= min(req
->end
, 31);
523 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
524 i2c_getdata(t
, len
, buf
))
526 if(copy_to_user(req
->buffer
+start
-req
->start
, buf
, len
))
534 vtx_pagereq_t
*req
= arg
;
536 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
538 t
->vdau
[req
->pgbuf
].stopped
= TRUE
;
539 t
->is_searching
[req
->pgbuf
] = FALSE
;
550 if (i2c_senddata(t
, 0, NUM_DAUS
, 0, 8, -1) || i2c_senddata(t
, 11,
551 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',
552 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ', -1))
554 if (i2c_senddata(t
, 3, 0x20, -1))
556 jdelay(10 * CLEAR_DELAY
); /* I have no idea how long we have to wait here */
562 /* The SAA5249 has virtual-row reception turned on always */
563 t
->virtual_mode
= (int)(long)arg
;
571 * Translates old vtx IOCTLs to new ones
573 * This keeps new kernel versions compatible with old userspace programs.
575 static inline unsigned int vtx_fix_command(unsigned int cmd
)
578 case VTXIOCGETINFO_OLD
:
581 case VTXIOCCLRPAGE_OLD
:
584 case VTXIOCCLRFOUND_OLD
:
585 cmd
= VTXIOCCLRFOUND
;
587 case VTXIOCPAGEREQ_OLD
:
590 case VTXIOCGETSTAT_OLD
:
593 case VTXIOCGETPAGE_OLD
:
596 case VTXIOCSTOPDAU_OLD
:
599 case VTXIOCPUTPAGE_OLD
:
602 case VTXIOCSETDISP_OLD
:
605 case VTXIOCPUTSTAT_OLD
:
608 case VTXIOCCLRCACHE_OLD
:
609 cmd
= VTXIOCCLRCACHE
;
611 case VTXIOCSETVIRT_OLD
:
622 static int saa5249_ioctl(struct inode
*inode
, struct file
*file
,
623 unsigned int cmd
, unsigned long arg
)
625 struct video_device
*vd
= video_devdata(file
);
626 struct saa5249_device
*t
=vd
->priv
;
629 cmd
= vtx_fix_command(cmd
);
631 err
= video_usercopy(inode
,file
,cmd
,arg
,do_saa5249_ioctl
);
636 static int saa5249_open(struct inode
*inode
, struct file
*file
)
638 struct video_device
*vd
= video_devdata(file
);
639 struct saa5249_device
*t
=vd
->priv
;
642 err
= video_exclusive_open(inode
,file
);
646 if (t
->client
==NULL
) {
651 if (i2c_senddata(t
, 0, 0, -1) || /* Select R11 */
652 /* Turn off parity checks (we do this ourselves) */
653 i2c_senddata(t
, 1, disp_modes
[t
->disp_mode
][0], 0, -1) ||
654 /* Display TV-picture, no virtual rows */
655 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 */
662 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++)
664 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
665 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
666 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
667 t
->vdau
[pgbuf
].expire
= 0;
668 t
->vdau
[pgbuf
].clrfound
= TRUE
;
669 t
->vdau
[pgbuf
].stopped
= TRUE
;
670 t
->is_searching
[pgbuf
] = FALSE
;
672 t
->virtual_mode
=FALSE
;
676 video_exclusive_release(inode
,file
);
682 static int saa5249_release(struct inode
*inode
, struct file
*file
)
684 struct video_device
*vd
= video_devdata(file
);
685 struct saa5249_device
*t
=vd
->priv
;
686 i2c_senddata(t
, 1, 0x20, -1); /* Turn off CCT */
687 i2c_senddata(t
, 5, 3, 3, -1); /* Turn off TV-display */
688 video_exclusive_release(inode
,file
);
692 static int __init
init_saa_5249 (void)
694 printk(KERN_INFO
"SAA5249 driver (" IF_NAME
" interface) for VideoText version %d.%d\n",
695 VTX_VER_MAJ
, VTX_VER_MIN
);
696 return i2c_add_driver(&i2c_driver_videotext
);
699 static void __exit
cleanup_saa_5249 (void)
701 i2c_del_driver(&i2c_driver_videotext
);
704 module_init(init_saa_5249
);
705 module_exit(cleanup_saa_5249
);
707 static struct file_operations saa_fops
= {
708 .owner
= THIS_MODULE
,
709 .open
= saa5249_open
,
710 .release
= saa5249_release
,
711 .ioctl
= saa5249_ioctl
,
715 static struct video_device saa_template
=
717 .owner
= THIS_MODULE
,
719 .type
= VID_TYPE_TELETEXT
, /*| VID_TYPE_TUNER ?? */
720 .hardware
= VID_HARDWARE_SAA5249
,
724 MODULE_LICENSE("GPL");