1 /* 2 * Streamzap Remote Control driver 3 * 4 * Copyright (c) 2005 Christoph Bartelmus <lirc@bartelmus.de> 5 * Copyright (c) 2010 Jarod Wilson <jarod@wilsonet.com> 6 * 7 * This driver was based on the work of Greg Wickham and Adrian 8 * Dewhurst. It was substantially rewritten to support correct signal 9 * gaps and now maintains a delay buffer, which is used to present 10 * consistent timing behaviour to user space applications. Without the 11 * delay buffer an ugly hack would be required in lircd, which can 12 * cause sluggish signal decoding in certain situations. 13 * 14 * Ported to in-kernel ir-core interface by Jarod Wilson 15 * 16 * This driver is based on the USB skeleton driver packaged with the 17 * kernel; copyright (C) 2001-2003 Greg Kroah-Hartman (greg@kroah.com) 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 #include <linux/device.h> 35 #include <linux/module.h> 36 #include <linux/slab.h> 37 #include <linux/usb.h> 38 #include <linux/usb/input.h> 39 #include <media/rc-core.h> 40 41 #define DRIVER_VERSION "1.61" 42 #define DRIVER_NAME "streamzap" 43 #define DRIVER_DESC "Streamzap Remote Control driver" 44 45 #define USB_STREAMZAP_VENDOR_ID 0x0e9c 46 #define USB_STREAMZAP_PRODUCT_ID 0x0000 47 48 /* table of devices that work with this driver */ 49 static struct usb_device_id streamzap_table[] = { 50 /* Streamzap Remote Control */ 51 { USB_DEVICE(USB_STREAMZAP_VENDOR_ID, USB_STREAMZAP_PRODUCT_ID) }, 52 /* Terminating entry */ 53 { } 54 }; 55 56 MODULE_DEVICE_TABLE(usb, streamzap_table); 57 58 #define SZ_PULSE_MASK 0xf0 59 #define SZ_SPACE_MASK 0x0f 60 #define SZ_TIMEOUT 0xff 61 #define SZ_RESOLUTION 256 62 63 /* number of samples buffered */ 64 #define SZ_BUF_LEN 128 65 66 /* from ir-rc5-sz-decoder.c */ 67 #ifdef CONFIG_IR_RC5_SZ_DECODER_MODULE 68 #define load_rc5_sz_decode() request_module("ir-rc5-sz-decoder") 69 #else 70 #define load_rc5_sz_decode() {} 71 #endif 72 73 enum StreamzapDecoderState { 74 PulseSpace, 75 FullPulse, 76 FullSpace, 77 IgnorePulse 78 }; 79 80 /* structure to hold our device specific stuff */ 81 struct streamzap_ir { 82 /* ir-core */ 83 struct rc_dev *rdev; 84 85 /* core device info */ 86 struct device *dev; 87 88 /* usb */ 89 struct usb_device *usbdev; 90 struct usb_interface *interface; 91 struct usb_endpoint_descriptor *endpoint; 92 struct urb *urb_in; 93 94 /* buffer & dma */ 95 unsigned char *buf_in; 96 dma_addr_t dma_in; 97 unsigned int buf_in_len; 98 99 /* track what state we're in */ 100 enum StreamzapDecoderState decoder_state; 101 /* tracks whether we are currently receiving some signal */ 102 bool idle; 103 /* sum of signal lengths received since signal start */ 104 unsigned long sum; 105 /* start time of signal; necessary for gap tracking */ 106 struct timeval signal_last; 107 struct timeval signal_start; 108 bool timeout_enabled; 109 110 char name[128]; 111 char phys[64]; 112 }; 113 114 115 /* local function prototypes */ 116 static int streamzap_probe(struct usb_interface *interface, 117 const struct usb_device_id *id); 118 static void streamzap_disconnect(struct usb_interface *interface); 119 static void streamzap_callback(struct urb *urb); 120 static int streamzap_suspend(struct usb_interface *intf, pm_message_t message); 121 static int streamzap_resume(struct usb_interface *intf); 122 123 /* usb specific object needed to register this driver with the usb subsystem */ 124 static struct usb_driver streamzap_driver = { 125 .name = DRIVER_NAME, 126 .probe = streamzap_probe, 127 .disconnect = streamzap_disconnect, 128 .suspend = streamzap_suspend, 129 .resume = streamzap_resume, 130 .id_table = streamzap_table, 131 }; 132 133 static void sz_push(struct streamzap_ir *sz, struct ir_raw_event rawir) 134 { 135 dev_dbg(sz->dev, "Storing %s with duration %u us\n", 136 (rawir.pulse ? "pulse" : "space"), rawir.duration); 137 ir_raw_event_store_with_filter(sz->rdev, &rawir); 138 } 139 140 static void sz_push_full_pulse(struct streamzap_ir *sz, 141 unsigned char value) 142 { 143 DEFINE_IR_RAW_EVENT(rawir); 144 145 if (sz->idle) { 146 long deltv; 147 148 sz->signal_last = sz->signal_start; 149 do_gettimeofday(&sz->signal_start); 150 151 deltv = sz->signal_start.tv_sec - sz->signal_last.tv_sec; 152 rawir.pulse = false; 153 if (deltv > 15) { 154 /* really long time */ 155 rawir.duration = IR_MAX_DURATION; 156 } else { 157 rawir.duration = (int)(deltv * 1000000 + 158 sz->signal_start.tv_usec - 159 sz->signal_last.tv_usec); 160 rawir.duration -= sz->sum; 161 rawir.duration = US_TO_NS(rawir.duration); 162 rawir.duration &= IR_MAX_DURATION; 163 } 164 sz_push(sz, rawir); 165 166 sz->idle = false; 167 sz->sum = 0; 168 } 169 170 rawir.pulse = true; 171 rawir.duration = ((int) value) * SZ_RESOLUTION; 172 rawir.duration += SZ_RESOLUTION / 2; 173 sz->sum += rawir.duration; 174 rawir.duration = US_TO_NS(rawir.duration); 175 rawir.duration &= IR_MAX_DURATION; 176 sz_push(sz, rawir); 177 } 178 179 static void sz_push_half_pulse(struct streamzap_ir *sz, 180 unsigned char value) 181 { 182 sz_push_full_pulse(sz, (value & SZ_PULSE_MASK) >> 4); 183 } 184 185 static void sz_push_full_space(struct streamzap_ir *sz, 186 unsigned char value) 187 { 188 DEFINE_IR_RAW_EVENT(rawir); 189 190 rawir.pulse = false; 191 rawir.duration = ((int) value) * SZ_RESOLUTION; 192 rawir.duration += SZ_RESOLUTION / 2; 193 sz->sum += rawir.duration; 194 rawir.duration = US_TO_NS(rawir.duration); 195 sz_push(sz, rawir); 196 } 197 198 static void sz_push_half_space(struct streamzap_ir *sz, 199 unsigned long value) 200 { 201 sz_push_full_space(sz, value & SZ_SPACE_MASK); 202 } 203 204 /** 205 * streamzap_callback - usb IRQ handler callback 206 * 207 * This procedure is invoked on reception of data from 208 * the usb remote. 209 */ 210 static void streamzap_callback(struct urb *urb) 211 { 212 struct streamzap_ir *sz; 213 unsigned int i; 214 int len; 215 216 if (!urb) 217 return; 218 219 sz = urb->context; 220 len = urb->actual_length; 221 222 switch (urb->status) { 223 case -ECONNRESET: 224 case -ENOENT: 225 case -ESHUTDOWN: 226 /* 227 * this urb is terminated, clean up. 228 * sz might already be invalid at this point 229 */ 230 dev_err(sz->dev, "urb terminated, status: %d\n", urb->status); 231 return; 232 default: 233 break; 234 } 235 236 dev_dbg(sz->dev, "%s: received urb, len %d\n", __func__, len); 237 for (i = 0; i < len; i++) { 238 dev_dbg(sz->dev, "sz->buf_in[%d]: %x\n", 239 i, (unsigned char)sz->buf_in[i]); 240 switch (sz->decoder_state) { 241 case PulseSpace: 242 if ((sz->buf_in[i] & SZ_PULSE_MASK) == 243 SZ_PULSE_MASK) { 244 sz->decoder_state = FullPulse; 245 continue; 246 } else if ((sz->buf_in[i] & SZ_SPACE_MASK) 247 == SZ_SPACE_MASK) { 248 sz_push_half_pulse(sz, sz->buf_in[i]); 249 sz->decoder_state = FullSpace; 250 continue; 251 } else { 252 sz_push_half_pulse(sz, sz->buf_in[i]); 253 sz_push_half_space(sz, sz->buf_in[i]); 254 } 255 break; 256 case FullPulse: 257 sz_push_full_pulse(sz, sz->buf_in[i]); 258 sz->decoder_state = IgnorePulse; 259 break; 260 case FullSpace: 261 if (sz->buf_in[i] == SZ_TIMEOUT) { 262 DEFINE_IR_RAW_EVENT(rawir); 263 264 rawir.pulse = false; 265 rawir.duration = sz->rdev->timeout; 266 sz->idle = true; 267 if (sz->timeout_enabled) 268 sz_push(sz, rawir); 269 ir_raw_event_handle(sz->rdev); 270 ir_raw_event_reset(sz->rdev); 271 } else { 272 sz_push_full_space(sz, sz->buf_in[i]); 273 } 274 sz->decoder_state = PulseSpace; 275 break; 276 case IgnorePulse: 277 if ((sz->buf_in[i] & SZ_SPACE_MASK) == 278 SZ_SPACE_MASK) { 279 sz->decoder_state = FullSpace; 280 continue; 281 } 282 sz_push_half_space(sz, sz->buf_in[i]); 283 sz->decoder_state = PulseSpace; 284 break; 285 } 286 } 287 288 ir_raw_event_handle(sz->rdev); 289 usb_submit_urb(urb, GFP_ATOMIC); 290 291 return; 292 } 293 294 static struct rc_dev *streamzap_init_rc_dev(struct streamzap_ir *sz) 295 { 296 struct rc_dev *rdev; 297 struct device *dev = sz->dev; 298 int ret; 299 300 rdev = rc_allocate_device(); 301 if (!rdev) { 302 dev_err(dev, "remote dev allocation failed\n"); 303 goto out; 304 } 305 306 snprintf(sz->name, sizeof(sz->name), "Streamzap PC Remote Infrared " 307 "Receiver (%04x:%04x)", 308 le16_to_cpu(sz->usbdev->descriptor.idVendor), 309 le16_to_cpu(sz->usbdev->descriptor.idProduct)); 310 usb_make_path(sz->usbdev, sz->phys, sizeof(sz->phys)); 311 strlcat(sz->phys, "/input0", sizeof(sz->phys)); 312 313 rdev->input_name = sz->name; 314 rdev->input_phys = sz->phys; 315 usb_to_input_id(sz->usbdev, &rdev->input_id); 316 rdev->dev.parent = dev; 317 rdev->priv = sz; 318 rdev->driver_type = RC_DRIVER_IR_RAW; 319 rc_set_allowed_protocols(rdev, RC_BIT_ALL); 320 rdev->driver_name = DRIVER_NAME; 321 rdev->map_name = RC_MAP_STREAMZAP; 322 323 ret = rc_register_device(rdev); 324 if (ret < 0) { 325 dev_err(dev, "remote input device register failed\n"); 326 goto out; 327 } 328 329 return rdev; 330 331 out: 332 rc_free_device(rdev); 333 return NULL; 334 } 335 336 /** 337 * streamzap_probe 338 * 339 * Called by usb-core to associated with a candidate device 340 * On any failure the return value is the ERROR 341 * On success return 0 342 */ 343 static int streamzap_probe(struct usb_interface *intf, 344 const struct usb_device_id *id) 345 { 346 struct usb_device *usbdev = interface_to_usbdev(intf); 347 struct usb_host_interface *iface_host; 348 struct streamzap_ir *sz = NULL; 349 char buf[63], name[128] = ""; 350 int retval = -ENOMEM; 351 int pipe, maxp; 352 353 /* Allocate space for device driver specific data */ 354 sz = kzalloc(sizeof(struct streamzap_ir), GFP_KERNEL); 355 if (!sz) 356 return -ENOMEM; 357 358 sz->usbdev = usbdev; 359 sz->interface = intf; 360 361 /* Check to ensure endpoint information matches requirements */ 362 iface_host = intf->cur_altsetting; 363 364 if (iface_host->desc.bNumEndpoints != 1) { 365 dev_err(&intf->dev, "%s: Unexpected desc.bNumEndpoints (%d)\n", 366 __func__, iface_host->desc.bNumEndpoints); 367 retval = -ENODEV; 368 goto free_sz; 369 } 370 371 sz->endpoint = &(iface_host->endpoint[0].desc); 372 if ((sz->endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) 373 != USB_DIR_IN) { 374 dev_err(&intf->dev, "%s: endpoint doesn't match input device " 375 "02%02x\n", __func__, sz->endpoint->bEndpointAddress); 376 retval = -ENODEV; 377 goto free_sz; 378 } 379 380 if ((sz->endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) 381 != USB_ENDPOINT_XFER_INT) { 382 dev_err(&intf->dev, "%s: endpoint attributes don't match xfer " 383 "02%02x\n", __func__, sz->endpoint->bmAttributes); 384 retval = -ENODEV; 385 goto free_sz; 386 } 387 388 pipe = usb_rcvintpipe(usbdev, sz->endpoint->bEndpointAddress); 389 maxp = usb_maxpacket(usbdev, pipe, usb_pipeout(pipe)); 390 391 if (maxp == 0) { 392 dev_err(&intf->dev, "%s: endpoint Max Packet Size is 0!?!\n", 393 __func__); 394 retval = -ENODEV; 395 goto free_sz; 396 } 397 398 /* Allocate the USB buffer and IRQ URB */ 399 sz->buf_in = usb_alloc_coherent(usbdev, maxp, GFP_ATOMIC, &sz->dma_in); 400 if (!sz->buf_in) 401 goto free_sz; 402 403 sz->urb_in = usb_alloc_urb(0, GFP_KERNEL); 404 if (!sz->urb_in) 405 goto free_buf_in; 406 407 sz->dev = &intf->dev; 408 sz->buf_in_len = maxp; 409 410 if (usbdev->descriptor.iManufacturer 411 && usb_string(usbdev, usbdev->descriptor.iManufacturer, 412 buf, sizeof(buf)) > 0) 413 strlcpy(name, buf, sizeof(name)); 414 415 if (usbdev->descriptor.iProduct 416 && usb_string(usbdev, usbdev->descriptor.iProduct, 417 buf, sizeof(buf)) > 0) 418 snprintf(name + strlen(name), sizeof(name) - strlen(name), 419 " %s", buf); 420 421 sz->rdev = streamzap_init_rc_dev(sz); 422 if (!sz->rdev) 423 goto rc_dev_fail; 424 425 sz->idle = true; 426 sz->decoder_state = PulseSpace; 427 /* FIXME: don't yet have a way to set this */ 428 sz->timeout_enabled = true; 429 sz->rdev->timeout = ((US_TO_NS(SZ_TIMEOUT * SZ_RESOLUTION) & 430 IR_MAX_DURATION) | 0x03000000); 431 #if 0 432 /* not yet supported, depends on patches from maxim */ 433 /* see also: LIRC_GET_REC_RESOLUTION and LIRC_SET_REC_TIMEOUT */ 434 sz->min_timeout = US_TO_NS(SZ_TIMEOUT * SZ_RESOLUTION); 435 sz->max_timeout = US_TO_NS(SZ_TIMEOUT * SZ_RESOLUTION); 436 #endif 437 438 do_gettimeofday(&sz->signal_start); 439 440 /* Complete final initialisations */ 441 usb_fill_int_urb(sz->urb_in, usbdev, pipe, sz->buf_in, 442 maxp, (usb_complete_t)streamzap_callback, 443 sz, sz->endpoint->bInterval); 444 sz->urb_in->transfer_dma = sz->dma_in; 445 sz->urb_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 446 447 usb_set_intfdata(intf, sz); 448 449 if (usb_submit_urb(sz->urb_in, GFP_ATOMIC)) 450 dev_err(sz->dev, "urb submit failed\n"); 451 452 dev_info(sz->dev, "Registered %s on usb%d:%d\n", name, 453 usbdev->bus->busnum, usbdev->devnum); 454 455 /* Load the streamzap not-quite-rc5 decoder too */ 456 load_rc5_sz_decode(); 457 458 return 0; 459 460 rc_dev_fail: 461 usb_free_urb(sz->urb_in); 462 free_buf_in: 463 usb_free_coherent(usbdev, maxp, sz->buf_in, sz->dma_in); 464 free_sz: 465 kfree(sz); 466 467 return retval; 468 } 469 470 /** 471 * streamzap_disconnect 472 * 473 * Called by the usb core when the device is removed from the system. 474 * 475 * This routine guarantees that the driver will not submit any more urbs 476 * by clearing dev->usbdev. It is also supposed to terminate any currently 477 * active urbs. Unfortunately, usb_bulk_msg(), used in streamzap_read(), 478 * does not provide any way to do this. 479 */ 480 static void streamzap_disconnect(struct usb_interface *interface) 481 { 482 struct streamzap_ir *sz = usb_get_intfdata(interface); 483 struct usb_device *usbdev = interface_to_usbdev(interface); 484 485 usb_set_intfdata(interface, NULL); 486 487 if (!sz) 488 return; 489 490 sz->usbdev = NULL; 491 rc_unregister_device(sz->rdev); 492 usb_kill_urb(sz->urb_in); 493 usb_free_urb(sz->urb_in); 494 usb_free_coherent(usbdev, sz->buf_in_len, sz->buf_in, sz->dma_in); 495 496 kfree(sz); 497 } 498 499 static int streamzap_suspend(struct usb_interface *intf, pm_message_t message) 500 { 501 struct streamzap_ir *sz = usb_get_intfdata(intf); 502 503 usb_kill_urb(sz->urb_in); 504 505 return 0; 506 } 507 508 static int streamzap_resume(struct usb_interface *intf) 509 { 510 struct streamzap_ir *sz = usb_get_intfdata(intf); 511 512 if (usb_submit_urb(sz->urb_in, GFP_ATOMIC)) { 513 dev_err(sz->dev, "Error sumbiting urb\n"); 514 return -EIO; 515 } 516 517 return 0; 518 } 519 520 module_usb_driver(streamzap_driver); 521 522 MODULE_AUTHOR("Jarod Wilson <jarod@wilsonet.com>"); 523 MODULE_DESCRIPTION(DRIVER_DESC); 524 MODULE_LICENSE("GPL"); 525