2 * Belkin USB Serial Adapter Driver
4 * Copyright (C) 2000 William Greathouse (wgreathouse@smva.com)
5 * Copyright (C) 2000-2001 Greg Kroah-Hartman (greg@kroah.com)
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.
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.
16 * See Documentation/usb/usb-serial.txt for more information on using this driver
19 * -- Add true modem contol line query capability. Currently we track the
20 * states reported by the interrupt and the states we request.
21 * -- Add error reporting back to application for UART error conditions.
22 * Just point me at how to implement this and I'll do it. I've put the
23 * framework in, but haven't analyzed the "tty_flip" interface yet.
24 * -- Add support for flush commands
25 * -- Add everything that is missing :)
28 * compressed all the differnent device entries into 1.
31 * switched from using spinlock to a semaphore, which fixes lots of problems.
34 * - Identify version on module load.
37 * - Added support for the GoHubs GO-COM232 device which is the same as the
41 * - Added support for the old Belkin and Peracom devices.
42 * - Made the port able to be opened multiple times.
43 * - Added some defaults incase the line settings are things these devices
46 * 18-Oct-2000 William Greathouse
47 * Released into the wild (linux-usb-devel)
49 * 17-Oct-2000 William Greathouse
50 * Add code to recognize firmware version and set hardware flow control
51 * appropriately. Belkin states that firmware prior to 3.05 does not
52 * operate correctly in hardware handshake mode. I have verified this
53 * on firmware 2.05 -- for both RTS and DTR input flow control, the control
54 * line is not reset. The test performed by the Belkin Win* driver is
55 * to enable hardware flow control for firmware 2.06 or greater and
56 * for 1.00 or prior. I am only enabling for 2.06 or greater.
58 * 12-Oct-2000 William Greathouse
59 * First cut at supporting Belkin USB Serial Adapter F5U103
60 * I did not have a copy of the original work to support this
61 * adapter, so pardon any stupid mistakes. All of the information
62 * I am using to write this driver was acquired by using a modified
63 * UsbSnoop on Windows2000 and from examining the other USB drivers.
66 #include <linux/config.h>
67 #include <linux/kernel.h>
68 #include <linux/errno.h>
69 #include <linux/init.h>
70 #include <linux/slab.h>
71 #include <linux/tty.h>
72 #include <linux/tty_driver.h>
73 #include <linux/tty_flip.h>
74 #include <linux/module.h>
75 #include <linux/spinlock.h>
76 #include <asm/uaccess.h>
77 #include <linux/usb.h>
79 #ifdef CONFIG_USB_SERIAL_DEBUG
85 #include "usb-serial.h"
86 #include "belkin_sa.h"
91 #define DRIVER_VERSION "v1.2"
92 #define DRIVER_AUTHOR "William Greathouse <wgreathouse@smva.com>"
93 #define DRIVER_DESC "USB Belkin Serial converter driver"
95 /* function prototypes for a Belkin USB Serial Adapter F5U103 */
96 static int belkin_sa_startup (struct usb_serial *serial);
97 static void belkin_sa_shutdown (struct usb_serial *serial);
98 static int belkin_sa_open (struct usb_serial_port *port, struct file *filp);
99 static void belkin_sa_close (struct usb_serial_port *port, struct file *filp);
100 static void belkin_sa_read_int_callback (struct urb *urb, struct pt_regs *regs);
101 static void belkin_sa_set_termios (struct usb_serial_port *port, struct termios * old);
102 static int belkin_sa_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
103 static void belkin_sa_break_ctl (struct usb_serial_port *port, int break_state );
104 static int belkin_sa_tiocmget (struct usb_serial_port *port, struct file *file);
105 static int belkin_sa_tiocmset (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
108 static struct usb_device_id id_table_combined [] = {
109 { USB_DEVICE(BELKIN_SA_VID, BELKIN_SA_PID) },
110 { USB_DEVICE(BELKIN_OLD_VID, BELKIN_OLD_PID) },
111 { USB_DEVICE(PERACOM_VID, PERACOM_PID) },
112 { USB_DEVICE(GOHUBS_VID, GOHUBS_PID) },
113 { USB_DEVICE(GOHUBS_VID, HANDYLINK_PID) },
114 { USB_DEVICE(BELKIN_DOCKSTATION_VID, BELKIN_DOCKSTATION_PID) },
115 { } /* Terminating entry */
118 MODULE_DEVICE_TABLE (usb, id_table_combined);
120 static struct usb_driver belkin_driver = {
121 .owner = THIS_MODULE,
123 .probe = usb_serial_probe,
124 .disconnect = usb_serial_disconnect,
125 .id_table = id_table_combined,
128 /* All of the device info needed for the serial converters */
129 static struct usb_serial_device_type belkin_device = {
130 .owner = THIS_MODULE,
131 .name = "Belkin / Peracom / GoHubs USB Serial Adapter",
132 .short_name = "belkin",
133 .id_table = id_table_combined,
134 .num_interrupt_in = 1,
138 .open = belkin_sa_open,
139 .close = belkin_sa_close,
140 .read_int_callback = belkin_sa_read_int_callback, /* How we get the status info */
141 .ioctl = belkin_sa_ioctl,
142 .set_termios = belkin_sa_set_termios,
143 .break_ctl = belkin_sa_break_ctl,
144 .tiocmget = belkin_sa_tiocmget,
145 .tiocmset = belkin_sa_tiocmset,
146 .attach = belkin_sa_startup,
147 .shutdown = belkin_sa_shutdown,
151 struct belkin_sa_private {
153 unsigned long control_state;
154 unsigned char last_lsr;
155 unsigned char last_msr;
156 int bad_flow_control;
161 * ***************************************************************************
162 * Belkin USB Serial Adapter F5U103 specific driver functions
163 * ***************************************************************************
166 #define WDR_TIMEOUT (HZ * 5 ) /* default urb timeout */
168 /* assumes that struct usb_serial *serial is available */
169 #define BSA_USB_CMD(c,v) usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), \
170 (c), BELKIN_SA_SET_REQUEST_TYPE, \
171 (v), 0, NULL, 0, WDR_TIMEOUT)
173 /* do some startup allocations not currently performed by usb_serial_probe() */
174 static int belkin_sa_startup (struct usb_serial *serial)
176 struct usb_device *dev = serial->dev;
177 struct belkin_sa_private *priv;
179 /* allocate the private data structure */
180 priv = kmalloc(sizeof(struct belkin_sa_private), GFP_KERNEL);
182 return (-1); /* error */
183 /* set initial values for control structures */
184 spin_lock_init(&priv->lock);
185 priv->control_state = 0;
188 /* see comments at top of file */
189 priv->bad_flow_control = (dev->descriptor.bcdDevice <= 0x0206) ? 1 : 0;
190 info("bcdDevice: %04x, bfc: %d", dev->descriptor.bcdDevice, priv->bad_flow_control);
192 init_waitqueue_head(&serial->port[0]->write_wait);
193 usb_set_serial_port_data(serial->port[0], priv);
199 static void belkin_sa_shutdown (struct usb_serial *serial)
201 struct belkin_sa_private *priv;
204 dbg ("%s", __FUNCTION__);
206 /* stop reads and writes on all ports */
207 for (i=0; i < serial->num_ports; ++i) {
208 /* My special items, the standard routines free my urbs */
209 priv = usb_get_serial_port_data(serial->port[i]);
216 static int belkin_sa_open (struct usb_serial_port *port, struct file *filp)
220 dbg("%s port %d", __FUNCTION__, port->number);
222 /*Start reading from the device*/
223 /* TODO: Look at possibility of submitting multiple URBs to device to
224 * enhance buffering. Win trace shows 16 initial read URBs.
226 port->read_urb->dev = port->serial->dev;
227 retval = usb_submit_urb(port->read_urb, GFP_KERNEL);
229 err("usb_submit_urb(read bulk) failed");
233 port->interrupt_in_urb->dev = port->serial->dev;
234 retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
236 usb_unlink_urb(port->read_urb);
237 err(" usb_submit_urb(read int) failed");
242 } /* belkin_sa_open */
245 static void belkin_sa_close (struct usb_serial_port *port, struct file *filp)
247 dbg("%s port %d", __FUNCTION__, port->number);
249 /* shutdown our bulk reads and writes */
250 usb_unlink_urb (port->write_urb);
251 usb_unlink_urb (port->read_urb);
252 usb_unlink_urb (port->interrupt_in_urb);
253 } /* belkin_sa_close */
256 static void belkin_sa_read_int_callback (struct urb *urb, struct pt_regs *regs)
258 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
259 struct belkin_sa_private *priv;
260 unsigned char *data = urb->transfer_buffer;
264 switch (urb->status) {
271 /* this urb is terminated, clean up */
272 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
275 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
279 usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length, data);
281 /* Handle known interrupt data */
282 /* ignore data[0] and data[1] */
284 priv = usb_get_serial_port_data(port);
285 spin_lock_irqsave(&priv->lock, flags);
286 priv->last_msr = data[BELKIN_SA_MSR_INDEX];
288 /* Record Control Line states */
289 if (priv->last_msr & BELKIN_SA_MSR_DSR)
290 priv->control_state |= TIOCM_DSR;
292 priv->control_state &= ~TIOCM_DSR;
294 if (priv->last_msr & BELKIN_SA_MSR_CTS)
295 priv->control_state |= TIOCM_CTS;
297 priv->control_state &= ~TIOCM_CTS;
299 if (priv->last_msr & BELKIN_SA_MSR_RI)
300 priv->control_state |= TIOCM_RI;
302 priv->control_state &= ~TIOCM_RI;
304 if (priv->last_msr & BELKIN_SA_MSR_CD)
305 priv->control_state |= TIOCM_CD;
307 priv->control_state &= ~TIOCM_CD;
309 /* Now to report any errors */
310 priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
313 * fill in the flip buffer here, but I do not know the relation
314 * to the current/next receive buffer or characters. I need
315 * to look in to this before committing any code.
317 if (priv->last_lsr & BELKIN_SA_LSR_ERR) {
320 if (priv->last_lsr & BELKIN_SA_LSR_OE) {
323 if (priv->last_lsr & BELKIN_SA_LSR_PE) {
326 if (priv->last_lsr & BELKIN_SA_LSR_FE) {
328 /* Break Indicator */
329 if (priv->last_lsr & BELKIN_SA_LSR_BI) {
333 spin_unlock_irqrestore(&priv->lock, flags);
335 retval = usb_submit_urb (urb, GFP_ATOMIC);
337 err ("%s - usb_submit_urb failed with result %d",
338 __FUNCTION__, retval);
341 static void belkin_sa_set_termios (struct usb_serial_port *port, struct termios *old_termios)
343 struct usb_serial *serial = port->serial;
344 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
347 unsigned int old_iflag = 0;
348 unsigned int old_cflag = 0;
349 __u16 urb_value = 0; /* Will hold the new flags */
351 unsigned long control_state;
352 int bad_flow_control;
354 if ((!port->tty) || (!port->tty->termios)) {
355 dbg ("%s - no tty or termios structure", __FUNCTION__);
359 iflag = port->tty->termios->c_iflag;
360 cflag = port->tty->termios->c_cflag;
362 /* get a local copy of the current port settings */
363 spin_lock_irqsave(&priv->lock, flags);
364 control_state = priv->control_state;
365 bad_flow_control = priv->bad_flow_control;
366 spin_unlock_irqrestore(&priv->lock, flags);
368 /* check that they really want us to change something */
370 if ((cflag == old_termios->c_cflag) &&
371 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
372 dbg("%s - nothing to change...", __FUNCTION__);
375 old_iflag = old_termios->c_iflag;
376 old_cflag = old_termios->c_cflag;
379 /* Set the baud rate */
380 if( (cflag&CBAUD) != (old_cflag&CBAUD) ) {
381 /* reassert DTR and (maybe) RTS on transition from B0 */
382 if( (old_cflag&CBAUD) == B0 ) {
383 control_state |= (TIOCM_DTR|TIOCM_RTS);
384 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
385 err("Set DTR error");
386 /* don't set RTS if using hardware flow control */
387 if (!(old_cflag&CRTSCTS) )
388 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 1) < 0)
389 err("Set RTS error");
392 switch(cflag & CBAUD) {
393 case B0: /* handled below */ break;
394 case B300: urb_value = BELKIN_SA_BAUD(300); break;
395 case B600: urb_value = BELKIN_SA_BAUD(600); break;
396 case B1200: urb_value = BELKIN_SA_BAUD(1200); break;
397 case B2400: urb_value = BELKIN_SA_BAUD(2400); break;
398 case B4800: urb_value = BELKIN_SA_BAUD(4800); break;
399 case B9600: urb_value = BELKIN_SA_BAUD(9600); break;
400 case B19200: urb_value = BELKIN_SA_BAUD(19200); break;
401 case B38400: urb_value = BELKIN_SA_BAUD(38400); break;
402 case B57600: urb_value = BELKIN_SA_BAUD(57600); break;
403 case B115200: urb_value = BELKIN_SA_BAUD(115200); break;
404 case B230400: urb_value = BELKIN_SA_BAUD(230400); break;
405 default: err("BELKIN USB Serial Adapter: unsupported baudrate request, using default of 9600");
406 urb_value = BELKIN_SA_BAUD(9600); break;
408 if ((cflag & CBAUD) != B0 ) {
409 if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
410 err("Set baudrate error");
412 /* Disable flow control */
413 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, BELKIN_SA_FLOW_NONE) < 0)
414 err("Disable flowcontrol error");
416 /* Drop RTS and DTR */
417 control_state &= ~(TIOCM_DTR | TIOCM_RTS);
418 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
419 err("DTR LOW error");
420 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
421 err("RTS LOW error");
426 if( (cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD)) ) {
428 urb_value = (cflag & PARODD) ? BELKIN_SA_PARITY_ODD : BELKIN_SA_PARITY_EVEN;
430 urb_value = BELKIN_SA_PARITY_NONE;
431 if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
432 err("Set parity error");
435 /* set the number of data bits */
436 if( (cflag&CSIZE) != (old_cflag&CSIZE) ) {
437 switch (cflag & CSIZE) {
438 case CS5: urb_value = BELKIN_SA_DATA_BITS(5); break;
439 case CS6: urb_value = BELKIN_SA_DATA_BITS(6); break;
440 case CS7: urb_value = BELKIN_SA_DATA_BITS(7); break;
441 case CS8: urb_value = BELKIN_SA_DATA_BITS(8); break;
442 default: err("CSIZE was not CS5-CS8, using default of 8");
443 urb_value = BELKIN_SA_DATA_BITS(8);
446 if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
447 err("Set data bits error");
450 /* set the number of stop bits */
451 if( (cflag&CSTOPB) != (old_cflag&CSTOPB) ) {
452 urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2) : BELKIN_SA_STOP_BITS(1);
453 if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST, urb_value) < 0)
454 err("Set stop bits error");
457 /* Set flow control */
458 if( (iflag&IXOFF) != (old_iflag&IXOFF)
459 || (iflag&IXON) != (old_iflag&IXON)
460 || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
462 if ((iflag & IXOFF) || (iflag & IXON))
463 urb_value |= (BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
465 urb_value &= ~(BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
468 urb_value |= (BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
470 urb_value &= ~(BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
472 if (bad_flow_control)
473 urb_value &= ~(BELKIN_SA_FLOW_IRTS);
475 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
476 err("Set flow control error");
479 /* save off the modified port settings */
480 spin_lock_irqsave(&priv->lock, flags);
481 priv->control_state = control_state;
482 spin_unlock_irqrestore(&priv->lock, flags);
483 } /* belkin_sa_set_termios */
486 static void belkin_sa_break_ctl( struct usb_serial_port *port, int break_state )
488 struct usb_serial *serial = port->serial;
490 if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
491 err("Set break_ctl %d", break_state);
495 static int belkin_sa_tiocmget (struct usb_serial_port *port, struct file *file)
497 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
498 unsigned long control_state;
501 dbg("%s", __FUNCTION__);
503 spin_lock_irqsave(&priv->lock, flags);
504 control_state = priv->control_state;
505 spin_unlock_irqrestore(&priv->lock, flags);
507 return control_state;
511 static int belkin_sa_tiocmset (struct usb_serial_port *port, struct file *file,
512 unsigned int set, unsigned int clear)
514 struct usb_serial *serial = port->serial;
515 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
516 unsigned long control_state;
522 dbg("%s", __FUNCTION__);
524 spin_lock_irqsave(&priv->lock, flags);
525 control_state = priv->control_state;
527 if (set & TIOCM_RTS) {
528 control_state |= TIOCM_RTS;
531 if (set & TIOCM_DTR) {
532 control_state |= TIOCM_DTR;
535 if (clear & TIOCM_RTS) {
536 control_state &= ~TIOCM_RTS;
539 if (clear & TIOCM_DTR) {
540 control_state &= ~TIOCM_DTR;
544 priv->control_state = control_state;
545 spin_unlock_irqrestore(&priv->lock, flags);
547 retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
549 err("Set RTS error %d", retval);
553 retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
555 err("Set DTR error %d", retval);
563 static int belkin_sa_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
567 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
572 /* return count of modemline transitions */
577 dbg("belkin_sa_ioctl arg not supported - 0x%04x",cmd);
578 return(-ENOIOCTLCMD);
582 } /* belkin_sa_ioctl */
585 static int __init belkin_sa_init (void)
588 retval = usb_serial_register(&belkin_device);
590 goto failed_usb_serial_register;
591 retval = usb_register(&belkin_driver);
593 goto failed_usb_register;
594 info(DRIVER_DESC " " DRIVER_VERSION);
597 usb_serial_deregister(&belkin_device);
598 failed_usb_serial_register:
603 static void __exit belkin_sa_exit (void)
605 usb_deregister (&belkin_driver);
606 usb_serial_deregister (&belkin_device);
610 module_init (belkin_sa_init);
611 module_exit (belkin_sa_exit);
613 MODULE_AUTHOR( DRIVER_AUTHOR );
614 MODULE_DESCRIPTION( DRIVER_DESC );
615 MODULE_LICENSE("GPL");
617 MODULE_PARM(debug, "i");
618 MODULE_PARM_DESC(debug, "Debug enabled or not");