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_open(struct tty_struct *tty, struct usb_serial_port *port);
49static int ir_prepare_write_buffer(struct usb_serial_port *port,
50 void *dest, size_t size);
51static void ir_process_read_urb(struct urb *urb);
52static void ir_set_termios(struct tty_struct *tty,
53 struct usb_serial_port *port, struct ktermios *old_termios);
54
55/* Not that this lot means you can only have one per system */
56static u8 ir_baud;
57static u8 ir_xbof;
58static u8 ir_add_bof;
59
60static const struct usb_device_id ir_id_table[] = {
61 { USB_DEVICE(0x050f, 0x0180) }, /* KC Technology, KC-180 */
62 { USB_DEVICE(0x08e9, 0x0100) }, /* XTNDAccess */
63 { USB_DEVICE(0x09c4, 0x0011) }, /* ACTiSys ACT-IR2000U */
64 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, USB_SUBCLASS_IRDA, 0) },
65 { } /* Terminating entry */
66};
67
68MODULE_DEVICE_TABLE(usb, ir_id_table);
69
70static struct usb_serial_driver ir_device = {
71 .driver = {
72 .owner = THIS_MODULE,
73 .name = "ir-usb",
74 },
75 .description = "IR Dongle",
76 .id_table = ir_id_table,
77 .num_ports = 1,
78 .set_termios = ir_set_termios,
79 .attach = ir_startup,
80 .open = ir_open,
81 .prepare_write_buffer = ir_prepare_write_buffer,
82 .process_read_urb = ir_process_read_urb,
83};
84
85static struct usb_serial_driver * const serial_drivers[] = {
86 &ir_device, NULL
87};
88
89static inline void irda_usb_dump_class_desc(struct usb_serial *serial,
90 struct usb_irda_cs_descriptor *desc)
91{
92 struct device *dev = &serial->dev->dev;
93
94 dev_dbg(dev, "bLength=%x\n", desc->bLength);
95 dev_dbg(dev, "bDescriptorType=%x\n", desc->bDescriptorType);
96 dev_dbg(dev, "bcdSpecRevision=%x\n", __le16_to_cpu(desc->bcdSpecRevision));
97 dev_dbg(dev, "bmDataSize=%x\n", desc->bmDataSize);
98 dev_dbg(dev, "bmWindowSize=%x\n", desc->bmWindowSize);
99 dev_dbg(dev, "bmMinTurnaroundTime=%d\n", desc->bmMinTurnaroundTime);
100 dev_dbg(dev, "wBaudRate=%x\n", __le16_to_cpu(desc->wBaudRate));
101 dev_dbg(dev, "bmAdditionalBOFs=%x\n", desc->bmAdditionalBOFs);
102 dev_dbg(dev, "bIrdaRateSniff=%x\n", desc->bIrdaRateSniff);
103 dev_dbg(dev, "bMaxUnicastList=%x\n", desc->bMaxUnicastList);
104}
105
106/*------------------------------------------------------------------*/
107/*
108 * Function irda_usb_find_class_desc(dev, ifnum)
109 *
110 * Returns instance of IrDA class descriptor, or NULL if not found
111 *
112 * The class descriptor is some extra info that IrDA USB devices will
113 * offer to us, describing their IrDA characteristics. We will use that in
114 * irda_usb_init_qos()
115 *
116 * Based on the same function in drivers/net/irda/irda-usb.c
117 */
118static struct usb_irda_cs_descriptor *
119irda_usb_find_class_desc(struct usb_serial *serial, unsigned int ifnum)
120{
121 struct usb_device *dev = serial->dev;
122 struct usb_irda_cs_descriptor *desc;
123 int ret;
124
125 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
126 if (!desc)
127 return NULL;
128
129 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
130 USB_REQ_CS_IRDA_GET_CLASS_DESC,
131 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
132 0, ifnum, desc, sizeof(*desc), 1000);
133
134 dev_dbg(&serial->dev->dev, "%s - ret=%d\n", __func__, ret);
135 if (ret < (int)sizeof(*desc)) {
136 dev_dbg(&serial->dev->dev,
137 "%s - class descriptor read %s (%d)\n", __func__,
138 (ret < 0) ? "failed" : "too short", ret);
139 goto error;
140 }
141 if (desc->bDescriptorType != USB_DT_CS_IRDA) {
142 dev_dbg(&serial->dev->dev, "%s - bad class descriptor type\n",
143 __func__);
144 goto error;
145 }
146
147 irda_usb_dump_class_desc(serial, desc);
148 return desc;
149
150error:
151 kfree(desc);
152 return NULL;
153}
154
155static u8 ir_xbof_change(u8 xbof)
156{
157 u8 result;
158
159 /* reference irda-usb.c */
160 switch (xbof) {
161 case 48:
162 result = 0x10;
163 break;
164 case 28:
165 case 24:
166 result = 0x20;
167 break;
168 default:
169 case 12:
170 result = 0x30;
171 break;
172 case 5:
173 case 6:
174 result = 0x40;
175 break;
176 case 3:
177 result = 0x50;
178 break;
179 case 2:
180 result = 0x60;
181 break;
182 case 1:
183 result = 0x70;
184 break;
185 case 0:
186 result = 0x80;
187 break;
188 }
189
190 return(result);
191}
192
193static int ir_startup(struct usb_serial *serial)
194{
195 struct usb_irda_cs_descriptor *irda_desc;
196 int rates;
197
198 irda_desc = irda_usb_find_class_desc(serial, 0);
199 if (!irda_desc) {
200 dev_err(&serial->dev->dev,
201 "IRDA class descriptor not found, device not bound\n");
202 return -ENODEV;
203 }
204
205 rates = le16_to_cpu(irda_desc->wBaudRate);
206
207 dev_dbg(&serial->dev->dev,
208 "%s - Baud rates supported:%s%s%s%s%s%s%s%s%s\n",
209 __func__,
210 (rates & USB_IRDA_BR_2400) ? " 2400" : "",
211 (rates & USB_IRDA_BR_9600) ? " 9600" : "",
212 (rates & USB_IRDA_BR_19200) ? " 19200" : "",
213 (rates & USB_IRDA_BR_38400) ? " 38400" : "",
214 (rates & USB_IRDA_BR_57600) ? " 57600" : "",
215 (rates & USB_IRDA_BR_115200) ? " 115200" : "",
216 (rates & USB_IRDA_BR_576000) ? " 576000" : "",
217 (rates & USB_IRDA_BR_1152000) ? " 1152000" : "",
218 (rates & USB_IRDA_BR_4000000) ? " 4000000" : "");
219
220 switch (irda_desc->bmAdditionalBOFs) {
221 case USB_IRDA_AB_48:
222 ir_add_bof = 48;
223 break;
224 case USB_IRDA_AB_24:
225 ir_add_bof = 24;
226 break;
227 case USB_IRDA_AB_12:
228 ir_add_bof = 12;
229 break;
230 case USB_IRDA_AB_6:
231 ir_add_bof = 6;
232 break;
233 case USB_IRDA_AB_3:
234 ir_add_bof = 3;
235 break;
236 case USB_IRDA_AB_2:
237 ir_add_bof = 2;
238 break;
239 case USB_IRDA_AB_1:
240 ir_add_bof = 1;
241 break;
242 case USB_IRDA_AB_0:
243 ir_add_bof = 0;
244 break;
245 default:
246 break;
247 }
248
249 kfree(irda_desc);
250
251 return 0;
252}
253
254static int ir_open(struct tty_struct *tty, struct usb_serial_port *port)
255{
256 int i;
257
258 for (i = 0; i < ARRAY_SIZE(port->write_urbs); ++i)
259 port->write_urbs[i]->transfer_flags = URB_ZERO_PACKET;
260
261 /* Start reading from the device */
262 return usb_serial_generic_open(tty, port);
263}
264
265static int ir_prepare_write_buffer(struct usb_serial_port *port,
266 void *dest, size_t size)
267{
268 unsigned char *buf = dest;
269 int count;
270
271 /*
272 * The first byte of the packet we send to the device contains an
273 * inbound header which indicates an additional number of BOFs and
274 * a baud rate change.
275 *
276 * See section 5.4.2.2 of the USB IrDA spec.
277 */
278 *buf = ir_xbof | ir_baud;
279
280 count = kfifo_out_locked(&port->write_fifo, buf + 1, size - 1,
281 &port->lock);
282 return count + 1;
283}
284
285static void ir_process_read_urb(struct urb *urb)
286{
287 struct usb_serial_port *port = urb->context;
288 unsigned char *data = urb->transfer_buffer;
289
290 if (!urb->actual_length)
291 return;
292 /*
293 * The first byte of the packet we get from the device
294 * contains a busy indicator and baud rate change.
295 * See section 5.4.1.2 of the USB IrDA spec.
296 */
297 if (*data & 0x0f)
298 ir_baud = *data & 0x0f;
299
300 if (urb->actual_length == 1)
301 return;
302
303 tty_insert_flip_string(&port->port, data + 1, urb->actual_length - 1);
304 tty_flip_buffer_push(&port->port);
305}
306
307static void ir_set_termios_callback(struct urb *urb)
308{
309 kfree(urb->transfer_buffer);
310
311 if (urb->status)
312 dev_dbg(&urb->dev->dev, "%s - non-zero urb status: %d\n",
313 __func__, urb->status);
314}
315
316static void ir_set_termios(struct tty_struct *tty,
317 struct usb_serial_port *port, struct ktermios *old_termios)
318{
319 struct urb *urb;
320 unsigned char *transfer_buffer;
321 int result;
322 speed_t baud;
323 int ir_baud;
324
325 baud = tty_get_baud_rate(tty);
326
327 /*
328 * FIXME, we should compare the baud request against the
329 * capability stated in the IR header that we got in the
330 * startup function.
331 */
332
333 switch (baud) {
334 case 2400:
335 ir_baud = USB_IRDA_BR_2400;
336 break;
337 case 9600:
338 ir_baud = USB_IRDA_BR_9600;
339 break;
340 case 19200:
341 ir_baud = USB_IRDA_BR_19200;
342 break;
343 case 38400:
344 ir_baud = USB_IRDA_BR_38400;
345 break;
346 case 57600:
347 ir_baud = USB_IRDA_BR_57600;
348 break;
349 case 115200:
350 ir_baud = USB_IRDA_BR_115200;
351 break;
352 case 576000:
353 ir_baud = USB_IRDA_BR_576000;
354 break;
355 case 1152000:
356 ir_baud = USB_IRDA_BR_1152000;
357 break;
358 case 4000000:
359 ir_baud = USB_IRDA_BR_4000000;
360 break;
361 default:
362 ir_baud = USB_IRDA_BR_9600;
363 baud = 9600;
364 }
365
366 if (xbof == -1)
367 ir_xbof = ir_xbof_change(ir_add_bof);
368 else
369 ir_xbof = ir_xbof_change(xbof) ;
370
371 /* Only speed changes are supported */
372 tty_termios_copy_hw(&tty->termios, old_termios);
373 tty_encode_baud_rate(tty, baud, baud);
374
375 /*
376 * send the baud change out on an "empty" data packet
377 */
378 urb = usb_alloc_urb(0, GFP_KERNEL);
379 if (!urb)
380 return;
381
382 transfer_buffer = kmalloc(1, GFP_KERNEL);
383 if (!transfer_buffer)
384 goto err_buf;
385
386 *transfer_buffer = ir_xbof | ir_baud;
387
388 usb_fill_bulk_urb(
389 urb,
390 port->serial->dev,
391 usb_sndbulkpipe(port->serial->dev,
392 port->bulk_out_endpointAddress),
393 transfer_buffer,
394 1,
395 ir_set_termios_callback,
396 port);
397
398 urb->transfer_flags = URB_ZERO_PACKET;
399
400 result = usb_submit_urb(urb, GFP_KERNEL);
401 if (result) {
402 dev_err(&port->dev, "%s - failed to submit urb: %d\n",
403 __func__, result);
404 goto err_subm;
405 }
406
407 usb_free_urb(urb);
408
409 return;
410err_subm:
411 kfree(transfer_buffer);
412err_buf:
413 usb_free_urb(urb);
414}
415
416static int __init ir_init(void)
417{
418 if (buffer_size) {
419 ir_device.bulk_in_size = buffer_size;
420 ir_device.bulk_out_size = buffer_size;
421 }
422
423 return usb_serial_register_drivers(serial_drivers, KBUILD_MODNAME, ir_id_table);
424}
425
426static void __exit ir_exit(void)
427{
428 usb_serial_deregister_drivers(serial_drivers);
429}
430
431
432module_init(ir_init);
433module_exit(ir_exit);
434
435MODULE_AUTHOR(DRIVER_AUTHOR);
436MODULE_DESCRIPTION(DRIVER_DESC);
437MODULE_LICENSE("GPL");
438
439module_param(xbof, int, 0);
440MODULE_PARM_DESC(xbof, "Force specific number of XBOFs");
441module_param(buffer_size, int, 0);
442MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers");
443