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