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/input.h> 40#include <media/ir-core.h> 41#include <media/ir-common.h> 42 43#define DRIVER_VERSION "1.91" 44#define DRIVER_AUTHOR "Jarod Wilson <jarod@wilsonet.com>" 45#define DRIVER_DESC "Windows Media Center Ed. eHome Infrared Transceiver " \ 46 "device driver" 47#define DRIVER_NAME "mceusb" 48 49#define USB_BUFLEN 32 /* USB reception buffer length */ 50#define USB_CTRL_MSG_SZ 2 /* Size of usb ctrl msg on gen1 hw */ 51#define MCE_G1_INIT_MSGS 40 /* Init messages on gen1 hw to throw out */ 52 53/* MCE constants */ 54#define MCE_CMDBUF_SIZE 384 /* MCE Command buffer length */ 55#define MCE_TIME_UNIT 50 /* Approx 50us resolution */ 56#define MCE_CODE_LENGTH 5 /* Normal length of packet (with header) */ 57#define MCE_PACKET_SIZE 4 /* Normal length of packet (without header) */ 58#define MCE_PACKET_HEADER 0x84 /* Actual header format is 0x80 + num_bytes */ 59#define MCE_CONTROL_HEADER 0x9F /* MCE status header */ 60#define MCE_TX_HEADER_LENGTH 3 /* # of bytes in the initializing tx header */ 61#define MCE_MAX_CHANNELS 2 /* Two transmitters, hardware dependent? */ 62#define MCE_DEFAULT_TX_MASK 0x03 /* Val opts: TX1=0x01, TX2=0x02, ALL=0x03 */ 63#define MCE_PULSE_BIT 0x80 /* Pulse bit, MSB set == PULSE else SPACE */ 64#define MCE_PULSE_MASK 0x7F /* Pulse mask */ 65#define MCE_MAX_PULSE_LENGTH 0x7F /* Longest transmittable pulse symbol */ 66#define MCE_PACKET_LENGTH_MASK 0x1F /* Packet length mask */ 67 68 69/* module parameters */ 70#ifdef CONFIG_USB_DEBUG 71static int debug = 1; 72#else 73static int debug; 74#endif 75 76/* general constants */ 77#define SEND_FLAG_IN_PROGRESS 1 78#define SEND_FLAG_COMPLETE 2 79#define RECV_FLAG_IN_PROGRESS 3 80#define RECV_FLAG_COMPLETE 4 81 82#define MCEUSB_RX 1 83#define MCEUSB_TX 2 84 85#define VENDOR_PHILIPS 0x0471 86#define VENDOR_SMK 0x0609 87#define VENDOR_TATUNG 0x1460 88#define VENDOR_GATEWAY 0x107b 89#define VENDOR_SHUTTLE 0x1308 90#define VENDOR_SHUTTLE2 0x051c 91#define VENDOR_MITSUMI 0x03ee 92#define VENDOR_TOPSEED 0x1784 93#define VENDOR_RICAVISION 0x179d 94#define VENDOR_ITRON 0x195d 95#define VENDOR_FIC 0x1509 96#define VENDOR_LG 0x043e 97#define VENDOR_MICROSOFT 0x045e 98#define VENDOR_FORMOSA 0x147a 99#define VENDOR_FINTEK 0x1934 100#define VENDOR_PINNACLE 0x2304 101#define VENDOR_ECS 0x1019 102#define VENDOR_WISTRON 0x0fb8 103#define VENDOR_COMPRO 0x185b 104#define VENDOR_NORTHSTAR 0x04eb 105#define VENDOR_REALTEK 0x0bda 106#define VENDOR_TIVO 0x105a 107 108static struct usb_device_id mceusb_dev_table[] = { 109 /* Original Microsoft MCE IR Transceiver (often HP-branded) */ 110 { USB_DEVICE(VENDOR_MICROSOFT, 0x006d) }, 111 /* Philips Infrared Transceiver - Sahara branded */ 112 { USB_DEVICE(VENDOR_PHILIPS, 0x0608) }, 113 /* Philips Infrared Transceiver - HP branded */ 114 { USB_DEVICE(VENDOR_PHILIPS, 0x060c) }, 115 /* Philips SRM5100 */ 116 { USB_DEVICE(VENDOR_PHILIPS, 0x060d) }, 117 /* Philips Infrared Transceiver - Omaura */ 118 { USB_DEVICE(VENDOR_PHILIPS, 0x060f) }, 119 /* Philips Infrared Transceiver - Spinel plus */ 120 { USB_DEVICE(VENDOR_PHILIPS, 0x0613) }, 121 /* Philips eHome Infrared Transceiver */ 122 { USB_DEVICE(VENDOR_PHILIPS, 0x0815) }, 123 /* Philips/Spinel plus IR transceiver for ASUS */ 124 { USB_DEVICE(VENDOR_PHILIPS, 0x206c) }, 125 /* Philips/Spinel plus IR transceiver for ASUS */ 126 { USB_DEVICE(VENDOR_PHILIPS, 0x2088) }, 127 /* Realtek MCE IR Receiver */ 128 { USB_DEVICE(VENDOR_REALTEK, 0x0161) }, 129 /* SMK/Toshiba G83C0004D410 */ 130 { USB_DEVICE(VENDOR_SMK, 0x031d) }, 131 /* SMK eHome Infrared Transceiver (Sony VAIO) */ 132 { USB_DEVICE(VENDOR_SMK, 0x0322) }, 133 /* bundled with Hauppauge PVR-150 */ 134 { USB_DEVICE(VENDOR_SMK, 0x0334) }, 135 /* SMK eHome Infrared Transceiver */ 136 { USB_DEVICE(VENDOR_SMK, 0x0338) }, 137 /* Tatung eHome Infrared Transceiver */ 138 { USB_DEVICE(VENDOR_TATUNG, 0x9150) }, 139 /* Shuttle eHome Infrared Transceiver */ 140 { USB_DEVICE(VENDOR_SHUTTLE, 0xc001) }, 141 /* Shuttle eHome Infrared Transceiver */ 142 { USB_DEVICE(VENDOR_SHUTTLE2, 0xc001) }, 143 /* Gateway eHome Infrared Transceiver */ 144 { USB_DEVICE(VENDOR_GATEWAY, 0x3009) }, 145 /* Mitsumi */ 146 { USB_DEVICE(VENDOR_MITSUMI, 0x2501) }, 147 /* Topseed eHome Infrared Transceiver */ 148 { USB_DEVICE(VENDOR_TOPSEED, 0x0001) }, 149 /* Topseed HP eHome Infrared Transceiver */ 150 { USB_DEVICE(VENDOR_TOPSEED, 0x0006) }, 151 /* Topseed eHome Infrared Transceiver */ 152 { USB_DEVICE(VENDOR_TOPSEED, 0x0007) }, 153 /* Topseed eHome Infrared Transceiver */ 154 { USB_DEVICE(VENDOR_TOPSEED, 0x0008) }, 155 /* Topseed eHome Infrared Transceiver */ 156 { USB_DEVICE(VENDOR_TOPSEED, 0x000a) }, 157 /* Topseed eHome Infrared Transceiver */ 158 { USB_DEVICE(VENDOR_TOPSEED, 0x0011) }, 159 /* Ricavision internal Infrared Transceiver */ 160 { USB_DEVICE(VENDOR_RICAVISION, 0x0010) }, 161 /* Itron ione Libra Q-11 */ 162 { USB_DEVICE(VENDOR_ITRON, 0x7002) }, 163 /* FIC eHome Infrared Transceiver */ 164 { USB_DEVICE(VENDOR_FIC, 0x9242) }, 165 /* LG eHome Infrared Transceiver */ 166 { USB_DEVICE(VENDOR_LG, 0x9803) }, 167 /* Microsoft MCE Infrared Transceiver */ 168 { USB_DEVICE(VENDOR_MICROSOFT, 0x00a0) }, 169 /* Formosa eHome Infrared Transceiver */ 170 { USB_DEVICE(VENDOR_FORMOSA, 0xe015) }, 171 /* Formosa21 / eHome Infrared Receiver */ 172 { USB_DEVICE(VENDOR_FORMOSA, 0xe016) }, 173 /* Formosa aim / Trust MCE Infrared Receiver */ 174 { USB_DEVICE(VENDOR_FORMOSA, 0xe017) }, 175 /* Formosa Industrial Computing / Beanbag Emulation Device */ 176 { USB_DEVICE(VENDOR_FORMOSA, 0xe018) }, 177 /* Formosa21 / eHome Infrared Receiver */ 178 { USB_DEVICE(VENDOR_FORMOSA, 0xe03a) }, 179 /* Formosa Industrial Computing AIM IR605/A */ 180 { USB_DEVICE(VENDOR_FORMOSA, 0xe03c) }, 181 /* Formosa Industrial Computing */ 182 { USB_DEVICE(VENDOR_FORMOSA, 0xe03e) }, 183 /* Fintek eHome Infrared Transceiver */ 184 { USB_DEVICE(VENDOR_FINTEK, 0x0602) }, 185 /* Fintek eHome Infrared Transceiver (in the AOpen MP45) */ 186 { USB_DEVICE(VENDOR_FINTEK, 0x0702) }, 187 /* Pinnacle Remote Kit */ 188 { USB_DEVICE(VENDOR_PINNACLE, 0x0225) }, 189 /* Elitegroup Computer Systems IR */ 190 { USB_DEVICE(VENDOR_ECS, 0x0f38) }, 191 /* Wistron Corp. eHome Infrared Receiver */ 192 { USB_DEVICE(VENDOR_WISTRON, 0x0002) }, 193 /* Compro K100 */ 194 { USB_DEVICE(VENDOR_COMPRO, 0x3020) }, 195 /* Compro K100 v2 */ 196 { USB_DEVICE(VENDOR_COMPRO, 0x3082) }, 197 /* Northstar Systems, Inc. eHome Infrared Transceiver */ 198 { USB_DEVICE(VENDOR_NORTHSTAR, 0xe004) }, 199 /* TiVo PC IR Receiver */ 200 { USB_DEVICE(VENDOR_TIVO, 0x2000) }, 201 /* Terminating entry */ 202 { } 203}; 204 205static struct usb_device_id gen3_list[] = { 206 { USB_DEVICE(VENDOR_PINNACLE, 0x0225) }, 207 { USB_DEVICE(VENDOR_TOPSEED, 0x0008) }, 208 {} 209}; 210 211static struct usb_device_id microsoft_gen1_list[] = { 212 { USB_DEVICE(VENDOR_MICROSOFT, 0x006d) }, 213 {} 214}; 215 216static struct usb_device_id std_tx_mask_list[] = { 217 { USB_DEVICE(VENDOR_MICROSOFT, 0x006d) }, 218 { USB_DEVICE(VENDOR_PHILIPS, 0x060c) }, 219 { USB_DEVICE(VENDOR_SMK, 0x031d) }, 220 { USB_DEVICE(VENDOR_SMK, 0x0322) }, 221 { USB_DEVICE(VENDOR_SMK, 0x0334) }, 222 { USB_DEVICE(VENDOR_TOPSEED, 0x0001) }, 223 { USB_DEVICE(VENDOR_TOPSEED, 0x0006) }, 224 { USB_DEVICE(VENDOR_TOPSEED, 0x0007) }, 225 { USB_DEVICE(VENDOR_TOPSEED, 0x0008) }, 226 { USB_DEVICE(VENDOR_TOPSEED, 0x000a) }, 227 { USB_DEVICE(VENDOR_TOPSEED, 0x0011) }, 228 { USB_DEVICE(VENDOR_PINNACLE, 0x0225) }, 229 {} 230}; 231 232/* data structure for each usb transceiver */ 233struct mceusb_dev { 234 /* ir-core bits */ 235 struct ir_dev_props *props; 236 struct ir_raw_event rawir; 237 238 /* core device bits */ 239 struct device *dev; 240 struct input_dev *idev; 241 242 /* usb */ 243 struct usb_device *usbdev; 244 struct urb *urb_in; 245 struct usb_endpoint_descriptor *usb_ep_in; 246 struct usb_endpoint_descriptor *usb_ep_out; 247 248 /* buffers and dma */ 249 unsigned char *buf_in; 250 unsigned int len_in; 251 u8 cmd; /* MCE command type */ 252 u8 rem; /* Remaining IR data bytes in packet */ 253 dma_addr_t dma_in; 254 dma_addr_t dma_out; 255 256 struct { 257 u32 connected:1; 258 u32 tx_mask_inverted:1; 259 u32 microsoft_gen1:1; 260 u32 reserved:29; 261 } flags; 262 263 /* transmit support */ 264 int send_flags; 265 u32 carrier; 266 unsigned char tx_mask; 267 268 char name[128]; 269 char phys[64]; 270}; 271 272/* 273 * MCE Device Command Strings 274 * Device command responses vary from device to device... 275 * - DEVICE_RESET resets the hardware to its default state 276 * - GET_REVISION fetches the hardware/software revision, common 277 * replies are ff 0b 45 ff 1b 08 and ff 0b 50 ff 1b 42 278 * - GET_CARRIER_FREQ gets the carrier mode and frequency of the 279 * device, with replies in the form of 9f 06 MM FF, where MM is 0-3, 280 * meaning clk of 10000000, 2500000, 625000 or 156250, and FF is 281 * ((clk / frequency) - 1) 282 * - GET_RX_TIMEOUT fetches the receiver timeout in units of 50us, 283 * response in the form of 9f 0c msb lsb 284 * - GET_TX_BITMASK fetches the transmitter bitmask, replies in 285 * the form of 9f 08 bm, where bm is the bitmask 286 * - GET_RX_SENSOR fetches the RX sensor setting -- long-range 287 * general use one or short-range learning one, in the form of 288 * 9f 14 ss, where ss is either 01 for long-range or 02 for short 289 * - SET_CARRIER_FREQ sets a new carrier mode and frequency 290 * - SET_TX_BITMASK sets the transmitter bitmask 291 * - SET_RX_TIMEOUT sets the receiver timeout 292 * - SET_RX_SENSOR sets which receiver sensor to use 293 */ 294static char DEVICE_RESET[] = {0x00, 0xff, 0xaa}; 295static char GET_REVISION[] = {0xff, 0x0b}; 296static char GET_UNKNOWN[] = {0xff, 0x18}; 297static char GET_UNKNOWN2[] = {0x9f, 0x05}; 298static char GET_CARRIER_FREQ[] = {0x9f, 0x07}; 299static char GET_RX_TIMEOUT[] = {0x9f, 0x0d}; 300static char GET_TX_BITMASK[] = {0x9f, 0x13}; 301static char GET_RX_SENSOR[] = {0x9f, 0x15}; 302/* sub in desired values in lower byte or bytes for full command */ 303 304static void mceusb_dev_printdata(struct mceusb_dev *ir, char *buf, 305 int len, bool out) 306{ 307 char codes[USB_BUFLEN * 3 + 1]; 308 char inout[9]; 309 int i; 310 u8 cmd, subcmd, data1, data2; 311 struct device *dev = ir->dev; 312 int idx = 0; 313 314 /* skip meaningless 0xb1 0x60 header bytes on orig receiver */ 315 if (ir->flags.microsoft_gen1 && !out) 316 idx = 2; 317 318 if (len <= idx) 319 return; 320 321 for (i = 0; i < len && i < USB_BUFLEN; i++) 322 snprintf(codes + i * 3, 4, "%02x ", buf[i] & 0xFF); 323 324 dev_info(dev, "%sx data: %s (length=%d)\n", 325 (out ? "t" : "r"), codes, len); 326 327 if (out) 328 strcpy(inout, "Request\0"); 329 else 330 strcpy(inout, "Got\0"); 331 332 cmd = buf[idx] & 0xff; 333 subcmd = buf[idx + 1] & 0xff; 334 data1 = buf[idx + 2] & 0xff; 335 data2 = buf[idx + 3] & 0xff; 336 337 switch (cmd) { 338 case 0x00: 339 if (subcmd == 0xff && data1 == 0xaa) 340 dev_info(dev, "Device reset requested\n"); 341 else 342 dev_info(dev, "Unknown command 0x%02x 0x%02x\n", 343 cmd, subcmd); 344 break; 345 case 0xff: 346 switch (subcmd) { 347 case 0x0b: 348 if (len == 2) 349 dev_info(dev, "Get hw/sw rev?\n"); 350 else 351 dev_info(dev, "hw/sw rev 0x%02x 0x%02x " 352 "0x%02x 0x%02x\n", data1, data2, 353 buf[idx + 4], buf[idx + 5]); 354 break; 355 case 0xaa: 356 dev_info(dev, "Device reset requested\n"); 357 break; 358 case 0xfe: 359 dev_info(dev, "Previous command not supported\n"); 360 break; 361 case 0x18: 362 case 0x1b: 363 default: 364 dev_info(dev, "Unknown command 0x%02x 0x%02x\n", 365 cmd, subcmd); 366 break; 367 } 368 break; 369 case 0x9f: 370 switch (subcmd) { 371 case 0x03: 372 dev_info(dev, "Ping\n"); 373 break; 374 case 0x04: 375 dev_info(dev, "Resp to 9f 05 of 0x%02x 0x%02x\n", 376 data1, data2); 377 break; 378 case 0x06: 379 dev_info(dev, "%s carrier mode and freq of " 380 "0x%02x 0x%02x\n", inout, data1, data2); 381 break; 382 case 0x07: 383 dev_info(dev, "Get carrier mode and freq\n"); 384 break; 385 case 0x08: 386 dev_info(dev, "%s transmit blaster mask of 0x%02x\n", 387 inout, data1); 388 break; 389 case 0x0c: 390 /* value is in units of 50us, so x*50/100 or x/2 ms */ 391 dev_info(dev, "%s receive timeout of %d ms\n", 392 inout, ((data1 << 8) | data2) / 2); 393 break; 394 case 0x0d: 395 dev_info(dev, "Get receive timeout\n"); 396 break; 397 case 0x13: 398 dev_info(dev, "Get transmit blaster mask\n"); 399 break; 400 case 0x14: 401 dev_info(dev, "%s %s-range receive sensor in use\n", 402 inout, data1 == 0x02 ? "short" : "long"); 403 break; 404 case 0x15: 405 if (len == 2) 406 dev_info(dev, "Get receive sensor\n"); 407 else 408 dev_info(dev, "Received pulse count is %d\n", 409 ((data1 << 8) | data2)); 410 break; 411 case 0xfe: 412 dev_info(dev, "Error! Hardware is likely wedged...\n"); 413 break; 414 case 0x05: 415 case 0x09: 416 case 0x0f: 417 default: 418 dev_info(dev, "Unknown command 0x%02x 0x%02x\n", 419 cmd, subcmd); 420 break; 421 } 422 break; 423 default: 424 break; 425 } 426} 427 428static void mce_async_callback(struct urb *urb, struct pt_regs *regs) 429{ 430 struct mceusb_dev *ir; 431 int len; 432 433 if (!urb) 434 return; 435 436 ir = urb->context; 437 if (ir) { 438 len = urb->actual_length; 439 440 dev_dbg(ir->dev, "callback called (status=%d len=%d)\n", 441 urb->status, len); 442 443 if (debug) 444 mceusb_dev_printdata(ir, urb->transfer_buffer, 445 len, true); 446 } 447 448} 449 450/* request incoming or send outgoing usb packet - used to initialize remote */ 451static void mce_request_packet(struct mceusb_dev *ir, 452 struct usb_endpoint_descriptor *ep, 453 unsigned char *data, int size, int urb_type) 454{ 455 int res; 456 struct urb *async_urb; 457 struct device *dev = ir->dev; 458 unsigned char *async_buf; 459 460 if (urb_type == MCEUSB_TX) { 461 async_urb = usb_alloc_urb(0, GFP_KERNEL); 462 if (unlikely(!async_urb)) { 463 dev_err(dev, "Error, couldn't allocate urb!\n"); 464 return; 465 } 466 467 async_buf = kzalloc(size, GFP_KERNEL); 468 if (!async_buf) { 469 dev_err(dev, "Error, couldn't allocate buf!\n"); 470 usb_free_urb(async_urb); 471 return; 472 } 473 474 /* outbound data */ 475 usb_fill_int_urb(async_urb, ir->usbdev, 476 usb_sndintpipe(ir->usbdev, ep->bEndpointAddress), 477 async_buf, size, (usb_complete_t)mce_async_callback, 478 ir, ep->bInterval); 479 memcpy(async_buf, data, size); 480 481 } else if (urb_type == MCEUSB_RX) { 482 /* standard request */ 483 async_urb = ir->urb_in; 484 ir->send_flags = RECV_FLAG_IN_PROGRESS; 485 486 } else { 487 dev_err(dev, "Error! Unknown urb type %d\n", urb_type); 488 return; 489 } 490 491 dev_dbg(dev, "receive request called (size=%#x)\n", size); 492 493 async_urb->transfer_buffer_length = size; 494 async_urb->dev = ir->usbdev; 495 496 res = usb_submit_urb(async_urb, GFP_ATOMIC); 497 if (res) { 498 dev_dbg(dev, "receive request FAILED! (res=%d)\n", res); 499 return; 500 } 501 dev_dbg(dev, "receive request complete (res=%d)\n", res); 502} 503 504static void mce_async_out(struct mceusb_dev *ir, unsigned char *data, int size) 505{ 506 mce_request_packet(ir, ir->usb_ep_out, data, size, MCEUSB_TX); 507} 508 509static void mce_sync_in(struct mceusb_dev *ir, unsigned char *data, int size) 510{ 511 mce_request_packet(ir, ir->usb_ep_in, data, size, MCEUSB_RX); 512} 513 514/* Send data out the IR blaster port(s) */ 515static int mceusb_tx_ir(void *priv, int *txbuf, u32 n) 516{ 517 struct mceusb_dev *ir = priv; 518 int i, ret = 0; 519 int count, cmdcount = 0; 520 unsigned char *cmdbuf; /* MCE command buffer */ 521 long signal_duration = 0; /* Singnal length in us */ 522 struct timeval start_time, end_time; 523 524 do_gettimeofday(&start_time); 525 526 count = n / sizeof(int); 527 528 cmdbuf = kzalloc(sizeof(int) * MCE_CMDBUF_SIZE, GFP_KERNEL); 529 if (!cmdbuf) 530 return -ENOMEM; 531 532 /* MCE tx init header */ 533 cmdbuf[cmdcount++] = MCE_CONTROL_HEADER; 534 cmdbuf[cmdcount++] = 0x08; 535 cmdbuf[cmdcount++] = ir->tx_mask; 536 537 /* Generate mce packet data */ 538 for (i = 0; (i < count) && (cmdcount < MCE_CMDBUF_SIZE); i++) { 539 signal_duration += txbuf[i]; 540 txbuf[i] = txbuf[i] / MCE_TIME_UNIT; 541 542 do { /* loop to support long pulses/spaces > 127*50us=6.35ms */ 543 544 /* Insert mce packet header every 4th entry */ 545 if ((cmdcount < MCE_CMDBUF_SIZE) && 546 (cmdcount - MCE_TX_HEADER_LENGTH) % 547 MCE_CODE_LENGTH == 0) 548 cmdbuf[cmdcount++] = MCE_PACKET_HEADER; 549 550 /* Insert mce packet data */ 551 if (cmdcount < MCE_CMDBUF_SIZE) 552 cmdbuf[cmdcount++] = 553 (txbuf[i] < MCE_PULSE_BIT ? 554 txbuf[i] : MCE_MAX_PULSE_LENGTH) | 555 (i & 1 ? 0x00 : MCE_PULSE_BIT); 556 else { 557 ret = -EINVAL; 558 goto out; 559 } 560 561 } while ((txbuf[i] > MCE_MAX_PULSE_LENGTH) && 562 (txbuf[i] -= MCE_MAX_PULSE_LENGTH)); 563 } 564 565 /* Fix packet length in last header */ 566 cmdbuf[cmdcount - (cmdcount - MCE_TX_HEADER_LENGTH) % MCE_CODE_LENGTH] = 567 0x80 + (cmdcount - MCE_TX_HEADER_LENGTH) % MCE_CODE_LENGTH - 1; 568 569 /* Check if we have room for the empty packet at the end */ 570 if (cmdcount >= MCE_CMDBUF_SIZE) { 571 ret = -EINVAL; 572 goto out; 573 } 574 575 /* All mce commands end with an empty packet (0x80) */ 576 cmdbuf[cmdcount++] = 0x80; 577 578 /* Transmit the command to the mce device */ 579 mce_async_out(ir, cmdbuf, cmdcount); 580 581 /* 582 * The lircd gap calculation expects the write function to 583 * wait the time it takes for the ircommand to be sent before 584 * it returns. 585 */ 586 do_gettimeofday(&end_time); 587 signal_duration -= (end_time.tv_usec - start_time.tv_usec) + 588 (end_time.tv_sec - start_time.tv_sec) * 1000000; 589 590 /* delay with the closest number of ticks */ 591 set_current_state(TASK_INTERRUPTIBLE); 592 schedule_timeout(usecs_to_jiffies(signal_duration)); 593 594out: 595 kfree(cmdbuf); 596 return ret ? ret : n; 597} 598 599/* Sets active IR outputs -- mce devices typically (all?) have two */ 600static int mceusb_set_tx_mask(void *priv, u32 mask) 601{ 602 struct mceusb_dev *ir = priv; 603 604 if (ir->flags.tx_mask_inverted) 605 ir->tx_mask = (mask != 0x03 ? mask ^ 0x03 : mask) << 1; 606 else 607 ir->tx_mask = mask; 608 609 return 0; 610} 611 612/* Sets the send carrier frequency and mode */ 613static int mceusb_set_tx_carrier(void *priv, u32 carrier) 614{ 615 struct mceusb_dev *ir = priv; 616 int clk = 10000000; 617 int prescaler = 0, divisor = 0; 618 unsigned char cmdbuf[4] = { 0x9f, 0x06, 0x00, 0x00 }; 619 620 /* Carrier has changed */ 621 if (ir->carrier != carrier) { 622 623 if (carrier == 0) { 624 ir->carrier = carrier; 625 cmdbuf[2] = 0x01; 626 cmdbuf[3] = 0x80; 627 dev_dbg(ir->dev, "%s: disabling carrier " 628 "modulation\n", __func__); 629 mce_async_out(ir, cmdbuf, sizeof(cmdbuf)); 630 return carrier; 631 } 632 633 for (prescaler = 0; prescaler < 4; ++prescaler) { 634 divisor = (clk >> (2 * prescaler)) / carrier; 635 if (divisor <= 0xFF) { 636 ir->carrier = carrier; 637 cmdbuf[2] = prescaler; 638 cmdbuf[3] = divisor; 639 dev_dbg(ir->dev, "%s: requesting %u HZ " 640 "carrier\n", __func__, carrier); 641 642 /* Transmit new carrier to mce device */ 643 mce_async_out(ir, cmdbuf, sizeof(cmdbuf)); 644 return carrier; 645 } 646 } 647 648 return -EINVAL; 649 650 } 651 652 return carrier; 653} 654 655static void mceusb_process_ir_data(struct mceusb_dev *ir, int buf_len) 656{ 657 struct ir_raw_event rawir = { .pulse = false, .duration = 0 }; 658 int i, start_index = 0; 659 u8 hdr = MCE_CONTROL_HEADER; 660 661 /* skip meaningless 0xb1 0x60 header bytes on orig receiver */ 662 if (ir->flags.microsoft_gen1) 663 start_index = 2; 664 665 for (i = start_index; i < buf_len;) { 666 if (ir->rem == 0) { 667 /* decode mce packets of the form (84),AA,BB,CC,DD */ 668 /* IR data packets can span USB messages - rem */ 669 hdr = ir->buf_in[i]; 670 ir->rem = (hdr & MCE_PACKET_LENGTH_MASK); 671 ir->cmd = (hdr & ~MCE_PACKET_LENGTH_MASK); 672 dev_dbg(ir->dev, "New data. rem: 0x%02x, cmd: 0x%02x\n", 673 ir->rem, ir->cmd); 674 i++; 675 } 676 677 /* don't process MCE commands */ 678 if (hdr == MCE_CONTROL_HEADER || hdr == 0xff) { 679 ir->rem = 0; 680 return; 681 } 682 683 for (; (ir->rem > 0) && (i < buf_len); i++) { 684 ir->rem--; 685 686 rawir.pulse = ((ir->buf_in[i] & MCE_PULSE_BIT) != 0); 687 rawir.duration = (ir->buf_in[i] & MCE_PULSE_MASK) 688 * MCE_TIME_UNIT * 1000; 689 690 if ((ir->buf_in[i] & MCE_PULSE_MASK) == 0x7f) { 691 if (ir->rawir.pulse == rawir.pulse) 692 ir->rawir.duration += rawir.duration; 693 else { 694 ir->rawir.duration = rawir.duration; 695 ir->rawir.pulse = rawir.pulse; 696 } 697 continue; 698 } 699 rawir.duration += ir->rawir.duration; 700 ir->rawir.duration = 0; 701 ir->rawir.pulse = rawir.pulse; 702 703 dev_dbg(ir->dev, "Storing %s with duration %d\n", 704 rawir.pulse ? "pulse" : "space", 705 rawir.duration); 706 707 ir_raw_event_store(ir->idev, &rawir); 708 } 709 710 if (ir->buf_in[i] == 0x80 || ir->buf_in[i] == 0x9f) 711 ir->rem = 0; 712 713 dev_dbg(ir->dev, "calling ir_raw_event_handle\n"); 714 ir_raw_event_handle(ir->idev); 715 } 716} 717 718static void mceusb_dev_recv(struct urb *urb, struct pt_regs *regs) 719{ 720 struct mceusb_dev *ir; 721 int buf_len; 722 723 if (!urb) 724 return; 725 726 ir = urb->context; 727 if (!ir) { 728 usb_unlink_urb(urb); 729 return; 730 } 731 732 buf_len = urb->actual_length; 733 734 if (debug) 735 mceusb_dev_printdata(ir, urb->transfer_buffer, buf_len, false); 736 737 if (ir->send_flags == RECV_FLAG_IN_PROGRESS) { 738 ir->send_flags = SEND_FLAG_COMPLETE; 739 dev_dbg(ir->dev, "setup answer received %d bytes\n", 740 buf_len); 741 } 742 743 switch (urb->status) { 744 /* success */ 745 case 0: 746 mceusb_process_ir_data(ir, buf_len); 747 break; 748 749 case -ECONNRESET: 750 case -ENOENT: 751 case -ESHUTDOWN: 752 usb_unlink_urb(urb); 753 return; 754 755 case -EPIPE: 756 default: 757 break; 758 } 759 760 usb_submit_urb(urb, GFP_ATOMIC); 761} 762 763static void mceusb_gen1_init(struct mceusb_dev *ir) 764{ 765 int ret; 766 int maxp = ir->len_in; 767 struct device *dev = ir->dev; 768 char *data; 769 770 data = kzalloc(USB_CTRL_MSG_SZ, GFP_KERNEL); 771 if (!data) { 772 dev_err(dev, "%s: memory allocation failed!\n", __func__); 773 return; 774 } 775 776 /* 777 * This is a strange one. Windows issues a set address to the device 778 * on the receive control pipe and expect a certain value pair back 779 */ 780 ret = usb_control_msg(ir->usbdev, usb_rcvctrlpipe(ir->usbdev, 0), 781 USB_REQ_SET_ADDRESS, USB_TYPE_VENDOR, 0, 0, 782 data, USB_CTRL_MSG_SZ, HZ * 3); 783 dev_dbg(dev, "%s - ret = %d\n", __func__, ret); 784 dev_dbg(dev, "%s - data[0] = %d, data[1] = %d\n", 785 __func__, data[0], data[1]); 786 787 /* set feature: bit rate 38400 bps */ 788 ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0), 789 USB_REQ_SET_FEATURE, USB_TYPE_VENDOR, 790 0xc04e, 0x0000, NULL, 0, HZ * 3); 791 792 dev_dbg(dev, "%s - ret = %d\n", __func__, ret); 793 794 /* bRequest 4: set char length to 8 bits */ 795 ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0), 796 4, USB_TYPE_VENDOR, 797 0x0808, 0x0000, NULL, 0, HZ * 3); 798 dev_dbg(dev, "%s - retB = %d\n", __func__, ret); 799 800 /* bRequest 2: set handshaking to use DTR/DSR */ 801 ret = usb_control_msg(ir->usbdev, usb_sndctrlpipe(ir->usbdev, 0), 802 2, USB_TYPE_VENDOR, 803 0x0000, 0x0100, NULL, 0, HZ * 3); 804 dev_dbg(dev, "%s - retC = %d\n", __func__, ret); 805 806 /* device reset */ 807 mce_async_out(ir, DEVICE_RESET, sizeof(DEVICE_RESET)); 808 mce_sync_in(ir, NULL, maxp); 809 810 /* get hw/sw revision? */ 811 mce_async_out(ir, GET_REVISION, sizeof(GET_REVISION)); 812 mce_sync_in(ir, NULL, maxp); 813 814 kfree(data); 815}; 816 817static void mceusb_gen2_init(struct mceusb_dev *ir) 818{ 819 int maxp = ir->len_in; 820 821 /* device reset */ 822 mce_async_out(ir, DEVICE_RESET, sizeof(DEVICE_RESET)); 823 mce_sync_in(ir, NULL, maxp); 824 825 /* get hw/sw revision? */ 826 mce_async_out(ir, GET_REVISION, sizeof(GET_REVISION)); 827 mce_sync_in(ir, NULL, maxp); 828 829 /* unknown what the next two actually return... */ 830 mce_async_out(ir, GET_UNKNOWN, sizeof(GET_UNKNOWN)); 831 mce_sync_in(ir, NULL, maxp); 832 mce_async_out(ir, GET_UNKNOWN2, sizeof(GET_UNKNOWN2)); 833 mce_sync_in(ir, NULL, maxp); 834} 835 836static void mceusb_get_parameters(struct mceusb_dev *ir) 837{ 838 int maxp = ir->len_in; 839 840 /* get the carrier and frequency */ 841 mce_async_out(ir, GET_CARRIER_FREQ, sizeof(GET_CARRIER_FREQ)); 842 mce_sync_in(ir, NULL, maxp); 843 844 /* get the transmitter bitmask */ 845 mce_async_out(ir, GET_TX_BITMASK, sizeof(GET_TX_BITMASK)); 846 mce_sync_in(ir, NULL, maxp); 847 848 /* get receiver timeout value */ 849 mce_async_out(ir, GET_RX_TIMEOUT, sizeof(GET_RX_TIMEOUT)); 850 mce_sync_in(ir, NULL, maxp); 851 852 /* get receiver sensor setting */ 853 mce_async_out(ir, GET_RX_SENSOR, sizeof(GET_RX_SENSOR)); 854 mce_sync_in(ir, NULL, maxp); 855} 856 857static struct input_dev *mceusb_init_input_dev(struct mceusb_dev *ir) 858{ 859 struct input_dev *idev; 860 struct ir_dev_props *props; 861 struct device *dev = ir->dev; 862 int ret = -ENODEV; 863 864 idev = input_allocate_device(); 865 if (!idev) { 866 dev_err(dev, "remote input dev allocation failed\n"); 867 goto idev_alloc_failed; 868 } 869 870 ret = -ENOMEM; 871 props = kzalloc(sizeof(struct ir_dev_props), GFP_KERNEL); 872 if (!props) { 873 dev_err(dev, "remote ir dev props allocation failed\n"); 874 goto props_alloc_failed; 875 } 876 877 snprintf(ir->name, sizeof(ir->name), "Media Center Ed. eHome " 878 "Infrared Remote Transceiver (%04x:%04x)", 879 le16_to_cpu(ir->usbdev->descriptor.idVendor), 880 le16_to_cpu(ir->usbdev->descriptor.idProduct)); 881 882 idev->name = ir->name; 883 usb_make_path(ir->usbdev, ir->phys, sizeof(ir->phys)); 884 strlcat(ir->phys, "/input0", sizeof(ir->phys)); 885 idev->phys = ir->phys; 886 887 props->priv = ir; 888 props->driver_type = RC_DRIVER_IR_RAW; 889 props->allowed_protos = IR_TYPE_ALL; 890 props->s_tx_mask = mceusb_set_tx_mask; 891 props->s_tx_carrier = mceusb_set_tx_carrier; 892 props->tx_ir = mceusb_tx_ir; 893 894 ir->props = props; 895 896 ret = ir_input_register(idev, RC_MAP_RC6_MCE, props, DRIVER_NAME); 897 if (ret < 0) { 898 dev_err(dev, "remote input device register failed\n"); 899 goto irdev_failed; 900 } 901 902 return idev; 903 904irdev_failed: 905 kfree(props); 906props_alloc_failed: 907 input_free_device(idev); 908idev_alloc_failed: 909 return NULL; 910} 911 912static int __devinit mceusb_dev_probe(struct usb_interface *intf, 913 const struct usb_device_id *id) 914{ 915 struct usb_device *dev = interface_to_usbdev(intf); 916 struct usb_host_interface *idesc; 917 struct usb_endpoint_descriptor *ep = NULL; 918 struct usb_endpoint_descriptor *ep_in = NULL; 919 struct usb_endpoint_descriptor *ep_out = NULL; 920 struct mceusb_dev *ir = NULL; 921 int pipe, maxp, i; 922 char buf[63], name[128] = ""; 923 bool is_gen3; 924 bool is_microsoft_gen1; 925 bool tx_mask_inverted; 926 927 dev_dbg(&intf->dev, ": %s called\n", __func__); 928 929 idesc = intf->cur_altsetting; 930 931 is_gen3 = usb_match_id(intf, gen3_list) ? 1 : 0; 932 is_microsoft_gen1 = usb_match_id(intf, microsoft_gen1_list) ? 1 : 0; 933 tx_mask_inverted = usb_match_id(intf, std_tx_mask_list) ? 0 : 1; 934 935 /* step through the endpoints to find first bulk in and out endpoint */ 936 for (i = 0; i < idesc->desc.bNumEndpoints; ++i) { 937 ep = &idesc->endpoint[i].desc; 938 939 if ((ep_in == NULL) 940 && ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK) 941 == USB_DIR_IN) 942 && (((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) 943 == USB_ENDPOINT_XFER_BULK) 944 || ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) 945 == USB_ENDPOINT_XFER_INT))) { 946 947 ep_in = ep; 948 ep_in->bmAttributes = USB_ENDPOINT_XFER_INT; 949 ep_in->bInterval = 1; 950 dev_dbg(&intf->dev, ": acceptable inbound endpoint " 951 "found\n"); 952 } 953 954 if ((ep_out == NULL) 955 && ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK) 956 == USB_DIR_OUT) 957 && (((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) 958 == USB_ENDPOINT_XFER_BULK) 959 || ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) 960 == USB_ENDPOINT_XFER_INT))) { 961 962 ep_out = ep; 963 ep_out->bmAttributes = USB_ENDPOINT_XFER_INT; 964 ep_out->bInterval = 1; 965 dev_dbg(&intf->dev, ": acceptable outbound endpoint " 966 "found\n"); 967 } 968 } 969 if (ep_in == NULL) { 970 dev_dbg(&intf->dev, ": inbound and/or endpoint not found\n"); 971 return -ENODEV; 972 } 973 974 pipe = usb_rcvintpipe(dev, ep_in->bEndpointAddress); 975 maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe)); 976 977 ir = kzalloc(sizeof(struct mceusb_dev), GFP_KERNEL); 978 if (!ir) 979 goto mem_alloc_fail; 980 981 ir->buf_in = usb_alloc_coherent(dev, maxp, GFP_ATOMIC, &ir->dma_in); 982 if (!ir->buf_in) 983 goto buf_in_alloc_fail; 984 985 ir->urb_in = usb_alloc_urb(0, GFP_KERNEL); 986 if (!ir->urb_in) 987 goto urb_in_alloc_fail; 988 989 ir->usbdev = dev; 990 ir->dev = &intf->dev; 991 ir->len_in = maxp; 992 ir->flags.microsoft_gen1 = is_microsoft_gen1; 993 ir->flags.tx_mask_inverted = tx_mask_inverted; 994 995 /* Saving usb interface data for use by the transmitter routine */ 996 ir->usb_ep_in = ep_in; 997 ir->usb_ep_out = ep_out; 998 999 if (dev->descriptor.iManufacturer 1000 && usb_string(dev, dev->descriptor.iManufacturer, 1001 buf, sizeof(buf)) > 0) 1002 strlcpy(name, buf, sizeof(name)); 1003 if (dev->descriptor.iProduct 1004 && usb_string(dev, dev->descriptor.iProduct, 1005 buf, sizeof(buf)) > 0) 1006 snprintf(name + strlen(name), sizeof(name) - strlen(name), 1007 " %s", buf); 1008 1009 ir->idev = mceusb_init_input_dev(ir); 1010 if (!ir->idev) 1011 goto input_dev_fail; 1012 1013 /* flush buffers on the device */ 1014 mce_sync_in(ir, NULL, maxp); 1015 mce_sync_in(ir, NULL, maxp); 1016 1017 /* wire up inbound data handler */ 1018 usb_fill_int_urb(ir->urb_in, dev, pipe, ir->buf_in, 1019 maxp, (usb_complete_t) mceusb_dev_recv, ir, ep_in->bInterval); 1020 ir->urb_in->transfer_dma = ir->dma_in; 1021 ir->urb_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 1022 1023 /* initialize device */ 1024 if (ir->flags.microsoft_gen1) 1025 mceusb_gen1_init(ir); 1026 else if (!is_gen3) 1027 mceusb_gen2_init(ir); 1028 1029 mceusb_get_parameters(ir); 1030 1031 mceusb_set_tx_mask(ir, MCE_DEFAULT_TX_MASK); 1032 1033 usb_set_intfdata(intf, ir); 1034 1035 dev_info(&intf->dev, "Registered %s on usb%d:%d\n", name, 1036 dev->bus->busnum, dev->devnum); 1037 1038 return 0; 1039 1040 /* Error-handling path */ 1041input_dev_fail: 1042 usb_free_urb(ir->urb_in); 1043urb_in_alloc_fail: 1044 usb_free_coherent(dev, maxp, ir->buf_in, ir->dma_in); 1045buf_in_alloc_fail: 1046 kfree(ir); 1047mem_alloc_fail: 1048 dev_err(&intf->dev, "%s: device setup failed!\n", __func__); 1049 1050 return -ENOMEM; 1051} 1052 1053 1054static void __devexit mceusb_dev_disconnect(struct usb_interface *intf) 1055{ 1056 struct usb_device *dev = interface_to_usbdev(intf); 1057 struct mceusb_dev *ir = usb_get_intfdata(intf); 1058 1059 usb_set_intfdata(intf, NULL); 1060 1061 if (!ir) 1062 return; 1063 1064 ir->usbdev = NULL; 1065 ir_input_unregister(ir->idev); 1066 usb_kill_urb(ir->urb_in); 1067 usb_free_urb(ir->urb_in); 1068 usb_free_coherent(dev, ir->len_in, ir->buf_in, ir->dma_in); 1069 1070 kfree(ir); 1071} 1072 1073static int mceusb_dev_suspend(struct usb_interface *intf, pm_message_t message) 1074{ 1075 struct mceusb_dev *ir = usb_get_intfdata(intf); 1076 dev_info(ir->dev, "suspend\n"); 1077 usb_kill_urb(ir->urb_in); 1078 return 0; 1079} 1080 1081static int mceusb_dev_resume(struct usb_interface *intf) 1082{ 1083 struct mceusb_dev *ir = usb_get_intfdata(intf); 1084 dev_info(ir->dev, "resume\n"); 1085 if (usb_submit_urb(ir->urb_in, GFP_ATOMIC)) 1086 return -EIO; 1087 return 0; 1088} 1089 1090static struct usb_driver mceusb_dev_driver = { 1091 .name = DRIVER_NAME, 1092 .probe = mceusb_dev_probe, 1093 .disconnect = mceusb_dev_disconnect, 1094 .suspend = mceusb_dev_suspend, 1095 .resume = mceusb_dev_resume, 1096 .reset_resume = mceusb_dev_resume, 1097 .id_table = mceusb_dev_table 1098}; 1099 1100static int __init mceusb_dev_init(void) 1101{ 1102 int ret; 1103 1104 ret = usb_register(&mceusb_dev_driver); 1105 if (ret < 0) 1106 printk(KERN_ERR DRIVER_NAME 1107 ": usb register failed, result = %d\n", ret); 1108 1109 return ret; 1110} 1111 1112static void __exit mceusb_dev_exit(void) 1113{ 1114 usb_deregister(&mceusb_dev_driver); 1115} 1116 1117module_init(mceusb_dev_init); 1118module_exit(mceusb_dev_exit); 1119 1120MODULE_DESCRIPTION(DRIVER_DESC); 1121MODULE_AUTHOR(DRIVER_AUTHOR); 1122MODULE_LICENSE("GPL"); 1123MODULE_DEVICE_TABLE(usb, mceusb_dev_table); 1124 1125module_param(debug, bool, S_IRUGO | S_IWUSR); 1126MODULE_PARM_DESC(debug, "Debug enabled or not"); 1127