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