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