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