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