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;
85 static void ssu100_release(struct usb_serial *serial)
87 struct ssu100_port_private *priv = usb_get_serial_port_data(*serial->port);
93 static inline int ssu100_control_msg(struct usb_device *dev,
94 u8 request, u16 data, u16 index)
96 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
97 request, 0x40, data, index,
101 static inline int ssu100_setdevice(struct usb_device *dev, u8 *data)
103 u16 x = ((u16)(data[1] << 8) | (u16)(data[0]));
105 return ssu100_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
109 static inline int ssu100_getdevice(struct usb_device *dev, u8 *data)
111 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
112 QT_SET_GET_DEVICE, 0xc0, 0, 0,
116 static inline int ssu100_getregister(struct usb_device *dev,
121 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
122 QT_SET_GET_REGISTER, 0xc0, reg,
123 uart, data, sizeof(*data), 300);
128 static inline int ssu100_setregister(struct usb_device *dev,
132 u16 value = (data << 8) | UART_MCR;
134 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
135 QT_SET_GET_REGISTER, 0x40, value, uart,
140 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
141 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
143 /* these do not deal with device that have more than 1 port */
144 static inline int update_mctrl(struct usb_device *dev, unsigned int set,
150 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
151 dbg("%s - DTR|RTS not being set|cleared", __func__);
152 return 0; /* no change */
155 clear &= ~set; /* 'set' takes precedence over 'clear' */
158 urb_value |= UART_MCR_DTR;
160 urb_value |= UART_MCR_RTS;
162 result = ssu100_setregister(dev, 0, urb_value);
164 dbg("%s Error from MODEM_CTRL urb", __func__);
169 static int ssu100_initdevice(struct usb_device *dev)
176 data = kzalloc(3, GFP_KERNEL);
180 result = ssu100_getdevice(dev, data);
182 dbg("%s - get_device failed %i", __func__, result);
186 data[1] &= ~FULLPWRBIT;
188 result = ssu100_setdevice(dev, data);
190 dbg("%s - setdevice failed %i", __func__, result);
194 result = ssu100_control_msg(dev, QT_GET_SET_PREBUF_TRIG_LVL, 128, 0);
196 dbg("%s - set prebuffer level failed %i", __func__, result);
200 result = ssu100_control_msg(dev, QT_SET_ATF, ATC_DISABLED, 0);
202 dbg("%s - set ATFprebuffer level failed %i", __func__, result);
206 result = ssu100_getdevice(dev, data);
208 dbg("%s - get_device failed %i", __func__, result);
212 data[0] &= ~(RR_BITS | DUPMODE_BITS);
214 data[1] &= ~(LOOPMODE_BITS);
215 data[1] |= RS232_MODE;
217 result = ssu100_setdevice(dev, data);
219 dbg("%s - setdevice failed %i", __func__, result);
229 static void ssu100_set_termios(struct tty_struct *tty,
230 struct usb_serial_port *port,
231 struct ktermios *old_termios)
233 struct usb_device *dev = port->serial->dev;
234 struct ktermios *termios = tty->termios;
235 u16 baud, divisor, remainder;
236 unsigned int cflag = termios->c_cflag;
237 u16 urb_value = 0; /* will hold the new flags */
242 if (cflag & PARENB) {
244 urb_value |= UART_LCR_PARITY;
246 urb_value |= SERIAL_EVEN_PARITY;
249 switch (cflag & CSIZE) {
251 urb_value |= UART_LCR_WLEN5;
254 urb_value |= UART_LCR_WLEN6;
257 urb_value |= UART_LCR_WLEN7;
261 urb_value |= UART_LCR_WLEN8;
265 baud = tty_get_baud_rate(tty);
269 dbg("%s - got baud = %d\n", __func__, baud);
272 divisor = MAX_BAUD_RATE / baud;
273 remainder = MAX_BAUD_RATE % baud;
274 if (((remainder * 2) >= baud) && (baud != 110))
277 urb_value = urb_value << 8;
279 result = ssu100_control_msg(dev, QT_GET_SET_UART, divisor, urb_value);
281 dbg("%s - set uart failed", __func__);
284 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
287 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
290 dbg("%s - set HW flow control failed", __func__);
292 if (I_IXOFF(tty) || I_IXON(tty)) {
293 u16 x = ((u16)(START_CHAR(tty) << 8) | (u16)(STOP_CHAR(tty)));
295 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
298 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
302 dbg("%s - set SW flow control failed", __func__);
307 static int ssu100_open(struct tty_struct *tty, struct usb_serial_port *port)
309 struct usb_device *dev = port->serial->dev;
310 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
315 dbg("%s - port %d", __func__, port->number);
317 data = kzalloc(2, GFP_KERNEL);
321 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
322 QT_OPEN_CLOSE_CHANNEL,
323 QT_TRANSFER_IN, 0x01,
326 dbg("%s - open failed %i", __func__, result);
331 spin_lock_irqsave(&priv->status_lock, flags);
332 priv->shadowLSR = data[0] & (UART_LSR_OE | UART_LSR_PE |
333 UART_LSR_FE | UART_LSR_BI);
335 priv->shadowMSR = data[1] & (UART_MSR_CTS | UART_MSR_DSR |
336 UART_MSR_RI | UART_MSR_DCD);
337 spin_unlock_irqrestore(&priv->status_lock, flags);
342 result = ssu100_control_msg(dev, QT_GET_SET_UART, 0x30, 0x0300);
344 dbg("%s - set uart failed", __func__);
347 ssu100_set_termios(tty, port, tty->termios);
349 return usb_serial_generic_open(tty, port);
352 static void ssu100_close(struct usb_serial_port *port)
355 usb_serial_generic_close(port);
358 static int get_serial_info(struct usb_serial_port *port,
359 struct serial_struct __user *retinfo)
361 struct serial_struct tmp;
366 memset(&tmp, 0, sizeof(tmp));
367 tmp.line = port->serial->minor;
370 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
371 tmp.xmit_fifo_size = port->bulk_out_size;
372 tmp.baud_base = 9600;
373 tmp.close_delay = 5*HZ;
374 tmp.closing_wait = 30*HZ;
376 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
381 static int ssu100_ioctl(struct tty_struct *tty, struct file *file,
382 unsigned int cmd, unsigned long arg)
384 struct usb_serial_port *port = tty->driver_data;
385 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
387 dbg("%s cmd 0x%04x", __func__, cmd);
391 return get_serial_info(port,
392 (struct serial_struct __user *) arg);
395 while (priv != NULL) {
396 u8 prevMSR = priv->shadowMSR & SERIAL_MSR_MASK;
397 interruptible_sleep_on(&priv->delta_msr_wait);
398 /* see if a signal did it */
399 if (signal_pending(current))
402 u8 diff = (priv->shadowMSR & SERIAL_MSR_MASK) ^ prevMSR;
404 return -EIO; /* no change => error */
406 /* Return 0 if caller wanted to know about
409 if (((arg & TIOCM_RNG) && (diff & UART_MSR_RI)) ||
410 ((arg & TIOCM_DSR) && (diff & UART_MSR_DSR)) ||
411 ((arg & TIOCM_CD) && (diff & UART_MSR_DCD)) ||
412 ((arg & TIOCM_CTS) && (diff & UART_MSR_CTS)))
422 dbg("%s arg not supported", __func__);
427 static void ssu100_set_max_packet_size(struct usb_serial_port *port)
429 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
430 struct usb_serial *serial = port->serial;
431 struct usb_device *udev = serial->dev;
433 struct usb_interface *interface = serial->interface;
434 struct usb_endpoint_descriptor *ep_desc = &interface->cur_altsetting->endpoint[1].desc;
436 unsigned num_endpoints;
440 num_endpoints = interface->cur_altsetting->desc.bNumEndpoints;
441 dev_info(&udev->dev, "Number of endpoints %d\n", num_endpoints);
443 for (i = 0; i < num_endpoints; i++) {
444 dev_info(&udev->dev, "Endpoint %d MaxPacketSize %d\n", i+1,
445 interface->cur_altsetting->endpoint[i].desc.wMaxPacketSize);
446 ep_desc = &interface->cur_altsetting->endpoint[i].desc;
449 /* set max packet size based on descriptor */
450 spin_lock_irqsave(&priv->status_lock, flags);
451 priv->max_packet_size = ep_desc->wMaxPacketSize;
452 spin_unlock_irqrestore(&priv->status_lock, flags);
454 dev_info(&udev->dev, "Setting MaxPacketSize %d\n", priv->max_packet_size);
457 static int ssu100_attach(struct usb_serial *serial)
459 struct ssu100_port_private *priv;
460 struct usb_serial_port *port = *serial->port;
464 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
466 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
471 spin_lock_init(&priv->status_lock);
472 init_waitqueue_head(&priv->delta_msr_wait);
473 usb_set_serial_port_data(port, priv);
474 ssu100_set_max_packet_size(port);
476 return ssu100_initdevice(serial->dev);
479 static int ssu100_tiocmget(struct tty_struct *tty, struct file *file)
481 struct usb_serial_port *port = tty->driver_data;
482 struct usb_device *dev = port->serial->dev;
486 dbg("%s\n", __func__);
488 d = kzalloc(2, GFP_KERNEL);
492 r = ssu100_getregister(dev, 0, UART_MCR, d);
496 r = ssu100_getregister(dev, 0, UART_MSR, d+1);
500 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
501 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
502 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
503 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
504 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
505 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
512 static int ssu100_tiocmset(struct tty_struct *tty, struct file *file,
513 unsigned int set, unsigned int clear)
515 struct usb_serial_port *port = tty->driver_data;
516 struct usb_device *dev = port->serial->dev;
518 dbg("%s\n", __func__);
519 return update_mctrl(dev, set, clear);
522 static void ssu100_dtr_rts(struct usb_serial_port *port, int on)
524 struct usb_device *dev = port->serial->dev;
526 dbg("%s\n", __func__);
528 mutex_lock(&port->serial->disc_mutex);
529 if (!port->serial->disconnected) {
530 /* Disable flow control */
532 ssu100_setregister(dev, 0, 0) < 0)
533 dev_err(&port->dev, "error from flowcontrol urb\n");
534 /* drop RTS and DTR */
536 set_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
538 clear_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
540 mutex_unlock(&port->serial->disc_mutex);
543 static int ssu100_process_packet(struct tty_struct *tty,
544 struct usb_serial_port *port,
545 struct ssu100_port_private *priv,
546 char *packet, int len)
552 dbg("%s - port %d", __func__, port->number);
555 (packet[0] == 0x1b) && (packet[1] == 0x1b) &&
556 ((packet[2] == 0x00) || (packet[2] == 0x01))) {
557 if (packet[2] == 0x00)
558 priv->shadowLSR = packet[3] & (UART_LSR_OE |
563 if (packet[2] == 0x01) {
564 priv->shadowMSR = packet[3];
565 wake_up_interruptible(&priv->delta_msr_wait);
574 return 0; /* status only */
576 if (port->port.console && port->sysrq) {
577 for (i = 0; i < len; i++, ch++) {
578 if (!usb_serial_handle_sysrq_char(tty, port, *ch))
579 tty_insert_flip_char(tty, *ch, flag);
582 tty_insert_flip_string_fixed_flag(tty, ch, flag, len);
587 static void ssu100_process_read_urb(struct urb *urb)
589 struct usb_serial_port *port = urb->context;
590 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
591 char *data = (char *)urb->transfer_buffer;
592 struct tty_struct *tty;
599 tty = tty_port_tty_get(&port->port);
603 for (i = 0; i < urb->actual_length; i += priv->max_packet_size) {
604 len = min_t(int, urb->actual_length - i, priv->max_packet_size);
605 count += ssu100_process_packet(tty, port, priv, &data[i], len);
609 tty_flip_buffer_push(tty);
614 static struct usb_serial_driver ssu100_device = {
616 .owner = THIS_MODULE,
619 .description = DRIVER_DESC,
620 .id_table = id_table,
621 .usb_driver = &ssu100_driver,
624 .bulk_out_size = 256,
626 .close = ssu100_close,
627 .attach = ssu100_attach,
628 .release = ssu100_release,
629 .dtr_rts = ssu100_dtr_rts,
630 .process_read_urb = ssu100_process_read_urb,
631 .tiocmget = ssu100_tiocmget,
632 .tiocmset = ssu100_tiocmset,
633 .ioctl = ssu100_ioctl,
634 .set_termios = ssu100_set_termios,
637 static int __init ssu100_init(void)
643 /* register with usb-serial */
644 retval = usb_serial_register(&ssu100_device);
647 goto failed_usb_sio_register;
649 retval = usb_register(&ssu100_driver);
651 goto failed_usb_register;
653 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
659 usb_serial_deregister(&ssu100_device);
660 failed_usb_sio_register:
664 static void __exit ssu100_exit(void)
666 usb_deregister(&ssu100_driver);
667 usb_serial_deregister(&ssu100_device);
670 module_init(ssu100_init);
671 module_exit(ssu100_exit);
673 MODULE_DESCRIPTION(DRIVER_DESC);
674 MODULE_LICENSE("GPL");
676 module_param(debug, bool, S_IRUGO | S_IWUSR);
677 MODULE_PARM_DESC(debug, "Debug enabled or not");