2 * Driver for USB Windows Media Center Ed. eHome Infrared Transceivers
4 * Copyright (c) 2010-2011, Jarod Wilson <jarod@redhat.com>
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.
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
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.
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.
36 #include <linux/device.h>
37 #include <linux/module.h>
38 #include <linux/slab.h>
39 #include <linux/workqueue.h>
40 #include <linux/usb.h>
41 #include <linux/usb/input.h>
42 #include <linux/pm_wakeup.h>
43 #include <media/rc-core.h>
45 #define DRIVER_VERSION "1.93"
46 #define DRIVER_AUTHOR "Jarod Wilson <jarod@redhat.com>"
47 #define DRIVER_DESC "Windows Media Center Ed. eHome Infrared Transceiver " \
49 #define DRIVER_NAME "mceusb"
51 #define USB_CTRL_MSG_SZ 2 /* Size of usb ctrl msg on gen1 hw */
52 #define MCE_G1_INIT_MSGS 40 /* Init messages on gen1 hw to throw out */
55 #define MCE_CMDBUF_SIZE 384 /* MCE Command buffer length */
56 #define MCE_TIME_UNIT 50 /* Approx 50us resolution */
57 #define MCE_CODE_LENGTH 5 /* Normal length of packet (with header) */
58 #define MCE_PACKET_SIZE 4 /* Normal length of packet (without header) */
59 #define MCE_IRDATA_HEADER 0x84 /* Actual header format is 0x80 + num_bytes */
60 #define MCE_IRDATA_TRAILER 0x80 /* End of IR data */
61 #define MCE_MAX_CHANNELS 2 /* Two transmitters, hardware dependent? */
62 #define MCE_DEFAULT_TX_MASK 0x03 /* Vals: TX1=0x01, TX2=0x02, ALL=0x03 */
63 #define MCE_PULSE_BIT 0x80 /* Pulse bit, MSB set == PULSE else SPACE */
64 #define MCE_PULSE_MASK 0x7f /* Pulse mask */
65 #define MCE_MAX_PULSE_LENGTH 0x7f /* Longest transmittable pulse symbol */
68 * The interface between the host and the IR hardware is command-response
69 * based. All commands and responses have a consistent format, where a lead
70 * byte always identifies the type of data following it. The lead byte has
71 * a port value in the 3 highest bits and a length value in the 5 lowest
74 * The length field is overloaded, with a value of 11111 indicating that the
75 * following byte is a command or response code, and the length of the entire
76 * message is determined by the code. If the length field is not 11111, then
77 * it specifies the number of bytes of port data that follow.
80 #define MCE_PORT_IR 0x4 /* (0x4 << 5) | MCE_CMD = 0x9f */
81 #define MCE_PORT_SYS 0x7 /* (0x7 << 5) | MCE_CMD = 0xff */
82 #define MCE_PORT_SER 0x6 /* 0xc0 thru 0xdf flush & 0x1f bytes */
83 #define MCE_PORT_MASK 0xe0 /* Mask out command bits */
85 /* Command port headers */
86 #define MCE_CMD_PORT_IR 0x9f /* IR-related cmd/rsp */
87 #define MCE_CMD_PORT_SYS 0xff /* System (non-IR) device cmd/rsp */
89 /* Commands that set device state (2-4 bytes in length) */
90 #define MCE_CMD_RESET 0xfe /* Reset device, 2 bytes */
91 #define MCE_CMD_RESUME 0xaa /* Resume device after error, 2 bytes */
92 #define MCE_CMD_SETIRCFS 0x06 /* Set tx carrier, 4 bytes */
93 #define MCE_CMD_SETIRTIMEOUT 0x0c /* Set timeout, 4 bytes */
94 #define MCE_CMD_SETIRTXPORTS 0x08 /* Set tx ports, 3 bytes */
95 #define MCE_CMD_SETIRRXPORTEN 0x14 /* Set rx ports, 3 bytes */
96 #define MCE_CMD_FLASHLED 0x23 /* Flash receiver LED, 2 bytes */
98 /* Commands that query device state (all 2 bytes, unless noted) */
99 #define MCE_CMD_GETIRCFS 0x07 /* Get carrier */
100 #define MCE_CMD_GETIRTIMEOUT 0x0d /* Get timeout */
101 #define MCE_CMD_GETIRTXPORTS 0x13 /* Get tx ports */
102 #define MCE_CMD_GETIRRXPORTEN 0x15 /* Get rx ports */
103 #define MCE_CMD_GETPORTSTATUS 0x11 /* Get tx port status, 3 bytes */
104 #define MCE_CMD_GETIRNUMPORTS 0x16 /* Get number of ports */
105 #define MCE_CMD_GETWAKESOURCE 0x17 /* Get wake source */
106 #define MCE_CMD_GETEMVER 0x22 /* Get emulator interface version */
107 #define MCE_CMD_GETDEVDETAILS 0x21 /* Get device details (em ver2 only) */
108 #define MCE_CMD_GETWAKESUPPORT 0x20 /* Get wake details (em ver2 only) */
109 #define MCE_CMD_GETWAKEVERSION 0x18 /* Get wake pattern (em ver2 only) */
112 #define MCE_CMD_NOP 0xff /* No operation */
114 /* Responses to commands (non-error cases) */
115 #define MCE_RSP_EQIRCFS 0x06 /* tx carrier, 4 bytes */
116 #define MCE_RSP_EQIRTIMEOUT 0x0c /* rx timeout, 4 bytes */
117 #define MCE_RSP_GETWAKESOURCE 0x17 /* wake source, 3 bytes */
118 #define MCE_RSP_EQIRTXPORTS 0x08 /* tx port mask, 3 bytes */
119 #define MCE_RSP_EQIRRXPORTEN 0x14 /* rx port mask, 3 bytes */
120 #define MCE_RSP_GETPORTSTATUS 0x11 /* tx port status, 7 bytes */
121 #define MCE_RSP_EQIRRXCFCNT 0x15 /* rx carrier count, 4 bytes */
122 #define MCE_RSP_EQIRNUMPORTS 0x16 /* number of ports, 4 bytes */
123 #define MCE_RSP_EQWAKESUPPORT 0x20 /* wake capabilities, 3 bytes */
124 #define MCE_RSP_EQWAKEVERSION 0x18 /* wake pattern details, 6 bytes */
125 #define MCE_RSP_EQDEVDETAILS 0x21 /* device capabilities, 3 bytes */
126 #define MCE_RSP_EQEMVER 0x22 /* emulator interface ver, 3 bytes */
127 #define MCE_RSP_FLASHLED 0x23 /* success flashing LED, 2 bytes */
129 /* Responses to error cases, must send MCE_CMD_RESUME to clear them */
130 #define MCE_RSP_CMD_ILLEGAL 0xfe /* illegal command for port, 2 bytes */
131 #define MCE_RSP_TX_TIMEOUT 0x81 /* tx timed out, 2 bytes */
133 /* Misc commands/responses not defined in the MCE remote/transceiver spec */
134 #define MCE_CMD_SIG_END 0x01 /* End of signal */
135 #define MCE_CMD_PING 0x03 /* Ping device */
136 #define MCE_CMD_UNKNOWN 0x04 /* Unknown */
137 #define MCE_CMD_UNKNOWN2 0x05 /* Unknown */
138 #define MCE_CMD_UNKNOWN3 0x09 /* Unknown */
139 #define MCE_CMD_UNKNOWN4 0x0a /* Unknown */
140 #define MCE_CMD_G_REVISION 0x0b /* Get hw/sw revision */
141 #define MCE_CMD_UNKNOWN5 0x0e /* Unknown */
142 #define MCE_CMD_UNKNOWN6 0x0f /* Unknown */
143 #define MCE_CMD_UNKNOWN8 0x19 /* Unknown */
144 #define MCE_CMD_UNKNOWN9 0x1b /* Unknown */
145 #define MCE_CMD_NULL 0x00 /* These show up various places... */
147 /* if buf[i] & MCE_PORT_MASK == 0x80 and buf[i] != MCE_CMD_PORT_IR,
148 * then we're looking at a raw IR data sample */
149 #define MCE_COMMAND_IRDATA 0x80
150 #define MCE_PACKET_LENGTH_MASK 0x1f /* Packet length mask */
152 #define VENDOR_PHILIPS 0x0471
153 #define VENDOR_SMK 0x0609
154 #define VENDOR_TATUNG 0x1460
155 #define VENDOR_GATEWAY 0x107b
156 #define VENDOR_SHUTTLE 0x1308
157 #define VENDOR_SHUTTLE2 0x051c
158 #define VENDOR_MITSUMI 0x03ee
159 #define VENDOR_TOPSEED 0x1784
160 #define VENDOR_RICAVISION 0x179d
161 #define VENDOR_ITRON 0x195d
162 #define VENDOR_FIC 0x1509
163 #define VENDOR_LG 0x043e
164 #define VENDOR_MICROSOFT 0x045e
165 #define VENDOR_FORMOSA 0x147a
166 #define VENDOR_FINTEK 0x1934
167 #define VENDOR_PINNACLE 0x2304
168 #define VENDOR_ECS 0x1019
169 #define VENDOR_WISTRON 0x0fb8
170 #define VENDOR_COMPRO 0x185b
171 #define VENDOR_NORTHSTAR 0x04eb
172 #define VENDOR_REALTEK 0x0bda
173 #define VENDOR_TIVO 0x105a
174 #define VENDOR_CONEXANT 0x0572
175 #define VENDOR_TWISTEDMELON 0x2596
176 #define VENDOR_HAUPPAUGE 0x2040
177 #define VENDOR_PCTV 0x2013
178 #define VENDOR_ADAPTEC 0x03f3
180 enum mceusb_model_type {
181 MCE_GEN2 = 0, /* Most boards */
190 HAUPPAUGE_CX_HYBRID_TV,
193 struct mceusb_model {
197 u32 tx_mask_normal:1;
202 const char *rc_map; /* Allow specify a per-board map */
203 const char *name; /* per-board name */
206 static const struct mceusb_model mceusb_model[] = {
218 [MCE_GEN2_TX_INV] = {
228 * In fact, the EVK is shipped without
229 * remotes, but we should have something handy,
230 * to allow testing it
232 .name = "Conexant Hybrid TV (cx231xx) MCE IR",
235 .no_tx = 1, /* tx isn't wired up at all */
236 .name = "Conexant Hybrid TV (cx231xx) MCE IR",
238 [HAUPPAUGE_CX_HYBRID_TV] = {
239 .no_tx = 1, /* eeprom says it has no tx */
240 .name = "Conexant Hybrid TV (cx231xx) MCE IR no TX",
248 .rc_map = RC_MAP_TIVO,
252 static struct usb_device_id mceusb_dev_table[] = {
253 /* Original Microsoft MCE IR Transceiver (often HP-branded) */
254 { USB_DEVICE(VENDOR_MICROSOFT, 0x006d),
255 .driver_info = MCE_GEN1 },
256 /* Philips Infrared Transceiver - Sahara branded */
257 { USB_DEVICE(VENDOR_PHILIPS, 0x0608) },
258 /* Philips Infrared Transceiver - HP branded */
259 { USB_DEVICE(VENDOR_PHILIPS, 0x060c),
260 .driver_info = MCE_GEN2_TX_INV },
261 /* Philips SRM5100 */
262 { USB_DEVICE(VENDOR_PHILIPS, 0x060d) },
263 /* Philips Infrared Transceiver - Omaura */
264 { USB_DEVICE(VENDOR_PHILIPS, 0x060f) },
265 /* Philips Infrared Transceiver - Spinel plus */
266 { USB_DEVICE(VENDOR_PHILIPS, 0x0613) },
267 /* Philips eHome Infrared Transceiver */
268 { USB_DEVICE(VENDOR_PHILIPS, 0x0815) },
269 /* Philips/Spinel plus IR transceiver for ASUS */
270 { USB_DEVICE(VENDOR_PHILIPS, 0x206c) },
271 /* Philips/Spinel plus IR transceiver for ASUS */
272 { USB_DEVICE(VENDOR_PHILIPS, 0x2088) },
273 /* Philips IR transceiver (Dell branded) */
274 { USB_DEVICE(VENDOR_PHILIPS, 0x2093),
275 .driver_info = MCE_GEN2_TX_INV },
276 /* Realtek MCE IR Receiver and card reader */
277 { USB_DEVICE(VENDOR_REALTEK, 0x0161),
278 .driver_info = MULTIFUNCTION },
279 /* SMK/Toshiba G83C0004D410 */
280 { USB_DEVICE(VENDOR_SMK, 0x031d),
281 .driver_info = MCE_GEN2_TX_INV },
282 /* SMK eHome Infrared Transceiver (Sony VAIO) */
283 { USB_DEVICE(VENDOR_SMK, 0x0322),
284 .driver_info = MCE_GEN2_TX_INV },
285 /* bundled with Hauppauge PVR-150 */
286 { USB_DEVICE(VENDOR_SMK, 0x0334),
287 .driver_info = MCE_GEN2_TX_INV },
288 /* SMK eHome Infrared Transceiver */
289 { USB_DEVICE(VENDOR_SMK, 0x0338) },
290 /* SMK/I-O Data GV-MC7/RCKIT Receiver */
291 { USB_DEVICE(VENDOR_SMK, 0x0353),
292 .driver_info = MCE_GEN2_NO_TX },
293 /* SMK RXX6000 Infrared Receiver */
294 { USB_DEVICE(VENDOR_SMK, 0x0357),
295 .driver_info = MCE_GEN2_NO_TX },
296 /* Tatung eHome Infrared Transceiver */
297 { USB_DEVICE(VENDOR_TATUNG, 0x9150) },
298 /* Shuttle eHome Infrared Transceiver */
299 { USB_DEVICE(VENDOR_SHUTTLE, 0xc001) },
300 /* Shuttle eHome Infrared Transceiver */
301 { USB_DEVICE(VENDOR_SHUTTLE2, 0xc001) },
302 /* Gateway eHome Infrared Transceiver */
303 { USB_DEVICE(VENDOR_GATEWAY, 0x3009) },
305 { USB_DEVICE(VENDOR_MITSUMI, 0x2501) },
306 /* Topseed eHome Infrared Transceiver */
307 { USB_DEVICE(VENDOR_TOPSEED, 0x0001),
308 .driver_info = MCE_GEN2_TX_INV },
309 /* Topseed HP eHome Infrared Transceiver */
310 { USB_DEVICE(VENDOR_TOPSEED, 0x0006),
311 .driver_info = MCE_GEN2_TX_INV },
312 /* Topseed eHome Infrared Transceiver */
313 { USB_DEVICE(VENDOR_TOPSEED, 0x0007),
314 .driver_info = MCE_GEN2_TX_INV },
315 /* Topseed eHome Infrared Transceiver */
316 { USB_DEVICE(VENDOR_TOPSEED, 0x0008),
317 .driver_info = MCE_GEN3 },
318 /* Topseed eHome Infrared Transceiver */
319 { USB_DEVICE(VENDOR_TOPSEED, 0x000a),
320 .driver_info = MCE_GEN2_TX_INV },
321 /* Topseed eHome Infrared Transceiver */
322 { USB_DEVICE(VENDOR_TOPSEED, 0x0011),
323 .driver_info = MCE_GEN3 },
324 /* Ricavision internal Infrared Transceiver */
325 { USB_DEVICE(VENDOR_RICAVISION, 0x0010) },
326 /* Itron ione Libra Q-11 */
327 { USB_DEVICE(VENDOR_ITRON, 0x7002) },
328 /* FIC eHome Infrared Transceiver */
329 { USB_DEVICE(VENDOR_FIC, 0x9242) },
330 /* LG eHome Infrared Transceiver */
331 { USB_DEVICE(VENDOR_LG, 0x9803) },
332 /* Microsoft MCE Infrared Transceiver */
333 { USB_DEVICE(VENDOR_MICROSOFT, 0x00a0) },
334 /* Formosa eHome Infrared Transceiver */
335 { USB_DEVICE(VENDOR_FORMOSA, 0xe015) },
336 /* Formosa21 / eHome Infrared Receiver */
337 { USB_DEVICE(VENDOR_FORMOSA, 0xe016) },
338 /* Formosa aim / Trust MCE Infrared Receiver */
339 { USB_DEVICE(VENDOR_FORMOSA, 0xe017),
340 .driver_info = MCE_GEN2_NO_TX },
341 /* Formosa Industrial Computing / Beanbag Emulation Device */
342 { USB_DEVICE(VENDOR_FORMOSA, 0xe018) },
343 /* Formosa21 / eHome Infrared Receiver */
344 { USB_DEVICE(VENDOR_FORMOSA, 0xe03a) },
345 /* Formosa Industrial Computing AIM IR605/A */
346 { USB_DEVICE(VENDOR_FORMOSA, 0xe03c) },
347 /* Formosa Industrial Computing */
348 { USB_DEVICE(VENDOR_FORMOSA, 0xe03e) },
349 /* Formosa Industrial Computing */
350 { USB_DEVICE(VENDOR_FORMOSA, 0xe042) },
351 /* Fintek eHome Infrared Transceiver (HP branded) */
352 { USB_DEVICE(VENDOR_FINTEK, 0x5168),
353 .driver_info = MCE_GEN2_TX_INV },
354 /* Fintek eHome Infrared Transceiver */
355 { USB_DEVICE(VENDOR_FINTEK, 0x0602) },
356 /* Fintek eHome Infrared Transceiver (in the AOpen MP45) */
357 { USB_DEVICE(VENDOR_FINTEK, 0x0702) },
358 /* Pinnacle Remote Kit */
359 { USB_DEVICE(VENDOR_PINNACLE, 0x0225),
360 .driver_info = MCE_GEN3 },
361 /* Elitegroup Computer Systems IR */
362 { USB_DEVICE(VENDOR_ECS, 0x0f38) },
363 /* Wistron Corp. eHome Infrared Receiver */
364 { USB_DEVICE(VENDOR_WISTRON, 0x0002) },
366 { USB_DEVICE(VENDOR_COMPRO, 0x3020) },
368 { USB_DEVICE(VENDOR_COMPRO, 0x3082) },
369 /* Northstar Systems, Inc. eHome Infrared Transceiver */
370 { USB_DEVICE(VENDOR_NORTHSTAR, 0xe004) },
371 /* TiVo PC IR Receiver */
372 { USB_DEVICE(VENDOR_TIVO, 0x2000),
373 .driver_info = TIVO_KIT },
374 /* Conexant Hybrid TV "Shelby" Polaris SDK */
375 { USB_DEVICE(VENDOR_CONEXANT, 0x58a1),
376 .driver_info = POLARIS_EVK },
377 /* Conexant Hybrid TV RDU253S Polaris */
378 { USB_DEVICE(VENDOR_CONEXANT, 0x58a5),
379 .driver_info = CX_HYBRID_TV },
380 /* Twisted Melon Inc. - Manta Mini Receiver */
381 { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8008) },
382 /* Twisted Melon Inc. - Manta Pico Receiver */
383 { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8016) },
384 /* Twisted Melon Inc. - Manta Transceiver */
385 { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8042) },
386 /* Hauppauge WINTV-HVR-HVR 930C-HD - based on cx231xx */
387 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb130),
388 .driver_info = HAUPPAUGE_CX_HYBRID_TV },
389 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb131),
390 .driver_info = HAUPPAUGE_CX_HYBRID_TV },
391 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb138),
392 .driver_info = HAUPPAUGE_CX_HYBRID_TV },
393 { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb139),
394 .driver_info = HAUPPAUGE_CX_HYBRID_TV },
395 { USB_DEVICE(VENDOR_PCTV, 0x0259),
396 .driver_info = HAUPPAUGE_CX_HYBRID_TV },
397 { USB_DEVICE(VENDOR_PCTV, 0x025e),
398 .driver_info = HAUPPAUGE_CX_HYBRID_TV },
399 /* Adaptec / HP eHome Receiver */
400 { USB_DEVICE(VENDOR_ADAPTEC, 0x0094) },
402 /* Terminating entry */
406 /* data structure for each usb transceiver */
411 /* optional features we can enable */
412 bool learning_enabled;
414 /* core device bits */
418 struct usb_device *usbdev;
420 unsigned int pipe_in;
421 struct usb_endpoint_descriptor *usb_ep_out;
422 unsigned int pipe_out;
424 /* buffers and dma */
425 unsigned char *buf_in;
436 u8 cmd, rem; /* Remaining IR data bytes in packet */
440 u32 tx_mask_normal:1;
441 u32 microsoft_gen1:1;
445 /* transmit support */
447 unsigned char tx_mask;
451 enum mceusb_model_type model;
453 bool need_reset; /* flag to issue a device resume cmd */
454 u8 emver; /* emulator interface version */
455 u8 num_txports; /* number of transmit ports */
456 u8 num_rxports; /* number of receive sensors */
457 u8 txports_cabled; /* bitmask of transmitters with cable */
458 u8 rxports_active; /* bitmask of active receive sensors */
461 * support for async error handler mceusb_deferred_kevent()
462 * where usb_clear_halt(), usb_reset_configuration(),
463 * usb_reset_device(), etc. must be done in process context
465 struct work_struct kevent;
466 unsigned long kevent_flags;
467 # define EVENT_TX_HALT 0
468 # define EVENT_RX_HALT 1
471 /* MCE Device Command Strings, generally a port and command pair */
472 static char DEVICE_RESUME[] = {MCE_CMD_NULL, MCE_CMD_PORT_SYS,
474 static char GET_REVISION[] = {MCE_CMD_PORT_SYS, MCE_CMD_G_REVISION};
475 static char GET_EMVER[] = {MCE_CMD_PORT_SYS, MCE_CMD_GETEMVER};
476 static char GET_WAKEVERSION[] = {MCE_CMD_PORT_SYS, MCE_CMD_GETWAKEVERSION};
477 static char FLASH_LED[] = {MCE_CMD_PORT_SYS, MCE_CMD_FLASHLED};
478 static char GET_UNKNOWN2[] = {MCE_CMD_PORT_IR, MCE_CMD_UNKNOWN2};
479 static char GET_CARRIER_FREQ[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRCFS};
480 static char GET_RX_TIMEOUT[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTIMEOUT};
481 static char GET_NUM_PORTS[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRNUMPORTS};
482 static char GET_TX_BITMASK[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTXPORTS};
483 static char GET_RX_SENSOR[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRRXPORTEN};
484 /* sub in desired values in lower byte or bytes for full command */
485 /* FIXME: make use of these for transmit.
486 static char SET_CARRIER_FREQ[] = {MCE_CMD_PORT_IR,
487 MCE_CMD_SETIRCFS, 0x00, 0x00};
488 static char SET_TX_BITMASK[] = {MCE_CMD_PORT_IR, MCE_CMD_SETIRTXPORTS, 0x00};
489 static char SET_RX_TIMEOUT[] = {MCE_CMD_PORT_IR,
490 MCE_CMD_SETIRTIMEOUT, 0x00, 0x00};
491 static char SET_RX_SENSOR[] = {MCE_CMD_PORT_IR,
492 MCE_RSP_EQIRRXPORTEN, 0x00};
495 static int mceusb_cmd_datasize(u8 cmd, u8 subcmd)
501 if (subcmd == MCE_CMD_PORT_SYS)
504 case MCE_CMD_PORT_SYS:
506 case MCE_RSP_GETPORTSTATUS:
509 case MCE_RSP_EQWAKEVERSION:
512 case MCE_CMD_G_REVISION:
515 case MCE_RSP_EQWAKESUPPORT:
516 case MCE_RSP_GETWAKESOURCE:
517 case MCE_RSP_EQDEVDETAILS:
518 case MCE_RSP_EQEMVER:
522 case MCE_CMD_PORT_IR:
524 case MCE_CMD_UNKNOWN:
525 case MCE_RSP_EQIRCFS:
526 case MCE_RSP_EQIRTIMEOUT:
527 case MCE_RSP_EQIRRXCFCNT:
528 case MCE_RSP_EQIRNUMPORTS:
531 case MCE_CMD_SIG_END:
532 case MCE_RSP_EQIRTXPORTS:
533 case MCE_RSP_EQIRRXPORTEN:
541 static void mceusb_dev_printdata(struct mceusb_dev *ir, u8 *buf, int buf_len,
542 int offset, int len, bool out)
544 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
546 u8 cmd, subcmd, *data;
547 struct device *dev = ir->dev;
551 /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
552 if (ir->flags.microsoft_gen1 && !out && !offset)
558 dev_dbg(dev, "%cx data: %*ph (length=%d)",
560 min(len, buf_len - offset), buf + offset, len);
562 inout = out ? "Request" : "Got";
564 start = offset + skip;
565 cmd = buf[start] & 0xff;
566 subcmd = buf[start + 1] & 0xff;
567 data = buf + start + 2;
571 if (subcmd == MCE_CMD_NULL)
573 if ((subcmd == MCE_CMD_PORT_SYS) &&
574 (data[0] == MCE_CMD_RESUME))
575 dev_dbg(dev, "Device resume requested");
577 dev_dbg(dev, "Unknown command 0x%02x 0x%02x",
580 case MCE_CMD_PORT_SYS:
582 case MCE_RSP_EQEMVER:
584 dev_dbg(dev, "Emulator interface version %x",
587 case MCE_CMD_G_REVISION:
589 dev_dbg(dev, "Get hw/sw rev?");
591 dev_dbg(dev, "hw/sw rev %*ph",
595 dev_dbg(dev, "Device resume requested");
597 case MCE_RSP_CMD_ILLEGAL:
598 dev_dbg(dev, "Illegal PORT_SYS command");
600 case MCE_RSP_EQWAKEVERSION:
602 dev_dbg(dev, "Wake version, proto: 0x%02x, payload: 0x%02x, address: 0x%02x, version: 0x%02x",
603 data[0], data[1], data[2], data[3]);
605 case MCE_RSP_GETPORTSTATUS:
607 /* We use data1 + 1 here, to match hw labels */
608 dev_dbg(dev, "TX port %d: blaster is%s connected",
609 data[0] + 1, data[3] ? " not" : "");
611 case MCE_CMD_FLASHLED:
612 dev_dbg(dev, "Attempting to flash LED");
615 dev_dbg(dev, "Unknown command 0x%02x 0x%02x",
620 case MCE_CMD_PORT_IR:
622 case MCE_CMD_SIG_END:
623 dev_dbg(dev, "End of signal");
626 dev_dbg(dev, "Ping");
628 case MCE_CMD_UNKNOWN:
629 dev_dbg(dev, "Resp to 9f 05 of 0x%02x 0x%02x",
632 case MCE_RSP_EQIRCFS:
633 if (!data[0] && !data[1]) {
634 dev_dbg(dev, "%s: no carrier", inout);
637 // prescaler should make sense
640 period = DIV_ROUND_CLOSEST((1U << data[0] * 2) *
644 carrier = USEC_PER_SEC / period;
645 dev_dbg(dev, "%s carrier of %u Hz (period %uus)",
646 inout, carrier, period);
648 case MCE_CMD_GETIRCFS:
649 dev_dbg(dev, "Get carrier mode and freq");
651 case MCE_RSP_EQIRTXPORTS:
652 dev_dbg(dev, "%s transmit blaster mask of 0x%02x",
655 case MCE_RSP_EQIRTIMEOUT:
656 /* value is in units of 50us, so x*50/1000 ms */
657 period = ((data[0] << 8) | data[1]) *
658 MCE_TIME_UNIT / 1000;
659 dev_dbg(dev, "%s receive timeout of %d ms",
662 case MCE_CMD_GETIRTIMEOUT:
663 dev_dbg(dev, "Get receive timeout");
665 case MCE_CMD_GETIRTXPORTS:
666 dev_dbg(dev, "Get transmit blaster mask");
668 case MCE_RSP_EQIRRXPORTEN:
669 dev_dbg(dev, "%s %s-range receive sensor in use",
670 inout, data[0] == 0x02 ? "short" : "long");
672 case MCE_CMD_GETIRRXPORTEN:
673 /* aka MCE_RSP_EQIRRXCFCNT */
675 dev_dbg(dev, "Get receive sensor");
676 else if (ir->learning_enabled)
677 dev_dbg(dev, "RX pulse count: %d",
678 ((data[0] << 8) | data[1]));
680 case MCE_RSP_EQIRNUMPORTS:
683 dev_dbg(dev, "Num TX ports: %x, num RX ports: %x",
686 case MCE_RSP_CMD_ILLEGAL:
687 dev_dbg(dev, "Illegal PORT_IR command");
690 dev_dbg(dev, "Unknown command 0x%02x 0x%02x",
699 if (cmd == MCE_IRDATA_TRAILER)
700 dev_dbg(dev, "End of raw IR data");
701 else if ((cmd != MCE_CMD_PORT_IR) &&
702 ((cmd & MCE_PORT_MASK) == MCE_COMMAND_IRDATA))
703 dev_dbg(dev, "Raw IR data, %d pulse/space samples", ir->rem);
708 * Schedule work that can't be done in interrupt handlers
709 * (mceusb_dev_recv() and mce_async_callback()) nor tasklets.
710 * Invokes mceusb_deferred_kevent() for recovering from
711 * error events specified by the kevent bit field.
713 static void mceusb_defer_kevent(struct mceusb_dev *ir, int kevent)
715 set_bit(kevent, &ir->kevent_flags);
716 if (!schedule_work(&ir->kevent))
717 dev_err(ir->dev, "kevent %d may have been dropped", kevent);
719 dev_dbg(ir->dev, "kevent %d scheduled", kevent);
722 static void mce_async_callback(struct urb *urb)
724 struct mceusb_dev *ir;
732 switch (urb->status) {
735 len = urb->actual_length;
737 mceusb_dev_printdata(ir, urb->transfer_buffer, len,
748 dev_err(ir->dev, "Error: request urb status = %d (TX HALT)",
750 mceusb_defer_kevent(ir, EVENT_TX_HALT);
754 dev_err(ir->dev, "Error: request urb status = %d", urb->status);
758 /* the transfer buffer and urb were allocated in mce_request_packet */
759 kfree(urb->transfer_buffer);
763 /* request outgoing (send) usb packet - used to initialize remote */
764 static void mce_request_packet(struct mceusb_dev *ir, unsigned char *data,
768 struct urb *async_urb;
769 struct device *dev = ir->dev;
770 unsigned char *async_buf;
772 async_urb = usb_alloc_urb(0, GFP_KERNEL);
773 if (unlikely(!async_urb)) {
774 dev_err(dev, "Error, couldn't allocate urb!");
778 async_buf = kmalloc(size, GFP_KERNEL);
780 usb_free_urb(async_urb);
785 if (usb_endpoint_xfer_int(ir->usb_ep_out))
786 usb_fill_int_urb(async_urb, ir->usbdev, ir->pipe_out,
787 async_buf, size, mce_async_callback, ir,
788 ir->usb_ep_out->bInterval);
790 usb_fill_bulk_urb(async_urb, ir->usbdev, ir->pipe_out,
791 async_buf, size, mce_async_callback, ir);
793 memcpy(async_buf, data, size);
795 dev_dbg(dev, "send request called (size=%#x)", size);
797 res = usb_submit_urb(async_urb, GFP_ATOMIC);
799 dev_err(dev, "send request FAILED! (res=%d)", res);
801 usb_free_urb(async_urb);
804 dev_dbg(dev, "send request complete (res=%d)", res);
807 static void mce_async_out(struct mceusb_dev *ir, unsigned char *data, int size)
809 int rsize = sizeof(DEVICE_RESUME);
811 if (ir->need_reset) {
812 ir->need_reset = false;
813 mce_request_packet(ir, DEVICE_RESUME, rsize);
817 mce_request_packet(ir, data, size);
821 /* Send data out the IR blaster port(s) */
822 static int mceusb_tx_ir(struct rc_dev *dev, unsigned *txbuf, unsigned count)
824 struct mceusb_dev *ir = dev->priv;
825 int i, length, ret = 0;
827 unsigned char cmdbuf[MCE_CMDBUF_SIZE];
829 /* MCE tx init header */
830 cmdbuf[cmdcount++] = MCE_CMD_PORT_IR;
831 cmdbuf[cmdcount++] = MCE_CMD_SETIRTXPORTS;
832 cmdbuf[cmdcount++] = ir->tx_mask;
834 /* Send the set TX ports command */
835 mce_async_out(ir, cmdbuf, cmdcount);
838 /* Generate mce packet data */
839 for (i = 0; (i < count) && (cmdcount < MCE_CMDBUF_SIZE); i++) {
840 txbuf[i] = txbuf[i] / MCE_TIME_UNIT;
842 do { /* loop to support long pulses/spaces > 127*50us=6.35ms */
844 /* Insert mce packet header every 4th entry */
845 if ((cmdcount < MCE_CMDBUF_SIZE) &&
846 (cmdcount % MCE_CODE_LENGTH) == 0)
847 cmdbuf[cmdcount++] = MCE_IRDATA_HEADER;
849 /* Insert mce packet data */
850 if (cmdcount < MCE_CMDBUF_SIZE)
852 (txbuf[i] < MCE_PULSE_BIT ?
853 txbuf[i] : MCE_MAX_PULSE_LENGTH) |
854 (i & 1 ? 0x00 : MCE_PULSE_BIT);
860 } while ((txbuf[i] > MCE_MAX_PULSE_LENGTH) &&
861 (txbuf[i] -= MCE_MAX_PULSE_LENGTH));
864 /* Check if we have room for the empty packet at the end */
865 if (cmdcount >= MCE_CMDBUF_SIZE) {
870 /* Fix packet length in last header */
871 length = cmdcount % MCE_CODE_LENGTH;
872 cmdbuf[cmdcount - length] -= MCE_CODE_LENGTH - length;
874 /* All mce commands end with an empty packet (0x80) */
875 cmdbuf[cmdcount++] = MCE_IRDATA_TRAILER;
877 /* Transmit the command to the mce device */
878 mce_async_out(ir, cmdbuf, cmdcount);
881 return ret ? ret : count;
884 /* Sets active IR outputs -- mce devices typically have two */
885 static int mceusb_set_tx_mask(struct rc_dev *dev, u32 mask)
887 struct mceusb_dev *ir = dev->priv;
889 /* return number of transmitters */
890 int emitters = ir->num_txports ? ir->num_txports : 2;
892 if (mask >= (1 << emitters))
895 if (ir->flags.tx_mask_normal)
898 ir->tx_mask = (mask != MCE_DEFAULT_TX_MASK ?
899 mask ^ MCE_DEFAULT_TX_MASK : mask) << 1;
904 /* Sets the send carrier frequency and mode */
905 static int mceusb_set_tx_carrier(struct rc_dev *dev, u32 carrier)
907 struct mceusb_dev *ir = dev->priv;
909 int prescaler = 0, divisor = 0;
910 unsigned char cmdbuf[4] = { MCE_CMD_PORT_IR,
911 MCE_CMD_SETIRCFS, 0x00, 0x00 };
913 /* Carrier has changed */
914 if (ir->carrier != carrier) {
917 ir->carrier = carrier;
918 cmdbuf[2] = MCE_CMD_SIG_END;
919 cmdbuf[3] = MCE_IRDATA_TRAILER;
920 dev_dbg(ir->dev, "disabling carrier modulation");
921 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
925 for (prescaler = 0; prescaler < 4; ++prescaler) {
926 divisor = (clk >> (2 * prescaler)) / carrier;
927 if (divisor <= 0xff) {
928 ir->carrier = carrier;
929 cmdbuf[2] = prescaler;
931 dev_dbg(ir->dev, "requesting %u HZ carrier",
934 /* Transmit new carrier to mce device */
935 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
948 * We don't do anything but print debug spew for many of the command bits
949 * we receive from the hardware, but some of them are useful information
950 * we want to store so that we can use them.
952 static void mceusb_handle_command(struct mceusb_dev *ir, int index)
954 u8 hi = ir->buf_in[index + 1] & 0xff;
955 u8 lo = ir->buf_in[index + 2] & 0xff;
957 switch (ir->buf_in[index]) {
958 /* the one and only 5-byte return value command */
959 case MCE_RSP_GETPORTSTATUS:
960 if ((ir->buf_in[index + 4] & 0xff) == 0x00)
961 ir->txports_cabled |= 1 << hi;
964 /* 2-byte return value commands */
965 case MCE_RSP_EQIRTIMEOUT:
966 ir->rc->timeout = US_TO_NS((hi << 8 | lo) * MCE_TIME_UNIT);
968 case MCE_RSP_EQIRNUMPORTS:
969 ir->num_txports = hi;
970 ir->num_rxports = lo;
973 /* 1-byte return value commands */
974 case MCE_RSP_EQEMVER:
977 case MCE_RSP_EQIRTXPORTS:
980 case MCE_RSP_EQIRRXPORTEN:
981 ir->learning_enabled = ((hi & 0x02) == 0x02);
982 ir->rxports_active = hi;
984 case MCE_RSP_CMD_ILLEGAL:
985 ir->need_reset = true;
992 static void mceusb_process_ir_data(struct mceusb_dev *ir, int buf_len)
994 DEFINE_IR_RAW_EVENT(rawir);
998 /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
999 if (ir->flags.microsoft_gen1)
1002 /* if there's no data, just return now */
1006 for (; i < buf_len; i++) {
1007 switch (ir->parser_state) {
1009 ir->rem = mceusb_cmd_datasize(ir->cmd, ir->buf_in[i]);
1010 mceusb_dev_printdata(ir, ir->buf_in, buf_len, i - 1,
1011 ir->rem + 2, false);
1012 mceusb_handle_command(ir, i);
1013 ir->parser_state = CMD_DATA;
1017 init_ir_raw_event(&rawir);
1018 rawir.pulse = ((ir->buf_in[i] & MCE_PULSE_BIT) != 0);
1019 rawir.duration = (ir->buf_in[i] & MCE_PULSE_MASK)
1020 * US_TO_NS(MCE_TIME_UNIT);
1022 dev_dbg(ir->dev, "Storing %s with duration %u",
1023 rawir.pulse ? "pulse" : "space",
1026 if (ir_raw_event_store_with_filter(ir->rc, &rawir))
1033 /* decode mce packets of the form (84),AA,BB,CC,DD */
1034 /* IR data packets can span USB messages - rem */
1035 ir->cmd = ir->buf_in[i];
1036 if ((ir->cmd == MCE_CMD_PORT_IR) ||
1037 ((ir->cmd & MCE_PORT_MASK) !=
1038 MCE_COMMAND_IRDATA)) {
1039 ir->parser_state = SUBCMD;
1042 ir->rem = (ir->cmd & MCE_PACKET_LENGTH_MASK);
1043 mceusb_dev_printdata(ir, ir->buf_in, buf_len,
1044 i, ir->rem + 1, false);
1046 ir->parser_state = PARSE_IRDATA;
1048 ir_raw_event_reset(ir->rc);
1052 if (ir->parser_state != CMD_HEADER && !ir->rem)
1053 ir->parser_state = CMD_HEADER;
1056 dev_dbg(ir->dev, "processed IR data");
1057 ir_raw_event_handle(ir->rc);
1061 static void mceusb_dev_recv(struct urb *urb)
1063 struct mceusb_dev *ir;
1070 usb_unlink_urb(urb);
1074 switch (urb->status) {
1077 mceusb_process_ir_data(ir, urb->actual_length);
1084 usb_unlink_urb(urb);
1088 dev_err(ir->dev, "Error: urb status = %d (RX HALT)",
1090 mceusb_defer_kevent(ir, EVENT_RX_HALT);
1094 dev_err(ir->dev, "Error: urb status = %d", urb->status);
1098 usb_submit_urb(urb, GFP_ATOMIC);
1101 static void mceusb_get_emulator_version(struct mceusb_dev *ir)
1103 /* If we get no reply or an illegal command reply, its ver 1, says MS */
1105 mce_async_out(ir, GET_EMVER, sizeof(GET_EMVER));
1108 static void mceusb_gen1_init(struct mceusb_dev *ir)
1111 struct device *dev = ir->dev;
1114 data = kzalloc(USB_CTRL_MSG_SZ, GFP_KERNEL);
1116 dev_err(dev, "%s: memory allocation failed!", __func__);
1121 * This is a strange one. Windows issues a set address to the device
1122 * on the receive control pipe and expect a certain value pair back
1124 ret = usb_control_msg(ir->usbdev, usb_rcvctrlpipe(ir->usbdev, 0),
1125 USB_REQ_SET_ADDRESS, USB_TYPE_VENDOR, 0, 0,
1126 data, USB_CTRL_MSG_SZ, HZ * 3);
1127 dev_dbg(dev, "set address - ret = %d", ret);
1128 dev_dbg(dev, "set address - data[0] = %d, data[1] = %d",
1131 /* set feature: bit rate 38400 bps */
1132 ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1133 USB_REQ_SET_FEATURE, USB_TYPE_VENDOR,
1134 0xc04e, 0x0000, NULL, 0, HZ * 3);
1136 dev_dbg(dev, "set feature - ret = %d", ret);
1138 /* bRequest 4: set char length to 8 bits */
1139 ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1141 0x0808, 0x0000, NULL, 0, HZ * 3);
1142 dev_dbg(dev, "set char length - retB = %d", ret);
1144 /* bRequest 2: set handshaking to use DTR/DSR */
1145 ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1147 0x0000, 0x0100, NULL, 0, HZ * 3);
1148 dev_dbg(dev, "set handshake - retC = %d", ret);
1151 mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
1153 /* get hw/sw revision? */
1154 mce_async_out(ir, GET_REVISION, sizeof(GET_REVISION));
1159 static void mceusb_gen2_init(struct mceusb_dev *ir)
1162 mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
1164 /* get wake version (protocol, key, address) */
1165 mce_async_out(ir, GET_WAKEVERSION, sizeof(GET_WAKEVERSION));
1167 /* unknown what this one actually returns... */
1168 mce_async_out(ir, GET_UNKNOWN2, sizeof(GET_UNKNOWN2));
1171 static void mceusb_get_parameters(struct mceusb_dev *ir)
1174 unsigned char cmdbuf[3] = { MCE_CMD_PORT_SYS,
1175 MCE_CMD_GETPORTSTATUS, 0x00 };
1177 /* defaults, if the hardware doesn't support querying */
1178 ir->num_txports = 2;
1179 ir->num_rxports = 2;
1181 /* get number of tx and rx ports */
1182 mce_async_out(ir, GET_NUM_PORTS, sizeof(GET_NUM_PORTS));
1184 /* get the carrier and frequency */
1185 mce_async_out(ir, GET_CARRIER_FREQ, sizeof(GET_CARRIER_FREQ));
1187 if (ir->num_txports && !ir->flags.no_tx)
1188 /* get the transmitter bitmask */
1189 mce_async_out(ir, GET_TX_BITMASK, sizeof(GET_TX_BITMASK));
1191 /* get receiver timeout value */
1192 mce_async_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT));
1194 /* get receiver sensor setting */
1195 mce_async_out(ir, GET_RX_SENSOR, sizeof(GET_RX_SENSOR));
1197 for (i = 0; i < ir->num_txports; i++) {
1199 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1203 static void mceusb_flash_led(struct mceusb_dev *ir)
1208 mce_async_out(ir, FLASH_LED, sizeof(FLASH_LED));
1212 * Workqueue function
1213 * for resetting or recovering device after occurrence of error events
1214 * specified in ir->kevent bit field.
1215 * Function runs (via schedule_work()) in non-interrupt context, for
1216 * calls here (such as usb_clear_halt()) requiring non-interrupt context.
1218 static void mceusb_deferred_kevent(struct work_struct *work)
1220 struct mceusb_dev *ir =
1221 container_of(work, struct mceusb_dev, kevent);
1224 if (test_bit(EVENT_RX_HALT, &ir->kevent_flags)) {
1225 usb_unlink_urb(ir->urb_in);
1226 status = usb_clear_halt(ir->usbdev, ir->pipe_in);
1228 dev_err(ir->dev, "rx clear halt error %d",
1231 clear_bit(EVENT_RX_HALT, &ir->kevent_flags);
1233 status = usb_submit_urb(ir->urb_in, GFP_KERNEL);
1236 "rx unhalt submit urb error %d",
1242 if (test_bit(EVENT_TX_HALT, &ir->kevent_flags)) {
1243 status = usb_clear_halt(ir->usbdev, ir->pipe_out);
1245 dev_err(ir->dev, "tx clear halt error %d", status);
1246 clear_bit(EVENT_TX_HALT, &ir->kevent_flags);
1250 static struct rc_dev *mceusb_init_rc_dev(struct mceusb_dev *ir)
1252 struct usb_device *udev = ir->usbdev;
1253 struct device *dev = ir->dev;
1257 rc = rc_allocate_device(RC_DRIVER_IR_RAW);
1259 dev_err(dev, "remote dev allocation failed");
1263 snprintf(ir->name, sizeof(ir->name), "%s (%04x:%04x)",
1264 mceusb_model[ir->model].name ?
1265 mceusb_model[ir->model].name :
1266 "Media Center Ed. eHome Infrared Remote Transceiver",
1267 le16_to_cpu(ir->usbdev->descriptor.idVendor),
1268 le16_to_cpu(ir->usbdev->descriptor.idProduct));
1270 usb_make_path(ir->usbdev, ir->phys, sizeof(ir->phys));
1272 rc->device_name = ir->name;
1273 rc->input_phys = ir->phys;
1274 usb_to_input_id(ir->usbdev, &rc->input_id);
1275 rc->dev.parent = dev;
1277 rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;
1278 rc->timeout = MS_TO_NS(100);
1279 if (!ir->flags.no_tx) {
1280 rc->s_tx_mask = mceusb_set_tx_mask;
1281 rc->s_tx_carrier = mceusb_set_tx_carrier;
1282 rc->tx_ir = mceusb_tx_ir;
1284 rc->driver_name = DRIVER_NAME;
1286 switch (le16_to_cpu(udev->descriptor.idVendor)) {
1287 case VENDOR_HAUPPAUGE:
1288 rc->map_name = RC_MAP_HAUPPAUGE;
1291 rc->map_name = RC_MAP_PINNACLE_PCTV_HD;
1294 rc->map_name = RC_MAP_RC6_MCE;
1296 if (mceusb_model[ir->model].rc_map)
1297 rc->map_name = mceusb_model[ir->model].rc_map;
1299 ret = rc_register_device(rc);
1301 dev_err(dev, "remote dev registration failed");
1312 static int mceusb_dev_probe(struct usb_interface *intf,
1313 const struct usb_device_id *id)
1315 struct usb_device *dev = interface_to_usbdev(intf);
1316 struct usb_host_interface *idesc;
1317 struct usb_endpoint_descriptor *ep = NULL;
1318 struct usb_endpoint_descriptor *ep_in = NULL;
1319 struct usb_endpoint_descriptor *ep_out = NULL;
1320 struct mceusb_dev *ir = NULL;
1321 int pipe, maxp, i, res;
1322 char buf[63], name[128] = "";
1323 enum mceusb_model_type model = id->driver_info;
1325 bool is_microsoft_gen1;
1326 bool tx_mask_normal;
1329 dev_dbg(&intf->dev, "%s called", __func__);
1331 idesc = intf->cur_altsetting;
1333 is_gen3 = mceusb_model[model].mce_gen3;
1334 is_microsoft_gen1 = mceusb_model[model].mce_gen1;
1335 tx_mask_normal = mceusb_model[model].tx_mask_normal;
1336 ir_intfnum = mceusb_model[model].ir_intfnum;
1338 /* There are multi-function devices with non-IR interfaces */
1339 if (idesc->desc.bInterfaceNumber != ir_intfnum)
1342 /* step through the endpoints to find first bulk in and out endpoint */
1343 for (i = 0; i < idesc->desc.bNumEndpoints; ++i) {
1344 ep = &idesc->endpoint[i].desc;
1346 if (ep_in == NULL) {
1347 if (usb_endpoint_is_bulk_in(ep)) {
1349 dev_dbg(&intf->dev, "acceptable bulk inbound endpoint found\n");
1350 } else if (usb_endpoint_is_int_in(ep)) {
1352 ep_in->bInterval = 1;
1353 dev_dbg(&intf->dev, "acceptable interrupt inbound endpoint found\n");
1357 if (ep_out == NULL) {
1358 if (usb_endpoint_is_bulk_out(ep)) {
1360 dev_dbg(&intf->dev, "acceptable bulk outbound endpoint found\n");
1361 } else if (usb_endpoint_is_int_out(ep)) {
1363 ep_out->bInterval = 1;
1364 dev_dbg(&intf->dev, "acceptable interrupt outbound endpoint found\n");
1368 if (!ep_in || !ep_out) {
1369 dev_dbg(&intf->dev, "required endpoints not found\n");
1373 if (usb_endpoint_xfer_int(ep_in))
1374 pipe = usb_rcvintpipe(dev, ep_in->bEndpointAddress);
1376 pipe = usb_rcvbulkpipe(dev, ep_in->bEndpointAddress);
1377 maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
1379 ir = kzalloc(sizeof(struct mceusb_dev), GFP_KERNEL);
1381 goto mem_alloc_fail;
1384 ir->buf_in = usb_alloc_coherent(dev, maxp, GFP_ATOMIC, &ir->dma_in);
1386 goto buf_in_alloc_fail;
1388 ir->urb_in = usb_alloc_urb(0, GFP_KERNEL);
1390 goto urb_in_alloc_fail;
1392 ir->usbdev = usb_get_dev(dev);
1393 ir->dev = &intf->dev;
1395 ir->flags.microsoft_gen1 = is_microsoft_gen1;
1396 ir->flags.tx_mask_normal = tx_mask_normal;
1397 ir->flags.no_tx = mceusb_model[model].no_tx;
1400 /* Saving usb interface data for use by the transmitter routine */
1401 ir->usb_ep_out = ep_out;
1402 if (usb_endpoint_xfer_int(ep_out))
1403 ir->pipe_out = usb_sndintpipe(ir->usbdev,
1404 ep_out->bEndpointAddress);
1406 ir->pipe_out = usb_sndbulkpipe(ir->usbdev,
1407 ep_out->bEndpointAddress);
1409 if (dev->descriptor.iManufacturer
1410 && usb_string(dev, dev->descriptor.iManufacturer,
1411 buf, sizeof(buf)) > 0)
1412 strlcpy(name, buf, sizeof(name));
1413 if (dev->descriptor.iProduct
1414 && usb_string(dev, dev->descriptor.iProduct,
1415 buf, sizeof(buf)) > 0)
1416 snprintf(name + strlen(name), sizeof(name) - strlen(name),
1420 * Initialize async USB error handler before registering
1421 * or activating any mceusb RX and TX functions
1423 INIT_WORK(&ir->kevent, mceusb_deferred_kevent);
1425 ir->rc = mceusb_init_rc_dev(ir);
1429 /* wire up inbound data handler */
1430 if (usb_endpoint_xfer_int(ep_in))
1431 usb_fill_int_urb(ir->urb_in, dev, pipe, ir->buf_in, maxp,
1432 mceusb_dev_recv, ir, ep_in->bInterval);
1434 usb_fill_bulk_urb(ir->urb_in, dev, pipe, ir->buf_in, maxp,
1435 mceusb_dev_recv, ir);
1437 ir->urb_in->transfer_dma = ir->dma_in;
1438 ir->urb_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1440 /* flush buffers on the device */
1441 dev_dbg(&intf->dev, "Flushing receive buffers");
1442 res = usb_submit_urb(ir->urb_in, GFP_KERNEL);
1444 dev_err(&intf->dev, "failed to flush buffers: %d", res);
1446 /* figure out which firmware/emulator version this hardware has */
1447 mceusb_get_emulator_version(ir);
1449 /* initialize device */
1450 if (ir->flags.microsoft_gen1)
1451 mceusb_gen1_init(ir);
1453 mceusb_gen2_init(ir);
1455 mceusb_get_parameters(ir);
1457 mceusb_flash_led(ir);
1459 if (!ir->flags.no_tx)
1460 mceusb_set_tx_mask(ir->rc, MCE_DEFAULT_TX_MASK);
1462 usb_set_intfdata(intf, ir);
1464 /* enable wake via this device */
1465 device_set_wakeup_capable(ir->dev, true);
1466 device_set_wakeup_enable(ir->dev, true);
1468 dev_info(&intf->dev, "Registered %s with mce emulator interface version %x",
1470 dev_info(&intf->dev, "%x tx ports (0x%x cabled) and %x rx sensors (0x%x active)",
1471 ir->num_txports, ir->txports_cabled,
1472 ir->num_rxports, ir->rxports_active);
1476 /* Error-handling path */
1478 cancel_work_sync(&ir->kevent);
1479 usb_put_dev(ir->usbdev);
1480 usb_kill_urb(ir->urb_in);
1481 usb_free_urb(ir->urb_in);
1483 usb_free_coherent(dev, maxp, ir->buf_in, ir->dma_in);
1487 dev_err(&intf->dev, "%s: device setup failed!", __func__);
1493 static void mceusb_dev_disconnect(struct usb_interface *intf)
1495 struct usb_device *dev = interface_to_usbdev(intf);
1496 struct mceusb_dev *ir = usb_get_intfdata(intf);
1498 usb_set_intfdata(intf, NULL);
1504 cancel_work_sync(&ir->kevent);
1505 rc_unregister_device(ir->rc);
1506 usb_kill_urb(ir->urb_in);
1507 usb_free_urb(ir->urb_in);
1508 usb_free_coherent(dev, ir->len_in, ir->buf_in, ir->dma_in);
1514 static int mceusb_dev_suspend(struct usb_interface *intf, pm_message_t message)
1516 struct mceusb_dev *ir = usb_get_intfdata(intf);
1517 dev_info(ir->dev, "suspend");
1518 usb_kill_urb(ir->urb_in);
1522 static int mceusb_dev_resume(struct usb_interface *intf)
1524 struct mceusb_dev *ir = usb_get_intfdata(intf);
1525 dev_info(ir->dev, "resume");
1526 if (usb_submit_urb(ir->urb_in, GFP_ATOMIC))
1531 static struct usb_driver mceusb_dev_driver = {
1532 .name = DRIVER_NAME,
1533 .probe = mceusb_dev_probe,
1534 .disconnect = mceusb_dev_disconnect,
1535 .suspend = mceusb_dev_suspend,
1536 .resume = mceusb_dev_resume,
1537 .reset_resume = mceusb_dev_resume,
1538 .id_table = mceusb_dev_table
1541 module_usb_driver(mceusb_dev_driver);
1543 MODULE_DESCRIPTION(DRIVER_DESC);
1544 MODULE_AUTHOR(DRIVER_AUTHOR);
1545 MODULE_LICENSE("GPL");
1546 MODULE_DEVICE_TABLE(usb, mceusb_dev_table);