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