drivers/media/rc/mceusb.c

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