1/*
2 * Hauppauge HD PVR USB driver
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 <linux/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
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
42static uint default_video_input = HDPVR_VIDEO_INPUTS;
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
47static uint default_audio_input = HDPVR_AUDIO_INPUTS;
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
52static bool boost_audio;
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) },
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 */
65};
66MODULE_DEVICE_TABLE(usb, hdpvr_table);
67
68
69void hdpvr_delete(struct hdpvr_device *dev)
70{
71	hdpvr_free_buffers(dev);
72	usb_put_dev(dev->udev);
73}
74
75static void challenge(u8 *bytes)
76{
77	__le64 *i64P;
78	u64 tmp64;
79	uint i, idx;
80
81	for (idx = 0; idx < 32; ++idx) {
82
83		if (idx & 0x3)
84			bytes[(idx >> 3) + 3] = bytes[(idx >> 2) & 0x3];
85
86		switch (idx & 0x3) {
87		case 0x3:
88			bytes[2] += bytes[3] * 4 + bytes[4] + bytes[5];
89			bytes[4] += bytes[(idx & 0x1) * 2] * 9 + 9;
90			break;
91		case 0x1:
92			bytes[0] *= 8;
93			bytes[0] += 7*idx + 4;
94			bytes[6] += bytes[3] * 3;
95			break;
96		case 0x0:
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;
101			break;
102		case 0x2:
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);
110			}
111			break;
112		}
113	}
114}
115
116/* try to init the device like the windows driver */
117static int device_authorization(struct hdpvr_device *dev)
118{
119
120	int ret, retval = -ENOMEM;
121	char request_type = 0x38, rcv_request = 0x81;
122	char *response;
123
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,
128			      0x0400, 0x0003,
129			      dev->usbc_buf, 46,
130			      10000);
131	if (ret != 46) {
132		v4l2_err(&dev->v4l2_dev,
133			 "unexpected answer of status request, len %d\n", ret);
134		goto unlock;
135	}
136#ifdef HDPVR_DEBUG
137	else {
138		v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
139			 "Status request returned, len %d: %46ph\n",
140			 ret, dev->usbc_buf);
141	}
142#endif
143
144	dev->fw_ver = dev->usbc_buf[1];
145
146	v4l2_info(&dev->v4l2_dev, "firmware version 0x%x dated %s\n",
147			  dev->fw_ver, &dev->usbc_buf[2]);
148
149	if (dev->fw_ver > 0x15) {
150		dev->options.brightness	= 0x80;
151		dev->options.contrast	= 0x40;
152		dev->options.hue	= 0xf;
153		dev->options.saturation	= 0x40;
154		dev->options.sharpness	= 0x80;
155	}
156
157	switch (dev->fw_ver) {
158	case HDPVR_FIRMWARE_VERSION:
159		dev->flags &= ~HDPVR_FLAG_AC3_CAP;
160		break;
161	case HDPVR_FIRMWARE_VERSION_AC3:
162	case HDPVR_FIRMWARE_VERSION_0X12:
163	case HDPVR_FIRMWARE_VERSION_0X15:
164	case HDPVR_FIRMWARE_VERSION_0X1E:
165		dev->flags |= HDPVR_FLAG_AC3_CAP;
166		break;
167	default:
168		v4l2_info(&dev->v4l2_dev, "untested firmware, the driver might"
169			  " not work.\n");
170		if (dev->fw_ver >= HDPVR_FIRMWARE_VERSION_AC3)
171			dev->flags |= HDPVR_FLAG_AC3_CAP;
172		else
173			dev->flags &= ~HDPVR_FLAG_AC3_CAP;
174	}
175
176	response = dev->usbc_buf+38;
177#ifdef HDPVR_DEBUG
178	v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, "challenge: %8ph\n",
179		 response);
180#endif
181	challenge(response);
182#ifdef HDPVR_DEBUG
183	v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, " response: %8ph\n",
184		 response);
185#endif
186
187	msleep(100);
188	ret = usb_control_msg(dev->udev,
189			      usb_sndctrlpipe(dev->udev, 0),
190			      0xd1, 0x00 | request_type,
191			      0x0000, 0x0000,
192			      response, 8,
193			      10000);
194	v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
195		 "magic request returned %d\n", ret);
196
197	retval = ret != 8;
198unlock:
199	mutex_unlock(&dev->usbc_mutex);
200	return retval;
201}
202
203static int hdpvr_device_init(struct hdpvr_device *dev)
204{
205	int ret;
206	u8 *buf;
207
208	if (device_authorization(dev))
209		return -EACCES;
210
211	/* default options for init */
212	hdpvr_set_options(dev);
213
214	/* set filter options */
215	mutex_lock(&dev->usbc_mutex);
216	buf = dev->usbc_buf;
217	buf[0] = 0x03; buf[1] = 0x03; buf[2] = 0x00; buf[3] = 0x00;
218	ret = usb_control_msg(dev->udev,
219			      usb_sndctrlpipe(dev->udev, 0),
220			      0x01, 0x38,
221			      CTRL_LOW_PASS_FILTER_VALUE, CTRL_DEFAULT_INDEX,
222			      buf, 4,
223			      1000);
224	v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
225		 "control request returned %d\n", ret);
226	mutex_unlock(&dev->usbc_mutex);
227
228	/* enable fan and bling leds */
229	mutex_lock(&dev->usbc_mutex);
230	buf[0] = 0x1;
231	ret = usb_control_msg(dev->udev,
232			      usb_sndctrlpipe(dev->udev, 0),
233			      0xd4, 0x38, 0, 0, buf, 1,
234			      1000);
235	v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
236		 "control request returned %d\n", ret);
237
238	/* boost analog audio */
239	buf[0] = boost_audio;
240	ret = usb_control_msg(dev->udev,
241			      usb_sndctrlpipe(dev->udev, 0),
242			      0xd5, 0x38, 0, 0, buf, 1,
243			      1000);
244	v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev,
245		 "control request returned %d\n", ret);
246	mutex_unlock(&dev->usbc_mutex);
247
248	dev->status = STATUS_IDLE;
249	return 0;
250}
251
252static const struct hdpvr_options hdpvr_default_options = {
253	.video_std	= HDPVR_60HZ,
254	.video_input	= HDPVR_COMPONENT,
255	.audio_input	= HDPVR_RCA_BACK,
256	.bitrate	= 65, /* 6 mbps */
257	.peak_bitrate	= 90, /* 9 mbps */
258	.bitrate_mode	= HDPVR_CONSTANT,
259	.gop_mode	= HDPVR_SIMPLE_IDR_GOP,
260	.audio_codec	= V4L2_MPEG_AUDIO_ENCODING_AAC,
261	/* original picture controls for firmware version <= 0x15 */
262	/* updated in device_authorization() for newer firmware */
263	.brightness	= 0x86,
264	.contrast	= 0x80,
265	.hue		= 0x80,
266	.saturation	= 0x80,
267	.sharpness	= 0x80,
268};
269
270static int hdpvr_probe(struct usb_interface *interface,
271		       const struct usb_device_id *id)
272{
273	struct hdpvr_device *dev;
274	struct usb_host_interface *iface_desc;
275	struct usb_endpoint_descriptor *endpoint;
276	struct i2c_client *client;
277	size_t buffer_size;
278	int i;
279	int retval = -ENOMEM;
280
281	/* allocate memory for our device state and initialize it */
282	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
283	if (!dev) {
284		dev_err(&interface->dev, "Out of memory\n");
285		goto error;
286	}
287
288	/* init video transfer queues first of all */
289	/* to prevent oops in hdpvr_delete() on error paths */
290	INIT_LIST_HEAD(&dev->free_buff_list);
291	INIT_LIST_HEAD(&dev->rec_buff_list);
292
293	/* register v4l2_device early so it can be used for printks */
294	if (v4l2_device_register(&interface->dev, &dev->v4l2_dev)) {
295		dev_err(&interface->dev, "v4l2_device_register failed\n");
296		goto error;
297	}
298
299	mutex_init(&dev->io_mutex);
300	mutex_init(&dev->i2c_mutex);
301	mutex_init(&dev->usbc_mutex);
302	dev->usbc_buf = kmalloc(64, GFP_KERNEL);
303	if (!dev->usbc_buf) {
304		v4l2_err(&dev->v4l2_dev, "Out of memory\n");
305		goto error;
306	}
307
308	init_waitqueue_head(&dev->wait_buffer);
309	init_waitqueue_head(&dev->wait_data);
310
311	dev->workqueue = create_singlethread_workqueue("hdpvr_buffer");
312	if (!dev->workqueue)
313		goto error;
314
315	dev->options = hdpvr_default_options;
316
317	if (default_video_input < HDPVR_VIDEO_INPUTS)
318		dev->options.video_input = default_video_input;
319
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;
325	}
326
327	dev->udev = usb_get_dev(interface_to_usbdev(interface));
328
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;
334
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 */
339			buffer_size = 8192;
340			dev->bulk_in_size = buffer_size;
341			dev->bulk_in_endpointAddr = endpoint->bEndpointAddress;
342		}
343
344	}
345	if (!dev->bulk_in_endpointAddr) {
346		v4l2_err(&dev->v4l2_dev, "Could not find bulk-in endpoint\n");
347		goto error;
348	}
349
350	/* init the device */
351	if (hdpvr_device_init(dev)) {
352		v4l2_err(&dev->v4l2_dev, "device init failed\n");
353		goto error;
354	}
355
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");
361		goto error;
362	}
363	mutex_unlock(&dev->io_mutex);
364
365#if IS_ENABLED(CONFIG_I2C)
366	retval = hdpvr_register_i2c_adapter(dev);
367	if (retval < 0) {
368		v4l2_err(&dev->v4l2_dev, "i2c adapter register failed\n");
369		goto error;
370	}
371
372	client = hdpvr_register_ir_rx_i2c(dev);
373	if (!client) {
374		v4l2_err(&dev->v4l2_dev, "i2c IR RX device register failed\n");
375		retval = -ENODEV;
376		goto reg_fail;
377	}
378
379	client = hdpvr_register_ir_tx_i2c(dev);
380	if (!client) {
381		v4l2_err(&dev->v4l2_dev, "i2c IR TX device register failed\n");
382		retval = -ENODEV;
383		goto reg_fail;
384	}
385#endif
386
387	retval = hdpvr_register_videodev(dev, &interface->dev,
388				    video_nr[atomic_inc_return(&dev_nr)]);
389	if (retval < 0) {
390		v4l2_err(&dev->v4l2_dev, "registering videodev failed\n");
391		goto reg_fail;
392	}
393
394	/* let the user know what node this device is now attached to */
395	v4l2_info(&dev->v4l2_dev, "device now attached to %s\n",
396		  video_device_node_name(&dev->video_dev));
397	return 0;
398
399reg_fail:
400#if IS_ENABLED(CONFIG_I2C)
401	i2c_del_adapter(&dev->i2c_adapter);
402#endif
403error:
404	if (dev) {
405		/* Destroy single thread */
406		if (dev->workqueue)
407			destroy_workqueue(dev->workqueue);
408		/* this frees allocated memory */
409		hdpvr_delete(dev);
410	}
411	return retval;
412}
413
414static void hdpvr_disconnect(struct usb_interface *interface)
415{
416	struct hdpvr_device *dev = to_hdpvr_dev(usb_get_intfdata(interface));
417
418	v4l2_info(&dev->v4l2_dev, "device %s disconnected\n",
419		  video_device_node_name(&dev->video_dev));
420	/* prevent more I/O from starting and stop any ongoing */
421	mutex_lock(&dev->io_mutex);
422	dev->status = STATUS_DISCONNECTED;
423	wake_up_interruptible(&dev->wait_data);
424	wake_up_interruptible(&dev->wait_buffer);
425	mutex_unlock(&dev->io_mutex);
426	v4l2_device_disconnect(&dev->v4l2_dev);
427	msleep(100);
428	flush_workqueue(dev->workqueue);
429	mutex_lock(&dev->io_mutex);
430	hdpvr_cancel_queue(dev);
431	mutex_unlock(&dev->io_mutex);
432#if IS_ENABLED(CONFIG_I2C)
433	i2c_del_adapter(&dev->i2c_adapter);
434#endif
435	video_unregister_device(&dev->video_dev);
436	atomic_dec(&dev_nr);
437}
438
439
440static struct usb_driver hdpvr_usb_driver = {
441	.name =		"hdpvr",
442	.probe =	hdpvr_probe,
443	.disconnect =	hdpvr_disconnect,
444	.id_table =	hdpvr_table,
445};
446
447module_usb_driver(hdpvr_usb_driver);
448
449MODULE_LICENSE("GPL");
450MODULE_VERSION("0.2.1");
451MODULE_AUTHOR("Janne Grunau");
452MODULE_DESCRIPTION("Hauppauge HD PVR driver");
453