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
51 /* Version Information */
52 #define DRIVER_VERSION "v0.1"
53 #define DRIVER_DESC "Quatech SSU-100 USB to Serial Driver"
55 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
56 #define QUATECH_SSU100 0xC020 /* SSU100 */
58 static const struct usb_device_id id_table[] = {
59 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100)},
60 {} /* Terminating entry */
63 MODULE_DEVICE_TABLE(usb, id_table);
66 static struct usb_driver ssu100_driver = {
68 .probe = usb_serial_probe,
69 .disconnect = usb_serial_disconnect,
71 .suspend = usb_serial_suspend,
72 .resume = usb_serial_resume,
74 .supports_autosuspend = 1,
77 struct ssu100_port_private {
78 spinlock_t status_lock;
81 struct async_icount icount;
84 static void ssu100_release(struct usb_serial *serial)
86 struct ssu100_port_private *priv = usb_get_serial_port_data(*serial->port);
92 static inline int ssu100_control_msg(struct usb_device *dev,
93 u8 request, u16 data, u16 index)
95 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
96 request, 0x40, data, index,
100 static inline int ssu100_setdevice(struct usb_device *dev, u8 *data)
102 u16 x = ((u16)(data[1] << 8) | (u16)(data[0]));
104 return ssu100_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
108 static inline int ssu100_getdevice(struct usb_device *dev, u8 *data)
112 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
113 QT_SET_GET_DEVICE, 0xc0, 0, 0,
123 static inline int ssu100_getregister(struct usb_device *dev,
130 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
131 QT_SET_GET_REGISTER, 0xc0, reg,
132 uart, data, sizeof(*data), 300);
133 if (ret < sizeof(*data)) {
142 static inline int ssu100_setregister(struct usb_device *dev,
147 u16 value = (data << 8) | reg;
149 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
150 QT_SET_GET_REGISTER, 0x40, value, uart,
155 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
156 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
158 /* these do not deal with device that have more than 1 port */
159 static inline int update_mctrl(struct usb_device *dev, unsigned int set,
165 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
166 dbg("%s - DTR|RTS not being set|cleared", __func__);
167 return 0; /* no change */
170 clear &= ~set; /* 'set' takes precedence over 'clear' */
173 urb_value |= UART_MCR_DTR;
175 urb_value |= UART_MCR_RTS;
177 result = ssu100_setregister(dev, 0, UART_MCR, urb_value);
179 dbg("%s Error from MODEM_CTRL urb", __func__);
184 static int ssu100_initdevice(struct usb_device *dev)
191 data = kzalloc(3, GFP_KERNEL);
195 result = ssu100_getdevice(dev, data);
197 dbg("%s - get_device failed %i", __func__, result);
201 data[1] &= ~FULLPWRBIT;
203 result = ssu100_setdevice(dev, data);
205 dbg("%s - setdevice failed %i", __func__, result);
209 result = ssu100_control_msg(dev, QT_GET_SET_PREBUF_TRIG_LVL, 128, 0);
211 dbg("%s - set prebuffer level failed %i", __func__, result);
215 result = ssu100_control_msg(dev, QT_SET_ATF, ATC_DISABLED, 0);
217 dbg("%s - set ATFprebuffer level failed %i", __func__, result);
221 result = ssu100_getdevice(dev, data);
223 dbg("%s - get_device failed %i", __func__, result);
227 data[0] &= ~(RR_BITS | DUPMODE_BITS);
229 data[1] &= ~(LOOPMODE_BITS);
230 data[1] |= RS232_MODE;
232 result = ssu100_setdevice(dev, data);
234 dbg("%s - setdevice failed %i", __func__, result);
244 static void ssu100_set_termios(struct tty_struct *tty,
245 struct usb_serial_port *port,
246 struct ktermios *old_termios)
248 struct usb_device *dev = port->serial->dev;
249 struct ktermios *termios = tty->termios;
250 u16 baud, divisor, remainder;
251 unsigned int cflag = termios->c_cflag;
252 u16 urb_value = 0; /* will hold the new flags */
257 if (cflag & PARENB) {
259 urb_value |= UART_LCR_PARITY;
261 urb_value |= SERIAL_EVEN_PARITY;
264 switch (cflag & CSIZE) {
266 urb_value |= UART_LCR_WLEN5;
269 urb_value |= UART_LCR_WLEN6;
272 urb_value |= UART_LCR_WLEN7;
276 urb_value |= UART_LCR_WLEN8;
280 baud = tty_get_baud_rate(tty);
284 dbg("%s - got baud = %d\n", __func__, baud);
287 divisor = MAX_BAUD_RATE / baud;
288 remainder = MAX_BAUD_RATE % baud;
289 if (((remainder * 2) >= baud) && (baud != 110))
292 urb_value = urb_value << 8;
294 result = ssu100_control_msg(dev, QT_GET_SET_UART, divisor, urb_value);
296 dbg("%s - set uart failed", __func__);
299 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
302 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
305 dbg("%s - set HW flow control failed", __func__);
307 if (I_IXOFF(tty) || I_IXON(tty)) {
308 u16 x = ((u16)(START_CHAR(tty) << 8) | (u16)(STOP_CHAR(tty)));
310 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
313 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
317 dbg("%s - set SW flow control failed", __func__);
322 static int ssu100_open(struct tty_struct *tty, struct usb_serial_port *port)
324 struct usb_device *dev = port->serial->dev;
325 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
330 dbg("%s - port %d", __func__, port->number);
332 data = kzalloc(2, GFP_KERNEL);
336 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
337 QT_OPEN_CLOSE_CHANNEL,
338 QT_TRANSFER_IN, 0x01,
341 dbg("%s - open failed %i", __func__, result);
348 spin_lock_irqsave(&priv->status_lock, flags);
349 priv->shadowLSR = data[0];
350 priv->shadowMSR = data[1];
351 spin_unlock_irqrestore(&priv->status_lock, flags);
356 result = ssu100_control_msg(dev, QT_GET_SET_UART, 0x30, 0x0300);
358 dbg("%s - set uart failed", __func__);
361 ssu100_set_termios(tty, port, tty->termios);
363 return usb_serial_generic_open(tty, port);
366 static void ssu100_close(struct usb_serial_port *port)
369 usb_serial_generic_close(port);
372 static int get_serial_info(struct usb_serial_port *port,
373 struct serial_struct __user *retinfo)
375 struct serial_struct tmp;
380 memset(&tmp, 0, sizeof(tmp));
381 tmp.line = port->serial->minor;
384 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
385 tmp.xmit_fifo_size = port->bulk_out_size;
386 tmp.baud_base = 9600;
387 tmp.close_delay = 5*HZ;
388 tmp.closing_wait = 30*HZ;
390 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
395 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
397 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
398 struct async_icount prev, cur;
401 spin_lock_irqsave(&priv->status_lock, flags);
403 spin_unlock_irqrestore(&priv->status_lock, flags);
406 wait_event_interruptible(port->delta_msr_wait,
407 (port->serial->disconnected ||
408 (priv->icount.rng != prev.rng) ||
409 (priv->icount.dsr != prev.dsr) ||
410 (priv->icount.dcd != prev.dcd) ||
411 (priv->icount.cts != prev.cts)));
413 if (signal_pending(current))
416 if (port->serial->disconnected)
419 spin_lock_irqsave(&priv->status_lock, flags);
421 spin_unlock_irqrestore(&priv->status_lock, flags);
423 if ((prev.rng == cur.rng) &&
424 (prev.dsr == cur.dsr) &&
425 (prev.dcd == cur.dcd) &&
426 (prev.cts == cur.cts))
429 if ((arg & TIOCM_RNG && (prev.rng != cur.rng)) ||
430 (arg & TIOCM_DSR && (prev.dsr != cur.dsr)) ||
431 (arg & TIOCM_CD && (prev.dcd != cur.dcd)) ||
432 (arg & TIOCM_CTS && (prev.cts != cur.cts)))
438 static int ssu100_get_icount(struct tty_struct *tty,
439 struct serial_icounter_struct *icount)
441 struct usb_serial_port *port = tty->driver_data;
442 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
443 struct async_icount cnow = priv->icount;
445 icount->cts = cnow.cts;
446 icount->dsr = cnow.dsr;
447 icount->rng = cnow.rng;
448 icount->dcd = cnow.dcd;
449 icount->rx = cnow.rx;
450 icount->tx = cnow.tx;
451 icount->frame = cnow.frame;
452 icount->overrun = cnow.overrun;
453 icount->parity = cnow.parity;
454 icount->brk = cnow.brk;
455 icount->buf_overrun = cnow.buf_overrun;
462 static int ssu100_ioctl(struct tty_struct *tty,
463 unsigned int cmd, unsigned long arg)
465 struct usb_serial_port *port = tty->driver_data;
467 dbg("%s cmd 0x%04x", __func__, cmd);
471 return get_serial_info(port,
472 (struct serial_struct __user *) arg);
475 return wait_modem_info(port, arg);
481 dbg("%s arg not supported", __func__);
486 static int ssu100_attach(struct usb_serial *serial)
488 struct ssu100_port_private *priv;
489 struct usb_serial_port *port = *serial->port;
493 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
495 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
500 spin_lock_init(&priv->status_lock);
501 usb_set_serial_port_data(port, priv);
503 return ssu100_initdevice(serial->dev);
506 static int ssu100_tiocmget(struct tty_struct *tty)
508 struct usb_serial_port *port = tty->driver_data;
509 struct usb_device *dev = port->serial->dev;
513 dbg("%s\n", __func__);
515 d = kzalloc(2, GFP_KERNEL);
519 r = ssu100_getregister(dev, 0, UART_MCR, d);
523 r = ssu100_getregister(dev, 0, UART_MSR, d+1);
527 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
528 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
529 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
530 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
531 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
532 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
539 static int ssu100_tiocmset(struct tty_struct *tty,
540 unsigned int set, unsigned int clear)
542 struct usb_serial_port *port = tty->driver_data;
543 struct usb_device *dev = port->serial->dev;
545 dbg("%s\n", __func__);
546 return update_mctrl(dev, set, clear);
549 static void ssu100_dtr_rts(struct usb_serial_port *port, int on)
551 struct usb_device *dev = port->serial->dev;
553 dbg("%s\n", __func__);
555 /* Disable flow control */
557 if (ssu100_setregister(dev, 0, UART_MCR, 0) < 0)
558 dev_err(&port->dev, "error from flowcontrol urb\n");
560 /* drop RTS and DTR */
562 set_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
564 clear_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
567 static void ssu100_update_msr(struct usb_serial_port *port, u8 msr)
569 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
572 spin_lock_irqsave(&priv->status_lock, flags);
573 priv->shadowMSR = msr;
574 spin_unlock_irqrestore(&priv->status_lock, flags);
576 if (msr & UART_MSR_ANY_DELTA) {
577 /* update input line counters */
578 if (msr & UART_MSR_DCTS)
580 if (msr & UART_MSR_DDSR)
582 if (msr & UART_MSR_DDCD)
584 if (msr & UART_MSR_TERI)
586 wake_up_interruptible(&port->delta_msr_wait);
590 static void ssu100_update_lsr(struct usb_serial_port *port, u8 lsr,
593 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
596 spin_lock_irqsave(&priv->status_lock, flags);
597 priv->shadowLSR = lsr;
598 spin_unlock_irqrestore(&priv->status_lock, flags);
600 *tty_flag = TTY_NORMAL;
601 if (lsr & UART_LSR_BRK_ERROR_BITS) {
602 /* we always want to update icount, but we only want to
603 * update tty_flag for one case */
604 if (lsr & UART_LSR_BI) {
606 *tty_flag = TTY_BREAK;
607 usb_serial_handle_break(port);
609 if (lsr & UART_LSR_PE) {
610 priv->icount.parity++;
611 if (*tty_flag == TTY_NORMAL)
612 *tty_flag = TTY_PARITY;
614 if (lsr & UART_LSR_FE) {
615 priv->icount.frame++;
616 if (*tty_flag == TTY_NORMAL)
617 *tty_flag = TTY_FRAME;
619 if (lsr & UART_LSR_OE) {
620 priv->icount.overrun++;
621 tty_insert_flip_char(tty_port_tty_get(&port->port),
628 static int ssu100_process_packet(struct urb *urb,
629 struct tty_struct *tty)
631 struct usb_serial_port *port = urb->context;
632 char *packet = (char *)urb->transfer_buffer;
633 char flag = TTY_NORMAL;
634 u32 len = urb->actual_length;
638 dbg("%s - port %d", __func__, port->number);
641 (packet[0] == 0x1b) && (packet[1] == 0x1b) &&
642 ((packet[2] == 0x00) || (packet[2] == 0x01))) {
643 if (packet[2] == 0x00)
644 ssu100_update_lsr(port, packet[3], &flag);
645 if (packet[2] == 0x01)
646 ssu100_update_msr(port, packet[3]);
654 return 0; /* status only */
656 if (port->port.console && port->sysrq) {
657 for (i = 0; i < len; i++, ch++) {
658 if (!usb_serial_handle_sysrq_char(port, *ch))
659 tty_insert_flip_char(tty, *ch, flag);
662 tty_insert_flip_string_fixed_flag(tty, ch, flag, len);
667 static void ssu100_process_read_urb(struct urb *urb)
669 struct usb_serial_port *port = urb->context;
670 struct tty_struct *tty;
675 tty = tty_port_tty_get(&port->port);
679 count = ssu100_process_packet(urb, tty);
682 tty_flip_buffer_push(tty);
686 static struct usb_serial_driver ssu100_device = {
688 .owner = THIS_MODULE,
691 .description = DRIVER_DESC,
692 .id_table = id_table,
693 .usb_driver = &ssu100_driver,
696 .close = ssu100_close,
697 .attach = ssu100_attach,
698 .release = ssu100_release,
699 .dtr_rts = ssu100_dtr_rts,
700 .process_read_urb = ssu100_process_read_urb,
701 .tiocmget = ssu100_tiocmget,
702 .tiocmset = ssu100_tiocmset,
703 .get_icount = ssu100_get_icount,
704 .ioctl = ssu100_ioctl,
705 .set_termios = ssu100_set_termios,
706 .disconnect = usb_serial_generic_disconnect,
709 static int __init ssu100_init(void)
715 /* register with usb-serial */
716 retval = usb_serial_register(&ssu100_device);
719 goto failed_usb_sio_register;
721 retval = usb_register(&ssu100_driver);
723 goto failed_usb_register;
725 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
731 usb_serial_deregister(&ssu100_device);
732 failed_usb_sio_register:
736 static void __exit ssu100_exit(void)
738 usb_deregister(&ssu100_driver);
739 usb_serial_deregister(&ssu100_device);
742 module_init(ssu100_init);
743 module_exit(ssu100_exit);
745 MODULE_DESCRIPTION(DRIVER_DESC);
746 MODULE_LICENSE("GPL");
748 module_param(debug, bool, S_IRUGO | S_IWUSR);
749 MODULE_PARM_DESC(debug, "Debug enabled or not");