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