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.
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
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>
41 #define DRIVER_VERSION "1.61"
42 #define DRIVER_NAME "streamzap"
43 #define DRIVER_DESC "Streamzap Remote Control driver"
45 #define USB_STREAMZAP_VENDOR_ID 0x0e9c
46 #define USB_STREAMZAP_PRODUCT_ID 0x0000
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 */
56 MODULE_DEVICE_TABLE(usb
, streamzap_table
);
58 #define SZ_PULSE_MASK 0xf0
59 #define SZ_SPACE_MASK 0x0f
60 #define SZ_TIMEOUT 0xff
61 #define SZ_RESOLUTION 256
63 /* number of samples buffered */
64 #define SZ_BUF_LEN 128
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")
70 #define load_rc5_sz_decode() {}
73 enum StreamzapDecoderState
{
80 /* structure to hold our device specific stuff */
85 /* core device info */
89 struct usb_device
*usbdev
;
90 struct usb_interface
*interface
;
91 struct usb_endpoint_descriptor
*endpoint
;
95 unsigned char *buf_in
;
97 unsigned int buf_in_len
;
99 /* track what state we're in */
100 enum StreamzapDecoderState decoder_state
;
101 /* tracks whether we are currently receiving some signal */
103 /* sum of signal lengths received since signal start */
105 /* start time of signal; necessary for gap tracking */
106 struct timeval signal_last
;
107 struct timeval signal_start
;
108 bool timeout_enabled
;
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
);
123 /* usb specific object needed to register this driver with the usb subsystem */
124 static struct usb_driver streamzap_driver
= {
126 .probe
= streamzap_probe
,
127 .disconnect
= streamzap_disconnect
,
128 .suspend
= streamzap_suspend
,
129 .resume
= streamzap_resume
,
130 .id_table
= streamzap_table
,
133 static void sz_push(struct streamzap_ir
*sz
, struct ir_raw_event rawir
)
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
);
140 static void sz_push_full_pulse(struct streamzap_ir
*sz
,
143 DEFINE_IR_RAW_EVENT(rawir
);
148 sz
->signal_last
= sz
->signal_start
;
149 do_gettimeofday(&sz
->signal_start
);
151 deltv
= sz
->signal_start
.tv_sec
- sz
->signal_last
.tv_sec
;
154 /* really long time */
155 rawir
.duration
= IR_MAX_DURATION
;
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
;
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
;
179 static void sz_push_half_pulse(struct streamzap_ir
*sz
,
182 sz_push_full_pulse(sz
, (value
& SZ_PULSE_MASK
) >> 4);
185 static void sz_push_full_space(struct streamzap_ir
*sz
,
188 DEFINE_IR_RAW_EVENT(rawir
);
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
);
198 static void sz_push_half_space(struct streamzap_ir
*sz
,
201 sz_push_full_space(sz
, value
& SZ_SPACE_MASK
);
205 * streamzap_callback - usb IRQ handler callback
207 * This procedure is invoked on reception of data from
210 static void streamzap_callback(struct urb
*urb
)
212 struct streamzap_ir
*sz
;
220 len
= urb
->actual_length
;
222 switch (urb
->status
) {
227 * this urb is terminated, clean up.
228 * sz might already be invalid at this point
230 dev_err(sz
->dev
, "urb terminated, status: %d\n", urb
->status
);
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
) {
242 if ((sz
->buf_in
[i
] & SZ_PULSE_MASK
) ==
244 sz
->decoder_state
= FullPulse
;
246 } else if ((sz
->buf_in
[i
] & SZ_SPACE_MASK
)
248 sz_push_half_pulse(sz
, sz
->buf_in
[i
]);
249 sz
->decoder_state
= FullSpace
;
252 sz_push_half_pulse(sz
, sz
->buf_in
[i
]);
253 sz_push_half_space(sz
, sz
->buf_in
[i
]);
257 sz_push_full_pulse(sz
, sz
->buf_in
[i
]);
258 sz
->decoder_state
= IgnorePulse
;
261 if (sz
->buf_in
[i
] == SZ_TIMEOUT
) {
262 DEFINE_IR_RAW_EVENT(rawir
);
265 rawir
.duration
= sz
->rdev
->timeout
;
267 if (sz
->timeout_enabled
)
269 ir_raw_event_handle(sz
->rdev
);
270 ir_raw_event_reset(sz
->rdev
);
272 sz_push_full_space(sz
, sz
->buf_in
[i
]);
274 sz
->decoder_state
= PulseSpace
;
277 if ((sz
->buf_in
[i
] & SZ_SPACE_MASK
) ==
279 sz
->decoder_state
= FullSpace
;
282 sz_push_half_space(sz
, sz
->buf_in
[i
]);
283 sz
->decoder_state
= PulseSpace
;
288 ir_raw_event_handle(sz
->rdev
);
289 usb_submit_urb(urb
, GFP_ATOMIC
);
294 static struct rc_dev
*streamzap_init_rc_dev(struct streamzap_ir
*sz
)
297 struct device
*dev
= sz
->dev
;
300 rdev
= rc_allocate_device();
302 dev_err(dev
, "remote dev allocation failed\n");
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
));
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
;
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
;
323 ret
= rc_register_device(rdev
);
325 dev_err(dev
, "remote input device register failed\n");
332 rc_free_device(rdev
);
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
343 static int streamzap_probe(struct usb_interface
*intf
,
344 const struct usb_device_id
*id
)
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
;
353 /* Allocate space for device driver specific data */
354 sz
= kzalloc(sizeof(struct streamzap_ir
), GFP_KERNEL
);
359 sz
->interface
= intf
;
361 /* Check to ensure endpoint information matches requirements */
362 iface_host
= intf
->cur_altsetting
;
364 if (iface_host
->desc
.bNumEndpoints
!= 1) {
365 dev_err(&intf
->dev
, "%s: Unexpected desc.bNumEndpoints (%d)\n",
366 __func__
, iface_host
->desc
.bNumEndpoints
);
371 sz
->endpoint
= &(iface_host
->endpoint
[0].desc
);
372 if ((sz
->endpoint
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
)
374 dev_err(&intf
->dev
, "%s: endpoint doesn't match input device "
375 "02%02x\n", __func__
, sz
->endpoint
->bEndpointAddress
);
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
);
388 pipe
= usb_rcvintpipe(usbdev
, sz
->endpoint
->bEndpointAddress
);
389 maxp
= usb_maxpacket(usbdev
, pipe
, usb_pipeout(pipe
));
392 dev_err(&intf
->dev
, "%s: endpoint Max Packet Size is 0!?!\n",
398 /* Allocate the USB buffer and IRQ URB */
399 sz
->buf_in
= usb_alloc_coherent(usbdev
, maxp
, GFP_ATOMIC
, &sz
->dma_in
);
403 sz
->urb_in
= usb_alloc_urb(0, GFP_KERNEL
);
407 sz
->dev
= &intf
->dev
;
408 sz
->buf_in_len
= maxp
;
410 if (usbdev
->descriptor
.iManufacturer
411 && usb_string(usbdev
, usbdev
->descriptor
.iManufacturer
,
412 buf
, sizeof(buf
)) > 0)
413 strlcpy(name
, buf
, sizeof(name
));
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
),
421 sz
->rdev
= streamzap_init_rc_dev(sz
);
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);
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
);
438 do_gettimeofday(&sz
->signal_start
);
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
;
447 usb_set_intfdata(intf
, sz
);
449 if (usb_submit_urb(sz
->urb_in
, GFP_ATOMIC
))
450 dev_err(sz
->dev
, "urb submit failed\n");
452 dev_info(sz
->dev
, "Registered %s on usb%d:%d\n", name
,
453 usbdev
->bus
->busnum
, usbdev
->devnum
);
455 /* Load the streamzap not-quite-rc5 decoder too */
456 load_rc5_sz_decode();
461 usb_free_urb(sz
->urb_in
);
463 usb_free_coherent(usbdev
, maxp
, sz
->buf_in
, sz
->dma_in
);
471 * streamzap_disconnect
473 * Called by the usb core when the device is removed from the system.
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.
480 static void streamzap_disconnect(struct usb_interface
*interface
)
482 struct streamzap_ir
*sz
= usb_get_intfdata(interface
);
483 struct usb_device
*usbdev
= interface_to_usbdev(interface
);
485 usb_set_intfdata(interface
, 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
);
499 static int streamzap_suspend(struct usb_interface
*intf
, pm_message_t message
)
501 struct streamzap_ir
*sz
= usb_get_intfdata(intf
);
503 usb_kill_urb(sz
->urb_in
);
508 static int streamzap_resume(struct usb_interface
*intf
)
510 struct streamzap_ir
*sz
= usb_get_intfdata(intf
);
512 if (usb_submit_urb(sz
->urb_in
, GFP_ATOMIC
)) {
513 dev_err(sz
->dev
, "Error sumbiting urb\n");
520 module_usb_driver(streamzap_driver
);
522 MODULE_AUTHOR("Jarod Wilson <jarod@wilsonet.com>");
523 MODULE_DESCRIPTION(DRIVER_DESC
);
524 MODULE_LICENSE("GPL");