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