2 * This code was developed for the Quatech USB line for linux, it used
3 * much of the code developed by Greg Kroah-Hartman for USB serial devices
7 #include <linux/errno.h>
8 #include <linux/init.h>
9 #include <linux/slab.h>
10 #include <linux/tty.h>
11 #include <linux/tty_driver.h>
12 #include <linux/tty_flip.h>
13 #include <linux/module.h>
14 #include <linux/serial.h>
15 #include <linux/usb.h>
16 #include <linux/usb/serial.h>
17 #include <linux/uaccess.h>
19 /* Version Information */
20 #define DRIVER_VERSION "v2.14"
21 #define DRIVER_AUTHOR "Tim Gobeli, Quatech, Inc"
22 #define DRIVER_DESC "Quatech USB to Serial Driver"
24 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
25 #define QUATECH_SSU200 0xC030 /* SSU200 */
26 #define QUATECH_DSU100 0xC040 /* DSU100 */
27 #define QUATECH_DSU200 0xC050 /* DSU200 */
28 #define QUATECH_QSU100 0xC060 /* QSU100 */
29 #define QUATECH_QSU200 0xC070 /* QSU200 */
30 #define QUATECH_ESU100A 0xC080 /* ESU100A */
31 #define QUATECH_ESU100B 0xC081 /* ESU100B */
32 #define QUATECH_ESU200A 0xC0A0 /* ESU200A */
33 #define QUATECH_ESU200B 0xC0A1 /* ESU200B */
34 #define QUATECH_HSU100A 0xC090 /* HSU100A */
35 #define QUATECH_HSU100B 0xC091 /* HSU100B */
36 #define QUATECH_HSU100C 0xC092 /* HSU100C */
37 #define QUATECH_HSU100D 0xC093 /* HSU100D */
38 #define QUATECH_HSU200A 0xC0B0 /* HSU200A */
39 #define QUATECH_HSU200B 0xC0B1 /* HSU200B */
40 #define QUATECH_HSU200C 0xC0B2 /* HSU200C */
41 #define QUATECH_HSU200D 0xC0B3 /* HSU200D */
43 #define QT_SET_GET_DEVICE 0xc2
44 #define QT_OPEN_CLOSE_CHANNEL 0xca
45 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
46 #define QT_SET_ATF 0xcd
47 #define QT_GET_SET_REGISTER 0xc0
48 #define QT_GET_SET_UART 0xc1
49 #define QT_HW_FLOW_CONTROL_MASK 0xc5
50 #define QT_SW_FLOW_CONTROL_MASK 0xc6
51 #define QT_SW_FLOW_CONTROL_DISABLE 0xc7
52 #define QT_BREAK_CONTROL 0xc8
54 #define USBD_TRANSFER_DIRECTION_IN 0xc0
55 #define USBD_TRANSFER_DIRECTION_OUT 0x40
57 #define MAX_BAUD_RATE 460800
58 #define MAX_BAUD_REMAINDER 4608
60 #define DIV_LATCH_LS 0x00
61 #define XMT_HOLD_REGISTER 0x00
62 #define XVR_BUFFER_REGISTER 0x00
63 #define DIV_LATCH_MS 0x01
64 #define FIFO_CONTROL_REGISTER 0x02
65 #define LINE_CONTROL_REGISTER 0x03
66 #define MODEM_CONTROL_REGISTER 0x04
67 #define LINE_STATUS_REGISTER 0x05
68 #define MODEM_STATUS_REGISTER 0x06
70 #define SERIAL_MCR_DTR 0x01
71 #define SERIAL_MCR_RTS 0x02
72 #define SERIAL_MCR_LOOP 0x10
74 #define SERIAL_MSR_CTS 0x10
75 #define SERIAL_MSR_CD 0x80
76 #define SERIAL_MSR_RI 0x40
77 #define SERIAL_MSR_DSR 0x20
78 #define SERIAL_MSR_MASK 0xf0
80 #define SERIAL_8_DATA 0x03
81 #define SERIAL_7_DATA 0x02
82 #define SERIAL_6_DATA 0x01
83 #define SERIAL_5_DATA 0x00
85 #define SERIAL_ODD_PARITY 0X08
86 #define SERIAL_EVEN_PARITY 0X18
87 #define SERIAL_TWO_STOPB 0x04
88 #define SERIAL_ONE_STOPB 0x00
90 #define DEFAULT_DIVISOR 0x30 /* gives 9600 baud rate */
91 #define DEFAULT_LCR SERIAL_8_DATA /* 8, none , 1 */
93 #define FULLPWRBIT 0x00000080
94 #define NEXT_BOARD_POWER_BIT 0x00000004
96 #define SERIAL_LSR_OE 0x02
97 #define SERIAL_LSR_PE 0x04
98 #define SERIAL_LSR_FE 0x08
99 #define SERIAL_LSR_BI 0x10
101 #define SERIAL_MSR_CTS 0x10
102 #define SERIAL_MSR_CD 0x80
103 #define SERIAL_MSR_RI 0x40
104 #define SERIAL_MSR_DSR 0x20
105 #define SERIAL_MSR_MASK 0xf0
107 #define PREFUFF_LEVEL_CONSERVATIVE 128
108 #define ATC_DISABLED 0x0
110 #define RR_BITS 0x03 /* for clearing clock bits */
111 #define DUPMODE_BITS 0xc0
114 #define LOOPMODE_BITS 0x41 /* LOOP1 = b6, LOOP0 = b0 (PORT B) */
115 #define ALL_LOOPBACK 0x01
116 #define MODEM_CTRL 0x40
117 #define RS232_MODE 0x00
119 static const struct usb_device_id id_table[] = {
120 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU200)},
121 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU100)},
122 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU200)},
123 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU100)},
124 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU200)},
125 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100A)},
126 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100B)},
127 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU200A)},
128 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU200B)},
129 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100A)},
130 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100B)},
131 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100C)},
132 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100D)},
133 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200A)},
134 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200B)},
135 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200C)},
136 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200D)},
137 {} /* Terminating entry */
139 MODULE_DEVICE_TABLE(usb, id_table);
141 struct qt_get_device_data {
147 struct qt_open_channel_data {
152 struct quatech_port {
153 int port_num; /* number of the port */
154 struct urb *write_urb; /* write URB for this port */
155 struct urb *read_urb; /* read URB for this port */
158 __u8 shadowLCR; /* last LCR value received */
159 __u8 shadowMCR; /* last MCR value received */
160 __u8 shadowMSR; /* last MSR value received */
161 __u8 shadowLSR; /* last LSR value received */
164 /* Used for TIOCMIWAIT */
165 wait_queue_head_t msr_wait;
166 char prev_status, diff_status;
168 wait_queue_head_t wait;
170 struct async_icount icount;
172 struct usb_serial_port *port; /* owner of this object */
173 struct qt_get_device_data DeviceData;
181 static int port_paranoia_check(struct usb_serial_port *port,
182 const char *function)
185 pr_debug("%s - port == NULL", function);
189 pr_debug("%s - port->serial == NULL\n", function);
196 static int serial_paranoia_check(struct usb_serial *serial,
197 const char *function)
200 pr_debug("%s - serial == NULL\n", function);
205 pr_debug("%s - serial->type == NULL!", function);
212 static inline struct quatech_port *qt_get_port_private(struct usb_serial_port
215 return (struct quatech_port *)usb_get_serial_port_data(port);
218 static inline void qt_set_port_private(struct usb_serial_port *port,
219 struct quatech_port *data)
221 usb_set_serial_port_data(port, (void *)data);
224 static struct usb_serial *get_usb_serial(struct usb_serial_port *port,
225 const char *function)
227 /* if no port was specified, or it fails a paranoia check */
229 port_paranoia_check(port, function) ||
230 serial_paranoia_check(port->serial, function)) {
232 * then say that we dont have a valid usb_serial thing,
233 * which will end up genrating -ENODEV return values
241 static void ProcessLineStatus(struct quatech_port *qt_port,
242 unsigned char line_status)
246 line_status & (SERIAL_LSR_OE | SERIAL_LSR_PE | SERIAL_LSR_FE |
250 static void ProcessModemStatus(struct quatech_port *qt_port,
251 unsigned char modem_status)
254 qt_port->shadowMSR = modem_status;
255 wake_up_interruptible(&qt_port->wait);
258 static void ProcessRxChar(struct tty_struct *tty, struct usb_serial_port *port,
261 struct urb *urb = port->read_urb;
262 if (urb->actual_length)
263 tty_insert_flip_char(tty, data, TTY_NORMAL);
266 static void qt_write_bulk_callback(struct urb *urb)
268 struct tty_struct *tty;
270 struct quatech_port *quatech_port;
272 status = urb->status;
275 dev_dbg(&urb->dev->dev,
276 "nonzero write bulk status received:%d\n", status);
280 quatech_port = urb->context;
282 tty = tty_port_tty_get(&quatech_port->port->port);
289 static void qt_interrupt_callback(struct urb *urb)
294 static void qt_status_change_check(struct tty_struct *tty,
296 struct quatech_port *qt_port,
297 struct usb_serial_port *port)
300 unsigned char *data = urb->transfer_buffer;
301 unsigned int RxCount = urb->actual_length;
303 for (i = 0; i < RxCount; ++i) {
304 /* Look ahead code here */
305 if ((i <= (RxCount - 3)) && (data[i] == 0x1b)
306 && (data[i + 1] == 0x1b)) {
308 switch (data[i + 2]) {
310 if (i > (RxCount - 4)) {
312 "Illegal escape seuences in received data\n");
316 ProcessLineStatus(qt_port, data[i + 3]);
323 if (i > (RxCount - 4)) {
325 "Illegal escape seuences in received data\n");
329 ProcessModemStatus(qt_port, data[i + 3]);
336 dev_dbg(&port->dev, "No status sequence.\n");
338 ProcessRxChar(tty, port, data[i]);
339 ProcessRxChar(tty, port, data[i + 1]);
348 if (tty && urb->actual_length)
349 tty_insert_flip_char(tty, data[i], TTY_NORMAL);
352 tty_flip_buffer_push(tty);
355 static void qt_read_bulk_callback(struct urb *urb)
358 struct usb_serial_port *port = urb->context;
359 struct usb_serial *serial = get_usb_serial(port, __func__);
360 struct quatech_port *qt_port = qt_get_port_private(port);
361 struct tty_struct *tty;
365 qt_port->ReadBulkStopped = 1;
366 dev_dbg(&urb->dev->dev,
367 "%s - nonzero write bulk status received: %d\n",
368 __func__, urb->status);
372 tty = tty_port_tty_get(&port->port);
377 "%s - port->RxHolding = %d\n", __func__, qt_port->RxHolding);
379 if (port_paranoia_check(port, __func__) != 0) {
380 qt_port->ReadBulkStopped = 1;
387 if (qt_port->closePending == 1) {
388 /* Were closing , stop reading */
390 "%s - (qt_port->closepending == 1\n", __func__);
391 qt_port->ReadBulkStopped = 1;
396 * RxHolding is asserted by throttle, if we assert it, we're not
397 * receiving any more characters and let the box handle the flow
400 if (qt_port->RxHolding == 1) {
401 qt_port->ReadBulkStopped = 1;
406 qt_port->ReadBulkStopped = 1;
409 "%s - nonzero read bulk status received: %d\n",
410 __func__, urb->status);
414 if (urb->actual_length)
415 qt_status_change_check(tty, urb, qt_port, port);
417 /* Continue trying to always read */
418 usb_fill_bulk_urb(port->read_urb, serial->dev,
419 usb_rcvbulkpipe(serial->dev,
420 port->bulk_in_endpointAddress),
421 port->read_urb->transfer_buffer,
422 port->read_urb->transfer_buffer_length,
423 qt_read_bulk_callback, port);
424 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
427 "%s - failed resubmitting read urb, error %d",
430 if (urb->actual_length) {
431 tty_flip_buffer_push(tty);
432 tty_schedule_flip(tty);
436 schedule_work(&port->work);
443 * Issue a GET_DEVICE vendor-specific request on the default control pipe If
444 * successful, fills in the qt_get_device_data structure pointed to by
445 * device_data, otherwise return a negative error number of the problem.
448 static int qt_get_device(struct usb_serial *serial,
449 struct qt_get_device_data *device_data)
452 unsigned char *transfer_buffer;
455 kmalloc(sizeof(struct qt_get_device_data), GFP_KERNEL);
456 if (!transfer_buffer)
459 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
460 QT_SET_GET_DEVICE, 0xc0, 0, 0,
462 sizeof(struct qt_get_device_data), 300);
464 memcpy(device_data, transfer_buffer,
465 sizeof(struct qt_get_device_data));
466 kfree(transfer_buffer);
471 /****************************************************************************
472 * BoxSetPrebufferLevel
473 TELLS BOX WHEN TO ASSERT FLOW CONTROL
474 ****************************************************************************/
475 static int BoxSetPrebufferLevel(struct usb_serial *serial)
480 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
481 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
482 QT_GET_SET_PREBUF_TRIG_LVL, 0x40,
483 buffer_length, 0, NULL, 0, 300);
487 /****************************************************************************
489 TELLS BOX WHEN TO ASSERT automatic transmitter control
490 ****************************************************************************/
491 static int BoxSetATC(struct usb_serial *serial, __u16 n_Mode)
496 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
499 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
500 QT_SET_ATF, 0x40, n_Mode, 0, NULL, 0, 300);
507 * Issue a SET_DEVICE vendor-specific request on the default control pipe If
508 * successful returns the number of bytes written, otherwise it returns a
509 * negative error number of the problem.
511 static int qt_set_device(struct usb_serial *serial,
512 struct qt_get_device_data *device_data)
518 PortSettings = ((__u16) (device_data->portb));
519 PortSettings = (PortSettings << 8);
520 PortSettings += ((__u16) (device_data->porta));
522 length = sizeof(struct qt_get_device_data);
524 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
525 QT_SET_GET_DEVICE, 0x40, PortSettings,
530 static int qt_open_channel(struct usb_serial *serial, __u16 Uart_Number,
531 struct qt_open_channel_data *pDeviceData)
535 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
536 QT_OPEN_CLOSE_CHANNEL,
537 USBD_TRANSFER_DIRECTION_IN, 1, Uart_Number,
539 sizeof(struct qt_open_channel_data), 300);
545 static int qt_close_channel(struct usb_serial *serial, __u16 Uart_Number)
549 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
550 QT_OPEN_CLOSE_CHANNEL,
551 USBD_TRANSFER_DIRECTION_OUT, 0, Uart_Number,
558 /****************************************************************************
560 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
561 * If successful, fills in the pValue with the register value asked for
562 ****************************************************************************/
563 static int BoxGetRegister(struct usb_serial *serial, unsigned short Uart_Number,
564 unsigned short Register_Num, __u8 *pValue)
567 __u16 current_length;
569 current_length = sizeof(struct qt_get_device_data);
572 usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
573 QT_GET_SET_REGISTER, 0xC0, Register_Num,
574 Uart_Number, (void *)pValue, sizeof(*pValue), 300);
579 /****************************************************************************
581 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
582 * If successful, fills in the pValue with the register value asked for
583 ****************************************************************************/
584 static int BoxSetRegister(struct usb_serial *serial, unsigned short Uart_Number,
585 unsigned short Register_Num, unsigned short Value)
588 unsigned short RegAndByte;
591 RegAndByte = RegAndByte << 8;
592 RegAndByte = RegAndByte + Register_Num;
595 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
596 QT_GET_SET_REGISTER, 0xC0, Register_Num,
597 Uart_Number, NULL, 0, 300);
601 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
602 QT_GET_SET_REGISTER, 0x40, RegAndByte, Uart_Number,
610 * issues a SET_UART vendor-specific request on the default control pipe
611 * If successful sets baud rate divisor and LCR value
613 static int qt_setuart(struct usb_serial *serial, unsigned short Uart_Number,
614 unsigned short default_divisor, unsigned char default_LCR)
617 unsigned short UartNumandLCR;
619 UartNumandLCR = (default_LCR << 8) + Uart_Number;
622 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
623 QT_GET_SET_UART, 0x40, default_divisor,
624 UartNumandLCR, NULL, 0, 300);
629 static int BoxSetHW_FlowCtrl(struct usb_serial *serial, unsigned int index,
633 __u8 msr = 0, MOUT_Value = 0;
637 /* flow control, box will clear RTS line to prevent remote */
638 mcr = SERIAL_MCR_RTS;
639 } /* device from xmitting more chars */
641 /* no flow control to remote device */
645 MOUT_Value = mcr << 8;
648 /* flow control, box will inhibit xmit data if CTS line is
650 msr = SERIAL_MSR_CTS;
652 /* Box will not inhimbe xmit data due to CTS line */
658 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
659 QT_HW_FLOW_CONTROL_MASK, 0x40, MOUT_Value,
660 index, NULL, 0, 300);
665 static int BoxSetSW_FlowCtrl(struct usb_serial *serial, __u16 index,
666 unsigned char stop_char, unsigned char start_char)
671 nSWflowout = start_char << 8;
672 nSWflowout = (unsigned short)stop_char;
675 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
676 QT_SW_FLOW_CONTROL_MASK, 0x40, nSWflowout,
677 index, NULL, 0, 300);
682 static int BoxDisable_SW_FlowCtrl(struct usb_serial *serial, __u16 index)
687 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
688 QT_SW_FLOW_CONTROL_DISABLE, 0x40, 0, index,
694 static int qt_startup(struct usb_serial *serial)
696 struct device *dev = &serial->dev->dev;
697 struct usb_serial_port *port;
698 struct quatech_port *qt_port;
699 struct qt_get_device_data DeviceData;
703 /* Now setup per port private data */
704 for (i = 0; i < serial->num_ports; i++) {
705 port = serial->port[i];
706 qt_port = kzalloc(sizeof(*qt_port), GFP_KERNEL);
708 for (--i; i >= 0; i--) {
709 port = serial->port[i];
710 kfree(usb_get_serial_port_data(port));
711 usb_set_serial_port_data(port, NULL);
715 mutex_init(&qt_port->lock);
717 usb_set_serial_port_data(port, qt_port);
721 status = qt_get_device(serial, &DeviceData);
725 dev_dbg(dev, "DeviceData.portb = 0x%x\n", DeviceData.portb);
727 DeviceData.portb &= ~FULLPWRBIT;
728 dev_dbg(dev, "Changing DeviceData.portb to 0x%x\n", DeviceData.portb);
730 status = qt_set_device(serial, &DeviceData);
732 dev_dbg(dev, "qt_set_device failed\n");
736 status = qt_get_device(serial, &DeviceData);
738 dev_dbg(dev, "qt_get_device failed\n");
742 switch (serial->dev->descriptor.idProduct) {
745 case QUATECH_ESU100A:
746 case QUATECH_ESU100B:
747 case QUATECH_HSU100A:
748 case QUATECH_HSU100B:
749 case QUATECH_HSU100C:
750 case QUATECH_HSU100D:
751 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
752 DeviceData.porta |= CLKS_X4;
753 DeviceData.portb &= ~(LOOPMODE_BITS);
754 DeviceData.portb |= RS232_MODE;
760 case QUATECH_ESU200A:
761 case QUATECH_ESU200B:
762 case QUATECH_HSU200A:
763 case QUATECH_HSU200B:
764 case QUATECH_HSU200C:
765 case QUATECH_HSU200D:
766 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
767 DeviceData.porta |= CLKS_X4;
768 DeviceData.portb &= ~(LOOPMODE_BITS);
769 DeviceData.portb |= ALL_LOOPBACK;
772 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
773 DeviceData.porta |= CLKS_X4;
774 DeviceData.portb &= ~(LOOPMODE_BITS);
775 DeviceData.portb |= RS232_MODE;
780 status = BoxSetPrebufferLevel(serial); /* sets to default value */
782 dev_dbg(dev, "BoxSetPrebufferLevel failed\n");
786 status = BoxSetATC(serial, ATC_DISABLED);
788 dev_dbg(dev, "BoxSetATC failed\n");
792 dev_dbg(dev, "DeviceData.portb = 0x%x\n", DeviceData.portb);
794 DeviceData.portb |= NEXT_BOARD_POWER_BIT;
795 dev_dbg(dev, "Changing DeviceData.portb to 0x%x\n", DeviceData.portb);
797 status = qt_set_device(serial, &DeviceData);
799 dev_dbg(dev, "qt_set_device failed\n");
806 for (i = 0; i < serial->num_ports; i++) {
807 port = serial->port[i];
808 qt_port = qt_get_port_private(port);
810 usb_set_serial_port_data(port, NULL);
816 static void qt_release(struct usb_serial *serial)
818 struct usb_serial_port *port;
819 struct quatech_port *qt_port;
822 for (i = 0; i < serial->num_ports; i++) {
823 port = serial->port[i];
827 qt_port = usb_get_serial_port_data(port);
829 usb_set_serial_port_data(port, NULL);
834 static void qt_submit_urb_from_open(struct usb_serial *serial,
835 struct usb_serial_port *port)
838 struct usb_serial_port *port0 = serial->port[0];
840 /* set up interrupt urb */
841 usb_fill_int_urb(port0->interrupt_in_urb,
843 usb_rcvintpipe(serial->dev,
844 port0->interrupt_in_endpointAddress),
845 port0->interrupt_in_buffer,
846 port0->interrupt_in_urb->transfer_buffer_length,
847 qt_interrupt_callback, serial,
848 port0->interrupt_in_urb->interval);
850 result = usb_submit_urb(port0->interrupt_in_urb,
854 "%s - Error %d submitting interrupt urb\n",
859 static int qt_open(struct tty_struct *tty,
860 struct usb_serial_port *port)
862 struct usb_serial *serial;
863 struct quatech_port *quatech_port;
864 struct quatech_port *port0;
865 struct qt_open_channel_data ChannelData;
869 if (port_paranoia_check(port, __func__))
872 serial = port->serial;
874 if (serial_paranoia_check(serial, __func__))
877 quatech_port = qt_get_port_private(port);
878 port0 = qt_get_port_private(serial->port[0]);
880 if (quatech_port == NULL || port0 == NULL)
883 usb_clear_halt(serial->dev, port->write_urb->pipe);
884 usb_clear_halt(serial->dev, port->read_urb->pipe);
887 result = qt_get_device(serial, &port0->DeviceData);
889 /* Port specific setups */
890 result = qt_open_channel(serial, port->number, &ChannelData);
892 dev_dbg(&port->dev, "qt_open_channel failed\n");
895 dev_dbg(&port->dev, "qt_open_channel completed.\n");
897 /* FIXME: are these needed? Does it even do anything useful? */
898 quatech_port->shadowLSR = ChannelData.line_status &
899 (SERIAL_LSR_OE | SERIAL_LSR_PE | SERIAL_LSR_FE | SERIAL_LSR_BI);
901 quatech_port->shadowMSR = ChannelData.modem_status &
902 (SERIAL_MSR_CTS | SERIAL_MSR_DSR | SERIAL_MSR_RI | SERIAL_MSR_CD);
904 /* Set Baud rate to default and turn off (default)flow control here */
905 result = qt_setuart(serial, port->number, DEFAULT_DIVISOR, DEFAULT_LCR);
907 dev_dbg(&port->dev, "qt_setuart failed\n");
910 dev_dbg(&port->dev, "qt_setuart completed.\n");
913 * Put this here to make it responsive to stty and defaults set by
917 /* Check to see if we've set up our endpoint info yet */
918 if (port0->open_ports == 1) {
919 if (serial->port[0]->interrupt_in_buffer == NULL)
920 qt_submit_urb_from_open(serial, port);
923 dev_dbg(&port->dev, "port number is %d\n", port->number);
924 dev_dbg(&port->dev, "serial number is %d\n", port->serial->minor);
926 "Bulkin endpoint is %d\n", port->bulk_in_endpointAddress);
928 "BulkOut endpoint is %d\n", port->bulk_out_endpointAddress);
929 dev_dbg(&port->dev, "Interrupt endpoint is %d\n",
930 port->interrupt_in_endpointAddress);
931 dev_dbg(&port->dev, "port's number in the device is %d\n",
932 quatech_port->port_num);
933 quatech_port->read_urb = port->read_urb;
935 /* set up our bulk in urb */
937 usb_fill_bulk_urb(quatech_port->read_urb,
939 usb_rcvbulkpipe(serial->dev,
940 port->bulk_in_endpointAddress),
941 port->bulk_in_buffer,
942 quatech_port->read_urb->transfer_buffer_length,
943 qt_read_bulk_callback, quatech_port);
945 dev_dbg(&port->dev, "qt_open: bulkin endpoint is %d\n",
946 port->bulk_in_endpointAddress);
947 quatech_port->read_urb_busy = true;
948 result = usb_submit_urb(quatech_port->read_urb, GFP_KERNEL);
951 "%s - Error %d submitting control urb\n",
953 quatech_port->read_urb_busy = false;
956 /* initialize our wait queues */
957 init_waitqueue_head(&quatech_port->wait);
958 init_waitqueue_head(&quatech_port->msr_wait);
960 /* initialize our icount structure */
961 memset(&(quatech_port->icount), 0x00, sizeof(quatech_port->icount));
967 static int qt_chars_in_buffer(struct tty_struct *tty)
969 struct usb_serial_port *port = tty->driver_data;
970 struct usb_serial *serial;
973 serial = get_usb_serial(port, __func__);
975 if (serial->num_bulk_out) {
976 if (port->write_urb->status == -EINPROGRESS)
977 chars = port->write_urb->transfer_buffer_length;
983 static void qt_block_until_empty(struct tty_struct *tty,
984 struct quatech_port *qt_port)
986 int timeout = HZ / 10;
992 count = qt_chars_in_buffer(tty);
997 interruptible_sleep_on_timeout(&qt_port->wait, timeout);
1001 dev_dbg(&qt_port->port->dev, "%s - TIMEOUT", __func__);
1009 static void qt_close(struct usb_serial_port *port)
1011 struct usb_serial *serial = port->serial;
1012 struct quatech_port *qt_port;
1013 struct quatech_port *port0;
1014 struct tty_struct *tty;
1019 tty = tty_port_tty_get(&port->port);
1020 index = tty->index - serial->minor;
1022 qt_port = qt_get_port_private(port);
1023 port0 = qt_get_port_private(serial->port[0]);
1025 /* shutdown any bulk reads that might be going on */
1026 if (serial->num_bulk_out)
1027 usb_unlink_urb(port->write_urb);
1028 if (serial->num_bulk_in)
1029 usb_unlink_urb(port->read_urb);
1031 /* wait up to for transmitter to empty */
1033 qt_block_until_empty(tty, qt_port);
1036 /* Close uart channel */
1037 status = qt_close_channel(serial, index);
1040 "%s - port %d qt_close_channel failed.\n",
1041 __func__, port->number);
1043 port0->open_ports--;
1045 dev_dbg(&port->dev, "qt_num_open_ports in close%d:in port%d\n",
1046 port0->open_ports, port->number);
1048 if (port0->open_ports == 0) {
1049 if (serial->port[0]->interrupt_in_urb) {
1050 dev_dbg(&port->dev, "Shutdown interrupt_in_urb\n");
1051 usb_kill_urb(serial->port[0]->interrupt_in_urb);
1056 if (qt_port->write_urb) {
1057 /* if this urb had a transfer buffer already (old tx) free it */
1058 kfree(qt_port->write_urb->transfer_buffer);
1059 usb_free_urb(qt_port->write_urb);
1064 static int qt_write(struct tty_struct *tty, struct usb_serial_port *port,
1065 const unsigned char *buf, int count)
1068 struct usb_serial *serial = get_usb_serial(port, __func__);
1075 "%s - write request of 0 bytes\n", __func__);
1079 /* only do something if we have a bulk out endpoint */
1080 if (serial->num_bulk_out) {
1081 if (port->write_urb->status == -EINPROGRESS) {
1082 dev_dbg(&port->dev, "%s - already writing\n", __func__);
1087 (count > port->bulk_out_size) ? port->bulk_out_size : count;
1088 memcpy(port->write_urb->transfer_buffer, buf, count);
1090 /* set up our urb */
1092 usb_fill_bulk_urb(port->write_urb, serial->dev,
1093 usb_sndbulkpipe(serial->dev,
1095 bulk_out_endpointAddress),
1096 port->write_urb->transfer_buffer, count,
1097 qt_write_bulk_callback, port);
1099 /* send the data out the bulk port */
1100 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1103 "%s - failed submitting write urb, error %d\n",
1111 /* no bulk out, so return 0 bytes written */
1115 static int qt_write_room(struct tty_struct *tty)
1117 struct usb_serial_port *port = tty->driver_data;
1118 struct usb_serial *serial;
1119 struct quatech_port *qt_port;
1121 int retval = -EINVAL;
1123 if (port_paranoia_check(port, __func__))
1126 serial = get_usb_serial(port, __func__);
1131 qt_port = qt_get_port_private(port);
1133 mutex_lock(&qt_port->lock);
1135 if (serial->num_bulk_out) {
1136 if (port->write_urb->status != -EINPROGRESS)
1137 retval = port->bulk_out_size;
1140 mutex_unlock(&qt_port->lock);
1145 static int qt_ioctl(struct tty_struct *tty,
1146 unsigned int cmd, unsigned long arg)
1148 struct usb_serial_port *port = tty->driver_data;
1149 struct quatech_port *qt_port = qt_get_port_private(port);
1150 struct usb_serial *serial = get_usb_serial(port, __func__);
1153 dev_dbg(&port->dev, "%s cmd 0x%04x\n", __func__, cmd);
1155 index = tty->index - serial->minor;
1157 if (cmd == TIOCMIWAIT) {
1158 while (qt_port != NULL) {
1159 interruptible_sleep_on(&qt_port->msr_wait);
1160 if (signal_pending(current))
1161 return -ERESTARTSYS;
1163 char diff = qt_port->diff_status;
1166 return -EIO; /* no change => error */
1168 /* Consume all events */
1169 qt_port->diff_status = 0;
1171 if (((arg & TIOCM_RNG)
1172 && (diff & SERIAL_MSR_RI))
1173 || ((arg & TIOCM_DSR)
1174 && (diff & SERIAL_MSR_DSR))
1175 || ((arg & TIOCM_CD)
1176 && (diff & SERIAL_MSR_CD))
1177 || ((arg & TIOCM_CTS)
1178 && (diff & SERIAL_MSR_CTS))) {
1186 dev_dbg(&port->dev, "%s -No ioctl for that one. port = %d\n",
1187 __func__, port->number);
1188 return -ENOIOCTLCMD;
1191 static void qt_set_termios(struct tty_struct *tty,
1192 struct usb_serial_port *port,
1193 struct ktermios *old_termios)
1195 struct ktermios *termios = &tty->termios;
1196 unsigned char new_LCR = 0;
1197 unsigned int cflag = termios->c_cflag;
1199 int baud, divisor, remainder;
1202 index = tty->index - port->serial->minor;
1204 switch (cflag & CSIZE) {
1206 new_LCR |= SERIAL_5_DATA;
1209 new_LCR |= SERIAL_6_DATA;
1212 new_LCR |= SERIAL_7_DATA;
1215 termios->c_cflag &= ~CSIZE;
1216 termios->c_cflag |= CS8;
1218 new_LCR |= SERIAL_8_DATA;
1223 if (cflag & PARENB) {
1225 new_LCR |= SERIAL_ODD_PARITY;
1227 new_LCR |= SERIAL_EVEN_PARITY;
1230 new_LCR |= SERIAL_TWO_STOPB;
1232 new_LCR |= SERIAL_ONE_STOPB;
1234 dev_dbg(&port->dev, "%s - 4\n", __func__);
1236 /* Thats the LCR stuff, go ahead and set it */
1237 baud = tty_get_baud_rate(tty);
1239 /* pick a default, any default... */
1242 dev_dbg(&port->dev, "%s - got baud = %d\n", __func__, baud);
1244 divisor = MAX_BAUD_RATE / baud;
1245 remainder = MAX_BAUD_RATE % baud;
1246 /* Round to nearest divisor */
1247 if (((remainder * 2) >= baud) && (baud != 110))
1251 * Set Baud rate to default and turn off (default)flow control here
1254 qt_setuart(port->serial, index, (unsigned short)divisor, new_LCR);
1256 dev_dbg(&port->dev, "qt_setuart failed\n");
1260 /* Now determine flow control */
1261 if (cflag & CRTSCTS) {
1262 dev_dbg(&port->dev, "%s - Enabling HW flow control port %d\n",
1263 __func__, port->number);
1265 /* Enable RTS/CTS flow control */
1266 status = BoxSetHW_FlowCtrl(port->serial, index, 1);
1269 dev_dbg(&port->dev, "BoxSetHW_FlowCtrl failed\n");
1273 /* Disable RTS/CTS flow control */
1275 "%s - disabling HW flow control port %d\n",
1276 __func__, port->number);
1278 status = BoxSetHW_FlowCtrl(port->serial, index, 0);
1280 dev_dbg(&port->dev, "BoxSetHW_FlowCtrl failed\n");
1286 /* if we are implementing XON/XOFF, set the start and stop character in
1288 if (I_IXOFF(tty) || I_IXON(tty)) {
1289 unsigned char stop_char = STOP_CHAR(tty);
1290 unsigned char start_char = START_CHAR(tty);
1292 BoxSetSW_FlowCtrl(port->serial, index, stop_char,
1296 "BoxSetSW_FlowCtrl (enabled) failed\n");
1299 /* disable SW flow control */
1300 status = BoxDisable_SW_FlowCtrl(port->serial, index);
1303 "BoxSetSW_FlowCtrl (diabling) failed\n");
1306 termios->c_cflag &= ~CMSPAR;
1308 Error cases should be returning the actual bits changed only
1312 static void qt_break(struct tty_struct *tty, int break_state)
1314 struct usb_serial_port *port = tty->driver_data;
1315 struct usb_serial *serial = get_usb_serial(port, __func__);
1316 struct quatech_port *qt_port;
1318 unsigned int result;
1320 index = tty->index - serial->minor;
1322 qt_port = qt_get_port_private(port);
1324 if (break_state == -1)
1329 mutex_lock(&qt_port->lock);
1332 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
1333 QT_BREAK_CONTROL, 0x40, onoff, index, NULL, 0, 300);
1335 mutex_unlock(&qt_port->lock);
1338 static inline int qt_real_tiocmget(struct tty_struct *tty,
1339 struct usb_serial_port *port,
1340 struct usb_serial *serial)
1345 unsigned int result = 0;
1349 index = tty->index - serial->minor;
1351 BoxGetRegister(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1354 BoxGetRegister(port->serial, index,
1355 MODEM_STATUS_REGISTER, &msr);
1360 result = ((mcr & SERIAL_MCR_DTR) ? TIOCM_DTR : 0)
1362 | ((mcr & SERIAL_MCR_RTS) ? TIOCM_RTS : 0)
1364 | ((msr & SERIAL_MSR_CTS) ? TIOCM_CTS : 0)
1366 | ((msr & SERIAL_MSR_CD) ? TIOCM_CAR : 0)
1367 /* Carrier detect is set */
1368 | ((msr & SERIAL_MSR_RI) ? TIOCM_RI : 0)
1369 /* Ring indicator set */
1370 | ((msr & SERIAL_MSR_DSR) ? TIOCM_DSR : 0);
1378 static inline int qt_real_tiocmset(struct tty_struct *tty,
1379 struct usb_serial_port *port,
1380 struct usb_serial *serial,
1388 index = tty->index - serial->minor;
1390 BoxGetRegister(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1395 * Turn off the RTS and DTR and loopback and then only turn on what was
1398 mcr &= ~(SERIAL_MCR_RTS | SERIAL_MCR_DTR | SERIAL_MCR_LOOP);
1399 if (value & TIOCM_RTS)
1400 mcr |= SERIAL_MCR_RTS;
1401 if (value & TIOCM_DTR)
1402 mcr |= SERIAL_MCR_DTR;
1403 if (value & TIOCM_LOOP)
1404 mcr |= SERIAL_MCR_LOOP;
1407 BoxSetRegister(port->serial, index, MODEM_CONTROL_REGISTER, mcr);
1414 static int qt_tiocmget(struct tty_struct *tty)
1416 struct usb_serial_port *port = tty->driver_data;
1417 struct usb_serial *serial = get_usb_serial(port, __func__);
1418 struct quatech_port *qt_port = qt_get_port_private(port);
1424 mutex_lock(&qt_port->lock);
1425 retval = qt_real_tiocmget(tty, port, serial);
1426 mutex_unlock(&qt_port->lock);
1430 static int qt_tiocmset(struct tty_struct *tty,
1431 unsigned int set, unsigned int clear)
1434 struct usb_serial_port *port = tty->driver_data;
1435 struct usb_serial *serial = get_usb_serial(port, __func__);
1436 struct quatech_port *qt_port = qt_get_port_private(port);
1442 mutex_lock(&qt_port->lock);
1443 retval = qt_real_tiocmset(tty, port, serial, set);
1444 mutex_unlock(&qt_port->lock);
1448 static void qt_throttle(struct tty_struct *tty)
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;
1457 qt_port = qt_get_port_private(port);
1459 mutex_lock(&qt_port->lock);
1461 /* pass on to the driver specific version of this function */
1462 qt_port->RxHolding = 1;
1464 mutex_unlock(&qt_port->lock);
1467 static void qt_submit_urb_from_unthrottle(struct usb_serial_port *port,
1468 struct usb_serial *serial)
1472 /* Start reading from the device */
1473 usb_fill_bulk_urb(port->read_urb, serial->dev,
1474 usb_rcvbulkpipe(serial->dev,
1475 port->bulk_in_endpointAddress),
1476 port->read_urb->transfer_buffer,
1477 port->read_urb->transfer_buffer_length,
1478 qt_read_bulk_callback, port);
1480 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1484 "%s - failed restarting read urb, error %d\n",
1488 static void qt_unthrottle(struct tty_struct *tty)
1490 struct usb_serial_port *port = tty->driver_data;
1491 struct usb_serial *serial = get_usb_serial(port, __func__);
1492 struct quatech_port *qt_port;
1497 qt_port = qt_get_port_private(port);
1499 mutex_lock(&qt_port->lock);
1501 if (qt_port->RxHolding == 1) {
1502 dev_dbg(&port->dev, "%s -qt_port->RxHolding == 1\n", __func__);
1504 qt_port->RxHolding = 0;
1505 dev_dbg(&port->dev, "%s - qt_port->RxHolding = 0\n", __func__);
1507 /* if we have a bulk endpoint, start it up */
1508 if ((serial->num_bulk_in) && (qt_port->ReadBulkStopped == 1))
1509 qt_submit_urb_from_unthrottle(port, serial);
1511 mutex_unlock(&qt_port->lock);
1514 static int qt_calc_num_ports(struct usb_serial *serial)
1519 (serial->interface->cur_altsetting->desc.bNumEndpoints - 1) / 2;
1524 static struct usb_serial_driver quatech_device = {
1526 .owner = THIS_MODULE,
1529 .description = DRIVER_DESC,
1530 .id_table = id_table,
1535 .write_room = qt_write_room,
1536 .chars_in_buffer = qt_chars_in_buffer,
1537 .throttle = qt_throttle,
1538 .unthrottle = qt_unthrottle,
1539 .calc_num_ports = qt_calc_num_ports,
1541 .set_termios = qt_set_termios,
1542 .break_ctl = qt_break,
1543 .tiocmget = qt_tiocmget,
1544 .tiocmset = qt_tiocmset,
1545 .attach = qt_startup,
1546 .release = qt_release,
1549 static struct usb_serial_driver * const serial_drivers[] = {
1550 &quatech_device, NULL
1553 module_usb_serial_driver(serial_drivers, id_table);
1555 MODULE_AUTHOR(DRIVER_AUTHOR);
1556 MODULE_DESCRIPTION(DRIVER_DESC);
1557 MODULE_LICENSE("GPL");