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