V4L/DVB (10954): Add cx231xx USB driver
[linux-2.6] / drivers / media / video / hdpvr / hdpvr-core.c
1 /*
2  * Hauppauge HD PVR USB driver
3  *
4  * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
5  * Copyright (C) 2008      Janne Grunau (j@jannau.net)
6  * Copyright (C) 2008      John Poet
7  *
8  *      This program is free software; you can redistribute it and/or
9  *      modify it under the terms of the GNU General Public License as
10  *      published by the Free Software Foundation, version 2.
11  *
12  */
13
14 #include <linux/kernel.h>
15 #include <linux/errno.h>
16 #include <linux/init.h>
17 #include <linux/slab.h>
18 #include <linux/module.h>
19 #include <linux/uaccess.h>
20 #include <asm/atomic.h>
21 #include <linux/usb.h>
22 #include <linux/mutex.h>
23 #include <linux/i2c.h>
24
25 #include <linux/videodev2.h>
26 #include <media/v4l2-dev.h>
27 #include <media/v4l2-common.h>
28
29 #include "hdpvr.h"
30
31 static int video_nr[HDPVR_MAX] = {[0 ... (HDPVR_MAX - 1)] = UNSET};
32 module_param_array(video_nr, int, NULL, 0);
33 MODULE_PARM_DESC(video_nr, "video device number (-1=Auto)");
34
35 /* holds the number of currently registered devices */
36 static atomic_t dev_nr = ATOMIC_INIT(-1);
37
38 int hdpvr_debug;
39 module_param(hdpvr_debug, int, S_IRUGO|S_IWUSR);
40 MODULE_PARM_DESC(hdpvr_debug, "enable debugging output");
41
42 uint default_video_input = HDPVR_VIDEO_INPUTS;
43 module_param(default_video_input, uint, S_IRUGO|S_IWUSR);
44 MODULE_PARM_DESC(default_video_input, "default video input: 0=Component / "
45                  "1=S-Video / 2=Composite");
46
47 uint default_audio_input = HDPVR_AUDIO_INPUTS;
48 module_param(default_audio_input, uint, S_IRUGO|S_IWUSR);
49 MODULE_PARM_DESC(default_audio_input, "default audio input: 0=RCA back / "
50                  "1=RCA front / 2=S/PDIF");
51
52 static int boost_audio;
53 module_param(boost_audio, bool, S_IRUGO|S_IWUSR);
54 MODULE_PARM_DESC(boost_audio, "boost the audio signal");
55
56
57 /* table of devices that work with this driver */
58 static struct usb_device_id hdpvr_table[] = {
59         { USB_DEVICE(HD_PVR_VENDOR_ID, HD_PVR_PRODUCT_ID) },
60         { USB_DEVICE(HD_PVR_VENDOR_ID, HD_PVR_PRODUCT_ID1) },
61         { USB_DEVICE(HD_PVR_VENDOR_ID, HD_PVR_PRODUCT_ID2) },
62         { }                                     /* Terminating entry */
63 };
64 MODULE_DEVICE_TABLE(usb, hdpvr_table);
65
66
67 void hdpvr_delete(struct hdpvr_device *dev)
68 {
69         hdpvr_free_buffers(dev);
70
71         if (dev->video_dev)
72                 video_device_release(dev->video_dev);
73
74         usb_put_dev(dev->udev);
75 }
76
77 static void challenge(u8 *bytes)
78 {
79         u64 *i64P, tmp64;
80         uint i, idx;
81
82         for (idx = 0; idx < 32; ++idx) {
83
84                 if (idx & 0x3)
85                         bytes[(idx >> 3) + 3] = bytes[(idx >> 2) & 0x3];
86
87                 switch (idx & 0x3) {
88                 case 0x3:
89                         bytes[2] += bytes[3] * 4 + bytes[4] + bytes[5];
90                         bytes[4] += bytes[(idx & 0x1) * 2] * 9 + 9;
91                         break;
92                 case 0x1:
93                         bytes[0] *= 8;
94                         bytes[0] += 7*idx + 4;
95                         bytes[6] += bytes[3] * 3;
96                         break;
97                 case 0x0:
98                         bytes[3 - (idx >> 3)] = bytes[idx >> 2];
99                         bytes[5] += bytes[6] * 3;
100                         for (i = 0; i < 3; i++)
101                                 bytes[3] *= bytes[3] + 1;
102                         break;
103                 case 0x2:
104                         for (i = 0; i < 3; i++)
105                                 bytes[1] *= bytes[6] + 1;
106                         for (i = 0; i < 3; i++) {
107                                 i64P = (u64 *)bytes;
108                                 tmp64 = le64_to_cpup(i64P);
109                                 tmp64 <<= bytes[7] & 0x0f;
110                                 *i64P += cpu_to_le64(tmp64);
111                         }
112                         break;
113                 }
114         }
115 }
116
117 /* try to init the device like the windows driver */
118 static int device_authorization(struct hdpvr_device *dev)
119 {
120
121         int ret, retval = -ENOMEM;
122         char request_type = 0x38, rcv_request = 0x81;
123         char *response;
124 #ifdef HDPVR_DEBUG
125         size_t buf_size = 46;
126         char *print_buf = kzalloc(5*buf_size+1, GFP_KERNEL);
127         if (!print_buf) {
128                 v4l2_err(&dev->v4l2_dev, "Out of memory\n");
129                 goto error;
130         }
131 #endif
132
133         mutex_lock(&dev->usbc_mutex);
134         ret = usb_control_msg(dev->udev,
135                               usb_rcvctrlpipe(dev->udev, 0),
136                               rcv_request, 0x80 | request_type,
137                               0x0400, 0x0003,
138                               dev->usbc_buf, 46,
139                               10000);
140         if (ret != 46) {
141                 v4l2_err(&dev->v4l2_dev,
142                          "unexpected answer of status request, len %d\n", ret);
143                 goto error;
144         }
145 #ifdef HDPVR_DEBUG
146         else {
147                 hex_dump_to_buffer(dev->usbc_buf, 46, 16, 1, print_buf,
148                                    sizeof(print_buf), 0);
149                 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
150                          "Status request returned, len %d: %s\n",
151                          ret, print_buf);
152         }
153 #endif
154         if (dev->usbc_buf[1] == HDPVR_FIRMWARE_VERSION) {
155                 dev->flags &= ~HDPVR_FLAG_AC3_CAP;
156         } else if (dev->usbc_buf[1] == HDPVR_FIRMWARE_VERSION_AC3) {
157                 dev->flags |= HDPVR_FLAG_AC3_CAP;
158         } else if (dev->usbc_buf[1] > HDPVR_FIRMWARE_VERSION_AC3) {
159                 v4l2_info(&dev->v4l2_dev, "untested firmware version 0x%x, "
160                           "the driver might not work\n", dev->usbc_buf[1]);
161                 dev->flags |= HDPVR_FLAG_AC3_CAP;
162         } else {
163                 v4l2_err(&dev->v4l2_dev, "unknown firmware version 0x%x\n",
164                         dev->usbc_buf[1]);
165                 ret = -EINVAL;
166                 goto error;
167         }
168
169         response = dev->usbc_buf+38;
170 #ifdef HDPVR_DEBUG
171         hex_dump_to_buffer(response, 8, 16, 1, print_buf, sizeof(print_buf), 0);
172         v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, "challenge: %s\n",
173                  print_buf);
174 #endif
175         challenge(response);
176 #ifdef HDPVR_DEBUG
177         hex_dump_to_buffer(response, 8, 16, 1, print_buf, sizeof(print_buf), 0);
178         v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, " response: %s\n",
179                  print_buf);
180 #endif
181
182         msleep(100);
183         ret = usb_control_msg(dev->udev,
184                               usb_sndctrlpipe(dev->udev, 0),
185                               0xd1, 0x00 | request_type,
186                               0x0000, 0x0000,
187                               response, 8,
188                               10000);
189         v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
190                  "magic request returned %d\n", ret);
191         mutex_unlock(&dev->usbc_mutex);
192
193         retval = ret != 8;
194 error:
195         return retval;
196 }
197
198 static int hdpvr_device_init(struct hdpvr_device *dev)
199 {
200         int ret;
201         u8 *buf;
202         struct hdpvr_video_info *vidinf;
203
204         if (device_authorization(dev))
205                 return -EACCES;
206
207         /* default options for init */
208         hdpvr_set_options(dev);
209
210         /* set filter options */
211         mutex_lock(&dev->usbc_mutex);
212         buf = dev->usbc_buf;
213         buf[0] = 0x03; buf[1] = 0x03; buf[2] = 0x00; buf[3] = 0x00;
214         ret = usb_control_msg(dev->udev,
215                               usb_sndctrlpipe(dev->udev, 0),
216                               0x01, 0x38,
217                               CTRL_LOW_PASS_FILTER_VALUE, CTRL_DEFAULT_INDEX,
218                               buf, 4,
219                               1000);
220         v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
221                  "control request returned %d\n", ret);
222         mutex_unlock(&dev->usbc_mutex);
223
224         vidinf = get_video_info(dev);
225         if (!vidinf)
226                 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
227                         "no valid video signal or device init failed\n");
228         else
229                 kfree(vidinf);
230
231         /* enable fan and bling leds */
232         mutex_lock(&dev->usbc_mutex);
233         buf[0] = 0x1;
234         ret = usb_control_msg(dev->udev,
235                               usb_sndctrlpipe(dev->udev, 0),
236                               0xd4, 0x38, 0, 0, buf, 1,
237                               1000);
238         v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
239                  "control request returned %d\n", ret);
240
241         /* boost analog audio */
242         buf[0] = boost_audio;
243         ret = usb_control_msg(dev->udev,
244                               usb_sndctrlpipe(dev->udev, 0),
245                               0xd5, 0x38, 0, 0, buf, 1,
246                               1000);
247         v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
248                  "control request returned %d\n", ret);
249         mutex_unlock(&dev->usbc_mutex);
250
251         dev->status = STATUS_IDLE;
252         return 0;
253 }
254
255 static const struct hdpvr_options hdpvr_default_options = {
256         .video_std      = HDPVR_60HZ,
257         .video_input    = HDPVR_COMPONENT,
258         .audio_input    = HDPVR_RCA_BACK,
259         .bitrate        = 65, /* 6 mbps */
260         .peak_bitrate   = 90, /* 9 mbps */
261         .bitrate_mode   = HDPVR_CONSTANT,
262         .gop_mode       = HDPVR_SIMPLE_IDR_GOP,
263         .audio_codec    = V4L2_MPEG_AUDIO_ENCODING_AAC,
264         .brightness     = 0x86,
265         .contrast       = 0x80,
266         .hue            = 0x80,
267         .saturation     = 0x80,
268         .sharpness      = 0x80,
269 };
270
271 static int hdpvr_probe(struct usb_interface *interface,
272                        const struct usb_device_id *id)
273 {
274         struct hdpvr_device *dev;
275         struct usb_host_interface *iface_desc;
276         struct usb_endpoint_descriptor *endpoint;
277         size_t buffer_size;
278         int i;
279         int retval = -ENOMEM;
280
281         /* allocate memory for our device state and initialize it */
282         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
283         if (!dev) {
284                 err("Out of memory");
285                 goto error;
286         }
287
288         /* register v4l2_device early so it can be used for printks */
289         if (v4l2_device_register(&interface->dev, &dev->v4l2_dev)) {
290                 err("v4l2_device_register failed");
291                 goto error;
292         }
293
294         mutex_init(&dev->io_mutex);
295         mutex_init(&dev->i2c_mutex);
296         mutex_init(&dev->usbc_mutex);
297         dev->usbc_buf = kmalloc(64, GFP_KERNEL);
298         if (!dev->usbc_buf) {
299                 v4l2_err(&dev->v4l2_dev, "Out of memory\n");
300                 goto error;
301         }
302
303         init_waitqueue_head(&dev->wait_buffer);
304         init_waitqueue_head(&dev->wait_data);
305
306         dev->workqueue = create_singlethread_workqueue("hdpvr_buffer");
307         if (!dev->workqueue)
308                 goto error;
309
310         /* init video transfer queues */
311         INIT_LIST_HEAD(&dev->free_buff_list);
312         INIT_LIST_HEAD(&dev->rec_buff_list);
313
314         dev->options = hdpvr_default_options;
315
316         if (default_video_input < HDPVR_VIDEO_INPUTS)
317                 dev->options.video_input = default_video_input;
318
319         if (default_audio_input < HDPVR_AUDIO_INPUTS)
320                 dev->options.audio_input = default_audio_input;
321
322         dev->udev = usb_get_dev(interface_to_usbdev(interface));
323
324         /* set up the endpoint information */
325         /* use only the first bulk-in and bulk-out endpoints */
326         iface_desc = interface->cur_altsetting;
327         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
328                 endpoint = &iface_desc->endpoint[i].desc;
329
330                 if (!dev->bulk_in_endpointAddr &&
331                     usb_endpoint_is_bulk_in(endpoint)) {
332                         /* USB interface description is buggy, reported max
333                          * packet size is 512 bytes, windows driver uses 8192 */
334                         buffer_size = 8192;
335                         dev->bulk_in_size = buffer_size;
336                         dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
337                 }
338
339         }
340         if (!dev->bulk_in_endpointAddr) {
341                 v4l2_err(&dev->v4l2_dev, "Could not find bulk-in endpoint\n");
342                 goto error;
343         }
344
345         /* init the device */
346         if (hdpvr_device_init(dev)) {
347                 v4l2_err(&dev->v4l2_dev, "device init failed\n");
348                 goto error;
349         }
350
351         mutex_lock(&dev->io_mutex);
352         if (hdpvr_alloc_buffers(dev, NUM_BUFFERS)) {
353                 v4l2_err(&dev->v4l2_dev,
354                          "allocating transfer buffers failed\n");
355                 goto error;
356         }
357         mutex_unlock(&dev->io_mutex);
358
359         if (hdpvr_register_videodev(dev, &interface->dev,
360                                     video_nr[atomic_inc_return(&dev_nr)])) {
361                 v4l2_err(&dev->v4l2_dev, "registering videodev failed\n");
362                 goto error;
363         }
364
365 #ifdef CONFIG_I2C
366         /* until i2c is working properly */
367         retval = 0; /* hdpvr_register_i2c_adapter(dev); */
368         if (retval < 0) {
369                 v4l2_err(&dev->v4l2_dev, "registering i2c adapter failed\n");
370                 goto error;
371         }
372 #endif /* CONFIG_I2C */
373
374         /* save our data pointer in this interface device */
375         usb_set_intfdata(interface, dev);
376
377         /* let the user know what node this device is now attached to */
378         v4l2_info(&dev->v4l2_dev, "device now attached to /dev/video%d\n",
379                   dev->video_dev->minor);
380         return 0;
381
382 error:
383         if (dev) {
384                 mutex_unlock(&dev->io_mutex);
385                 /* this frees allocated memory */
386                 hdpvr_delete(dev);
387         }
388         return retval;
389 }
390
391 static void hdpvr_disconnect(struct usb_interface *interface)
392 {
393         struct hdpvr_device *dev;
394         int minor;
395
396         dev = usb_get_intfdata(interface);
397         usb_set_intfdata(interface, NULL);
398
399         minor = dev->video_dev->minor;
400
401         /* prevent more I/O from starting and stop any ongoing */
402         mutex_lock(&dev->io_mutex);
403         dev->status = STATUS_DISCONNECTED;
404         v4l2_device_disconnect(&dev->v4l2_dev);
405         video_unregister_device(dev->video_dev);
406         wake_up_interruptible(&dev->wait_data);
407         wake_up_interruptible(&dev->wait_buffer);
408         mutex_unlock(&dev->io_mutex);
409         msleep(100);
410         flush_workqueue(dev->workqueue);
411         mutex_lock(&dev->io_mutex);
412         hdpvr_cancel_queue(dev);
413         destroy_workqueue(dev->workqueue);
414         mutex_unlock(&dev->io_mutex);
415
416         /* deregister I2C adapter */
417 #ifdef CONFIG_I2C
418         mutex_lock(&dev->i2c_mutex);
419         if (dev->i2c_adapter)
420                 i2c_del_adapter(dev->i2c_adapter);
421         kfree(dev->i2c_adapter);
422         dev->i2c_adapter = NULL;
423         mutex_unlock(&dev->i2c_mutex);
424 #endif /* CONFIG_I2C */
425
426         atomic_dec(&dev_nr);
427
428         v4l2_info(&dev->v4l2_dev, "device /dev/video%d disconnected\n", minor);
429
430         v4l2_device_unregister(&dev->v4l2_dev);
431         kfree(dev->usbc_buf);
432         kfree(dev);
433 }
434
435
436 static struct usb_driver hdpvr_usb_driver = {
437         .name =         "hdpvr",
438         .probe =        hdpvr_probe,
439         .disconnect =   hdpvr_disconnect,
440         .id_table =     hdpvr_table,
441 };
442
443 static int __init hdpvr_init(void)
444 {
445         int result;
446
447         /* register this driver with the USB subsystem */
448         result = usb_register(&hdpvr_usb_driver);
449         if (result)
450                 err("usb_register failed. Error number %d", result);
451
452         return result;
453 }
454
455 static void __exit hdpvr_exit(void)
456 {
457         /* deregister this driver with the USB subsystem */
458         usb_deregister(&hdpvr_usb_driver);
459 }
460
461 module_init(hdpvr_init);
462 module_exit(hdpvr_exit);
463
464 MODULE_LICENSE("GPL");
465 MODULE_AUTHOR("Janne Grunau");
466 MODULE_DESCRIPTION("Hauppauge HD PVR driver");