2 * tveeprom - eeprom decoder for tvcard configuration eeproms
4 * Data and decoding routines shamelessly borrowed from bttv-cards.c
5 * eeprom access routine shamelessly borrowed from bttv-if.c
8 Copyright (C) 1996,97,98 Ralph Metzler (rjkm@thp.uni-koeln.de)
9 & Marcus Metzler (mocm@thp.uni-koeln.de)
10 (c) 1999-2001 Gerd Knorr <kraxel@goldbach.in-berlin.de>
12 * Adjustments to fit a more general model and all bugs:
14 Copyright (C) 2003 John Klar <linpvr at projectplasma.com>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
32 #include <linux/module.h>
33 #include <linux/moduleparam.h>
34 #include <linux/errno.h>
35 #include <linux/kernel.h>
36 #include <linux/init.h>
37 #include <linux/types.h>
38 #include <linux/videodev.h>
39 #include <linux/i2c.h>
41 #include <media/tuner.h>
42 #include <media/tveeprom.h>
44 MODULE_DESCRIPTION("i2c Hauppauge eeprom decoder driver");
45 MODULE_AUTHOR("John Klar");
46 MODULE_LICENSE("GPL");
49 module_param(debug, int, 0644);
50 MODULE_PARM_DESC(debug, "Debug level (0-2)");
52 #define STRM(array,i) (i < sizeof(array)/sizeof(char*) ? array[i] : "unknown")
54 #define dprintk(num, args...) \
57 printk(KERN_INFO "tveeprom: " args); \
60 #define TVEEPROM_KERN_ERR(args...) printk(KERN_ERR "tveeprom: " args);
61 #define TVEEPROM_KERN_INFO(args...) printk(KERN_INFO "tveeprom: " args);
63 /* ----------------------------------------------------------------------- */
64 /* some hauppauge specific stuff */
66 static struct HAUPPAUGE_TUNER_FMT
71 hauppauge_tuner_fmt[] =
73 { 0x00000000, "unknown1" },
74 { 0x00000000, "unknown2" },
75 { 0x00000007, "PAL(B/G)" },
76 { 0x00001000, "NTSC(M)" },
77 { 0x00000010, "PAL(I)" },
78 { 0x00400000, "SECAM(L/L´)" },
79 { 0x00000e00, "PAL(D/K)" },
80 { 0x03000000, "ATSC Digital" },
83 /* This is the full list of possible tuners. Many thanks to Hauppauge for
84 supplying this information. Note that many tuners where only used for
85 testing and never made it to the outside world. So you will only see
86 a subset in actual produced cards. */
87 static struct HAUPPAUGE_TUNER
95 { TUNER_ABSENT, "None" },
96 { TUNER_ABSENT, "External" },
97 { TUNER_ABSENT, "Unspecified" },
98 { TUNER_PHILIPS_PAL, "Philips FI1216" },
99 { TUNER_PHILIPS_SECAM, "Philips FI1216MF" },
100 { TUNER_PHILIPS_NTSC, "Philips FI1236" },
101 { TUNER_PHILIPS_PAL_I, "Philips FI1246" },
102 { TUNER_PHILIPS_PAL_DK,"Philips FI1256" },
103 { TUNER_PHILIPS_PAL, "Philips FI1216 MK2" },
104 { TUNER_PHILIPS_SECAM, "Philips FI1216MF MK2" },
106 { TUNER_PHILIPS_NTSC, "Philips FI1236 MK2" },
107 { TUNER_PHILIPS_PAL_I, "Philips FI1246 MK2" },
108 { TUNER_PHILIPS_PAL_DK,"Philips FI1256 MK2" },
109 { TUNER_TEMIC_NTSC, "Temic 4032FY5" },
110 { TUNER_TEMIC_PAL, "Temic 4002FH5" },
111 { TUNER_TEMIC_PAL_I, "Temic 4062FY5" },
112 { TUNER_PHILIPS_PAL, "Philips FR1216 MK2" },
113 { TUNER_PHILIPS_SECAM, "Philips FR1216MF MK2" },
114 { TUNER_PHILIPS_NTSC, "Philips FR1236 MK2" },
115 { TUNER_PHILIPS_PAL_I, "Philips FR1246 MK2" },
117 { TUNER_PHILIPS_PAL_DK,"Philips FR1256 MK2" },
118 { TUNER_PHILIPS_PAL, "Philips FM1216" },
119 { TUNER_PHILIPS_SECAM, "Philips FM1216MF" },
120 { TUNER_PHILIPS_NTSC, "Philips FM1236" },
121 { TUNER_PHILIPS_PAL_I, "Philips FM1246" },
122 { TUNER_PHILIPS_PAL_DK,"Philips FM1256" },
123 { TUNER_TEMIC_4036FY5_NTSC, "Temic 4036FY5" },
124 { TUNER_ABSENT, "Samsung TCPN9082D" },
125 { TUNER_ABSENT, "Samsung TCPM9092P" },
126 { TUNER_TEMIC_4006FH5_PAL, "Temic 4006FH5" },
128 { TUNER_ABSENT, "Samsung TCPN9085D" },
129 { TUNER_ABSENT, "Samsung TCPB9085P" },
130 { TUNER_ABSENT, "Samsung TCPL9091P" },
131 { TUNER_TEMIC_4039FR5_NTSC, "Temic 4039FR5" },
132 { TUNER_PHILIPS_FQ1216ME, "Philips FQ1216 ME" },
133 { TUNER_TEMIC_4066FY5_PAL_I, "Temic 4066FY5" },
134 { TUNER_PHILIPS_NTSC, "Philips TD1536" },
135 { TUNER_PHILIPS_NTSC, "Philips TD1536D" },
136 { TUNER_PHILIPS_NTSC, "Philips FMR1236" }, /* mono radio */
137 { TUNER_ABSENT, "Philips FI1256MP" },
139 { TUNER_ABSENT, "Samsung TCPQ9091P" },
140 { TUNER_TEMIC_4006FN5_MULTI_PAL, "Temic 4006FN5" },
141 { TUNER_TEMIC_4009FR5_PAL, "Temic 4009FR5" },
142 { TUNER_TEMIC_4046FM5, "Temic 4046FM5" },
143 { TUNER_TEMIC_4009FN5_MULTI_PAL_FM, "Temic 4009FN5" },
144 { TUNER_ABSENT, "Philips TD1536D FH 44"},
145 { TUNER_LG_NTSC_FM, "LG TP18NSR01F"},
146 { TUNER_LG_PAL_FM, "LG TP18PSB01D"},
147 { TUNER_LG_PAL, "LG TP18PSB11D"},
148 { TUNER_LG_PAL_I_FM, "LG TAPC-I001D"},
150 { TUNER_LG_PAL_I, "LG TAPC-I701D"},
151 { TUNER_ABSENT, "Temic 4042FI5"},
152 { TUNER_MICROTUNE_4049FM5, "Microtune 4049 FM5"},
153 { TUNER_ABSENT, "LG TPI8NSR11F"},
154 { TUNER_ABSENT, "Microtune 4049 FM5 Alt I2C"},
155 { TUNER_ABSENT, "Philips FQ1216ME MK3"},
156 { TUNER_ABSENT, "Philips FI1236 MK3"},
157 { TUNER_PHILIPS_FM1216ME_MK3, "Philips FM1216 ME MK3"},
158 { TUNER_ABSENT, "Philips FM1236 MK3"},
159 { TUNER_ABSENT, "Philips FM1216MP MK3"},
161 { TUNER_ABSENT, "LG S001D MK3"},
162 { TUNER_ABSENT, "LG M001D MK3"},
163 { TUNER_ABSENT, "LG S701D MK3"},
164 { TUNER_ABSENT, "LG M701D MK3"},
165 { TUNER_ABSENT, "Temic 4146FM5"},
166 { TUNER_ABSENT, "Temic 4136FY5"},
167 { TUNER_ABSENT, "Temic 4106FH5"},
168 { TUNER_ABSENT, "Philips FQ1216LMP MK3"},
169 { TUNER_LG_NTSC_TAPE, "LG TAPE H001F MK3"},
170 { TUNER_ABSENT, "LG TAPE H701F MK3"},
172 { TUNER_ABSENT, "LG TALN H200T"},
173 { TUNER_ABSENT, "LG TALN H250T"},
174 { TUNER_ABSENT, "LG TALN M200T"},
175 { TUNER_ABSENT, "LG TALN Z200T"},
176 { TUNER_ABSENT, "LG TALN S200T"},
177 { TUNER_ABSENT, "Thompson DTT7595"},
178 { TUNER_ABSENT, "Thompson DTT7592"},
179 { TUNER_ABSENT, "Silicon TDA8275C1 8290"},
180 { TUNER_ABSENT, "Silicon TDA8275C1 8290 FM"},
181 { TUNER_ABSENT, "Thompson DTT757"},
183 { TUNER_ABSENT, "Philips FQ1216LME MK3"},
184 { TUNER_ABSENT, "LG TAPC G701D"},
185 { TUNER_LG_NTSC_NEW_TAPC, "LG TAPC H791F"},
186 { TUNER_ABSENT, "TCL 2002MB 3"},
187 { TUNER_ABSENT, "TCL 2002MI 3"},
188 { TUNER_TCL_2002N, "TCL 2002N 6A"},
189 { TUNER_ABSENT, "Philips FQ1236 MK3"},
190 { TUNER_ABSENT, "Samsung TCPN 2121P30A"},
191 { TUNER_ABSENT, "Samsung TCPE 4121P30A"},
192 { TUNER_ABSENT, "TCL MFPE05 2"},
194 { TUNER_ABSENT, "LG TALN H202T"},
195 { TUNER_PHILIPS_FQ1216AME_MK4, "Philips FQ1216AME MK4"},
196 { TUNER_PHILIPS_FQ1236A_MK4, "Philips FQ1236A MK4"},
197 { TUNER_ABSENT, "Philips FQ1286A MK4"},
198 { TUNER_ABSENT, "Philips FQ1216ME MK5"},
199 { TUNER_ABSENT, "Philips FQ1236 MK5"},
200 { TUNER_ABSENT, "Unspecified"},
201 { TUNER_LG_PAL_TAPE, "LG PAL (TAPE Series)"},
204 static char *sndtype[] = {
205 "None", "TEA6300", "TEA6320", "TDA9850", "MSP3400C", "MSP3410D",
206 "MSP3415", "MSP3430", "MSP3438", "CS5331", "MSP3435", "MSP3440",
207 "MSP3445", "MSP3411", "MSP3416", "MSP3425",
209 "Type 0x10","Type 0x11","Type 0x12","Type 0x13",
210 "Type 0x14","Type 0x15","Type 0x16","Type 0x17",
211 "Type 0x18","MSP4418","Type 0x1a","MSP4448",
212 "Type 0x1c","Type 0x1d","Type 0x1e","Type 0x1f",
215 static int hasRadioTuner(int tunerType)
218 case 18: //PNPEnv_TUNER_FR1236_MK2:
219 case 23: //PNPEnv_TUNER_FM1236:
220 case 38: //PNPEnv_TUNER_FMR1236:
221 case 16: //PNPEnv_TUNER_FR1216_MK2:
222 case 19: //PNPEnv_TUNER_FR1246_MK2:
223 case 21: //PNPEnv_TUNER_FM1216:
224 case 24: //PNPEnv_TUNER_FM1246:
225 case 17: //PNPEnv_TUNER_FR1216MF_MK2:
226 case 22: //PNPEnv_TUNER_FM1216MF:
227 case 20: //PNPEnv_TUNER_FR1256_MK2:
228 case 25: //PNPEnv_TUNER_FM1256:
229 case 33: //PNPEnv_TUNER_4039FR5:
230 case 42: //PNPEnv_TUNER_4009FR5:
231 case 52: //PNPEnv_TUNER_4049FM5:
232 case 54: //PNPEnv_TUNER_4049FM5_AltI2C:
233 case 44: //PNPEnv_TUNER_4009FN5:
234 case 31: //PNPEnv_TUNER_TCPB9085P:
235 case 30: //PNPEnv_TUNER_TCPN9085D:
236 case 46: //PNPEnv_TUNER_TP18NSR01F:
237 case 47: //PNPEnv_TUNER_TP18PSB01D:
238 case 49: //PNPEnv_TUNER_TAPC_I001D:
239 case 60: //PNPEnv_TUNER_TAPE_S001D_MK3:
240 case 57: //PNPEnv_TUNER_FM1216ME_MK3:
241 case 59: //PNPEnv_TUNER_FM1216MP_MK3:
242 case 58: //PNPEnv_TUNER_FM1236_MK3:
243 case 68: //PNPEnv_TUNER_TAPE_H001F_MK3:
244 case 61: //PNPEnv_TUNER_TAPE_M001D_MK3:
245 case 78: //PNPEnv_TUNER_TDA8275C1_8290_FM:
246 case 89: //PNPEnv_TUNER_TCL_MFPE05_2:
247 case 92: //PNPEnv_TUNER_PHILIPS_FQ1236A_MK4:
253 void tveeprom_hauppauge_analog(struct tveeprom *tvee, unsigned char *eeprom_data)
255 /* ----------------------------------------------
256 ** The hauppauge eeprom format is tagged
258 ** if packet[0] == 0x84, then packet[0..1] == length
259 ** else length = packet[0] & 3f;
260 ** if packet[0] & f8 == f8, then EOD and packet[1] == checksum
262 ** In our (ivtv) case we're interested in the following:
263 ** tuner type: tag [00].05 or [0a].01 (index into hauppauge_tuner)
264 ** tuner fmts: tag [00].04 or [0a].00 (bitmask index into hauppauge_tuner_fmt)
265 ** radio: tag [00].{last} or [0e].00 (bitmask. bit2=FM)
266 ** audio proc: tag [02].01 or [05].00 (lower nibble indexes lut?)
269 ** model: tag [00].07-08 or [06].00-01
270 ** revision: tag [00].09-0b or [06].04-06
271 ** serial#: tag [01].05-07 or [04].04-06
273 ** # of inputs/outputs ???
276 int i, j, len, done, beenhere, tag, tuner = 0, t_format = 0;
277 char *t_name = NULL, *t_fmt_name = NULL;
279 dprintk(1, "%s\n",__FUNCTION__);
280 tvee->revision = done = len = beenhere = 0;
281 for (i = 0; !done && i < 256; i += len) {
282 dprintk(2, "processing pos = %02x (%02x, %02x)\n",
283 i, eeprom_data[i], eeprom_data[i + 1]);
285 if (eeprom_data[i] == 0x84) {
286 len = eeprom_data[i + 1] + (eeprom_data[i + 2] << 8);
288 } else if ((eeprom_data[i] & 0xf0) == 0x70) {
289 if ((eeprom_data[i] & 0x08)) {
290 /* verify checksum! */
294 len = eeprom_data[i] & 0x07;
297 TVEEPROM_KERN_ERR("Encountered bad packet header [%02x]. "
298 "Corrupt or not a Hauppauge eeprom.\n", eeprom_data[i]);
302 dprintk(1, "%3d [%02x] ", len, eeprom_data[i]);
303 for(j = 1; j < len; j++) {
304 dprintk(1, "%02x ", eeprom_data[i + j]);
309 tag = eeprom_data[i];
312 tuner = eeprom_data[i+6];
313 t_format = eeprom_data[i+5];
314 tvee->has_radio = eeprom_data[i+len-1];
317 (eeprom_data[i+9] << 8);
318 tvee->revision = eeprom_data[i+10] +
319 (eeprom_data[i+11] << 8) +
320 (eeprom_data[i+12] << 16);
323 tvee->serial_number =
325 (eeprom_data[i+7] << 8) +
326 (eeprom_data[i+8] << 16);
329 tvee->audio_processor = eeprom_data[i+2] & 0x0f;
332 tvee->serial_number =
334 (eeprom_data[i+6] << 8) +
335 (eeprom_data[i+7] << 16);
338 tvee->audio_processor = eeprom_data[i+1] & 0x0f;
343 (eeprom_data[i+2] << 8);
344 tvee->revision = eeprom_data[i+5] +
345 (eeprom_data[i+6] << 8) +
346 (eeprom_data[i+7] << 16);
350 tuner = eeprom_data[i+2];
351 t_format = eeprom_data[i+1];
358 tvee->has_radio = eeprom_data[i+1];
361 dprintk(1, "Not sure what to do with tag [%02x]\n", tag);
362 /* dump the rest of the packet? */
368 TVEEPROM_KERN_ERR("Ran out of data!\n");
372 if (tvee->revision != 0) {
373 tvee->rev_str[0] = 32 + ((tvee->revision >> 18) & 0x3f);
374 tvee->rev_str[1] = 32 + ((tvee->revision >> 12) & 0x3f);
375 tvee->rev_str[2] = 32 + ((tvee->revision >> 6) & 0x3f);
376 tvee->rev_str[3] = 32 + ( tvee->revision & 0x3f);
377 tvee->rev_str[4] = 0;
380 if (hasRadioTuner(tuner) && !tvee->has_radio) {
381 TVEEPROM_KERN_INFO("The eeprom says no radio is present, but the tuner type\n");
382 TVEEPROM_KERN_INFO("indicates otherwise. I will assume that radio is present.\n");
386 if (tuner < sizeof(hauppauge_tuner)/sizeof(struct HAUPPAUGE_TUNER)) {
387 tvee->tuner_type = hauppauge_tuner[tuner].id;
388 t_name = hauppauge_tuner[tuner].name;
390 t_name = "<unknown>";
393 tvee->tuner_formats = 0;
394 t_fmt_name = "<none>";
395 for (i = 0; i < 8; i++) {
396 if (t_format & (1<<i)) {
397 tvee->tuner_formats |= hauppauge_tuner_fmt[i].id;
399 t_fmt_name = hauppauge_tuner_fmt[i].name;
404 if (t_format < sizeof(hauppauge_tuner_fmt)/sizeof(struct HAUPPAUGE_TUNER_FMT)) {
405 tvee->tuner_formats = hauppauge_tuner_fmt[t_format].id;
406 t_fmt_name = hauppauge_tuner_fmt[t_format].name;
408 t_fmt_name = "<unknown>";
412 TVEEPROM_KERN_INFO("Hauppauge: model = %d, rev = %s, serial# = %d\n",
415 tvee->serial_number);
416 TVEEPROM_KERN_INFO("tuner = %s (idx = %d, type = %d)\n",
420 TVEEPROM_KERN_INFO("tuner fmt = %s (eeprom = 0x%02x, v4l2 = 0x%08x)\n",
423 tvee->tuner_formats);
425 TVEEPROM_KERN_INFO("audio_processor = %s (type = %d)\n",
426 STRM(sndtype,tvee->audio_processor),
427 tvee->audio_processor);
430 EXPORT_SYMBOL(tveeprom_hauppauge_analog);
432 /* ----------------------------------------------------------------------- */
433 /* generic helper functions */
435 int tveeprom_read(struct i2c_client *c, unsigned char *eedata, int len)
440 dprintk(1, "%s\n",__FUNCTION__);
442 if (1 != (err = i2c_master_send(c,&buf,1))) {
443 printk(KERN_INFO "tveeprom(%s): Huh, no eeprom present (err=%d)?\n",
447 if (len != (err = i2c_master_recv(c,eedata,len))) {
448 printk(KERN_WARNING "tveeprom(%s): i2c eeprom read error (err=%d)\n",
454 EXPORT_SYMBOL(tveeprom_read);
456 int tveeprom_dump(unsigned char *eedata, int len)
460 dprintk(1, "%s\n",__FUNCTION__);
461 for (i = 0; i < len; i++) {
463 printk(KERN_INFO "tveeprom: %02x:",i);
464 printk(" %02x",eedata[i]);
470 EXPORT_SYMBOL(tveeprom_dump);
472 /* ----------------------------------------------------------------------- */
473 /* needed for ivtv.sf.net at the moment. Should go away in the long */
474 /* run, just call the exported tveeprom_* directly, there is no point in */
475 /* using the indirect way via i2c_driver->command() */
477 #ifndef I2C_DRIVERID_TVEEPROM
478 # define I2C_DRIVERID_TVEEPROM I2C_DRIVERID_EXP2
481 static unsigned short normal_i2c[] = {
487 struct i2c_driver i2c_driver_tveeprom;
490 tveeprom_command(struct i2c_client *client,
494 struct tveeprom eeprom;
495 u32 *eeprom_props = arg;
500 buf = kmalloc(256,GFP_KERNEL);
502 tveeprom_read(client,buf,256);
503 tveeprom_hauppauge_analog(&eeprom,buf);
505 eeprom_props[0] = eeprom.tuner_type;
506 eeprom_props[1] = eeprom.tuner_formats;
507 eeprom_props[2] = eeprom.model;
508 eeprom_props[3] = eeprom.revision;
517 tveeprom_detect_client(struct i2c_adapter *adapter,
521 struct i2c_client *client;
523 dprintk(1,"%s: id 0x%x @ 0x%x\n",__FUNCTION__,
524 adapter->id, address << 1);
525 client = kmalloc(sizeof(struct i2c_client), GFP_KERNEL);
528 memset(client, 0, sizeof(struct i2c_client));
529 client->addr = address;
530 client->adapter = adapter;
531 client->driver = &i2c_driver_tveeprom;
532 client->flags = I2C_CLIENT_ALLOW_USE;
533 snprintf(client->name, sizeof(client->name), "tveeprom");
534 i2c_attach_client(client);
539 tveeprom_attach_adapter (struct i2c_adapter *adapter)
541 dprintk(1,"%s: id 0x%x\n",__FUNCTION__,adapter->id);
542 if (adapter->id != (I2C_ALGO_BIT | I2C_HW_B_BT848))
544 return i2c_probe(adapter, &addr_data, tveeprom_detect_client);
548 tveeprom_detach_client (struct i2c_client *client)
552 err = i2c_detach_client(client);
559 struct i2c_driver i2c_driver_tveeprom = {
560 .owner = THIS_MODULE,
562 .id = I2C_DRIVERID_TVEEPROM,
563 .flags = I2C_DF_NOTIFY,
564 .attach_adapter = tveeprom_attach_adapter,
565 .detach_client = tveeprom_detach_client,
566 .command = tveeprom_command,
569 static int __init tveeprom_init(void)
571 return i2c_add_driver(&i2c_driver_tveeprom);
574 static void __exit tveeprom_exit(void)
576 i2c_del_driver(&i2c_driver_tveeprom);
579 module_init(tveeprom_init);
580 module_exit(tveeprom_exit);