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