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 */
44 #define QUATECH_SSU100_2 0xC120 /* SSU100_2 */
45 #define QUATECH_DSU100_2 0xC140 /* DSU100_2 */
46 #define QUATECH_DSU400_2 0xC150 /* DSU400_2 */
47 #define QUATECH_QSU100_2 0xC160 /* QSU100_2 */
48 #define QUATECH_QSU400_2 0xC170 /* QSU400_2 */
49 #define QUATECH_ESU400_2 0xC180 /* ESU400_2 */
50 #define QUATECH_ESU100_2 0xC1A0 /* ESU100_2 */
52 #define QT_SET_GET_DEVICE 0xc2
53 #define QT_OPEN_CLOSE_CHANNEL 0xca
54 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
55 #define QT_SET_ATF 0xcd
56 #define QT_GET_SET_REGISTER 0xc0
57 #define QT_GET_SET_UART 0xc1
58 #define QT_HW_FLOW_CONTROL_MASK 0xc5
59 #define QT_SW_FLOW_CONTROL_MASK 0xc6
60 #define QT_SW_FLOW_CONTROL_DISABLE 0xc7
61 #define QT_BREAK_CONTROL 0xc8
63 #define USBD_TRANSFER_DIRECTION_IN 0xc0
64 #define USBD_TRANSFER_DIRECTION_OUT 0x40
66 #define MAX_BAUD_RATE 460800
67 #define MAX_BAUD_REMAINDER 4608
69 #define DIV_LATCH_LS 0x00
70 #define XMT_HOLD_REGISTER 0x00
71 #define XVR_BUFFER_REGISTER 0x00
72 #define DIV_LATCH_MS 0x01
73 #define FIFO_CONTROL_REGISTER 0x02
74 #define LINE_CONTROL_REGISTER 0x03
75 #define MODEM_CONTROL_REGISTER 0x04
76 #define LINE_STATUS_REGISTER 0x05
77 #define MODEM_STATUS_REGISTER 0x06
79 #define SERIAL_MCR_DTR 0x01
80 #define SERIAL_MCR_RTS 0x02
81 #define SERIAL_MCR_LOOP 0x10
83 #define SERIAL_MSR_CTS 0x10
84 #define SERIAL_MSR_CD 0x80
85 #define SERIAL_MSR_RI 0x40
86 #define SERIAL_MSR_DSR 0x20
87 #define SERIAL_MSR_MASK 0xf0
89 #define SERIAL_8_DATA 0x03
90 #define SERIAL_7_DATA 0x02
91 #define SERIAL_6_DATA 0x01
92 #define SERIAL_5_DATA 0x00
94 #define SERIAL_ODD_PARITY 0X08
95 #define SERIAL_EVEN_PARITY 0X18
96 #define SERIAL_TWO_STOPB 0x04
97 #define SERIAL_ONE_STOPB 0x00
99 #define DEFAULT_DIVISOR 0x30 /* gives 9600 baud rate */
100 #define DEFAULT_LCR SERIAL_8_DATA /* 8, none , 1 */
102 #define FULLPWRBIT 0x00000080
103 #define NEXT_BOARD_POWER_BIT 0x00000004
105 #define SERIAL_LSR_OE 0x02
106 #define SERIAL_LSR_PE 0x04
107 #define SERIAL_LSR_FE 0x08
108 #define SERIAL_LSR_BI 0x10
110 #define SERIAL_MSR_CTS 0x10
111 #define SERIAL_MSR_CD 0x80
112 #define SERIAL_MSR_RI 0x40
113 #define SERIAL_MSR_DSR 0x20
114 #define SERIAL_MSR_MASK 0xf0
116 #define PREFUFF_LEVEL_CONSERVATIVE 128
117 #define ATC_DISABLED 0x0
119 #define RR_BITS 0x03 /* for clearing clock bits */
120 #define DUPMODE_BITS 0xc0
123 #define LOOPMODE_BITS 0x41 /* LOOP1 = b6, LOOP0 = b0 (PORT B) */
124 #define ALL_LOOPBACK 0x01
125 #define MODEM_CTRL 0x40
126 #define RS232_MODE 0x00
128 static const struct usb_device_id serqt_id_table[] = {
129 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU200)},
130 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU100)},
131 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU200)},
132 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU100)},
133 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU200)},
134 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100A)},
135 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100B)},
136 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU200A)},
137 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU200B)},
138 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100A)},
139 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100B)},
140 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100C)},
141 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100D)},
142 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200A)},
143 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200B)},
144 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200C)},
145 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200D)},
146 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100_2)},
147 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU100_2)},
148 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU400_2)},
149 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU100_2)},
150 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU400_2)},
151 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU400_2)},
152 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100_2)},
153 {} /* Terminating entry */
156 MODULE_DEVICE_TABLE(usb, serqt_id_table);
158 struct qt_get_device_data {
164 struct qt_open_channel_data {
169 struct quatech_port {
170 int port_num; /* number of the port */
171 struct urb *write_urb; /* write URB for this port */
172 struct urb *read_urb; /* read URB for this port */
175 __u8 shadowLCR; /* last LCR value received */
176 __u8 shadowMCR; /* last MCR value received */
177 __u8 shadowMSR; /* last MSR value received */
178 __u8 shadowLSR; /* last LSR value received */
181 /* Used for TIOCMIWAIT */
182 wait_queue_head_t msr_wait;
183 char prev_status, diff_status;
185 wait_queue_head_t wait;
187 struct async_icount icount;
189 struct usb_serial_port *port; /* owner of this object */
190 struct qt_get_device_data DeviceData;
198 static struct usb_driver serqt_usb_driver = {
199 .name = "quatech-usb-serial",
200 .id_table = serqt_id_table,
203 static int port_paranoia_check(struct usb_serial_port *port,
204 const char *function)
207 dbg("%s - port == NULL", function);
211 dbg("%s - port->serial == NULL\n", function);
218 static int serial_paranoia_check(struct usb_serial *serial,
219 const char *function)
222 dbg("%s - serial == NULL\n", function);
227 dbg("%s - serial->type == NULL!", function);
234 static inline struct quatech_port *qt_get_port_private(struct usb_serial_port
237 return (struct quatech_port *)usb_get_serial_port_data(port);
240 static inline void qt_set_port_private(struct usb_serial_port *port,
241 struct quatech_port *data)
243 usb_set_serial_port_data(port, (void *)data);
246 static struct usb_serial *get_usb_serial(struct usb_serial_port *port,
247 const char *function)
249 /* if no port was specified, or it fails a paranoia check */
251 port_paranoia_check(port, function) ||
252 serial_paranoia_check(port->serial, function)) {
254 * then say that we dont have a valid usb_serial thing,
255 * which will end up genrating -ENODEV return values
263 static void ProcessLineStatus(struct quatech_port *qt_port,
264 unsigned char line_status)
268 line_status & (SERIAL_LSR_OE | SERIAL_LSR_PE | SERIAL_LSR_FE |
273 static void ProcessModemStatus(struct quatech_port *qt_port,
274 unsigned char modem_status)
277 qt_port->shadowMSR = modem_status;
278 wake_up_interruptible(&qt_port->wait);
282 static void ProcessRxChar(struct tty_struct *tty, struct usb_serial_port *port,
285 struct urb *urb = port->read_urb;
286 if (urb->actual_length)
287 tty_insert_flip_char(tty, data, TTY_NORMAL);
290 static void qt_write_bulk_callback(struct urb *urb)
292 struct tty_struct *tty;
294 struct quatech_port *quatech_port;
296 status = urb->status;
299 dbg("nonzero write bulk status received:%d\n", status);
303 quatech_port = urb->context;
305 tty = tty_port_tty_get(&quatech_port->port->port);
312 static void qt_interrupt_callback(struct urb *urb)
317 static void qt_read_bulk_callback(struct urb *urb)
320 struct usb_serial_port *port = urb->context;
321 struct usb_serial *serial = get_usb_serial(port, __func__);
322 struct quatech_port *qt_port = qt_get_port_private(port);
324 struct tty_struct *tty;
326 unsigned int RxCount;
331 qt_port->ReadBulkStopped = 1;
332 dbg("%s - nonzero write bulk status received: %d\n",
333 __func__, urb->status);
337 tty = tty_port_tty_get(&port->port);
339 dbg("%s - bad tty pointer - exiting", __func__);
343 data = urb->transfer_buffer;
345 RxCount = urb->actual_length;
347 /* index = MINOR(port->tty->device) - serial->minor; */
348 index = tty->index - serial->minor;
350 dbg("%s - port->RxHolding = %d\n", __func__, qt_port->RxHolding);
352 if (port_paranoia_check(port, __func__) != 0) {
353 dbg("%s - port_paranoia_check, exiting\n", __func__);
354 qt_port->ReadBulkStopped = 1;
359 dbg("%s - bad serial pointer, exiting\n", __func__);
362 if (qt_port->closePending == 1) {
363 /* Were closing , stop reading */
364 dbg("%s - (qt_port->closepending == 1\n", __func__);
365 qt_port->ReadBulkStopped = 1;
370 * RxHolding is asserted by throttle, if we assert it, we're not
371 * receiving any more characters and let the box handle the flow
374 if (qt_port->RxHolding == 1) {
375 qt_port->ReadBulkStopped = 1;
380 qt_port->ReadBulkStopped = 1;
382 dbg("%s - nonzero read bulk status received: %d\n",
383 __func__, urb->status);
387 if (tty && RxCount) {
389 for (i = 0; i < RxCount; ++i) {
390 /* Look ahead code here */
391 if ((i <= (RxCount - 3)) && (data[i] == 0x1b)
392 && (data[i + 1] == 0x1b)) {
394 switch (data[i + 2]) {
396 /* line status change 4th byte must follow */
397 if (i > (RxCount - 4)) {
398 dbg("Illegal escape seuences in received data\n");
401 ProcessLineStatus(qt_port, data[i + 3]);
407 /* Modem status status change 4th byte must follow */
408 dbg("Modem status status.\n");
409 if (i > (RxCount - 4)) {
410 dbg("Illegal escape sequences in received data\n");
413 ProcessModemStatus(qt_port,
419 dbg("No status sequence.\n");
422 ProcessRxChar(tty, port, data[i]);
423 ProcessRxChar(tty, port, data[i + 1]);
432 if (tty && urb->actual_length)
433 tty_insert_flip_char(tty, data[i], TTY_NORMAL);
436 tty_flip_buffer_push(tty);
439 /* Continue trying to always read */
440 usb_fill_bulk_urb(port->read_urb, serial->dev,
441 usb_rcvbulkpipe(serial->dev,
442 port->bulk_in_endpointAddress),
443 port->read_urb->transfer_buffer,
444 port->read_urb->transfer_buffer_length,
445 qt_read_bulk_callback, port);
446 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
448 dbg("%s - failed resubmitting read urb, error %d",
451 if (tty && RxCount) {
452 tty_flip_buffer_push(tty);
453 tty_schedule_flip(tty);
457 schedule_work(&port->work);
464 * Issue a GET_DEVICE vendor-specific request on the default control pipe If
465 * successful, fills in the qt_get_device_data structure pointed to by
466 * device_data, otherwise return a negative error number of the problem.
469 static int qt_get_device(struct usb_serial *serial,
470 struct qt_get_device_data *device_data)
473 unsigned char *transfer_buffer;
476 kmalloc(sizeof(struct qt_get_device_data), GFP_KERNEL);
477 if (!transfer_buffer)
480 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
481 QT_SET_GET_DEVICE, 0xc0, 0, 0,
483 sizeof(struct qt_get_device_data), 300);
485 memcpy(device_data, transfer_buffer,
486 sizeof(struct qt_get_device_data));
487 kfree(transfer_buffer);
492 /****************************************************************************
493 * BoxSetPrebufferLevel
494 TELLS BOX WHEN TO ASSERT FLOW CONTROL
495 ****************************************************************************/
496 static int BoxSetPrebufferLevel(struct usb_serial *serial)
501 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
502 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
503 QT_GET_SET_PREBUF_TRIG_LVL, 0x40,
504 buffer_length, 0, NULL, 0, 300);
508 /****************************************************************************
510 TELLS BOX WHEN TO ASSERT automatic transmitter control
511 ****************************************************************************/
512 static int BoxSetATC(struct usb_serial *serial, __u16 n_Mode)
517 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
520 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
521 QT_SET_ATF, 0x40, n_Mode, 0, NULL, 0, 300);
528 * Issue a SET_DEVICE vendor-specific request on the default control pipe If
529 * successful returns the number of bytes written, otherwise it returns a
530 * negative error number of the problem.
532 static int qt_set_device(struct usb_serial *serial,
533 struct qt_get_device_data *device_data)
539 PortSettings = ((__u16) (device_data->portb));
540 PortSettings = (PortSettings << 8);
541 PortSettings += ((__u16) (device_data->porta));
543 length = sizeof(struct qt_get_device_data);
544 dbg("%s - PortSettings = 0x%x\n", __func__, PortSettings);
546 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
547 QT_SET_GET_DEVICE, 0x40, PortSettings,
552 static int qt_open_channel(struct usb_serial *serial, __u16 Uart_Number,
553 struct qt_open_channel_data *pDeviceData)
557 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
558 QT_OPEN_CLOSE_CHANNEL,
559 USBD_TRANSFER_DIRECTION_IN, 1, Uart_Number,
561 sizeof(struct qt_open_channel_data), 300);
567 static int qt_close_channel(struct usb_serial *serial, __u16 Uart_Number)
571 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
572 QT_OPEN_CLOSE_CHANNEL,
573 USBD_TRANSFER_DIRECTION_OUT, 0, Uart_Number,
580 /****************************************************************************
582 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
583 * If successful, fills in the pValue with the register value asked for
584 ****************************************************************************/
585 static int BoxGetRegister(struct usb_serial *serial, unsigned short Uart_Number,
586 unsigned short Register_Num, __u8 *pValue)
589 __u16 current_length;
591 current_length = sizeof(struct qt_get_device_data);
594 usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
595 QT_GET_SET_REGISTER, 0xC0, Register_Num,
596 Uart_Number, (void *)pValue, sizeof(*pValue), 300);
601 /****************************************************************************
603 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
604 * If successful, fills in the pValue with the register value asked for
605 ****************************************************************************/
606 static int BoxSetRegister(struct usb_serial *serial, unsigned short Uart_Number,
607 unsigned short Register_Num, unsigned short Value)
610 unsigned short RegAndByte;
613 RegAndByte = RegAndByte << 8;
614 RegAndByte = RegAndByte + Register_Num;
617 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
618 QT_GET_SET_REGISTER, 0xC0, Register_Num,
619 Uart_Number, NULL, 0, 300);
623 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
624 QT_GET_SET_REGISTER, 0x40, RegAndByte, Uart_Number,
632 * issuse a SET_UART vendor-spcific request on the default control pipe
633 * If successful sets baud rate divisor and LCR value
635 static int qt_setuart(struct usb_serial *serial, unsigned short Uart_Number,
636 unsigned short default_divisor, unsigned char default_LCR)
639 unsigned short UartNumandLCR;
641 UartNumandLCR = (default_LCR << 8) + Uart_Number;
644 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
645 QT_GET_SET_UART, 0x40, default_divisor,
646 UartNumandLCR, NULL, 0, 300);
651 static int BoxSetHW_FlowCtrl(struct usb_serial *serial, unsigned int index,
655 __u8 msr = 0, MOUT_Value = 0;
659 /* flow control, box will clear RTS line to prevent remote */
660 mcr = SERIAL_MCR_RTS;
661 } /* device from xmitting more chars */
663 /* no flow control to remote device */
667 MOUT_Value = mcr << 8;
670 /* flow control, box will inhibit xmit data if CTS line is
672 msr = SERIAL_MSR_CTS;
674 /* Box will not inhimbe xmit data due to CTS line */
680 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
681 QT_HW_FLOW_CONTROL_MASK, 0x40, MOUT_Value,
682 index, NULL, 0, 300);
687 static int BoxSetSW_FlowCtrl(struct usb_serial *serial, __u16 index,
688 unsigned char stop_char, unsigned char start_char)
693 nSWflowout = start_char << 8;
694 nSWflowout = (unsigned short)stop_char;
697 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
698 QT_SW_FLOW_CONTROL_MASK, 0x40, nSWflowout,
699 index, NULL, 0, 300);
704 static int BoxDisable_SW_FlowCtrl(struct usb_serial *serial, __u16 index)
709 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
710 QT_SW_FLOW_CONTROL_DISABLE, 0x40, 0, index,
716 static int qt_startup(struct usb_serial *serial)
718 struct usb_serial_port *port;
719 struct quatech_port *qt_port;
720 struct qt_get_device_data DeviceData;
724 /* Now setup per port private data */
725 for (i = 0; i < serial->num_ports; i++) {
726 port = serial->port[i];
727 qt_port = kzalloc(sizeof(*qt_port), GFP_KERNEL);
729 dbg("%s: kmalloc for quatech_port (%d) failed!.",
731 for (--i; i >= 0; i--) {
732 port = serial->port[i];
733 kfree(usb_get_serial_port_data(port));
734 usb_set_serial_port_data(port, NULL);
738 mutex_init(&qt_port->lock);
740 usb_set_serial_port_data(port, qt_port);
744 status = qt_get_device(serial, &DeviceData);
746 dbg(__FILE__ "box_get_device failed");
750 dbg(__FILE__ "DeviceData.portb = 0x%x", DeviceData.portb);
752 DeviceData.portb &= ~FULLPWRBIT;
753 dbg(__FILE__ "Changing DeviceData.portb to 0x%x", DeviceData.portb);
755 status = qt_set_device(serial, &DeviceData);
757 dbg(__FILE__ "qt_set_device failed\n");
761 status = qt_get_device(serial, &DeviceData);
763 dbg(__FILE__ "qt_get_device failed");
767 switch (serial->dev->descriptor.idProduct) {
770 case QUATECH_ESU100A:
771 case QUATECH_ESU100B:
772 case QUATECH_HSU100A:
773 case QUATECH_HSU100B:
774 case QUATECH_HSU100C:
775 case QUATECH_HSU100D:
776 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
777 DeviceData.porta |= CLKS_X4;
778 DeviceData.portb &= ~(LOOPMODE_BITS);
779 DeviceData.portb |= RS232_MODE;
785 case QUATECH_ESU200A:
786 case QUATECH_ESU200B:
787 case QUATECH_HSU200A:
788 case QUATECH_HSU200B:
789 case QUATECH_HSU200C:
790 case QUATECH_HSU200D:
791 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
792 DeviceData.porta |= CLKS_X4;
793 DeviceData.portb &= ~(LOOPMODE_BITS);
794 DeviceData.portb |= ALL_LOOPBACK;
797 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
798 DeviceData.porta |= CLKS_X4;
799 DeviceData.portb &= ~(LOOPMODE_BITS);
800 DeviceData.portb |= RS232_MODE;
805 status = BoxSetPrebufferLevel(serial); /* sets to default value */
807 dbg(__FILE__ "BoxSetPrebufferLevel failed\n");
811 status = BoxSetATC(serial, ATC_DISABLED);
813 dbg(__FILE__ "BoxSetATC failed\n");
817 dbg(__FILE__ "DeviceData.portb = 0x%x", DeviceData.portb);
819 DeviceData.portb |= NEXT_BOARD_POWER_BIT;
820 dbg(__FILE__ "Changing DeviceData.portb to 0x%x", DeviceData.portb);
822 status = qt_set_device(serial, &DeviceData);
824 dbg(__FILE__ "qt_set_device failed\n");
828 dbg("Exit Success %s\n", __func__);
833 for (i = 0; i < serial->num_ports; i++) {
834 port = serial->port[i];
835 qt_port = qt_get_port_private(port);
837 usb_set_serial_port_data(port, NULL);
840 dbg("Exit fail %s\n", __func__);
845 static void qt_release(struct usb_serial *serial)
847 struct usb_serial_port *port;
848 struct quatech_port *qt_port;
851 for (i = 0; i < serial->num_ports; i++) {
852 port = serial->port[i];
856 qt_port = usb_get_serial_port_data(port);
858 usb_set_serial_port_data(port, NULL);
863 static int qt_open(struct tty_struct *tty,
864 struct usb_serial_port *port)
866 struct usb_serial *serial;
867 struct quatech_port *quatech_port;
868 struct quatech_port *port0;
869 struct qt_open_channel_data ChannelData;
873 if (port_paranoia_check(port, __func__))
876 serial = port->serial;
878 if (serial_paranoia_check(serial, __func__))
881 quatech_port = qt_get_port_private(port);
882 port0 = qt_get_port_private(serial->port[0]);
884 if (quatech_port == NULL || port0 == NULL)
887 usb_clear_halt(serial->dev, port->write_urb->pipe);
888 usb_clear_halt(serial->dev, port->read_urb->pipe);
891 result = qt_get_device(serial, &port0->DeviceData);
893 /* Port specific setups */
894 result = qt_open_channel(serial, port->number, &ChannelData);
896 dbg(__FILE__ "qt_open_channel failed\n");
899 dbg(__FILE__ "qt_open_channel completed.\n");
901 /* FIXME: are these needed? Does it even do anything useful? */
902 quatech_port->shadowLSR = ChannelData.line_status &
903 (SERIAL_LSR_OE | SERIAL_LSR_PE | SERIAL_LSR_FE | SERIAL_LSR_BI);
905 quatech_port->shadowMSR = ChannelData.modem_status &
906 (SERIAL_MSR_CTS | SERIAL_MSR_DSR | SERIAL_MSR_RI | SERIAL_MSR_CD);
908 /* Set Baud rate to default and turn off (default)flow control here */
909 result = qt_setuart(serial, port->number, DEFAULT_DIVISOR, DEFAULT_LCR);
911 dbg(__FILE__ "qt_setuart failed\n");
914 dbg(__FILE__ "qt_setuart completed.\n");
917 * Put this here to make it responsive to stty and defaults set by
920 /* FIXME: is this needed? */
921 /* qt_set_termios(tty, port, NULL); */
923 /* Check to see if we've set up our endpoint info yet */
924 if (port0->open_ports == 1) {
925 if (serial->port[0]->interrupt_in_buffer == NULL) {
926 /* set up interrupt urb */
927 usb_fill_int_urb(serial->port[0]->interrupt_in_urb,
929 usb_rcvintpipe(serial->dev,
930 serial->port[0]->interrupt_in_endpointAddress),
931 serial->port[0]->interrupt_in_buffer,
933 interrupt_in_urb->transfer_buffer_length,
934 qt_interrupt_callback, serial,
936 interrupt_in_urb->interval);
939 usb_submit_urb(serial->port[0]->interrupt_in_urb,
943 "%s - Error %d submitting "
944 "interrupt urb\n", __func__, result);
951 dbg("port number is %d\n", port->number);
952 dbg("serial number is %d\n", port->serial->minor);
953 dbg("Bulkin endpoint is %d\n", port->bulk_in_endpointAddress);
954 dbg("BulkOut endpoint is %d\n", port->bulk_out_endpointAddress);
955 dbg("Interrupt endpoint is %d\n", port->interrupt_in_endpointAddress);
956 dbg("port's number in the device is %d\n", quatech_port->port_num);
957 quatech_port->read_urb = port->read_urb;
959 /* set up our bulk in urb */
961 usb_fill_bulk_urb(quatech_port->read_urb,
963 usb_rcvbulkpipe(serial->dev,
964 port->bulk_in_endpointAddress),
965 port->bulk_in_buffer,
966 quatech_port->read_urb->transfer_buffer_length,
967 qt_read_bulk_callback, quatech_port);
969 dbg("qt_open: bulkin endpoint is %d\n", port->bulk_in_endpointAddress);
970 quatech_port->read_urb_busy = true;
971 result = usb_submit_urb(quatech_port->read_urb, GFP_KERNEL);
974 "%s - Error %d submitting control urb\n",
976 quatech_port->read_urb_busy = false;
979 /* initialize our wait queues */
980 init_waitqueue_head(&quatech_port->wait);
981 init_waitqueue_head(&quatech_port->msr_wait);
983 /* initialize our icount structure */
984 memset(&(quatech_port->icount), 0x00, sizeof(quatech_port->icount));
990 static int qt_chars_in_buffer(struct tty_struct *tty)
992 struct usb_serial_port *port = tty->driver_data;
993 struct usb_serial *serial;
996 serial = get_usb_serial(port, __func__);
998 if (serial->num_bulk_out) {
999 if (port->write_urb->status == -EINPROGRESS)
1000 chars = port->write_urb->transfer_buffer_length;
1003 dbg("%s - returns %d\n", __func__, chars);
1008 static void qt_block_until_empty(struct tty_struct *tty,
1009 struct quatech_port *qt_port)
1011 int timeout = HZ / 10;
1017 count = qt_chars_in_buffer(tty);
1022 interruptible_sleep_on_timeout(&qt_port->wait, timeout);
1026 dbg("%s - TIMEOUT", __func__);
1034 static void qt_close(struct usb_serial_port *port)
1036 struct usb_serial *serial = port->serial;
1037 struct quatech_port *qt_port;
1038 struct quatech_port *port0;
1039 struct tty_struct *tty;
1044 tty = tty_port_tty_get(&port->port);
1045 index = tty->index - serial->minor;
1047 qt_port = qt_get_port_private(port);
1048 port0 = qt_get_port_private(serial->port[0]);
1050 /* shutdown any bulk reads that might be going on */
1051 if (serial->num_bulk_out)
1052 usb_unlink_urb(port->write_urb);
1053 if (serial->num_bulk_in)
1054 usb_unlink_urb(port->read_urb);
1056 /* wait up to for transmitter to empty */
1058 qt_block_until_empty(tty, qt_port);
1061 /* Close uart channel */
1062 status = qt_close_channel(serial, index);
1064 dbg("%s - port %d qt_close_channel failed.\n",
1065 __func__, port->number);
1067 port0->open_ports--;
1069 dbg("qt_num_open_ports in close%d:in port%d\n",
1070 port0->open_ports, port->number);
1072 if (port0->open_ports == 0) {
1073 if (serial->port[0]->interrupt_in_urb) {
1074 dbg("%s", "Shutdown interrupt_in_urb\n");
1075 usb_kill_urb(serial->port[0]->interrupt_in_urb);
1080 if (qt_port->write_urb) {
1081 /* if this urb had a transfer buffer already (old tx) free it */
1082 kfree(qt_port->write_urb->transfer_buffer);
1083 usb_free_urb(qt_port->write_urb);
1088 static int qt_write(struct tty_struct *tty, struct usb_serial_port *port,
1089 const unsigned char *buf, int count)
1092 struct usb_serial *serial = get_usb_serial(port, __func__);
1098 dbg("%s - write request of 0 bytes\n", __func__);
1102 /* only do something if we have a bulk out endpoint */
1103 if (serial->num_bulk_out) {
1104 if (port->write_urb->status == -EINPROGRESS) {
1105 dbg("%s - already writing\n", __func__);
1110 (count > port->bulk_out_size) ? port->bulk_out_size : count;
1111 memcpy(port->write_urb->transfer_buffer, buf, count);
1113 /* set up our urb */
1115 usb_fill_bulk_urb(port->write_urb, serial->dev,
1116 usb_sndbulkpipe(serial->dev,
1118 bulk_out_endpointAddress),
1119 port->write_urb->transfer_buffer, count,
1120 qt_write_bulk_callback, port);
1122 /* send the data out the bulk port */
1123 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1125 dbg("%s - failed submitting write urb, error %d\n",
1133 /* no bulk out, so return 0 bytes written */
1137 static int qt_write_room(struct tty_struct *tty)
1139 struct usb_serial_port *port = tty->driver_data;
1140 struct usb_serial *serial;
1141 struct quatech_port *qt_port;
1143 int retval = -EINVAL;
1145 if (port_paranoia_check(port, __func__)) {
1146 dbg("%s", "Invalid port\n");
1150 serial = get_usb_serial(port, __func__);
1155 qt_port = qt_get_port_private(port);
1157 mutex_lock(&qt_port->lock);
1159 if (serial->num_bulk_out) {
1160 if (port->write_urb->status != -EINPROGRESS)
1161 retval = port->bulk_out_size;
1164 mutex_unlock(&qt_port->lock);
1169 static int qt_ioctl(struct tty_struct *tty,
1170 unsigned int cmd, unsigned long arg)
1172 struct usb_serial_port *port = tty->driver_data;
1173 struct quatech_port *qt_port = qt_get_port_private(port);
1174 struct usb_serial *serial = get_usb_serial(port, __func__);
1177 dbg("%s cmd 0x%04x", __func__, cmd);
1179 index = tty->index - serial->minor;
1181 if (cmd == TIOCMIWAIT) {
1182 while (qt_port != NULL) {
1183 interruptible_sleep_on(&qt_port->msr_wait);
1184 if (signal_pending(current))
1185 return -ERESTARTSYS;
1187 char diff = qt_port->diff_status;
1190 return -EIO; /* no change => error */
1192 /* Consume all events */
1193 qt_port->diff_status = 0;
1195 if (((arg & TIOCM_RNG)
1196 && (diff & SERIAL_MSR_RI))
1197 || ((arg & TIOCM_DSR)
1198 && (diff & SERIAL_MSR_DSR))
1199 || ((arg & TIOCM_CD)
1200 && (diff & SERIAL_MSR_CD))
1201 || ((arg & TIOCM_CTS)
1202 && (diff & SERIAL_MSR_CTS))) {
1210 dbg("%s -No ioctl for that one. port = %d\n", __func__, port->number);
1211 return -ENOIOCTLCMD;
1214 static void qt_set_termios(struct tty_struct *tty,
1215 struct usb_serial_port *port,
1216 struct ktermios *old_termios)
1218 struct ktermios *termios = tty->termios;
1219 unsigned char new_LCR = 0;
1220 unsigned int cflag = termios->c_cflag;
1222 int baud, divisor, remainder;
1225 index = tty->index - port->serial->minor;
1229 new_LCR |= SERIAL_5_DATA;
1232 new_LCR |= SERIAL_6_DATA;
1235 new_LCR |= SERIAL_7_DATA;
1239 new_LCR |= SERIAL_8_DATA;
1244 if (cflag & PARENB) {
1246 new_LCR |= SERIAL_ODD_PARITY;
1248 new_LCR |= SERIAL_EVEN_PARITY;
1251 new_LCR |= SERIAL_TWO_STOPB;
1253 new_LCR |= SERIAL_ONE_STOPB;
1255 dbg("%s - 4\n", __func__);
1257 /* Thats the LCR stuff, go ahead and set it */
1258 baud = tty_get_baud_rate(tty);
1260 /* pick a default, any default... */
1263 dbg("%s - got baud = %d\n", __func__, baud);
1265 divisor = MAX_BAUD_RATE / baud;
1266 remainder = MAX_BAUD_RATE % baud;
1267 /* Round to nearest divisor */
1268 if (((remainder * 2) >= baud) && (baud != 110))
1272 * Set Baud rate to default and turn off (default)flow control here
1275 qt_setuart(port->serial, index, (unsigned short)divisor, new_LCR);
1277 dbg(__FILE__ "qt_setuart failed\n");
1281 /* Now determine flow control */
1282 if (cflag & CRTSCTS) {
1283 dbg("%s - Enabling HW flow control port %d\n", __func__,
1286 /* Enable RTS/CTS flow control */
1287 status = BoxSetHW_FlowCtrl(port->serial, index, 1);
1290 dbg(__FILE__ "BoxSetHW_FlowCtrl failed\n");
1294 /* Disable RTS/CTS flow control */
1295 dbg("%s - disabling HW flow control port %d\n", __func__,
1298 status = BoxSetHW_FlowCtrl(port->serial, index, 0);
1300 dbg(__FILE__ "BoxSetHW_FlowCtrl failed\n");
1306 /* if we are implementing XON/XOFF, set the start and stop character in
1308 if (I_IXOFF(tty) || I_IXON(tty)) {
1309 unsigned char stop_char = STOP_CHAR(tty);
1310 unsigned char start_char = START_CHAR(tty);
1312 BoxSetSW_FlowCtrl(port->serial, index, stop_char,
1315 dbg(__FILE__ "BoxSetSW_FlowCtrl (enabled) failed\n");
1318 /* disable SW flow control */
1319 status = BoxDisable_SW_FlowCtrl(port->serial, index);
1321 dbg(__FILE__ "BoxSetSW_FlowCtrl (diabling) failed\n");
1324 tty->termios->c_cflag &= ~CMSPAR;
1325 /* FIXME: Error cases should be returning the actual bits changed only */
1328 static void qt_break(struct tty_struct *tty, int break_state)
1330 struct usb_serial_port *port = tty->driver_data;
1331 struct usb_serial *serial = get_usb_serial(port, __func__);
1332 struct quatech_port *qt_port;
1334 unsigned int result;
1336 index = tty->index - serial->minor;
1338 qt_port = qt_get_port_private(port);
1340 if (break_state == -1)
1345 mutex_lock(&qt_port->lock);
1348 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
1349 QT_BREAK_CONTROL, 0x40, onoff, index, NULL, 0, 300);
1351 mutex_unlock(&qt_port->lock);
1354 static inline int qt_real_tiocmget(struct tty_struct *tty,
1355 struct usb_serial_port *port,
1356 struct usb_serial *serial)
1361 unsigned int result = 0;
1365 index = tty->index - serial->minor;
1367 BoxGetRegister(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1370 BoxGetRegister(port->serial, index,
1371 MODEM_STATUS_REGISTER, &msr);
1376 result = ((mcr & SERIAL_MCR_DTR) ? TIOCM_DTR : 0)
1378 | ((mcr & SERIAL_MCR_RTS) ? TIOCM_RTS : 0)
1380 | ((msr & SERIAL_MSR_CTS) ? TIOCM_CTS : 0)
1382 | ((msr & SERIAL_MSR_CD) ? TIOCM_CAR : 0)
1383 /* Carrier detect is set */
1384 | ((msr & SERIAL_MSR_RI) ? TIOCM_RI : 0)
1385 /* Ring indicator set */
1386 | ((msr & SERIAL_MSR_DSR) ? TIOCM_DSR : 0);
1394 static inline int qt_real_tiocmset(struct tty_struct *tty,
1395 struct usb_serial_port *port,
1396 struct usb_serial *serial,
1404 index = tty->index - serial->minor;
1406 BoxGetRegister(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1411 * Turn off the RTS and DTR and loopbcck and then only turn on what was
1414 mcr &= ~(SERIAL_MCR_RTS | SERIAL_MCR_DTR | SERIAL_MCR_LOOP);
1415 if (value & TIOCM_RTS)
1416 mcr |= SERIAL_MCR_RTS;
1417 if (value & TIOCM_DTR)
1418 mcr |= SERIAL_MCR_DTR;
1419 if (value & TIOCM_LOOP)
1420 mcr |= SERIAL_MCR_LOOP;
1423 BoxSetRegister(port->serial, index, MODEM_CONTROL_REGISTER, mcr);
1430 static int qt_tiocmget(struct tty_struct *tty)
1432 struct usb_serial_port *port = tty->driver_data;
1433 struct usb_serial *serial = get_usb_serial(port, __func__);
1434 struct quatech_port *qt_port = qt_get_port_private(port);
1435 int retval = -ENODEV;
1440 mutex_lock(&qt_port->lock);
1441 retval = qt_real_tiocmget(tty, port, serial);
1442 mutex_unlock(&qt_port->lock);
1446 static int qt_tiocmset(struct tty_struct *tty,
1447 unsigned int set, unsigned int clear)
1450 struct usb_serial_port *port = tty->driver_data;
1451 struct usb_serial *serial = get_usb_serial(port, __func__);
1452 struct quatech_port *qt_port = qt_get_port_private(port);
1453 int retval = -ENODEV;
1458 mutex_lock(&qt_port->lock);
1459 retval = qt_real_tiocmset(tty, port, serial, set);
1460 mutex_unlock(&qt_port->lock);
1464 static void qt_throttle(struct tty_struct *tty)
1466 struct usb_serial_port *port = tty->driver_data;
1467 struct usb_serial *serial = get_usb_serial(port, __func__);
1468 struct quatech_port *qt_port;
1473 qt_port = qt_get_port_private(port);
1475 mutex_lock(&qt_port->lock);
1477 /* pass on to the driver specific version of this function */
1478 qt_port->RxHolding = 1;
1480 mutex_unlock(&qt_port->lock);
1484 static void qt_unthrottle(struct tty_struct *tty)
1486 struct usb_serial_port *port = tty->driver_data;
1487 struct usb_serial *serial = get_usb_serial(port, __func__);
1488 struct quatech_port *qt_port;
1489 unsigned int result;
1494 qt_port = qt_get_port_private(port);
1496 mutex_lock(&qt_port->lock);
1498 if (qt_port->RxHolding == 1) {
1499 dbg("%s -qt_port->RxHolding == 1\n", __func__);
1501 qt_port->RxHolding = 0;
1502 dbg("%s - qt_port->RxHolding = 0\n", __func__);
1504 /* if we have a bulk endpoint, start it up */
1505 if ((serial->num_bulk_in) && (qt_port->ReadBulkStopped == 1)) {
1506 /* Start reading from the device */
1507 usb_fill_bulk_urb(port->read_urb, serial->dev,
1508 usb_rcvbulkpipe(serial->dev,
1509 port->bulk_in_endpointAddress),
1510 port->read_urb->transfer_buffer,
1512 transfer_buffer_length,
1513 qt_read_bulk_callback, port);
1514 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1517 "%s - failed restarting read urb, error %d\n",
1521 mutex_unlock(&qt_port->lock);
1526 static int qt_calc_num_ports(struct usb_serial *serial)
1530 dbg("numberofendpoints: %d\n",
1531 (int)serial->interface->cur_altsetting->desc.bNumEndpoints);
1532 dbg("numberofendpoints: %d\n",
1533 (int)serial->interface->altsetting->desc.bNumEndpoints);
1536 (serial->interface->cur_altsetting->desc.bNumEndpoints - 1) / 2;
1541 static struct usb_serial_driver quatech_device = {
1543 .owner = THIS_MODULE,
1546 .description = DRIVER_DESC,
1547 .id_table = serqt_id_table,
1552 .write_room = qt_write_room,
1553 .chars_in_buffer = qt_chars_in_buffer,
1554 .throttle = qt_throttle,
1555 .unthrottle = qt_unthrottle,
1556 .calc_num_ports = qt_calc_num_ports,
1558 .set_termios = qt_set_termios,
1559 .break_ctl = qt_break,
1560 .tiocmget = qt_tiocmget,
1561 .tiocmset = qt_tiocmset,
1562 .attach = qt_startup,
1563 .release = qt_release,
1566 static struct usb_serial_driver * const serial_drivers[] = {
1567 &quatech_device, NULL
1570 module_usb_serial_driver(serqt_usb_driver, serial_drivers);
1572 MODULE_AUTHOR(DRIVER_AUTHOR);
1573 MODULE_DESCRIPTION(DRIVER_DESC);
1574 MODULE_LICENSE("GPL");
1576 module_param(debug, bool, S_IRUGO | S_IWUSR);
1577 MODULE_PARM_DESC(debug, "Debug enabled or not");