2 * This code was developed for the Quatech USB line for linux, it used
3 * much of the code developed by Greg Kroah-Hartman for USB serial devices
7 #include <linux/errno.h>
8 #include <linux/init.h>
9 #include <linux/slab.h>
10 #include <linux/tty.h>
11 #include <linux/tty_driver.h>
12 #include <linux/tty_flip.h>
13 #include <linux/module.h>
14 #include <linux/serial.h>
15 #include <linux/usb.h>
16 #include <linux/usb/serial.h>
17 #include <linux/uaccess.h>
21 /* Version Information */
22 #define DRIVER_VERSION "v2.14"
23 #define DRIVER_AUTHOR "Tim Gobeli, Quatech, Inc"
24 #define DRIVER_DESC "Quatech USB to Serial Driver"
26 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
27 #define QUATECH_SSU200 0xC030 /* SSU200 */
28 #define QUATECH_DSU100 0xC040 /* DSU100 */
29 #define QUATECH_DSU200 0xC050 /* DSU200 */
30 #define QUATECH_QSU100 0xC060 /* QSU100 */
31 #define QUATECH_QSU200 0xC070 /* QSU200 */
32 #define QUATECH_ESU100A 0xC080 /* ESU100A */
33 #define QUATECH_ESU100B 0xC081 /* ESU100B */
34 #define QUATECH_ESU200A 0xC0A0 /* ESU200A */
35 #define QUATECH_ESU200B 0xC0A1 /* ESU200B */
36 #define QUATECH_HSU100A 0xC090 /* HSU100A */
37 #define QUATECH_HSU100B 0xC091 /* HSU100B */
38 #define QUATECH_HSU100C 0xC092 /* HSU100C */
39 #define QUATECH_HSU100D 0xC093 /* HSU100D */
40 #define QUATECH_HSU200A 0xC0B0 /* HSU200A */
41 #define QUATECH_HSU200B 0xC0B1 /* HSU200B */
42 #define QUATECH_HSU200C 0xC0B2 /* HSU200C */
43 #define QUATECH_HSU200D 0xC0B3 /* HSU200D */
45 #define QT_SET_GET_DEVICE 0xc2
46 #define QT_OPEN_CLOSE_CHANNEL 0xca
47 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
48 #define QT_SET_ATF 0xcd
49 #define QT_GET_SET_REGISTER 0xc0
50 #define QT_GET_SET_UART 0xc1
51 #define QT_HW_FLOW_CONTROL_MASK 0xc5
52 #define QT_SW_FLOW_CONTROL_MASK 0xc6
53 #define QT_SW_FLOW_CONTROL_DISABLE 0xc7
54 #define QT_BREAK_CONTROL 0xc8
56 #define USBD_TRANSFER_DIRECTION_IN 0xc0
57 #define USBD_TRANSFER_DIRECTION_OUT 0x40
59 #define MAX_BAUD_RATE 460800
60 #define MAX_BAUD_REMAINDER 4608
62 #define DIV_LATCH_LS 0x00
63 #define XMT_HOLD_REGISTER 0x00
64 #define XVR_BUFFER_REGISTER 0x00
65 #define DIV_LATCH_MS 0x01
66 #define FIFO_CONTROL_REGISTER 0x02
67 #define LINE_CONTROL_REGISTER 0x03
68 #define MODEM_CONTROL_REGISTER 0x04
69 #define LINE_STATUS_REGISTER 0x05
70 #define MODEM_STATUS_REGISTER 0x06
72 #define SERIAL_MCR_DTR 0x01
73 #define SERIAL_MCR_RTS 0x02
74 #define SERIAL_MCR_LOOP 0x10
76 #define SERIAL_MSR_CTS 0x10
77 #define SERIAL_MSR_CD 0x80
78 #define SERIAL_MSR_RI 0x40
79 #define SERIAL_MSR_DSR 0x20
80 #define SERIAL_MSR_MASK 0xf0
82 #define SERIAL_8_DATA 0x03
83 #define SERIAL_7_DATA 0x02
84 #define SERIAL_6_DATA 0x01
85 #define SERIAL_5_DATA 0x00
87 #define SERIAL_ODD_PARITY 0X08
88 #define SERIAL_EVEN_PARITY 0X18
89 #define SERIAL_TWO_STOPB 0x04
90 #define SERIAL_ONE_STOPB 0x00
92 #define DEFAULT_DIVISOR 0x30 /* gives 9600 baud rate */
93 #define DEFAULT_LCR SERIAL_8_DATA /* 8, none , 1 */
95 #define FULLPWRBIT 0x00000080
96 #define NEXT_BOARD_POWER_BIT 0x00000004
98 #define SERIAL_LSR_OE 0x02
99 #define SERIAL_LSR_PE 0x04
100 #define SERIAL_LSR_FE 0x08
101 #define SERIAL_LSR_BI 0x10
103 #define SERIAL_MSR_CTS 0x10
104 #define SERIAL_MSR_CD 0x80
105 #define SERIAL_MSR_RI 0x40
106 #define SERIAL_MSR_DSR 0x20
107 #define SERIAL_MSR_MASK 0xf0
109 #define PREFUFF_LEVEL_CONSERVATIVE 128
110 #define ATC_DISABLED 0x0
112 #define RR_BITS 0x03 /* for clearing clock bits */
113 #define DUPMODE_BITS 0xc0
116 #define LOOPMODE_BITS 0x41 /* LOOP1 = b6, LOOP0 = b0 (PORT B) */
117 #define ALL_LOOPBACK 0x01
118 #define MODEM_CTRL 0x40
119 #define RS232_MODE 0x00
121 static const struct usb_device_id id_table
[] = {
122 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_SSU200
)},
123 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_DSU100
)},
124 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_DSU200
)},
125 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_QSU100
)},
126 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_QSU200
)},
127 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_ESU100A
)},
128 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_ESU100B
)},
129 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_ESU200A
)},
130 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_ESU200B
)},
131 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU100A
)},
132 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU100B
)},
133 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU100C
)},
134 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU100D
)},
135 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU200A
)},
136 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU200B
)},
137 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU200C
)},
138 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU200D
)},
139 {} /* Terminating entry */
141 MODULE_DEVICE_TABLE(usb
, id_table
);
143 struct qt_get_device_data
{
149 struct qt_open_channel_data
{
154 struct quatech_port
{
155 int port_num
; /* number of the port */
156 struct urb
*write_urb
; /* write URB for this port */
157 struct urb
*read_urb
; /* read URB for this port */
160 __u8 shadowLCR
; /* last LCR value received */
161 __u8 shadowMCR
; /* last MCR value received */
162 __u8 shadowMSR
; /* last MSR value received */
163 __u8 shadowLSR
; /* last LSR value received */
166 /* Used for TIOCMIWAIT */
167 wait_queue_head_t msr_wait
;
168 char prev_status
, diff_status
;
170 wait_queue_head_t wait
;
172 struct async_icount icount
;
174 struct usb_serial_port
*port
; /* owner of this object */
175 struct qt_get_device_data DeviceData
;
183 static int port_paranoia_check(struct usb_serial_port
*port
,
184 const char *function
)
187 dbg("%s - port == NULL", function
);
191 dbg("%s - port->serial == NULL\n", function
);
198 static int serial_paranoia_check(struct usb_serial
*serial
,
199 const char *function
)
202 dbg("%s - serial == NULL\n", function
);
207 dbg("%s - serial->type == NULL!", function
);
214 static inline struct quatech_port
*qt_get_port_private(struct usb_serial_port
217 return (struct quatech_port
*)usb_get_serial_port_data(port
);
220 static inline void qt_set_port_private(struct usb_serial_port
*port
,
221 struct quatech_port
*data
)
223 usb_set_serial_port_data(port
, (void *)data
);
226 static struct usb_serial
*get_usb_serial(struct usb_serial_port
*port
,
227 const char *function
)
229 /* if no port was specified, or it fails a paranoia check */
231 port_paranoia_check(port
, function
) ||
232 serial_paranoia_check(port
->serial
, function
)) {
234 * then say that we dont have a valid usb_serial thing,
235 * which will end up genrating -ENODEV return values
243 static void ProcessLineStatus(struct quatech_port
*qt_port
,
244 unsigned char line_status
)
248 line_status
& (SERIAL_LSR_OE
| SERIAL_LSR_PE
| SERIAL_LSR_FE
|
253 static void ProcessModemStatus(struct quatech_port
*qt_port
,
254 unsigned char modem_status
)
257 qt_port
->shadowMSR
= modem_status
;
258 wake_up_interruptible(&qt_port
->wait
);
262 static void ProcessRxChar(struct tty_struct
*tty
, struct usb_serial_port
*port
,
265 struct urb
*urb
= port
->read_urb
;
266 if (urb
->actual_length
)
267 tty_insert_flip_char(tty
, data
, TTY_NORMAL
);
270 static void qt_write_bulk_callback(struct urb
*urb
)
272 struct tty_struct
*tty
;
274 struct quatech_port
*quatech_port
;
276 status
= urb
->status
;
279 dbg("nonzero write bulk status received:%d\n", status
);
283 quatech_port
= urb
->context
;
285 tty
= tty_port_tty_get(&quatech_port
->port
->port
);
292 static void qt_interrupt_callback(struct urb
*urb
)
297 static void qt_read_bulk_callback(struct urb
*urb
)
300 struct usb_serial_port
*port
= urb
->context
;
301 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
302 struct quatech_port
*qt_port
= qt_get_port_private(port
);
304 struct tty_struct
*tty
;
306 unsigned int RxCount
;
311 qt_port
->ReadBulkStopped
= 1;
312 dbg("%s - nonzero write bulk status received: %d\n",
313 __func__
, urb
->status
);
317 tty
= tty_port_tty_get(&port
->port
);
319 dbg("%s - bad tty pointer - exiting", __func__
);
323 data
= urb
->transfer_buffer
;
325 RxCount
= urb
->actual_length
;
327 /* index = MINOR(port->tty->device) - serial->minor; */
328 index
= tty
->index
- serial
->minor
;
330 dbg("%s - port->RxHolding = %d\n", __func__
, qt_port
->RxHolding
);
332 if (port_paranoia_check(port
, __func__
) != 0) {
333 dbg("%s - port_paranoia_check, exiting\n", __func__
);
334 qt_port
->ReadBulkStopped
= 1;
339 dbg("%s - bad serial pointer, exiting\n", __func__
);
342 if (qt_port
->closePending
== 1) {
343 /* Were closing , stop reading */
344 dbg("%s - (qt_port->closepending == 1\n", __func__
);
345 qt_port
->ReadBulkStopped
= 1;
350 * RxHolding is asserted by throttle, if we assert it, we're not
351 * receiving any more characters and let the box handle the flow
354 if (qt_port
->RxHolding
== 1) {
355 qt_port
->ReadBulkStopped
= 1;
360 qt_port
->ReadBulkStopped
= 1;
362 dbg("%s - nonzero read bulk status received: %d\n",
363 __func__
, urb
->status
);
367 if (tty
&& RxCount
) {
369 for (i
= 0; i
< RxCount
; ++i
) {
370 /* Look ahead code here */
371 if ((i
<= (RxCount
- 3)) && (data
[i
] == 0x1b)
372 && (data
[i
+ 1] == 0x1b)) {
374 switch (data
[i
+ 2]) {
376 /* line status change 4th byte must follow */
377 if (i
> (RxCount
- 4)) {
378 dbg("Illegal escape seuences in received data\n");
381 ProcessLineStatus(qt_port
, data
[i
+ 3]);
387 /* Modem status status change 4th byte must follow */
388 dbg("Modem status status.\n");
389 if (i
> (RxCount
- 4)) {
390 dbg("Illegal escape sequences in received data\n");
393 ProcessModemStatus(qt_port
,
399 dbg("No status sequence.\n");
402 ProcessRxChar(tty
, port
, data
[i
]);
403 ProcessRxChar(tty
, port
, data
[i
+ 1]);
412 if (tty
&& urb
->actual_length
)
413 tty_insert_flip_char(tty
, data
[i
], TTY_NORMAL
);
416 tty_flip_buffer_push(tty
);
419 /* Continue trying to always read */
420 usb_fill_bulk_urb(port
->read_urb
, serial
->dev
,
421 usb_rcvbulkpipe(serial
->dev
,
422 port
->bulk_in_endpointAddress
),
423 port
->read_urb
->transfer_buffer
,
424 port
->read_urb
->transfer_buffer_length
,
425 qt_read_bulk_callback
, port
);
426 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
428 dbg("%s - failed resubmitting read urb, error %d",
431 if (tty
&& RxCount
) {
432 tty_flip_buffer_push(tty
);
433 tty_schedule_flip(tty
);
437 schedule_work(&port
->work
);
444 * Issue a GET_DEVICE vendor-specific request on the default control pipe If
445 * successful, fills in the qt_get_device_data structure pointed to by
446 * device_data, otherwise return a negative error number of the problem.
449 static int qt_get_device(struct usb_serial
*serial
,
450 struct qt_get_device_data
*device_data
)
453 unsigned char *transfer_buffer
;
456 kmalloc(sizeof(struct qt_get_device_data
), GFP_KERNEL
);
457 if (!transfer_buffer
)
460 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
461 QT_SET_GET_DEVICE
, 0xc0, 0, 0,
463 sizeof(struct qt_get_device_data
), 300);
465 memcpy(device_data
, transfer_buffer
,
466 sizeof(struct qt_get_device_data
));
467 kfree(transfer_buffer
);
472 /****************************************************************************
473 * BoxSetPrebufferLevel
474 TELLS BOX WHEN TO ASSERT FLOW CONTROL
475 ****************************************************************************/
476 static int BoxSetPrebufferLevel(struct usb_serial
*serial
)
481 buffer_length
= PREFUFF_LEVEL_CONSERVATIVE
;
482 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
483 QT_GET_SET_PREBUF_TRIG_LVL
, 0x40,
484 buffer_length
, 0, NULL
, 0, 300);
488 /****************************************************************************
490 TELLS BOX WHEN TO ASSERT automatic transmitter control
491 ****************************************************************************/
492 static int BoxSetATC(struct usb_serial
*serial
, __u16 n_Mode
)
497 buffer_length
= PREFUFF_LEVEL_CONSERVATIVE
;
500 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
501 QT_SET_ATF
, 0x40, n_Mode
, 0, NULL
, 0, 300);
508 * Issue a SET_DEVICE vendor-specific request on the default control pipe If
509 * successful returns the number of bytes written, otherwise it returns a
510 * negative error number of the problem.
512 static int qt_set_device(struct usb_serial
*serial
,
513 struct qt_get_device_data
*device_data
)
519 PortSettings
= ((__u16
) (device_data
->portb
));
520 PortSettings
= (PortSettings
<< 8);
521 PortSettings
+= ((__u16
) (device_data
->porta
));
523 length
= sizeof(struct qt_get_device_data
);
524 dbg("%s - PortSettings = 0x%x\n", __func__
, PortSettings
);
526 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
527 QT_SET_GET_DEVICE
, 0x40, PortSettings
,
532 static int qt_open_channel(struct usb_serial
*serial
, __u16 Uart_Number
,
533 struct qt_open_channel_data
*pDeviceData
)
537 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
538 QT_OPEN_CLOSE_CHANNEL
,
539 USBD_TRANSFER_DIRECTION_IN
, 1, Uart_Number
,
541 sizeof(struct qt_open_channel_data
), 300);
547 static int qt_close_channel(struct usb_serial
*serial
, __u16 Uart_Number
)
551 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
552 QT_OPEN_CLOSE_CHANNEL
,
553 USBD_TRANSFER_DIRECTION_OUT
, 0, Uart_Number
,
560 /****************************************************************************
562 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
563 * If successful, fills in the pValue with the register value asked for
564 ****************************************************************************/
565 static int BoxGetRegister(struct usb_serial
*serial
, unsigned short Uart_Number
,
566 unsigned short Register_Num
, __u8
*pValue
)
569 __u16 current_length
;
571 current_length
= sizeof(struct qt_get_device_data
);
574 usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
575 QT_GET_SET_REGISTER
, 0xC0, Register_Num
,
576 Uart_Number
, (void *)pValue
, sizeof(*pValue
), 300);
581 /****************************************************************************
583 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
584 * If successful, fills in the pValue with the register value asked for
585 ****************************************************************************/
586 static int BoxSetRegister(struct usb_serial
*serial
, unsigned short Uart_Number
,
587 unsigned short Register_Num
, unsigned short Value
)
590 unsigned short RegAndByte
;
593 RegAndByte
= RegAndByte
<< 8;
594 RegAndByte
= RegAndByte
+ Register_Num
;
597 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
598 QT_GET_SET_REGISTER, 0xC0, Register_Num,
599 Uart_Number, NULL, 0, 300);
603 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
604 QT_GET_SET_REGISTER
, 0x40, RegAndByte
, Uart_Number
,
612 * issues a SET_UART vendor-specific request on the default control pipe
613 * If successful sets baud rate divisor and LCR value
615 static int qt_setuart(struct usb_serial
*serial
, unsigned short Uart_Number
,
616 unsigned short default_divisor
, unsigned char default_LCR
)
619 unsigned short UartNumandLCR
;
621 UartNumandLCR
= (default_LCR
<< 8) + Uart_Number
;
624 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
625 QT_GET_SET_UART
, 0x40, default_divisor
,
626 UartNumandLCR
, NULL
, 0, 300);
631 static int BoxSetHW_FlowCtrl(struct usb_serial
*serial
, unsigned int index
,
635 __u8 msr
= 0, MOUT_Value
= 0;
639 /* flow control, box will clear RTS line to prevent remote */
640 mcr
= SERIAL_MCR_RTS
;
641 } /* device from xmitting more chars */
643 /* no flow control to remote device */
647 MOUT_Value
= mcr
<< 8;
650 /* flow control, box will inhibit xmit data if CTS line is
652 msr
= SERIAL_MSR_CTS
;
654 /* Box will not inhimbe xmit data due to CTS line */
660 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
661 QT_HW_FLOW_CONTROL_MASK
, 0x40, MOUT_Value
,
662 index
, NULL
, 0, 300);
667 static int BoxSetSW_FlowCtrl(struct usb_serial
*serial
, __u16 index
,
668 unsigned char stop_char
, unsigned char start_char
)
673 nSWflowout
= start_char
<< 8;
674 nSWflowout
= (unsigned short)stop_char
;
677 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
678 QT_SW_FLOW_CONTROL_MASK
, 0x40, nSWflowout
,
679 index
, NULL
, 0, 300);
684 static int BoxDisable_SW_FlowCtrl(struct usb_serial
*serial
, __u16 index
)
689 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
690 QT_SW_FLOW_CONTROL_DISABLE
, 0x40, 0, index
,
696 static int qt_startup(struct usb_serial
*serial
)
698 struct usb_serial_port
*port
;
699 struct quatech_port
*qt_port
;
700 struct qt_get_device_data DeviceData
;
704 /* Now setup per port private data */
705 for (i
= 0; i
< serial
->num_ports
; i
++) {
706 port
= serial
->port
[i
];
707 qt_port
= kzalloc(sizeof(*qt_port
), GFP_KERNEL
);
709 dbg("%s: kmalloc for quatech_port (%d) failed!.",
711 for (--i
; i
>= 0; i
--) {
712 port
= serial
->port
[i
];
713 kfree(usb_get_serial_port_data(port
));
714 usb_set_serial_port_data(port
, NULL
);
718 mutex_init(&qt_port
->lock
);
720 usb_set_serial_port_data(port
, qt_port
);
724 status
= qt_get_device(serial
, &DeviceData
);
726 dbg(__FILE__
"box_get_device failed");
730 dbg(__FILE__
"DeviceData.portb = 0x%x", DeviceData
.portb
);
732 DeviceData
.portb
&= ~FULLPWRBIT
;
733 dbg(__FILE__
"Changing DeviceData.portb to 0x%x", DeviceData
.portb
);
735 status
= qt_set_device(serial
, &DeviceData
);
737 dbg(__FILE__
"qt_set_device failed\n");
741 status
= qt_get_device(serial
, &DeviceData
);
743 dbg(__FILE__
"qt_get_device failed");
747 switch (serial
->dev
->descriptor
.idProduct
) {
750 case QUATECH_ESU100A
:
751 case QUATECH_ESU100B
:
752 case QUATECH_HSU100A
:
753 case QUATECH_HSU100B
:
754 case QUATECH_HSU100C
:
755 case QUATECH_HSU100D
:
756 DeviceData
.porta
&= ~(RR_BITS
| DUPMODE_BITS
);
757 DeviceData
.porta
|= CLKS_X4
;
758 DeviceData
.portb
&= ~(LOOPMODE_BITS
);
759 DeviceData
.portb
|= RS232_MODE
;
765 case QUATECH_ESU200A
:
766 case QUATECH_ESU200B
:
767 case QUATECH_HSU200A
:
768 case QUATECH_HSU200B
:
769 case QUATECH_HSU200C
:
770 case QUATECH_HSU200D
:
771 DeviceData
.porta
&= ~(RR_BITS
| DUPMODE_BITS
);
772 DeviceData
.porta
|= CLKS_X4
;
773 DeviceData
.portb
&= ~(LOOPMODE_BITS
);
774 DeviceData
.portb
|= ALL_LOOPBACK
;
777 DeviceData
.porta
&= ~(RR_BITS
| DUPMODE_BITS
);
778 DeviceData
.porta
|= CLKS_X4
;
779 DeviceData
.portb
&= ~(LOOPMODE_BITS
);
780 DeviceData
.portb
|= RS232_MODE
;
785 status
= BoxSetPrebufferLevel(serial
); /* sets to default value */
787 dbg(__FILE__
"BoxSetPrebufferLevel failed\n");
791 status
= BoxSetATC(serial
, ATC_DISABLED
);
793 dbg(__FILE__
"BoxSetATC failed\n");
797 dbg(__FILE__
"DeviceData.portb = 0x%x", DeviceData
.portb
);
799 DeviceData
.portb
|= NEXT_BOARD_POWER_BIT
;
800 dbg(__FILE__
"Changing DeviceData.portb to 0x%x", DeviceData
.portb
);
802 status
= qt_set_device(serial
, &DeviceData
);
804 dbg(__FILE__
"qt_set_device failed\n");
808 dbg("Exit Success %s\n", __func__
);
813 for (i
= 0; i
< serial
->num_ports
; i
++) {
814 port
= serial
->port
[i
];
815 qt_port
= qt_get_port_private(port
);
817 usb_set_serial_port_data(port
, NULL
);
820 dbg("Exit fail %s\n", __func__
);
825 static void qt_release(struct usb_serial
*serial
)
827 struct usb_serial_port
*port
;
828 struct quatech_port
*qt_port
;
831 for (i
= 0; i
< serial
->num_ports
; i
++) {
832 port
= serial
->port
[i
];
836 qt_port
= usb_get_serial_port_data(port
);
838 usb_set_serial_port_data(port
, NULL
);
843 static int qt_open(struct tty_struct
*tty
,
844 struct usb_serial_port
*port
)
846 struct usb_serial
*serial
;
847 struct quatech_port
*quatech_port
;
848 struct quatech_port
*port0
;
849 struct qt_open_channel_data ChannelData
;
853 if (port_paranoia_check(port
, __func__
))
856 serial
= port
->serial
;
858 if (serial_paranoia_check(serial
, __func__
))
861 quatech_port
= qt_get_port_private(port
);
862 port0
= qt_get_port_private(serial
->port
[0]);
864 if (quatech_port
== NULL
|| port0
== NULL
)
867 usb_clear_halt(serial
->dev
, port
->write_urb
->pipe
);
868 usb_clear_halt(serial
->dev
, port
->read_urb
->pipe
);
871 result
= qt_get_device(serial
, &port0
->DeviceData
);
873 /* Port specific setups */
874 result
= qt_open_channel(serial
, port
->number
, &ChannelData
);
876 dbg(__FILE__
"qt_open_channel failed\n");
879 dbg(__FILE__
"qt_open_channel completed.\n");
881 /* FIXME: are these needed? Does it even do anything useful? */
882 quatech_port
->shadowLSR
= ChannelData
.line_status
&
883 (SERIAL_LSR_OE
| SERIAL_LSR_PE
| SERIAL_LSR_FE
| SERIAL_LSR_BI
);
885 quatech_port
->shadowMSR
= ChannelData
.modem_status
&
886 (SERIAL_MSR_CTS
| SERIAL_MSR_DSR
| SERIAL_MSR_RI
| SERIAL_MSR_CD
);
888 /* Set Baud rate to default and turn off (default)flow control here */
889 result
= qt_setuart(serial
, port
->number
, DEFAULT_DIVISOR
, DEFAULT_LCR
);
891 dbg(__FILE__
"qt_setuart failed\n");
894 dbg(__FILE__
"qt_setuart completed.\n");
897 * Put this here to make it responsive to stty and defaults set by
900 /* FIXME: is this needed? */
901 /* qt_set_termios(tty, port, NULL); */
903 /* Check to see if we've set up our endpoint info yet */
904 if (port0
->open_ports
== 1) {
905 if (serial
->port
[0]->interrupt_in_buffer
== NULL
) {
906 /* set up interrupt urb */
907 usb_fill_int_urb(serial
->port
[0]->interrupt_in_urb
,
909 usb_rcvintpipe(serial
->dev
,
910 serial
->port
[0]->interrupt_in_endpointAddress
),
911 serial
->port
[0]->interrupt_in_buffer
,
913 interrupt_in_urb
->transfer_buffer_length
,
914 qt_interrupt_callback
, serial
,
916 interrupt_in_urb
->interval
);
919 usb_submit_urb(serial
->port
[0]->interrupt_in_urb
,
923 "%s - Error %d submitting "
924 "interrupt urb\n", __func__
, result
);
931 dbg("port number is %d\n", port
->number
);
932 dbg("serial number is %d\n", port
->serial
->minor
);
933 dbg("Bulkin endpoint is %d\n", port
->bulk_in_endpointAddress
);
934 dbg("BulkOut endpoint is %d\n", port
->bulk_out_endpointAddress
);
935 dbg("Interrupt endpoint is %d\n", port
->interrupt_in_endpointAddress
);
936 dbg("port's number in the device is %d\n", quatech_port
->port_num
);
937 quatech_port
->read_urb
= port
->read_urb
;
939 /* set up our bulk in urb */
941 usb_fill_bulk_urb(quatech_port
->read_urb
,
943 usb_rcvbulkpipe(serial
->dev
,
944 port
->bulk_in_endpointAddress
),
945 port
->bulk_in_buffer
,
946 quatech_port
->read_urb
->transfer_buffer_length
,
947 qt_read_bulk_callback
, quatech_port
);
949 dbg("qt_open: bulkin endpoint is %d\n", port
->bulk_in_endpointAddress
);
950 quatech_port
->read_urb_busy
= true;
951 result
= usb_submit_urb(quatech_port
->read_urb
, GFP_KERNEL
);
954 "%s - Error %d submitting control urb\n",
956 quatech_port
->read_urb_busy
= false;
959 /* initialize our wait queues */
960 init_waitqueue_head(&quatech_port
->wait
);
961 init_waitqueue_head(&quatech_port
->msr_wait
);
963 /* initialize our icount structure */
964 memset(&(quatech_port
->icount
), 0x00, sizeof(quatech_port
->icount
));
970 static int qt_chars_in_buffer(struct tty_struct
*tty
)
972 struct usb_serial_port
*port
= tty
->driver_data
;
973 struct usb_serial
*serial
;
976 serial
= get_usb_serial(port
, __func__
);
978 if (serial
->num_bulk_out
) {
979 if (port
->write_urb
->status
== -EINPROGRESS
)
980 chars
= port
->write_urb
->transfer_buffer_length
;
983 dbg("%s - returns %d\n", __func__
, chars
);
988 static void qt_block_until_empty(struct tty_struct
*tty
,
989 struct quatech_port
*qt_port
)
991 int timeout
= HZ
/ 10;
997 count
= qt_chars_in_buffer(tty
);
1002 interruptible_sleep_on_timeout(&qt_port
->wait
, timeout
);
1006 dbg("%s - TIMEOUT", __func__
);
1014 static void qt_close(struct usb_serial_port
*port
)
1016 struct usb_serial
*serial
= port
->serial
;
1017 struct quatech_port
*qt_port
;
1018 struct quatech_port
*port0
;
1019 struct tty_struct
*tty
;
1024 tty
= tty_port_tty_get(&port
->port
);
1025 index
= tty
->index
- serial
->minor
;
1027 qt_port
= qt_get_port_private(port
);
1028 port0
= qt_get_port_private(serial
->port
[0]);
1030 /* shutdown any bulk reads that might be going on */
1031 if (serial
->num_bulk_out
)
1032 usb_unlink_urb(port
->write_urb
);
1033 if (serial
->num_bulk_in
)
1034 usb_unlink_urb(port
->read_urb
);
1036 /* wait up to for transmitter to empty */
1038 qt_block_until_empty(tty
, qt_port
);
1041 /* Close uart channel */
1042 status
= qt_close_channel(serial
, index
);
1044 dbg("%s - port %d qt_close_channel failed.\n",
1045 __func__
, port
->number
);
1047 port0
->open_ports
--;
1049 dbg("qt_num_open_ports in close%d:in port%d\n",
1050 port0
->open_ports
, port
->number
);
1052 if (port0
->open_ports
== 0) {
1053 if (serial
->port
[0]->interrupt_in_urb
) {
1054 dbg("%s", "Shutdown interrupt_in_urb\n");
1055 usb_kill_urb(serial
->port
[0]->interrupt_in_urb
);
1060 if (qt_port
->write_urb
) {
1061 /* if this urb had a transfer buffer already (old tx) free it */
1062 kfree(qt_port
->write_urb
->transfer_buffer
);
1063 usb_free_urb(qt_port
->write_urb
);
1068 static int qt_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
1069 const unsigned char *buf
, int count
)
1072 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1078 dbg("%s - write request of 0 bytes\n", __func__
);
1082 /* only do something if we have a bulk out endpoint */
1083 if (serial
->num_bulk_out
) {
1084 if (port
->write_urb
->status
== -EINPROGRESS
) {
1085 dbg("%s - already writing\n", __func__
);
1090 (count
> port
->bulk_out_size
) ? port
->bulk_out_size
: count
;
1091 memcpy(port
->write_urb
->transfer_buffer
, buf
, count
);
1093 /* set up our urb */
1095 usb_fill_bulk_urb(port
->write_urb
, serial
->dev
,
1096 usb_sndbulkpipe(serial
->dev
,
1098 bulk_out_endpointAddress
),
1099 port
->write_urb
->transfer_buffer
, count
,
1100 qt_write_bulk_callback
, port
);
1102 /* send the data out the bulk port */
1103 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
1105 dbg("%s - failed submitting write urb, error %d\n",
1113 /* no bulk out, so return 0 bytes written */
1117 static int qt_write_room(struct tty_struct
*tty
)
1119 struct usb_serial_port
*port
= tty
->driver_data
;
1120 struct usb_serial
*serial
;
1121 struct quatech_port
*qt_port
;
1123 int retval
= -EINVAL
;
1125 if (port_paranoia_check(port
, __func__
)) {
1126 dbg("%s", "Invalid port\n");
1130 serial
= get_usb_serial(port
, __func__
);
1135 qt_port
= qt_get_port_private(port
);
1137 mutex_lock(&qt_port
->lock
);
1139 if (serial
->num_bulk_out
) {
1140 if (port
->write_urb
->status
!= -EINPROGRESS
)
1141 retval
= port
->bulk_out_size
;
1144 mutex_unlock(&qt_port
->lock
);
1149 static int qt_ioctl(struct tty_struct
*tty
,
1150 unsigned int cmd
, unsigned long arg
)
1152 struct usb_serial_port
*port
= tty
->driver_data
;
1153 struct quatech_port
*qt_port
= qt_get_port_private(port
);
1154 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1157 dbg("%s cmd 0x%04x", __func__
, cmd
);
1159 index
= tty
->index
- serial
->minor
;
1161 if (cmd
== TIOCMIWAIT
) {
1162 while (qt_port
!= NULL
) {
1163 interruptible_sleep_on(&qt_port
->msr_wait
);
1164 if (signal_pending(current
))
1165 return -ERESTARTSYS
;
1167 char diff
= qt_port
->diff_status
;
1170 return -EIO
; /* no change => error */
1172 /* Consume all events */
1173 qt_port
->diff_status
= 0;
1175 if (((arg
& TIOCM_RNG
)
1176 && (diff
& SERIAL_MSR_RI
))
1177 || ((arg
& TIOCM_DSR
)
1178 && (diff
& SERIAL_MSR_DSR
))
1179 || ((arg
& TIOCM_CD
)
1180 && (diff
& SERIAL_MSR_CD
))
1181 || ((arg
& TIOCM_CTS
)
1182 && (diff
& SERIAL_MSR_CTS
))) {
1190 dbg("%s -No ioctl for that one. port = %d\n", __func__
, port
->number
);
1191 return -ENOIOCTLCMD
;
1194 static void qt_set_termios(struct tty_struct
*tty
,
1195 struct usb_serial_port
*port
,
1196 struct ktermios
*old_termios
)
1198 struct ktermios
*termios
= tty
->termios
;
1199 unsigned char new_LCR
= 0;
1200 unsigned int cflag
= termios
->c_cflag
;
1202 int baud
, divisor
, remainder
;
1205 index
= tty
->index
- port
->serial
->minor
;
1209 new_LCR
|= SERIAL_5_DATA
;
1212 new_LCR
|= SERIAL_6_DATA
;
1215 new_LCR
|= SERIAL_7_DATA
;
1219 new_LCR
|= SERIAL_8_DATA
;
1224 if (cflag
& PARENB
) {
1226 new_LCR
|= SERIAL_ODD_PARITY
;
1228 new_LCR
|= SERIAL_EVEN_PARITY
;
1231 new_LCR
|= SERIAL_TWO_STOPB
;
1233 new_LCR
|= SERIAL_ONE_STOPB
;
1235 dbg("%s - 4\n", __func__
);
1237 /* Thats the LCR stuff, go ahead and set it */
1238 baud
= tty_get_baud_rate(tty
);
1240 /* pick a default, any default... */
1243 dbg("%s - got baud = %d\n", __func__
, baud
);
1245 divisor
= MAX_BAUD_RATE
/ baud
;
1246 remainder
= MAX_BAUD_RATE
% baud
;
1247 /* Round to nearest divisor */
1248 if (((remainder
* 2) >= baud
) && (baud
!= 110))
1252 * Set Baud rate to default and turn off (default)flow control here
1255 qt_setuart(port
->serial
, index
, (unsigned short)divisor
, new_LCR
);
1257 dbg(__FILE__
"qt_setuart failed\n");
1261 /* Now determine flow control */
1262 if (cflag
& CRTSCTS
) {
1263 dbg("%s - Enabling HW flow control port %d\n", __func__
,
1266 /* Enable RTS/CTS flow control */
1267 status
= BoxSetHW_FlowCtrl(port
->serial
, index
, 1);
1270 dbg(__FILE__
"BoxSetHW_FlowCtrl failed\n");
1274 /* Disable RTS/CTS flow control */
1275 dbg("%s - disabling HW flow control port %d\n", __func__
,
1278 status
= BoxSetHW_FlowCtrl(port
->serial
, index
, 0);
1280 dbg(__FILE__
"BoxSetHW_FlowCtrl failed\n");
1286 /* if we are implementing XON/XOFF, set the start and stop character in
1288 if (I_IXOFF(tty
) || I_IXON(tty
)) {
1289 unsigned char stop_char
= STOP_CHAR(tty
);
1290 unsigned char start_char
= START_CHAR(tty
);
1292 BoxSetSW_FlowCtrl(port
->serial
, index
, stop_char
,
1295 dbg(__FILE__
"BoxSetSW_FlowCtrl (enabled) failed\n");
1298 /* disable SW flow control */
1299 status
= BoxDisable_SW_FlowCtrl(port
->serial
, index
);
1301 dbg(__FILE__
"BoxSetSW_FlowCtrl (diabling) failed\n");
1304 tty
->termios
->c_cflag
&= ~CMSPAR
;
1305 /* FIXME: Error cases should be returning the actual bits changed only */
1308 static void qt_break(struct tty_struct
*tty
, int break_state
)
1310 struct usb_serial_port
*port
= tty
->driver_data
;
1311 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1312 struct quatech_port
*qt_port
;
1314 unsigned int result
;
1316 index
= tty
->index
- serial
->minor
;
1318 qt_port
= qt_get_port_private(port
);
1320 if (break_state
== -1)
1325 mutex_lock(&qt_port
->lock
);
1328 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
1329 QT_BREAK_CONTROL
, 0x40, onoff
, index
, NULL
, 0, 300);
1331 mutex_unlock(&qt_port
->lock
);
1334 static inline int qt_real_tiocmget(struct tty_struct
*tty
,
1335 struct usb_serial_port
*port
,
1336 struct usb_serial
*serial
)
1341 unsigned int result
= 0;
1345 index
= tty
->index
- serial
->minor
;
1347 BoxGetRegister(port
->serial
, index
, MODEM_CONTROL_REGISTER
, &mcr
);
1350 BoxGetRegister(port
->serial
, index
,
1351 MODEM_STATUS_REGISTER
, &msr
);
1356 result
= ((mcr
& SERIAL_MCR_DTR
) ? TIOCM_DTR
: 0)
1358 | ((mcr
& SERIAL_MCR_RTS
) ? TIOCM_RTS
: 0)
1360 | ((msr
& SERIAL_MSR_CTS
) ? TIOCM_CTS
: 0)
1362 | ((msr
& SERIAL_MSR_CD
) ? TIOCM_CAR
: 0)
1363 /* Carrier detect is set */
1364 | ((msr
& SERIAL_MSR_RI
) ? TIOCM_RI
: 0)
1365 /* Ring indicator set */
1366 | ((msr
& SERIAL_MSR_DSR
) ? TIOCM_DSR
: 0);
1374 static inline int qt_real_tiocmset(struct tty_struct
*tty
,
1375 struct usb_serial_port
*port
,
1376 struct usb_serial
*serial
,
1384 index
= tty
->index
- serial
->minor
;
1386 BoxGetRegister(port
->serial
, index
, MODEM_CONTROL_REGISTER
, &mcr
);
1391 * Turn off the RTS and DTR and loopback and then only turn on what was
1394 mcr
&= ~(SERIAL_MCR_RTS
| SERIAL_MCR_DTR
| SERIAL_MCR_LOOP
);
1395 if (value
& TIOCM_RTS
)
1396 mcr
|= SERIAL_MCR_RTS
;
1397 if (value
& TIOCM_DTR
)
1398 mcr
|= SERIAL_MCR_DTR
;
1399 if (value
& TIOCM_LOOP
)
1400 mcr
|= SERIAL_MCR_LOOP
;
1403 BoxSetRegister(port
->serial
, index
, MODEM_CONTROL_REGISTER
, mcr
);
1410 static int qt_tiocmget(struct tty_struct
*tty
)
1412 struct usb_serial_port
*port
= tty
->driver_data
;
1413 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1414 struct quatech_port
*qt_port
= qt_get_port_private(port
);
1420 mutex_lock(&qt_port
->lock
);
1421 retval
= qt_real_tiocmget(tty
, port
, serial
);
1422 mutex_unlock(&qt_port
->lock
);
1426 static int qt_tiocmset(struct tty_struct
*tty
,
1427 unsigned int set
, unsigned int clear
)
1430 struct usb_serial_port
*port
= tty
->driver_data
;
1431 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1432 struct quatech_port
*qt_port
= qt_get_port_private(port
);
1438 mutex_lock(&qt_port
->lock
);
1439 retval
= qt_real_tiocmset(tty
, port
, serial
, set
);
1440 mutex_unlock(&qt_port
->lock
);
1444 static void qt_throttle(struct tty_struct
*tty
)
1446 struct usb_serial_port
*port
= tty
->driver_data
;
1447 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1448 struct quatech_port
*qt_port
;
1453 qt_port
= qt_get_port_private(port
);
1455 mutex_lock(&qt_port
->lock
);
1457 /* pass on to the driver specific version of this function */
1458 qt_port
->RxHolding
= 1;
1460 mutex_unlock(&qt_port
->lock
);
1463 static void qt_unthrottle(struct tty_struct
*tty
)
1465 struct usb_serial_port
*port
= tty
->driver_data
;
1466 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1467 struct quatech_port
*qt_port
;
1468 unsigned int result
;
1473 qt_port
= qt_get_port_private(port
);
1475 mutex_lock(&qt_port
->lock
);
1477 if (qt_port
->RxHolding
== 1) {
1478 dbg("%s -qt_port->RxHolding == 1\n", __func__
);
1480 qt_port
->RxHolding
= 0;
1481 dbg("%s - qt_port->RxHolding = 0\n", __func__
);
1483 /* if we have a bulk endpoint, start it up */
1484 if ((serial
->num_bulk_in
) && (qt_port
->ReadBulkStopped
== 1)) {
1485 /* Start reading from the device */
1486 usb_fill_bulk_urb(port
->read_urb
, serial
->dev
,
1487 usb_rcvbulkpipe(serial
->dev
,
1488 port
->bulk_in_endpointAddress
),
1489 port
->read_urb
->transfer_buffer
,
1491 transfer_buffer_length
,
1492 qt_read_bulk_callback
, port
);
1493 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
1496 "%s - failed restarting read urb, error %d\n",
1500 mutex_unlock(&qt_port
->lock
);
1503 static int qt_calc_num_ports(struct usb_serial
*serial
)
1507 dbg("numberofendpoints: %d\n",
1508 (int)serial
->interface
->cur_altsetting
->desc
.bNumEndpoints
);
1509 dbg("numberofendpoints: %d\n",
1510 (int)serial
->interface
->altsetting
->desc
.bNumEndpoints
);
1513 (serial
->interface
->cur_altsetting
->desc
.bNumEndpoints
- 1) / 2;
1518 static struct usb_serial_driver quatech_device
= {
1520 .owner
= THIS_MODULE
,
1523 .description
= DRIVER_DESC
,
1524 .id_table
= id_table
,
1529 .write_room
= qt_write_room
,
1530 .chars_in_buffer
= qt_chars_in_buffer
,
1531 .throttle
= qt_throttle
,
1532 .unthrottle
= qt_unthrottle
,
1533 .calc_num_ports
= qt_calc_num_ports
,
1535 .set_termios
= qt_set_termios
,
1536 .break_ctl
= qt_break
,
1537 .tiocmget
= qt_tiocmget
,
1538 .tiocmset
= qt_tiocmset
,
1539 .attach
= qt_startup
,
1540 .release
= qt_release
,
1543 static struct usb_serial_driver
* const serial_drivers
[] = {
1544 &quatech_device
, NULL
1547 module_usb_serial_driver(serial_drivers
, id_table
);
1549 MODULE_AUTHOR(DRIVER_AUTHOR
);
1550 MODULE_DESCRIPTION(DRIVER_DESC
);
1551 MODULE_LICENSE("GPL");
1553 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1554 MODULE_PARM_DESC(debug
, "Debug enabled or not");