4 * Copyright (C) 2001-2002 Greg Kroah-Hartman (greg@kroah.com)
5 * Copyright (C) 2002 Gary Brubaker (xavyer@ix.netcom.com)
6 * Copyright (C) 2010 Johan Hovold (jhovold@gmail.com)
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This driver allows a USB IrDA device to be used as a "dumb" serial device.
14 * This can be useful if you do not have access to a full IrDA stack on the
15 * other side of the connection. If you do have an IrDA stack on both devices,
16 * please use the usb-irda driver, as it contains the proper error checking and
17 * other goodness of a full IrDA stack.
19 * Portions of this driver were taken from drivers/net/irda/irda-usb.c, which
20 * was written by Roman Weissgaerber <weissg@vienna.at>, Dag Brattli
21 * <dag@brattli.net>, and Jean Tourrilhes <jt@hpl.hp.com>
23 * See Documentation/usb/usb-serial.txt for more information on using this
27 #include <linux/kernel.h>
28 #include <linux/errno.h>
29 #include <linux/init.h>
30 #include <linux/slab.h>
31 #include <linux/tty.h>
32 #include <linux/tty_driver.h>
33 #include <linux/tty_flip.h>
34 #include <linux/module.h>
35 #include <linux/spinlock.h>
36 #include <linux/uaccess.h>
37 #include <linux/usb.h>
38 #include <linux/usb/serial.h>
39 #include <linux/usb/irda.h>
44 #define DRIVER_VERSION "v0.5"
45 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Johan Hovold <jhovold@gmail.com>"
46 #define DRIVER_DESC "USB IR Dongle driver"
50 /* if overridden by the user, then use their value for the size of the read and
52 static int buffer_size;
54 /* if overridden by the user, then use the specified number of XBOFs */
57 static int ir_startup (struct usb_serial *serial);
58 static int ir_open(struct tty_struct *tty, struct usb_serial_port *port);
59 static int ir_prepare_write_buffer(struct usb_serial_port *port,
60 void *dest, size_t size);
61 static void ir_process_read_urb(struct urb *urb);
62 static void ir_set_termios(struct tty_struct *tty,
63 struct usb_serial_port *port, struct ktermios *old_termios);
65 /* Not that this lot means you can only have one per system */
70 static const struct usb_device_id ir_id_table[] = {
71 { USB_DEVICE(0x050f, 0x0180) }, /* KC Technology, KC-180 */
72 { USB_DEVICE(0x08e9, 0x0100) }, /* XTNDAccess */
73 { USB_DEVICE(0x09c4, 0x0011) }, /* ACTiSys ACT-IR2000U */
74 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, USB_SUBCLASS_IRDA, 0) },
75 { } /* Terminating entry */
78 MODULE_DEVICE_TABLE(usb, ir_id_table);
80 static struct usb_serial_driver ir_device = {
85 .description = "IR Dongle",
86 .id_table = ir_id_table,
88 .set_termios = ir_set_termios,
91 .prepare_write_buffer = ir_prepare_write_buffer,
92 .process_read_urb = ir_process_read_urb,
95 static struct usb_serial_driver * const serial_drivers[] = {
99 static inline void irda_usb_dump_class_desc(struct usb_serial *serial,
100 struct usb_irda_cs_descriptor *desc)
102 struct device *dev = &serial->dev->dev;
104 dev_dbg(dev, "bLength=%x\n", desc->bLength);
105 dev_dbg(dev, "bDescriptorType=%x\n", desc->bDescriptorType);
106 dev_dbg(dev, "bcdSpecRevision=%x\n", __le16_to_cpu(desc->bcdSpecRevision));
107 dev_dbg(dev, "bmDataSize=%x\n", desc->bmDataSize);
108 dev_dbg(dev, "bmWindowSize=%x\n", desc->bmWindowSize);
109 dev_dbg(dev, "bmMinTurnaroundTime=%d\n", desc->bmMinTurnaroundTime);
110 dev_dbg(dev, "wBaudRate=%x\n", __le16_to_cpu(desc->wBaudRate));
111 dev_dbg(dev, "bmAdditionalBOFs=%x\n", desc->bmAdditionalBOFs);
112 dev_dbg(dev, "bIrdaRateSniff=%x\n", desc->bIrdaRateSniff);
113 dev_dbg(dev, "bMaxUnicastList=%x\n", desc->bMaxUnicastList);
116 /*------------------------------------------------------------------*/
118 * Function irda_usb_find_class_desc(dev, ifnum)
120 * Returns instance of IrDA class descriptor, or NULL if not found
122 * The class descriptor is some extra info that IrDA USB devices will
123 * offer to us, describing their IrDA characteristics. We will use that in
124 * irda_usb_init_qos()
126 * Based on the same function in drivers/net/irda/irda-usb.c
128 static struct usb_irda_cs_descriptor *
129 irda_usb_find_class_desc(struct usb_serial *serial, unsigned int ifnum)
131 struct usb_device *dev = serial->dev;
132 struct usb_irda_cs_descriptor *desc;
135 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
139 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
140 USB_REQ_CS_IRDA_GET_CLASS_DESC,
141 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
142 0, ifnum, desc, sizeof(*desc), 1000);
144 dev_dbg(&serial->dev->dev, "%s - ret=%d\n", __func__, ret);
145 if (ret < sizeof(*desc)) {
146 dev_dbg(&serial->dev->dev,
147 "%s - class descriptor read %s (%d)\n", __func__,
148 (ret < 0) ? "failed" : "too short", ret);
151 if (desc->bDescriptorType != USB_DT_CS_IRDA) {
152 dev_dbg(&serial->dev->dev, "%s - bad class descriptor type\n",
157 irda_usb_dump_class_desc(serial, desc);
165 static u8 ir_xbof_change(u8 xbof)
169 /* reference irda-usb.c */
203 static int ir_startup(struct usb_serial *serial)
205 struct usb_irda_cs_descriptor *irda_desc;
207 irda_desc = irda_usb_find_class_desc(serial, 0);
209 dev_err(&serial->dev->dev,
210 "IRDA class descriptor not found, device not bound\n");
214 dev_dbg(&serial->dev->dev,
215 "%s - Baud rates supported:%s%s%s%s%s%s%s%s%s\n",
217 (irda_desc->wBaudRate & USB_IRDA_BR_2400) ? " 2400" : "",
218 (irda_desc->wBaudRate & USB_IRDA_BR_9600) ? " 9600" : "",
219 (irda_desc->wBaudRate & USB_IRDA_BR_19200) ? " 19200" : "",
220 (irda_desc->wBaudRate & USB_IRDA_BR_38400) ? " 38400" : "",
221 (irda_desc->wBaudRate & USB_IRDA_BR_57600) ? " 57600" : "",
222 (irda_desc->wBaudRate & USB_IRDA_BR_115200) ? " 115200" : "",
223 (irda_desc->wBaudRate & USB_IRDA_BR_576000) ? " 576000" : "",
224 (irda_desc->wBaudRate & USB_IRDA_BR_1152000) ? " 1152000" : "",
225 (irda_desc->wBaudRate & USB_IRDA_BR_4000000) ? " 4000000" : "");
227 switch (irda_desc->bmAdditionalBOFs) {
261 static int ir_open(struct tty_struct *tty, struct usb_serial_port *port)
265 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
266 port->write_urbs[i]->transfer_flags = URB_ZERO_PACKET;
268 /* Start reading from the device */
269 return usb_serial_generic_open(tty, port);
272 static int ir_prepare_write_buffer(struct usb_serial_port *port,
273 void *dest, size_t size)
275 unsigned char *buf = dest;
279 * The first byte of the packet we send to the device contains an
280 * inbound header which indicates an additional number of BOFs and
281 * a baud rate change.
283 * See section 5.4.2.2 of the USB IrDA spec.
285 *buf = ir_xbof | ir_baud;
287 count = kfifo_out_locked(&port->write_fifo, buf + 1, size - 1,
292 static void ir_process_read_urb(struct urb *urb)
294 struct usb_serial_port *port = urb->context;
295 unsigned char *data = urb->transfer_buffer;
296 struct tty_struct *tty;
298 if (!urb->actual_length)
301 * The first byte of the packet we get from the device
302 * contains a busy indicator and baud rate change.
303 * See section 5.4.1.2 of the USB IrDA spec.
306 ir_baud = *data & 0x0f;
308 if (urb->actual_length == 1)
311 tty = tty_port_tty_get(&port->port);
314 tty_insert_flip_string(tty, data + 1, urb->actual_length - 1);
315 tty_flip_buffer_push(tty);
319 static void ir_set_termios_callback(struct urb *urb)
321 kfree(urb->transfer_buffer);
324 dev_dbg(&urb->dev->dev, "%s - non-zero urb status: %d\n",
325 __func__, urb->status);
328 static void ir_set_termios(struct tty_struct *tty,
329 struct usb_serial_port *port, struct ktermios *old_termios)
332 unsigned char *transfer_buffer;
337 baud = tty_get_baud_rate(tty);
340 * FIXME, we should compare the baud request against the
341 * capability stated in the IR header that we got in the
347 ir_baud = USB_IRDA_BR_2400;
350 ir_baud = USB_IRDA_BR_9600;
353 ir_baud = USB_IRDA_BR_19200;
356 ir_baud = USB_IRDA_BR_38400;
359 ir_baud = USB_IRDA_BR_57600;
362 ir_baud = USB_IRDA_BR_115200;
365 ir_baud = USB_IRDA_BR_576000;
368 ir_baud = USB_IRDA_BR_1152000;
371 ir_baud = USB_IRDA_BR_4000000;
374 ir_baud = USB_IRDA_BR_9600;
379 ir_xbof = ir_xbof_change(ir_add_bof);
381 ir_xbof = ir_xbof_change(xbof) ;
383 /* Only speed changes are supported */
384 tty_termios_copy_hw(tty->termios, old_termios);
385 tty_encode_baud_rate(tty, baud, baud);
388 * send the baud change out on an "empty" data packet
390 urb = usb_alloc_urb(0, GFP_KERNEL);
392 dev_err(&port->dev, "%s - no more urbs\n", __func__);
395 transfer_buffer = kmalloc(1, GFP_KERNEL);
396 if (!transfer_buffer) {
397 dev_err(&port->dev, "%s - out of memory\n", __func__);
401 *transfer_buffer = ir_xbof | ir_baud;
406 usb_sndbulkpipe(port->serial->dev,
407 port->bulk_out_endpointAddress),
410 ir_set_termios_callback,
413 urb->transfer_flags = URB_ZERO_PACKET;
415 result = usb_submit_urb(urb, GFP_KERNEL);
417 dev_err(&port->dev, "%s - failed to submit urb: %d\n",
426 kfree(transfer_buffer);
431 static int __init ir_init(void)
436 ir_device.bulk_in_size = buffer_size;
437 ir_device.bulk_out_size = buffer_size;
440 retval = usb_serial_register_drivers(serial_drivers, KBUILD_MODNAME, ir_id_table);
442 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
447 static void __exit ir_exit(void)
449 usb_serial_deregister_drivers(serial_drivers);
453 module_init(ir_init);
454 module_exit(ir_exit);
456 MODULE_AUTHOR(DRIVER_AUTHOR);
457 MODULE_DESCRIPTION(DRIVER_DESC);
458 MODULE_LICENSE("GPL");
460 module_param(debug, bool, S_IRUGO | S_IWUSR);
461 MODULE_PARM_DESC(debug, "Debug enabled or not");
462 module_param(xbof, int, 0);
463 MODULE_PARM_DESC(xbof, "Force specific number of XBOFs");
464 module_param(buffer_size, int, 0);
465 MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers");