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