2 * usb-serial driver for Quatech SSU-100
4 * based on ftdi_sio.c and the original serqt_usb.c from Quatech
8 #include <linux/errno.h>
9 #include <linux/init.h>
10 #include <linux/slab.h>
11 #include <linux/tty.h>
12 #include <linux/tty_driver.h>
13 #include <linux/tty_flip.h>
14 #include <linux/module.h>
15 #include <linux/serial.h>
16 #include <linux/usb.h>
17 #include <linux/usb/serial.h>
18 #include <linux/serial_reg.h>
19 #include <linux/uaccess.h>
21 #define QT_OPEN_CLOSE_CHANNEL 0xca
22 #define QT_SET_GET_DEVICE 0xc2
23 #define QT_SET_GET_REGISTER 0xc0
24 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
25 #define QT_SET_ATF 0xcd
26 #define QT_GET_SET_UART 0xc1
27 #define QT_TRANSFER_IN 0xc0
28 #define QT_HW_FLOW_CONTROL_MASK 0xc5
29 #define QT_SW_FLOW_CONTROL_MASK 0xc6
31 #define SERIAL_MSR_MASK 0xf0
33 #define SERIAL_CRTSCTS ((UART_MCR_RTS << 8) | UART_MSR_CTS)
35 #define SERIAL_EVEN_PARITY (UART_LCR_PARITY | UART_LCR_EPAR)
37 #define MAX_BAUD_RATE 460800
39 #define ATC_DISABLED 0x00
40 #define DUPMODE_BITS 0xc0
42 #define LOOPMODE_BITS 0x41
43 #define RS232_MODE 0x00
44 #define RTSCTS_TO_CONNECTOR 0x40
46 #define FULLPWRBIT 0x00000080
47 #define NEXT_BOARD_POWER_BIT 0x00000004
49 #define DRIVER_DESC "Quatech SSU-100 USB to Serial Driver"
51 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
52 #define QUATECH_SSU100 0xC020 /* SSU100 */
54 static const struct usb_device_id id_table[] = {
55 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100)},
56 {} /* Terminating entry */
58 MODULE_DEVICE_TABLE(usb, id_table);
60 struct ssu100_port_private {
61 spinlock_t status_lock;
64 struct async_icount icount;
67 static inline int ssu100_control_msg(struct usb_device *dev,
68 u8 request, u16 data, u16 index)
70 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
71 request, 0x40, data, index,
75 static inline int ssu100_setdevice(struct usb_device *dev, u8 *data)
77 u16 x = ((u16)(data[1] << 8) | (u16)(data[0]));
79 return ssu100_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
83 static inline int ssu100_getdevice(struct usb_device *dev, u8 *data)
85 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
86 QT_SET_GET_DEVICE, 0xc0, 0, 0,
90 static inline int ssu100_getregister(struct usb_device *dev,
95 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
96 QT_SET_GET_REGISTER, 0xc0, reg,
97 uart, data, sizeof(*data), 300);
102 static inline int ssu100_setregister(struct usb_device *dev,
107 u16 value = (data << 8) | reg;
109 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
110 QT_SET_GET_REGISTER, 0x40, value, uart,
115 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
116 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
118 /* these do not deal with device that have more than 1 port */
119 static inline int update_mctrl(struct usb_device *dev, unsigned int set,
125 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
126 dev_dbg(&dev->dev, "%s - DTR|RTS not being set|cleared\n", __func__);
127 return 0; /* no change */
130 clear &= ~set; /* 'set' takes precedence over 'clear' */
133 urb_value |= UART_MCR_DTR;
135 urb_value |= UART_MCR_RTS;
137 result = ssu100_setregister(dev, 0, UART_MCR, urb_value);
139 dev_dbg(&dev->dev, "%s Error from MODEM_CTRL urb\n", __func__);
144 static int ssu100_initdevice(struct usb_device *dev)
149 data = kzalloc(3, GFP_KERNEL);
153 result = ssu100_getdevice(dev, data);
155 dev_dbg(&dev->dev, "%s - get_device failed %i\n", __func__, result);
159 data[1] &= ~FULLPWRBIT;
161 result = ssu100_setdevice(dev, data);
163 dev_dbg(&dev->dev, "%s - setdevice failed %i\n", __func__, result);
167 result = ssu100_control_msg(dev, QT_GET_SET_PREBUF_TRIG_LVL, 128, 0);
169 dev_dbg(&dev->dev, "%s - set prebuffer level failed %i\n", __func__, result);
173 result = ssu100_control_msg(dev, QT_SET_ATF, ATC_DISABLED, 0);
175 dev_dbg(&dev->dev, "%s - set ATFprebuffer level failed %i\n", __func__, result);
179 result = ssu100_getdevice(dev, data);
181 dev_dbg(&dev->dev, "%s - get_device failed %i\n", __func__, result);
185 data[0] &= ~(RR_BITS | DUPMODE_BITS);
187 data[1] &= ~(LOOPMODE_BITS);
188 data[1] |= RS232_MODE;
190 result = ssu100_setdevice(dev, data);
192 dev_dbg(&dev->dev, "%s - setdevice failed %i\n", __func__, result);
202 static void ssu100_set_termios(struct tty_struct *tty,
203 struct usb_serial_port *port,
204 struct ktermios *old_termios)
206 struct usb_device *dev = port->serial->dev;
207 struct ktermios *termios = &tty->termios;
208 u16 baud, divisor, remainder;
209 unsigned int cflag = termios->c_cflag;
210 u16 urb_value = 0; /* will hold the new flags */
213 if (cflag & PARENB) {
215 urb_value |= UART_LCR_PARITY;
217 urb_value |= SERIAL_EVEN_PARITY;
220 switch (cflag & CSIZE) {
222 urb_value |= UART_LCR_WLEN5;
225 urb_value |= UART_LCR_WLEN6;
228 urb_value |= UART_LCR_WLEN7;
232 urb_value |= UART_LCR_WLEN8;
236 baud = tty_get_baud_rate(tty);
240 dev_dbg(&port->dev, "%s - got baud = %d\n", __func__, baud);
243 divisor = MAX_BAUD_RATE / baud;
244 remainder = MAX_BAUD_RATE % baud;
245 if (((remainder * 2) >= baud) && (baud != 110))
248 urb_value = urb_value << 8;
250 result = ssu100_control_msg(dev, QT_GET_SET_UART, divisor, urb_value);
252 dev_dbg(&port->dev, "%s - set uart failed\n", __func__);
255 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
258 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
261 dev_dbg(&port->dev, "%s - set HW flow control failed\n", __func__);
263 if (I_IXOFF(tty) || I_IXON(tty)) {
264 u16 x = ((u16)(START_CHAR(tty) << 8) | (u16)(STOP_CHAR(tty)));
266 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
269 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
273 dev_dbg(&port->dev, "%s - set SW flow control failed\n", __func__);
278 static int ssu100_open(struct tty_struct *tty, struct usb_serial_port *port)
280 struct usb_device *dev = port->serial->dev;
281 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
286 data = kzalloc(2, GFP_KERNEL);
290 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
291 QT_OPEN_CLOSE_CHANNEL,
292 QT_TRANSFER_IN, 0x01,
295 dev_dbg(&port->dev, "%s - open failed %i\n", __func__, result);
300 spin_lock_irqsave(&priv->status_lock, flags);
301 priv->shadowLSR = data[0];
302 priv->shadowMSR = data[1];
303 spin_unlock_irqrestore(&priv->status_lock, flags);
308 result = ssu100_control_msg(dev, QT_GET_SET_UART, 0x30, 0x0300);
310 dev_dbg(&port->dev, "%s - set uart failed\n", __func__);
313 ssu100_set_termios(tty, port, &tty->termios);
315 return usb_serial_generic_open(tty, port);
318 static void ssu100_close(struct usb_serial_port *port)
320 usb_serial_generic_close(port);
323 static int get_serial_info(struct usb_serial_port *port,
324 struct serial_struct __user *retinfo)
326 struct serial_struct tmp;
331 memset(&tmp, 0, sizeof(tmp));
332 tmp.line = port->serial->minor;
335 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
336 tmp.xmit_fifo_size = port->bulk_out_size;
337 tmp.baud_base = 9600;
338 tmp.close_delay = 5*HZ;
339 tmp.closing_wait = 30*HZ;
341 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
346 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
348 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
349 struct async_icount prev, cur;
352 spin_lock_irqsave(&priv->status_lock, flags);
354 spin_unlock_irqrestore(&priv->status_lock, flags);
357 wait_event_interruptible(port->delta_msr_wait,
358 (port->serial->disconnected ||
359 (priv->icount.rng != prev.rng) ||
360 (priv->icount.dsr != prev.dsr) ||
361 (priv->icount.dcd != prev.dcd) ||
362 (priv->icount.cts != prev.cts)));
364 if (signal_pending(current))
367 if (port->serial->disconnected)
370 spin_lock_irqsave(&priv->status_lock, flags);
372 spin_unlock_irqrestore(&priv->status_lock, flags);
374 if ((prev.rng == cur.rng) &&
375 (prev.dsr == cur.dsr) &&
376 (prev.dcd == cur.dcd) &&
377 (prev.cts == cur.cts))
380 if ((arg & TIOCM_RNG && (prev.rng != cur.rng)) ||
381 (arg & TIOCM_DSR && (prev.dsr != cur.dsr)) ||
382 (arg & TIOCM_CD && (prev.dcd != cur.dcd)) ||
383 (arg & TIOCM_CTS && (prev.cts != cur.cts)))
389 static int ssu100_get_icount(struct tty_struct *tty,
390 struct serial_icounter_struct *icount)
392 struct usb_serial_port *port = tty->driver_data;
393 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
394 struct async_icount cnow = priv->icount;
396 icount->cts = cnow.cts;
397 icount->dsr = cnow.dsr;
398 icount->rng = cnow.rng;
399 icount->dcd = cnow.dcd;
400 icount->rx = cnow.rx;
401 icount->tx = cnow.tx;
402 icount->frame = cnow.frame;
403 icount->overrun = cnow.overrun;
404 icount->parity = cnow.parity;
405 icount->brk = cnow.brk;
406 icount->buf_overrun = cnow.buf_overrun;
413 static int ssu100_ioctl(struct tty_struct *tty,
414 unsigned int cmd, unsigned long arg)
416 struct usb_serial_port *port = tty->driver_data;
418 dev_dbg(&port->dev, "%s cmd 0x%04x\n", __func__, cmd);
422 return get_serial_info(port,
423 (struct serial_struct __user *) arg);
426 return wait_modem_info(port, arg);
432 dev_dbg(&port->dev, "%s arg not supported\n", __func__);
437 static int ssu100_attach(struct usb_serial *serial)
439 return ssu100_initdevice(serial->dev);
442 static int ssu100_port_probe(struct usb_serial_port *port)
444 struct ssu100_port_private *priv;
446 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
450 spin_lock_init(&priv->status_lock);
452 usb_set_serial_port_data(port, priv);
457 static int ssu100_port_remove(struct usb_serial_port *port)
459 struct ssu100_port_private *priv;
461 priv = usb_get_serial_port_data(port);
467 static int ssu100_tiocmget(struct tty_struct *tty)
469 struct usb_serial_port *port = tty->driver_data;
470 struct usb_device *dev = port->serial->dev;
474 d = kzalloc(2, GFP_KERNEL);
478 r = ssu100_getregister(dev, 0, UART_MCR, d);
482 r = ssu100_getregister(dev, 0, UART_MSR, d+1);
486 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
487 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
488 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
489 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
490 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
491 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
498 static int ssu100_tiocmset(struct tty_struct *tty,
499 unsigned int set, unsigned int clear)
501 struct usb_serial_port *port = tty->driver_data;
502 struct usb_device *dev = port->serial->dev;
504 return update_mctrl(dev, set, clear);
507 static void ssu100_dtr_rts(struct usb_serial_port *port, int on)
509 struct usb_device *dev = port->serial->dev;
511 /* Disable flow control */
513 if (ssu100_setregister(dev, 0, UART_MCR, 0) < 0)
514 dev_err(&port->dev, "error from flowcontrol urb\n");
516 /* drop RTS and DTR */
518 set_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
520 clear_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
523 static void ssu100_update_msr(struct usb_serial_port *port, u8 msr)
525 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
528 spin_lock_irqsave(&priv->status_lock, flags);
529 priv->shadowMSR = msr;
530 spin_unlock_irqrestore(&priv->status_lock, flags);
532 if (msr & UART_MSR_ANY_DELTA) {
533 /* update input line counters */
534 if (msr & UART_MSR_DCTS)
536 if (msr & UART_MSR_DDSR)
538 if (msr & UART_MSR_DDCD)
540 if (msr & UART_MSR_TERI)
542 wake_up_interruptible(&port->delta_msr_wait);
546 static void ssu100_update_lsr(struct usb_serial_port *port, u8 lsr,
549 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
552 spin_lock_irqsave(&priv->status_lock, flags);
553 priv->shadowLSR = lsr;
554 spin_unlock_irqrestore(&priv->status_lock, flags);
556 *tty_flag = TTY_NORMAL;
557 if (lsr & UART_LSR_BRK_ERROR_BITS) {
558 /* we always want to update icount, but we only want to
559 * update tty_flag for one case */
560 if (lsr & UART_LSR_BI) {
562 *tty_flag = TTY_BREAK;
563 usb_serial_handle_break(port);
565 if (lsr & UART_LSR_PE) {
566 priv->icount.parity++;
567 if (*tty_flag == TTY_NORMAL)
568 *tty_flag = TTY_PARITY;
570 if (lsr & UART_LSR_FE) {
571 priv->icount.frame++;
572 if (*tty_flag == TTY_NORMAL)
573 *tty_flag = TTY_FRAME;
575 if (lsr & UART_LSR_OE){
576 priv->icount.overrun++;
577 if (*tty_flag == TTY_NORMAL)
578 *tty_flag = TTY_OVERRUN;
584 static void ssu100_process_read_urb(struct urb *urb)
586 struct usb_serial_port *port = urb->context;
587 char *packet = (char *)urb->transfer_buffer;
588 char flag = TTY_NORMAL;
589 u32 len = urb->actual_length;
594 (packet[0] == 0x1b) && (packet[1] == 0x1b) &&
595 ((packet[2] == 0x00) || (packet[2] == 0x01))) {
596 if (packet[2] == 0x00) {
597 ssu100_update_lsr(port, packet[3], &flag);
598 if (flag == TTY_OVERRUN)
599 tty_insert_flip_char(&port->port, 0,
602 if (packet[2] == 0x01)
603 ssu100_update_msr(port, packet[3]);
611 return; /* status only */
613 if (port->port.console && port->sysrq) {
614 for (i = 0; i < len; i++, ch++) {
615 if (!usb_serial_handle_sysrq_char(port, *ch))
616 tty_insert_flip_char(&port->port, *ch, flag);
619 tty_insert_flip_string_fixed_flag(&port->port, ch, flag, len);
621 tty_flip_buffer_push(&port->port);
624 static struct usb_serial_driver ssu100_device = {
626 .owner = THIS_MODULE,
629 .description = DRIVER_DESC,
630 .id_table = id_table,
633 .close = ssu100_close,
634 .attach = ssu100_attach,
635 .port_probe = ssu100_port_probe,
636 .port_remove = ssu100_port_remove,
637 .dtr_rts = ssu100_dtr_rts,
638 .process_read_urb = ssu100_process_read_urb,
639 .tiocmget = ssu100_tiocmget,
640 .tiocmset = ssu100_tiocmset,
641 .get_icount = ssu100_get_icount,
642 .ioctl = ssu100_ioctl,
643 .set_termios = ssu100_set_termios,
644 .disconnect = usb_serial_generic_disconnect,
647 static struct usb_serial_driver * const serial_drivers[] = {
651 module_usb_serial_driver(serial_drivers, id_table);
653 MODULE_DESCRIPTION(DRIVER_DESC);
654 MODULE_LICENSE("GPL");