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