V4L/DVB (5132): M920x: more trivial cleanups
[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, u16 index, void *data, int size)
43 {
44         int ret;
45
46         ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
47                               request, USB_TYPE_VENDOR | USB_DIR_IN,
48                               value, index, data, size, 2000);
49         if (ret < 0)
50                 return ret;
51
52         if (ret != size)
53                 return -EIO;
54
55         return 0;
56 }
57
58 static inline int m9206_write(struct usb_device *udev, u8 request, u16 value, u16 index)
59 {
60         int ret;
61
62         ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
63                               request, USB_TYPE_VENDOR | USB_DIR_OUT,
64                               value, index, NULL, 0, 2000);
65         return ret;
66 }
67
68 static int m9206_rc_init(struct usb_device *udev)
69 {
70         int ret = 0;
71
72         /* Remote controller init. */
73         if ((ret = m9206_write(udev, M9206_CORE, 0xa8, M9206_RC_INIT2)) != 0)
74                 return ret;
75
76         if ((ret = m9206_write(udev, M9206_CORE, 0x51, M9206_RC_INIT1)) != 0)
77                 return ret;
78
79         return ret;
80 }
81
82 static int m9206_rc_query(struct dvb_usb_device *d, u32 *event, int *state)
83 {
84         struct m9206_state *m = d->priv;
85         int i, ret = 0;
86         u8 rc_state[2];
87
88
89         if ((ret = m9206_read(d->udev, M9206_CORE, 0x0, M9206_RC_STATE, rc_state, 1)) != 0)
90                 goto unlock;
91
92         if ((ret = m9206_read(d->udev, M9206_CORE, 0x0, M9206_RC_KEY, rc_state + 1, 1)) != 0)
93                 goto unlock;
94
95         for (i = 0; i < ARRAY_SIZE(megasky_rc_keys); i++)
96                 if (megasky_rc_keys[i].data == rc_state[1]) {
97                         *event = megasky_rc_keys[i].event;
98
99                         switch(rc_state[0]) {
100                         case 0x80:
101                                 *state = REMOTE_NO_KEY_PRESSED;
102                                 goto unlock;
103
104                         case 0x93:
105                         case 0x92:
106                                 m->rep_count = 0;
107                                 *state = REMOTE_KEY_PRESSED;
108                                 goto unlock;
109
110                         case 0x91:
111                                 /* For comfort. */
112                                 if (++m->rep_count > 2)
113                                         *state = REMOTE_KEY_REPEAT;
114                                 goto unlock;
115
116                         default:
117                                 deb_rc("Unexpected rc response %x\n", rc_state[0]);
118                                 *state = REMOTE_NO_KEY_PRESSED;
119                                 goto unlock;
120                         }
121                 }
122
123         if (rc_state[1] != 0)
124                 deb_rc("Unknown rc key %x\n", rc_state[1]);
125
126         *state = REMOTE_NO_KEY_PRESSED;
127
128         unlock:
129
130         return ret;
131 }
132
133 /* I2C */
134
135 static int m9206_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msg[], int num)
136 {
137         struct dvb_usb_device *d = i2c_get_adapdata(adap);
138         int i;
139         int ret = 0;
140
141         if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
142                 return -EAGAIN;
143
144         if (num > 2)
145                 return -EINVAL;
146
147         for (i = 0; i < num; i++) {
148                 u8 w_len;
149
150                 if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].addr, 0x80)) != 0)
151                         goto unlock;
152
153                 if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].buf[0], 0x0)) != 0)
154                         goto unlock;
155
156                 if (i + 1 < num && msg[i + 1].flags & I2C_M_RD) {
157                         /* Possibly device dependant */
158                         if (msg[i].addr == d->adapter[0].pll_addr)
159                                 w_len = 0xc5;
160                         else
161                                 w_len = 0x1f;
162
163                         if ((ret = m9206_write(d->udev, M9206_I2C, w_len, 0x80)) != 0)
164                                 goto unlock;
165
166                         if ((ret = m9206_read(d->udev, M9206_I2C, 0x0, 0x60, msg[i + 1].buf, msg[i + 1].len)) != 0)
167                                 goto unlock;
168
169                         i++;
170                 } else {
171                         if (msg[i].len != 2)
172                                 return -EINVAL;
173
174                         if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].buf[1], 0x40)) != 0)
175                                 goto unlock;
176                 }
177         }
178         ret = i;
179         unlock:
180         mutex_unlock(&d->i2c_mutex);
181
182         return ret;
183 }
184
185 static u32 m9206_i2c_func(struct i2c_adapter *adapter)
186 {
187         return I2C_FUNC_I2C;
188 }
189
190 static struct i2c_algorithm m9206_i2c_algo = {
191         .master_xfer   = m9206_i2c_xfer,
192         .functionality = m9206_i2c_func,
193 };
194
195 /* Callbacks for DVB USB */
196 static int megasky_identify_state(struct usb_device *udev,
197                                   struct dvb_usb_device_properties *props,
198                                   struct dvb_usb_device_description **desc,
199                                   int *cold)
200 {
201         struct usb_host_interface *alt;
202
203         alt = usb_altnum_to_altsetting(usb_ifnum_to_if(udev, 0), 1);
204         *cold = (alt == NULL) ? 1 : 0;
205
206         return 0;
207 }
208
209 static int megasky_mt352_demod_init(struct dvb_frontend *fe)
210 {
211         u8 config[] = { CONFIG, 0x3d };
212         u8 clock[] = { CLOCK_CTL, 0x30 };
213         u8 reset[] = { RESET, 0x80 };
214         u8 adc_ctl[] = { ADC_CTL_1, 0x40 };
215         u8 agc[] = { AGC_TARGET, 0x1c, 0x20 };
216         u8 sec_agc[] = { 0x69, 0x00, 0xff, 0xff, 0x40, 0xff, 0x00, 0x40, 0x40 };
217         u8 unk1[] = { 0x93, 0x1a };
218         u8 unk2[] = { 0xb5, 0x7a };
219
220         mt352_write(fe, config, ARRAY_SIZE(config));
221         mt352_write(fe, clock, ARRAY_SIZE(clock));
222         mt352_write(fe, reset, ARRAY_SIZE(reset));
223         mt352_write(fe, adc_ctl, ARRAY_SIZE(adc_ctl));
224         mt352_write(fe, agc, ARRAY_SIZE(agc));
225         mt352_write(fe, sec_agc, ARRAY_SIZE(sec_agc));
226         mt352_write(fe, unk1, ARRAY_SIZE(unk1));
227         mt352_write(fe, unk2, ARRAY_SIZE(unk2));
228
229         deb_rc("Demod init!\n");
230
231         return 0;
232 }
233
234 static struct mt352_config megasky_mt352_config = {
235         .demod_address = 0x1e,
236         .no_tuner = 1,
237         .demod_init = megasky_mt352_demod_init,
238 };
239
240 static int megasky_frontend_attach(struct dvb_usb_adapter *adap)
241 {
242         deb_rc("megasky_frontend_attach!\n");
243
244         if ((adap->fe = dvb_attach(mt352_attach, &megasky_mt352_config, &adap->dev->i2c_adap)) != NULL)
245                 return 0;
246         return -EIO;
247 }
248
249 static int megasky_tuner_attach(struct dvb_usb_adapter *adap)
250 {
251         adap->pll_addr = 0xc4;
252         adap->pll_desc = NULL;
253         adap->fe->ops.tuner_ops.set_params = qt1010_set_params;
254
255         return 0;
256 }
257
258 static int m9206_set_filter(struct dvb_usb_adapter *adap, int type, int idx, int pid)
259 {
260         int ret = 0;
261
262         if (pid >= 0x8000)
263                 return -EINVAL;
264
265         pid |= 0x8000;
266
267         if ((ret = m9206_write(adap->dev->udev, M9206_FILTER, pid, (type << 8) | (idx * 4) )) != 0)
268                 return ret;
269
270         if ((ret = m9206_write(adap->dev->udev, M9206_FILTER, 0, (type << 8) | (idx * 4) )) != 0)
271                 return ret;
272
273         return ret;
274 }
275
276 static int m9206_update_filters(struct dvb_usb_adapter *adap)
277 {
278         struct m9206_state *m = adap->dev->priv;
279         int enabled = m->filtering_enabled;
280         int i, ret = 0, filter = 0;
281
282         for (i = 0; i < M9206_MAX_FILTERS; i++)
283                 if (m->filters[i] == 8192)
284                         enabled = 0;
285
286         /* Disable all filters */
287         if ((ret = m9206_set_filter(adap, 0x81, 1, enabled)) != 0)
288                 return ret;
289
290         for (i = 0; i < M9206_MAX_FILTERS; i++)
291                 if ((ret = m9206_set_filter(adap, 0x81, i + 2, 0)) != 0)
292                         return ret;
293
294         if ((ret = m9206_set_filter(adap, 0x82, 0, 0x0)) != 0)
295                 return ret;
296
297         /* Set */
298         if (enabled) {
299                 for (i = 0; i < M9206_MAX_FILTERS; i++) {
300                         if (m->filters[i] == 0)
301                                 continue;
302
303                         if ((ret = m9206_set_filter(adap, 0x81, filter + 2, m->filters[i])) != 0)
304                                 return ret;
305
306                         filter++;
307                 }
308         }
309
310         if ((ret = m9206_set_filter(adap, 0x82, 0, 0x02f5)) != 0)
311                 return ret;
312
313         return ret;
314 }
315
316 static int m9206_pid_filter_ctrl(struct dvb_usb_adapter *adap, int onoff)
317 {
318         struct m9206_state *m = adap->dev->priv;
319
320         m->filtering_enabled = onoff ? 1 : 0;
321
322         return m9206_update_filters(adap);
323 }
324
325 static int m9206_pid_filter(struct dvb_usb_adapter *adap, int index, u16 pid, int onoff)
326 {
327         struct m9206_state *m = adap->dev->priv;
328
329         m->filters[index] = onoff ? pid : 0;
330
331         return m9206_update_filters(adap);
332 }
333
334 static int m9206_firmware_download(struct usb_device *udev, const struct firmware *fw)
335 {
336         u16 value, index, size;
337         u8 read[4], *buff;
338         int i, pass, ret = 0;
339
340         buff = kmalloc(65536, GFP_KERNEL);
341
342         if ((ret = m9206_read(udev, M9206_FILTER, 0x0, 0x8000, read, 4)) != 0)
343                 goto done;
344         deb_rc("%x %x %x %x\n", read[0], read[1], read[2], read[3]);
345
346         if ((ret = m9206_read(udev, M9206_FW, 0x0, 0x0, read, 1)) != 0)
347                 goto done;
348         deb_rc("%x\n", read[0]);
349
350         for (pass = 0; pass < 2; pass++) {
351                 for (i = 0; i + (sizeof(u16) * 3) < fw->size;) {
352                         value = le16_to_cpu(*(u16 *)(fw->data + i));
353                         i += sizeof(u16);
354
355                         index = le16_to_cpu(*(u16 *)(fw->data + i));
356                         i += sizeof(u16);
357
358                         size = le16_to_cpu(*(u16 *)(fw->data + i));
359                         i += sizeof(u16);
360
361                         if (pass == 1) {
362                                 /* Will stall if using fw->data ... */
363                                 memcpy(buff, fw->data + i, size);
364
365                                 ret = usb_control_msg(udev, usb_sndctrlpipe(udev,0),
366                                             M9206_FW,
367                                             USB_TYPE_VENDOR | USB_DIR_OUT,
368                                             value, index, buff, size, 20);
369                                 if (ret != size) {
370                                         deb_rc("error while uploading fw!\n");
371                                         ret = -EIO;
372                                         goto done;
373                                 }
374                                 msleep(3);
375                         }
376                         i += size;
377                 }
378                 if (i != fw->size) {
379                         ret = -EINVAL;
380                         goto done;
381                 }
382         }
383
384         msleep(36);
385
386         /* m9206 will disconnect itself from the bus after this. */
387         (void) m9206_write(udev, M9206_CORE, 0x01, M9206_FW_GO);
388         deb_rc("firmware uploaded!\n");
389
390         done:
391         kfree(buff);
392
393         return ret;
394 }
395
396 /* DVB USB Driver stuff */
397 static struct dvb_usb_device_properties megasky_properties;
398
399 static int m920x_probe(struct usb_interface *intf, const struct usb_device_id *id)
400 {
401         struct dvb_usb_device *d;
402         struct usb_host_interface *alt;
403         int ret;
404
405         if ((ret = dvb_usb_device_init(intf, &megasky_properties, THIS_MODULE, &d)) == 0) {
406                 deb_rc("probed!\n");
407
408                 alt = usb_altnum_to_altsetting(intf, 1);
409                 if (alt == NULL) {
410                         deb_rc("not alt found!\n");
411                         return -ENODEV;
412                 }
413
414                 ret = usb_set_interface(d->udev, alt->desc.bInterfaceNumber, alt->desc.bAlternateSetting);
415                 if (ret < 0)
416                         return ret;
417
418                 deb_rc("Changed to alternate setting!\n");
419
420                 if ((ret = m9206_rc_init(d->udev)) != 0)
421                         return ret;
422         }
423         return ret;
424 }
425
426 static struct usb_device_id m920x_table [] = {
427                 { USB_DEVICE(USB_VID_MSI, USB_PID_MSI_MEGASKY580) },
428                 { }             /* Terminating entry */
429 };
430 MODULE_DEVICE_TABLE (usb, m920x_table);
431
432 static struct dvb_usb_device_properties megasky_properties = {
433         .usb_ctrl = DEVICE_SPECIFIC,
434         .firmware = "dvb-usb-megasky-02.fw",
435         .download_firmware = m9206_firmware_download,
436
437         .rc_interval      = 100,
438         .rc_key_map       = megasky_rc_keys,
439         .rc_key_map_size  = ARRAY_SIZE(megasky_rc_keys),
440         .rc_query         = m9206_rc_query,
441
442         .size_of_priv     = sizeof(struct m9206_state),
443
444         .identify_state   = megasky_identify_state,
445         .num_adapters = 1,
446         .adapter = {{
447                 .caps = DVB_USB_IS_AN_I2C_ADAPTER | DVB_USB_ADAP_HAS_PID_FILTER |
448                         DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF,
449
450                 .pid_filter_count = 8,
451                 .pid_filter       = m9206_pid_filter,
452                 .pid_filter_ctrl  = m9206_pid_filter_ctrl,
453
454                 .frontend_attach  = megasky_frontend_attach,
455                 .tuner_attach     = megasky_tuner_attach,
456
457                 .stream = {
458                         .type = USB_BULK,
459                         .count = 8,
460                         .endpoint = 0x81,
461                         .u = {
462                                 .bulk = {
463                                         .buffersize = 512,
464                                 }
465                         }
466                 },
467         }},
468         .i2c_algo         = &m9206_i2c_algo,
469
470         .num_device_descs = 1,
471         .devices = {
472                 {   "MSI Mega Sky 580 DVB-T USB2.0",
473                         { &m920x_table[0], NULL },
474                         { NULL },
475                 },
476                 { NULL },
477         }
478 };
479
480 static struct usb_driver m920x_driver = {
481         .name           = "dvb_usb_m920x",
482         .probe          = m920x_probe,
483         .disconnect     = dvb_usb_device_exit,
484         .id_table       = m920x_table,
485 };
486
487 /* module stuff */
488 static int __init m920x_module_init(void)
489 {
490         int ret;
491
492         if ((ret = usb_register(&m920x_driver))) {
493                 err("usb_register failed. Error number %d", ret);
494                 return ret;
495         }
496
497         return 0;
498 }
499
500 static void __exit m920x_module_exit(void)
501 {
502         /* deregister this driver from the USB subsystem */
503         usb_deregister(&m920x_driver);
504 }
505
506 module_init (m920x_module_init);
507 module_exit (m920x_module_exit);
508
509 MODULE_AUTHOR("Aapo Tahkola <aet@rasterburn.org>");
510 MODULE_DESCRIPTION("Driver MSI Mega Sky 580 DVB-T USB2.0 / Uli m920x");
511 MODULE_VERSION("0.1");
512 MODULE_LICENSE("GPL");