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 128 mutex_lock(&dev->usbc_mutex); 129 ret = usb_control_msg(dev->udev, 130 usb_rcvctrlpipe(dev->udev, 0), 131 rcv_request, 0x80 | request_type, 132 0x0400, 0x0003, 133 dev->usbc_buf, 46, 134 10000); 135 if (ret != 46) { 136 v4l2_err(&dev->v4l2_dev, 137 "unexpected answer of status request, len %d\n", ret); 138 goto unlock; 139 } 140 #ifdef HDPVR_DEBUG 141 else { 142 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, 143 "Status request returned, len %d: %46ph\n", 144 ret, dev->usbc_buf); 145 } 146 #endif 147 148 dev->fw_ver = dev->usbc_buf[1]; 149 150 v4l2_info(&dev->v4l2_dev, "firmware version 0x%x dated %s\n", 151 dev->fw_ver, &dev->usbc_buf[2]); 152 153 if (dev->fw_ver > 0x15) { 154 dev->options.brightness = 0x80; 155 dev->options.contrast = 0x40; 156 dev->options.hue = 0xf; 157 dev->options.saturation = 0x40; 158 dev->options.sharpness = 0x80; 159 } 160 161 switch (dev->fw_ver) { 162 case HDPVR_FIRMWARE_VERSION: 163 dev->flags &= ~HDPVR_FLAG_AC3_CAP; 164 break; 165 case HDPVR_FIRMWARE_VERSION_AC3: 166 case HDPVR_FIRMWARE_VERSION_0X12: 167 case HDPVR_FIRMWARE_VERSION_0X15: 168 case HDPVR_FIRMWARE_VERSION_0X1E: 169 dev->flags |= HDPVR_FLAG_AC3_CAP; 170 break; 171 default: 172 v4l2_info(&dev->v4l2_dev, "untested firmware, the driver might" 173 " not work.\n"); 174 if (dev->fw_ver >= HDPVR_FIRMWARE_VERSION_AC3) 175 dev->flags |= HDPVR_FLAG_AC3_CAP; 176 else 177 dev->flags &= ~HDPVR_FLAG_AC3_CAP; 178 } 179 180 response = dev->usbc_buf+38; 181 #ifdef HDPVR_DEBUG 182 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, "challenge: %8ph\n", 183 response); 184 #endif 185 challenge(response); 186 #ifdef HDPVR_DEBUG 187 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, " response: %8ph\n", 188 response); 189 #endif 190 191 msleep(100); 192 ret = usb_control_msg(dev->udev, 193 usb_sndctrlpipe(dev->udev, 0), 194 0xd1, 0x00 | request_type, 195 0x0000, 0x0000, 196 response, 8, 197 10000); 198 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, 199 "magic request returned %d\n", ret); 200 201 retval = ret != 8; 202 unlock: 203 mutex_unlock(&dev->usbc_mutex); 204 return retval; 205 } 206 207 static int hdpvr_device_init(struct hdpvr_device *dev) 208 { 209 int ret; 210 u8 *buf; 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); 228 v4l2_dbg(MSG_INFO, hdpvr_debug, &dev->v4l2_dev, 229 "control request returned %d\n", ret); 230 mutex_unlock(&dev->usbc_mutex); 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 256 static 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 /* original picture controls for firmware version <= 0x15 */ 266 /* updated in device_authorization() for newer firmware */ 267 .brightness = 0x86, 268 .contrast = 0x80, 269 .hue = 0x80, 270 .saturation = 0x80, 271 .sharpness = 0x80, 272 }; 273 274 static int hdpvr_probe(struct usb_interface *interface, 275 const struct usb_device_id *id) 276 { 277 struct hdpvr_device *dev; 278 struct usb_host_interface *iface_desc; 279 struct usb_endpoint_descriptor *endpoint; 280 struct i2c_client *client; 281 size_t buffer_size; 282 int i; 283 int retval = -ENOMEM; 284 285 /* allocate memory for our device state and initialize it */ 286 dev = kzalloc(sizeof(*dev), GFP_KERNEL); 287 if (!dev) { 288 dev_err(&interface->dev, "Out of memory\n"); 289 goto error; 290 } 291 292 /* init video transfer queues first of all */ 293 /* to prevent oops in hdpvr_delete() on error paths */ 294 INIT_LIST_HEAD(&dev->free_buff_list); 295 INIT_LIST_HEAD(&dev->rec_buff_list); 296 297 /* register v4l2_device early so it can be used for printks */ 298 if (v4l2_device_register(&interface->dev, &dev->v4l2_dev)) { 299 dev_err(&interface->dev, "v4l2_device_register failed\n"); 300 goto error; 301 } 302 303 mutex_init(&dev->io_mutex); 304 mutex_init(&dev->i2c_mutex); 305 mutex_init(&dev->usbc_mutex); 306 dev->usbc_buf = kmalloc(64, GFP_KERNEL); 307 if (!dev->usbc_buf) { 308 v4l2_err(&dev->v4l2_dev, "Out of memory\n"); 309 goto error; 310 } 311 312 init_waitqueue_head(&dev->wait_buffer); 313 init_waitqueue_head(&dev->wait_data); 314 315 dev->workqueue = create_singlethread_workqueue("hdpvr_buffer"); 316 if (!dev->workqueue) 317 goto error; 318 319 dev->options = hdpvr_default_options; 320 321 if (default_video_input < HDPVR_VIDEO_INPUTS) 322 dev->options.video_input = default_video_input; 323 324 if (default_audio_input < HDPVR_AUDIO_INPUTS) { 325 dev->options.audio_input = default_audio_input; 326 if (default_audio_input == HDPVR_SPDIF) 327 dev->options.audio_codec = 328 V4L2_MPEG_AUDIO_ENCODING_AC3; 329 } 330 331 dev->udev = usb_get_dev(interface_to_usbdev(interface)); 332 333 /* set up the endpoint information */ 334 /* use only the first bulk-in and bulk-out endpoints */ 335 iface_desc = interface->cur_altsetting; 336 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) { 337 endpoint = &iface_desc->endpoint[i].desc; 338 339 if (!dev->bulk_in_endpointAddr && 340 usb_endpoint_is_bulk_in(endpoint)) { 341 /* USB interface description is buggy, reported max 342 * packet size is 512 bytes, windows driver uses 8192 */ 343 buffer_size = 8192; 344 dev->bulk_in_size = buffer_size; 345 dev->bulk_in_endpointAddr = endpoint->bEndpointAddress; 346 } 347 348 } 349 if (!dev->bulk_in_endpointAddr) { 350 v4l2_err(&dev->v4l2_dev, "Could not find bulk-in endpoint\n"); 351 goto error; 352 } 353 354 /* init the device */ 355 if (hdpvr_device_init(dev)) { 356 v4l2_err(&dev->v4l2_dev, "device init failed\n"); 357 goto error; 358 } 359 360 mutex_lock(&dev->io_mutex); 361 if (hdpvr_alloc_buffers(dev, NUM_BUFFERS)) { 362 mutex_unlock(&dev->io_mutex); 363 v4l2_err(&dev->v4l2_dev, 364 "allocating transfer buffers failed\n"); 365 goto error; 366 } 367 mutex_unlock(&dev->io_mutex); 368 369 #if IS_ENABLED(CONFIG_I2C) 370 retval = hdpvr_register_i2c_adapter(dev); 371 if (retval < 0) { 372 v4l2_err(&dev->v4l2_dev, "i2c adapter register failed\n"); 373 goto error; 374 } 375 376 client = hdpvr_register_ir_rx_i2c(dev); 377 if (!client) { 378 v4l2_err(&dev->v4l2_dev, "i2c IR RX device register failed\n"); 379 retval = -ENODEV; 380 goto reg_fail; 381 } 382 383 client = hdpvr_register_ir_tx_i2c(dev); 384 if (!client) { 385 v4l2_err(&dev->v4l2_dev, "i2c IR TX device register failed\n"); 386 retval = -ENODEV; 387 goto reg_fail; 388 } 389 #endif 390 391 retval = hdpvr_register_videodev(dev, &interface->dev, 392 video_nr[atomic_inc_return(&dev_nr)]); 393 if (retval < 0) { 394 v4l2_err(&dev->v4l2_dev, "registering videodev failed\n"); 395 goto reg_fail; 396 } 397 398 /* let the user know what node this device is now attached to */ 399 v4l2_info(&dev->v4l2_dev, "device now attached to %s\n", 400 video_device_node_name(dev->video_dev)); 401 return 0; 402 403 reg_fail: 404 #if IS_ENABLED(CONFIG_I2C) 405 i2c_del_adapter(&dev->i2c_adapter); 406 #endif 407 error: 408 if (dev) { 409 /* Destroy single thread */ 410 if (dev->workqueue) 411 destroy_workqueue(dev->workqueue); 412 /* this frees allocated memory */ 413 hdpvr_delete(dev); 414 } 415 return retval; 416 } 417 418 static void hdpvr_disconnect(struct usb_interface *interface) 419 { 420 struct hdpvr_device *dev = to_hdpvr_dev(usb_get_intfdata(interface)); 421 422 v4l2_info(&dev->v4l2_dev, "device %s disconnected\n", 423 video_device_node_name(dev->video_dev)); 424 /* prevent more I/O from starting and stop any ongoing */ 425 mutex_lock(&dev->io_mutex); 426 dev->status = STATUS_DISCONNECTED; 427 wake_up_interruptible(&dev->wait_data); 428 wake_up_interruptible(&dev->wait_buffer); 429 mutex_unlock(&dev->io_mutex); 430 v4l2_device_disconnect(&dev->v4l2_dev); 431 msleep(100); 432 flush_workqueue(dev->workqueue); 433 mutex_lock(&dev->io_mutex); 434 hdpvr_cancel_queue(dev); 435 mutex_unlock(&dev->io_mutex); 436 #if IS_ENABLED(CONFIG_I2C) 437 i2c_del_adapter(&dev->i2c_adapter); 438 #endif 439 video_unregister_device(dev->video_dev); 440 atomic_dec(&dev_nr); 441 } 442 443 444 static struct usb_driver hdpvr_usb_driver = { 445 .name = "hdpvr", 446 .probe = hdpvr_probe, 447 .disconnect = hdpvr_disconnect, 448 .id_table = hdpvr_table, 449 }; 450 451 module_usb_driver(hdpvr_usb_driver); 452 453 MODULE_LICENSE("GPL"); 454 MODULE_VERSION("0.2.1"); 455 MODULE_AUTHOR("Janne Grunau"); 456 MODULE_DESCRIPTION("Hauppauge HD PVR driver"); 457