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