1 // SPDX-License-Identifier: GPL-2.0+
3 * Belkin USB Serial Adapter Driver
5 * Copyright (C) 2000 William Greathouse (wgreathouse@smva.com)
6 * Copyright (C) 2000-2001 Greg Kroah-Hartman (greg@kroah.com)
7 * Copyright (C) 2010 Johan Hovold (jhovold@gmail.com)
9 * This program is largely derived from work by the linux-usb group
10 * and associated source files. Please see the usb/serial files for
11 * individual credits and copyrights.
13 * See Documentation/usb/usb-serial.rst for more information on using this
17 * -- Add true modem control line query capability. Currently we track the
18 * states reported by the interrupt and the states we request.
19 * -- Add support for flush commands
22 #include <linux/kernel.h>
23 #include <linux/errno.h>
24 #include <linux/slab.h>
25 #include <linux/tty.h>
26 #include <linux/tty_driver.h>
27 #include <linux/tty_flip.h>
28 #include <linux/module.h>
29 #include <linux/spinlock.h>
30 #include <linux/uaccess.h>
31 #include <linux/usb.h>
32 #include <linux/usb/serial.h>
33 #include "belkin_sa.h"
35 #define DRIVER_AUTHOR "William Greathouse <wgreathouse@smva.com>"
36 #define DRIVER_DESC "USB Belkin Serial converter driver"
38 /* function prototypes for a Belkin USB Serial Adapter F5U103 */
39 static int belkin_sa_port_probe(struct usb_serial_port *port);
40 static void belkin_sa_port_remove(struct usb_serial_port *port);
41 static int belkin_sa_open(struct tty_struct *tty,
42 struct usb_serial_port *port);
43 static void belkin_sa_close(struct usb_serial_port *port);
44 static void belkin_sa_read_int_callback(struct urb *urb);
45 static void belkin_sa_process_read_urb(struct urb *urb);
46 static void belkin_sa_set_termios(struct tty_struct *tty,
47 struct usb_serial_port *port, struct ktermios * old);
48 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state);
49 static int belkin_sa_tiocmget(struct tty_struct *tty);
50 static int belkin_sa_tiocmset(struct tty_struct *tty,
51 unsigned int set, unsigned int clear);
54 static const struct usb_device_id id_table[] = {
55 { USB_DEVICE(BELKIN_SA_VID, BELKIN_SA_PID) },
56 { USB_DEVICE(BELKIN_OLD_VID, BELKIN_OLD_PID) },
57 { USB_DEVICE(PERACOM_VID, PERACOM_PID) },
58 { USB_DEVICE(GOHUBS_VID, GOHUBS_PID) },
59 { USB_DEVICE(GOHUBS_VID, HANDYLINK_PID) },
60 { USB_DEVICE(BELKIN_DOCKSTATION_VID, BELKIN_DOCKSTATION_PID) },
61 { } /* Terminating entry */
63 MODULE_DEVICE_TABLE(usb, id_table);
65 /* All of the device info needed for the serial converters */
66 static struct usb_serial_driver belkin_device = {
71 .description = "Belkin / Peracom / GoHubs USB Serial Adapter",
74 .open = belkin_sa_open,
75 .close = belkin_sa_close,
76 .read_int_callback = belkin_sa_read_int_callback,
77 .process_read_urb = belkin_sa_process_read_urb,
78 .set_termios = belkin_sa_set_termios,
79 .break_ctl = belkin_sa_break_ctl,
80 .tiocmget = belkin_sa_tiocmget,
81 .tiocmset = belkin_sa_tiocmset,
82 .port_probe = belkin_sa_port_probe,
83 .port_remove = belkin_sa_port_remove,
86 static struct usb_serial_driver * const serial_drivers[] = {
90 struct belkin_sa_private {
92 unsigned long control_state;
93 unsigned char last_lsr;
94 unsigned char last_msr;
100 * ***************************************************************************
101 * Belkin USB Serial Adapter F5U103 specific driver functions
102 * ***************************************************************************
105 #define WDR_TIMEOUT 5000 /* default urb timeout */
107 /* assumes that struct usb_serial *serial is available */
108 #define BSA_USB_CMD(c, v) usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), \
109 (c), BELKIN_SA_SET_REQUEST_TYPE, \
110 (v), 0, NULL, 0, WDR_TIMEOUT)
112 static int belkin_sa_port_probe(struct usb_serial_port *port)
114 struct usb_device *dev = port->serial->dev;
115 struct belkin_sa_private *priv;
117 priv = kmalloc(sizeof(struct belkin_sa_private), GFP_KERNEL);
121 spin_lock_init(&priv->lock);
122 priv->control_state = 0;
125 /* see comments at top of file */
126 priv->bad_flow_control =
127 (le16_to_cpu(dev->descriptor.bcdDevice) <= 0x0206) ? 1 : 0;
128 dev_info(&dev->dev, "bcdDevice: %04x, bfc: %d\n",
129 le16_to_cpu(dev->descriptor.bcdDevice),
130 priv->bad_flow_control);
132 usb_set_serial_port_data(port, priv);
137 static void belkin_sa_port_remove(struct usb_serial_port *port)
139 struct belkin_sa_private *priv;
141 priv = usb_get_serial_port_data(port);
145 static int belkin_sa_open(struct tty_struct *tty,
146 struct usb_serial_port *port)
150 retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
152 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
156 retval = usb_serial_generic_open(tty, port);
158 usb_kill_urb(port->interrupt_in_urb);
163 static void belkin_sa_close(struct usb_serial_port *port)
165 usb_serial_generic_close(port);
166 usb_kill_urb(port->interrupt_in_urb);
169 static void belkin_sa_read_int_callback(struct urb *urb)
171 struct usb_serial_port *port = urb->context;
172 struct belkin_sa_private *priv;
173 unsigned char *data = urb->transfer_buffer;
175 int status = urb->status;
185 /* this urb is terminated, clean up */
186 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
190 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
195 usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
197 /* Handle known interrupt data */
198 /* ignore data[0] and data[1] */
200 priv = usb_get_serial_port_data(port);
201 spin_lock_irqsave(&priv->lock, flags);
202 priv->last_msr = data[BELKIN_SA_MSR_INDEX];
204 /* Record Control Line states */
205 if (priv->last_msr & BELKIN_SA_MSR_DSR)
206 priv->control_state |= TIOCM_DSR;
208 priv->control_state &= ~TIOCM_DSR;
210 if (priv->last_msr & BELKIN_SA_MSR_CTS)
211 priv->control_state |= TIOCM_CTS;
213 priv->control_state &= ~TIOCM_CTS;
215 if (priv->last_msr & BELKIN_SA_MSR_RI)
216 priv->control_state |= TIOCM_RI;
218 priv->control_state &= ~TIOCM_RI;
220 if (priv->last_msr & BELKIN_SA_MSR_CD)
221 priv->control_state |= TIOCM_CD;
223 priv->control_state &= ~TIOCM_CD;
225 priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
226 spin_unlock_irqrestore(&priv->lock, flags);
228 retval = usb_submit_urb(urb, GFP_ATOMIC);
230 dev_err(&port->dev, "%s - usb_submit_urb failed with "
231 "result %d\n", __func__, retval);
234 static void belkin_sa_process_read_urb(struct urb *urb)
236 struct usb_serial_port *port = urb->context;
237 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
238 unsigned char *data = urb->transfer_buffer;
240 unsigned char status;
243 /* Update line status */
244 tty_flag = TTY_NORMAL;
246 spin_lock_irqsave(&priv->lock, flags);
247 status = priv->last_lsr;
248 priv->last_lsr &= ~BELKIN_SA_LSR_ERR;
249 spin_unlock_irqrestore(&priv->lock, flags);
251 if (!urb->actual_length)
254 if (status & BELKIN_SA_LSR_ERR) {
255 /* Break takes precedence over parity, which takes precedence
256 * over framing errors. */
257 if (status & BELKIN_SA_LSR_BI)
258 tty_flag = TTY_BREAK;
259 else if (status & BELKIN_SA_LSR_PE)
260 tty_flag = TTY_PARITY;
261 else if (status & BELKIN_SA_LSR_FE)
262 tty_flag = TTY_FRAME;
263 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
265 /* Overrun is special, not associated with a char. */
266 if (status & BELKIN_SA_LSR_OE)
267 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
270 tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
272 tty_flip_buffer_push(&port->port);
275 static void belkin_sa_set_termios(struct tty_struct *tty,
276 struct usb_serial_port *port, struct ktermios *old_termios)
278 struct usb_serial *serial = port->serial;
279 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
282 unsigned int old_iflag = 0;
283 unsigned int old_cflag = 0;
284 __u16 urb_value = 0; /* Will hold the new flags */
286 unsigned long control_state;
287 int bad_flow_control;
289 struct ktermios *termios = &tty->termios;
291 iflag = termios->c_iflag;
292 cflag = termios->c_cflag;
294 termios->c_cflag &= ~CMSPAR;
296 /* get a local copy of the current port settings */
297 spin_lock_irqsave(&priv->lock, flags);
298 control_state = priv->control_state;
299 bad_flow_control = priv->bad_flow_control;
300 spin_unlock_irqrestore(&priv->lock, flags);
302 old_iflag = old_termios->c_iflag;
303 old_cflag = old_termios->c_cflag;
305 /* Set the baud rate */
306 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
307 /* reassert DTR and (maybe) RTS on transition from B0 */
308 if ((old_cflag & CBAUD) == B0) {
309 control_state |= (TIOCM_DTR|TIOCM_RTS);
310 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
311 dev_err(&port->dev, "Set DTR error\n");
312 /* don't set RTS if using hardware flow control */
313 if (!(old_cflag & CRTSCTS))
314 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST
316 dev_err(&port->dev, "Set RTS error\n");
320 baud = tty_get_baud_rate(tty);
322 urb_value = BELKIN_SA_BAUD(baud);
323 /* Clip to maximum speed */
326 /* Turn it back into a resulting real baud rate */
327 baud = BELKIN_SA_BAUD(urb_value);
329 /* Report the actual baud rate back to the caller */
330 tty_encode_baud_rate(tty, baud, baud);
331 if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
332 dev_err(&port->dev, "Set baudrate error\n");
334 /* Disable flow control */
335 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST,
336 BELKIN_SA_FLOW_NONE) < 0)
337 dev_err(&port->dev, "Disable flowcontrol error\n");
338 /* Drop RTS and DTR */
339 control_state &= ~(TIOCM_DTR | TIOCM_RTS);
340 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
341 dev_err(&port->dev, "DTR LOW error\n");
342 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
343 dev_err(&port->dev, "RTS LOW error\n");
347 if ((cflag ^ old_cflag) & (PARENB | PARODD)) {
349 urb_value = (cflag & PARODD) ? BELKIN_SA_PARITY_ODD
350 : BELKIN_SA_PARITY_EVEN;
352 urb_value = BELKIN_SA_PARITY_NONE;
353 if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
354 dev_err(&port->dev, "Set parity error\n");
357 /* set the number of data bits */
358 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
359 urb_value = BELKIN_SA_DATA_BITS(tty_get_char_size(cflag));
360 if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
361 dev_err(&port->dev, "Set data bits error\n");
364 /* set the number of stop bits */
365 if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
366 urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2)
367 : BELKIN_SA_STOP_BITS(1);
368 if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST,
370 dev_err(&port->dev, "Set stop bits error\n");
373 /* Set flow control */
374 if (((iflag ^ old_iflag) & (IXOFF | IXON)) ||
375 ((cflag ^ old_cflag) & CRTSCTS)) {
377 if ((iflag & IXOFF) || (iflag & IXON))
378 urb_value |= (BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
380 urb_value &= ~(BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
383 urb_value |= (BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
385 urb_value &= ~(BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
387 if (bad_flow_control)
388 urb_value &= ~(BELKIN_SA_FLOW_IRTS);
390 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
391 dev_err(&port->dev, "Set flow control error\n");
394 /* save off the modified port settings */
395 spin_lock_irqsave(&priv->lock, flags);
396 priv->control_state = control_state;
397 spin_unlock_irqrestore(&priv->lock, flags);
400 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state)
402 struct usb_serial_port *port = tty->driver_data;
403 struct usb_serial *serial = port->serial;
405 if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
406 dev_err(&port->dev, "Set break_ctl %d\n", break_state);
409 static int belkin_sa_tiocmget(struct tty_struct *tty)
411 struct usb_serial_port *port = tty->driver_data;
412 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
413 unsigned long control_state;
416 spin_lock_irqsave(&priv->lock, flags);
417 control_state = priv->control_state;
418 spin_unlock_irqrestore(&priv->lock, flags);
420 return control_state;
423 static int belkin_sa_tiocmset(struct tty_struct *tty,
424 unsigned int set, unsigned int clear)
426 struct usb_serial_port *port = tty->driver_data;
427 struct usb_serial *serial = port->serial;
428 struct belkin_sa_private *priv = usb_get_serial_port_data(port);
429 unsigned long control_state;
435 spin_lock_irqsave(&priv->lock, flags);
436 control_state = priv->control_state;
438 if (set & TIOCM_RTS) {
439 control_state |= TIOCM_RTS;
442 if (set & TIOCM_DTR) {
443 control_state |= TIOCM_DTR;
446 if (clear & TIOCM_RTS) {
447 control_state &= ~TIOCM_RTS;
450 if (clear & TIOCM_DTR) {
451 control_state &= ~TIOCM_DTR;
455 priv->control_state = control_state;
456 spin_unlock_irqrestore(&priv->lock, flags);
458 retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
460 dev_err(&port->dev, "Set RTS error %d\n", retval);
464 retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
466 dev_err(&port->dev, "Set DTR error %d\n", retval);
473 module_usb_serial_driver(serial_drivers, id_table);
475 MODULE_AUTHOR(DRIVER_AUTHOR);
476 MODULE_DESCRIPTION(DRIVER_DESC);
477 MODULE_LICENSE("GPL");