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 <linux/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 bool 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 { USB_DEVICE(HD_PVR_VENDOR_ID, HD_PVR_PRODUCT_ID4) },
64 { } /* Terminating entry */
66 MODULE_DEVICE_TABLE(usb, hdpvr_table);
69 void hdpvr_delete(struct hdpvr_device *dev)
71 hdpvr_free_buffers(dev);
72 usb_put_dev(dev->udev);
75 static void challenge(u8 *bytes)
81 for (idx = 0; idx < 32; ++idx) {
84 bytes[(idx >> 3) + 3] = bytes[(idx >> 2) & 0x3];
88 bytes[2] += bytes[3] * 4 + bytes[4] + bytes[5];
89 bytes[4] += bytes[(idx & 0x1) * 2] * 9 + 9;
93 bytes[0] += 7*idx + 4;
94 bytes[6] += bytes[3] * 3;
97 bytes[3 - (idx >> 3)] = bytes[idx >> 2];
98 bytes[5] += bytes[6] * 3;
99 for (i = 0; i < 3; i++)
100 bytes[3] *= bytes[3] + 1;
103 for (i = 0; i < 3; i++)
104 bytes[1] *= bytes[6] + 1;
105 for (i = 0; i < 3; i++) {
106 i64P = (__le64 *)bytes;
107 tmp64 = le64_to_cpup(i64P);
108 tmp64 = tmp64 + (tmp64 << (bytes[7] & 0x0f));
109 *i64P = cpu_to_le64(tmp64);
116 /* try to init the device like the windows driver */
117 static int device_authorization(struct hdpvr_device *dev)
120 int ret, retval = -ENOMEM;
121 char request_type = 0x38, rcv_request = 0x81;
124 mutex_lock(&dev->usbc_mutex);
125 ret = usb_control_msg(dev->udev,
126 usb_rcvctrlpipe(dev->udev, 0),
127 rcv_request, 0x80 | request_type,
132 v4l2_err(&dev->v4l2_dev,
133 "unexpected answer of status request, len %d\n", ret);
138 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
139 "Status request returned, len %d: %46ph\n",
144 dev->fw_ver = dev->usbc_buf[1];
146 dev->usbc_buf[46] = '\0';
147 v4l2_info(&dev->v4l2_dev, "firmware version 0x%x dated %s\n",
148 dev->fw_ver, &dev->usbc_buf[2]);
150 if (dev->fw_ver > 0x15) {
151 dev->options.brightness = 0x80;
152 dev->options.contrast = 0x40;
153 dev->options.hue = 0xf;
154 dev->options.saturation = 0x40;
155 dev->options.sharpness = 0x80;
158 switch (dev->fw_ver) {
159 case HDPVR_FIRMWARE_VERSION:
160 dev->flags &= ~HDPVR_FLAG_AC3_CAP;
162 case HDPVR_FIRMWARE_VERSION_AC3:
163 case HDPVR_FIRMWARE_VERSION_0X12:
164 case HDPVR_FIRMWARE_VERSION_0X15:
165 case HDPVR_FIRMWARE_VERSION_0X1E:
166 dev->flags |= HDPVR_FLAG_AC3_CAP;
169 v4l2_info(&dev->v4l2_dev, "untested firmware, the driver might"
171 if (dev->fw_ver >= HDPVR_FIRMWARE_VERSION_AC3)
172 dev->flags |= HDPVR_FLAG_AC3_CAP;
174 dev->flags &= ~HDPVR_FLAG_AC3_CAP;
177 response = dev->usbc_buf+38;
179 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, "challenge: %8ph\n",
184 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, " response: %8ph\n",
189 ret = usb_control_msg(dev->udev,
190 usb_sndctrlpipe(dev->udev, 0),
191 0xd1, 0x00 | request_type,
195 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
196 "magic request returned %d\n", ret);
200 mutex_unlock(&dev->usbc_mutex);
204 static int hdpvr_device_init(struct hdpvr_device *dev)
209 if (device_authorization(dev))
212 /* default options for init */
213 hdpvr_set_options(dev);
215 /* set filter options */
216 mutex_lock(&dev->usbc_mutex);
218 buf[0] = 0x03; buf[1] = 0x03; buf[2] = 0x00; buf[3] = 0x00;
219 ret = usb_control_msg(dev->udev,
220 usb_sndctrlpipe(dev->udev, 0),
222 CTRL_LOW_PASS_FILTER_VALUE, CTRL_DEFAULT_INDEX,
225 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
226 "control request returned %d\n", ret);
227 mutex_unlock(&dev->usbc_mutex);
229 /* enable fan and bling leds */
230 mutex_lock(&dev->usbc_mutex);
232 ret = usb_control_msg(dev->udev,
233 usb_sndctrlpipe(dev->udev, 0),
234 0xd4, 0x38, 0, 0, buf, 1,
236 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
237 "control request returned %d\n", ret);
239 /* boost analog audio */
240 buf[0] = boost_audio;
241 ret = usb_control_msg(dev->udev,
242 usb_sndctrlpipe(dev->udev, 0),
243 0xd5, 0x38, 0, 0, buf, 1,
245 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
246 "control request returned %d\n", ret);
247 mutex_unlock(&dev->usbc_mutex);
249 dev->status = STATUS_IDLE;
253 static const struct hdpvr_options hdpvr_default_options = {
254 .video_std = HDPVR_60HZ,
255 .video_input = HDPVR_COMPONENT,
256 .audio_input = HDPVR_RCA_BACK,
257 .bitrate = 65, /* 6 mbps */
258 .peak_bitrate = 90, /* 9 mbps */
259 .bitrate_mode = HDPVR_CONSTANT,
260 .gop_mode = HDPVR_SIMPLE_IDR_GOP,
261 .audio_codec = V4L2_MPEG_AUDIO_ENCODING_AAC,
262 /* original picture controls for firmware version <= 0x15 */
263 /* updated in device_authorization() for newer firmware */
271 static int hdpvr_probe(struct usb_interface *interface,
272 const struct usb_device_id *id)
274 struct hdpvr_device *dev;
275 struct usb_host_interface *iface_desc;
276 struct usb_endpoint_descriptor *endpoint;
277 #if IS_ENABLED(CONFIG_I2C)
278 struct i2c_client *client;
283 int retval = -ENOMEM;
285 /* allocate memory for our device state and initialize it */
286 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
288 dev_err(&interface->dev, "Out of memory\n");
292 /* init video transfer queues first of all */
293 /* to prevent oops in hdpvr_delete() on error paths */
294 INIT_LIST_HEAD(&dev->free_buff_list);
295 INIT_LIST_HEAD(&dev->rec_buff_list);
297 /* register v4l2_device early so it can be used for printks */
298 if (v4l2_device_register(&interface->dev, &dev->v4l2_dev)) {
299 dev_err(&interface->dev, "v4l2_device_register failed\n");
303 mutex_init(&dev->io_mutex);
304 mutex_init(&dev->i2c_mutex);
305 mutex_init(&dev->usbc_mutex);
306 dev->usbc_buf = kmalloc(64, GFP_KERNEL);
307 if (!dev->usbc_buf) {
308 v4l2_err(&dev->v4l2_dev, "Out of memory\n");
309 goto error_v4l2_unregister;
312 init_waitqueue_head(&dev->wait_buffer);
313 init_waitqueue_head(&dev->wait_data);
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;
322 if (default_audio_input == HDPVR_SPDIF)
323 dev->options.audio_codec =
324 V4L2_MPEG_AUDIO_ENCODING_AC3;
327 dev->udev = usb_get_dev(interface_to_usbdev(interface));
329 /* set up the endpoint information */
330 /* use only the first bulk-in and bulk-out endpoints */
331 iface_desc = interface->cur_altsetting;
332 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
333 endpoint = &iface_desc->endpoint[i].desc;
335 if (!dev->bulk_in_endpointAddr &&
336 usb_endpoint_is_bulk_in(endpoint)) {
337 /* USB interface description is buggy, reported max
338 * packet size is 512 bytes, windows driver uses 8192 */
340 dev->bulk_in_size = buffer_size;
341 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
345 if (!dev->bulk_in_endpointAddr) {
346 v4l2_err(&dev->v4l2_dev, "Could not find bulk-in endpoint\n");
350 /* init the device */
351 if (hdpvr_device_init(dev)) {
352 v4l2_err(&dev->v4l2_dev, "device init failed\n");
356 mutex_lock(&dev->io_mutex);
357 if (hdpvr_alloc_buffers(dev, NUM_BUFFERS)) {
358 mutex_unlock(&dev->io_mutex);
359 v4l2_err(&dev->v4l2_dev,
360 "allocating transfer buffers failed\n");
363 mutex_unlock(&dev->io_mutex);
365 #if IS_ENABLED(CONFIG_I2C)
366 retval = hdpvr_register_i2c_adapter(dev);
368 v4l2_err(&dev->v4l2_dev, "i2c adapter register failed\n");
369 goto error_free_buffers;
372 client = hdpvr_register_ir_rx_i2c(dev);
374 v4l2_err(&dev->v4l2_dev, "i2c IR RX device register failed\n");
379 client = hdpvr_register_ir_tx_i2c(dev);
381 v4l2_err(&dev->v4l2_dev, "i2c IR TX device register failed\n");
387 dev_num = atomic_inc_return(&dev_nr);
388 if (dev_num >= HDPVR_MAX) {
389 v4l2_err(&dev->v4l2_dev,
390 "max device number reached, device register failed\n");
396 retval = hdpvr_register_videodev(dev, &interface->dev,
399 v4l2_err(&dev->v4l2_dev, "registering videodev failed\n");
403 /* let the user know what node this device is now attached to */
404 v4l2_info(&dev->v4l2_dev, "device now attached to %s\n",
405 video_device_node_name(&dev->video_dev));
409 #if IS_ENABLED(CONFIG_I2C)
410 i2c_del_adapter(&dev->i2c_adapter);
413 hdpvr_free_buffers(dev);
415 usb_put_dev(dev->udev);
416 kfree(dev->usbc_buf);
417 error_v4l2_unregister:
418 v4l2_device_unregister(&dev->v4l2_dev);
425 static void hdpvr_disconnect(struct usb_interface *interface)
427 struct hdpvr_device *dev = to_hdpvr_dev(usb_get_intfdata(interface));
429 v4l2_info(&dev->v4l2_dev, "device %s disconnected\n",
430 video_device_node_name(&dev->video_dev));
431 /* prevent more I/O from starting and stop any ongoing */
432 mutex_lock(&dev->io_mutex);
433 dev->status = STATUS_DISCONNECTED;
434 wake_up_interruptible(&dev->wait_data);
435 wake_up_interruptible(&dev->wait_buffer);
436 mutex_unlock(&dev->io_mutex);
437 v4l2_device_disconnect(&dev->v4l2_dev);
439 flush_work(&dev->worker);
440 mutex_lock(&dev->io_mutex);
441 hdpvr_cancel_queue(dev);
442 mutex_unlock(&dev->io_mutex);
443 #if IS_ENABLED(CONFIG_I2C)
444 i2c_del_adapter(&dev->i2c_adapter);
446 video_unregister_device(&dev->video_dev);
451 static struct usb_driver hdpvr_usb_driver = {
453 .probe = hdpvr_probe,
454 .disconnect = hdpvr_disconnect,
455 .id_table = hdpvr_table,
458 module_usb_driver(hdpvr_usb_driver);
460 MODULE_LICENSE("GPL");
461 MODULE_VERSION("0.2.1");
462 MODULE_AUTHOR("Janne Grunau");
463 MODULE_DESCRIPTION("Hauppauge HD PVR driver");