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