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 GET_UNKNOWN2[]      = {MCE_CMD_PORT_IR, MCE_CMD_UNKNOWN2};
 455 static char GET_CARRIER_FREQ[]  = {MCE_CMD_PORT_IR, MCE_CMD_GETIRCFS};
 456 static char GET_RX_TIMEOUT[]    = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTIMEOUT};
 457 static char GET_NUM_PORTS[]     = {MCE_CMD_PORT_IR, MCE_CMD_GETIRNUMPORTS};
 458 static char GET_TX_BITMASK[]    = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTXPORTS};
 459 static char GET_RX_SENSOR[]     = {MCE_CMD_PORT_IR, MCE_CMD_GETIRRXPORTEN};
 460 /* sub in desired values in lower byte or bytes for full command */
 461 /* FIXME: make use of these for transmit.
 462 static char SET_CARRIER_FREQ[]  = {MCE_CMD_PORT_IR,
 463                                    MCE_CMD_SETIRCFS, 0x00, 0x00};
 464 static char SET_TX_BITMASK[]    = {MCE_CMD_PORT_IR, MCE_CMD_SETIRTXPORTS, 0x00};
 465 static char SET_RX_TIMEOUT[]    = {MCE_CMD_PORT_IR,
 466                                    MCE_CMD_SETIRTIMEOUT, 0x00, 0x00};
 467 static char SET_RX_SENSOR[]     = {MCE_CMD_PORT_IR,
 468                                    MCE_RSP_EQIRRXPORTEN, 0x00};
 469 */
 470
 471 static int mceusb_cmdsize(u8 cmd, u8 subcmd)
 472 {
 473         int datasize = 0;
 474
 475         switch (cmd) {
 476         case MCE_CMD_NULL:
 477                 if (subcmd == MCE_CMD_PORT_SYS)
 478                         datasize = 1;
 479                 break;
 480         case MCE_CMD_PORT_SYS:
 481                 switch (subcmd) {
 482                 case MCE_RSP_EQWAKEVERSION:
 483                         datasize = 4;
 484                         break;
 485                 case MCE_CMD_G_REVISION:
 486                         datasize = 2;
 487                         break;
 488                 case MCE_RSP_EQWAKESUPPORT:
 489                         datasize = 1;
 490                         break;
 491                 }
 492         case MCE_CMD_PORT_IR:
 493                 switch (subcmd) {
 494                 case MCE_CMD_UNKNOWN:
 495                 case MCE_RSP_EQIRCFS:
 496                 case MCE_RSP_EQIRTIMEOUT:
 497                 case MCE_RSP_EQIRRXCFCNT:
 498                         datasize = 2;
 499                         break;
 500                 case MCE_CMD_SIG_END:
 501                 case MCE_RSP_EQIRTXPORTS:
 502                 case MCE_RSP_EQIRRXPORTEN:
 503                         datasize = 1;
 504                         break;
 505                 }
 506         }
 507         return datasize;
 508 }
 509
 510 static void mceusb_dev_printdata(struct mceusb_dev *ir, char *buf,
 511                                  int offset, int len, bool out)
 512 {
 513         char codes[USB_BUFLEN * 3 + 1];
 514         char inout[9];
 515         u8 cmd, subcmd, data1, data2, data3, data4, data5;
 516         struct device *dev = ir->dev;
 517         int i, start, skip = 0;
 518
 519         if (!debug)
 520                 return;
 521
 522         /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
 523         if (ir->flags.microsoft_gen1 && !out && !offset)
 524                 skip = 2;
 525
 526         if (len <= skip)
 527                 return;
 528
 529         for (i = 0; i < len && i < USB_BUFLEN; i++)
 530                 snprintf(codes + i * 3, 4, "%02x ", buf[i + offset] & 0xff);
 531
 532         dev_info(dev, "%sx data: %s(length=%d)\n",
 533                  (out ? "t" : "r"), codes, len);
 534
 535         if (out)
 536                 strcpy(inout, "Request\0");
 537         else
 538                 strcpy(inout, "Got\0");
 539
 540         start  = offset + skip;
 541         cmd    = buf[start] & 0xff;
 542         subcmd = buf[start + 1] & 0xff;
 543         data1  = buf[start + 2] & 0xff;
 544         data2  = buf[start + 3] & 0xff;
 545         data3  = buf[start + 4] & 0xff;
 546         data4  = buf[start + 5] & 0xff;
 547         data5  = buf[start + 6] & 0xff;
 548
 549         switch (cmd) {
 550         case MCE_CMD_NULL:
 551                 if (subcmd == MCE_CMD_NULL)
 552                         break;
 553                 if ((subcmd == MCE_CMD_PORT_SYS) &&
 554                     (data1 == MCE_CMD_RESUME))
 555                         dev_info(dev, "Device resume requested\n");
 556                 else
 557                         dev_info(dev, "Unknown command 0x%02x 0x%02x\n",
 558                                  cmd, subcmd);
 559                 break;
 560         case MCE_CMD_PORT_SYS:
 561                 switch (subcmd) {
 562                 case MCE_RSP_EQEMVER:
 563                         if (!out)
 564                                 dev_info(dev, "Emulator interface version %x\n",
 565                                          data1);
 566                         break;
 567                 case MCE_CMD_G_REVISION:
 568                         if (len == 2)
 569                                 dev_info(dev, "Get hw/sw rev?\n");
 570                         else
 571                                 dev_info(dev, "hw/sw rev 0x%02x 0x%02x "
 572                                          "0x%02x 0x%02x\n", data1, data2,
 573                                          buf[start + 4], buf[start + 5]);
 574                         break;
 575                 case MCE_CMD_RESUME:
 576                         dev_info(dev, "Device resume requested\n");
 577                         break;
 578                 case MCE_RSP_CMD_ILLEGAL:
 579                         dev_info(dev, "Illegal PORT_SYS command\n");
 580                         break;
 581                 case MCE_RSP_EQWAKEVERSION:
 582                         if (!out)
 583                                 dev_info(dev, "Wake version, proto: 0x%02x, "
 584                                          "payload: 0x%02x, address: 0x%02x, "
 585                                          "version: 0x%02x\n",
 586                                          data1, data2, data3, data4);
 587                         break;
 588                 case MCE_RSP_GETPORTSTATUS:
 589                         if (!out)
 590                                 /* We use data1 + 1 here, to match hw labels */
 591                                 dev_info(dev, "TX port %d: blaster is%s connected\n",
 592                                          data1 + 1, data4 ? " not" : "");
 593                         break;
 594                 default:
 595                         dev_info(dev, "Unknown command 0x%02x 0x%02x\n",
 596                                  cmd, subcmd);
 597                         break;
 598                 }
 599                 break;
 600         case MCE_CMD_PORT_IR:
 601                 switch (subcmd) {
 602                 case MCE_CMD_SIG_END:
 603                         dev_info(dev, "End of signal\n");
 604                         break;
 605                 case MCE_CMD_PING:
 606                         dev_info(dev, "Ping\n");
 607                         break;
 608                 case MCE_CMD_UNKNOWN:
 609                         dev_info(dev, "Resp to 9f 05 of 0x%02x 0x%02x\n",
 610                                  data1, data2);
 611                         break;
 612                 case MCE_CMD_SETIRCFS:
 613                         dev_info(dev, "%s carrier mode and freq of "
 614                                  "0x%02x 0x%02x\n", inout, data1, data2);
 615                         break;
 616                 case MCE_CMD_GETIRCFS:
 617                         dev_info(dev, "Get carrier mode and freq\n");
 618                         break;
 619                 case MCE_RSP_EQIRTXPORTS:
 620                         dev_info(dev, "%s transmit blaster mask of 0x%02x\n",
 621                                  inout, data1);
 622                         break;
 623                 case MCE_RSP_EQIRTIMEOUT:
 624                         /* value is in units of 50us, so x*50/1000 ms */
 625                         dev_info(dev, "%s receive timeout of %d ms\n",
 626                                  inout,
 627                                  ((data1 << 8) | data2) * MCE_TIME_UNIT / 1000);
 628                         break;
 629                 case MCE_CMD_GETIRTIMEOUT:
 630                         dev_info(dev, "Get receive timeout\n");
 631                         break;
 632                 case MCE_CMD_GETIRTXPORTS:
 633                         dev_info(dev, "Get transmit blaster mask\n");
 634                         break;
 635                 case MCE_RSP_EQIRRXPORTEN:
 636                         dev_info(dev, "%s %s-range receive sensor in use\n",
 637                                  inout, data1 == 0x02 ? "short" : "long");
 638                         break;
 639                 case MCE_CMD_GETIRRXPORTEN:
 640                 /* aka MCE_RSP_EQIRRXCFCNT */
 641                         if (out)
 642                                 dev_info(dev, "Get receive sensor\n");
 643                         else if (ir->learning_enabled)
 644                                 dev_info(dev, "RX pulse count: %d\n",
 645                                          ((data1 << 8) | data2));
 646                         break;
 647                 case MCE_RSP_EQIRNUMPORTS:
 648                         if (out)
 649                                 break;
 650                         dev_info(dev, "Num TX ports: %x, num RX ports: %x\n",
 651                                  data1, data2);
 652                         break;
 653                 case MCE_RSP_CMD_ILLEGAL:
 654                         dev_info(dev, "Illegal PORT_IR command\n");
 655                         break;
 656                 default:
 657                         dev_info(dev, "Unknown command 0x%02x 0x%02x\n",
 658                                  cmd, subcmd);
 659                         break;
 660                 }
 661                 break;
 662         default:
 663                 break;
 664         }
 665
 666         if (cmd == MCE_IRDATA_TRAILER)
 667                 dev_info(dev, "End of raw IR data\n");
 668         else if ((cmd != MCE_CMD_PORT_IR) &&
 669                  ((cmd & MCE_PORT_MASK) == MCE_COMMAND_IRDATA))
 670                 dev_info(dev, "Raw IR data, %d pulse/space samples\n", ir->rem);
 671 }
 672
 673 static void mce_async_callback(struct urb *urb, struct pt_regs *regs)
 674 {
 675         struct mceusb_dev *ir;
 676         int len;
 677
 678         if (!urb)
 679                 return;
 680
 681         ir = urb->context;
 682         if (ir) {
 683                 len = urb->actual_length;
 684
 685                 mceusb_dev_printdata(ir, urb->transfer_buffer, 0, len, true);
 686         }
 687
 688         /* the transfer buffer and urb were allocated in mce_request_packet */
 689         kfree(urb->transfer_buffer);
 690         usb_free_urb(urb);
 691 }
 692
 693 /* request incoming or send outgoing usb packet - used to initialize remote */
 694 static void mce_request_packet(struct mceusb_dev *ir, unsigned char *data,
 695                                int size, int urb_type)
 696 {
 697         int res, pipe;
 698         struct urb *async_urb;
 699         struct device *dev = ir->dev;
 700         unsigned char *async_buf;
 701
 702         if (urb_type == MCEUSB_TX) {
 703                 async_urb = usb_alloc_urb(0, GFP_KERNEL);
 704                 if (unlikely(!async_urb)) {
 705                         dev_err(dev, "Error, couldn't allocate urb!\n");
 706                         return;
 707                 }
 708
 709                 async_buf = kzalloc(size, GFP_KERNEL);
 710                 if (!async_buf) {
 711                         dev_err(dev, "Error, couldn't allocate buf!\n");
 712                         usb_free_urb(async_urb);
 713                         return;
 714                 }
 715
 716                 /* outbound data */
 717                 pipe = usb_sndintpipe(ir->usbdev,
 718                                       ir->usb_ep_out->bEndpointAddress);
 719                 usb_fill_int_urb(async_urb, ir->usbdev, pipe,
 720                         async_buf, size, (usb_complete_t)mce_async_callback,
 721                         ir, ir->usb_ep_out->bInterval);
 722                 memcpy(async_buf, data, size);
 723
 724         } else if (urb_type == MCEUSB_RX) {
 725                 /* standard request */
 726                 async_urb = ir->urb_in;
 727                 ir->send_flags = RECV_FLAG_IN_PROGRESS;
 728
 729         } else {
 730                 dev_err(dev, "Error! Unknown urb type %d\n", urb_type);
 731                 return;
 732         }
 733
 734         mce_dbg(dev, "receive request called (size=%#x)\n", size);
 735
 736         async_urb->transfer_buffer_length = size;
 737         async_urb->dev = ir->usbdev;
 738
 739         res = usb_submit_urb(async_urb, GFP_ATOMIC);
 740         if (res) {
 741                 mce_dbg(dev, "receive request FAILED! (res=%d)\n", res);
 742                 return;
 743         }
 744         mce_dbg(dev, "receive request complete (res=%d)\n", res);
 745 }
 746
 747 static void mce_async_out(struct mceusb_dev *ir, unsigned char *data, int size)
 748 {
 749         int rsize = sizeof(DEVICE_RESUME);
 750
 751         if (ir->need_reset) {
 752                 ir->need_reset = false;
 753                 mce_request_packet(ir, DEVICE_RESUME, rsize, MCEUSB_TX);
 754                 msleep(10);
 755         }
 756
 757         mce_request_packet(ir, data, size, MCEUSB_TX);
 758         msleep(10);
 759 }
 760
 761 static void mce_flush_rx_buffer(struct mceusb_dev *ir, int size)
 762 {
 763         mce_request_packet(ir, NULL, size, MCEUSB_RX);
 764 }
 765
 766 /* Send data out the IR blaster port(s) */
 767 static int mceusb_tx_ir(struct rc_dev *dev, unsigned *txbuf, unsigned count)
 768 {
 769         struct mceusb_dev *ir = dev->priv;
 770         int i, ret = 0;
 771         int cmdcount = 0;
 772         unsigned char *cmdbuf; /* MCE command buffer */
 773         long signal_duration = 0; /* Singnal length in us */
 774         struct timeval start_time, end_time;
 775
 776         do_gettimeofday(&start_time);
 777
 778         cmdbuf = kzalloc(sizeof(unsigned) * MCE_CMDBUF_SIZE, GFP_KERNEL);
 779         if (!cmdbuf)
 780                 return -ENOMEM;
 781
 782         /* MCE tx init header */
 783         cmdbuf[cmdcount++] = MCE_CMD_PORT_IR;
 784         cmdbuf[cmdcount++] = MCE_CMD_SETIRTXPORTS;
 785         cmdbuf[cmdcount++] = ir->tx_mask;
 786
 787         /* Generate mce packet data */
 788         for (i = 0; (i < count) && (cmdcount < MCE_CMDBUF_SIZE); i++) {
 789                 signal_duration += txbuf[i];
 790                 txbuf[i] = txbuf[i] / MCE_TIME_UNIT;
 791
 792                 do { /* loop to support long pulses/spaces > 127*50us=6.35ms */
 793
 794                         /* Insert mce packet header every 4th entry */
 795                         if ((cmdcount < MCE_CMDBUF_SIZE) &&
 796                             (cmdcount - MCE_TX_HEADER_LENGTH) %
 797                              MCE_CODE_LENGTH == 0)
 798                                 cmdbuf[cmdcount++] = MCE_IRDATA_HEADER;
 799
 800                         /* Insert mce packet data */
 801                         if (cmdcount < MCE_CMDBUF_SIZE)
 802                                 cmdbuf[cmdcount++] =
 803                                         (txbuf[i] < MCE_PULSE_BIT ?
 804                                          txbuf[i] : MCE_MAX_PULSE_LENGTH) |
 805                                          (i & 1 ? 0x00 : MCE_PULSE_BIT);
 806                         else {
 807                                 ret = -EINVAL;
 808                                 goto out;
 809                         }
 810
 811                 } while ((txbuf[i] > MCE_MAX_PULSE_LENGTH) &&
 812                          (txbuf[i] -= MCE_MAX_PULSE_LENGTH));
 813         }
 814
 815         /* Fix packet length in last header */
 816         cmdbuf[cmdcount - (cmdcount - MCE_TX_HEADER_LENGTH) % MCE_CODE_LENGTH] =
 817                 MCE_COMMAND_IRDATA + (cmdcount - MCE_TX_HEADER_LENGTH) %
 818                 MCE_CODE_LENGTH - 1;
 819
 820         /* Check if we have room for the empty packet at the end */
 821         if (cmdcount >= MCE_CMDBUF_SIZE) {
 822                 ret = -EINVAL;
 823                 goto out;
 824         }
 825
 826         /* All mce commands end with an empty packet (0x80) */
 827         cmdbuf[cmdcount++] = MCE_IRDATA_TRAILER;
 828
 829         /* Transmit the command to the mce device */
 830         mce_async_out(ir, cmdbuf, cmdcount);
 831
 832         /*
 833          * The lircd gap calculation expects the write function to
 834          * wait the time it takes for the ircommand to be sent before
 835          * it returns.
 836          */
 837         do_gettimeofday(&end_time);
 838         signal_duration -= (end_time.tv_usec - start_time.tv_usec) +
 839                            (end_time.tv_sec - start_time.tv_sec) * 1000000;
 840
 841         /* delay with the closest number of ticks */
 842         set_current_state(TASK_INTERRUPTIBLE);
 843         schedule_timeout(usecs_to_jiffies(signal_duration));
 844
 845 out:
 846         kfree(cmdbuf);
 847         return ret ? ret : count;
 848 }
 849
 850 /* Sets active IR outputs -- mce devices typically have two */
 851 static int mceusb_set_tx_mask(struct rc_dev *dev, u32 mask)
 852 {
 853         struct mceusb_dev *ir = dev->priv;
 854
 855         if (ir->flags.tx_mask_normal)
 856                 ir->tx_mask = mask;
 857         else
 858                 ir->tx_mask = (mask != MCE_DEFAULT_TX_MASK ?
 859                                 mask ^ MCE_DEFAULT_TX_MASK : mask) << 1;
 860
 861         return 0;
 862 }
 863
 864 /* Sets the send carrier frequency and mode */
 865 static int mceusb_set_tx_carrier(struct rc_dev *dev, u32 carrier)
 866 {
 867         struct mceusb_dev *ir = dev->priv;
 868         int clk = 10000000;
 869         int prescaler = 0, divisor = 0;
 870         unsigned char cmdbuf[4] = { MCE_CMD_PORT_IR,
 871                                     MCE_CMD_SETIRCFS, 0x00, 0x00 };
 872
 873         /* Carrier has changed */
 874         if (ir->carrier != carrier) {
 875
 876                 if (carrier == 0) {
 877                         ir->carrier = carrier;
 878                         cmdbuf[2] = MCE_CMD_SIG_END;
 879                         cmdbuf[3] = MCE_IRDATA_TRAILER;
 880                         mce_dbg(ir->dev, "%s: disabling carrier "
 881                                 "modulation\n", __func__);
 882                         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
 883                         return carrier;
 884                 }
 885
 886                 for (prescaler = 0; prescaler < 4; ++prescaler) {
 887                         divisor = (clk >> (2 * prescaler)) / carrier;
 888                         if (divisor <= 0xff) {
 889                                 ir->carrier = carrier;
 890                                 cmdbuf[2] = prescaler;
 891                                 cmdbuf[3] = divisor;
 892                                 mce_dbg(ir->dev, "%s: requesting %u HZ "
 893                                         "carrier\n", __func__, carrier);
 894
 895                                 /* Transmit new carrier to mce device */
 896                                 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
 897                                 return carrier;
 898                         }
 899                 }
 900
 901                 return -EINVAL;
 902
 903         }
 904
 905         return carrier;
 906 }
 907
 908 /*
 909  * We don't do anything but print debug spew for many of the command bits
 910  * we receive from the hardware, but some of them are useful information
 911  * we want to store so that we can use them.
 912  */
 913 static void mceusb_handle_command(struct mceusb_dev *ir, int index)
 914 {
 915         u8 hi = ir->buf_in[index + 1] & 0xff;
 916         u8 lo = ir->buf_in[index + 2] & 0xff;
 917
 918         switch (ir->buf_in[index]) {
 919         /* the one and only 5-byte return value command */
 920         case MCE_RSP_GETPORTSTATUS:
 921                 if ((ir->buf_in[index + 4] & 0xff) == 0x00)
 922                         ir->txports_cabled |= 1 << hi;
 923                 break;
 924
 925         /* 2-byte return value commands */
 926         case MCE_RSP_EQIRTIMEOUT:
 927                 ir->rc->timeout = US_TO_NS((hi << 8 | lo) * MCE_TIME_UNIT);
 928                 break;
 929         case MCE_RSP_EQIRNUMPORTS:
 930                 ir->num_txports = hi;
 931                 ir->num_rxports = lo;
 932                 break;
 933
 934         /* 1-byte return value commands */
 935         case MCE_RSP_EQEMVER:
 936                 ir->emver = hi;
 937                 break;
 938         case MCE_RSP_EQIRTXPORTS:
 939                 ir->tx_mask = hi;
 940                 break;
 941         case MCE_RSP_EQIRRXPORTEN:
 942                 ir->learning_enabled = ((hi & 0x02) == 0x02);
 943                 ir->rxports_active = hi;
 944                 break;
 945         case MCE_RSP_CMD_ILLEGAL:
 946                 ir->need_reset = true;
 947                 break;
 948         default:
 949                 break;
 950         }
 951 }
 952
 953 static void mceusb_process_ir_data(struct mceusb_dev *ir, int buf_len)
 954 {
 955         DEFINE_IR_RAW_EVENT(rawir);
 956         int i = 0;
 957
 958         /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
 959         if (ir->flags.microsoft_gen1)
 960                 i = 2;
 961
 962         /* if there's no data, just return now */
 963         if (buf_len <= i)
 964                 return;
 965
 966         for (; i < buf_len; i++) {
 967                 switch (ir->parser_state) {
 968                 case SUBCMD:
 969                         ir->rem = mceusb_cmdsize(ir->cmd, ir->buf_in[i]);
 970                         mceusb_dev_printdata(ir, ir->buf_in, i - 1,
 971                                              ir->rem + 2, false);
 972                         mceusb_handle_command(ir, i);
 973                         ir->parser_state = CMD_DATA;
 974                         break;
 975                 case PARSE_IRDATA:
 976                         ir->rem--;
 977                         init_ir_raw_event(&rawir);
 978                         rawir.pulse = ((ir->buf_in[i] & MCE_PULSE_BIT) != 0);
 979                         rawir.duration = (ir->buf_in[i] & MCE_PULSE_MASK)
 980                                          * US_TO_NS(MCE_TIME_UNIT);
 981
 982                         mce_dbg(ir->dev, "Storing %s with duration %d\n",
 983                                 rawir.pulse ? "pulse" : "space",
 984                                 rawir.duration);
 985
 986                         ir_raw_event_store_with_filter(ir->rc, &rawir);
 987                         break;
 988                 case CMD_DATA:
 989                         ir->rem--;
 990                         break;
 991                 case CMD_HEADER:
 992                         /* decode mce packets of the form (84),AA,BB,CC,DD */
 993                         /* IR data packets can span USB messages - rem */
 994                         ir->cmd = ir->buf_in[i];
 995                         if ((ir->cmd == MCE_CMD_PORT_IR) ||
 996                             ((ir->cmd & MCE_PORT_MASK) !=
 997                              MCE_COMMAND_IRDATA)) {
 998                                 ir->parser_state = SUBCMD;
 999                                 continue;
1000                         }
1001                         ir->rem = (ir->cmd & MCE_PACKET_LENGTH_MASK);
1002                         mceusb_dev_printdata(ir, ir->buf_in,
1003                                              i, ir->rem + 1, false);
1004                         if (ir->rem)
1005                                 ir->parser_state = PARSE_IRDATA;
1006                         else
1007                                 ir_raw_event_reset(ir->rc);
1008                         break;
1009                 }
1010
1011                 if (ir->parser_state != CMD_HEADER && !ir->rem)
1012                         ir->parser_state = CMD_HEADER;
1013         }
1014         mce_dbg(ir->dev, "processed IR data, calling ir_raw_event_handle\n");
1015         ir_raw_event_handle(ir->rc);
1016 }
1017
1018 static void mceusb_dev_recv(struct urb *urb, struct pt_regs *regs)
1019 {
1020         struct mceusb_dev *ir;
1021         int buf_len;
1022
1023         if (!urb)
1024                 return;
1025
1026         ir = urb->context;
1027         if (!ir) {
1028                 usb_unlink_urb(urb);
1029                 return;
1030         }
1031
1032         buf_len = urb->actual_length;
1033
1034         if (ir->send_flags == RECV_FLAG_IN_PROGRESS) {
1035                 ir->send_flags = SEND_FLAG_COMPLETE;
1036                 mce_dbg(ir->dev, "setup answer received %d bytes\n",
1037                         buf_len);
1038         }
1039
1040         switch (urb->status) {
1041         /* success */
1042         case 0:
1043                 mceusb_process_ir_data(ir, buf_len);
1044                 break;
1045
1046         case -ECONNRESET:
1047         case -ENOENT:
1048         case -ESHUTDOWN:
1049                 usb_unlink_urb(urb);
1050                 return;
1051
1052         case -EPIPE:
1053         default:
1054                 mce_dbg(ir->dev, "Error: urb status = %d\n", urb->status);
1055                 break;
1056         }
1057
1058         usb_submit_urb(urb, GFP_ATOMIC);
1059 }
1060
1061 static void mceusb_get_emulator_version(struct mceusb_dev *ir)
1062 {
1063         /* If we get no reply or an illegal command reply, its ver 1, says MS */
1064         ir->emver = 1;
1065         mce_async_out(ir, GET_EMVER, sizeof(GET_EMVER));
1066 }
1067
1068 static void mceusb_gen1_init(struct mceusb_dev *ir)
1069 {
1070         int ret;
1071         struct device *dev = ir->dev;
1072         char *data;
1073
1074         data = kzalloc(USB_CTRL_MSG_SZ, GFP_KERNEL);
1075         if (!data) {
1076                 dev_err(dev, "%s: memory allocation failed!\n", __func__);
1077                 return;
1078         }
1079
1080         /*
1081          * This is a strange one. Windows issues a set address to the device
1082          * on the receive control pipe and expect a certain value pair back
1083          */
1084         ret = usb_control_msg(ir->usbdev, usb_rcvctrlpipe(ir->usbdev, 0),
1085                               USB_REQ_SET_ADDRESS, USB_TYPE_VENDOR, 0, 0,
1086                               data, USB_CTRL_MSG_SZ, HZ * 3);
1087         mce_dbg(dev, "%s - ret = %d\n", __func__, ret);
1088         mce_dbg(dev, "%s - data[0] = %d, data[1] = %d\n",
1089                 __func__, data[0], data[1]);
1090
1091         /* set feature: bit rate 38400 bps */
1092         ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1093                               USB_REQ_SET_FEATURE, USB_TYPE_VENDOR,
1094                               0xc04e, 0x0000, NULL, 0, HZ * 3);
1095
1096         mce_dbg(dev, "%s - ret = %d\n", __func__, ret);
1097
1098         /* bRequest 4: set char length to 8 bits */
1099         ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1100                               4, USB_TYPE_VENDOR,
1101                               0x0808, 0x0000, NULL, 0, HZ * 3);
1102         mce_dbg(dev, "%s - retB = %d\n", __func__, ret);
1103
1104         /* bRequest 2: set handshaking to use DTR/DSR */
1105         ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1106                               2, USB_TYPE_VENDOR,
1107                               0x0000, 0x0100, NULL, 0, HZ * 3);
1108         mce_dbg(dev, "%s - retC = %d\n", __func__, ret);
1109
1110         /* device resume */
1111         mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
1112
1113         /* get hw/sw revision? */
1114         mce_async_out(ir, GET_REVISION, sizeof(GET_REVISION));
1115
1116         kfree(data);
1117 };
1118
1119 static void mceusb_gen2_init(struct mceusb_dev *ir)
1120 {
1121         /* device resume */
1122         mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
1123
1124         /* get hw/sw revision? */
1125         mce_async_out(ir, GET_REVISION, sizeof(GET_REVISION));
1126
1127         /* get wake version (protocol, key, address) */
1128         mce_async_out(ir, GET_WAKEVERSION, sizeof(GET_WAKEVERSION));
1129
1130         /* unknown what this one actually returns... */
1131         mce_async_out(ir, GET_UNKNOWN2, sizeof(GET_UNKNOWN2));
1132 }
1133
1134 static void mceusb_get_parameters(struct mceusb_dev *ir)
1135 {
1136         int i;
1137         unsigned char cmdbuf[3] = { MCE_CMD_PORT_SYS,
1138                                     MCE_CMD_GETPORTSTATUS, 0x00 };
1139
1140         /* defaults, if the hardware doesn't support querying */
1141         ir->num_txports = 2;
1142         ir->num_rxports = 2;
1143
1144         /* get number of tx and rx ports */
1145         mce_async_out(ir, GET_NUM_PORTS, sizeof(GET_NUM_PORTS));
1146
1147         /* get the carrier and frequency */
1148         mce_async_out(ir, GET_CARRIER_FREQ, sizeof(GET_CARRIER_FREQ));
1149
1150         if (ir->num_txports && !ir->flags.no_tx)
1151                 /* get the transmitter bitmask */
1152                 mce_async_out(ir, GET_TX_BITMASK, sizeof(GET_TX_BITMASK));
1153
1154         /* get receiver timeout value */
1155         mce_async_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT));
1156
1157         /* get receiver sensor setting */
1158         mce_async_out(ir, GET_RX_SENSOR, sizeof(GET_RX_SENSOR));
1159
1160         for (i = 0; i < ir->num_txports; i++) {
1161                 cmdbuf[2] = i;
1162                 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1163         }
1164 }
1165
1166 static struct rc_dev *mceusb_init_rc_dev(struct mceusb_dev *ir)
1167 {
1168         struct device *dev = ir->dev;
1169         struct rc_dev *rc;
1170         int ret;
1171
1172         rc = rc_allocate_device();
1173         if (!rc) {
1174                 dev_err(dev, "remote dev allocation failed\n");
1175                 goto out;
1176         }
1177
1178         snprintf(ir->name, sizeof(ir->name), "%s (%04x:%04x)",
1179                  mceusb_model[ir->model].name ?
1180                         mceusb_model[ir->model].name :
1181                         "Media Center Ed. eHome Infrared Remote Transceiver",
1182                  le16_to_cpu(ir->usbdev->descriptor.idVendor),
1183                  le16_to_cpu(ir->usbdev->descriptor.idProduct));
1184
1185         usb_make_path(ir->usbdev, ir->phys, sizeof(ir->phys));
1186
1187         rc->input_name = ir->name;
1188         rc->input_phys = ir->phys;
1189         usb_to_input_id(ir->usbdev, &rc->input_id);
1190         rc->dev.parent = dev;
1191         rc->priv = ir;
1192         rc->driver_type = RC_DRIVER_IR_RAW;
1193         rc->allowed_protos = RC_TYPE_ALL;
1194         rc->timeout = MS_TO_NS(100);
1195         if (!ir->flags.no_tx) {
1196                 rc->s_tx_mask = mceusb_set_tx_mask;
1197                 rc->s_tx_carrier = mceusb_set_tx_carrier;
1198                 rc->tx_ir = mceusb_tx_ir;
1199         }
1200         rc->driver_name = DRIVER_NAME;
1201         rc->map_name = mceusb_model[ir->model].rc_map ?
1202                         mceusb_model[ir->model].rc_map : RC_MAP_RC6_MCE;
1203
1204         ret = rc_register_device(rc);
1205         if (ret < 0) {
1206                 dev_err(dev, "remote dev registration failed\n");
1207                 goto out;
1208         }
1209
1210         return rc;
1211
1212 out:
1213         rc_free_device(rc);
1214         return NULL;
1215 }
1216
1217 static int __devinit mceusb_dev_probe(struct usb_interface *intf,
1218                                       const struct usb_device_id *id)
1219 {
1220         struct usb_device *dev = interface_to_usbdev(intf);
1221         struct usb_host_interface *idesc;
1222         struct usb_endpoint_descriptor *ep = NULL;
1223         struct usb_endpoint_descriptor *ep_in = NULL;
1224         struct usb_endpoint_descriptor *ep_out = NULL;
1225         struct mceusb_dev *ir = NULL;
1226         int pipe, maxp, i;
1227         char buf[63], name[128] = "";
1228         enum mceusb_model_type model = id->driver_info;
1229         bool is_gen3;
1230         bool is_microsoft_gen1;
1231         bool tx_mask_normal;
1232         int ir_intfnum;
1233
1234         mce_dbg(&intf->dev, "%s called\n", __func__);
1235
1236         idesc  = intf->cur_altsetting;
1237
1238         is_gen3 = mceusb_model[model].mce_gen3;
1239         is_microsoft_gen1 = mceusb_model[model].mce_gen1;
1240         tx_mask_normal = mceusb_model[model].tx_mask_normal;
1241         ir_intfnum = mceusb_model[model].ir_intfnum;
1242
1243         /* There are multi-function devices with non-IR interfaces */
1244         if (idesc->desc.bInterfaceNumber != ir_intfnum)
1245                 return -ENODEV;
1246
1247         /* step through the endpoints to find first bulk in and out endpoint */
1248         for (i = 0; i < idesc->desc.bNumEndpoints; ++i) {
1249                 ep = &idesc->endpoint[i].desc;
1250
1251                 if ((ep_in == NULL)
1252                         && ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
1253                             == USB_DIR_IN)
1254                         && (((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1255                             == USB_ENDPOINT_XFER_BULK)
1256                         || ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1257                             == USB_ENDPOINT_XFER_INT))) {
1258
1259                         ep_in = ep;
1260                         ep_in->bmAttributes = USB_ENDPOINT_XFER_INT;
1261                         ep_in->bInterval = 1;
1262                         mce_dbg(&intf->dev, "acceptable inbound endpoint "
1263                                 "found\n");
1264                 }
1265
1266                 if ((ep_out == NULL)
1267                         && ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
1268                             == USB_DIR_OUT)
1269                         && (((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1270                             == USB_ENDPOINT_XFER_BULK)
1271                         || ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1272                             == USB_ENDPOINT_XFER_INT))) {
1273
1274                         ep_out = ep;
1275                         ep_out->bmAttributes = USB_ENDPOINT_XFER_INT;
1276                         ep_out->bInterval = 1;
1277                         mce_dbg(&intf->dev, "acceptable outbound endpoint "
1278                                 "found\n");
1279                 }
1280         }
1281         if (ep_in == NULL) {
1282                 mce_dbg(&intf->dev, "inbound and/or endpoint not found\n");
1283                 return -ENODEV;
1284         }
1285
1286         pipe = usb_rcvintpipe(dev, ep_in->bEndpointAddress);
1287         maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
1288
1289         ir = kzalloc(sizeof(struct mceusb_dev), GFP_KERNEL);
1290         if (!ir)
1291                 goto mem_alloc_fail;
1292
1293         ir->buf_in = usb_alloc_coherent(dev, maxp, GFP_ATOMIC, &ir->dma_in);
1294         if (!ir->buf_in)
1295                 goto buf_in_alloc_fail;
1296
1297         ir->urb_in = usb_alloc_urb(0, GFP_KERNEL);
1298         if (!ir->urb_in)
1299                 goto urb_in_alloc_fail;
1300
1301         ir->usbdev = dev;
1302         ir->dev = &intf->dev;
1303         ir->len_in = maxp;
1304         ir->flags.microsoft_gen1 = is_microsoft_gen1;
1305         ir->flags.tx_mask_normal = tx_mask_normal;
1306         ir->flags.no_tx = mceusb_model[model].no_tx;
1307         ir->model = model;
1308
1309         /* Saving usb interface data for use by the transmitter routine */
1310         ir->usb_ep_in = ep_in;
1311         ir->usb_ep_out = ep_out;
1312
1313         if (dev->descriptor.iManufacturer
1314             && usb_string(dev, dev->descriptor.iManufacturer,
1315                           buf, sizeof(buf)) > 0)
1316                 strlcpy(name, buf, sizeof(name));
1317         if (dev->descriptor.iProduct
1318             && usb_string(dev, dev->descriptor.iProduct,
1319                           buf, sizeof(buf)) > 0)
1320                 snprintf(name + strlen(name), sizeof(name) - strlen(name),
1321                          " %s", buf);
1322
1323         ir->rc = mceusb_init_rc_dev(ir);
1324         if (!ir->rc)
1325                 goto rc_dev_fail;
1326
1327         /* wire up inbound data handler */
1328         usb_fill_int_urb(ir->urb_in, dev, pipe, ir->buf_in,
1329                 maxp, (usb_complete_t) mceusb_dev_recv, ir, ep_in->bInterval);
1330         ir->urb_in->transfer_dma = ir->dma_in;
1331         ir->urb_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1332
1333         /* flush buffers on the device */
1334         mce_dbg(&intf->dev, "Flushing receive buffers\n");
1335         mce_flush_rx_buffer(ir, maxp);
1336
1337         /* figure out which firmware/emulator version this hardware has */
1338         mceusb_get_emulator_version(ir);
1339
1340         /* initialize device */
1341         if (ir->flags.microsoft_gen1)
1342                 mceusb_gen1_init(ir);
1343         else if (!is_gen3)
1344                 mceusb_gen2_init(ir);
1345
1346         mceusb_get_parameters(ir);
1347
1348         if (!ir->flags.no_tx)
1349                 mceusb_set_tx_mask(ir->rc, MCE_DEFAULT_TX_MASK);
1350
1351         usb_set_intfdata(intf, ir);
1352
1353         /* enable wake via this device */
1354         device_set_wakeup_capable(ir->dev, true);
1355         device_set_wakeup_enable(ir->dev, true);
1356
1357         dev_info(&intf->dev, "Registered %s with mce emulator interface "
1358                  "version %x\n", name, ir->emver);
1359         dev_info(&intf->dev, "%x tx ports (0x%x cabled) and "
1360                  "%x rx sensors (0x%x active)\n",
1361                  ir->num_txports, ir->txports_cabled,
1362                  ir->num_rxports, ir->rxports_active);
1363
1364         return 0;
1365
1366         /* Error-handling path */
1367 rc_dev_fail:
1368         usb_free_urb(ir->urb_in);
1369 urb_in_alloc_fail:
1370         usb_free_coherent(dev, maxp, ir->buf_in, ir->dma_in);
1371 buf_in_alloc_fail:
1372         kfree(ir);
1373 mem_alloc_fail:
1374         dev_err(&intf->dev, "%s: device setup failed!\n", __func__);
1375
1376         return -ENOMEM;
1377 }
1378
1379
1380 static void __devexit mceusb_dev_disconnect(struct usb_interface *intf)
1381 {
1382         struct usb_device *dev = interface_to_usbdev(intf);
1383         struct mceusb_dev *ir = usb_get_intfdata(intf);
1384
1385         usb_set_intfdata(intf, NULL);
1386
1387         if (!ir)
1388                 return;
1389
1390         ir->usbdev = NULL;
1391         rc_unregister_device(ir->rc);
1392         usb_kill_urb(ir->urb_in);
1393         usb_free_urb(ir->urb_in);
1394         usb_free_coherent(dev, ir->len_in, ir->buf_in, ir->dma_in);
1395
1396         kfree(ir);
1397 }
1398
1399 static int mceusb_dev_suspend(struct usb_interface *intf, pm_message_t message)
1400 {
1401         struct mceusb_dev *ir = usb_get_intfdata(intf);
1402         dev_info(ir->dev, "suspend\n");
1403         usb_kill_urb(ir->urb_in);
1404         return 0;
1405 }
1406
1407 static int mceusb_dev_resume(struct usb_interface *intf)
1408 {
1409         struct mceusb_dev *ir = usb_get_intfdata(intf);
1410         dev_info(ir->dev, "resume\n");
1411         if (usb_submit_urb(ir->urb_in, GFP_ATOMIC))
1412                 return -EIO;
1413         return 0;
1414 }
1415
1416 static struct usb_driver mceusb_dev_driver = {
1417         .name =         DRIVER_NAME,
1418         .probe =        mceusb_dev_probe,
1419         .disconnect =   mceusb_dev_disconnect,
1420         .suspend =      mceusb_dev_suspend,
1421         .resume =       mceusb_dev_resume,
1422         .reset_resume = mceusb_dev_resume,
1423         .id_table =     mceusb_dev_table
1424 };
1425
1426 static int __init mceusb_dev_init(void)
1427 {
1428         int ret;
1429
1430         ret = usb_register(&mceusb_dev_driver);
1431         if (ret < 0)
1432                 printk(KERN_ERR DRIVER_NAME
1433                        ": usb register failed, result = %d\n", ret);
1434
1435         return ret;
1436 }
1437
1438 static void __exit mceusb_dev_exit(void)
1439 {
1440         usb_deregister(&mceusb_dev_driver);
1441 }
1442
1443 module_init(mceusb_dev_init);
1444 module_exit(mceusb_dev_exit);
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");