647431c1ccb1b13f520eff21f665e693045eec46
[linux-2.6.git] / drivers / usb / serial / ir-usb.c
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  *
7  *      This program is free software; you can redistribute it and/or modify
8  *      it under the terms of the GNU General Public License as published by
9  *      the Free Software Foundation; either version 2 of the License, or
10  *      (at your option) any later version.
11  *
12  * This driver allows a USB IrDA device to be used as a "dumb" serial device.
13  * This can be useful if you do not have access to a full IrDA stack on the
14  * other side of the connection.  If you do have an IrDA stack on both devices,
15  * please use the usb-irda driver, as it contains the proper error checking and
16  * other goodness of a full IrDA stack.
17  *
18  * Portions of this driver were taken from drivers/net/irda/irda-usb.c, which
19  * was written by Roman Weissgaerber <weissg@vienna.at>, Dag Brattli
20  * <dag@brattli.net>, and Jean Tourrilhes <jt@hpl.hp.com>
21  *
22  * See Documentation/usb/usb-serial.txt for more information on using this driver
23  *
24  * 2002_Mar_07  greg kh
25  *      moved some needed structures and #define values from the
26  *      net/irda/irda-usb.h file into our file, as we don't want to depend on
27  *      that codebase compiling correctly :)
28  *
29  * 2002_Jan_14  gb
30  *      Added module parameter to force specific number of XBOFs.
31  *      Added ir_xbof_change().
32  *      Reorganized read_bulk_callback error handling.
33  *      Switched from FILL_BULK_URB() to usb_fill_bulk_urb().
34  *
35  * 2001_Nov_08  greg kh
36  *      Changed the irda_usb_find_class_desc() function based on comments and
37  *      code from Martin Diehl.
38  *
39  * 2001_Nov_01  greg kh
40  *      Added support for more IrDA USB devices.
41  *      Added support for zero packet.  Added buffer override paramater, so
42  *      users can transfer larger packets at once if they wish.  Both patches
43  *      came from Dag Brattli <dag@obexcode.com>.
44  *
45  * 2001_Oct_07  greg kh
46  *      initial version released.
47  */
48
49 #include <linux/config.h>
50 #include <linux/kernel.h>
51 #include <linux/errno.h>
52 #include <linux/init.h>
53 #include <linux/slab.h>
54 #include <linux/tty.h>
55 #include <linux/tty_driver.h>
56 #include <linux/tty_flip.h>
57 #include <linux/module.h>
58 #include <linux/spinlock.h>
59 #include <asm/uaccess.h>
60 #include <linux/usb.h>
61 #include "usb-serial.h"
62
63 /*
64  * Version Information
65  */
66 #define DRIVER_VERSION "v0.4"
67 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
68 #define DRIVER_DESC "USB IR Dongle driver"
69
70 /* USB IrDA class spec information */
71 #define USB_CLASS_IRDA          0x02
72 #define USB_DT_IRDA             0x21
73 #define IU_REQ_GET_CLASS_DESC   0x06
74 #define SPEED_2400              0x01
75 #define SPEED_9600              0x02
76 #define SPEED_19200             0x03
77 #define SPEED_38400             0x04
78 #define SPEED_57600             0x05
79 #define SPEED_115200            0x06
80 #define SPEED_576000            0x07
81 #define SPEED_1152000           0x08
82 #define SPEED_4000000           0x09
83
84 struct irda_class_desc {
85         u8      bLength;
86         u8      bDescriptorType;
87         u16     bcdSpecRevision;
88         u8      bmDataSize;
89         u8      bmWindowSize;
90         u8      bmMinTurnaroundTime;
91         u16     wBaudRate;
92         u8      bmAdditionalBOFs;
93         u8      bIrdaRateSniff;
94         u8      bMaxUnicastList;
95 } __attribute__ ((packed));
96
97 static int debug;
98
99 /* if overridden by the user, then use their value for the size of the read and
100  * write urbs */
101 static int buffer_size;
102 /* if overridden by the user, then use the specified number of XBOFs */
103 static int xbof = -1;
104
105 static int  ir_startup (struct usb_serial *serial);
106 static int  ir_open (struct usb_serial_port *port, struct file *filep);
107 static void ir_close (struct usb_serial_port *port, struct file *filep);
108 static int  ir_write (struct usb_serial_port *port, const unsigned char *buf, int count);
109 static void ir_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
110 static void ir_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
111 static void ir_set_termios (struct usb_serial_port *port, struct termios *old_termios);
112
113 static u8 ir_baud = 0;
114 static u8 ir_xbof = 0;
115 static u8 ir_add_bof = 0;
116
117 static struct usb_device_id id_table [] = {
118         { USB_DEVICE(0x050f, 0x0180) },         /* KC Technology, KC-180 */
119         { USB_DEVICE(0x08e9, 0x0100) },         /* XTNDAccess */
120         { USB_DEVICE(0x09c4, 0x0011) },         /* ACTiSys ACT-IR2000U */
121         { USB_INTERFACE_INFO (USB_CLASS_APP_SPEC, USB_CLASS_IRDA, 0) },
122         { }                                     /* Terminating entry */
123 };
124
125 MODULE_DEVICE_TABLE (usb, id_table);
126
127 static struct usb_driver ir_driver = {
128         .owner =        THIS_MODULE,
129         .name =         "ir-usb",
130         .probe =        usb_serial_probe,
131         .disconnect =   usb_serial_disconnect,
132         .id_table =     id_table,
133         .no_dynamic_id =        1,
134 };
135
136
137 static struct usb_serial_driver ir_device = {
138         .driver = {
139                 .owner =        THIS_MODULE,
140                 .name =         "ir-usb",
141         },
142         .description =          "IR Dongle",
143         .id_table =             id_table,
144         .num_interrupt_in =     1,
145         .num_bulk_in =          1,
146         .num_bulk_out =         1,
147         .num_ports =            1,
148         .set_termios =          ir_set_termios,
149         .attach =               ir_startup,
150         .open =                 ir_open,
151         .close =                ir_close,
152         .write =                ir_write,
153         .write_bulk_callback =  ir_write_bulk_callback,
154         .read_bulk_callback =   ir_read_bulk_callback,
155 };
156
157 static inline void irda_usb_dump_class_desc(struct irda_class_desc *desc)
158 {
159         dbg("bLength=%x", desc->bLength);
160         dbg("bDescriptorType=%x", desc->bDescriptorType);
161         dbg("bcdSpecRevision=%x", desc->bcdSpecRevision); 
162         dbg("bmDataSize=%x", desc->bmDataSize);
163         dbg("bmWindowSize=%x", desc->bmWindowSize);
164         dbg("bmMinTurnaroundTime=%d", desc->bmMinTurnaroundTime);
165         dbg("wBaudRate=%x", desc->wBaudRate);
166         dbg("bmAdditionalBOFs=%x", desc->bmAdditionalBOFs);
167         dbg("bIrdaRateSniff=%x", desc->bIrdaRateSniff);
168         dbg("bMaxUnicastList=%x", desc->bMaxUnicastList);
169 }
170
171 /*------------------------------------------------------------------*/
172 /*
173  * Function irda_usb_find_class_desc(dev, ifnum)
174  *
175  *    Returns instance of IrDA class descriptor, or NULL if not found
176  *
177  * The class descriptor is some extra info that IrDA USB devices will
178  * offer to us, describing their IrDA characteristics. We will use that in
179  * irda_usb_init_qos()
180  *
181  * Based on the same function in drivers/net/irda/irda-usb.c
182  */
183 static struct irda_class_desc *irda_usb_find_class_desc(struct usb_device *dev, unsigned int ifnum)
184 {
185         struct irda_class_desc *desc;
186         int ret;
187                 
188         desc = kmalloc(sizeof (struct irda_class_desc), GFP_KERNEL);
189         if (desc == NULL) 
190                 return NULL;
191         memset(desc, 0, sizeof(struct irda_class_desc));
192         
193         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev,0),
194                         IU_REQ_GET_CLASS_DESC,
195                         USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
196                         0, ifnum, desc, sizeof(*desc), 1000);
197         
198         dbg("%s -  ret=%d", __FUNCTION__, ret);
199         if (ret < sizeof(*desc)) {
200                 dbg("%s - class descriptor read %s (%d)",
201                                 __FUNCTION__, 
202                                 (ret<0) ? "failed" : "too short",
203                                 ret);
204                 goto error;
205         }
206         if (desc->bDescriptorType != USB_DT_IRDA) {
207                 dbg("%s - bad class descriptor type", __FUNCTION__);
208                 goto error;
209         }
210         
211         irda_usb_dump_class_desc(desc);
212         return desc;
213 error:
214         kfree(desc);
215         return NULL;
216 }
217
218
219 static u8 ir_xbof_change(u8 xbof)
220 {
221         u8 result;
222         /* reference irda-usb.c */
223         switch(xbof) {
224                 case 48: result = 0x10; break;
225                 case 28:
226                 case 24: result = 0x20; break;
227                 default:
228                 case 12: result = 0x30; break;
229                 case  5:
230                 case  6: result = 0x40; break;
231                 case  3: result = 0x50; break;
232                 case  2: result = 0x60; break;
233                 case  1: result = 0x70; break;
234                 case  0: result = 0x80; break;
235         }
236         return(result);
237 }
238
239
240 static int ir_startup (struct usb_serial *serial)
241 {
242         struct irda_class_desc *irda_desc;
243
244         irda_desc = irda_usb_find_class_desc (serial->dev, 0);
245         if (irda_desc == NULL) {
246                 dev_err (&serial->dev->dev, "IRDA class descriptor not found, device not bound\n");
247                 return -ENODEV;
248         }
249
250         dbg ("%s - Baud rates supported:%s%s%s%s%s%s%s%s%s",
251                 __FUNCTION__,
252                 (irda_desc->wBaudRate & 0x0001) ? " 2400"    : "",
253                 (irda_desc->wBaudRate & 0x0002) ? " 9600"    : "",
254                 (irda_desc->wBaudRate & 0x0004) ? " 19200"   : "",
255                 (irda_desc->wBaudRate & 0x0008) ? " 38400"   : "",
256                 (irda_desc->wBaudRate & 0x0010) ? " 57600"   : "",
257                 (irda_desc->wBaudRate & 0x0020) ? " 115200"  : "",
258                 (irda_desc->wBaudRate & 0x0040) ? " 576000"  : "",
259                 (irda_desc->wBaudRate & 0x0080) ? " 1152000" : "",
260                 (irda_desc->wBaudRate & 0x0100) ? " 4000000" : "");
261
262         switch( irda_desc->bmAdditionalBOFs ) {
263                 case 0x01: ir_add_bof = 48; break;
264                 case 0x02: ir_add_bof = 24; break;
265                 case 0x04: ir_add_bof = 12; break;
266                 case 0x08: ir_add_bof =  6; break;
267                 case 0x10: ir_add_bof =  3; break;
268                 case 0x20: ir_add_bof =  2; break;
269                 case 0x40: ir_add_bof =  1; break;
270                 case 0x80: ir_add_bof =  0; break;
271                 default:;
272         }
273
274         kfree (irda_desc);
275
276         return 0;               
277 }
278
279 static int ir_open (struct usb_serial_port *port, struct file *filp)
280 {
281         char *buffer;
282         int result = 0;
283
284         dbg("%s - port %d", __FUNCTION__, port->number);
285
286         if (buffer_size) {
287                 /* override the default buffer sizes */
288                 buffer = kmalloc (buffer_size, GFP_KERNEL);
289                 if (!buffer) {
290                         dev_err (&port->dev, "%s - out of memory.\n", __FUNCTION__);
291                         return -ENOMEM;
292                 }
293                 kfree (port->read_urb->transfer_buffer);
294                 port->read_urb->transfer_buffer = buffer;
295                 port->read_urb->transfer_buffer_length = buffer_size;
296
297                 buffer = kmalloc (buffer_size, GFP_KERNEL);
298                 if (!buffer) {
299                         dev_err (&port->dev, "%s - out of memory.\n", __FUNCTION__);
300                         return -ENOMEM;
301                 }
302                 kfree (port->write_urb->transfer_buffer);
303                 port->write_urb->transfer_buffer = buffer;
304                 port->write_urb->transfer_buffer_length = buffer_size;
305                 port->bulk_out_size = buffer_size;
306         }
307
308         /* Start reading from the device */
309         usb_fill_bulk_urb (
310                 port->read_urb,
311                 port->serial->dev, 
312                 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
313                 port->read_urb->transfer_buffer,
314                 port->read_urb->transfer_buffer_length,
315                 ir_read_bulk_callback,
316                 port);
317         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
318         if (result)
319                 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
320
321         return result;
322 }
323
324 static void ir_close (struct usb_serial_port *port, struct file * filp)
325 {
326         dbg("%s - port %d", __FUNCTION__, port->number);
327                          
328         /* shutdown our bulk read */
329         usb_kill_urb(port->read_urb);
330 }
331
332 static int ir_write (struct usb_serial_port *port, const unsigned char *buf, int count)
333 {
334         unsigned char *transfer_buffer;
335         int result;
336         int transfer_size;
337
338         dbg("%s - port = %d, count = %d", __FUNCTION__, port->number, count);
339
340         if (!port->tty) {
341                 dev_err (&port->dev, "%s - no tty???\n", __FUNCTION__);
342                 return 0;
343         }
344
345         if (count == 0)
346                 return 0;
347
348         spin_lock(&port->lock);
349         if (port->write_urb_busy) {
350                 spin_unlock(&port->lock);
351                 dbg("%s - already writing", __FUNCTION__);
352                 return 0;
353         }
354         port->write_urb_busy = 1;
355         spin_unlock(&port->lock);
356
357         transfer_buffer = port->write_urb->transfer_buffer;
358         transfer_size = min(count, port->bulk_out_size - 1);
359
360         /*
361          * The first byte of the packet we send to the device contains an
362          * inband header which indicates an additional number of BOFs and
363          * a baud rate change.
364          *
365          * See section 5.4.2.2 of the USB IrDA spec.
366          */
367         *transfer_buffer = ir_xbof | ir_baud;
368         ++transfer_buffer;
369
370         memcpy (transfer_buffer, buf, transfer_size);
371
372         usb_fill_bulk_urb (
373                 port->write_urb,
374                 port->serial->dev,
375                 usb_sndbulkpipe(port->serial->dev,
376                         port->bulk_out_endpointAddress),
377                 port->write_urb->transfer_buffer,
378                 transfer_size + 1,
379                 ir_write_bulk_callback,
380                 port);
381
382         port->write_urb->transfer_flags = URB_ZERO_PACKET;
383
384         result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
385         if (result) {
386                 port->write_urb_busy = 0;
387                 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
388         } else
389                 result = transfer_size;
390
391         return result;
392 }
393
394 static void ir_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
395 {
396         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
397
398         dbg("%s - port %d", __FUNCTION__, port->number);
399
400         port->write_urb_busy = 0;
401         if (urb->status) {
402                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
403                 return;
404         }
405
406         usb_serial_debug_data (
407                 debug,
408                 &port->dev,
409                 __FUNCTION__,
410                 urb->actual_length,
411                 urb->transfer_buffer);
412
413         schedule_work(&port->work);
414 }
415
416 static void ir_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
417 {
418         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
419         struct tty_struct *tty;
420         unsigned char *data = urb->transfer_buffer;
421         int result;
422
423         dbg("%s - port %d", __FUNCTION__, port->number);
424
425         if (!port->open_count) {
426                 dbg("%s - port closed.", __FUNCTION__);
427                 return;
428         }
429
430         switch (urb->status) {
431
432                 case 0: /* Successful */
433
434                         /*
435                          * The first byte of the packet we get from the device
436                          * contains a busy indicator and baud rate change.
437                          * See section 5.4.1.2 of the USB IrDA spec.
438                          */
439                         if ((*data & 0x0f) > 0)
440                                 ir_baud = *data & 0x0f;
441
442                         usb_serial_debug_data (
443                                 debug,
444                                 &port->dev,
445                                 __FUNCTION__,
446                                 urb->actual_length,
447                                 data);
448
449                         /*
450                          * Bypass flip-buffers, and feed the ldisc directly
451                          * due to our potentially large buffer size.  Since we
452                          * used to set low_latency, this is exactly what the
453                          * tty layer did anyway :)
454                          */
455                         tty = port->tty;
456
457                         /*
458                          *      FIXME: must not do this in IRQ context,
459                          *      must honour TTY_DONT_FLIP
460                          */
461                         tty->ldisc.receive_buf(
462                                 tty,
463                                 data+1,
464                                 NULL,
465                                 urb->actual_length-1);
466
467                         /*
468                          * No break here.
469                          * We want to resubmit the urb so we can read
470                          * again.
471                          */
472
473                 case -EPROTO: /* taking inspiration from pl2303.c */
474
475                         /* Continue trying to always read */
476                         usb_fill_bulk_urb (
477                                 port->read_urb,
478                                 port->serial->dev, 
479                                 usb_rcvbulkpipe(port->serial->dev,
480                                         port->bulk_in_endpointAddress),
481                                 port->read_urb->transfer_buffer,
482                                 port->read_urb->transfer_buffer_length,
483                                 ir_read_bulk_callback,
484                                 port);
485
486                         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
487                         if (result)
488                                 dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n",
489                                         __FUNCTION__, result);
490
491                         break ;
492
493                 default:
494                         dbg("%s - nonzero read bulk status received: %d",
495                                 __FUNCTION__, 
496                                 urb->status);
497                         break ;
498
499         }
500
501         return;
502 }
503
504 static void ir_set_termios (struct usb_serial_port *port, struct termios *old_termios)
505 {
506         unsigned char *transfer_buffer;
507         unsigned int cflag;
508         int result;
509
510         dbg("%s - port %d", __FUNCTION__, port->number);
511
512         if ((!port->tty) || (!port->tty->termios)) {
513                 dbg("%s - no tty structures", __FUNCTION__);
514                 return;
515         }
516
517         cflag = port->tty->termios->c_cflag;
518         /* check that they really want us to change something */
519         if (old_termios) {
520                 if ((cflag == old_termios->c_cflag) &&
521                     (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
522                         dbg("%s - nothing to change...", __FUNCTION__);
523                         return;
524                 }
525         }
526
527         /* All we can change is the baud rate */
528         if (cflag & CBAUD) {
529
530                 dbg ("%s - asking for baud %d",
531                         __FUNCTION__,
532                         tty_get_baud_rate(port->tty));
533
534                 /* 
535                  * FIXME, we should compare the baud request against the
536                  * capability stated in the IR header that we got in the
537                  * startup function.
538                  */
539                 switch (cflag & CBAUD) {
540                         case B2400:    ir_baud = SPEED_2400;    break;
541                         default:
542                         case B9600:    ir_baud = SPEED_9600;    break;
543                         case B19200:   ir_baud = SPEED_19200;   break;
544                         case B38400:   ir_baud = SPEED_38400;   break;
545                         case B57600:   ir_baud = SPEED_57600;   break;
546                         case B115200:  ir_baud = SPEED_115200;  break;
547                         case B576000:  ir_baud = SPEED_576000;  break;
548                         case B1152000: ir_baud = SPEED_1152000; break;
549 #ifdef B4000000
550                         case B4000000: ir_baud = SPEED_4000000; break;
551 #endif
552                 }
553
554                 if (xbof == -1) {
555                         ir_xbof = ir_xbof_change(ir_add_bof);
556                 } else {
557                         ir_xbof = ir_xbof_change(xbof) ;
558                 }
559
560                 /* Notify the tty driver that the termios have changed. */
561                 port->tty->ldisc.set_termios(port->tty, NULL);
562
563                 /* FIXME need to check to see if our write urb is busy right
564                  * now, or use a urb pool.
565                  *
566                  * send the baud change out on an "empty" data packet
567                  */
568                 transfer_buffer = port->write_urb->transfer_buffer;
569                 *transfer_buffer = ir_xbof | ir_baud;
570
571                 usb_fill_bulk_urb (
572                         port->write_urb,
573                         port->serial->dev,
574                         usb_sndbulkpipe(port->serial->dev,
575                                 port->bulk_out_endpointAddress),
576                         port->write_urb->transfer_buffer,
577                         1,
578                         ir_write_bulk_callback,
579                         port);
580
581                 port->write_urb->transfer_flags = URB_ZERO_PACKET;
582
583                 result = usb_submit_urb (port->write_urb, GFP_KERNEL);
584                 if (result)
585                         dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
586         }
587         return;
588 }
589
590
591 static int __init ir_init (void)
592 {
593         int retval;
594         retval = usb_serial_register(&ir_device);
595         if (retval)
596                 goto failed_usb_serial_register;
597         retval = usb_register(&ir_driver);
598         if (retval) 
599                 goto failed_usb_register;
600         info(DRIVER_DESC " " DRIVER_VERSION);
601         return 0;
602 failed_usb_register:
603         usb_serial_deregister(&ir_device);
604 failed_usb_serial_register:
605         return retval;
606 }
607
608
609 static void __exit ir_exit (void)
610 {
611         usb_deregister (&ir_driver);
612         usb_serial_deregister (&ir_device);
613 }
614
615
616 module_init(ir_init);
617 module_exit(ir_exit);
618
619 MODULE_AUTHOR(DRIVER_AUTHOR);
620 MODULE_DESCRIPTION(DRIVER_DESC);
621 MODULE_LICENSE("GPL");
622
623 module_param(debug, bool, S_IRUGO | S_IWUSR);
624 MODULE_PARM_DESC(debug, "Debug enabled or not");
625 module_param(xbof, int, 0);
626 MODULE_PARM_DESC(xbof, "Force specific number of XBOFs");
627 module_param(buffer_size, int, 0);
628 MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers");
629