4 * lirc_ttusbir - LIRC device driver for the TechnoTrend USB IR Receiver
6 * Copyright (C) 2007 Stefan Macher <st_maker-lirc@yahoo.de>
8 * This LIRC driver provides access to the TechnoTrend USB IR Receiver.
9 * The receiver delivers the IR signal as raw sampled true/false data in
10 * isochronous USB packets each of size 128 byte.
11 * Currently the driver reduces the sampling rate by factor of 8 as this
12 * is still more than enough to decode RC-5 - others should be analyzed.
13 * But the driver does not rely on RC-5 it should be able to decode every
14 * IR signal that is not too fast.
18 * This program is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation; either version 2 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 #include <linux/version.h>
34 #include <linux/kernel.h>
35 #include <linux/init.h>
36 #include <linux/module.h>
37 #include <linux/errno.h>
38 #include <linux/slab.h>
39 #include <linux/usb.h>
41 #include <media/lirc.h>
42 #include <media/lirc_dev.h>
44 MODULE_DESCRIPTION("TechnoTrend USB IR device driver for LIRC");
45 MODULE_AUTHOR("Stefan Macher (st_maker-lirc@yahoo.de)");
46 MODULE_LICENSE("GPL");
50 #define DPRINTK printk
52 #define DPRINTK(_x_, a...)
55 /* function declarations */
56 static int probe(struct usb_interface
*intf
, const struct usb_device_id
*id
);
57 static void disconnect(struct usb_interface
*intf
);
58 static void urb_complete(struct urb
*urb
);
59 static int set_use_inc(void *data
);
60 static void set_use_dec(void *data
);
62 static int num_urbs
= 2;
63 module_param(num_urbs
, int, S_IRUGO
);
64 MODULE_PARM_DESC(num_urbs
,
65 "Number of URBs in queue. Try to increase to 4 in case "
66 "of problems (default: 2; minimum: 2)");
68 /* table of devices that work with this driver */
69 static struct usb_device_id device_id_table
[] = {
70 /* TechnoTrend USB IR Receiver */
71 { USB_DEVICE(0x0B48, 0x2003) },
72 /* Terminating entry */
75 MODULE_DEVICE_TABLE(usb
, device_id_table
);
77 /* USB driver definition */
78 static struct usb_driver usb_driver
= {
80 .id_table
= &(device_id_table
[0]),
82 .disconnect
= disconnect
,
85 /* USB device definition */
86 struct ttusbir_device
{
87 struct usb_driver
*usb_driver
;
88 struct usb_device
*udev
;
89 struct usb_interface
*interf
;
90 struct usb_class_driver class_driver
;
91 unsigned int ifnum
; /* Interface number to use */
92 unsigned int alt_setting
; /* alternate setting to use */
93 unsigned int endpoint
; /* Endpoint to use */
94 struct urb
**urb
; /* num_urb URB pointers*/
95 char **buffer
; /* 128 byte buffer for each URB */
96 struct lirc_buffer rbuf
; /* Buffer towards LIRC */
97 struct lirc_driver driver
;
99 int last_pulse
; /* remembers if last received byte was pulse or space */
100 int last_num
; /* remembers how many last bytes appeared */
104 /*** LIRC specific functions ***/
105 static int set_use_inc(void *data
)
108 struct ttusbir_device
*ttusbir
= data
;
110 DPRINTK("Sending first URBs\n");
111 /* @TODO Do I need to check if I am already opened */
114 for (i
= 0; i
< num_urbs
; i
++) {
115 retval
= usb_submit_urb(ttusbir
->urb
[i
], GFP_KERNEL
);
117 err("%s: usb_submit_urb failed on urb %d",
125 static void set_use_dec(void *data
)
127 struct ttusbir_device
*ttusbir
= data
;
129 DPRINTK("Device closed\n");
134 /*** USB specific functions ***/
137 * This mapping table is used to do a very simple filtering of the
139 * For a value with at least 4 bits set it returns 0xFF otherwise
140 * 0x00. For faster IR signals this can not be used. But for RC-5 we
141 * still have about 14 samples per pulse/space, i.e. we sample with 14
142 * times higher frequency than the signal frequency
144 const unsigned char map_table
[] =
146 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
147 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
148 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
149 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
150 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
151 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
152 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
153 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
154 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
155 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
156 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
157 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
158 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
159 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
160 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
161 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
162 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
163 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
164 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
165 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
166 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
167 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
168 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
169 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
170 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
171 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
172 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
173 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
174 0x00, 0x00, 0x00, 0xFF, 0x00, 0xFF, 0xFF, 0xFF,
175 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
176 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
177 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
180 static void urb_complete(struct urb
*urb
)
182 struct ttusbir_device
*ttusbir
;
187 ttusbir
= urb
->context
;
189 if (!ttusbir
->opened
)
192 buf
= (unsigned char *)urb
->transfer_buffer
;
194 for (i
= 0; i
< 128; i
++) {
195 /* Here we do the filtering and some kind of down sampling */
196 buf
[i
] = ~map_table
[buf
[i
]];
197 if (ttusbir
->last_pulse
== buf
[i
]) {
198 if (ttusbir
->last_num
< PULSE_MASK
/63)
201 * else we are in a idle period and do not need to
202 * increment any longer
205 l
= ttusbir
->last_num
* 62; /* about 62 = us/byte */
206 if (ttusbir
->last_pulse
) /* pulse or space? */
208 if (!lirc_buffer_full(&ttusbir
->rbuf
)) {
209 lirc_buffer_write(&ttusbir
->rbuf
, (void *)&l
);
210 wake_up_interruptible(&ttusbir
->rbuf
.wait_poll
);
212 ttusbir
->last_num
= 0;
213 ttusbir
->last_pulse
= buf
[i
];
216 usb_submit_urb(urb
, GFP_ATOMIC
); /* keep data rolling :-) */
220 * Called whenever the USB subsystem thinks we could be the right driver
221 * to handle this device
223 static int probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
229 struct usb_host_interface
*host_interf
;
230 struct usb_interface_descriptor
*interf_desc
;
231 struct usb_host_endpoint
*host_endpoint
;
232 struct ttusbir_device
*ttusbir
;
234 DPRINTK("Module ttusbir probe\n");
236 /* To reduce memory fragmentation we use only one allocation */
237 struct_size
= sizeof(struct ttusbir_device
) +
238 (sizeof(struct urb
*) * num_urbs
) +
239 (sizeof(char *) * num_urbs
) +
241 ttusbir
= kzalloc(struct_size
, GFP_KERNEL
);
245 ttusbir
->urb
= (struct urb
**)((char *)ttusbir
+
246 sizeof(struct ttusbir_device
));
247 ttusbir
->buffer
= (char **)((char *)ttusbir
->urb
+
248 (sizeof(struct urb
*) * num_urbs
));
249 for (i
= 0; i
< num_urbs
; i
++)
250 ttusbir
->buffer
[i
] = (char *)ttusbir
->buffer
+
251 (sizeof(char *)*num_urbs
) + (i
* 128);
253 ttusbir
->usb_driver
= &usb_driver
;
254 ttusbir
->alt_setting
= -1;
255 /* @TODO check if error can be returned */
256 ttusbir
->udev
= usb_get_dev(interface_to_usbdev(intf
));
257 ttusbir
->interf
= intf
;
258 ttusbir
->last_pulse
= 0x00;
259 ttusbir
->last_num
= 0;
262 * Now look for interface setting we can handle
263 * We are searching for the alt setting where end point
264 * 0x82 has max packet size 16
266 for (alt_set
= 0; alt_set
< intf
->num_altsetting
&& !found
; alt_set
++) {
267 host_interf
= &intf
->altsetting
[alt_set
];
268 interf_desc
= &host_interf
->desc
;
269 for (endp
= 0; endp
< interf_desc
->bNumEndpoints
; endp
++) {
270 host_endpoint
= &host_interf
->endpoint
[endp
];
271 if ((host_endpoint
->desc
.bEndpointAddress
== 0x82) &&
272 (host_endpoint
->desc
.wMaxPacketSize
== 0x10)) {
273 ttusbir
->alt_setting
= alt_set
;
274 ttusbir
->endpoint
= endp
;
280 if (ttusbir
->alt_setting
!= -1)
281 DPRINTK("alt setting: %d\n", ttusbir
->alt_setting
);
283 err("Could not find alternate setting\n");
288 /* OK lets setup this interface setting */
289 usb_set_interface(ttusbir
->udev
, 0, ttusbir
->alt_setting
);
291 /* Store device info in interface structure */
292 usb_set_intfdata(intf
, ttusbir
);
294 /* Register as a LIRC driver */
295 if (lirc_buffer_init(&ttusbir
->rbuf
, sizeof(int), 256) < 0) {
296 err("Could not get memory for LIRC data buffer\n");
297 usb_set_intfdata(intf
, NULL
);
301 strcpy(ttusbir
->driver
.name
, "TTUSBIR");
302 ttusbir
->driver
.minor
= -1;
303 ttusbir
->driver
.code_length
= 1;
304 ttusbir
->driver
.sample_rate
= 0;
305 ttusbir
->driver
.data
= ttusbir
;
306 ttusbir
->driver
.add_to_buf
= NULL
;
307 ttusbir
->driver
.rbuf
= &ttusbir
->rbuf
;
308 ttusbir
->driver
.set_use_inc
= set_use_inc
;
309 ttusbir
->driver
.set_use_dec
= set_use_dec
;
310 ttusbir
->driver
.dev
= &intf
->dev
;
311 ttusbir
->driver
.owner
= THIS_MODULE
;
312 ttusbir
->driver
.features
= LIRC_CAN_REC_MODE2
;
313 ttusbir
->minor
= lirc_register_driver(&ttusbir
->driver
);
314 if (ttusbir
->minor
< 0) {
315 err("Error registering as LIRC driver\n");
316 usb_set_intfdata(intf
, NULL
);
317 lirc_buffer_free(&ttusbir
->rbuf
);
322 /* Allocate and setup the URB that we will use to talk to the device */
323 for (i
= 0; i
< num_urbs
; i
++) {
324 ttusbir
->urb
[i
] = usb_alloc_urb(8, GFP_KERNEL
);
325 if (!ttusbir
->urb
[i
]) {
326 err("Could not allocate memory for the URB\n");
327 for (j
= i
- 1; j
>= 0; j
--)
328 kfree(ttusbir
->urb
[j
]);
329 lirc_buffer_free(&ttusbir
->rbuf
);
330 lirc_unregister_driver(ttusbir
->minor
);
332 usb_set_intfdata(intf
, NULL
);
335 ttusbir
->urb
[i
]->dev
= ttusbir
->udev
;
336 ttusbir
->urb
[i
]->context
= ttusbir
;
337 ttusbir
->urb
[i
]->pipe
= usb_rcvisocpipe(ttusbir
->udev
,
339 ttusbir
->urb
[i
]->interval
= 1;
340 ttusbir
->urb
[i
]->transfer_flags
= URB_ISO_ASAP
;
341 ttusbir
->urb
[i
]->transfer_buffer
= &ttusbir
->buffer
[i
][0];
342 ttusbir
->urb
[i
]->complete
= urb_complete
;
343 ttusbir
->urb
[i
]->number_of_packets
= 8;
344 ttusbir
->urb
[i
]->transfer_buffer_length
= 128;
345 for (j
= 0; j
< 8; j
++) {
346 ttusbir
->urb
[i
]->iso_frame_desc
[j
].offset
= j
*16;
347 ttusbir
->urb
[i
]->iso_frame_desc
[j
].length
= 16;
354 * Called when the driver is unloaded or the device is unplugged
356 static void disconnect(struct usb_interface
*intf
)
359 struct ttusbir_device
*ttusbir
;
361 DPRINTK("Module ttusbir disconnect\n");
363 ttusbir
= (struct ttusbir_device
*) usb_get_intfdata(intf
);
364 usb_set_intfdata(intf
, NULL
);
365 lirc_unregister_driver(ttusbir
->minor
);
366 DPRINTK("unregistered\n");
368 for (i
= 0; i
< num_urbs
; i
++) {
369 usb_kill_urb(ttusbir
->urb
[i
]);
370 usb_free_urb(ttusbir
->urb
[i
]);
372 DPRINTK("URBs killed\n");
373 lirc_buffer_free(&ttusbir
->rbuf
);
377 static int ttusbir_init_module(void)
381 DPRINTK(KERN_DEBUG
"Module ttusbir init\n");
383 /* register this driver with the USB subsystem */
384 result
= usb_register(&usb_driver
);
386 err("usb_register failed. Error number %d", result
);
390 static void ttusbir_exit_module(void)
392 printk(KERN_DEBUG
"Module ttusbir exit\n");
393 usb_deregister(&usb_driver
);
396 module_init(ttusbir_init_module
);
397 module_exit(ttusbir_exit_module
);