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"
43 #define DRIVER_VERSION "v1.3"
44 #define DRIVER_AUTHOR "William Greathouse <wgreathouse@smva.com>"
45 #define DRIVER_DESC "USB Belkin Serial converter driver"
47 /* function prototypes for a Belkin USB Serial Adapter F5U103 */
48 static int belkin_sa_port_probe(struct usb_serial_port *port);
49 static int belkin_sa_port_remove(struct usb_serial_port *port);
50 static int belkin_sa_open(struct tty_struct *tty,
51 struct usb_serial_port *port);
52 static void belkin_sa_close(struct usb_serial_port *port);
53 static void belkin_sa_read_int_callback(struct urb *urb);
54 static void belkin_sa_process_read_urb(struct urb *urb);
55 static void belkin_sa_set_termios(struct tty_struct *tty,
56 struct usb_serial_port *port, struct ktermios * old);
57 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state);
58 static int belkin_sa_tiocmget(struct tty_struct *tty);
59 static int belkin_sa_tiocmset(struct tty_struct *tty,
60 unsigned int set, unsigned int clear);
63 static const struct usb_device_id id_table[] = {
64 { USB_DEVICE(BELKIN_SA_VID, BELKIN_SA_PID) },
65 { USB_DEVICE(BELKIN_OLD_VID, BELKIN_OLD_PID) },
66 { USB_DEVICE(PERACOM_VID, PERACOM_PID) },
67 { USB_DEVICE(GOHUBS_VID, GOHUBS_PID) },
68 { USB_DEVICE(GOHUBS_VID, HANDYLINK_PID) },
69 { USB_DEVICE(BELKIN_DOCKSTATION_VID, BELKIN_DOCKSTATION_PID) },
70 { } /* Terminating entry */
72 MODULE_DEVICE_TABLE(usb, id_table);
74 /* All of the device info needed for the serial converters */
75 static struct usb_serial_driver belkin_device = {
80 .description = "Belkin / Peracom / GoHubs USB Serial Adapter",
83 .open = belkin_sa_open,
84 .close = belkin_sa_close,
85 .read_int_callback = belkin_sa_read_int_callback,
86 .process_read_urb = belkin_sa_process_read_urb,
87 .set_termios = belkin_sa_set_termios,
88 .break_ctl = belkin_sa_break_ctl,
89 .tiocmget = belkin_sa_tiocmget,
90 .tiocmset = belkin_sa_tiocmset,
91 .port_probe = belkin_sa_port_probe,
92 .port_remove = belkin_sa_port_remove,
95 static struct usb_serial_driver * const serial_drivers[] = {
99 struct belkin_sa_private {
101 unsigned long control_state;
102 unsigned char last_lsr;
103 unsigned char last_msr;
104 int bad_flow_control;
109 * ***************************************************************************
110 * Belkin USB Serial Adapter F5U103 specific driver functions
111 * ***************************************************************************
114 #define WDR_TIMEOUT 5000 /* default urb timeout */
116 /* assumes that struct usb_serial *serial is available */
117 #define BSA_USB_CMD(c, v) usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), \
118 (c), BELKIN_SA_SET_REQUEST_TYPE, \
119 (v), 0, NULL, 0, WDR_TIMEOUT)
121 static int belkin_sa_port_probe(struct usb_serial_port *port)
123 struct usb_device *dev = port->serial->dev;
124 struct belkin_sa_private *priv;
126 priv = kmalloc(sizeof(struct belkin_sa_private), GFP_KERNEL);
130 spin_lock_init(&priv->lock);
131 priv->control_state = 0;
134 /* see comments at top of file */
135 priv->bad_flow_control =
136 (le16_to_cpu(dev->descriptor.bcdDevice) <= 0x0206) ? 1 : 0;
137 dev_info(&dev->dev, "bcdDevice: %04x, bfc: %d\n",
138 le16_to_cpu(dev->descriptor.bcdDevice),
139 priv->bad_flow_control);
141 usb_set_serial_port_data(port, priv);
146 static int belkin_sa_port_remove(struct usb_serial_port *port)
148 struct belkin_sa_private *priv;
150 priv = usb_get_serial_port_data(port);
156 static int belkin_sa_open(struct tty_struct *tty,
157 struct usb_serial_port *port)
161 retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
163 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
167 retval = usb_serial_generic_open(tty, port);
169 usb_kill_urb(port->interrupt_in_urb);
174 static void belkin_sa_close(struct usb_serial_port *port)
176 usb_serial_generic_close(port);
177 usb_kill_urb(port->interrupt_in_urb);
180 static void belkin_sa_read_int_callback(struct urb *urb)
182 struct usb_serial_port *port = urb->context;
183 struct belkin_sa_private *priv;
184 unsigned char *data = urb->transfer_buffer;
186 int status = urb->status;
196 /* this urb is terminated, clean up */
197 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
201 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
206 usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
208 /* Handle known interrupt data */
209 /* ignore data[0] and data[1] */
211 priv = usb_get_serial_port_data(port);
212 spin_lock_irqsave(&priv->lock, flags);
213 priv->last_msr = data[BELKIN_SA_MSR_INDEX];
215 /* Record Control Line states */
216 if (priv->last_msr & BELKIN_SA_MSR_DSR)
217 priv->control_state |= TIOCM_DSR;
219 priv->control_state &= ~TIOCM_DSR;
221 if (priv->last_msr & BELKIN_SA_MSR_CTS)
222 priv->control_state |= TIOCM_CTS;
224 priv->control_state &= ~TIOCM_CTS;
226 if (priv->last_msr & BELKIN_SA_MSR_RI)
227 priv->control_state |= TIOCM_RI;
229 priv->control_state &= ~TIOCM_RI;
231 if (priv->last_msr & BELKIN_SA_MSR_CD)
232 priv->control_state |= TIOCM_CD;
234 priv->control_state &= ~TIOCM_CD;
236 priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
237 spin_unlock_irqrestore(&priv->lock, flags);
239 retval = usb_submit_urb(urb, GFP_ATOMIC);
241 dev_err(&port->dev, "%s - usb_submit_urb failed with "
242 "result %d\n", __func__, retval);
245 static void belkin_sa_process_read_urb(struct urb *urb)
247 struct usb_serial_port *port = urb->context;
248 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
249 struct tty_struct *tty;
250 unsigned char *data = urb->transfer_buffer;
252 unsigned char status;
255 /* Update line status */
256 tty_flag = TTY_NORMAL;
258 spin_lock_irqsave(&priv->lock, flags);
259 status = priv->last_lsr;
260 priv->last_lsr &= ~BELKIN_SA_LSR_ERR;
261 spin_unlock_irqrestore(&priv->lock, flags);
263 if (!urb->actual_length)
266 tty = tty_port_tty_get(&port->port);
270 if (status & BELKIN_SA_LSR_ERR) {
271 /* Break takes precedence over parity, which takes precedence
272 * over framing errors. */
273 if (status & BELKIN_SA_LSR_BI)
274 tty_flag = TTY_BREAK;
275 else if (status & BELKIN_SA_LSR_PE)
276 tty_flag = TTY_PARITY;
277 else if (status & BELKIN_SA_LSR_FE)
278 tty_flag = TTY_FRAME;
279 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
281 /* Overrun is special, not associated with a char. */
282 if (status & BELKIN_SA_LSR_OE)
283 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
286 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
288 tty_flip_buffer_push(tty);
292 static void belkin_sa_set_termios(struct tty_struct *tty,
293 struct usb_serial_port *port, struct ktermios *old_termios)
295 struct usb_serial *serial = port->serial;
296 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
299 unsigned int old_iflag = 0;
300 unsigned int old_cflag = 0;
301 __u16 urb_value = 0; /* Will hold the new flags */
303 unsigned long control_state;
304 int bad_flow_control;
306 struct ktermios *termios = &tty->termios;
308 iflag = termios->c_iflag;
309 cflag = termios->c_cflag;
311 termios->c_cflag &= ~CMSPAR;
313 /* get a local copy of the current port settings */
314 spin_lock_irqsave(&priv->lock, flags);
315 control_state = priv->control_state;
316 bad_flow_control = priv->bad_flow_control;
317 spin_unlock_irqrestore(&priv->lock, flags);
319 old_iflag = old_termios->c_iflag;
320 old_cflag = old_termios->c_cflag;
322 /* Set the baud rate */
323 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
324 /* reassert DTR and (maybe) RTS on transition from B0 */
325 if ((old_cflag & CBAUD) == B0) {
326 control_state |= (TIOCM_DTR|TIOCM_RTS);
327 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
328 dev_err(&port->dev, "Set DTR error\n");
329 /* don't set RTS if using hardware flow control */
330 if (!(old_cflag & CRTSCTS))
331 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST
333 dev_err(&port->dev, "Set RTS error\n");
337 baud = tty_get_baud_rate(tty);
339 urb_value = BELKIN_SA_BAUD(baud);
340 /* Clip to maximum speed */
343 /* Turn it back into a resulting real baud rate */
344 baud = BELKIN_SA_BAUD(urb_value);
346 /* Report the actual baud rate back to the caller */
347 tty_encode_baud_rate(tty, baud, baud);
348 if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
349 dev_err(&port->dev, "Set baudrate error\n");
351 /* Disable flow control */
352 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST,
353 BELKIN_SA_FLOW_NONE) < 0)
354 dev_err(&port->dev, "Disable flowcontrol error\n");
355 /* Drop RTS and DTR */
356 control_state &= ~(TIOCM_DTR | TIOCM_RTS);
357 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
358 dev_err(&port->dev, "DTR LOW error\n");
359 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
360 dev_err(&port->dev, "RTS LOW error\n");
364 if ((cflag ^ old_cflag) & (PARENB | PARODD)) {
366 urb_value = (cflag & PARODD) ? BELKIN_SA_PARITY_ODD
367 : BELKIN_SA_PARITY_EVEN;
369 urb_value = BELKIN_SA_PARITY_NONE;
370 if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
371 dev_err(&port->dev, "Set parity error\n");
374 /* set the number of data bits */
375 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
376 switch (cflag & CSIZE) {
378 urb_value = BELKIN_SA_DATA_BITS(5);
381 urb_value = BELKIN_SA_DATA_BITS(6);
384 urb_value = BELKIN_SA_DATA_BITS(7);
387 urb_value = BELKIN_SA_DATA_BITS(8);
391 "CSIZE was not CS5-CS8, using default of 8\n");
392 urb_value = BELKIN_SA_DATA_BITS(8);
395 if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
396 dev_err(&port->dev, "Set data bits error\n");
399 /* set the number of stop bits */
400 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
401 urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2)
402 : BELKIN_SA_STOP_BITS(1);
403 if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST,
405 dev_err(&port->dev, "Set stop bits error\n");
408 /* Set flow control */
409 if (((iflag ^ old_iflag) & (IXOFF | IXON)) ||
410 ((cflag ^ old_cflag) & CRTSCTS)) {
412 if ((iflag & IXOFF) || (iflag & IXON))
413 urb_value |= (BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
415 urb_value &= ~(BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
418 urb_value |= (BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
420 urb_value &= ~(BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
422 if (bad_flow_control)
423 urb_value &= ~(BELKIN_SA_FLOW_IRTS);
425 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
426 dev_err(&port->dev, "Set flow control error\n");
429 /* save off the modified port settings */
430 spin_lock_irqsave(&priv->lock, flags);
431 priv->control_state = control_state;
432 spin_unlock_irqrestore(&priv->lock, flags);
435 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state)
437 struct usb_serial_port *port = tty->driver_data;
438 struct usb_serial *serial = port->serial;
440 if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
441 dev_err(&port->dev, "Set break_ctl %d\n", break_state);
444 static int belkin_sa_tiocmget(struct tty_struct *tty)
446 struct usb_serial_port *port = tty->driver_data;
447 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
448 unsigned long control_state;
451 spin_lock_irqsave(&priv->lock, flags);
452 control_state = priv->control_state;
453 spin_unlock_irqrestore(&priv->lock, flags);
455 return control_state;
458 static int belkin_sa_tiocmset(struct tty_struct *tty,
459 unsigned int set, unsigned int clear)
461 struct usb_serial_port *port = tty->driver_data;
462 struct usb_serial *serial = port->serial;
463 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
464 unsigned long control_state;
470 spin_lock_irqsave(&priv->lock, flags);
471 control_state = priv->control_state;
473 if (set & TIOCM_RTS) {
474 control_state |= TIOCM_RTS;
477 if (set & TIOCM_DTR) {
478 control_state |= TIOCM_DTR;
481 if (clear & TIOCM_RTS) {
482 control_state &= ~TIOCM_RTS;
485 if (clear & TIOCM_DTR) {
486 control_state &= ~TIOCM_DTR;
490 priv->control_state = control_state;
491 spin_unlock_irqrestore(&priv->lock, flags);
493 retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
495 dev_err(&port->dev, "Set RTS error %d\n", retval);
499 retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
501 dev_err(&port->dev, "Set DTR error %d\n", retval);
508 module_usb_serial_driver(serial_drivers, id_table);
510 MODULE_AUTHOR(DRIVER_AUTHOR);
511 MODULE_DESCRIPTION(DRIVER_DESC);
512 MODULE_VERSION(DRIVER_VERSION);
513 MODULE_LICENSE("GPL");