blob: f38d9a8c6880168a4c6256bdb227218c70123ed9 [file] [log] [blame]
Jarod Wilson66e89522010-06-01 17:32:08 -03001/*
2 * Driver for USB Windows Media Center Ed. eHome Infrared Transceivers
3 *
Jarod Wilsonfda516b2011-07-18 16:54:29 -03004 * Copyright (c) 2010-2011, Jarod Wilson <jarod@redhat.com>
Jarod Wilson66e89522010-06-01 17:32:08 -03005 *
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 *
Jarod Wilsonfda516b2011-07-18 16:54:29 -030018 * 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 *
Jarod Wilson66e89522010-06-01 17:32:08 -030023 *
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 * You should have received a copy of the GNU General Public License
35 * along with this program; if not, write to the Free Software
36 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
37 *
38 */
39
40#include <linux/device.h>
41#include <linux/module.h>
42#include <linux/slab.h>
Paul Bender635f76b2010-12-16 13:23:07 -030043#include <linux/usb.h>
44#include <linux/usb/input.h>
Jarod Wilsonfa3348982011-07-18 16:54:23 -030045#include <linux/pm_wakeup.h>
Mauro Carvalho Chehab6bda9642010-11-17 13:28:38 -030046#include <media/rc-core.h>
Jarod Wilson66e89522010-06-01 17:32:08 -030047
Jarod Wilsonfda516b2011-07-18 16:54:29 -030048#define DRIVER_VERSION "1.92"
49#define DRIVER_AUTHOR "Jarod Wilson <jarod@redhat.com>"
Jarod Wilson66e89522010-06-01 17:32:08 -030050#define DRIVER_DESC "Windows Media Center Ed. eHome Infrared Transceiver " \
51 "device driver"
52#define DRIVER_NAME "mceusb"
53
Jarod Wilson4a883912010-10-22 14:42:54 -030054#define USB_BUFLEN 32 /* USB reception buffer length */
55#define USB_CTRL_MSG_SZ 2 /* Size of usb ctrl msg on gen1 hw */
56#define MCE_G1_INIT_MSGS 40 /* Init messages on gen1 hw to throw out */
Jarod Wilson66e89522010-06-01 17:32:08 -030057
58/* MCE constants */
Jarod Wilson4a883912010-10-22 14:42:54 -030059#define MCE_CMDBUF_SIZE 384 /* MCE Command buffer length */
60#define MCE_TIME_UNIT 50 /* Approx 50us resolution */
61#define MCE_CODE_LENGTH 5 /* Normal length of packet (with header) */
62#define MCE_PACKET_SIZE 4 /* Normal length of packet (without header) */
63#define MCE_IRDATA_HEADER 0x84 /* Actual header format is 0x80 + num_bytes */
64#define MCE_IRDATA_TRAILER 0x80 /* End of IR data */
65#define MCE_TX_HEADER_LENGTH 3 /* # of bytes in the initializing tx header */
66#define MCE_MAX_CHANNELS 2 /* Two transmitters, hardware dependent? */
67#define MCE_DEFAULT_TX_MASK 0x03 /* Vals: TX1=0x01, TX2=0x02, ALL=0x03 */
68#define MCE_PULSE_BIT 0x80 /* Pulse bit, MSB set == PULSE else SPACE */
69#define MCE_PULSE_MASK 0x7f /* Pulse mask */
70#define MCE_MAX_PULSE_LENGTH 0x7f /* Longest transmittable pulse symbol */
71
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -030072/*
73 * The interface between the host and the IR hardware is command-response
74 * based. All commands and responses have a consistent format, where a lead
75 * byte always identifies the type of data following it. The lead byte has
76 * a port value in the 3 highest bits and a length value in the 5 lowest
77 * bits.
78 *
79 * The length field is overloaded, with a value of 11111 indicating that the
80 * following byte is a command or response code, and the length of the entire
81 * message is determined by the code. If the length field is not 11111, then
82 * it specifies the number of bytes of port data that follow.
83 */
84#define MCE_CMD 0x1f
85#define MCE_PORT_IR 0x4 /* (0x4 << 5) | MCE_CMD = 0x9f */
86#define MCE_PORT_SYS 0x7 /* (0x7 << 5) | MCE_CMD = 0xff */
87#define MCE_PORT_SER 0x6 /* 0xc0 thru 0xdf flush & 0x1f bytes */
88#define MCE_PORT_MASK 0xe0 /* Mask out command bits */
Jarod Wilson4a883912010-10-22 14:42:54 -030089
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -030090/* Command port headers */
91#define MCE_CMD_PORT_IR 0x9f /* IR-related cmd/rsp */
92#define MCE_CMD_PORT_SYS 0xff /* System (non-IR) device cmd/rsp */
93
94/* Commands that set device state (2-4 bytes in length) */
95#define MCE_CMD_RESET 0xfe /* Reset device, 2 bytes */
96#define MCE_CMD_RESUME 0xaa /* Resume device after error, 2 bytes */
97#define MCE_CMD_SETIRCFS 0x06 /* Set tx carrier, 4 bytes */
98#define MCE_CMD_SETIRTIMEOUT 0x0c /* Set timeout, 4 bytes */
99#define MCE_CMD_SETIRTXPORTS 0x08 /* Set tx ports, 3 bytes */
100#define MCE_CMD_SETIRRXPORTEN 0x14 /* Set rx ports, 3 bytes */
101#define MCE_CMD_FLASHLED 0x23 /* Flash receiver LED, 2 bytes */
102
103/* Commands that query device state (all 2 bytes, unless noted) */
104#define MCE_CMD_GETIRCFS 0x07 /* Get carrier */
105#define MCE_CMD_GETIRTIMEOUT 0x0d /* Get timeout */
106#define MCE_CMD_GETIRTXPORTS 0x13 /* Get tx ports */
107#define MCE_CMD_GETIRRXPORTEN 0x15 /* Get rx ports */
108#define MCE_CMD_GETPORTSTATUS 0x11 /* Get tx port status, 3 bytes */
109#define MCE_CMD_GETIRNUMPORTS 0x16 /* Get number of ports */
110#define MCE_CMD_GETWAKESOURCE 0x17 /* Get wake source */
111#define MCE_CMD_GETEMVER 0x22 /* Get emulator interface version */
112#define MCE_CMD_GETDEVDETAILS 0x21 /* Get device details (em ver2 only) */
113#define MCE_CMD_GETWAKESUPPORT 0x20 /* Get wake details (em ver2 only) */
114#define MCE_CMD_GETWAKEVERSION 0x18 /* Get wake pattern (em ver2 only) */
115
116/* Misc commands */
117#define MCE_CMD_NOP 0xff /* No operation */
118
119/* Responses to commands (non-error cases) */
120#define MCE_RSP_EQIRCFS 0x06 /* tx carrier, 4 bytes */
121#define MCE_RSP_EQIRTIMEOUT 0x0c /* rx timeout, 4 bytes */
122#define MCE_RSP_GETWAKESOURCE 0x17 /* wake source, 3 bytes */
123#define MCE_RSP_EQIRTXPORTS 0x08 /* tx port mask, 3 bytes */
124#define MCE_RSP_EQIRRXPORTEN 0x14 /* rx port mask, 3 bytes */
125#define MCE_RSP_GETPORTSTATUS 0x11 /* tx port status, 7 bytes */
126#define MCE_RSP_EQIRRXCFCNT 0x15 /* rx carrier count, 4 bytes */
127#define MCE_RSP_EQIRNUMPORTS 0x16 /* number of ports, 4 bytes */
128#define MCE_RSP_EQWAKESUPPORT 0x20 /* wake capabilities, 3 bytes */
129#define MCE_RSP_EQWAKEVERSION 0x18 /* wake pattern details, 6 bytes */
130#define MCE_RSP_EQDEVDETAILS 0x21 /* device capabilities, 3 bytes */
131#define MCE_RSP_EQEMVER 0x22 /* emulator interface ver, 3 bytes */
132#define MCE_RSP_FLASHLED 0x23 /* success flashing LED, 2 bytes */
133
134/* Responses to error cases, must send MCE_CMD_RESUME to clear them */
135#define MCE_RSP_CMD_ILLEGAL 0xfe /* illegal command for port, 2 bytes */
136#define MCE_RSP_TX_TIMEOUT 0x81 /* tx timed out, 2 bytes */
137
138/* Misc commands/responses not defined in the MCE remote/transceiver spec */
Jarod Wilson1cd50f22010-11-09 18:41:03 -0300139#define MCE_CMD_SIG_END 0x01 /* End of signal */
Jarod Wilson4a883912010-10-22 14:42:54 -0300140#define MCE_CMD_PING 0x03 /* Ping device */
141#define MCE_CMD_UNKNOWN 0x04 /* Unknown */
142#define MCE_CMD_UNKNOWN2 0x05 /* Unknown */
Jarod Wilson4a883912010-10-22 14:42:54 -0300143#define MCE_CMD_UNKNOWN3 0x09 /* Unknown */
144#define MCE_CMD_UNKNOWN4 0x0a /* Unknown */
145#define MCE_CMD_G_REVISION 0x0b /* Get hw/sw revision */
Jarod Wilson4a883912010-10-22 14:42:54 -0300146#define MCE_CMD_UNKNOWN5 0x0e /* Unknown */
147#define MCE_CMD_UNKNOWN6 0x0f /* Unknown */
Jarod Wilson4a883912010-10-22 14:42:54 -0300148#define MCE_CMD_UNKNOWN8 0x19 /* Unknown */
149#define MCE_CMD_UNKNOWN9 0x1b /* Unknown */
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300150#define MCE_CMD_NULL 0x00 /* These show up various places... */
Jarod Wilson66e89522010-06-01 17:32:08 -0300151
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300152/* if buf[i] & MCE_PORT_MASK == 0x80 and buf[i] != MCE_CMD_PORT_IR,
153 * then we're looking at a raw IR data sample */
154#define MCE_COMMAND_IRDATA 0x80
155#define MCE_PACKET_LENGTH_MASK 0x1f /* Packet length mask */
Jarod Wilson66e89522010-06-01 17:32:08 -0300156
157/* module parameters */
158#ifdef CONFIG_USB_DEBUG
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030159static bool debug = 1;
Jarod Wilson66e89522010-06-01 17:32:08 -0300160#else
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030161static bool debug;
Jarod Wilson66e89522010-06-01 17:32:08 -0300162#endif
163
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -0300164#define mce_dbg(dev, fmt, ...) \
165 do { \
166 if (debug) \
167 dev_info(dev, fmt, ## __VA_ARGS__); \
168 } while (0)
169
Jarod Wilson66e89522010-06-01 17:32:08 -0300170/* general constants */
171#define SEND_FLAG_IN_PROGRESS 1
172#define SEND_FLAG_COMPLETE 2
173#define RECV_FLAG_IN_PROGRESS 3
174#define RECV_FLAG_COMPLETE 4
175
176#define MCEUSB_RX 1
177#define MCEUSB_TX 2
178
179#define VENDOR_PHILIPS 0x0471
180#define VENDOR_SMK 0x0609
181#define VENDOR_TATUNG 0x1460
182#define VENDOR_GATEWAY 0x107b
183#define VENDOR_SHUTTLE 0x1308
184#define VENDOR_SHUTTLE2 0x051c
185#define VENDOR_MITSUMI 0x03ee
186#define VENDOR_TOPSEED 0x1784
187#define VENDOR_RICAVISION 0x179d
188#define VENDOR_ITRON 0x195d
189#define VENDOR_FIC 0x1509
190#define VENDOR_LG 0x043e
191#define VENDOR_MICROSOFT 0x045e
192#define VENDOR_FORMOSA 0x147a
193#define VENDOR_FINTEK 0x1934
194#define VENDOR_PINNACLE 0x2304
195#define VENDOR_ECS 0x1019
196#define VENDOR_WISTRON 0x0fb8
197#define VENDOR_COMPRO 0x185b
198#define VENDOR_NORTHSTAR 0x04eb
199#define VENDOR_REALTEK 0x0bda
200#define VENDOR_TIVO 0x105a
Mauro Carvalho Chehab56e92f62010-10-18 16:32:50 -0300201#define VENDOR_CONEXANT 0x0572
Mark Lorda4de5f02012-07-11 18:53:28 -0300202#define VENDOR_TWISTEDMELON 0x2596
Jarod Wilson66e89522010-06-01 17:32:08 -0300203
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300204enum mceusb_model_type {
205 MCE_GEN2 = 0, /* Most boards */
206 MCE_GEN1,
207 MCE_GEN3,
208 MCE_GEN2_TX_INV,
209 POLARIS_EVK,
Jarod Wilson6f6c6252010-10-29 00:07:39 -0300210 CX_HYBRID_TV,
Jarod Wilsona6994eb2011-03-01 12:38:28 -0300211 MULTIFUNCTION,
Jarod Wilsond8ee99e2011-03-24 12:59:10 -0300212 TIVO_KIT,
Jarod Wilson2faa0ca2011-04-19 16:47:34 -0300213 MCE_GEN2_NO_TX,
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300214};
215
216struct mceusb_model {
217 u32 mce_gen1:1;
218 u32 mce_gen2:1;
219 u32 mce_gen3:1;
Jarod Wilsond8cc7fd2010-12-15 19:20:55 -0300220 u32 tx_mask_normal:1;
Jarod Wilson6f6c6252010-10-29 00:07:39 -0300221 u32 no_tx:1;
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300222
Jarod Wilsona6994eb2011-03-01 12:38:28 -0300223 int ir_intfnum;
224
Mauro Carvalho Chehab17c2b1f2010-10-22 11:51:50 -0300225 const char *rc_map; /* Allow specify a per-board map */
Mauro Carvalho Chehab3459d452010-10-22 11:52:53 -0300226 const char *name; /* per-board name */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300227};
228
229static const struct mceusb_model mceusb_model[] = {
230 [MCE_GEN1] = {
231 .mce_gen1 = 1,
Jarod Wilsond8cc7fd2010-12-15 19:20:55 -0300232 .tx_mask_normal = 1,
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300233 },
234 [MCE_GEN2] = {
235 .mce_gen2 = 1,
236 },
Jarod Wilson2faa0ca2011-04-19 16:47:34 -0300237 [MCE_GEN2_NO_TX] = {
238 .mce_gen2 = 1,
239 .no_tx = 1,
240 },
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300241 [MCE_GEN2_TX_INV] = {
242 .mce_gen2 = 1,
Jarod Wilsond8cc7fd2010-12-15 19:20:55 -0300243 .tx_mask_normal = 1,
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300244 },
245 [MCE_GEN3] = {
246 .mce_gen3 = 1,
Jarod Wilsond8cc7fd2010-12-15 19:20:55 -0300247 .tx_mask_normal = 1,
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300248 },
249 [POLARIS_EVK] = {
Mauro Carvalho Chehab17c2b1f2010-10-22 11:51:50 -0300250 /*
251 * In fact, the EVK is shipped without
252 * remotes, but we should have something handy,
253 * to allow testing it
254 */
Mauro Carvalho Chehab15195d32011-01-24 12:18:47 -0300255 .rc_map = RC_MAP_HAUPPAUGE,
Jarod Wilson6f6c6252010-10-29 00:07:39 -0300256 .name = "Conexant Hybrid TV (cx231xx) MCE IR",
257 },
258 [CX_HYBRID_TV] = {
Jarod Wilson6f6c6252010-10-29 00:07:39 -0300259 .no_tx = 1, /* tx isn't wired up at all */
260 .name = "Conexant Hybrid TV (cx231xx) MCE IR",
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300261 },
Jarod Wilsona6994eb2011-03-01 12:38:28 -0300262 [MULTIFUNCTION] = {
263 .mce_gen2 = 1,
264 .ir_intfnum = 2,
265 },
Jarod Wilsond8ee99e2011-03-24 12:59:10 -0300266 [TIVO_KIT] = {
267 .mce_gen2 = 1,
268 .rc_map = RC_MAP_TIVO,
269 },
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300270};
271
Jarod Wilson66e89522010-06-01 17:32:08 -0300272static struct usb_device_id mceusb_dev_table[] = {
273 /* Original Microsoft MCE IR Transceiver (often HP-branded) */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300274 { USB_DEVICE(VENDOR_MICROSOFT, 0x006d),
275 .driver_info = MCE_GEN1 },
Jarod Wilson66e89522010-06-01 17:32:08 -0300276 /* Philips Infrared Transceiver - Sahara branded */
277 { USB_DEVICE(VENDOR_PHILIPS, 0x0608) },
278 /* Philips Infrared Transceiver - HP branded */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300279 { USB_DEVICE(VENDOR_PHILIPS, 0x060c),
280 .driver_info = MCE_GEN2_TX_INV },
Jarod Wilson66e89522010-06-01 17:32:08 -0300281 /* Philips SRM5100 */
282 { USB_DEVICE(VENDOR_PHILIPS, 0x060d) },
283 /* Philips Infrared Transceiver - Omaura */
284 { USB_DEVICE(VENDOR_PHILIPS, 0x060f) },
285 /* Philips Infrared Transceiver - Spinel plus */
286 { USB_DEVICE(VENDOR_PHILIPS, 0x0613) },
287 /* Philips eHome Infrared Transceiver */
288 { USB_DEVICE(VENDOR_PHILIPS, 0x0815) },
Jarod Wilsonc13df9c2010-08-27 18:21:14 -0300289 /* Philips/Spinel plus IR transceiver for ASUS */
290 { USB_DEVICE(VENDOR_PHILIPS, 0x206c) },
291 /* Philips/Spinel plus IR transceiver for ASUS */
292 { USB_DEVICE(VENDOR_PHILIPS, 0x2088) },
Jarod Wilsone296e122011-04-25 14:48:18 -0300293 /* Philips IR transceiver (Dell branded) */
294 { USB_DEVICE(VENDOR_PHILIPS, 0x2093) },
Jarod Wilsona6994eb2011-03-01 12:38:28 -0300295 /* Realtek MCE IR Receiver and card reader */
296 { USB_DEVICE(VENDOR_REALTEK, 0x0161),
297 .driver_info = MULTIFUNCTION },
Jarod Wilson66e89522010-06-01 17:32:08 -0300298 /* SMK/Toshiba G83C0004D410 */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300299 { USB_DEVICE(VENDOR_SMK, 0x031d),
300 .driver_info = MCE_GEN2_TX_INV },
Jarod Wilson66e89522010-06-01 17:32:08 -0300301 /* SMK eHome Infrared Transceiver (Sony VAIO) */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300302 { USB_DEVICE(VENDOR_SMK, 0x0322),
303 .driver_info = MCE_GEN2_TX_INV },
Jarod Wilson66e89522010-06-01 17:32:08 -0300304 /* bundled with Hauppauge PVR-150 */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300305 { USB_DEVICE(VENDOR_SMK, 0x0334),
306 .driver_info = MCE_GEN2_TX_INV },
Jarod Wilson66e89522010-06-01 17:32:08 -0300307 /* SMK eHome Infrared Transceiver */
308 { USB_DEVICE(VENDOR_SMK, 0x0338) },
Jarod Wilsonb825fe1b2011-05-26 16:03:17 -0300309 /* SMK/I-O Data GV-MC7/RCKIT Receiver */
310 { USB_DEVICE(VENDOR_SMK, 0x0353),
311 .driver_info = MCE_GEN2_NO_TX },
Jarod Wilson66e89522010-06-01 17:32:08 -0300312 /* Tatung eHome Infrared Transceiver */
313 { USB_DEVICE(VENDOR_TATUNG, 0x9150) },
314 /* Shuttle eHome Infrared Transceiver */
315 { USB_DEVICE(VENDOR_SHUTTLE, 0xc001) },
316 /* Shuttle eHome Infrared Transceiver */
317 { USB_DEVICE(VENDOR_SHUTTLE2, 0xc001) },
318 /* Gateway eHome Infrared Transceiver */
319 { USB_DEVICE(VENDOR_GATEWAY, 0x3009) },
320 /* Mitsumi */
321 { USB_DEVICE(VENDOR_MITSUMI, 0x2501) },
322 /* Topseed eHome Infrared Transceiver */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300323 { USB_DEVICE(VENDOR_TOPSEED, 0x0001),
324 .driver_info = MCE_GEN2_TX_INV },
Jarod Wilson66e89522010-06-01 17:32:08 -0300325 /* Topseed HP eHome Infrared Transceiver */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300326 { USB_DEVICE(VENDOR_TOPSEED, 0x0006),
327 .driver_info = MCE_GEN2_TX_INV },
Jarod Wilson66e89522010-06-01 17:32:08 -0300328 /* Topseed eHome Infrared Transceiver */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300329 { USB_DEVICE(VENDOR_TOPSEED, 0x0007),
330 .driver_info = MCE_GEN2_TX_INV },
Jarod Wilson66e89522010-06-01 17:32:08 -0300331 /* Topseed eHome Infrared Transceiver */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300332 { USB_DEVICE(VENDOR_TOPSEED, 0x0008),
333 .driver_info = MCE_GEN3 },
Jarod Wilson66e89522010-06-01 17:32:08 -0300334 /* Topseed eHome Infrared Transceiver */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300335 { USB_DEVICE(VENDOR_TOPSEED, 0x000a),
336 .driver_info = MCE_GEN2_TX_INV },
Jarod Wilson66e89522010-06-01 17:32:08 -0300337 /* Topseed eHome Infrared Transceiver */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300338 { USB_DEVICE(VENDOR_TOPSEED, 0x0011),
Jarod Wilson7d9a46f2011-03-04 20:20:47 -0300339 .driver_info = MCE_GEN3 },
Jarod Wilson66e89522010-06-01 17:32:08 -0300340 /* Ricavision internal Infrared Transceiver */
341 { USB_DEVICE(VENDOR_RICAVISION, 0x0010) },
342 /* Itron ione Libra Q-11 */
343 { USB_DEVICE(VENDOR_ITRON, 0x7002) },
344 /* FIC eHome Infrared Transceiver */
345 { USB_DEVICE(VENDOR_FIC, 0x9242) },
346 /* LG eHome Infrared Transceiver */
347 { USB_DEVICE(VENDOR_LG, 0x9803) },
348 /* Microsoft MCE Infrared Transceiver */
349 { USB_DEVICE(VENDOR_MICROSOFT, 0x00a0) },
350 /* Formosa eHome Infrared Transceiver */
351 { USB_DEVICE(VENDOR_FORMOSA, 0xe015) },
352 /* Formosa21 / eHome Infrared Receiver */
353 { USB_DEVICE(VENDOR_FORMOSA, 0xe016) },
354 /* Formosa aim / Trust MCE Infrared Receiver */
Jarod Wilson2faa0ca2011-04-19 16:47:34 -0300355 { USB_DEVICE(VENDOR_FORMOSA, 0xe017),
356 .driver_info = MCE_GEN2_NO_TX },
Jarod Wilson66e89522010-06-01 17:32:08 -0300357 /* Formosa Industrial Computing / Beanbag Emulation Device */
358 { USB_DEVICE(VENDOR_FORMOSA, 0xe018) },
359 /* Formosa21 / eHome Infrared Receiver */
360 { USB_DEVICE(VENDOR_FORMOSA, 0xe03a) },
361 /* Formosa Industrial Computing AIM IR605/A */
362 { USB_DEVICE(VENDOR_FORMOSA, 0xe03c) },
363 /* Formosa Industrial Computing */
364 { USB_DEVICE(VENDOR_FORMOSA, 0xe03e) },
Jarod Wilson22f17322012-03-12 13:27:03 -0300365 /* Formosa Industrial Computing */
366 { USB_DEVICE(VENDOR_FORMOSA, 0xe042) },
Jarod Wilsonfbb1f1b2010-12-16 13:27:11 -0300367 /* Fintek eHome Infrared Transceiver (HP branded) */
368 { USB_DEVICE(VENDOR_FINTEK, 0x5168) },
Jarod Wilson66e89522010-06-01 17:32:08 -0300369 /* Fintek eHome Infrared Transceiver */
370 { USB_DEVICE(VENDOR_FINTEK, 0x0602) },
371 /* Fintek eHome Infrared Transceiver (in the AOpen MP45) */
372 { USB_DEVICE(VENDOR_FINTEK, 0x0702) },
373 /* Pinnacle Remote Kit */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300374 { USB_DEVICE(VENDOR_PINNACLE, 0x0225),
375 .driver_info = MCE_GEN3 },
Jarod Wilson66e89522010-06-01 17:32:08 -0300376 /* Elitegroup Computer Systems IR */
377 { USB_DEVICE(VENDOR_ECS, 0x0f38) },
378 /* Wistron Corp. eHome Infrared Receiver */
379 { USB_DEVICE(VENDOR_WISTRON, 0x0002) },
380 /* Compro K100 */
381 { USB_DEVICE(VENDOR_COMPRO, 0x3020) },
382 /* Compro K100 v2 */
383 { USB_DEVICE(VENDOR_COMPRO, 0x3082) },
384 /* Northstar Systems, Inc. eHome Infrared Transceiver */
385 { USB_DEVICE(VENDOR_NORTHSTAR, 0xe004) },
386 /* TiVo PC IR Receiver */
Jarod Wilsond8ee99e2011-03-24 12:59:10 -0300387 { USB_DEVICE(VENDOR_TIVO, 0x2000),
388 .driver_info = TIVO_KIT },
Jarod Wilson6f6c6252010-10-29 00:07:39 -0300389 /* Conexant Hybrid TV "Shelby" Polaris SDK */
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300390 { USB_DEVICE(VENDOR_CONEXANT, 0x58a1),
391 .driver_info = POLARIS_EVK },
Jarod Wilson6f6c6252010-10-29 00:07:39 -0300392 /* Conexant Hybrid TV RDU253S Polaris */
393 { USB_DEVICE(VENDOR_CONEXANT, 0x58a5),
394 .driver_info = CX_HYBRID_TV },
Mark Lorda4de5f02012-07-11 18:53:28 -0300395 /* Twisted Melon Inc. - Manta Mini Receiver */
396 { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8008) },
397 /* Twisted Melon Inc. - Manta Pico Receiver */
398 { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8016) },
399 /* Twisted Melon Inc. - Manta Transceiver */
400 { USB_DEVICE(VENDOR_TWISTEDMELON, 0x8042) },
Jarod Wilson66e89522010-06-01 17:32:08 -0300401 /* Terminating entry */
402 { }
403};
404
Jarod Wilson66e89522010-06-01 17:32:08 -0300405/* data structure for each usb transceiver */
406struct mceusb_dev {
407 /* ir-core bits */
David Härdemand8b4b582010-10-29 16:08:23 -0300408 struct rc_dev *rc;
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300409
410 /* optional features we can enable */
411 bool carrier_report_enabled;
412 bool learning_enabled;
Jarod Wilson66e89522010-06-01 17:32:08 -0300413
414 /* core device bits */
415 struct device *dev;
Jarod Wilson66e89522010-06-01 17:32:08 -0300416
417 /* usb */
418 struct usb_device *usbdev;
419 struct urb *urb_in;
Jarod Wilson66e89522010-06-01 17:32:08 -0300420 struct usb_endpoint_descriptor *usb_ep_out;
421
422 /* buffers and dma */
423 unsigned char *buf_in;
424 unsigned int len_in;
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300425 dma_addr_t dma_in;
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300426
427 enum {
428 CMD_HEADER = 0,
429 SUBCMD,
430 CMD_DATA,
431 PARSE_IRDATA,
432 } parser_state;
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300433
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300434 u8 cmd, rem; /* Remaining IR data bytes in packet */
Jarod Wilson66e89522010-06-01 17:32:08 -0300435
436 struct {
437 u32 connected:1;
Jarod Wilsond8cc7fd2010-12-15 19:20:55 -0300438 u32 tx_mask_normal:1;
Jarod Wilson66e89522010-06-01 17:32:08 -0300439 u32 microsoft_gen1:1;
Jarod Wilson6f6c6252010-10-29 00:07:39 -0300440 u32 no_tx:1;
Jarod Wilson66e89522010-06-01 17:32:08 -0300441 } flags;
442
Jarod Wilsone23fb962010-06-16 17:55:52 -0300443 /* transmit support */
Jarod Wilson66e89522010-06-01 17:32:08 -0300444 int send_flags;
Jarod Wilsone23fb962010-06-16 17:55:52 -0300445 u32 carrier;
446 unsigned char tx_mask;
Jarod Wilson66e89522010-06-01 17:32:08 -0300447
448 char name[128];
449 char phys[64];
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -0300450 enum mceusb_model_type model;
Jarod Wilson4840b782011-07-18 16:54:24 -0300451
452 bool need_reset; /* flag to issue a device resume cmd */
Jarod Wilsonab1072e2011-07-18 16:54:25 -0300453 u8 emver; /* emulator interface version */
Jarod Wilsona411e832011-07-18 16:54:26 -0300454 u8 num_txports; /* number of transmit ports */
455 u8 num_rxports; /* number of receive sensors */
456 u8 txports_cabled; /* bitmask of transmitters with cable */
457 u8 rxports_active; /* bitmask of active receive sensors */
Jarod Wilson66e89522010-06-01 17:32:08 -0300458};
459
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300460/* MCE Device Command Strings, generally a port and command pair */
461static char DEVICE_RESUME[] = {MCE_CMD_NULL, MCE_CMD_PORT_SYS,
462 MCE_CMD_RESUME};
463static char GET_REVISION[] = {MCE_CMD_PORT_SYS, MCE_CMD_G_REVISION};
Jarod Wilsonab1072e2011-07-18 16:54:25 -0300464static char GET_EMVER[] = {MCE_CMD_PORT_SYS, MCE_CMD_GETEMVER};
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300465static char GET_WAKEVERSION[] = {MCE_CMD_PORT_SYS, MCE_CMD_GETWAKEVERSION};
Jarod Wilsonb71969b2011-07-18 16:54:27 -0300466static char FLASH_LED[] = {MCE_CMD_PORT_SYS, MCE_CMD_FLASHLED};
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300467static char GET_UNKNOWN2[] = {MCE_CMD_PORT_IR, MCE_CMD_UNKNOWN2};
468static char GET_CARRIER_FREQ[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRCFS};
469static char GET_RX_TIMEOUT[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTIMEOUT};
Jarod Wilsona411e832011-07-18 16:54:26 -0300470static char GET_NUM_PORTS[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRNUMPORTS};
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300471static char GET_TX_BITMASK[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRTXPORTS};
472static char GET_RX_SENSOR[] = {MCE_CMD_PORT_IR, MCE_CMD_GETIRRXPORTEN};
Jarod Wilson66e89522010-06-01 17:32:08 -0300473/* sub in desired values in lower byte or bytes for full command */
474/* FIXME: make use of these for transmit.
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300475static char SET_CARRIER_FREQ[] = {MCE_CMD_PORT_IR,
476 MCE_CMD_SETIRCFS, 0x00, 0x00};
477static char SET_TX_BITMASK[] = {MCE_CMD_PORT_IR, MCE_CMD_SETIRTXPORTS, 0x00};
478static char SET_RX_TIMEOUT[] = {MCE_CMD_PORT_IR,
479 MCE_CMD_SETIRTIMEOUT, 0x00, 0x00};
480static char SET_RX_SENSOR[] = {MCE_CMD_PORT_IR,
481 MCE_RSP_EQIRRXPORTEN, 0x00};
Jarod Wilson66e89522010-06-01 17:32:08 -0300482*/
483
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300484static int mceusb_cmdsize(u8 cmd, u8 subcmd)
485{
486 int datasize = 0;
487
488 switch (cmd) {
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300489 case MCE_CMD_NULL:
490 if (subcmd == MCE_CMD_PORT_SYS)
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300491 datasize = 1;
492 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300493 case MCE_CMD_PORT_SYS:
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300494 switch (subcmd) {
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300495 case MCE_RSP_EQWAKEVERSION:
496 datasize = 4;
497 break;
Jarod Wilson4a883912010-10-22 14:42:54 -0300498 case MCE_CMD_G_REVISION:
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300499 datasize = 2;
500 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300501 case MCE_RSP_EQWAKESUPPORT:
502 datasize = 1;
503 break;
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300504 }
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300505 case MCE_CMD_PORT_IR:
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300506 switch (subcmd) {
Jarod Wilson4a883912010-10-22 14:42:54 -0300507 case MCE_CMD_UNKNOWN:
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300508 case MCE_RSP_EQIRCFS:
509 case MCE_RSP_EQIRTIMEOUT:
510 case MCE_RSP_EQIRRXCFCNT:
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300511 datasize = 2;
512 break;
Jarod Wilson1cd50f22010-11-09 18:41:03 -0300513 case MCE_CMD_SIG_END:
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300514 case MCE_RSP_EQIRTXPORTS:
515 case MCE_RSP_EQIRRXPORTEN:
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300516 datasize = 1;
517 break;
518 }
519 }
520 return datasize;
521}
522
Jarod Wilson66e89522010-06-01 17:32:08 -0300523static void mceusb_dev_printdata(struct mceusb_dev *ir, char *buf,
Jarod Wilson36e9d262010-10-22 16:49:35 -0300524 int offset, int len, bool out)
Jarod Wilson66e89522010-06-01 17:32:08 -0300525{
526 char codes[USB_BUFLEN * 3 + 1];
527 char inout[9];
Hans Verkuil5becbc52012-05-14 10:22:58 -0300528 u8 cmd, subcmd, data1, data2, data3, data4;
Jarod Wilson66e89522010-06-01 17:32:08 -0300529 struct device *dev = ir->dev;
Jarod Wilson36e9d262010-10-22 16:49:35 -0300530 int i, start, skip = 0;
Jarod Wilsone217fb42011-07-18 16:54:28 -0300531 u32 carrier, period;
Jarod Wilson36e9d262010-10-22 16:49:35 -0300532
533 if (!debug)
534 return;
Jarod Wilson66e89522010-06-01 17:32:08 -0300535
Jarod Wilson657290b2010-06-16 17:10:05 -0300536 /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
Jarod Wilson29b44942010-11-09 18:41:46 -0300537 if (ir->flags.microsoft_gen1 && !out && !offset)
Jarod Wilson36e9d262010-10-22 16:49:35 -0300538 skip = 2;
Jarod Wilson66e89522010-06-01 17:32:08 -0300539
Jarod Wilson36e9d262010-10-22 16:49:35 -0300540 if (len <= skip)
Jarod Wilson66e89522010-06-01 17:32:08 -0300541 return;
542
543 for (i = 0; i < len && i < USB_BUFLEN; i++)
Jarod Wilson36e9d262010-10-22 16:49:35 -0300544 snprintf(codes + i * 3, 4, "%02x ", buf[i + offset] & 0xff);
Jarod Wilson66e89522010-06-01 17:32:08 -0300545
Jarod Wilson36e9d262010-10-22 16:49:35 -0300546 dev_info(dev, "%sx data: %s(length=%d)\n",
Jarod Wilson66e89522010-06-01 17:32:08 -0300547 (out ? "t" : "r"), codes, len);
548
549 if (out)
550 strcpy(inout, "Request\0");
551 else
552 strcpy(inout, "Got\0");
553
Jarod Wilson36e9d262010-10-22 16:49:35 -0300554 start = offset + skip;
555 cmd = buf[start] & 0xff;
556 subcmd = buf[start + 1] & 0xff;
557 data1 = buf[start + 2] & 0xff;
558 data2 = buf[start + 3] & 0xff;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300559 data3 = buf[start + 4] & 0xff;
560 data4 = buf[start + 5] & 0xff;
Jarod Wilson66e89522010-06-01 17:32:08 -0300561
562 switch (cmd) {
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300563 case MCE_CMD_NULL:
Jarod Wilsona411e832011-07-18 16:54:26 -0300564 if (subcmd == MCE_CMD_NULL)
565 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300566 if ((subcmd == MCE_CMD_PORT_SYS) &&
567 (data1 == MCE_CMD_RESUME))
568 dev_info(dev, "Device resume requested\n");
Jarod Wilson66e89522010-06-01 17:32:08 -0300569 else
570 dev_info(dev, "Unknown command 0x%02x 0x%02x\n",
571 cmd, subcmd);
572 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300573 case MCE_CMD_PORT_SYS:
Jarod Wilson66e89522010-06-01 17:32:08 -0300574 switch (subcmd) {
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300575 case MCE_RSP_EQEMVER:
576 if (!out)
577 dev_info(dev, "Emulator interface version %x\n",
578 data1);
579 break;
Jarod Wilson4a883912010-10-22 14:42:54 -0300580 case MCE_CMD_G_REVISION:
Jarod Wilson66e89522010-06-01 17:32:08 -0300581 if (len == 2)
582 dev_info(dev, "Get hw/sw rev?\n");
583 else
584 dev_info(dev, "hw/sw rev 0x%02x 0x%02x "
585 "0x%02x 0x%02x\n", data1, data2,
Jarod Wilson36e9d262010-10-22 16:49:35 -0300586 buf[start + 4], buf[start + 5]);
Jarod Wilson66e89522010-06-01 17:32:08 -0300587 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300588 case MCE_CMD_RESUME:
589 dev_info(dev, "Device resume requested\n");
Jarod Wilson66e89522010-06-01 17:32:08 -0300590 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300591 case MCE_RSP_CMD_ILLEGAL:
592 dev_info(dev, "Illegal PORT_SYS command\n");
Jarod Wilson66e89522010-06-01 17:32:08 -0300593 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300594 case MCE_RSP_EQWAKEVERSION:
595 if (!out)
596 dev_info(dev, "Wake version, proto: 0x%02x, "
597 "payload: 0x%02x, address: 0x%02x, "
598 "version: 0x%02x\n",
599 data1, data2, data3, data4);
600 break;
601 case MCE_RSP_GETPORTSTATUS:
602 if (!out)
603 /* We use data1 + 1 here, to match hw labels */
604 dev_info(dev, "TX port %d: blaster is%s connected\n",
605 data1 + 1, data4 ? " not" : "");
606 break;
Jarod Wilsonb71969b2011-07-18 16:54:27 -0300607 case MCE_CMD_FLASHLED:
608 dev_info(dev, "Attempting to flash LED\n");
609 break;
Jarod Wilson66e89522010-06-01 17:32:08 -0300610 default:
611 dev_info(dev, "Unknown command 0x%02x 0x%02x\n",
612 cmd, subcmd);
613 break;
614 }
615 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300616 case MCE_CMD_PORT_IR:
Jarod Wilson66e89522010-06-01 17:32:08 -0300617 switch (subcmd) {
Jarod Wilson1cd50f22010-11-09 18:41:03 -0300618 case MCE_CMD_SIG_END:
619 dev_info(dev, "End of signal\n");
620 break;
Jarod Wilson4a883912010-10-22 14:42:54 -0300621 case MCE_CMD_PING:
Jarod Wilson66e89522010-06-01 17:32:08 -0300622 dev_info(dev, "Ping\n");
623 break;
Jarod Wilson4a883912010-10-22 14:42:54 -0300624 case MCE_CMD_UNKNOWN:
Jarod Wilson66e89522010-06-01 17:32:08 -0300625 dev_info(dev, "Resp to 9f 05 of 0x%02x 0x%02x\n",
626 data1, data2);
627 break;
Jarod Wilsone217fb42011-07-18 16:54:28 -0300628 case MCE_RSP_EQIRCFS:
629 period = DIV_ROUND_CLOSEST(
630 (1 << data1 * 2) * (data2 + 1), 10);
631 if (!period)
632 break;
633 carrier = (1000 * 1000) / period;
634 dev_info(dev, "%s carrier of %u Hz (period %uus)\n",
635 inout, carrier, period);
Jarod Wilson66e89522010-06-01 17:32:08 -0300636 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300637 case MCE_CMD_GETIRCFS:
Jarod Wilson66e89522010-06-01 17:32:08 -0300638 dev_info(dev, "Get carrier mode and freq\n");
639 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300640 case MCE_RSP_EQIRTXPORTS:
Jarod Wilson66e89522010-06-01 17:32:08 -0300641 dev_info(dev, "%s transmit blaster mask of 0x%02x\n",
642 inout, data1);
643 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300644 case MCE_RSP_EQIRTIMEOUT:
Rafi Rubinf3e456c2011-07-03 17:13:52 -0300645 /* value is in units of 50us, so x*50/1000 ms */
Jarod Wilsone217fb42011-07-18 16:54:28 -0300646 period = ((data1 << 8) | data2) * MCE_TIME_UNIT / 1000;
Jarod Wilson66e89522010-06-01 17:32:08 -0300647 dev_info(dev, "%s receive timeout of %d ms\n",
Jarod Wilsone217fb42011-07-18 16:54:28 -0300648 inout, period);
Jarod Wilson66e89522010-06-01 17:32:08 -0300649 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300650 case MCE_CMD_GETIRTIMEOUT:
Jarod Wilson66e89522010-06-01 17:32:08 -0300651 dev_info(dev, "Get receive timeout\n");
652 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300653 case MCE_CMD_GETIRTXPORTS:
Jarod Wilson66e89522010-06-01 17:32:08 -0300654 dev_info(dev, "Get transmit blaster mask\n");
655 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300656 case MCE_RSP_EQIRRXPORTEN:
Jarod Wilson66e89522010-06-01 17:32:08 -0300657 dev_info(dev, "%s %s-range receive sensor in use\n",
658 inout, data1 == 0x02 ? "short" : "long");
659 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300660 case MCE_CMD_GETIRRXPORTEN:
661 /* aka MCE_RSP_EQIRRXCFCNT */
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300662 if (out)
Jarod Wilson66e89522010-06-01 17:32:08 -0300663 dev_info(dev, "Get receive sensor\n");
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300664 else if (ir->learning_enabled)
665 dev_info(dev, "RX pulse count: %d\n",
Jarod Wilson66e89522010-06-01 17:32:08 -0300666 ((data1 << 8) | data2));
667 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300668 case MCE_RSP_EQIRNUMPORTS:
669 if (out)
670 break;
671 dev_info(dev, "Num TX ports: %x, num RX ports: %x\n",
672 data1, data2);
Jarod Wilson66e89522010-06-01 17:32:08 -0300673 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300674 case MCE_RSP_CMD_ILLEGAL:
675 dev_info(dev, "Illegal PORT_IR command\n");
676 break;
Jarod Wilson66e89522010-06-01 17:32:08 -0300677 default:
678 dev_info(dev, "Unknown command 0x%02x 0x%02x\n",
679 cmd, subcmd);
680 break;
681 }
682 break;
683 default:
684 break;
685 }
Jarod Wilson36e9d262010-10-22 16:49:35 -0300686
687 if (cmd == MCE_IRDATA_TRAILER)
688 dev_info(dev, "End of raw IR data\n");
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300689 else if ((cmd != MCE_CMD_PORT_IR) &&
690 ((cmd & MCE_PORT_MASK) == MCE_COMMAND_IRDATA))
Jarod Wilson36e9d262010-10-22 16:49:35 -0300691 dev_info(dev, "Raw IR data, %d pulse/space samples\n", ir->rem);
Jarod Wilson66e89522010-06-01 17:32:08 -0300692}
693
Sean Young6ac454a2012-07-15 13:31:31 -0300694static void mce_async_callback(struct urb *urb)
Jarod Wilson66e89522010-06-01 17:32:08 -0300695{
696 struct mceusb_dev *ir;
697 int len;
698
699 if (!urb)
700 return;
701
702 ir = urb->context;
703 if (ir) {
704 len = urb->actual_length;
705
Jarod Wilson36e9d262010-10-22 16:49:35 -0300706 mceusb_dev_printdata(ir, urb->transfer_buffer, 0, len, true);
Jarod Wilson66e89522010-06-01 17:32:08 -0300707 }
708
Jarod Wilson0b43fcd2011-05-24 16:44:54 -0300709 /* the transfer buffer and urb were allocated in mce_request_packet */
710 kfree(urb->transfer_buffer);
711 usb_free_urb(urb);
Jarod Wilson66e89522010-06-01 17:32:08 -0300712}
713
714/* request incoming or send outgoing usb packet - used to initialize remote */
Jarod Wilson51ea6292011-05-10 14:09:59 -0300715static void mce_request_packet(struct mceusb_dev *ir, unsigned char *data,
716 int size, int urb_type)
Jarod Wilson66e89522010-06-01 17:32:08 -0300717{
Jarod Wilson51ea6292011-05-10 14:09:59 -0300718 int res, pipe;
Jarod Wilson66e89522010-06-01 17:32:08 -0300719 struct urb *async_urb;
720 struct device *dev = ir->dev;
721 unsigned char *async_buf;
722
723 if (urb_type == MCEUSB_TX) {
724 async_urb = usb_alloc_urb(0, GFP_KERNEL);
725 if (unlikely(!async_urb)) {
726 dev_err(dev, "Error, couldn't allocate urb!\n");
727 return;
728 }
729
730 async_buf = kzalloc(size, GFP_KERNEL);
731 if (!async_buf) {
732 dev_err(dev, "Error, couldn't allocate buf!\n");
733 usb_free_urb(async_urb);
734 return;
735 }
736
737 /* outbound data */
Jarod Wilson51ea6292011-05-10 14:09:59 -0300738 pipe = usb_sndintpipe(ir->usbdev,
739 ir->usb_ep_out->bEndpointAddress);
740 usb_fill_int_urb(async_urb, ir->usbdev, pipe,
Sean Young6ac454a2012-07-15 13:31:31 -0300741 async_buf, size, mce_async_callback,
Jarod Wilson51ea6292011-05-10 14:09:59 -0300742 ir, ir->usb_ep_out->bInterval);
Jarod Wilson66e89522010-06-01 17:32:08 -0300743 memcpy(async_buf, data, size);
744
745 } else if (urb_type == MCEUSB_RX) {
746 /* standard request */
747 async_urb = ir->urb_in;
748 ir->send_flags = RECV_FLAG_IN_PROGRESS;
749
750 } else {
751 dev_err(dev, "Error! Unknown urb type %d\n", urb_type);
752 return;
753 }
754
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -0300755 mce_dbg(dev, "receive request called (size=%#x)\n", size);
Jarod Wilson66e89522010-06-01 17:32:08 -0300756
757 async_urb->transfer_buffer_length = size;
758 async_urb->dev = ir->usbdev;
759
760 res = usb_submit_urb(async_urb, GFP_ATOMIC);
761 if (res) {
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -0300762 mce_dbg(dev, "receive request FAILED! (res=%d)\n", res);
Jarod Wilson66e89522010-06-01 17:32:08 -0300763 return;
764 }
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -0300765 mce_dbg(dev, "receive request complete (res=%d)\n", res);
Jarod Wilson66e89522010-06-01 17:32:08 -0300766}
767
768static void mce_async_out(struct mceusb_dev *ir, unsigned char *data, int size)
769{
Jarod Wilson4840b782011-07-18 16:54:24 -0300770 int rsize = sizeof(DEVICE_RESUME);
771
772 if (ir->need_reset) {
773 ir->need_reset = false;
774 mce_request_packet(ir, DEVICE_RESUME, rsize, MCEUSB_TX);
775 msleep(10);
776 }
777
Jarod Wilson51ea6292011-05-10 14:09:59 -0300778 mce_request_packet(ir, data, size, MCEUSB_TX);
Jarod Wilson417c0a22011-07-18 16:54:22 -0300779 msleep(10);
Jarod Wilson66e89522010-06-01 17:32:08 -0300780}
781
Jarod Wilson3a918aa2011-05-26 14:23:18 -0300782static void mce_flush_rx_buffer(struct mceusb_dev *ir, int size)
Jarod Wilson66e89522010-06-01 17:32:08 -0300783{
Jarod Wilson3a918aa2011-05-26 14:23:18 -0300784 mce_request_packet(ir, NULL, size, MCEUSB_RX);
Jarod Wilson66e89522010-06-01 17:32:08 -0300785}
786
Jarod Wilsone23fb962010-06-16 17:55:52 -0300787/* Send data out the IR blaster port(s) */
David Härdeman5588dc22011-04-28 12:13:58 -0300788static int mceusb_tx_ir(struct rc_dev *dev, unsigned *txbuf, unsigned count)
Jarod Wilsone23fb962010-06-16 17:55:52 -0300789{
David Härdemand8b4b582010-10-29 16:08:23 -0300790 struct mceusb_dev *ir = dev->priv;
Jarod Wilsone23fb962010-06-16 17:55:52 -0300791 int i, ret = 0;
David Härdeman5588dc22011-04-28 12:13:58 -0300792 int cmdcount = 0;
Jarod Wilsone23fb962010-06-16 17:55:52 -0300793 unsigned char *cmdbuf; /* MCE command buffer */
794 long signal_duration = 0; /* Singnal length in us */
795 struct timeval start_time, end_time;
796
797 do_gettimeofday(&start_time);
798
David Härdeman5588dc22011-04-28 12:13:58 -0300799 cmdbuf = kzalloc(sizeof(unsigned) * MCE_CMDBUF_SIZE, GFP_KERNEL);
Jarod Wilsone23fb962010-06-16 17:55:52 -0300800 if (!cmdbuf)
801 return -ENOMEM;
802
803 /* MCE tx init header */
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300804 cmdbuf[cmdcount++] = MCE_CMD_PORT_IR;
805 cmdbuf[cmdcount++] = MCE_CMD_SETIRTXPORTS;
Jarod Wilsone23fb962010-06-16 17:55:52 -0300806 cmdbuf[cmdcount++] = ir->tx_mask;
807
808 /* Generate mce packet data */
809 for (i = 0; (i < count) && (cmdcount < MCE_CMDBUF_SIZE); i++) {
810 signal_duration += txbuf[i];
811 txbuf[i] = txbuf[i] / MCE_TIME_UNIT;
812
813 do { /* loop to support long pulses/spaces > 127*50us=6.35ms */
814
815 /* Insert mce packet header every 4th entry */
816 if ((cmdcount < MCE_CMDBUF_SIZE) &&
817 (cmdcount - MCE_TX_HEADER_LENGTH) %
818 MCE_CODE_LENGTH == 0)
Jarod Wilson4a883912010-10-22 14:42:54 -0300819 cmdbuf[cmdcount++] = MCE_IRDATA_HEADER;
Jarod Wilsone23fb962010-06-16 17:55:52 -0300820
821 /* Insert mce packet data */
822 if (cmdcount < MCE_CMDBUF_SIZE)
823 cmdbuf[cmdcount++] =
824 (txbuf[i] < MCE_PULSE_BIT ?
825 txbuf[i] : MCE_MAX_PULSE_LENGTH) |
826 (i & 1 ? 0x00 : MCE_PULSE_BIT);
827 else {
828 ret = -EINVAL;
829 goto out;
830 }
831
832 } while ((txbuf[i] > MCE_MAX_PULSE_LENGTH) &&
833 (txbuf[i] -= MCE_MAX_PULSE_LENGTH));
834 }
835
836 /* Fix packet length in last header */
837 cmdbuf[cmdcount - (cmdcount - MCE_TX_HEADER_LENGTH) % MCE_CODE_LENGTH] =
Jarod Wilson4a883912010-10-22 14:42:54 -0300838 MCE_COMMAND_IRDATA + (cmdcount - MCE_TX_HEADER_LENGTH) %
839 MCE_CODE_LENGTH - 1;
Jarod Wilsone23fb962010-06-16 17:55:52 -0300840
841 /* Check if we have room for the empty packet at the end */
842 if (cmdcount >= MCE_CMDBUF_SIZE) {
843 ret = -EINVAL;
844 goto out;
845 }
846
847 /* All mce commands end with an empty packet (0x80) */
Jarod Wilson4a883912010-10-22 14:42:54 -0300848 cmdbuf[cmdcount++] = MCE_IRDATA_TRAILER;
Jarod Wilsone23fb962010-06-16 17:55:52 -0300849
850 /* Transmit the command to the mce device */
851 mce_async_out(ir, cmdbuf, cmdcount);
852
853 /*
854 * The lircd gap calculation expects the write function to
855 * wait the time it takes for the ircommand to be sent before
856 * it returns.
857 */
858 do_gettimeofday(&end_time);
859 signal_duration -= (end_time.tv_usec - start_time.tv_usec) +
860 (end_time.tv_sec - start_time.tv_sec) * 1000000;
861
862 /* delay with the closest number of ticks */
863 set_current_state(TASK_INTERRUPTIBLE);
864 schedule_timeout(usecs_to_jiffies(signal_duration));
865
866out:
867 kfree(cmdbuf);
David Härdeman5588dc22011-04-28 12:13:58 -0300868 return ret ? ret : count;
Jarod Wilsone23fb962010-06-16 17:55:52 -0300869}
870
Jarod Wilson6f6c6252010-10-29 00:07:39 -0300871/* Sets active IR outputs -- mce devices typically have two */
David Härdemand8b4b582010-10-29 16:08:23 -0300872static int mceusb_set_tx_mask(struct rc_dev *dev, u32 mask)
Jarod Wilson657290b2010-06-16 17:10:05 -0300873{
David Härdemand8b4b582010-10-29 16:08:23 -0300874 struct mceusb_dev *ir = dev->priv;
Jarod Wilson657290b2010-06-16 17:10:05 -0300875
Jarod Wilsond8cc7fd2010-12-15 19:20:55 -0300876 if (ir->flags.tx_mask_normal)
877 ir->tx_mask = mask;
878 else
Jarod Wilson4a883912010-10-22 14:42:54 -0300879 ir->tx_mask = (mask != MCE_DEFAULT_TX_MASK ?
880 mask ^ MCE_DEFAULT_TX_MASK : mask) << 1;
Jarod Wilson657290b2010-06-16 17:10:05 -0300881
882 return 0;
883}
884
Jarod Wilsone23fb962010-06-16 17:55:52 -0300885/* Sets the send carrier frequency and mode */
David Härdemand8b4b582010-10-29 16:08:23 -0300886static int mceusb_set_tx_carrier(struct rc_dev *dev, u32 carrier)
Jarod Wilsone23fb962010-06-16 17:55:52 -0300887{
David Härdemand8b4b582010-10-29 16:08:23 -0300888 struct mceusb_dev *ir = dev->priv;
Jarod Wilsone23fb962010-06-16 17:55:52 -0300889 int clk = 10000000;
890 int prescaler = 0, divisor = 0;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300891 unsigned char cmdbuf[4] = { MCE_CMD_PORT_IR,
892 MCE_CMD_SETIRCFS, 0x00, 0x00 };
Jarod Wilsone23fb962010-06-16 17:55:52 -0300893
894 /* Carrier has changed */
895 if (ir->carrier != carrier) {
896
897 if (carrier == 0) {
898 ir->carrier = carrier;
Jarod Wilson1cd50f22010-11-09 18:41:03 -0300899 cmdbuf[2] = MCE_CMD_SIG_END;
Jarod Wilson4a883912010-10-22 14:42:54 -0300900 cmdbuf[3] = MCE_IRDATA_TRAILER;
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -0300901 mce_dbg(ir->dev, "%s: disabling carrier "
Jarod Wilsone23fb962010-06-16 17:55:52 -0300902 "modulation\n", __func__);
903 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
904 return carrier;
905 }
906
907 for (prescaler = 0; prescaler < 4; ++prescaler) {
908 divisor = (clk >> (2 * prescaler)) / carrier;
Jarod Wilson4a883912010-10-22 14:42:54 -0300909 if (divisor <= 0xff) {
Jarod Wilsone23fb962010-06-16 17:55:52 -0300910 ir->carrier = carrier;
911 cmdbuf[2] = prescaler;
912 cmdbuf[3] = divisor;
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -0300913 mce_dbg(ir->dev, "%s: requesting %u HZ "
Jarod Wilsone23fb962010-06-16 17:55:52 -0300914 "carrier\n", __func__, carrier);
915
916 /* Transmit new carrier to mce device */
917 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
918 return carrier;
919 }
920 }
921
922 return -EINVAL;
923
924 }
925
926 return carrier;
927}
928
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300929/*
930 * We don't do anything but print debug spew for many of the command bits
931 * we receive from the hardware, but some of them are useful information
932 * we want to store so that we can use them.
933 */
934static void mceusb_handle_command(struct mceusb_dev *ir, int index)
935{
936 u8 hi = ir->buf_in[index + 1] & 0xff;
937 u8 lo = ir->buf_in[index + 2] & 0xff;
938
939 switch (ir->buf_in[index]) {
Jarod Wilsona411e832011-07-18 16:54:26 -0300940 /* the one and only 5-byte return value command */
941 case MCE_RSP_GETPORTSTATUS:
942 if ((ir->buf_in[index + 4] & 0xff) == 0x00)
943 ir->txports_cabled |= 1 << hi;
944 break;
945
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300946 /* 2-byte return value commands */
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300947 case MCE_RSP_EQIRTIMEOUT:
Rafi Rubinf3e456c2011-07-03 17:13:52 -0300948 ir->rc->timeout = US_TO_NS((hi << 8 | lo) * MCE_TIME_UNIT);
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300949 break;
Jarod Wilsona411e832011-07-18 16:54:26 -0300950 case MCE_RSP_EQIRNUMPORTS:
951 ir->num_txports = hi;
952 ir->num_rxports = lo;
953 break;
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300954
955 /* 1-byte return value commands */
Jarod Wilsonab1072e2011-07-18 16:54:25 -0300956 case MCE_RSP_EQEMVER:
957 ir->emver = hi;
958 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300959 case MCE_RSP_EQIRTXPORTS:
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300960 ir->tx_mask = hi;
961 break;
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -0300962 case MCE_RSP_EQIRRXPORTEN:
963 ir->learning_enabled = ((hi & 0x02) == 0x02);
Jarod Wilsona411e832011-07-18 16:54:26 -0300964 ir->rxports_active = hi;
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300965 break;
Jarod Wilson4840b782011-07-18 16:54:24 -0300966 case MCE_RSP_CMD_ILLEGAL:
967 ir->need_reset = true;
968 break;
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300969 default:
970 break;
971 }
972}
973
Jarod Wilson66e89522010-06-01 17:32:08 -0300974static void mceusb_process_ir_data(struct mceusb_dev *ir, int buf_len)
975{
Maxim Levitsky46519182010-10-16 19:56:28 -0300976 DEFINE_IR_RAW_EVENT(rawir);
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300977 int i = 0;
Jarod Wilson66e89522010-06-01 17:32:08 -0300978
979 /* skip meaningless 0xb1 0x60 header bytes on orig receiver */
980 if (ir->flags.microsoft_gen1)
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300981 i = 2;
Jarod Wilson66e89522010-06-01 17:32:08 -0300982
Jarod Wilson29b44942010-11-09 18:41:46 -0300983 /* if there's no data, just return now */
984 if (buf_len <= i)
985 return;
986
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300987 for (; i < buf_len; i++) {
988 switch (ir->parser_state) {
989 case SUBCMD:
990 ir->rem = mceusb_cmdsize(ir->cmd, ir->buf_in[i]);
Jarod Wilson36e9d262010-10-22 16:49:35 -0300991 mceusb_dev_printdata(ir, ir->buf_in, i - 1,
992 ir->rem + 2, false);
Jarod Wilson2ee95db2010-11-12 19:49:04 -0300993 mceusb_handle_command(ir, i);
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -0300994 ir->parser_state = CMD_DATA;
995 break;
996 case PARSE_IRDATA:
Jarod Wilson66e89522010-06-01 17:32:08 -0300997 ir->rem--;
Jarod Wilson5bd9d732011-01-26 12:20:09 -0300998 init_ir_raw_event(&rawir);
Jarod Wilson66e89522010-06-01 17:32:08 -0300999 rawir.pulse = ((ir->buf_in[i] & MCE_PULSE_BIT) != 0);
1000 rawir.duration = (ir->buf_in[i] & MCE_PULSE_MASK)
Jarod Wilsonb4608fa2011-01-18 17:31:24 -03001001 * US_TO_NS(MCE_TIME_UNIT);
Jarod Wilson66e89522010-06-01 17:32:08 -03001002
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001003 mce_dbg(ir->dev, "Storing %s with duration %d\n",
Jarod Wilson66e89522010-06-01 17:32:08 -03001004 rawir.pulse ? "pulse" : "space",
1005 rawir.duration);
1006
David Härdemand8b4b582010-10-29 16:08:23 -03001007 ir_raw_event_store_with_filter(ir->rc, &rawir);
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -03001008 break;
1009 case CMD_DATA:
1010 ir->rem--;
1011 break;
1012 case CMD_HEADER:
1013 /* decode mce packets of the form (84),AA,BB,CC,DD */
1014 /* IR data packets can span USB messages - rem */
1015 ir->cmd = ir->buf_in[i];
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -03001016 if ((ir->cmd == MCE_CMD_PORT_IR) ||
1017 ((ir->cmd & MCE_PORT_MASK) !=
Jarod Wilson4a883912010-10-22 14:42:54 -03001018 MCE_COMMAND_IRDATA)) {
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -03001019 ir->parser_state = SUBCMD;
1020 continue;
1021 }
1022 ir->rem = (ir->cmd & MCE_PACKET_LENGTH_MASK);
Jarod Wilson2ee95db2010-11-12 19:49:04 -03001023 mceusb_dev_printdata(ir, ir->buf_in,
1024 i, ir->rem + 1, false);
Jarod Wilson1cd50f22010-11-09 18:41:03 -03001025 if (ir->rem)
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -03001026 ir->parser_state = PARSE_IRDATA;
Jarod Wilson5bd9d732011-01-26 12:20:09 -03001027 else
1028 ir_raw_event_reset(ir->rc);
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -03001029 break;
Jarod Wilson66e89522010-06-01 17:32:08 -03001030 }
1031
Mauro Carvalho Chehab39dc5c32010-10-22 01:35:44 -03001032 if (ir->parser_state != CMD_HEADER && !ir->rem)
1033 ir->parser_state = CMD_HEADER;
Jarod Wilson66e89522010-06-01 17:32:08 -03001034 }
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001035 mce_dbg(ir->dev, "processed IR data, calling ir_raw_event_handle\n");
David Härdemand8b4b582010-10-29 16:08:23 -03001036 ir_raw_event_handle(ir->rc);
Jarod Wilson66e89522010-06-01 17:32:08 -03001037}
1038
Sean Young6ac454a2012-07-15 13:31:31 -03001039static void mceusb_dev_recv(struct urb *urb)
Jarod Wilson66e89522010-06-01 17:32:08 -03001040{
1041 struct mceusb_dev *ir;
1042 int buf_len;
1043
1044 if (!urb)
1045 return;
1046
1047 ir = urb->context;
1048 if (!ir) {
1049 usb_unlink_urb(urb);
1050 return;
1051 }
1052
1053 buf_len = urb->actual_length;
1054
Jarod Wilson66e89522010-06-01 17:32:08 -03001055 if (ir->send_flags == RECV_FLAG_IN_PROGRESS) {
1056 ir->send_flags = SEND_FLAG_COMPLETE;
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001057 mce_dbg(ir->dev, "setup answer received %d bytes\n",
Jarod Wilson66e89522010-06-01 17:32:08 -03001058 buf_len);
1059 }
1060
1061 switch (urb->status) {
1062 /* success */
1063 case 0:
1064 mceusb_process_ir_data(ir, buf_len);
1065 break;
1066
1067 case -ECONNRESET:
1068 case -ENOENT:
1069 case -ESHUTDOWN:
1070 usb_unlink_urb(urb);
1071 return;
1072
1073 case -EPIPE:
1074 default:
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001075 mce_dbg(ir->dev, "Error: urb status = %d\n", urb->status);
Jarod Wilson66e89522010-06-01 17:32:08 -03001076 break;
1077 }
1078
1079 usb_submit_urb(urb, GFP_ATOMIC);
1080}
1081
Jarod Wilsonab1072e2011-07-18 16:54:25 -03001082static void mceusb_get_emulator_version(struct mceusb_dev *ir)
1083{
1084 /* If we get no reply or an illegal command reply, its ver 1, says MS */
1085 ir->emver = 1;
1086 mce_async_out(ir, GET_EMVER, sizeof(GET_EMVER));
1087}
1088
Jarod Wilson66e89522010-06-01 17:32:08 -03001089static void mceusb_gen1_init(struct mceusb_dev *ir)
1090{
Mauro Carvalho Chehabca17a4f2010-07-10 11:19:42 -03001091 int ret;
Jarod Wilson66e89522010-06-01 17:32:08 -03001092 struct device *dev = ir->dev;
Jarod Wilsonb48592e2010-07-03 22:42:14 -03001093 char *data;
Jarod Wilson657290b2010-06-16 17:10:05 -03001094
1095 data = kzalloc(USB_CTRL_MSG_SZ, GFP_KERNEL);
1096 if (!data) {
1097 dev_err(dev, "%s: memory allocation failed!\n", __func__);
Jarod Wilson657290b2010-06-16 17:10:05 -03001098 return;
1099 }
Jarod Wilson66e89522010-06-01 17:32:08 -03001100
1101 /*
Jarod Wilsonb48592e2010-07-03 22:42:14 -03001102 * This is a strange one. Windows issues a set address to the device
Jarod Wilson66e89522010-06-01 17:32:08 -03001103 * on the receive control pipe and expect a certain value pair back
1104 */
Jarod Wilson66e89522010-06-01 17:32:08 -03001105 ret = usb_control_msg(ir->usbdev, usb_rcvctrlpipe(ir->usbdev, 0),
1106 USB_REQ_SET_ADDRESS, USB_TYPE_VENDOR, 0, 0,
Jarod Wilson657290b2010-06-16 17:10:05 -03001107 data, USB_CTRL_MSG_SZ, HZ * 3);
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001108 mce_dbg(dev, "%s - ret = %d\n", __func__, ret);
1109 mce_dbg(dev, "%s - data[0] = %d, data[1] = %d\n",
Jarod Wilson66e89522010-06-01 17:32:08 -03001110 __func__, data[0], data[1]);
1111
1112 /* set feature: bit rate 38400 bps */
1113 ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1114 USB_REQ_SET_FEATURE, USB_TYPE_VENDOR,
1115 0xc04e, 0x0000, NULL, 0, HZ * 3);
1116
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001117 mce_dbg(dev, "%s - ret = %d\n", __func__, ret);
Jarod Wilson66e89522010-06-01 17:32:08 -03001118
1119 /* bRequest 4: set char length to 8 bits */
1120 ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1121 4, USB_TYPE_VENDOR,
1122 0x0808, 0x0000, NULL, 0, HZ * 3);
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001123 mce_dbg(dev, "%s - retB = %d\n", __func__, ret);
Jarod Wilson66e89522010-06-01 17:32:08 -03001124
1125 /* bRequest 2: set handshaking to use DTR/DSR */
1126 ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0),
1127 2, USB_TYPE_VENDOR,
1128 0x0000, 0x0100, NULL, 0, HZ * 3);
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001129 mce_dbg(dev, "%s - retC = %d\n", __func__, ret);
Jarod Wilson657290b2010-06-16 17:10:05 -03001130
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -03001131 /* device resume */
1132 mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
Jarod Wilson22b07662010-07-08 12:38:57 -03001133
1134 /* get hw/sw revision? */
1135 mce_async_out(ir, GET_REVISION, sizeof(GET_REVISION));
Jarod Wilson22b07662010-07-08 12:38:57 -03001136
Jarod Wilson657290b2010-06-16 17:10:05 -03001137 kfree(data);
Jarod Wilson66e89522010-06-01 17:32:08 -03001138};
1139
1140static void mceusb_gen2_init(struct mceusb_dev *ir)
1141{
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -03001142 /* device resume */
1143 mce_async_out(ir, DEVICE_RESUME, sizeof(DEVICE_RESUME));
Jarod Wilson66e89522010-06-01 17:32:08 -03001144
1145 /* get hw/sw revision? */
1146 mce_async_out(ir, GET_REVISION, sizeof(GET_REVISION));
Jarod Wilson66e89522010-06-01 17:32:08 -03001147
Jarod Wilsona6fbd3b2011-07-18 16:54:21 -03001148 /* get wake version (protocol, key, address) */
1149 mce_async_out(ir, GET_WAKEVERSION, sizeof(GET_WAKEVERSION));
1150
1151 /* unknown what this one actually returns... */
Jarod Wilson22b07662010-07-08 12:38:57 -03001152 mce_async_out(ir, GET_UNKNOWN2, sizeof(GET_UNKNOWN2));
Jarod Wilson66e89522010-06-01 17:32:08 -03001153}
1154
Jarod Wilson22b07662010-07-08 12:38:57 -03001155static void mceusb_get_parameters(struct mceusb_dev *ir)
Jarod Wilson66e89522010-06-01 17:32:08 -03001156{
Jarod Wilsona411e832011-07-18 16:54:26 -03001157 int i;
1158 unsigned char cmdbuf[3] = { MCE_CMD_PORT_SYS,
1159 MCE_CMD_GETPORTSTATUS, 0x00 };
1160
1161 /* defaults, if the hardware doesn't support querying */
1162 ir->num_txports = 2;
1163 ir->num_rxports = 2;
1164
1165 /* get number of tx and rx ports */
1166 mce_async_out(ir, GET_NUM_PORTS, sizeof(GET_NUM_PORTS));
1167
Jarod Wilson66e89522010-06-01 17:32:08 -03001168 /* get the carrier and frequency */
1169 mce_async_out(ir, GET_CARRIER_FREQ, sizeof(GET_CARRIER_FREQ));
Jarod Wilson66e89522010-06-01 17:32:08 -03001170
Jarod Wilsona411e832011-07-18 16:54:26 -03001171 if (ir->num_txports && !ir->flags.no_tx)
Jarod Wilson6f6c6252010-10-29 00:07:39 -03001172 /* get the transmitter bitmask */
1173 mce_async_out(ir, GET_TX_BITMASK, sizeof(GET_TX_BITMASK));
Jarod Wilson66e89522010-06-01 17:32:08 -03001174
1175 /* get receiver timeout value */
1176 mce_async_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT));
Jarod Wilson66e89522010-06-01 17:32:08 -03001177
1178 /* get receiver sensor setting */
1179 mce_async_out(ir, GET_RX_SENSOR, sizeof(GET_RX_SENSOR));
Jarod Wilsona411e832011-07-18 16:54:26 -03001180
1181 for (i = 0; i < ir->num_txports; i++) {
1182 cmdbuf[2] = i;
1183 mce_async_out(ir, cmdbuf, sizeof(cmdbuf));
1184 }
Jarod Wilson66e89522010-06-01 17:32:08 -03001185}
1186
Jarod Wilsonb71969b2011-07-18 16:54:27 -03001187static void mceusb_flash_led(struct mceusb_dev *ir)
1188{
1189 if (ir->emver < 2)
1190 return;
1191
1192 mce_async_out(ir, FLASH_LED, sizeof(FLASH_LED));
1193}
1194
David Härdemand8b4b582010-10-29 16:08:23 -03001195static struct rc_dev *mceusb_init_rc_dev(struct mceusb_dev *ir)
Jarod Wilson66e89522010-06-01 17:32:08 -03001196{
Jarod Wilson66e89522010-06-01 17:32:08 -03001197 struct device *dev = ir->dev;
David Härdemand8b4b582010-10-29 16:08:23 -03001198 struct rc_dev *rc;
1199 int ret;
Jarod Wilson66e89522010-06-01 17:32:08 -03001200
David Härdemand8b4b582010-10-29 16:08:23 -03001201 rc = rc_allocate_device();
1202 if (!rc) {
1203 dev_err(dev, "remote dev allocation failed\n");
1204 goto out;
Jarod Wilson66e89522010-06-01 17:32:08 -03001205 }
1206
Mauro Carvalho Chehab3459d452010-10-22 11:52:53 -03001207 snprintf(ir->name, sizeof(ir->name), "%s (%04x:%04x)",
David Härdemand8b4b582010-10-29 16:08:23 -03001208 mceusb_model[ir->model].name ?
Paul Bender5ad1a552010-11-17 16:56:17 -03001209 mceusb_model[ir->model].name :
David Härdemand8b4b582010-10-29 16:08:23 -03001210 "Media Center Ed. eHome Infrared Remote Transceiver",
Jarod Wilson66e89522010-06-01 17:32:08 -03001211 le16_to_cpu(ir->usbdev->descriptor.idVendor),
1212 le16_to_cpu(ir->usbdev->descriptor.idProduct));
1213
Jarod Wilson66e89522010-06-01 17:32:08 -03001214 usb_make_path(ir->usbdev, ir->phys, sizeof(ir->phys));
Jarod Wilson66e89522010-06-01 17:32:08 -03001215
David Härdemand8b4b582010-10-29 16:08:23 -03001216 rc->input_name = ir->name;
1217 rc->input_phys = ir->phys;
1218 usb_to_input_id(ir->usbdev, &rc->input_id);
1219 rc->dev.parent = dev;
1220 rc->priv = ir;
1221 rc->driver_type = RC_DRIVER_IR_RAW;
Mauro Carvalho Chehab52b66142010-11-17 14:20:52 -03001222 rc->allowed_protos = RC_TYPE_ALL;
Rafi Rubin9824ae42011-07-03 17:13:53 -03001223 rc->timeout = MS_TO_NS(100);
Jarod Wilson6f6c6252010-10-29 00:07:39 -03001224 if (!ir->flags.no_tx) {
David Härdemand8b4b582010-10-29 16:08:23 -03001225 rc->s_tx_mask = mceusb_set_tx_mask;
1226 rc->s_tx_carrier = mceusb_set_tx_carrier;
1227 rc->tx_ir = mceusb_tx_ir;
Jarod Wilson6f6c6252010-10-29 00:07:39 -03001228 }
David Härdemand8b4b582010-10-29 16:08:23 -03001229 rc->driver_name = DRIVER_NAME;
1230 rc->map_name = mceusb_model[ir->model].rc_map ?
1231 mceusb_model[ir->model].rc_map : RC_MAP_RC6_MCE;
Jarod Wilson66e89522010-06-01 17:32:08 -03001232
David Härdemand8b4b582010-10-29 16:08:23 -03001233 ret = rc_register_device(rc);
Jarod Wilson66e89522010-06-01 17:32:08 -03001234 if (ret < 0) {
David Härdemand8b4b582010-10-29 16:08:23 -03001235 dev_err(dev, "remote dev registration failed\n");
1236 goto out;
Jarod Wilson66e89522010-06-01 17:32:08 -03001237 }
1238
David Härdemand8b4b582010-10-29 16:08:23 -03001239 return rc;
Jarod Wilson66e89522010-06-01 17:32:08 -03001240
David Härdemand8b4b582010-10-29 16:08:23 -03001241out:
1242 rc_free_device(rc);
Jarod Wilson66e89522010-06-01 17:32:08 -03001243 return NULL;
1244}
1245
1246static int __devinit mceusb_dev_probe(struct usb_interface *intf,
1247 const struct usb_device_id *id)
1248{
1249 struct usb_device *dev = interface_to_usbdev(intf);
1250 struct usb_host_interface *idesc;
1251 struct usb_endpoint_descriptor *ep = NULL;
1252 struct usb_endpoint_descriptor *ep_in = NULL;
1253 struct usb_endpoint_descriptor *ep_out = NULL;
Jarod Wilson66e89522010-06-01 17:32:08 -03001254 struct mceusb_dev *ir = NULL;
Jarod Wilsond732a722010-06-16 17:10:46 -03001255 int pipe, maxp, i;
Jarod Wilson66e89522010-06-01 17:32:08 -03001256 char buf[63], name[128] = "";
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -03001257 enum mceusb_model_type model = id->driver_info;
Jarod Wilson66e89522010-06-01 17:32:08 -03001258 bool is_gen3;
1259 bool is_microsoft_gen1;
Jarod Wilsond8cc7fd2010-12-15 19:20:55 -03001260 bool tx_mask_normal;
Jarod Wilsona6994eb2011-03-01 12:38:28 -03001261 int ir_intfnum;
Jarod Wilson66e89522010-06-01 17:32:08 -03001262
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001263 mce_dbg(&intf->dev, "%s called\n", __func__);
Jarod Wilson66e89522010-06-01 17:32:08 -03001264
Jarod Wilson66e89522010-06-01 17:32:08 -03001265 idesc = intf->cur_altsetting;
1266
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -03001267 is_gen3 = mceusb_model[model].mce_gen3;
1268 is_microsoft_gen1 = mceusb_model[model].mce_gen1;
Jarod Wilsond8cc7fd2010-12-15 19:20:55 -03001269 tx_mask_normal = mceusb_model[model].tx_mask_normal;
Jarod Wilsona6994eb2011-03-01 12:38:28 -03001270 ir_intfnum = mceusb_model[model].ir_intfnum;
Mauro Carvalho Chehab56e92f62010-10-18 16:32:50 -03001271
Jarod Wilsona6994eb2011-03-01 12:38:28 -03001272 /* There are multi-function devices with non-IR interfaces */
1273 if (idesc->desc.bInterfaceNumber != ir_intfnum)
1274 return -ENODEV;
Jarod Wilson66e89522010-06-01 17:32:08 -03001275
1276 /* step through the endpoints to find first bulk in and out endpoint */
1277 for (i = 0; i < idesc->desc.bNumEndpoints; ++i) {
1278 ep = &idesc->endpoint[i].desc;
1279
1280 if ((ep_in == NULL)
1281 && ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
1282 == USB_DIR_IN)
1283 && (((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1284 == USB_ENDPOINT_XFER_BULK)
1285 || ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1286 == USB_ENDPOINT_XFER_INT))) {
1287
Jarod Wilson66e89522010-06-01 17:32:08 -03001288 ep_in = ep;
1289 ep_in->bmAttributes = USB_ENDPOINT_XFER_INT;
Jarod Wilsond732a722010-06-16 17:10:46 -03001290 ep_in->bInterval = 1;
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001291 mce_dbg(&intf->dev, "acceptable inbound endpoint "
Jarod Wilsond732a722010-06-16 17:10:46 -03001292 "found\n");
Jarod Wilson66e89522010-06-01 17:32:08 -03001293 }
1294
1295 if ((ep_out == NULL)
1296 && ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK)
1297 == USB_DIR_OUT)
1298 && (((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1299 == USB_ENDPOINT_XFER_BULK)
1300 || ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1301 == USB_ENDPOINT_XFER_INT))) {
1302
Jarod Wilson66e89522010-06-01 17:32:08 -03001303 ep_out = ep;
1304 ep_out->bmAttributes = USB_ENDPOINT_XFER_INT;
Jarod Wilsond732a722010-06-16 17:10:46 -03001305 ep_out->bInterval = 1;
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001306 mce_dbg(&intf->dev, "acceptable outbound endpoint "
Jarod Wilsond732a722010-06-16 17:10:46 -03001307 "found\n");
Jarod Wilson66e89522010-06-01 17:32:08 -03001308 }
1309 }
1310 if (ep_in == NULL) {
Jarod Wilson5ae8f9a2011-05-26 15:51:11 -03001311 mce_dbg(&intf->dev, "inbound and/or endpoint not found\n");
Jarod Wilson66e89522010-06-01 17:32:08 -03001312 return -ENODEV;
1313 }
1314
1315 pipe = usb_rcvintpipe(dev, ep_in->bEndpointAddress);
1316 maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
1317
1318 ir = kzalloc(sizeof(struct mceusb_dev), GFP_KERNEL);
1319 if (!ir)
1320 goto mem_alloc_fail;
1321
1322 ir->buf_in = usb_alloc_coherent(dev, maxp, GFP_ATOMIC, &ir->dma_in);
1323 if (!ir->buf_in)
1324 goto buf_in_alloc_fail;
1325
1326 ir->urb_in = usb_alloc_urb(0, GFP_KERNEL);
1327 if (!ir->urb_in)
1328 goto urb_in_alloc_fail;
1329
1330 ir->usbdev = dev;
1331 ir->dev = &intf->dev;
1332 ir->len_in = maxp;
Jarod Wilson66e89522010-06-01 17:32:08 -03001333 ir->flags.microsoft_gen1 = is_microsoft_gen1;
Jarod Wilsond8cc7fd2010-12-15 19:20:55 -03001334 ir->flags.tx_mask_normal = tx_mask_normal;
Jarod Wilson6f6c6252010-10-29 00:07:39 -03001335 ir->flags.no_tx = mceusb_model[model].no_tx;
Mauro Carvalho Chehab37dbd3a2010-10-22 11:50:37 -03001336 ir->model = model;
1337
Jarod Wilson66e89522010-06-01 17:32:08 -03001338 /* Saving usb interface data for use by the transmitter routine */
Jarod Wilson66e89522010-06-01 17:32:08 -03001339 ir->usb_ep_out = ep_out;
1340
1341 if (dev->descriptor.iManufacturer
1342 && usb_string(dev, dev->descriptor.iManufacturer,
1343 buf, sizeof(buf)) > 0)
1344 strlcpy(name, buf, sizeof(name));
1345 if (dev->descriptor.iProduct
1346 && usb_string(dev, dev->descriptor.iProduct,
1347 buf, sizeof(buf)) > 0)
1348 snprintf(name + strlen(name), sizeof(name) - strlen(name),
1349 " %s", buf);
1350
David Härdemand8b4b582010-10-29 16:08:23 -03001351 ir->rc = mceusb_init_rc_dev(ir);
1352 if (!ir->rc)
1353 goto rc_dev_fail;
Jarod Wilson66e89522010-06-01 17:32:08 -03001354
Jarod Wilsonb48592e2010-07-03 22:42:14 -03001355 /* wire up inbound data handler */
Sean Young6ac454a2012-07-15 13:31:31 -03001356 usb_fill_int_urb(ir->urb_in, dev, pipe, ir->buf_in, maxp,
1357 mceusb_dev_recv, ir, ep_in->bInterval);
Jarod Wilson66e89522010-06-01 17:32:08 -03001358 ir->urb_in->transfer_dma = ir->dma_in;
1359 ir->urb_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1360
Jarod Wilson3a918aa2011-05-26 14:23:18 -03001361 /* flush buffers on the device */
1362 mce_dbg(&intf->dev, "Flushing receive buffers\n");
1363 mce_flush_rx_buffer(ir, maxp);
1364
Jarod Wilsonab1072e2011-07-18 16:54:25 -03001365 /* figure out which firmware/emulator version this hardware has */
1366 mceusb_get_emulator_version(ir);
1367
Jarod Wilson66e89522010-06-01 17:32:08 -03001368 /* initialize device */
Jarod Wilson22b07662010-07-08 12:38:57 -03001369 if (ir->flags.microsoft_gen1)
Jarod Wilson66e89522010-06-01 17:32:08 -03001370 mceusb_gen1_init(ir);
Jarod Wilson22b07662010-07-08 12:38:57 -03001371 else if (!is_gen3)
Jarod Wilson66e89522010-06-01 17:32:08 -03001372 mceusb_gen2_init(ir);
1373
Jarod Wilson22b07662010-07-08 12:38:57 -03001374 mceusb_get_parameters(ir);
Jarod Wilson66e89522010-06-01 17:32:08 -03001375
Jarod Wilsonb71969b2011-07-18 16:54:27 -03001376 mceusb_flash_led(ir);
1377
Jarod Wilson6f6c6252010-10-29 00:07:39 -03001378 if (!ir->flags.no_tx)
David Härdemand8b4b582010-10-29 16:08:23 -03001379 mceusb_set_tx_mask(ir->rc, MCE_DEFAULT_TX_MASK);
Jarod Wilson66e89522010-06-01 17:32:08 -03001380
1381 usb_set_intfdata(intf, ir);
1382
Jarod Wilsonfa3348982011-07-18 16:54:23 -03001383 /* enable wake via this device */
1384 device_set_wakeup_capable(ir->dev, true);
1385 device_set_wakeup_enable(ir->dev, true);
1386
Jarod Wilsonab1072e2011-07-18 16:54:25 -03001387 dev_info(&intf->dev, "Registered %s with mce emulator interface "
1388 "version %x\n", name, ir->emver);
Jarod Wilsona411e832011-07-18 16:54:26 -03001389 dev_info(&intf->dev, "%x tx ports (0x%x cabled) and "
1390 "%x rx sensors (0x%x active)\n",
1391 ir->num_txports, ir->txports_cabled,
1392 ir->num_rxports, ir->rxports_active);
Jarod Wilson66e89522010-06-01 17:32:08 -03001393
1394 return 0;
1395
1396 /* Error-handling path */
David Härdemand8b4b582010-10-29 16:08:23 -03001397rc_dev_fail:
Jarod Wilson66e89522010-06-01 17:32:08 -03001398 usb_free_urb(ir->urb_in);
1399urb_in_alloc_fail:
1400 usb_free_coherent(dev, maxp, ir->buf_in, ir->dma_in);
1401buf_in_alloc_fail:
1402 kfree(ir);
1403mem_alloc_fail:
1404 dev_err(&intf->dev, "%s: device setup failed!\n", __func__);
1405
1406 return -ENOMEM;
1407}
1408
1409
1410static void __devexit mceusb_dev_disconnect(struct usb_interface *intf)
1411{
1412 struct usb_device *dev = interface_to_usbdev(intf);
1413 struct mceusb_dev *ir = usb_get_intfdata(intf);
1414
1415 usb_set_intfdata(intf, NULL);
1416
1417 if (!ir)
1418 return;
1419
1420 ir->usbdev = NULL;
David Härdemand8b4b582010-10-29 16:08:23 -03001421 rc_unregister_device(ir->rc);
Jarod Wilson66e89522010-06-01 17:32:08 -03001422 usb_kill_urb(ir->urb_in);
1423 usb_free_urb(ir->urb_in);
1424 usb_free_coherent(dev, ir->len_in, ir->buf_in, ir->dma_in);
1425
1426 kfree(ir);
1427}
1428
1429static int mceusb_dev_suspend(struct usb_interface *intf, pm_message_t message)
1430{
1431 struct mceusb_dev *ir = usb_get_intfdata(intf);
1432 dev_info(ir->dev, "suspend\n");
1433 usb_kill_urb(ir->urb_in);
1434 return 0;
1435}
1436
1437static int mceusb_dev_resume(struct usb_interface *intf)
1438{
1439 struct mceusb_dev *ir = usb_get_intfdata(intf);
1440 dev_info(ir->dev, "resume\n");
1441 if (usb_submit_urb(ir->urb_in, GFP_ATOMIC))
1442 return -EIO;
1443 return 0;
1444}
1445
1446static struct usb_driver mceusb_dev_driver = {
1447 .name = DRIVER_NAME,
1448 .probe = mceusb_dev_probe,
Arnd Bergmanncd624c72012-05-03 18:22:22 -03001449 .disconnect = __devexit_p(mceusb_dev_disconnect),
Jarod Wilson66e89522010-06-01 17:32:08 -03001450 .suspend = mceusb_dev_suspend,
1451 .resume = mceusb_dev_resume,
1452 .reset_resume = mceusb_dev_resume,
1453 .id_table = mceusb_dev_table
1454};
1455
Greg Kroah-Hartmanecb3b2b2011-11-18 09:46:12 -08001456module_usb_driver(mceusb_dev_driver);
Jarod Wilson66e89522010-06-01 17:32:08 -03001457
1458MODULE_DESCRIPTION(DRIVER_DESC);
1459MODULE_AUTHOR(DRIVER_AUTHOR);
1460MODULE_LICENSE("GPL");
1461MODULE_DEVICE_TABLE(usb, mceusb_dev_table);
1462
1463module_param(debug, bool, S_IRUGO | S_IWUSR);
1464MODULE_PARM_DESC(debug, "Debug enabled or not");