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)
6 * Copyright (C) 2010 Johan Hovold (jhovold@gmail.com)
8 * This program is largely derived from work by the linux-usb group
9 * and associated source files. Please see the usb/serial files for
10 * individual credits and copyrights.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * See Documentation/usb/usb-serial.txt for more information on using this
21 * -- Add true modem contol line query capability. Currently we track the
22 * states reported by the interrupt and the states we request.
23 * -- Add support for flush commands
26 #include <linux/kernel.h>
27 #include <linux/errno.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/tty.h>
31 #include <linux/tty_driver.h>
32 #include <linux/tty_flip.h>
33 #include <linux/module.h>
34 #include <linux/spinlock.h>
35 #include <linux/uaccess.h>
36 #include <linux/usb.h>
37 #include <linux/usb/serial.h>
38 #include "belkin_sa.h"
45 #define DRIVER_VERSION "v1.3"
46 #define DRIVER_AUTHOR "William Greathouse <wgreathouse@smva.com>"
47 #define DRIVER_DESC "USB Belkin Serial converter driver"
49 /* function prototypes for a Belkin USB Serial Adapter F5U103 */
50 static int belkin_sa_startup(struct usb_serial *serial);
51 static void belkin_sa_release(struct usb_serial *serial);
52 static int belkin_sa_open(struct tty_struct *tty,
53 struct usb_serial_port *port);
54 static void belkin_sa_close(struct usb_serial_port *port);
55 static void belkin_sa_read_int_callback(struct urb *urb);
56 static void belkin_sa_process_read_urb(struct urb *urb);
57 static void belkin_sa_set_termios(struct tty_struct *tty,
58 struct usb_serial_port *port, struct ktermios * old);
59 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state);
60 static int belkin_sa_tiocmget(struct tty_struct *tty);
61 static int belkin_sa_tiocmset(struct tty_struct *tty,
62 unsigned int set, unsigned int clear);
65 static const struct usb_device_id id_table_combined[] = {
66 { USB_DEVICE(BELKIN_SA_VID, BELKIN_SA_PID) },
67 { USB_DEVICE(BELKIN_OLD_VID, BELKIN_OLD_PID) },
68 { USB_DEVICE(PERACOM_VID, PERACOM_PID) },
69 { USB_DEVICE(GOHUBS_VID, GOHUBS_PID) },
70 { USB_DEVICE(GOHUBS_VID, HANDYLINK_PID) },
71 { USB_DEVICE(BELKIN_DOCKSTATION_VID, BELKIN_DOCKSTATION_PID) },
72 { } /* Terminating entry */
74 MODULE_DEVICE_TABLE(usb, id_table_combined);
76 static struct usb_driver belkin_driver = {
78 .probe = usb_serial_probe,
79 .disconnect = usb_serial_disconnect,
80 .id_table = id_table_combined,
83 /* All of the device info needed for the serial converters */
84 static struct usb_serial_driver belkin_device = {
89 .description = "Belkin / Peracom / GoHubs USB Serial Adapter",
90 .id_table = id_table_combined,
92 .open = belkin_sa_open,
93 .close = belkin_sa_close,
94 .read_int_callback = belkin_sa_read_int_callback,
95 .process_read_urb = belkin_sa_process_read_urb,
96 .set_termios = belkin_sa_set_termios,
97 .break_ctl = belkin_sa_break_ctl,
98 .tiocmget = belkin_sa_tiocmget,
99 .tiocmset = belkin_sa_tiocmset,
100 .attach = belkin_sa_startup,
101 .release = belkin_sa_release,
104 static struct usb_serial_driver * const serial_drivers[] = {
108 struct belkin_sa_private {
110 unsigned long control_state;
111 unsigned char last_lsr;
112 unsigned char last_msr;
113 int bad_flow_control;
118 * ***************************************************************************
119 * Belkin USB Serial Adapter F5U103 specific driver functions
120 * ***************************************************************************
123 #define WDR_TIMEOUT 5000 /* default urb timeout */
125 /* assumes that struct usb_serial *serial is available */
126 #define BSA_USB_CMD(c, v) usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), \
127 (c), BELKIN_SA_SET_REQUEST_TYPE, \
128 (v), 0, NULL, 0, WDR_TIMEOUT)
130 /* do some startup allocations not currently performed by usb_serial_probe() */
131 static int belkin_sa_startup(struct usb_serial *serial)
133 struct usb_device *dev = serial->dev;
134 struct belkin_sa_private *priv;
136 /* allocate the private data structure */
137 priv = kmalloc(sizeof(struct belkin_sa_private), GFP_KERNEL);
139 return -1; /* error */
140 /* set initial values for control structures */
141 spin_lock_init(&priv->lock);
142 priv->control_state = 0;
145 /* see comments at top of file */
146 priv->bad_flow_control =
147 (le16_to_cpu(dev->descriptor.bcdDevice) <= 0x0206) ? 1 : 0;
148 dev_info(&dev->dev, "bcdDevice: %04x, bfc: %d\n",
149 le16_to_cpu(dev->descriptor.bcdDevice),
150 priv->bad_flow_control);
152 init_waitqueue_head(&serial->port[0]->write_wait);
153 usb_set_serial_port_data(serial->port[0], priv);
158 static void belkin_sa_release(struct usb_serial *serial)
162 for (i = 0; i < serial->num_ports; ++i)
163 kfree(usb_get_serial_port_data(serial->port[i]));
166 static int belkin_sa_open(struct tty_struct *tty,
167 struct usb_serial_port *port)
171 retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
173 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
177 retval = usb_serial_generic_open(tty, port);
179 usb_kill_urb(port->interrupt_in_urb);
184 static void belkin_sa_close(struct usb_serial_port *port)
186 usb_serial_generic_close(port);
187 usb_kill_urb(port->interrupt_in_urb);
190 static void belkin_sa_read_int_callback(struct urb *urb)
192 struct usb_serial_port *port = urb->context;
193 struct belkin_sa_private *priv;
194 unsigned char *data = urb->transfer_buffer;
196 int status = urb->status;
206 /* this urb is terminated, clean up */
207 dbg("%s - urb shutting down with status: %d",
211 dbg("%s - nonzero urb status received: %d",
216 usb_serial_debug_data(debug, &port->dev, __func__,
217 urb->actual_length, data);
219 /* Handle known interrupt data */
220 /* ignore data[0] and data[1] */
222 priv = usb_get_serial_port_data(port);
223 spin_lock_irqsave(&priv->lock, flags);
224 priv->last_msr = data[BELKIN_SA_MSR_INDEX];
226 /* Record Control Line states */
227 if (priv->last_msr & BELKIN_SA_MSR_DSR)
228 priv->control_state |= TIOCM_DSR;
230 priv->control_state &= ~TIOCM_DSR;
232 if (priv->last_msr & BELKIN_SA_MSR_CTS)
233 priv->control_state |= TIOCM_CTS;
235 priv->control_state &= ~TIOCM_CTS;
237 if (priv->last_msr & BELKIN_SA_MSR_RI)
238 priv->control_state |= TIOCM_RI;
240 priv->control_state &= ~TIOCM_RI;
242 if (priv->last_msr & BELKIN_SA_MSR_CD)
243 priv->control_state |= TIOCM_CD;
245 priv->control_state &= ~TIOCM_CD;
247 priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
248 spin_unlock_irqrestore(&priv->lock, flags);
250 retval = usb_submit_urb(urb, GFP_ATOMIC);
252 dev_err(&port->dev, "%s - usb_submit_urb failed with "
253 "result %d\n", __func__, retval);
256 static void belkin_sa_process_read_urb(struct urb *urb)
258 struct usb_serial_port *port = urb->context;
259 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
260 struct tty_struct *tty;
261 unsigned char *data = urb->transfer_buffer;
263 unsigned char status;
266 /* Update line status */
267 tty_flag = TTY_NORMAL;
269 spin_lock_irqsave(&priv->lock, flags);
270 status = priv->last_lsr;
271 priv->last_lsr &= ~BELKIN_SA_LSR_ERR;
272 spin_unlock_irqrestore(&priv->lock, flags);
274 if (!urb->actual_length)
277 tty = tty_port_tty_get(&port->port);
281 if (status & BELKIN_SA_LSR_ERR) {
282 /* Break takes precedence over parity, which takes precedence
283 * over framing errors. */
284 if (status & BELKIN_SA_LSR_BI)
285 tty_flag = TTY_BREAK;
286 else if (status & BELKIN_SA_LSR_PE)
287 tty_flag = TTY_PARITY;
288 else if (status & BELKIN_SA_LSR_FE)
289 tty_flag = TTY_FRAME;
290 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
292 /* Overrun is special, not associated with a char. */
293 if (status & BELKIN_SA_LSR_OE)
294 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
297 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
299 tty_flip_buffer_push(tty);
303 static void belkin_sa_set_termios(struct tty_struct *tty,
304 struct usb_serial_port *port, struct ktermios *old_termios)
306 struct usb_serial *serial = port->serial;
307 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
310 unsigned int old_iflag = 0;
311 unsigned int old_cflag = 0;
312 __u16 urb_value = 0; /* Will hold the new flags */
314 unsigned long control_state;
315 int bad_flow_control;
317 struct ktermios *termios = tty->termios;
319 iflag = termios->c_iflag;
320 cflag = termios->c_cflag;
322 termios->c_cflag &= ~CMSPAR;
324 /* get a local copy of the current port settings */
325 spin_lock_irqsave(&priv->lock, flags);
326 control_state = priv->control_state;
327 bad_flow_control = priv->bad_flow_control;
328 spin_unlock_irqrestore(&priv->lock, flags);
330 old_iflag = old_termios->c_iflag;
331 old_cflag = old_termios->c_cflag;
333 /* Set the baud rate */
334 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
335 /* reassert DTR and (maybe) RTS on transition from B0 */
336 if ((old_cflag & CBAUD) == B0) {
337 control_state |= (TIOCM_DTR|TIOCM_RTS);
338 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
339 dev_err(&port->dev, "Set DTR error\n");
340 /* don't set RTS if using hardware flow control */
341 if (!(old_cflag & CRTSCTS))
342 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST
344 dev_err(&port->dev, "Set RTS error\n");
348 baud = tty_get_baud_rate(tty);
350 urb_value = BELKIN_SA_BAUD(baud);
351 /* Clip to maximum speed */
354 /* Turn it back into a resulting real baud rate */
355 baud = BELKIN_SA_BAUD(urb_value);
357 /* Report the actual baud rate back to the caller */
358 tty_encode_baud_rate(tty, baud, baud);
359 if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
360 dev_err(&port->dev, "Set baudrate error\n");
362 /* Disable flow control */
363 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST,
364 BELKIN_SA_FLOW_NONE) < 0)
365 dev_err(&port->dev, "Disable flowcontrol error\n");
366 /* Drop RTS and DTR */
367 control_state &= ~(TIOCM_DTR | TIOCM_RTS);
368 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
369 dev_err(&port->dev, "DTR LOW error\n");
370 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
371 dev_err(&port->dev, "RTS LOW error\n");
375 if ((cflag ^ old_cflag) & (PARENB | PARODD)) {
377 urb_value = (cflag & PARODD) ? BELKIN_SA_PARITY_ODD
378 : BELKIN_SA_PARITY_EVEN;
380 urb_value = BELKIN_SA_PARITY_NONE;
381 if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
382 dev_err(&port->dev, "Set parity error\n");
385 /* set the number of data bits */
386 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
387 switch (cflag & CSIZE) {
389 urb_value = BELKIN_SA_DATA_BITS(5);
392 urb_value = BELKIN_SA_DATA_BITS(6);
395 urb_value = BELKIN_SA_DATA_BITS(7);
398 urb_value = BELKIN_SA_DATA_BITS(8);
401 dbg("CSIZE was not CS5-CS8, using default of 8");
402 urb_value = BELKIN_SA_DATA_BITS(8);
405 if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
406 dev_err(&port->dev, "Set data bits error\n");
409 /* set the number of stop bits */
410 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
411 urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2)
412 : BELKIN_SA_STOP_BITS(1);
413 if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST,
415 dev_err(&port->dev, "Set stop bits error\n");
418 /* Set flow control */
419 if (((iflag ^ old_iflag) & (IXOFF | IXON)) ||
420 ((cflag ^ old_cflag) & CRTSCTS)) {
422 if ((iflag & IXOFF) || (iflag & IXON))
423 urb_value |= (BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
425 urb_value &= ~(BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
428 urb_value |= (BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
430 urb_value &= ~(BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
432 if (bad_flow_control)
433 urb_value &= ~(BELKIN_SA_FLOW_IRTS);
435 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
436 dev_err(&port->dev, "Set flow control error\n");
439 /* save off the modified port settings */
440 spin_lock_irqsave(&priv->lock, flags);
441 priv->control_state = control_state;
442 spin_unlock_irqrestore(&priv->lock, flags);
445 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state)
447 struct usb_serial_port *port = tty->driver_data;
448 struct usb_serial *serial = port->serial;
450 if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
451 dev_err(&port->dev, "Set break_ctl %d\n", break_state);
454 static int belkin_sa_tiocmget(struct tty_struct *tty)
456 struct usb_serial_port *port = tty->driver_data;
457 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
458 unsigned long control_state;
461 spin_lock_irqsave(&priv->lock, flags);
462 control_state = priv->control_state;
463 spin_unlock_irqrestore(&priv->lock, flags);
465 return control_state;
468 static int belkin_sa_tiocmset(struct tty_struct *tty,
469 unsigned int set, unsigned int clear)
471 struct usb_serial_port *port = tty->driver_data;
472 struct usb_serial *serial = port->serial;
473 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
474 unsigned long control_state;
480 spin_lock_irqsave(&priv->lock, flags);
481 control_state = priv->control_state;
483 if (set & TIOCM_RTS) {
484 control_state |= TIOCM_RTS;
487 if (set & TIOCM_DTR) {
488 control_state |= TIOCM_DTR;
491 if (clear & TIOCM_RTS) {
492 control_state &= ~TIOCM_RTS;
495 if (clear & TIOCM_DTR) {
496 control_state &= ~TIOCM_DTR;
500 priv->control_state = control_state;
501 spin_unlock_irqrestore(&priv->lock, flags);
503 retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
505 dev_err(&port->dev, "Set RTS error %d\n", retval);
509 retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
511 dev_err(&port->dev, "Set DTR error %d\n", retval);
518 module_usb_serial_driver(belkin_driver, serial_drivers);
520 MODULE_AUTHOR(DRIVER_AUTHOR);
521 MODULE_DESCRIPTION(DRIVER_DESC);
522 MODULE_VERSION(DRIVER_VERSION);
523 MODULE_LICENSE("GPL");
525 module_param(debug, bool, S_IRUGO | S_IWUSR);
526 MODULE_PARM_DESC(debug, "Debug enabled or not");