drivers/media/rc/mceusb.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Driver for USB Windows Media Center Ed. eHome Infrared Transceivers
   4  *
   5  * Copyright (c) 2010-2011, Jarod Wilson <jarod@redhat.com>
   6  *
   7  * Based on the original lirc_mceusb and lirc_mceusb2 drivers, by Dan
   8  * Conti, Martin Blatter and Daniel Melander, the latter of which was
   9  * in turn also based on the lirc_atiusb driver by Paul Miller. The
  10  * two mce drivers were merged into one by Jarod Wilson, with transmit
  11  * support for the 1st-gen device added primarily by Patrick Calhoun,
  12  * with a bit of tweaks by Jarod. Debugging improvements and proper
  13  * support for what appears to be 3rd-gen hardware added by Jarod.
  14  * Initial port from lirc driver to ir-core drivery by Jarod, based
  15  * partially on a port to an earlier proposed IR infrastructure by
  16  * Jon Smirl, which included enhancements and simplifications to the
  17  * incoming IR buffer parsing routines.
  18  *
  19  * Updated in July of 2011 with the aid of Microsoft's official
  20  * remote/transceiver requirements and specification document, found at
  21  * download.microsoft.com, title
  22  * Windows-Media-Center-RC-IR-Collection-Green-Button-Specification-03-08-2011-V2.pdf
  23  */
  24
  25 #include <linux/device.h>
  26 #include <linux/module.h>
  27 #include <linux/slab.h>
  28 #include <linux/workqueue.h>
  29 #include <linux/usb.h>
  30 #include <linux/usb/input.h>
  31 #include <linux/pm_wakeup.h>
  32 #include <media/rc-core.h>
  33
  34 #define DRIVER_VERSION  "1.94"
  35 #define DRIVER_AUTHOR   "Jarod Wilson <jarod@redhat.com>"
  36 #define DRIVER_DESC     "Windows Media Center Ed. eHome Infrared Transceiver " \
  37                         "device driver"
  38 #define DRIVER_NAME     "mceusb"
  39
  40 #define USB_CTRL_MSG_SZ         2  /* Size of usb ctrl msg on gen1 hw */
  41 #define MCE_G1_INIT_MSGS        40 /* Init messages on gen1 hw to throw out */
  42
  43 /* MCE constants */
  44 #define MCE_CMDBUF_SIZE         384  /* MCE Command buffer length */
  45 #define MCE_TIME_UNIT           50   /* Approx 50us resolution */
  46 #define MCE_CODE_LENGTH         5    /* Normal length of packet (with header) */
  47 #define MCE_PACKET_SIZE         4    /* Normal length of packet (without header) */
  48 #define MCE_IRDATA_HEADER       0x84 /* Actual header format is 0x80 + num_bytes */
  49 #define MCE_IRDATA_TRAILER      0x80 /* End of IR data */
  50 #define MCE_MAX_CHANNELS        2    /* Two transmitters, hardware dependent? */
  51 #define MCE_DEFAULT_TX_MASK     0x03 /* Vals: TX1=0x01, TX2=0x02, ALL=0x03 */
  52 #define MCE_PULSE_BIT           0x80 /* Pulse bit, MSB set == PULSE else SPACE */
  53 #define MCE_PULSE_MASK          0x7f /* Pulse mask */
  54 #define MCE_MAX_PULSE_LENGTH    0x7f /* Longest transmittable pulse symbol */
  55
  56 /*
  57  * The interface between the host and the IR hardware is command-response
  58  * based. All commands and responses have a consistent format, where a lead
  59  * byte always identifies the type of data following it. The lead byte has
  60  * a port value in the 3 highest bits and a length value in the 5 lowest
  61  * bits.
  62  *
  63  * The length field is overloaded, with a value of 11111 indicating that the
  64  * following byte is a command or response code, and the length of the entire
  65  * message is determined by the code. If the length field is not 11111, then
  66  * it specifies the number of bytes of port data that follow.
  67  */
  68 #define MCE_CMD                 0x1f
  69 #define MCE_PORT_IR             0x4     /* (0x4 << 5) | MCE_CMD = 0x9f */
  70 #define MCE_PORT_SYS            0x7     /* (0x7 << 5) | MCE_CMD = 0xff */
  71 #define MCE_PORT_SER            0x6     /* 0xc0 through 0xdf flush & 0x1f bytes */
  72 #define MCE_PORT_MASK           0xe0    /* Mask out command bits */
  73
  74 /* Command port headers */
  75 #define MCE_CMD_PORT_IR         0x9f    /* IR-related cmd/rsp */
  76 #define MCE_CMD_PORT_SYS        0xff    /* System (non-IR) device cmd/rsp */
  77
  78 /* Commands that set device state  (2-4 bytes in length) */
  79 #define MCE_CMD_RESET           0xfe    /* Reset device, 2 bytes */
  80 #define MCE_CMD_RESUME          0xaa    /* Resume device after error, 2 bytes */
  81 #define MCE_CMD_SETIRCFS        0x06    /* Set tx carrier, 4 bytes */
  82 #define MCE_CMD_SETIRTIMEOUT    0x0c    /* Set timeout, 4 bytes */
  83 #define MCE_CMD_SETIRTXPORTS    0x08    /* Set tx ports, 3 bytes */
  84 #define MCE_CMD_SETIRRXPORTEN   0x14    /* Set rx ports, 3 bytes */
  85 #define MCE_CMD_FLASHLED        0x23    /* Flash receiver LED, 2 bytes */
  86
  87 /* Commands that query device state (all 2 bytes, unless noted) */
  88 #define MCE_CMD_GETIRCFS        0x07    /* Get carrier */
  89 #define MCE_CMD_GETIRTIMEOUT    0x0d    /* Get timeout */
  90 #define MCE_CMD_GETIRTXPORTS    0x13    /* Get tx ports */
  91 #define MCE_CMD_GETIRRXPORTEN   0x15    /* Get rx ports */
  92 #define MCE_CMD_GETPORTSTATUS   0x11    /* Get tx port status, 3 bytes */
  93 #define MCE_CMD_GETIRNUMPORTS   0x16    /* Get number of ports */
  94 #define MCE_CMD_GETWAKESOURCE   0x17    /* Get wake source */
  95 #define MCE_CMD_GETEMVER        0x22    /* Get emulator interface version */
  96 #define MCE_CMD_GETDEVDETAILS   0x21    /* Get device details (em ver2 only) */
  97 #define MCE_CMD_GETWAKESUPPORT  0x20    /* Get wake details (em ver2 only) */
  98 #define MCE_CMD_GETWAKEVERSION  0x18    /* Get wake pattern (em ver2 only) */
  99
 100 /* Misc commands */
 101 #define MCE_CMD_NOP             0xff    /* No operation */
 102
 103 /* Responses to commands (non-error cases) */
 104 #define MCE_RSP_EQIRCFS         0x06    /* tx carrier, 4 bytes */
 105 #define MCE_RSP_EQIRTIMEOUT     0x0c    /* rx timeout, 4 bytes */
 106 #define MCE_RSP_GETWAKESOURCE   0x17    /* wake source, 3 bytes */
 107 #define MCE_RSP_EQIRTXPORTS     0x08    /* tx port mask, 3 bytes */
 108 #define MCE_RSP_EQIRRXPORTEN    0x14    /* rx port mask, 3 bytes */
 109 #define MCE_RSP_GETPORTSTATUS   0x11    /* tx port status, 7 bytes */
 110 #define MCE_RSP_EQIRRXCFCNT     0x15    /* rx carrier count, 4 bytes */
 111 #define MCE_RSP_EQIRNUMPORTS    0x16    /* number of ports, 4 bytes */
 112 #define MCE_RSP_EQWAKESUPPORT   0x20    /* wake capabilities, 3 bytes */
 113 #define MCE_RSP_EQWAKEVERSION   0x18    /* wake pattern details, 6 bytes */
 114 #define MCE_RSP_EQDEVDETAILS    0x21    /* device capabilities, 3 bytes */
 115 #define MCE_RSP_EQEMVER         0x22    /* emulator interface ver, 3 bytes */
 116 #define MCE_RSP_FLASHLED        0x23    /* success flashing LED, 2 bytes */
 117
 118 /* Responses to error cases, must send MCE_CMD_RESUME to clear them */
 119 #define MCE_RSP_CMD_ILLEGAL     0xfe    /* illegal command for port, 2 bytes */
 120 #define MCE_RSP_TX_TIMEOUT      0x81    /* tx timed out, 2 bytes */
 121
 122 /* Misc commands/responses not defined in the MCE remote/transceiver spec */
 123 #define MCE_CMD_SIG_END         0x01    /* End of signal */
 124 #define MCE_CMD_PING            0x03    /* Ping device */
 125 #define MCE_CMD_UNKNOWN         0x04    /* Unknown */
 126 #define MCE_CMD_UNKNOWN2        0x05    /* Unknown */
 127 #define MCE_CMD_UNKNOWN3        0x09    /* Unknown */
 128 #define MCE_CMD_UNKNOWN4        0x0a    /* Unknown */
 129 #define MCE_CMD_G_REVISION      0x0b    /* Get hw/sw revision */
 130 #define MCE_CMD_UNKNOWN5        0x0e    /* Unknown */
 131 #define MCE_CMD_UNKNOWN6        0x0f    /* Unknown */
 132 #define MCE_CMD_UNKNOWN8        0x19    /* Unknown */
 133 #define MCE_CMD_UNKNOWN9        0x1b    /* Unknown */
 134 #define MCE_CMD_NULL            0x00    /* These show up various places... */
 135
 136 /* if buf[i] & MCE_PORT_MASK == 0x80 and buf[i] != MCE_CMD_PORT_IR,
 137  * then we're looking at a raw IR data sample */
 138 #define MCE_COMMAND_IRDATA      0x80
 139 #define MCE_PACKET_LENGTH_MASK  0x1f /* Packet length mask */
 140
 141 #define VENDOR_PHILIPS          0x0471
 142 #define VENDOR_SMK              0x0609
 143 #define VENDOR_TATUNG           0x1460
 144 #define VENDOR_GATEWAY          0x107b
 145 #define VENDOR_SHUTTLE          0x1308
 146 #define VENDOR_SHUTTLE2         0x051c
 147 #define VENDOR_MITSUMI          0x03ee
 148 #define VENDOR_TOPSEED          0x1784
 149 #define VENDOR_RICAVISION       0x179d
 150 #define VENDOR_ITRON            0x195d
 151 #define VENDOR_FIC              0x1509
 152 #define VENDOR_LG               0x043e
 153 #define VENDOR_MICROSOFT        0x045e
 154 #define VENDOR_FORMOSA          0x147a
 155 #define VENDOR_FINTEK           0x1934
 156 #define VENDOR_PINNACLE         0x2304
 157 #define VENDOR_ECS              0x1019
 158 #define VENDOR_WISTRON          0x0fb8
 159 #define VENDOR_COMPRO           0x185b
 160 #define VENDOR_NORTHSTAR        0x04eb
 161 #define VENDOR_REALTEK          0x0bda
 162 #define VENDOR_TIVO             0x105a
 163 #define VENDOR_CONEXANT         0x0572
 164 #define VENDOR_TWISTEDMELON     0x2596
 165 #define VENDOR_HAUPPAUGE        0x2040
 166 #define VENDOR_PCTV             0x2013
 167 #define VENDOR_ADAPTEC          0x03f3
 168
 169 enum mceusb_model_type {
 170         MCE_GEN2 = 0,           /* Most boards */
 171         MCE_GEN1,
 172         MCE_GEN3,
 173         MCE_GEN3_BROKEN_IRTIMEOUT,
 174         MCE_GEN2_TX_INV,
 175         MCE_GEN2_TX_INV_RX_GOOD,
 176         POLARIS_EVK,
 177         CX_HYBRID_TV,
 178         MULTIFUNCTION,
 179         TIVO_KIT,
 180         MCE_GEN2_NO_TX,
 181         HAUPPAUGE_CX_HYBRID_TV,
 182         EVROMEDIA_FULL_HYBRID_FULLHD,
 183         ASTROMETA_T2HYBRID,
 184 };
 185
 186 struct mceusb_model {
 187         u32 mce_gen1:1;
 188         u32 mce_gen2:1;
 189         u32 mce_gen3:1;
 190         u32 tx_mask_normal:1;
 191         u32 no_tx:1;
 192         u32 broken_irtimeout:1;
 193         /*
 194          * 2nd IR receiver (short-range, wideband) for learning mode:
 195          *     0, absent 2nd receiver (rx2)
 196          *     1, rx2 present
 197          *     2, rx2 which under counts IR carrier cycles
 198          */
 199         u32 rx2;
 200
 201         int ir_intfnum;
 202
 203         const char *rc_map;     /* Allow specify a per-board map */
 204         const char *name;       /* per-board name */
 205 };
 206
 207 static const struct mceusb_model mceusb_model[] = {
 208         [MCE_GEN1] = {
 209                 .mce_gen1 = 1,
 210                 .tx_mask_normal = 1,
 211                 .rx2 = 2,
 212         },
 213         [MCE_GEN2] = {
 214                 .mce_gen2 = 1,
 215                 .rx2 = 2,
 216         },
 217         [MCE_GEN2_NO_TX] = {
 218                 .mce_gen2 = 1,
 219                 .no_tx = 1,
 220         },
 221         [MCE_GEN2_TX_INV] = {
 222                 .mce_gen2 = 1,
 223                 .tx_mask_normal = 1,
 224                 .rx2 = 1,
 225         },
 226         [MCE_GEN2_TX_INV_RX_GOOD] = {
 227                 .mce_gen2 = 1,
 228                 .tx_mask_normal = 1,
 229                 .rx2 = 2,
 230         },
 231         [MCE_GEN3] = {
 232                 .mce_gen3 = 1,
 233                 .tx_mask_normal = 1,
 234                 .rx2 = 2,
 235         },
 236         [MCE_GEN3_BROKEN_IRTIMEOUT] = {
 237                 .mce_gen3 = 1,
 238                 .tx_mask_normal = 1,
 239                 .rx2 = 2,
 240                 .broken_irtimeout = 1
 241         },
 242         [POLARIS_EVK] = {
 243                 /*
 244                  * In fact, the EVK is shipped without
 245                  * remotes, but we should have something handy,
 246                  * to allow testing it
 247                  */
 248                 .name = "Conexant Hybrid TV (cx231xx) MCE IR",
 249                 .rx2 = 2,
 250         },
 251         [CX_HYBRID_TV] = {
 252                 .no_tx = 1, /* tx isn't wired up at all */
 253                 .name = "Conexant Hybrid TV (cx231xx) MCE IR",
 254         },
 255         [HAUPPAUGE_CX_HYBRID_TV] = {
 256                 .no_tx = 1, /* eeprom says it has no tx */
 257                 .name = "Conexant Hybrid TV (cx231xx) MCE IR no TX",
 258         },
 259         [MULTIFUNCTION] = {
 260                 .mce_gen2 = 1,
 261                 .ir_intfnum = 2,
 262                 .rx2 = 2,
 263         },
 264         [TIVO_KIT] = {
 265                 .mce_gen2 = 1,
 266                 .rc_map = RC_MAP_TIVO,
 267                 .rx2 = 2,
 268         },
 269         [EVROMEDIA_FULL_HYBRID_FULLHD] = {
 270                 .name = "Evromedia USB Full Hybrid Full HD",
 271                 .no_tx = 1,
 272                 .rc_map = RC_MAP_MSI_DIGIVOX_III,
 273         },
 274         [ASTROMETA_T2HYBRID] = {
 275                 .name = "Astrometa T2Hybrid",
 276                 .no_tx = 1,
 277                 .rc_map = RC_MAP_ASTROMETA_T2HYBRID,
 278         }
 279 };
 280
 281 static const struct usb_device_id mceusb_dev_table[] = {
 282         /* Original Microsoft MCE IR Transceiver (often HP-branded) */
 283         { USB_DEVICE(VENDOR_MICROSOFT, 0x006d),
 284           .driver_info = MCE_GEN1 },
 285         /* Philips Infrared Transceiver - Sahara branded */
 286         { USB_DEVICE(VENDOR_PHILIPS, 0x0608) },
 287         /* Philips Infrared Transceiver - HP branded */
 288         { USB_DEVICE(VENDOR_PHILIPS, 0x060c),
 289           .driver_info = MCE_GEN2_TX_INV },
 290         /* Philips SRM5100 */
 291         { USB_DEVICE(VENDOR_PHILIPS, 0x060d) },
 292         /* Philips Infrared Transceiver - Omaura */
 293         { USB_DEVICE(VENDOR_PHILIPS, 0x060f) },
 294         /* Philips Infrared Transceiver - Spinel plus */
 295         { USB_DEVICE(VENDOR_PHILIPS, 0x0613) },
 296         /* Philips eHome Infrared Transceiver */
 297         { USB_DEVICE(VENDOR_PHILIPS, 0x0815) },
 298         /* Philips/Spinel plus IR transceiver for ASUS */
 299         { USB_DEVICE(VENDOR_PHILIPS, 0x206c) },
 300         /* Philips/Spinel plus IR transceiver for ASUS */
 301         { USB_DEVICE(VENDOR_PHILIPS, 0x2088) },
 302         /* Philips IR transceiver (Dell branded) */
 303         { USB_DEVICE(VENDOR_PHILIPS, 0x2093),
 304           .driver_info = MCE_GEN2_TX_INV },
 305         /* Realtek MCE IR Receiver and card reader */
 306         { USB_DEVICE(VENDOR_REALTEK, 0x0161),
 307           .driver_info = MULTIFUNCTION },
 308         /* SMK/Toshiba G83C0004D410 */
 309         { USB_DEVICE(VENDOR_SMK, 0x031d),
 310           .driver_info = MCE_GEN2_TX_INV_RX_GOOD },
 311         /* SMK eHome Infrared Transceiver (Sony VAIO) */
 312         { USB_DEVICE(VENDOR_SMK, 0x0322),
 313           .driver_info = MCE_GEN2_TX_INV },
 314         /* bundled with Hauppauge PVR-150 */
 315         { USB_DEVICE(VENDOR_SMK, 0x0334),
 316           .driver_info = MCE_GEN2_TX_INV },
 317         /* SMK eHome Infrared Transceiver */
 318         { USB_DEVICE(VENDOR_SMK, 0x0338) },
 319         /* SMK/I-O Data GV-MC7/RCKIT Receiver */
 320         { USB_DEVICE(VENDOR_SMK, 0x0353),
 321           .driver_info = MCE_GEN2_NO_TX },
 322         /* SMK RXX6000 Infrared Receiver */
 323         { USB_DEVICE(VENDOR_SMK, 0x0357),
 324           .driver_info = MCE_GEN2_NO_TX },
 325         /* Tatung eHome Infrared Transceiver */
 326         { USB_DEVICE(VENDOR_TATUNG, 0x9150) },
 327         /* Shuttle eHome Infrared Transceiver */
 328         { USB_DEVICE(VENDOR_SHUTTLE, 0xc001) },
 329         /* Shuttle eHome Infrared Transceiver */
 330         { USB_DEVICE(VENDOR_SHUTTLE2, 0xc001) },
 331         /* Gateway eHome Infrared Transceiver */
 332         { USB_DEVICE(VENDOR_GATEWAY, 0x3009) },
 333         /* Mitsumi */
 334         { USB_DEVICE(VENDOR_MITSUMI, 0x2501) },
 335         /* Topseed eHome Infrared Transceiver */
 336         { USB_DEVICE(VENDOR_TOPSEED, 0x0001),
 337           .driver_info = MCE_GEN2_TX_INV },
 338         /* Topseed HP eHome Infrared Transceiver */
 339         { USB_DEVICE(VENDOR_TOPSEED, 0x0006),
 340           .driver_info = MCE_GEN2_TX_INV },
 341         /* Topseed eHome Infrared Transceiver */
 342         { USB_DEVICE(VENDOR_TOPSEED, 0x0007),
 343           .driver_info = MCE_GEN2_TX_INV },
 344         /* Topseed eHome Infrared Transceiver */
 345         { USB_DEVICE(VENDOR_TOPSEED, 0x0008),
 346           .driver_info = MCE_GEN3 },
 347         /* Topseed eHome Infrared Transceiver */
 348         { USB_DEVICE(VENDOR_TOPSEED, 0x000a),
 349           .driver_info = MCE_GEN2_TX_INV },
 350         /* Topseed eHome Infrared Transceiver */
 351         { USB_DEVICE(VENDOR_TOPSEED, 0x0011),
 352           .driver_info = MCE_GEN3_BROKEN_IRTIMEOUT },
 353         /* Ricavision internal Infrared Transceiver */
 354         { USB_DEVICE(VENDOR_RICAVISION, 0x0010) },
 355         /* Itron ione Libra Q-11 */
 356         { USB_DEVICE(VENDOR_ITRON, 0x7002) },
 357         /* FIC eHome Infrared Transceiver */
 358         { USB_DEVICE(VENDOR_FIC, 0x9242) },
 359         /* LG eHome Infrared Transceiver */
 360         { USB_DEVICE(VENDOR_LG, 0x9803) },
 361         /* Microsoft MCE Infrared Transceiver */
 362         { USB_DEVICE(VENDOR_MICROSOFT, 0x00a0) },
 363         /* Formosa eHome Infrared Transceiver */
 364         { USB_DEVICE(VENDOR_FORMOSA, 0xe015) },
 365         /* Formosa21 / eHome Infrared Receiver */
 366         { USB_DEVICE(VENDOR_FORMOSA, 0xe016) },
 367         /* Formosa aim / Trust MCE Infrared Receiver */
 368         { USB_DEVICE(VENDOR_FORMOSA, 0xe017),
 369           .driver_info = MCE_GEN2_NO_TX },
 370         /* Formosa Industrial Computing / Beanbag Emulation Device */
 371         { USB_DEVICE(VENDOR_FORMOSA, 0xe018) },
 372         /* Formosa21 / eHome Infrared Receiver */
 373         { USB_DEVICE(VENDOR_FORMOSA, 0xe03a) },
 374         /* Formosa Industrial Computing AIM IR605/A */
 375         { USB_DEVICE(VENDOR_FORMOSA, 0xe03c) },
 376         /* Formosa Industrial Computing */
 377         { USB_DEVICE(VENDOR_FORMOSA, 0xe03e) },
 378         /* Formosa Industrial Computing */
 379         { USB_DEVICE(VENDOR_FORMOSA, 0xe042) },
 380         /* Fintek eHome Infrared Transceiver (HP branded) */
 381         { USB_DEVICE(VENDOR_FINTEK, 0x5168),
 382           .driver_info = MCE_GEN2_TX_INV },
 383         /* Fintek eHome Infrared Transceiver */
 384         { USB_DEVICE(VENDOR_FINTEK, 0x0602) },
 385         /* Fintek eHome Infrared Transceiver (in the AOpen MP45) */
 386         { USB_DEVICE(VENDOR_FINTEK, 0x0702) },
 387         /* Pinnacle Remote Kit */
 388         { USB_DEVICE(VENDOR_PINNACLE, 0x0225),
 389           .driver_info = MCE_GEN3 },
 390         /* Elitegroup Computer Systems IR */
 391         { USB_DEVICE(VENDOR_ECS, 0x0f38) },
 392         /* Wistron Corp. eHome Infrared Receiver */
 393         { USB_DEVICE(VENDOR_WISTRON, 0x0002) },
 394         /* Compro K100 */
 395         { USB_DEVICE(VENDOR_COMPRO, 0x3020) },
 396         /* Compro K100 v2 */
 397         { USB_DEVICE(VENDOR_COMPRO, 0x3082) },
 398         /* Northstar Systems, Inc. eHome Infrared Transceiver */
 399         { USB_DEVICE(VENDOR_NORTHSTAR, 0xe004) },
 400         /* TiVo PC IR Receiver */
 401         { USB_DEVICE(VENDOR_TIVO, 0x2000),
 402           .driver_info = TIVO_KIT },
 403         /* Conexant Hybrid TV "Shelby" Polaris SDK */
 404         { USB_DEVICE(VENDOR_CONEXANT, 0x58a1),
 405           .driver_info = POLARIS_EVK },
 406         /* Conexant Hybrid TV RDU253S Polaris */
 407         { USB_DEVICE(VENDOR_CONEXANT, 0x58a5),
 408           .driver_info = CX_HYBRID_TV },
 409         /* Twisted Melon Inc. - Manta Mini Receiver */
 410         { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8008) },
 411         /* Twisted Melon Inc. - Manta Pico Receiver */
 412         { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8016) },
 413         /* Twisted Melon Inc. - Manta Transceiver */
 414         { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8042) },
 415         /* Hauppauge WINTV-HVR-HVR 930C-HD - based on cx231xx */
 416         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb130),
 417           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
 418         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb131),
 419           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
 420         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb138),
 421           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
 422         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb139),
 423           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
 424         /* Hauppauge WinTV-HVR-935C - based on cx231xx */
 425         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb151),
 426           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
 427         /* Hauppauge WinTV-HVR-955Q - based on cx231xx */
 428         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb123),
 429           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
 430         /* Hauppauge WinTV-HVR-975 - based on cx231xx */
 431         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb150),
 432           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
 433         { USB_DEVICE(VENDOR_PCTV, 0x0259),
 434           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
 435         { USB_DEVICE(VENDOR_PCTV, 0x025e),
 436           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
 437         /* Adaptec / HP eHome Receiver */
 438         { USB_DEVICE(VENDOR_ADAPTEC, 0x0094) },
 439         /* Evromedia USB Full Hybrid Full HD */
 440         { USB_DEVICE(0x1b80, 0xd3b2),
 441           .driver_info = EVROMEDIA_FULL_HYBRID_FULLHD },
 442         /* Astrometa T2hybrid */
 443         { USB_DEVICE(0x15f4, 0x0135),
 444           .driver_info = ASTROMETA_T2HYBRID },
 445
 446         /* Terminating entry */
 447         { }
 448 };
 449
 450 /* data structure for each usb transceiver */
 451 struct mceusb_dev {
 452         /* ir-core bits */
 453         struct rc_dev *rc;
 454
 455         /* optional features we can enable */
 456         bool carrier_report_enabled;
 457         bool wideband_rx_enabled;       /* aka learning mode, short-range rx */
 458
 459         /* core device bits */
 460         struct device *dev;
 461
 462         /* usb */
 463         struct usb_device *usbdev;
 464         struct usb_interface *usbintf;
 465         struct urb *urb_in;
 466         unsigned int pipe_in;
 467         struct usb_endpoint_descriptor *usb_ep_out;
 468         unsigned int pipe_out;
 469
 470         /* buffers and dma */
 471         unsigned char *buf_in;
 472         unsigned int len_in;
 473         dma_addr_t dma_in;
 474
 475         enum {
 476                 CMD_HEADER = 0,
 477                 SUBCMD,
 478                 CMD_DATA,
 479                 PARSE_IRDATA,
 480         } parser_state;
 481
 482         u8 cmd, rem;            /* Remaining IR data bytes in packet */
 483
 484         struct {
 485                 u32 connected:1;
 486                 u32 tx_mask_normal:1;
 487                 u32 microsoft_gen1:1;
 488                 u32 no_tx:1;
 489                 u32 rx2;
 490         } flags;
 491
 492         /* transmit support */
 493         u32 carrier;
 494         unsigned char tx_mask;
 495
 496         char name[128];
 497         char phys[64];
 498         enum mceusb_model_type model;
 499
 500         bool need_reset;        /* flag to issue a device resume cmd */
 501         u8 emver;               /* emulator interface version */
 502         u8 num_txports;         /* number of transmit ports */
 503         u8 num_rxports;         /* number of receive sensors */
 504         u8 txports_cabled;      /* bitmask of transmitters with cable */
 505         u8 rxports_active;      /* bitmask of active receive sensors */
 506         bool learning_active;   /* wideband rx is active */
 507
 508         /* receiver carrier frequency detection support */
 509         u32 pulse_tunit;        /* IR pulse "on" cumulative time units */
 510         u32 pulse_count;        /* pulse "on" count in measurement interval */
 511
 512         /*
 513          * support for async error handler mceusb_deferred_kevent()
 514          * where usb_clear_halt(), usb_reset_configuration(),
 515          * usb_reset_device(), etc. must be done in process context
 516          */
 517         struct work_struct kevent;
 518         unsigned long kevent_flags;
 519 #               define EVENT_TX_HALT    0
 520 #               define EVENT_RX_HALT    1
 521 #               define EVENT_RST_PEND   31
 522 };
 523
 524 /* MCE Device Command Strings, generally a port and command pair */
 525 static char DEVICE_RESUME[]     = {MCE_CMD_NULL, MCE_CMD_PORT_SYS,
 526                                    MCE_CMD_RESUME};
 527 static char GET_REVISION[]      = {MCE_CMD_PORT_SYS, MCE_CMD_G_REVISION};
 528 static char GET_EMVER[]         = {MCE_CMD_PORT_SYS, MCE_CMD_GETEMVER};
 529 static char GET_WAKEVERSION[]   = {MCE_CMD_PORT_SYS, MCE_CMD_GETWAKEVERSION};
 530 static char FLASH_LED[]         = {MCE_CMD_PORT_SYS, MCE_CMD_FLASHLED};
 531 static char GET_UNKNOWN2[]      = {MCE_CMD_PORT_IR, MCE_CMD_UNKNOWN2};
 532 static char GET_CARRIER_FREQ[]  = {MCE_CMD_PORT_IR, MCE_CMD_GETIRCFS};
 533 static char GET_RX_TIMEOUT[]    = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTIMEOUT};
 534 static char GET_NUM_PORTS[]     = {MCE_CMD_PORT_IR, MCE_CMD_GETIRNUMPORTS};
 535 static char GET_TX_BITMASK[]    = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTXPORTS};
 536 static char GET_RX_SENSOR[]     = {MCE_CMD_PORT_IR, MCE_CMD_GETIRRXPORTEN};
 537 /* sub in desired values in lower byte or bytes for full command */
 538 /* FIXME: make use of these for transmit.
 539 static char SET_CARRIER_FREQ[]  = {MCE_CMD_PORT_IR,
 540                                    MCE_CMD_SETIRCFS, 0x00, 0x00};
 541 static char SET_TX_BITMASK[]    = {MCE_CMD_PORT_IR, MCE_CMD_SETIRTXPORTS, 0x00};
 542 static char SET_RX_TIMEOUT[]    = {MCE_CMD_PORT_IR,
 543                                    MCE_CMD_SETIRTIMEOUT, 0x00, 0x00};
 544 static char SET_RX_SENSOR[]     = {MCE_CMD_PORT_IR,
 545                                    MCE_RSP_EQIRRXPORTEN, 0x00};
 546 */
 547
 548 static int mceusb_cmd_datasize(u8 cmd, u8 subcmd)
 549 {
 550         int datasize = 0;
 551
 552         switch (cmd) {
 553         case MCE_CMD_NULL:
 554                 if (subcmd == MCE_CMD_PORT_SYS)
 555                         datasize = 1;
 556                 break;
 557         case MCE_CMD_PORT_SYS:
 558                 switch (subcmd) {
 559                 case MCE_RSP_GETPORTSTATUS:
 560                         datasize = 5;
 561                         break;
 562                 case MCE_RSP_EQWAKEVERSION:
 563                         datasize = 4;
 564                         break;
 565                 case MCE_CMD_G_REVISION:
 566                         datasize = 2;
 567                         break;
 568                 case MCE_RSP_EQWAKESUPPORT:
 569                 case MCE_RSP_GETWAKESOURCE:
 570                 case MCE_RSP_EQDEVDETAILS:
 571                 case MCE_RSP_EQEMVER:
 572                         datasize = 1;
 573                         break;
 574                 }
 575                 break;
 576         case MCE_CMD_PORT_IR:
 577                 switch (subcmd) {
 578                 case MCE_CMD_UNKNOWN:
 579                 case MCE_RSP_EQIRCFS:
 580                 case MCE_RSP_EQIRTIMEOUT:
 581                 case MCE_RSP_EQIRRXCFCNT:
 582                 case MCE_RSP_EQIRNUMPORTS:
 583                         datasize = 2;
 584                         break;
 585                 case MCE_CMD_SIG_END:
 586                 case MCE_RSP_EQIRTXPORTS:
 587                 case MCE_RSP_EQIRRXPORTEN:
 588                         datasize = 1;
 589                         break;
 590                 }
 591         }
 592         return datasize;
 593 }
 594
 595 static void mceusb_dev_printdata(struct mceusb_dev *ir, u8 *buf, int buf_len,
 596                                  int offset, int len, bool out)
 597 {
 598 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
 599         char *inout;
 600         u8 cmd, subcmd, *data;
 601         struct device *dev = ir->dev;
 602         int start, skip = 0;
 603         u32 carrier, period;
 604
 605         /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
 606         if (ir->flags.microsoft_gen1 && !out && !offset)
 607                 skip = 2;
 608
 609         if (len <= skip)
 610                 return;
 611
 612         dev_dbg(dev, "%cx data: %*ph (length=%d)",
 613                 (out ? 't' : 'r'),
 614                 min(len, buf_len - offset), buf + offset, len);
 615
 616         inout = out ? "Request" : "Got";
 617
 618         start  = offset + skip;
 619         cmd    = buf[start] & 0xff;
 620         subcmd = buf[start + 1] & 0xff;
 621         data = buf + start + 2;
 622
 623         switch (cmd) {
 624         case MCE_CMD_NULL:
 625                 if (subcmd == MCE_CMD_NULL)
 626                         break;
 627                 if ((subcmd == MCE_CMD_PORT_SYS) &&
 628                     (data[0] == MCE_CMD_RESUME))
 629                         dev_dbg(dev, "Device resume requested");
 630                 else
 631                         dev_dbg(dev, "Unknown command 0x%02x 0x%02x",
 632                                  cmd, subcmd);
 633                 break;
 634         case MCE_CMD_PORT_SYS:
 635                 switch (subcmd) {
 636                 case MCE_RSP_EQEMVER:
 637                         if (!out)
 638                                 dev_dbg(dev, "Emulator interface version %x",
 639                                          data[0]);
 640                         break;
 641                 case MCE_CMD_G_REVISION:
 642                         if (len == 2)
 643                                 dev_dbg(dev, "Get hw/sw rev?");
 644                         else
 645                                 dev_dbg(dev, "hw/sw rev %*ph",
 646                                         4, &buf[start + 2]);
 647                         break;
 648                 case MCE_CMD_RESUME:
 649                         dev_dbg(dev, "Device resume requested");
 650                         break;
 651                 case MCE_RSP_CMD_ILLEGAL:
 652                         dev_dbg(dev, "Illegal PORT_SYS command");
 653                         break;
 654                 case MCE_RSP_EQWAKEVERSION:
 655                         if (!out)
 656                                 dev_dbg(dev, "Wake version, proto: 0x%02x, payload: 0x%02x, address: 0x%02x, version: 0x%02x",
 657                                         data[0], data[1], data[2], data[3]);
 658                         break;
 659                 case MCE_RSP_GETPORTSTATUS:
 660                         if (!out)
 661                                 /* We use data1 + 1 here, to match hw labels */
 662                                 dev_dbg(dev, "TX port %d: blaster is%s connected",
 663                                          data[0] + 1, data[3] ? " not" : "");
 664                         break;
 665                 case MCE_CMD_FLASHLED:
 666                         dev_dbg(dev, "Attempting to flash LED");
 667                         break;
 668                 default:
 669                         dev_dbg(dev, "Unknown command 0x%02x 0x%02x",
 670                                  cmd, subcmd);
 671                         break;
 672                 }
 673                 break;
 674         case MCE_CMD_PORT_IR:
 675                 switch (subcmd) {
 676                 case MCE_CMD_SIG_END:
 677                         dev_dbg(dev, "End of signal");
 678                         break;
 679                 case MCE_CMD_PING:
 680                         dev_dbg(dev, "Ping");
 681                         break;
 682                 case MCE_CMD_UNKNOWN:
 683                         dev_dbg(dev, "Resp to 9f 05 of 0x%02x 0x%02x",
 684                                 data[0], data[1]);
 685                         break;
 686                 case MCE_RSP_EQIRCFS:
 687                         period = DIV_ROUND_CLOSEST((1U << data[0] * 2) *
 688                                                    (data[1] + 1), 10);
 689                         if (!period)
 690                                 break;
 691                         carrier = (1000 * 1000) / period;
 692                         dev_dbg(dev, "%s carrier of %u Hz (period %uus)",
 693                                  inout, carrier, period);
 694                         break;
 695                 case MCE_CMD_GETIRCFS:
 696                         dev_dbg(dev, "Get carrier mode and freq");
 697                         break;
 698                 case MCE_RSP_EQIRTXPORTS:
 699                         dev_dbg(dev, "%s transmit blaster mask of 0x%02x",
 700                                  inout, data[0]);
 701                         break;
 702                 case MCE_RSP_EQIRTIMEOUT:
 703                         /* value is in units of 50us, so x*50/1000 ms */
 704                         period = ((data[0] << 8) | data[1]) *
 705                                   MCE_TIME_UNIT / 1000;
 706                         dev_dbg(dev, "%s receive timeout of %d ms",
 707                                  inout, period);
 708                         break;
 709                 case MCE_CMD_GETIRTIMEOUT:
 710                         dev_dbg(dev, "Get receive timeout");
 711                         break;
 712                 case MCE_CMD_GETIRTXPORTS:
 713                         dev_dbg(dev, "Get transmit blaster mask");
 714                         break;
 715                 case MCE_RSP_EQIRRXPORTEN:
 716                         dev_dbg(dev, "%s %s-range receive sensor in use",
 717                                  inout, data[0] == 0x02 ? "short" : "long");
 718                         break;
 719                 case MCE_CMD_GETIRRXPORTEN:
 720                 /* aka MCE_RSP_EQIRRXCFCNT */
 721                         if (out)
 722                                 dev_dbg(dev, "Get receive sensor");
 723                         else
 724                                 dev_dbg(dev, "RX carrier cycle count: %d",
 725                                         ((data[0] << 8) | data[1]));
 726                         break;
 727                 case MCE_RSP_EQIRNUMPORTS:
 728                         if (out)
 729                                 break;
 730                         dev_dbg(dev, "Num TX ports: %x, num RX ports: %x",
 731                                 data[0], data[1]);
 732                         break;
 733                 case MCE_RSP_CMD_ILLEGAL:
 734                         dev_dbg(dev, "Illegal PORT_IR command");
 735                         break;
 736                 default:
 737                         dev_dbg(dev, "Unknown command 0x%02x 0x%02x",
 738                                  cmd, subcmd);
 739                         break;
 740                 }
 741                 break;
 742         default:
 743                 break;
 744         }
 745
 746         if (cmd == MCE_IRDATA_TRAILER)
 747                 dev_dbg(dev, "End of raw IR data");
 748         else if ((cmd != MCE_CMD_PORT_IR) &&
 749                  ((cmd & MCE_PORT_MASK) == MCE_COMMAND_IRDATA))
 750                 dev_dbg(dev, "Raw IR data, %d pulse/space samples", ir->rem);
 751 #endif
 752 }
 753
 754 /*
 755  * Schedule work that can't be done in interrupt handlers
 756  * (mceusb_dev_recv() and mce_async_callback()) nor tasklets.
 757  * Invokes mceusb_deferred_kevent() for recovering from
 758  * error events specified by the kevent bit field.
 759  */
 760 static void mceusb_defer_kevent(struct mceusb_dev *ir, int kevent)
 761 {
 762         set_bit(kevent, &ir->kevent_flags);
 763
 764         if (test_bit(EVENT_RST_PEND, &ir->kevent_flags)) {
 765                 dev_dbg(ir->dev, "kevent %d dropped pending USB Reset Device",
 766                         kevent);
 767                 return;
 768         }
 769
 770         if (!schedule_work(&ir->kevent))
 771                 dev_dbg(ir->dev, "kevent %d already scheduled", kevent);
 772         else
 773                 dev_dbg(ir->dev, "kevent %d scheduled", kevent);
 774 }
 775
 776 static void mce_async_callback(struct urb *urb)
 777 {
 778         struct mceusb_dev *ir;
 779         int len;
 780
 781         if (!urb)
 782                 return;
 783
 784         ir = urb->context;
 785
 786         switch (urb->status) {
 787         /* success */
 788         case 0:
 789                 len = urb->actual_length;
 790
 791                 mceusb_dev_printdata(ir, urb->transfer_buffer, len,
 792                                      0, len, true);
 793                 break;
 794
 795         case -ECONNRESET:
 796         case -ENOENT:
 797         case -EILSEQ:
 798         case -ESHUTDOWN:
 799                 break;
 800
 801         case -EPIPE:
 802                 dev_err(ir->dev, "Error: request urb status = %d (TX HALT)",
 803                         urb->status);
 804                 mceusb_defer_kevent(ir, EVENT_TX_HALT);
 805                 break;
 806
 807         default:
 808                 dev_err(ir->dev, "Error: request urb status = %d", urb->status);
 809                 break;
 810         }
 811
 812         /* the transfer buffer and urb were allocated in mce_request_packet */
 813         kfree(urb->transfer_buffer);
 814         usb_free_urb(urb);
 815 }
 816
 817 /* request outgoing (send) usb packet - used to initialize remote */
 818 static void mce_request_packet(struct mceusb_dev *ir, unsigned char *data,
 819                                                                 int size)
 820 {
 821         int res;
 822         struct urb *async_urb;
 823         struct device *dev = ir->dev;
 824         unsigned char *async_buf;
 825
 826         async_urb = usb_alloc_urb(0, GFP_KERNEL);
 827         if (unlikely(!async_urb)) {
 828                 dev_err(dev, "Error, couldn't allocate urb!");
 829                 return;
 830         }
 831
 832         async_buf = kmalloc(size, GFP_KERNEL);
 833         if (!async_buf) {
 834                 usb_free_urb(async_urb);
 835                 return;
 836         }
 837
 838         /* outbound data */
 839         if (usb_endpoint_xfer_int(ir->usb_ep_out))
 840                 usb_fill_int_urb(async_urb, ir->usbdev, ir->pipe_out,
 841                                  async_buf, size, mce_async_callback, ir,
 842                                  ir->usb_ep_out->bInterval);
 843         else
 844                 usb_fill_bulk_urb(async_urb, ir->usbdev, ir->pipe_out,
 845                                   async_buf, size, mce_async_callback, ir);
 846
 847         memcpy(async_buf, data, size);
 848
 849         dev_dbg(dev, "send request called (size=%#x)", size);
 850
 851         res = usb_submit_urb(async_urb, GFP_ATOMIC);
 852         if (res) {
 853                 dev_err(dev, "send request FAILED! (res=%d)", res);
 854                 kfree(async_buf);
 855                 usb_free_urb(async_urb);
 856                 return;
 857         }
 858         dev_dbg(dev, "send request complete (res=%d)", res);
 859 }
 860
 861 static void mce_async_out(struct mceusb_dev *ir, unsigned char *data, int size)
 862 {
 863         int rsize = sizeof(DEVICE_RESUME);
 864
 865         if (ir->need_reset) {
 866                 ir->need_reset = false;
 867                 mce_request_packet(ir, DEVICE_RESUME, rsize);
 868                 msleep(10);
 869         }
 870
 871         mce_request_packet(ir, data, size);
 872         msleep(10);
 873 }
 874
 875 /* Send data out the IR blaster port(s) */
 876 static int mceusb_tx_ir(struct rc_dev *dev, unsigned *txbuf, unsigned count)
 877 {
 878         struct mceusb_dev *ir = dev->priv;
 879         int i, length, ret = 0;
 880         int cmdcount = 0;
 881         unsigned char cmdbuf[MCE_CMDBUF_SIZE];
 882
 883         /* MCE tx init header */
 884         cmdbuf[cmdcount++] = MCE_CMD_PORT_IR;
 885         cmdbuf[cmdcount++] = MCE_CMD_SETIRTXPORTS;
 886         cmdbuf[cmdcount++] = ir->tx_mask;
 887
 888         /* Send the set TX ports command */
 889         mce_async_out(ir, cmdbuf, cmdcount);
 890         cmdcount = 0;
 891
 892         /* Generate mce packet data */
 893         for (i = 0; (i < count) && (cmdcount < MCE_CMDBUF_SIZE); i++) {
 894                 txbuf[i] = txbuf[i] / MCE_TIME_UNIT;
 895
 896                 do { /* loop to support long pulses/spaces > 127*50us=6.35ms */
 897
 898                         /* Insert mce packet header every 4th entry */
 899                         if ((cmdcount < MCE_CMDBUF_SIZE) &&
 900                             (cmdcount % MCE_CODE_LENGTH) == 0)
 901                                 cmdbuf[cmdcount++] = MCE_IRDATA_HEADER;
 902
 903                         /* Insert mce packet data */
 904                         if (cmdcount < MCE_CMDBUF_SIZE)
 905                                 cmdbuf[cmdcount++] =
 906                                         (txbuf[i] < MCE_PULSE_BIT ?
 907                                          txbuf[i] : MCE_MAX_PULSE_LENGTH) |
 908                                          (i & 1 ? 0x00 : MCE_PULSE_BIT);
 909                         else {
 910                                 ret = -EINVAL;
 911                                 goto out;
 912                         }
 913
 914                 } while ((txbuf[i] > MCE_MAX_PULSE_LENGTH) &&
 915                          (txbuf[i] -= MCE_MAX_PULSE_LENGTH));
 916         }
 917
 918         /* Check if we have room for the empty packet at the end */
 919         if (cmdcount >= MCE_CMDBUF_SIZE) {
 920                 ret = -EINVAL;
 921                 goto out;
 922         }
 923
 924         /* Fix packet length in last header */
 925         length = cmdcount % MCE_CODE_LENGTH;
 926         cmdbuf[cmdcount - length] -= MCE_CODE_LENGTH - length;
 927
 928         /* All mce commands end with an empty packet (0x80) */
 929         cmdbuf[cmdcount++] = MCE_IRDATA_TRAILER;
 930
 931         /* Transmit the command to the mce device */
 932         mce_async_out(ir, cmdbuf, cmdcount);
 933
 934 out:
 935         return ret ? ret : count;
 936 }
 937
 938 /* Sets active IR outputs -- mce devices typically have two */
 939 static int mceusb_set_tx_mask(struct rc_dev *dev, u32 mask)
 940 {
 941         struct mceusb_dev *ir = dev->priv;
 942
 943         /* return number of transmitters */
 944         int emitters = ir->num_txports ? ir->num_txports : 2;
 945
 946         if (mask >= (1 << emitters))
 947                 return emitters;
 948
 949         if (ir->flags.tx_mask_normal)
 950                 ir->tx_mask = mask;
 951         else
 952                 ir->tx_mask = (mask != MCE_DEFAULT_TX_MASK ?
 953                                 mask ^ MCE_DEFAULT_TX_MASK : mask) << 1;
 954
 955         return 0;
 956 }
 957
 958 /* Sets the send carrier frequency and mode */
 959 static int mceusb_set_tx_carrier(struct rc_dev *dev, u32 carrier)
 960 {
 961         struct mceusb_dev *ir = dev->priv;
 962         int clk = 10000000;
 963         int prescaler = 0, divisor = 0;
 964         unsigned char cmdbuf[4] = { MCE_CMD_PORT_IR,
 965                                     MCE_CMD_SETIRCFS, 0x00, 0x00 };
 966
 967         /* Carrier has changed */
 968         if (ir->carrier != carrier) {
 969
 970                 if (carrier == 0) {
 971                         ir->carrier = carrier;
 972                         cmdbuf[2] = MCE_CMD_SIG_END;
 973                         cmdbuf[3] = MCE_IRDATA_TRAILER;
 974                         dev_dbg(ir->dev, "disabling carrier modulation");
 975                         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
 976                         return 0;
 977                 }
 978
 979                 for (prescaler = 0; prescaler < 4; ++prescaler) {
 980                         divisor = (clk >> (2 * prescaler)) / carrier;
 981                         if (divisor <= 0xff) {
 982                                 ir->carrier = carrier;
 983                                 cmdbuf[2] = prescaler;
 984                                 cmdbuf[3] = divisor;
 985                                 dev_dbg(ir->dev, "requesting %u HZ carrier",
 986                                                                 carrier);
 987
 988                                 /* Transmit new carrier to mce device */
 989                                 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
 990                                 return 0;
 991                         }
 992                 }
 993
 994                 return -EINVAL;
 995
 996         }
 997
 998         return 0;
 999 }
