]> err.no Git - linux-2.6/blob - drivers/media/dvb/dvb-usb/m920x.c
V4L/DVB (5449): M920x: add error messages for debugging purposes
[linux-2.6] / drivers / media / dvb / dvb-usb / m920x.c
1 /* DVB USB compliant linux driver for MSI Mega Sky 580 DVB-T USB2.0 receiver
2  *
3  * Copyright (C) 2006 Aapo Tahkola (aet@rasterburn.org)
4  *
5  *      This program is free software; you can redistribute it and/or modify it
6  *      under the terms of the GNU General Public License as published by the Free
7  *      Software Foundation, version 2.
8  *
9  * see Documentation/dvb/README.dvb-usb for more information
10  */
11
12 #include "m920x.h"
13
14 #include "mt352.h"
15 #include "mt352_priv.h"
16 #include "qt1010.h"
17
18 /* debug */
19 static int dvb_usb_m920x_debug;
20 module_param_named(debug,dvb_usb_m920x_debug, int, 0644);
21 MODULE_PARM_DESC(debug, "set debugging level (1=rc (or-able))." DVB_USB_DEBUG_STATUS);
22
23 static struct dvb_usb_rc_key megasky_rc_keys [] = {
24         { 0x0, 0x12, KEY_POWER },
25         { 0x0, 0x1e, KEY_CYCLEWINDOWS }, /* min/max */
26         { 0x0, 0x02, KEY_CHANNELUP },
27         { 0x0, 0x05, KEY_CHANNELDOWN },
28         { 0x0, 0x03, KEY_VOLUMEUP },
29         { 0x0, 0x06, KEY_VOLUMEDOWN },
30         { 0x0, 0x04, KEY_MUTE },
31         { 0x0, 0x07, KEY_OK }, /* TS */
32         { 0x0, 0x08, KEY_STOP },
33         { 0x0, 0x09, KEY_MENU }, /* swap */
34         { 0x0, 0x0a, KEY_REWIND },
35         { 0x0, 0x1b, KEY_PAUSE },
36         { 0x0, 0x1f, KEY_FASTFORWARD },
37         { 0x0, 0x0c, KEY_RECORD },
38         { 0x0, 0x0d, KEY_CAMERA }, /* screenshot */
39         { 0x0, 0x0e, KEY_COFFEE }, /* "MTS" */
40 };
41
42 static inline int m9206_read(struct usb_device *udev, u8 request, u16 value,\
43                              u16 index, void *data, int size)
44 {
45         int ret;
46
47         ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
48                               request, USB_TYPE_VENDOR | USB_DIR_IN,
49                               value, index, data, size, 2000);
50         if (ret < 0) {
51                 printk(KERN_INFO "m920x_read = error: %d\n", ret);
52                 return ret;
53         }
54
55         if (ret != size) {
56                 deb_rc("m920x_read = no data\n");
57                 return -EIO;
58         }
59
60         return 0;
61 }
62
63 static inline int m9206_write(struct usb_device *udev, u8 request,
64                               u16 value, u16 index)
65 {
66         int ret;
67
68         ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
69                               request, USB_TYPE_VENDOR | USB_DIR_OUT,
70                               value, index, NULL, 0, 2000);
71
72         return ret;
73 }
74
75 static int m9206_init(struct dvb_usb_device *d)
76 {
77         int ret = 0;
78
79         /* Remote controller init. */
80         if (d->props.rc_query) {
81                 if ((ret = m9206_write(d->udev, M9206_CORE, 0xa8, M9206_RC_INIT2)) != 0)
82                         return ret;
83
84                 if ((ret = m9206_write(d->udev, M9206_CORE, 0x51, M9206_RC_INIT1)) != 0)
85                         return ret;
86         }
87
88         return ret;
89 }
90
91 static int m9206_rc_query(struct dvb_usb_device *d, u32 *event, int *state)
92 {
93         struct m9206_state *m = d->priv;
94         int i, ret = 0;
95         u8 rc_state[2];
96
97         if ((ret = m9206_read(d->udev, M9206_CORE, 0x0, M9206_RC_STATE, rc_state, 1)) != 0)
98                 goto unlock;
99
100         if ((ret = m9206_read(d->udev, M9206_CORE, 0x0, M9206_RC_KEY, rc_state + 1, 1)) != 0)
101                 goto unlock;
102
103         for (i = 0; i < d->props.rc_key_map_size; i++)
104                 if (d->props.rc_key_map[i].data == rc_state[1]) {
105                         *event = d->props.rc_key_map[i].event;
106
107                         switch(rc_state[0]) {
108                         case 0x80:
109                                 *state = REMOTE_NO_KEY_PRESSED;
110                                 goto unlock;
111
112                         case 0x93:
113                         case 0x92:
114                                 m->rep_count = 0;
115                                 *state = REMOTE_KEY_PRESSED;
116                                 goto unlock;
117
118                         case 0x91:
119                                 /* For comfort. */
120                                 if (++m->rep_count > 2)
121                                         *state = REMOTE_KEY_REPEAT;
122                                 goto unlock;
123
124                         default:
125                                 deb_rc("Unexpected rc response %x\n", rc_state[0]);
126                                 *state = REMOTE_NO_KEY_PRESSED;
127                                 goto unlock;
128                         }
129                 }
130
131         if (rc_state[1] != 0)
132                 deb_rc("Unknown rc key %x\n", rc_state[1]);
133
134         *state = REMOTE_NO_KEY_PRESSED;
135
136         unlock:
137
138         return ret;
139 }
140
141 /* I2C */
142 static int m9206_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msg[],
143                           int num)
144 {
145         struct dvb_usb_device *d = i2c_get_adapdata(adap);
146         int i, j;
147         int ret = 0;
148
149         if (!num)
150                 return -EINVAL;
151
152         if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
153                 return -EAGAIN;
154
155         for (i = 0; i < num; i++) {
156                 if (msg[i].flags & (I2C_M_NO_RD_ACK|I2C_M_IGNORE_NAK|I2C_M_TEN) ||
157                     msg[i].len == 0) {
158                         /* For a 0 byte message, I think sending the address to index 0x80|0x40
159                          * would be the correct thing to do.  However, zero byte messages are
160                          * only used for probing, and since we don't know how to get the slave's
161                          * ack, we can't probe. */
162                         ret = -ENOTSUPP;
163                         goto unlock;
164                 }
165                 /* Send START & address/RW bit */
166                 if (!(msg[i].flags & I2C_M_NOSTART)) {
167                         if ((ret = m9206_write(d->udev, M9206_I2C, (msg[i].addr<<1)|(msg[i].flags&I2C_M_RD?0x01:0), 0x80)) != 0)
168                                 goto unlock;
169                         /* Should check for ack here, if we knew how. */
170                 }
171                 if (msg[i].flags & I2C_M_RD) {
172                         for (j = 0; j < msg[i].len; j++) {
173                                 /* Last byte of transaction? Send STOP, otherwise send ACK. */
174                                 int stop = (i+1 == num && j+1 == msg[i].len)?0x40:0x01;
175                                 if ((ret = m9206_read(d->udev, M9206_I2C, 0x0, 0x20|stop, &msg[i].buf[j], 1)) != 0)
176                                         goto unlock;
177                         }
178                 } else {
179                         for (j = 0; j < msg[i].len; j++) {
180                                 /* Last byte of transaction? Then send STOP. */
181                                 int stop = (i+1 == num && j+1 == msg[i].len)?0x40:0x00;
182                                 if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].buf[j], stop)) != 0)
183                                         goto unlock;
184                                 /* Should check for ack here too. */
185                         }
186                 }
187         }
188         ret = num;
189
190 unlock:
191         mutex_unlock(&d->i2c_mutex);
192
193         return ret;
194 }
195
196 static u32 m9206_i2c_func(struct i2c_adapter *adapter)
197 {
198         return I2C_FUNC_I2C;
199 }
200
201 static struct i2c_algorithm m9206_i2c_algo = {
202         .master_xfer   = m9206_i2c_xfer,
203         .functionality = m9206_i2c_func,
204 };
205
206
207 static int m9206_set_filter(struct dvb_usb_adapter *adap, int type, int idx,
208                             int pid)
209 {
210         int ret = 0;
211
212         if (pid >= 0x8000)
213                 return -EINVAL;
214
215         pid |= 0x8000;
216
217         if ((ret = m9206_write(adap->dev->udev, M9206_FILTER, pid, (type << 8) | (idx * 4) )) != 0)
218                 return ret;
219
220         if ((ret = m9206_write(adap->dev->udev, M9206_FILTER, 0, (type << 8) | (idx * 4) )) != 0)
221                 return ret;
222
223         return ret;
224 }
225
226 static int m9206_update_filters(struct dvb_usb_adapter *adap)
227 {
228         struct m9206_state *m = adap->dev->priv;
229         int enabled = m->filtering_enabled;
230         int i, ret = 0, filter = 0;
231
232         for (i = 0; i < M9206_MAX_FILTERS; i++)
233                 if (m->filters[i] == 8192)
234                         enabled = 0;
235
236         /* Disable all filters */
237         if ((ret = m9206_set_filter(adap, 0x81, 1, enabled)) != 0)
238                 return ret;
239
240         for (i = 0; i < M9206_MAX_FILTERS; i++)
241                 if ((ret = m9206_set_filter(adap, 0x81, i + 2, 0)) != 0)
242                         return ret;
243
244         if ((ret = m9206_set_filter(adap, 0x82, 0, 0x0)) != 0)
245                 return ret;
246
247         /* Set */
248         if (enabled) {
249                 for (i = 0; i < M9206_MAX_FILTERS; i++) {
250                         if (m->filters[i] == 0)
251                                 continue;
252
253                         if ((ret = m9206_set_filter(adap, 0x81, filter + 2, m->filters[i])) != 0)
254                                 return ret;
255
256                         filter++;
257                 }
258         }
259
260         if ((ret = m9206_set_filter(adap, 0x82, 0, 0x02f5)) != 0)
261                 return ret;
262
263         return ret;
264 }
265
266 static int m9206_pid_filter_ctrl(struct dvb_usb_adapter *adap, int onoff)
267 {
268         struct m9206_state *m = adap->dev->priv;
269
270         m->filtering_enabled = onoff ? 1 : 0;
271
272         return m9206_update_filters(adap);
273 }
274
275 static int m9206_pid_filter(struct dvb_usb_adapter *adap, int index, u16 pid,
276                             int onoff)
277 {
278         struct m9206_state *m = adap->dev->priv;
279
280         m->filters[index] = onoff ? pid : 0;
281
282         return m9206_update_filters(adap);
283 }
284
285 static int m9206_firmware_download(struct usb_device *udev,
286                                    const struct firmware *fw)
287 {
288         u16 value, index, size;
289         u8 read[4], *buff;
290         int i, pass, ret = 0;
291
292         buff = kmalloc(65536, GFP_KERNEL);
293
294         if ((ret = m9206_read(udev, M9206_FILTER, 0x0, 0x8000, read, 4)) != 0)
295                 goto done;
296         deb_rc("%x %x %x %x\n", read[0], read[1], read[2], read[3]);
297
298         if ((ret = m9206_read(udev, M9206_FW, 0x0, 0x0, read, 1)) != 0)
299                 goto done;
300         deb_rc("%x\n", read[0]);
301
302         for (pass = 0; pass < 2; pass++) {
303                 for (i = 0; i + (sizeof(u16) * 3) < fw->size;) {
304                         value = le16_to_cpu(*(u16 *)(fw->data + i));
305                         i += sizeof(u16);
306
307                         index = le16_to_cpu(*(u16 *)(fw->data + i));
308                         i += sizeof(u16);
309
310                         size = le16_to_cpu(*(u16 *)(fw->data + i));
311                         i += sizeof(u16);
312
313                         if (pass == 1) {
314                                 /* Will stall if using fw->data ... */
315                                 memcpy(buff, fw->data + i, size);
316
317                                 ret = usb_control_msg(udev, usb_sndctrlpipe(udev,0),
318                                             M9206_FW,
319                                             USB_TYPE_VENDOR | USB_DIR_OUT,
320                                             value, index, buff, size, 20);
321                                 if (ret != size) {
322                                         deb_rc("error while uploading fw!\n");
323                                         ret = -EIO;
324                                         goto done;
325                                 }
326                                 msleep(3);
327                         }
328                         i += size;
329                 }
330                 if (i != fw->size) {
331                         deb_rc("bad firmware file!\n");
332                         ret = -EINVAL;
333                         goto done;
334                 }
335         }
336
337         msleep(36);
338
339         /* m9206 will disconnect itself from the bus after this. */
340         (void) m9206_write(udev, M9206_CORE, 0x01, M9206_FW_GO);
341         deb_rc("firmware uploaded!\n");
342
343         done:
344         kfree(buff);
345
346         return ret;
347 }
348
349 /* Callbacks for DVB USB */
350 static int m920x_identify_state(struct usb_device *udev,
351                                 struct dvb_usb_device_properties *props,
352                                 struct dvb_usb_device_description **desc,
353                                 int *cold)
354 {
355         struct usb_host_interface *alt;
356
357         alt = usb_altnum_to_altsetting(usb_ifnum_to_if(udev, 0), 1);
358         *cold = (alt == NULL) ? 1 : 0;
359
360         return 0;
361 }
362
363 static int megasky_mt352_demod_init(struct dvb_frontend *fe)
364 {
365         u8 config[] = { CONFIG, 0x3d };
366         u8 clock[] = { CLOCK_CTL, 0x30 };
367         u8 reset[] = { RESET, 0x80 };
368         u8 adc_ctl[] = { ADC_CTL_1, 0x40 };
369         u8 agc[] = { AGC_TARGET, 0x1c, 0x20 };
370         u8 sec_agc[] = { 0x69, 0x00, 0xff, 0xff, 0x40, 0xff, 0x00, 0x40, 0x40 };
371         u8 unk1[] = { 0x93, 0x1a };
372         u8 unk2[] = { 0xb5, 0x7a };
373
374         mt352_write(fe, config, ARRAY_SIZE(config));
375         mt352_write(fe, clock, ARRAY_SIZE(clock));
376         mt352_write(fe, reset, ARRAY_SIZE(reset));
377         mt352_write(fe, adc_ctl, ARRAY_SIZE(adc_ctl));
378         mt352_write(fe, agc, ARRAY_SIZE(agc));
379         mt352_write(fe, sec_agc, ARRAY_SIZE(sec_agc));
380         mt352_write(fe, unk1, ARRAY_SIZE(unk1));
381         mt352_write(fe, unk2, ARRAY_SIZE(unk2));
382
383         deb_rc("Demod init!\n");
384
385         return 0;
386 }
387
388 static struct mt352_config megasky_mt352_config = {
389         .demod_address = 0x0f,
390         .no_tuner = 1,
391         .demod_init = megasky_mt352_demod_init,
392 };
393
394 static int megasky_mt352_frontend_attach(struct dvb_usb_adapter *adap)
395 {
396         deb_rc("megasky_frontend_attach!\n");
397
398         if ((adap->fe = dvb_attach(mt352_attach, &megasky_mt352_config, &adap->dev->i2c_adap)) == NULL)
399                 return -EIO;
400
401         return 0;
402 }
403
404 static struct qt1010_config megasky_qt1010_config = {
405         .i2c_address = 0x62
406 };
407
408 static int megasky_qt1010_tuner_attach(struct dvb_usb_adapter *adap)
409 {
410         if (dvb_attach(qt1010_attach, adap->fe, &adap->dev->i2c_adap,
411                        &megasky_qt1010_config) == NULL)
412                 return -ENODEV;
413
414         return 0;
415 }
416
417 /* DVB USB Driver stuff */
418 static struct dvb_usb_device_properties megasky_properties;
419
420 static int m920x_probe(struct usb_interface *intf,
421                        const struct usb_device_id *id)
422 {
423         struct dvb_usb_device *d;
424         struct usb_host_interface *alt;
425         int ret;
426
427         deb_rc("Probed!\n");
428
429         if ((ret = dvb_usb_device_init(intf, &megasky_properties, THIS_MODULE, &d)) == 0)
430                 goto found;
431
432         return ret;
433
434 found:
435         alt = usb_altnum_to_altsetting(intf, 1);
436         if (alt == NULL) {
437                 deb_rc("No alt found!\n");
438                 return -ENODEV;
439         }
440
441         ret = usb_set_interface(d->udev, alt->desc.bInterfaceNumber,
442                                 alt->desc.bAlternateSetting);
443         if (ret < 0)
444                 return ret;
445
446         if ((ret = m9206_init(d)) != 0)
447                 return ret;
448
449         return ret;
450 }
451
452 static struct usb_device_id m920x_table [] = {
453                 { USB_DEVICE(USB_VID_MSI, USB_PID_MSI_MEGASKY580) },
454                 { }             /* Terminating entry */
455 };
456 MODULE_DEVICE_TABLE (usb, m920x_table);
457
458 static struct dvb_usb_device_properties megasky_properties = {
459         .caps = DVB_USB_IS_AN_I2C_ADAPTER,
460
461         .usb_ctrl = DEVICE_SPECIFIC,
462         .firmware = "dvb-usb-megasky-02.fw",
463         .download_firmware = m9206_firmware_download,
464
465         .rc_interval      = 100,
466         .rc_key_map       = megasky_rc_keys,
467         .rc_key_map_size  = ARRAY_SIZE(megasky_rc_keys),
468         .rc_query         = m9206_rc_query,
469
470         .size_of_priv     = sizeof(struct m9206_state),
471
472         .identify_state   = m920x_identify_state,
473         .num_adapters = 1,
474         .adapter = {{
475                 .caps = DVB_USB_ADAP_HAS_PID_FILTER |
476                         DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF,
477
478                 .pid_filter_count = 8,
479                 .pid_filter       = m9206_pid_filter,
480                 .pid_filter_ctrl  = m9206_pid_filter_ctrl,
481
482                 .frontend_attach  = megasky_mt352_frontend_attach,
483                 .tuner_attach     = megasky_qt1010_tuner_attach,
484
485                 .stream = {
486                         .type = USB_BULK,
487                         .count = 8,
488                         .endpoint = 0x81,
489                         .u = {
490                                 .bulk = {
491                                         .buffersize = 512,
492                                 }
493                         }
494                 },
495         }},
496         .i2c_algo         = &m9206_i2c_algo,
497
498         .num_device_descs = 1,
499         .devices = {
500                 {   "MSI Mega Sky 580 DVB-T USB2.0",
501                         { &m920x_table[0], NULL },
502                         { NULL },
503                 },
504         }
505 };
506
507 static struct usb_driver m920x_driver = {
508         .name           = "dvb_usb_m920x",
509         .probe          = m920x_probe,
510         .disconnect     = dvb_usb_device_exit,
511         .id_table       = m920x_table,
512 };
513
514 /* module stuff */
515 static int __init m920x_module_init(void)
516 {
517         int ret;
518
519         if ((ret = usb_register(&m920x_driver))) {
520                 err("usb_register failed. Error number %d", ret);
521                 return ret;
522         }
523
524         return 0;
525 }
526
527 static void __exit m920x_module_exit(void)
528 {
529         /* deregister this driver from the USB subsystem */
530         usb_deregister(&m920x_driver);
531 }
532
533 module_init (m920x_module_init);
534 module_exit (m920x_module_exit);
535
536 MODULE_AUTHOR("Aapo Tahkola <aet@rasterburn.org>");
537 MODULE_DESCRIPTION("Driver MSI Mega Sky 580 DVB-T USB2.0 / Uli m920x");
538 MODULE_VERSION("0.1");
539 MODULE_LICENSE("GPL");