drivers/media/rc/mceusb.c

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