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