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
);
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 dev
->fw_ver
= dev
->usbc_buf
[1];
159 v4l2_info(&dev
->v4l2_dev
, "firmware version 0x%x dated %s\n",
160 dev
->fw_ver
, &dev
->usbc_buf
[2]);
162 if (dev
->fw_ver
> 0x15) {
163 dev
->options
.brightness
= 0x80;
164 dev
->options
.contrast
= 0x40;
165 dev
->options
.hue
= 0xf;
166 dev
->options
.saturation
= 0x40;
167 dev
->options
.sharpness
= 0x80;
170 switch (dev
->fw_ver
) {
171 case HDPVR_FIRMWARE_VERSION
:
172 dev
->flags
&= ~HDPVR_FLAG_AC3_CAP
;
174 case HDPVR_FIRMWARE_VERSION_AC3
:
175 case HDPVR_FIRMWARE_VERSION_0X12
:
176 case HDPVR_FIRMWARE_VERSION_0X15
:
177 case HDPVR_FIRMWARE_VERSION_0X1E
:
178 dev
->flags
|= HDPVR_FLAG_AC3_CAP
;
181 v4l2_info(&dev
->v4l2_dev
, "untested firmware, the driver might"
183 if (dev
->fw_ver
>= HDPVR_FIRMWARE_VERSION_AC3
)
184 dev
->flags
|= HDPVR_FLAG_AC3_CAP
;
186 dev
->flags
&= ~HDPVR_FLAG_AC3_CAP
;
189 response
= dev
->usbc_buf
+38;
191 hex_dump_to_buffer(response
, 8, 16, 1, print_buf
, 5*buf_size
+1, 0);
192 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
, "challenge: %s\n",
197 hex_dump_to_buffer(response
, 8, 16, 1, print_buf
, 5*buf_size
+1, 0);
198 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
, " response: %s\n",
204 ret
= usb_control_msg(dev
->udev
,
205 usb_sndctrlpipe(dev
->udev
, 0),
206 0xd1, 0x00 | request_type
,
210 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
211 "magic request returned %d\n", ret
);
215 mutex_unlock(&dev
->usbc_mutex
);
219 static int hdpvr_device_init(struct hdpvr_device
*dev
)
224 if (device_authorization(dev
))
227 /* default options for init */
228 hdpvr_set_options(dev
);
230 /* set filter options */
231 mutex_lock(&dev
->usbc_mutex
);
233 buf
[0] = 0x03; buf
[1] = 0x03; buf
[2] = 0x00; buf
[3] = 0x00;
234 ret
= usb_control_msg(dev
->udev
,
235 usb_sndctrlpipe(dev
->udev
, 0),
237 CTRL_LOW_PASS_FILTER_VALUE
, CTRL_DEFAULT_INDEX
,
240 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
241 "control request returned %d\n", ret
);
242 mutex_unlock(&dev
->usbc_mutex
);
244 /* enable fan and bling leds */
245 mutex_lock(&dev
->usbc_mutex
);
247 ret
= usb_control_msg(dev
->udev
,
248 usb_sndctrlpipe(dev
->udev
, 0),
249 0xd4, 0x38, 0, 0, buf
, 1,
251 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
252 "control request returned %d\n", ret
);
254 /* boost analog audio */
255 buf
[0] = boost_audio
;
256 ret
= usb_control_msg(dev
->udev
,
257 usb_sndctrlpipe(dev
->udev
, 0),
258 0xd5, 0x38, 0, 0, buf
, 1,
260 v4l2_dbg(MSG_INFO
, hdpvr_debug
, &dev
->v4l2_dev
,
261 "control request returned %d\n", ret
);
262 mutex_unlock(&dev
->usbc_mutex
);
264 dev
->status
= STATUS_IDLE
;
268 static const struct hdpvr_options hdpvr_default_options
= {
269 .video_std
= HDPVR_60HZ
,
270 .video_input
= HDPVR_COMPONENT
,
271 .audio_input
= HDPVR_RCA_BACK
,
272 .bitrate
= 65, /* 6 mbps */
273 .peak_bitrate
= 90, /* 9 mbps */
274 .bitrate_mode
= HDPVR_CONSTANT
,
275 .gop_mode
= HDPVR_SIMPLE_IDR_GOP
,
276 .audio_codec
= V4L2_MPEG_AUDIO_ENCODING_AAC
,
277 /* original picture controls for firmware version <= 0x15 */
278 /* updated in device_authorization() for newer firmware */
286 static int hdpvr_probe(struct usb_interface
*interface
,
287 const struct usb_device_id
*id
)
289 struct hdpvr_device
*dev
;
290 struct usb_host_interface
*iface_desc
;
291 struct usb_endpoint_descriptor
*endpoint
;
292 struct i2c_client
*client
;
295 int retval
= -ENOMEM
;
297 /* allocate memory for our device state and initialize it */
298 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
300 dev_err(&interface
->dev
, "Out of memory\n");
306 /* register v4l2_device early so it can be used for printks */
307 if (v4l2_device_register(&interface
->dev
, &dev
->v4l2_dev
)) {
308 dev_err(&interface
->dev
, "v4l2_device_register failed\n");
312 mutex_init(&dev
->io_mutex
);
313 mutex_init(&dev
->i2c_mutex
);
314 mutex_init(&dev
->usbc_mutex
);
315 dev
->usbc_buf
= kmalloc(64, GFP_KERNEL
);
316 if (!dev
->usbc_buf
) {
317 v4l2_err(&dev
->v4l2_dev
, "Out of memory\n");
321 init_waitqueue_head(&dev
->wait_buffer
);
322 init_waitqueue_head(&dev
->wait_data
);
324 dev
->workqueue
= create_singlethread_workqueue("hdpvr_buffer");
328 /* init video transfer queues */
329 INIT_LIST_HEAD(&dev
->free_buff_list
);
330 INIT_LIST_HEAD(&dev
->rec_buff_list
);
332 dev
->options
= hdpvr_default_options
;
334 if (default_video_input
< HDPVR_VIDEO_INPUTS
)
335 dev
->options
.video_input
= default_video_input
;
337 if (default_audio_input
< HDPVR_AUDIO_INPUTS
) {
338 dev
->options
.audio_input
= default_audio_input
;
339 if (default_audio_input
== HDPVR_SPDIF
)
340 dev
->options
.audio_codec
=
341 V4L2_MPEG_AUDIO_ENCODING_AC3
;
344 dev
->udev
= usb_get_dev(interface_to_usbdev(interface
));
346 /* set up the endpoint information */
347 /* use only the first bulk-in and bulk-out endpoints */
348 iface_desc
= interface
->cur_altsetting
;
349 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
350 endpoint
= &iface_desc
->endpoint
[i
].desc
;
352 if (!dev
->bulk_in_endpointAddr
&&
353 usb_endpoint_is_bulk_in(endpoint
)) {
354 /* USB interface description is buggy, reported max
355 * packet size is 512 bytes, windows driver uses 8192 */
357 dev
->bulk_in_size
= buffer_size
;
358 dev
->bulk_in_endpointAddr
= endpoint
->bEndpointAddress
;
362 if (!dev
->bulk_in_endpointAddr
) {
363 v4l2_err(&dev
->v4l2_dev
, "Could not find bulk-in endpoint\n");
367 /* init the device */
368 if (hdpvr_device_init(dev
)) {
369 v4l2_err(&dev
->v4l2_dev
, "device init failed\n");
373 mutex_lock(&dev
->io_mutex
);
374 if (hdpvr_alloc_buffers(dev
, NUM_BUFFERS
)) {
375 mutex_unlock(&dev
->io_mutex
);
376 v4l2_err(&dev
->v4l2_dev
,
377 "allocating transfer buffers failed\n");
380 mutex_unlock(&dev
->io_mutex
);
382 #if IS_ENABLED(CONFIG_I2C)
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");
396 client
= hdpvr_register_ir_tx_i2c(dev
);
398 v4l2_err(&dev
->v4l2_dev
, "i2c IR TX device register failed\n");
404 retval
= hdpvr_register_videodev(dev
, &interface
->dev
,
405 video_nr
[atomic_inc_return(&dev_nr
)]);
407 v4l2_err(&dev
->v4l2_dev
, "registering videodev failed\n");
411 /* let the user know what node this device is now attached to */
412 v4l2_info(&dev
->v4l2_dev
, "device now attached to %s\n",
413 video_device_node_name(dev
->video_dev
));
417 #if IS_ENABLED(CONFIG_I2C)
418 i2c_del_adapter(&dev
->i2c_adapter
);
422 /* Destroy single thread */
424 destroy_workqueue(dev
->workqueue
);
425 /* this frees allocated memory */
431 static void hdpvr_disconnect(struct usb_interface
*interface
)
433 struct hdpvr_device
*dev
= to_hdpvr_dev(usb_get_intfdata(interface
));
435 v4l2_info(&dev
->v4l2_dev
, "device %s disconnected\n",
436 video_device_node_name(dev
->video_dev
));
437 /* prevent more I/O from starting and stop any ongoing */
438 mutex_lock(&dev
->io_mutex
);
439 dev
->status
= STATUS_DISCONNECTED
;
440 wake_up_interruptible(&dev
->wait_data
);
441 wake_up_interruptible(&dev
->wait_buffer
);
442 mutex_unlock(&dev
->io_mutex
);
443 v4l2_device_disconnect(&dev
->v4l2_dev
);
445 flush_workqueue(dev
->workqueue
);
446 mutex_lock(&dev
->io_mutex
);
447 hdpvr_cancel_queue(dev
);
448 mutex_unlock(&dev
->io_mutex
);
449 #if IS_ENABLED(CONFIG_I2C)
450 i2c_del_adapter(&dev
->i2c_adapter
);
452 video_unregister_device(dev
->video_dev
);
457 static struct usb_driver hdpvr_usb_driver
= {
459 .probe
= hdpvr_probe
,
460 .disconnect
= hdpvr_disconnect
,
461 .id_table
= hdpvr_table
,
464 module_usb_driver(hdpvr_usb_driver
);
466 MODULE_LICENSE("GPL");
467 MODULE_VERSION("0.2.1");
468 MODULE_AUTHOR("Janne Grunau");
469 MODULE_DESCRIPTION("Hauppauge HD PVR driver");