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