[PATCH] dvb: Add generalized dvb-usb driver
[linux-2.6.git] / drivers / media / dvb / dvb-usb / digitv.c
1 /* DVB USB compliant linux driver for Nebula Electronics uDigiTV DVB-T USB2.0
2  * receiver
3  *
4  * Copyright (C) 2005 Patrick Boettcher (patrick.boettcher@desy.de) and
5  *                    Allan Third (allan.third@cs.man.ac.uk)
6  *
7  * partly based on the SDK published by Nebula Electronics (TODO do we want this line ?)
8  *
9  *      This program is free software; you can redistribute it and/or modify it
10  *      under the terms of the GNU General Public License as published by the Free
11  *      Software Foundation, version 2.
12  *
13  * see Documentation/dvb/README.dvb-usb for more information
14  */
15 #include "digitv.h"
16
17 #include "mt352.h"
18 #include "nxt6000.h"
19
20 /* debug */
21 int dvb_usb_digitv_debug;
22 module_param_named(debug,dvb_usb_digitv_debug, int, 0644);
23 MODULE_PARM_DESC(debug, "set debugging level (1=rc (or-able))." DVB_USB_DEBUG_STATUS);
24
25 static int digitv_ctrl_msg(struct dvb_usb_device *d,
26                 u8 cmd, u8 vv, u8 *wbuf, int wlen, u8 *rbuf, int rlen)
27 {
28         int wo = (rbuf == NULL || rlen == 0); /* write-only */
29         u8 sndbuf[7],rcvbuf[7];
30         memset(sndbuf,0,7); memset(rcvbuf,0,7);
31
32         sndbuf[0] = cmd;
33         sndbuf[1] = vv;
34         sndbuf[2] = wo ? wlen : rlen;
35
36         if (!wo) {
37                 memcpy(&sndbuf[3],wbuf,wlen);
38                 dvb_usb_generic_write(d,sndbuf,7);
39         } else {
40                 dvb_usb_generic_rw(d,sndbuf,7,rcvbuf,7,10);
41                 memcpy(&rbuf,&rcvbuf[3],rlen);
42         }
43         return 0;
44 }
45
46 /* I2C */
47 static int digitv_i2c_xfer(struct i2c_adapter *adap,struct i2c_msg msg[],int num)
48 {
49         struct dvb_usb_device *d = i2c_get_adapdata(adap);
50         int i;
51
52         if (down_interruptible(&d->i2c_sem) < 0)
53                 return -EAGAIN;
54
55         if (num > 2)
56                 warn("more than 2 i2c messages at a time is not handled yet. TODO.");
57
58         for (i = 0; i < num; i++) {
59                 /* write/read request */
60                 if (i+1 < num && (msg[i+1].flags & I2C_M_RD)) {
61                         if (digitv_ctrl_msg(d, USB_READ_COFDM, msg[i].buf[0], NULL, 0,
62                                                 msg[i+1].buf,msg[i+1].len) < 0)
63                                 break;
64                         i++;
65                 } else
66                         if (digitv_ctrl_msg(d,USB_WRITE_COFDM, msg[i].buf[0],
67                                                 &msg[i].buf[1],msg[i].len-1,NULL,0) < 0)
68                                 break;
69         }
70
71         up(&d->i2c_sem);
72         return i;
73 }
74
75 static u32 digitv_i2c_func(struct i2c_adapter *adapter)
76 {
77         return I2C_FUNC_I2C;
78 }
79
80 static struct i2c_algorithm digitv_i2c_algo = {
81         .name          = "Nebula DigiTV USB I2C algorithm",
82         .id            = I2C_ALGO_BIT,
83         .master_xfer   = digitv_i2c_xfer,
84         .functionality = digitv_i2c_func,
85 };
86
87 /* Callbacks for DVB USB */
88 static int digitv_identify_state (struct usb_device *udev, struct
89                 dvb_usb_properties *props, struct dvb_usb_device_description **desc,
90                 int *cold)
91 {
92         *cold = udev->descriptor.iManufacturer == 0 && udev->descriptor.iProduct == 0;
93         return 0;
94 }
95
96 static int digitv_mt352_demod_init(struct dvb_frontend *fe)
97 {
98         static u8 mt352_clock_config[] = { 0x89, 0x38, 0x2d };
99         static u8 mt352_reset[] = { 0x50, 0x80 };
100         static u8 mt352_mclk_ratio[] = { 0x8b, 0x00 };
101
102         static u8 mt352_agc_cfg[] = { 0x68, 0xa0 };
103         static u8 mt352_adc_ctl_1_cfg[] = { 0x8E, 0xa0 };
104         static u8 mt352_acq_ctl[] = { 0x53, 0x50 };
105         static u8 mt352_agc_target[] = { 0x67, 0x20 };
106
107         static u8 mt352_rs_err_per[] = { 0x7c, 0x00, 0x01 };
108         static u8 mt352_snr_select[] = { 0x79, 0x00, 0x20 };
109
110         static u8 mt352_input_freq_1[] = { 0x56, 0x31, 0x05 };
111
112         static u8 mt352_scan_ctl[] = { 0x88, 0x0f };
113         static u8 mt352_capt_range[] = { 0x75, 0x32 };
114
115         mt352_write(fe, mt352_clock_config, sizeof(mt352_clock_config));
116         mt352_write(fe, mt352_reset, sizeof(mt352_reset));
117         msleep(1);
118         mt352_write(fe, mt352_mclk_ratio, sizeof(mt352_mclk_ratio));
119
120         mt352_write(fe, mt352_agc_cfg, sizeof(mt352_agc_cfg));
121         mt352_write(fe, mt352_adc_ctl_1_cfg, sizeof(mt352_adc_ctl_1_cfg));
122         mt352_write(fe, mt352_acq_ctl, sizeof(mt352_acq_ctl));
123         mt352_write(fe, mt352_agc_target, sizeof(mt352_agc_target));
124
125
126         mt352_write(fe, mt352_rs_err_per, sizeof(mt352_rs_err_per));
127         mt352_write(fe, mt352_snr_select, sizeof(mt352_snr_select));
128
129         mt352_write(fe, mt352_input_freq_1, sizeof(mt352_input_freq_1));
130
131         mt352_write(fe, mt352_scan_ctl, sizeof(mt352_scan_ctl));
132         mt352_write(fe, mt352_capt_range, sizeof(mt352_capt_range));
133
134         return 0;
135 }
136
137 static struct mt352_config digitv_mt352_config = {
138         .demod_address = 0x0, /* ignored by the digitv anyway */
139         .demod_init = digitv_mt352_demod_init,
140         .pll_set = NULL, /* TODO */
141 };
142
143 static struct nxt6000_config digitv_nxt6000_config = {
144         .demod_address = 0x0, /* ignored by the digitv anyway */
145         .clock_inversion = 0x0,
146
147         .pll_init = NULL,
148         .pll_set = NULL,
149 };
150
151 static int digitv_frontend_attach(struct dvb_usb_device *d)
152 {
153         if ((d->fe = mt352_attach(&digitv_mt352_config, &d->i2c_adap)) == NULL)
154                 return 0;
155         if ((d->fe = nxt6000_attach(&digitv_nxt6000_config, &d->i2c_adap)) == NULL) {
156
157                 warn("nxt6000 support is not done yet, in fact you are one of the first "
158                                 "person who wants to use this device in Linux. Please report to "
159                                 "linux-dvb@linuxtv.org");
160
161                 return 0;
162         }
163         return -EIO;
164 }
165
166 static struct dvb_usb_rc_key digitv_rc_keys[] = {
167         { 0x00, 0x16, KEY_POWER }, /* dummy key */
168 };
169
170 /* TODO is it really the NEC protocol ? */
171 int digitv_rc_query(struct dvb_usb_device *d, u32 *event, int *state)
172 {
173         u8 key[5];
174
175         digitv_ctrl_msg(d,USB_READ_REMOTE,0,NULL,0,&key[1],4);
176         /* TODO state, maybe it is VV ? */
177         if (key[1] != 0)
178                 key[0] = 0x01; /* if something is inside the buffer, simulate key press */
179
180         /* call the universal NEC remote processor, to find out the key's state and event */
181         dvb_usb_nec_rc_key_to_event(d,key,event,state);
182         if (key[0] != 0)
183                 deb_rc("key: %x %x %x %x %x\n",key[0],key[1],key[2],key[3],key[4]);
184         return 0;
185 }
186
187
188 /* DVB USB Driver stuff */
189 static struct dvb_usb_properties digitv_properties;
190
191 static int digitv_probe(struct usb_interface *intf,
192                 const struct usb_device_id *id)
193 {
194         return dvb_usb_device_init(intf,&digitv_properties,THIS_MODULE);
195 }
196
197 static struct usb_device_id digitv_table [] = {
198                 { USB_DEVICE(USB_VID_ANCHOR, USB_PID_NEBULA_DIGITV) },
199                 { }             /* Terminating entry */
200 };
201 MODULE_DEVICE_TABLE (usb, digitv_table);
202
203 static struct dvb_usb_properties digitv_properties = {
204         .caps = DVB_USB_IS_AN_I2C_ADAPTER,
205
206         .usb_ctrl = CYPRESS_FX2,
207         .firmware = "dvb-usb-digitv-01.fw",
208
209         .size_of_priv     = 0,
210
211         .streaming_ctrl   = NULL,
212         .pid_filter       = NULL,
213         .pid_filter_ctrl  = NULL,
214         .power_ctrl       = NULL,
215         .frontend_attach  = digitv_frontend_attach,
216         .tuner_attach     = NULL, // digitv_tuner_attach,
217         .read_mac_address = NULL,
218
219         .rc_interval      = 1000,
220         .rc_key_map       = digitv_rc_keys,
221         .rc_key_map_size  = ARRAY_SIZE(digitv_rc_keys),
222         .rc_query         = digitv_rc_query,
223
224         .identify_state   = digitv_identify_state,
225
226         .i2c_algo         = &digitv_i2c_algo,
227
228         .generic_bulk_ctrl_endpoint = 0x01,
229         /* parameter for the MPEG2-data transfer */
230         .urb = {
231                 .type = DVB_USB_BULK,
232                 .count = 7,
233                 .endpoint = 0x02,
234                 .u = {
235                         .bulk = {
236                                 .buffersize = 4096,
237                         }
238                 }
239         },
240
241         .num_device_descs = 2,
242         .devices = {
243                 {   "Nebula Electronics uDigiTV DVB-T USB2.0)",
244                         { &digitv_table[0], NULL },
245                         { NULL },
246                 },
247         }
248 };
249
250 static struct usb_driver digitv_driver = {
251         .owner          = THIS_MODULE,
252         .name           = "Nebula Electronics uDigiTV DVB-T USB2.0 device",
253         .probe          = digitv_probe,
254         .disconnect = dvb_usb_device_exit,
255         .id_table       = digitv_table,
256 };
257
258 /* module stuff */
259 static int __init digitv_module_init(void)
260 {
261         int result;
262         if ((result = usb_register(&digitv_driver))) {
263                 err("usb_register failed. Error number %d",result);
264                 return result;
265         }
266
267         return 0;
268 }
269
270 static void __exit digitv_module_exit(void)
271 {
272         /* deregister this driver from the USB subsystem */
273         usb_deregister(&digitv_driver);
274 }
275
276 module_init (digitv_module_init);
277 module_exit (digitv_module_exit);
278
279 MODULE_AUTHOR("Patrick Boettcher <patrick.boettcher@desy.de>");
280 MODULE_DESCRIPTION("Driver for Nebula Electronics uDigiTV DVB-T USB2.0");
281 MODULE_VERSION("1.0-alpha");
282 MODULE_LICENSE("GPL");