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>
19 /* Version Information */
20 #define DRIVER_VERSION "v2.14"
21 #define DRIVER_AUTHOR "Tim Gobeli, Quatech, Inc"
22 #define DRIVER_DESC "Quatech USB to Serial Driver"
24 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
25 #define QUATECH_SSU200 0xC030 /* SSU200 */
26 #define QUATECH_DSU100 0xC040 /* DSU100 */
27 #define QUATECH_DSU200 0xC050 /* DSU200 */
28 #define QUATECH_QSU100 0xC060 /* QSU100 */
29 #define QUATECH_QSU200 0xC070 /* QSU200 */
30 #define QUATECH_ESU100A 0xC080 /* ESU100A */
31 #define QUATECH_ESU100B 0xC081 /* ESU100B */
32 #define QUATECH_ESU200A 0xC0A0 /* ESU200A */
33 #define QUATECH_ESU200B 0xC0A1 /* ESU200B */
34 #define QUATECH_HSU100A 0xC090 /* HSU100A */
35 #define QUATECH_HSU100B 0xC091 /* HSU100B */
36 #define QUATECH_HSU100C 0xC092 /* HSU100C */
37 #define QUATECH_HSU100D 0xC093 /* HSU100D */
38 #define QUATECH_HSU200A 0xC0B0 /* HSU200A */
39 #define QUATECH_HSU200B 0xC0B1 /* HSU200B */
40 #define QUATECH_HSU200C 0xC0B2 /* HSU200C */
41 #define QUATECH_HSU200D 0xC0B3 /* HSU200D */
43 #define QT_SET_GET_DEVICE 0xc2
44 #define QT_OPEN_CLOSE_CHANNEL 0xca
45 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
46 #define QT_SET_ATF 0xcd
47 #define QT_GET_SET_REGISTER 0xc0
48 #define QT_GET_SET_UART 0xc1
49 #define QT_HW_FLOW_CONTROL_MASK 0xc5
50 #define QT_SW_FLOW_CONTROL_MASK 0xc6
51 #define QT_SW_FLOW_CONTROL_DISABLE 0xc7
52 #define QT_BREAK_CONTROL 0xc8
54 #define USBD_TRANSFER_DIRECTION_IN 0xc0
55 #define USBD_TRANSFER_DIRECTION_OUT 0x40
57 #define MAX_BAUD_RATE 460800
58 #define MAX_BAUD_REMAINDER 4608
60 #define DIV_LATCH_LS 0x00
61 #define XMT_HOLD_REGISTER 0x00
62 #define XVR_BUFFER_REGISTER 0x00
63 #define DIV_LATCH_MS 0x01
64 #define FIFO_CONTROL_REGISTER 0x02
65 #define LINE_CONTROL_REGISTER 0x03
66 #define MODEM_CONTROL_REGISTER 0x04
67 #define LINE_STATUS_REGISTER 0x05
68 #define MODEM_STATUS_REGISTER 0x06
70 #define SERIAL_MCR_DTR 0x01
71 #define SERIAL_MCR_RTS 0x02
72 #define SERIAL_MCR_LOOP 0x10
74 #define SERIAL_MSR_CTS 0x10
75 #define SERIAL_MSR_CD 0x80
76 #define SERIAL_MSR_RI 0x40
77 #define SERIAL_MSR_DSR 0x20
78 #define SERIAL_MSR_MASK 0xf0
80 #define SERIAL_8_DATA 0x03
81 #define SERIAL_7_DATA 0x02
82 #define SERIAL_6_DATA 0x01
83 #define SERIAL_5_DATA 0x00
85 #define SERIAL_ODD_PARITY 0X08
86 #define SERIAL_EVEN_PARITY 0X18
87 #define SERIAL_TWO_STOPB 0x04
88 #define SERIAL_ONE_STOPB 0x00
90 #define DEFAULT_DIVISOR 0x30 /* gives 9600 baud rate */
91 #define DEFAULT_LCR SERIAL_8_DATA /* 8, none , 1 */
93 #define FULLPWRBIT 0x00000080
94 #define NEXT_BOARD_POWER_BIT 0x00000004
96 #define SERIAL_LSR_OE 0x02
97 #define SERIAL_LSR_PE 0x04
98 #define SERIAL_LSR_FE 0x08
99 #define SERIAL_LSR_BI 0x10
101 #define SERIAL_MSR_CTS 0x10
102 #define SERIAL_MSR_CD 0x80
103 #define SERIAL_MSR_RI 0x40
104 #define SERIAL_MSR_DSR 0x20
105 #define SERIAL_MSR_MASK 0xf0
107 #define PREFUFF_LEVEL_CONSERVATIVE 128
108 #define ATC_DISABLED 0x0
110 #define RR_BITS 0x03 /* for clearing clock bits */
111 #define DUPMODE_BITS 0xc0
114 #define LOOPMODE_BITS 0x41 /* LOOP1 = b6, LOOP0 = b0 (PORT B) */
115 #define ALL_LOOPBACK 0x01
116 #define MODEM_CTRL 0x40
117 #define RS232_MODE 0x00
119 static const struct usb_device_id id_table
[] = {
120 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_SSU200
)},
121 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_DSU100
)},
122 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_DSU200
)},
123 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_QSU100
)},
124 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_QSU200
)},
125 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_ESU100A
)},
126 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_ESU100B
)},
127 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_ESU200A
)},
128 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_ESU200B
)},
129 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU100A
)},
130 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU100B
)},
131 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU100C
)},
132 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU100D
)},
133 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU200A
)},
134 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU200B
)},
135 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU200C
)},
136 {USB_DEVICE(USB_VENDOR_ID_QUATECH
, QUATECH_HSU200D
)},
137 {} /* Terminating entry */
139 MODULE_DEVICE_TABLE(usb
, id_table
);
141 struct qt_get_device_data
{
147 struct qt_open_channel_data
{
152 struct quatech_port
{
153 int port_num
; /* number of the port */
154 struct urb
*write_urb
; /* write URB for this port */
155 struct urb
*read_urb
; /* read URB for this port */
158 __u8 shadowLCR
; /* last LCR value received */
159 __u8 shadowMCR
; /* last MCR value received */
160 __u8 shadowMSR
; /* last MSR value received */
161 __u8 shadowLSR
; /* last LSR value received */
164 /* Used for TIOCMIWAIT */
165 wait_queue_head_t msr_wait
;
166 char prev_status
, diff_status
;
168 wait_queue_head_t wait
;
170 struct async_icount icount
;
172 struct usb_serial_port
*port
; /* owner of this object */
173 struct qt_get_device_data DeviceData
;
181 static int port_paranoia_check(struct usb_serial_port
*port
,
182 const char *function
)
185 pr_debug("%s - port == NULL", function
);
189 pr_debug("%s - port->serial == NULL\n", function
);
196 static int serial_paranoia_check(struct usb_serial
*serial
,
197 const char *function
)
200 pr_debug("%s - serial == NULL\n", function
);
205 pr_debug("%s - serial->type == NULL!", function
);
212 static inline struct quatech_port
*qt_get_port_private(struct usb_serial_port
215 return (struct quatech_port
*)usb_get_serial_port_data(port
);
218 static inline void qt_set_port_private(struct usb_serial_port
*port
,
219 struct quatech_port
*data
)
221 usb_set_serial_port_data(port
, (void *)data
);
224 static struct usb_serial
*get_usb_serial(struct usb_serial_port
*port
,
225 const char *function
)
227 /* if no port was specified, or it fails a paranoia check */
229 port_paranoia_check(port
, function
) ||
230 serial_paranoia_check(port
->serial
, function
)) {
232 * then say that we dont have a valid usb_serial thing,
233 * which will end up genrating -ENODEV return values
241 static void ProcessLineStatus(struct quatech_port
*qt_port
,
242 unsigned char line_status
)
246 line_status
& (SERIAL_LSR_OE
| SERIAL_LSR_PE
| SERIAL_LSR_FE
|
250 static void ProcessModemStatus(struct quatech_port
*qt_port
,
251 unsigned char modem_status
)
254 qt_port
->shadowMSR
= modem_status
;
255 wake_up_interruptible(&qt_port
->wait
);
258 static void ProcessRxChar(struct tty_struct
*tty
, struct usb_serial_port
*port
,
261 struct urb
*urb
= port
->read_urb
;
262 if (urb
->actual_length
)
263 tty_insert_flip_char(tty
, data
, TTY_NORMAL
);
266 static void qt_write_bulk_callback(struct urb
*urb
)
268 struct tty_struct
*tty
;
270 struct quatech_port
*quatech_port
;
272 status
= urb
->status
;
275 dev_dbg(&urb
->dev
->dev
, "nonzero write bulk status received:%d\n", status
);
279 quatech_port
= urb
->context
;
281 tty
= tty_port_tty_get(&quatech_port
->port
->port
);
288 static void qt_interrupt_callback(struct urb
*urb
)
293 static void qt_read_bulk_callback(struct urb
*urb
)
296 struct usb_serial_port
*port
= urb
->context
;
297 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
298 struct quatech_port
*qt_port
= qt_get_port_private(port
);
300 struct tty_struct
*tty
;
302 unsigned int RxCount
;
307 qt_port
->ReadBulkStopped
= 1;
308 dev_dbg(&urb
->dev
->dev
, "%s - nonzero write bulk status received: %d\n",
309 __func__
, urb
->status
);
313 tty
= tty_port_tty_get(&port
->port
);
317 data
= urb
->transfer_buffer
;
319 RxCount
= urb
->actual_length
;
321 /* index = MINOR(port->tty->device) - serial->minor; */
322 index
= tty
->index
- serial
->minor
;
324 dev_dbg(&port
->dev
, "%s - port->RxHolding = %d\n", __func__
, qt_port
->RxHolding
);
326 if (port_paranoia_check(port
, __func__
) != 0) {
327 qt_port
->ReadBulkStopped
= 1;
334 if (qt_port
->closePending
== 1) {
335 /* Were closing , stop reading */
336 dev_dbg(&port
->dev
, "%s - (qt_port->closepending == 1\n", __func__
);
337 qt_port
->ReadBulkStopped
= 1;
342 * RxHolding is asserted by throttle, if we assert it, we're not
343 * receiving any more characters and let the box handle the flow
346 if (qt_port
->RxHolding
== 1) {
347 qt_port
->ReadBulkStopped
= 1;
352 qt_port
->ReadBulkStopped
= 1;
354 dev_dbg(&port
->dev
, "%s - nonzero read bulk status received: %d\n",
355 __func__
, urb
->status
);
361 for (i
= 0; i
< RxCount
; ++i
) {
362 /* Look ahead code here */
363 if ((i
<= (RxCount
- 3)) && (data
[i
] == 0x1b)
364 && (data
[i
+ 1] == 0x1b)) {
366 switch (data
[i
+ 2]) {
368 /* line status change 4th byte must follow */
369 if (i
> (RxCount
- 4)) {
370 dev_dbg(&port
->dev
, "Illegal escape seuences in received data\n");
373 ProcessLineStatus(qt_port
, data
[i
+ 3]);
379 /* Modem status status change 4th byte must follow */
380 dev_dbg(&port
->dev
, "Modem status status.\n");
381 if (i
> (RxCount
- 4)) {
382 dev_dbg(&port
->dev
, "Illegal escape sequences in received data\n");
385 ProcessModemStatus(qt_port
,
391 dev_dbg(&port
->dev
, "No status sequence.\n");
394 ProcessRxChar(tty
, port
, data
[i
]);
395 ProcessRxChar(tty
, port
, data
[i
+ 1]);
404 if (tty
&& urb
->actual_length
)
405 tty_insert_flip_char(tty
, data
[i
], TTY_NORMAL
);
408 tty_flip_buffer_push(tty
);
411 /* Continue trying to always read */
412 usb_fill_bulk_urb(port
->read_urb
, serial
->dev
,
413 usb_rcvbulkpipe(serial
->dev
,
414 port
->bulk_in_endpointAddress
),
415 port
->read_urb
->transfer_buffer
,
416 port
->read_urb
->transfer_buffer_length
,
417 qt_read_bulk_callback
, port
);
418 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
420 dev_dbg(&port
->dev
, "%s - failed resubmitting read urb, error %d",
424 tty_flip_buffer_push(tty
);
425 tty_schedule_flip(tty
);
429 schedule_work(&port
->work
);
436 * Issue a GET_DEVICE vendor-specific request on the default control pipe If
437 * successful, fills in the qt_get_device_data structure pointed to by
438 * device_data, otherwise return a negative error number of the problem.
441 static int qt_get_device(struct usb_serial
*serial
,
442 struct qt_get_device_data
*device_data
)
445 unsigned char *transfer_buffer
;
448 kmalloc(sizeof(struct qt_get_device_data
), GFP_KERNEL
);
449 if (!transfer_buffer
)
452 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
453 QT_SET_GET_DEVICE
, 0xc0, 0, 0,
455 sizeof(struct qt_get_device_data
), 300);
457 memcpy(device_data
, transfer_buffer
,
458 sizeof(struct qt_get_device_data
));
459 kfree(transfer_buffer
);
464 /****************************************************************************
465 * BoxSetPrebufferLevel
466 TELLS BOX WHEN TO ASSERT FLOW CONTROL
467 ****************************************************************************/
468 static int BoxSetPrebufferLevel(struct usb_serial
*serial
)
473 buffer_length
= PREFUFF_LEVEL_CONSERVATIVE
;
474 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
475 QT_GET_SET_PREBUF_TRIG_LVL
, 0x40,
476 buffer_length
, 0, NULL
, 0, 300);
480 /****************************************************************************
482 TELLS BOX WHEN TO ASSERT automatic transmitter control
483 ****************************************************************************/
484 static int BoxSetATC(struct usb_serial
*serial
, __u16 n_Mode
)
489 buffer_length
= PREFUFF_LEVEL_CONSERVATIVE
;
492 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
493 QT_SET_ATF
, 0x40, n_Mode
, 0, NULL
, 0, 300);
500 * Issue a SET_DEVICE vendor-specific request on the default control pipe If
501 * successful returns the number of bytes written, otherwise it returns a
502 * negative error number of the problem.
504 static int qt_set_device(struct usb_serial
*serial
,
505 struct qt_get_device_data
*device_data
)
511 PortSettings
= ((__u16
) (device_data
->portb
));
512 PortSettings
= (PortSettings
<< 8);
513 PortSettings
+= ((__u16
) (device_data
->porta
));
515 length
= sizeof(struct qt_get_device_data
);
517 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
518 QT_SET_GET_DEVICE
, 0x40, PortSettings
,
523 static int qt_open_channel(struct usb_serial
*serial
, __u16 Uart_Number
,
524 struct qt_open_channel_data
*pDeviceData
)
528 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
529 QT_OPEN_CLOSE_CHANNEL
,
530 USBD_TRANSFER_DIRECTION_IN
, 1, Uart_Number
,
532 sizeof(struct qt_open_channel_data
), 300);
538 static int qt_close_channel(struct usb_serial
*serial
, __u16 Uart_Number
)
542 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
543 QT_OPEN_CLOSE_CHANNEL
,
544 USBD_TRANSFER_DIRECTION_OUT
, 0, Uart_Number
,
551 /****************************************************************************
553 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
554 * If successful, fills in the pValue with the register value asked for
555 ****************************************************************************/
556 static int BoxGetRegister(struct usb_serial
*serial
, unsigned short Uart_Number
,
557 unsigned short Register_Num
, __u8
*pValue
)
560 __u16 current_length
;
562 current_length
= sizeof(struct qt_get_device_data
);
565 usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
566 QT_GET_SET_REGISTER
, 0xC0, Register_Num
,
567 Uart_Number
, (void *)pValue
, sizeof(*pValue
), 300);
572 /****************************************************************************
574 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
575 * If successful, fills in the pValue with the register value asked for
576 ****************************************************************************/
577 static int BoxSetRegister(struct usb_serial
*serial
, unsigned short Uart_Number
,
578 unsigned short Register_Num
, unsigned short Value
)
581 unsigned short RegAndByte
;
584 RegAndByte
= RegAndByte
<< 8;
585 RegAndByte
= RegAndByte
+ Register_Num
;
588 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
589 QT_GET_SET_REGISTER, 0xC0, Register_Num,
590 Uart_Number, NULL, 0, 300);
594 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
595 QT_GET_SET_REGISTER
, 0x40, RegAndByte
, Uart_Number
,
603 * issues a SET_UART vendor-specific request on the default control pipe
604 * If successful sets baud rate divisor and LCR value
606 static int qt_setuart(struct usb_serial
*serial
, unsigned short Uart_Number
,
607 unsigned short default_divisor
, unsigned char default_LCR
)
610 unsigned short UartNumandLCR
;
612 UartNumandLCR
= (default_LCR
<< 8) + Uart_Number
;
615 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
616 QT_GET_SET_UART
, 0x40, default_divisor
,
617 UartNumandLCR
, NULL
, 0, 300);
622 static int BoxSetHW_FlowCtrl(struct usb_serial
*serial
, unsigned int index
,
626 __u8 msr
= 0, MOUT_Value
= 0;
630 /* flow control, box will clear RTS line to prevent remote */
631 mcr
= SERIAL_MCR_RTS
;
632 } /* device from xmitting more chars */
634 /* no flow control to remote device */
638 MOUT_Value
= mcr
<< 8;
641 /* flow control, box will inhibit xmit data if CTS line is
643 msr
= SERIAL_MSR_CTS
;
645 /* Box will not inhimbe xmit data due to CTS line */
651 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
652 QT_HW_FLOW_CONTROL_MASK
, 0x40, MOUT_Value
,
653 index
, NULL
, 0, 300);
658 static int BoxSetSW_FlowCtrl(struct usb_serial
*serial
, __u16 index
,
659 unsigned char stop_char
, unsigned char start_char
)
664 nSWflowout
= start_char
<< 8;
665 nSWflowout
= (unsigned short)stop_char
;
668 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
669 QT_SW_FLOW_CONTROL_MASK
, 0x40, nSWflowout
,
670 index
, NULL
, 0, 300);
675 static int BoxDisable_SW_FlowCtrl(struct usb_serial
*serial
, __u16 index
)
680 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
681 QT_SW_FLOW_CONTROL_DISABLE
, 0x40, 0, index
,
687 static int qt_startup(struct usb_serial
*serial
)
689 struct device
*dev
= &serial
->dev
->dev
;
690 struct usb_serial_port
*port
;
691 struct quatech_port
*qt_port
;
692 struct qt_get_device_data DeviceData
;
696 /* Now setup per port private data */
697 for (i
= 0; i
< serial
->num_ports
; i
++) {
698 port
= serial
->port
[i
];
699 qt_port
= kzalloc(sizeof(*qt_port
), GFP_KERNEL
);
701 for (--i
; i
>= 0; i
--) {
702 port
= serial
->port
[i
];
703 kfree(usb_get_serial_port_data(port
));
704 usb_set_serial_port_data(port
, NULL
);
708 mutex_init(&qt_port
->lock
);
710 usb_set_serial_port_data(port
, qt_port
);
714 status
= qt_get_device(serial
, &DeviceData
);
718 dev_dbg(dev
, "DeviceData.portb = 0x%x\n", DeviceData
.portb
);
720 DeviceData
.portb
&= ~FULLPWRBIT
;
721 dev_dbg(dev
, "Changing DeviceData.portb to 0x%x\n", DeviceData
.portb
);
723 status
= qt_set_device(serial
, &DeviceData
);
725 dev_dbg(dev
, "qt_set_device failed\n");
729 status
= qt_get_device(serial
, &DeviceData
);
731 dev_dbg(dev
, "qt_get_device failed\n");
735 switch (serial
->dev
->descriptor
.idProduct
) {
738 case QUATECH_ESU100A
:
739 case QUATECH_ESU100B
:
740 case QUATECH_HSU100A
:
741 case QUATECH_HSU100B
:
742 case QUATECH_HSU100C
:
743 case QUATECH_HSU100D
:
744 DeviceData
.porta
&= ~(RR_BITS
| DUPMODE_BITS
);
745 DeviceData
.porta
|= CLKS_X4
;
746 DeviceData
.portb
&= ~(LOOPMODE_BITS
);
747 DeviceData
.portb
|= RS232_MODE
;
753 case QUATECH_ESU200A
:
754 case QUATECH_ESU200B
:
755 case QUATECH_HSU200A
:
756 case QUATECH_HSU200B
:
757 case QUATECH_HSU200C
:
758 case QUATECH_HSU200D
:
759 DeviceData
.porta
&= ~(RR_BITS
| DUPMODE_BITS
);
760 DeviceData
.porta
|= CLKS_X4
;
761 DeviceData
.portb
&= ~(LOOPMODE_BITS
);
762 DeviceData
.portb
|= ALL_LOOPBACK
;
765 DeviceData
.porta
&= ~(RR_BITS
| DUPMODE_BITS
);
766 DeviceData
.porta
|= CLKS_X4
;
767 DeviceData
.portb
&= ~(LOOPMODE_BITS
);
768 DeviceData
.portb
|= RS232_MODE
;
773 status
= BoxSetPrebufferLevel(serial
); /* sets to default value */
775 dev_dbg(dev
, "BoxSetPrebufferLevel failed\n");
779 status
= BoxSetATC(serial
, ATC_DISABLED
);
781 dev_dbg(dev
, "BoxSetATC failed\n");
785 dev_dbg(dev
, "DeviceData.portb = 0x%x\n", DeviceData
.portb
);
787 DeviceData
.portb
|= NEXT_BOARD_POWER_BIT
;
788 dev_dbg(dev
, "Changing DeviceData.portb to 0x%x\n", DeviceData
.portb
);
790 status
= qt_set_device(serial
, &DeviceData
);
792 dev_dbg(dev
, "qt_set_device failed\n");
799 for (i
= 0; i
< serial
->num_ports
; i
++) {
800 port
= serial
->port
[i
];
801 qt_port
= qt_get_port_private(port
);
803 usb_set_serial_port_data(port
, NULL
);
809 static void qt_release(struct usb_serial
*serial
)
811 struct usb_serial_port
*port
;
812 struct quatech_port
*qt_port
;
815 for (i
= 0; i
< serial
->num_ports
; i
++) {
816 port
= serial
->port
[i
];
820 qt_port
= usb_get_serial_port_data(port
);
822 usb_set_serial_port_data(port
, NULL
);
827 static int qt_open(struct tty_struct
*tty
,
828 struct usb_serial_port
*port
)
830 struct usb_serial
*serial
;
831 struct quatech_port
*quatech_port
;
832 struct quatech_port
*port0
;
833 struct qt_open_channel_data ChannelData
;
837 if (port_paranoia_check(port
, __func__
))
840 serial
= port
->serial
;
842 if (serial_paranoia_check(serial
, __func__
))
845 quatech_port
= qt_get_port_private(port
);
846 port0
= qt_get_port_private(serial
->port
[0]);
848 if (quatech_port
== NULL
|| port0
== NULL
)
851 usb_clear_halt(serial
->dev
, port
->write_urb
->pipe
);
852 usb_clear_halt(serial
->dev
, port
->read_urb
->pipe
);
855 result
= qt_get_device(serial
, &port0
->DeviceData
);
857 /* Port specific setups */
858 result
= qt_open_channel(serial
, port
->number
, &ChannelData
);
860 dev_dbg(&port
->dev
, "qt_open_channel failed\n");
863 dev_dbg(&port
->dev
, "qt_open_channel completed.\n");
865 /* FIXME: are these needed? Does it even do anything useful? */
866 quatech_port
->shadowLSR
= ChannelData
.line_status
&
867 (SERIAL_LSR_OE
| SERIAL_LSR_PE
| SERIAL_LSR_FE
| SERIAL_LSR_BI
);
869 quatech_port
->shadowMSR
= ChannelData
.modem_status
&
870 (SERIAL_MSR_CTS
| SERIAL_MSR_DSR
| SERIAL_MSR_RI
| SERIAL_MSR_CD
);
872 /* Set Baud rate to default and turn off (default)flow control here */
873 result
= qt_setuart(serial
, port
->number
, DEFAULT_DIVISOR
, DEFAULT_LCR
);
875 dev_dbg(&port
->dev
, "qt_setuart failed\n");
878 dev_dbg(&port
->dev
, "qt_setuart completed.\n");
881 * Put this here to make it responsive to stty and defaults set by
885 /* Check to see if we've set up our endpoint info yet */
886 if (port0
->open_ports
== 1) {
887 if (serial
->port
[0]->interrupt_in_buffer
== NULL
) {
888 /* set up interrupt urb */
889 usb_fill_int_urb(serial
->port
[0]->interrupt_in_urb
,
891 usb_rcvintpipe(serial
->dev
,
892 serial
->port
[0]->interrupt_in_endpointAddress
),
893 serial
->port
[0]->interrupt_in_buffer
,
895 interrupt_in_urb
->transfer_buffer_length
,
896 qt_interrupt_callback
, serial
,
898 interrupt_in_urb
->interval
);
901 usb_submit_urb(serial
->port
[0]->interrupt_in_urb
,
905 "%s - Error %d submitting "
906 "interrupt urb\n", __func__
, result
);
913 dev_dbg(&port
->dev
, "port number is %d\n", port
->number
);
914 dev_dbg(&port
->dev
, "serial number is %d\n", port
->serial
->minor
);
915 dev_dbg(&port
->dev
, "Bulkin endpoint is %d\n", port
->bulk_in_endpointAddress
);
916 dev_dbg(&port
->dev
, "BulkOut endpoint is %d\n", port
->bulk_out_endpointAddress
);
917 dev_dbg(&port
->dev
, "Interrupt endpoint is %d\n", port
->interrupt_in_endpointAddress
);
918 dev_dbg(&port
->dev
, "port's number in the device is %d\n", quatech_port
->port_num
);
919 quatech_port
->read_urb
= port
->read_urb
;
921 /* set up our bulk in urb */
923 usb_fill_bulk_urb(quatech_port
->read_urb
,
925 usb_rcvbulkpipe(serial
->dev
,
926 port
->bulk_in_endpointAddress
),
927 port
->bulk_in_buffer
,
928 quatech_port
->read_urb
->transfer_buffer_length
,
929 qt_read_bulk_callback
, quatech_port
);
931 dev_dbg(&port
->dev
, "qt_open: bulkin endpoint is %d\n", port
->bulk_in_endpointAddress
);
932 quatech_port
->read_urb_busy
= true;
933 result
= usb_submit_urb(quatech_port
->read_urb
, GFP_KERNEL
);
936 "%s - Error %d submitting control urb\n",
938 quatech_port
->read_urb_busy
= false;
941 /* initialize our wait queues */
942 init_waitqueue_head(&quatech_port
->wait
);
943 init_waitqueue_head(&quatech_port
->msr_wait
);
945 /* initialize our icount structure */
946 memset(&(quatech_port
->icount
), 0x00, sizeof(quatech_port
->icount
));
952 static int qt_chars_in_buffer(struct tty_struct
*tty
)
954 struct usb_serial_port
*port
= tty
->driver_data
;
955 struct usb_serial
*serial
;
958 serial
= get_usb_serial(port
, __func__
);
960 if (serial
->num_bulk_out
) {
961 if (port
->write_urb
->status
== -EINPROGRESS
)
962 chars
= port
->write_urb
->transfer_buffer_length
;
968 static void qt_block_until_empty(struct tty_struct
*tty
,
969 struct quatech_port
*qt_port
)
971 int timeout
= HZ
/ 10;
977 count
= qt_chars_in_buffer(tty
);
982 interruptible_sleep_on_timeout(&qt_port
->wait
, timeout
);
986 dev_dbg(&qt_port
->port
->dev
, "%s - TIMEOUT", __func__
);
994 static void qt_close(struct usb_serial_port
*port
)
996 struct usb_serial
*serial
= port
->serial
;
997 struct quatech_port
*qt_port
;
998 struct quatech_port
*port0
;
999 struct tty_struct
*tty
;
1004 tty
= tty_port_tty_get(&port
->port
);
1005 index
= tty
->index
- serial
->minor
;
1007 qt_port
= qt_get_port_private(port
);
1008 port0
= qt_get_port_private(serial
->port
[0]);
1010 /* shutdown any bulk reads that might be going on */
1011 if (serial
->num_bulk_out
)
1012 usb_unlink_urb(port
->write_urb
);
1013 if (serial
->num_bulk_in
)
1014 usb_unlink_urb(port
->read_urb
);
1016 /* wait up to for transmitter to empty */
1018 qt_block_until_empty(tty
, qt_port
);
1021 /* Close uart channel */
1022 status
= qt_close_channel(serial
, index
);
1024 dev_dbg(&port
->dev
, "%s - port %d qt_close_channel failed.\n", __func__
, port
->number
);
1026 port0
->open_ports
--;
1028 dev_dbg(&port
->dev
, "qt_num_open_ports in close%d:in port%d\n", port0
->open_ports
, port
->number
);
1030 if (port0
->open_ports
== 0) {
1031 if (serial
->port
[0]->interrupt_in_urb
) {
1032 dev_dbg(&port
->dev
, "%s", "Shutdown interrupt_in_urb\n");
1033 usb_kill_urb(serial
->port
[0]->interrupt_in_urb
);
1038 if (qt_port
->write_urb
) {
1039 /* if this urb had a transfer buffer already (old tx) free it */
1040 kfree(qt_port
->write_urb
->transfer_buffer
);
1041 usb_free_urb(qt_port
->write_urb
);
1046 static int qt_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
1047 const unsigned char *buf
, int count
)
1050 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1056 dev_dbg(&port
->dev
, "%s - write request of 0 bytes\n", __func__
);
1060 /* only do something if we have a bulk out endpoint */
1061 if (serial
->num_bulk_out
) {
1062 if (port
->write_urb
->status
== -EINPROGRESS
) {
1063 dev_dbg(&port
->dev
, "%s - already writing\n", __func__
);
1068 (count
> port
->bulk_out_size
) ? port
->bulk_out_size
: count
;
1069 memcpy(port
->write_urb
->transfer_buffer
, buf
, count
);
1071 /* set up our urb */
1073 usb_fill_bulk_urb(port
->write_urb
, serial
->dev
,
1074 usb_sndbulkpipe(serial
->dev
,
1076 bulk_out_endpointAddress
),
1077 port
->write_urb
->transfer_buffer
, count
,
1078 qt_write_bulk_callback
, port
);
1080 /* send the data out the bulk port */
1081 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
1083 dev_dbg(&port
->dev
, "%s - failed submitting write urb, error %d\n",
1091 /* no bulk out, so return 0 bytes written */
1095 static int qt_write_room(struct tty_struct
*tty
)
1097 struct usb_serial_port
*port
= tty
->driver_data
;
1098 struct usb_serial
*serial
;
1099 struct quatech_port
*qt_port
;
1101 int retval
= -EINVAL
;
1103 if (port_paranoia_check(port
, __func__
))
1106 serial
= get_usb_serial(port
, __func__
);
1111 qt_port
= qt_get_port_private(port
);
1113 mutex_lock(&qt_port
->lock
);
1115 if (serial
->num_bulk_out
) {
1116 if (port
->write_urb
->status
!= -EINPROGRESS
)
1117 retval
= port
->bulk_out_size
;
1120 mutex_unlock(&qt_port
->lock
);
1125 static int qt_ioctl(struct tty_struct
*tty
,
1126 unsigned int cmd
, unsigned long arg
)
1128 struct usb_serial_port
*port
= tty
->driver_data
;
1129 struct quatech_port
*qt_port
= qt_get_port_private(port
);
1130 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1133 dev_dbg(&port
->dev
, "%s cmd 0x%04x\n", __func__
, cmd
);
1135 index
= tty
->index
- serial
->minor
;
1137 if (cmd
== TIOCMIWAIT
) {
1138 while (qt_port
!= NULL
) {
1139 interruptible_sleep_on(&qt_port
->msr_wait
);
1140 if (signal_pending(current
))
1141 return -ERESTARTSYS
;
1143 char diff
= qt_port
->diff_status
;
1146 return -EIO
; /* no change => error */
1148 /* Consume all events */
1149 qt_port
->diff_status
= 0;
1151 if (((arg
& TIOCM_RNG
)
1152 && (diff
& SERIAL_MSR_RI
))
1153 || ((arg
& TIOCM_DSR
)
1154 && (diff
& SERIAL_MSR_DSR
))
1155 || ((arg
& TIOCM_CD
)
1156 && (diff
& SERIAL_MSR_CD
))
1157 || ((arg
& TIOCM_CTS
)
1158 && (diff
& SERIAL_MSR_CTS
))) {
1166 dev_dbg(&port
->dev
, "%s -No ioctl for that one. port = %d\n", __func__
, port
->number
);
1167 return -ENOIOCTLCMD
;
1170 static void qt_set_termios(struct tty_struct
*tty
,
1171 struct usb_serial_port
*port
,
1172 struct ktermios
*old_termios
)
1174 struct ktermios
*termios
= &tty
->termios
;
1175 unsigned char new_LCR
= 0;
1176 unsigned int cflag
= termios
->c_cflag
;
1178 int baud
, divisor
, remainder
;
1181 index
= tty
->index
- port
->serial
->minor
;
1183 switch (cflag
& CSIZE
) {
1185 new_LCR
|= SERIAL_5_DATA
;
1188 new_LCR
|= SERIAL_6_DATA
;
1191 new_LCR
|= SERIAL_7_DATA
;
1194 termios
->c_cflag
&= ~CSIZE
;
1195 termios
->c_cflag
|= CS8
;
1197 new_LCR
|= SERIAL_8_DATA
;
1202 if (cflag
& PARENB
) {
1204 new_LCR
|= SERIAL_ODD_PARITY
;
1206 new_LCR
|= SERIAL_EVEN_PARITY
;
1209 new_LCR
|= SERIAL_TWO_STOPB
;
1211 new_LCR
|= SERIAL_ONE_STOPB
;
1213 dev_dbg(&port
->dev
, "%s - 4\n", __func__
);
1215 /* Thats the LCR stuff, go ahead and set it */
1216 baud
= tty_get_baud_rate(tty
);
1218 /* pick a default, any default... */
1221 dev_dbg(&port
->dev
, "%s - got baud = %d\n", __func__
, baud
);
1223 divisor
= MAX_BAUD_RATE
/ baud
;
1224 remainder
= MAX_BAUD_RATE
% baud
;
1225 /* Round to nearest divisor */
1226 if (((remainder
* 2) >= baud
) && (baud
!= 110))
1230 * Set Baud rate to default and turn off (default)flow control here
1233 qt_setuart(port
->serial
, index
, (unsigned short)divisor
, new_LCR
);
1235 dev_dbg(&port
->dev
, "qt_setuart failed\n");
1239 /* Now determine flow control */
1240 if (cflag
& CRTSCTS
) {
1241 dev_dbg(&port
->dev
, "%s - Enabling HW flow control port %d\n", __func__
, port
->number
);
1243 /* Enable RTS/CTS flow control */
1244 status
= BoxSetHW_FlowCtrl(port
->serial
, index
, 1);
1247 dev_dbg(&port
->dev
, "BoxSetHW_FlowCtrl failed\n");
1251 /* Disable RTS/CTS flow control */
1252 dev_dbg(&port
->dev
, "%s - disabling HW flow control port %d\n", __func__
, port
->number
);
1254 status
= BoxSetHW_FlowCtrl(port
->serial
, index
, 0);
1256 dev_dbg(&port
->dev
, "BoxSetHW_FlowCtrl failed\n");
1262 /* if we are implementing XON/XOFF, set the start and stop character in
1264 if (I_IXOFF(tty
) || I_IXON(tty
)) {
1265 unsigned char stop_char
= STOP_CHAR(tty
);
1266 unsigned char start_char
= START_CHAR(tty
);
1268 BoxSetSW_FlowCtrl(port
->serial
, index
, stop_char
,
1271 dev_dbg(&port
->dev
, "BoxSetSW_FlowCtrl (enabled) failed\n");
1274 /* disable SW flow control */
1275 status
= BoxDisable_SW_FlowCtrl(port
->serial
, index
);
1277 dev_dbg(&port
->dev
, "BoxSetSW_FlowCtrl (diabling) failed\n");
1280 termios
->c_cflag
&= ~CMSPAR
;
1281 /* FIXME: Error cases should be returning the actual bits changed only */
1284 static void qt_break(struct tty_struct
*tty
, int break_state
)
1286 struct usb_serial_port
*port
= tty
->driver_data
;
1287 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1288 struct quatech_port
*qt_port
;
1290 unsigned int result
;
1292 index
= tty
->index
- serial
->minor
;
1294 qt_port
= qt_get_port_private(port
);
1296 if (break_state
== -1)
1301 mutex_lock(&qt_port
->lock
);
1304 usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
1305 QT_BREAK_CONTROL
, 0x40, onoff
, index
, NULL
, 0, 300);
1307 mutex_unlock(&qt_port
->lock
);
1310 static inline int qt_real_tiocmget(struct tty_struct
*tty
,
1311 struct usb_serial_port
*port
,
1312 struct usb_serial
*serial
)
1317 unsigned int result
= 0;
1321 index
= tty
->index
- serial
->minor
;
1323 BoxGetRegister(port
->serial
, index
, MODEM_CONTROL_REGISTER
, &mcr
);
1326 BoxGetRegister(port
->serial
, index
,
1327 MODEM_STATUS_REGISTER
, &msr
);
1332 result
= ((mcr
& SERIAL_MCR_DTR
) ? TIOCM_DTR
: 0)
1334 | ((mcr
& SERIAL_MCR_RTS
) ? TIOCM_RTS
: 0)
1336 | ((msr
& SERIAL_MSR_CTS
) ? TIOCM_CTS
: 0)
1338 | ((msr
& SERIAL_MSR_CD
) ? TIOCM_CAR
: 0)
1339 /* Carrier detect is set */
1340 | ((msr
& SERIAL_MSR_RI
) ? TIOCM_RI
: 0)
1341 /* Ring indicator set */
1342 | ((msr
& SERIAL_MSR_DSR
) ? TIOCM_DSR
: 0);
1350 static inline int qt_real_tiocmset(struct tty_struct
*tty
,
1351 struct usb_serial_port
*port
,
1352 struct usb_serial
*serial
,
1360 index
= tty
->index
- serial
->minor
;
1362 BoxGetRegister(port
->serial
, index
, MODEM_CONTROL_REGISTER
, &mcr
);
1367 * Turn off the RTS and DTR and loopback and then only turn on what was
1370 mcr
&= ~(SERIAL_MCR_RTS
| SERIAL_MCR_DTR
| SERIAL_MCR_LOOP
);
1371 if (value
& TIOCM_RTS
)
1372 mcr
|= SERIAL_MCR_RTS
;
1373 if (value
& TIOCM_DTR
)
1374 mcr
|= SERIAL_MCR_DTR
;
1375 if (value
& TIOCM_LOOP
)
1376 mcr
|= SERIAL_MCR_LOOP
;
1379 BoxSetRegister(port
->serial
, index
, MODEM_CONTROL_REGISTER
, mcr
);
1386 static int qt_tiocmget(struct tty_struct
*tty
)
1388 struct usb_serial_port
*port
= tty
->driver_data
;
1389 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1390 struct quatech_port
*qt_port
= qt_get_port_private(port
);
1396 mutex_lock(&qt_port
->lock
);
1397 retval
= qt_real_tiocmget(tty
, port
, serial
);
1398 mutex_unlock(&qt_port
->lock
);
1402 static int qt_tiocmset(struct tty_struct
*tty
,
1403 unsigned int set
, unsigned int clear
)
1406 struct usb_serial_port
*port
= tty
->driver_data
;
1407 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1408 struct quatech_port
*qt_port
= qt_get_port_private(port
);
1414 mutex_lock(&qt_port
->lock
);
1415 retval
= qt_real_tiocmset(tty
, port
, serial
, set
);
1416 mutex_unlock(&qt_port
->lock
);
1420 static void qt_throttle(struct tty_struct
*tty
)
1422 struct usb_serial_port
*port
= tty
->driver_data
;
1423 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1424 struct quatech_port
*qt_port
;
1429 qt_port
= qt_get_port_private(port
);
1431 mutex_lock(&qt_port
->lock
);
1433 /* pass on to the driver specific version of this function */
1434 qt_port
->RxHolding
= 1;
1436 mutex_unlock(&qt_port
->lock
);
1439 static void qt_unthrottle(struct tty_struct
*tty
)
1441 struct usb_serial_port
*port
= tty
->driver_data
;
1442 struct usb_serial
*serial
= get_usb_serial(port
, __func__
);
1443 struct quatech_port
*qt_port
;
1444 unsigned int result
;
1449 qt_port
= qt_get_port_private(port
);
1451 mutex_lock(&qt_port
->lock
);
1453 if (qt_port
->RxHolding
== 1) {
1454 dev_dbg(&port
->dev
, "%s -qt_port->RxHolding == 1\n", __func__
);
1456 qt_port
->RxHolding
= 0;
1457 dev_dbg(&port
->dev
, "%s - qt_port->RxHolding = 0\n", __func__
);
1459 /* if we have a bulk endpoint, start it up */
1460 if ((serial
->num_bulk_in
) && (qt_port
->ReadBulkStopped
== 1)) {
1461 /* Start reading from the device */
1462 usb_fill_bulk_urb(port
->read_urb
, serial
->dev
,
1463 usb_rcvbulkpipe(serial
->dev
,
1464 port
->bulk_in_endpointAddress
),
1465 port
->read_urb
->transfer_buffer
,
1467 transfer_buffer_length
,
1468 qt_read_bulk_callback
, port
);
1469 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
1472 "%s - failed restarting read urb, error %d\n",
1476 mutex_unlock(&qt_port
->lock
);
1479 static int qt_calc_num_ports(struct usb_serial
*serial
)
1484 (serial
->interface
->cur_altsetting
->desc
.bNumEndpoints
- 1) / 2;
1489 static struct usb_serial_driver quatech_device
= {
1491 .owner
= THIS_MODULE
,
1494 .description
= DRIVER_DESC
,
1495 .id_table
= id_table
,
1500 .write_room
= qt_write_room
,
1501 .chars_in_buffer
= qt_chars_in_buffer
,
1502 .throttle
= qt_throttle
,
1503 .unthrottle
= qt_unthrottle
,
1504 .calc_num_ports
= qt_calc_num_ports
,
1506 .set_termios
= qt_set_termios
,
1507 .break_ctl
= qt_break
,
1508 .tiocmget
= qt_tiocmget
,
1509 .tiocmset
= qt_tiocmset
,
1510 .attach
= qt_startup
,
1511 .release
= qt_release
,
1514 static struct usb_serial_driver
* const serial_drivers
[] = {
1515 &quatech_device
, NULL
1518 module_usb_serial_driver(serial_drivers
, id_table
);
1520 MODULE_AUTHOR(DRIVER_AUTHOR
);
1521 MODULE_DESCRIPTION(DRIVER_DESC
);
1522 MODULE_LICENSE("GPL");