drivers/media/usb/hdpvr/hdpvr-core.c

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