2 * Hauppauge HD PVR USB driver
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
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.
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>
25 #include <linux/videodev2.h>
26 #include <media/v4l2-dev.h>
27 #include <media/v4l2-common.h>
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)");
35 /* holds the number of currently registered devices */
36 static atomic_t dev_nr = ATOMIC_INIT(-1);
39 module_param(hdpvr_debug, int, S_IRUGO|S_IWUSR);
40 MODULE_PARM_DESC(hdpvr_debug, "enable debugging output");
42 static 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");
47 static 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");
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");
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 { USB_DEVICE(HD_PVR_VENDOR_ID, HD_PVR_PRODUCT_ID3) },
63 { } /* Terminating entry */
65 MODULE_DEVICE_TABLE(usb, hdpvr_table);
68 void hdpvr_delete(struct hdpvr_device *dev)
70 hdpvr_free_buffers(dev);
73 video_device_release(dev->video_dev);
75 usb_put_dev(dev->udev);
78 static void challenge(u8 *bytes)
83 for (idx = 0; idx < 32; ++idx) {
86 bytes[(idx >> 3) + 3] = bytes[(idx >> 2) & 0x3];
90 bytes[2] += bytes[3] * 4 + bytes[4] + bytes[5];
91 bytes[4] += bytes[(idx & 0x1) * 2] * 9 + 9;
95 bytes[0] += 7*idx + 4;
96 bytes[6] += bytes[3] * 3;
99 bytes[3 - (idx >> 3)] = bytes[idx >> 2];
100 bytes[5] += bytes[6] * 3;
101 for (i = 0; i < 3; i++)
102 bytes[3] *= bytes[3] + 1;
105 for (i = 0; i < 3; i++)
106 bytes[1] *= bytes[6] + 1;
107 for (i = 0; i < 3; i++) {
109 tmp64 = le64_to_cpup(i64P);
110 tmp64 <<= bytes[7] & 0x0f;
111 *i64P += cpu_to_le64(tmp64);
118 /* try to init the device like the windows driver */
119 static int device_authorization(struct hdpvr_device *dev)
122 int ret, retval = -ENOMEM;
123 char request_type = 0x38, rcv_request = 0x81;
126 size_t buf_size = 46;
127 char *print_buf = kzalloc(5*buf_size+1, GFP_KERNEL);
129 v4l2_err(&dev->v4l2_dev, "Out of memory\n");
134 mutex_lock(&dev->usbc_mutex);
135 ret = usb_control_msg(dev->udev,
136 usb_rcvctrlpipe(dev->udev, 0),
137 rcv_request, 0x80 | request_type,
142 v4l2_err(&dev->v4l2_dev,
143 "unexpected answer of status request, len %d\n", ret);
148 hex_dump_to_buffer(dev->usbc_buf, 46, 16, 1, print_buf,
150 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
151 "Status request returned, len %d: %s\n",
155 if (dev->usbc_buf[1] == HDPVR_FIRMWARE_VERSION) {
156 dev->flags &= ~HDPVR_FLAG_AC3_CAP;
157 } else if (dev->usbc_buf[1] == HDPVR_FIRMWARE_VERSION_AC3) {
158 dev->flags |= HDPVR_FLAG_AC3_CAP;
159 } else if (dev->usbc_buf[1] > HDPVR_FIRMWARE_VERSION_AC3) {
160 v4l2_info(&dev->v4l2_dev, "untested firmware version 0x%x, "
161 "the driver might not work\n", dev->usbc_buf[1]);
162 dev->flags |= HDPVR_FLAG_AC3_CAP;
164 v4l2_err(&dev->v4l2_dev, "unknown firmware version 0x%x\n",
170 response = dev->usbc_buf+38;
172 hex_dump_to_buffer(response, 8, 16, 1, print_buf, 5*buf_size+1, 0);
173 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, "challenge: %s\n",
178 hex_dump_to_buffer(response, 8, 16, 1, print_buf, 5*buf_size+1, 0);
179 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, " response: %s\n",
184 ret = usb_control_msg(dev->udev,
185 usb_sndctrlpipe(dev->udev, 0),
186 0xd1, 0x00 | request_type,
190 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
191 "magic request returned %d\n", ret);
195 mutex_unlock(&dev->usbc_mutex);
199 static int hdpvr_device_init(struct hdpvr_device *dev)
203 struct hdpvr_video_info *vidinf;
205 if (device_authorization(dev))
208 /* default options for init */
209 hdpvr_set_options(dev);
211 /* set filter options */
212 mutex_lock(&dev->usbc_mutex);
214 buf[0] = 0x03; buf[1] = 0x03; buf[2] = 0x00; buf[3] = 0x00;
215 ret = usb_control_msg(dev->udev,
216 usb_sndctrlpipe(dev->udev, 0),
218 CTRL_LOW_PASS_FILTER_VALUE, CTRL_DEFAULT_INDEX,
221 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
222 "control request returned %d\n", ret);
223 mutex_unlock(&dev->usbc_mutex);
225 vidinf = get_video_info(dev);
227 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
228 "no valid video signal or device init failed\n");
232 /* enable fan and bling leds */
233 mutex_lock(&dev->usbc_mutex);
235 ret = usb_control_msg(dev->udev,
236 usb_sndctrlpipe(dev->udev, 0),
237 0xd4, 0x38, 0, 0, buf, 1,
239 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
240 "control request returned %d\n", ret);
242 /* boost analog audio */
243 buf[0] = boost_audio;
244 ret = usb_control_msg(dev->udev,
245 usb_sndctrlpipe(dev->udev, 0),
246 0xd5, 0x38, 0, 0, buf, 1,
248 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
249 "control request returned %d\n", ret);
250 mutex_unlock(&dev->usbc_mutex);
252 dev->status = STATUS_IDLE;
256 static const struct hdpvr_options hdpvr_default_options = {
257 .video_std = HDPVR_60HZ,
258 .video_input = HDPVR_COMPONENT,
259 .audio_input = HDPVR_RCA_BACK,
260 .bitrate = 65, /* 6 mbps */
261 .peak_bitrate = 90, /* 9 mbps */
262 .bitrate_mode = HDPVR_CONSTANT,
263 .gop_mode = HDPVR_SIMPLE_IDR_GOP,
264 .audio_codec = V4L2_MPEG_AUDIO_ENCODING_AAC,
272 static int hdpvr_probe(struct usb_interface *interface,
273 const struct usb_device_id *id)
275 struct hdpvr_device *dev;
276 struct usb_host_interface *iface_desc;
277 struct usb_endpoint_descriptor *endpoint;
280 int retval = -ENOMEM;
282 /* allocate memory for our device state and initialize it */
283 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
285 err("Out of memory");
289 /* register v4l2_device early so it can be used for printks */
290 if (v4l2_device_register(&interface->dev, &dev->v4l2_dev)) {
291 err("v4l2_device_register failed");
295 mutex_init(&dev->io_mutex);
296 mutex_init(&dev->i2c_mutex);
297 mutex_init(&dev->usbc_mutex);
298 dev->usbc_buf = kmalloc(64, GFP_KERNEL);
299 if (!dev->usbc_buf) {
300 v4l2_err(&dev->v4l2_dev, "Out of memory\n");
304 init_waitqueue_head(&dev->wait_buffer);
305 init_waitqueue_head(&dev->wait_data);
307 dev->workqueue = create_singlethread_workqueue("hdpvr_buffer");
311 /* init video transfer queues */
312 INIT_LIST_HEAD(&dev->free_buff_list);
313 INIT_LIST_HEAD(&dev->rec_buff_list);
315 dev->options = hdpvr_default_options;
317 if (default_video_input < HDPVR_VIDEO_INPUTS)
318 dev->options.video_input = default_video_input;
320 if (default_audio_input < HDPVR_AUDIO_INPUTS)
321 dev->options.audio_input = default_audio_input;
323 dev->udev = usb_get_dev(interface_to_usbdev(interface));
325 /* set up the endpoint information */
326 /* use only the first bulk-in and bulk-out endpoints */
327 iface_desc = interface->cur_altsetting;
328 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
329 endpoint = &iface_desc->endpoint[i].desc;
331 if (!dev->bulk_in_endpointAddr &&
332 usb_endpoint_is_bulk_in(endpoint)) {
333 /* USB interface description is buggy, reported max
334 * packet size is 512 bytes, windows driver uses 8192 */
336 dev->bulk_in_size = buffer_size;
337 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
341 if (!dev->bulk_in_endpointAddr) {
342 v4l2_err(&dev->v4l2_dev, "Could not find bulk-in endpoint\n");
346 /* init the device */
347 if (hdpvr_device_init(dev)) {
348 v4l2_err(&dev->v4l2_dev, "device init failed\n");
352 mutex_lock(&dev->io_mutex);
353 if (hdpvr_alloc_buffers(dev, NUM_BUFFERS)) {
354 mutex_unlock(&dev->io_mutex);
355 v4l2_err(&dev->v4l2_dev,
356 "allocating transfer buffers failed\n");
359 mutex_unlock(&dev->io_mutex);
361 if (hdpvr_register_videodev(dev, &interface->dev,
362 video_nr[atomic_inc_return(&dev_nr)])) {
363 v4l2_err(&dev->v4l2_dev, "registering videodev failed\n");
368 /* until i2c is working properly */
369 retval = 0; /* hdpvr_register_i2c_adapter(dev); */
371 v4l2_err(&dev->v4l2_dev, "registering i2c adapter failed\n");
374 #endif /* CONFIG_I2C */
376 /* let the user know what node this device is now attached to */
377 v4l2_info(&dev->v4l2_dev, "device now attached to %s\n",
378 video_device_node_name(dev->video_dev));
383 /* this frees allocated memory */
389 static void hdpvr_disconnect(struct usb_interface *interface)
391 struct hdpvr_device *dev = to_hdpvr_dev(usb_get_intfdata(interface));
393 v4l2_info(&dev->v4l2_dev, "device %s disconnected\n",
394 video_device_node_name(dev->video_dev));
395 /* prevent more I/O from starting and stop any ongoing */
396 mutex_lock(&dev->io_mutex);
397 dev->status = STATUS_DISCONNECTED;
398 wake_up_interruptible(&dev->wait_data);
399 wake_up_interruptible(&dev->wait_buffer);
400 mutex_unlock(&dev->io_mutex);
401 v4l2_device_disconnect(&dev->v4l2_dev);
403 flush_workqueue(dev->workqueue);
404 mutex_lock(&dev->io_mutex);
405 hdpvr_cancel_queue(dev);
406 mutex_unlock(&dev->io_mutex);
407 video_unregister_device(dev->video_dev);
412 static struct usb_driver hdpvr_usb_driver = {
414 .probe = hdpvr_probe,
415 .disconnect = hdpvr_disconnect,
416 .id_table = hdpvr_table,
419 static int __init hdpvr_init(void)
423 /* register this driver with the USB subsystem */
424 result = usb_register(&hdpvr_usb_driver);
426 err("usb_register failed. Error number %d", result);
431 static void __exit hdpvr_exit(void)
433 /* deregister this driver with the USB subsystem */
434 usb_deregister(&hdpvr_usb_driver);
437 module_init(hdpvr_init);
438 module_exit(hdpvr_exit);
440 MODULE_LICENSE("GPL");
441 MODULE_AUTHOR("Janne Grunau");
442 MODULE_DESCRIPTION("Hauppauge HD PVR driver");