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/slab.h>
10 #include <linux/tty_driver.h>
11 #include <linux/tty_flip.h>
12 #include <linux/module.h>
13 #include <linux/serial.h>
14 #include <linux/usb.h>
15 #include <linux/usb/serial.h>
16 #include <linux/uaccess.h>
18 /* Version Information */
19 #define DRIVER_VERSION "v2.14"
20 #define DRIVER_AUTHOR "Tim Gobeli, Quatech, Inc"
21 #define DRIVER_DESC "Quatech USB to Serial Driver"
23 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
24 #define QUATECH_SSU200 0xC030 /* SSU200 */
25 #define QUATECH_DSU100 0xC040 /* DSU100 */
26 #define QUATECH_DSU200 0xC050 /* DSU200 */
27 #define QUATECH_QSU100 0xC060 /* QSU100 */
28 #define QUATECH_QSU200 0xC070 /* QSU200 */
29 #define QUATECH_ESU100A 0xC080 /* ESU100A */
30 #define QUATECH_ESU100B 0xC081 /* ESU100B */
31 #define QUATECH_ESU200A 0xC0A0 /* ESU200A */
32 #define QUATECH_ESU200B 0xC0A1 /* ESU200B */
33 #define QUATECH_HSU100A 0xC090 /* HSU100A */
34 #define QUATECH_HSU100B 0xC091 /* HSU100B */
35 #define QUATECH_HSU100C 0xC092 /* HSU100C */
36 #define QUATECH_HSU100D 0xC093 /* HSU100D */
37 #define QUATECH_HSU200A 0xC0B0 /* HSU200A */
38 #define QUATECH_HSU200B 0xC0B1 /* HSU200B */
39 #define QUATECH_HSU200C 0xC0B2 /* HSU200C */
40 #define QUATECH_HSU200D 0xC0B3 /* HSU200D */
42 #define QT_SET_GET_DEVICE 0xc2
43 #define QT_OPEN_CLOSE_CHANNEL 0xca
44 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
45 #define QT_SET_ATF 0xcd
46 #define QT_GET_SET_REGISTER 0xc0
47 #define QT_GET_SET_UART 0xc1
48 #define QT_HW_FLOW_CONTROL_MASK 0xc5
49 #define QT_SW_FLOW_CONTROL_MASK 0xc6
50 #define QT_SW_FLOW_CONTROL_DISABLE 0xc7
51 #define QT_BREAK_CONTROL 0xc8
53 #define USBD_TRANSFER_DIRECTION_IN 0xc0
54 #define USBD_TRANSFER_DIRECTION_OUT 0x40
56 #define MAX_BAUD_RATE 460800
57 #define MAX_BAUD_REMAINDER 4608
59 #define DIV_LATCH_LS 0x00
60 #define XMT_HOLD_REGISTER 0x00
61 #define XVR_BUFFER_REGISTER 0x00
62 #define DIV_LATCH_MS 0x01
63 #define FIFO_CONTROL_REGISTER 0x02
64 #define LINE_CONTROL_REGISTER 0x03
65 #define MODEM_CONTROL_REGISTER 0x04
66 #define LINE_STATUS_REGISTER 0x05
67 #define MODEM_STATUS_REGISTER 0x06
69 #define SERIAL_MCR_DTR 0x01
70 #define SERIAL_MCR_RTS 0x02
71 #define SERIAL_MCR_LOOP 0x10
73 #define SERIAL_MSR_CTS 0x10
74 #define SERIAL_MSR_CD 0x80
75 #define SERIAL_MSR_RI 0x40
76 #define SERIAL_MSR_DSR 0x20
77 #define SERIAL_MSR_MASK 0xf0
79 #define SERIAL_8_DATA 0x03
80 #define SERIAL_7_DATA 0x02
81 #define SERIAL_6_DATA 0x01
82 #define SERIAL_5_DATA 0x00
84 #define SERIAL_ODD_PARITY 0X08
85 #define SERIAL_EVEN_PARITY 0X18
86 #define SERIAL_TWO_STOPB 0x04
87 #define SERIAL_ONE_STOPB 0x00
89 #define DEFAULT_DIVISOR 0x30 /* gives 9600 baud rate */
90 #define DEFAULT_LCR SERIAL_8_DATA /* 8, none , 1 */
92 #define FULLPWRBIT 0x00000080
93 #define NEXT_BOARD_POWER_BIT 0x00000004
95 #define SERIAL_LSR_OE 0x02
96 #define SERIAL_LSR_PE 0x04
97 #define SERIAL_LSR_FE 0x08
98 #define SERIAL_LSR_BI 0x10
100 #define SERIAL_MSR_CTS 0x10
101 #define SERIAL_MSR_CD 0x80
102 #define SERIAL_MSR_RI 0x40
103 #define SERIAL_MSR_DSR 0x20
104 #define SERIAL_MSR_MASK 0xf0
106 #define PREFUFF_LEVEL_CONSERVATIVE 128
107 #define ATC_DISABLED 0x0
109 #define RR_BITS 0x03 /* for clearing clock bits */
110 #define DUPMODE_BITS 0xc0
113 #define LOOPMODE_BITS 0x41 /* LOOP1 = b6, LOOP0 = b0 (PORT B) */
114 #define ALL_LOOPBACK 0x01
115 #define MODEM_CTRL 0x40
116 #define RS232_MODE 0x00
118 static const struct usb_device_id id_table[] = {
119 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU200)},
120 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU100)},
121 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU200)},
122 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU100)},
123 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU200)},
124 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100A)},
125 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100B)},
126 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU200A)},
127 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU200B)},
128 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100A)},
129 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100B)},
130 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100C)},
131 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100D)},
132 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200A)},
133 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200B)},
134 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200C)},
135 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200D)},
136 {} /* Terminating entry */
138 MODULE_DEVICE_TABLE(usb, id_table);
140 struct qt_get_device_data {
146 struct qt_open_channel_data {
151 struct quatech_port {
152 int port_num; /* number of the port */
153 struct urb *write_urb; /* write URB for this port */
154 struct urb *read_urb; /* read URB for this port */
157 __u8 shadow_lcr; /* last LCR value received */
158 __u8 shadow_mcr; /* last MCR value received */
159 __u8 shadow_msr; /* last MSR value received */
160 __u8 shadow_lsr; /* last LSR value received */
163 /* Used for TIOCMIWAIT */
164 wait_queue_head_t msr_wait;
165 char prev_status, diff_status;
167 wait_queue_head_t wait;
169 struct async_icount icount;
171 struct usb_serial_port *port; /* owner of this object */
172 struct qt_get_device_data device_data;
176 int read_bulk_stopped;
180 static int port_paranoia_check(struct usb_serial_port *port,
181 const char *function)
184 pr_debug("%s - port == NULL", function);
188 pr_debug("%s - port->serial == NULL\n", function);
195 static int serial_paranoia_check(struct usb_serial *serial,
196 const char *function)
199 pr_debug("%s - serial == NULL\n", function);
204 pr_debug("%s - serial->type == NULL!", function);
211 static inline struct quatech_port *qt_get_port_private(struct usb_serial_port
214 return (struct quatech_port *)usb_get_serial_port_data(port);
217 static inline void qt_set_port_private(struct usb_serial_port *port,
218 struct quatech_port *data)
220 usb_set_serial_port_data(port, (void *)data);
223 static struct usb_serial *get_usb_serial(struct usb_serial_port *port,
224 const char *function)
226 /* if no port was specified, or it fails a paranoia check */
228 port_paranoia_check(port, function) ||
229 serial_paranoia_check(port->serial, function)) {
231 * then say that we dont have a valid usb_serial thing,
232 * which will end up genrating -ENODEV return values
240 static void process_line_status(struct quatech_port *qt_port,
241 unsigned char line_status)
244 qt_port->shadow_lsr =
245 line_status & (SERIAL_LSR_OE | SERIAL_LSR_PE | SERIAL_LSR_FE |
249 static void process_modem_status(struct quatech_port *qt_port,
250 unsigned char modem_status)
253 qt_port->shadow_msr = modem_status;
254 wake_up_interruptible(&qt_port->wait);
257 static void process_rx_char(struct usb_serial_port *port, unsigned char data)
259 struct urb *urb = port->read_urb;
260 if (urb->actual_length)
261 tty_insert_flip_char(&port->port, data, TTY_NORMAL);
264 static void qt_write_bulk_callback(struct urb *urb)
267 struct quatech_port *quatech_port;
269 status = urb->status;
272 dev_dbg(&urb->dev->dev,
273 "nonzero write bulk status received:%d\n", status);
277 quatech_port = urb->context;
279 tty_port_tty_wakeup(&quatech_port->port->port);
282 static void qt_interrupt_callback(struct urb *urb)
287 static void qt_status_change_check(struct urb *urb,
288 struct quatech_port *qt_port,
289 struct usb_serial_port *port)
292 unsigned char *data = urb->transfer_buffer;
293 unsigned int rx_count = urb->actual_length;
295 for (i = 0; i < rx_count; ++i) {
296 /* Look ahead code here */
297 if ((i <= (rx_count - 3)) && (data[i] == 0x1b)
298 && (data[i + 1] == 0x1b)) {
300 switch (data[i + 2]) {
302 if (i > (rx_count - 4)) {
304 "Illegal escape seuences in received data\n");
308 process_line_status(qt_port, data[i + 3]);
315 if (i > (rx_count - 4)) {
317 "Illegal escape seuences in received data\n");
321 process_modem_status(qt_port, data[i + 3]);
328 dev_dbg(&port->dev, "No status sequence.\n");
330 process_rx_char(port, data[i]);
331 process_rx_char(port, data[i + 1]);
340 if (urb->actual_length)
341 tty_insert_flip_char(&port->port, data[i], TTY_NORMAL);
344 tty_flip_buffer_push(&port->port);
347 static void qt_read_bulk_callback(struct urb *urb)
350 struct usb_serial_port *port = urb->context;
351 struct usb_serial *serial = get_usb_serial(port, __func__);
352 struct quatech_port *qt_port = qt_get_port_private(port);
356 qt_port->read_bulk_stopped = 1;
357 dev_dbg(&urb->dev->dev,
358 "%s - nonzero write bulk status received: %d\n",
359 __func__, urb->status);
364 "%s - port->rx_holding = %d\n", __func__, qt_port->rx_holding);
366 if (port_paranoia_check(port, __func__) != 0) {
367 qt_port->read_bulk_stopped = 1;
374 if (qt_port->close_pending == 1) {
375 /* Were closing , stop reading */
377 "%s - (qt_port->close_pending == 1\n", __func__);
378 qt_port->read_bulk_stopped = 1;
383 * rx_holding is asserted by throttle, if we assert it, we're not
384 * receiving any more characters and let the box handle the flow
387 if (qt_port->rx_holding == 1) {
388 qt_port->read_bulk_stopped = 1;
393 qt_port->read_bulk_stopped = 1;
396 "%s - nonzero read bulk status received: %d\n",
397 __func__, urb->status);
401 if (urb->actual_length)
402 qt_status_change_check(urb, qt_port, port);
404 /* Continue trying to always read */
405 usb_fill_bulk_urb(port->read_urb, serial->dev,
406 usb_rcvbulkpipe(serial->dev,
407 port->bulk_in_endpointAddress),
408 port->read_urb->transfer_buffer,
409 port->read_urb->transfer_buffer_length,
410 qt_read_bulk_callback, port);
411 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
414 "%s - failed resubmitting read urb, error %d",
417 if (urb->actual_length) {
418 tty_flip_buffer_push(&port->port);
419 tty_schedule_flip(&port->port);
423 schedule_work(&port->work);
428 * Issue a GET_DEVICE vendor-specific request on the default control pipe If
429 * successful, fills in the qt_get_device_data structure pointed to by
430 * device_data, otherwise return a negative error number of the problem.
433 static int qt_get_device(struct usb_serial *serial,
434 struct qt_get_device_data *device_data)
437 unsigned char *transfer_buffer;
440 kmalloc(sizeof(struct qt_get_device_data), GFP_KERNEL);
441 if (!transfer_buffer)
444 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
445 QT_SET_GET_DEVICE, 0xc0, 0, 0,
447 sizeof(struct qt_get_device_data), 300);
449 memcpy(device_data, transfer_buffer,
450 sizeof(struct qt_get_device_data));
451 kfree(transfer_buffer);
456 /****************************************************************************
457 * box_set_prebuffer_level
458 TELLS BOX WHEN TO ASSERT FLOW CONTROL
459 ****************************************************************************/
460 static int box_set_prebuffer_level(struct usb_serial *serial)
465 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
466 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
467 QT_GET_SET_PREBUF_TRIG_LVL, 0x40,
468 buffer_length, 0, NULL, 0, 300);
472 /****************************************************************************
474 TELLS BOX WHEN TO ASSERT automatic transmitter control
475 ****************************************************************************/
476 static int box_set_atc(struct usb_serial *serial, __u16 n_mode)
481 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
484 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
485 QT_SET_ATF, 0x40, n_mode, 0, NULL, 0, 300);
492 * Issue a SET_DEVICE vendor-specific request on the default control pipe If
493 * successful returns the number of bytes written, otherwise it returns a
494 * negative error number of the problem.
496 static int qt_set_device(struct usb_serial *serial,
497 struct qt_get_device_data *device_data)
503 port_settings = ((__u16) (device_data->portb));
504 port_settings = (port_settings << 8);
505 port_settings += ((__u16) (device_data->porta));
507 length = sizeof(struct qt_get_device_data);
509 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
510 QT_SET_GET_DEVICE, 0x40, port_settings,
515 static int qt_open_channel(struct usb_serial *serial, __u16 uart_num,
516 struct qt_open_channel_data *pdevice_data)
520 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
521 QT_OPEN_CLOSE_CHANNEL,
522 USBD_TRANSFER_DIRECTION_IN, 1, uart_num,
524 sizeof(struct qt_open_channel_data), 300);
530 static int qt_close_channel(struct usb_serial *serial, __u16 uart_num)
534 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
535 QT_OPEN_CLOSE_CHANNEL,
536 USBD_TRANSFER_DIRECTION_OUT, 0, uart_num,
543 /****************************************************************************
545 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
546 * If successful, fills in the p_value with the register value asked for
547 ****************************************************************************/
548 static int box_get_register(struct usb_serial *serial, unsigned short uart_num,
549 unsigned short register_num, __u8 *p_value)
552 __u16 current_length;
554 current_length = sizeof(struct qt_get_device_data);
557 usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
558 QT_GET_SET_REGISTER, 0xC0, register_num,
559 uart_num, (void *)p_value, sizeof(*p_value), 300);
564 /****************************************************************************
566 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
567 * If successful, fills in the p_value with the register value asked for
568 ****************************************************************************/
569 static int box_set_register(struct usb_serial *serial, unsigned short uart_num,
570 unsigned short register_num, unsigned short value)
573 unsigned short reg_and_byte;
575 reg_and_byte = value;
576 reg_and_byte = reg_and_byte << 8;
577 reg_and_byte = reg_and_byte + register_num;
580 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
581 QT_GET_SET_REGISTER, 0xC0, register_num,
582 uart_num, NULL, 0, 300);
586 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
587 QT_GET_SET_REGISTER, 0x40, reg_and_byte, uart_num,
595 * issues a SET_UART vendor-specific request on the default control pipe
596 * If successful sets baud rate divisor and LCR value
598 static int qt_setuart(struct usb_serial *serial, unsigned short uart_num,
599 unsigned short default_divisor, unsigned char default_lcr)
602 unsigned short uart_num_and_lcr;
604 uart_num_and_lcr = (default_lcr << 8) + uart_num;
607 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
608 QT_GET_SET_UART, 0x40, default_divisor,
609 uart_num_and_lcr, NULL, 0, 300);
614 static int box_set_hw_flow_ctrl(struct usb_serial *serial, unsigned int index,
618 __u8 msr = 0, mout_value = 0;
622 /* flow control, box will clear RTS line to prevent remote */
623 mcr = SERIAL_MCR_RTS;
624 } /* device from xmitting more chars */
626 /* no flow control to remote device */
630 mout_value = mcr << 8;
633 /* flow control, box will inhibit xmit data if CTS line is
635 msr = SERIAL_MSR_CTS;
637 /* Box will not inhimbe xmit data due to CTS line */
643 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
644 QT_HW_FLOW_CONTROL_MASK, 0x40, mout_value,
645 index, NULL, 0, 300);
650 static int box_set_sw_flow_ctrl(struct usb_serial *serial, __u16 index,
651 unsigned char stop_char, unsigned char start_char)
656 n_sw_flow_out = start_char << 8;
657 n_sw_flow_out = (unsigned short)stop_char;
660 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
661 QT_SW_FLOW_CONTROL_MASK, 0x40, n_sw_flow_out,
662 index, NULL, 0, 300);
667 static int box_disable_sw_flow_ctrl(struct usb_serial *serial, __u16 index)
672 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
673 QT_SW_FLOW_CONTROL_DISABLE, 0x40, 0, index,
679 static int qt_startup(struct usb_serial *serial)
681 struct device *dev = &serial->dev->dev;
682 struct usb_serial_port *port;
683 struct quatech_port *qt_port;
684 struct qt_get_device_data device_data;
688 /* Now setup per port private data */
689 for (i = 0; i < serial->num_ports; i++) {
690 port = serial->port[i];
691 qt_port = kzalloc(sizeof(*qt_port), GFP_KERNEL);
693 for (--i; i >= 0; i--) {
694 port = serial->port[i];
695 kfree(usb_get_serial_port_data(port));
696 usb_set_serial_port_data(port, NULL);
700 mutex_init(&qt_port->lock);
702 usb_set_serial_port_data(port, qt_port);
706 status = qt_get_device(serial, &device_data);
710 dev_dbg(dev, "device_data.portb = 0x%x\n", device_data.portb);
712 device_data.portb &= ~FULLPWRBIT;
713 dev_dbg(dev, "Changing device_data.portb to 0x%x\n", device_data.portb);
715 status = qt_set_device(serial, &device_data);
717 dev_dbg(dev, "qt_set_device failed\n");
721 status = qt_get_device(serial, &device_data);
723 dev_dbg(dev, "qt_get_device failed\n");
727 switch (serial->dev->descriptor.idProduct) {
730 case QUATECH_ESU100A:
731 case QUATECH_ESU100B:
732 case QUATECH_HSU100A:
733 case QUATECH_HSU100B:
734 case QUATECH_HSU100C:
735 case QUATECH_HSU100D:
736 device_data.porta &= ~(RR_BITS | DUPMODE_BITS);
737 device_data.porta |= CLKS_X4;
738 device_data.portb &= ~(LOOPMODE_BITS);
739 device_data.portb |= RS232_MODE;
745 case QUATECH_ESU200A:
746 case QUATECH_ESU200B:
747 case QUATECH_HSU200A:
748 case QUATECH_HSU200B:
749 case QUATECH_HSU200C:
750 case QUATECH_HSU200D:
751 device_data.porta &= ~(RR_BITS | DUPMODE_BITS);
752 device_data.porta |= CLKS_X4;
753 device_data.portb &= ~(LOOPMODE_BITS);
754 device_data.portb |= ALL_LOOPBACK;
757 device_data.porta &= ~(RR_BITS | DUPMODE_BITS);
758 device_data.porta |= CLKS_X4;
759 device_data.portb &= ~(LOOPMODE_BITS);
760 device_data.portb |= RS232_MODE;
765 status = box_set_prebuffer_level(serial); /* sets to default value */
767 dev_dbg(dev, "box_set_prebuffer_level failed\n");
771 status = box_set_atc(serial, ATC_DISABLED);
773 dev_dbg(dev, "box_set_atc failed\n");
777 dev_dbg(dev, "device_data.portb = 0x%x\n", device_data.portb);
779 device_data.portb |= NEXT_BOARD_POWER_BIT;
780 dev_dbg(dev, "Changing device_data.portb to 0x%x\n", device_data.portb);
782 status = qt_set_device(serial, &device_data);
784 dev_dbg(dev, "qt_set_device failed\n");
791 for (i = 0; i < serial->num_ports; i++) {
792 port = serial->port[i];
793 qt_port = qt_get_port_private(port);
795 usb_set_serial_port_data(port, NULL);
801 static void qt_release(struct usb_serial *serial)
803 struct usb_serial_port *port;
804 struct quatech_port *qt_port;
807 for (i = 0; i < serial->num_ports; i++) {
808 port = serial->port[i];
812 qt_port = usb_get_serial_port_data(port);
814 usb_set_serial_port_data(port, NULL);
819 static void qt_submit_urb_from_open(struct usb_serial *serial,
820 struct usb_serial_port *port)
823 struct usb_serial_port *port0 = serial->port[0];
825 /* set up interrupt urb */
826 usb_fill_int_urb(port0->interrupt_in_urb,
828 usb_rcvintpipe(serial->dev,
829 port0->interrupt_in_endpointAddress),
830 port0->interrupt_in_buffer,
831 port0->interrupt_in_urb->transfer_buffer_length,
832 qt_interrupt_callback, serial,
833 port0->interrupt_in_urb->interval);
835 result = usb_submit_urb(port0->interrupt_in_urb,
839 "%s - Error %d submitting interrupt urb\n",
844 static int qt_open(struct tty_struct *tty,
845 struct usb_serial_port *port)
847 struct usb_serial *serial;
848 struct quatech_port *quatech_port;
849 struct quatech_port *port0;
850 struct qt_open_channel_data channel_data;
854 if (port_paranoia_check(port, __func__))
857 serial = port->serial;
859 if (serial_paranoia_check(serial, __func__))
862 quatech_port = qt_get_port_private(port);
863 port0 = qt_get_port_private(serial->port[0]);
865 if (quatech_port == NULL || port0 == NULL)
868 usb_clear_halt(serial->dev, port->write_urb->pipe);
869 usb_clear_halt(serial->dev, port->read_urb->pipe);
872 result = qt_get_device(serial, &port0->device_data);
874 /* Port specific setups */
875 result = qt_open_channel(serial, port->port_number, &channel_data);
877 dev_dbg(&port->dev, "qt_open_channel failed\n");
880 dev_dbg(&port->dev, "qt_open_channel completed.\n");
882 /* FIXME: are these needed? Does it even do anything useful? */
883 quatech_port->shadow_lsr = channel_data.line_status &
884 (SERIAL_LSR_OE | SERIAL_LSR_PE | SERIAL_LSR_FE | SERIAL_LSR_BI);
886 quatech_port->shadow_msr = channel_data.modem_status &
887 (SERIAL_MSR_CTS | SERIAL_MSR_DSR | SERIAL_MSR_RI | SERIAL_MSR_CD);
889 /* Set Baud rate to default and turn off (default)flow control here */
890 result = qt_setuart(serial, port->port_number, DEFAULT_DIVISOR, DEFAULT_LCR);
892 dev_dbg(&port->dev, "qt_setuart failed\n");
895 dev_dbg(&port->dev, "qt_setuart completed.\n");
898 * Put this here to make it responsive to stty and defaults set by
902 /* Check to see if we've set up our endpoint info yet */
903 if (port0->open_ports == 1) {
904 if (serial->port[0]->interrupt_in_buffer == NULL)
905 qt_submit_urb_from_open(serial, port);
908 dev_dbg(&port->dev, "minor number is %d\n", port->minor);
910 "Bulkin endpoint is %d\n", port->bulk_in_endpointAddress);
912 "BulkOut endpoint is %d\n", port->bulk_out_endpointAddress);
913 dev_dbg(&port->dev, "Interrupt endpoint is %d\n",
914 port->interrupt_in_endpointAddress);
915 dev_dbg(&port->dev, "port's number in the device is %d\n",
916 quatech_port->port_num);
917 quatech_port->read_urb = port->read_urb;
919 /* set up our bulk in urb */
921 usb_fill_bulk_urb(quatech_port->read_urb,
923 usb_rcvbulkpipe(serial->dev,
924 port->bulk_in_endpointAddress),
925 port->bulk_in_buffer,
926 quatech_port->read_urb->transfer_buffer_length,
927 qt_read_bulk_callback, quatech_port);
929 dev_dbg(&port->dev, "qt_open: bulkin endpoint is %d\n",
930 port->bulk_in_endpointAddress);
931 quatech_port->read_urb_busy = true;
932 result = usb_submit_urb(quatech_port->read_urb, GFP_KERNEL);
935 "%s - Error %d submitting control urb\n",
937 quatech_port->read_urb_busy = false;
940 /* initialize our wait queues */
941 init_waitqueue_head(&quatech_port->wait);
942 init_waitqueue_head(&quatech_port->msr_wait);
944 /* initialize our icount structure */
945 memset(&(quatech_port->icount), 0x00, sizeof(quatech_port->icount));
951 static int qt_chars_in_buffer(struct tty_struct *tty)
953 struct usb_serial_port *port = tty->driver_data;
954 struct usb_serial *serial;
957 serial = get_usb_serial(port, __func__);
959 if (serial->num_bulk_out) {
960 if (port->write_urb->status == -EINPROGRESS)
961 chars = port->write_urb->transfer_buffer_length;
967 static void qt_block_until_empty(struct tty_struct *tty,
968 struct quatech_port *qt_port)
970 int timeout = HZ / 10;
973 /* returns if we get a signal, an error, or the buffer is empty */
974 while (wait_event_interruptible_timeout(qt_port->wait,
975 qt_chars_in_buffer(tty) <= 0,
979 dev_dbg(&qt_port->port->dev, "%s - TIMEOUT", __func__);
987 static void qt_close(struct usb_serial_port *port)
989 struct usb_serial *serial = port->serial;
990 struct quatech_port *qt_port;
991 struct quatech_port *port0;
992 struct tty_struct *tty;
997 tty = tty_port_tty_get(&port->port);
998 index = port->port_number;
1000 qt_port = qt_get_port_private(port);
1001 port0 = qt_get_port_private(serial->port[0]);
1003 /* shutdown any bulk reads that might be going on */
1004 if (serial->num_bulk_out)
1005 usb_unlink_urb(port->write_urb);
1006 if (serial->num_bulk_in)
1007 usb_unlink_urb(port->read_urb);
1009 /* wait up to for transmitter to empty */
1011 qt_block_until_empty(tty, qt_port);
1014 /* Close uart channel */
1015 status = qt_close_channel(serial, index);
1017 dev_dbg(&port->dev, "%s - qt_close_channel failed.\n", __func__);
1019 port0->open_ports--;
1021 dev_dbg(&port->dev, "qt_num_open_ports in close%d\n", port0->open_ports);
1023 if (port0->open_ports == 0) {
1024 if (serial->port[0]->interrupt_in_urb) {
1025 dev_dbg(&port->dev, "Shutdown interrupt_in_urb\n");
1026 usb_kill_urb(serial->port[0]->interrupt_in_urb);
1031 if (qt_port->write_urb) {
1032 /* if this urb had a transfer buffer already (old tx) free it */
1033 kfree(qt_port->write_urb->transfer_buffer);
1034 usb_free_urb(qt_port->write_urb);
1039 static int qt_write(struct tty_struct *tty, struct usb_serial_port *port,
1040 const unsigned char *buf, int count)
1043 struct usb_serial *serial = get_usb_serial(port, __func__);
1050 "%s - write request of 0 bytes\n", __func__);
1054 /* only do something if we have a bulk out endpoint */
1055 if (serial->num_bulk_out) {
1056 if (port->write_urb->status == -EINPROGRESS) {
1057 dev_dbg(&port->dev, "%s - already writing\n", __func__);
1062 (count > port->bulk_out_size) ? port->bulk_out_size : count;
1063 memcpy(port->write_urb->transfer_buffer, buf, count);
1065 /* set up our urb */
1067 usb_fill_bulk_urb(port->write_urb, serial->dev,
1068 usb_sndbulkpipe(serial->dev,
1070 bulk_out_endpointAddress),
1071 port->write_urb->transfer_buffer, count,
1072 qt_write_bulk_callback, port);
1074 /* send the data out the bulk port */
1075 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1078 "%s - failed submitting write urb, error %d\n",
1086 /* no bulk out, so return 0 bytes written */
1090 static int qt_write_room(struct tty_struct *tty)
1092 struct usb_serial_port *port = tty->driver_data;
1093 struct usb_serial *serial;
1094 struct quatech_port *qt_port;
1096 int retval = -EINVAL;
1098 if (port_paranoia_check(port, __func__))
1101 serial = get_usb_serial(port, __func__);
1106 qt_port = qt_get_port_private(port);
1108 mutex_lock(&qt_port->lock);
1110 if (serial->num_bulk_out) {
1111 if (port->write_urb->status != -EINPROGRESS)
1112 retval = port->bulk_out_size;
1115 mutex_unlock(&qt_port->lock);
1120 static int qt_ioctl(struct tty_struct *tty,
1121 unsigned int cmd, unsigned long arg)
1123 struct usb_serial_port *port = tty->driver_data;
1124 struct quatech_port *qt_port = qt_get_port_private(port);
1127 dev_dbg(&port->dev, "%s cmd 0x%04x\n", __func__, cmd);
1129 index = port->port_number;
1131 if (cmd == TIOCMIWAIT) {
1132 while (qt_port != NULL) {
1134 /* this never wakes up */
1135 interruptible_sleep_on(&qt_port->msr_wait);
1137 if (signal_pending(current))
1138 return -ERESTARTSYS;
1140 char diff = qt_port->diff_status;
1143 return -EIO; /* no change => error */
1145 /* Consume all events */
1146 qt_port->diff_status = 0;
1148 if (((arg & TIOCM_RNG)
1149 && (diff & SERIAL_MSR_RI))
1150 || ((arg & TIOCM_DSR)
1151 && (diff & SERIAL_MSR_DSR))
1152 || ((arg & TIOCM_CD)
1153 && (diff & SERIAL_MSR_CD))
1154 || ((arg & TIOCM_CTS)
1155 && (diff & SERIAL_MSR_CTS))) {
1163 dev_dbg(&port->dev, "%s -No ioctl for that one.\n", __func__);
1164 return -ENOIOCTLCMD;
1167 static void qt_set_termios(struct tty_struct *tty,
1168 struct usb_serial_port *port,
1169 struct ktermios *old_termios)
1171 struct ktermios *termios = &tty->termios;
1172 unsigned char new_lcr = 0;
1173 unsigned int cflag = termios->c_cflag;
1175 int baud, divisor, remainder;
1178 index = port->port_number;
1180 switch (cflag & CSIZE) {
1182 new_lcr |= SERIAL_5_DATA;
1185 new_lcr |= SERIAL_6_DATA;
1188 new_lcr |= SERIAL_7_DATA;
1191 termios->c_cflag &= ~CSIZE;
1192 termios->c_cflag |= CS8;
1194 new_lcr |= SERIAL_8_DATA;
1199 if (cflag & PARENB) {
1201 new_lcr |= SERIAL_ODD_PARITY;
1203 new_lcr |= SERIAL_EVEN_PARITY;
1206 new_lcr |= SERIAL_TWO_STOPB;
1208 new_lcr |= SERIAL_ONE_STOPB;
1210 dev_dbg(&port->dev, "%s - 4\n", __func__);
1212 /* Thats the LCR stuff, go ahead and set it */
1213 baud = tty_get_baud_rate(tty);
1215 /* pick a default, any default... */
1218 dev_dbg(&port->dev, "%s - got baud = %d\n", __func__, baud);
1220 divisor = MAX_BAUD_RATE / baud;
1221 remainder = MAX_BAUD_RATE % baud;
1222 /* Round to nearest divisor */
1223 if (((remainder * 2) >= baud) && (baud != 110))
1227 * Set Baud rate to default and turn off (default)flow control here
1230 qt_setuart(port->serial, index, (unsigned short)divisor, new_lcr);
1232 dev_dbg(&port->dev, "qt_setuart failed\n");
1236 /* Now determine flow control */
1237 if (cflag & CRTSCTS) {
1238 dev_dbg(&port->dev, "%s - Enabling HW flow control\n", __func__);
1240 /* Enable RTS/CTS flow control */
1241 status = box_set_hw_flow_ctrl(port->serial, index, 1);
1244 dev_dbg(&port->dev, "box_set_hw_flow_ctrl failed\n");
1248 /* Disable RTS/CTS flow control */
1250 "%s - disabling HW flow control\n", __func__);
1252 status = box_set_hw_flow_ctrl(port->serial, index, 0);
1254 dev_dbg(&port->dev, "box_set_hw_flow_ctrl failed\n");
1260 /* if we are implementing XON/XOFF, set the start and stop character in
1262 if (I_IXOFF(tty) || I_IXON(tty)) {
1263 unsigned char stop_char = STOP_CHAR(tty);
1264 unsigned char start_char = START_CHAR(tty);
1266 box_set_sw_flow_ctrl(port->serial, index, stop_char,
1270 "box_set_sw_flow_ctrl (enabled) failed\n");
1273 /* disable SW flow control */
1274 status = box_disable_sw_flow_ctrl(port->serial, index);
1277 "box_set_sw_flow_ctrl (diabling) failed\n");
1280 termios->c_cflag &= ~CMSPAR;
1282 Error cases should be returning the actual bits changed only
1286 static void qt_break(struct tty_struct *tty, int break_state)
1288 struct usb_serial_port *port = tty->driver_data;
1289 struct usb_serial *serial = get_usb_serial(port, __func__);
1290 struct quatech_port *qt_port;
1292 unsigned int result;
1294 index = port->port_number;
1296 qt_port = qt_get_port_private(port);
1298 if (break_state == -1)
1303 mutex_lock(&qt_port->lock);
1306 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
1307 QT_BREAK_CONTROL, 0x40, onoff, index, NULL, 0, 300);
1309 mutex_unlock(&qt_port->lock);
1312 static inline int qt_real_tiocmget(struct tty_struct *tty,
1313 struct usb_serial_port *port,
1314 struct usb_serial *serial)
1319 unsigned int result = 0;
1323 index = port->port_number;
1325 box_get_register(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1328 box_get_register(port->serial, index,
1329 MODEM_STATUS_REGISTER, &msr);
1334 result = ((mcr & SERIAL_MCR_DTR) ? TIOCM_DTR : 0)
1336 | ((mcr & SERIAL_MCR_RTS) ? TIOCM_RTS : 0)
1338 | ((msr & SERIAL_MSR_CTS) ? TIOCM_CTS : 0)
1340 | ((msr & SERIAL_MSR_CD) ? TIOCM_CAR : 0)
1341 /* Carrier detect is set */
1342 | ((msr & SERIAL_MSR_RI) ? TIOCM_RI : 0)
1343 /* Ring indicator set */
1344 | ((msr & SERIAL_MSR_DSR) ? TIOCM_DSR : 0);
1352 static inline int qt_real_tiocmset(struct tty_struct *tty,
1353 struct usb_serial_port *port,
1354 struct usb_serial *serial,
1362 index = port->port_number;
1364 box_get_register(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1369 * Turn off the RTS and DTR and loopback and then only turn on what was
1372 mcr &= ~(SERIAL_MCR_RTS | SERIAL_MCR_DTR | SERIAL_MCR_LOOP);
1373 if (value & TIOCM_RTS)
1374 mcr |= SERIAL_MCR_RTS;
1375 if (value & TIOCM_DTR)
1376 mcr |= SERIAL_MCR_DTR;
1377 if (value & TIOCM_LOOP)
1378 mcr |= SERIAL_MCR_LOOP;
1381 box_set_register(port->serial, index, MODEM_CONTROL_REGISTER, mcr);
1388 static int qt_tiocmget(struct tty_struct *tty)
1390 struct usb_serial_port *port = tty->driver_data;
1391 struct usb_serial *serial = get_usb_serial(port, __func__);
1392 struct quatech_port *qt_port = qt_get_port_private(port);
1398 mutex_lock(&qt_port->lock);
1399 retval = qt_real_tiocmget(tty, port, serial);
1400 mutex_unlock(&qt_port->lock);
1404 static int qt_tiocmset(struct tty_struct *tty,
1405 unsigned int set, unsigned int clear)
1408 struct usb_serial_port *port = tty->driver_data;
1409 struct usb_serial *serial = get_usb_serial(port, __func__);
1410 struct quatech_port *qt_port = qt_get_port_private(port);
1416 mutex_lock(&qt_port->lock);
1417 retval = qt_real_tiocmset(tty, port, serial, set);
1418 mutex_unlock(&qt_port->lock);
1422 static void qt_throttle(struct tty_struct *tty)
1424 struct usb_serial_port *port = tty->driver_data;
1425 struct usb_serial *serial = get_usb_serial(port, __func__);
1426 struct quatech_port *qt_port;
1431 qt_port = qt_get_port_private(port);
1433 mutex_lock(&qt_port->lock);
1435 /* pass on to the driver specific version of this function */
1436 qt_port->rx_holding = 1;
1438 mutex_unlock(&qt_port->lock);
1441 static void qt_submit_urb_from_unthrottle(struct usb_serial_port *port,
1442 struct usb_serial *serial)
1446 /* Start reading from the device */
1447 usb_fill_bulk_urb(port->read_urb, serial->dev,
1448 usb_rcvbulkpipe(serial->dev,
1449 port->bulk_in_endpointAddress),
1450 port->read_urb->transfer_buffer,
1451 port->read_urb->transfer_buffer_length,
1452 qt_read_bulk_callback, port);
1454 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1458 "%s - failed restarting read urb, error %d\n",
1462 static void qt_unthrottle(struct tty_struct *tty)
1464 struct usb_serial_port *port = tty->driver_data;
1465 struct usb_serial *serial = get_usb_serial(port, __func__);
1466 struct quatech_port *qt_port;
1471 qt_port = qt_get_port_private(port);
1473 mutex_lock(&qt_port->lock);
1475 if (qt_port->rx_holding == 1) {
1476 dev_dbg(&port->dev, "%s -qt_port->rx_holding == 1\n", __func__);
1478 qt_port->rx_holding = 0;
1479 dev_dbg(&port->dev, "%s - qt_port->rx_holding = 0\n", __func__);
1481 /* if we have a bulk endpoint, start it up */
1482 if ((serial->num_bulk_in) && (qt_port->read_bulk_stopped == 1))
1483 qt_submit_urb_from_unthrottle(port, serial);
1485 mutex_unlock(&qt_port->lock);
1488 static int qt_calc_num_ports(struct usb_serial *serial)
1493 (serial->interface->cur_altsetting->desc.bNumEndpoints - 1) / 2;
1498 static struct usb_serial_driver quatech_device = {
1500 .owner = THIS_MODULE,
1503 .description = DRIVER_DESC,
1504 .id_table = id_table,
1509 .write_room = qt_write_room,
1510 .chars_in_buffer = qt_chars_in_buffer,
1511 .throttle = qt_throttle,
1512 .unthrottle = qt_unthrottle,
1513 .calc_num_ports = qt_calc_num_ports,
1515 .set_termios = qt_set_termios,
1516 .break_ctl = qt_break,
1517 .tiocmget = qt_tiocmget,
1518 .tiocmset = qt_tiocmset,
1519 .attach = qt_startup,
1520 .release = qt_release,
1523 static struct usb_serial_driver * const serial_drivers[] = {
1524 &quatech_device, NULL
1527 module_usb_serial_driver(serial_drivers, id_table);
1529 MODULE_AUTHOR(DRIVER_AUTHOR);
1530 MODULE_DESCRIPTION(DRIVER_DESC);
1531 MODULE_LICENSE("GPL");