2 * Streamzap Remote Control driver
4 * Copyright (c) 2005 Christoph Bartelmus <lirc@bartelmus.de>
5 * Copyright (c) 2010 Jarod Wilson <jarod@wilsonet.com>
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.
14 * Ported to in-kernel ir-core interface by Jarod Wilson
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)
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.
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.
30 #include <linux/device.h>
31 #include <linux/module.h>
32 #include <linux/slab.h>
33 #include <linux/ktime.h>
34 #include <linux/usb.h>
35 #include <linux/usb/input.h>
36 #include <media/rc-core.h>
38 #define DRIVER_VERSION "1.61"
39 #define DRIVER_NAME "streamzap"
40 #define DRIVER_DESC "Streamzap Remote Control driver"
42 #define USB_STREAMZAP_VENDOR_ID 0x0e9c
43 #define USB_STREAMZAP_PRODUCT_ID 0x0000
45 /* table of devices that work with this driver */
46 static const struct usb_device_id streamzap_table[] = {
47 /* Streamzap Remote Control */
48 { USB_DEVICE(USB_STREAMZAP_VENDOR_ID, USB_STREAMZAP_PRODUCT_ID) },
49 /* Terminating entry */
53 MODULE_DEVICE_TABLE(usb, streamzap_table);
55 #define SZ_PULSE_MASK 0xf0
56 #define SZ_SPACE_MASK 0x0f
57 #define SZ_TIMEOUT 0xff
58 #define SZ_RESOLUTION 256
60 /* number of samples buffered */
61 #define SZ_BUF_LEN 128
63 enum StreamzapDecoderState {
70 /* structure to hold our device specific stuff */
75 /* core device info */
79 struct usb_device *usbdev;
80 struct usb_interface *interface;
81 struct usb_endpoint_descriptor *endpoint;
85 unsigned char *buf_in;
87 unsigned int buf_in_len;
89 /* track what state we're in */
90 enum StreamzapDecoderState decoder_state;
91 /* tracks whether we are currently receiving some signal */
93 /* sum of signal lengths received since signal start */
95 /* start time of signal; necessary for gap tracking */
105 /* local function prototypes */
106 static int streamzap_probe(struct usb_interface *interface,
107 const struct usb_device_id *id);
108 static void streamzap_disconnect(struct usb_interface *interface);
109 static void streamzap_callback(struct urb *urb);
110 static int streamzap_suspend(struct usb_interface *intf, pm_message_t message);
111 static int streamzap_resume(struct usb_interface *intf);
113 /* usb specific object needed to register this driver with the usb subsystem */
114 static struct usb_driver streamzap_driver = {
116 .probe = streamzap_probe,
117 .disconnect = streamzap_disconnect,
118 .suspend = streamzap_suspend,
119 .resume = streamzap_resume,
120 .id_table = streamzap_table,
123 static void sz_push(struct streamzap_ir *sz, struct ir_raw_event rawir)
125 dev_dbg(sz->dev, "Storing %s with duration %u us\n",
126 (rawir.pulse ? "pulse" : "space"), rawir.duration);
127 ir_raw_event_store_with_filter(sz->rdev, &rawir);
130 static void sz_push_full_pulse(struct streamzap_ir *sz,
133 DEFINE_IR_RAW_EVENT(rawir);
138 sz->signal_last = sz->signal_start;
139 sz->signal_start = ktime_get_real();
141 delta = ktime_us_delta(sz->signal_start, sz->signal_last);
143 if (delta > (15 * USEC_PER_SEC)) {
144 /* really long time */
145 rawir.duration = IR_MAX_DURATION;
147 rawir.duration = delta;
148 rawir.duration -= sz->sum;
149 rawir.duration = US_TO_NS(rawir.duration);
150 rawir.duration = (rawir.duration > IR_MAX_DURATION) ?
151 IR_MAX_DURATION : rawir.duration;
160 rawir.duration = ((int) value) * SZ_RESOLUTION;
161 rawir.duration += SZ_RESOLUTION / 2;
162 sz->sum += rawir.duration;
163 rawir.duration = US_TO_NS(rawir.duration);
164 rawir.duration = (rawir.duration > IR_MAX_DURATION) ?
165 IR_MAX_DURATION : rawir.duration;
169 static void sz_push_half_pulse(struct streamzap_ir *sz,
172 sz_push_full_pulse(sz, (value & SZ_PULSE_MASK) >> 4);
175 static void sz_push_full_space(struct streamzap_ir *sz,
178 DEFINE_IR_RAW_EVENT(rawir);
181 rawir.duration = ((int) value) * SZ_RESOLUTION;
182 rawir.duration += SZ_RESOLUTION / 2;
183 sz->sum += rawir.duration;
184 rawir.duration = US_TO_NS(rawir.duration);
188 static void sz_push_half_space(struct streamzap_ir *sz,
191 sz_push_full_space(sz, value & SZ_SPACE_MASK);
195 * streamzap_callback - usb IRQ handler callback
197 * This procedure is invoked on reception of data from
200 static void streamzap_callback(struct urb *urb)
202 struct streamzap_ir *sz;
210 len = urb->actual_length;
212 switch (urb->status) {
217 * this urb is terminated, clean up.
218 * sz might already be invalid at this point
220 dev_err(sz->dev, "urb terminated, status: %d\n", urb->status);
226 dev_dbg(sz->dev, "%s: received urb, len %d\n", __func__, len);
227 for (i = 0; i < len; i++) {
228 dev_dbg(sz->dev, "sz->buf_in[%d]: %x\n",
229 i, (unsigned char)sz->buf_in[i]);
230 switch (sz->decoder_state) {
232 if ((sz->buf_in[i] & SZ_PULSE_MASK) ==
234 sz->decoder_state = FullPulse;
236 } else if ((sz->buf_in[i] & SZ_SPACE_MASK)
238 sz_push_half_pulse(sz, sz->buf_in[i]);
239 sz->decoder_state = FullSpace;
242 sz_push_half_pulse(sz, sz->buf_in[i]);
243 sz_push_half_space(sz, sz->buf_in[i]);
247 sz_push_full_pulse(sz, sz->buf_in[i]);
248 sz->decoder_state = IgnorePulse;
251 if (sz->buf_in[i] == SZ_TIMEOUT) {
252 DEFINE_IR_RAW_EVENT(rawir);
255 rawir.duration = sz->rdev->timeout;
257 if (sz->timeout_enabled)
259 ir_raw_event_handle(sz->rdev);
260 ir_raw_event_reset(sz->rdev);
262 sz_push_full_space(sz, sz->buf_in[i]);
264 sz->decoder_state = PulseSpace;
267 if ((sz->buf_in[i] & SZ_SPACE_MASK) ==
269 sz->decoder_state = FullSpace;
272 sz_push_half_space(sz, sz->buf_in[i]);
273 sz->decoder_state = PulseSpace;
278 ir_raw_event_handle(sz->rdev);
279 usb_submit_urb(urb, GFP_ATOMIC);
284 static struct rc_dev *streamzap_init_rc_dev(struct streamzap_ir *sz)
287 struct device *dev = sz->dev;
290 rdev = rc_allocate_device(RC_DRIVER_IR_RAW);
292 dev_err(dev, "remote dev allocation failed\n");
296 snprintf(sz->name, sizeof(sz->name), "Streamzap PC Remote Infrared Receiver (%04x:%04x)",
297 le16_to_cpu(sz->usbdev->descriptor.idVendor),
298 le16_to_cpu(sz->usbdev->descriptor.idProduct));
299 usb_make_path(sz->usbdev, sz->phys, sizeof(sz->phys));
300 strlcat(sz->phys, "/input0", sizeof(sz->phys));
302 rdev->device_name = sz->name;
303 rdev->input_phys = sz->phys;
304 usb_to_input_id(sz->usbdev, &rdev->input_id);
305 rdev->dev.parent = dev;
307 rdev->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;
308 rdev->driver_name = DRIVER_NAME;
309 rdev->map_name = RC_MAP_STREAMZAP;
311 ret = rc_register_device(rdev);
313 dev_err(dev, "remote input device register failed\n");
320 rc_free_device(rdev);
327 * Called by usb-core to associated with a candidate device
328 * On any failure the return value is the ERROR
329 * On success return 0
331 static int streamzap_probe(struct usb_interface *intf,
332 const struct usb_device_id *id)
334 struct usb_device *usbdev = interface_to_usbdev(intf);
335 struct usb_host_interface *iface_host;
336 struct streamzap_ir *sz = NULL;
337 char buf[63], name[128] = "";
338 int retval = -ENOMEM;
341 /* Allocate space for device driver specific data */
342 sz = kzalloc(sizeof(struct streamzap_ir), GFP_KERNEL);
347 sz->interface = intf;
349 /* Check to ensure endpoint information matches requirements */
350 iface_host = intf->cur_altsetting;
352 if (iface_host->desc.bNumEndpoints != 1) {
353 dev_err(&intf->dev, "%s: Unexpected desc.bNumEndpoints (%d)\n",
354 __func__, iface_host->desc.bNumEndpoints);
359 sz->endpoint = &(iface_host->endpoint[0].desc);
360 if (!usb_endpoint_dir_in(sz->endpoint)) {
361 dev_err(&intf->dev, "%s: endpoint doesn't match input device 02%02x\n",
362 __func__, sz->endpoint->bEndpointAddress);
367 if (!usb_endpoint_xfer_int(sz->endpoint)) {
368 dev_err(&intf->dev, "%s: endpoint attributes don't match xfer 02%02x\n",
369 __func__, sz->endpoint->bmAttributes);
374 pipe = usb_rcvintpipe(usbdev, sz->endpoint->bEndpointAddress);
375 maxp = usb_maxpacket(usbdev, pipe, usb_pipeout(pipe));
378 dev_err(&intf->dev, "%s: endpoint Max Packet Size is 0!?!\n",
384 /* Allocate the USB buffer and IRQ URB */
385 sz->buf_in = usb_alloc_coherent(usbdev, maxp, GFP_ATOMIC, &sz->dma_in);
389 sz->urb_in = usb_alloc_urb(0, GFP_KERNEL);
393 sz->dev = &intf->dev;
394 sz->buf_in_len = maxp;
396 if (usbdev->descriptor.iManufacturer
397 && usb_string(usbdev, usbdev->descriptor.iManufacturer,
398 buf, sizeof(buf)) > 0)
399 strlcpy(name, buf, sizeof(name));
401 if (usbdev->descriptor.iProduct
402 && usb_string(usbdev, usbdev->descriptor.iProduct,
403 buf, sizeof(buf)) > 0)
404 snprintf(name + strlen(name), sizeof(name) - strlen(name),
407 sz->rdev = streamzap_init_rc_dev(sz);
412 sz->decoder_state = PulseSpace;
413 /* FIXME: don't yet have a way to set this */
414 sz->timeout_enabled = true;
415 sz->rdev->timeout = ((US_TO_NS(SZ_TIMEOUT * SZ_RESOLUTION) &
416 IR_MAX_DURATION) | 0x03000000);
418 /* not yet supported, depends on patches from maxim */
419 /* see also: LIRC_GET_REC_RESOLUTION and LIRC_SET_REC_TIMEOUT */
420 sz->min_timeout = US_TO_NS(SZ_TIMEOUT * SZ_RESOLUTION);
421 sz->max_timeout = US_TO_NS(SZ_TIMEOUT * SZ_RESOLUTION);
424 sz->signal_start = ktime_get_real();
426 /* Complete final initialisations */
427 usb_fill_int_urb(sz->urb_in, usbdev, pipe, sz->buf_in,
428 maxp, (usb_complete_t)streamzap_callback,
429 sz, sz->endpoint->bInterval);
430 sz->urb_in->transfer_dma = sz->dma_in;
431 sz->urb_in->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
433 usb_set_intfdata(intf, sz);
435 if (usb_submit_urb(sz->urb_in, GFP_ATOMIC))
436 dev_err(sz->dev, "urb submit failed\n");
438 dev_info(sz->dev, "Registered %s on usb%d:%d\n", name,
439 usbdev->bus->busnum, usbdev->devnum);
444 usb_free_urb(sz->urb_in);
446 usb_free_coherent(usbdev, maxp, sz->buf_in, sz->dma_in);
454 * streamzap_disconnect
456 * Called by the usb core when the device is removed from the system.
458 * This routine guarantees that the driver will not submit any more urbs
459 * by clearing dev->usbdev. It is also supposed to terminate any currently
460 * active urbs. Unfortunately, usb_bulk_msg(), used in streamzap_read(),
461 * does not provide any way to do this.
463 static void streamzap_disconnect(struct usb_interface *interface)
465 struct streamzap_ir *sz = usb_get_intfdata(interface);
466 struct usb_device *usbdev = interface_to_usbdev(interface);
468 usb_set_intfdata(interface, NULL);
474 rc_unregister_device(sz->rdev);
475 usb_kill_urb(sz->urb_in);
476 usb_free_urb(sz->urb_in);
477 usb_free_coherent(usbdev, sz->buf_in_len, sz->buf_in, sz->dma_in);
482 static int streamzap_suspend(struct usb_interface *intf, pm_message_t message)
484 struct streamzap_ir *sz = usb_get_intfdata(intf);
486 usb_kill_urb(sz->urb_in);
491 static int streamzap_resume(struct usb_interface *intf)
493 struct streamzap_ir *sz = usb_get_intfdata(intf);
495 if (usb_submit_urb(sz->urb_in, GFP_ATOMIC)) {
496 dev_err(sz->dev, "Error submitting urb\n");
503 module_usb_driver(streamzap_driver);
505 MODULE_AUTHOR("Jarod Wilson <jarod@wilsonet.com>");
506 MODULE_DESCRIPTION(DRIVER_DESC);
507 MODULE_LICENSE("GPL");