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