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 /* Version Information */
50 #define DRIVER_VERSION "v0.1"
51 #define DRIVER_DESC "Quatech SSU-100 USB to Serial Driver"
53 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
54 #define QUATECH_SSU100 0xC020 /* SSU100 */
56 static const struct usb_device_id id_table[] = {
57 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100)},
58 {} /* Terminating entry */
60 MODULE_DEVICE_TABLE(usb, id_table);
62 struct ssu100_port_private {
63 spinlock_t status_lock;
66 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
67 struct async_icount icount;
70 static void ssu100_release(struct usb_serial *serial)
72 struct ssu100_port_private *priv = usb_get_serial_port_data(*serial->port);
77 static inline int ssu100_control_msg(struct usb_device *dev,
78 u8 request, u16 data, u16 index)
80 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
81 request, 0x40, data, index,
85 static inline int ssu100_setdevice(struct usb_device *dev, u8 *data)
87 u16 x = ((u16)(data[1] << 8) | (u16)(data[0]));
89 return ssu100_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
93 static inline int ssu100_getdevice(struct usb_device *dev, u8 *data)
95 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
96 QT_SET_GET_DEVICE, 0xc0, 0, 0,
100 static inline int ssu100_getregister(struct usb_device *dev,
105 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
106 QT_SET_GET_REGISTER, 0xc0, reg,
107 uart, data, sizeof(*data), 300);
112 static inline int ssu100_setregister(struct usb_device *dev,
117 u16 value = (data << 8) | reg;
119 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
120 QT_SET_GET_REGISTER, 0x40, value, uart,
125 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
126 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
128 /* these do not deal with device that have more than 1 port */
129 static inline int update_mctrl(struct usb_device *dev, unsigned int set,
135 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
136 dev_dbg(&dev->dev, "%s - DTR|RTS not being set|cleared\n", __func__);
137 return 0; /* no change */
140 clear &= ~set; /* 'set' takes precedence over 'clear' */
143 urb_value |= UART_MCR_DTR;
145 urb_value |= UART_MCR_RTS;
147 result = ssu100_setregister(dev, 0, UART_MCR, urb_value);
149 dev_dbg(&dev->dev, "%s Error from MODEM_CTRL urb\n", __func__);
154 static int ssu100_initdevice(struct usb_device *dev)
159 data = kzalloc(3, GFP_KERNEL);
163 result = ssu100_getdevice(dev, data);
165 dev_dbg(&dev->dev, "%s - get_device failed %i\n", __func__, result);
169 data[1] &= ~FULLPWRBIT;
171 result = ssu100_setdevice(dev, data);
173 dev_dbg(&dev->dev, "%s - setdevice failed %i\n", __func__, result);
177 result = ssu100_control_msg(dev, QT_GET_SET_PREBUF_TRIG_LVL, 128, 0);
179 dev_dbg(&dev->dev, "%s - set prebuffer level failed %i\n", __func__, result);
183 result = ssu100_control_msg(dev, QT_SET_ATF, ATC_DISABLED, 0);
185 dev_dbg(&dev->dev, "%s - set ATFprebuffer level failed %i\n", __func__, result);
189 result = ssu100_getdevice(dev, data);
191 dev_dbg(&dev->dev, "%s - get_device failed %i\n", __func__, result);
195 data[0] &= ~(RR_BITS | DUPMODE_BITS);
197 data[1] &= ~(LOOPMODE_BITS);
198 data[1] |= RS232_MODE;
200 result = ssu100_setdevice(dev, data);
202 dev_dbg(&dev->dev, "%s - setdevice failed %i\n", __func__, result);
212 static void ssu100_set_termios(struct tty_struct *tty,
213 struct usb_serial_port *port,
214 struct ktermios *old_termios)
216 struct usb_device *dev = port->serial->dev;
217 struct ktermios *termios = &tty->termios;
218 u16 baud, divisor, remainder;
219 unsigned int cflag = termios->c_cflag;
220 u16 urb_value = 0; /* will hold the new flags */
223 if (cflag & PARENB) {
225 urb_value |= UART_LCR_PARITY;
227 urb_value |= SERIAL_EVEN_PARITY;
230 switch (cflag & CSIZE) {
232 urb_value |= UART_LCR_WLEN5;
235 urb_value |= UART_LCR_WLEN6;
238 urb_value |= UART_LCR_WLEN7;
242 urb_value |= UART_LCR_WLEN8;
246 baud = tty_get_baud_rate(tty);
250 dev_dbg(&port->dev, "%s - got baud = %d\n", __func__, baud);
253 divisor = MAX_BAUD_RATE / baud;
254 remainder = MAX_BAUD_RATE % baud;
255 if (((remainder * 2) >= baud) && (baud != 110))
258 urb_value = urb_value << 8;
260 result = ssu100_control_msg(dev, QT_GET_SET_UART, divisor, urb_value);
262 dev_dbg(&port->dev, "%s - set uart failed\n", __func__);
265 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
268 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
271 dev_dbg(&port->dev, "%s - set HW flow control failed\n", __func__);
273 if (I_IXOFF(tty) || I_IXON(tty)) {
274 u16 x = ((u16)(START_CHAR(tty) << 8) | (u16)(STOP_CHAR(tty)));
276 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
279 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
283 dev_dbg(&port->dev, "%s - set SW flow control failed\n", __func__);
288 static int ssu100_open(struct tty_struct *tty, struct usb_serial_port *port)
290 struct usb_device *dev = port->serial->dev;
291 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
296 data = kzalloc(2, GFP_KERNEL);
300 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
301 QT_OPEN_CLOSE_CHANNEL,
302 QT_TRANSFER_IN, 0x01,
305 dev_dbg(&port->dev, "%s - open failed %i\n", __func__, result);
310 spin_lock_irqsave(&priv->status_lock, flags);
311 priv->shadowLSR = data[0];
312 priv->shadowMSR = data[1];
313 spin_unlock_irqrestore(&priv->status_lock, flags);
318 result = ssu100_control_msg(dev, QT_GET_SET_UART, 0x30, 0x0300);
320 dev_dbg(&port->dev, "%s - set uart failed\n", __func__);
323 ssu100_set_termios(tty, port, &tty->termios);
325 return usb_serial_generic_open(tty, port);
328 static void ssu100_close(struct usb_serial_port *port)
330 usb_serial_generic_close(port);
333 static int get_serial_info(struct usb_serial_port *port,
334 struct serial_struct __user *retinfo)
336 struct serial_struct tmp;
341 memset(&tmp, 0, sizeof(tmp));
342 tmp.line = port->serial->minor;
345 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
346 tmp.xmit_fifo_size = port->bulk_out_size;
347 tmp.baud_base = 9600;
348 tmp.close_delay = 5*HZ;
349 tmp.closing_wait = 30*HZ;
351 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
356 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
358 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
359 struct async_icount prev, cur;
362 spin_lock_irqsave(&priv->status_lock, flags);
364 spin_unlock_irqrestore(&priv->status_lock, flags);
367 wait_event_interruptible(priv->delta_msr_wait,
368 ((priv->icount.rng != prev.rng) ||
369 (priv->icount.dsr != prev.dsr) ||
370 (priv->icount.dcd != prev.dcd) ||
371 (priv->icount.cts != prev.cts)));
373 if (signal_pending(current))
376 spin_lock_irqsave(&priv->status_lock, flags);
378 spin_unlock_irqrestore(&priv->status_lock, flags);
380 if ((prev.rng == cur.rng) &&
381 (prev.dsr == cur.dsr) &&
382 (prev.dcd == cur.dcd) &&
383 (prev.cts == cur.cts))
386 if ((arg & TIOCM_RNG && (prev.rng != cur.rng)) ||
387 (arg & TIOCM_DSR && (prev.dsr != cur.dsr)) ||
388 (arg & TIOCM_CD && (prev.dcd != cur.dcd)) ||
389 (arg & TIOCM_CTS && (prev.cts != cur.cts)))
395 static int ssu100_get_icount(struct tty_struct *tty,
396 struct serial_icounter_struct *icount)
398 struct usb_serial_port *port = tty->driver_data;
399 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
400 struct async_icount cnow = priv->icount;
402 icount->cts = cnow.cts;
403 icount->dsr = cnow.dsr;
404 icount->rng = cnow.rng;
405 icount->dcd = cnow.dcd;
406 icount->rx = cnow.rx;
407 icount->tx = cnow.tx;
408 icount->frame = cnow.frame;
409 icount->overrun = cnow.overrun;
410 icount->parity = cnow.parity;
411 icount->brk = cnow.brk;
412 icount->buf_overrun = cnow.buf_overrun;
419 static int ssu100_ioctl(struct tty_struct *tty,
420 unsigned int cmd, unsigned long arg)
422 struct usb_serial_port *port = tty->driver_data;
424 dev_dbg(&port->dev, "%s cmd 0x%04x\n", __func__, cmd);
428 return get_serial_info(port,
429 (struct serial_struct __user *) arg);
432 return wait_modem_info(port, arg);
438 dev_dbg(&port->dev, "%s arg not supported\n", __func__);
443 static int ssu100_attach(struct usb_serial *serial)
445 struct ssu100_port_private *priv;
446 struct usb_serial_port *port = *serial->port;
448 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
450 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
455 spin_lock_init(&priv->status_lock);
456 init_waitqueue_head(&priv->delta_msr_wait);
457 usb_set_serial_port_data(port, priv);
459 return ssu100_initdevice(serial->dev);
462 static int ssu100_tiocmget(struct tty_struct *tty)
464 struct usb_serial_port *port = tty->driver_data;
465 struct usb_device *dev = port->serial->dev;
469 d = kzalloc(2, GFP_KERNEL);
473 r = ssu100_getregister(dev, 0, UART_MCR, d);
477 r = ssu100_getregister(dev, 0, UART_MSR, d+1);
481 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
482 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
483 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
484 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
485 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
486 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
493 static int ssu100_tiocmset(struct tty_struct *tty,
494 unsigned int set, unsigned int clear)
496 struct usb_serial_port *port = tty->driver_data;
497 struct usb_device *dev = port->serial->dev;
499 return update_mctrl(dev, set, clear);
502 static void ssu100_dtr_rts(struct usb_serial_port *port, int on)
504 struct usb_device *dev = port->serial->dev;
506 mutex_lock(&port->serial->disc_mutex);
507 if (!port->serial->disconnected) {
508 /* Disable flow control */
510 ssu100_setregister(dev, 0, UART_MCR, 0) < 0)
511 dev_err(&port->dev, "error from flowcontrol urb\n");
512 /* drop RTS and DTR */
514 set_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
516 clear_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
518 mutex_unlock(&port->serial->disc_mutex);
521 static void ssu100_update_msr(struct usb_serial_port *port, u8 msr)
523 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
526 spin_lock_irqsave(&priv->status_lock, flags);
527 priv->shadowMSR = msr;
528 spin_unlock_irqrestore(&priv->status_lock, flags);
530 if (msr & UART_MSR_ANY_DELTA) {
531 /* update input line counters */
532 if (msr & UART_MSR_DCTS)
534 if (msr & UART_MSR_DDSR)
536 if (msr & UART_MSR_DDCD)
538 if (msr & UART_MSR_TERI)
540 wake_up_interruptible(&priv->delta_msr_wait);
544 static void ssu100_update_lsr(struct usb_serial_port *port, u8 lsr,
547 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
550 spin_lock_irqsave(&priv->status_lock, flags);
551 priv->shadowLSR = lsr;
552 spin_unlock_irqrestore(&priv->status_lock, flags);
554 *tty_flag = TTY_NORMAL;
555 if (lsr & UART_LSR_BRK_ERROR_BITS) {
556 /* we always want to update icount, but we only want to
557 * update tty_flag for one case */
558 if (lsr & UART_LSR_BI) {
560 *tty_flag = TTY_BREAK;
561 usb_serial_handle_break(port);
563 if (lsr & UART_LSR_PE) {
564 priv->icount.parity++;
565 if (*tty_flag == TTY_NORMAL)
566 *tty_flag = TTY_PARITY;
568 if (lsr & UART_LSR_FE) {
569 priv->icount.frame++;
570 if (*tty_flag == TTY_NORMAL)
571 *tty_flag = TTY_FRAME;
573 if (lsr & UART_LSR_OE){
574 priv->icount.overrun++;
575 if (*tty_flag == TTY_NORMAL)
576 *tty_flag = TTY_OVERRUN;
582 static int ssu100_process_packet(struct urb *urb,
583 struct tty_struct *tty)
585 struct usb_serial_port *port = urb->context;
586 char *packet = (char *)urb->transfer_buffer;
587 char flag = TTY_NORMAL;
588 u32 len = urb->actual_length;
593 (packet[0] == 0x1b) && (packet[1] == 0x1b) &&
594 ((packet[2] == 0x00) || (packet[2] == 0x01))) {
595 if (packet[2] == 0x00) {
596 ssu100_update_lsr(port, packet[3], &flag);
597 if (flag == TTY_OVERRUN)
598 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
600 if (packet[2] == 0x01)
601 ssu100_update_msr(port, packet[3]);
609 return 0; /* status only */
611 if (port->port.console && port->sysrq) {
612 for (i = 0; i < len; i++, ch++) {
613 if (!usb_serial_handle_sysrq_char(port, *ch))
614 tty_insert_flip_char(tty, *ch, flag);
617 tty_insert_flip_string_fixed_flag(tty, ch, flag, len);
622 static void ssu100_process_read_urb(struct urb *urb)
624 struct usb_serial_port *port = urb->context;
625 struct tty_struct *tty;
628 tty = tty_port_tty_get(&port->port);
632 count = ssu100_process_packet(urb, tty);
635 tty_flip_buffer_push(tty);
639 static struct usb_serial_driver ssu100_device = {
641 .owner = THIS_MODULE,
644 .description = DRIVER_DESC,
645 .id_table = id_table,
648 .close = ssu100_close,
649 .attach = ssu100_attach,
650 .release = ssu100_release,
651 .dtr_rts = ssu100_dtr_rts,
652 .process_read_urb = ssu100_process_read_urb,
653 .tiocmget = ssu100_tiocmget,
654 .tiocmset = ssu100_tiocmset,
655 .get_icount = ssu100_get_icount,
656 .ioctl = ssu100_ioctl,
657 .set_termios = ssu100_set_termios,
658 .disconnect = usb_serial_generic_disconnect,
661 static struct usb_serial_driver * const serial_drivers[] = {
665 module_usb_serial_driver(serial_drivers, id_table);
667 MODULE_DESCRIPTION(DRIVER_DESC);
668 MODULE_LICENSE("GPL");