2 * Cleaned up to use existing videodev interface and allow the idea
3 * of multiple teletext decoders on the video4linux iface. Changed i2c
4 * to cover addressing clashes on device busses. It's also rebuilt so
5 * you can add arbitary multiple teletext devices to Linux video4linux
6 * now (well 32 anyway).
8 * Alan Cox <Alan.Cox@linux.org>
10 * The original driver was heavily modified to match the i2c interface
11 * It was truncated to use the WinTV boards, too.
13 * Copyright (c) 1998 Richard Guenther <richard.guenther@student.uni-tuebingen.de>
15 * $Id: saa5249.c,v 1.1 1998/03/30 22:23:23 alan Exp $
20 * This is a loadable character-device-driver for videotext-interfaces
21 * (aka teletext). Please check the Makefile/README for a list of supported
24 * Copyright (c) 1994-97 Martin Buck <martin-2.buck@student.uni-ulm.de>
27 * This program is free software; you can redistribute it and/or modify
28 * it under the terms of the GNU General Public License as published by
29 * the Free Software Foundation; either version 2 of the License, or
30 * (at your option) any later version.
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 * You should have received a copy of the GNU General Public License
38 * along with this program; if not, write to the Free Software
39 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
43 #include <linux/module.h>
44 #include <linux/kernel.h>
45 #include <linux/sched.h>
47 #include <linux/errno.h>
48 #include <linux/delay.h>
49 #include <linux/ioport.h>
50 #include <linux/slab.h>
51 #include <linux/init.h>
53 #include <linux/i2c.h>
54 #include <linux/videotext.h>
55 #include <linux/videodev.h>
58 #include <asm/uaccess.h>
67 #define IF_NAME "SAA5249"
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 (300*HZ/1000) /* Time between requesting page and */
84 /* checking status bits */
85 #define PGBUF_EXPIRE (15*HZ) /* 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
;
108 #define CCTWR 34 /* I²C write/read-address of vtx-chip */
110 #define NOACK_REPEAT 10 /* Retry access this many times on failure */
111 #define CLEAR_DELAY (HZ/20) /* Time required to clear a page */
112 #define READY_TIMEOUT (30*HZ/1000) /* Time to wait for ready signal of I²C-bus interface */
113 #define INIT_DELAY 500 /* Time in usec to wait at initialization of CEA interface */
114 #define START_DELAY 10 /* Time in usec to wait before starting write-cycle (CEA) */
116 #define VTX_DEV_MINOR 0
118 /* General defines and debugging support */
125 #define MIN(a, b) ((a) < (b) ? (a) : (b))
126 #define MAX(a, b) ((a) > (b) ? (a) : (b))
131 if (current->need_resched) \
135 static struct video_device saa_template
; /* Declared near bottom */
137 /* Addresses to scan */
138 static unsigned short normal_i2c
[] = {34>>1,I2C_CLIENT_END
};
139 static unsigned short normal_i2c_range
[] = {I2C_CLIENT_END
};
140 static unsigned short probe
[2] = { I2C_CLIENT_END
, I2C_CLIENT_END
};
141 static unsigned short probe_range
[2] = { I2C_CLIENT_END
, I2C_CLIENT_END
};
142 static unsigned short ignore
[2] = { I2C_CLIENT_END
, I2C_CLIENT_END
};
143 static unsigned short ignore_range
[2] = { I2C_CLIENT_END
, I2C_CLIENT_END
};
144 static unsigned short force
[2] = { I2C_CLIENT_END
, I2C_CLIENT_END
};
146 static struct i2c_client_address_data addr_data
= {
147 normal_i2c
, normal_i2c_range
,
149 ignore
, ignore_range
,
153 static struct i2c_client client_template
;
155 static int saa5249_attach(struct i2c_adapter
*adap
, int addr
, unsigned short flags
, int kind
)
159 struct i2c_client
*client
;
160 struct video_device
*vd
;
161 struct saa5249_device
*t
;
163 printk(KERN_INFO
"saa5249: teletext chip found.\n");
164 client
=kmalloc(sizeof(*client
), GFP_KERNEL
);
167 client_template
.adapter
= adap
;
168 client_template
.addr
= addr
;
169 memcpy(client
, &client_template
, sizeof(*client
));
170 t
= kmalloc(sizeof(*t
), GFP_KERNEL
);
176 memset(t
, 0, sizeof(*t
));
177 strcpy(client
->name
, IF_NAME
);
180 * Now create a video4linux device
183 client
->data
= vd
=(struct video_device
*)kmalloc(sizeof(struct video_device
), GFP_KERNEL
);
190 memcpy(vd
, &saa_template
, sizeof(*vd
));
192 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++)
194 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
195 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
196 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
197 t
->vdau
[pgbuf
].expire
= 0;
198 t
->vdau
[pgbuf
].clrfound
= TRUE
;
199 t
->vdau
[pgbuf
].stopped
= TRUE
;
200 t
->is_searching
[pgbuf
] = FALSE
;
208 if((err
=video_register_device(vd
, VFL_TYPE_VTX
))<0)
216 i2c_attach_client(client
);
222 * We do most of the hard work when we become a device on the i2c.
225 static int saa5249_probe(struct i2c_adapter
*adap
)
227 /* Only attach these chips to the BT848 bus for now */
229 if (adap
->id
== (I2C_ALGO_BIT
| I2C_HW_B_BT848
))
231 return i2c_probe(adap
, &addr_data
, saa5249_attach
);
236 static int saa5249_detach(struct i2c_client
*client
)
238 struct video_device
*vd
=client
->data
;
239 i2c_detach_client(client
);
240 video_unregister_device(vd
);
248 static int saa5249_command(struct i2c_client
*device
,
249 unsigned int cmd
, void *arg
)
254 /* new I2C driver support */
256 static struct i2c_driver i2c_driver_videotext
=
259 I2C_DRIVERID_SAA5249
, /* in i2c.h */
266 static struct i2c_client client_template
= {
272 &i2c_driver_videotext
276 * Wait the given number of jiffies (10ms). This calls the scheduler, so the actual
277 * delay may be longer.
280 static void jdelay(unsigned long delay
)
282 sigset_t oldblocked
= current
->blocked
;
284 spin_lock_irq(¤t
->sigmask_lock
);
285 sigfillset(¤t
->blocked
);
286 recalc_sigpending(current
);
287 spin_unlock_irq(¤t
->sigmask_lock
);
288 current
->state
= TASK_INTERRUPTIBLE
;
289 schedule_timeout(delay
);
291 spin_lock_irq(¤t
->sigmask_lock
);
292 current
->blocked
= oldblocked
;
293 recalc_sigpending(current
);
294 spin_unlock_irq(¤t
->sigmask_lock
);
302 static int i2c_sendbuf(struct saa5249_device
*t
, int reg
, int count
, u8
*data
)
307 memcpy(buf
+1, data
, count
);
309 if(i2c_master_send(t
->client
, buf
, count
+1)==count
+1)
314 static int i2c_senddata(struct saa5249_device
*t
, ...)
316 unsigned char buf
[64];
322 while((v
=va_arg(argp
,int))!=-1)
324 return i2c_sendbuf(t
, buf
[0], ct
-1, buf
+1);
327 /* Get count number of bytes from I²C-device at address adr, store them in buf. Start & stop
328 * handshaking is done by this routine, ack will be sent after the last byte to inhibit further
329 * sending of data. If uaccess is TRUE, data is written to user-space with put_user.
330 * Returns -1 if I²C-device didn't send acknowledge, 0 otherwise
333 static int i2c_getdata(struct saa5249_device
*t
, int count
, u8
*buf
)
335 if(i2c_master_recv(t
->client
, buf
, count
)!=count
)
342 * Standard character-device-driver functions
345 static int saa5249_ioctl(struct video_device
*vd
, unsigned int cmd
, void *arg
)
347 struct saa5249_device
*t
=vd
->priv
;
348 static int virtual_mode
= FALSE
;
355 info
.version_major
= VTX_VER_MAJ
;
356 info
.version_minor
= VTX_VER_MIN
;
357 info
.numpages
= NUM_DAUS
;
358 /*info.cct_type = CCT_TYPE;*/
359 if(copy_to_user((void*)arg
, &info
, sizeof(vtx_info_t
)))
368 if(copy_from_user(&req
, (void*)arg
, sizeof(vtx_pagereq_t
)))
370 if (req
.pgbuf
< 0 || req
.pgbuf
>= NUM_DAUS
)
372 memset(t
->vdau
[req
.pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
373 t
->vdau
[req
.pgbuf
].clrfound
= TRUE
;
381 if(copy_from_user(&req
, (void*)arg
, sizeof(vtx_pagereq_t
)))
383 if (req
.pgbuf
< 0 || req
.pgbuf
>= NUM_DAUS
)
385 t
->vdau
[req
.pgbuf
].clrfound
= TRUE
;
392 if(copy_from_user(&req
, (void*)arg
, sizeof(vtx_pagereq_t
)))
394 if (!(req
.pagemask
& PGMASK_PAGE
))
396 if (!(req
.pagemask
& PGMASK_HOUR
))
398 if (!(req
.pagemask
& PGMASK_MINUTE
))
400 if (req
.page
< 0 || req
.page
> 0x8ff) /* 7FF ?? */
403 if (req
.hour
< 0 || req
.hour
> 0x3f || req
.minute
< 0 || req
.minute
> 0x7f ||
404 req
.pagemask
< 0 || req
.pagemask
>= PGMASK_MAX
|| req
.pgbuf
< 0 || req
.pgbuf
>= NUM_DAUS
)
406 t
->vdau
[req
.pgbuf
].sregs
[0] = (req
.pagemask
& PG_HUND
? 0x10 : 0) | (req
.page
/ 0x100);
407 t
->vdau
[req
.pgbuf
].sregs
[1] = (req
.pagemask
& PG_TEN
? 0x10 : 0) | ((req
.page
/ 0x10) & 0xf);
408 t
->vdau
[req
.pgbuf
].sregs
[2] = (req
.pagemask
& PG_UNIT
? 0x10 : 0) | (req
.page
& 0xf);
409 t
->vdau
[req
.pgbuf
].sregs
[3] = (req
.pagemask
& HR_TEN
? 0x10 : 0) | (req
.hour
/ 0x10);
410 t
->vdau
[req
.pgbuf
].sregs
[4] = (req
.pagemask
& HR_UNIT
? 0x10 : 0) | (req
.hour
& 0xf);
411 t
->vdau
[req
.pgbuf
].sregs
[5] = (req
.pagemask
& MIN_TEN
? 0x10 : 0) | (req
.minute
/ 0x10);
412 t
->vdau
[req
.pgbuf
].sregs
[6] = (req
.pagemask
& MIN_UNIT
? 0x10 : 0) | (req
.minute
& 0xf);
413 t
->vdau
[req
.pgbuf
].stopped
= FALSE
;
414 t
->vdau
[req
.pgbuf
].clrfound
= TRUE
;
415 t
->is_searching
[req
.pgbuf
] = TRUE
;
426 if(copy_from_user(&req
, (void*)arg
, sizeof(vtx_pagereq_t
)))
428 if (req
.pgbuf
< 0 || req
.pgbuf
>= NUM_DAUS
)
430 if (!t
->vdau
[req
.pgbuf
].stopped
)
432 if (i2c_senddata(t
, 2, 0, -1) ||
433 i2c_sendbuf(t
, 3, sizeof(t
->vdau
[0].sregs
), t
->vdau
[req
.pgbuf
].sregs
) ||
434 i2c_senddata(t
, 8, 0, 25, 0, ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', -1) ||
435 i2c_senddata(t
, 2, 0, t
->vdau
[req
.pgbuf
].sregs
[0] | 8, -1) ||
436 i2c_senddata(t
, 8, 0, 25, 0, -1))
439 if (i2c_getdata(t
, 10, infobits
))
442 if (!(infobits
[8] & 0x10) && !(infobits
[7] & 0xf0) && /* check FOUND-bit */
443 (memcmp(infobits
, t
->vdau
[req
.pgbuf
].laststat
, sizeof(infobits
)) ||
444 time_after_eq(jiffies
, t
->vdau
[req
.pgbuf
].expire
)))
445 { /* check if new page arrived */
446 if (i2c_senddata(t
, 8, 0, 0, 0, -1) ||
447 i2c_getdata(t
, VTX_PAGESIZE
, t
->vdau
[req
.pgbuf
].pgbuf
))
449 t
->vdau
[req
.pgbuf
].expire
= jiffies
+ PGBUF_EXPIRE
;
450 memset(t
->vdau
[req
.pgbuf
].pgbuf
+ VTX_PAGESIZE
, ' ', VTX_VIRTUALSIZE
- VTX_PAGESIZE
);
454 if (i2c_senddata(t
, 8, 0, 0x20, 0, -1) ||
455 i2c_getdata(t
, 40, t
->vdau
[req
.pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 20 * 40))
458 if (i2c_senddata(t
, 8, 0, 0x21, 0, -1) ||
459 i2c_getdata(t
, 40, t
->vdau
[req
.pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 16 * 40))
461 /* Packet 8/30/0...8/30/15
462 * FIXME: AFAIK, the 5249 does hamming-decoding for some bytes in packet 8/30,
463 * so we should undo this here.
465 if (i2c_senddata(t
, 8, 0, 0x22, 0, -1) ||
466 i2c_getdata(t
, 40, t
->vdau
[req
.pgbuf
].pgbuf
+ VTX_PAGESIZE
+ 23 * 40))
469 t
->vdau
[req
.pgbuf
].clrfound
= FALSE
;
470 memcpy(t
->vdau
[req
.pgbuf
].laststat
, infobits
, sizeof(infobits
));
474 memcpy(infobits
, t
->vdau
[req
.pgbuf
].laststat
, sizeof(infobits
));
479 memcpy(infobits
, t
->vdau
[req
.pgbuf
].laststat
, sizeof(infobits
));
482 info
.pagenum
= ((infobits
[8] << 8) & 0x700) | ((infobits
[1] << 4) & 0xf0) | (infobits
[0] & 0x0f);
483 if (info
.pagenum
< 0x100)
484 info
.pagenum
+= 0x800;
485 info
.hour
= ((infobits
[5] << 4) & 0x30) | (infobits
[4] & 0x0f);
486 info
.minute
= ((infobits
[3] << 4) & 0x70) | (infobits
[2] & 0x0f);
487 info
.charset
= ((infobits
[7] >> 1) & 7);
488 info
.delete = !!(infobits
[3] & 8);
489 info
.headline
= !!(infobits
[5] & 4);
490 info
.subtitle
= !!(infobits
[5] & 8);
491 info
.supp_header
= !!(infobits
[6] & 1);
492 info
.update
= !!(infobits
[6] & 2);
493 info
.inter_seq
= !!(infobits
[6] & 4);
494 info
.dis_disp
= !!(infobits
[6] & 8);
495 info
.serial
= !!(infobits
[7] & 1);
496 info
.notfound
= !!(infobits
[8] & 0x10);
497 info
.pblf
= !!(infobits
[9] & 0x20);
499 for (a
= 0; a
<= 7; a
++)
501 if (infobits
[a
] & 0xf0)
507 if (t
->vdau
[req
.pgbuf
].clrfound
)
509 if(copy_to_user(req
.buffer
, &info
, sizeof(vtx_pageinfo_t
)))
511 if (!info
.hamming
&& !info
.notfound
)
513 t
->is_searching
[req
.pgbuf
] = FALSE
;
523 if(copy_from_user(&req
, (void*)arg
, sizeof(vtx_pagereq_t
)))
525 if (req
.pgbuf
< 0 || req
.pgbuf
>= NUM_DAUS
|| req
.start
< 0 ||
526 req
.start
> req
.end
|| req
.end
>= (virtual_mode
? VTX_VIRTUALSIZE
: VTX_PAGESIZE
))
528 if(copy_to_user(req
.buffer
, &t
->vdau
[req
.pgbuf
].pgbuf
[req
.start
], req
.end
- req
.start
+ 1))
532 * Always read the time directly from SAA5249
535 if (req
.start
<= 39 && req
.end
>= 32)
539 start
= MAX(req
.start
, 32);
540 end
= MIN(req
.end
, 39);
542 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
543 i2c_getdata(t
, len
, buf
))
545 if(copy_to_user(req
.buffer
+start
-req
.start
, buf
, len
))
548 /* Insert the current header if DAU is still searching for a page */
549 if (req
.start
<= 31 && req
.end
>= 7 && t
->is_searching
[req
.pgbuf
])
553 start
= MAX(req
.start
, 7);
554 end
= MIN(req
.end
, 31);
556 if (i2c_senddata(t
, 8, 0, 0, start
, -1) ||
557 i2c_getdata(t
, len
, buf
))
559 if(copy_to_user(req
.buffer
+start
-req
.start
, buf
, len
))
569 if(copy_from_user(&req
, (void*)arg
, sizeof(vtx_pagereq_t
)))
571 if (req
.pgbuf
< 0 || req
.pgbuf
>= NUM_DAUS
)
573 t
->vdau
[req
.pgbuf
].stopped
= TRUE
;
574 t
->is_searching
[req
.pgbuf
] = FALSE
;
585 if (i2c_senddata(t
, 0, NUM_DAUS
, 0, 8, -1) || i2c_senddata(t
, 11,
586 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',
587 ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',' ', -1))
589 if (i2c_senddata(t
, 3, 0x20, -1))
591 jdelay(10 * CLEAR_DELAY
); /* I have no idea how long we have to wait here */
597 /* The SAA5249 has virtual-row reception turned on always */
598 t
->virtual_mode
= (int)arg
;
606 static int saa5249_open(struct video_device
*vd
, int nb
)
608 struct saa5249_device
*t
=vd
->priv
;
614 if (i2c_senddata(t
, 0, 0, -1) || /* Select R11 */
615 /* Turn off parity checks (we do this ourselves) */
616 i2c_senddata(t
, 1, disp_modes
[t
->disp_mode
][0], 0, -1) ||
617 /* Display TV-picture, no virtual rows */
618 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 */
624 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++)
626 memset(t
->vdau
[pgbuf
].pgbuf
, ' ', sizeof(t
->vdau
[0].pgbuf
));
627 memset(t
->vdau
[pgbuf
].sregs
, 0, sizeof(t
->vdau
[0].sregs
));
628 memset(t
->vdau
[pgbuf
].laststat
, 0, sizeof(t
->vdau
[0].laststat
));
629 t
->vdau
[pgbuf
].expire
= 0;
630 t
->vdau
[pgbuf
].clrfound
= TRUE
;
631 t
->vdau
[pgbuf
].stopped
= TRUE
;
632 t
->is_searching
[pgbuf
] = FALSE
;
634 t
->virtual_mode
=FALSE
;
641 static void saa5249_release(struct video_device
*vd
)
643 struct saa5249_device
*t
=vd
->priv
;
644 i2c_senddata(t
, 1, 0x20, -1); /* Turn off CCT */
645 i2c_senddata(t
, 5, 3, 3, -1); /* Turn off TV-display */
650 static long saa5249_write(struct video_device
*v
, const char *buf
, unsigned long l
, int nb
)
655 static int __init
init_saa_5249 (void)
657 printk(KERN_INFO
"SAA5249 driver (" IF_NAME
" interface) for VideoText version %d.%d\n",
658 VTX_VER_MAJ
, VTX_VER_MIN
);
659 return i2c_add_driver(&i2c_driver_videotext
);
662 static void __exit
cleanup_saa_5249 (void)
664 i2c_del_driver(&i2c_driver_videotext
);
667 module_init(init_saa_5249
);
668 module_exit(cleanup_saa_5249
);
670 static struct video_device saa_template
=
673 VID_TYPE_TELETEXT
, /*| VID_TYPE_TUNER ?? */
674 VID_HARDWARE_SAA5249
,
681 /* the rest are null */