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