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