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/uaccess.h>
20 #define QT_OPEN_CLOSE_CHANNEL 0xca
21 #define QT_SET_GET_DEVICE 0xc2
22 #define QT_SET_GET_REGISTER 0xc0
23 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
24 #define QT_SET_ATF 0xcd
25 #define QT_GET_SET_UART 0xc1
26 #define QT_TRANSFER_IN 0xc0
27 #define QT_HW_FLOW_CONTROL_MASK 0xc5
28 #define QT_SW_FLOW_CONTROL_MASK 0xc6
30 #define MODEM_CTL_REGISTER 0x04
31 #define MODEM_STATUS_REGISTER 0x06
34 #define SERIAL_LSR_OE 0x02
35 #define SERIAL_LSR_PE 0x04
36 #define SERIAL_LSR_FE 0x08
37 #define SERIAL_LSR_BI 0x10
39 #define SERIAL_LSR_TEMT 0x40
41 #define SERIAL_MCR_DTR 0x01
42 #define SERIAL_MCR_RTS 0x02
43 #define SERIAL_MCR_LOOP 0x10
45 #define SERIAL_MSR_CTS 0x10
46 #define SERIAL_MSR_CD 0x80
47 #define SERIAL_MSR_RI 0x40
48 #define SERIAL_MSR_DSR 0x20
49 #define SERIAL_MSR_MASK 0xf0
51 #define SERIAL_CRTSCTS ((SERIAL_MCR_RTS << 8) | SERIAL_MSR_CTS)
53 #define SERIAL_8_DATA 0x03
54 #define SERIAL_7_DATA 0x02
55 #define SERIAL_6_DATA 0x01
56 #define SERIAL_5_DATA 0x00
58 #define SERIAL_ODD_PARITY 0X08
59 #define SERIAL_EVEN_PARITY 0X18
61 #define MAX_BAUD_RATE 460800
63 #define ATC_DISABLED 0x00
64 #define DUPMODE_BITS 0xc0
66 #define LOOPMODE_BITS 0x41
67 #define RS232_MODE 0x00
68 #define RTSCTS_TO_CONNECTOR 0x40
70 #define FULLPWRBIT 0x00000080
71 #define NEXT_BOARD_POWER_BIT 0x00000004
75 /* Version Information */
76 #define DRIVER_VERSION "v0.1"
77 #define DRIVER_DESC "Quatech SSU-100 USB to Serial Driver"
79 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
80 #define QUATECH_SSU100 0xC020 /* SSU100 */
82 static const struct usb_device_id id_table[] = {
83 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100)},
84 {} /* Terminating entry */
87 MODULE_DEVICE_TABLE(usb, id_table);
90 static struct usb_driver ssu100_driver = {
92 .probe = usb_serial_probe,
93 .disconnect = usb_serial_disconnect,
95 .suspend = usb_serial_suspend,
96 .resume = usb_serial_resume,
98 .supports_autosuspend = 1,
101 struct ssu100_port_private {
102 spinlock_t status_lock;
105 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
106 unsigned short max_packet_size;
109 static void ssu100_release(struct usb_serial *serial)
111 struct ssu100_port_private *priv = usb_get_serial_port_data(*serial->port);
117 static inline int ssu100_control_msg(struct usb_device *dev,
118 u8 request, u16 data, u16 index)
120 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
121 request, 0x40, data, index,
125 static inline int ssu100_setdevice(struct usb_device *dev, u8 *data)
127 u16 x = ((u16)(data[1] << 8) | (u16)(data[0]));
129 return ssu100_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
133 static inline int ssu100_getdevice(struct usb_device *dev, u8 *data)
135 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
136 QT_SET_GET_DEVICE, 0xc0, 0, 0,
140 static inline int ssu100_getregister(struct usb_device *dev,
145 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
146 QT_SET_GET_REGISTER, 0xc0, reg,
147 uart, data, sizeof(*data), 300);
152 static inline int ssu100_setregister(struct usb_device *dev,
156 u16 value = (data << 8) | MODEM_CTL_REGISTER;
158 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
159 QT_SET_GET_REGISTER, 0x40, value, uart,
164 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
165 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
167 /* these do not deal with device that have more than 1 port */
168 static inline int update_mctrl(struct usb_device *dev, unsigned int set,
174 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
175 dbg("%s - DTR|RTS not being set|cleared", __func__);
176 return 0; /* no change */
179 clear &= ~set; /* 'set' takes precedence over 'clear' */
182 urb_value |= SERIAL_MCR_DTR;
184 urb_value |= SERIAL_MCR_RTS;
186 result = ssu100_setregister(dev, 0, urb_value);
188 dbg("%s Error from MODEM_CTRL urb", __func__);
193 static int ssu100_initdevice(struct usb_device *dev)
200 data = kzalloc(3, GFP_KERNEL);
204 result = ssu100_getdevice(dev, data);
206 dbg("%s - get_device failed %i", __func__, result);
210 data[1] &= ~FULLPWRBIT;
212 result = ssu100_setdevice(dev, data);
214 dbg("%s - setdevice failed %i", __func__, result);
218 result = ssu100_control_msg(dev, QT_GET_SET_PREBUF_TRIG_LVL, 128, 0);
220 dbg("%s - set prebuffer level failed %i", __func__, result);
224 result = ssu100_control_msg(dev, QT_SET_ATF, ATC_DISABLED, 0);
226 dbg("%s - set ATFprebuffer level failed %i", __func__, result);
230 result = ssu100_getdevice(dev, data);
232 dbg("%s - get_device failed %i", __func__, result);
236 data[0] &= ~(RR_BITS | DUPMODE_BITS);
238 data[1] &= ~(LOOPMODE_BITS);
239 data[1] |= RS232_MODE;
241 result = ssu100_setdevice(dev, data);
243 dbg("%s - setdevice failed %i", __func__, result);
253 static void ssu100_set_termios(struct tty_struct *tty,
254 struct usb_serial_port *port,
255 struct ktermios *old_termios)
257 struct usb_device *dev = port->serial->dev;
258 struct ktermios *termios = tty->termios;
259 u16 baud, divisor, remainder;
260 unsigned int cflag = termios->c_cflag;
261 u16 urb_value = 0; /* will hold the new flags */
266 if (cflag & PARENB) {
268 urb_value |= SERIAL_ODD_PARITY;
270 urb_value |= SERIAL_EVEN_PARITY;
273 switch (cflag & CSIZE) {
275 urb_value |= SERIAL_5_DATA;
278 urb_value |= SERIAL_6_DATA;
281 urb_value |= SERIAL_7_DATA;
285 urb_value |= SERIAL_8_DATA;
289 baud = tty_get_baud_rate(tty);
293 dbg("%s - got baud = %d\n", __func__, baud);
296 divisor = MAX_BAUD_RATE / baud;
297 remainder = MAX_BAUD_RATE % baud;
298 if (((remainder * 2) >= baud) && (baud != 110))
301 urb_value = urb_value << 8;
303 result = ssu100_control_msg(dev, QT_GET_SET_UART, divisor, urb_value);
305 dbg("%s - set uart failed", __func__);
308 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
311 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
314 dbg("%s - set HW flow control failed", __func__);
316 if (I_IXOFF(tty) || I_IXON(tty)) {
317 u16 x = ((u16)(START_CHAR(tty) << 8) | (u16)(STOP_CHAR(tty)));
319 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
322 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
326 dbg("%s - set SW flow control failed", __func__);
331 static int ssu100_open(struct tty_struct *tty, struct usb_serial_port *port)
333 struct usb_device *dev = port->serial->dev;
334 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
339 dbg("%s - port %d", __func__, port->number);
341 data = kzalloc(2, GFP_KERNEL);
345 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
346 QT_OPEN_CLOSE_CHANNEL,
347 QT_TRANSFER_IN, 0x01,
350 dbg("%s - open failed %i", __func__, result);
355 spin_lock_irqsave(&priv->status_lock, flags);
356 priv->shadowLSR = data[0] & (SERIAL_LSR_OE | SERIAL_LSR_PE |
357 SERIAL_LSR_FE | SERIAL_LSR_BI);
359 priv->shadowMSR = data[1] & (SERIAL_MSR_CTS | SERIAL_MSR_DSR |
360 SERIAL_MSR_RI | SERIAL_MSR_CD);
361 spin_unlock_irqrestore(&priv->status_lock, flags);
366 result = ssu100_control_msg(dev, QT_GET_SET_UART, 0x30, 0x0300);
368 dbg("%s - set uart failed", __func__);
371 ssu100_set_termios(tty, port, tty->termios);
373 return usb_serial_generic_open(tty, port);
376 static void ssu100_close(struct usb_serial_port *port)
379 usb_serial_generic_close(port);
382 static int get_serial_info(struct usb_serial_port *port,
383 struct serial_struct __user *retinfo)
385 struct serial_struct tmp;
390 memset(&tmp, 0, sizeof(tmp));
391 tmp.line = port->serial->minor;
394 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
395 tmp.xmit_fifo_size = port->bulk_out_size;
396 tmp.baud_base = 9600;
397 tmp.close_delay = 5*HZ;
398 tmp.closing_wait = 30*HZ;
400 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
405 static int ssu100_ioctl(struct tty_struct *tty, struct file *file,
406 unsigned int cmd, unsigned long arg)
408 struct usb_serial_port *port = tty->driver_data;
409 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
411 dbg("%s cmd 0x%04x", __func__, cmd);
415 return get_serial_info(port,
416 (struct serial_struct __user *) arg);
419 while (priv != NULL) {
420 u8 prevMSR = priv->shadowMSR & SERIAL_MSR_MASK;
421 interruptible_sleep_on(&priv->delta_msr_wait);
422 /* see if a signal did it */
423 if (signal_pending(current))
426 u8 diff = (priv->shadowMSR & SERIAL_MSR_MASK) ^ prevMSR;
428 return -EIO; /* no change => error */
430 /* Return 0 if caller wanted to know about
433 if (((arg & TIOCM_RNG) && (diff & SERIAL_MSR_RI)) ||
434 ((arg & TIOCM_DSR) && (diff & SERIAL_MSR_DSR)) ||
435 ((arg & TIOCM_CD) && (diff & SERIAL_MSR_CD)) ||
436 ((arg & TIOCM_CTS) && (diff & SERIAL_MSR_CTS)))
446 dbg("%s arg not supported", __func__);
451 static void ssu100_set_max_packet_size(struct usb_serial_port *port)
453 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
454 struct usb_serial *serial = port->serial;
455 struct usb_device *udev = serial->dev;
457 struct usb_interface *interface = serial->interface;
458 struct usb_endpoint_descriptor *ep_desc = &interface->cur_altsetting->endpoint[1].desc;
460 unsigned num_endpoints;
464 num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
465 dev_info(&udev->dev, "Number of endpoints %d\n", num_endpoints);
467 for (i = 0; i < num_endpoints; i++) {
468 dev_info(&udev->dev, "Endpoint %d MaxPacketSize %d\n", i+1,
469 interface->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
470 ep_desc = &interface->cur_altsetting->endpoint[i].desc;
473 /* set max packet size based on descriptor */
474 spin_lock_irqsave(&priv->status_lock, flags);
475 priv->max_packet_size = ep_desc->wMaxPacketSize;
476 spin_unlock_irqrestore(&priv->status_lock, flags);
478 dev_info(&udev->dev, "Setting MaxPacketSize %d\n", priv->max_packet_size);
481 static int ssu100_attach(struct usb_serial *serial)
483 struct ssu100_port_private *priv;
484 struct usb_serial_port *port = *serial->port;
488 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
490 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
495 spin_lock_init(&priv->status_lock);
496 init_waitqueue_head(&priv->delta_msr_wait);
497 usb_set_serial_port_data(port, priv);
498 ssu100_set_max_packet_size(port);
500 return ssu100_initdevice(serial->dev);
503 static int ssu100_tiocmget(struct tty_struct *tty, struct file *file)
505 struct usb_serial_port *port = tty->driver_data;
506 struct usb_device *dev = port->serial->dev;
510 dbg("%s\n", __func__);
512 d = kzalloc(2, GFP_KERNEL);
516 r = ssu100_getregister(dev, 0, MODEM_CTL_REGISTER, d);
520 r = ssu100_getregister(dev, 0, MODEM_STATUS_REGISTER, d+1);
524 r = (d[0] & SERIAL_MCR_DTR ? TIOCM_DTR : 0) |
525 (d[0] & SERIAL_MCR_RTS ? TIOCM_RTS : 0) |
526 (d[1] & SERIAL_MSR_CTS ? TIOCM_CTS : 0) |
527 (d[1] & SERIAL_MSR_CD ? TIOCM_CAR : 0) |
528 (d[1] & SERIAL_MSR_RI ? TIOCM_RI : 0) |
529 (d[1] & SERIAL_MSR_DSR ? TIOCM_DSR : 0);
536 static int ssu100_tiocmset(struct tty_struct *tty, struct file *file,
537 unsigned int set, unsigned int clear)
539 struct usb_serial_port *port = tty->driver_data;
540 struct usb_device *dev = port->serial->dev;
542 dbg("%s\n", __func__);
543 return update_mctrl(dev, set, clear);
546 static void ssu100_dtr_rts(struct usb_serial_port *port, int on)
548 struct usb_device *dev = port->serial->dev;
550 dbg("%s\n", __func__);
552 mutex_lock(&port->serial->disc_mutex);
553 if (!port->serial->disconnected) {
554 /* Disable flow control */
556 ssu100_setregister(dev, 0, 0) < 0)
557 dev_err(&port->dev, "error from flowcontrol urb\n");
558 /* drop RTS and DTR */
560 set_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
562 clear_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
564 mutex_unlock(&port->serial->disc_mutex);
567 static int ssu100_process_packet(struct tty_struct *tty,
568 struct usb_serial_port *port,
569 struct ssu100_port_private *priv,
570 char *packet, int len)
576 dbg("%s - port %d", __func__, port->number);
579 dbg("%s - malformed packet", __func__);
583 if ((packet[0] == 0x1b) && (packet[1] == 0x1b) &&
584 ((packet[2] == 0x00) || (packet[2] == 0x01))) {
585 if (packet[2] == 0x00)
586 priv->shadowLSR = packet[3] & (SERIAL_LSR_OE |
591 if (packet[2] == 0x01) {
592 priv->shadowMSR = packet[3];
593 wake_up_interruptible(&priv->delta_msr_wait);
602 return 0; /* status only */
604 if (port->port.console && port->sysrq) {
605 for (i = 0; i < len; i++, ch++) {
606 if (!usb_serial_handle_sysrq_char(tty, port, *ch))
607 tty_insert_flip_char(tty, *ch, flag);
610 tty_insert_flip_string_fixed_flag(tty, ch, flag, len);
615 static void ssu100_process_read_urb(struct urb *urb)
617 struct usb_serial_port *port = urb->context;
618 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
619 char *data = (char *)urb->transfer_buffer;
620 struct tty_struct *tty;
627 tty = tty_port_tty_get(&port->port);
631 for (i = 0; i < urb->actual_length; i += priv->max_packet_size) {
632 len = min_t(int, urb->actual_length - i, priv->max_packet_size);
633 count += ssu100_process_packet(tty, port, priv, &data[i], len);
637 tty_flip_buffer_push(tty);
642 static struct usb_serial_driver ssu100_device = {
644 .owner = THIS_MODULE,
647 .description = DRIVER_DESC,
648 .id_table = id_table,
649 .usb_driver = &ssu100_driver,
652 .bulk_out_size = 256,
654 .close = ssu100_close,
655 .attach = ssu100_attach,
656 .release = ssu100_release,
657 .dtr_rts = ssu100_dtr_rts,
658 .process_read_urb = ssu100_process_read_urb,
659 .tiocmget = ssu100_tiocmget,
660 .tiocmset = ssu100_tiocmset,
661 .ioctl = ssu100_ioctl,
662 .set_termios = ssu100_set_termios,
665 static int __init ssu100_init(void)
671 /* register with usb-serial */
672 retval = usb_serial_register(&ssu100_device);
675 goto failed_usb_sio_register;
677 retval = usb_register(&ssu100_driver);
679 goto failed_usb_register;
681 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
687 usb_serial_deregister(&ssu100_device);
688 failed_usb_sio_register:
692 static void __exit ssu100_exit(void)
694 usb_deregister(&ssu100_driver);
695 usb_serial_deregister(&ssu100_device);
698 module_init(ssu100_init);
699 module_exit(ssu100_exit);
701 MODULE_DESCRIPTION(DRIVER_DESC);
702 MODULE_LICENSE("GPL");
704 module_param(debug, bool, S_IRUGO | S_IWUSR);
705 MODULE_PARM_DESC(debug, "Debug enabled or not");