2 * This code was developed for the Quatech USB line for linux, it used
3 * much of the code developed by Greg Kroah-Hartman for USB serial devices
7 #include <linux/errno.h>
8 #include <linux/init.h>
9 #include <linux/slab.h>
10 #include <linux/tty.h>
11 #include <linux/tty_driver.h>
12 #include <linux/tty_flip.h>
13 #include <linux/module.h>
14 #include <linux/serial.h>
15 #include <linux/usb.h>
16 #include <linux/usb/serial.h>
17 #include <linux/uaccess.h>
21 /* Version Information */
22 #define DRIVER_VERSION "v2.14"
23 #define DRIVER_AUTHOR "Tim Gobeli, Quatech, Inc"
24 #define DRIVER_DESC "Quatech USB to Serial Driver"
26 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
27 #define QUATECH_SSU100 0xC020 /* SSU100 */
28 #define QUATECH_SSU200 0xC030 /* SSU200 */
29 #define QUATECH_DSU100 0xC040 /* DSU100 */
30 #define QUATECH_DSU200 0xC050 /* DSU200 */
31 #define QUATECH_QSU100 0xC060 /* QSU100 */
32 #define QUATECH_QSU200 0xC070 /* QSU200 */
33 #define QUATECH_ESU100A 0xC080 /* ESU100A */
34 #define QUATECH_ESU100B 0xC081 /* ESU100B */
35 #define QUATECH_ESU200A 0xC0A0 /* ESU200A */
36 #define QUATECH_ESU200B 0xC0A1 /* ESU200B */
37 #define QUATECH_HSU100A 0xC090 /* HSU100A */
38 #define QUATECH_HSU100B 0xC091 /* HSU100B */
39 #define QUATECH_HSU100C 0xC092 /* HSU100C */
40 #define QUATECH_HSU100D 0xC093 /* HSU100D */
41 #define QUATECH_HSU200A 0xC0B0 /* HSU200A */
42 #define QUATECH_HSU200B 0xC0B1 /* HSU200B */
43 #define QUATECH_HSU200C 0xC0B2 /* HSU200C */
44 #define QUATECH_HSU200D 0xC0B3 /* HSU200D */
45 #define QUATECH_SSU100_2 0xC120 /* SSU100_2 */
46 #define QUATECH_DSU100_2 0xC140 /* DSU100_2 */
47 #define QUATECH_DSU400_2 0xC150 /* DSU400_2 */
48 #define QUATECH_QSU100_2 0xC160 /* QSU100_2 */
49 #define QUATECH_QSU400_2 0xC170 /* QSU400_2 */
50 #define QUATECH_ESU400_2 0xC180 /* ESU400_2 */
51 #define QUATECH_ESU100_2 0xC1A0 /* ESU100_2 */
53 #define QT_SET_GET_DEVICE 0xc2
54 #define QT_OPEN_CLOSE_CHANNEL 0xca
55 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
56 #define QT_SET_ATF 0xcd
57 #define QT_GET_SET_REGISTER 0xc0
58 #define QT_GET_SET_UART 0xc1
59 #define QT_HW_FLOW_CONTROL_MASK 0xc5
60 #define QT_SW_FLOW_CONTROL_MASK 0xc6
61 #define QT_SW_FLOW_CONTROL_DISABLE 0xc7
62 #define QT_BREAK_CONTROL 0xc8
64 #define USBD_TRANSFER_DIRECTION_IN 0xc0
65 #define USBD_TRANSFER_DIRECTION_OUT 0x40
67 #define MAX_BAUD_RATE 460800
68 #define MAX_BAUD_REMAINDER 4608
70 #define DIV_LATCH_LS 0x00
71 #define XMT_HOLD_REGISTER 0x00
72 #define XVR_BUFFER_REGISTER 0x00
73 #define DIV_LATCH_MS 0x01
74 #define FIFO_CONTROL_REGISTER 0x02
75 #define LINE_CONTROL_REGISTER 0x03
76 #define MODEM_CONTROL_REGISTER 0x04
77 #define LINE_STATUS_REGISTER 0x05
78 #define MODEM_STATUS_REGISTER 0x06
80 #define SERIAL_MCR_DTR 0x01
81 #define SERIAL_MCR_RTS 0x02
82 #define SERIAL_MCR_LOOP 0x10
84 #define SERIAL_MSR_CTS 0x10
85 #define SERIAL_MSR_CD 0x80
86 #define SERIAL_MSR_RI 0x40
87 #define SERIAL_MSR_DSR 0x20
88 #define SERIAL_MSR_MASK 0xf0
90 #define SERIAL_8_DATA 0x03
91 #define SERIAL_7_DATA 0x02
92 #define SERIAL_6_DATA 0x01
93 #define SERIAL_5_DATA 0x00
95 #define SERIAL_ODD_PARITY 0X08
96 #define SERIAL_EVEN_PARITY 0X18
97 #define SERIAL_TWO_STOPB 0x04
98 #define SERIAL_ONE_STOPB 0x00
100 #define DEFAULT_DIVISOR 0x30 /* gives 9600 baud rate */
101 #define DEFAULT_LCR SERIAL_8_DATA /* 8, none , 1 */
103 #define FULLPWRBIT 0x00000080
104 #define NEXT_BOARD_POWER_BIT 0x00000004
106 #define SERIAL_LSR_OE 0x02
107 #define SERIAL_LSR_PE 0x04
108 #define SERIAL_LSR_FE 0x08
109 #define SERIAL_LSR_BI 0x10
111 #define SERIAL_MSR_CTS 0x10
112 #define SERIAL_MSR_CD 0x80
113 #define SERIAL_MSR_RI 0x40
114 #define SERIAL_MSR_DSR 0x20
115 #define SERIAL_MSR_MASK 0xf0
117 #define PREFUFF_LEVEL_CONSERVATIVE 128
118 #define ATC_DISABLED 0x0
120 #define RR_BITS 0x03 /* for clearing clock bits */
121 #define DUPMODE_BITS 0xc0
124 #define LOOPMODE_BITS 0x41 /* LOOP1 = b6, LOOP0 = b0 (PORT B) */
125 #define ALL_LOOPBACK 0x01
126 #define MODEM_CTRL 0x40
127 #define RS232_MODE 0x00
129 static struct usb_device_id serqt_id_table[] = {
130 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100)},
131 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU200)},
132 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU100)},
133 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU200)},
134 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU100)},
135 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU200)},
136 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100A)},
137 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100B)},
138 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU200A)},
139 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU200B)},
140 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100A)},
141 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100B)},
142 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100C)},
143 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU100D)},
144 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200A)},
145 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200B)},
146 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200C)},
147 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_HSU200D)},
148 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100_2)},
149 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU100_2)},
150 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU400_2)},
151 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU100_2)},
152 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU400_2)},
153 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU400_2)},
154 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU100_2)},
155 {} /* Terminating entry */
158 MODULE_DEVICE_TABLE(usb, serqt_id_table);
160 struct qt_get_device_data {
166 struct qt_open_channel_data {
171 struct quatech_port {
172 int port_num; /* number of the port */
173 struct urb *write_urb; /* write URB for this port */
174 struct urb *read_urb; /* read URB for this port */
177 __u8 shadowLCR; /* last LCR value received */
178 __u8 shadowMCR; /* last MCR value received */
179 __u8 shadowMSR; /* last MSR value received */
180 __u8 shadowLSR; /* last LSR value received */
183 /* Used for TIOCMIWAIT */
184 wait_queue_head_t msr_wait;
185 char prev_status, diff_status;
187 wait_queue_head_t wait;
189 struct async_icount icount;
191 struct usb_serial_port *port; /* owner of this object */
192 struct qt_get_device_data DeviceData;
200 static struct usb_driver serqt_usb_driver = {
201 .name = "quatech-usb-serial",
202 .probe = usb_serial_probe,
203 .disconnect = usb_serial_disconnect,
204 .id_table = serqt_id_table,
208 static int port_paranoia_check(struct usb_serial_port *port,
209 const char *function)
212 dbg("%s - port == NULL", function);
216 dbg("%s - port->serial == NULL\n", function);
223 static int serial_paranoia_check(struct usb_serial *serial,
224 const char *function)
227 dbg("%s - serial == NULL\n", function);
232 dbg("%s - serial->type == NULL!", function);
239 static inline struct quatech_port *qt_get_port_private(struct usb_serial_port
242 return (struct quatech_port *)usb_get_serial_port_data(port);
245 static inline void qt_set_port_private(struct usb_serial_port *port,
246 struct quatech_port *data)
248 usb_set_serial_port_data(port, (void *)data);
251 static struct usb_serial *get_usb_serial(struct usb_serial_port *port,
252 const char *function)
254 /* if no port was specified, or it fails a paranoia check */
256 port_paranoia_check(port, function) ||
257 serial_paranoia_check(port->serial, function)) {
259 * then say that we dont have a valid usb_serial thing,
260 * which will end up genrating -ENODEV return values
268 static void ProcessLineStatus(struct quatech_port *qt_port,
269 unsigned char line_status)
273 line_status & (SERIAL_LSR_OE | SERIAL_LSR_PE | SERIAL_LSR_FE |
278 static void ProcessModemStatus(struct quatech_port *qt_port,
279 unsigned char modem_status)
282 qt_port->shadowMSR = modem_status;
283 wake_up_interruptible(&qt_port->wait);
287 static void ProcessRxChar(struct tty_struct *tty, struct usb_serial_port *port,
290 struct urb *urb = port->read_urb;
291 if (urb->actual_length)
292 tty_insert_flip_char(tty, data, TTY_NORMAL);
295 static void qt_write_bulk_callback(struct urb *urb)
297 struct tty_struct *tty;
299 struct quatech_port *quatech_port;
301 status = urb->status;
304 dbg("nonzero write bulk status received:%d\n", status);
308 quatech_port = urb->context;
310 dbg("%s - port %d\n", __func__, quatech_port->port_num);
312 tty = tty_port_tty_get(&quatech_port->port->port);
319 static void qt_interrupt_callback(struct urb *urb)
324 static void qt_read_bulk_callback(struct urb *urb)
327 struct usb_serial_port *port = urb->context;
328 struct usb_serial *serial = get_usb_serial(port, __func__);
329 struct quatech_port *qt_port = qt_get_port_private(port);
331 struct tty_struct *tty;
333 unsigned int RxCount;
338 qt_port->ReadBulkStopped = 1;
339 dbg("%s - nonzero write bulk status received: %d\n",
340 __func__, urb->status);
344 tty = tty_port_tty_get(&port->port);
346 dbg("%s - bad tty pointer - exiting", __func__);
350 data = urb->transfer_buffer;
352 RxCount = urb->actual_length;
354 /* index = MINOR(port->tty->device) - serial->minor; */
355 index = tty->index - serial->minor;
357 dbg("%s - port %d\n", __func__, port->number);
358 dbg("%s - port->RxHolding = %d\n", __func__, qt_port->RxHolding);
360 if (port_paranoia_check(port, __func__) != 0) {
361 dbg("%s - port_paranoia_check, exiting\n", __func__);
362 qt_port->ReadBulkStopped = 1;
367 dbg("%s - bad serial pointer, exiting\n", __func__);
370 if (qt_port->closePending == 1) {
371 /* Were closing , stop reading */
372 dbg("%s - (qt_port->closepending == 1\n", __func__);
373 qt_port->ReadBulkStopped = 1;
378 * RxHolding is asserted by throttle, if we assert it, we're not
379 * receiving any more characters and let the box handle the flow
382 if (qt_port->RxHolding == 1) {
383 qt_port->ReadBulkStopped = 1;
388 qt_port->ReadBulkStopped = 1;
390 dbg("%s - nonzero read bulk status received: %d\n",
391 __func__, urb->status);
395 if (tty && RxCount) {
397 for (i = 0; i < RxCount; ++i) {
398 /* Look ahead code here */
399 if ((i <= (RxCount - 3)) && (data[i] == 0x1b)
400 && (data[i + 1] == 0x1b)) {
402 switch (data[i + 2]) {
404 /* line status change 4th byte must follow */
405 if (i > (RxCount - 4)) {
406 dbg("Illegal escape seuences in received data\n");
409 ProcessLineStatus(qt_port, data[i + 3]);
415 /* Modem status status change 4th byte must follow */
416 dbg("Modem status status. \n");
417 if (i > (RxCount - 4)) {
418 dbg("Illegal escape sequences in received data\n");
421 ProcessModemStatus(qt_port,
427 dbg("No status sequence. \n");
430 ProcessRxChar(tty, port, data[i]);
431 ProcessRxChar(tty, port, data[i + 1]);
440 if (tty && urb->actual_length)
441 tty_insert_flip_char(tty, data[i], TTY_NORMAL);
444 tty_flip_buffer_push(tty);
447 /* Continue trying to always read */
448 usb_fill_bulk_urb(port->read_urb, serial->dev,
449 usb_rcvbulkpipe(serial->dev,
450 port->bulk_in_endpointAddress),
451 port->read_urb->transfer_buffer,
452 port->read_urb->transfer_buffer_length,
453 qt_read_bulk_callback, port);
454 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
456 dbg("%s - failed resubmitting read urb, error %d",
459 if (tty && RxCount) {
460 tty_flip_buffer_push(tty);
461 tty_schedule_flip(tty);
465 schedule_work(&port->work);
470 * Issue a GET_DEVICE vendor-specific request on the default control pipe If
471 * successful, fills in the qt_get_device_data structure pointed to by
472 * device_data, otherwise return a negative error number of the problem.
475 static int qt_get_device(struct usb_serial *serial,
476 struct qt_get_device_data *device_data)
479 unsigned char *transfer_buffer;
482 kmalloc(sizeof(struct qt_get_device_data), GFP_KERNEL);
483 if (!transfer_buffer)
486 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
487 QT_SET_GET_DEVICE, 0xc0, 0, 0,
489 sizeof(struct qt_get_device_data), 300);
491 memcpy(device_data, transfer_buffer,
492 sizeof(struct qt_get_device_data));
493 kfree(transfer_buffer);
498 /****************************************************************************
499 * BoxSetPrebufferLevel
500 TELLS BOX WHEN TO ASSERT FLOW CONTROL
501 ****************************************************************************/
502 static int BoxSetPrebufferLevel(struct usb_serial *serial)
507 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
508 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
509 QT_GET_SET_PREBUF_TRIG_LVL, 0x40,
510 buffer_length, 0, NULL, 0, 300);
514 /****************************************************************************
516 TELLS BOX WHEN TO ASSERT automatic transmitter control
517 ****************************************************************************/
518 static int BoxSetATC(struct usb_serial *serial, __u16 n_Mode)
523 buffer_length = PREFUFF_LEVEL_CONSERVATIVE;
526 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
527 QT_SET_ATF, 0x40, n_Mode, 0, NULL, 0, 300);
534 * Issue a SET_DEVICE vendor-specific request on the default control pipe If
535 * successful returns the number of bytes written, otherwise it returns a
536 * negative error number of the problem.
538 static int qt_set_device(struct usb_serial *serial,
539 struct qt_get_device_data *device_data)
545 PortSettings = ((__u16) (device_data->portb));
546 PortSettings = (PortSettings << 8);
547 PortSettings += ((__u16) (device_data->porta));
549 length = sizeof(struct qt_get_device_data);
550 dbg("%s - PortSettings = 0x%x\n", __func__, PortSettings);
552 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
553 QT_SET_GET_DEVICE, 0x40, PortSettings,
558 static int qt_open_channel(struct usb_serial *serial, __u16 Uart_Number,
559 struct qt_open_channel_data *pDeviceData)
563 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
564 QT_OPEN_CLOSE_CHANNEL,
565 USBD_TRANSFER_DIRECTION_IN, 1, Uart_Number,
567 sizeof(struct qt_open_channel_data), 300);
573 static int qt_close_channel(struct usb_serial *serial, __u16 Uart_Number)
577 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
578 QT_OPEN_CLOSE_CHANNEL,
579 USBD_TRANSFER_DIRECTION_OUT, 0, Uart_Number,
586 /****************************************************************************
588 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
589 * If successful, fills in the pValue with the register value asked for
590 ****************************************************************************/
591 static int BoxGetRegister(struct usb_serial *serial, unsigned short Uart_Number,
592 unsigned short Register_Num, __u8 *pValue)
595 __u16 current_length;
597 current_length = sizeof(struct qt_get_device_data);
600 usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
601 QT_GET_SET_REGISTER, 0xC0, Register_Num,
602 Uart_Number, (void *)pValue, sizeof(*pValue), 300);
607 /****************************************************************************
609 * issuse a GET_REGISTER vendor-spcific request on the default control pipe
610 * If successful, fills in the pValue with the register value asked for
611 ****************************************************************************/
612 static int BoxSetRegister(struct usb_serial *serial, unsigned short Uart_Number,
613 unsigned short Register_Num, unsigned short Value)
616 unsigned short RegAndByte;
619 RegAndByte = RegAndByte << 8;
620 RegAndByte = RegAndByte + Register_Num;
623 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
624 QT_GET_SET_REGISTER, 0xC0, Register_Num,
625 Uart_Number, NULL, 0, 300);
629 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
630 QT_GET_SET_REGISTER, 0x40, RegAndByte, Uart_Number,
638 * issuse a SET_UART vendor-spcific request on the default control pipe
639 * If successful sets baud rate divisor and LCR value
641 static int qt_setuart(struct usb_serial *serial, unsigned short Uart_Number,
642 unsigned short default_divisor, unsigned char default_LCR)
645 unsigned short UartNumandLCR;
647 UartNumandLCR = (default_LCR << 8) + Uart_Number;
650 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
651 QT_GET_SET_UART, 0x40, default_divisor,
652 UartNumandLCR, NULL, 0, 300);
657 static int BoxSetHW_FlowCtrl(struct usb_serial *serial, unsigned int index,
661 __u8 msr = 0, MOUT_Value = 0;
665 /* flow control, box will clear RTS line to prevent remote */
666 mcr = SERIAL_MCR_RTS;
667 } /* device from xmitting more chars */
669 /* no flow control to remote device */
673 MOUT_Value = mcr << 8;
676 /* flow control, box will inhibit xmit data if CTS line is
678 msr = SERIAL_MSR_CTS;
680 /* Box will not inhimbe xmit data due to CTS line */
686 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
687 QT_HW_FLOW_CONTROL_MASK, 0x40, MOUT_Value,
688 index, NULL, 0, 300);
693 static int BoxSetSW_FlowCtrl(struct usb_serial *serial, __u16 index,
694 unsigned char stop_char, unsigned char start_char)
699 nSWflowout = start_char << 8;
700 nSWflowout = (unsigned short)stop_char;
703 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
704 QT_SW_FLOW_CONTROL_MASK, 0x40, nSWflowout,
705 index, NULL, 0, 300);
710 static int BoxDisable_SW_FlowCtrl(struct usb_serial *serial, __u16 index)
715 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
716 QT_SW_FLOW_CONTROL_DISABLE, 0x40, 0, index,
722 static int qt_startup(struct usb_serial *serial)
724 struct usb_serial_port *port;
725 struct quatech_port *qt_port;
726 struct qt_get_device_data DeviceData;
730 dbg("enterting %s", __func__);
732 /* Now setup per port private data */
733 for (i = 0; i < serial->num_ports; i++) {
734 port = serial->port[i];
735 qt_port = kzalloc(sizeof(*qt_port), GFP_KERNEL);
737 dbg("%s: kmalloc for quatech_port (%d) failed!.",
741 spin_lock_init(&qt_port->lock);
743 usb_set_serial_port_data(port, qt_port);
747 status = qt_get_device(serial, &DeviceData);
749 dbg(__FILE__ "box_get_device failed");
753 dbg(__FILE__ "DeviceData.portb = 0x%x", DeviceData.portb);
755 DeviceData.portb &= ~FULLPWRBIT;
756 dbg(__FILE__ "Changing DeviceData.portb to 0x%x", DeviceData.portb);
758 status = qt_set_device(serial, &DeviceData);
760 dbg(__FILE__ "qt_set_device failed\n");
764 status = qt_get_device(serial, &DeviceData);
766 dbg(__FILE__ "qt_get_device failed");
770 switch (serial->dev->descriptor.idProduct) {
774 case QUATECH_ESU100A:
775 case QUATECH_ESU100B:
776 case QUATECH_HSU100A:
777 case QUATECH_HSU100B:
778 case QUATECH_HSU100C:
779 case QUATECH_HSU100D:
780 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
781 DeviceData.porta |= CLKS_X4;
782 DeviceData.portb &= ~(LOOPMODE_BITS);
783 DeviceData.portb |= RS232_MODE;
789 case QUATECH_ESU200A:
790 case QUATECH_ESU200B:
791 case QUATECH_HSU200A:
792 case QUATECH_HSU200B:
793 case QUATECH_HSU200C:
794 case QUATECH_HSU200D:
795 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
796 DeviceData.porta |= CLKS_X4;
797 DeviceData.portb &= ~(LOOPMODE_BITS);
798 DeviceData.portb |= ALL_LOOPBACK;
801 DeviceData.porta &= ~(RR_BITS | DUPMODE_BITS);
802 DeviceData.porta |= CLKS_X4;
803 DeviceData.portb &= ~(LOOPMODE_BITS);
804 DeviceData.portb |= RS232_MODE;
809 status = BoxSetPrebufferLevel(serial); /* sets to default value */
811 dbg(__FILE__ "BoxSetPrebufferLevel failed\n");
815 status = BoxSetATC(serial, ATC_DISABLED);
817 dbg(__FILE__ "BoxSetATC failed\n");
821 dbg(__FILE__ "DeviceData.portb = 0x%x", DeviceData.portb);
823 DeviceData.portb |= NEXT_BOARD_POWER_BIT;
824 dbg(__FILE__ "Changing DeviceData.portb to 0x%x", DeviceData.portb);
826 status = qt_set_device(serial, &DeviceData);
828 dbg(__FILE__ "qt_set_device failed\n");
832 dbg("Exit Success %s\n", __func__);
837 for (i = 0; i < serial->num_ports; i++) {
838 port = serial->port[i];
839 qt_port = qt_get_port_private(port);
841 usb_set_serial_port_data(port, NULL);
844 dbg("Exit fail %s\n", __func__);
849 static void qt_release(struct usb_serial *serial)
851 struct usb_serial_port *port;
852 struct quatech_port *qt_port;
855 dbg("enterting %s", __func__);
857 for (i = 0; i < serial->num_ports; i++) {
858 port = serial->port[i];
862 qt_port = usb_get_serial_port_data(port);
864 usb_set_serial_port_data(port, NULL);
869 static int qt_open(struct tty_struct *tty,
870 struct usb_serial_port *port, struct file *filp)
872 struct usb_serial *serial;
873 struct quatech_port *quatech_port;
874 struct quatech_port *port0;
875 struct qt_open_channel_data ChannelData;
879 if (port_paranoia_check(port, __func__))
882 dbg("%s - port %d\n", __func__, port->number);
884 serial = port->serial;
886 if (serial_paranoia_check(serial, __func__))
889 quatech_port = qt_get_port_private(port);
890 port0 = qt_get_port_private(serial->port[0]);
892 if (quatech_port == NULL || port0 == NULL)
895 usb_clear_halt(serial->dev, port->write_urb->pipe);
896 usb_clear_halt(serial->dev, port->read_urb->pipe);
899 result = qt_get_device(serial, &port0->DeviceData);
901 /* Port specific setups */
902 result = qt_open_channel(serial, port->number, &ChannelData);
904 dbg(__FILE__ "qt_open_channel failed\n");
907 dbg(__FILE__ "qt_open_channel completed.\n");
909 /* FIXME: are these needed? Does it even do anything useful? */
910 quatech_port->shadowLSR = ChannelData.line_status &
911 (SERIAL_LSR_OE | SERIAL_LSR_PE | SERIAL_LSR_FE | SERIAL_LSR_BI);
913 quatech_port->shadowMSR = ChannelData.modem_status &
914 (SERIAL_MSR_CTS | SERIAL_MSR_DSR | SERIAL_MSR_RI | SERIAL_MSR_CD);
916 /* Set Baud rate to default and turn off (default)flow control here */
917 result = qt_setuart(serial, port->number, DEFAULT_DIVISOR, DEFAULT_LCR);
919 dbg(__FILE__ "qt_setuart failed\n");
922 dbg(__FILE__ "qt_setuart completed.\n");
925 * Put this here to make it responsive to stty and defauls set by
928 /* FIXME: is this needed? */
929 /* qt_set_termios(tty, port, NULL); */
931 /* Check to see if we've set up our endpoint info yet */
932 if (port0->open_ports == 1) {
933 if (serial->port[0]->interrupt_in_buffer == NULL) {
934 /* set up interrupt urb */
935 usb_fill_int_urb(serial->port[0]->interrupt_in_urb,
937 usb_rcvintpipe(serial->dev,
938 serial->port[0]->interrupt_in_endpointAddress),
939 serial->port[0]->interrupt_in_buffer,
941 interrupt_in_urb->transfer_buffer_length,
942 qt_interrupt_callback, serial,
944 interrupt_in_urb->interval);
947 usb_submit_urb(serial->port[0]->interrupt_in_urb,
951 "%s - Error %d submitting "
952 "interrupt urb\n", __func__, result);
959 dbg("port number is %d \n", port->number);
960 dbg("serial number is %d \n", port->serial->minor);
961 dbg("Bulkin endpoint is %d \n", port->bulk_in_endpointAddress);
962 dbg("BulkOut endpoint is %d \n", port->bulk_out_endpointAddress);
963 dbg("Interrupt endpoint is %d \n", port->interrupt_in_endpointAddress);
964 dbg("port's number in the device is %d\n", quatech_port->port_num);
965 quatech_port->read_urb = port->read_urb;
967 /* set up our bulk in urb */
969 usb_fill_bulk_urb(quatech_port->read_urb,
971 usb_rcvbulkpipe(serial->dev,
972 port->bulk_in_endpointAddress),
973 port->bulk_in_buffer,
974 quatech_port->read_urb->transfer_buffer_length,
975 qt_read_bulk_callback, quatech_port);
977 dbg("qt_open: bulkin endpoint is %d\n", port->bulk_in_endpointAddress);
978 quatech_port->read_urb_busy = true;
979 result = usb_submit_urb(quatech_port->read_urb, GFP_KERNEL);
982 "%s - Error %d submitting control urb\n",
984 quatech_port->read_urb_busy = false;
987 /* initialize our wait queues */
988 init_waitqueue_head(&quatech_port->wait);
989 init_waitqueue_head(&quatech_port->msr_wait);
991 /* initialize our icount structure */
992 memset(&(quatech_port->icount), 0x00, sizeof(quatech_port->icount));
998 static int qt_chars_in_buffer(struct tty_struct *tty)
1000 struct usb_serial_port *port = tty->driver_data;
1001 struct usb_serial *serial;
1004 serial = get_usb_serial(port, __func__);
1006 dbg("%s - port %d\n", __func__, port->number);
1008 if (serial->num_bulk_out) {
1009 if (port->write_urb->status == -EINPROGRESS)
1010 chars = port->write_urb->transfer_buffer_length;
1013 dbg("%s - returns %d\n", __func__, chars);
1018 static void qt_block_until_empty(struct tty_struct *tty,
1019 struct quatech_port *qt_port)
1021 int timeout = HZ / 10;
1027 count = qt_chars_in_buffer(tty);
1032 interruptible_sleep_on_timeout(&qt_port->wait, timeout);
1036 dbg("%s - TIMEOUT", __func__);
1044 static void qt_close( struct usb_serial_port *port)
1046 struct usb_serial *serial = port->serial;
1047 struct quatech_port *qt_port;
1048 struct quatech_port *port0;
1049 struct tty_struct *tty;
1054 dbg("%s - port %d\n", __func__, port->number);
1056 tty = tty_port_tty_get(&port->port);
1057 index = tty->index - serial->minor;
1059 qt_port = qt_get_port_private(port);
1060 port0 = qt_get_port_private(serial->port[0]);
1062 /* shutdown any bulk reads that might be going on */
1063 if (serial->num_bulk_out)
1064 usb_unlink_urb(port->write_urb);
1065 if (serial->num_bulk_in)
1066 usb_unlink_urb(port->read_urb);
1068 /* wait up to for transmitter to empty */
1070 qt_block_until_empty(tty, qt_port);
1072 /* Close uart channel */
1073 status = qt_close_channel(serial, index);
1075 dbg("%s - port %d qt_close_channel failed.\n",
1076 __func__, port->number);
1078 port0->open_ports--;
1080 dbg("qt_num_open_ports in close%d:in port%d\n",
1081 port0->open_ports, port->number);
1083 if (port0->open_ports == 0) {
1084 if (serial->port[0]->interrupt_in_urb) {
1085 dbg("%s", "Shutdown interrupt_in_urb\n");
1086 usb_kill_urb(serial->port[0]->interrupt_in_urb);
1091 if (qt_port->write_urb) {
1092 /* if this urb had a transfer buffer already (old tx) free it */
1093 if (qt_port->write_urb->transfer_buffer != NULL)
1094 kfree(qt_port->write_urb->transfer_buffer);
1095 usb_free_urb(qt_port->write_urb);
1100 static int qt_write(struct tty_struct *tty, struct usb_serial_port *port,
1101 const unsigned char *buf, int count)
1104 struct usb_serial *serial = get_usb_serial(port, __func__);
1109 dbg("%s - port %d\n", __func__, port->number);
1112 dbg("%s - write request of 0 bytes\n", __func__);
1116 /* only do something if we have a bulk out endpoint */
1117 if (serial->num_bulk_out) {
1118 if (port->write_urb->status == -EINPROGRESS) {
1119 dbg("%s - already writing\n", __func__);
1124 (count > port->bulk_out_size) ? port->bulk_out_size : count;
1125 memcpy(port->write_urb->transfer_buffer, buf, count);
1127 /* set up our urb */
1129 usb_fill_bulk_urb(port->write_urb, serial->dev,
1130 usb_sndbulkpipe(serial->dev,
1132 bulk_out_endpointAddress),
1133 port->write_urb->transfer_buffer, count,
1134 qt_write_bulk_callback, port);
1136 /* send the data out the bulk port */
1137 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1139 dbg("%s - failed submitting write urb, error %d\n",
1147 /* no bulk out, so return 0 bytes written */
1151 static int qt_write_room(struct tty_struct *tty)
1153 struct usb_serial_port *port = tty->driver_data;
1154 struct usb_serial *serial;
1155 struct quatech_port *qt_port;
1156 unsigned long flags;
1158 int retval = -EINVAL;
1160 if (port_paranoia_check(port, __func__)) {
1161 dbg("%s", "Invalid port\n");
1165 serial = get_usb_serial(port, __func__);
1170 qt_port = qt_get_port_private(port);
1172 spin_lock_irqsave(&qt_port->lock, flags);
1174 dbg("%s - port %d\n", __func__, port->number);
1176 if (serial->num_bulk_out) {
1177 if (port->write_urb->status != -EINPROGRESS)
1178 retval = port->bulk_out_size;
1181 spin_unlock_irqrestore(&qt_port->lock, flags);
1186 static int qt_ioctl(struct tty_struct *tty, struct file *file,
1187 unsigned int cmd, unsigned long arg)
1189 struct usb_serial_port *port = tty->driver_data;
1190 struct quatech_port *qt_port = qt_get_port_private(port);
1191 struct usb_serial *serial = get_usb_serial(port, __func__);
1194 dbg("%s cmd 0x%04x", __func__, cmd);
1196 index = tty->index - serial->minor;
1198 if (cmd == TIOCMIWAIT) {
1199 while (qt_port != NULL) {
1200 interruptible_sleep_on(&qt_port->msr_wait);
1201 if (signal_pending(current))
1202 return -ERESTARTSYS;
1204 char diff = qt_port->diff_status;
1207 return -EIO; /* no change => error */
1209 /* Consume all events */
1210 qt_port->diff_status = 0;
1212 if (((arg & TIOCM_RNG)
1213 && (diff & SERIAL_MSR_RI))
1214 || ((arg & TIOCM_DSR)
1215 && (diff & SERIAL_MSR_DSR))
1216 || ((arg & TIOCM_CD)
1217 && (diff & SERIAL_MSR_CD))
1218 || ((arg & TIOCM_CTS)
1219 && (diff & SERIAL_MSR_CTS))) {
1227 dbg("%s -No ioctl for that one. port = %d\n", __func__, port->number);
1228 return -ENOIOCTLCMD;
1231 static void qt_set_termios(struct tty_struct *tty,
1232 struct usb_serial_port *port,
1233 struct ktermios *old_termios)
1235 struct ktermios *termios = tty->termios;
1236 unsigned char new_LCR = 0;
1237 unsigned int cflag = termios->c_cflag;
1239 int baud, divisor, remainder;
1242 dbg("%s", __func__);
1244 index = tty->index - port->serial->minor;
1248 new_LCR |= SERIAL_5_DATA;
1251 new_LCR |= SERIAL_6_DATA;
1254 new_LCR |= SERIAL_7_DATA;
1258 new_LCR |= SERIAL_8_DATA;
1263 if (cflag & PARENB) {
1265 new_LCR |= SERIAL_ODD_PARITY;
1267 new_LCR |= SERIAL_EVEN_PARITY;
1270 new_LCR |= SERIAL_TWO_STOPB;
1272 new_LCR |= SERIAL_TWO_STOPB;
1274 dbg("%s - 4\n", __func__);
1276 /* Thats the LCR stuff, go ahead and set it */
1277 baud = tty_get_baud_rate(tty);
1279 /* pick a default, any default... */
1282 dbg("%s - got baud = %d\n", __func__, baud);
1284 divisor = MAX_BAUD_RATE / baud;
1285 remainder = MAX_BAUD_RATE % baud;
1286 /* Round to nearest divisor */
1287 if (((remainder * 2) >= baud) && (baud != 110))
1291 * Set Baud rate to default and turn off (default)flow control here
1294 qt_setuart(port->serial, index, (unsigned short)divisor, new_LCR);
1296 dbg(__FILE__ "qt_setuart failed\n");
1300 /* Now determine flow control */
1301 if (cflag & CRTSCTS) {
1302 dbg("%s - Enabling HW flow control port %d\n", __func__,
1305 /* Enable RTS/CTS flow control */
1306 status = BoxSetHW_FlowCtrl(port->serial, index, 1);
1309 dbg(__FILE__ "BoxSetHW_FlowCtrl failed\n");
1313 /* Disable RTS/CTS flow control */
1314 dbg("%s - disabling HW flow control port %d\n", __func__,
1317 status = BoxSetHW_FlowCtrl(port->serial, index, 0);
1319 dbg(__FILE__ "BoxSetHW_FlowCtrl failed\n");
1325 /* if we are implementing XON/XOFF, set the start and stop character in
1327 if (I_IXOFF(tty) || I_IXON(tty)) {
1328 unsigned char stop_char = STOP_CHAR(tty);
1329 unsigned char start_char = START_CHAR(tty);
1331 BoxSetSW_FlowCtrl(port->serial, index, stop_char,
1334 dbg(__FILE__ "BoxSetSW_FlowCtrl (enabled) failed\n");
1337 /* disable SW flow control */
1338 status = BoxDisable_SW_FlowCtrl(port->serial, index);
1340 dbg(__FILE__ "BoxSetSW_FlowCtrl (diabling) failed\n");
1343 tty->termios->c_cflag &= ~CMSPAR;
1344 /* FIXME: Error cases should be returning the actual bits changed only */
1347 static void qt_break(struct tty_struct *tty, int break_state)
1349 struct usb_serial_port *port = tty->driver_data;
1350 struct usb_serial *serial = get_usb_serial(port, __func__);
1351 struct quatech_port *qt_port;
1353 unsigned int result;
1354 unsigned long flags;
1356 index = tty->index - serial->minor;
1358 qt_port = qt_get_port_private(port);
1360 if (break_state == -1)
1365 spin_lock_irqsave(&qt_port->lock, flags);
1367 dbg("%s - port %d\n", __func__, port->number);
1370 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
1371 QT_BREAK_CONTROL, 0x40, onoff, index, NULL, 0, 300);
1373 spin_unlock_irqrestore(&qt_port->lock, flags);
1376 static inline int qt_real_tiocmget(struct tty_struct *tty,
1377 struct usb_serial_port *port,
1378 struct file *file, struct usb_serial *serial)
1383 unsigned int result = 0;
1387 dbg("%s - port %d, tty =0x%p\n", __func__, port->number, tty);
1389 index = tty->index - serial->minor;
1391 BoxGetRegister(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1394 BoxGetRegister(port->serial, index,
1395 MODEM_STATUS_REGISTER, &msr);
1400 result = ((mcr & SERIAL_MCR_DTR) ? TIOCM_DTR : 0)
1402 | ((mcr & SERIAL_MCR_RTS) ? TIOCM_RTS : 0)
1404 | ((msr & SERIAL_MSR_CTS) ? TIOCM_CTS : 0)
1406 | ((msr & SERIAL_MSR_CD) ? TIOCM_CAR : 0)
1407 /* Carrier detect is set */
1408 | ((msr & SERIAL_MSR_RI) ? TIOCM_RI : 0)
1409 /* Ring indicator set */
1410 | ((msr & SERIAL_MSR_DSR) ? TIOCM_DSR : 0);
1418 static inline int qt_real_tiocmset(struct tty_struct *tty,
1419 struct usb_serial_port *port,
1421 struct usb_serial *serial,
1429 dbg("%s - port %d\n", __func__, port->number);
1431 index = tty->index - serial->minor;
1433 BoxGetRegister(port->serial, index, MODEM_CONTROL_REGISTER, &mcr);
1438 * Turn off the RTS and DTR and loopbcck and then only turn on what was
1441 mcr &= ~(SERIAL_MCR_RTS | SERIAL_MCR_DTR | SERIAL_MCR_LOOP);
1442 if (value & TIOCM_RTS)
1443 mcr |= SERIAL_MCR_RTS;
1444 if (value & TIOCM_DTR)
1445 mcr |= SERIAL_MCR_DTR;
1446 if (value & TIOCM_LOOP)
1447 mcr |= SERIAL_MCR_LOOP;
1450 BoxSetRegister(port->serial, index, MODEM_CONTROL_REGISTER, mcr);
1457 static int qt_tiocmget(struct tty_struct *tty, struct file *file)
1459 struct usb_serial_port *port = tty->driver_data;
1460 struct usb_serial *serial = get_usb_serial(port, __func__);
1461 struct quatech_port *qt_port = qt_get_port_private(port);
1462 int retval = -ENODEV;
1463 unsigned long flags;
1465 dbg("In %s \n", __func__);
1470 spin_lock_irqsave(&qt_port->lock, flags);
1472 dbg("%s - port %d\n", __func__, port->number);
1473 dbg("%s - port->RxHolding = %d\n", __func__, qt_port->RxHolding);
1475 retval = qt_real_tiocmget(tty, port, file, serial);
1477 spin_unlock_irqrestore(&qt_port->lock, flags);
1481 static int qt_tiocmset(struct tty_struct *tty, struct file *file,
1482 unsigned int set, unsigned int clear)
1485 struct usb_serial_port *port = tty->driver_data;
1486 struct usb_serial *serial = get_usb_serial(port, __func__);
1487 struct quatech_port *qt_port = qt_get_port_private(port);
1488 unsigned long flags;
1489 int retval = -ENODEV;
1491 dbg("In %s \n", __func__);
1496 spin_lock_irqsave(&qt_port->lock, flags);
1498 dbg("%s - port %d \n", __func__, port->number);
1499 dbg("%s - qt_port->RxHolding = %d\n", __func__, qt_port->RxHolding);
1501 retval = qt_real_tiocmset(tty, port, file, serial, set);
1503 spin_unlock_irqrestore(&qt_port->lock, flags);
1507 static void qt_throttle(struct tty_struct *tty)
1509 struct usb_serial_port *port = tty->driver_data;
1510 struct usb_serial *serial = get_usb_serial(port, __func__);
1511 struct quatech_port *qt_port;
1512 unsigned long flags;
1514 dbg("%s - port %d\n", __func__, port->number);
1519 qt_port = qt_get_port_private(port);
1521 spin_lock_irqsave(&qt_port->lock, flags);
1523 /* pass on to the driver specific version of this function */
1524 qt_port->RxHolding = 1;
1525 dbg("%s - port->RxHolding = 1\n", __func__);
1527 spin_unlock_irqrestore(&qt_port->lock, flags);
1531 static void qt_unthrottle(struct tty_struct *tty)
1533 struct usb_serial_port *port = tty->driver_data;
1534 struct usb_serial *serial = get_usb_serial(port, __func__);
1535 struct quatech_port *qt_port;
1536 unsigned long flags;
1537 unsigned int result;
1542 qt_port = qt_get_port_private(port);
1544 spin_lock_irqsave(&qt_port->lock, flags);
1546 dbg("%s - port %d\n", __func__, port->number);
1548 if (qt_port->RxHolding == 1) {
1549 dbg("%s -qt_port->RxHolding == 1\n", __func__);
1551 qt_port->RxHolding = 0;
1552 dbg("%s - qt_port->RxHolding = 0\n", __func__);
1554 /* if we have a bulk endpoint, start it up */
1555 if ((serial->num_bulk_in) && (qt_port->ReadBulkStopped == 1)) {
1556 /* Start reading from the device */
1557 usb_fill_bulk_urb(port->read_urb, serial->dev,
1558 usb_rcvbulkpipe(serial->dev,
1559 port->bulk_in_endpointAddress),
1560 port->read_urb->transfer_buffer,
1562 transfer_buffer_length,
1563 qt_read_bulk_callback, port);
1564 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1566 err("%s - failed restarting read urb, error %d",
1570 spin_unlock_irqrestore(&qt_port->lock, flags);
1575 static int qt_calc_num_ports(struct usb_serial *serial)
1579 dbg("numberofendpoints: %d \n",
1580 (int)serial->interface->cur_altsetting->desc.bNumEndpoints);
1581 dbg("numberofendpoints: %d \n",
1582 (int)serial->interface->altsetting->desc.bNumEndpoints);
1585 (serial->interface->cur_altsetting->desc.bNumEndpoints - 1) / 2;
1590 static struct usb_serial_driver quatech_device = {
1592 .owner = THIS_MODULE,
1595 .description = DRIVER_DESC,
1596 .usb_driver = &serqt_usb_driver,
1597 .id_table = serqt_id_table,
1602 .write_room = qt_write_room,
1603 .chars_in_buffer = qt_chars_in_buffer,
1604 .throttle = qt_throttle,
1605 .unthrottle = qt_unthrottle,
1606 .calc_num_ports = qt_calc_num_ports,
1608 .set_termios = qt_set_termios,
1609 .break_ctl = qt_break,
1610 .tiocmget = qt_tiocmget,
1611 .tiocmset = qt_tiocmset,
1612 .attach = qt_startup,
1613 .release = qt_release,
1616 static int __init serqt_usb_init(void)
1620 dbg("%s\n", __func__);
1622 /* register with usb-serial */
1623 retval = usb_serial_register(&quatech_device);
1626 goto failed_usb_serial_register;
1628 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1631 /* register with usb */
1633 retval = usb_register(&serqt_usb_driver);
1637 /* if we're here, usb_register() failed */
1638 usb_serial_deregister(&quatech_device);
1639 failed_usb_serial_register:
1643 static void __exit serqt_usb_exit(void)
1645 usb_deregister(&serqt_usb_driver);
1646 usb_serial_deregister(&quatech_device);
1649 module_init(serqt_usb_init);
1650 module_exit(serqt_usb_exit);
1652 MODULE_AUTHOR(DRIVER_AUTHOR);
1653 MODULE_DESCRIPTION(DRIVER_DESC);
1654 MODULE_LICENSE("GPL");
1656 module_param(debug, bool, S_IRUGO | S_IWUSR);
1657 MODULE_PARM_DESC(debug, "Debug enabled or not");