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 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
82 unsigned short max_packet_size;
83 struct async_icount icount;
86 static void ssu100_release(struct usb_serial *serial)
88 struct ssu100_port_private *priv = usb_get_serial_port_data(*serial->port);
94 static inline int ssu100_control_msg(struct usb_device *dev,
95 u8 request, u16 data, u16 index)
97 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
98 request, 0x40, data, index,
102 static inline int ssu100_setdevice(struct usb_device *dev, u8 *data)
104 u16 x = ((u16)(data[1] << 8) | (u16)(data[0]));
106 return ssu100_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
110 static inline int ssu100_getdevice(struct usb_device *dev, u8 *data)
112 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
113 QT_SET_GET_DEVICE, 0xc0, 0, 0,
117 static inline int ssu100_getregister(struct usb_device *dev,
122 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
123 QT_SET_GET_REGISTER, 0xc0, reg,
124 uart, data, sizeof(*data), 300);
129 static inline int ssu100_setregister(struct usb_device *dev,
134 u16 value = (data << 8) | reg;
136 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
137 QT_SET_GET_REGISTER, 0x40, value, uart,
142 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
143 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
145 /* these do not deal with device that have more than 1 port */
146 static inline int update_mctrl(struct usb_device *dev, unsigned int set,
152 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
153 dbg("%s - DTR|RTS not being set|cleared", __func__);
154 return 0; /* no change */
157 clear &= ~set; /* 'set' takes precedence over 'clear' */
160 urb_value |= UART_MCR_DTR;
162 urb_value |= UART_MCR_RTS;
164 result = ssu100_setregister(dev, 0, UART_MCR, urb_value);
166 dbg("%s Error from MODEM_CTRL urb", __func__);
171 static int ssu100_initdevice(struct usb_device *dev)
178 data = kzalloc(3, GFP_KERNEL);
182 result = ssu100_getdevice(dev, data);
184 dbg("%s - get_device failed %i", __func__, result);
188 data[1] &= ~FULLPWRBIT;
190 result = ssu100_setdevice(dev, data);
192 dbg("%s - setdevice failed %i", __func__, result);
196 result = ssu100_control_msg(dev, QT_GET_SET_PREBUF_TRIG_LVL, 128, 0);
198 dbg("%s - set prebuffer level failed %i", __func__, result);
202 result = ssu100_control_msg(dev, QT_SET_ATF, ATC_DISABLED, 0);
204 dbg("%s - set ATFprebuffer level failed %i", __func__, result);
208 result = ssu100_getdevice(dev, data);
210 dbg("%s - get_device failed %i", __func__, result);
214 data[0] &= ~(RR_BITS | DUPMODE_BITS);
216 data[1] &= ~(LOOPMODE_BITS);
217 data[1] |= RS232_MODE;
219 result = ssu100_setdevice(dev, data);
221 dbg("%s - setdevice failed %i", __func__, result);
231 static void ssu100_set_termios(struct tty_struct *tty,
232 struct usb_serial_port *port,
233 struct ktermios *old_termios)
235 struct usb_device *dev = port->serial->dev;
236 struct ktermios *termios = tty->termios;
237 u16 baud, divisor, remainder;
238 unsigned int cflag = termios->c_cflag;
239 u16 urb_value = 0; /* will hold the new flags */
244 if (cflag & PARENB) {
246 urb_value |= UART_LCR_PARITY;
248 urb_value |= SERIAL_EVEN_PARITY;
251 switch (cflag & CSIZE) {
253 urb_value |= UART_LCR_WLEN5;
256 urb_value |= UART_LCR_WLEN6;
259 urb_value |= UART_LCR_WLEN7;
263 urb_value |= UART_LCR_WLEN8;
267 baud = tty_get_baud_rate(tty);
271 dbg("%s - got baud = %d\n", __func__, baud);
274 divisor = MAX_BAUD_RATE / baud;
275 remainder = MAX_BAUD_RATE % baud;
276 if (((remainder * 2) >= baud) && (baud != 110))
279 urb_value = urb_value << 8;
281 result = ssu100_control_msg(dev, QT_GET_SET_UART, divisor, urb_value);
283 dbg("%s - set uart failed", __func__);
286 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
289 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
292 dbg("%s - set HW flow control failed", __func__);
294 if (I_IXOFF(tty) || I_IXON(tty)) {
295 u16 x = ((u16)(START_CHAR(tty) << 8) | (u16)(STOP_CHAR(tty)));
297 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
300 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
304 dbg("%s - set SW flow control failed", __func__);
309 static int ssu100_open(struct tty_struct *tty, struct usb_serial_port *port)
311 struct usb_device *dev = port->serial->dev;
312 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
317 dbg("%s - port %d", __func__, port->number);
319 data = kzalloc(2, GFP_KERNEL);
323 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
324 QT_OPEN_CLOSE_CHANNEL,
325 QT_TRANSFER_IN, 0x01,
328 dbg("%s - open failed %i", __func__, result);
333 spin_lock_irqsave(&priv->status_lock, flags);
334 priv->shadowLSR = data[0];
335 priv->shadowMSR = data[1];
336 spin_unlock_irqrestore(&priv->status_lock, flags);
341 result = ssu100_control_msg(dev, QT_GET_SET_UART, 0x30, 0x0300);
343 dbg("%s - set uart failed", __func__);
346 ssu100_set_termios(tty, port, tty->termios);
348 return usb_serial_generic_open(tty, port);
351 static void ssu100_close(struct usb_serial_port *port)
354 usb_serial_generic_close(port);
357 static int get_serial_info(struct usb_serial_port *port,
358 struct serial_struct __user *retinfo)
360 struct serial_struct tmp;
365 memset(&tmp, 0, sizeof(tmp));
366 tmp.line = port->serial->minor;
369 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
370 tmp.xmit_fifo_size = port->bulk_out_size;
371 tmp.baud_base = 9600;
372 tmp.close_delay = 5*HZ;
373 tmp.closing_wait = 30*HZ;
375 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
380 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
382 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
383 struct async_icount prev, cur;
386 spin_lock_irqsave(&priv->status_lock, flags);
388 spin_unlock_irqrestore(&priv->status_lock, flags);
391 wait_event_interruptible(priv->delta_msr_wait,
392 ((priv->icount.rng != prev.rng) ||
393 (priv->icount.dsr != prev.dsr) ||
394 (priv->icount.dcd != prev.dcd) ||
395 (priv->icount.cts != prev.cts)));
397 if (signal_pending(current))
400 spin_lock_irqsave(&priv->status_lock, flags);
402 spin_unlock_irqrestore(&priv->status_lock, flags);
404 if ((prev.rng == cur.rng) &&
405 (prev.dsr == cur.dsr) &&
406 (prev.dcd == cur.dcd) &&
407 (prev.cts == cur.cts))
410 if ((arg & TIOCM_RNG && (prev.rng != cur.rng)) ||
411 (arg & TIOCM_DSR && (prev.dsr != cur.dsr)) ||
412 (arg & TIOCM_CD && (prev.dcd != cur.dcd)) ||
413 (arg & TIOCM_CTS && (prev.cts != cur.cts)))
419 static int ssu100_get_icount(struct tty_struct *tty,
420 struct serial_icounter_struct *icount)
422 struct usb_serial_port *port = tty->driver_data;
423 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
424 struct async_icount cnow = priv->icount;
426 icount->cts = cnow.cts;
427 icount->dsr = cnow.dsr;
428 icount->rng = cnow.rng;
429 icount->dcd = cnow.dcd;
430 icount->rx = cnow.rx;
431 icount->tx = cnow.tx;
432 icount->frame = cnow.frame;
433 icount->overrun = cnow.overrun;
434 icount->parity = cnow.parity;
435 icount->brk = cnow.brk;
436 icount->buf_overrun = cnow.buf_overrun;
443 static int ssu100_ioctl(struct tty_struct *tty, struct file *file,
444 unsigned int cmd, unsigned long arg)
446 struct usb_serial_port *port = tty->driver_data;
448 dbg("%s cmd 0x%04x", __func__, cmd);
452 return get_serial_info(port,
453 (struct serial_struct __user *) arg);
456 return wait_modem_info(port, arg);
462 dbg("%s arg not supported", __func__);
467 static void ssu100_set_max_packet_size(struct usb_serial_port *port)
469 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
470 struct usb_serial *serial = port->serial;
471 struct usb_device *udev = serial->dev;
473 struct usb_interface *interface = serial->interface;
474 struct usb_endpoint_descriptor *ep_desc = &interface->cur_altsetting->endpoint[1].desc;
476 unsigned num_endpoints;
480 num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
481 dev_info(&udev->dev, "Number of endpoints %d\n", num_endpoints);
483 for (i = 0; i < num_endpoints; i++) {
484 dev_info(&udev->dev, "Endpoint %d MaxPacketSize %d\n", i+1,
485 interface->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
486 ep_desc = &interface->cur_altsetting->endpoint[i].desc;
489 /* set max packet size based on descriptor */
490 spin_lock_irqsave(&priv->status_lock, flags);
491 priv->max_packet_size = ep_desc->wMaxPacketSize;
492 spin_unlock_irqrestore(&priv->status_lock, flags);
494 dev_info(&udev->dev, "Setting MaxPacketSize %d\n", priv->max_packet_size);
497 static int ssu100_attach(struct usb_serial *serial)
499 struct ssu100_port_private *priv;
500 struct usb_serial_port *port = *serial->port;
504 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
506 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
511 spin_lock_init(&priv->status_lock);
512 init_waitqueue_head(&priv->delta_msr_wait);
513 usb_set_serial_port_data(port, priv);
514 ssu100_set_max_packet_size(port);
516 return ssu100_initdevice(serial->dev);
519 static int ssu100_tiocmget(struct tty_struct *tty, struct file *file)
521 struct usb_serial_port *port = tty->driver_data;
522 struct usb_device *dev = port->serial->dev;
526 dbg("%s\n", __func__);
528 d = kzalloc(2, GFP_KERNEL);
532 r = ssu100_getregister(dev, 0, UART_MCR, d);
536 r = ssu100_getregister(dev, 0, UART_MSR, d+1);
540 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
541 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
542 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
543 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
544 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
545 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
552 static int ssu100_tiocmset(struct tty_struct *tty, struct file *file,
553 unsigned int set, unsigned int clear)
555 struct usb_serial_port *port = tty->driver_data;
556 struct usb_device *dev = port->serial->dev;
558 dbg("%s\n", __func__);
559 return update_mctrl(dev, set, clear);
562 static void ssu100_dtr_rts(struct usb_serial_port *port, int on)
564 struct usb_device *dev = port->serial->dev;
566 dbg("%s\n", __func__);
568 mutex_lock(&port->serial->disc_mutex);
569 if (!port->serial->disconnected) {
570 /* Disable flow control */
572 ssu100_setregister(dev, 0, UART_MCR, 0) < 0)
573 dev_err(&port->dev, "error from flowcontrol urb\n");
574 /* drop RTS and DTR */
576 set_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
578 clear_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
580 mutex_unlock(&port->serial->disc_mutex);
583 static void ssu100_update_msr(struct usb_serial_port *port, u8 msr)
585 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
588 spin_lock_irqsave(&priv->status_lock, flags);
589 priv->shadowMSR = msr;
590 spin_unlock_irqrestore(&priv->status_lock, flags);
592 if (msr & UART_MSR_ANY_DELTA) {
593 /* update input line counters */
594 if (msr & UART_MSR_DCTS)
596 if (msr & UART_MSR_DDSR)
598 if (msr & UART_MSR_DDCD)
600 if (msr & UART_MSR_TERI)
602 wake_up_interruptible(&priv->delta_msr_wait);
606 static void ssu100_update_lsr(struct usb_serial_port *port, u8 lsr,
609 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
612 spin_lock_irqsave(&priv->status_lock, flags);
613 priv->shadowLSR = lsr;
614 spin_unlock_irqrestore(&priv->status_lock, flags);
616 *tty_flag = TTY_NORMAL;
617 if (lsr & UART_LSR_BRK_ERROR_BITS) {
618 /* we always want to update icount, but we only want to
619 * update tty_flag for one case */
620 if (lsr & UART_LSR_BI) {
622 *tty_flag = TTY_BREAK;
623 usb_serial_handle_break(port);
625 if (lsr & UART_LSR_PE) {
626 priv->icount.parity++;
627 if (*tty_flag == TTY_NORMAL)
628 *tty_flag = TTY_PARITY;
630 if (lsr & UART_LSR_FE) {
631 priv->icount.frame++;
632 if (*tty_flag == TTY_NORMAL)
633 *tty_flag = TTY_FRAME;
635 if (lsr & UART_LSR_OE){
636 priv->icount.overrun++;
637 if (*tty_flag == TTY_NORMAL)
638 *tty_flag = TTY_OVERRUN;
644 static int ssu100_process_packet(struct tty_struct *tty,
645 struct usb_serial_port *port,
646 struct ssu100_port_private *priv,
647 char *packet, int len)
650 char flag = TTY_NORMAL;
653 dbg("%s - port %d", __func__, port->number);
656 (packet[0] == 0x1b) && (packet[1] == 0x1b) &&
657 ((packet[2] == 0x00) || (packet[2] == 0x01))) {
658 if (packet[2] == 0x00) {
659 ssu100_update_lsr(port, packet[3], &flag);
660 if (flag == TTY_OVERRUN)
661 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
663 if (packet[2] == 0x01)
664 ssu100_update_msr(port, packet[3]);
672 return 0; /* status only */
674 if (port->port.console && port->sysrq) {
675 for (i = 0; i < len; i++, ch++) {
676 if (!usb_serial_handle_sysrq_char(port, *ch))
677 tty_insert_flip_char(tty, *ch, flag);
680 tty_insert_flip_string_fixed_flag(tty, ch, flag, len);
685 static void ssu100_process_read_urb(struct urb *urb)
687 struct usb_serial_port *port = urb->context;
688 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
689 char *data = (char *)urb->transfer_buffer;
690 struct tty_struct *tty;
697 tty = tty_port_tty_get(&port->port);
701 for (i = 0; i < urb->actual_length; i += priv->max_packet_size) {
702 len = min_t(int, urb->actual_length - i, priv->max_packet_size);
703 count += ssu100_process_packet(tty, port, priv, &data[i], len);
707 tty_flip_buffer_push(tty);
711 static struct usb_serial_driver ssu100_device = {
713 .owner = THIS_MODULE,
716 .description = DRIVER_DESC,
717 .id_table = id_table,
718 .usb_driver = &ssu100_driver,
721 .bulk_out_size = 256,
723 .close = ssu100_close,
724 .attach = ssu100_attach,
725 .release = ssu100_release,
726 .dtr_rts = ssu100_dtr_rts,
727 .process_read_urb = ssu100_process_read_urb,
728 .tiocmget = ssu100_tiocmget,
729 .tiocmset = ssu100_tiocmset,
730 .get_icount = ssu100_get_icount,
731 .ioctl = ssu100_ioctl,
732 .set_termios = ssu100_set_termios,
733 .disconnect = usb_serial_generic_disconnect,
736 static int __init ssu100_init(void)
742 /* register with usb-serial */
743 retval = usb_serial_register(&ssu100_device);
746 goto failed_usb_sio_register;
748 retval = usb_register(&ssu100_driver);
750 goto failed_usb_register;
752 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
758 usb_serial_deregister(&ssu100_device);
759 failed_usb_sio_register:
763 static void __exit ssu100_exit(void)
765 usb_deregister(&ssu100_driver);
766 usb_serial_deregister(&ssu100_device);
769 module_init(ssu100_init);
770 module_exit(ssu100_exit);
772 MODULE_DESCRIPTION(DRIVER_DESC);
773 MODULE_LICENSE("GPL");
775 module_param(debug, bool, S_IRUGO | S_IWUSR);
776 MODULE_PARM_DESC(debug, "Debug enabled or not");