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 struct usb_serial *serial;
249 if (port_paranoia_check (port, __FUNCTION__))
252 serial = get_usb_serial (port, __FUNCTION__);
256 dbg("%s port %d", __FUNCTION__, port->number);
259 /* shutdown our bulk reads and writes */
260 usb_unlink_urb (port->write_urb);
261 usb_unlink_urb (port->read_urb);
262 usb_unlink_urb (port->interrupt_in_urb);
264 } /* belkin_sa_close */
267 static void belkin_sa_read_int_callback (struct urb *urb, struct pt_regs *regs)
269 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
270 struct belkin_sa_private *priv;
271 struct usb_serial *serial;
272 unsigned char *data = urb->transfer_buffer;
276 switch (urb->status) {
283 /* this urb is terminated, clean up */
284 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
287 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
291 if (port_paranoia_check (port, __FUNCTION__))
294 serial = port->serial;
296 if (serial_paranoia_check (serial, __FUNCTION__))
299 usb_serial_debug_data (__FILE__, __FUNCTION__, urb->actual_length, data);
301 /* Handle known interrupt data */
302 /* ignore data[0] and data[1] */
304 priv = usb_get_serial_port_data(port);
305 spin_lock_irqsave(&priv->lock, flags);
306 priv->last_msr = data[BELKIN_SA_MSR_INDEX];
308 /* Record Control Line states */
309 if (priv->last_msr & BELKIN_SA_MSR_DSR)
310 priv->control_state |= TIOCM_DSR;
312 priv->control_state &= ~TIOCM_DSR;
314 if (priv->last_msr & BELKIN_SA_MSR_CTS)
315 priv->control_state |= TIOCM_CTS;
317 priv->control_state &= ~TIOCM_CTS;
319 if (priv->last_msr & BELKIN_SA_MSR_RI)
320 priv->control_state |= TIOCM_RI;
322 priv->control_state &= ~TIOCM_RI;
324 if (priv->last_msr & BELKIN_SA_MSR_CD)
325 priv->control_state |= TIOCM_CD;
327 priv->control_state &= ~TIOCM_CD;
329 /* Now to report any errors */
330 priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
333 * fill in the flip buffer here, but I do not know the relation
334 * to the current/next receive buffer or characters. I need
335 * to look in to this before committing any code.
337 if (priv->last_lsr & BELKIN_SA_LSR_ERR) {
340 if (priv->last_lsr & BELKIN_SA_LSR_OE) {
343 if (priv->last_lsr & BELKIN_SA_LSR_PE) {
346 if (priv->last_lsr & BELKIN_SA_LSR_FE) {
348 /* Break Indicator */
349 if (priv->last_lsr & BELKIN_SA_LSR_BI) {
353 spin_unlock_irqrestore(&priv->lock, flags);
355 retval = usb_submit_urb (urb, GFP_ATOMIC);
357 err ("%s - usb_submit_urb failed with result %d",
358 __FUNCTION__, retval);
361 static void belkin_sa_set_termios (struct usb_serial_port *port, struct termios *old_termios)
363 struct usb_serial *serial = port->serial;
364 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
367 unsigned int old_iflag = 0;
368 unsigned int old_cflag = 0;
369 __u16 urb_value = 0; /* Will hold the new flags */
371 unsigned long control_state;
372 int bad_flow_control;
374 if ((!port->tty) || (!port->tty->termios)) {
375 dbg ("%s - no tty or termios structure", __FUNCTION__);
379 iflag = port->tty->termios->c_iflag;
380 cflag = port->tty->termios->c_cflag;
382 /* get a local copy of the current port settings */
383 spin_lock_irqsave(&priv->lock, flags);
384 control_state = priv->control_state;
385 bad_flow_control = priv->bad_flow_control;
386 spin_unlock_irqrestore(&priv->lock, flags);
388 /* check that they really want us to change something */
390 if ((cflag == old_termios->c_cflag) &&
391 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
392 dbg("%s - nothing to change...", __FUNCTION__);
395 old_iflag = old_termios->c_iflag;
396 old_cflag = old_termios->c_cflag;
399 /* Set the baud rate */
400 if( (cflag&CBAUD) != (old_cflag&CBAUD) ) {
401 /* reassert DTR and (maybe) RTS on transition from B0 */
402 if( (old_cflag&CBAUD) == B0 ) {
403 control_state |= (TIOCM_DTR|TIOCM_RTS);
404 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
405 err("Set DTR error");
406 /* don't set RTS if using hardware flow control */
407 if (!(old_cflag&CRTSCTS) )
408 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 1) < 0)
409 err("Set RTS error");
412 switch(cflag & CBAUD) {
413 case B0: /* handled below */ break;
414 case B300: urb_value = BELKIN_SA_BAUD(300); break;
415 case B600: urb_value = BELKIN_SA_BAUD(600); break;
416 case B1200: urb_value = BELKIN_SA_BAUD(1200); break;
417 case B2400: urb_value = BELKIN_SA_BAUD(2400); break;
418 case B4800: urb_value = BELKIN_SA_BAUD(4800); break;
419 case B9600: urb_value = BELKIN_SA_BAUD(9600); break;
420 case B19200: urb_value = BELKIN_SA_BAUD(19200); break;
421 case B38400: urb_value = BELKIN_SA_BAUD(38400); break;
422 case B57600: urb_value = BELKIN_SA_BAUD(57600); break;
423 case B115200: urb_value = BELKIN_SA_BAUD(115200); break;
424 case B230400: urb_value = BELKIN_SA_BAUD(230400); break;
425 default: err("BELKIN USB Serial Adapter: unsupported baudrate request, using default of 9600");
426 urb_value = BELKIN_SA_BAUD(9600); break;
428 if ((cflag & CBAUD) != B0 ) {
429 if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
430 err("Set baudrate error");
432 /* Disable flow control */
433 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, BELKIN_SA_FLOW_NONE) < 0)
434 err("Disable flowcontrol error");
436 /* Drop RTS and DTR */
437 control_state &= ~(TIOCM_DTR | TIOCM_RTS);
438 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
439 err("DTR LOW error");
440 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
441 err("RTS LOW error");
446 if( (cflag&(PARENB|PARODD)) != (old_cflag&(PARENB|PARODD)) ) {
448 urb_value = (cflag & PARODD) ? BELKIN_SA_PARITY_ODD : BELKIN_SA_PARITY_EVEN;
450 urb_value = BELKIN_SA_PARITY_NONE;
451 if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
452 err("Set parity error");
455 /* set the number of data bits */
456 if( (cflag&CSIZE) != (old_cflag&CSIZE) ) {
457 switch (cflag & CSIZE) {
458 case CS5: urb_value = BELKIN_SA_DATA_BITS(5); break;
459 case CS6: urb_value = BELKIN_SA_DATA_BITS(6); break;
460 case CS7: urb_value = BELKIN_SA_DATA_BITS(7); break;
461 case CS8: urb_value = BELKIN_SA_DATA_BITS(8); break;
462 default: err("CSIZE was not CS5-CS8, using default of 8");
463 urb_value = BELKIN_SA_DATA_BITS(8);
466 if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
467 err("Set data bits error");
470 /* set the number of stop bits */
471 if( (cflag&CSTOPB) != (old_cflag&CSTOPB) ) {
472 urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2) : BELKIN_SA_STOP_BITS(1);
473 if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST, urb_value) < 0)
474 err("Set stop bits error");
477 /* Set flow control */
478 if( (iflag&IXOFF) != (old_iflag&IXOFF)
479 || (iflag&IXON) != (old_iflag&IXON)
480 || (cflag&CRTSCTS) != (old_cflag&CRTSCTS) ) {
482 if ((iflag & IXOFF) || (iflag & IXON))
483 urb_value |= (BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
485 urb_value &= ~(BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
488 urb_value |= (BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
490 urb_value &= ~(BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
492 if (bad_flow_control)
493 urb_value &= ~(BELKIN_SA_FLOW_IRTS);
495 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
496 err("Set flow control error");
499 /* save off the modified port settings */
500 spin_lock_irqsave(&priv->lock, flags);
501 priv->control_state = control_state;
502 spin_unlock_irqrestore(&priv->lock, flags);
503 } /* belkin_sa_set_termios */
506 static void belkin_sa_break_ctl( struct usb_serial_port *port, int break_state )
508 struct usb_serial *serial = port->serial;
510 if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
511 err("Set break_ctl %d", break_state);
515 static int belkin_sa_tiocmget (struct usb_serial_port *port, struct file *file)
517 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
518 unsigned long control_state;
521 dbg("%s", __FUNCTION__);
523 spin_lock_irqsave(&priv->lock, flags);
524 control_state = priv->control_state;
525 spin_unlock_irqrestore(&priv->lock, flags);
527 return control_state;
531 static int belkin_sa_tiocmset (struct usb_serial_port *port, struct file *file,
532 unsigned int set, unsigned int clear)
534 struct usb_serial *serial = port->serial;
535 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
536 unsigned long control_state;
542 dbg("%s", __FUNCTION__);
544 spin_lock_irqsave(&priv->lock, flags);
545 control_state = priv->control_state;
547 if (set & TIOCM_RTS) {
548 control_state |= TIOCM_RTS;
551 if (set & TIOCM_DTR) {
552 control_state |= TIOCM_DTR;
555 if (clear & TIOCM_RTS) {
556 control_state &= ~TIOCM_RTS;
559 if (clear & TIOCM_DTR) {
560 control_state &= ~TIOCM_DTR;
564 priv->control_state = control_state;
565 spin_unlock_irqrestore(&priv->lock, flags);
567 retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
569 err("Set RTS error %d", retval);
573 retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
575 err("Set DTR error %d", retval);
583 static int belkin_sa_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
587 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
592 /* return count of modemline transitions */
597 dbg("belkin_sa_ioctl arg not supported - 0x%04x",cmd);
598 return(-ENOIOCTLCMD);
602 } /* belkin_sa_ioctl */
605 static int __init belkin_sa_init (void)
608 retval = usb_serial_register(&belkin_device);
610 goto failed_usb_serial_register;
611 retval = usb_register(&belkin_driver);
613 goto failed_usb_register;
614 info(DRIVER_DESC " " DRIVER_VERSION);
617 usb_serial_deregister(&belkin_device);
618 failed_usb_serial_register:
623 static void __exit belkin_sa_exit (void)
625 usb_deregister (&belkin_driver);
626 usb_serial_deregister (&belkin_device);
630 module_init (belkin_sa_init);
631 module_exit (belkin_sa_exit);
633 MODULE_AUTHOR( DRIVER_AUTHOR );
634 MODULE_DESCRIPTION( DRIVER_DESC );
635 MODULE_LICENSE("GPL");
637 MODULE_PARM(debug, "i");
638 MODULE_PARM_DESC(debug, "Debug enabled or not");