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 #define DRIVER_DESC "Quatech SSU-100 USB to Serial Driver"
51 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
52 #define QUATECH_SSU100 0xC020 /* SSU100 */
54 static const struct usb_device_id id_table[] = {
55 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100)},
56 {} /* Terminating entry */
58 MODULE_DEVICE_TABLE(usb, id_table);
60 struct ssu100_port_private {
61 spinlock_t status_lock;
64 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
65 struct async_icount icount;
68 static inline int ssu100_control_msg(struct usb_device *dev,
69 u8 request, u16 data, u16 index)
71 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
72 request, 0x40, data, index,
76 static inline int ssu100_setdevice(struct usb_device *dev, u8 *data)
78 u16 x = ((u16)(data[1] << 8) | (u16)(data[0]));
80 return ssu100_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
84 static inline int ssu100_getdevice(struct usb_device *dev, u8 *data)
86 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
87 QT_SET_GET_DEVICE, 0xc0, 0, 0,
91 static inline int ssu100_getregister(struct usb_device *dev,
96 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
97 QT_SET_GET_REGISTER, 0xc0, reg,
98 uart, data, sizeof(*data), 300);
103 static inline int ssu100_setregister(struct usb_device *dev,
108 u16 value = (data << 8) | reg;
110 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
111 QT_SET_GET_REGISTER, 0x40, value, uart,
116 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
117 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
119 /* these do not deal with device that have more than 1 port */
120 static inline int update_mctrl(struct usb_device *dev, unsigned int set,
126 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
127 dev_dbg(&dev->dev, "%s - DTR|RTS not being set|cleared\n", __func__);
128 return 0; /* no change */
131 clear &= ~set; /* 'set' takes precedence over 'clear' */
134 urb_value |= UART_MCR_DTR;
136 urb_value |= UART_MCR_RTS;
138 result = ssu100_setregister(dev, 0, UART_MCR, urb_value);
140 dev_dbg(&dev->dev, "%s Error from MODEM_CTRL urb\n", __func__);
145 static int ssu100_initdevice(struct usb_device *dev)
150 data = kzalloc(3, GFP_KERNEL);
154 result = ssu100_getdevice(dev, data);
156 dev_dbg(&dev->dev, "%s - get_device failed %i\n", __func__, result);
160 data[1] &= ~FULLPWRBIT;
162 result = ssu100_setdevice(dev, data);
164 dev_dbg(&dev->dev, "%s - setdevice failed %i\n", __func__, result);
168 result = ssu100_control_msg(dev, QT_GET_SET_PREBUF_TRIG_LVL, 128, 0);
170 dev_dbg(&dev->dev, "%s - set prebuffer level failed %i\n", __func__, result);
174 result = ssu100_control_msg(dev, QT_SET_ATF, ATC_DISABLED, 0);
176 dev_dbg(&dev->dev, "%s - set ATFprebuffer level failed %i\n", __func__, result);
180 result = ssu100_getdevice(dev, data);
182 dev_dbg(&dev->dev, "%s - get_device failed %i\n", __func__, result);
186 data[0] &= ~(RR_BITS | DUPMODE_BITS);
188 data[1] &= ~(LOOPMODE_BITS);
189 data[1] |= RS232_MODE;
191 result = ssu100_setdevice(dev, data);
193 dev_dbg(&dev->dev, "%s - setdevice failed %i\n", __func__, result);
203 static void ssu100_set_termios(struct tty_struct *tty,
204 struct usb_serial_port *port,
205 struct ktermios *old_termios)
207 struct usb_device *dev = port->serial->dev;
208 struct ktermios *termios = &tty->termios;
209 u16 baud, divisor, remainder;
210 unsigned int cflag = termios->c_cflag;
211 u16 urb_value = 0; /* will hold the new flags */
214 if (cflag & PARENB) {
216 urb_value |= UART_LCR_PARITY;
218 urb_value |= SERIAL_EVEN_PARITY;
221 switch (cflag & CSIZE) {
223 urb_value |= UART_LCR_WLEN5;
226 urb_value |= UART_LCR_WLEN6;
229 urb_value |= UART_LCR_WLEN7;
233 urb_value |= UART_LCR_WLEN8;
237 baud = tty_get_baud_rate(tty);
241 dev_dbg(&port->dev, "%s - got baud = %d\n", __func__, baud);
244 divisor = MAX_BAUD_RATE / baud;
245 remainder = MAX_BAUD_RATE % baud;
246 if (((remainder * 2) >= baud) && (baud != 110))
249 urb_value = urb_value << 8;
251 result = ssu100_control_msg(dev, QT_GET_SET_UART, divisor, urb_value);
253 dev_dbg(&port->dev, "%s - set uart failed\n", __func__);
256 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
259 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
262 dev_dbg(&port->dev, "%s - set HW flow control failed\n", __func__);
264 if (I_IXOFF(tty) || I_IXON(tty)) {
265 u16 x = ((u16)(START_CHAR(tty) << 8) | (u16)(STOP_CHAR(tty)));
267 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
270 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
274 dev_dbg(&port->dev, "%s - set SW flow control failed\n", __func__);
279 static int ssu100_open(struct tty_struct *tty, struct usb_serial_port *port)
281 struct usb_device *dev = port->serial->dev;
282 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
287 data = kzalloc(2, GFP_KERNEL);
291 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
292 QT_OPEN_CLOSE_CHANNEL,
293 QT_TRANSFER_IN, 0x01,
296 dev_dbg(&port->dev, "%s - open failed %i\n", __func__, result);
301 spin_lock_irqsave(&priv->status_lock, flags);
302 priv->shadowLSR = data[0];
303 priv->shadowMSR = data[1];
304 spin_unlock_irqrestore(&priv->status_lock, flags);
309 result = ssu100_control_msg(dev, QT_GET_SET_UART, 0x30, 0x0300);
311 dev_dbg(&port->dev, "%s - set uart failed\n", __func__);
314 ssu100_set_termios(tty, port, &tty->termios);
316 return usb_serial_generic_open(tty, port);
319 static void ssu100_close(struct usb_serial_port *port)
321 usb_serial_generic_close(port);
324 static int get_serial_info(struct usb_serial_port *port,
325 struct serial_struct __user *retinfo)
327 struct serial_struct tmp;
332 memset(&tmp, 0, sizeof(tmp));
333 tmp.line = port->serial->minor;
336 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
337 tmp.xmit_fifo_size = port->bulk_out_size;
338 tmp.baud_base = 9600;
339 tmp.close_delay = 5*HZ;
340 tmp.closing_wait = 30*HZ;
342 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
347 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
349 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
350 struct async_icount prev, cur;
353 spin_lock_irqsave(&priv->status_lock, flags);
355 spin_unlock_irqrestore(&priv->status_lock, flags);
358 wait_event_interruptible(priv->delta_msr_wait,
359 ((priv->icount.rng != prev.rng) ||
360 (priv->icount.dsr != prev.dsr) ||
361 (priv->icount.dcd != prev.dcd) ||
362 (priv->icount.cts != prev.cts)));
364 if (signal_pending(current))
367 spin_lock_irqsave(&priv->status_lock, flags);
369 spin_unlock_irqrestore(&priv->status_lock, flags);
371 if ((prev.rng == cur.rng) &&
372 (prev.dsr == cur.dsr) &&
373 (prev.dcd == cur.dcd) &&
374 (prev.cts == cur.cts))
377 if ((arg & TIOCM_RNG && (prev.rng != cur.rng)) ||
378 (arg & TIOCM_DSR && (prev.dsr != cur.dsr)) ||
379 (arg & TIOCM_CD && (prev.dcd != cur.dcd)) ||
380 (arg & TIOCM_CTS && (prev.cts != cur.cts)))
386 static int ssu100_get_icount(struct tty_struct *tty,
387 struct serial_icounter_struct *icount)
389 struct usb_serial_port *port = tty->driver_data;
390 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
391 struct async_icount cnow = priv->icount;
393 icount->cts = cnow.cts;
394 icount->dsr = cnow.dsr;
395 icount->rng = cnow.rng;
396 icount->dcd = cnow.dcd;
397 icount->rx = cnow.rx;
398 icount->tx = cnow.tx;
399 icount->frame = cnow.frame;
400 icount->overrun = cnow.overrun;
401 icount->parity = cnow.parity;
402 icount->brk = cnow.brk;
403 icount->buf_overrun = cnow.buf_overrun;
410 static int ssu100_ioctl(struct tty_struct *tty,
411 unsigned int cmd, unsigned long arg)
413 struct usb_serial_port *port = tty->driver_data;
415 dev_dbg(&port->dev, "%s cmd 0x%04x\n", __func__, cmd);
419 return get_serial_info(port,
420 (struct serial_struct __user *) arg);
423 return wait_modem_info(port, arg);
429 dev_dbg(&port->dev, "%s arg not supported\n", __func__);
434 static int ssu100_attach(struct usb_serial *serial)
436 return ssu100_initdevice(serial->dev);
439 static int ssu100_port_probe(struct usb_serial_port *port)
441 struct ssu100_port_private *priv;
443 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
447 spin_lock_init(&priv->status_lock);
448 init_waitqueue_head(&priv->delta_msr_wait);
450 usb_set_serial_port_data(port, priv);
455 static int ssu100_port_remove(struct usb_serial_port *port)
457 struct ssu100_port_private *priv;
459 priv = usb_get_serial_port_data(port);
465 static int ssu100_tiocmget(struct tty_struct *tty)
467 struct usb_serial_port *port = tty->driver_data;
468 struct usb_device *dev = port->serial->dev;
472 d = kzalloc(2, GFP_KERNEL);
476 r = ssu100_getregister(dev, 0, UART_MCR, d);
480 r = ssu100_getregister(dev, 0, UART_MSR, d+1);
484 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
485 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
486 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
487 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
488 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
489 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
496 static int ssu100_tiocmset(struct tty_struct *tty,
497 unsigned int set, unsigned int clear)
499 struct usb_serial_port *port = tty->driver_data;
500 struct usb_device *dev = port->serial->dev;
502 return update_mctrl(dev, set, clear);
505 static void ssu100_dtr_rts(struct usb_serial_port *port, int on)
507 struct usb_device *dev = port->serial->dev;
509 mutex_lock(&port->serial->disc_mutex);
510 if (!port->serial->disconnected) {
511 /* Disable flow control */
513 ssu100_setregister(dev, 0, UART_MCR, 0) < 0)
514 dev_err(&port->dev, "error from flowcontrol urb\n");
515 /* drop RTS and DTR */
517 set_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
519 clear_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
521 mutex_unlock(&port->serial->disc_mutex);
524 static void ssu100_update_msr(struct usb_serial_port *port, u8 msr)
526 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
529 spin_lock_irqsave(&priv->status_lock, flags);
530 priv->shadowMSR = msr;
531 spin_unlock_irqrestore(&priv->status_lock, flags);
533 if (msr & UART_MSR_ANY_DELTA) {
534 /* update input line counters */
535 if (msr & UART_MSR_DCTS)
537 if (msr & UART_MSR_DDSR)
539 if (msr & UART_MSR_DDCD)
541 if (msr & UART_MSR_TERI)
543 wake_up_interruptible(&priv->delta_msr_wait);
547 static void ssu100_update_lsr(struct usb_serial_port *port, u8 lsr,
550 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
553 spin_lock_irqsave(&priv->status_lock, flags);
554 priv->shadowLSR = lsr;
555 spin_unlock_irqrestore(&priv->status_lock, flags);
557 *tty_flag = TTY_NORMAL;
558 if (lsr & UART_LSR_BRK_ERROR_BITS) {
559 /* we always want to update icount, but we only want to
560 * update tty_flag for one case */
561 if (lsr & UART_LSR_BI) {
563 *tty_flag = TTY_BREAK;
564 usb_serial_handle_break(port);
566 if (lsr & UART_LSR_PE) {
567 priv->icount.parity++;
568 if (*tty_flag == TTY_NORMAL)
569 *tty_flag = TTY_PARITY;
571 if (lsr & UART_LSR_FE) {
572 priv->icount.frame++;
573 if (*tty_flag == TTY_NORMAL)
574 *tty_flag = TTY_FRAME;
576 if (lsr & UART_LSR_OE){
577 priv->icount.overrun++;
578 if (*tty_flag == TTY_NORMAL)
579 *tty_flag = TTY_OVERRUN;
585 static int ssu100_process_packet(struct urb *urb,
586 struct tty_struct *tty)
588 struct usb_serial_port *port = urb->context;
589 char *packet = (char *)urb->transfer_buffer;
590 char flag = TTY_NORMAL;
591 u32 len = urb->actual_length;
596 (packet[0] == 0x1b) && (packet[1] == 0x1b) &&
597 ((packet[2] == 0x00) || (packet[2] == 0x01))) {
598 if (packet[2] == 0x00) {
599 ssu100_update_lsr(port, packet[3], &flag);
600 if (flag == TTY_OVERRUN)
601 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
603 if (packet[2] == 0x01)
604 ssu100_update_msr(port, packet[3]);
612 return 0; /* status only */
614 if (port->port.console && port->sysrq) {
615 for (i = 0; i < len; i++, ch++) {
616 if (!usb_serial_handle_sysrq_char(port, *ch))
617 tty_insert_flip_char(tty, *ch, flag);
620 tty_insert_flip_string_fixed_flag(tty, ch, flag, len);
625 static void ssu100_process_read_urb(struct urb *urb)
627 struct usb_serial_port *port = urb->context;
628 struct tty_struct *tty;
631 tty = tty_port_tty_get(&port->port);
635 count = ssu100_process_packet(urb, tty);
638 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,
651 .close = ssu100_close,
652 .attach = ssu100_attach,
653 .port_probe = ssu100_port_probe,
654 .port_remove = ssu100_port_remove,
655 .dtr_rts = ssu100_dtr_rts,
656 .process_read_urb = ssu100_process_read_urb,
657 .tiocmget = ssu100_tiocmget,
658 .tiocmset = ssu100_tiocmset,
659 .get_icount = ssu100_get_icount,
660 .ioctl = ssu100_ioctl,
661 .set_termios = ssu100_set_termios,
662 .disconnect = usb_serial_generic_disconnect,
665 static struct usb_serial_driver * const serial_drivers[] = {
669 module_usb_serial_driver(serial_drivers, id_table);
671 MODULE_DESCRIPTION(DRIVER_DESC);
672 MODULE_LICENSE("GPL");