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

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