1000
1001 static int mceusb_set_timeout(struct rc_dev *dev, unsigned int timeout)
1002 {
1003         u8 cmdbuf[4] = { MCE_CMD_PORT_IR, MCE_CMD_SETIRTIMEOUT, 0, 0 };
1004         struct mceusb_dev *ir = dev->priv;
1005         unsigned int units;
1006
1007         units = DIV_ROUND_CLOSEST(timeout, US_TO_NS(MCE_TIME_UNIT));
1008
1009         cmdbuf[2] = units >> 8;
1010         cmdbuf[3] = units;
1011
1012         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1013
1014         /* get receiver timeout value */
1015         mce_async_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT));
1016
1017         return 0;
1018 }
1019
1020 /*
1021  * Select or deselect the 2nd receiver port.
1022  * Second receiver is learning mode, wide-band, short-range receiver.
1023  * Only one receiver (long or short range) may be active at a time.
1024  */
1025 static int mceusb_set_rx_wideband(struct rc_dev *dev, int enable)
1026 {
1027         struct mceusb_dev *ir = dev->priv;
1028         unsigned char cmdbuf[3] = { MCE_CMD_PORT_IR,
1029                                     MCE_CMD_SETIRRXPORTEN, 0x00 };
1030
1031         dev_dbg(ir->dev, "select %s-range receive sensor",
1032                 enable ? "short" : "long");
1033         if (enable) {
1034                 ir->wideband_rx_enabled = true;
1035                 cmdbuf[2] = 2;  /* port 2 is short range receiver */
1036         } else {
1037                 ir->wideband_rx_enabled = false;
1038                 cmdbuf[2] = 1;  /* port 1 is long range receiver */
1039         }
1040         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1041         /* response from device sets ir->learning_active */
1042
1043         return 0;
1044 }
1045
1046 /*
1047  * Enable/disable receiver carrier frequency pass through reporting.
1048  * Only the short-range receiver has carrier frequency measuring capability.
1049  * Implicitly select this receiver when enabling carrier frequency reporting.
1050  */
1051 static int mceusb_set_rx_carrier_report(struct rc_dev *dev, int enable)
1052 {
1053         struct mceusb_dev *ir = dev->priv;
1054         unsigned char cmdbuf[3] = { MCE_CMD_PORT_IR,
1055                                     MCE_CMD_SETIRRXPORTEN, 0x00 };
1056
1057         dev_dbg(ir->dev, "%s short-range receiver carrier reporting",
1058                 enable ? "enable" : "disable");
1059         if (enable) {
1060                 ir->carrier_report_enabled = true;
1061                 if (!ir->learning_active) {
1062                         cmdbuf[2] = 2;  /* port 2 is short range receiver */
1063                         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1064                 }
1065         } else {
1066                 ir->carrier_report_enabled = false;
1067                 /*
1068                  * Revert to normal (long-range) receiver only if the
1069                  * wideband (short-range) receiver wasn't explicitly
1070                  * enabled.
1071                  */
1072                 if (ir->learning_active && !ir->wideband_rx_enabled) {
1073                         cmdbuf[2] = 1;  /* port 1 is long range receiver */
1074                         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1075                 }
1076         }
1077
1078         return 0;
1079 }
1080
1081 /*
1082  * We don't do anything but print debug spew for many of the command bits
1083  * we receive from the hardware, but some of them are useful information
1084  * we want to store so that we can use them.
1085  */
1086 static void mceusb_handle_command(struct mceusb_dev *ir, int index)
1087 {
1088         struct ir_raw_event rawir = {};
1089         u8 hi = ir->buf_in[index + 1] & 0xff;
1090         u8 lo = ir->buf_in[index + 2] & 0xff;
1091         u32 carrier_cycles;
1092         u32 cycles_fix;
1093
1094         switch (ir->buf_in[index]) {
1095         /* the one and only 5-byte return value command */
1096         case MCE_RSP_GETPORTSTATUS:
1097                 if ((ir->buf_in[index + 4] & 0xff) == 0x00)
1098                         ir->txports_cabled |= 1 << hi;
1099                 break;
1100
1101         /* 2-byte return value commands */
1102         case MCE_RSP_EQIRTIMEOUT:
1103                 ir->rc->timeout = US_TO_NS((hi << 8 | lo) * MCE_TIME_UNIT);
1104                 break;
1105         case MCE_RSP_EQIRNUMPORTS:
1106                 ir->num_txports = hi;
1107                 ir->num_rxports = lo;
1108                 break;
1109         case MCE_RSP_EQIRRXCFCNT:
1110                 /*
1111                  * The carrier cycle counter can overflow and wrap around
1112                  * without notice from the device. So frequency measurement
1113                  * will be inaccurate with long duration IR.
1114                  *
1115                  * The long-range (non learning) receiver always reports
1116                  * zero count so we always ignore its report.
1117                  */
1118                 if (ir->carrier_report_enabled && ir->learning_active &&
1119                     ir->pulse_tunit > 0) {
1120                         carrier_cycles = (hi << 8 | lo);
1121                         /*
1122                          * Adjust carrier cycle count by adding
1123                          * 1 missed count per pulse "on"
1124                          */
1125                         cycles_fix = ir->flags.rx2 == 2 ? ir->pulse_count : 0;
1126                         rawir.carrier_report = 1;
1127                         rawir.carrier = (1000000u / MCE_TIME_UNIT) *
1128                                         (carrier_cycles + cycles_fix) /
1129                                         ir->pulse_tunit;
1130                         dev_dbg(ir->dev, "RX carrier frequency %u Hz (pulse count = %u, cycles = %u, duration = %u, rx2 = %u)",
1131                                 rawir.carrier, ir->pulse_count, carrier_cycles,
1132                                 ir->pulse_tunit, ir->flags.rx2);
1133                         ir_raw_event_store(ir->rc, &rawir);
1134                 }
1135                 break;
1136
1137         /* 1-byte return value commands */
1138         case MCE_RSP_EQEMVER:
1139                 ir->emver = hi;
1140                 break;
1141         case MCE_RSP_EQIRTXPORTS:
1142                 ir->tx_mask = hi;
1143                 break;
1144         case MCE_RSP_EQIRRXPORTEN:
1145                 ir->learning_active = ((hi & 0x02) == 0x02);
1146                 if (ir->rxports_active != hi) {
1147                         dev_info(ir->dev, "%s-range (0x%x) receiver active",
1148                                  ir->learning_active ? "short" : "long", hi);
1149                         ir->rxports_active = hi;
1150                 }
1151                 break;
1152         case MCE_RSP_CMD_ILLEGAL:
1153                 ir->need_reset = true;
1154                 break;
1155         default:
1156                 break;
1157         }
1158 }
1159
1160 static void mceusb_process_ir_data(struct mceusb_dev *ir, int buf_len)
1161 {
1162         struct ir_raw_event rawir = {};
1163         bool event = false;
1164         int i = 0;
1165
1166         /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
1167         if (ir->flags.microsoft_gen1)
1168                 i = 2;
1169
1170         /* if there's no data, just return now */
1171         if (buf_len <= i)
1172                 return;
1173
1174         for (; i < buf_len; i++) {
1175                 switch (ir->parser_state) {
1176                 case SUBCMD:
1177                         ir->rem = mceusb_cmd_datasize(ir->cmd, ir->buf_in[i]);
1178                         mceusb_dev_printdata(ir, ir->buf_in, buf_len, i - 1,
1179                                              ir->rem + 2, false);
1180                         mceusb_handle_command(ir, i);
1181                         ir->parser_state = CMD_DATA;
1182                         break;
1183                 case PARSE_IRDATA:
1184                         ir->rem--;
1185                         rawir.pulse = ((ir->buf_in[i] & MCE_PULSE_BIT) != 0);
1186                         rawir.duration = (ir->buf_in[i] & MCE_PULSE_MASK);
1187                         if (unlikely(!rawir.duration)) {
1188                                 dev_dbg(ir->dev, "nonsensical irdata %02x with duration 0",
1189                                         ir->buf_in[i]);
1190                                 break;
1191                         }
1192                         if (rawir.pulse) {
1193                                 ir->pulse_tunit += rawir.duration;
1194                                 ir->pulse_count++;
1195                         }
1196                         rawir.duration *= US_TO_NS(MCE_TIME_UNIT);
1197
1198                         dev_dbg(ir->dev, "Storing %s %u ns (%02x)",
1199                                 rawir.pulse ? "pulse" : "space",
1200                                 rawir.duration, ir->buf_in[i]);
1201
1202                         if (ir_raw_event_store_with_filter(ir->rc, &rawir))
1203                                 event = true;
1204                         break;
1205                 case CMD_DATA:
1206                         ir->rem--;
1207                         break;
1208                 case CMD_HEADER:
1209                         /* decode mce packets of the form (84),AA,BB,CC,DD */
1210                         /* IR data packets can span USB messages - rem */
1211                         ir->cmd = ir->buf_in[i];
1212                         if ((ir->cmd == MCE_CMD_PORT_IR) ||
1213                             ((ir->cmd & MCE_PORT_MASK) !=
1214                              MCE_COMMAND_IRDATA)) {
1215                                 ir->parser_state = SUBCMD;
1216                                 continue;
1217                         }
1218                         ir->rem = (ir->cmd & MCE_PACKET_LENGTH_MASK);
1219                         mceusb_dev_printdata(ir, ir->buf_in, buf_len,
1220                                              i, ir->rem + 1, false);
1221                         if (ir->rem) {
1222                                 ir->parser_state = PARSE_IRDATA;
1223                         } else {
1224                                 struct ir_raw_event ev = {
1225                                         .timeout = 1,
1226                                         .duration = ir->rc->timeout
1227                                 };
1228
1229                                 if (ir_raw_event_store_with_filter(ir->rc,
1230                                                                    &ev))
1231                                         event = true;
1232                                 ir->pulse_tunit = 0;
1233                                 ir->pulse_count = 0;
1234                         }
1235                         break;
1236                 }
1237
1238                 if (ir->parser_state != CMD_HEADER && !ir->rem)
1239                         ir->parser_state = CMD_HEADER;
1240         }
1241         if (event) {
1242                 dev_dbg(ir->dev, "processed IR data");
1243                 ir_raw_event_handle(ir->rc);
1244         }
1245 }
1246
1247 static void mceusb_dev_recv(struct urb *urb)
1248 {
1249         struct mceusb_dev *ir;
1250
1251         if (!urb)
1252                 return;
1253
1254         ir = urb->context;
1255         if (!ir) {
1256                 usb_unlink_urb(urb);
1257                 return;
1258         }
1259
1260         switch (urb->status) {
1261         /* success */
1262         case 0:
1263                 mceusb_process_ir_data(ir, urb->actual_length);
1264                 break;
1265
1266         case -ECONNRESET:
1267         case -ENOENT:
1268         case -EILSEQ:
1269         case -ESHUTDOWN:
1270                 usb_unlink_urb(urb);
1271                 return;
1272
1273         case -EPIPE:
1274                 dev_err(ir->dev, "Error: urb status = %d (RX HALT)",
1275                         urb->status);
1276                 mceusb_defer_kevent(ir, EVENT_RX_HALT);
1277                 return;
1278
1279         default:
1280                 dev_err(ir->dev, "Error: urb status = %d", urb->status);
1281                 break;
1282         }
1283
1284         usb_submit_urb(urb, GFP_ATOMIC);
1285 }
1286
1287 static void mceusb_get_emulator_version(struct mceusb_dev *ir)
1288 {
1289         /* If we get no reply or an illegal command reply, its ver 1, says MS */
1290         ir->emver = 1;
1291         mce_async_out(ir, GET_EMVER, sizeof(GET_EMVER));
1292 }
1293
1294 static void mceusb_gen1_init(struct mceusb_dev *ir)
1295 {
1296         int ret;
1297         struct device *dev = ir->dev;
1298         char *data;
1299
1300         data = kzalloc(USB_CTRL_MSG_SZ, GFP_KERNEL);
1301         if (!data) {
1302                 dev_err(dev, "%s: memory allocation failed!", __func__);
1303                 return;
1304         }
1305
1306         /*
1307          * This is a strange one. Windows issues a set address to the device
1308          * on the receive control pipe and expect a certain value pair back
1309          */
1310         ret = usb_control_msg(ir->usbdev, usb_rcvctrlpipe(ir->usbdev, 0),
1311                               USB_REQ_SET_ADDRESS, USB_TYPE_VENDOR, 0, 0,
1312                               data, USB_CTRL_MSG_SZ, HZ * 3);
1313         dev_dbg(dev, "set address - ret = %d", ret);
1314         dev_dbg(dev, "set address - data[0] = %d, data[1] = %d",
1315                                                 data[0], data[1]);
1316
1317         /* set feature: bit rate 38400 bps */
1318         ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1319                               USB_REQ_SET_FEATURE, USB_TYPE_VENDOR,
1320                               0xc04e, 0x0000, NULL, 0, HZ * 3);
1321
1322         dev_dbg(dev, "set feature - ret = %d", ret);
1323
1324         /* bRequest 4: set char length to 8 bits */
1325         ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1326                               4, USB_TYPE_VENDOR,
1327                               0x0808, 0x0000, NULL, 0, HZ * 3);
1328         dev_dbg(dev, "set char length - retB = %d", ret);
1329
1330         /* bRequest 2: set handshaking to use DTR/DSR */
1331         ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1332                               2, USB_TYPE_VENDOR,
1333                               0x0000, 0x0100, NULL, 0, HZ * 3);
1334         dev_dbg(dev, "set handshake  - retC = %d", ret);
1335
1336         /* device resume */
1337         mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
1338
1339         /* get hw/sw revision? */
1340         mce_async_out(ir, GET_REVISION, sizeof(GET_REVISION));
1341
1342         kfree(data);
1343 }
1344
1345 static void mceusb_gen2_init(struct mceusb_dev *ir)
1346 {
1347         /* device resume */
1348         mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
1349
1350         /* get wake version (protocol, key, address) */
1351         mce_async_out(ir, GET_WAKEVERSION, sizeof(GET_WAKEVERSION));
1352
1353         /* unknown what this one actually returns... */
1354         mce_async_out(ir, GET_UNKNOWN2, sizeof(GET_UNKNOWN2));
1355 }
1356
1357 static void mceusb_get_parameters(struct mceusb_dev *ir)
1358 {
1359         int i;
1360         unsigned char cmdbuf[3] = { MCE_CMD_PORT_SYS,
1361                                     MCE_CMD_GETPORTSTATUS, 0x00 };
1362
1363         /* defaults, if the hardware doesn't support querying */
1364         ir->num_txports = 2;
1365         ir->num_rxports = 2;
1366
1367         /* get number of tx and rx ports */
1368         mce_async_out(ir, GET_NUM_PORTS, sizeof(GET_NUM_PORTS));
1369
1370         /* get the carrier and frequency */
1371         mce_async_out(ir, GET_CARRIER_FREQ, sizeof(GET_CARRIER_FREQ));
1372
1373         if (ir->num_txports && !ir->flags.no_tx)
1374                 /* get the transmitter bitmask */
1375                 mce_async_out(ir, GET_TX_BITMASK, sizeof(GET_TX_BITMASK));
1376
1377         /* get receiver timeout value */
1378         mce_async_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT));
1379
1380         /* get receiver sensor setting */
1381         mce_async_out(ir, GET_RX_SENSOR, sizeof(GET_RX_SENSOR));
1382
1383         for (i = 0; i < ir->num_txports; i++) {
1384                 cmdbuf[2] = i;
1385                 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1386         }
1387 }
1388
1389 static void mceusb_flash_led(struct mceusb_dev *ir)
1390 {
1391         if (ir->emver < 2)
1392                 return;
1393
1394         mce_async_out(ir, FLASH_LED, sizeof(FLASH_LED));
1395 }
1396
1397 /*
1398  * Workqueue function
1399  * for resetting or recovering device after occurrence of error events
1400  * specified in ir->kevent bit field.
1401  * Function runs (via schedule_work()) in non-interrupt context, for
1402  * calls here (such as usb_clear_halt()) requiring non-interrupt context.
1403  */
1404 static void mceusb_deferred_kevent(struct work_struct *work)
1405 {
1406         struct mceusb_dev *ir =
1407                 container_of(work, struct mceusb_dev, kevent);
1408         int status;
1409
1410         dev_err(ir->dev, "kevent handler called (flags 0x%lx)",
1411                 ir->kevent_flags);
1412
1413         if (test_bit(EVENT_RST_PEND, &ir->kevent_flags)) {
1414                 dev_err(ir->dev, "kevent handler canceled pending USB Reset Device");
1415                 return;
1416         }
1417
1418         if (test_bit(EVENT_RX_HALT, &ir->kevent_flags)) {
1419                 usb_unlink_urb(ir->urb_in);
1420                 status = usb_clear_halt(ir->usbdev, ir->pipe_in);
1421                 dev_err(ir->dev, "rx clear halt status = %d", status);
1422                 if (status < 0) {
1423                         /*
1424                          * Unable to clear RX halt/stall.
1425                          * Will need to call usb_reset_device().
1426                          */
1427                         dev_err(ir->dev,
1428                                 "stuck RX HALT state requires USB Reset Device to clear");
1429                         usb_queue_reset_device(ir->usbintf);
1430                         set_bit(EVENT_RST_PEND, &ir->kevent_flags);
1431                         clear_bit(EVENT_RX_HALT, &ir->kevent_flags);
1432
1433                         /* Cancel all other error events and handlers */
1434                         clear_bit(EVENT_TX_HALT, &ir->kevent_flags);
1435                         return;
1436                 }
1437                 clear_bit(EVENT_RX_HALT, &ir->kevent_flags);
1438                 status = usb_submit_urb(ir->urb_in, GFP_KERNEL);
1439                 if (status < 0) {
1440                         dev_err(ir->dev, "rx unhalt submit urb error = %d",
1441                                 status);
1442                 }
1443         }
1444
1445         if (test_bit(EVENT_TX_HALT, &ir->kevent_flags)) {
1446                 status = usb_clear_halt(ir->usbdev, ir->pipe_out);
1447                 dev_err(ir->dev, "tx clear halt status = %d", status);
1448                 if (status < 0) {
1449                         /*
1450                          * Unable to clear TX halt/stall.
1451                          * Will need to call usb_reset_device().
1452                          */
1453                         dev_err(ir->dev,
1454                                 "stuck TX HALT state requires USB Reset Device to clear");
1455                         usb_queue_reset_device(ir->usbintf);
1456                         set_bit(EVENT_RST_PEND, &ir->kevent_flags);
1457                         clear_bit(EVENT_TX_HALT, &ir->kevent_flags);
1458
1459                         /* Cancel all other error events and handlers */
1460                         clear_bit(EVENT_RX_HALT, &ir->kevent_flags);
1461                         return;
1462                 }
1463                 clear_bit(EVENT_TX_HALT, &ir->kevent_flags);
1464         }
1465 }
1466
1467 static struct rc_dev *mceusb_init_rc_dev(struct mceusb_dev *ir)
1468 {
1469         struct usb_device *udev = ir->usbdev;
1470         struct device *dev = ir->dev;
1471         struct rc_dev *rc;
1472         int ret;
1473
1474         rc = rc_allocate_device(RC_DRIVER_IR_RAW);
1475         if (!rc) {
1476                 dev_err(dev, "remote dev allocation failed");
1477                 goto out;
1478         }
1479
1480         snprintf(ir->name, sizeof(ir->name), "%s (%04x:%04x)",
1481                  mceusb_model[ir->model].name ?
1482                         mceusb_model[ir->model].name :
1483                         "Media Center Ed. eHome Infrared Remote Transceiver",
1484                  le16_to_cpu(ir->usbdev->descriptor.idVendor),
1485                  le16_to_cpu(ir->usbdev->descriptor.idProduct));
1486
1487         usb_make_path(ir->usbdev, ir->phys, sizeof(ir->phys));
1488
1489         rc->device_name = ir->name;
1490         rc->input_phys = ir->phys;
1491         usb_to_input_id(ir->usbdev, &rc->input_id);
1492         rc->dev.parent = dev;
1493         rc->priv = ir;
1494         rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;
1495         rc->min_timeout = US_TO_NS(MCE_TIME_UNIT);
1496         rc->timeout = MS_TO_NS(100);
1497         if (!mceusb_model[ir->model].broken_irtimeout) {
1498                 rc->s_timeout = mceusb_set_timeout;
1499                 rc->max_timeout = 10 * IR_DEFAULT_TIMEOUT;
1500         } else {
1501                 /*
1502                  * If we can't set the timeout using CMD_SETIRTIMEOUT, we can
1503                  * rely on software timeouts for timeouts < 100ms.
1504                  */
1505                 rc->max_timeout = rc->timeout;
1506         }
1507         if (!ir->flags.no_tx) {
1508                 rc->s_tx_mask = mceusb_set_tx_mask;
1509                 rc->s_tx_carrier = mceusb_set_tx_carrier;
1510                 rc->tx_ir = mceusb_tx_ir;
1511         }
1512         if (ir->flags.rx2 > 0) {
1513                 rc->s_learning_mode = mceusb_set_rx_wideband;
1514                 rc->s_carrier_report = mceusb_set_rx_carrier_report;
1515         }
1516         rc->driver_name = DRIVER_NAME;
1517
1518         switch (le16_to_cpu(udev->descriptor.idVendor)) {
1519         case VENDOR_HAUPPAUGE:
1520                 rc->map_name = RC_MAP_HAUPPAUGE;
1521                 break;
1522         case VENDOR_PCTV:
1523                 rc->map_name = RC_MAP_PINNACLE_PCTV_HD;
1524                 break;
1525         default:
1526                 rc->map_name = RC_MAP_RC6_MCE;
1527         }
1528         if (mceusb_model[ir->model].rc_map)
1529                 rc->map_name = mceusb_model[ir->model].rc_map;
1530
1531         ret = rc_register_device(rc);
1532         if (ret < 0) {
1533                 dev_err(dev, "remote dev registration failed");
1534                 goto out;
1535         }
1536
1537         return rc;
1538
1539 out:
1540         rc_free_device(rc);
1541         return NULL;
1542 }
1543
1544 static int mceusb_dev_probe(struct usb_interface *intf,
1545                             const struct usb_device_id *id)
1546 {
1547         struct usb_device *dev = interface_to_usbdev(intf);
1548         struct usb_host_interface *idesc;
1549         struct usb_endpoint_descriptor *ep = NULL;
1550         struct usb_endpoint_descriptor *ep_in = NULL;
1551         struct usb_endpoint_descriptor *ep_out = NULL;
1552         struct mceusb_dev *ir = NULL;
1553         int pipe, maxp, i, res;
1554         char buf[63], name[128] = "";
1555         enum mceusb_model_type model = id->driver_info;
1556         bool is_gen3;
1557         bool is_microsoft_gen1;
1558         bool tx_mask_normal;
1559         int ir_intfnum;
1560
1561         dev_dbg(&intf->dev, "%s called", __func__);
1562
1563         idesc  = intf->cur_altsetting;
1564
1565         is_gen3 = mceusb_model[model].mce_gen3;
1566         is_microsoft_gen1 = mceusb_model[model].mce_gen1;
1567         tx_mask_normal = mceusb_model[model].tx_mask_normal;
1568         ir_intfnum = mceusb_model[model].ir_intfnum;
1569
1570         /* There are multi-function devices with non-IR interfaces */
1571         if (idesc->desc.bInterfaceNumber != ir_intfnum)
1572                 return -ENODEV;
1573
1574         /* step through the endpoints to find first bulk in and out endpoint */
1575         for (i = 0; i < idesc->desc.bNumEndpoints; ++i) {
1576                 ep = &idesc->endpoint[i].desc;
1577
1578                 if (ep_in == NULL) {
1579                         if (usb_endpoint_is_bulk_in(ep)) {
1580                                 ep_in = ep;
1581                                 dev_dbg(&intf->dev, "acceptable bulk inbound endpoint found\n");
1582                         } else if (usb_endpoint_is_int_in(ep)) {
1583                                 ep_in = ep;
1584                                 ep_in->bInterval = 1;
1585                                 dev_dbg(&intf->dev, "acceptable interrupt inbound endpoint found\n");
1586                         }
1587                 }
1588
1589                 if (ep_out == NULL) {
1590                         if (usb_endpoint_is_bulk_out(ep)) {
1591                                 ep_out = ep;
1592                                 dev_dbg(&intf->dev, "acceptable bulk outbound endpoint found\n");
1593                         } else if (usb_endpoint_is_int_out(ep)) {
1594                                 ep_out = ep;
1595                                 ep_out->bInterval = 1;
1596                                 dev_dbg(&intf->dev, "acceptable interrupt outbound endpoint found\n");
1597                         }
1598                 }
1599         }
1600         if (!ep_in || !ep_out) {
1601                 dev_dbg(&intf->dev, "required endpoints not found\n");
1602                 return -ENODEV;
1603         }
1604
1605         if (usb_endpoint_xfer_int(ep_in))
1606                 pipe = usb_rcvintpipe(dev, ep_in->bEndpointAddress);
1607         else
1608                 pipe = usb_rcvbulkpipe(dev, ep_in->bEndpointAddress);
1609         maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
1610
1611         ir = kzalloc(sizeof(struct mceusb_dev), GFP_KERNEL);
1612         if (!ir)
1613                 goto mem_alloc_fail;
1614
1615         ir->pipe_in = pipe;
1616         ir->buf_in = usb_alloc_coherent(dev, maxp, GFP_ATOMIC, &ir->dma_in);
1617         if (!ir->buf_in)
1618                 goto buf_in_alloc_fail;
1619
1620         ir->urb_in = usb_alloc_urb(0, GFP_KERNEL);
1621         if (!ir->urb_in)
1622                 goto urb_in_alloc_fail;
1623
1624         ir->usbintf = intf;
1625         ir->usbdev = usb_get_dev(dev);
1626         ir->dev = &intf->dev;
1627         ir->len_in = maxp;
1628         ir->flags.microsoft_gen1 = is_microsoft_gen1;
1629         ir->flags.tx_mask_normal = tx_mask_normal;
1630         ir->flags.no_tx = mceusb_model[model].no_tx;
1631         ir->flags.rx2 = mceusb_model[model].rx2;
1632         ir->model = model;
1633
1634         /* Saving usb interface data for use by the transmitter routine */
1635         ir->usb_ep_out = ep_out;
1636         if (usb_endpoint_xfer_int(ep_out))
1637                 ir->pipe_out = usb_sndintpipe(ir->usbdev,
1638                                               ep_out->bEndpointAddress);
1639         else
1640                 ir->pipe_out = usb_sndbulkpipe(ir->usbdev,
1641                                                ep_out->bEndpointAddress);
1642
1643         if (dev->descriptor.iManufacturer
1644             && usb_string(dev, dev->descriptor.iManufacturer,
1645                           buf, sizeof(buf)) > 0)
1646                 strscpy(name, buf, sizeof(name));
1647         if (dev->descriptor.iProduct
1648             && usb_string(dev, dev->descriptor.iProduct,
1649                           buf, sizeof(buf)) > 0)
1650                 snprintf(name + strlen(name), sizeof(name) - strlen(name),
1651                          " %s", buf);
1652
1653         /*
1654          * Initialize async USB error handler before registering
1655          * or activating any mceusb RX and TX functions
1656          */
1657         INIT_WORK(&ir->kevent, mceusb_deferred_kevent);
1658
1659         ir->rc = mceusb_init_rc_dev(ir);
1660         if (!ir->rc)
1661                 goto rc_dev_fail;
1662
1663         /* wire up inbound data handler */
1664         if (usb_endpoint_xfer_int(ep_in))
1665                 usb_fill_int_urb(ir->urb_in, dev, pipe, ir->buf_in, maxp,
1666                                  mceusb_dev_recv, ir, ep_in->bInterval);
1667         else
1668                 usb_fill_bulk_urb(ir->urb_in, dev, pipe, ir->buf_in, maxp,
1669                                   mceusb_dev_recv, ir);
1670
1671         ir->urb_in->transfer_dma = ir->dma_in;
1672         ir->urb_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1673
1674         /* flush buffers on the device */
1675         dev_dbg(&intf->dev, "Flushing receive buffers");
1676         res = usb_submit_urb(ir->urb_in, GFP_KERNEL);
1677         if (res)
1678                 dev_err(&intf->dev, "failed to flush buffers: %d", res);
1679
1680         /* figure out which firmware/emulator version this hardware has */
1681         mceusb_get_emulator_version(ir);
1682
1683         /* initialize device */
1684         if (ir->flags.microsoft_gen1)
1685                 mceusb_gen1_init(ir);
1686         else if (!is_gen3)
1687                 mceusb_gen2_init(ir);
1688
1689         mceusb_get_parameters(ir);
1690
1691         mceusb_flash_led(ir);
1692
1693         if (!ir->flags.no_tx)
1694                 mceusb_set_tx_mask(ir->rc, MCE_DEFAULT_TX_MASK);
1695
1696         usb_set_intfdata(intf, ir);
1697
1698         /* enable wake via this device */
1699         device_set_wakeup_capable(ir->dev, true);
1700         device_set_wakeup_enable(ir->dev, true);
1701
1702         dev_info(&intf->dev, "Registered %s with mce emulator interface version %x",
1703                 name, ir->emver);
1704         dev_info(&intf->dev, "%x tx ports (0x%x cabled) and %x rx sensors (0x%x active)",
1705                  ir->num_txports, ir->txports_cabled,
1706                  ir->num_rxports, ir->rxports_active);
1707
1708         return 0;
1709
1710         /* Error-handling path */
1711 rc_dev_fail:
1712         cancel_work_sync(&ir->kevent);
1713         usb_put_dev(ir->usbdev);
1714         usb_kill_urb(ir->urb_in);
1715         usb_free_urb(ir->urb_in);
1716 urb_in_alloc_fail:
1717         usb_free_coherent(dev, maxp, ir->buf_in, ir->dma_in);
1718 buf_in_alloc_fail:
1719         kfree(ir);
1720 mem_alloc_fail:
1721         dev_err(&intf->dev, "%s: device setup failed!", __func__);
1722
1723         return -ENOMEM;
1724 }
1725
1726
1727 static void mceusb_dev_disconnect(struct usb_interface *intf)
1728 {
1729         struct usb_device *dev = interface_to_usbdev(intf);
1730         struct mceusb_dev *ir = usb_get_intfdata(intf);
1731
1732         dev_dbg(&intf->dev, "%s called", __func__);
1733
1734         usb_set_intfdata(intf, NULL);
1735
1736         if (!ir)
1737                 return;
1738
1739         ir->usbdev = NULL;
1740         cancel_work_sync(&ir->kevent);
1741         rc_unregister_device(ir->rc);
1742         usb_kill_urb(ir->urb_in);
1743         usb_free_urb(ir->urb_in);
1744         usb_free_coherent(dev, ir->len_in, ir->buf_in, ir->dma_in);
1745         usb_put_dev(dev);
1746
1747         kfree(ir);
1748 }
1749
1750 static int mceusb_dev_suspend(struct usb_interface *intf, pm_message_t message)
1751 {
1752         struct mceusb_dev *ir = usb_get_intfdata(intf);
1753         dev_info(ir->dev, "suspend");
1754         usb_kill_urb(ir->urb_in);
1755         return 0;
1756 }
1757
1758 static int mceusb_dev_resume(struct usb_interface *intf)
1759 {
1760         struct mceusb_dev *ir = usb_get_intfdata(intf);
1761         dev_info(ir->dev, "resume");
1762         if (usb_submit_urb(ir->urb_in, GFP_ATOMIC))
1763                 return -EIO;
1764         return 0;
1765 }
1766
1767 static struct usb_driver mceusb_dev_driver = {
1768         .name =         DRIVER_NAME,
1769         .probe =        mceusb_dev_probe,
1770         .disconnect =   mceusb_dev_disconnect,
1771         .suspend =      mceusb_dev_suspend,
1772         .resume =       mceusb_dev_resume,
1773         .reset_resume = mceusb_dev_resume,
1774         .id_table =     mceusb_dev_table
1775 };
1776
1777 module_usb_driver(mceusb_dev_driver);
1778
1779 MODULE_DESCRIPTION(DRIVER_DESC);
1780 MODULE_AUTHOR(DRIVER_AUTHOR);
1781 MODULE_LICENSE("GPL");
1782 MODULE_DEVICE_TABLE(usb, mceusb_dev_table);