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