2 * Driver for the SAA5246A or SAA5281 Teletext (=Videotext) decoder chips from
5 * Only capturing of Teletext pages is tested. The videotext chips also have a
6 * TV output but my hardware doesn't use it. For this reason this driver does
7 * not support changing any TV display settings.
9 * Copyright (C) 2004 Michael Geng <linux@MichaelGeng.de>
14 * Copyright (C) 1998 Richard Guenther
15 * <richard.guenther@student.uni-tuebingen.de>
18 * Alan Cox <Alan.Cox@linux.org>
23 * Copyright (C) 1994-97 Martin Buck <martin-2.buck@student.uni-ulm.de>
25 * This program is free software; you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation; either version 2 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program; if not, write to the Free Software
37 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
41 #include <linux/module.h>
42 #include <linux/kernel.h>
43 #include <linux/sched.h>
45 #include <linux/init.h>
46 #include <linux/i2c.h>
47 #include <linux/videotext.h>
48 #include <linux/videodev.h>
51 MODULE_AUTHOR("Michael Geng <linux@MichaelGeng.de>");
52 MODULE_DESCRIPTION("Philips SAA5246A, SAA5281 Teletext decoder driver");
53 MODULE_LICENSE("GPL");
55 struct saa5246a_device
57 u8 pgbuf[NUM_DAUS][VTX_VIRTUALSIZE];
58 int is_searching[NUM_DAUS];
59 struct i2c_client *client;
60 struct semaphore lock;
63 static struct video_device saa_template; /* Declared near bottom */
65 /* Addresses to scan */
66 static unsigned short normal_i2c[] = { I2C_ADDRESS, I2C_CLIENT_END };
69 static struct i2c_client client_template;
71 static int saa5246a_attach(struct i2c_adapter *adap, int addr, int kind)
75 struct i2c_client *client;
76 struct video_device *vd;
77 struct saa5246a_device *t;
79 printk(KERN_INFO "saa5246a: teletext chip found.\n");
80 client=kmalloc(sizeof(*client), GFP_KERNEL);
83 client_template.adapter = adap;
84 client_template.addr = addr;
85 memcpy(client, &client_template, sizeof(*client));
86 t = kzalloc(sizeof(*t), GFP_KERNEL);
92 strlcpy(client->name, IF_NAME, I2C_NAME_SIZE);
96 * Now create a video4linux device
99 vd = video_device_alloc();
106 i2c_set_clientdata(client, vd);
107 memcpy(vd, &saa_template, sizeof(*vd));
109 for (pgbuf = 0; pgbuf < NUM_DAUS; pgbuf++)
111 memset(t->pgbuf[pgbuf], ' ', sizeof(t->pgbuf[0]));
112 t->is_searching[pgbuf] = FALSE;
121 if((err=video_register_device(vd, VFL_TYPE_VTX,-1))<0)
125 video_device_release(vd);
129 i2c_attach_client(client);
134 * We do most of the hard work when we become a device on the i2c.
136 static int saa5246a_probe(struct i2c_adapter *adap)
138 if (adap->class & I2C_CLASS_TV_ANALOG)
139 return i2c_probe(adap, &addr_data, saa5246a_attach);
143 static int saa5246a_detach(struct i2c_client *client)
145 struct video_device *vd = i2c_get_clientdata(client);
146 i2c_detach_client(client);
147 video_unregister_device(vd);
157 static struct i2c_driver i2c_driver_videotext =
160 .name = IF_NAME, /* name */
162 .id = I2C_DRIVERID_SAA5249, /* in i2c.h */
163 .attach_adapter = saa5246a_probe,
164 .detach_client = saa5246a_detach,
167 static struct i2c_client client_template = {
168 .driver = &i2c_driver_videotext,
172 static int i2c_sendbuf(struct saa5246a_device *t, int reg, int count, u8 *data)
177 memcpy(buf+1, data, count);
179 if(i2c_master_send(t->client, buf, count+1)==count+1)
184 static int i2c_senddata(struct saa5246a_device *t, ...)
186 unsigned char buf[64];
192 while((v=va_arg(argp,int))!=-1)
194 return i2c_sendbuf(t, buf[0], ct-1, buf+1);
197 /* Get count number of bytes from I²C-device at address adr, store them in buf.
198 * Start & stop handshaking is done by this routine, ack will be sent after the
199 * last byte to inhibit further sending of data. If uaccess is TRUE, data is
200 * written to user-space with put_user. Returns -1 if I²C-device didn't send
201 * acknowledge, 0 otherwise
203 static int i2c_getdata(struct saa5246a_device *t, int count, u8 *buf)
205 if(i2c_master_recv(t->client, buf, count)!=count)
210 /* When a page is found then the not FOUND bit in one of the status registers
211 * of the SAA5264A chip is cleared. Unfortunately this bit is not set
212 * automatically when a new page is requested. Instead this function must be
213 * called after a page has been requested.
215 * Return value: 0 if successful
217 static int saa5246a_clear_found_bit(struct saa5246a_device *t,
218 unsigned char dau_no)
220 unsigned char row_25_column_8;
222 if (i2c_senddata(t, SAA5246A_REGISTER_R8,
225 R8_DO_NOT_CLEAR_MEMORY,
232 i2c_getdata(t, 1, &row_25_column_8))
236 row_25_column_8 |= ROW25_COLUMN8_PAGE_NOT_FOUND;
237 if (i2c_senddata(t, SAA5246A_REGISTER_R8,
240 R8_DO_NOT_CLEAR_MEMORY,
256 /* Requests one videotext page as described in req. The fields of req are
257 * checked and an error is returned if something is invalid.
259 * Return value: 0 if successful
261 static int saa5246a_request_page(struct saa5246a_device *t,
264 if (req->pagemask < 0 || req->pagemask >= PGMASK_MAX)
266 if (req->pagemask & PGMASK_PAGE)
267 if (req->page < 0 || req->page > PAGE_MAX)
269 if (req->pagemask & PGMASK_HOUR)
270 if (req->hour < 0 || req->hour > HOUR_MAX)
272 if (req->pagemask & PGMASK_MINUTE)
273 if (req->minute < 0 || req->minute > MINUTE_MAX)
275 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
278 if (i2c_senddata(t, SAA5246A_REGISTER_R2,
280 R2_IN_R3_SELECT_PAGE_HUNDREDS |
283 R2_HAMMING_CHECK_OFF,
285 HUNDREDS_OF_PAGE(req->page) |
287 (req->pagemask & PG_HUND ?
288 R3_PAGE_HUNDREDS_DO_CARE :
289 R3_PAGE_HUNDREDS_DO_NOT_CARE),
291 TENS_OF_PAGE(req->page) |
292 (req->pagemask & PG_TEN ?
293 R3_PAGE_TENS_DO_CARE :
294 R3_PAGE_TENS_DO_NOT_CARE),
296 UNITS_OF_PAGE(req->page) |
297 (req->pagemask & PG_UNIT ?
298 R3_PAGE_UNITS_DO_CARE :
299 R3_PAGE_UNITS_DO_NOT_CARE),
301 TENS_OF_HOUR(req->hour) |
302 (req->pagemask & HR_TEN ?
303 R3_HOURS_TENS_DO_CARE :
304 R3_HOURS_TENS_DO_NOT_CARE),
306 UNITS_OF_HOUR(req->hour) |
307 (req->pagemask & HR_UNIT ?
308 R3_HOURS_UNITS_DO_CARE :
309 R3_HOURS_UNITS_DO_NOT_CARE),
311 TENS_OF_MINUTE(req->minute) |
312 (req->pagemask & MIN_TEN ?
313 R3_MINUTES_TENS_DO_CARE :
314 R3_MINUTES_TENS_DO_NOT_CARE),
316 UNITS_OF_MINUTE(req->minute) |
317 (req->pagemask & MIN_UNIT ?
318 R3_MINUTES_UNITS_DO_CARE :
319 R3_MINUTES_UNITS_DO_NOT_CARE),
321 COMMAND_END) || i2c_senddata(t, SAA5246A_REGISTER_R2,
323 R2_IN_R3_SELECT_PAGE_HUNDREDS |
326 R2_HAMMING_CHECK_OFF,
328 HUNDREDS_OF_PAGE(req->page) |
330 (req->pagemask & PG_HUND ?
331 R3_PAGE_HUNDREDS_DO_CARE :
332 R3_PAGE_HUNDREDS_DO_NOT_CARE),
339 t->is_searching[req->pgbuf] = TRUE;
343 /* This routine decodes the page number from the infobits contained in line 25.
346 * infobits: must be bits 0 to 9 of column 25
348 * Return value: page number coded in hexadecimal, i. e. page 123 is coded 0x123
350 static inline int saa5246a_extract_pagenum_from_infobits(
351 unsigned char infobits[10])
353 int page_hundreds, page_tens, page_units;
355 page_units = infobits[0] & ROW25_COLUMN0_PAGE_UNITS;
356 page_tens = infobits[1] & ROW25_COLUMN1_PAGE_TENS;
357 page_hundreds = infobits[8] & ROW25_COLUMN8_PAGE_HUNDREDS;
359 /* page 0x.. means page 8.. */
360 if (page_hundreds == 0)
363 return((page_hundreds << 8) | (page_tens << 4) | page_units);
366 /* Decodes the hour from the infobits contained in line 25.
369 * infobits: must be bits 0 to 9 of column 25
371 * Return: hour coded in hexadecimal, i. e. 12h is coded 0x12
373 static inline int saa5246a_extract_hour_from_infobits(
374 unsigned char infobits[10])
376 int hour_tens, hour_units;
378 hour_units = infobits[4] & ROW25_COLUMN4_HOUR_UNITS;
379 hour_tens = infobits[5] & ROW25_COLUMN5_HOUR_TENS;
381 return((hour_tens << 4) | hour_units);
384 /* Decodes the minutes from the infobits contained in line 25.
387 * infobits: must be bits 0 to 9 of column 25
389 * Return: minutes coded in hexadecimal, i. e. 10min is coded 0x10
391 static inline int saa5246a_extract_minutes_from_infobits(
392 unsigned char infobits[10])
394 int minutes_tens, minutes_units;
396 minutes_units = infobits[2] & ROW25_COLUMN2_MINUTES_UNITS;
397 minutes_tens = infobits[3] & ROW25_COLUMN3_MINUTES_TENS;
399 return((minutes_tens << 4) | minutes_units);
402 /* Reads the status bits contained in the first 10 columns of the first line
403 * and extracts the information into info.
405 * Return value: 0 if successful
407 static inline int saa5246a_get_status(struct saa5246a_device *t,
408 vtx_pageinfo_t *info, unsigned char dau_no)
410 unsigned char infobits[10];
413 if (dau_no >= NUM_DAUS)
416 if (i2c_senddata(t, SAA5246A_REGISTER_R8,
419 R8_DO_NOT_CLEAR_MEMORY,
426 i2c_getdata(t, 10, infobits))
431 info->pagenum = saa5246a_extract_pagenum_from_infobits(infobits);
432 info->hour = saa5246a_extract_hour_from_infobits(infobits);
433 info->minute = saa5246a_extract_minutes_from_infobits(infobits);
434 info->charset = ((infobits[7] & ROW25_COLUMN7_CHARACTER_SET) >> 1);
435 info->delete = !!(infobits[3] & ROW25_COLUMN3_DELETE_PAGE);
436 info->headline = !!(infobits[5] & ROW25_COLUMN5_INSERT_HEADLINE);
437 info->subtitle = !!(infobits[5] & ROW25_COLUMN5_INSERT_SUBTITLE);
438 info->supp_header = !!(infobits[6] & ROW25_COLUMN6_SUPPRESS_HEADER);
439 info->update = !!(infobits[6] & ROW25_COLUMN6_UPDATE_PAGE);
440 info->inter_seq = !!(infobits[6] & ROW25_COLUMN6_INTERRUPTED_SEQUENCE);
441 info->dis_disp = !!(infobits[6] & ROW25_COLUMN6_SUPPRESS_DISPLAY);
442 info->serial = !!(infobits[7] & ROW25_COLUMN7_SERIAL_MODE);
443 info->notfound = !!(infobits[8] & ROW25_COLUMN8_PAGE_NOT_FOUND);
444 info->pblf = !!(infobits[9] & ROW25_COLUMN9_PAGE_BEING_LOOKED_FOR);
446 for (column = 0; column <= 7; column++) {
447 if (infobits[column] & ROW25_COLUMN0_TO_7_HAMMING_ERROR) {
452 if (!info->hamming && !info->notfound)
453 t->is_searching[dau_no] = FALSE;
457 /* Reads 1 videotext page buffer of the SAA5246A.
459 * req is used both as input and as output. It contains information which part
460 * must be read. The videotext page is copied into req->buffer.
462 * Return value: 0 if successful
464 static inline int saa5246a_get_page(struct saa5246a_device *t,
467 int start, end, size;
471 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS ||
472 req->start < 0 || req->start > req->end || req->end >= VTX_PAGESIZE)
475 buf = kmalloc(VTX_PAGESIZE, GFP_KERNEL);
479 /* Read "normal" part of page */
482 end = min(req->end, VTX_PAGESIZE - 1);
483 if (i2c_senddata(t, SAA5246A_REGISTER_R8,
484 req->pgbuf | R8_DO_NOT_CLEAR_MEMORY,
485 ROW(req->start), COLUMN(req->start), COMMAND_END))
487 if (i2c_getdata(t, end - req->start + 1, buf))
490 if (copy_to_user(req->buffer, buf, end - req->start + 1))
493 /* Always get the time from buffer 4, since this stupid SAA5246A only
494 * updates the currently displayed buffer...
496 if (REQ_CONTAINS_TIME(req)) {
497 start = max(req->start, POS_TIME_START);
498 end = min(req->end, POS_TIME_END);
499 size = end - start + 1;
504 if (i2c_senddata(t, SAA5246A_REGISTER_R8,
505 R8_ACTIVE_CHAPTER_4 | R8_DO_NOT_CLEAR_MEMORY,
506 R9_CURSER_ROW_0, start, COMMAND_END))
508 if (i2c_getdata(t, size, buf))
511 if (copy_to_user(req->buffer + start - req->start, buf, size))
514 /* Insert the header from buffer 4 only, if acquisition circuit is still searching for a page */
515 if (REQ_CONTAINS_HEADER(req) && t->is_searching[req->pgbuf]) {
516 start = max(req->start, POS_HEADER_START);
517 end = min(req->end, POS_HEADER_END);
518 size = end - start + 1;
523 if (i2c_senddata(t, SAA5246A_REGISTER_R8,
524 R8_ACTIVE_CHAPTER_4 | R8_DO_NOT_CLEAR_MEMORY,
525 R9_CURSER_ROW_0, start, COMMAND_END))
527 if (i2c_getdata(t, end - start + 1, buf))
530 if (copy_to_user(req->buffer + start - req->start, buf, size))
539 /* Stops the acquisition circuit given in dau_no. The page buffer associated
540 * with this acquisition circuit will no more be updated. The other daus are
543 * Return value: 0 if successful
545 static inline int saa5246a_stop_dau(struct saa5246a_device *t,
546 unsigned char dau_no)
548 if (dau_no >= NUM_DAUS)
550 if (i2c_senddata(t, SAA5246A_REGISTER_R2,
552 R2_IN_R3_SELECT_PAGE_HUNDREDS |
555 R2_HAMMING_CHECK_OFF,
559 R3_PAGE_HUNDREDS_DO_NOT_CARE,
565 t->is_searching[dau_no] = FALSE;
569 /* Handles ioctls defined in videotext.h
571 * Returns 0 if successful
573 static int do_saa5246a_ioctl(struct inode *inode, struct file *file,
574 unsigned int cmd, void *arg)
576 struct video_device *vd = video_devdata(file);
577 struct saa5246a_device *t=vd->priv;
582 vtx_info_t *info = arg;
584 info->version_major = MAJOR_VERSION;
585 info->version_minor = MINOR_VERSION;
586 info->numpages = NUM_DAUS;
592 vtx_pagereq_t *req = arg;
594 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
596 memset(t->pgbuf[req->pgbuf], ' ', sizeof(t->pgbuf[0]));
602 vtx_pagereq_t *req = arg;
604 if (req->pgbuf < 0 || req->pgbuf >= NUM_DAUS)
606 return(saa5246a_clear_found_bit(t, req->pgbuf));
611 vtx_pagereq_t *req = arg;
613 return(saa5246a_request_page(t, req));
618 vtx_pagereq_t *req = arg;
622 if ((rval = saa5246a_get_status(t, &info, req->pgbuf)))
624 if(copy_to_user(req->buffer, &info,
625 sizeof(vtx_pageinfo_t)))
632 vtx_pagereq_t *req = arg;
634 return(saa5246a_get_page(t, req));
639 vtx_pagereq_t *req = arg;
641 return(saa5246a_stop_dau(t, req->pgbuf));
656 /* I do not know what "virtual mode" means */
664 * Translates old vtx IOCTLs to new ones
666 * This keeps new kernel versions compatible with old userspace programs.
668 static inline unsigned int vtx_fix_command(unsigned int cmd)
671 case VTXIOCGETINFO_OLD:
674 case VTXIOCCLRPAGE_OLD:
677 case VTXIOCCLRFOUND_OLD:
678 cmd = VTXIOCCLRFOUND;
680 case VTXIOCPAGEREQ_OLD:
683 case VTXIOCGETSTAT_OLD:
686 case VTXIOCGETPAGE_OLD:
689 case VTXIOCSTOPDAU_OLD:
692 case VTXIOCPUTPAGE_OLD:
695 case VTXIOCSETDISP_OLD:
698 case VTXIOCPUTSTAT_OLD:
701 case VTXIOCCLRCACHE_OLD:
702 cmd = VTXIOCCLRCACHE;
704 case VTXIOCSETVIRT_OLD:
714 static int saa5246a_ioctl(struct inode *inode, struct file *file,
715 unsigned int cmd, unsigned long arg)
717 struct video_device *vd = video_devdata(file);
718 struct saa5246a_device *t = vd->priv;
721 cmd = vtx_fix_command(cmd);
723 err = video_usercopy(inode, file, cmd, arg, do_saa5246a_ioctl);
728 static int saa5246a_open(struct inode *inode, struct file *file)
730 struct video_device *vd = video_devdata(file);
731 struct saa5246a_device *t = vd->priv;
734 err = video_exclusive_open(inode,file);
738 if (t->client==NULL) {
743 if (i2c_senddata(t, SAA5246A_REGISTER_R0,
746 R0_PLL_TIME_CONSTANT_LONG |
747 R0_ENABLE_nODD_EVEN_OUTPUT |
749 R0_DO_NOT_FORCE_nODD_EVEN_LOW_IF_PICTURE_DISPLAYED |
751 R0_NO_AUTOMATIC_FASTEXT_PROMPT,
753 R1_NON_INTERLACED_312_312_LINES |
755 R1_EXTENDED_PACKET_DISABLE |
757 R1_8_BITS_NO_PARITY |
761 i2c_senddata(t, SAA5246A_REGISTER_R4,
763 /* We do not care much for the TV display but nevertheless we
764 * need the currently displayed page later because only on that
765 * page the time is updated. */
777 video_exclusive_release(inode,file);
781 static int saa5246a_release(struct inode *inode, struct file *file)
783 struct video_device *vd = video_devdata(file);
784 struct saa5246a_device *t = vd->priv;
786 /* Stop all acquisition circuits. */
787 i2c_senddata(t, SAA5246A_REGISTER_R1,
789 R1_INTERLACED_312_AND_HALF_312_AND_HALF_LINES |
791 R1_EXTENDED_PACKET_DISABLE |
793 R1_8_BITS_NO_PARITY |
797 video_exclusive_release(inode,file);
801 static int __init init_saa_5246a (void)
804 "SAA5246A (or compatible) Teletext decoder driver version %d.%d\n",
805 MAJOR_VERSION, MINOR_VERSION);
806 return i2c_add_driver(&i2c_driver_videotext);
809 static void __exit cleanup_saa_5246a (void)
811 i2c_del_driver(&i2c_driver_videotext);
814 module_init(init_saa_5246a);
815 module_exit(cleanup_saa_5246a);
817 static struct file_operations saa_fops = {
818 .owner = THIS_MODULE,
819 .open = saa5246a_open,
820 .release = saa5246a_release,
821 .ioctl = saa5246a_ioctl,
825 static struct video_device saa_template =
827 .owner = THIS_MODULE,
829 .type = VID_TYPE_TELETEXT,
830 .hardware = VID_HARDWARE_SAA5249,
832 .release = video_device_release,