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 <media/v4l2-common.h>
60 #include <linux/mutex.h>
64 #include <asm/uaccess.h>
73 #define IF_NAME "SAA5249"
75 static const int disp_modes
[8][3] =
77 { 0x46, 0x03, 0x03 }, /* DISPOFF */
78 { 0x46, 0xcc, 0xcc }, /* DISPNORM */
79 { 0x44, 0x0f, 0x0f }, /* DISPTRANS */
80 { 0x46, 0xcc, 0x46 }, /* DISPINS */
81 { 0x44, 0x03, 0x03 }, /* DISPOFF, interlaced */
82 { 0x44, 0xcc, 0xcc }, /* DISPNORM, interlaced */
83 { 0x44, 0x0f, 0x0f }, /* DISPTRANS, interlaced */
84 { 0x44, 0xcc, 0x46 } /* DISPINS, interlaced */
89 #define PAGE_WAIT msecs_to_jiffies(300) /* Time between requesting page and */
90 /* checking status bits */
91 #define PGBUF_EXPIRE msecs_to_jiffies(15000) /* Time to wait before retransmitting */
92 /* page regardless of infobits */
94 u8 pgbuf
[VTX_VIRTUALSIZE
]; /* Page-buffer */
95 u8 laststat
[10]; /* Last value of infobits for DAU */
96 u8 sregs
[7]; /* Page-request registers */
97 unsigned long expire
; /* Time when page will be expired */
98 unsigned clrfound
: 1; /* VTXIOCCLRFOUND has been called */
99 unsigned stopped
: 1; /* VTXIOCSTOPDAU has been called */
102 struct saa5249_device
104 vdau_t vdau
[NUM_DAUS
]; /* Data for virtual DAUs (the 5249 only has one */
105 /* real DAU, so we have to simulate some more) */
107 int is_searching
[NUM_DAUS
];
110 struct i2c_client
*client
;
115 #define CCTWR 34 /* I²C write/read-address of vtx-chip */
117 #define NOACK_REPEAT 10 /* Retry access this many times on failure */
118 #define CLEAR_DELAY msecs_to_jiffies(50) /* Time required to clear a page */
119 #define READY_TIMEOUT msecs_to_jiffies(30) /* Time to wait for ready signal of I2C-bus interface */
120 #define INIT_DELAY 500 /* Time in usec to wait at initialization of CEA interface */
121 #define START_DELAY 10 /* Time in usec to wait before starting write-cycle (CEA) */
123 #define VTX_DEV_MINOR 0
125 /* General defines and debugging support */
127 #define RESCHED do { cond_resched(); } while(0)
129 static struct video_device saa_template
; /* Declared near bottom */
131 /* Addresses to scan */
132 static unsigned short normal_i2c
[] = {34>>1,I2C_CLIENT_END
};
135 static struct i2c_client client_template
;
137 static int saa5249_attach(struct i2c_adapter
*adap
, int addr
, int kind
)
141 struct i2c_client
*client
;
142 struct video_device
*vd
;
143 struct saa5249_device
*t
;
145 printk(KERN_INFO
"saa5249: teletext chip found.\n");
146 client
=kmalloc(sizeof(*client
), GFP_KERNEL
);
149 client_template
.adapter
= adap
;
150 client_template
.addr
= addr
;
151 memcpy(client
, &client_template
, sizeof(*client
));
152 t
= kzalloc(sizeof(*t
), GFP_KERNEL
);
158 strlcpy(client
->name
, IF_NAME
, I2C_NAME_SIZE
);
159 mutex_init(&t
->lock
);
162 * Now create a video4linux device
165 vd
= kmalloc(sizeof(struct video_device
), GFP_KERNEL
);
172 i2c_set_clientdata(client
, vd
);
173 memcpy(vd
, &saa_template
, sizeof(*vd
));
175 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++)
177 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
178 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
179 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
180 t
->vdau
[pgbuf
].expire
= 0;
181 t
->vdau
[pgbuf
].clrfound
= true;
182 t
->vdau
[pgbuf
].stopped
= true;
183 t
->is_searching
[pgbuf
] = false;
192 if((err
=video_register_device(vd
, VFL_TYPE_VTX
,-1))<0)
200 i2c_attach_client(client
);
205 * We do most of the hard work when we become a device on the i2c.
208 static int saa5249_probe(struct i2c_adapter
*adap
)
210 if (adap
->class & I2C_CLASS_TV_ANALOG
)
211 return i2c_probe(adap
, &addr_data
, saa5249_attach
);
215 static int saa5249_detach(struct i2c_client
*client
)
217 struct video_device
*vd
= i2c_get_clientdata(client
);
218 i2c_detach_client(client
);
219 video_unregister_device(vd
);
226 /* new I2C driver support */
228 static struct i2c_driver i2c_driver_videotext
=
231 .name
= IF_NAME
, /* name */
233 .id
= I2C_DRIVERID_SAA5249
, /* in i2c.h */
234 .attach_adapter
= saa5249_probe
,
235 .detach_client
= saa5249_detach
,
238 static struct i2c_client client_template
= {
239 .driver
= &i2c_driver_videotext
,
244 * Wait the given number of jiffies (10ms). This calls the scheduler, so the actual
245 * delay may be longer.
248 static void jdelay(unsigned long delay
)
250 sigset_t oldblocked
= current
->blocked
;
252 spin_lock_irq(¤t
->sighand
->siglock
);
253 sigfillset(¤t
->blocked
);
255 spin_unlock_irq(¤t
->sighand
->siglock
);
256 msleep_interruptible(jiffies_to_msecs(delay
));
258 spin_lock_irq(¤t
->sighand
->siglock
);
259 current
->blocked
= oldblocked
;
261 spin_unlock_irq(¤t
->sighand
->siglock
);
269 static int i2c_sendbuf(struct saa5249_device
*t
, int reg
, int count
, u8
*data
)
274 memcpy(buf
+1, data
, count
);
276 if(i2c_master_send(t
->client
, buf
, count
+1)==count
+1)
281 static int i2c_senddata(struct saa5249_device
*t
, ...)
283 unsigned char buf
[64];
289 while ((v
= va_arg(argp
, int)) != -1)
293 return i2c_sendbuf(t
, buf
[0], ct
-1, buf
+1);
296 /* Get count number of bytes from I²C-device at address adr, store them in buf. Start & stop
297 * handshaking is done by this routine, ack will be sent after the last byte to inhibit further
298 * sending of data. If uaccess is 'true', data is written to user-space with put_user.
299 * Returns -1 if I²C-device didn't send acknowledge, 0 otherwise
302 static int i2c_getdata(struct saa5249_device
*t
, int count
, u8
*buf
)
304 if(i2c_master_recv(t
->client
, buf
, count
)!=count
)
311 * Standard character-device-driver functions
314 static int do_saa5249_ioctl(struct inode
*inode
, struct file
*file
,
315 unsigned int cmd
, void *arg
)
317 static int virtual_mode
= false;
318 struct video_device
*vd
= video_devdata(file
);
319 struct saa5249_device
*t
=vd
->priv
;
325 vtx_info_t
*info
= arg
;
326 info
->version_major
= VTX_VER_MAJ
;
327 info
->version_minor
= VTX_VER_MIN
;
328 info
->numpages
= NUM_DAUS
;
329 /*info->cct_type = CCT_TYPE;*/
335 vtx_pagereq_t
*req
= arg
;
337 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
339 memset(t
->vdau
[req
->pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
340 t
->vdau
[req
->pgbuf
].clrfound
= true;
346 vtx_pagereq_t
*req
= arg
;
348 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
350 t
->vdau
[req
->pgbuf
].clrfound
= true;
356 vtx_pagereq_t
*req
= arg
;
357 if (!(req
->pagemask
& PGMASK_PAGE
))
359 if (!(req
->pagemask
& PGMASK_HOUR
))
361 if (!(req
->pagemask
& PGMASK_MINUTE
))
363 if (req
->page
< 0 || req
->page
> 0x8ff) /* 7FF ?? */
366 if (req
->hour
< 0 || req
->hour
> 0x3f || req
->minute
< 0 || req
->minute
> 0x7f ||
367 req
->pagemask
< 0 || req
->pagemask
>= PGMASK_MAX
|| req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
369 t
->vdau
[req
->pgbuf
].sregs
[0] = (req
->pagemask
& PG_HUND
? 0x10 : 0) | (req
->page
/ 0x100);
370 t
->vdau
[req
->pgbuf
].sregs
[1] = (req
->pagemask
& PG_TEN
? 0x10 : 0) | ((req
->page
/ 0x10) & 0xf);
371 t
->vdau
[req
->pgbuf
].sregs
[2] = (req
->pagemask
& PG_UNIT
? 0x10 : 0) | (req
->page
& 0xf);
372 t
->vdau
[req
->pgbuf
].sregs
[3] = (req
->pagemask
& HR_TEN
? 0x10 : 0) | (req
->hour
/ 0x10);
373 t
->vdau
[req
->pgbuf
].sregs
[4] = (req
->pagemask
& HR_UNIT
? 0x10 : 0) | (req
->hour
& 0xf);
374 t
->vdau
[req
->pgbuf
].sregs
[5] = (req
->pagemask
& MIN_TEN
? 0x10 : 0) | (req
->minute
/ 0x10);
375 t
->vdau
[req
->pgbuf
].sregs
[6] = (req
->pagemask
& MIN_UNIT
? 0x10 : 0) | (req
->minute
& 0xf);
376 t
->vdau
[req
->pgbuf
].stopped
= false;
377 t
->vdau
[req
->pgbuf
].clrfound
= true;
378 t
->is_searching
[req
->pgbuf
] = true;
384 vtx_pagereq_t
*req
= arg
;
389 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
391 if (!t
->vdau
[req
->pgbuf
].stopped
)
393 if (i2c_senddata(t
, 2, 0, -1) ||
394 i2c_sendbuf(t
, 3, sizeof(t
->vdau
[0].sregs
), t
->vdau
[req
->pgbuf
].sregs
) ||
395 i2c_senddata(t
, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
396 i2c_senddata(t
, 2, 0, t
->vdau
[req
->pgbuf
].sregs
[0] | 8, -1) ||
397 i2c_senddata(t
, 8, 0, 25, 0, -1))
400 if (i2c_getdata(t
, 10, infobits
))
403 if (!(infobits
[8] & 0x10) && !(infobits
[7] & 0xf0) && /* check FOUND-bit */
404 (memcmp(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
)) ||
405 time_after_eq(jiffies
, t
->vdau
[req
->pgbuf
].expire
)))
406 { /* check if new page arrived */
407 if (i2c_senddata(t
, 8, 0, 0, 0, -1) ||
408 i2c_getdata(t
, VTX_PAGESIZE
, t
->vdau
[req
->pgbuf
].pgbuf
))
410 t
->vdau
[req
->pgbuf
].expire
= jiffies
+ PGBUF_EXPIRE
;
411 memset(t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
, ' ', VTX_VIRTUALSIZE
- VTX_PAGESIZE
);
415 if (i2c_senddata(t
, 8, 0, 0x20, 0, -1) ||
416 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 20 * 40))
419 if (i2c_senddata(t
, 8, 0, 0x21, 0, -1) ||
420 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 16 * 40))
422 /* Packet 8/30/0...8/30/15
423 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
424 * so we should undo this here.
426 if (i2c_senddata(t
, 8, 0, 0x22, 0, -1) ||
427 i2c_getdata(t
, 40, t
->vdau
[req
->pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 23 * 40))
430 t
->vdau
[req
->pgbuf
].clrfound
= false;
431 memcpy(t
->vdau
[req
->pgbuf
].laststat
, infobits
, sizeof(infobits
));
435 memcpy(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
));
440 memcpy(infobits
, t
->vdau
[req
->pgbuf
].laststat
, sizeof(infobits
));
443 info
.pagenum
= ((infobits
[8] << 8) & 0x700) | ((infobits
[1] << 4) & 0xf0) | (infobits
[0] & 0x0f);
444 if (info
.pagenum
< 0x100)
445 info
.pagenum
+= 0x800;
446 info
.hour
= ((infobits
[5] << 4) & 0x30) | (infobits
[4] & 0x0f);
447 info
.minute
= ((infobits
[3] << 4) & 0x70) | (infobits
[2] & 0x0f);
448 info
.charset
= ((infobits
[7] >> 1) & 7);
449 info
.delete = !!(infobits
[3] & 8);
450 info
.headline
= !!(infobits
[5] & 4);
451 info
.subtitle
= !!(infobits
[5] & 8);
452 info
.supp_header
= !!(infobits
[6] & 1);
453 info
.update
= !!(infobits
[6] & 2);
454 info
.inter_seq
= !!(infobits
[6] & 4);
455 info
.dis_disp
= !!(infobits
[6] & 8);
456 info
.serial
= !!(infobits
[7] & 1);
457 info
.notfound
= !!(infobits
[8] & 0x10);
458 info
.pblf
= !!(infobits
[9] & 0x20);
460 for (a
= 0; a
<= 7; a
++)
462 if (infobits
[a
] & 0xf0)
468 if (t
->vdau
[req
->pgbuf
].clrfound
)
470 if(copy_to_user(req
->buffer
, &info
, sizeof(vtx_pageinfo_t
)))
472 if (!info
.hamming
&& !info
.notfound
)
474 t
->is_searching
[req
->pgbuf
] = false;
481 vtx_pagereq_t
*req
= arg
;
484 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
|| req
->start
< 0 ||
485 req
->start
> req
->end
|| req
->end
>= (virtual_mode
? VTX_VIRTUALSIZE
: VTX_PAGESIZE
))
487 if(copy_to_user(req
->buffer
, &t
->vdau
[req
->pgbuf
].pgbuf
[req
->start
], req
->end
- req
->start
+ 1))
491 * Always read the time directly from SAA5249
494 if (req
->start
<= 39 && req
->end
>= 32)
498 start
= max(req
->start
, 32);
499 end
= min(req
->end
, 39);
501 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
502 i2c_getdata(t
, len
, buf
))
504 if(copy_to_user(req
->buffer
+start
-req
->start
, buf
, len
))
507 /* Insert the current header if DAU is still searching for a page */
508 if (req
->start
<= 31 && req
->end
>= 7 && t
->is_searching
[req
->pgbuf
])
512 start
= max(req
->start
, 7);
513 end
= min(req
->end
, 31);
515 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
516 i2c_getdata(t
, len
, buf
))
518 if(copy_to_user(req
->buffer
+start
-req
->start
, buf
, len
))
526 vtx_pagereq_t
*req
= arg
;
528 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
530 t
->vdau
[req
->pgbuf
].stopped
= true;
531 t
->is_searching
[req
->pgbuf
] = false;
542 if (i2c_senddata(t
, 0, NUM_DAUS
, 0, 8, -1) || i2c_senddata(t
, 11,
543 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',
544 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ', -1))
546 if (i2c_senddata(t
, 3, 0x20, -1))
548 jdelay(10 * CLEAR_DELAY
); /* I have no idea how long we have to wait here */
554 /* The SAA5249 has virtual-row reception turned on always */
555 t
->virtual_mode
= (int)(long)arg
;
563 * Translates old vtx IOCTLs to new ones
565 * This keeps new kernel versions compatible with old userspace programs.
567 static inline unsigned int vtx_fix_command(unsigned int cmd
)
570 case VTXIOCGETINFO_OLD
:
573 case VTXIOCCLRPAGE_OLD
:
576 case VTXIOCCLRFOUND_OLD
:
577 cmd
= VTXIOCCLRFOUND
;
579 case VTXIOCPAGEREQ_OLD
:
582 case VTXIOCGETSTAT_OLD
:
585 case VTXIOCGETPAGE_OLD
:
588 case VTXIOCSTOPDAU_OLD
:
591 case VTXIOCPUTPAGE_OLD
:
594 case VTXIOCSETDISP_OLD
:
597 case VTXIOCPUTSTAT_OLD
:
600 case VTXIOCCLRCACHE_OLD
:
601 cmd
= VTXIOCCLRCACHE
;
603 case VTXIOCSETVIRT_OLD
:
614 static int saa5249_ioctl(struct inode
*inode
, struct file
*file
,
615 unsigned int cmd
, unsigned long arg
)
617 struct video_device
*vd
= video_devdata(file
);
618 struct saa5249_device
*t
=vd
->priv
;
621 cmd
= vtx_fix_command(cmd
);
622 mutex_lock(&t
->lock
);
623 err
= video_usercopy(inode
,file
,cmd
,arg
,do_saa5249_ioctl
);
624 mutex_unlock(&t
->lock
);
628 static int saa5249_open(struct inode
*inode
, struct file
*file
)
630 struct video_device
*vd
= video_devdata(file
);
631 struct saa5249_device
*t
=vd
->priv
;
634 err
= video_exclusive_open(inode
,file
);
638 if (t
->client
==NULL
) {
643 if (i2c_senddata(t
, 0, 0, -1) || /* Select R11 */
644 /* Turn off parity checks (we do this ourselves) */
645 i2c_senddata(t
, 1, disp_modes
[t
->disp_mode
][0], 0, -1) ||
646 /* Display TV-picture, no virtual rows */
647 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 */
654 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++)
656 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
657 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
658 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
659 t
->vdau
[pgbuf
].expire
= 0;
660 t
->vdau
[pgbuf
].clrfound
= true;
661 t
->vdau
[pgbuf
].stopped
= true;
662 t
->is_searching
[pgbuf
] = false;
664 t
->virtual_mode
= false;
668 video_exclusive_release(inode
,file
);
674 static int saa5249_release(struct inode
*inode
, struct file
*file
)
676 struct video_device
*vd
= video_devdata(file
);
677 struct saa5249_device
*t
=vd
->priv
;
678 i2c_senddata(t
, 1, 0x20, -1); /* Turn off CCT */
679 i2c_senddata(t
, 5, 3, 3, -1); /* Turn off TV-display */
680 video_exclusive_release(inode
,file
);
684 static int __init
init_saa_5249 (void)
686 printk(KERN_INFO
"SAA5249 driver (" IF_NAME
" interface) for VideoText version %d.%d\n",
687 VTX_VER_MAJ
, VTX_VER_MIN
);
688 return i2c_add_driver(&i2c_driver_videotext
);
691 static void __exit
cleanup_saa_5249 (void)
693 i2c_del_driver(&i2c_driver_videotext
);
696 module_init(init_saa_5249
);
697 module_exit(cleanup_saa_5249
);
699 static const struct file_operations saa_fops
= {
700 .owner
= THIS_MODULE
,
701 .open
= saa5249_open
,
702 .release
= saa5249_release
,
703 .ioctl
= saa5249_ioctl
,
705 .compat_ioctl
= v4l_compat_ioctl32
,
710 static struct video_device saa_template
=
712 .owner
= THIS_MODULE
,
714 .type
= VID_TYPE_TELETEXT
, /*| VID_TYPE_TUNER ?? */
718 MODULE_LICENSE("GPL");