Commit | Line | Data |
---|---|---|
9aba42ef | 1 | /* |
e86da6f0 | 2 | * Hauppauge HD PVR USB driver |
9aba42ef JG |
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 | ||
b38aa09d | 42 | static uint default_video_input = HDPVR_VIDEO_INPUTS; |
9aba42ef JG |
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 | ||
b38aa09d | 47 | static uint default_audio_input = HDPVR_AUDIO_INPUTS; |
9aba42ef JG |
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) }, | |
c22425ff | 62 | { USB_DEVICE(HD_PVR_VENDOR_ID, HD_PVR_PRODUCT_ID3) }, |
9aba42ef JG |
63 | { } /* Terminating entry */ |
64 | }; | |
65 | MODULE_DEVICE_TABLE(usb, hdpvr_table); | |
66 | ||
67 | ||
68 | void hdpvr_delete(struct hdpvr_device *dev) | |
69 | { | |
70 | hdpvr_free_buffers(dev); | |
71 | ||
72 | if (dev->video_dev) | |
73 | video_device_release(dev->video_dev); | |
74 | ||
75 | usb_put_dev(dev->udev); | |
76 | } | |
77 | ||
78 | static void challenge(u8 *bytes) | |
79 | { | |
80 | u64 *i64P, tmp64; | |
81 | uint i, idx; | |
82 | ||
83 | for (idx = 0; idx < 32; ++idx) { | |
84 | ||
85 | if (idx & 0x3) | |
86 | bytes[(idx >> 3) + 3] = bytes[(idx >> 2) & 0x3]; | |
87 | ||
88 | switch (idx & 0x3) { | |
89 | case 0x3: | |
90 | bytes[2] += bytes[3] * 4 + bytes[4] + bytes[5]; | |
91 | bytes[4] += bytes[(idx & 0x1) * 2] * 9 + 9; | |
92 | break; | |
93 | case 0x1: | |
94 | bytes[0] *= 8; | |
95 | bytes[0] += 7*idx + 4; | |
96 | bytes[6] += bytes[3] * 3; | |
97 | break; | |
98 | case 0x0: | |
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; | |
103 | break; | |
104 | case 0x2: | |
105 | for (i = 0; i < 3; i++) | |
106 | bytes[1] *= bytes[6] + 1; | |
107 | for (i = 0; i < 3; i++) { | |
108 | i64P = (u64 *)bytes; | |
109 | tmp64 = le64_to_cpup(i64P); | |
110 | tmp64 <<= bytes[7] & 0x0f; | |
111 | *i64P += cpu_to_le64(tmp64); | |
112 | } | |
113 | break; | |
114 | } | |
115 | } | |
116 | } | |
117 | ||
118 | /* try to init the device like the windows driver */ | |
119 | static int device_authorization(struct hdpvr_device *dev) | |
120 | { | |
121 | ||
122 | int ret, retval = -ENOMEM; | |
123 | char request_type = 0x38, rcv_request = 0x81; | |
124 | char *response; | |
125 | #ifdef HDPVR_DEBUG | |
126 | size_t buf_size = 46; | |
127 | char *print_buf = kzalloc(5*buf_size+1, GFP_KERNEL); | |
128 | if (!print_buf) { | |
9ef77adf | 129 | v4l2_err(&dev->v4l2_dev, "Out of memory\n"); |
00c1e216 | 130 | return retval; |
9aba42ef JG |
131 | } |
132 | #endif | |
133 | ||
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, | |
138 | 0x0400, 0x0003, | |
139 | dev->usbc_buf, 46, | |
140 | 10000); | |
141 | if (ret != 46) { | |
9ef77adf JG |
142 | v4l2_err(&dev->v4l2_dev, |
143 | "unexpected answer of status request, len %d\n", ret); | |
00c1e216 | 144 | goto unlock; |
9aba42ef JG |
145 | } |
146 | #ifdef HDPVR_DEBUG | |
147 | else { | |
148 | hex_dump_to_buffer(dev->usbc_buf, 46, 16, 1, print_buf, | |
9518f179 | 149 | 5*buf_size+1, 0); |
9ef77adf JG |
150 | v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, |
151 | "Status request returned, len %d: %s\n", | |
152 | ret, print_buf); | |
9aba42ef JG |
153 | } |
154 | #endif | |
74a558b1 AY |
155 | |
156 | v4l2_info(&dev->v4l2_dev, "firmware version 0x%x dated %s\n", | |
157 | dev->usbc_buf[1], &dev->usbc_buf[2]); | |
158 | ||
35b53664 JG |
159 | switch (dev->usbc_buf[1]) { |
160 | case HDPVR_FIRMWARE_VERSION: | |
9aba42ef | 161 | dev->flags &= ~HDPVR_FLAG_AC3_CAP; |
35b53664 JG |
162 | break; |
163 | case HDPVR_FIRMWARE_VERSION_AC3: | |
164 | case HDPVR_FIRMWARE_VERSION_0X12: | |
165 | case HDPVR_FIRMWARE_VERSION_0X15: | |
9aba42ef | 166 | dev->flags |= HDPVR_FLAG_AC3_CAP; |
35b53664 JG |
167 | break; |
168 | default: | |
169 | v4l2_info(&dev->v4l2_dev, "untested firmware, the driver might" | |
170 | " not work.\n"); | |
171 | if (dev->usbc_buf[1] >= HDPVR_FIRMWARE_VERSION_AC3) | |
172 | dev->flags |= HDPVR_FLAG_AC3_CAP; | |
173 | else | |
174 | dev->flags &= ~HDPVR_FLAG_AC3_CAP; | |
9aba42ef JG |
175 | } |
176 | ||
177 | response = dev->usbc_buf+38; | |
178 | #ifdef HDPVR_DEBUG | |
9518f179 | 179 | hex_dump_to_buffer(response, 8, 16, 1, print_buf, 5*buf_size+1, 0); |
9ef77adf JG |
180 | v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, "challenge: %s\n", |
181 | print_buf); | |
9aba42ef JG |
182 | #endif |
183 | challenge(response); | |
184 | #ifdef HDPVR_DEBUG | |
9518f179 | 185 | hex_dump_to_buffer(response, 8, 16, 1, print_buf, 5*buf_size+1, 0); |
9ef77adf JG |
186 | v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, " response: %s\n", |
187 | print_buf); | |
9aba42ef JG |
188 | #endif |
189 | ||
190 | msleep(100); | |
191 | ret = usb_control_msg(dev->udev, | |
192 | usb_sndctrlpipe(dev->udev, 0), | |
193 | 0xd1, 0x00 | request_type, | |
194 | 0x0000, 0x0000, | |
195 | response, 8, | |
196 | 10000); | |
9ef77adf JG |
197 | v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, |
198 | "magic request returned %d\n", ret); | |
9aba42ef JG |
199 | |
200 | retval = ret != 8; | |
00c1e216 JS |
201 | unlock: |
202 | mutex_unlock(&dev->usbc_mutex); | |
9aba42ef JG |
203 | return retval; |
204 | } | |
205 | ||
206 | static int hdpvr_device_init(struct hdpvr_device *dev) | |
207 | { | |
208 | int ret; | |
209 | u8 *buf; | |
210 | struct hdpvr_video_info *vidinf; | |
211 | ||
212 | if (device_authorization(dev)) | |
213 | return -EACCES; | |
214 | ||
215 | /* default options for init */ | |
216 | hdpvr_set_options(dev); | |
217 | ||
218 | /* set filter options */ | |
219 | mutex_lock(&dev->usbc_mutex); | |
220 | buf = dev->usbc_buf; | |
221 | buf[0] = 0x03; buf[1] = 0x03; buf[2] = 0x00; buf[3] = 0x00; | |
222 | ret = usb_control_msg(dev->udev, | |
223 | usb_sndctrlpipe(dev->udev, 0), | |
224 | 0x01, 0x38, | |
225 | CTRL_LOW_PASS_FILTER_VALUE, CTRL_DEFAULT_INDEX, | |
226 | buf, 4, | |
227 | 1000); | |
9ef77adf JG |
228 | v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, |
229 | "control request returned %d\n", ret); | |
9aba42ef JG |
230 | mutex_unlock(&dev->usbc_mutex); |
231 | ||
232 | vidinf = get_video_info(dev); | |
233 | if (!vidinf) | |
9ef77adf | 234 | v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, |
9aba42ef JG |
235 | "no valid video signal or device init failed\n"); |
236 | else | |
237 | kfree(vidinf); | |
238 | ||
239 | /* enable fan and bling leds */ | |
240 | mutex_lock(&dev->usbc_mutex); | |
241 | buf[0] = 0x1; | |
242 | ret = usb_control_msg(dev->udev, | |
243 | usb_sndctrlpipe(dev->udev, 0), | |
244 | 0xd4, 0x38, 0, 0, buf, 1, | |
245 | 1000); | |
9ef77adf JG |
246 | v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, |
247 | "control request returned %d\n", ret); | |
9aba42ef JG |
248 | |
249 | /* boost analog audio */ | |
250 | buf[0] = boost_audio; | |
251 | ret = usb_control_msg(dev->udev, | |
252 | usb_sndctrlpipe(dev->udev, 0), | |
253 | 0xd5, 0x38, 0, 0, buf, 1, | |
254 | 1000); | |
9ef77adf JG |
255 | v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, |
256 | "control request returned %d\n", ret); | |
9aba42ef JG |
257 | mutex_unlock(&dev->usbc_mutex); |
258 | ||
259 | dev->status = STATUS_IDLE; | |
260 | return 0; | |
261 | } | |
262 | ||
263 | static const struct hdpvr_options hdpvr_default_options = { | |
264 | .video_std = HDPVR_60HZ, | |
265 | .video_input = HDPVR_COMPONENT, | |
266 | .audio_input = HDPVR_RCA_BACK, | |
267 | .bitrate = 65, /* 6 mbps */ | |
268 | .peak_bitrate = 90, /* 9 mbps */ | |
269 | .bitrate_mode = HDPVR_CONSTANT, | |
270 | .gop_mode = HDPVR_SIMPLE_IDR_GOP, | |
271 | .audio_codec = V4L2_MPEG_AUDIO_ENCODING_AAC, | |
272 | .brightness = 0x86, | |
273 | .contrast = 0x80, | |
274 | .hue = 0x80, | |
275 | .saturation = 0x80, | |
276 | .sharpness = 0x80, | |
277 | }; | |
278 | ||
279 | static int hdpvr_probe(struct usb_interface *interface, | |
280 | const struct usb_device_id *id) | |
281 | { | |
282 | struct hdpvr_device *dev; | |
283 | struct usb_host_interface *iface_desc; | |
284 | struct usb_endpoint_descriptor *endpoint; | |
285 | size_t buffer_size; | |
286 | int i; | |
287 | int retval = -ENOMEM; | |
288 | ||
289 | /* allocate memory for our device state and initialize it */ | |
290 | dev = kzalloc(sizeof(*dev), GFP_KERNEL); | |
291 | if (!dev) { | |
292 | err("Out of memory"); | |
293 | goto error; | |
294 | } | |
06630aec | 295 | |
07204aea PA |
296 | dev->workqueue = 0; |
297 | ||
06630aec JG |
298 | /* register v4l2_device early so it can be used for printks */ |
299 | if (v4l2_device_register(&interface->dev, &dev->v4l2_dev)) { | |
300 | err("v4l2_device_register failed"); | |
301 | goto error; | |
302 | } | |
303 | ||
9aba42ef JG |
304 | mutex_init(&dev->io_mutex); |
305 | mutex_init(&dev->i2c_mutex); | |
306 | mutex_init(&dev->usbc_mutex); | |
307 | dev->usbc_buf = kmalloc(64, GFP_KERNEL); | |
308 | if (!dev->usbc_buf) { | |
9ef77adf | 309 | v4l2_err(&dev->v4l2_dev, "Out of memory\n"); |
9aba42ef JG |
310 | goto error; |
311 | } | |
312 | ||
313 | init_waitqueue_head(&dev->wait_buffer); | |
314 | init_waitqueue_head(&dev->wait_data); | |
315 | ||
316 | dev->workqueue = create_singlethread_workqueue("hdpvr_buffer"); | |
317 | if (!dev->workqueue) | |
318 | goto error; | |
319 | ||
320 | /* init video transfer queues */ | |
321 | INIT_LIST_HEAD(&dev->free_buff_list); | |
322 | INIT_LIST_HEAD(&dev->rec_buff_list); | |
323 | ||
324 | dev->options = hdpvr_default_options; | |
325 | ||
326 | if (default_video_input < HDPVR_VIDEO_INPUTS) | |
327 | dev->options.video_input = default_video_input; | |
328 | ||
d4533332 | 329 | if (default_audio_input < HDPVR_AUDIO_INPUTS) { |
9aba42ef | 330 | dev->options.audio_input = default_audio_input; |
d4533332 JG |
331 | if (default_audio_input == HDPVR_SPDIF) |
332 | dev->options.audio_codec = | |
333 | V4L2_MPEG_AUDIO_ENCODING_AC3; | |
334 | } | |
9aba42ef JG |
335 | |
336 | dev->udev = usb_get_dev(interface_to_usbdev(interface)); | |
337 | ||
338 | /* set up the endpoint information */ | |
339 | /* use only the first bulk-in and bulk-out endpoints */ | |
340 | iface_desc = interface->cur_altsetting; | |
341 | for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) { | |
342 | endpoint = &iface_desc->endpoint[i].desc; | |
343 | ||
344 | if (!dev->bulk_in_endpointAddr && | |
345 | usb_endpoint_is_bulk_in(endpoint)) { | |
346 | /* USB interface description is buggy, reported max | |
347 | * packet size is 512 bytes, windows driver uses 8192 */ | |
348 | buffer_size = 8192; | |
349 | dev->bulk_in_size = buffer_size; | |
350 | dev->bulk_in_endpointAddr = endpoint->bEndpointAddress; | |
351 | } | |
352 | ||
353 | } | |
354 | if (!dev->bulk_in_endpointAddr) { | |
9ef77adf | 355 | v4l2_err(&dev->v4l2_dev, "Could not find bulk-in endpoint\n"); |
9aba42ef JG |
356 | goto error; |
357 | } | |
358 | ||
359 | /* init the device */ | |
360 | if (hdpvr_device_init(dev)) { | |
9ef77adf | 361 | v4l2_err(&dev->v4l2_dev, "device init failed\n"); |
9aba42ef JG |
362 | goto error; |
363 | } | |
364 | ||
365 | mutex_lock(&dev->io_mutex); | |
366 | if (hdpvr_alloc_buffers(dev, NUM_BUFFERS)) { | |
00c1e216 | 367 | mutex_unlock(&dev->io_mutex); |
9ef77adf JG |
368 | v4l2_err(&dev->v4l2_dev, |
369 | "allocating transfer buffers failed\n"); | |
9aba42ef JG |
370 | goto error; |
371 | } | |
372 | mutex_unlock(&dev->io_mutex); | |
373 | ||
a50ab291 | 374 | if (hdpvr_register_videodev(dev, &interface->dev, |
9aba42ef | 375 | video_nr[atomic_inc_return(&dev_nr)])) { |
9ef77adf | 376 | v4l2_err(&dev->v4l2_dev, "registering videodev failed\n"); |
9aba42ef JG |
377 | goto error; |
378 | } | |
379 | ||
c457377a JG |
380 | #ifdef CONFIG_I2C |
381 | /* until i2c is working properly */ | |
382 | retval = 0; /* hdpvr_register_i2c_adapter(dev); */ | |
383 | if (retval < 0) { | |
9ef77adf | 384 | v4l2_err(&dev->v4l2_dev, "registering i2c adapter failed\n"); |
c457377a JG |
385 | goto error; |
386 | } | |
387 | #endif /* CONFIG_I2C */ | |
9aba42ef | 388 | |
9aba42ef | 389 | /* let the user know what node this device is now attached to */ |
38c7c036 LP |
390 | v4l2_info(&dev->v4l2_dev, "device now attached to %s\n", |
391 | video_device_node_name(dev->video_dev)); | |
9aba42ef JG |
392 | return 0; |
393 | ||
394 | error: | |
395 | if (dev) { | |
07204aea PA |
396 | /* Destroy single thread */ |
397 | if (dev->workqueue) | |
398 | destroy_workqueue(dev->workqueue); | |
9aba42ef JG |
399 | /* this frees allocated memory */ |
400 | hdpvr_delete(dev); | |
401 | } | |
402 | return retval; | |
403 | } | |
404 | ||
405 | static void hdpvr_disconnect(struct usb_interface *interface) | |
406 | { | |
f2b305cd | 407 | struct hdpvr_device *dev = to_hdpvr_dev(usb_get_intfdata(interface)); |
9aba42ef | 408 | |
f2b305cd HV |
409 | v4l2_info(&dev->v4l2_dev, "device %s disconnected\n", |
410 | video_device_node_name(dev->video_dev)); | |
9aba42ef JG |
411 | /* prevent more I/O from starting and stop any ongoing */ |
412 | mutex_lock(&dev->io_mutex); | |
413 | dev->status = STATUS_DISCONNECTED; | |
9aba42ef JG |
414 | wake_up_interruptible(&dev->wait_data); |
415 | wake_up_interruptible(&dev->wait_buffer); | |
48f98f75 | 416 | mutex_unlock(&dev->io_mutex); |
f2b305cd | 417 | v4l2_device_disconnect(&dev->v4l2_dev); |
9aba42ef JG |
418 | msleep(100); |
419 | flush_workqueue(dev->workqueue); | |
48f98f75 | 420 | mutex_lock(&dev->io_mutex); |
9aba42ef | 421 | hdpvr_cancel_queue(dev); |
9aba42ef | 422 | mutex_unlock(&dev->io_mutex); |
f2b305cd | 423 | video_unregister_device(dev->video_dev); |
9aba42ef | 424 | atomic_dec(&dev_nr); |
9aba42ef JG |
425 | } |
426 | ||
427 | ||
428 | static struct usb_driver hdpvr_usb_driver = { | |
429 | .name = "hdpvr", | |
430 | .probe = hdpvr_probe, | |
431 | .disconnect = hdpvr_disconnect, | |
432 | .id_table = hdpvr_table, | |
433 | }; | |
434 | ||
435 | static int __init hdpvr_init(void) | |
436 | { | |
437 | int result; | |
438 | ||
439 | /* register this driver with the USB subsystem */ | |
440 | result = usb_register(&hdpvr_usb_driver); | |
441 | if (result) | |
442 | err("usb_register failed. Error number %d", result); | |
443 | ||
444 | return result; | |
445 | } | |
446 | ||
447 | static void __exit hdpvr_exit(void) | |
448 | { | |
449 | /* deregister this driver with the USB subsystem */ | |
450 | usb_deregister(&hdpvr_usb_driver); | |
451 | } | |
452 | ||
453 | module_init(hdpvr_init); | |
454 | module_exit(hdpvr_exit); | |
455 | ||
456 | MODULE_LICENSE("GPL"); | |
457 | MODULE_AUTHOR("Janne Grunau"); | |
458 | MODULE_DESCRIPTION("Hauppauge HD PVR driver"); |