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