USB: belkin_sa: minor clean-ups
[linux-2.6.git] / drivers / usb / serial / belkin_sa.c
1 /*
2  * Belkin USB Serial Adapter Driver
3  *
4  *  Copyright (C) 2000          William Greathouse (wgreathouse@smva.com)
5  *  Copyright (C) 2000-2001     Greg Kroah-Hartman (greg@kroah.com)
6  *
7  *  This program is largely derived from work by the linux-usb group
8  *  and associated source files.  Please see the usb/serial files for
9  *  individual credits and copyrights.
10  *
11  *      This program is free software; you can redistribute it and/or modify
12  *      it under the terms of the GNU General Public License as published by
13  *      the Free Software Foundation; either version 2 of the License, or
14  *      (at your option) any later version.
15  *
16  * See Documentation/usb/usb-serial.txt for more information on using this
17  * driver
18  *
19  * TODO:
20  * -- Add true modem contol line query capability.  Currently we track the
21  *    states reported by the interrupt and the states we request.
22  * -- Add error reporting back to application for UART error conditions.
23  *    Just point me at how to implement this and I'll do it. I've put the
24  *    framework in, but haven't analyzed the "tty_flip" interface yet.
25  * -- Add support for flush commands
26  * -- Add everything that is missing :)
27  *
28  * 27-Nov-2001 gkh
29  *      compressed all the differnent device entries into 1.
30  *
31  * 30-May-2001 gkh
32  *      switched from using spinlock to a semaphore, which fixes lots of
33  *      problems.
34  *
35  * 08-Apr-2001 gb
36  *      - Identify version on module load.
37  *
38  * 12-Mar-2001 gkh
39  *      - Added support for the GoHubs GO-COM232 device which is the same as the
40  *        Peracom device.
41  *
42  * 06-Nov-2000 gkh
43  *      - Added support for the old Belkin and Peracom devices.
44  *      - Made the port able to be opened multiple times.
45  *      - Added some defaults incase the line settings are things these devices
46  *        can't support.
47  *
48  * 18-Oct-2000 William Greathouse
49  *    Released into the wild (linux-usb-devel)
50  *
51  * 17-Oct-2000 William Greathouse
52  *    Add code to recognize firmware version and set hardware flow control
53  *    appropriately.  Belkin states that firmware prior to 3.05 does not
54  *    operate correctly in hardware handshake mode.  I have verified this
55  *    on firmware 2.05 -- for both RTS and DTR input flow control, the control
56  *    line is not reset.  The test performed by the Belkin Win* driver is
57  *    to enable hardware flow control for firmware 2.06 or greater and
58  *    for 1.00 or prior.  I am only enabling for 2.06 or greater.
59  *
60  * 12-Oct-2000 William Greathouse
61  *    First cut at supporting Belkin USB Serial Adapter F5U103
62  *    I did not have a copy of the original work to support this
63  *    adapter, so pardon any stupid mistakes.  All of the information
64  *    I am using to write this driver was acquired by using a modified
65  *    UsbSnoop on Windows2000 and from examining the other USB drivers.
66  */
67
68 #include <linux/kernel.h>
69 #include <linux/errno.h>
70 #include <linux/init.h>
71 #include <linux/slab.h>
72 #include <linux/tty.h>
73 #include <linux/tty_driver.h>
74 #include <linux/tty_flip.h>
75 #include <linux/module.h>
76 #include <linux/spinlock.h>
77 #include <linux/uaccess.h>
78 #include <linux/usb.h>
79 #include <linux/usb/serial.h>
80 #include "belkin_sa.h"
81
82 static int debug;
83
84 /*
85  * Version Information
86  */
87 #define DRIVER_VERSION "v1.2"
88 #define DRIVER_AUTHOR "William Greathouse <wgreathouse@smva.com>"
89 #define DRIVER_DESC "USB Belkin Serial converter driver"
90
91 /* function prototypes for a Belkin USB Serial Adapter F5U103 */
92 static int  belkin_sa_startup(struct usb_serial *serial);
93 static void belkin_sa_release(struct usb_serial *serial);
94 static int  belkin_sa_open(struct tty_struct *tty,
95                         struct usb_serial_port *port);
96 static void belkin_sa_close(struct usb_serial_port *port);
97 static void belkin_sa_read_int_callback(struct urb *urb);
98 static void belkin_sa_set_termios(struct tty_struct *tty,
99                         struct usb_serial_port *port, struct ktermios * old);
100 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state);
101 static int  belkin_sa_tiocmget(struct tty_struct *tty, struct file *file);
102 static int  belkin_sa_tiocmset(struct tty_struct *tty, struct file *file,
103                                         unsigned int set, unsigned int clear);
104
105
106 static const struct usb_device_id id_table_combined[] = {
107         { USB_DEVICE(BELKIN_SA_VID, BELKIN_SA_PID) },
108         { USB_DEVICE(BELKIN_OLD_VID, BELKIN_OLD_PID) },
109         { USB_DEVICE(PERACOM_VID, PERACOM_PID) },
110         { USB_DEVICE(GOHUBS_VID, GOHUBS_PID) },
111         { USB_DEVICE(GOHUBS_VID, HANDYLINK_PID) },
112         { USB_DEVICE(BELKIN_DOCKSTATION_VID, BELKIN_DOCKSTATION_PID) },
113         { }     /* Terminating entry */
114 };
115 MODULE_DEVICE_TABLE(usb, id_table_combined);
116
117 static struct usb_driver belkin_driver = {
118         .name =         "belkin",
119         .probe =        usb_serial_probe,
120         .disconnect =   usb_serial_disconnect,
121         .id_table =     id_table_combined,
122         .no_dynamic_id =        1,
123 };
124
125 /* All of the device info needed for the serial converters */
126 static struct usb_serial_driver belkin_device = {
127         .driver = {
128                 .owner =        THIS_MODULE,
129                 .name =         "belkin",
130         },
131         .description =          "Belkin / Peracom / GoHubs USB Serial Adapter",
132         .usb_driver =           &belkin_driver,
133         .id_table =             id_table_combined,
134         .num_ports =            1,
135         .open =                 belkin_sa_open,
136         .close =                belkin_sa_close,
137         .read_int_callback =    belkin_sa_read_int_callback,
138                                         /* How we get the status info */
139         .set_termios =          belkin_sa_set_termios,
140         .break_ctl =            belkin_sa_break_ctl,
141         .tiocmget =             belkin_sa_tiocmget,
142         .tiocmset =             belkin_sa_tiocmset,
143         .attach =               belkin_sa_startup,
144         .release =              belkin_sa_release,
145 };
146
147 struct belkin_sa_private {
148         spinlock_t              lock;
149         unsigned long           control_state;
150         unsigned char           last_lsr;
151         unsigned char           last_msr;
152         int                     bad_flow_control;
153 };
154
155
156 /*
157  * ***************************************************************************
158  * Belkin USB Serial Adapter F5U103 specific driver functions
159  * ***************************************************************************
160  */
161
162 #define WDR_TIMEOUT 5000 /* default urb timeout */
163
164 /* assumes that struct usb_serial *serial is available */
165 #define BSA_USB_CMD(c, v) usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), \
166                                             (c), BELKIN_SA_SET_REQUEST_TYPE, \
167                                             (v), 0, NULL, 0, WDR_TIMEOUT)
168
169 /* do some startup allocations not currently performed by usb_serial_probe() */
170 static int belkin_sa_startup(struct usb_serial *serial)
171 {
172         struct usb_device *dev = serial->dev;
173         struct belkin_sa_private *priv;
174
175         /* allocate the private data structure */
176         priv = kmalloc(sizeof(struct belkin_sa_private), GFP_KERNEL);
177         if (!priv)
178                 return -1; /* error */
179         /* set initial values for control structures */
180         spin_lock_init(&priv->lock);
181         priv->control_state = 0;
182         priv->last_lsr = 0;
183         priv->last_msr = 0;
184         /* see comments at top of file */
185         priv->bad_flow_control =
186                 (le16_to_cpu(dev->descriptor.bcdDevice) <= 0x0206) ? 1 : 0;
187         dev_info(&dev->dev, "bcdDevice: %04x, bfc: %d\n",
188                                         le16_to_cpu(dev->descriptor.bcdDevice),
189                                         priv->bad_flow_control);
190
191         init_waitqueue_head(&serial->port[0]->write_wait);
192         usb_set_serial_port_data(serial->port[0], priv);
193
194         return 0;
195 }
196
197 static void belkin_sa_release(struct usb_serial *serial)
198 {
199         int i;
200
201         dbg("%s", __func__);
202
203         for (i = 0; i < serial->num_ports; ++i)
204                 kfree(usb_get_serial_port_data(serial->port[i]));
205 }
206
207 static int belkin_sa_open(struct tty_struct *tty,
208                                         struct usb_serial_port *port)
209 {
210         int retval = 0;
211
212         dbg("%s port %d", __func__, port->number);
213
214         /*Start reading from the device*/
215         /* TODO: Look at possibility of submitting multiple URBs to device to
216          *       enhance buffering.  Win trace shows 16 initial read URBs.
217          */
218         port->read_urb->dev = port->serial->dev;
219         retval = usb_submit_urb(port->read_urb, GFP_KERNEL);
220         if (retval) {
221                 dev_err(&port->dev, "usb_submit_urb(read bulk) failed\n");
222                 goto exit;
223         }
224
225         port->interrupt_in_urb->dev = port->serial->dev;
226         retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
227         if (retval) {
228                 usb_kill_urb(port->read_urb);
229                 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
230         }
231
232 exit:
233         return retval;
234 }
235
236 static void belkin_sa_close(struct usb_serial_port *port)
237 {
238         dbg("%s port %d", __func__, port->number);
239
240         usb_serial_generic_close(port);
241         usb_kill_urb(port->interrupt_in_urb);
242 }
243
244 static void belkin_sa_read_int_callback(struct urb *urb)
245 {
246         struct usb_serial_port *port = urb->context;
247         struct belkin_sa_private *priv;
248         unsigned char *data = urb->transfer_buffer;
249         int retval;
250         int status = urb->status;
251         unsigned long flags;
252
253         switch (status) {
254         case 0:
255                 /* success */
256                 break;
257         case -ECONNRESET:
258         case -ENOENT:
259         case -ESHUTDOWN:
260                 /* this urb is terminated, clean up */
261                 dbg("%s - urb shutting down with status: %d",
262                     __func__, status);
263                 return;
264         default:
265                 dbg("%s - nonzero urb status received: %d",
266                     __func__, status);
267                 goto exit;
268         }
269
270         usb_serial_debug_data(debug, &port->dev, __func__,
271                                         urb->actual_length, data);
272
273         /* Handle known interrupt data */
274         /* ignore data[0] and data[1] */
275
276         priv = usb_get_serial_port_data(port);
277         spin_lock_irqsave(&priv->lock, flags);
278         priv->last_msr = data[BELKIN_SA_MSR_INDEX];
279
280         /* Record Control Line states */
281         if (priv->last_msr & BELKIN_SA_MSR_DSR)
282                 priv->control_state |= TIOCM_DSR;
283         else
284                 priv->control_state &= ~TIOCM_DSR;
285
286         if (priv->last_msr & BELKIN_SA_MSR_CTS)
287                 priv->control_state |= TIOCM_CTS;
288         else
289                 priv->control_state &= ~TIOCM_CTS;
290
291         if (priv->last_msr & BELKIN_SA_MSR_RI)
292                 priv->control_state |= TIOCM_RI;
293         else
294                 priv->control_state &= ~TIOCM_RI;
295
296         if (priv->last_msr & BELKIN_SA_MSR_CD)
297                 priv->control_state |= TIOCM_CD;
298         else
299                 priv->control_state &= ~TIOCM_CD;
300
301         /* Now to report any errors */
302         priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
303 #if 0
304         /*
305          * fill in the flip buffer here, but I do not know the relation
306          * to the current/next receive buffer or characters.  I need
307          * to look in to this before committing any code.
308          */
309         if (priv->last_lsr & BELKIN_SA_LSR_ERR) {
310                 tty = tty_port_tty_get(&port->port);
311                 /* Overrun Error */
312                 if (priv->last_lsr & BELKIN_SA_LSR_OE) {
313                 }
314                 /* Parity Error */
315                 if (priv->last_lsr & BELKIN_SA_LSR_PE) {
316                 }
317                 /* Framing Error */
318                 if (priv->last_lsr & BELKIN_SA_LSR_FE) {
319                 }
320                 /* Break Indicator */
321                 if (priv->last_lsr & BELKIN_SA_LSR_BI) {
322                 }
323                 tty_kref_put(tty);
324         }
325 #endif
326         spin_unlock_irqrestore(&priv->lock, flags);
327 exit:
328         retval = usb_submit_urb(urb, GFP_ATOMIC);
329         if (retval)
330                 dev_err(&port->dev, "%s - usb_submit_urb failed with "
331                         "result %d\n", __func__, retval);
332 }
333
334 static void belkin_sa_set_termios(struct tty_struct *tty,
335                 struct usb_serial_port *port, struct ktermios *old_termios)
336 {
337         struct usb_serial *serial = port->serial;
338         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
339         unsigned int iflag;
340         unsigned int cflag;
341         unsigned int old_iflag = 0;
342         unsigned int old_cflag = 0;
343         __u16 urb_value = 0; /* Will hold the new flags */
344         unsigned long flags;
345         unsigned long control_state;
346         int bad_flow_control;
347         speed_t baud;
348         struct ktermios *termios = tty->termios;
349
350         iflag = termios->c_iflag;
351         cflag = termios->c_cflag;
352
353         termios->c_cflag &= ~CMSPAR;
354
355         /* get a local copy of the current port settings */
356         spin_lock_irqsave(&priv->lock, flags);
357         control_state = priv->control_state;
358         bad_flow_control = priv->bad_flow_control;
359         spin_unlock_irqrestore(&priv->lock, flags);
360
361         old_iflag = old_termios->c_iflag;
362         old_cflag = old_termios->c_cflag;
363
364         /* Set the baud rate */
365         if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
366                 /* reassert DTR and (maybe) RTS on transition from B0 */
367                 if ((old_cflag & CBAUD) == B0) {
368                         control_state |= (TIOCM_DTR|TIOCM_RTS);
369                         if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
370                                 dev_err(&port->dev, "Set DTR error\n");
371                         /* don't set RTS if using hardware flow control */
372                         if (!(old_cflag & CRTSCTS))
373                                 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST
374                                                                 , 1) < 0)
375                                         dev_err(&port->dev, "Set RTS error\n");
376                 }
377         }
378
379         baud = tty_get_baud_rate(tty);
380         if (baud) {
381                 urb_value = BELKIN_SA_BAUD(baud);
382                 /* Clip to maximum speed */
383                 if (urb_value == 0)
384                         urb_value = 1;
385                 /* Turn it back into a resulting real baud rate */
386                 baud = BELKIN_SA_BAUD(urb_value);
387
388                 /* Report the actual baud rate back to the caller */
389                 tty_encode_baud_rate(tty, baud, baud);
390                 if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
391                         dev_err(&port->dev, "Set baudrate error\n");
392         } else {
393                 /* Disable flow control */
394                 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST,
395                                                 BELKIN_SA_FLOW_NONE) < 0)
396                         dev_err(&port->dev, "Disable flowcontrol error\n");
397                 /* Drop RTS and DTR */
398                 control_state &= ~(TIOCM_DTR | TIOCM_RTS);
399                 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
400                         dev_err(&port->dev, "DTR LOW error\n");
401                 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
402                         dev_err(&port->dev, "RTS LOW error\n");
403         }
404
405         /* set the parity */
406         if ((cflag ^ old_cflag) & (PARENB | PARODD)) {
407                 if (cflag & PARENB)
408                         urb_value = (cflag & PARODD) ?  BELKIN_SA_PARITY_ODD
409                                                 : BELKIN_SA_PARITY_EVEN;
410                 else
411                         urb_value = BELKIN_SA_PARITY_NONE;
412                 if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
413                         dev_err(&port->dev, "Set parity error\n");
414         }
415
416         /* set the number of data bits */
417         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
418                 switch (cflag & CSIZE) {
419                 case CS5:
420                         urb_value = BELKIN_SA_DATA_BITS(5);
421                         break;
422                 case CS6:
423                         urb_value = BELKIN_SA_DATA_BITS(6);
424                         break;
425                 case CS7:
426                         urb_value = BELKIN_SA_DATA_BITS(7);
427                         break;
428                 case CS8:
429                         urb_value = BELKIN_SA_DATA_BITS(8);
430                         break;
431                 default: dbg("CSIZE was not CS5-CS8, using default of 8");
432                         urb_value = BELKIN_SA_DATA_BITS(8);
433                         break;
434                 }
435                 if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
436                         dev_err(&port->dev, "Set data bits error\n");
437         }
438
439         /* set the number of stop bits */
440         if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
441                 urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2)
442                                                 : BELKIN_SA_STOP_BITS(1);
443                 if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST,
444                                                         urb_value) < 0)
445                         dev_err(&port->dev, "Set stop bits error\n");
446         }
447
448         /* Set flow control */
449         if (((iflag ^ old_iflag) & (IXOFF | IXON)) ||
450                 ((cflag ^ old_cflag) & CRTSCTS)) {
451                 urb_value = 0;
452                 if ((iflag & IXOFF) || (iflag & IXON))
453                         urb_value |= (BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
454                 else
455                         urb_value &= ~(BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
456
457                 if (cflag & CRTSCTS)
458                         urb_value |=  (BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
459                 else
460                         urb_value &= ~(BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
461
462                 if (bad_flow_control)
463                         urb_value &= ~(BELKIN_SA_FLOW_IRTS);
464
465                 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
466                         dev_err(&port->dev, "Set flow control error\n");
467         }
468
469         /* save off the modified port settings */
470         spin_lock_irqsave(&priv->lock, flags);
471         priv->control_state = control_state;
472         spin_unlock_irqrestore(&priv->lock, flags);
473 }
474
475 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state)
476 {
477         struct usb_serial_port *port = tty->driver_data;
478         struct usb_serial *serial = port->serial;
479
480         if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
481                 dev_err(&port->dev, "Set break_ctl %d\n", break_state);
482 }
483
484 static int belkin_sa_tiocmget(struct tty_struct *tty, struct file *file)
485 {
486         struct usb_serial_port *port = tty->driver_data;
487         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
488         unsigned long control_state;
489         unsigned long flags;
490
491         dbg("%s", __func__);
492
493         spin_lock_irqsave(&priv->lock, flags);
494         control_state = priv->control_state;
495         spin_unlock_irqrestore(&priv->lock, flags);
496
497         return control_state;
498 }
499
500 static int belkin_sa_tiocmset(struct tty_struct *tty, struct file *file,
501                                unsigned int set, unsigned int clear)
502 {
503         struct usb_serial_port *port = tty->driver_data;
504         struct usb_serial *serial = port->serial;
505         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
506         unsigned long control_state;
507         unsigned long flags;
508         int retval;
509         int rts = 0;
510         int dtr = 0;
511
512         dbg("%s", __func__);
513
514         spin_lock_irqsave(&priv->lock, flags);
515         control_state = priv->control_state;
516
517         if (set & TIOCM_RTS) {
518                 control_state |= TIOCM_RTS;
519                 rts = 1;
520         }
521         if (set & TIOCM_DTR) {
522                 control_state |= TIOCM_DTR;
523                 dtr = 1;
524         }
525         if (clear & TIOCM_RTS) {
526                 control_state &= ~TIOCM_RTS;
527                 rts = 0;
528         }
529         if (clear & TIOCM_DTR) {
530                 control_state &= ~TIOCM_DTR;
531                 dtr = 0;
532         }
533
534         priv->control_state = control_state;
535         spin_unlock_irqrestore(&priv->lock, flags);
536
537         retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
538         if (retval < 0) {
539                 dev_err(&port->dev, "Set RTS error %d\n", retval);
540                 goto exit;
541         }
542
543         retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
544         if (retval < 0) {
545                 dev_err(&port->dev, "Set DTR error %d\n", retval);
546                 goto exit;
547         }
548 exit:
549         return retval;
550 }
551
552
553 static int __init belkin_sa_init(void)
554 {
555         int retval;
556         retval = usb_serial_register(&belkin_device);
557         if (retval)
558                 goto failed_usb_serial_register;
559         retval = usb_register(&belkin_driver);
560         if (retval)
561                 goto failed_usb_register;
562         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
563                DRIVER_DESC "\n");
564         return 0;
565 failed_usb_register:
566         usb_serial_deregister(&belkin_device);
567 failed_usb_serial_register:
568         return retval;
569 }
570
571 static void __exit belkin_sa_exit (void)
572 {
573         usb_deregister(&belkin_driver);
574         usb_serial_deregister(&belkin_device);
575 }
576
577
578 module_init(belkin_sa_init);
579 module_exit(belkin_sa_exit);
580
581 MODULE_AUTHOR(DRIVER_AUTHOR);
582 MODULE_DESCRIPTION(DRIVER_DESC);
583 MODULE_VERSION(DRIVER_VERSION);
584 MODULE_LICENSE("GPL");
585
586 module_param(debug, bool, S_IRUGO | S_IWUSR);
587 MODULE_PARM_DESC(debug, "Debug enabled or not");