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
= kmalloc(sizeof(*t
), GFP_KERNEL
);
92 memset(t
, 0, sizeof(*t
));
93 strlcpy(client
->name
, IF_NAME
, I2C_NAME_SIZE
);
97 * Now create a video4linux device
100 vd
= video_device_alloc();
107 i2c_set_clientdata(client
, vd
);
108 memcpy(vd
, &saa_template
, sizeof(*vd
));
110 for (pgbuf
= 0; pgbuf
< NUM_DAUS
; pgbuf
++)
112 memset(t
->pgbuf
[pgbuf
], ' ', sizeof(t
->pgbuf
[0]));
113 t
->is_searching
[pgbuf
] = FALSE
;
122 if((err
=video_register_device(vd
, VFL_TYPE_VTX
,-1))<0)
126 video_device_release(vd
);
130 i2c_attach_client(client
);
135 * We do most of the hard work when we become a device on the i2c.
137 static int saa5246a_probe(struct i2c_adapter
*adap
)
139 if (adap
->class & I2C_CLASS_TV_ANALOG
)
140 return i2c_probe(adap
, &addr_data
, saa5246a_attach
);
144 static int saa5246a_detach(struct i2c_client
*client
)
146 struct video_device
*vd
= i2c_get_clientdata(client
);
147 i2c_detach_client(client
);
148 video_unregister_device(vd
);
154 static int saa5246a_command(struct i2c_client
*device
, unsigned int cmd
,
164 static struct i2c_driver i2c_driver_videotext
=
166 .owner
= THIS_MODULE
,
167 .name
= IF_NAME
, /* name */
168 .id
= I2C_DRIVERID_SAA5249
, /* in i2c.h */
169 .flags
= I2C_DF_NOTIFY
,
170 .attach_adapter
= saa5246a_probe
,
171 .detach_client
= saa5246a_detach
,
172 .command
= saa5246a_command
175 static struct i2c_client client_template
= {
176 .driver
= &i2c_driver_videotext
,
180 static int i2c_sendbuf(struct saa5246a_device
*t
, int reg
, int count
, u8
*data
)
185 memcpy(buf
+1, data
, count
);
187 if(i2c_master_send(t
->client
, buf
, count
+1)==count
+1)
192 static int i2c_senddata(struct saa5246a_device
*t
, ...)
194 unsigned char buf
[64];
200 while((v
=va_arg(argp
,int))!=-1)
202 return i2c_sendbuf(t
, buf
[0], ct
-1, buf
+1);
205 /* Get count number of bytes from I²C-device at address adr, store them in buf.
206 * Start & stop handshaking is done by this routine, ack will be sent after the
207 * last byte to inhibit further sending of data. If uaccess is TRUE, data is
208 * written to user-space with put_user. Returns -1 if I²C-device didn't send
209 * acknowledge, 0 otherwise
211 static int i2c_getdata(struct saa5246a_device
*t
, int count
, u8
*buf
)
213 if(i2c_master_recv(t
->client
, buf
, count
)!=count
)
218 /* When a page is found then the not FOUND bit in one of the status registers
219 * of the SAA5264A chip is cleared. Unfortunately this bit is not set
220 * automatically when a new page is requested. Instead this function must be
221 * called after a page has been requested.
223 * Return value: 0 if successful
225 static int saa5246a_clear_found_bit(struct saa5246a_device
*t
,
226 unsigned char dau_no
)
228 unsigned char row_25_column_8
;
230 if (i2c_senddata(t
, SAA5246A_REGISTER_R8
,
233 R8_DO_NOT_CLEAR_MEMORY
,
240 i2c_getdata(t
, 1, &row_25_column_8
))
244 row_25_column_8
|= ROW25_COLUMN8_PAGE_NOT_FOUND
;
245 if (i2c_senddata(t
, SAA5246A_REGISTER_R8
,
248 R8_DO_NOT_CLEAR_MEMORY
,
264 /* Requests one videotext page as described in req. The fields of req are
265 * checked and an error is returned if something is invalid.
267 * Return value: 0 if successful
269 static int saa5246a_request_page(struct saa5246a_device
*t
,
272 if (req
->pagemask
< 0 || req
->pagemask
>= PGMASK_MAX
)
274 if (req
->pagemask
& PGMASK_PAGE
)
275 if (req
->page
< 0 || req
->page
> PAGE_MAX
)
277 if (req
->pagemask
& PGMASK_HOUR
)
278 if (req
->hour
< 0 || req
->hour
> HOUR_MAX
)
280 if (req
->pagemask
& PGMASK_MINUTE
)
281 if (req
->minute
< 0 || req
->minute
> MINUTE_MAX
)
283 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
286 if (i2c_senddata(t
, SAA5246A_REGISTER_R2
,
288 R2_IN_R3_SELECT_PAGE_HUNDREDS
|
291 R2_HAMMING_CHECK_OFF
,
293 HUNDREDS_OF_PAGE(req
->page
) |
295 (req
->pagemask
& PG_HUND
?
296 R3_PAGE_HUNDREDS_DO_CARE
:
297 R3_PAGE_HUNDREDS_DO_NOT_CARE
),
299 TENS_OF_PAGE(req
->page
) |
300 (req
->pagemask
& PG_TEN
?
301 R3_PAGE_TENS_DO_CARE
:
302 R3_PAGE_TENS_DO_NOT_CARE
),
304 UNITS_OF_PAGE(req
->page
) |
305 (req
->pagemask
& PG_UNIT
?
306 R3_PAGE_UNITS_DO_CARE
:
307 R3_PAGE_UNITS_DO_NOT_CARE
),
309 TENS_OF_HOUR(req
->hour
) |
310 (req
->pagemask
& HR_TEN
?
311 R3_HOURS_TENS_DO_CARE
:
312 R3_HOURS_TENS_DO_NOT_CARE
),
314 UNITS_OF_HOUR(req
->hour
) |
315 (req
->pagemask
& HR_UNIT
?
316 R3_HOURS_UNITS_DO_CARE
:
317 R3_HOURS_UNITS_DO_NOT_CARE
),
319 TENS_OF_MINUTE(req
->minute
) |
320 (req
->pagemask
& MIN_TEN
?
321 R3_MINUTES_TENS_DO_CARE
:
322 R3_MINUTES_TENS_DO_NOT_CARE
),
324 UNITS_OF_MINUTE(req
->minute
) |
325 (req
->pagemask
& MIN_UNIT
?
326 R3_MINUTES_UNITS_DO_CARE
:
327 R3_MINUTES_UNITS_DO_NOT_CARE
),
329 COMMAND_END
) || i2c_senddata(t
, SAA5246A_REGISTER_R2
,
331 R2_IN_R3_SELECT_PAGE_HUNDREDS
|
334 R2_HAMMING_CHECK_OFF
,
336 HUNDREDS_OF_PAGE(req
->page
) |
338 (req
->pagemask
& PG_HUND
?
339 R3_PAGE_HUNDREDS_DO_CARE
:
340 R3_PAGE_HUNDREDS_DO_NOT_CARE
),
347 t
->is_searching
[req
->pgbuf
] = TRUE
;
351 /* This routine decodes the page number from the infobits contained in line 25.
354 * infobits: must be bits 0 to 9 of column 25
356 * Return value: page number coded in hexadecimal, i. e. page 123 is coded 0x123
358 static inline int saa5246a_extract_pagenum_from_infobits(
359 unsigned char infobits
[10])
361 int page_hundreds
, page_tens
, page_units
;
363 page_units
= infobits
[0] & ROW25_COLUMN0_PAGE_UNITS
;
364 page_tens
= infobits
[1] & ROW25_COLUMN1_PAGE_TENS
;
365 page_hundreds
= infobits
[8] & ROW25_COLUMN8_PAGE_HUNDREDS
;
367 /* page 0x.. means page 8.. */
368 if (page_hundreds
== 0)
371 return((page_hundreds
<< 8) | (page_tens
<< 4) | page_units
);
374 /* Decodes the hour from the infobits contained in line 25.
377 * infobits: must be bits 0 to 9 of column 25
379 * Return: hour coded in hexadecimal, i. e. 12h is coded 0x12
381 static inline int saa5246a_extract_hour_from_infobits(
382 unsigned char infobits
[10])
384 int hour_tens
, hour_units
;
386 hour_units
= infobits
[4] & ROW25_COLUMN4_HOUR_UNITS
;
387 hour_tens
= infobits
[5] & ROW25_COLUMN5_HOUR_TENS
;
389 return((hour_tens
<< 4) | hour_units
);
392 /* Decodes the minutes from the infobits contained in line 25.
395 * infobits: must be bits 0 to 9 of column 25
397 * Return: minutes coded in hexadecimal, i. e. 10min is coded 0x10
399 static inline int saa5246a_extract_minutes_from_infobits(
400 unsigned char infobits
[10])
402 int minutes_tens
, minutes_units
;
404 minutes_units
= infobits
[2] & ROW25_COLUMN2_MINUTES_UNITS
;
405 minutes_tens
= infobits
[3] & ROW25_COLUMN3_MINUTES_TENS
;
407 return((minutes_tens
<< 4) | minutes_units
);
410 /* Reads the status bits contained in the first 10 columns of the first line
411 * and extracts the information into info.
413 * Return value: 0 if successful
415 static inline int saa5246a_get_status(struct saa5246a_device
*t
,
416 vtx_pageinfo_t
*info
, unsigned char dau_no
)
418 unsigned char infobits
[10];
421 if (dau_no
>= NUM_DAUS
)
424 if (i2c_senddata(t
, SAA5246A_REGISTER_R8
,
427 R8_DO_NOT_CLEAR_MEMORY
,
434 i2c_getdata(t
, 10, infobits
))
439 info
->pagenum
= saa5246a_extract_pagenum_from_infobits(infobits
);
440 info
->hour
= saa5246a_extract_hour_from_infobits(infobits
);
441 info
->minute
= saa5246a_extract_minutes_from_infobits(infobits
);
442 info
->charset
= ((infobits
[7] & ROW25_COLUMN7_CHARACTER_SET
) >> 1);
443 info
->delete = !!(infobits
[3] & ROW25_COLUMN3_DELETE_PAGE
);
444 info
->headline
= !!(infobits
[5] & ROW25_COLUMN5_INSERT_HEADLINE
);
445 info
->subtitle
= !!(infobits
[5] & ROW25_COLUMN5_INSERT_SUBTITLE
);
446 info
->supp_header
= !!(infobits
[6] & ROW25_COLUMN6_SUPPRESS_HEADER
);
447 info
->update
= !!(infobits
[6] & ROW25_COLUMN6_UPDATE_PAGE
);
448 info
->inter_seq
= !!(infobits
[6] & ROW25_COLUMN6_INTERRUPTED_SEQUENCE
);
449 info
->dis_disp
= !!(infobits
[6] & ROW25_COLUMN6_SUPPRESS_DISPLAY
);
450 info
->serial
= !!(infobits
[7] & ROW25_COLUMN7_SERIAL_MODE
);
451 info
->notfound
= !!(infobits
[8] & ROW25_COLUMN8_PAGE_NOT_FOUND
);
452 info
->pblf
= !!(infobits
[9] & ROW25_COLUMN9_PAGE_BEING_LOOKED_FOR
);
454 for (column
= 0; column
<= 7; column
++) {
455 if (infobits
[column
] & ROW25_COLUMN0_TO_7_HAMMING_ERROR
) {
460 if (!info
->hamming
&& !info
->notfound
)
461 t
->is_searching
[dau_no
] = FALSE
;
465 /* Reads 1 videotext page buffer of the SAA5246A.
467 * req is used both as input and as output. It contains information which part
468 * must be read. The videotext page is copied into req->buffer.
470 * Return value: 0 if successful
472 static inline int saa5246a_get_page(struct saa5246a_device
*t
,
475 int start
, end
, size
;
479 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
||
480 req
->start
< 0 || req
->start
> req
->end
|| req
->end
>= VTX_PAGESIZE
)
483 buf
= kmalloc(VTX_PAGESIZE
, GFP_KERNEL
);
487 /* Read "normal" part of page */
490 end
= min(req
->end
, VTX_PAGESIZE
- 1);
491 if (i2c_senddata(t
, SAA5246A_REGISTER_R8
,
492 req
->pgbuf
| R8_DO_NOT_CLEAR_MEMORY
,
493 ROW(req
->start
), COLUMN(req
->start
), COMMAND_END
))
495 if (i2c_getdata(t
, end
- req
->start
+ 1, buf
))
498 if (copy_to_user(req
->buffer
, buf
, end
- req
->start
+ 1))
501 /* Always get the time from buffer 4, since this stupid SAA5246A only
502 * updates the currently displayed buffer...
504 if (REQ_CONTAINS_TIME(req
)) {
505 start
= max(req
->start
, POS_TIME_START
);
506 end
= min(req
->end
, POS_TIME_END
);
507 size
= end
- start
+ 1;
512 if (i2c_senddata(t
, SAA5246A_REGISTER_R8
,
513 R8_ACTIVE_CHAPTER_4
| R8_DO_NOT_CLEAR_MEMORY
,
514 R9_CURSER_ROW_0
, start
, COMMAND_END
))
516 if (i2c_getdata(t
, size
, buf
))
519 if (copy_to_user(req
->buffer
+ start
- req
->start
, buf
, size
))
522 /* Insert the header from buffer 4 only, if acquisition circuit is still searching for a page */
523 if (REQ_CONTAINS_HEADER(req
) && t
->is_searching
[req
->pgbuf
]) {
524 start
= max(req
->start
, POS_HEADER_START
);
525 end
= min(req
->end
, POS_HEADER_END
);
526 size
= end
- start
+ 1;
531 if (i2c_senddata(t
, SAA5246A_REGISTER_R8
,
532 R8_ACTIVE_CHAPTER_4
| R8_DO_NOT_CLEAR_MEMORY
,
533 R9_CURSER_ROW_0
, start
, COMMAND_END
))
535 if (i2c_getdata(t
, end
- start
+ 1, buf
))
538 if (copy_to_user(req
->buffer
+ start
- req
->start
, buf
, size
))
547 /* Stops the acquisition circuit given in dau_no. The page buffer associated
548 * with this acquisition circuit will no more be updated. The other daus are
551 * Return value: 0 if successful
553 static inline int saa5246a_stop_dau(struct saa5246a_device
*t
,
554 unsigned char dau_no
)
556 if (dau_no
>= NUM_DAUS
)
558 if (i2c_senddata(t
, SAA5246A_REGISTER_R2
,
560 R2_IN_R3_SELECT_PAGE_HUNDREDS
|
563 R2_HAMMING_CHECK_OFF
,
567 R3_PAGE_HUNDREDS_DO_NOT_CARE
,
573 t
->is_searching
[dau_no
] = FALSE
;
577 /* Handles ioctls defined in videotext.h
579 * Returns 0 if successful
581 static int do_saa5246a_ioctl(struct inode
*inode
, struct file
*file
,
582 unsigned int cmd
, void *arg
)
584 struct video_device
*vd
= video_devdata(file
);
585 struct saa5246a_device
*t
=vd
->priv
;
590 vtx_info_t
*info
= arg
;
592 info
->version_major
= MAJOR_VERSION
;
593 info
->version_minor
= MINOR_VERSION
;
594 info
->numpages
= NUM_DAUS
;
600 vtx_pagereq_t
*req
= arg
;
602 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
604 memset(t
->pgbuf
[req
->pgbuf
], ' ', sizeof(t
->pgbuf
[0]));
610 vtx_pagereq_t
*req
= arg
;
612 if (req
->pgbuf
< 0 || req
->pgbuf
>= NUM_DAUS
)
614 return(saa5246a_clear_found_bit(t
, req
->pgbuf
));
619 vtx_pagereq_t
*req
= arg
;
621 return(saa5246a_request_page(t
, req
));
626 vtx_pagereq_t
*req
= arg
;
630 if ((rval
= saa5246a_get_status(t
, &info
, req
->pgbuf
)))
632 if(copy_to_user(req
->buffer
, &info
,
633 sizeof(vtx_pageinfo_t
)))
640 vtx_pagereq_t
*req
= arg
;
642 return(saa5246a_get_page(t
, req
));
647 vtx_pagereq_t
*req
= arg
;
649 return(saa5246a_stop_dau(t
, req
->pgbuf
));
664 /* I do not know what "virtual mode" means */
672 * Translates old vtx IOCTLs to new ones
674 * This keeps new kernel versions compatible with old userspace programs.
676 static inline unsigned int vtx_fix_command(unsigned int cmd
)
679 case VTXIOCGETINFO_OLD
:
682 case VTXIOCCLRPAGE_OLD
:
685 case VTXIOCCLRFOUND_OLD
:
686 cmd
= VTXIOCCLRFOUND
;
688 case VTXIOCPAGEREQ_OLD
:
691 case VTXIOCGETSTAT_OLD
:
694 case VTXIOCGETPAGE_OLD
:
697 case VTXIOCSTOPDAU_OLD
:
700 case VTXIOCPUTPAGE_OLD
:
703 case VTXIOCSETDISP_OLD
:
706 case VTXIOCPUTSTAT_OLD
:
709 case VTXIOCCLRCACHE_OLD
:
710 cmd
= VTXIOCCLRCACHE
;
712 case VTXIOCSETVIRT_OLD
:
722 static int saa5246a_ioctl(struct inode
*inode
, struct file
*file
,
723 unsigned int cmd
, unsigned long arg
)
725 struct video_device
*vd
= video_devdata(file
);
726 struct saa5246a_device
*t
= vd
->priv
;
729 cmd
= vtx_fix_command(cmd
);
731 err
= video_usercopy(inode
, file
, cmd
, arg
, do_saa5246a_ioctl
);
736 static int saa5246a_open(struct inode
*inode
, struct file
*file
)
738 struct video_device
*vd
= video_devdata(file
);
739 struct saa5246a_device
*t
= vd
->priv
;
742 err
= video_exclusive_open(inode
,file
);
746 if (t
->client
==NULL
) {
751 if (i2c_senddata(t
, SAA5246A_REGISTER_R0
,
754 R0_PLL_TIME_CONSTANT_LONG
|
755 R0_ENABLE_nODD_EVEN_OUTPUT
|
757 R0_DO_NOT_FORCE_nODD_EVEN_LOW_IF_PICTURE_DISPLAYED
|
759 R0_NO_AUTOMATIC_FASTEXT_PROMPT
,
761 R1_NON_INTERLACED_312_312_LINES
|
763 R1_EXTENDED_PACKET_DISABLE
|
765 R1_8_BITS_NO_PARITY
|
769 i2c_senddata(t
, SAA5246A_REGISTER_R4
,
771 /* We do not care much for the TV display but nevertheless we
772 * need the currently displayed page later because only on that
773 * page the time is updated. */
785 video_exclusive_release(inode
,file
);
789 static int saa5246a_release(struct inode
*inode
, struct file
*file
)
791 struct video_device
*vd
= video_devdata(file
);
792 struct saa5246a_device
*t
= vd
->priv
;
794 /* Stop all acquisition circuits. */
795 i2c_senddata(t
, SAA5246A_REGISTER_R1
,
797 R1_INTERLACED_312_AND_HALF_312_AND_HALF_LINES
|
799 R1_EXTENDED_PACKET_DISABLE
|
801 R1_8_BITS_NO_PARITY
|
805 video_exclusive_release(inode
,file
);
809 static int __init
init_saa_5246a (void)
812 "SAA5246A (or compatible) Teletext decoder driver version %d.%d\n",
813 MAJOR_VERSION
, MINOR_VERSION
);
814 return i2c_add_driver(&i2c_driver_videotext
);
817 static void __exit
cleanup_saa_5246a (void)
819 i2c_del_driver(&i2c_driver_videotext
);
822 module_init(init_saa_5246a
);
823 module_exit(cleanup_saa_5246a
);
825 static struct file_operations saa_fops
= {
826 .owner
= THIS_MODULE
,
827 .open
= saa5246a_open
,
828 .release
= saa5246a_release
,
829 .ioctl
= saa5246a_ioctl
,
833 static struct video_device saa_template
=
835 .owner
= THIS_MODULE
,
837 .type
= VID_TYPE_TELETEXT
,
838 .hardware
= VID_HARDWARE_SAA5249
,
840 .release
= video_device_release
,