Merge tag 'rpmsg-v5.3' of git://github.com/andersson/remoteproc
[linux-2.6-block.git] / drivers / media / rc / mceusb.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Driver for USB Windows Media Center Ed. eHome Infrared Transceivers
4  *
5  * Copyright (c) 2010-2011, Jarod Wilson <jarod@redhat.com>
6  *
7  * Based on the original lirc_mceusb and lirc_mceusb2 drivers, by Dan
8  * Conti, Martin Blatter and Daniel Melander, the latter of which was
9  * in turn also based on the lirc_atiusb driver by Paul Miller. The
10  * two mce drivers were merged into one by Jarod Wilson, with transmit
11  * support for the 1st-gen device added primarily by Patrick Calhoun,
12  * with a bit of tweaks by Jarod. Debugging improvements and proper
13  * support for what appears to be 3rd-gen hardware added by Jarod.
14  * Initial port from lirc driver to ir-core drivery by Jarod, based
15  * partially on a port to an earlier proposed IR infrastructure by
16  * Jon Smirl, which included enhancements and simplifications to the
17  * incoming IR buffer parsing routines.
18  *
19  * Updated in July of 2011 with the aid of Microsoft's official
20  * remote/transceiver requirements and specification document, found at
21  * download.microsoft.com, title
22  * Windows-Media-Center-RC-IR-Collection-Green-Button-Specification-03-08-2011-V2.pdf
23  */
24
25 #include <linux/device.h>
26 #include <linux/module.h>
27 #include <linux/slab.h>
28 #include <linux/workqueue.h>
29 #include <linux/usb.h>
30 #include <linux/usb/input.h>
31 #include <linux/pm_wakeup.h>
32 #include <media/rc-core.h>
33
34 #define DRIVER_VERSION  "1.94"
35 #define DRIVER_AUTHOR   "Jarod Wilson <jarod@redhat.com>"
36 #define DRIVER_DESC     "Windows Media Center Ed. eHome Infrared Transceiver " \
37                         "device driver"
38 #define DRIVER_NAME     "mceusb"
39
40 #define USB_CTRL_MSG_SZ         2  /* Size of usb ctrl msg on gen1 hw */
41 #define MCE_G1_INIT_MSGS        40 /* Init messages on gen1 hw to throw out */
42
43 /* MCE constants */
44 #define MCE_CMDBUF_SIZE         384  /* MCE Command buffer length */
45 #define MCE_TIME_UNIT           50   /* Approx 50us resolution */
46 #define MCE_CODE_LENGTH         5    /* Normal length of packet (with header) */
47 #define MCE_PACKET_SIZE         4    /* Normal length of packet (without header) */
48 #define MCE_IRDATA_HEADER       0x84 /* Actual header format is 0x80 + num_bytes */
49 #define MCE_IRDATA_TRAILER      0x80 /* End of IR data */
50 #define MCE_MAX_CHANNELS        2    /* Two transmitters, hardware dependent? */
51 #define MCE_DEFAULT_TX_MASK     0x03 /* Vals: TX1=0x01, TX2=0x02, ALL=0x03 */
52 #define MCE_PULSE_BIT           0x80 /* Pulse bit, MSB set == PULSE else SPACE */
53 #define MCE_PULSE_MASK          0x7f /* Pulse mask */
54 #define MCE_MAX_PULSE_LENGTH    0x7f /* Longest transmittable pulse symbol */
55
56 /*
57  * The interface between the host and the IR hardware is command-response
58  * based. All commands and responses have a consistent format, where a lead
59  * byte always identifies the type of data following it. The lead byte has
60  * a port value in the 3 highest bits and a length value in the 5 lowest
61  * bits.
62  *
63  * The length field is overloaded, with a value of 11111 indicating that the
64  * following byte is a command or response code, and the length of the entire
65  * message is determined by the code. If the length field is not 11111, then
66  * it specifies the number of bytes of port data that follow.
67  */
68 #define MCE_CMD                 0x1f
69 #define MCE_PORT_IR             0x4     /* (0x4 << 5) | MCE_CMD = 0x9f */
70 #define MCE_PORT_SYS            0x7     /* (0x7 << 5) | MCE_CMD = 0xff */
71 #define MCE_PORT_SER            0x6     /* 0xc0 through 0xdf flush & 0x1f bytes */
72 #define MCE_PORT_MASK           0xe0    /* Mask out command bits */
73
74 /* Command port headers */
75 #define MCE_CMD_PORT_IR         0x9f    /* IR-related cmd/rsp */
76 #define MCE_CMD_PORT_SYS        0xff    /* System (non-IR) device cmd/rsp */
77
78 /* Commands that set device state  (2-4 bytes in length) */
79 #define MCE_CMD_RESET           0xfe    /* Reset device, 2 bytes */
80 #define MCE_CMD_RESUME          0xaa    /* Resume device after error, 2 bytes */
81 #define MCE_CMD_SETIRCFS        0x06    /* Set tx carrier, 4 bytes */
82 #define MCE_CMD_SETIRTIMEOUT    0x0c    /* Set timeout, 4 bytes */
83 #define MCE_CMD_SETIRTXPORTS    0x08    /* Set tx ports, 3 bytes */
84 #define MCE_CMD_SETIRRXPORTEN   0x14    /* Set rx ports, 3 bytes */
85 #define MCE_CMD_FLASHLED        0x23    /* Flash receiver LED, 2 bytes */
86
87 /* Commands that query device state (all 2 bytes, unless noted) */
88 #define MCE_CMD_GETIRCFS        0x07    /* Get carrier */
89 #define MCE_CMD_GETIRTIMEOUT    0x0d    /* Get timeout */
90 #define MCE_CMD_GETIRTXPORTS    0x13    /* Get tx ports */
91 #define MCE_CMD_GETIRRXPORTEN   0x15    /* Get rx ports */
92 #define MCE_CMD_GETPORTSTATUS   0x11    /* Get tx port status, 3 bytes */
93 #define MCE_CMD_GETIRNUMPORTS   0x16    /* Get number of ports */
94 #define MCE_CMD_GETWAKESOURCE   0x17    /* Get wake source */
95 #define MCE_CMD_GETEMVER        0x22    /* Get emulator interface version */
96 #define MCE_CMD_GETDEVDETAILS   0x21    /* Get device details (em ver2 only) */
97 #define MCE_CMD_GETWAKESUPPORT  0x20    /* Get wake details (em ver2 only) */
98 #define MCE_CMD_GETWAKEVERSION  0x18    /* Get wake pattern (em ver2 only) */
99
100 /* Misc commands */
101 #define MCE_CMD_NOP             0xff    /* No operation */
102
103 /* Responses to commands (non-error cases) */
104 #define MCE_RSP_EQIRCFS         0x06    /* tx carrier, 4 bytes */
105 #define MCE_RSP_EQIRTIMEOUT     0x0c    /* rx timeout, 4 bytes */
106 #define MCE_RSP_GETWAKESOURCE   0x17    /* wake source, 3 bytes */
107 #define MCE_RSP_EQIRTXPORTS     0x08    /* tx port mask, 3 bytes */
108 #define MCE_RSP_EQIRRXPORTEN    0x14    /* rx port mask, 3 bytes */
109 #define MCE_RSP_GETPORTSTATUS   0x11    /* tx port status, 7 bytes */
110 #define MCE_RSP_EQIRRXCFCNT     0x15    /* rx carrier count, 4 bytes */
111 #define MCE_RSP_EQIRNUMPORTS    0x16    /* number of ports, 4 bytes */
112 #define MCE_RSP_EQWAKESUPPORT   0x20    /* wake capabilities, 3 bytes */
113 #define MCE_RSP_EQWAKEVERSION   0x18    /* wake pattern details, 6 bytes */
114 #define MCE_RSP_EQDEVDETAILS    0x21    /* device capabilities, 3 bytes */
115 #define MCE_RSP_EQEMVER         0x22    /* emulator interface ver, 3 bytes */
116 #define MCE_RSP_FLASHLED        0x23    /* success flashing LED, 2 bytes */
117
118 /* Responses to error cases, must send MCE_CMD_RESUME to clear them */
119 #define MCE_RSP_CMD_ILLEGAL     0xfe    /* illegal command for port, 2 bytes */
120 #define MCE_RSP_TX_TIMEOUT      0x81    /* tx timed out, 2 bytes */
121
122 /* Misc commands/responses not defined in the MCE remote/transceiver spec */
123 #define MCE_CMD_SIG_END         0x01    /* End of signal */
124 #define MCE_CMD_PING            0x03    /* Ping device */
125 #define MCE_CMD_UNKNOWN         0x04    /* Unknown */
126 #define MCE_CMD_UNKNOWN2        0x05    /* Unknown */
127 #define MCE_CMD_UNKNOWN3        0x09    /* Unknown */
128 #define MCE_CMD_UNKNOWN4        0x0a    /* Unknown */
129 #define MCE_CMD_G_REVISION      0x0b    /* Get hw/sw revision */
130 #define MCE_CMD_UNKNOWN5        0x0e    /* Unknown */
131 #define MCE_CMD_UNKNOWN6        0x0f    /* Unknown */
132 #define MCE_CMD_UNKNOWN8        0x19    /* Unknown */
133 #define MCE_CMD_UNKNOWN9        0x1b    /* Unknown */
134 #define MCE_CMD_NULL            0x00    /* These show up various places... */
135
136 /* if buf[i] & MCE_PORT_MASK == 0x80 and buf[i] != MCE_CMD_PORT_IR,
137  * then we're looking at a raw IR data sample */
138 #define MCE_COMMAND_IRDATA      0x80
139 #define MCE_PACKET_LENGTH_MASK  0x1f /* Packet length mask */
140
141 #define VENDOR_PHILIPS          0x0471
142 #define VENDOR_SMK              0x0609
143 #define VENDOR_TATUNG           0x1460
144 #define VENDOR_GATEWAY          0x107b
145 #define VENDOR_SHUTTLE          0x1308
146 #define VENDOR_SHUTTLE2         0x051c
147 #define VENDOR_MITSUMI          0x03ee
148 #define VENDOR_TOPSEED          0x1784
149 #define VENDOR_RICAVISION       0x179d
150 #define VENDOR_ITRON            0x195d
151 #define VENDOR_FIC              0x1509
152 #define VENDOR_LG               0x043e
153 #define VENDOR_MICROSOFT        0x045e
154 #define VENDOR_FORMOSA          0x147a
155 #define VENDOR_FINTEK           0x1934
156 #define VENDOR_PINNACLE         0x2304
157 #define VENDOR_ECS              0x1019
158 #define VENDOR_WISTRON          0x0fb8
159 #define VENDOR_COMPRO           0x185b
160 #define VENDOR_NORTHSTAR        0x04eb
161 #define VENDOR_REALTEK          0x0bda
162 #define VENDOR_TIVO             0x105a
163 #define VENDOR_CONEXANT         0x0572
164 #define VENDOR_TWISTEDMELON     0x2596
165 #define VENDOR_HAUPPAUGE        0x2040
166 #define VENDOR_PCTV             0x2013
167 #define VENDOR_ADAPTEC          0x03f3
168
169 enum mceusb_model_type {
170         MCE_GEN2 = 0,           /* Most boards */
171         MCE_GEN1,
172         MCE_GEN3,
173         MCE_GEN3_BROKEN_IRTIMEOUT,
174         MCE_GEN2_TX_INV,
175         MCE_GEN2_TX_INV_RX_GOOD,
176         POLARIS_EVK,
177         CX_HYBRID_TV,
178         MULTIFUNCTION,
179         TIVO_KIT,
180         MCE_GEN2_NO_TX,
181         HAUPPAUGE_CX_HYBRID_TV,
182         EVROMEDIA_FULL_HYBRID_FULLHD,
183         ASTROMETA_T2HYBRID,
184 };
185
186 struct mceusb_model {
187         u32 mce_gen1:1;
188         u32 mce_gen2:1;
189         u32 mce_gen3:1;
190         u32 tx_mask_normal:1;
191         u32 no_tx:1;
192         u32 broken_irtimeout:1;
193         /*
194          * 2nd IR receiver (short-range, wideband) for learning mode:
195          *     0, absent 2nd receiver (rx2)
196          *     1, rx2 present
197          *     2, rx2 which under counts IR carrier cycles
198          */
199         u32 rx2;
200
201         int ir_intfnum;
202
203         const char *rc_map;     /* Allow specify a per-board map */
204         const char *name;       /* per-board name */
205 };
206
207 static const struct mceusb_model mceusb_model[] = {
208         [MCE_GEN1] = {
209                 .mce_gen1 = 1,
210                 .tx_mask_normal = 1,
211                 .rx2 = 2,
212         },
213         [MCE_GEN2] = {
214                 .mce_gen2 = 1,
215                 .rx2 = 2,
216         },
217         [MCE_GEN2_NO_TX] = {
218                 .mce_gen2 = 1,
219                 .no_tx = 1,
220         },
221         [MCE_GEN2_TX_INV] = {
222                 .mce_gen2 = 1,
223                 .tx_mask_normal = 1,
224                 .rx2 = 1,
225         },
226         [MCE_GEN2_TX_INV_RX_GOOD] = {
227                 .mce_gen2 = 1,
228                 .tx_mask_normal = 1,
229                 .rx2 = 2,
230         },
231         [MCE_GEN3] = {
232                 .mce_gen3 = 1,
233                 .tx_mask_normal = 1,
234                 .rx2 = 2,
235         },
236         [MCE_GEN3_BROKEN_IRTIMEOUT] = {
237                 .mce_gen3 = 1,
238                 .tx_mask_normal = 1,
239                 .rx2 = 2,
240                 .broken_irtimeout = 1
241         },
242         [POLARIS_EVK] = {
243                 /*
244                  * In fact, the EVK is shipped without
245                  * remotes, but we should have something handy,
246                  * to allow testing it
247                  */
248                 .name = "Conexant Hybrid TV (cx231xx) MCE IR",
249                 .rx2 = 2,
250         },
251         [CX_HYBRID_TV] = {
252                 .no_tx = 1, /* tx isn't wired up at all */
253                 .name = "Conexant Hybrid TV (cx231xx) MCE IR",
254         },
255         [HAUPPAUGE_CX_HYBRID_TV] = {
256                 .no_tx = 1, /* eeprom says it has no tx */
257                 .name = "Conexant Hybrid TV (cx231xx) MCE IR no TX",
258         },
259         [MULTIFUNCTION] = {
260                 .mce_gen2 = 1,
261                 .ir_intfnum = 2,
262                 .rx2 = 2,
263         },
264         [TIVO_KIT] = {
265                 .mce_gen2 = 1,
266                 .rc_map = RC_MAP_TIVO,
267                 .rx2 = 2,
268         },
269         [EVROMEDIA_FULL_HYBRID_FULLHD] = {
270                 .name = "Evromedia USB Full Hybrid Full HD",
271                 .no_tx = 1,
272                 .rc_map = RC_MAP_MSI_DIGIVOX_III,
273         },
274         [ASTROMETA_T2HYBRID] = {
275                 .name = "Astrometa T2Hybrid",
276                 .no_tx = 1,
277                 .rc_map = RC_MAP_ASTROMETA_T2HYBRID,
278         }
279 };
280
281 static const struct usb_device_id mceusb_dev_table[] = {
282         /* Original Microsoft MCE IR Transceiver (often HP-branded) */
283         { USB_DEVICE(VENDOR_MICROSOFT, 0x006d),
284           .driver_info = MCE_GEN1 },
285         /* Philips Infrared Transceiver - Sahara branded */
286         { USB_DEVICE(VENDOR_PHILIPS, 0x0608) },
287         /* Philips Infrared Transceiver - HP branded */
288         { USB_DEVICE(VENDOR_PHILIPS, 0x060c),
289           .driver_info = MCE_GEN2_TX_INV },
290         /* Philips SRM5100 */
291         { USB_DEVICE(VENDOR_PHILIPS, 0x060d) },
292         /* Philips Infrared Transceiver - Omaura */
293         { USB_DEVICE(VENDOR_PHILIPS, 0x060f) },
294         /* Philips Infrared Transceiver - Spinel plus */
295         { USB_DEVICE(VENDOR_PHILIPS, 0x0613) },
296         /* Philips eHome Infrared Transceiver */
297         { USB_DEVICE(VENDOR_PHILIPS, 0x0815) },
298         /* Philips/Spinel plus IR transceiver for ASUS */
299         { USB_DEVICE(VENDOR_PHILIPS, 0x206c) },
300         /* Philips/Spinel plus IR transceiver for ASUS */
301         { USB_DEVICE(VENDOR_PHILIPS, 0x2088) },
302         /* Philips IR transceiver (Dell branded) */
303         { USB_DEVICE(VENDOR_PHILIPS, 0x2093),
304           .driver_info = MCE_GEN2_TX_INV },
305         /* Realtek MCE IR Receiver and card reader */
306         { USB_DEVICE(VENDOR_REALTEK, 0x0161),
307           .driver_info = MULTIFUNCTION },
308         /* SMK/Toshiba G83C0004D410 */
309         { USB_DEVICE(VENDOR_SMK, 0x031d),
310           .driver_info = MCE_GEN2_TX_INV_RX_GOOD },
311         /* SMK eHome Infrared Transceiver (Sony VAIO) */
312         { USB_DEVICE(VENDOR_SMK, 0x0322),
313           .driver_info = MCE_GEN2_TX_INV },
314         /* bundled with Hauppauge PVR-150 */
315         { USB_DEVICE(VENDOR_SMK, 0x0334),
316           .driver_info = MCE_GEN2_TX_INV },
317         /* SMK eHome Infrared Transceiver */
318         { USB_DEVICE(VENDOR_SMK, 0x0338) },
319         /* SMK/I-O Data GV-MC7/RCKIT Receiver */
320         { USB_DEVICE(VENDOR_SMK, 0x0353),
321           .driver_info = MCE_GEN2_NO_TX },
322         /* SMK RXX6000 Infrared Receiver */
323         { USB_DEVICE(VENDOR_SMK, 0x0357),
324           .driver_info = MCE_GEN2_NO_TX },
325         /* Tatung eHome Infrared Transceiver */
326         { USB_DEVICE(VENDOR_TATUNG, 0x9150) },
327         /* Shuttle eHome Infrared Transceiver */
328         { USB_DEVICE(VENDOR_SHUTTLE, 0xc001) },
329         /* Shuttle eHome Infrared Transceiver */
330         { USB_DEVICE(VENDOR_SHUTTLE2, 0xc001) },
331         /* Gateway eHome Infrared Transceiver */
332         { USB_DEVICE(VENDOR_GATEWAY, 0x3009) },
333         /* Mitsumi */
334         { USB_DEVICE(VENDOR_MITSUMI, 0x2501) },
335         /* Topseed eHome Infrared Transceiver */
336         { USB_DEVICE(VENDOR_TOPSEED, 0x0001),
337           .driver_info = MCE_GEN2_TX_INV },
338         /* Topseed HP eHome Infrared Transceiver */
339         { USB_DEVICE(VENDOR_TOPSEED, 0x0006),
340           .driver_info = MCE_GEN2_TX_INV },
341         /* Topseed eHome Infrared Transceiver */
342         { USB_DEVICE(VENDOR_TOPSEED, 0x0007),
343           .driver_info = MCE_GEN2_TX_INV },
344         /* Topseed eHome Infrared Transceiver */
345         { USB_DEVICE(VENDOR_TOPSEED, 0x0008),
346           .driver_info = MCE_GEN3 },
347         /* Topseed eHome Infrared Transceiver */
348         { USB_DEVICE(VENDOR_TOPSEED, 0x000a),
349           .driver_info = MCE_GEN2_TX_INV },
350         /* Topseed eHome Infrared Transceiver */
351         { USB_DEVICE(VENDOR_TOPSEED, 0x0011),
352           .driver_info = MCE_GEN3_BROKEN_IRTIMEOUT },
353         /* Ricavision internal Infrared Transceiver */
354         { USB_DEVICE(VENDOR_RICAVISION, 0x0010) },
355         /* Itron ione Libra Q-11 */
356         { USB_DEVICE(VENDOR_ITRON, 0x7002) },
357         /* FIC eHome Infrared Transceiver */
358         { USB_DEVICE(VENDOR_FIC, 0x9242) },
359         /* LG eHome Infrared Transceiver */
360         { USB_DEVICE(VENDOR_LG, 0x9803) },
361         /* Microsoft MCE Infrared Transceiver */
362         { USB_DEVICE(VENDOR_MICROSOFT, 0x00a0) },
363         /* Formosa eHome Infrared Transceiver */
364         { USB_DEVICE(VENDOR_FORMOSA, 0xe015) },
365         /* Formosa21 / eHome Infrared Receiver */
366         { USB_DEVICE(VENDOR_FORMOSA, 0xe016) },
367         /* Formosa aim / Trust MCE Infrared Receiver */
368         { USB_DEVICE(VENDOR_FORMOSA, 0xe017),
369           .driver_info = MCE_GEN2_NO_TX },
370         /* Formosa Industrial Computing / Beanbag Emulation Device */
371         { USB_DEVICE(VENDOR_FORMOSA, 0xe018) },
372         /* Formosa21 / eHome Infrared Receiver */
373         { USB_DEVICE(VENDOR_FORMOSA, 0xe03a) },
374         /* Formosa Industrial Computing AIM IR605/A */
375         { USB_DEVICE(VENDOR_FORMOSA, 0xe03c) },
376         /* Formosa Industrial Computing */
377         { USB_DEVICE(VENDOR_FORMOSA, 0xe03e) },
378         /* Formosa Industrial Computing */
379         { USB_DEVICE(VENDOR_FORMOSA, 0xe042) },
380         /* Fintek eHome Infrared Transceiver (HP branded) */
381         { USB_DEVICE(VENDOR_FINTEK, 0x5168),
382           .driver_info = MCE_GEN2_TX_INV },
383         /* Fintek eHome Infrared Transceiver */
384         { USB_DEVICE(VENDOR_FINTEK, 0x0602) },
385         /* Fintek eHome Infrared Transceiver (in the AOpen MP45) */
386         { USB_DEVICE(VENDOR_FINTEK, 0x0702) },
387         /* Pinnacle Remote Kit */
388         { USB_DEVICE(VENDOR_PINNACLE, 0x0225),
389           .driver_info = MCE_GEN3 },
390         /* Elitegroup Computer Systems IR */
391         { USB_DEVICE(VENDOR_ECS, 0x0f38) },
392         /* Wistron Corp. eHome Infrared Receiver */
393         { USB_DEVICE(VENDOR_WISTRON, 0x0002) },
394         /* Compro K100 */
395         { USB_DEVICE(VENDOR_COMPRO, 0x3020) },
396         /* Compro K100 v2 */
397         { USB_DEVICE(VENDOR_COMPRO, 0x3082) },
398         /* Northstar Systems, Inc. eHome Infrared Transceiver */
399         { USB_DEVICE(VENDOR_NORTHSTAR, 0xe004) },
400         /* TiVo PC IR Receiver */
401         { USB_DEVICE(VENDOR_TIVO, 0x2000),
402           .driver_info = TIVO_KIT },
403         /* Conexant Hybrid TV "Shelby" Polaris SDK */
404         { USB_DEVICE(VENDOR_CONEXANT, 0x58a1),
405           .driver_info = POLARIS_EVK },
406         /* Conexant Hybrid TV RDU253S Polaris */
407         { USB_DEVICE(VENDOR_CONEXANT, 0x58a5),
408           .driver_info = CX_HYBRID_TV },
409         /* Twisted Melon Inc. - Manta Mini Receiver */
410         { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8008) },
411         /* Twisted Melon Inc. - Manta Pico Receiver */
412         { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8016) },
413         /* Twisted Melon Inc. - Manta Transceiver */
414         { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8042) },
415         /* Hauppauge WINTV-HVR-HVR 930C-HD - based on cx231xx */
416         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb130),
417           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
418         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb131),
419           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
420         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb138),
421           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
422         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb139),
423           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
424         /* Hauppauge WinTV-HVR-935C - based on cx231xx */
425         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb151),
426           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
427         /* Hauppauge WinTV-HVR-955Q - based on cx231xx */
428         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb123),
429           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
430         /* Hauppauge WinTV-HVR-975 - based on cx231xx */
431         { USB_DEVICE(VENDOR_HAUPPAUGE, 0xb150),
432           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
433         { USB_DEVICE(VENDOR_PCTV, 0x0259),
434           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
435         { USB_DEVICE(VENDOR_PCTV, 0x025e),
436           .driver_info = HAUPPAUGE_CX_HYBRID_TV },
437         /* Adaptec / HP eHome Receiver */
438         { USB_DEVICE(VENDOR_ADAPTEC, 0x0094) },
439         /* Evromedia USB Full Hybrid Full HD */
440         { USB_DEVICE(0x1b80, 0xd3b2),
441           .driver_info = EVROMEDIA_FULL_HYBRID_FULLHD },
442         /* Astrometa T2hybrid */
443         { USB_DEVICE(0x15f4, 0x0135),
444           .driver_info = ASTROMETA_T2HYBRID },
445
446         /* Terminating entry */
447         { }
448 };
449
450 /* data structure for each usb transceiver */
451 struct mceusb_dev {
452         /* ir-core bits */
453         struct rc_dev *rc;
454
455         /* optional features we can enable */
456         bool carrier_report_enabled;
457         bool wideband_rx_enabled;       /* aka learning mode, short-range rx */
458
459         /* core device bits */
460         struct device *dev;
461
462         /* usb */
463         struct usb_device *usbdev;
464         struct urb *urb_in;
465         unsigned int pipe_in;
466         struct usb_endpoint_descriptor *usb_ep_out;
467         unsigned int pipe_out;
468
469         /* buffers and dma */
470         unsigned char *buf_in;
471         unsigned int len_in;
472         dma_addr_t dma_in;
473
474         enum {
475                 CMD_HEADER = 0,
476                 SUBCMD,
477                 CMD_DATA,
478                 PARSE_IRDATA,
479         } parser_state;
480
481         u8 cmd, rem;            /* Remaining IR data bytes in packet */
482
483         struct {
484                 u32 connected:1;
485                 u32 tx_mask_normal:1;
486                 u32 microsoft_gen1:1;
487                 u32 no_tx:1;
488                 u32 rx2;
489         } flags;
490
491         /* transmit support */
492         u32 carrier;
493         unsigned char tx_mask;
494
495         char name[128];
496         char phys[64];
497         enum mceusb_model_type model;
498
499         bool need_reset;        /* flag to issue a device resume cmd */
500         u8 emver;               /* emulator interface version */
501         u8 num_txports;         /* number of transmit ports */
502         u8 num_rxports;         /* number of receive sensors */
503         u8 txports_cabled;      /* bitmask of transmitters with cable */
504         u8 rxports_active;      /* bitmask of active receive sensors */
505         bool learning_active;   /* wideband rx is active */
506
507         /* receiver carrier frequency detection support */
508         u32 pulse_tunit;        /* IR pulse "on" cumulative time units */
509         u32 pulse_count;        /* pulse "on" count in measurement interval */
510
511         /*
512          * support for async error handler mceusb_deferred_kevent()
513          * where usb_clear_halt(), usb_reset_configuration(),
514          * usb_reset_device(), etc. must be done in process context
515          */
516         struct work_struct kevent;
517         unsigned long kevent_flags;
518 #               define EVENT_TX_HALT    0
519 #               define EVENT_RX_HALT    1
520 };
521
522 /* MCE Device Command Strings, generally a port and command pair */
523 static char DEVICE_RESUME[]     = {MCE_CMD_NULL, MCE_CMD_PORT_SYS,
524                                    MCE_CMD_RESUME};
525 static char GET_REVISION[]      = {MCE_CMD_PORT_SYS, MCE_CMD_G_REVISION};
526 static char GET_EMVER[]         = {MCE_CMD_PORT_SYS, MCE_CMD_GETEMVER};
527 static char GET_WAKEVERSION[]   = {MCE_CMD_PORT_SYS, MCE_CMD_GETWAKEVERSION};
528 static char FLASH_LED[]         = {MCE_CMD_PORT_SYS, MCE_CMD_FLASHLED};
529 static char GET_UNKNOWN2[]      = {MCE_CMD_PORT_IR, MCE_CMD_UNKNOWN2};
530 static char GET_CARRIER_FREQ[]  = {MCE_CMD_PORT_IR, MCE_CMD_GETIRCFS};
531 static char GET_RX_TIMEOUT[]    = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTIMEOUT};
532 static char GET_NUM_PORTS[]     = {MCE_CMD_PORT_IR, MCE_CMD_GETIRNUMPORTS};
533 static char GET_TX_BITMASK[]    = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTXPORTS};
534 static char GET_RX_SENSOR[]     = {MCE_CMD_PORT_IR, MCE_CMD_GETIRRXPORTEN};
535 /* sub in desired values in lower byte or bytes for full command */
536 /* FIXME: make use of these for transmit.
537 static char SET_CARRIER_FREQ[]  = {MCE_CMD_PORT_IR,
538                                    MCE_CMD_SETIRCFS, 0x00, 0x00};
539 static char SET_TX_BITMASK[]    = {MCE_CMD_PORT_IR, MCE_CMD_SETIRTXPORTS, 0x00};
540 static char SET_RX_TIMEOUT[]    = {MCE_CMD_PORT_IR,
541                                    MCE_CMD_SETIRTIMEOUT, 0x00, 0x00};
542 static char SET_RX_SENSOR[]     = {MCE_CMD_PORT_IR,
543                                    MCE_RSP_EQIRRXPORTEN, 0x00};
544 */
545
546 static int mceusb_cmd_datasize(u8 cmd, u8 subcmd)
547 {
548         int datasize = 0;
549
550         switch (cmd) {
551         case MCE_CMD_NULL:
552                 if (subcmd == MCE_CMD_PORT_SYS)
553                         datasize = 1;
554                 break;
555         case MCE_CMD_PORT_SYS:
556                 switch (subcmd) {
557                 case MCE_RSP_GETPORTSTATUS:
558                         datasize = 5;
559                         break;
560                 case MCE_RSP_EQWAKEVERSION:
561                         datasize = 4;
562                         break;
563                 case MCE_CMD_G_REVISION:
564                         datasize = 2;
565                         break;
566                 case MCE_RSP_EQWAKESUPPORT:
567                 case MCE_RSP_GETWAKESOURCE:
568                 case MCE_RSP_EQDEVDETAILS:
569                 case MCE_RSP_EQEMVER:
570                         datasize = 1;
571                         break;
572                 }
573                 break;
574         case MCE_CMD_PORT_IR:
575                 switch (subcmd) {
576                 case MCE_CMD_UNKNOWN:
577                 case MCE_RSP_EQIRCFS:
578                 case MCE_RSP_EQIRTIMEOUT:
579                 case MCE_RSP_EQIRRXCFCNT:
580                 case MCE_RSP_EQIRNUMPORTS:
581                         datasize = 2;
582                         break;
583                 case MCE_CMD_SIG_END:
584                 case MCE_RSP_EQIRTXPORTS:
585                 case MCE_RSP_EQIRRXPORTEN:
586                         datasize = 1;
587                         break;
588                 }
589         }
590         return datasize;
591 }
592
593 static void mceusb_dev_printdata(struct mceusb_dev *ir, u8 *buf, int buf_len,
594                                  int offset, int len, bool out)
595 {
596 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
597         char *inout;
598         u8 cmd, subcmd, *data;
599         struct device *dev = ir->dev;
600         int start, skip = 0;
601         u32 carrier, period;
602
603         /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
604         if (ir->flags.microsoft_gen1 && !out && !offset)
605                 skip = 2;
606
607         if (len <= skip)
608                 return;
609
610         dev_dbg(dev, "%cx data: %*ph (length=%d)",
611                 (out ? 't' : 'r'),
612                 min(len, buf_len - offset), buf + offset, len);
613
614         inout = out ? "Request" : "Got";
615
616         start  = offset + skip;
617         cmd    = buf[start] & 0xff;
618         subcmd = buf[start + 1] & 0xff;
619         data = buf + start + 2;
620
621         switch (cmd) {
622         case MCE_CMD_NULL:
623                 if (subcmd == MCE_CMD_NULL)
624                         break;
625                 if ((subcmd == MCE_CMD_PORT_SYS) &&
626                     (data[0] == MCE_CMD_RESUME))
627                         dev_dbg(dev, "Device resume requested");
628                 else
629                         dev_dbg(dev, "Unknown command 0x%02x 0x%02x",
630                                  cmd, subcmd);
631                 break;
632         case MCE_CMD_PORT_SYS:
633                 switch (subcmd) {
634                 case MCE_RSP_EQEMVER:
635                         if (!out)
636                                 dev_dbg(dev, "Emulator interface version %x",
637                                          data[0]);
638                         break;
639                 case MCE_CMD_G_REVISION:
640                         if (len == 2)
641                                 dev_dbg(dev, "Get hw/sw rev?");
642                         else
643                                 dev_dbg(dev, "hw/sw rev %*ph",
644                                         4, &buf[start + 2]);
645                         break;
646                 case MCE_CMD_RESUME:
647                         dev_dbg(dev, "Device resume requested");
648                         break;
649                 case MCE_RSP_CMD_ILLEGAL:
650                         dev_dbg(dev, "Illegal PORT_SYS command");
651                         break;
652                 case MCE_RSP_EQWAKEVERSION:
653                         if (!out)
654                                 dev_dbg(dev, "Wake version, proto: 0x%02x, payload: 0x%02x, address: 0x%02x, version: 0x%02x",
655                                         data[0], data[1], data[2], data[3]);
656                         break;
657                 case MCE_RSP_GETPORTSTATUS:
658                         if (!out)
659                                 /* We use data1 + 1 here, to match hw labels */
660                                 dev_dbg(dev, "TX port %d: blaster is%s connected",
661                                          data[0] + 1, data[3] ? " not" : "");
662                         break;
663                 case MCE_CMD_FLASHLED:
664                         dev_dbg(dev, "Attempting to flash LED");
665                         break;
666                 default:
667                         dev_dbg(dev, "Unknown command 0x%02x 0x%02x",
668                                  cmd, subcmd);
669                         break;
670                 }
671                 break;
672         case MCE_CMD_PORT_IR:
673                 switch (subcmd) {
674                 case MCE_CMD_SIG_END:
675                         dev_dbg(dev, "End of signal");
676                         break;
677                 case MCE_CMD_PING:
678                         dev_dbg(dev, "Ping");
679                         break;
680                 case MCE_CMD_UNKNOWN:
681                         dev_dbg(dev, "Resp to 9f 05 of 0x%02x 0x%02x",
682                                 data[0], data[1]);
683                         break;
684                 case MCE_RSP_EQIRCFS:
685                         period = DIV_ROUND_CLOSEST((1U << data[0] * 2) *
686                                                    (data[1] + 1), 10);
687                         if (!period)
688                                 break;
689                         carrier = (1000 * 1000) / period;
690                         dev_dbg(dev, "%s carrier of %u Hz (period %uus)",
691                                  inout, carrier, period);
692                         break;
693                 case MCE_CMD_GETIRCFS:
694                         dev_dbg(dev, "Get carrier mode and freq");
695                         break;
696                 case MCE_RSP_EQIRTXPORTS:
697                         dev_dbg(dev, "%s transmit blaster mask of 0x%02x",
698                                  inout, data[0]);
699                         break;
700                 case MCE_RSP_EQIRTIMEOUT:
701                         /* value is in units of 50us, so x*50/1000 ms */
702                         period = ((data[0] << 8) | data[1]) *
703                                   MCE_TIME_UNIT / 1000;
704                         dev_dbg(dev, "%s receive timeout of %d ms",
705                                  inout, period);
706                         break;
707                 case MCE_CMD_GETIRTIMEOUT:
708                         dev_dbg(dev, "Get receive timeout");
709                         break;
710                 case MCE_CMD_GETIRTXPORTS:
711                         dev_dbg(dev, "Get transmit blaster mask");
712                         break;
713                 case MCE_RSP_EQIRRXPORTEN:
714                         dev_dbg(dev, "%s %s-range receive sensor in use",
715                                  inout, data[0] == 0x02 ? "short" : "long");
716                         break;
717                 case MCE_CMD_GETIRRXPORTEN:
718                 /* aka MCE_RSP_EQIRRXCFCNT */
719                         if (out)
720                                 dev_dbg(dev, "Get receive sensor");
721                         else
722                                 dev_dbg(dev, "RX carrier cycle count: %d",
723                                         ((data[0] << 8) | data[1]));
724                         break;
725                 case MCE_RSP_EQIRNUMPORTS:
726                         if (out)
727                                 break;
728                         dev_dbg(dev, "Num TX ports: %x, num RX ports: %x",
729                                 data[0], data[1]);
730                         break;
731                 case MCE_RSP_CMD_ILLEGAL:
732                         dev_dbg(dev, "Illegal PORT_IR command");
733                         break;
734                 default:
735                         dev_dbg(dev, "Unknown command 0x%02x 0x%02x",
736                                  cmd, subcmd);
737                         break;
738                 }
739                 break;
740         default:
741                 break;
742         }
743
744         if (cmd == MCE_IRDATA_TRAILER)
745                 dev_dbg(dev, "End of raw IR data");
746         else if ((cmd != MCE_CMD_PORT_IR) &&
747                  ((cmd & MCE_PORT_MASK) == MCE_COMMAND_IRDATA))
748                 dev_dbg(dev, "Raw IR data, %d pulse/space samples", ir->rem);
749 #endif
750 }
751
752 /*
753  * Schedule work that can't be done in interrupt handlers
754  * (mceusb_dev_recv() and mce_async_callback()) nor tasklets.
755  * Invokes mceusb_deferred_kevent() for recovering from
756  * error events specified by the kevent bit field.
757  */
758 static void mceusb_defer_kevent(struct mceusb_dev *ir, int kevent)
759 {
760         set_bit(kevent, &ir->kevent_flags);
761         if (!schedule_work(&ir->kevent))
762                 dev_err(ir->dev, "kevent %d may have been dropped", kevent);
763         else
764                 dev_dbg(ir->dev, "kevent %d scheduled", kevent);
765 }
766
767 static void mce_async_callback(struct urb *urb)
768 {
769         struct mceusb_dev *ir;
770         int len;
771
772         if (!urb)
773                 return;
774
775         ir = urb->context;
776
777         switch (urb->status) {
778         /* success */
779         case 0:
780                 len = urb->actual_length;
781
782                 mceusb_dev_printdata(ir, urb->transfer_buffer, len,
783                                      0, len, true);
784                 break;
785
786         case -ECONNRESET:
787         case -ENOENT:
788         case -EILSEQ:
789         case -ESHUTDOWN:
790                 break;
791
792         case -EPIPE:
793                 dev_err(ir->dev, "Error: request urb status = %d (TX HALT)",
794                         urb->status);
795                 mceusb_defer_kevent(ir, EVENT_TX_HALT);
796                 break;
797
798         default:
799                 dev_err(ir->dev, "Error: request urb status = %d", urb->status);
800                 break;
801         }
802
803         /* the transfer buffer and urb were allocated in mce_request_packet */
804         kfree(urb->transfer_buffer);
805         usb_free_urb(urb);
806 }
807
808 /* request outgoing (send) usb packet - used to initialize remote */
809 static void mce_request_packet(struct mceusb_dev *ir, unsigned char *data,
810                                                                 int size)
811 {
812         int res;
813         struct urb *async_urb;
814         struct device *dev = ir->dev;
815         unsigned char *async_buf;
816
817         async_urb = usb_alloc_urb(0, GFP_KERNEL);
818         if (unlikely(!async_urb)) {
819                 dev_err(dev, "Error, couldn't allocate urb!");
820                 return;
821         }
822
823         async_buf = kmalloc(size, GFP_KERNEL);
824         if (!async_buf) {
825                 usb_free_urb(async_urb);
826                 return;
827         }
828
829         /* outbound data */
830         if (usb_endpoint_xfer_int(ir->usb_ep_out))
831                 usb_fill_int_urb(async_urb, ir->usbdev, ir->pipe_out,
832                                  async_buf, size, mce_async_callback, ir,
833                                  ir->usb_ep_out->bInterval);
834         else
835                 usb_fill_bulk_urb(async_urb, ir->usbdev, ir->pipe_out,
836                                   async_buf, size, mce_async_callback, ir);
837
838         memcpy(async_buf, data, size);
839
840         dev_dbg(dev, "send request called (size=%#x)", size);
841
842         res = usb_submit_urb(async_urb, GFP_ATOMIC);
843         if (res) {
844                 dev_err(dev, "send request FAILED! (res=%d)", res);
845                 kfree(async_buf);
846                 usb_free_urb(async_urb);
847                 return;
848         }
849         dev_dbg(dev, "send request complete (res=%d)", res);
850 }
851
852 static void mce_async_out(struct mceusb_dev *ir, unsigned char *data, int size)
853 {
854         int rsize = sizeof(DEVICE_RESUME);
855
856         if (ir->need_reset) {
857                 ir->need_reset = false;
858                 mce_request_packet(ir, DEVICE_RESUME, rsize);
859                 msleep(10);
860         }
861
862         mce_request_packet(ir, data, size);
863         msleep(10);
864 }
865
866 /* Send data out the IR blaster port(s) */
867 static int mceusb_tx_ir(struct rc_dev *dev, unsigned *txbuf, unsigned count)
868 {
869         struct mceusb_dev *ir = dev->priv;
870         int i, length, ret = 0;
871         int cmdcount = 0;
872         unsigned char cmdbuf[MCE_CMDBUF_SIZE];
873
874         /* MCE tx init header */
875         cmdbuf[cmdcount++] = MCE_CMD_PORT_IR;
876         cmdbuf[cmdcount++] = MCE_CMD_SETIRTXPORTS;
877         cmdbuf[cmdcount++] = ir->tx_mask;
878
879         /* Send the set TX ports command */
880         mce_async_out(ir, cmdbuf, cmdcount);
881         cmdcount = 0;
882
883         /* Generate mce packet data */
884         for (i = 0; (i < count) && (cmdcount < MCE_CMDBUF_SIZE); i++) {
885                 txbuf[i] = txbuf[i] / MCE_TIME_UNIT;
886
887                 do { /* loop to support long pulses/spaces > 127*50us=6.35ms */
888
889                         /* Insert mce packet header every 4th entry */
890                         if ((cmdcount < MCE_CMDBUF_SIZE) &&
891                             (cmdcount % MCE_CODE_LENGTH) == 0)
892                                 cmdbuf[cmdcount++] = MCE_IRDATA_HEADER;
893
894                         /* Insert mce packet data */
895                         if (cmdcount < MCE_CMDBUF_SIZE)
896                                 cmdbuf[cmdcount++] =
897                                         (txbuf[i] < MCE_PULSE_BIT ?
898                                          txbuf[i] : MCE_MAX_PULSE_LENGTH) |
899                                          (i & 1 ? 0x00 : MCE_PULSE_BIT);
900                         else {
901                                 ret = -EINVAL;
902                                 goto out;
903                         }
904
905                 } while ((txbuf[i] > MCE_MAX_PULSE_LENGTH) &&
906                          (txbuf[i] -= MCE_MAX_PULSE_LENGTH));
907         }
908
909         /* Check if we have room for the empty packet at the end */
910         if (cmdcount >= MCE_CMDBUF_SIZE) {
911                 ret = -EINVAL;
912                 goto out;
913         }
914
915         /* Fix packet length in last header */
916         length = cmdcount % MCE_CODE_LENGTH;
917         cmdbuf[cmdcount - length] -= MCE_CODE_LENGTH - length;
918
919         /* All mce commands end with an empty packet (0x80) */
920         cmdbuf[cmdcount++] = MCE_IRDATA_TRAILER;
921
922         /* Transmit the command to the mce device */
923         mce_async_out(ir, cmdbuf, cmdcount);
924
925 out:
926         return ret ? ret : count;
927 }
928
929 /* Sets active IR outputs -- mce devices typically have two */
930 static int mceusb_set_tx_mask(struct rc_dev *dev, u32 mask)
931 {
932         struct mceusb_dev *ir = dev->priv;
933
934         /* return number of transmitters */
935         int emitters = ir->num_txports ? ir->num_txports : 2;
936
937         if (mask >= (1 << emitters))
938                 return emitters;
939
940         if (ir->flags.tx_mask_normal)
941                 ir->tx_mask = mask;
942         else
943                 ir->tx_mask = (mask != MCE_DEFAULT_TX_MASK ?
944                                 mask ^ MCE_DEFAULT_TX_MASK : mask) << 1;
945
946         return 0;
947 }
948
949 /* Sets the send carrier frequency and mode */
950 static int mceusb_set_tx_carrier(struct rc_dev *dev, u32 carrier)
951 {
952         struct mceusb_dev *ir = dev->priv;
953         int clk = 10000000;
954         int prescaler = 0, divisor = 0;
955         unsigned char cmdbuf[4] = { MCE_CMD_PORT_IR,
956                                     MCE_CMD_SETIRCFS, 0x00, 0x00 };
957
958         /* Carrier has changed */
959         if (ir->carrier != carrier) {
960
961                 if (carrier == 0) {
962                         ir->carrier = carrier;
963                         cmdbuf[2] = MCE_CMD_SIG_END;
964                         cmdbuf[3] = MCE_IRDATA_TRAILER;
965                         dev_dbg(ir->dev, "disabling carrier modulation");
966                         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
967                         return 0;
968                 }
969
970                 for (prescaler = 0; prescaler < 4; ++prescaler) {
971                         divisor = (clk >> (2 * prescaler)) / carrier;
972                         if (divisor <= 0xff) {
973                                 ir->carrier = carrier;
974                                 cmdbuf[2] = prescaler;
975                                 cmdbuf[3] = divisor;
976                                 dev_dbg(ir->dev, "requesting %u HZ carrier",
977                                                                 carrier);
978
979                                 /* Transmit new carrier to mce device */
980                                 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
981                                 return 0;
982                         }
983                 }
984
985                 return -EINVAL;
986
987         }
988
989         return 0;
990 }
991
992 static int mceusb_set_timeout(struct rc_dev *dev, unsigned int timeout)
993 {
994         u8 cmdbuf[4] = { MCE_CMD_PORT_IR, MCE_CMD_SETIRTIMEOUT, 0, 0 };
995         struct mceusb_dev *ir = dev->priv;
996         unsigned int units;
997
998         units = DIV_ROUND_CLOSEST(timeout, US_TO_NS(MCE_TIME_UNIT));
999
1000         cmdbuf[2] = units >> 8;
1001         cmdbuf[3] = units;
1002
1003         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1004
1005         /* get receiver timeout value */
1006         mce_async_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT));
1007
1008         return 0;
1009 }
1010
1011 /*
1012  * Select or deselect the 2nd receiver port.
1013  * Second receiver is learning mode, wide-band, short-range receiver.
1014  * Only one receiver (long or short range) may be active at a time.
1015  */
1016 static int mceusb_set_rx_wideband(struct rc_dev *dev, int enable)
1017 {
1018         struct mceusb_dev *ir = dev->priv;
1019         unsigned char cmdbuf[3] = { MCE_CMD_PORT_IR,
1020                                     MCE_CMD_SETIRRXPORTEN, 0x00 };
1021
1022         dev_dbg(ir->dev, "select %s-range receive sensor",
1023                 enable ? "short" : "long");
1024         if (enable) {
1025                 ir->wideband_rx_enabled = true;
1026                 cmdbuf[2] = 2;  /* port 2 is short range receiver */
1027         } else {
1028                 ir->wideband_rx_enabled = false;
1029                 cmdbuf[2] = 1;  /* port 1 is long range receiver */
1030         }
1031         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1032         /* response from device sets ir->learning_active */
1033
1034         return 0;
1035 }
1036
1037 /*
1038  * Enable/disable receiver carrier frequency pass through reporting.
1039  * Only the short-range receiver has carrier frequency measuring capability.
1040  * Implicitly select this receiver when enabling carrier frequency reporting.
1041  */
1042 static int mceusb_set_rx_carrier_report(struct rc_dev *dev, int enable)
1043 {
1044         struct mceusb_dev *ir = dev->priv;
1045         unsigned char cmdbuf[3] = { MCE_CMD_PORT_IR,
1046                                     MCE_CMD_SETIRRXPORTEN, 0x00 };
1047
1048         dev_dbg(ir->dev, "%s short-range receiver carrier reporting",
1049                 enable ? "enable" : "disable");
1050         if (enable) {
1051                 ir->carrier_report_enabled = true;
1052                 if (!ir->learning_active) {
1053                         cmdbuf[2] = 2;  /* port 2 is short range receiver */
1054                         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1055                 }
1056         } else {
1057                 ir->carrier_report_enabled = false;
1058                 /*
1059                  * Revert to normal (long-range) receiver only if the
1060                  * wideband (short-range) receiver wasn't explicitly
1061                  * enabled.
1062                  */
1063                 if (ir->learning_active && !ir->wideband_rx_enabled) {
1064                         cmdbuf[2] = 1;  /* port 1 is long range receiver */
1065                         mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1066                 }
1067         }
1068
1069         return 0;
1070 }
1071
1072 /*
1073  * We don't do anything but print debug spew for many of the command bits
1074  * we receive from the hardware, but some of them are useful information
1075  * we want to store so that we can use them.
1076  */
1077 static void mceusb_handle_command(struct mceusb_dev *ir, int index)
1078 {
1079         struct ir_raw_event rawir = {};
1080         u8 hi = ir->buf_in[index + 1] & 0xff;
1081         u8 lo = ir->buf_in[index + 2] & 0xff;
1082         u32 carrier_cycles;
1083         u32 cycles_fix;
1084
1085         switch (ir->buf_in[index]) {
1086         /* the one and only 5-byte return value command */
1087         case MCE_RSP_GETPORTSTATUS:
1088                 if ((ir->buf_in[index + 4] & 0xff) == 0x00)
1089                         ir->txports_cabled |= 1 << hi;
1090                 break;
1091
1092         /* 2-byte return value commands */
1093         case MCE_RSP_EQIRTIMEOUT:
1094                 ir->rc->timeout = US_TO_NS((hi << 8 | lo) * MCE_TIME_UNIT);
1095                 break;
1096         case MCE_RSP_EQIRNUMPORTS:
1097                 ir->num_txports = hi;
1098                 ir->num_rxports = lo;
1099                 break;
1100         case MCE_RSP_EQIRRXCFCNT:
1101                 /*
1102                  * The carrier cycle counter can overflow and wrap around
1103                  * without notice from the device. So frequency measurement
1104                  * will be inaccurate with long duration IR.
1105                  *
1106                  * The long-range (non learning) receiver always reports
1107                  * zero count so we always ignore its report.
1108                  */
1109                 if (ir->carrier_report_enabled && ir->learning_active &&
1110                     ir->pulse_tunit > 0) {
1111                         carrier_cycles = (hi << 8 | lo);
1112                         /*
1113                          * Adjust carrier cycle count by adding
1114                          * 1 missed count per pulse "on"
1115                          */
1116                         cycles_fix = ir->flags.rx2 == 2 ? ir->pulse_count : 0;
1117                         rawir.carrier_report = 1;
1118                         rawir.carrier = (1000000u / MCE_TIME_UNIT) *
1119                                         (carrier_cycles + cycles_fix) /
1120                                         ir->pulse_tunit;
1121                         dev_dbg(ir->dev, "RX carrier frequency %u Hz (pulse count = %u, cycles = %u, duration = %u, rx2 = %u)",
1122                                 rawir.carrier, ir->pulse_count, carrier_cycles,
1123                                 ir->pulse_tunit, ir->flags.rx2);
1124                         ir_raw_event_store(ir->rc, &rawir);
1125                 }
1126                 break;
1127
1128         /* 1-byte return value commands */
1129         case MCE_RSP_EQEMVER:
1130                 ir->emver = hi;
1131                 break;
1132         case MCE_RSP_EQIRTXPORTS:
1133                 ir->tx_mask = hi;
1134                 break;
1135         case MCE_RSP_EQIRRXPORTEN:
1136                 ir->learning_active = ((hi & 0x02) == 0x02);
1137                 if (ir->rxports_active != hi) {
1138                         dev_info(ir->dev, "%s-range (0x%x) receiver active",
1139                                  ir->learning_active ? "short" : "long", hi);
1140                         ir->rxports_active = hi;
1141                 }
1142                 break;
1143         case MCE_RSP_CMD_ILLEGAL:
1144                 ir->need_reset = true;
1145                 break;
1146         default:
1147                 break;
1148         }
1149 }
1150
1151 static void mceusb_process_ir_data(struct mceusb_dev *ir, int buf_len)
1152 {
1153         struct ir_raw_event rawir = {};
1154         bool event = false;
1155         int i = 0;
1156
1157         /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
1158         if (ir->flags.microsoft_gen1)
1159                 i = 2;
1160
1161         /* if there's no data, just return now */
1162         if (buf_len <= i)
1163                 return;
1164
1165         for (; i < buf_len; i++) {
1166                 switch (ir->parser_state) {
1167                 case SUBCMD:
1168                         ir->rem = mceusb_cmd_datasize(ir->cmd, ir->buf_in[i]);
1169                         mceusb_dev_printdata(ir, ir->buf_in, buf_len, i - 1,
1170                                              ir->rem + 2, false);
1171                         mceusb_handle_command(ir, i);
1172                         ir->parser_state = CMD_DATA;
1173                         break;
1174                 case PARSE_IRDATA:
1175                         ir->rem--;
1176                         rawir.pulse = ((ir->buf_in[i] & MCE_PULSE_BIT) != 0);
1177                         rawir.duration = (ir->buf_in[i] & MCE_PULSE_MASK);
1178                         if (unlikely(!rawir.duration)) {
1179                                 dev_dbg(ir->dev, "nonsensical irdata %02x with duration 0",
1180                                         ir->buf_in[i]);
1181                                 break;
1182                         }
1183                         if (rawir.pulse) {
1184                                 ir->pulse_tunit += rawir.duration;
1185                                 ir->pulse_count++;
1186                         }
1187                         rawir.duration *= US_TO_NS(MCE_TIME_UNIT);
1188
1189                         dev_dbg(ir->dev, "Storing %s %u ns (%02x)",
1190                                 rawir.pulse ? "pulse" : "space",
1191                                 rawir.duration, ir->buf_in[i]);
1192
1193                         if (ir_raw_event_store_with_filter(ir->rc, &rawir))
1194                                 event = true;
1195                         break;
1196                 case CMD_DATA:
1197                         ir->rem--;
1198                         break;
1199                 case CMD_HEADER:
1200                         /* decode mce packets of the form (84),AA,BB,CC,DD */
1201                         /* IR data packets can span USB messages - rem */
1202                         ir->cmd = ir->buf_in[i];
1203                         if ((ir->cmd == MCE_CMD_PORT_IR) ||
1204                             ((ir->cmd & MCE_PORT_MASK) !=
1205                              MCE_COMMAND_IRDATA)) {
1206                                 ir->parser_state = SUBCMD;
1207                                 continue;
1208                         }
1209                         ir->rem = (ir->cmd & MCE_PACKET_LENGTH_MASK);
1210                         mceusb_dev_printdata(ir, ir->buf_in, buf_len,
1211                                              i, ir->rem + 1, false);
1212                         if (ir->rem) {
1213                                 ir->parser_state = PARSE_IRDATA;
1214                         } else {
1215                                 struct ir_raw_event ev = {
1216                                         .timeout = 1,
1217                                         .duration = ir->rc->timeout
1218                                 };
1219
1220                                 if (ir_raw_event_store_with_filter(ir->rc,
1221                                                                    &ev))
1222                                         event = true;
1223                                 ir->pulse_tunit = 0;
1224                                 ir->pulse_count = 0;
1225                         }
1226                         break;
1227                 }
1228
1229                 if (ir->parser_state != CMD_HEADER && !ir->rem)
1230                         ir->parser_state = CMD_HEADER;
1231         }
1232         if (event) {
1233                 dev_dbg(ir->dev, "processed IR data");
1234                 ir_raw_event_handle(ir->rc);
1235         }
1236 }
1237
1238 static void mceusb_dev_recv(struct urb *urb)
1239 {
1240         struct mceusb_dev *ir;
1241
1242         if (!urb)
1243                 return;
1244
1245         ir = urb->context;
1246         if (!ir) {
1247                 usb_unlink_urb(urb);
1248                 return;
1249         }
1250
1251         switch (urb->status) {
1252         /* success */
1253         case 0:
1254                 mceusb_process_ir_data(ir, urb->actual_length);
1255                 break;
1256
1257         case -ECONNRESET:
1258         case -ENOENT:
1259         case -EILSEQ:
1260         case -ESHUTDOWN:
1261                 usb_unlink_urb(urb);
1262                 return;
1263
1264         case -EPIPE:
1265                 dev_err(ir->dev, "Error: urb status = %d (RX HALT)",
1266                         urb->status);
1267                 mceusb_defer_kevent(ir, EVENT_RX_HALT);
1268                 return;
1269
1270         default:
1271                 dev_err(ir->dev, "Error: urb status = %d", urb->status);
1272                 break;
1273         }
1274
1275         usb_submit_urb(urb, GFP_ATOMIC);
1276 }
1277
1278 static void mceusb_get_emulator_version(struct mceusb_dev *ir)
1279 {
1280         /* If we get no reply or an illegal command reply, its ver 1, says MS */
1281         ir->emver = 1;
1282         mce_async_out(ir, GET_EMVER, sizeof(GET_EMVER));
1283 }
1284
1285 static void mceusb_gen1_init(struct mceusb_dev *ir)
1286 {
1287         int ret;
1288         struct device *dev = ir->dev;
1289         char *data;
1290
1291         data = kzalloc(USB_CTRL_MSG_SZ, GFP_KERNEL);
1292         if (!data) {
1293                 dev_err(dev, "%s: memory allocation failed!", __func__);
1294                 return;
1295         }
1296
1297         /*
1298          * This is a strange one. Windows issues a set address to the device
1299          * on the receive control pipe and expect a certain value pair back
1300          */
1301         ret = usb_control_msg(ir->usbdev, usb_rcvctrlpipe(ir->usbdev, 0),
1302                               USB_REQ_SET_ADDRESS, USB_TYPE_VENDOR, 0, 0,
1303                               data, USB_CTRL_MSG_SZ, HZ * 3);
1304         dev_dbg(dev, "set address - ret = %d", ret);
1305         dev_dbg(dev, "set address - data[0] = %d, data[1] = %d",
1306                                                 data[0], data[1]);
1307
1308         /* set feature: bit rate 38400 bps */
1309         ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1310                               USB_REQ_SET_FEATURE, USB_TYPE_VENDOR,
1311                               0xc04e, 0x0000, NULL, 0, HZ * 3);
1312
1313         dev_dbg(dev, "set feature - ret = %d", ret);
1314
1315         /* bRequest 4: set char length to 8 bits */
1316         ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1317                               4, USB_TYPE_VENDOR,
1318                               0x0808, 0x0000, NULL, 0, HZ * 3);
1319         dev_dbg(dev, "set char length - retB = %d", ret);
1320
1321         /* bRequest 2: set handshaking to use DTR/DSR */
1322         ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1323                               2, USB_TYPE_VENDOR,
1324                               0x0000, 0x0100, NULL, 0, HZ * 3);
1325         dev_dbg(dev, "set handshake  - retC = %d", ret);
1326
1327         /* device resume */
1328         mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
1329
1330         /* get hw/sw revision? */
1331         mce_async_out(ir, GET_REVISION, sizeof(GET_REVISION));
1332
1333         kfree(data);
1334 }
1335
1336 static void mceusb_gen2_init(struct mceusb_dev *ir)
1337 {
1338         /* device resume */
1339         mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
1340
1341         /* get wake version (protocol, key, address) */
1342         mce_async_out(ir, GET_WAKEVERSION, sizeof(GET_WAKEVERSION));
1343
1344         /* unknown what this one actually returns... */
1345         mce_async_out(ir, GET_UNKNOWN2, sizeof(GET_UNKNOWN2));
1346 }
1347
1348 static void mceusb_get_parameters(struct mceusb_dev *ir)
1349 {
1350         int i;
1351         unsigned char cmdbuf[3] = { MCE_CMD_PORT_SYS,
1352                                     MCE_CMD_GETPORTSTATUS, 0x00 };
1353
1354         /* defaults, if the hardware doesn't support querying */
1355         ir->num_txports = 2;
1356         ir->num_rxports = 2;
1357
1358         /* get number of tx and rx ports */
1359         mce_async_out(ir, GET_NUM_PORTS, sizeof(GET_NUM_PORTS));
1360
1361         /* get the carrier and frequency */
1362         mce_async_out(ir, GET_CARRIER_FREQ, sizeof(GET_CARRIER_FREQ));
1363
1364         if (ir->num_txports && !ir->flags.no_tx)
1365                 /* get the transmitter bitmask */
1366                 mce_async_out(ir, GET_TX_BITMASK, sizeof(GET_TX_BITMASK));
1367
1368         /* get receiver timeout value */
1369         mce_async_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT));
1370
1371         /* get receiver sensor setting */
1372         mce_async_out(ir, GET_RX_SENSOR, sizeof(GET_RX_SENSOR));
1373
1374         for (i = 0; i < ir->num_txports; i++) {
1375                 cmdbuf[2] = i;
1376                 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1377         }
1378 }
1379
1380 static void mceusb_flash_led(struct mceusb_dev *ir)
1381 {
1382         if (ir->emver < 2)
1383                 return;
1384
1385         mce_async_out(ir, FLASH_LED, sizeof(FLASH_LED));
1386 }
1387
1388 /*
1389  * Workqueue function
1390  * for resetting or recovering device after occurrence of error events
1391  * specified in ir->kevent bit field.
1392  * Function runs (via schedule_work()) in non-interrupt context, for
1393  * calls here (such as usb_clear_halt()) requiring non-interrupt context.
1394  */
1395 static void mceusb_deferred_kevent(struct work_struct *work)
1396 {
1397         struct mceusb_dev *ir =
1398                 container_of(work, struct mceusb_dev, kevent);
1399         int status;
1400
1401         if (test_bit(EVENT_RX_HALT, &ir->kevent_flags)) {
1402                 usb_unlink_urb(ir->urb_in);
1403                 status = usb_clear_halt(ir->usbdev, ir->pipe_in);
1404                 if (status < 0) {
1405                         dev_err(ir->dev, "rx clear halt error %d",
1406                                 status);
1407                 }
1408                 clear_bit(EVENT_RX_HALT, &ir->kevent_flags);
1409                 if (status == 0) {
1410                         status = usb_submit_urb(ir->urb_in, GFP_KERNEL);
1411                         if (status < 0) {
1412                                 dev_err(ir->dev,
1413                                         "rx unhalt submit urb error %d",
1414                                         status);
1415                         }
1416                 }
1417         }
1418
1419         if (test_bit(EVENT_TX_HALT, &ir->kevent_flags)) {
1420                 status = usb_clear_halt(ir->usbdev, ir->pipe_out);
1421                 if (status < 0)
1422                         dev_err(ir->dev, "tx clear halt error %d", status);
1423                 clear_bit(EVENT_TX_HALT, &ir->kevent_flags);
1424         }
1425 }
1426
1427 static struct rc_dev *mceusb_init_rc_dev(struct mceusb_dev *ir)
1428 {
1429         struct usb_device *udev = ir->usbdev;
1430         struct device *dev = ir->dev;
1431         struct rc_dev *rc;
1432         int ret;
1433
1434         rc = rc_allocate_device(RC_DRIVER_IR_RAW);
1435         if (!rc) {
1436                 dev_err(dev, "remote dev allocation failed");
1437                 goto out;
1438         }
1439
1440         snprintf(ir->name, sizeof(ir->name), "%s (%04x:%04x)",
1441                  mceusb_model[ir->model].name ?
1442                         mceusb_model[ir->model].name :
1443                         "Media Center Ed. eHome Infrared Remote Transceiver",
1444                  le16_to_cpu(ir->usbdev->descriptor.idVendor),
1445                  le16_to_cpu(ir->usbdev->descriptor.idProduct));
1446
1447         usb_make_path(ir->usbdev, ir->phys, sizeof(ir->phys));
1448
1449         rc->device_name = ir->name;
1450         rc->input_phys = ir->phys;
1451         usb_to_input_id(ir->usbdev, &rc->input_id);
1452         rc->dev.parent = dev;
1453         rc->priv = ir;
1454         rc->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;
1455         rc->min_timeout = US_TO_NS(MCE_TIME_UNIT);
1456         rc->timeout = MS_TO_NS(100);
1457         if (!mceusb_model[ir->model].broken_irtimeout) {
1458                 rc->s_timeout = mceusb_set_timeout;
1459                 rc->max_timeout = 10 * IR_DEFAULT_TIMEOUT;
1460         } else {
1461                 /*
1462                  * If we can't set the timeout using CMD_SETIRTIMEOUT, we can
1463                  * rely on software timeouts for timeouts < 100ms.
1464                  */
1465                 rc->max_timeout = rc->timeout;
1466         }
1467         if (!ir->flags.no_tx) {
1468                 rc->s_tx_mask = mceusb_set_tx_mask;
1469                 rc->s_tx_carrier = mceusb_set_tx_carrier;
1470                 rc->tx_ir = mceusb_tx_ir;
1471         }
1472         if (ir->flags.rx2 > 0) {
1473                 rc->s_learning_mode = mceusb_set_rx_wideband;
1474                 rc->s_carrier_report = mceusb_set_rx_carrier_report;
1475         }
1476         rc->driver_name = DRIVER_NAME;
1477
1478         switch (le16_to_cpu(udev->descriptor.idVendor)) {
1479         case VENDOR_HAUPPAUGE:
1480                 rc->map_name = RC_MAP_HAUPPAUGE;
1481                 break;
1482         case VENDOR_PCTV:
1483                 rc->map_name = RC_MAP_PINNACLE_PCTV_HD;
1484                 break;
1485         default:
1486                 rc->map_name = RC_MAP_RC6_MCE;
1487         }
1488         if (mceusb_model[ir->model].rc_map)
1489                 rc->map_name = mceusb_model[ir->model].rc_map;
1490
1491         ret = rc_register_device(rc);
1492         if (ret < 0) {
1493                 dev_err(dev, "remote dev registration failed");
1494                 goto out;
1495         }
1496
1497         return rc;
1498
1499 out:
1500         rc_free_device(rc);
1501         return NULL;
1502 }
1503
1504 static int mceusb_dev_probe(struct usb_interface *intf,
1505                             const struct usb_device_id *id)
1506 {
1507         struct usb_device *dev = interface_to_usbdev(intf);
1508         struct usb_host_interface *idesc;
1509         struct usb_endpoint_descriptor *ep = NULL;
1510         struct usb_endpoint_descriptor *ep_in = NULL;
1511         struct usb_endpoint_descriptor *ep_out = NULL;
1512         struct mceusb_dev *ir = NULL;
1513         int pipe, maxp, i, res;
1514         char buf[63], name[128] = "";
1515         enum mceusb_model_type model = id->driver_info;
1516         bool is_gen3;
1517         bool is_microsoft_gen1;
1518         bool tx_mask_normal;
1519         int ir_intfnum;
1520
1521         dev_dbg(&intf->dev, "%s called", __func__);
1522
1523         idesc  = intf->cur_altsetting;
1524
1525         is_gen3 = mceusb_model[model].mce_gen3;
1526         is_microsoft_gen1 = mceusb_model[model].mce_gen1;
1527         tx_mask_normal = mceusb_model[model].tx_mask_normal;
1528         ir_intfnum = mceusb_model[model].ir_intfnum;
1529
1530         /* There are multi-function devices with non-IR interfaces */
1531         if (idesc->desc.bInterfaceNumber != ir_intfnum)
1532                 return -ENODEV;
1533
1534         /* step through the endpoints to find first bulk in and out endpoint */
1535         for (i = 0; i < idesc->desc.bNumEndpoints; ++i) {
1536                 ep = &idesc->endpoint[i].desc;
1537
1538                 if (ep_in == NULL) {
1539                         if (usb_endpoint_is_bulk_in(ep)) {
1540                                 ep_in = ep;
1541                                 dev_dbg(&intf->dev, "acceptable bulk inbound endpoint found\n");
1542                         } else if (usb_endpoint_is_int_in(ep)) {
1543                                 ep_in = ep;
1544                                 ep_in->bInterval = 1;
1545                                 dev_dbg(&intf->dev, "acceptable interrupt inbound endpoint found\n");
1546                         }
1547                 }
1548
1549                 if (ep_out == NULL) {
1550                         if (usb_endpoint_is_bulk_out(ep)) {
1551                                 ep_out = ep;
1552                                 dev_dbg(&intf->dev, "acceptable bulk outbound endpoint found\n");
1553                         } else if (usb_endpoint_is_int_out(ep)) {
1554                                 ep_out = ep;
1555                                 ep_out->bInterval = 1;
1556                                 dev_dbg(&intf->dev, "acceptable interrupt outbound endpoint found\n");
1557                         }
1558                 }
1559         }
1560         if (!ep_in || !ep_out) {
1561                 dev_dbg(&intf->dev, "required endpoints not found\n");
1562                 return -ENODEV;
1563         }
1564
1565         if (usb_endpoint_xfer_int(ep_in))
1566                 pipe = usb_rcvintpipe(dev, ep_in->bEndpointAddress);
1567         else
1568                 pipe = usb_rcvbulkpipe(dev, ep_in->bEndpointAddress);
1569         maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
1570
1571         ir = kzalloc(sizeof(struct mceusb_dev), GFP_KERNEL);
1572         if (!ir)
1573                 goto mem_alloc_fail;
1574
1575         ir->pipe_in = pipe;
1576         ir->buf_in = usb_alloc_coherent(dev, maxp, GFP_ATOMIC, &ir->dma_in);
1577         if (!ir->buf_in)
1578                 goto buf_in_alloc_fail;
1579
1580         ir->urb_in = usb_alloc_urb(0, GFP_KERNEL);
1581         if (!ir->urb_in)
1582                 goto urb_in_alloc_fail;
1583
1584         ir->usbdev = usb_get_dev(dev);
1585         ir->dev = &intf->dev;
1586         ir->len_in = maxp;
1587         ir->flags.microsoft_gen1 = is_microsoft_gen1;
1588         ir->flags.tx_mask_normal = tx_mask_normal;
1589         ir->flags.no_tx = mceusb_model[model].no_tx;
1590         ir->flags.rx2 = mceusb_model[model].rx2;
1591         ir->model = model;
1592
1593         /* Saving usb interface data for use by the transmitter routine */
1594         ir->usb_ep_out = ep_out;
1595         if (usb_endpoint_xfer_int(ep_out))
1596                 ir->pipe_out = usb_sndintpipe(ir->usbdev,
1597                                               ep_out->bEndpointAddress);
1598         else
1599                 ir->pipe_out = usb_sndbulkpipe(ir->usbdev,
1600                                                ep_out->bEndpointAddress);
1601
1602         if (dev->descriptor.iManufacturer
1603             && usb_string(dev, dev->descriptor.iManufacturer,
1604                           buf, sizeof(buf)) > 0)
1605                 strscpy(name, buf, sizeof(name));
1606         if (dev->descriptor.iProduct
1607             && usb_string(dev, dev->descriptor.iProduct,
1608                           buf, sizeof(buf)) > 0)
1609                 snprintf(name + strlen(name), sizeof(name) - strlen(name),
1610                          " %s", buf);
1611
1612         /*
1613          * Initialize async USB error handler before registering
1614          * or activating any mceusb RX and TX functions
1615          */
1616         INIT_WORK(&ir->kevent, mceusb_deferred_kevent);
1617
1618         ir->rc = mceusb_init_rc_dev(ir);
1619         if (!ir->rc)
1620                 goto rc_dev_fail;
1621
1622         /* wire up inbound data handler */
1623         if (usb_endpoint_xfer_int(ep_in))
1624                 usb_fill_int_urb(ir->urb_in, dev, pipe, ir->buf_in, maxp,
1625                                  mceusb_dev_recv, ir, ep_in->bInterval);
1626         else
1627                 usb_fill_bulk_urb(ir->urb_in, dev, pipe, ir->buf_in, maxp,
1628                                   mceusb_dev_recv, ir);
1629
1630         ir->urb_in->transfer_dma = ir->dma_in;
1631         ir->urb_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1632
1633         /* flush buffers on the device */
1634         dev_dbg(&intf->dev, "Flushing receive buffers");
1635         res = usb_submit_urb(ir->urb_in, GFP_KERNEL);
1636         if (res)
1637                 dev_err(&intf->dev, "failed to flush buffers: %d", res);
1638
1639         /* figure out which firmware/emulator version this hardware has */
1640         mceusb_get_emulator_version(ir);
1641
1642         /* initialize device */
1643         if (ir->flags.microsoft_gen1)
1644                 mceusb_gen1_init(ir);
1645         else if (!is_gen3)
1646                 mceusb_gen2_init(ir);
1647
1648         mceusb_get_parameters(ir);
1649
1650         mceusb_flash_led(ir);
1651
1652         if (!ir->flags.no_tx)
1653                 mceusb_set_tx_mask(ir->rc, MCE_DEFAULT_TX_MASK);
1654
1655         usb_set_intfdata(intf, ir);
1656
1657         /* enable wake via this device */
1658         device_set_wakeup_capable(ir->dev, true);
1659         device_set_wakeup_enable(ir->dev, true);
1660
1661         dev_info(&intf->dev, "Registered %s with mce emulator interface version %x",
1662                 name, ir->emver);
1663         dev_info(&intf->dev, "%x tx ports (0x%x cabled) and %x rx sensors (0x%x active)",
1664                  ir->num_txports, ir->txports_cabled,
1665                  ir->num_rxports, ir->rxports_active);
1666
1667         return 0;
1668
1669         /* Error-handling path */
1670 rc_dev_fail:
1671         cancel_work_sync(&ir->kevent);
1672         usb_put_dev(ir->usbdev);
1673         usb_kill_urb(ir->urb_in);
1674         usb_free_urb(ir->urb_in);
1675 urb_in_alloc_fail:
1676         usb_free_coherent(dev, maxp, ir->buf_in, ir->dma_in);
1677 buf_in_alloc_fail:
1678         kfree(ir);
1679 mem_alloc_fail:
1680         dev_err(&intf->dev, "%s: device setup failed!", __func__);
1681
1682         return -ENOMEM;
1683 }
1684
1685
1686 static void mceusb_dev_disconnect(struct usb_interface *intf)
1687 {
1688         struct usb_device *dev = interface_to_usbdev(intf);
1689         struct mceusb_dev *ir = usb_get_intfdata(intf);
1690
1691         usb_set_intfdata(intf, NULL);
1692
1693         if (!ir)
1694                 return;
1695
1696         ir->usbdev = NULL;
1697         cancel_work_sync(&ir->kevent);
1698         rc_unregister_device(ir->rc);
1699         usb_kill_urb(ir->urb_in);
1700         usb_free_urb(ir->urb_in);
1701         usb_free_coherent(dev, ir->len_in, ir->buf_in, ir->dma_in);
1702         usb_put_dev(dev);
1703
1704         kfree(ir);
1705 }
1706
1707 static int mceusb_dev_suspend(struct usb_interface *intf, pm_message_t message)
1708 {
1709         struct mceusb_dev *ir = usb_get_intfdata(intf);
1710         dev_info(ir->dev, "suspend");
1711         usb_kill_urb(ir->urb_in);
1712         return 0;
1713 }
1714
1715 static int mceusb_dev_resume(struct usb_interface *intf)
1716 {
1717         struct mceusb_dev *ir = usb_get_intfdata(intf);
1718         dev_info(ir->dev, "resume");
1719         if (usb_submit_urb(ir->urb_in, GFP_ATOMIC))
1720                 return -EIO;
1721         return 0;
1722 }
1723
1724 static struct usb_driver mceusb_dev_driver = {
1725         .name =         DRIVER_NAME,
1726         .probe =        mceusb_dev_probe,
1727         .disconnect =   mceusb_dev_disconnect,
1728         .suspend =      mceusb_dev_suspend,
1729         .resume =       mceusb_dev_resume,
1730         .reset_resume = mceusb_dev_resume,
1731         .id_table =     mceusb_dev_table
1732 };
1733
1734 module_usb_driver(mceusb_dev_driver);
1735
1736 MODULE_DESCRIPTION(DRIVER_DESC);
1737 MODULE_AUTHOR(DRIVER_AUTHOR);
1738 MODULE_LICENSE("GPL");
1739 MODULE_DEVICE_TABLE(usb, mceusb_dev_table);