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