1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Driver for USB Windows Media Center Ed. eHome Infrared Transceivers 4 * 5 * Copyright (c) 2010-2011, Jarod Wilson <jarod@redhat.com> 6 * 7 * Based on the original lirc_mceusb and lirc_mceusb2 drivers, by Dan 8 * Conti, Martin Blatter and Daniel Melander, the latter of which was 9 * in turn also based on the lirc_atiusb driver by Paul Miller. The 10 * two mce drivers were merged into one by Jarod Wilson, with transmit 11 * support for the 1st-gen device added primarily by Patrick Calhoun, 12 * with a bit of tweaks by Jarod. Debugging improvements and proper 13 * support for what appears to be 3rd-gen hardware added by Jarod. 14 * Initial port from lirc driver to ir-core drivery by Jarod, based 15 * partially on a port to an earlier proposed IR infrastructure by 16 * Jon Smirl, which included enhancements and simplifications to the 17 * incoming IR buffer parsing routines. 18 * 19 * Updated in July of 2011 with the aid of Microsoft's official 20 * remote/transceiver requirements and specification document, found at 21 * download.microsoft.com, title 22 * Windows-Media-Center-RC-IR-Collection-Green-Button-Specification-03-08-2011-V2.pdf 23 */ 24 25 #include <linux/device.h> 26 #include <linux/module.h> 27 #include <linux/slab.h> 28 #include <linux/workqueue.h> 29 #include <linux/usb.h> 30 #include <linux/usb/input.h> 31 #include <media/rc-core.h> 32 33 #define DRIVER_VERSION "1.95" 34 #define DRIVER_AUTHOR "Jarod Wilson <jarod@redhat.com>" 35 #define DRIVER_DESC "Windows Media Center Ed. eHome Infrared Transceiver " \ 36 "device driver" 37 #define DRIVER_NAME "mceusb" 38 39 #define USB_TX_TIMEOUT 1000 /* in milliseconds */ 40 #define USB_CTRL_MSG_SZ 2 /* Size of usb ctrl msg on gen1 hw */ 41 #define MCE_G1_INIT_MSGS 40 /* Init messages on gen1 hw to throw out */ 42 43 /* MCE constants */ 44 #define MCE_IRBUF_SIZE 128 /* TX IR buffer length */ 45 #define MCE_TIME_UNIT 50 /* Approx 50us resolution */ 46 #define MCE_PACKET_SIZE 31 /* Max length of packet (with header) */ 47 #define MCE_IRDATA_HEADER (0x80 + MCE_PACKET_SIZE - 1) 48 /* Actual format is 0x80 + num_bytes */ 49 #define MCE_IRDATA_TRAILER 0x80 /* End of IR data */ 50 #define MCE_MAX_CHANNELS 2 /* Two transmitters, hardware dependent? */ 51 #define MCE_DEFAULT_TX_MASK 0x03 /* Vals: TX1=0x01, TX2=0x02, ALL=0x03 */ 52 #define MCE_PULSE_BIT 0x80 /* Pulse bit, MSB set == PULSE else SPACE */ 53 #define MCE_PULSE_MASK 0x7f /* Pulse mask */ 54 #define MCE_MAX_PULSE_LENGTH 0x7f /* Longest transmittable pulse symbol */ 55 56 /* 57 * The interface between the host and the IR hardware is command-response 58 * based. All commands and responses have a consistent format, where a lead 59 * byte always identifies the type of data following it. The lead byte has 60 * a port value in the 3 highest bits and a length value in the 5 lowest 61 * bits. 62 * 63 * The length field is overloaded, with a value of 11111 indicating that the 64 * following byte is a command or response code, and the length of the entire 65 * message is determined by the code. If the length field is not 11111, then 66 * it specifies the number of bytes of port data that follow. 67 */ 68 #define MCE_CMD 0x1f 69 #define MCE_PORT_IR 0x4 /* (0x4 << 5) | MCE_CMD = 0x9f */ 70 #define MCE_PORT_SYS 0x7 /* (0x7 << 5) | MCE_CMD = 0xff */ 71 #define MCE_PORT_SER 0x6 /* 0xc0 through 0xdf flush & 0x1f bytes */ 72 #define MCE_PORT_MASK 0xe0 /* Mask out command bits */ 73 74 /* Command port headers */ 75 #define MCE_CMD_PORT_IR 0x9f /* IR-related cmd/rsp */ 76 #define MCE_CMD_PORT_SYS 0xff /* System (non-IR) device cmd/rsp */ 77 78 /* Commands that set device state (2-4 bytes in length) */ 79 #define MCE_CMD_RESET 0xfe /* Reset device, 2 bytes */ 80 #define MCE_CMD_RESUME 0xaa /* Resume device after error, 2 bytes */ 81 #define MCE_CMD_SETIRCFS 0x06 /* Set tx carrier, 4 bytes */ 82 #define MCE_CMD_SETIRTIMEOUT 0x0c /* Set timeout, 4 bytes */ 83 #define MCE_CMD_SETIRTXPORTS 0x08 /* Set tx ports, 3 bytes */ 84 #define MCE_CMD_SETIRRXPORTEN 0x14 /* Set rx ports, 3 bytes */ 85 #define MCE_CMD_FLASHLED 0x23 /* Flash receiver LED, 2 bytes */ 86 87 /* Commands that query device state (all 2 bytes, unless noted) */ 88 #define MCE_CMD_GETIRCFS 0x07 /* Get carrier */ 89 #define MCE_CMD_GETIRTIMEOUT 0x0d /* Get timeout */ 90 #define MCE_CMD_GETIRTXPORTS 0x13 /* Get tx ports */ 91 #define MCE_CMD_GETIRRXPORTEN 0x15 /* Get rx ports */ 92 #define MCE_CMD_GETPORTSTATUS 0x11 /* Get tx port status, 3 bytes */ 93 #define MCE_CMD_GETIRNUMPORTS 0x16 /* Get number of ports */ 94 #define MCE_CMD_GETWAKESOURCE 0x17 /* Get wake source */ 95 #define MCE_CMD_GETEMVER 0x22 /* Get emulator interface version */ 96 #define MCE_CMD_GETDEVDETAILS 0x21 /* Get device details (em ver2 only) */ 97 #define MCE_CMD_GETWAKESUPPORT 0x20 /* Get wake details (em ver2 only) */ 98 #define MCE_CMD_GETWAKEVERSION 0x18 /* Get wake pattern (em ver2 only) */ 99 100 /* Misc commands */ 101 #define MCE_CMD_NOP 0xff /* No operation */ 102 103 /* Responses to commands (non-error cases) */ 104 #define MCE_RSP_EQIRCFS 0x06 /* tx carrier, 4 bytes */ 105 #define MCE_RSP_EQIRTIMEOUT 0x0c /* rx timeout, 4 bytes */ 106 #define MCE_RSP_GETWAKESOURCE 0x17 /* wake source, 3 bytes */ 107 #define MCE_RSP_EQIRTXPORTS 0x08 /* tx port mask, 3 bytes */ 108 #define MCE_RSP_EQIRRXPORTEN 0x14 /* rx port mask, 3 bytes */ 109 #define MCE_RSP_GETPORTSTATUS 0x11 /* tx port status, 7 bytes */ 110 #define MCE_RSP_EQIRRXCFCNT 0x15 /* rx carrier count, 4 bytes */ 111 #define MCE_RSP_EQIRNUMPORTS 0x16 /* number of ports, 4 bytes */ 112 #define MCE_RSP_EQWAKESUPPORT 0x20 /* wake capabilities, 3 bytes */ 113 #define MCE_RSP_EQWAKEVERSION 0x18 /* wake pattern details, 6 bytes */ 114 #define MCE_RSP_EQDEVDETAILS 0x21 /* device capabilities, 3 bytes */ 115 #define MCE_RSP_EQEMVER 0x22 /* emulator interface ver, 3 bytes */ 116 #define MCE_RSP_FLASHLED 0x23 /* success flashing LED, 2 bytes */ 117 118 /* Responses to error cases, must send MCE_CMD_RESUME to clear them */ 119 #define MCE_RSP_CMD_ILLEGAL 0xfe /* illegal command for port, 2 bytes */ 120 #define MCE_RSP_TX_TIMEOUT 0x81 /* tx timed out, 2 bytes */ 121 122 /* Misc commands/responses not defined in the MCE remote/transceiver spec */ 123 #define MCE_CMD_SIG_END 0x01 /* End of signal */ 124 #define MCE_CMD_PING 0x03 /* Ping device */ 125 #define MCE_CMD_UNKNOWN 0x04 /* Unknown */ 126 #define MCE_CMD_UNKNOWN2 0x05 /* Unknown */ 127 #define MCE_CMD_UNKNOWN3 0x09 /* Unknown */ 128 #define MCE_CMD_UNKNOWN4 0x0a /* Unknown */ 129 #define MCE_CMD_G_REVISION 0x0b /* Get hw/sw revision */ 130 #define MCE_CMD_UNKNOWN5 0x0e /* Unknown */ 131 #define MCE_CMD_UNKNOWN6 0x0f /* Unknown */ 132 #define MCE_CMD_UNKNOWN8 0x19 /* Unknown */ 133 #define MCE_CMD_UNKNOWN9 0x1b /* Unknown */ 134 #define MCE_CMD_NULL 0x00 /* These show up various places... */ 135 136 /* if buf[i] & MCE_PORT_MASK == 0x80 and buf[i] != MCE_CMD_PORT_IR, 137 * then we're looking at a raw IR data sample */ 138 #define MCE_COMMAND_IRDATA 0x80 139 #define MCE_PACKET_LENGTH_MASK 0x1f /* Packet length mask */ 140 141 #define VENDOR_PHILIPS 0x0471 142 #define VENDOR_SMK 0x0609 143 #define VENDOR_TATUNG 0x1460 144 #define VENDOR_GATEWAY 0x107b 145 #define VENDOR_SHUTTLE 0x1308 146 #define VENDOR_SHUTTLE2 0x051c 147 #define VENDOR_MITSUMI 0x03ee 148 #define VENDOR_TOPSEED 0x1784 149 #define VENDOR_RICAVISION 0x179d 150 #define VENDOR_ITRON 0x195d 151 #define VENDOR_FIC 0x1509 152 #define VENDOR_LG 0x043e 153 #define VENDOR_MICROSOFT 0x045e 154 #define VENDOR_FORMOSA 0x147a 155 #define VENDOR_FINTEK 0x1934 156 #define VENDOR_PINNACLE 0x2304 157 #define VENDOR_ECS 0x1019 158 #define VENDOR_WISTRON 0x0fb8 159 #define VENDOR_COMPRO 0x185b 160 #define VENDOR_NORTHSTAR 0x04eb 161 #define VENDOR_REALTEK 0x0bda 162 #define VENDOR_TIVO 0x105a 163 #define VENDOR_CONEXANT 0x0572 164 #define VENDOR_TWISTEDMELON 0x2596 165 #define VENDOR_HAUPPAUGE 0x2040 166 #define VENDOR_PCTV 0x2013 167 #define VENDOR_ADAPTEC 0x03f3 168 169 enum mceusb_model_type { 170 MCE_GEN2 = 0, /* Most boards */ 171 MCE_GEN1, 172 MCE_GEN3, 173 MCE_GEN3_BROKEN_IRTIMEOUT, 174 MCE_GEN2_TX_INV, 175 MCE_GEN2_TX_INV_RX_GOOD, 176 POLARIS_EVK, 177 CX_HYBRID_TV, 178 MULTIFUNCTION, 179 TIVO_KIT, 180 MCE_GEN2_NO_TX, 181 HAUPPAUGE_CX_HYBRID_TV, 182 EVROMEDIA_FULL_HYBRID_FULLHD, 183 ASTROMETA_T2HYBRID, 184 }; 185 186 struct mceusb_model { 187 u32 mce_gen1:1; 188 u32 mce_gen2:1; 189 u32 mce_gen3:1; 190 u32 tx_mask_normal:1; 191 u32 no_tx:1; 192 u32 broken_irtimeout:1; 193 /* 194 * 2nd IR receiver (short-range, wideband) for learning mode: 195 * 0, absent 2nd receiver (rx2) 196 * 1, rx2 present 197 * 2, rx2 which under counts IR carrier cycles 198 */ 199 u32 rx2; 200 201 int ir_intfnum; 202 203 const char *rc_map; /* Allow specify a per-board map */ 204 const char *name; /* per-board name */ 205 }; 206 207 static const struct mceusb_model mceusb_model[] = { 208 [MCE_GEN1] = { 209 .mce_gen1 = 1, 210 .tx_mask_normal = 1, 211 .rx2 = 2, 212 }, 213 [MCE_GEN2] = { 214 .mce_gen2 = 1, 215 .rx2 = 2, 216 }, 217 [MCE_GEN2_NO_TX] = { 218 .mce_gen2 = 1, 219 .no_tx = 1, 220 }, 221 [MCE_GEN2_TX_INV] = { 222 .mce_gen2 = 1, 223 .tx_mask_normal = 1, 224 .rx2 = 1, 225 }, 226 [MCE_GEN2_TX_INV_RX_GOOD] = { 227 .mce_gen2 = 1, 228 .tx_mask_normal = 1, 229 .rx2 = 2, 230 }, 231 [MCE_GEN3] = { 232 .mce_gen3 = 1, 233 .tx_mask_normal = 1, 234 .rx2 = 2, 235 }, 236 [MCE_GEN3_BROKEN_IRTIMEOUT] = { 237 .mce_gen3 = 1, 238 .tx_mask_normal = 1, 239 .rx2 = 2, 240 .broken_irtimeout = 1 241 }, 242 [POLARIS_EVK] = { 243 /* 244 * In fact, the EVK is shipped without 245 * remotes, but we should have something handy, 246 * to allow testing it 247 */ 248 .name = "Conexant Hybrid TV (cx231xx) MCE IR", 249 .rx2 = 2, 250 }, 251 [CX_HYBRID_TV] = { 252 .no_tx = 1, /* tx isn't wired up at all */ 253 .name = "Conexant Hybrid TV (cx231xx) MCE IR", 254 }, 255 [HAUPPAUGE_CX_HYBRID_TV] = { 256 .no_tx = 1, /* eeprom says it has no tx */ 257 .name = "Conexant Hybrid TV (cx231xx) MCE IR no TX", 258 }, 259 [MULTIFUNCTION] = { 260 .mce_gen2 = 1, 261 .ir_intfnum = 2, 262 .rx2 = 2, 263 }, 264 [TIVO_KIT] = { 265 .mce_gen2 = 1, 266 .rc_map = RC_MAP_TIVO, 267 .rx2 = 2, 268 }, 269 [EVROMEDIA_FULL_HYBRID_FULLHD] = { 270 .name = "Evromedia USB Full Hybrid Full HD", 271 .no_tx = 1, 272 .rc_map = RC_MAP_MSI_DIGIVOX_III, 273 }, 274 [ASTROMETA_T2HYBRID] = { 275 .name = "Astrometa T2Hybrid", 276 .no_tx = 1, 277 .rc_map = RC_MAP_ASTROMETA_T2HYBRID, 278 } 279 }; 280 281 static const struct usb_device_id mceusb_dev_table[] = { 282 /* Original Microsoft MCE IR Transceiver (often HP-branded) */ 283 { USB_DEVICE(VENDOR_MICROSOFT, 0x006d), 284 .driver_info = MCE_GEN1 }, 285 /* Philips Infrared Transceiver - Sahara branded */ 286 { USB_DEVICE(VENDOR_PHILIPS, 0x0608) }, 287 /* Philips Infrared Transceiver - HP branded */ 288 { USB_DEVICE(VENDOR_PHILIPS, 0x060c), 289 .driver_info = MCE_GEN2_TX_INV }, 290 /* Philips SRM5100 */ 291 { USB_DEVICE(VENDOR_PHILIPS, 0x060d) }, 292 /* Philips Infrared Transceiver - Omaura */ 293 { USB_DEVICE(VENDOR_PHILIPS, 0x060f) }, 294 /* Philips Infrared Transceiver - Spinel plus */ 295 { USB_DEVICE(VENDOR_PHILIPS, 0x0613) }, 296 /* Philips eHome Infrared Transceiver */ 297 { USB_DEVICE(VENDOR_PHILIPS, 0x0815) }, 298 /* Philips/Spinel plus IR transceiver for ASUS */ 299 { USB_DEVICE(VENDOR_PHILIPS, 0x206c) }, 300 /* Philips/Spinel plus IR transceiver for ASUS */ 301 { USB_DEVICE(VENDOR_PHILIPS, 0x2088) }, 302 /* Philips IR transceiver (Dell branded) */ 303 { USB_DEVICE(VENDOR_PHILIPS, 0x2093), 304 .driver_info = MCE_GEN2_TX_INV }, 305 /* Realtek MCE IR Receiver and card reader */ 306 { USB_DEVICE(VENDOR_REALTEK, 0x0161), 307 .driver_info = MULTIFUNCTION }, 308 /* SMK/Toshiba G83C0004D410 */ 309 { USB_DEVICE(VENDOR_SMK, 0x031d), 310 .driver_info = MCE_GEN2_TX_INV_RX_GOOD }, 311 /* SMK eHome Infrared Transceiver (Sony VAIO) */ 312 { USB_DEVICE(VENDOR_SMK, 0x0322), 313 .driver_info = MCE_GEN2_TX_INV }, 314 /* bundled with Hauppauge PVR-150 */ 315 { USB_DEVICE(VENDOR_SMK, 0x0334), 316 .driver_info = MCE_GEN2_TX_INV }, 317 /* SMK eHome Infrared Transceiver */ 318 { USB_DEVICE(VENDOR_SMK, 0x0338) }, 319 /* SMK/I-O Data GV-MC7/RCKIT Receiver */ 320 { USB_DEVICE(VENDOR_SMK, 0x0353), 321 .driver_info = MCE_GEN2_NO_TX }, 322 /* SMK RXX6000 Infrared Receiver */ 323 { USB_DEVICE(VENDOR_SMK, 0x0357), 324 .driver_info = MCE_GEN2_NO_TX }, 325 /* Tatung eHome Infrared Transceiver */ 326 { USB_DEVICE(VENDOR_TATUNG, 0x9150) }, 327 /* Shuttle eHome Infrared Transceiver */ 328 { USB_DEVICE(VENDOR_SHUTTLE, 0xc001) }, 329 /* Shuttle eHome Infrared Transceiver */ 330 { USB_DEVICE(VENDOR_SHUTTLE2, 0xc001) }, 331 /* Gateway eHome Infrared Transceiver */ 332 { USB_DEVICE(VENDOR_GATEWAY, 0x3009) }, 333 /* Mitsumi */ 334 { USB_DEVICE(VENDOR_MITSUMI, 0x2501) }, 335 /* Topseed eHome Infrared Transceiver */ 336 { USB_DEVICE(VENDOR_TOPSEED, 0x0001), 337 .driver_info = MCE_GEN2_TX_INV }, 338 /* Topseed HP eHome Infrared Transceiver */ 339 { USB_DEVICE(VENDOR_TOPSEED, 0x0006), 340 .driver_info = MCE_GEN2_TX_INV }, 341 /* Topseed eHome Infrared Transceiver */ 342 { USB_DEVICE(VENDOR_TOPSEED, 0x0007), 343 .driver_info = MCE_GEN2_TX_INV }, 344 /* Topseed eHome Infrared Transceiver */ 345 { USB_DEVICE(VENDOR_TOPSEED, 0x0008), 346 .driver_info = MCE_GEN3 }, 347 /* Topseed eHome Infrared Transceiver */ 348 { USB_DEVICE(VENDOR_TOPSEED, 0x000a), 349 .driver_info = MCE_GEN2_TX_INV }, 350 /* Topseed eHome Infrared Transceiver */ 351 { USB_DEVICE(VENDOR_TOPSEED, 0x0011), 352 .driver_info = MCE_GEN3_BROKEN_IRTIMEOUT }, 353 /* Ricavision internal Infrared Transceiver */ 354 { USB_DEVICE(VENDOR_RICAVISION, 0x0010) }, 355 /* Itron ione Libra Q-11 */ 356 { USB_DEVICE(VENDOR_ITRON, 0x7002) }, 357 /* FIC eHome Infrared Transceiver */ 358 { USB_DEVICE(VENDOR_FIC, 0x9242) }, 359 /* LG eHome Infrared Transceiver */ 360 { USB_DEVICE(VENDOR_LG, 0x9803) }, 361 /* Microsoft MCE Infrared Transceiver */ 362 { USB_DEVICE(VENDOR_MICROSOFT, 0x00a0) }, 363 /* Formosa eHome Infrared Transceiver */ 364 { USB_DEVICE(VENDOR_FORMOSA, 0xe015) }, 365 /* Formosa21 / eHome Infrared Receiver */ 366 { USB_DEVICE(VENDOR_FORMOSA, 0xe016) }, 367 /* Formosa aim / Trust MCE Infrared Receiver */ 368 { USB_DEVICE(VENDOR_FORMOSA, 0xe017), 369 .driver_info = MCE_GEN2_NO_TX }, 370 /* Formosa Industrial Computing / Beanbag Emulation Device */ 371 { USB_DEVICE(VENDOR_FORMOSA, 0xe018) }, 372 /* Formosa21 / eHome Infrared Receiver */ 373 { USB_DEVICE(VENDOR_FORMOSA, 0xe03a) }, 374 /* Formosa Industrial Computing AIM IR605/A */ 375 { USB_DEVICE(VENDOR_FORMOSA, 0xe03c) }, 376 /* Formosa Industrial Computing */ 377 { USB_DEVICE(VENDOR_FORMOSA, 0xe03e) }, 378 /* Formosa Industrial Computing */ 379 { USB_DEVICE(VENDOR_FORMOSA, 0xe042) }, 380 /* Fintek eHome Infrared Transceiver (HP branded) */ 381 { USB_DEVICE(VENDOR_FINTEK, 0x5168), 382 .driver_info = MCE_GEN2_TX_INV }, 383 /* Fintek eHome Infrared Transceiver */ 384 { USB_DEVICE(VENDOR_FINTEK, 0x0602) }, 385 /* Fintek eHome Infrared Transceiver (in the AOpen MP45) */ 386 { USB_DEVICE(VENDOR_FINTEK, 0x0702) }, 387 /* Pinnacle Remote Kit */ 388 { USB_DEVICE(VENDOR_PINNACLE, 0x0225), 389 .driver_info = MCE_GEN3 }, 390 /* Elitegroup Computer Systems IR */ 391 { USB_DEVICE(VENDOR_ECS, 0x0f38) }, 392 /* Wistron Corp. eHome Infrared Receiver */ 393 { USB_DEVICE(VENDOR_WISTRON, 0x0002) }, 394 /* Compro K100 */ 395 { USB_DEVICE(VENDOR_COMPRO, 0x3020) }, 396 /* Compro K100 v2 */ 397 { USB_DEVICE(VENDOR_COMPRO, 0x3082) }, 398 /* Northstar Systems, Inc. eHome Infrared Transceiver */ 399 { USB_DEVICE(VENDOR_NORTHSTAR, 0xe004) }, 400 /* TiVo PC IR Receiver */ 401 { USB_DEVICE(VENDOR_TIVO, 0x2000), 402 .driver_info = TIVO_KIT }, 403 /* Conexant Hybrid TV "Shelby" Polaris SDK */ 404 { USB_DEVICE(VENDOR_CONEXANT, 0x58a1), 405 .driver_info = POLARIS_EVK }, 406 /* Conexant Hybrid TV RDU253S Polaris */ 407 { USB_DEVICE(VENDOR_CONEXANT, 0x58a5), 408 .driver_info = CX_HYBRID_TV }, 409 /* Twisted Melon Inc. - Manta Mini Receiver */ 410 { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8008) }, 411 /* Twisted Melon Inc. - Manta Pico Receiver */ 412 { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8016) }, 413 /* Twisted Melon Inc. - Manta Transceiver */ 414 { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8042) }, 415 /* Hauppauge WINTV-HVR-HVR 930C-HD - based on cx231xx */ 416 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb130), 417 .driver_info = HAUPPAUGE_CX_HYBRID_TV }, 418 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb131), 419 .driver_info = HAUPPAUGE_CX_HYBRID_TV }, 420 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb138), 421 .driver_info = HAUPPAUGE_CX_HYBRID_TV }, 422 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb139), 423 .driver_info = HAUPPAUGE_CX_HYBRID_TV }, 424 /* Hauppauge WinTV-HVR-935C - based on cx231xx */ 425 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb151), 426 .driver_info = HAUPPAUGE_CX_HYBRID_TV }, 427 /* Hauppauge WinTV-HVR-955Q - based on cx231xx */ 428 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb123), 429 .driver_info = HAUPPAUGE_CX_HYBRID_TV }, 430 /* Hauppauge WinTV-HVR-975 - based on cx231xx */ 431 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb150), 432 .driver_info = HAUPPAUGE_CX_HYBRID_TV }, 433 { USB_DEVICE(VENDOR_PCTV, 0x0259), 434 .driver_info = HAUPPAUGE_CX_HYBRID_TV }, 435 { USB_DEVICE(VENDOR_PCTV, 0x025e), 436 .driver_info = HAUPPAUGE_CX_HYBRID_TV }, 437 /* Adaptec / HP eHome Receiver */ 438 { USB_DEVICE(VENDOR_ADAPTEC, 0x0094) }, 439 /* Evromedia USB Full Hybrid Full HD */ 440 { USB_DEVICE(0x1b80, 0xd3b2), 441 .driver_info = EVROMEDIA_FULL_HYBRID_FULLHD }, 442 /* Astrometa T2hybrid */ 443 { USB_DEVICE(0x15f4, 0x0135), 444 .driver_info = ASTROMETA_T2HYBRID }, 445 446 /* Terminating entry */ 447 { } 448 }; 449 450 /* data structure for each usb transceiver */ 451 struct mceusb_dev { 452 /* ir-core bits */ 453 struct rc_dev *rc; 454 455 /* optional features we can enable */ 456 bool carrier_report_enabled; 457 bool wideband_rx_enabled; /* aka learning mode, short-range rx */ 458 459 /* core device bits */ 460 struct device *dev; 461 462 /* usb */ 463 struct usb_device *usbdev; 464 struct usb_interface *usbintf; 465 struct urb *urb_in; 466 unsigned int pipe_in; 467 struct usb_endpoint_descriptor *usb_ep_out; 468 unsigned int pipe_out; 469 470 /* buffers and dma */ 471 unsigned char *buf_in; 472 unsigned int len_in; 473 dma_addr_t dma_in; 474 475 enum { 476 CMD_HEADER = 0, 477 SUBCMD, 478 CMD_DATA, 479 PARSE_IRDATA, 480 } parser_state; 481 482 u8 cmd, rem; /* Remaining IR data bytes in packet */ 483 484 struct { 485 u32 connected:1; 486 u32 tx_mask_normal:1; 487 u32 microsoft_gen1:1; 488 u32 no_tx:1; 489 u32 rx2; 490 } flags; 491 492 /* transmit support */ 493 u32 carrier; 494 unsigned char tx_mask; 495 496 char phys[64]; 497 enum mceusb_model_type model; 498 499 bool need_reset; /* flag to issue a device resume cmd */ 500 u8 emver; /* emulator interface version */ 501 u8 num_txports; /* number of transmit ports */ 502 u8 num_rxports; /* number of receive sensors */ 503 u8 txports_cabled; /* bitmask of transmitters with cable */ 504 u8 rxports_active; /* bitmask of active receive sensors */ 505 bool learning_active; /* wideband rx is active */ 506 507 /* receiver carrier frequency detection support */ 508 u32 pulse_tunit; /* IR pulse "on" cumulative time units */ 509 u32 pulse_count; /* pulse "on" count in measurement interval */ 510 511 /* 512 * support for async error handler mceusb_deferred_kevent() 513 * where usb_clear_halt(), usb_reset_configuration(), 514 * usb_reset_device(), etc. must be done in process context 515 */ 516 struct work_struct kevent; 517 unsigned long kevent_flags; 518 # define EVENT_TX_HALT 0 519 # define EVENT_RX_HALT 1 520 # define EVENT_RST_PEND 31 521 }; 522 523 /* MCE Device Command Strings, generally a port and command pair */ 524 static char DEVICE_RESUME[] = {MCE_CMD_NULL, MCE_CMD_PORT_SYS, 525 MCE_CMD_RESUME}; 526 static char GET_REVISION[] = {MCE_CMD_PORT_SYS, MCE_CMD_G_REVISION}; 527 static char GET_EMVER[] = {MCE_CMD_PORT_SYS, MCE_CMD_GETEMVER}; 528 static char GET_WAKEVERSION[] = {MCE_CMD_PORT_SYS, MCE_CMD_GETWAKEVERSION}; 529 static char FLASH_LED[] = {MCE_CMD_PORT_SYS, MCE_CMD_FLASHLED}; 530 static char GET_UNKNOWN2[] = {MCE_CMD_PORT_IR, MCE_CMD_UNKNOWN2}; 531 static char GET_CARRIER_FREQ[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRCFS}; 532 static char GET_RX_TIMEOUT[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTIMEOUT}; 533 static char GET_NUM_PORTS[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRNUMPORTS}; 534 static char GET_TX_BITMASK[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTXPORTS}; 535 static char GET_RX_SENSOR[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRRXPORTEN}; 536 /* sub in desired values in lower byte or bytes for full command */ 537 /* FIXME: make use of these for transmit. 538 static char SET_CARRIER_FREQ[] = {MCE_CMD_PORT_IR, 539 MCE_CMD_SETIRCFS, 0x00, 0x00}; 540 static char SET_TX_BITMASK[] = {MCE_CMD_PORT_IR, MCE_CMD_SETIRTXPORTS, 0x00}; 541 static char SET_RX_TIMEOUT[] = {MCE_CMD_PORT_IR, 542 MCE_CMD_SETIRTIMEOUT, 0x00, 0x00}; 543 static char SET_RX_SENSOR[] = {MCE_CMD_PORT_IR, 544 MCE_RSP_EQIRRXPORTEN, 0x00}; 545 */ 546 547 static int mceusb_cmd_datasize(u8 cmd, u8 subcmd) 548 { 549 int datasize = 0; 550 551 switch (cmd) { 552 case MCE_CMD_NULL: 553 if (subcmd == MCE_CMD_PORT_SYS) 554 datasize = 1; 555 break; 556 case MCE_CMD_PORT_SYS: 557 switch (subcmd) { 558 case MCE_RSP_GETPORTSTATUS: 559 datasize = 5; 560 break; 561 case MCE_RSP_EQWAKEVERSION: 562 datasize = 4; 563 break; 564 case MCE_CMD_G_REVISION: 565 datasize = 4; 566 break; 567 case MCE_RSP_EQWAKESUPPORT: 568 case MCE_RSP_GETWAKESOURCE: 569 case MCE_RSP_EQDEVDETAILS: 570 case MCE_RSP_EQEMVER: 571 datasize = 1; 572 break; 573 } 574 break; 575 case MCE_CMD_PORT_IR: 576 switch (subcmd) { 577 case MCE_CMD_UNKNOWN: 578 case MCE_RSP_EQIRCFS: 579 case MCE_RSP_EQIRTIMEOUT: 580 case MCE_RSP_EQIRRXCFCNT: 581 case MCE_RSP_EQIRNUMPORTS: 582 datasize = 2; 583 break; 584 case MCE_CMD_SIG_END: 585 case MCE_RSP_EQIRTXPORTS: 586 case MCE_RSP_EQIRRXPORTEN: 587 datasize = 1; 588 break; 589 } 590 } 591 return datasize; 592 } 593 594 static void mceusb_dev_printdata(struct mceusb_dev *ir, u8 *buf, int buf_len, 595 int offset, int len, bool out) 596 { 597 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG) 598 char *inout; 599 u8 cmd, subcmd, *data; 600 struct device *dev = ir->dev; 601 u32 carrier, period; 602 603 if (offset < 0 || offset >= buf_len) 604 return; 605 606 dev_dbg(dev, "%cx data[%d]: %*ph (len=%d sz=%d)", 607 (out ? 't' : 'r'), offset, 608 min(len, buf_len - offset), buf + offset, len, buf_len); 609 610 inout = out ? "Request" : "Got"; 611 612 cmd = buf[offset]; 613 subcmd = (offset + 1 < buf_len) ? buf[offset + 1] : 0; 614 data = &buf[offset] + 2; 615 616 /* Trace meaningless 0xb1 0x60 header bytes on original receiver */ 617 if (ir->flags.microsoft_gen1 && !out && !offset) { 618 dev_dbg(dev, "MCE gen 1 header"); 619 return; 620 } 621 622 /* Trace IR data header or trailer */ 623 if (cmd != MCE_CMD_PORT_IR && 624 (cmd & MCE_PORT_MASK) == MCE_COMMAND_IRDATA) { 625 if (cmd == MCE_IRDATA_TRAILER) 626 dev_dbg(dev, "End of raw IR data"); 627 else 628 dev_dbg(dev, "Raw IR data, %d pulse/space samples", 629 cmd & MCE_PACKET_LENGTH_MASK); 630 return; 631 } 632 633 /* Unexpected end of buffer? */ 634 if (offset + len > buf_len) 635 return; 636 637 /* Decode MCE command/response */ 638 switch (cmd) { 639 case MCE_CMD_NULL: 640 if (subcmd == MCE_CMD_NULL) 641 break; 642 if ((subcmd == MCE_CMD_PORT_SYS) && 643 (data[0] == MCE_CMD_RESUME)) 644 dev_dbg(dev, "Device resume requested"); 645 else 646 dev_dbg(dev, "Unknown command 0x%02x 0x%02x", 647 cmd, subcmd); 648 break; 649 case MCE_CMD_PORT_SYS: 650 switch (subcmd) { 651 case MCE_RSP_EQEMVER: 652 if (!out) 653 dev_dbg(dev, "Emulator interface version %x", 654 data[0]); 655 break; 656 case MCE_CMD_G_REVISION: 657 if (len == 2) 658 dev_dbg(dev, "Get hw/sw rev?"); 659 else 660 dev_dbg(dev, "hw/sw rev %4ph", 661 &buf[offset + 2]); 662 break; 663 case MCE_CMD_RESUME: 664 dev_dbg(dev, "Device resume requested"); 665 break; 666 case MCE_RSP_CMD_ILLEGAL: 667 dev_dbg(dev, "Illegal PORT_SYS command"); 668 break; 669 case MCE_RSP_EQWAKEVERSION: 670 if (!out) 671 dev_dbg(dev, "Wake version, proto: 0x%02x, payload: 0x%02x, address: 0x%02x, version: 0x%02x", 672 data[0], data[1], data[2], data[3]); 673 break; 674 case MCE_RSP_GETPORTSTATUS: 675 if (!out) 676 /* We use data1 + 1 here, to match hw labels */ 677 dev_dbg(dev, "TX port %d: blaster is%s connected", 678 data[0] + 1, data[3] ? " not" : ""); 679 break; 680 case MCE_CMD_FLASHLED: 681 dev_dbg(dev, "Attempting to flash LED"); 682 break; 683 default: 684 dev_dbg(dev, "Unknown command 0x%02x 0x%02x", 685 cmd, subcmd); 686 break; 687 } 688 break; 689 case MCE_CMD_PORT_IR: 690 switch (subcmd) { 691 case MCE_CMD_SIG_END: 692 dev_dbg(dev, "End of signal"); 693 break; 694 case MCE_CMD_PING: 695 dev_dbg(dev, "Ping"); 696 break; 697 case MCE_CMD_UNKNOWN: 698 dev_dbg(dev, "Resp to 9f 05 of 0x%02x 0x%02x", 699 data[0], data[1]); 700 break; 701 case MCE_RSP_EQIRCFS: 702 if (!data[0] && !data[1]) { 703 dev_dbg(dev, "%s: no carrier", inout); 704 break; 705 } 706 // prescaler should make sense 707 if (data[0] > 8) 708 break; 709 period = DIV_ROUND_CLOSEST((1U << data[0] * 2) * 710 (data[1] + 1), 10); 711 if (!period) 712 break; 713 carrier = USEC_PER_SEC / period; 714 dev_dbg(dev, "%s carrier of %u Hz (period %uus)", 715 inout, carrier, period); 716 break; 717 case MCE_CMD_GETIRCFS: 718 dev_dbg(dev, "Get carrier mode and freq"); 719 break; 720 case MCE_RSP_EQIRTXPORTS: 721 dev_dbg(dev, "%s transmit blaster mask of 0x%02x", 722 inout, data[0]); 723 break; 724 case MCE_RSP_EQIRTIMEOUT: 725 /* value is in units of 50us, so x*50/1000 ms */ 726 period = ((data[0] << 8) | data[1]) * 727 MCE_TIME_UNIT / 1000; 728 dev_dbg(dev, "%s receive timeout of %d ms", 729 inout, period); 730 break; 731 case MCE_CMD_GETIRTIMEOUT: 732 dev_dbg(dev, "Get receive timeout"); 733 break; 734 case MCE_CMD_GETIRTXPORTS: 735 dev_dbg(dev, "Get transmit blaster mask"); 736 break; 737 case MCE_RSP_EQIRRXPORTEN: 738 dev_dbg(dev, "%s %s-range receive sensor in use", 739 inout, data[0] == 0x02 ? "short" : "long"); 740 break; 741 case MCE_CMD_GETIRRXPORTEN: 742 /* aka MCE_RSP_EQIRRXCFCNT */ 743 if (out) 744 dev_dbg(dev, "Get receive sensor"); 745 else 746 dev_dbg(dev, "RX carrier cycle count: %d", 747 ((data[0] << 8) | data[1])); 748 break; 749 case MCE_RSP_EQIRNUMPORTS: 750 if (out) 751 break; 752 dev_dbg(dev, "Num TX ports: %x, num RX ports: %x", 753 data[0], data[1]); 754 break; 755 case MCE_RSP_CMD_ILLEGAL: 756 dev_dbg(dev, "Illegal PORT_IR command"); 757 break; 758 case MCE_RSP_TX_TIMEOUT: 759 dev_dbg(dev, "IR TX timeout (TX buffer underrun)"); 760 break; 761 default: 762 dev_dbg(dev, "Unknown command 0x%02x 0x%02x", 763 cmd, subcmd); 764 break; 765 } 766 break; 767 default: 768 break; 769 } 770 #endif 771 } 772 773 /* 774 * Schedule work that can't be done in interrupt handlers 775 * (mceusb_dev_recv() and mce_write_callback()) nor BH work. 776 * Invokes mceusb_deferred_kevent() for recovering from 777 * error events specified by the kevent bit field. 778 */ 779 static void mceusb_defer_kevent(struct mceusb_dev *ir, int kevent) 780 { 781 set_bit(kevent, &ir->kevent_flags); 782 783 if (test_bit(EVENT_RST_PEND, &ir->kevent_flags)) { 784 dev_dbg(ir->dev, "kevent %d dropped pending USB Reset Device", 785 kevent); 786 return; 787 } 788 789 if (!schedule_work(&ir->kevent)) 790 dev_dbg(ir->dev, "kevent %d already scheduled", kevent); 791 else 792 dev_dbg(ir->dev, "kevent %d scheduled", kevent); 793 } 794 795 static void mce_write_callback(struct urb *urb) 796 { 797 if (!urb) 798 return; 799 800 complete(urb->context); 801 } 802 803 /* 804 * Write (TX/send) data to MCE device USB endpoint out. 805 * Used for IR blaster TX and MCE device commands. 806 * 807 * Return: The number of bytes written (> 0) or errno (< 0). 808 */ 809 static int mce_write(struct mceusb_dev *ir, u8 *data, int size) 810 { 811 int ret; 812 struct urb *urb; 813 struct device *dev = ir->dev; 814 unsigned char *buf_out; 815 struct completion tx_done; 816 unsigned long expire; 817 unsigned long ret_wait; 818 819 mceusb_dev_printdata(ir, data, size, 0, size, true); 820 821 urb = usb_alloc_urb(0, GFP_KERNEL); 822 if (unlikely(!urb)) { 823 dev_err(dev, "Error: mce write couldn't allocate urb"); 824 return -ENOMEM; 825 } 826 827 buf_out = kmalloc(size, GFP_KERNEL); 828 if (!buf_out) { 829 usb_free_urb(urb); 830 return -ENOMEM; 831 } 832 833 init_completion(&tx_done); 834 835 /* outbound data */ 836 if (usb_endpoint_xfer_int(ir->usb_ep_out)) 837 usb_fill_int_urb(urb, ir->usbdev, ir->pipe_out, 838 buf_out, size, mce_write_callback, &tx_done, 839 ir->usb_ep_out->bInterval); 840 else 841 usb_fill_bulk_urb(urb, ir->usbdev, ir->pipe_out, 842 buf_out, size, mce_write_callback, &tx_done); 843 memcpy(buf_out, data, size); 844 845 ret = usb_submit_urb(urb, GFP_KERNEL); 846 if (ret) { 847 dev_err(dev, "Error: mce write submit urb error = %d", ret); 848 kfree(buf_out); 849 usb_free_urb(urb); 850 return ret; 851 } 852 853 expire = msecs_to_jiffies(USB_TX_TIMEOUT); 854 ret_wait = wait_for_completion_timeout(&tx_done, expire); 855 if (!ret_wait) { 856 dev_err(dev, "Error: mce write timed out (expire = %lu (%dms))", 857 expire, USB_TX_TIMEOUT); 858 usb_kill_urb(urb); 859 ret = (urb->status == -ENOENT ? -ETIMEDOUT : urb->status); 860 } else { 861 ret = urb->status; 862 } 863 if (ret >= 0) 864 ret = urb->actual_length; /* bytes written */ 865 866 switch (urb->status) { 867 /* success */ 868 case 0: 869 break; 870 871 case -ECONNRESET: 872 case -ENOENT: 873 case -EILSEQ: 874 case -ESHUTDOWN: 875 break; 876 877 case -EPIPE: 878 dev_err(ir->dev, "Error: mce write urb status = %d (TX HALT)", 879 urb->status); 880 mceusb_defer_kevent(ir, EVENT_TX_HALT); 881 break; 882 883 default: 884 dev_err(ir->dev, "Error: mce write urb status = %d", 885 urb->status); 886 break; 887 } 888 889 dev_dbg(dev, "tx done status = %d (wait = %lu, expire = %lu (%dms), urb->actual_length = %d, urb->status = %d)", 890 ret, ret_wait, expire, USB_TX_TIMEOUT, 891 urb->actual_length, urb->status); 892 893 kfree(buf_out); 894 usb_free_urb(urb); 895 896 return ret; 897 } 898 899 static void mce_command_out(struct mceusb_dev *ir, u8 *data, int size) 900 { 901 int rsize = sizeof(DEVICE_RESUME); 902 903 if (ir->need_reset) { 904 ir->need_reset = false; 905 mce_write(ir, DEVICE_RESUME, rsize); 906 msleep(10); 907 } 908 909 mce_write(ir, data, size); 910 msleep(10); 911 } 912 913 /* 914 * Transmit IR out the MCE device IR blaster port(s). 915 * 916 * Convert IR pulse/space sequence from LIRC to MCE format. 917 * Break up a long IR sequence into multiple parts (MCE IR data packets). 918 * 919 * u32 txbuf[] consists of IR pulse, space, ..., and pulse times in usec. 920 * Pulses and spaces are implicit by their position. 921 * The first IR sample, txbuf[0], is always a pulse. 922 * 923 * u8 irbuf[] consists of multiple IR data packets for the MCE device. 924 * A packet is 1 u8 MCE_IRDATA_HEADER and up to 30 u8 IR samples. 925 * An IR sample is 1-bit pulse/space flag with 7-bit time 926 * in MCE time units (50usec). 927 * 928 * Return: The number of IR samples sent (> 0) or errno (< 0). 929 */ 930 static int mceusb_tx_ir(struct rc_dev *dev, unsigned *txbuf, unsigned count) 931 { 932 struct mceusb_dev *ir = dev->priv; 933 u8 cmdbuf[3] = { MCE_CMD_PORT_IR, MCE_CMD_SETIRTXPORTS, 0x00 }; 934 u8 irbuf[MCE_IRBUF_SIZE]; 935 int ircount = 0; 936 unsigned int irsample; 937 int i, length, ret; 938 939 /* Send the set TX ports command */ 940 cmdbuf[2] = ir->tx_mask; 941 mce_command_out(ir, cmdbuf, sizeof(cmdbuf)); 942 943 /* Generate mce IR data packet */ 944 for (i = 0; i < count; i++) { 945 irsample = txbuf[i] / MCE_TIME_UNIT; 946 947 /* loop to support long pulses/spaces > 6350us (127*50us) */ 948 while (irsample > 0) { 949 /* Insert IR header every 30th entry */ 950 if (ircount % MCE_PACKET_SIZE == 0) { 951 /* Room for IR header and one IR sample? */ 952 if (ircount >= MCE_IRBUF_SIZE - 1) { 953 /* Send near full buffer */ 954 ret = mce_write(ir, irbuf, ircount); 955 if (ret < 0) 956 return ret; 957 ircount = 0; 958 } 959 irbuf[ircount++] = MCE_IRDATA_HEADER; 960 } 961 962 /* Insert IR sample */ 963 if (irsample <= MCE_MAX_PULSE_LENGTH) { 964 irbuf[ircount] = irsample; 965 irsample = 0; 966 } else { 967 irbuf[ircount] = MCE_MAX_PULSE_LENGTH; 968 irsample -= MCE_MAX_PULSE_LENGTH; 969 } 970 /* 971 * Even i = IR pulse 972 * Odd i = IR space 973 */ 974 irbuf[ircount] |= (i & 1 ? 0 : MCE_PULSE_BIT); 975 ircount++; 976 977 /* IR buffer full? */ 978 if (ircount >= MCE_IRBUF_SIZE) { 979 /* Fix packet length in last header */ 980 length = ircount % MCE_PACKET_SIZE; 981 if (length > 0) 982 irbuf[ircount - length] -= 983 MCE_PACKET_SIZE - length; 984 /* Send full buffer */ 985 ret = mce_write(ir, irbuf, ircount); 986 if (ret < 0) 987 return ret; 988 ircount = 0; 989 } 990 } 991 } /* after for loop, 0 <= ircount < MCE_IRBUF_SIZE */ 992 993 /* Fix packet length in last header */ 994 length = ircount % MCE_PACKET_SIZE; 995 if (length > 0) 996 irbuf[ircount - length] -= MCE_PACKET_SIZE - length; 997 998 /* Append IR trailer (0x80) to final partial (or empty) IR buffer */ 999 irbuf[ircount++] = MCE_IRDATA_TRAILER; 1000 1001 /* Send final buffer */ 1002 ret = mce_write(ir, irbuf, ircount); 1003 if (ret < 0) 1004 return ret; 1005 1006 return count; 1007 } 1008 1009 /* Sets active IR outputs -- mce devices typically have two */ 1010 static int mceusb_set_tx_mask(struct rc_dev *dev, u32 mask) 1011 { 1012 struct mceusb_dev *ir = dev->priv; 1013 1014 /* return number of transmitters */ 1015 int emitters = ir->num_txports ? ir->num_txports : 2; 1016 1017 if (mask >= (1 << emitters)) 1018 return emitters; 1019 1020 if (ir->flags.tx_mask_normal) 1021 ir->tx_mask = mask; 1022 else 1023 ir->tx_mask = (mask != MCE_DEFAULT_TX_MASK ? 1024 mask ^ MCE_DEFAULT_TX_MASK : mask) << 1; 1025 1026 return 0; 1027 } 1028 1029 /* Sets the send carrier frequency and mode */ 1030 static int mceusb_set_tx_carrier(struct rc_dev *dev, u32 carrier) 1031 { 1032 struct mceusb_dev *ir = dev->priv; 1033 int clk = 10000000; 1034 int prescaler = 0, divisor = 0; 1035 unsigned char cmdbuf[4] = { MCE_CMD_PORT_IR, 1036 MCE_CMD_SETIRCFS, 0x00, 0x00 }; 1037 1038 /* Carrier has changed */ 1039 if (ir->carrier != carrier) { 1040 1041 if (carrier == 0) { 1042 ir->carrier = carrier; 1043 cmdbuf[2] = MCE_CMD_SIG_END; 1044 cmdbuf[3] = MCE_IRDATA_TRAILER; 1045 dev_dbg(ir->dev, "disabling carrier modulation"); 1046 mce_command_out(ir, cmdbuf, sizeof(cmdbuf)); 1047 return 0; 1048 } 1049 1050 for (prescaler = 0; prescaler < 4; ++prescaler) { 1051 divisor = (clk >> (2 * prescaler)) / carrier; 1052 if (divisor <= 0xff) { 1053 ir->carrier = carrier; 1054 cmdbuf[2] = prescaler; 1055 cmdbuf[3] = divisor; 1056 dev_dbg(ir->dev, "requesting %u HZ carrier", 1057 carrier); 1058 1059 /* Transmit new carrier to mce device */ 1060 mce_command_out(ir, cmdbuf, sizeof(cmdbuf)); 1061 return 0; 1062 } 1063 } 1064 1065 return -EINVAL; 1066 1067 } 1068 1069 return 0; 1070 } 1071 1072 static int mceusb_set_timeout(struct rc_dev *dev, unsigned int timeout) 1073 { 1074 u8 cmdbuf[4] = { MCE_CMD_PORT_IR, MCE_CMD_SETIRTIMEOUT, 0, 0 }; 1075 struct mceusb_dev *ir = dev->priv; 1076 unsigned int units; 1077 1078 units = DIV_ROUND_UP(timeout, MCE_TIME_UNIT); 1079 1080 cmdbuf[2] = units >> 8; 1081 cmdbuf[3] = units; 1082 1083 mce_command_out(ir, cmdbuf, sizeof(cmdbuf)); 1084 1085 /* get receiver timeout value */ 1086 mce_command_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT)); 1087 1088 return 0; 1089 } 1090 1091 /* 1092 * Select or deselect the 2nd receiver port. 1093 * Second receiver is learning mode, wide-band, short-range receiver. 1094 * Only one receiver (long or short range) may be active at a time. 1095 */ 1096 static int mceusb_set_rx_wideband(struct rc_dev *dev, int enable) 1097 { 1098 struct mceusb_dev *ir = dev->priv; 1099 unsigned char cmdbuf[3] = { MCE_CMD_PORT_IR, 1100 MCE_CMD_SETIRRXPORTEN, 0x00 }; 1101 1102 dev_dbg(ir->dev, "select %s-range receive sensor", 1103 enable ? "short" : "long"); 1104 if (enable) { 1105 ir->wideband_rx_enabled = true; 1106 cmdbuf[2] = 2; /* port 2 is short range receiver */ 1107 } else { 1108 ir->wideband_rx_enabled = false; 1109 cmdbuf[2] = 1; /* port 1 is long range receiver */ 1110 } 1111 mce_command_out(ir, cmdbuf, sizeof(cmdbuf)); 1112 /* response from device sets ir->learning_active */ 1113 1114 return 0; 1115 } 1116 1117 /* 1118 * Enable/disable receiver carrier frequency pass through reporting. 1119 * Only the short-range receiver has carrier frequency measuring capability. 1120 * Implicitly select this receiver when enabling carrier frequency reporting. 1121 */ 1122 static int mceusb_set_rx_carrier_report(struct rc_dev *dev, int enable) 1123 { 1124 struct mceusb_dev *ir = dev->priv; 1125 unsigned char cmdbuf[3] = { MCE_CMD_PORT_IR, 1126 MCE_CMD_SETIRRXPORTEN, 0x00 }; 1127 1128 dev_dbg(ir->dev, "%s short-range receiver carrier reporting", 1129 enable ? "enable" : "disable"); 1130 if (enable) { 1131 ir->carrier_report_enabled = true; 1132 if (!ir->learning_active) { 1133 cmdbuf[2] = 2; /* port 2 is short range receiver */ 1134 mce_command_out(ir, cmdbuf, sizeof(cmdbuf)); 1135 } 1136 } else { 1137 ir->carrier_report_enabled = false; 1138 /* 1139 * Revert to normal (long-range) receiver only if the 1140 * wideband (short-range) receiver wasn't explicitly 1141 * enabled. 1142 */ 1143 if (ir->learning_active && !ir->wideband_rx_enabled) { 1144 cmdbuf[2] = 1; /* port 1 is long range receiver */ 1145 mce_command_out(ir, cmdbuf, sizeof(cmdbuf)); 1146 } 1147 } 1148 1149 return 0; 1150 } 1151 1152 /* 1153 * Handle PORT_SYS/IR command response received from the MCE device. 1154 * 1155 * Assumes single response with all its data (not truncated) 1156 * in buf_in[]. The response itself determines its total length 1157 * (mceusb_cmd_datasize() + 2) and hence the minimum size of buf_in[]. 1158 * 1159 * We don't do anything but print debug spew for many of the command bits 1160 * we receive from the hardware, but some of them are useful information 1161 * we want to store so that we can use them. 1162 */ 1163 static void mceusb_handle_command(struct mceusb_dev *ir, u8 *buf_in) 1164 { 1165 u8 cmd = buf_in[0]; 1166 u8 subcmd = buf_in[1]; 1167 u8 *hi = &buf_in[2]; /* read only when required */ 1168 u8 *lo = &buf_in[3]; /* read only when required */ 1169 struct ir_raw_event rawir = {}; 1170 u32 carrier_cycles; 1171 u32 cycles_fix; 1172 1173 if (cmd == MCE_CMD_PORT_SYS) { 1174 switch (subcmd) { 1175 /* the one and only 5-byte return value command */ 1176 case MCE_RSP_GETPORTSTATUS: 1177 if (buf_in[5] == 0 && *hi < 8) 1178 ir->txports_cabled |= 1 << *hi; 1179 break; 1180 1181 /* 1-byte return value commands */ 1182 case MCE_RSP_EQEMVER: 1183 ir->emver = *hi; 1184 break; 1185 1186 /* No return value commands */ 1187 case MCE_RSP_CMD_ILLEGAL: 1188 ir->need_reset = true; 1189 break; 1190 1191 default: 1192 break; 1193 } 1194 1195 return; 1196 } 1197 1198 if (cmd != MCE_CMD_PORT_IR) 1199 return; 1200 1201 switch (subcmd) { 1202 /* 2-byte return value commands */ 1203 case MCE_RSP_EQIRTIMEOUT: 1204 ir->rc->timeout = (*hi << 8 | *lo) * MCE_TIME_UNIT; 1205 break; 1206 case MCE_RSP_EQIRNUMPORTS: 1207 ir->num_txports = *hi; 1208 ir->num_rxports = *lo; 1209 break; 1210 case MCE_RSP_EQIRRXCFCNT: 1211 /* 1212 * The carrier cycle counter can overflow and wrap around 1213 * without notice from the device. So frequency measurement 1214 * will be inaccurate with long duration IR. 1215 * 1216 * The long-range (non learning) receiver always reports 1217 * zero count so we always ignore its report. 1218 */ 1219 if (ir->carrier_report_enabled && ir->learning_active && 1220 ir->pulse_tunit > 0) { 1221 carrier_cycles = (*hi << 8 | *lo); 1222 /* 1223 * Adjust carrier cycle count by adding 1224 * 1 missed count per pulse "on" 1225 */ 1226 cycles_fix = ir->flags.rx2 == 2 ? ir->pulse_count : 0; 1227 rawir.carrier_report = 1; 1228 rawir.carrier = (1000000u / MCE_TIME_UNIT) * 1229 (carrier_cycles + cycles_fix) / 1230 ir->pulse_tunit; 1231 dev_dbg(ir->dev, "RX carrier frequency %u Hz (pulse count = %u, cycles = %u, duration = %u, rx2 = %u)", 1232 rawir.carrier, ir->pulse_count, carrier_cycles, 1233 ir->pulse_tunit, ir->flags.rx2); 1234 ir_raw_event_store(ir->rc, &rawir); 1235 } 1236 break; 1237 1238 /* 1-byte return value commands */ 1239 case MCE_RSP_EQIRTXPORTS: 1240 ir->tx_mask = *hi; 1241 break; 1242 case MCE_RSP_EQIRRXPORTEN: 1243 ir->learning_active = ((*hi & 0x02) == 0x02); 1244 if (ir->rxports_active != *hi) { 1245 dev_info(ir->dev, "%s-range (0x%x) receiver active", 1246 ir->learning_active ? "short" : "long", *hi); 1247 ir->rxports_active = *hi; 1248 } 1249 break; 1250 1251 /* No return value commands */ 1252 case MCE_RSP_CMD_ILLEGAL: 1253 case MCE_RSP_TX_TIMEOUT: 1254 ir->need_reset = true; 1255 break; 1256 1257 default: 1258 break; 1259 } 1260 } 1261 1262 static void mceusb_process_ir_data(struct mceusb_dev *ir, int buf_len) 1263 { 1264 struct ir_raw_event rawir = {}; 1265 bool event = false; 1266 int i = 0; 1267 1268 /* skip meaningless 0xb1 0x60 header bytes on orig receiver */ 1269 if (ir->flags.microsoft_gen1) 1270 i = 2; 1271 1272 /* if there's no data, just return now */ 1273 if (buf_len <= i) 1274 return; 1275 1276 for (; i < buf_len; i++) { 1277 switch (ir->parser_state) { 1278 case SUBCMD: 1279 ir->rem = mceusb_cmd_datasize(ir->cmd, ir->buf_in[i]); 1280 mceusb_dev_printdata(ir, ir->buf_in, buf_len, i - 1, 1281 ir->rem + 2, false); 1282 if (i + ir->rem < buf_len) 1283 mceusb_handle_command(ir, &ir->buf_in[i - 1]); 1284 ir->parser_state = CMD_DATA; 1285 break; 1286 case PARSE_IRDATA: 1287 ir->rem--; 1288 rawir.pulse = ((ir->buf_in[i] & MCE_PULSE_BIT) != 0); 1289 rawir.duration = (ir->buf_in[i] & MCE_PULSE_MASK); 1290 if (unlikely(!rawir.duration)) { 1291 dev_dbg(ir->dev, "nonsensical irdata %02x with duration 0", 1292 ir->buf_in[i]); 1293 break; 1294 } 1295 if (rawir.pulse) { 1296 ir->pulse_tunit += rawir.duration; 1297 ir->pulse_count++; 1298 } 1299 rawir.duration *= MCE_TIME_UNIT; 1300 1301 dev_dbg(ir->dev, "Storing %s %u us (%02x)", 1302 rawir.pulse ? "pulse" : "space", 1303 rawir.duration, ir->buf_in[i]); 1304 1305 if (ir_raw_event_store_with_filter(ir->rc, &rawir)) 1306 event = true; 1307 break; 1308 case CMD_DATA: 1309 ir->rem--; 1310 break; 1311 case CMD_HEADER: 1312 ir->cmd = ir->buf_in[i]; 1313 if ((ir->cmd == MCE_CMD_PORT_IR) || 1314 ((ir->cmd & MCE_PORT_MASK) != 1315 MCE_COMMAND_IRDATA)) { 1316 /* 1317 * got PORT_SYS, PORT_IR, or unknown 1318 * command response prefix 1319 */ 1320 ir->parser_state = SUBCMD; 1321 continue; 1322 } 1323 /* 1324 * got IR data prefix (0x80 + num_bytes) 1325 * decode MCE packets of the form {0x83, AA, BB, CC} 1326 * IR data packets can span USB messages 1327 */ 1328 ir->rem = (ir->cmd & MCE_PACKET_LENGTH_MASK); 1329 mceusb_dev_printdata(ir, ir->buf_in, buf_len, 1330 i, ir->rem + 1, false); 1331 if (ir->rem) { 1332 ir->parser_state = PARSE_IRDATA; 1333 } else { 1334 struct ir_raw_event ev = { 1335 .timeout = 1, 1336 .duration = ir->rc->timeout 1337 }; 1338 1339 if (ir_raw_event_store_with_filter(ir->rc, 1340 &ev)) 1341 event = true; 1342 ir->pulse_tunit = 0; 1343 ir->pulse_count = 0; 1344 } 1345 break; 1346 } 1347 1348 if (ir->parser_state != CMD_HEADER && !ir->rem) 1349 ir->parser_state = CMD_HEADER; 1350 } 1351 1352 /* 1353 * Accept IR data spanning multiple rx buffers. 1354 * Reject MCE command response spanning multiple rx buffers. 1355 */ 1356 if (ir->parser_state != PARSE_IRDATA || !ir->rem) 1357 ir->parser_state = CMD_HEADER; 1358 1359 if (event) { 1360 dev_dbg(ir->dev, "processed IR data"); 1361 ir_raw_event_handle(ir->rc); 1362 } 1363 } 1364 1365 static void mceusb_dev_recv(struct urb *urb) 1366 { 1367 struct mceusb_dev *ir; 1368 1369 if (!urb) 1370 return; 1371 1372 ir = urb->context; 1373 if (!ir) { 1374 usb_unlink_urb(urb); 1375 return; 1376 } 1377 1378 switch (urb->status) { 1379 /* success */ 1380 case 0: 1381 mceusb_process_ir_data(ir, urb->actual_length); 1382 break; 1383 1384 case -ECONNRESET: 1385 case -ENOENT: 1386 case -EILSEQ: 1387 case -EPROTO: 1388 case -ESHUTDOWN: 1389 usb_unlink_urb(urb); 1390 return; 1391 1392 case -EPIPE: 1393 dev_err(ir->dev, "Error: urb status = %d (RX HALT)", 1394 urb->status); 1395 mceusb_defer_kevent(ir, EVENT_RX_HALT); 1396 return; 1397 1398 default: 1399 dev_err(ir->dev, "Error: urb status = %d", urb->status); 1400 break; 1401 } 1402 1403 usb_submit_urb(urb, GFP_ATOMIC); 1404 } 1405 1406 static void mceusb_get_emulator_version(struct mceusb_dev *ir) 1407 { 1408 /* If we get no reply or an illegal command reply, its ver 1, says MS */ 1409 ir->emver = 1; 1410 mce_command_out(ir, GET_EMVER, sizeof(GET_EMVER)); 1411 } 1412 1413 static void mceusb_gen1_init(struct mceusb_dev *ir) 1414 { 1415 int ret; 1416 struct device *dev = ir->dev; 1417 char data[USB_CTRL_MSG_SZ]; 1418 1419 /* 1420 * This is a strange one. Windows issues a set address to the device 1421 * on the receive control pipe and expect a certain value pair back 1422 */ 1423 ret = usb_control_msg_recv(ir->usbdev, 0, USB_REQ_SET_ADDRESS, 1424 USB_DIR_IN | USB_TYPE_VENDOR, 1425 0, 0, data, USB_CTRL_MSG_SZ, 3000, 1426 GFP_KERNEL); 1427 dev_dbg(dev, "set address - ret = %d", ret); 1428 dev_dbg(dev, "set address - data[0] = %d, data[1] = %d", 1429 data[0], data[1]); 1430 1431 /* set feature: bit rate 38400 bps */ 1432 ret = usb_control_msg_send(ir->usbdev, 0, 1433 USB_REQ_SET_FEATURE, USB_TYPE_VENDOR, 1434 0xc04e, 0x0000, NULL, 0, 3000, GFP_KERNEL); 1435 1436 dev_dbg(dev, "set feature - ret = %d", ret); 1437 1438 /* bRequest 4: set char length to 8 bits */ 1439 ret = usb_control_msg_send(ir->usbdev, 0, 1440 4, USB_TYPE_VENDOR, 1441 0x0808, 0x0000, NULL, 0, 3000, GFP_KERNEL); 1442 dev_dbg(dev, "set char length - retB = %d", ret); 1443 1444 /* bRequest 2: set handshaking to use DTR/DSR */ 1445 ret = usb_control_msg_send(ir->usbdev, 0, 1446 2, USB_TYPE_VENDOR, 1447 0x0000, 0x0100, NULL, 0, 3000, GFP_KERNEL); 1448 dev_dbg(dev, "set handshake - retC = %d", ret); 1449 1450 /* device resume */ 1451 mce_command_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME)); 1452 1453 /* get hw/sw revision? */ 1454 mce_command_out(ir, GET_REVISION, sizeof(GET_REVISION)); 1455 } 1456 1457 static void mceusb_gen2_init(struct mceusb_dev *ir) 1458 { 1459 /* device resume */ 1460 mce_command_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME)); 1461 1462 /* get wake version (protocol, key, address) */ 1463 mce_command_out(ir, GET_WAKEVERSION, sizeof(GET_WAKEVERSION)); 1464 1465 /* unknown what this one actually returns... */ 1466 mce_command_out(ir, GET_UNKNOWN2, sizeof(GET_UNKNOWN2)); 1467 } 1468 1469 static void mceusb_get_parameters(struct mceusb_dev *ir) 1470 { 1471 int i; 1472 unsigned char cmdbuf[3] = { MCE_CMD_PORT_SYS, 1473 MCE_CMD_GETPORTSTATUS, 0x00 }; 1474 1475 /* defaults, if the hardware doesn't support querying */ 1476 ir->num_txports = 2; 1477 ir->num_rxports = 2; 1478 1479 /* get number of tx and rx ports */ 1480 mce_command_out(ir, GET_NUM_PORTS, sizeof(GET_NUM_PORTS)); 1481 1482 /* get the carrier and frequency */ 1483 mce_command_out(ir, GET_CARRIER_FREQ, sizeof(GET_CARRIER_FREQ)); 1484 1485 if (ir->num_txports && !ir->flags.no_tx) 1486 /* get the transmitter bitmask */ 1487 mce_command_out(ir, GET_TX_BITMASK, sizeof(GET_TX_BITMASK)); 1488 1489 /* get receiver timeout value */ 1490 mce_command_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT)); 1491 1492 /* get receiver sensor setting */ 1493 mce_command_out(ir, GET_RX_SENSOR, sizeof(GET_RX_SENSOR)); 1494 1495 for (i = 0; i < ir->num_txports; i++) { 1496 cmdbuf[2] = i; 1497 mce_command_out(ir, cmdbuf, sizeof(cmdbuf)); 1498 } 1499 } 1500 1501 static void mceusb_flash_led(struct mceusb_dev *ir) 1502 { 1503 if (ir->emver < 2) 1504 return; 1505 1506 mce_command_out(ir, FLASH_LED, sizeof(FLASH_LED)); 1507 } 1508 1509 /* 1510 * Workqueue function 1511 * for resetting or recovering device after occurrence of error events 1512 * specified in ir->kevent bit field. 1513 * Function runs (via schedule_work()) in non-interrupt context, for 1514 * calls here (such as usb_clear_halt()) requiring non-interrupt context. 1515 */ 1516 static void mceusb_deferred_kevent(struct work_struct *work) 1517 { 1518 struct mceusb_dev *ir = 1519 container_of(work, struct mceusb_dev, kevent); 1520 int status; 1521 1522 dev_err(ir->dev, "kevent handler called (flags 0x%lx)", 1523 ir->kevent_flags); 1524 1525 if (test_bit(EVENT_RST_PEND, &ir->kevent_flags)) { 1526 dev_err(ir->dev, "kevent handler canceled pending USB Reset Device"); 1527 return; 1528 } 1529 1530 if (test_bit(EVENT_RX_HALT, &ir->kevent_flags)) { 1531 usb_unlink_urb(ir->urb_in); 1532 status = usb_clear_halt(ir->usbdev, ir->pipe_in); 1533 dev_err(ir->dev, "rx clear halt status = %d", status); 1534 if (status < 0) { 1535 /* 1536 * Unable to clear RX halt/stall. 1537 * Will need to call usb_reset_device(). 1538 */ 1539 dev_err(ir->dev, 1540 "stuck RX HALT state requires USB Reset Device to clear"); 1541 usb_queue_reset_device(ir->usbintf); 1542 set_bit(EVENT_RST_PEND, &ir->kevent_flags); 1543 clear_bit(EVENT_RX_HALT, &ir->kevent_flags); 1544 1545 /* Cancel all other error events and handlers */ 1546 clear_bit(EVENT_TX_HALT, &ir->kevent_flags); 1547 return; 1548 } 1549 clear_bit(EVENT_RX_HALT, &ir->kevent_flags); 1550 status = usb_submit_urb(ir->urb_in, GFP_KERNEL); 1551 if (status < 0) { 1552 dev_err(ir->dev, "rx unhalt submit urb error = %d", 1553 status); 1554 } 1555 } 1556 1557 if (test_bit(EVENT_TX_HALT, &ir->kevent_flags)) { 1558 status = usb_clear_halt(ir->usbdev, ir->pipe_out); 1559 dev_err(ir->dev, "tx clear halt status = %d", status); 1560 if (status < 0) { 1561 /* 1562 * Unable to clear TX halt/stall. 1563 * Will need to call usb_reset_device(). 1564 */ 1565 dev_err(ir->dev, 1566 "stuck TX HALT state requires USB Reset Device to clear"); 1567 usb_queue_reset_device(ir->usbintf); 1568 set_bit(EVENT_RST_PEND, &ir->kevent_flags); 1569 clear_bit(EVENT_TX_HALT, &ir->kevent_flags); 1570 1571 /* Cancel all other error events and handlers */ 1572 clear_bit(EVENT_RX_HALT, &ir->kevent_flags); 1573 return; 1574 } 1575 clear_bit(EVENT_TX_HALT, &ir->kevent_flags); 1576 } 1577 } 1578 1579 static struct rc_dev *mceusb_init_rc_dev(struct mceusb_dev *ir) 1580 { 1581 struct usb_device *udev = ir->usbdev; 1582 struct device *dev = ir->dev; 1583 struct rc_dev *rc; 1584 int ret; 1585 1586 rc = rc_allocate_device(RC_DRIVER_IR_RAW); 1587 if (!rc) { 1588 dev_err(dev, "remote dev allocation failed"); 1589 goto out; 1590 } 1591 1592 usb_make_path(ir->usbdev, ir->phys, sizeof(ir->phys)); 1593 1594 rc->device_name = mceusb_model[ir->model].name ? : 1595 "Media Center Ed. eHome Infrared Remote Transceiver"; 1596 rc->input_phys = ir->phys; 1597 usb_to_input_id(ir->usbdev, &rc->input_id); 1598 rc->dev.parent = dev; 1599 rc->priv = ir; 1600 rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER; 1601 rc->rx_resolution = MCE_TIME_UNIT; 1602 rc->min_timeout = MCE_TIME_UNIT; 1603 rc->timeout = MS_TO_US(100); 1604 if (!mceusb_model[ir->model].broken_irtimeout) { 1605 rc->s_timeout = mceusb_set_timeout; 1606 rc->max_timeout = 10 * IR_DEFAULT_TIMEOUT; 1607 } else { 1608 /* 1609 * If we can't set the timeout using CMD_SETIRTIMEOUT, we can 1610 * rely on software timeouts for timeouts < 100ms. 1611 */ 1612 rc->max_timeout = rc->timeout; 1613 } 1614 if (!ir->flags.no_tx) { 1615 rc->s_tx_mask = mceusb_set_tx_mask; 1616 rc->s_tx_carrier = mceusb_set_tx_carrier; 1617 rc->tx_ir = mceusb_tx_ir; 1618 } 1619 if (ir->flags.rx2 > 0) { 1620 rc->s_wideband_receiver = mceusb_set_rx_wideband; 1621 rc->s_carrier_report = mceusb_set_rx_carrier_report; 1622 } 1623 rc->driver_name = DRIVER_NAME; 1624 1625 switch (le16_to_cpu(udev->descriptor.idVendor)) { 1626 case VENDOR_HAUPPAUGE: 1627 rc->map_name = RC_MAP_HAUPPAUGE; 1628 break; 1629 case VENDOR_PCTV: 1630 rc->map_name = RC_MAP_PINNACLE_PCTV_HD; 1631 break; 1632 default: 1633 rc->map_name = RC_MAP_RC6_MCE; 1634 } 1635 if (mceusb_model[ir->model].rc_map) 1636 rc->map_name = mceusb_model[ir->model].rc_map; 1637 1638 ret = rc_register_device(rc); 1639 if (ret < 0) { 1640 dev_err(dev, "remote dev registration failed"); 1641 goto out; 1642 } 1643 1644 return rc; 1645 1646 out: 1647 rc_free_device(rc); 1648 return NULL; 1649 } 1650 1651 static int mceusb_dev_probe(struct usb_interface *intf, 1652 const struct usb_device_id *id) 1653 { 1654 struct usb_device *dev = interface_to_usbdev(intf); 1655 struct usb_host_interface *idesc; 1656 struct usb_endpoint_descriptor *ep = NULL; 1657 struct usb_endpoint_descriptor *ep_in = NULL; 1658 struct usb_endpoint_descriptor *ep_out = NULL; 1659 struct mceusb_dev *ir = NULL; 1660 int pipe, maxp, i, res; 1661 char buf[63], name[128] = ""; 1662 enum mceusb_model_type model = id->driver_info; 1663 bool is_gen3; 1664 bool is_microsoft_gen1; 1665 bool tx_mask_normal; 1666 int ir_intfnum; 1667 1668 dev_dbg(&intf->dev, "%s called", __func__); 1669 1670 idesc = intf->cur_altsetting; 1671 1672 is_gen3 = mceusb_model[model].mce_gen3; 1673 is_microsoft_gen1 = mceusb_model[model].mce_gen1; 1674 tx_mask_normal = mceusb_model[model].tx_mask_normal; 1675 ir_intfnum = mceusb_model[model].ir_intfnum; 1676 1677 /* There are multi-function devices with non-IR interfaces */ 1678 if (idesc->desc.bInterfaceNumber != ir_intfnum) 1679 return -ENODEV; 1680 1681 /* step through the endpoints to find first bulk in and out endpoint */ 1682 for (i = 0; i < idesc->desc.bNumEndpoints; ++i) { 1683 ep = &idesc->endpoint[i].desc; 1684 1685 if (ep_in == NULL) { 1686 if (usb_endpoint_is_bulk_in(ep)) { 1687 ep_in = ep; 1688 dev_dbg(&intf->dev, "acceptable bulk inbound endpoint found\n"); 1689 } else if (usb_endpoint_is_int_in(ep)) { 1690 ep_in = ep; 1691 ep_in->bInterval = 1; 1692 dev_dbg(&intf->dev, "acceptable interrupt inbound endpoint found\n"); 1693 } 1694 } 1695 1696 if (ep_out == NULL) { 1697 if (usb_endpoint_is_bulk_out(ep)) { 1698 ep_out = ep; 1699 dev_dbg(&intf->dev, "acceptable bulk outbound endpoint found\n"); 1700 } else if (usb_endpoint_is_int_out(ep)) { 1701 ep_out = ep; 1702 ep_out->bInterval = 1; 1703 dev_dbg(&intf->dev, "acceptable interrupt outbound endpoint found\n"); 1704 } 1705 } 1706 } 1707 if (!ep_in || !ep_out) { 1708 dev_dbg(&intf->dev, "required endpoints not found\n"); 1709 return -ENODEV; 1710 } 1711 1712 if (usb_endpoint_xfer_int(ep_in)) 1713 pipe = usb_rcvintpipe(dev, ep_in->bEndpointAddress); 1714 else 1715 pipe = usb_rcvbulkpipe(dev, ep_in->bEndpointAddress); 1716 maxp = usb_maxpacket(dev, pipe); 1717 1718 ir = kzalloc(sizeof(struct mceusb_dev), GFP_KERNEL); 1719 if (!ir) 1720 goto mem_alloc_fail; 1721 1722 ir->pipe_in = pipe; 1723 ir->buf_in = usb_alloc_coherent(dev, maxp, GFP_KERNEL, &ir->dma_in); 1724 if (!ir->buf_in) 1725 goto buf_in_alloc_fail; 1726 1727 ir->urb_in = usb_alloc_urb(0, GFP_KERNEL); 1728 if (!ir->urb_in) 1729 goto urb_in_alloc_fail; 1730 1731 ir->usbintf = intf; 1732 ir->usbdev = usb_get_dev(dev); 1733 ir->dev = &intf->dev; 1734 ir->len_in = maxp; 1735 ir->flags.microsoft_gen1 = is_microsoft_gen1; 1736 ir->flags.tx_mask_normal = tx_mask_normal; 1737 ir->flags.no_tx = mceusb_model[model].no_tx; 1738 ir->flags.rx2 = mceusb_model[model].rx2; 1739 ir->model = model; 1740 1741 /* Saving usb interface data for use by the transmitter routine */ 1742 ir->usb_ep_out = ep_out; 1743 if (usb_endpoint_xfer_int(ep_out)) 1744 ir->pipe_out = usb_sndintpipe(ir->usbdev, 1745 ep_out->bEndpointAddress); 1746 else 1747 ir->pipe_out = usb_sndbulkpipe(ir->usbdev, 1748 ep_out->bEndpointAddress); 1749 1750 if (dev->descriptor.iManufacturer 1751 && usb_string(dev, dev->descriptor.iManufacturer, 1752 buf, sizeof(buf)) > 0) 1753 strscpy(name, buf, sizeof(name)); 1754 if (dev->descriptor.iProduct 1755 && usb_string(dev, dev->descriptor.iProduct, 1756 buf, sizeof(buf)) > 0) 1757 snprintf(name + strlen(name), sizeof(name) - strlen(name), 1758 " %s", buf); 1759 1760 /* 1761 * Initialize async USB error handler before registering 1762 * or activating any mceusb RX and TX functions 1763 */ 1764 INIT_WORK(&ir->kevent, mceusb_deferred_kevent); 1765 1766 ir->rc = mceusb_init_rc_dev(ir); 1767 if (!ir->rc) 1768 goto rc_dev_fail; 1769 1770 /* wire up inbound data handler */ 1771 if (usb_endpoint_xfer_int(ep_in)) 1772 usb_fill_int_urb(ir->urb_in, dev, pipe, ir->buf_in, maxp, 1773 mceusb_dev_recv, ir, ep_in->bInterval); 1774 else 1775 usb_fill_bulk_urb(ir->urb_in, dev, pipe, ir->buf_in, maxp, 1776 mceusb_dev_recv, ir); 1777 1778 ir->urb_in->transfer_dma = ir->dma_in; 1779 ir->urb_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 1780 1781 /* flush buffers on the device */ 1782 dev_dbg(&intf->dev, "Flushing receive buffers"); 1783 res = usb_submit_urb(ir->urb_in, GFP_KERNEL); 1784 if (res) 1785 dev_err(&intf->dev, "failed to flush buffers: %d", res); 1786 1787 /* figure out which firmware/emulator version this hardware has */ 1788 mceusb_get_emulator_version(ir); 1789 1790 /* initialize device */ 1791 if (ir->flags.microsoft_gen1) 1792 mceusb_gen1_init(ir); 1793 else if (!is_gen3) 1794 mceusb_gen2_init(ir); 1795 1796 mceusb_get_parameters(ir); 1797 1798 mceusb_flash_led(ir); 1799 1800 if (!ir->flags.no_tx) 1801 mceusb_set_tx_mask(ir->rc, MCE_DEFAULT_TX_MASK); 1802 1803 usb_set_intfdata(intf, ir); 1804 1805 /* enable wake via this device */ 1806 device_set_wakeup_capable(ir->dev, true); 1807 device_set_wakeup_enable(ir->dev, true); 1808 1809 dev_info(&intf->dev, "Registered %s with mce emulator interface version %x", 1810 name, ir->emver); 1811 dev_info(&intf->dev, "%x tx ports (0x%x cabled) and %x rx sensors (0x%x active)", 1812 ir->num_txports, ir->txports_cabled, 1813 ir->num_rxports, ir->rxports_active); 1814 1815 return 0; 1816 1817 /* Error-handling path */ 1818 rc_dev_fail: 1819 cancel_work_sync(&ir->kevent); 1820 usb_put_dev(ir->usbdev); 1821 usb_kill_urb(ir->urb_in); 1822 usb_free_urb(ir->urb_in); 1823 urb_in_alloc_fail: 1824 usb_free_coherent(dev, maxp, ir->buf_in, ir->dma_in); 1825 buf_in_alloc_fail: 1826 kfree(ir); 1827 mem_alloc_fail: 1828 dev_err(&intf->dev, "%s: device setup failed!", __func__); 1829 1830 return -ENOMEM; 1831 } 1832 1833 1834 static void mceusb_dev_disconnect(struct usb_interface *intf) 1835 { 1836 struct usb_device *dev = interface_to_usbdev(intf); 1837 struct mceusb_dev *ir = usb_get_intfdata(intf); 1838 1839 dev_dbg(&intf->dev, "%s called", __func__); 1840 1841 usb_set_intfdata(intf, NULL); 1842 1843 if (!ir) 1844 return; 1845 1846 ir->usbdev = NULL; 1847 cancel_work_sync(&ir->kevent); 1848 rc_unregister_device(ir->rc); 1849 usb_kill_urb(ir->urb_in); 1850 usb_free_urb(ir->urb_in); 1851 usb_free_coherent(dev, ir->len_in, ir->buf_in, ir->dma_in); 1852 usb_put_dev(dev); 1853 1854 kfree(ir); 1855 } 1856 1857 static int mceusb_dev_suspend(struct usb_interface *intf, pm_message_t message) 1858 { 1859 struct mceusb_dev *ir = usb_get_intfdata(intf); 1860 dev_info(ir->dev, "suspend"); 1861 usb_kill_urb(ir->urb_in); 1862 return 0; 1863 } 1864 1865 static int mceusb_dev_resume(struct usb_interface *intf) 1866 { 1867 struct mceusb_dev *ir = usb_get_intfdata(intf); 1868 dev_info(ir->dev, "resume"); 1869 if (usb_submit_urb(ir->urb_in, GFP_ATOMIC)) 1870 return -EIO; 1871 return 0; 1872 } 1873 1874 static struct usb_driver mceusb_dev_driver = { 1875 .name = DRIVER_NAME, 1876 .probe = mceusb_dev_probe, 1877 .disconnect = mceusb_dev_disconnect, 1878 .suspend = mceusb_dev_suspend, 1879 .resume = mceusb_dev_resume, 1880 .reset_resume = mceusb_dev_resume, 1881 .id_table = mceusb_dev_table 1882 }; 1883 1884 module_usb_driver(mceusb_dev_driver); 1885 1886 MODULE_DESCRIPTION(DRIVER_DESC); 1887 MODULE_AUTHOR(DRIVER_AUTHOR); 1888 MODULE_LICENSE("GPL"); 1889 MODULE_DEVICE_TABLE(usb, mceusb_dev_table); 1890