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 { 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
);
74 video_device_release(dev
->video_dev
);
76 usb_put_dev(dev
->udev
);
79 static void challenge(u8
*bytes
)
84 for (idx
= 0; idx
< 32; ++idx
) {
87 bytes
[(idx
>> 3) + 3] = bytes
[(idx
>> 2) & 0x3];
91 bytes
[2] += bytes
[3] * 4 + bytes
[4] + bytes
[5];
92 bytes
[4] += bytes
[(idx
& 0x1) * 2] * 9 + 9;
96 bytes
[0] += 7*idx
+ 4;
97 bytes
[6] += bytes
[3] * 3;
100 bytes
[3 - (idx
>> 3)] = bytes
[idx
>> 2];
101 bytes
[5] += bytes
[6] * 3;
102 for (i
= 0; i
< 3; i
++)
103 bytes
[3] *= bytes
[3] + 1;
106 for (i
= 0; i
< 3; i
++)
107 bytes
[1] *= bytes
[6] + 1;
108 for (i
= 0; i
< 3; i
++) {
110 tmp64
= le64_to_cpup(i64P
);
111 tmp64
<<= bytes
[7] & 0x0f;
112 *i64P
+= cpu_to_le64(tmp64
);
119 /* try to init the device like the windows driver */
120 static int device_authorization(struct hdpvr_device
*dev
)
123 int ret
, retval
= -ENOMEM
;
124 char request_type
= 0x38, rcv_request
= 0x81;
127 size_t buf_size
= 46;
128 char *print_buf
= kzalloc(5*buf_size
+1, GFP_KERNEL
);
130 v4l2_err(&dev
->v4l2_dev
, "Out of memory\n");
135 mutex_lock(&dev
->usbc_mutex
);
136 ret
= usb_control_msg(dev
->udev
,
137 usb_rcvctrlpipe(dev
->udev
, 0),
138 rcv_request
, 0x80 | request_type
,
143 v4l2_err(&dev
->v4l2_dev
,
144 "unexpected answer of status request, len %d\n", ret
);
149 hex_dump_to_buffer(dev
->usbc_buf
, 46, 16, 1, print_buf
,
151 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
152 "Status request returned, len %d: %s\n",
157 v4l2_info(&dev
->v4l2_dev
, "firmware version 0x%x dated %s\n",
158 dev
->usbc_buf
[1], &dev
->usbc_buf
[2]);
160 switch (dev
->usbc_buf
[1]) {
161 case HDPVR_FIRMWARE_VERSION
:
162 dev
->flags
&= ~HDPVR_FLAG_AC3_CAP
;
164 case HDPVR_FIRMWARE_VERSION_AC3
:
165 case HDPVR_FIRMWARE_VERSION_0X12
:
166 case HDPVR_FIRMWARE_VERSION_0X15
:
167 dev
->flags
|= HDPVR_FLAG_AC3_CAP
;
170 v4l2_info(&dev
->v4l2_dev
, "untested firmware, the driver might"
172 if (dev
->usbc_buf
[1] >= HDPVR_FIRMWARE_VERSION_AC3
)
173 dev
->flags
|= HDPVR_FLAG_AC3_CAP
;
175 dev
->flags
&= ~HDPVR_FLAG_AC3_CAP
;
178 response
= dev
->usbc_buf
+38;
180 hex_dump_to_buffer(response
, 8, 16, 1, print_buf
, 5*buf_size
+1, 0);
181 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
, "challenge: %s\n",
186 hex_dump_to_buffer(response
, 8, 16, 1, print_buf
, 5*buf_size
+1, 0);
187 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
, " response: %s\n",
192 ret
= usb_control_msg(dev
->udev
,
193 usb_sndctrlpipe(dev
->udev
, 0),
194 0xd1, 0x00 | request_type
,
198 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
199 "magic request returned %d\n", ret
);
203 mutex_unlock(&dev
->usbc_mutex
);
207 static int hdpvr_device_init(struct hdpvr_device
*dev
)
211 struct hdpvr_video_info
*vidinf
;
213 if (device_authorization(dev
))
216 /* default options for init */
217 hdpvr_set_options(dev
);
219 /* set filter options */
220 mutex_lock(&dev
->usbc_mutex
);
222 buf
[0] = 0x03; buf
[1] = 0x03; buf
[2] = 0x00; buf
[3] = 0x00;
223 ret
= usb_control_msg(dev
->udev
,
224 usb_sndctrlpipe(dev
->udev
, 0),
226 CTRL_LOW_PASS_FILTER_VALUE
, CTRL_DEFAULT_INDEX
,
229 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
230 "control request returned %d\n", ret
);
231 mutex_unlock(&dev
->usbc_mutex
);
233 vidinf
= get_video_info(dev
);
235 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
236 "no valid video signal or device init failed\n");
240 /* enable fan and bling leds */
241 mutex_lock(&dev
->usbc_mutex
);
243 ret
= usb_control_msg(dev
->udev
,
244 usb_sndctrlpipe(dev
->udev
, 0),
245 0xd4, 0x38, 0, 0, buf
, 1,
247 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
248 "control request returned %d\n", ret
);
250 /* boost analog audio */
251 buf
[0] = boost_audio
;
252 ret
= usb_control_msg(dev
->udev
,
253 usb_sndctrlpipe(dev
->udev
, 0),
254 0xd5, 0x38, 0, 0, buf
, 1,
256 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
257 "control request returned %d\n", ret
);
258 mutex_unlock(&dev
->usbc_mutex
);
260 dev
->status
= STATUS_IDLE
;
264 static const struct hdpvr_options hdpvr_default_options
= {
265 .video_std
= HDPVR_60HZ
,
266 .video_input
= HDPVR_COMPONENT
,
267 .audio_input
= HDPVR_RCA_BACK
,
268 .bitrate
= 65, /* 6 mbps */
269 .peak_bitrate
= 90, /* 9 mbps */
270 .bitrate_mode
= HDPVR_CONSTANT
,
271 .gop_mode
= HDPVR_SIMPLE_IDR_GOP
,
272 .audio_codec
= V4L2_MPEG_AUDIO_ENCODING_AAC
,
280 static int hdpvr_probe(struct usb_interface
*interface
,
281 const struct usb_device_id
*id
)
283 struct hdpvr_device
*dev
;
284 struct usb_host_interface
*iface_desc
;
285 struct usb_endpoint_descriptor
*endpoint
;
286 struct i2c_client
*client
;
289 int retval
= -ENOMEM
;
291 /* allocate memory for our device state and initialize it */
292 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
294 err("Out of memory");
300 /* register v4l2_device early so it can be used for printks */
301 if (v4l2_device_register(&interface
->dev
, &dev
->v4l2_dev
)) {
302 err("v4l2_device_register failed");
306 mutex_init(&dev
->io_mutex
);
307 mutex_init(&dev
->i2c_mutex
);
308 mutex_init(&dev
->usbc_mutex
);
309 dev
->usbc_buf
= kmalloc(64, GFP_KERNEL
);
310 if (!dev
->usbc_buf
) {
311 v4l2_err(&dev
->v4l2_dev
, "Out of memory\n");
315 init_waitqueue_head(&dev
->wait_buffer
);
316 init_waitqueue_head(&dev
->wait_data
);
318 dev
->workqueue
= create_singlethread_workqueue("hdpvr_buffer");
322 /* init video transfer queues */
323 INIT_LIST_HEAD(&dev
->free_buff_list
);
324 INIT_LIST_HEAD(&dev
->rec_buff_list
);
326 dev
->options
= hdpvr_default_options
;
328 if (default_video_input
< HDPVR_VIDEO_INPUTS
)
329 dev
->options
.video_input
= default_video_input
;
331 if (default_audio_input
< HDPVR_AUDIO_INPUTS
) {
332 dev
->options
.audio_input
= default_audio_input
;
333 if (default_audio_input
== HDPVR_SPDIF
)
334 dev
->options
.audio_codec
=
335 V4L2_MPEG_AUDIO_ENCODING_AC3
;
338 dev
->udev
= usb_get_dev(interface_to_usbdev(interface
));
340 /* set up the endpoint information */
341 /* use only the first bulk-in and bulk-out endpoints */
342 iface_desc
= interface
->cur_altsetting
;
343 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
344 endpoint
= &iface_desc
->endpoint
[i
].desc
;
346 if (!dev
->bulk_in_endpointAddr
&&
347 usb_endpoint_is_bulk_in(endpoint
)) {
348 /* USB interface description is buggy, reported max
349 * packet size is 512 bytes, windows driver uses 8192 */
351 dev
->bulk_in_size
= buffer_size
;
352 dev
->bulk_in_endpointAddr
= endpoint
->bEndpointAddress
;
356 if (!dev
->bulk_in_endpointAddr
) {
357 v4l2_err(&dev
->v4l2_dev
, "Could not find bulk-in endpoint\n");
361 /* init the device */
362 if (hdpvr_device_init(dev
)) {
363 v4l2_err(&dev
->v4l2_dev
, "device init failed\n");
367 mutex_lock(&dev
->io_mutex
);
368 if (hdpvr_alloc_buffers(dev
, NUM_BUFFERS
)) {
369 mutex_unlock(&dev
->io_mutex
);
370 v4l2_err(&dev
->v4l2_dev
,
371 "allocating transfer buffers failed\n");
374 mutex_unlock(&dev
->io_mutex
);
376 if (hdpvr_register_videodev(dev
, &interface
->dev
,
377 video_nr
[atomic_inc_return(&dev_nr
)])) {
378 v4l2_err(&dev
->v4l2_dev
, "registering videodev failed\n");
382 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
383 retval
= hdpvr_register_i2c_adapter(dev
);
385 v4l2_err(&dev
->v4l2_dev
, "i2c adapter register failed\n");
389 client
= hdpvr_register_ir_rx_i2c(dev
);
391 v4l2_err(&dev
->v4l2_dev
, "i2c IR RX device register failed\n");
395 client
= hdpvr_register_ir_tx_i2c(dev
);
397 v4l2_err(&dev
->v4l2_dev
, "i2c IR TX device register failed\n");
402 /* let the user know what node this device is now attached to */
403 v4l2_info(&dev
->v4l2_dev
, "device now attached to %s\n",
404 video_device_node_name(dev
->video_dev
));
408 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
409 i2c_del_adapter(&dev
->i2c_adapter
);
413 /* Destroy single thread */
415 destroy_workqueue(dev
->workqueue
);
416 /* this frees allocated memory */
422 static void hdpvr_disconnect(struct usb_interface
*interface
)
424 struct hdpvr_device
*dev
= to_hdpvr_dev(usb_get_intfdata(interface
));
426 v4l2_info(&dev
->v4l2_dev
, "device %s disconnected\n",
427 video_device_node_name(dev
->video_dev
));
428 /* prevent more I/O from starting and stop any ongoing */
429 mutex_lock(&dev
->io_mutex
);
430 dev
->status
= STATUS_DISCONNECTED
;
431 wake_up_interruptible(&dev
->wait_data
);
432 wake_up_interruptible(&dev
->wait_buffer
);
433 mutex_unlock(&dev
->io_mutex
);
434 v4l2_device_disconnect(&dev
->v4l2_dev
);
436 flush_workqueue(dev
->workqueue
);
437 mutex_lock(&dev
->io_mutex
);
438 hdpvr_cancel_queue(dev
);
439 mutex_unlock(&dev
->io_mutex
);
440 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
441 i2c_del_adapter(&dev
->i2c_adapter
);
443 video_unregister_device(dev
->video_dev
);
448 static struct usb_driver hdpvr_usb_driver
= {
450 .probe
= hdpvr_probe
,
451 .disconnect
= hdpvr_disconnect
,
452 .id_table
= hdpvr_table
,
455 static int __init
hdpvr_init(void)
459 /* register this driver with the USB subsystem */
460 result
= usb_register(&hdpvr_usb_driver
);
462 err("usb_register failed. Error number %d", result
);
467 static void __exit
hdpvr_exit(void)
469 /* deregister this driver with the USB subsystem */
470 usb_deregister(&hdpvr_usb_driver
);
473 module_init(hdpvr_init
);
474 module_exit(hdpvr_exit
);
476 MODULE_LICENSE("GPL");
477 MODULE_AUTHOR("Janne Grunau");
478 MODULE_DESCRIPTION("Hauppauge HD PVR driver");