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
,
73 .supports_autosuspend
= 1,
76 struct ssu100_port_private
{
77 spinlock_t status_lock
;
80 wait_queue_head_t delta_msr_wait
; /* Used for TIOCMIWAIT */
81 struct async_icount icount
;
84 static void ssu100_release(struct usb_serial
*serial
)
86 struct ssu100_port_private
*priv
= usb_get_serial_port_data(*serial
->port
);
91 static inline int ssu100_control_msg(struct usb_device
*dev
,
92 u8 request
, u16 data
, u16 index
)
94 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
95 request
, 0x40, data
, index
,
99 static inline int ssu100_setdevice(struct usb_device
*dev
, u8
*data
)
101 u16 x
= ((u16
)(data
[1] << 8) | (u16
)(data
[0]));
103 return ssu100_control_msg(dev
, QT_SET_GET_DEVICE
, x
, 0);
107 static inline int ssu100_getdevice(struct usb_device
*dev
, u8
*data
)
109 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
110 QT_SET_GET_DEVICE
, 0xc0, 0, 0,
114 static inline int ssu100_getregister(struct usb_device
*dev
,
119 return usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
120 QT_SET_GET_REGISTER
, 0xc0, reg
,
121 uart
, data
, sizeof(*data
), 300);
126 static inline int ssu100_setregister(struct usb_device
*dev
,
131 u16 value
= (data
<< 8) | reg
;
133 return usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
134 QT_SET_GET_REGISTER
, 0x40, value
, uart
,
139 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
140 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
142 /* these do not deal with device that have more than 1 port */
143 static inline int update_mctrl(struct usb_device
*dev
, unsigned int set
,
149 if (((set
| clear
) & (TIOCM_DTR
| TIOCM_RTS
)) == 0) {
150 dbg("%s - DTR|RTS not being set|cleared", __func__
);
151 return 0; /* no change */
154 clear
&= ~set
; /* 'set' takes precedence over 'clear' */
157 urb_value
|= UART_MCR_DTR
;
159 urb_value
|= UART_MCR_RTS
;
161 result
= ssu100_setregister(dev
, 0, UART_MCR
, urb_value
);
163 dbg("%s Error from MODEM_CTRL urb", __func__
);
168 static int ssu100_initdevice(struct usb_device
*dev
)
173 data
= kzalloc(3, GFP_KERNEL
);
177 result
= ssu100_getdevice(dev
, data
);
179 dbg("%s - get_device failed %i", __func__
, result
);
183 data
[1] &= ~FULLPWRBIT
;
185 result
= ssu100_setdevice(dev
, data
);
187 dbg("%s - setdevice failed %i", __func__
, result
);
191 result
= ssu100_control_msg(dev
, QT_GET_SET_PREBUF_TRIG_LVL
, 128, 0);
193 dbg("%s - set prebuffer level failed %i", __func__
, result
);
197 result
= ssu100_control_msg(dev
, QT_SET_ATF
, ATC_DISABLED
, 0);
199 dbg("%s - set ATFprebuffer level failed %i", __func__
, result
);
203 result
= ssu100_getdevice(dev
, data
);
205 dbg("%s - get_device failed %i", __func__
, result
);
209 data
[0] &= ~(RR_BITS
| DUPMODE_BITS
);
211 data
[1] &= ~(LOOPMODE_BITS
);
212 data
[1] |= RS232_MODE
;
214 result
= ssu100_setdevice(dev
, data
);
216 dbg("%s - setdevice failed %i", __func__
, result
);
226 static void ssu100_set_termios(struct tty_struct
*tty
,
227 struct usb_serial_port
*port
,
228 struct ktermios
*old_termios
)
230 struct usb_device
*dev
= port
->serial
->dev
;
231 struct ktermios
*termios
= tty
->termios
;
232 u16 baud
, divisor
, remainder
;
233 unsigned int cflag
= termios
->c_cflag
;
234 u16 urb_value
= 0; /* will hold the new flags */
237 if (cflag
& PARENB
) {
239 urb_value
|= UART_LCR_PARITY
;
241 urb_value
|= SERIAL_EVEN_PARITY
;
244 switch (cflag
& CSIZE
) {
246 urb_value
|= UART_LCR_WLEN5
;
249 urb_value
|= UART_LCR_WLEN6
;
252 urb_value
|= UART_LCR_WLEN7
;
256 urb_value
|= UART_LCR_WLEN8
;
260 baud
= tty_get_baud_rate(tty
);
264 dbg("%s - got baud = %d\n", __func__
, baud
);
267 divisor
= MAX_BAUD_RATE
/ baud
;
268 remainder
= MAX_BAUD_RATE
% baud
;
269 if (((remainder
* 2) >= baud
) && (baud
!= 110))
272 urb_value
= urb_value
<< 8;
274 result
= ssu100_control_msg(dev
, QT_GET_SET_UART
, divisor
, urb_value
);
276 dbg("%s - set uart failed", __func__
);
279 result
= ssu100_control_msg(dev
, QT_HW_FLOW_CONTROL_MASK
,
282 result
= ssu100_control_msg(dev
, QT_HW_FLOW_CONTROL_MASK
,
285 dbg("%s - set HW flow control failed", __func__
);
287 if (I_IXOFF(tty
) || I_IXON(tty
)) {
288 u16 x
= ((u16
)(START_CHAR(tty
) << 8) | (u16
)(STOP_CHAR(tty
)));
290 result
= ssu100_control_msg(dev
, QT_SW_FLOW_CONTROL_MASK
,
293 result
= ssu100_control_msg(dev
, QT_SW_FLOW_CONTROL_MASK
,
297 dbg("%s - set SW flow control failed", __func__
);
302 static int ssu100_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
304 struct usb_device
*dev
= port
->serial
->dev
;
305 struct ssu100_port_private
*priv
= usb_get_serial_port_data(port
);
310 data
= kzalloc(2, GFP_KERNEL
);
314 result
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
315 QT_OPEN_CLOSE_CHANNEL
,
316 QT_TRANSFER_IN
, 0x01,
319 dbg("%s - open failed %i", __func__
, result
);
324 spin_lock_irqsave(&priv
->status_lock
, flags
);
325 priv
->shadowLSR
= data
[0];
326 priv
->shadowMSR
= data
[1];
327 spin_unlock_irqrestore(&priv
->status_lock
, flags
);
332 result
= ssu100_control_msg(dev
, QT_GET_SET_UART
, 0x30, 0x0300);
334 dbg("%s - set uart failed", __func__
);
337 ssu100_set_termios(tty
, port
, tty
->termios
);
339 return usb_serial_generic_open(tty
, port
);
342 static void ssu100_close(struct usb_serial_port
*port
)
344 usb_serial_generic_close(port
);
347 static int get_serial_info(struct usb_serial_port
*port
,
348 struct serial_struct __user
*retinfo
)
350 struct serial_struct tmp
;
355 memset(&tmp
, 0, sizeof(tmp
));
356 tmp
.line
= port
->serial
->minor
;
359 tmp
.flags
= ASYNC_SKIP_TEST
| ASYNC_AUTO_IRQ
;
360 tmp
.xmit_fifo_size
= port
->bulk_out_size
;
361 tmp
.baud_base
= 9600;
362 tmp
.close_delay
= 5*HZ
;
363 tmp
.closing_wait
= 30*HZ
;
365 if (copy_to_user(retinfo
, &tmp
, sizeof(*retinfo
)))
370 static int wait_modem_info(struct usb_serial_port
*port
, unsigned int arg
)
372 struct ssu100_port_private
*priv
= usb_get_serial_port_data(port
);
373 struct async_icount prev
, cur
;
376 spin_lock_irqsave(&priv
->status_lock
, flags
);
378 spin_unlock_irqrestore(&priv
->status_lock
, flags
);
381 wait_event_interruptible(priv
->delta_msr_wait
,
382 ((priv
->icount
.rng
!= prev
.rng
) ||
383 (priv
->icount
.dsr
!= prev
.dsr
) ||
384 (priv
->icount
.dcd
!= prev
.dcd
) ||
385 (priv
->icount
.cts
!= prev
.cts
)));
387 if (signal_pending(current
))
390 spin_lock_irqsave(&priv
->status_lock
, flags
);
392 spin_unlock_irqrestore(&priv
->status_lock
, flags
);
394 if ((prev
.rng
== cur
.rng
) &&
395 (prev
.dsr
== cur
.dsr
) &&
396 (prev
.dcd
== cur
.dcd
) &&
397 (prev
.cts
== cur
.cts
))
400 if ((arg
& TIOCM_RNG
&& (prev
.rng
!= cur
.rng
)) ||
401 (arg
& TIOCM_DSR
&& (prev
.dsr
!= cur
.dsr
)) ||
402 (arg
& TIOCM_CD
&& (prev
.dcd
!= cur
.dcd
)) ||
403 (arg
& TIOCM_CTS
&& (prev
.cts
!= cur
.cts
)))
409 static int ssu100_get_icount(struct tty_struct
*tty
,
410 struct serial_icounter_struct
*icount
)
412 struct usb_serial_port
*port
= tty
->driver_data
;
413 struct ssu100_port_private
*priv
= usb_get_serial_port_data(port
);
414 struct async_icount cnow
= priv
->icount
;
416 icount
->cts
= cnow
.cts
;
417 icount
->dsr
= cnow
.dsr
;
418 icount
->rng
= cnow
.rng
;
419 icount
->dcd
= cnow
.dcd
;
420 icount
->rx
= cnow
.rx
;
421 icount
->tx
= cnow
.tx
;
422 icount
->frame
= cnow
.frame
;
423 icount
->overrun
= cnow
.overrun
;
424 icount
->parity
= cnow
.parity
;
425 icount
->brk
= cnow
.brk
;
426 icount
->buf_overrun
= cnow
.buf_overrun
;
433 static int ssu100_ioctl(struct tty_struct
*tty
,
434 unsigned int cmd
, unsigned long arg
)
436 struct usb_serial_port
*port
= tty
->driver_data
;
438 dbg("%s cmd 0x%04x", __func__
, cmd
);
442 return get_serial_info(port
,
443 (struct serial_struct __user
*) arg
);
446 return wait_modem_info(port
, arg
);
452 dbg("%s arg not supported", __func__
);
457 static int ssu100_attach(struct usb_serial
*serial
)
459 struct ssu100_port_private
*priv
;
460 struct usb_serial_port
*port
= *serial
->port
;
462 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
464 dev_err(&port
->dev
, "%s- kmalloc(%Zd) failed.\n", __func__
,
469 spin_lock_init(&priv
->status_lock
);
470 init_waitqueue_head(&priv
->delta_msr_wait
);
471 usb_set_serial_port_data(port
, priv
);
473 return ssu100_initdevice(serial
->dev
);
476 static int ssu100_tiocmget(struct tty_struct
*tty
)
478 struct usb_serial_port
*port
= tty
->driver_data
;
479 struct usb_device
*dev
= port
->serial
->dev
;
483 d
= kzalloc(2, GFP_KERNEL
);
487 r
= ssu100_getregister(dev
, 0, UART_MCR
, d
);
491 r
= ssu100_getregister(dev
, 0, UART_MSR
, d
+1);
495 r
= (d
[0] & UART_MCR_DTR
? TIOCM_DTR
: 0) |
496 (d
[0] & UART_MCR_RTS
? TIOCM_RTS
: 0) |
497 (d
[1] & UART_MSR_CTS
? TIOCM_CTS
: 0) |
498 (d
[1] & UART_MSR_DCD
? TIOCM_CAR
: 0) |
499 (d
[1] & UART_MSR_RI
? TIOCM_RI
: 0) |
500 (d
[1] & UART_MSR_DSR
? TIOCM_DSR
: 0);
507 static int ssu100_tiocmset(struct tty_struct
*tty
,
508 unsigned int set
, unsigned int clear
)
510 struct usb_serial_port
*port
= tty
->driver_data
;
511 struct usb_device
*dev
= port
->serial
->dev
;
513 return update_mctrl(dev
, set
, clear
);
516 static void ssu100_dtr_rts(struct usb_serial_port
*port
, int on
)
518 struct usb_device
*dev
= port
->serial
->dev
;
520 mutex_lock(&port
->serial
->disc_mutex
);
521 if (!port
->serial
->disconnected
) {
522 /* Disable flow control */
524 ssu100_setregister(dev
, 0, UART_MCR
, 0) < 0)
525 dev_err(&port
->dev
, "error from flowcontrol urb\n");
526 /* drop RTS and DTR */
528 set_mctrl(dev
, TIOCM_DTR
| TIOCM_RTS
);
530 clear_mctrl(dev
, TIOCM_DTR
| TIOCM_RTS
);
532 mutex_unlock(&port
->serial
->disc_mutex
);
535 static void ssu100_update_msr(struct usb_serial_port
*port
, u8 msr
)
537 struct ssu100_port_private
*priv
= usb_get_serial_port_data(port
);
540 spin_lock_irqsave(&priv
->status_lock
, flags
);
541 priv
->shadowMSR
= msr
;
542 spin_unlock_irqrestore(&priv
->status_lock
, flags
);
544 if (msr
& UART_MSR_ANY_DELTA
) {
545 /* update input line counters */
546 if (msr
& UART_MSR_DCTS
)
548 if (msr
& UART_MSR_DDSR
)
550 if (msr
& UART_MSR_DDCD
)
552 if (msr
& UART_MSR_TERI
)
554 wake_up_interruptible(&priv
->delta_msr_wait
);
558 static void ssu100_update_lsr(struct usb_serial_port
*port
, u8 lsr
,
561 struct ssu100_port_private
*priv
= usb_get_serial_port_data(port
);
564 spin_lock_irqsave(&priv
->status_lock
, flags
);
565 priv
->shadowLSR
= lsr
;
566 spin_unlock_irqrestore(&priv
->status_lock
, flags
);
568 *tty_flag
= TTY_NORMAL
;
569 if (lsr
& UART_LSR_BRK_ERROR_BITS
) {
570 /* we always want to update icount, but we only want to
571 * update tty_flag for one case */
572 if (lsr
& UART_LSR_BI
) {
574 *tty_flag
= TTY_BREAK
;
575 usb_serial_handle_break(port
);
577 if (lsr
& UART_LSR_PE
) {
578 priv
->icount
.parity
++;
579 if (*tty_flag
== TTY_NORMAL
)
580 *tty_flag
= TTY_PARITY
;
582 if (lsr
& UART_LSR_FE
) {
583 priv
->icount
.frame
++;
584 if (*tty_flag
== TTY_NORMAL
)
585 *tty_flag
= TTY_FRAME
;
587 if (lsr
& UART_LSR_OE
){
588 priv
->icount
.overrun
++;
589 if (*tty_flag
== TTY_NORMAL
)
590 *tty_flag
= TTY_OVERRUN
;
596 static int ssu100_process_packet(struct urb
*urb
,
597 struct tty_struct
*tty
)
599 struct usb_serial_port
*port
= urb
->context
;
600 char *packet
= (char *)urb
->transfer_buffer
;
601 char flag
= TTY_NORMAL
;
602 u32 len
= urb
->actual_length
;
607 (packet
[0] == 0x1b) && (packet
[1] == 0x1b) &&
608 ((packet
[2] == 0x00) || (packet
[2] == 0x01))) {
609 if (packet
[2] == 0x00) {
610 ssu100_update_lsr(port
, packet
[3], &flag
);
611 if (flag
== TTY_OVERRUN
)
612 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
614 if (packet
[2] == 0x01)
615 ssu100_update_msr(port
, packet
[3]);
623 return 0; /* status only */
625 if (port
->port
.console
&& port
->sysrq
) {
626 for (i
= 0; i
< len
; i
++, ch
++) {
627 if (!usb_serial_handle_sysrq_char(port
, *ch
))
628 tty_insert_flip_char(tty
, *ch
, flag
);
631 tty_insert_flip_string_fixed_flag(tty
, ch
, flag
, len
);
636 static void ssu100_process_read_urb(struct urb
*urb
)
638 struct usb_serial_port
*port
= urb
->context
;
639 struct tty_struct
*tty
;
642 tty
= tty_port_tty_get(&port
->port
);
646 count
= ssu100_process_packet(urb
, tty
);
649 tty_flip_buffer_push(tty
);
653 static struct usb_serial_driver ssu100_device
= {
655 .owner
= THIS_MODULE
,
658 .description
= DRIVER_DESC
,
659 .id_table
= id_table
,
662 .close
= ssu100_close
,
663 .attach
= ssu100_attach
,
664 .release
= ssu100_release
,
665 .dtr_rts
= ssu100_dtr_rts
,
666 .process_read_urb
= ssu100_process_read_urb
,
667 .tiocmget
= ssu100_tiocmget
,
668 .tiocmset
= ssu100_tiocmset
,
669 .get_icount
= ssu100_get_icount
,
670 .ioctl
= ssu100_ioctl
,
671 .set_termios
= ssu100_set_termios
,
672 .disconnect
= usb_serial_generic_disconnect
,
675 static struct usb_serial_driver
* const serial_drivers
[] = {
679 module_usb_serial_driver(ssu100_driver
, serial_drivers
);
681 MODULE_DESCRIPTION(DRIVER_DESC
);
682 MODULE_LICENSE("GPL");
684 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
685 MODULE_PARM_DESC(debug
, "Debug enabled or not");