Loading...
1/*
2 * USB IR Dongle driver
3 *
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)
7 *
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.
12 *
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.
18 *
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>
22 *
23 * See Documentation/usb/usb-serial.txt for more information on using this
24 * driver
25 *
26 * 2008_Jun_02 Felipe Balbi <me@felipebalbi.com>
27 * Introduced common header to be used also in USB Gadget Framework.
28 * Still needs some other style fixes.
29 *
30 * 2007_Jun_21 Alan Cox <alan@lxorguk.ukuu.org.uk>
31 * Minimal cleanups for some of the driver problens and tty layer abuse.
32 * Still needs fixing to allow multiple dongles.
33 *
34 * 2002_Mar_07 greg kh
35 * moved some needed structures and #define values from the
36 * net/irda/irda-usb.h file into our file, as we don't want to depend on
37 * that codebase compiling correctly :)
38 *
39 * 2002_Jan_14 gb
40 * Added module parameter to force specific number of XBOFs.
41 * Added ir_xbof_change().
42 * Reorganized read_bulk_callback error handling.
43 * Switched from FILL_BULK_URB() to usb_fill_bulk_urb().
44 *
45 * 2001_Nov_08 greg kh
46 * Changed the irda_usb_find_class_desc() function based on comments and
47 * code from Martin Diehl.
48 *
49 * 2001_Nov_01 greg kh
50 * Added support for more IrDA USB devices.
51 * Added support for zero packet. Added buffer override paramater, so
52 * users can transfer larger packets at once if they wish. Both patches
53 * came from Dag Brattli <dag@obexcode.com>.
54 *
55 * 2001_Oct_07 greg kh
56 * initial version released.
57 */
58
59#include <linux/kernel.h>
60#include <linux/errno.h>
61#include <linux/init.h>
62#include <linux/slab.h>
63#include <linux/tty.h>
64#include <linux/tty_driver.h>
65#include <linux/tty_flip.h>
66#include <linux/module.h>
67#include <linux/spinlock.h>
68#include <linux/uaccess.h>
69#include <linux/usb.h>
70#include <linux/usb/serial.h>
71#include <linux/usb/irda.h>
72
73/*
74 * Version Information
75 */
76#define DRIVER_VERSION "v0.5"
77#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Johan Hovold <jhovold@gmail.com>"
78#define DRIVER_DESC "USB IR Dongle driver"
79
80static int debug;
81
82/* if overridden by the user, then use their value for the size of the read and
83 * write urbs */
84static int buffer_size;
85
86/* if overridden by the user, then use the specified number of XBOFs */
87static int xbof = -1;
88
89static int ir_startup (struct usb_serial *serial);
90static int ir_open(struct tty_struct *tty, struct usb_serial_port *port);
91static int ir_prepare_write_buffer(struct usb_serial_port *port,
92 void *dest, size_t size);
93static void ir_process_read_urb(struct urb *urb);
94static void ir_set_termios(struct tty_struct *tty,
95 struct usb_serial_port *port, struct ktermios *old_termios);
96
97/* Not that this lot means you can only have one per system */
98static u8 ir_baud;
99static u8 ir_xbof;
100static u8 ir_add_bof;
101
102static const struct usb_device_id ir_id_table[] = {
103 { USB_DEVICE(0x050f, 0x0180) }, /* KC Technology, KC-180 */
104 { USB_DEVICE(0x08e9, 0x0100) }, /* XTNDAccess */
105 { USB_DEVICE(0x09c4, 0x0011) }, /* ACTiSys ACT-IR2000U */
106 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, USB_SUBCLASS_IRDA, 0) },
107 { } /* Terminating entry */
108};
109
110MODULE_DEVICE_TABLE(usb, ir_id_table);
111
112static struct usb_driver ir_driver = {
113 .name = "ir-usb",
114 .probe = usb_serial_probe,
115 .disconnect = usb_serial_disconnect,
116 .id_table = ir_id_table,
117 .no_dynamic_id = 1,
118};
119
120static struct usb_serial_driver ir_device = {
121 .driver = {
122 .owner = THIS_MODULE,
123 .name = "ir-usb",
124 },
125 .description = "IR Dongle",
126 .usb_driver = &ir_driver,
127 .id_table = ir_id_table,
128 .num_ports = 1,
129 .set_termios = ir_set_termios,
130 .attach = ir_startup,
131 .open = ir_open,
132 .prepare_write_buffer = ir_prepare_write_buffer,
133 .process_read_urb = ir_process_read_urb,
134};
135
136static inline void irda_usb_dump_class_desc(struct usb_irda_cs_descriptor *desc)
137{
138 dbg("bLength=%x", desc->bLength);
139 dbg("bDescriptorType=%x", desc->bDescriptorType);
140 dbg("bcdSpecRevision=%x", __le16_to_cpu(desc->bcdSpecRevision));
141 dbg("bmDataSize=%x", desc->bmDataSize);
142 dbg("bmWindowSize=%x", desc->bmWindowSize);
143 dbg("bmMinTurnaroundTime=%d", desc->bmMinTurnaroundTime);
144 dbg("wBaudRate=%x", __le16_to_cpu(desc->wBaudRate));
145 dbg("bmAdditionalBOFs=%x", desc->bmAdditionalBOFs);
146 dbg("bIrdaRateSniff=%x", desc->bIrdaRateSniff);
147 dbg("bMaxUnicastList=%x", desc->bMaxUnicastList);
148}
149
150/*------------------------------------------------------------------*/
151/*
152 * Function irda_usb_find_class_desc(dev, ifnum)
153 *
154 * Returns instance of IrDA class descriptor, or NULL if not found
155 *
156 * The class descriptor is some extra info that IrDA USB devices will
157 * offer to us, describing their IrDA characteristics. We will use that in
158 * irda_usb_init_qos()
159 *
160 * Based on the same function in drivers/net/irda/irda-usb.c
161 */
162static struct usb_irda_cs_descriptor *
163irda_usb_find_class_desc(struct usb_device *dev, unsigned int ifnum)
164{
165 struct usb_irda_cs_descriptor *desc;
166 int ret;
167
168 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
169 if (!desc)
170 return NULL;
171
172 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
173 USB_REQ_CS_IRDA_GET_CLASS_DESC,
174 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
175 0, ifnum, desc, sizeof(*desc), 1000);
176
177 dbg("%s - ret=%d", __func__, ret);
178 if (ret < sizeof(*desc)) {
179 dbg("%s - class descriptor read %s (%d)",
180 __func__,
181 (ret < 0) ? "failed" : "too short",
182 ret);
183 goto error;
184 }
185 if (desc->bDescriptorType != USB_DT_CS_IRDA) {
186 dbg("%s - bad class descriptor type", __func__);
187 goto error;
188 }
189
190 irda_usb_dump_class_desc(desc);
191 return desc;
192
193error:
194 kfree(desc);
195 return NULL;
196}
197
198static u8 ir_xbof_change(u8 xbof)
199{
200 u8 result;
201
202 /* reference irda-usb.c */
203 switch (xbof) {
204 case 48:
205 result = 0x10;
206 break;
207 case 28:
208 case 24:
209 result = 0x20;
210 break;
211 default:
212 case 12:
213 result = 0x30;
214 break;
215 case 5:
216 case 6:
217 result = 0x40;
218 break;
219 case 3:
220 result = 0x50;
221 break;
222 case 2:
223 result = 0x60;
224 break;
225 case 1:
226 result = 0x70;
227 break;
228 case 0:
229 result = 0x80;
230 break;
231 }
232
233 return(result);
234}
235
236static int ir_startup(struct usb_serial *serial)
237{
238 struct usb_irda_cs_descriptor *irda_desc;
239
240 irda_desc = irda_usb_find_class_desc(serial->dev, 0);
241 if (!irda_desc) {
242 dev_err(&serial->dev->dev,
243 "IRDA class descriptor not found, device not bound\n");
244 return -ENODEV;
245 }
246
247 dbg("%s - Baud rates supported:%s%s%s%s%s%s%s%s%s",
248 __func__,
249 (irda_desc->wBaudRate & USB_IRDA_BR_2400) ? " 2400" : "",
250 (irda_desc->wBaudRate & USB_IRDA_BR_9600) ? " 9600" : "",
251 (irda_desc->wBaudRate & USB_IRDA_BR_19200) ? " 19200" : "",
252 (irda_desc->wBaudRate & USB_IRDA_BR_38400) ? " 38400" : "",
253 (irda_desc->wBaudRate & USB_IRDA_BR_57600) ? " 57600" : "",
254 (irda_desc->wBaudRate & USB_IRDA_BR_115200) ? " 115200" : "",
255 (irda_desc->wBaudRate & USB_IRDA_BR_576000) ? " 576000" : "",
256 (irda_desc->wBaudRate & USB_IRDA_BR_1152000) ? " 1152000" : "",
257 (irda_desc->wBaudRate & USB_IRDA_BR_4000000) ? " 4000000" : "");
258
259 switch (irda_desc->bmAdditionalBOFs) {
260 case USB_IRDA_AB_48:
261 ir_add_bof = 48;
262 break;
263 case USB_IRDA_AB_24:
264 ir_add_bof = 24;
265 break;
266 case USB_IRDA_AB_12:
267 ir_add_bof = 12;
268 break;
269 case USB_IRDA_AB_6:
270 ir_add_bof = 6;
271 break;
272 case USB_IRDA_AB_3:
273 ir_add_bof = 3;
274 break;
275 case USB_IRDA_AB_2:
276 ir_add_bof = 2;
277 break;
278 case USB_IRDA_AB_1:
279 ir_add_bof = 1;
280 break;
281 case USB_IRDA_AB_0:
282 ir_add_bof = 0;
283 break;
284 default:
285 break;
286 }
287
288 kfree(irda_desc);
289
290 return 0;
291}
292
293static int ir_open(struct tty_struct *tty, struct usb_serial_port *port)
294{
295 int i;
296
297 dbg("%s - port %d", __func__, port->number);
298
299 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
300 port->write_urbs[i]->transfer_flags = URB_ZERO_PACKET;
301
302 /* Start reading from the device */
303 return usb_serial_generic_open(tty, port);
304}
305
306static int ir_prepare_write_buffer(struct usb_serial_port *port,
307 void *dest, size_t size)
308{
309 unsigned char *buf = dest;
310 int count;
311
312 /*
313 * The first byte of the packet we send to the device contains an
314 * inbound header which indicates an additional number of BOFs and
315 * a baud rate change.
316 *
317 * See section 5.4.2.2 of the USB IrDA spec.
318 */
319 *buf = ir_xbof | ir_baud;
320
321 count = kfifo_out_locked(&port->write_fifo, buf + 1, size - 1,
322 &port->lock);
323 return count + 1;
324}
325
326static void ir_process_read_urb(struct urb *urb)
327{
328 struct usb_serial_port *port = urb->context;
329 unsigned char *data = urb->transfer_buffer;
330 struct tty_struct *tty;
331
332 if (!urb->actual_length)
333 return;
334 /*
335 * The first byte of the packet we get from the device
336 * contains a busy indicator and baud rate change.
337 * See section 5.4.1.2 of the USB IrDA spec.
338 */
339 if (*data & 0x0f)
340 ir_baud = *data & 0x0f;
341
342 if (urb->actual_length == 1)
343 return;
344
345 tty = tty_port_tty_get(&port->port);
346 if (!tty)
347 return;
348 tty_insert_flip_string(tty, data + 1, urb->actual_length - 1);
349 tty_flip_buffer_push(tty);
350 tty_kref_put(tty);
351}
352
353static void ir_set_termios_callback(struct urb *urb)
354{
355 struct usb_serial_port *port = urb->context;
356 int status = urb->status;
357
358 dbg("%s - port %d", __func__, port->number);
359
360 kfree(urb->transfer_buffer);
361
362 if (status)
363 dbg("%s - non-zero urb status: %d", __func__, status);
364}
365
366static void ir_set_termios(struct tty_struct *tty,
367 struct usb_serial_port *port, struct ktermios *old_termios)
368{
369 struct urb *urb;
370 unsigned char *transfer_buffer;
371 int result;
372 speed_t baud;
373 int ir_baud;
374
375 dbg("%s - port %d", __func__, port->number);
376
377 baud = tty_get_baud_rate(tty);
378
379 /*
380 * FIXME, we should compare the baud request against the
381 * capability stated in the IR header that we got in the
382 * startup function.
383 */
384
385 switch (baud) {
386 case 2400:
387 ir_baud = USB_IRDA_BR_2400;
388 break;
389 case 9600:
390 ir_baud = USB_IRDA_BR_9600;
391 break;
392 case 19200:
393 ir_baud = USB_IRDA_BR_19200;
394 break;
395 case 38400:
396 ir_baud = USB_IRDA_BR_38400;
397 break;
398 case 57600:
399 ir_baud = USB_IRDA_BR_57600;
400 break;
401 case 115200:
402 ir_baud = USB_IRDA_BR_115200;
403 break;
404 case 576000:
405 ir_baud = USB_IRDA_BR_576000;
406 break;
407 case 1152000:
408 ir_baud = USB_IRDA_BR_1152000;
409 break;
410 case 4000000:
411 ir_baud = USB_IRDA_BR_4000000;
412 break;
413 default:
414 ir_baud = USB_IRDA_BR_9600;
415 baud = 9600;
416 }
417
418 if (xbof == -1)
419 ir_xbof = ir_xbof_change(ir_add_bof);
420 else
421 ir_xbof = ir_xbof_change(xbof) ;
422
423 /* Only speed changes are supported */
424 tty_termios_copy_hw(tty->termios, old_termios);
425 tty_encode_baud_rate(tty, baud, baud);
426
427 /*
428 * send the baud change out on an "empty" data packet
429 */
430 urb = usb_alloc_urb(0, GFP_KERNEL);
431 if (!urb) {
432 dev_err(&port->dev, "%s - no more urbs\n", __func__);
433 return;
434 }
435 transfer_buffer = kmalloc(1, GFP_KERNEL);
436 if (!transfer_buffer) {
437 dev_err(&port->dev, "%s - out of memory\n", __func__);
438 goto err_buf;
439 }
440
441 *transfer_buffer = ir_xbof | ir_baud;
442
443 usb_fill_bulk_urb(
444 urb,
445 port->serial->dev,
446 usb_sndbulkpipe(port->serial->dev,
447 port->bulk_out_endpointAddress),
448 transfer_buffer,
449 1,
450 ir_set_termios_callback,
451 port);
452
453 urb->transfer_flags = URB_ZERO_PACKET;
454
455 result = usb_submit_urb(urb, GFP_KERNEL);
456 if (result) {
457 dev_err(&port->dev, "%s - failed to submit urb: %d\n",
458 __func__, result);
459 goto err_subm;
460 }
461
462 usb_free_urb(urb);
463
464 return;
465err_subm:
466 kfree(transfer_buffer);
467err_buf:
468 usb_free_urb(urb);
469}
470
471static int __init ir_init(void)
472{
473 int retval;
474
475 if (buffer_size) {
476 ir_device.bulk_in_size = buffer_size;
477 ir_device.bulk_out_size = buffer_size;
478 }
479
480 retval = usb_serial_register(&ir_device);
481 if (retval)
482 goto failed_usb_serial_register;
483
484 retval = usb_register(&ir_driver);
485 if (retval)
486 goto failed_usb_register;
487
488 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
489 DRIVER_DESC "\n");
490
491 return 0;
492
493failed_usb_register:
494 usb_serial_deregister(&ir_device);
495
496failed_usb_serial_register:
497 return retval;
498}
499
500static void __exit ir_exit(void)
501{
502 usb_deregister(&ir_driver);
503 usb_serial_deregister(&ir_device);
504}
505
506
507module_init(ir_init);
508module_exit(ir_exit);
509
510MODULE_AUTHOR(DRIVER_AUTHOR);
511MODULE_DESCRIPTION(DRIVER_DESC);
512MODULE_LICENSE("GPL");
513
514module_param(debug, bool, S_IRUGO | S_IWUSR);
515MODULE_PARM_DESC(debug, "Debug enabled or not");
516module_param(xbof, int, 0);
517MODULE_PARM_DESC(xbof, "Force specific number of XBOFs");
518module_param(buffer_size, int, 0);
519MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers");
520
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * USB IR Dongle driver
4 *
5 * Copyright (C) 2001-2002 Greg Kroah-Hartman (greg@kroah.com)
6 * Copyright (C) 2002 Gary Brubaker (xavyer@ix.netcom.com)
7 * Copyright (C) 2010 Johan Hovold (jhovold@gmail.com)
8 *
9 * This driver allows a USB IrDA device to be used as a "dumb" serial device.
10 * This can be useful if you do not have access to a full IrDA stack on the
11 * other side of the connection. If you do have an IrDA stack on both devices,
12 * please use the usb-irda driver, as it contains the proper error checking and
13 * other goodness of a full IrDA stack.
14 *
15 * Portions of this driver were taken from drivers/net/irda/irda-usb.c, which
16 * was written by Roman Weissgaerber <weissg@vienna.at>, Dag Brattli
17 * <dag@brattli.net>, and Jean Tourrilhes <jt@hpl.hp.com>
18 *
19 * See Documentation/usb/usb-serial.rst for more information on using this
20 * driver
21 */
22
23#include <linux/kernel.h>
24#include <linux/errno.h>
25#include <linux/init.h>
26#include <linux/slab.h>
27#include <linux/tty.h>
28#include <linux/tty_driver.h>
29#include <linux/tty_flip.h>
30#include <linux/module.h>
31#include <linux/spinlock.h>
32#include <linux/uaccess.h>
33#include <linux/usb.h>
34#include <linux/usb/serial.h>
35#include <linux/usb/irda.h>
36
37#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Johan Hovold <jhovold@gmail.com>"
38#define DRIVER_DESC "USB IR Dongle driver"
39
40/* if overridden by the user, then use their value for the size of the read and
41 * write urbs */
42static int buffer_size;
43
44/* if overridden by the user, then use the specified number of XBOFs */
45static int xbof = -1;
46
47static int ir_startup (struct usb_serial *serial);
48static int ir_write(struct tty_struct *tty, struct usb_serial_port *port,
49 const unsigned char *buf, int count);
50static unsigned int ir_write_room(struct tty_struct *tty);
51static void ir_write_bulk_callback(struct urb *urb);
52static void ir_process_read_urb(struct urb *urb);
53static void ir_set_termios(struct tty_struct *tty,
54 struct usb_serial_port *port,
55 const struct ktermios *old_termios);
56
57/* Not that this lot means you can only have one per system */
58static u8 ir_baud;
59static u8 ir_xbof;
60static u8 ir_add_bof;
61
62static const struct usb_device_id ir_id_table[] = {
63 { USB_DEVICE(0x050f, 0x0180) }, /* KC Technology, KC-180 */
64 { USB_DEVICE(0x08e9, 0x0100) }, /* XTNDAccess */
65 { USB_DEVICE(0x09c4, 0x0011) }, /* ACTiSys ACT-IR2000U */
66 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, USB_SUBCLASS_IRDA, 0) },
67 { } /* Terminating entry */
68};
69
70MODULE_DEVICE_TABLE(usb, ir_id_table);
71
72static struct usb_serial_driver ir_device = {
73 .driver = {
74 .name = "ir-usb",
75 },
76 .description = "IR Dongle",
77 .id_table = ir_id_table,
78 .num_ports = 1,
79 .num_bulk_in = 1,
80 .num_bulk_out = 1,
81 .set_termios = ir_set_termios,
82 .attach = ir_startup,
83 .write = ir_write,
84 .write_room = ir_write_room,
85 .write_bulk_callback = ir_write_bulk_callback,
86 .process_read_urb = ir_process_read_urb,
87};
88
89static struct usb_serial_driver * const serial_drivers[] = {
90 &ir_device, NULL
91};
92
93static inline void irda_usb_dump_class_desc(struct usb_serial *serial,
94 struct usb_irda_cs_descriptor *desc)
95{
96 struct device *dev = &serial->dev->dev;
97
98 dev_dbg(dev, "bLength=%x\n", desc->bLength);
99 dev_dbg(dev, "bDescriptorType=%x\n", desc->bDescriptorType);
100 dev_dbg(dev, "bcdSpecRevision=%x\n", __le16_to_cpu(desc->bcdSpecRevision));
101 dev_dbg(dev, "bmDataSize=%x\n", desc->bmDataSize);
102 dev_dbg(dev, "bmWindowSize=%x\n", desc->bmWindowSize);
103 dev_dbg(dev, "bmMinTurnaroundTime=%d\n", desc->bmMinTurnaroundTime);
104 dev_dbg(dev, "wBaudRate=%x\n", __le16_to_cpu(desc->wBaudRate));
105 dev_dbg(dev, "bmAdditionalBOFs=%x\n", desc->bmAdditionalBOFs);
106 dev_dbg(dev, "bIrdaRateSniff=%x\n", desc->bIrdaRateSniff);
107 dev_dbg(dev, "bMaxUnicastList=%x\n", desc->bMaxUnicastList);
108}
109
110/*------------------------------------------------------------------*/
111/*
112 * Function irda_usb_find_class_desc(dev, ifnum)
113 *
114 * Returns instance of IrDA class descriptor, or NULL if not found
115 *
116 * The class descriptor is some extra info that IrDA USB devices will
117 * offer to us, describing their IrDA characteristics. We will use that in
118 * irda_usb_init_qos()
119 *
120 * Based on the same function in drivers/net/irda/irda-usb.c
121 */
122static struct usb_irda_cs_descriptor *
123irda_usb_find_class_desc(struct usb_serial *serial, unsigned int ifnum)
124{
125 struct usb_device *dev = serial->dev;
126 struct usb_irda_cs_descriptor *desc;
127 int ret;
128
129 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
130 if (!desc)
131 return NULL;
132
133 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
134 USB_REQ_CS_IRDA_GET_CLASS_DESC,
135 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
136 0, ifnum, desc, sizeof(*desc), 1000);
137
138 dev_dbg(&serial->dev->dev, "%s - ret=%d\n", __func__, ret);
139 if (ret < (int)sizeof(*desc)) {
140 dev_dbg(&serial->dev->dev,
141 "%s - class descriptor read %s (%d)\n", __func__,
142 (ret < 0) ? "failed" : "too short", ret);
143 goto error;
144 }
145 if (desc->bDescriptorType != USB_DT_CS_IRDA) {
146 dev_dbg(&serial->dev->dev, "%s - bad class descriptor type\n",
147 __func__);
148 goto error;
149 }
150
151 irda_usb_dump_class_desc(serial, desc);
152 return desc;
153
154error:
155 kfree(desc);
156 return NULL;
157}
158
159static u8 ir_xbof_change(u8 xbof)
160{
161 u8 result;
162
163 /* reference irda-usb.c */
164 switch (xbof) {
165 case 48:
166 result = 0x10;
167 break;
168 case 28:
169 case 24:
170 result = 0x20;
171 break;
172 default:
173 case 12:
174 result = 0x30;
175 break;
176 case 5:
177 case 6:
178 result = 0x40;
179 break;
180 case 3:
181 result = 0x50;
182 break;
183 case 2:
184 result = 0x60;
185 break;
186 case 1:
187 result = 0x70;
188 break;
189 case 0:
190 result = 0x80;
191 break;
192 }
193
194 return(result);
195}
196
197static int ir_startup(struct usb_serial *serial)
198{
199 struct usb_irda_cs_descriptor *irda_desc;
200 int rates;
201
202 irda_desc = irda_usb_find_class_desc(serial, 0);
203 if (!irda_desc) {
204 dev_err(&serial->dev->dev,
205 "IRDA class descriptor not found, device not bound\n");
206 return -ENODEV;
207 }
208
209 rates = le16_to_cpu(irda_desc->wBaudRate);
210
211 dev_dbg(&serial->dev->dev,
212 "%s - Baud rates supported:%s%s%s%s%s%s%s%s%s\n",
213 __func__,
214 (rates & USB_IRDA_BR_2400) ? " 2400" : "",
215 (rates & USB_IRDA_BR_9600) ? " 9600" : "",
216 (rates & USB_IRDA_BR_19200) ? " 19200" : "",
217 (rates & USB_IRDA_BR_38400) ? " 38400" : "",
218 (rates & USB_IRDA_BR_57600) ? " 57600" : "",
219 (rates & USB_IRDA_BR_115200) ? " 115200" : "",
220 (rates & USB_IRDA_BR_576000) ? " 576000" : "",
221 (rates & USB_IRDA_BR_1152000) ? " 1152000" : "",
222 (rates & USB_IRDA_BR_4000000) ? " 4000000" : "");
223
224 switch (irda_desc->bmAdditionalBOFs) {
225 case USB_IRDA_AB_48:
226 ir_add_bof = 48;
227 break;
228 case USB_IRDA_AB_24:
229 ir_add_bof = 24;
230 break;
231 case USB_IRDA_AB_12:
232 ir_add_bof = 12;
233 break;
234 case USB_IRDA_AB_6:
235 ir_add_bof = 6;
236 break;
237 case USB_IRDA_AB_3:
238 ir_add_bof = 3;
239 break;
240 case USB_IRDA_AB_2:
241 ir_add_bof = 2;
242 break;
243 case USB_IRDA_AB_1:
244 ir_add_bof = 1;
245 break;
246 case USB_IRDA_AB_0:
247 ir_add_bof = 0;
248 break;
249 default:
250 break;
251 }
252
253 kfree(irda_desc);
254
255 return 0;
256}
257
258static int ir_write(struct tty_struct *tty, struct usb_serial_port *port,
259 const unsigned char *buf, int count)
260{
261 struct urb *urb = NULL;
262 unsigned long flags;
263 int ret;
264
265 if (port->bulk_out_size == 0)
266 return -EINVAL;
267
268 if (count == 0)
269 return 0;
270
271 count = min(count, port->bulk_out_size - 1);
272
273 spin_lock_irqsave(&port->lock, flags);
274 if (__test_and_clear_bit(0, &port->write_urbs_free)) {
275 urb = port->write_urbs[0];
276 port->tx_bytes += count;
277 }
278 spin_unlock_irqrestore(&port->lock, flags);
279
280 if (!urb)
281 return 0;
282
283 /*
284 * The first byte of the packet we send to the device contains an
285 * outbound header which indicates an additional number of BOFs and
286 * a baud rate change.
287 *
288 * See section 5.4.2.2 of the USB IrDA spec.
289 */
290 *(u8 *)urb->transfer_buffer = ir_xbof | ir_baud;
291
292 memcpy(urb->transfer_buffer + 1, buf, count);
293
294 urb->transfer_buffer_length = count + 1;
295 urb->transfer_flags = URB_ZERO_PACKET;
296
297 ret = usb_submit_urb(urb, GFP_ATOMIC);
298 if (ret) {
299 dev_err(&port->dev, "failed to submit write urb: %d\n", ret);
300
301 spin_lock_irqsave(&port->lock, flags);
302 __set_bit(0, &port->write_urbs_free);
303 port->tx_bytes -= count;
304 spin_unlock_irqrestore(&port->lock, flags);
305
306 return ret;
307 }
308
309 return count;
310}
311
312static void ir_write_bulk_callback(struct urb *urb)
313{
314 struct usb_serial_port *port = urb->context;
315 int status = urb->status;
316 unsigned long flags;
317
318 spin_lock_irqsave(&port->lock, flags);
319 __set_bit(0, &port->write_urbs_free);
320 port->tx_bytes -= urb->transfer_buffer_length - 1;
321 spin_unlock_irqrestore(&port->lock, flags);
322
323 switch (status) {
324 case 0:
325 break;
326 case -ENOENT:
327 case -ECONNRESET:
328 case -ESHUTDOWN:
329 dev_dbg(&port->dev, "write urb stopped: %d\n", status);
330 return;
331 case -EPIPE:
332 dev_err(&port->dev, "write urb stopped: %d\n", status);
333 return;
334 default:
335 dev_err(&port->dev, "nonzero write-urb status: %d\n", status);
336 break;
337 }
338
339 usb_serial_port_softint(port);
340}
341
342static unsigned int ir_write_room(struct tty_struct *tty)
343{
344 struct usb_serial_port *port = tty->driver_data;
345 unsigned int count = 0;
346
347 if (port->bulk_out_size == 0)
348 return 0;
349
350 if (test_bit(0, &port->write_urbs_free))
351 count = port->bulk_out_size - 1;
352
353 return count;
354}
355
356static void ir_process_read_urb(struct urb *urb)
357{
358 struct usb_serial_port *port = urb->context;
359 unsigned char *data = urb->transfer_buffer;
360
361 if (!urb->actual_length)
362 return;
363 /*
364 * The first byte of the packet we get from the device
365 * contains a busy indicator and baud rate change.
366 * See section 5.4.1.2 of the USB IrDA spec.
367 */
368 if (*data & 0x0f)
369 ir_baud = *data & 0x0f;
370
371 if (urb->actual_length == 1)
372 return;
373
374 tty_insert_flip_string(&port->port, data + 1, urb->actual_length - 1);
375 tty_flip_buffer_push(&port->port);
376}
377
378static void ir_set_termios(struct tty_struct *tty,
379 struct usb_serial_port *port,
380 const struct ktermios *old_termios)
381{
382 struct usb_device *udev = port->serial->dev;
383 unsigned char *transfer_buffer;
384 int actual_length;
385 speed_t baud;
386 int ir_baud;
387 int ret;
388
389 baud = tty_get_baud_rate(tty);
390
391 /*
392 * FIXME, we should compare the baud request against the
393 * capability stated in the IR header that we got in the
394 * startup function.
395 */
396
397 switch (baud) {
398 case 2400:
399 ir_baud = USB_IRDA_LS_2400;
400 break;
401 case 9600:
402 ir_baud = USB_IRDA_LS_9600;
403 break;
404 case 19200:
405 ir_baud = USB_IRDA_LS_19200;
406 break;
407 case 38400:
408 ir_baud = USB_IRDA_LS_38400;
409 break;
410 case 57600:
411 ir_baud = USB_IRDA_LS_57600;
412 break;
413 case 115200:
414 ir_baud = USB_IRDA_LS_115200;
415 break;
416 case 576000:
417 ir_baud = USB_IRDA_LS_576000;
418 break;
419 case 1152000:
420 ir_baud = USB_IRDA_LS_1152000;
421 break;
422 case 4000000:
423 ir_baud = USB_IRDA_LS_4000000;
424 break;
425 default:
426 ir_baud = USB_IRDA_LS_9600;
427 baud = 9600;
428 }
429
430 if (xbof == -1)
431 ir_xbof = ir_xbof_change(ir_add_bof);
432 else
433 ir_xbof = ir_xbof_change(xbof) ;
434
435 /* Only speed changes are supported */
436 tty_termios_copy_hw(&tty->termios, old_termios);
437 tty_encode_baud_rate(tty, baud, baud);
438
439 /*
440 * send the baud change out on an "empty" data packet
441 */
442 transfer_buffer = kmalloc(1, GFP_KERNEL);
443 if (!transfer_buffer)
444 return;
445
446 *transfer_buffer = ir_xbof | ir_baud;
447
448 ret = usb_bulk_msg(udev,
449 usb_sndbulkpipe(udev, port->bulk_out_endpointAddress),
450 transfer_buffer, 1, &actual_length, 5000);
451 if (ret || actual_length != 1) {
452 if (!ret)
453 ret = -EIO;
454 dev_err(&port->dev, "failed to change line speed: %d\n", ret);
455 }
456
457 kfree(transfer_buffer);
458}
459
460static int __init ir_init(void)
461{
462 if (buffer_size) {
463 ir_device.bulk_in_size = buffer_size;
464 ir_device.bulk_out_size = buffer_size;
465 }
466
467 return usb_serial_register_drivers(serial_drivers, KBUILD_MODNAME, ir_id_table);
468}
469
470static void __exit ir_exit(void)
471{
472 usb_serial_deregister_drivers(serial_drivers);
473}
474
475
476module_init(ir_init);
477module_exit(ir_exit);
478
479MODULE_AUTHOR(DRIVER_AUTHOR);
480MODULE_DESCRIPTION(DRIVER_DESC);
481MODULE_LICENSE("GPL");
482
483module_param(xbof, int, 0);
484MODULE_PARM_DESC(xbof, "Force specific number of XBOFs");
485module_param(buffer_size, int, 0);
486MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers");
487