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 usb_serial_port *port, unsigned char data)
260 struct urb *urb = port->read_urb;
261 if (urb->actual_length)
262 tty_insert_flip_char(&port->port, data, TTY_NORMAL);
265 static void qt_write_bulk_callback(struct urb *urb)
267 struct tty_struct *tty;
269 struct quatech_port *quatech_port;
271 status = urb->status;
274 dev_dbg(&urb->dev->dev,
275 "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_status_change_check(struct urb *urb,
294 struct quatech_port *qt_port,
295 struct usb_serial_port *port)
298 unsigned char *data = urb->transfer_buffer;
299 unsigned int RxCount = urb->actual_length;
301 for (i = 0; i < RxCount; ++i) {
302 /* Look ahead code here */
303 if ((i <= (RxCount - 3)) && (data[i] == 0x1b)
304 && (data[i + 1] == 0x1b)) {
306 switch (data[i + 2]) {
308 if (i > (RxCount - 4)) {
310 "Illegal escape seuences in received data\n");
314 ProcessLineStatus(qt_port, data[i + 3]);
321 if (i > (RxCount - 4)) {
323 "Illegal escape seuences in received data\n");
327 ProcessModemStatus(qt_port, data[i + 3]);
334 dev_dbg(&port->dev, "No status sequence.\n");
336 ProcessRxChar(port, data[i]);
337 ProcessRxChar(port, data[i + 1]);
346 if (urb->actual_length)
347 tty_insert_flip_char(&port->port, data[i], TTY_NORMAL);
350 tty_flip_buffer_push(&port->port);
353 static void qt_read_bulk_callback(struct urb *urb)
356 struct usb_serial_port *port = urb->context;
357 struct usb_serial *serial = get_usb_serial(port, __func__);
358 struct quatech_port *qt_port = qt_get_port_private(port);
362 qt_port->ReadBulkStopped = 1;
363 dev_dbg(&urb->dev->dev,
364 "%s - nonzero write bulk status received: %d\n",
365 __func__, urb->status);
370 "%s - port->RxHolding = %d\n", __func__, qt_port->RxHolding);
372 if (port_paranoia_check(port, __func__) != 0) {
373 qt_port->ReadBulkStopped = 1;
380 if (qt_port->closePending == 1) {
381 /* Were closing , stop reading */
383 "%s - (qt_port->closepending == 1\n", __func__);
384 qt_port->ReadBulkStopped = 1;
389 * RxHolding is asserted by throttle, if we assert it, we're not
390 * receiving any more characters and let the box handle the flow
393 if (qt_port->RxHolding == 1) {
394 qt_port->ReadBulkStopped = 1;
399 qt_port->ReadBulkStopped = 1;
402 "%s - nonzero read bulk status received: %d\n",
403 __func__, urb->status);
407 if (urb->actual_length)
408 qt_status_change_check(urb, qt_port, port);
410 /* Continue trying to always read */
411 usb_fill_bulk_urb(port->read_urb, serial->dev,
412 usb_rcvbulkpipe(serial->dev,
413 port->bulk_in_endpointAddress),
414 port->read_urb->transfer_buffer,
415 port->read_urb->transfer_buffer_length,
416 qt_read_bulk_callback, port);
417 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
420 "%s - failed resubmitting read urb, error %d",
423 if (urb->actual_length) {
424 tty_flip_buffer_push(&port->port);
425 tty_schedule_flip(&port->port);
429 schedule_work(&port->work);
434 * Issue a GET_DEVICE vendor-specific request on the default control pipe If
435 * successful, fills in the qt_get_device_data structure pointed to by
436 * device_data, otherwise return a negative error number of the problem.
439 static int qt_get_device(struct usb_serial *serial,
440 struct qt_get_device_data *device_data)
443 unsigned char *transfer_buffer;
446 kmalloc(sizeof(struct qt_get_device_data), GFP_KERNEL);
447 if (!transfer_buffer)
450 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
451 QT_SET_GET_DEVICE, 0xc0, 0, 0,
453 sizeof(struct qt_get_device_data), 300);
455 memcpy(device_data, transfer_buffer,
456 sizeof(struct qt_get_device_data));
457 kfree(transfer_buffer);
462 /****************************************************************************
463 * BoxSetPrebufferLevel
464 TELLS BOX WHEN TO ASSERT FLOW CONTROL
465 ****************************************************************************/
466 static int BoxSetPrebufferLevel(struct usb_serial *serial)
471 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
472 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
473 QT_GET_SET_PREBUF_TRIG_LVL, 0x40,
474 buffer_length, 0, NULL, 0, 300);
478 /****************************************************************************
480 TELLS BOX WHEN TO ASSERT automatic transmitter control
481 ****************************************************************************/
482 static int BoxSetATC(struct usb_serial *serial, __u16 n_Mode)
487 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
490 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
491 QT_SET_ATF, 0x40, n_Mode, 0, NULL, 0, 300);
498 * Issue a SET_DEVICE vendor-specific request on the default control pipe If
499 * successful returns the number of bytes written, otherwise it returns a
500 * negative error number of the problem.
502 static int qt_set_device(struct usb_serial *serial,
503 struct qt_get_device_data *device_data)
509 PortSettings = ((__u16) (device_data->portb));
510 PortSettings = (PortSettings << 8);
511 PortSettings += ((__u16) (device_data->porta));
513 length = sizeof(struct qt_get_device_data);
515 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
516 QT_SET_GET_DEVICE, 0x40, PortSettings,
521 static int qt_open_channel(struct usb_serial *serial, __u16 Uart_Number,
522 struct qt_open_channel_data *pDeviceData)
526 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
527 QT_OPEN_CLOSE_CHANNEL,
528 USBD_TRANSFER_DIRECTION_IN, 1, Uart_Number,
530 sizeof(struct qt_open_channel_data), 300);
536 static int qt_close_channel(struct usb_serial *serial, __u16 Uart_Number)
540 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
541 QT_OPEN_CLOSE_CHANNEL,
542 USBD_TRANSFER_DIRECTION_OUT, 0, Uart_Number,
549 /****************************************************************************
551 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
552 * If successful, fills in the pValue with the register value asked for
553 ****************************************************************************/
554 static int BoxGetRegister(struct usb_serial *serial, unsigned short Uart_Number,
555 unsigned short Register_Num, __u8 *pValue)
558 __u16 current_length;
560 current_length = sizeof(struct qt_get_device_data);
563 usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
564 QT_GET_SET_REGISTER, 0xC0, Register_Num,
565 Uart_Number, (void *)pValue, sizeof(*pValue), 300);
570 /****************************************************************************
572 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
573 * If successful, fills in the pValue with the register value asked for
574 ****************************************************************************/
575 static int BoxSetRegister(struct usb_serial *serial, unsigned short Uart_Number,
576 unsigned short Register_Num, unsigned short Value)
579 unsigned short RegAndByte;
582 RegAndByte = RegAndByte << 8;
583 RegAndByte = RegAndByte + Register_Num;
586 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
587 QT_GET_SET_REGISTER, 0xC0, Register_Num,
588 Uart_Number, NULL, 0, 300);
592 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
593 QT_GET_SET_REGISTER, 0x40, RegAndByte, Uart_Number,
601 * issues a SET_UART vendor-specific request on the default control pipe
602 * If successful sets baud rate divisor and LCR value
604 static int qt_setuart(struct usb_serial *serial, unsigned short Uart_Number,
605 unsigned short default_divisor, unsigned char default_LCR)
608 unsigned short UartNumandLCR;
610 UartNumandLCR = (default_LCR << 8) + Uart_Number;
613 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
614 QT_GET_SET_UART, 0x40, default_divisor,
615 UartNumandLCR, NULL, 0, 300);
620 static int BoxSetHW_FlowCtrl(struct usb_serial *serial, unsigned int index,
624 __u8 msr = 0, MOUT_Value = 0;
628 /* flow control, box will clear RTS line to prevent remote */
629 mcr = SERIAL_MCR_RTS;
630 } /* device from xmitting more chars */
632 /* no flow control to remote device */
636 MOUT_Value = mcr << 8;
639 /* flow control, box will inhibit xmit data if CTS line is
641 msr = SERIAL_MSR_CTS;
643 /* Box will not inhimbe xmit data due to CTS line */
649 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
650 QT_HW_FLOW_CONTROL_MASK, 0x40, MOUT_Value,
651 index, NULL, 0, 300);
656 static int BoxSetSW_FlowCtrl(struct usb_serial *serial, __u16 index,
657 unsigned char stop_char, unsigned char start_char)
662 nSWflowout = start_char << 8;
663 nSWflowout = (unsigned short)stop_char;
666 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
667 QT_SW_FLOW_CONTROL_MASK, 0x40, nSWflowout,
668 index, NULL, 0, 300);
673 static int BoxDisable_SW_FlowCtrl(struct usb_serial *serial, __u16 index)
678 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
679 QT_SW_FLOW_CONTROL_DISABLE, 0x40, 0, index,
685 static int qt_startup(struct usb_serial *serial)
687 struct device *dev = &serial->dev->dev;
688 struct usb_serial_port *port;
689 struct quatech_port *qt_port;
690 struct qt_get_device_data DeviceData;
694 /* Now setup per port private data */
695 for (i = 0; i < serial->num_ports; i++) {
696 port = serial->port[i];
697 qt_port = kzalloc(sizeof(*qt_port), GFP_KERNEL);
699 for (--i; i >= 0; i--) {
700 port = serial->port[i];
701 kfree(usb_get_serial_port_data(port));
702 usb_set_serial_port_data(port, NULL);
706 mutex_init(&qt_port->lock);
708 usb_set_serial_port_data(port, qt_port);
712 status = qt_get_device(serial, &DeviceData);
716 dev_dbg(dev, "DeviceData.portb = 0x%x\n", DeviceData.portb);
718 DeviceData.portb &= ~FULLPWRBIT;
719 dev_dbg(dev, "Changing DeviceData.portb to 0x%x\n", DeviceData.portb);
721 status = qt_set_device(serial, &DeviceData);
723 dev_dbg(dev, "qt_set_device failed\n");
727 status = qt_get_device(serial, &DeviceData);
729 dev_dbg(dev, "qt_get_device failed\n");
733 switch (serial->dev->descriptor.idProduct) {
736 case QUATECH_ESU100A:
737 case QUATECH_ESU100B:
738 case QUATECH_HSU100A:
739 case QUATECH_HSU100B:
740 case QUATECH_HSU100C:
741 case QUATECH_HSU100D:
742 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
743 DeviceData.porta |= CLKS_X4;
744 DeviceData.portb &= ~(LOOPMODE_BITS);
745 DeviceData.portb |= RS232_MODE;
751 case QUATECH_ESU200A:
752 case QUATECH_ESU200B:
753 case QUATECH_HSU200A:
754 case QUATECH_HSU200B:
755 case QUATECH_HSU200C:
756 case QUATECH_HSU200D:
757 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
758 DeviceData.porta |= CLKS_X4;
759 DeviceData.portb &= ~(LOOPMODE_BITS);
760 DeviceData.portb |= ALL_LOOPBACK;
763 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
764 DeviceData.porta |= CLKS_X4;
765 DeviceData.portb &= ~(LOOPMODE_BITS);
766 DeviceData.portb |= RS232_MODE;
771 status = BoxSetPrebufferLevel(serial); /* sets to default value */
773 dev_dbg(dev, "BoxSetPrebufferLevel failed\n");
777 status = BoxSetATC(serial, ATC_DISABLED);
779 dev_dbg(dev, "BoxSetATC failed\n");
783 dev_dbg(dev, "DeviceData.portb = 0x%x\n", DeviceData.portb);
785 DeviceData.portb |= NEXT_BOARD_POWER_BIT;
786 dev_dbg(dev, "Changing DeviceData.portb to 0x%x\n", DeviceData.portb);
788 status = qt_set_device(serial, &DeviceData);
790 dev_dbg(dev, "qt_set_device failed\n");
797 for (i = 0; i < serial->num_ports; i++) {
798 port = serial->port[i];
799 qt_port = qt_get_port_private(port);
801 usb_set_serial_port_data(port, NULL);
807 static void qt_release(struct usb_serial *serial)
809 struct usb_serial_port *port;
810 struct quatech_port *qt_port;
813 for (i = 0; i < serial->num_ports; i++) {
814 port = serial->port[i];
818 qt_port = usb_get_serial_port_data(port);
820 usb_set_serial_port_data(port, NULL);
825 static void qt_submit_urb_from_open(struct usb_serial *serial,
826 struct usb_serial_port *port)
829 struct usb_serial_port *port0 = serial->port[0];
831 /* set up interrupt urb */
832 usb_fill_int_urb(port0->interrupt_in_urb,
834 usb_rcvintpipe(serial->dev,
835 port0->interrupt_in_endpointAddress),
836 port0->interrupt_in_buffer,
837 port0->interrupt_in_urb->transfer_buffer_length,
838 qt_interrupt_callback, serial,
839 port0->interrupt_in_urb->interval);
841 result = usb_submit_urb(port0->interrupt_in_urb,
845 "%s - Error %d submitting interrupt urb\n",
850 static int qt_open(struct tty_struct *tty,
851 struct usb_serial_port *port)
853 struct usb_serial *serial;
854 struct quatech_port *quatech_port;
855 struct quatech_port *port0;
856 struct qt_open_channel_data ChannelData;
860 if (port_paranoia_check(port, __func__))
863 serial = port->serial;
865 if (serial_paranoia_check(serial, __func__))
868 quatech_port = qt_get_port_private(port);
869 port0 = qt_get_port_private(serial->port[0]);
871 if (quatech_port == NULL || port0 == NULL)
874 usb_clear_halt(serial->dev, port->write_urb->pipe);
875 usb_clear_halt(serial->dev, port->read_urb->pipe);
878 result = qt_get_device(serial, &port0->DeviceData);
880 /* Port specific setups */
881 result = qt_open_channel(serial, port->number, &ChannelData);
883 dev_dbg(&port->dev, "qt_open_channel failed\n");
886 dev_dbg(&port->dev, "qt_open_channel completed.\n");
888 /* FIXME: are these needed? Does it even do anything useful? */
889 quatech_port->shadowLSR = ChannelData.line_status &
890 (SERIAL_LSR_OE | SERIAL_LSR_PE | SERIAL_LSR_FE | SERIAL_LSR_BI);
892 quatech_port->shadowMSR = ChannelData.modem_status &
893 (SERIAL_MSR_CTS | SERIAL_MSR_DSR | SERIAL_MSR_RI | SERIAL_MSR_CD);
895 /* Set Baud rate to default and turn off (default)flow control here */
896 result = qt_setuart(serial, port->number, DEFAULT_DIVISOR, DEFAULT_LCR);
898 dev_dbg(&port->dev, "qt_setuart failed\n");
901 dev_dbg(&port->dev, "qt_setuart completed.\n");
904 * Put this here to make it responsive to stty and defaults set by
908 /* Check to see if we've set up our endpoint info yet */
909 if (port0->open_ports == 1) {
910 if (serial->port[0]->interrupt_in_buffer == NULL)
911 qt_submit_urb_from_open(serial, port);
914 dev_dbg(&port->dev, "port number is %d\n", port->number);
915 dev_dbg(&port->dev, "serial number is %d\n", port->serial->minor);
917 "Bulkin endpoint is %d\n", port->bulk_in_endpointAddress);
919 "BulkOut endpoint is %d\n", port->bulk_out_endpointAddress);
920 dev_dbg(&port->dev, "Interrupt endpoint is %d\n",
921 port->interrupt_in_endpointAddress);
922 dev_dbg(&port->dev, "port's number in the device is %d\n",
923 quatech_port->port_num);
924 quatech_port->read_urb = port->read_urb;
926 /* set up our bulk in urb */
928 usb_fill_bulk_urb(quatech_port->read_urb,
930 usb_rcvbulkpipe(serial->dev,
931 port->bulk_in_endpointAddress),
932 port->bulk_in_buffer,
933 quatech_port->read_urb->transfer_buffer_length,
934 qt_read_bulk_callback, quatech_port);
936 dev_dbg(&port->dev, "qt_open: bulkin endpoint is %d\n",
937 port->bulk_in_endpointAddress);
938 quatech_port->read_urb_busy = true;
939 result = usb_submit_urb(quatech_port->read_urb, GFP_KERNEL);
942 "%s - Error %d submitting control urb\n",
944 quatech_port->read_urb_busy = false;
947 /* initialize our wait queues */
948 init_waitqueue_head(&quatech_port->wait);
949 init_waitqueue_head(&quatech_port->msr_wait);
951 /* initialize our icount structure */
952 memset(&(quatech_port->icount), 0x00, sizeof(quatech_port->icount));
958 static int qt_chars_in_buffer(struct tty_struct *tty)
960 struct usb_serial_port *port = tty->driver_data;
961 struct usb_serial *serial;
964 serial = get_usb_serial(port, __func__);
966 if (serial->num_bulk_out) {
967 if (port->write_urb->status == -EINPROGRESS)
968 chars = port->write_urb->transfer_buffer_length;
974 static void qt_block_until_empty(struct tty_struct *tty,
975 struct quatech_port *qt_port)
977 int timeout = HZ / 10;
983 count = qt_chars_in_buffer(tty);
988 interruptible_sleep_on_timeout(&qt_port->wait, timeout);
992 dev_dbg(&qt_port->port->dev, "%s - TIMEOUT", __func__);
1000 static void qt_close(struct usb_serial_port *port)
1002 struct usb_serial *serial = port->serial;
1003 struct quatech_port *qt_port;
1004 struct quatech_port *port0;
1005 struct tty_struct *tty;
1010 tty = tty_port_tty_get(&port->port);
1011 index = tty->index - serial->minor;
1013 qt_port = qt_get_port_private(port);
1014 port0 = qt_get_port_private(serial->port[0]);
1016 /* shutdown any bulk reads that might be going on */
1017 if (serial->num_bulk_out)
1018 usb_unlink_urb(port->write_urb);
1019 if (serial->num_bulk_in)
1020 usb_unlink_urb(port->read_urb);
1022 /* wait up to for transmitter to empty */
1024 qt_block_until_empty(tty, qt_port);
1027 /* Close uart channel */
1028 status = qt_close_channel(serial, index);
1031 "%s - port %d qt_close_channel failed.\n",
1032 __func__, port->number);
1034 port0->open_ports--;
1036 dev_dbg(&port->dev, "qt_num_open_ports in close%d:in port%d\n",
1037 port0->open_ports, port->number);
1039 if (port0->open_ports == 0) {
1040 if (serial->port[0]->interrupt_in_urb) {
1041 dev_dbg(&port->dev, "Shutdown interrupt_in_urb\n");
1042 usb_kill_urb(serial->port[0]->interrupt_in_urb);
1047 if (qt_port->write_urb) {
1048 /* if this urb had a transfer buffer already (old tx) free it */
1049 kfree(qt_port->write_urb->transfer_buffer);
1050 usb_free_urb(qt_port->write_urb);
1055 static int qt_write(struct tty_struct *tty, struct usb_serial_port *port,
1056 const unsigned char *buf, int count)
1059 struct usb_serial *serial = get_usb_serial(port, __func__);
1066 "%s - write request of 0 bytes\n", __func__);
1070 /* only do something if we have a bulk out endpoint */
1071 if (serial->num_bulk_out) {
1072 if (port->write_urb->status == -EINPROGRESS) {
1073 dev_dbg(&port->dev, "%s - already writing\n", __func__);
1078 (count > port->bulk_out_size) ? port->bulk_out_size : count;
1079 memcpy(port->write_urb->transfer_buffer, buf, count);
1081 /* set up our urb */
1083 usb_fill_bulk_urb(port->write_urb, serial->dev,
1084 usb_sndbulkpipe(serial->dev,
1086 bulk_out_endpointAddress),
1087 port->write_urb->transfer_buffer, count,
1088 qt_write_bulk_callback, port);
1090 /* send the data out the bulk port */
1091 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1094 "%s - failed submitting write urb, error %d\n",
1102 /* no bulk out, so return 0 bytes written */
1106 static int qt_write_room(struct tty_struct *tty)
1108 struct usb_serial_port *port = tty->driver_data;
1109 struct usb_serial *serial;
1110 struct quatech_port *qt_port;
1112 int retval = -EINVAL;
1114 if (port_paranoia_check(port, __func__))
1117 serial = get_usb_serial(port, __func__);
1122 qt_port = qt_get_port_private(port);
1124 mutex_lock(&qt_port->lock);
1126 if (serial->num_bulk_out) {
1127 if (port->write_urb->status != -EINPROGRESS)
1128 retval = port->bulk_out_size;
1131 mutex_unlock(&qt_port->lock);
1136 static int qt_ioctl(struct tty_struct *tty,
1137 unsigned int cmd, unsigned long arg)
1139 struct usb_serial_port *port = tty->driver_data;
1140 struct quatech_port *qt_port = qt_get_port_private(port);
1141 struct usb_serial *serial = get_usb_serial(port, __func__);
1144 dev_dbg(&port->dev, "%s cmd 0x%04x\n", __func__, cmd);
1146 index = tty->index - serial->minor;
1148 if (cmd == TIOCMIWAIT) {
1149 while (qt_port != NULL) {
1150 interruptible_sleep_on(&qt_port->msr_wait);
1151 if (signal_pending(current))
1152 return -ERESTARTSYS;
1154 char diff = qt_port->diff_status;
1157 return -EIO; /* no change => error */
1159 /* Consume all events */
1160 qt_port->diff_status = 0;
1162 if (((arg & TIOCM_RNG)
1163 && (diff & SERIAL_MSR_RI))
1164 || ((arg & TIOCM_DSR)
1165 && (diff & SERIAL_MSR_DSR))
1166 || ((arg & TIOCM_CD)
1167 && (diff & SERIAL_MSR_CD))
1168 || ((arg & TIOCM_CTS)
1169 && (diff & SERIAL_MSR_CTS))) {
1177 dev_dbg(&port->dev, "%s -No ioctl for that one. port = %d\n",
1178 __func__, port->number);
1179 return -ENOIOCTLCMD;
1182 static void qt_set_termios(struct tty_struct *tty,
1183 struct usb_serial_port *port,
1184 struct ktermios *old_termios)
1186 struct ktermios *termios = &tty->termios;
1187 unsigned char new_LCR = 0;
1188 unsigned int cflag = termios->c_cflag;
1190 int baud, divisor, remainder;
1193 index = tty->index - port->serial->minor;
1195 switch (cflag & CSIZE) {
1197 new_LCR |= SERIAL_5_DATA;
1200 new_LCR |= SERIAL_6_DATA;
1203 new_LCR |= SERIAL_7_DATA;
1206 termios->c_cflag &= ~CSIZE;
1207 termios->c_cflag |= CS8;
1209 new_LCR |= SERIAL_8_DATA;
1214 if (cflag & PARENB) {
1216 new_LCR |= SERIAL_ODD_PARITY;
1218 new_LCR |= SERIAL_EVEN_PARITY;
1221 new_LCR |= SERIAL_TWO_STOPB;
1223 new_LCR |= SERIAL_ONE_STOPB;
1225 dev_dbg(&port->dev, "%s - 4\n", __func__);
1227 /* Thats the LCR stuff, go ahead and set it */
1228 baud = tty_get_baud_rate(tty);
1230 /* pick a default, any default... */
1233 dev_dbg(&port->dev, "%s - got baud = %d\n", __func__, baud);
1235 divisor = MAX_BAUD_RATE / baud;
1236 remainder = MAX_BAUD_RATE % baud;
1237 /* Round to nearest divisor */
1238 if (((remainder * 2) >= baud) && (baud != 110))
1242 * Set Baud rate to default and turn off (default)flow control here
1245 qt_setuart(port->serial, index, (unsigned short)divisor, new_LCR);
1247 dev_dbg(&port->dev, "qt_setuart failed\n");
1251 /* Now determine flow control */
1252 if (cflag & CRTSCTS) {
1253 dev_dbg(&port->dev, "%s - Enabling HW flow control port %d\n",
1254 __func__, port->number);
1256 /* Enable RTS/CTS flow control */
1257 status = BoxSetHW_FlowCtrl(port->serial, index, 1);
1260 dev_dbg(&port->dev, "BoxSetHW_FlowCtrl failed\n");
1264 /* Disable RTS/CTS flow control */
1266 "%s - disabling HW flow control port %d\n",
1267 __func__, port->number);
1269 status = BoxSetHW_FlowCtrl(port->serial, index, 0);
1271 dev_dbg(&port->dev, "BoxSetHW_FlowCtrl failed\n");
1277 /* if we are implementing XON/XOFF, set the start and stop character in
1279 if (I_IXOFF(tty) || I_IXON(tty)) {
1280 unsigned char stop_char = STOP_CHAR(tty);
1281 unsigned char start_char = START_CHAR(tty);
1283 BoxSetSW_FlowCtrl(port->serial, index, stop_char,
1287 "BoxSetSW_FlowCtrl (enabled) failed\n");
1290 /* disable SW flow control */
1291 status = BoxDisable_SW_FlowCtrl(port->serial, index);
1294 "BoxSetSW_FlowCtrl (diabling) failed\n");
1297 termios->c_cflag &= ~CMSPAR;
1299 Error cases should be returning the actual bits changed only
1303 static void qt_break(struct tty_struct *tty, int break_state)
1305 struct usb_serial_port *port = tty->driver_data;
1306 struct usb_serial *serial = get_usb_serial(port, __func__);
1307 struct quatech_port *qt_port;
1309 unsigned int result;
1311 index = tty->index - serial->minor;
1313 qt_port = qt_get_port_private(port);
1315 if (break_state == -1)
1320 mutex_lock(&qt_port->lock);
1323 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
1324 QT_BREAK_CONTROL, 0x40, onoff, index, NULL, 0, 300);
1326 mutex_unlock(&qt_port->lock);
1329 static inline int qt_real_tiocmget(struct tty_struct *tty,
1330 struct usb_serial_port *port,
1331 struct usb_serial *serial)
1336 unsigned int result = 0;
1340 index = tty->index - serial->minor;
1342 BoxGetRegister(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1345 BoxGetRegister(port->serial, index,
1346 MODEM_STATUS_REGISTER, &msr);
1351 result = ((mcr & SERIAL_MCR_DTR) ? TIOCM_DTR : 0)
1353 | ((mcr & SERIAL_MCR_RTS) ? TIOCM_RTS : 0)
1355 | ((msr & SERIAL_MSR_CTS) ? TIOCM_CTS : 0)
1357 | ((msr & SERIAL_MSR_CD) ? TIOCM_CAR : 0)
1358 /* Carrier detect is set */
1359 | ((msr & SERIAL_MSR_RI) ? TIOCM_RI : 0)
1360 /* Ring indicator set */
1361 | ((msr & SERIAL_MSR_DSR) ? TIOCM_DSR : 0);
1369 static inline int qt_real_tiocmset(struct tty_struct *tty,
1370 struct usb_serial_port *port,
1371 struct usb_serial *serial,
1379 index = tty->index - serial->minor;
1381 BoxGetRegister(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1386 * Turn off the RTS and DTR and loopback and then only turn on what was
1389 mcr &= ~(SERIAL_MCR_RTS | SERIAL_MCR_DTR | SERIAL_MCR_LOOP);
1390 if (value & TIOCM_RTS)
1391 mcr |= SERIAL_MCR_RTS;
1392 if (value & TIOCM_DTR)
1393 mcr |= SERIAL_MCR_DTR;
1394 if (value & TIOCM_LOOP)
1395 mcr |= SERIAL_MCR_LOOP;
1398 BoxSetRegister(port->serial, index, MODEM_CONTROL_REGISTER, mcr);
1405 static int qt_tiocmget(struct tty_struct *tty)
1407 struct usb_serial_port *port = tty->driver_data;
1408 struct usb_serial *serial = get_usb_serial(port, __func__);
1409 struct quatech_port *qt_port = qt_get_port_private(port);
1415 mutex_lock(&qt_port->lock);
1416 retval = qt_real_tiocmget(tty, port, serial);
1417 mutex_unlock(&qt_port->lock);
1421 static int qt_tiocmset(struct tty_struct *tty,
1422 unsigned int set, unsigned int clear)
1425 struct usb_serial_port *port = tty->driver_data;
1426 struct usb_serial *serial = get_usb_serial(port, __func__);
1427 struct quatech_port *qt_port = qt_get_port_private(port);
1433 mutex_lock(&qt_port->lock);
1434 retval = qt_real_tiocmset(tty, port, serial, set);
1435 mutex_unlock(&qt_port->lock);
1439 static void qt_throttle(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;
1448 qt_port = qt_get_port_private(port);
1450 mutex_lock(&qt_port->lock);
1452 /* pass on to the driver specific version of this function */
1453 qt_port->RxHolding = 1;
1455 mutex_unlock(&qt_port->lock);
1458 static void qt_submit_urb_from_unthrottle(struct usb_serial_port *port,
1459 struct usb_serial *serial)
1463 /* Start reading from the device */
1464 usb_fill_bulk_urb(port->read_urb, serial->dev,
1465 usb_rcvbulkpipe(serial->dev,
1466 port->bulk_in_endpointAddress),
1467 port->read_urb->transfer_buffer,
1468 port->read_urb->transfer_buffer_length,
1469 qt_read_bulk_callback, port);
1471 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1475 "%s - failed restarting read urb, error %d\n",
1479 static void qt_unthrottle(struct tty_struct *tty)
1481 struct usb_serial_port *port = tty->driver_data;
1482 struct usb_serial *serial = get_usb_serial(port, __func__);
1483 struct quatech_port *qt_port;
1488 qt_port = qt_get_port_private(port);
1490 mutex_lock(&qt_port->lock);
1492 if (qt_port->RxHolding == 1) {
1493 dev_dbg(&port->dev, "%s -qt_port->RxHolding == 1\n", __func__);
1495 qt_port->RxHolding = 0;
1496 dev_dbg(&port->dev, "%s - qt_port->RxHolding = 0\n", __func__);
1498 /* if we have a bulk endpoint, start it up */
1499 if ((serial->num_bulk_in) && (qt_port->ReadBulkStopped == 1))
1500 qt_submit_urb_from_unthrottle(port, serial);
1502 mutex_unlock(&qt_port->lock);
1505 static int qt_calc_num_ports(struct usb_serial *serial)
1510 (serial->interface->cur_altsetting->desc.bNumEndpoints - 1) / 2;
1515 static struct usb_serial_driver quatech_device = {
1517 .owner = THIS_MODULE,
1520 .description = DRIVER_DESC,
1521 .id_table = id_table,
1526 .write_room = qt_write_room,
1527 .chars_in_buffer = qt_chars_in_buffer,
1528 .throttle = qt_throttle,
1529 .unthrottle = qt_unthrottle,
1530 .calc_num_ports = qt_calc_num_ports,
1532 .set_termios = qt_set_termios,
1533 .break_ctl = qt_break,
1534 .tiocmget = qt_tiocmget,
1535 .tiocmset = qt_tiocmset,
1536 .attach = qt_startup,
1537 .release = qt_release,
1540 static struct usb_serial_driver * const serial_drivers[] = {
1541 &quatech_device, NULL
1544 module_usb_serial_driver(serial_drivers, id_table);
1546 MODULE_AUTHOR(DRIVER_AUTHOR);
1547 MODULE_DESCRIPTION(DRIVER_DESC);
1548 MODULE_LICENSE("GPL");