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