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