Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * usb-serial driver for Quatech USB 2 devices
4 *
5 * Copyright (C) 2012 Bill Pemberton (wfp5p@virginia.edu)
6 *
7 * These devices all have only 1 bulk in and 1 bulk out that is shared
8 * for all serial ports.
9 *
10 */
11
12#include <asm/unaligned.h>
13#include <linux/errno.h>
14#include <linux/slab.h>
15#include <linux/tty.h>
16#include <linux/tty_driver.h>
17#include <linux/tty_flip.h>
18#include <linux/module.h>
19#include <linux/serial.h>
20#include <linux/usb.h>
21#include <linux/usb/serial.h>
22#include <linux/serial_reg.h>
23#include <linux/uaccess.h>
24
25/* default urb timeout for usb operations */
26#define QT2_USB_TIMEOUT USB_CTRL_SET_TIMEOUT
27
28#define QT_OPEN_CLOSE_CHANNEL 0xca
29#define QT_SET_GET_DEVICE 0xc2
30#define QT_SET_GET_REGISTER 0xc0
31#define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
32#define QT_SET_ATF 0xcd
33#define QT_TRANSFER_IN 0xc0
34#define QT_HW_FLOW_CONTROL_MASK 0xc5
35#define QT_SW_FLOW_CONTROL_MASK 0xc6
36#define QT2_BREAK_CONTROL 0xc8
37#define QT2_GET_SET_UART 0xc1
38#define QT2_FLUSH_DEVICE 0xc4
39#define QT2_GET_SET_QMCR 0xe1
40#define QT2_QMCR_RS232 0x40
41#define QT2_QMCR_RS422 0x10
42
43#define SERIAL_CRTSCTS ((UART_MCR_RTS << 8) | UART_MSR_CTS)
44
45#define SERIAL_EVEN_PARITY (UART_LCR_PARITY | UART_LCR_EPAR)
46
47/* status bytes for the device */
48#define QT2_CONTROL_BYTE 0x1b
49#define QT2_LINE_STATUS 0x00 /* following 1 byte is line status */
50#define QT2_MODEM_STATUS 0x01 /* following 1 byte is modem status */
51#define QT2_XMIT_HOLD 0x02 /* following 2 bytes are ?? */
52#define QT2_CHANGE_PORT 0x03 /* following 1 byte is port to change to */
53#define QT2_REC_FLUSH 0x04 /* no following info */
54#define QT2_XMIT_FLUSH 0x05 /* no following info */
55#define QT2_CONTROL_ESCAPE 0xff /* pass through previous 2 control bytes */
56
57#define MAX_BAUD_RATE 921600
58#define DEFAULT_BAUD_RATE 9600
59
60#define QT2_READ_BUFFER_SIZE 512 /* size of read buffer */
61#define QT2_WRITE_BUFFER_SIZE 512 /* size of write buffer */
62#define QT2_WRITE_CONTROL_SIZE 5 /* control bytes used for a write */
63
64#define DRIVER_DESC "Quatech 2nd gen USB to Serial Driver"
65
66#define USB_VENDOR_ID_QUATECH 0x061d
67#define QUATECH_SSU2_100 0xC120 /* RS232 single port */
68#define QUATECH_DSU2_100 0xC140 /* RS232 dual port */
69#define QUATECH_DSU2_400 0xC150 /* RS232/422/485 dual port */
70#define QUATECH_QSU2_100 0xC160 /* RS232 four port */
71#define QUATECH_QSU2_400 0xC170 /* RS232/422/485 four port */
72#define QUATECH_ESU2_100 0xC1A0 /* RS232 eight port */
73#define QUATECH_ESU2_400 0xC180 /* RS232/422/485 eight port */
74
75struct qt2_device_detail {
76 int product_id;
77 int num_ports;
78};
79
80#define QT_DETAILS(prod, ports) \
81 .product_id = (prod), \
82 .num_ports = (ports)
83
84static const struct qt2_device_detail qt2_device_details[] = {
85 {QT_DETAILS(QUATECH_SSU2_100, 1)},
86 {QT_DETAILS(QUATECH_DSU2_400, 2)},
87 {QT_DETAILS(QUATECH_DSU2_100, 2)},
88 {QT_DETAILS(QUATECH_QSU2_400, 4)},
89 {QT_DETAILS(QUATECH_QSU2_100, 4)},
90 {QT_DETAILS(QUATECH_ESU2_400, 8)},
91 {QT_DETAILS(QUATECH_ESU2_100, 8)},
92 {QT_DETAILS(0, 0)} /* Terminating entry */
93};
94
95static const struct usb_device_id id_table[] = {
96 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU2_100)},
97 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU2_100)},
98 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU2_400)},
99 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU2_100)},
100 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU2_400)},
101 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU2_100)},
102 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU2_400)},
103 {} /* Terminating entry */
104};
105MODULE_DEVICE_TABLE(usb, id_table);
106
107struct qt2_serial_private {
108 unsigned char current_port; /* current port for incoming data */
109
110 struct urb *read_urb; /* shared among all ports */
111 char *read_buffer;
112};
113
114struct qt2_port_private {
115 u8 device_port;
116
117 spinlock_t urb_lock;
118 bool urb_in_use;
119 struct urb *write_urb;
120 char *write_buffer;
121
122 spinlock_t lock;
123 u8 shadowLSR;
124 u8 shadowMSR;
125
126 struct usb_serial_port *port;
127};
128
129static void qt2_update_lsr(struct usb_serial_port *port, unsigned char *ch);
130static void qt2_update_msr(struct usb_serial_port *port, unsigned char *ch);
131static void qt2_write_bulk_callback(struct urb *urb);
132static void qt2_read_bulk_callback(struct urb *urb);
133
134static void qt2_release(struct usb_serial *serial)
135{
136 struct qt2_serial_private *serial_priv;
137
138 serial_priv = usb_get_serial_data(serial);
139
140 usb_kill_urb(serial_priv->read_urb);
141 usb_free_urb(serial_priv->read_urb);
142 kfree(serial_priv->read_buffer);
143 kfree(serial_priv);
144}
145
146static inline int calc_baud_divisor(int baudrate)
147{
148 int divisor, rem;
149
150 divisor = MAX_BAUD_RATE / baudrate;
151 rem = MAX_BAUD_RATE % baudrate;
152 /* Round to nearest divisor */
153 if (((rem * 2) >= baudrate) && (baudrate != 110))
154 divisor++;
155
156 return divisor;
157}
158
159static inline int qt2_set_port_config(struct usb_device *dev,
160 unsigned char port_number,
161 u16 baudrate, u16 lcr)
162{
163 int divisor = calc_baud_divisor(baudrate);
164 u16 index = ((u16) (lcr << 8) | (u16) (port_number));
165
166 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
167 QT2_GET_SET_UART, 0x40,
168 divisor, index, NULL, 0, QT2_USB_TIMEOUT);
169}
170
171static inline int qt2_control_msg(struct usb_device *dev,
172 u8 request, u16 data, u16 index)
173{
174 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
175 request, 0x40, data, index,
176 NULL, 0, QT2_USB_TIMEOUT);
177}
178
179static inline int qt2_getregister(struct usb_device *dev,
180 u8 uart,
181 u8 reg,
182 u8 *data)
183{
184 int ret;
185
186 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
187 QT_SET_GET_REGISTER, 0xc0, reg,
188 uart, data, sizeof(*data), QT2_USB_TIMEOUT);
189 if (ret < (int)sizeof(*data)) {
190 if (ret >= 0)
191 ret = -EIO;
192 }
193
194 return ret;
195}
196
197static inline int qt2_setregister(struct usb_device *dev,
198 u8 uart, u8 reg, u16 data)
199{
200 u16 value = (data << 8) | reg;
201
202 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
203 QT_SET_GET_REGISTER, 0x40, value, uart,
204 NULL, 0, QT2_USB_TIMEOUT);
205}
206
207static inline int update_mctrl(struct qt2_port_private *port_priv,
208 unsigned int set, unsigned int clear)
209{
210 struct usb_serial_port *port = port_priv->port;
211 struct usb_device *dev = port->serial->dev;
212 unsigned urb_value;
213 int status;
214
215 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
216 dev_dbg(&port->dev,
217 "update_mctrl - DTR|RTS not being set|cleared\n");
218 return 0; /* no change */
219 }
220
221 clear &= ~set; /* 'set' takes precedence over 'clear' */
222 urb_value = 0;
223 if (set & TIOCM_DTR)
224 urb_value |= UART_MCR_DTR;
225 if (set & TIOCM_RTS)
226 urb_value |= UART_MCR_RTS;
227
228 status = qt2_setregister(dev, port_priv->device_port, UART_MCR,
229 urb_value);
230 if (status < 0)
231 dev_err(&port->dev,
232 "update_mctrl - Error from MODEM_CTRL urb: %i\n",
233 status);
234 return status;
235}
236
237static int qt2_calc_num_ports(struct usb_serial *serial,
238 struct usb_serial_endpoints *epds)
239{
240 struct qt2_device_detail d;
241 int i;
242
243 for (i = 0; d = qt2_device_details[i], d.product_id != 0; i++) {
244 if (d.product_id == le16_to_cpu(serial->dev->descriptor.idProduct))
245 return d.num_ports;
246 }
247
248 /* we didn't recognize the device */
249 dev_err(&serial->dev->dev,
250 "don't know the number of ports, assuming 1\n");
251
252 return 1;
253}
254
255static void qt2_set_termios(struct tty_struct *tty,
256 struct usb_serial_port *port,
257 const struct ktermios *old_termios)
258{
259 struct usb_device *dev = port->serial->dev;
260 struct qt2_port_private *port_priv;
261 struct ktermios *termios = &tty->termios;
262 u16 baud;
263 unsigned int cflag = termios->c_cflag;
264 u16 new_lcr = 0;
265 int status;
266
267 port_priv = usb_get_serial_port_data(port);
268
269 if (cflag & PARENB) {
270 if (cflag & PARODD)
271 new_lcr |= UART_LCR_PARITY;
272 else
273 new_lcr |= SERIAL_EVEN_PARITY;
274 }
275
276 new_lcr |= UART_LCR_WLEN(tty_get_char_size(cflag));
277
278 baud = tty_get_baud_rate(tty);
279 if (!baud)
280 baud = 9600;
281
282 status = qt2_set_port_config(dev, port_priv->device_port, baud,
283 new_lcr);
284 if (status < 0)
285 dev_err(&port->dev, "%s - qt2_set_port_config failed: %i\n",
286 __func__, status);
287
288 if (cflag & CRTSCTS)
289 status = qt2_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
290 SERIAL_CRTSCTS,
291 port_priv->device_port);
292 else
293 status = qt2_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
294 0, port_priv->device_port);
295 if (status < 0)
296 dev_err(&port->dev, "%s - set HW flow control failed: %i\n",
297 __func__, status);
298
299 if (I_IXOFF(tty) || I_IXON(tty)) {
300 u16 x = ((u16) (START_CHAR(tty) << 8) | (u16) (STOP_CHAR(tty)));
301
302 status = qt2_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
303 x, port_priv->device_port);
304 } else
305 status = qt2_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
306 0, port_priv->device_port);
307
308 if (status < 0)
309 dev_err(&port->dev, "%s - set SW flow control failed: %i\n",
310 __func__, status);
311
312}
313
314static int qt2_open(struct tty_struct *tty, struct usb_serial_port *port)
315{
316 struct usb_serial *serial;
317 struct qt2_port_private *port_priv;
318 u8 *data;
319 u16 device_port;
320 int status;
321 unsigned long flags;
322
323 device_port = port->port_number;
324
325 serial = port->serial;
326
327 port_priv = usb_get_serial_port_data(port);
328
329 /* set the port to RS232 mode */
330 status = qt2_control_msg(serial->dev, QT2_GET_SET_QMCR,
331 QT2_QMCR_RS232, device_port);
332 if (status < 0) {
333 dev_err(&port->dev,
334 "%s failed to set RS232 mode for port %i error %i\n",
335 __func__, device_port, status);
336 return status;
337 }
338
339 data = kzalloc(2, GFP_KERNEL);
340 if (!data)
341 return -ENOMEM;
342
343 /* open the port */
344 status = usb_control_msg(serial->dev,
345 usb_rcvctrlpipe(serial->dev, 0),
346 QT_OPEN_CLOSE_CHANNEL,
347 0xc0, 0,
348 device_port, data, 2, QT2_USB_TIMEOUT);
349
350 if (status < 2) {
351 dev_err(&port->dev, "%s - open port failed %i\n", __func__,
352 status);
353 if (status >= 0)
354 status = -EIO;
355 kfree(data);
356 return status;
357 }
358
359 spin_lock_irqsave(&port_priv->lock, flags);
360 port_priv->shadowLSR = data[0];
361 port_priv->shadowMSR = data[1];
362 spin_unlock_irqrestore(&port_priv->lock, flags);
363
364 kfree(data);
365
366 /* set to default speed and 8bit word size */
367 status = qt2_set_port_config(serial->dev, device_port,
368 DEFAULT_BAUD_RATE, UART_LCR_WLEN8);
369 if (status < 0) {
370 dev_err(&port->dev, "%s - initial setup failed (%i)\n",
371 __func__, device_port);
372 return status;
373 }
374
375 port_priv->device_port = (u8) device_port;
376
377 if (tty)
378 qt2_set_termios(tty, port, &tty->termios);
379
380 return 0;
381
382}
383
384static void qt2_close(struct usb_serial_port *port)
385{
386 struct usb_serial *serial;
387 struct qt2_port_private *port_priv;
388 int i;
389
390 serial = port->serial;
391 port_priv = usb_get_serial_port_data(port);
392
393 usb_kill_urb(port_priv->write_urb);
394
395 /* flush the port transmit buffer */
396 i = usb_control_msg(serial->dev,
397 usb_sndctrlpipe(serial->dev, 0),
398 QT2_FLUSH_DEVICE, 0x40, 1,
399 port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
400
401 if (i < 0)
402 dev_err(&port->dev, "%s - transmit buffer flush failed: %i\n",
403 __func__, i);
404
405 /* flush the port receive buffer */
406 i = usb_control_msg(serial->dev,
407 usb_sndctrlpipe(serial->dev, 0),
408 QT2_FLUSH_DEVICE, 0x40, 0,
409 port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
410
411 if (i < 0)
412 dev_err(&port->dev, "%s - receive buffer flush failed: %i\n",
413 __func__, i);
414
415 /* close the port */
416 i = usb_control_msg(serial->dev,
417 usb_sndctrlpipe(serial->dev, 0),
418 QT_OPEN_CLOSE_CHANNEL,
419 0x40, 0,
420 port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
421
422 if (i < 0)
423 dev_err(&port->dev, "%s - close port failed %i\n",
424 __func__, i);
425}
426
427static void qt2_disconnect(struct usb_serial *serial)
428{
429 struct qt2_serial_private *serial_priv = usb_get_serial_data(serial);
430
431 usb_kill_urb(serial_priv->read_urb);
432}
433
434static void qt2_process_status(struct usb_serial_port *port, unsigned char *ch)
435{
436 switch (*ch) {
437 case QT2_LINE_STATUS:
438 qt2_update_lsr(port, ch + 1);
439 break;
440 case QT2_MODEM_STATUS:
441 qt2_update_msr(port, ch + 1);
442 break;
443 }
444}
445
446static void qt2_process_read_urb(struct urb *urb)
447{
448 struct usb_serial *serial;
449 struct qt2_serial_private *serial_priv;
450 struct usb_serial_port *port;
451 bool escapeflag;
452 unsigned char *ch;
453 int i;
454 unsigned char newport;
455 int len = urb->actual_length;
456
457 if (!len)
458 return;
459
460 ch = urb->transfer_buffer;
461 serial = urb->context;
462 serial_priv = usb_get_serial_data(serial);
463 port = serial->port[serial_priv->current_port];
464
465 for (i = 0; i < urb->actual_length; i++) {
466 ch = (unsigned char *)urb->transfer_buffer + i;
467 if ((i <= (len - 3)) &&
468 (*ch == QT2_CONTROL_BYTE) &&
469 (*(ch + 1) == QT2_CONTROL_BYTE)) {
470 escapeflag = false;
471 switch (*(ch + 2)) {
472 case QT2_LINE_STATUS:
473 case QT2_MODEM_STATUS:
474 if (i > (len - 4)) {
475 dev_warn(&port->dev,
476 "%s - status message too short\n",
477 __func__);
478 break;
479 }
480 qt2_process_status(port, ch + 2);
481 i += 3;
482 escapeflag = true;
483 break;
484 case QT2_XMIT_HOLD:
485 if (i > (len - 5)) {
486 dev_warn(&port->dev,
487 "%s - xmit_empty message too short\n",
488 __func__);
489 break;
490 }
491 /* bytes_written = (ch[1] << 4) + ch[0]; */
492 i += 4;
493 escapeflag = true;
494 break;
495 case QT2_CHANGE_PORT:
496 if (i > (len - 4)) {
497 dev_warn(&port->dev,
498 "%s - change_port message too short\n",
499 __func__);
500 break;
501 }
502 tty_flip_buffer_push(&port->port);
503
504 newport = *(ch + 3);
505
506 if (newport > serial->num_ports) {
507 dev_err(&port->dev,
508 "%s - port change to invalid port: %i\n",
509 __func__, newport);
510 break;
511 }
512
513 serial_priv->current_port = newport;
514 port = serial->port[serial_priv->current_port];
515 i += 3;
516 escapeflag = true;
517 break;
518 case QT2_REC_FLUSH:
519 case QT2_XMIT_FLUSH:
520 i += 2;
521 escapeflag = true;
522 break;
523 case QT2_CONTROL_ESCAPE:
524 tty_insert_flip_string(&port->port, ch, 2);
525 i += 2;
526 escapeflag = true;
527 break;
528 default:
529 dev_warn(&port->dev,
530 "%s - unsupported command %i\n",
531 __func__, *(ch + 2));
532 break;
533 }
534 if (escapeflag)
535 continue;
536 }
537
538 tty_insert_flip_char(&port->port, *ch, TTY_NORMAL);
539 }
540
541 tty_flip_buffer_push(&port->port);
542}
543
544static void qt2_write_bulk_callback(struct urb *urb)
545{
546 struct usb_serial_port *port;
547 struct qt2_port_private *port_priv;
548 unsigned long flags;
549
550 port = urb->context;
551 port_priv = usb_get_serial_port_data(port);
552
553 spin_lock_irqsave(&port_priv->urb_lock, flags);
554
555 port_priv->urb_in_use = false;
556 usb_serial_port_softint(port);
557
558 spin_unlock_irqrestore(&port_priv->urb_lock, flags);
559
560}
561
562static void qt2_read_bulk_callback(struct urb *urb)
563{
564 struct usb_serial *serial = urb->context;
565 int status;
566
567 if (urb->status) {
568 dev_warn(&serial->dev->dev,
569 "%s - non-zero urb status: %i\n", __func__,
570 urb->status);
571 return;
572 }
573
574 qt2_process_read_urb(urb);
575
576 status = usb_submit_urb(urb, GFP_ATOMIC);
577 if (status != 0)
578 dev_err(&serial->dev->dev,
579 "%s - resubmit read urb failed: %i\n",
580 __func__, status);
581}
582
583static int qt2_setup_urbs(struct usb_serial *serial)
584{
585 struct usb_serial_port *port0;
586 struct qt2_serial_private *serial_priv;
587 int status;
588
589 port0 = serial->port[0];
590
591 serial_priv = usb_get_serial_data(serial);
592 serial_priv->read_urb = usb_alloc_urb(0, GFP_KERNEL);
593 if (!serial_priv->read_urb)
594 return -ENOMEM;
595
596 usb_fill_bulk_urb(serial_priv->read_urb, serial->dev,
597 usb_rcvbulkpipe(serial->dev,
598 port0->bulk_in_endpointAddress),
599 serial_priv->read_buffer,
600 QT2_READ_BUFFER_SIZE,
601 qt2_read_bulk_callback, serial);
602
603 status = usb_submit_urb(serial_priv->read_urb, GFP_KERNEL);
604 if (status != 0) {
605 dev_err(&serial->dev->dev,
606 "%s - submit read urb failed %i\n", __func__, status);
607 usb_free_urb(serial_priv->read_urb);
608 return status;
609 }
610
611 return 0;
612}
613
614static int qt2_attach(struct usb_serial *serial)
615{
616 struct qt2_serial_private *serial_priv;
617 int status;
618
619 /* power on unit */
620 status = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
621 0xc2, 0x40, 0x8000, 0, NULL, 0,
622 QT2_USB_TIMEOUT);
623 if (status < 0) {
624 dev_err(&serial->dev->dev,
625 "%s - failed to power on unit: %i\n", __func__, status);
626 return status;
627 }
628
629 serial_priv = kzalloc(sizeof(*serial_priv), GFP_KERNEL);
630 if (!serial_priv)
631 return -ENOMEM;
632
633 serial_priv->read_buffer = kmalloc(QT2_READ_BUFFER_SIZE, GFP_KERNEL);
634 if (!serial_priv->read_buffer) {
635 status = -ENOMEM;
636 goto err_buf;
637 }
638
639 usb_set_serial_data(serial, serial_priv);
640
641 status = qt2_setup_urbs(serial);
642 if (status != 0)
643 goto attach_failed;
644
645 return 0;
646
647attach_failed:
648 kfree(serial_priv->read_buffer);
649err_buf:
650 kfree(serial_priv);
651 return status;
652}
653
654static int qt2_port_probe(struct usb_serial_port *port)
655{
656 struct usb_serial *serial = port->serial;
657 struct qt2_port_private *port_priv;
658 u8 bEndpointAddress;
659
660 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
661 if (!port_priv)
662 return -ENOMEM;
663
664 spin_lock_init(&port_priv->lock);
665 spin_lock_init(&port_priv->urb_lock);
666 port_priv->port = port;
667
668 port_priv->write_buffer = kmalloc(QT2_WRITE_BUFFER_SIZE, GFP_KERNEL);
669 if (!port_priv->write_buffer)
670 goto err_buf;
671
672 port_priv->write_urb = usb_alloc_urb(0, GFP_KERNEL);
673 if (!port_priv->write_urb)
674 goto err_urb;
675
676 bEndpointAddress = serial->port[0]->bulk_out_endpointAddress;
677 usb_fill_bulk_urb(port_priv->write_urb, serial->dev,
678 usb_sndbulkpipe(serial->dev, bEndpointAddress),
679 port_priv->write_buffer,
680 QT2_WRITE_BUFFER_SIZE,
681 qt2_write_bulk_callback, port);
682
683 usb_set_serial_port_data(port, port_priv);
684
685 return 0;
686err_urb:
687 kfree(port_priv->write_buffer);
688err_buf:
689 kfree(port_priv);
690 return -ENOMEM;
691}
692
693static void qt2_port_remove(struct usb_serial_port *port)
694{
695 struct qt2_port_private *port_priv;
696
697 port_priv = usb_get_serial_port_data(port);
698 usb_free_urb(port_priv->write_urb);
699 kfree(port_priv->write_buffer);
700 kfree(port_priv);
701}
702
703static int qt2_tiocmget(struct tty_struct *tty)
704{
705 struct usb_serial_port *port = tty->driver_data;
706 struct usb_device *dev = port->serial->dev;
707 struct qt2_port_private *port_priv = usb_get_serial_port_data(port);
708 u8 *d;
709 int r;
710
711 d = kzalloc(2, GFP_KERNEL);
712 if (!d)
713 return -ENOMEM;
714
715 r = qt2_getregister(dev, port_priv->device_port, UART_MCR, d);
716 if (r < 0)
717 goto mget_out;
718
719 r = qt2_getregister(dev, port_priv->device_port, UART_MSR, d + 1);
720 if (r < 0)
721 goto mget_out;
722
723 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
724 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
725 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
726 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
727 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
728 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
729
730mget_out:
731 kfree(d);
732 return r;
733}
734
735static int qt2_tiocmset(struct tty_struct *tty,
736 unsigned int set, unsigned int clear)
737{
738 struct qt2_port_private *port_priv;
739
740 port_priv = usb_get_serial_port_data(tty->driver_data);
741 return update_mctrl(port_priv, set, clear);
742}
743
744static int qt2_break_ctl(struct tty_struct *tty, int break_state)
745{
746 struct usb_serial_port *port = tty->driver_data;
747 struct qt2_port_private *port_priv;
748 int status;
749 u16 val;
750
751 port_priv = usb_get_serial_port_data(port);
752
753 val = (break_state == -1) ? 1 : 0;
754
755 status = qt2_control_msg(port->serial->dev, QT2_BREAK_CONTROL,
756 val, port_priv->device_port);
757 if (status < 0) {
758 dev_warn(&port->dev,
759 "%s - failed to send control message: %i\n", __func__,
760 status);
761 return status;
762 }
763
764 return 0;
765}
766
767
768
769static void qt2_dtr_rts(struct usb_serial_port *port, int on)
770{
771 struct usb_device *dev = port->serial->dev;
772 struct qt2_port_private *port_priv = usb_get_serial_port_data(port);
773
774 /* Disable flow control */
775 if (!on) {
776 if (qt2_setregister(dev, port_priv->device_port,
777 UART_MCR, 0) < 0)
778 dev_warn(&port->dev, "error from flowcontrol urb\n");
779 }
780 /* drop RTS and DTR */
781 if (on)
782 update_mctrl(port_priv, TIOCM_DTR | TIOCM_RTS, 0);
783 else
784 update_mctrl(port_priv, 0, TIOCM_DTR | TIOCM_RTS);
785}
786
787static void qt2_update_msr(struct usb_serial_port *port, unsigned char *ch)
788{
789 struct qt2_port_private *port_priv;
790 u8 newMSR = (u8) *ch;
791 unsigned long flags;
792
793 /* May be called from qt2_process_read_urb() for an unbound port. */
794 port_priv = usb_get_serial_port_data(port);
795 if (!port_priv)
796 return;
797
798 spin_lock_irqsave(&port_priv->lock, flags);
799 port_priv->shadowMSR = newMSR;
800 spin_unlock_irqrestore(&port_priv->lock, flags);
801
802 if (newMSR & UART_MSR_ANY_DELTA) {
803 /* update input line counters */
804 if (newMSR & UART_MSR_DCTS)
805 port->icount.cts++;
806 if (newMSR & UART_MSR_DDSR)
807 port->icount.dsr++;
808 if (newMSR & UART_MSR_DDCD)
809 port->icount.dcd++;
810 if (newMSR & UART_MSR_TERI)
811 port->icount.rng++;
812
813 wake_up_interruptible(&port->port.delta_msr_wait);
814 }
815}
816
817static void qt2_update_lsr(struct usb_serial_port *port, unsigned char *ch)
818{
819 struct qt2_port_private *port_priv;
820 struct async_icount *icount;
821 unsigned long flags;
822 u8 newLSR = (u8) *ch;
823
824 /* May be called from qt2_process_read_urb() for an unbound port. */
825 port_priv = usb_get_serial_port_data(port);
826 if (!port_priv)
827 return;
828
829 if (newLSR & UART_LSR_BI)
830 newLSR &= (u8) (UART_LSR_OE | UART_LSR_BI);
831
832 spin_lock_irqsave(&port_priv->lock, flags);
833 port_priv->shadowLSR = newLSR;
834 spin_unlock_irqrestore(&port_priv->lock, flags);
835
836 icount = &port->icount;
837
838 if (newLSR & UART_LSR_BRK_ERROR_BITS) {
839
840 if (newLSR & UART_LSR_BI)
841 icount->brk++;
842
843 if (newLSR & UART_LSR_OE)
844 icount->overrun++;
845
846 if (newLSR & UART_LSR_PE)
847 icount->parity++;
848
849 if (newLSR & UART_LSR_FE)
850 icount->frame++;
851 }
852
853}
854
855static unsigned int qt2_write_room(struct tty_struct *tty)
856{
857 struct usb_serial_port *port = tty->driver_data;
858 struct qt2_port_private *port_priv;
859 unsigned long flags;
860 unsigned int r;
861
862 port_priv = usb_get_serial_port_data(port);
863
864 spin_lock_irqsave(&port_priv->urb_lock, flags);
865
866 if (port_priv->urb_in_use)
867 r = 0;
868 else
869 r = QT2_WRITE_BUFFER_SIZE - QT2_WRITE_CONTROL_SIZE;
870
871 spin_unlock_irqrestore(&port_priv->urb_lock, flags);
872
873 return r;
874}
875
876static int qt2_write(struct tty_struct *tty,
877 struct usb_serial_port *port,
878 const unsigned char *buf, int count)
879{
880 struct qt2_port_private *port_priv;
881 struct urb *write_urb;
882 unsigned char *data;
883 unsigned long flags;
884 int status;
885 int bytes_out = 0;
886
887 port_priv = usb_get_serial_port_data(port);
888
889 if (port_priv->write_urb == NULL) {
890 dev_err(&port->dev, "%s - no output urb\n", __func__);
891 return 0;
892 }
893 write_urb = port_priv->write_urb;
894
895 count = min(count, QT2_WRITE_BUFFER_SIZE - QT2_WRITE_CONTROL_SIZE);
896
897 data = write_urb->transfer_buffer;
898 spin_lock_irqsave(&port_priv->urb_lock, flags);
899 if (port_priv->urb_in_use) {
900 dev_err(&port->dev, "qt2_write - urb is in use\n");
901 goto write_out;
902 }
903
904 *data++ = QT2_CONTROL_BYTE;
905 *data++ = QT2_CONTROL_BYTE;
906 *data++ = port_priv->device_port;
907 put_unaligned_le16(count, data);
908 data += 2;
909 memcpy(data, buf, count);
910
911 write_urb->transfer_buffer_length = count + QT2_WRITE_CONTROL_SIZE;
912
913 status = usb_submit_urb(write_urb, GFP_ATOMIC);
914 if (status == 0) {
915 port_priv->urb_in_use = true;
916 bytes_out += count;
917 }
918
919write_out:
920 spin_unlock_irqrestore(&port_priv->urb_lock, flags);
921 return bytes_out;
922}
923
924
925static struct usb_serial_driver qt2_device = {
926 .driver = {
927 .owner = THIS_MODULE,
928 .name = "quatech-serial",
929 },
930 .description = DRIVER_DESC,
931 .id_table = id_table,
932 .open = qt2_open,
933 .close = qt2_close,
934 .write = qt2_write,
935 .write_room = qt2_write_room,
936 .calc_num_ports = qt2_calc_num_ports,
937 .attach = qt2_attach,
938 .release = qt2_release,
939 .disconnect = qt2_disconnect,
940 .port_probe = qt2_port_probe,
941 .port_remove = qt2_port_remove,
942 .dtr_rts = qt2_dtr_rts,
943 .break_ctl = qt2_break_ctl,
944 .tiocmget = qt2_tiocmget,
945 .tiocmset = qt2_tiocmset,
946 .tiocmiwait = usb_serial_generic_tiocmiwait,
947 .get_icount = usb_serial_generic_get_icount,
948 .set_termios = qt2_set_termios,
949};
950
951static struct usb_serial_driver *const serial_drivers[] = {
952 &qt2_device, NULL
953};
954
955module_usb_serial_driver(serial_drivers, id_table);
956
957MODULE_DESCRIPTION(DRIVER_DESC);
958MODULE_LICENSE("GPL v2");
1/*
2 * usb-serial driver for Quatech USB 2 devices
3 *
4 * Copyright (C) 2012 Bill Pemberton (wfp5p@virginia.edu)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version 2
8 * as published by the Free Software Foundation.
9 *
10 *
11 * These devices all have only 1 bulk in and 1 bulk out that is shared
12 * for all serial ports.
13 *
14 */
15
16#include <asm/unaligned.h>
17#include <linux/errno.h>
18#include <linux/slab.h>
19#include <linux/tty.h>
20#include <linux/tty_driver.h>
21#include <linux/tty_flip.h>
22#include <linux/module.h>
23#include <linux/serial.h>
24#include <linux/usb.h>
25#include <linux/usb/serial.h>
26#include <linux/serial_reg.h>
27#include <linux/uaccess.h>
28
29/* default urb timeout for usb operations */
30#define QT2_USB_TIMEOUT USB_CTRL_SET_TIMEOUT
31
32#define QT_OPEN_CLOSE_CHANNEL 0xca
33#define QT_SET_GET_DEVICE 0xc2
34#define QT_SET_GET_REGISTER 0xc0
35#define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
36#define QT_SET_ATF 0xcd
37#define QT_TRANSFER_IN 0xc0
38#define QT_HW_FLOW_CONTROL_MASK 0xc5
39#define QT_SW_FLOW_CONTROL_MASK 0xc6
40#define QT2_BREAK_CONTROL 0xc8
41#define QT2_GET_SET_UART 0xc1
42#define QT2_FLUSH_DEVICE 0xc4
43#define QT2_GET_SET_QMCR 0xe1
44#define QT2_QMCR_RS232 0x40
45#define QT2_QMCR_RS422 0x10
46
47#define SERIAL_CRTSCTS ((UART_MCR_RTS << 8) | UART_MSR_CTS)
48
49#define SERIAL_EVEN_PARITY (UART_LCR_PARITY | UART_LCR_EPAR)
50
51/* status bytes for the device */
52#define QT2_CONTROL_BYTE 0x1b
53#define QT2_LINE_STATUS 0x00 /* following 1 byte is line status */
54#define QT2_MODEM_STATUS 0x01 /* following 1 byte is modem status */
55#define QT2_XMIT_HOLD 0x02 /* following 2 bytes are ?? */
56#define QT2_CHANGE_PORT 0x03 /* following 1 byte is port to change to */
57#define QT2_REC_FLUSH 0x04 /* no following info */
58#define QT2_XMIT_FLUSH 0x05 /* no following info */
59#define QT2_CONTROL_ESCAPE 0xff /* pass through previous 2 control bytes */
60
61#define MAX_BAUD_RATE 921600
62#define DEFAULT_BAUD_RATE 9600
63
64#define QT2_READ_BUFFER_SIZE 512 /* size of read buffer */
65#define QT2_WRITE_BUFFER_SIZE 512 /* size of write buffer */
66#define QT2_WRITE_CONTROL_SIZE 5 /* control bytes used for a write */
67
68#define DRIVER_DESC "Quatech 2nd gen USB to Serial Driver"
69
70#define USB_VENDOR_ID_QUATECH 0x061d
71#define QUATECH_SSU2_100 0xC120 /* RS232 single port */
72#define QUATECH_DSU2_100 0xC140 /* RS232 dual port */
73#define QUATECH_DSU2_400 0xC150 /* RS232/422/485 dual port */
74#define QUATECH_QSU2_100 0xC160 /* RS232 four port */
75#define QUATECH_QSU2_400 0xC170 /* RS232/422/485 four port */
76#define QUATECH_ESU2_100 0xC1A0 /* RS232 eight port */
77#define QUATECH_ESU2_400 0xC180 /* RS232/422/485 eight port */
78
79struct qt2_device_detail {
80 int product_id;
81 int num_ports;
82};
83
84#define QT_DETAILS(prod, ports) \
85 .product_id = (prod), \
86 .num_ports = (ports)
87
88static const struct qt2_device_detail qt2_device_details[] = {
89 {QT_DETAILS(QUATECH_SSU2_100, 1)},
90 {QT_DETAILS(QUATECH_DSU2_400, 2)},
91 {QT_DETAILS(QUATECH_DSU2_100, 2)},
92 {QT_DETAILS(QUATECH_QSU2_400, 4)},
93 {QT_DETAILS(QUATECH_QSU2_100, 4)},
94 {QT_DETAILS(QUATECH_ESU2_400, 8)},
95 {QT_DETAILS(QUATECH_ESU2_100, 8)},
96 {QT_DETAILS(0, 0)} /* Terminating entry */
97};
98
99static const struct usb_device_id id_table[] = {
100 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU2_100)},
101 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU2_100)},
102 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_DSU2_400)},
103 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU2_100)},
104 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_QSU2_400)},
105 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU2_100)},
106 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_ESU2_400)},
107 {} /* Terminating entry */
108};
109MODULE_DEVICE_TABLE(usb, id_table);
110
111struct qt2_serial_private {
112 unsigned char current_port; /* current port for incoming data */
113
114 struct urb *read_urb; /* shared among all ports */
115 char *read_buffer;
116};
117
118struct qt2_port_private {
119 u8 device_port;
120
121 spinlock_t urb_lock;
122 bool urb_in_use;
123 struct urb *write_urb;
124 char *write_buffer;
125
126 spinlock_t lock;
127 u8 shadowLSR;
128 u8 shadowMSR;
129
130 struct usb_serial_port *port;
131};
132
133static void qt2_update_lsr(struct usb_serial_port *port, unsigned char *ch);
134static void qt2_update_msr(struct usb_serial_port *port, unsigned char *ch);
135static void qt2_write_bulk_callback(struct urb *urb);
136static void qt2_read_bulk_callback(struct urb *urb);
137
138static void qt2_release(struct usb_serial *serial)
139{
140 struct qt2_serial_private *serial_priv;
141
142 serial_priv = usb_get_serial_data(serial);
143
144 usb_kill_urb(serial_priv->read_urb);
145 usb_free_urb(serial_priv->read_urb);
146 kfree(serial_priv->read_buffer);
147 kfree(serial_priv);
148}
149
150static inline int calc_baud_divisor(int baudrate)
151{
152 int divisor, rem;
153
154 divisor = MAX_BAUD_RATE / baudrate;
155 rem = MAX_BAUD_RATE % baudrate;
156 /* Round to nearest divisor */
157 if (((rem * 2) >= baudrate) && (baudrate != 110))
158 divisor++;
159
160 return divisor;
161}
162
163static inline int qt2_set_port_config(struct usb_device *dev,
164 unsigned char port_number,
165 u16 baudrate, u16 lcr)
166{
167 int divisor = calc_baud_divisor(baudrate);
168 u16 index = ((u16) (lcr << 8) | (u16) (port_number));
169
170 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
171 QT2_GET_SET_UART, 0x40,
172 divisor, index, NULL, 0, QT2_USB_TIMEOUT);
173}
174
175static inline int qt2_control_msg(struct usb_device *dev,
176 u8 request, u16 data, u16 index)
177{
178 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
179 request, 0x40, data, index,
180 NULL, 0, QT2_USB_TIMEOUT);
181}
182
183static inline int qt2_setdevice(struct usb_device *dev, u8 *data)
184{
185 u16 x = ((u16) (data[1] << 8) | (u16) (data[0]));
186
187 return qt2_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
188}
189
190
191static inline int qt2_getdevice(struct usb_device *dev, u8 *data)
192{
193 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
194 QT_SET_GET_DEVICE, 0xc0, 0, 0,
195 data, 3, QT2_USB_TIMEOUT);
196}
197
198static inline int qt2_getregister(struct usb_device *dev,
199 u8 uart,
200 u8 reg,
201 u8 *data)
202{
203 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
204 QT_SET_GET_REGISTER, 0xc0, reg,
205 uart, data, sizeof(*data), QT2_USB_TIMEOUT);
206
207}
208
209static inline int qt2_setregister(struct usb_device *dev,
210 u8 uart, u8 reg, u16 data)
211{
212 u16 value = (data << 8) | reg;
213
214 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
215 QT_SET_GET_REGISTER, 0x40, value, uart,
216 NULL, 0, QT2_USB_TIMEOUT);
217}
218
219static inline int update_mctrl(struct qt2_port_private *port_priv,
220 unsigned int set, unsigned int clear)
221{
222 struct usb_serial_port *port = port_priv->port;
223 struct usb_device *dev = port->serial->dev;
224 unsigned urb_value;
225 int status;
226
227 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
228 dev_dbg(&port->dev,
229 "update_mctrl - DTR|RTS not being set|cleared\n");
230 return 0; /* no change */
231 }
232
233 clear &= ~set; /* 'set' takes precedence over 'clear' */
234 urb_value = 0;
235 if (set & TIOCM_DTR)
236 urb_value |= UART_MCR_DTR;
237 if (set & TIOCM_RTS)
238 urb_value |= UART_MCR_RTS;
239
240 status = qt2_setregister(dev, port_priv->device_port, UART_MCR,
241 urb_value);
242 if (status < 0)
243 dev_err(&port->dev,
244 "update_mctrl - Error from MODEM_CTRL urb: %i\n",
245 status);
246 return status;
247}
248
249static int qt2_calc_num_ports(struct usb_serial *serial)
250{
251 struct qt2_device_detail d;
252 int i;
253
254 for (i = 0; d = qt2_device_details[i], d.product_id != 0; i++) {
255 if (d.product_id == le16_to_cpu(serial->dev->descriptor.idProduct))
256 return d.num_ports;
257 }
258
259 /* we didn't recognize the device */
260 dev_err(&serial->dev->dev,
261 "don't know the number of ports, assuming 1\n");
262
263 return 1;
264}
265
266static void qt2_set_termios(struct tty_struct *tty,
267 struct usb_serial_port *port,
268 struct ktermios *old_termios)
269{
270 struct usb_device *dev = port->serial->dev;
271 struct qt2_port_private *port_priv;
272 struct ktermios *termios = &tty->termios;
273 u16 baud;
274 unsigned int cflag = termios->c_cflag;
275 u16 new_lcr = 0;
276 int status;
277
278 port_priv = usb_get_serial_port_data(port);
279
280 if (cflag & PARENB) {
281 if (cflag & PARODD)
282 new_lcr |= UART_LCR_PARITY;
283 else
284 new_lcr |= SERIAL_EVEN_PARITY;
285 }
286
287 switch (cflag & CSIZE) {
288 case CS5:
289 new_lcr |= UART_LCR_WLEN5;
290 break;
291 case CS6:
292 new_lcr |= UART_LCR_WLEN6;
293 break;
294 case CS7:
295 new_lcr |= UART_LCR_WLEN7;
296 break;
297 default:
298 case CS8:
299 new_lcr |= UART_LCR_WLEN8;
300 break;
301 }
302
303 baud = tty_get_baud_rate(tty);
304 if (!baud)
305 baud = 9600;
306
307 status = qt2_set_port_config(dev, port_priv->device_port, baud,
308 new_lcr);
309 if (status < 0)
310 dev_err(&port->dev, "%s - qt2_set_port_config failed: %i\n",
311 __func__, status);
312
313 if (cflag & CRTSCTS)
314 status = qt2_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
315 SERIAL_CRTSCTS,
316 port_priv->device_port);
317 else
318 status = qt2_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
319 0, port_priv->device_port);
320 if (status < 0)
321 dev_err(&port->dev, "%s - set HW flow control failed: %i\n",
322 __func__, status);
323
324 if (I_IXOFF(tty) || I_IXON(tty)) {
325 u16 x = ((u16) (START_CHAR(tty) << 8) | (u16) (STOP_CHAR(tty)));
326
327 status = qt2_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
328 x, port_priv->device_port);
329 } else
330 status = qt2_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
331 0, port_priv->device_port);
332
333 if (status < 0)
334 dev_err(&port->dev, "%s - set SW flow control failed: %i\n",
335 __func__, status);
336
337}
338
339static int qt2_open(struct tty_struct *tty, struct usb_serial_port *port)
340{
341 struct usb_serial *serial;
342 struct qt2_port_private *port_priv;
343 u8 *data;
344 u16 device_port;
345 int status;
346 unsigned long flags;
347
348 device_port = port->port_number;
349
350 serial = port->serial;
351
352 port_priv = usb_get_serial_port_data(port);
353
354 /* set the port to RS232 mode */
355 status = qt2_control_msg(serial->dev, QT2_GET_SET_QMCR,
356 QT2_QMCR_RS232, device_port);
357 if (status < 0) {
358 dev_err(&port->dev,
359 "%s failed to set RS232 mode for port %i error %i\n",
360 __func__, device_port, status);
361 return status;
362 }
363
364 data = kzalloc(2, GFP_KERNEL);
365 if (!data)
366 return -ENOMEM;
367
368 /* open the port */
369 status = usb_control_msg(serial->dev,
370 usb_rcvctrlpipe(serial->dev, 0),
371 QT_OPEN_CLOSE_CHANNEL,
372 0xc0, 0,
373 device_port, data, 2, QT2_USB_TIMEOUT);
374
375 if (status < 0) {
376 dev_err(&port->dev, "%s - open port failed %i\n", __func__,
377 status);
378 kfree(data);
379 return status;
380 }
381
382 spin_lock_irqsave(&port_priv->lock, flags);
383 port_priv->shadowLSR = data[0];
384 port_priv->shadowMSR = data[1];
385 spin_unlock_irqrestore(&port_priv->lock, flags);
386
387 kfree(data);
388
389 /* set to default speed and 8bit word size */
390 status = qt2_set_port_config(serial->dev, device_port,
391 DEFAULT_BAUD_RATE, UART_LCR_WLEN8);
392 if (status < 0) {
393 dev_err(&port->dev, "%s - initial setup failed (%i)\n",
394 __func__, device_port);
395 return status;
396 }
397
398 port_priv->device_port = (u8) device_port;
399
400 if (tty)
401 qt2_set_termios(tty, port, &tty->termios);
402
403 return 0;
404
405}
406
407static void qt2_close(struct usb_serial_port *port)
408{
409 struct usb_serial *serial;
410 struct qt2_port_private *port_priv;
411 int i;
412
413 serial = port->serial;
414 port_priv = usb_get_serial_port_data(port);
415
416 usb_kill_urb(port_priv->write_urb);
417
418 /* flush the port transmit buffer */
419 i = usb_control_msg(serial->dev,
420 usb_rcvctrlpipe(serial->dev, 0),
421 QT2_FLUSH_DEVICE, 0x40, 1,
422 port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
423
424 if (i < 0)
425 dev_err(&port->dev, "%s - transmit buffer flush failed: %i\n",
426 __func__, i);
427
428 /* flush the port receive buffer */
429 i = usb_control_msg(serial->dev,
430 usb_rcvctrlpipe(serial->dev, 0),
431 QT2_FLUSH_DEVICE, 0x40, 0,
432 port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
433
434 if (i < 0)
435 dev_err(&port->dev, "%s - receive buffer flush failed: %i\n",
436 __func__, i);
437
438 /* close the port */
439 i = usb_control_msg(serial->dev,
440 usb_sndctrlpipe(serial->dev, 0),
441 QT_OPEN_CLOSE_CHANNEL,
442 0x40, 0,
443 port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
444
445 if (i < 0)
446 dev_err(&port->dev, "%s - close port failed %i\n",
447 __func__, i);
448}
449
450static void qt2_disconnect(struct usb_serial *serial)
451{
452 struct qt2_serial_private *serial_priv = usb_get_serial_data(serial);
453
454 usb_kill_urb(serial_priv->read_urb);
455}
456
457static int get_serial_info(struct usb_serial_port *port,
458 struct serial_struct __user *retinfo)
459{
460 struct serial_struct tmp;
461
462 memset(&tmp, 0, sizeof(tmp));
463 tmp.line = port->minor;
464 tmp.port = 0;
465 tmp.irq = 0;
466 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
467 tmp.xmit_fifo_size = port->bulk_out_size;
468 tmp.baud_base = 9600;
469 tmp.close_delay = 5*HZ;
470 tmp.closing_wait = 30*HZ;
471
472 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
473 return -EFAULT;
474 return 0;
475}
476
477static int qt2_ioctl(struct tty_struct *tty,
478 unsigned int cmd, unsigned long arg)
479{
480 struct usb_serial_port *port = tty->driver_data;
481
482 switch (cmd) {
483 case TIOCGSERIAL:
484 return get_serial_info(port,
485 (struct serial_struct __user *)arg);
486 default:
487 break;
488 }
489
490 return -ENOIOCTLCMD;
491}
492
493static void qt2_process_status(struct usb_serial_port *port, unsigned char *ch)
494{
495 switch (*ch) {
496 case QT2_LINE_STATUS:
497 qt2_update_lsr(port, ch + 1);
498 break;
499 case QT2_MODEM_STATUS:
500 qt2_update_msr(port, ch + 1);
501 break;
502 }
503}
504
505/* not needed, kept to document functionality */
506static void qt2_process_xmit_empty(struct usb_serial_port *port,
507 unsigned char *ch)
508{
509 int bytes_written;
510
511 bytes_written = (int)(*ch) + (int)(*(ch + 1) << 4);
512}
513
514/* not needed, kept to document functionality */
515static void qt2_process_flush(struct usb_serial_port *port, unsigned char *ch)
516{
517 return;
518}
519
520static void qt2_process_read_urb(struct urb *urb)
521{
522 struct usb_serial *serial;
523 struct qt2_serial_private *serial_priv;
524 struct usb_serial_port *port;
525 struct qt2_port_private *port_priv;
526 bool escapeflag;
527 unsigned char *ch;
528 int i;
529 unsigned char newport;
530 int len = urb->actual_length;
531
532 if (!len)
533 return;
534
535 ch = urb->transfer_buffer;
536 serial = urb->context;
537 serial_priv = usb_get_serial_data(serial);
538 port = serial->port[serial_priv->current_port];
539 port_priv = usb_get_serial_port_data(port);
540
541 for (i = 0; i < urb->actual_length; i++) {
542 ch = (unsigned char *)urb->transfer_buffer + i;
543 if ((i <= (len - 3)) &&
544 (*ch == QT2_CONTROL_BYTE) &&
545 (*(ch + 1) == QT2_CONTROL_BYTE)) {
546 escapeflag = false;
547 switch (*(ch + 2)) {
548 case QT2_LINE_STATUS:
549 case QT2_MODEM_STATUS:
550 if (i > (len - 4)) {
551 dev_warn(&port->dev,
552 "%s - status message too short\n",
553 __func__);
554 break;
555 }
556 qt2_process_status(port, ch + 2);
557 i += 3;
558 escapeflag = true;
559 break;
560 case QT2_XMIT_HOLD:
561 if (i > (len - 5)) {
562 dev_warn(&port->dev,
563 "%s - xmit_empty message too short\n",
564 __func__);
565 break;
566 }
567 qt2_process_xmit_empty(port, ch + 3);
568 i += 4;
569 escapeflag = true;
570 break;
571 case QT2_CHANGE_PORT:
572 if (i > (len - 4)) {
573 dev_warn(&port->dev,
574 "%s - change_port message too short\n",
575 __func__);
576 break;
577 }
578 tty_flip_buffer_push(&port->port);
579
580 newport = *(ch + 3);
581
582 if (newport > serial->num_ports) {
583 dev_err(&port->dev,
584 "%s - port change to invalid port: %i\n",
585 __func__, newport);
586 break;
587 }
588
589 serial_priv->current_port = newport;
590 port = serial->port[serial_priv->current_port];
591 port_priv = usb_get_serial_port_data(port);
592 i += 3;
593 escapeflag = true;
594 break;
595 case QT2_REC_FLUSH:
596 case QT2_XMIT_FLUSH:
597 qt2_process_flush(port, ch + 2);
598 i += 2;
599 escapeflag = true;
600 break;
601 case QT2_CONTROL_ESCAPE:
602 tty_buffer_request_room(&port->port, 2);
603 tty_insert_flip_string(&port->port, ch, 2);
604 i += 2;
605 escapeflag = true;
606 break;
607 default:
608 dev_warn(&port->dev,
609 "%s - unsupported command %i\n",
610 __func__, *(ch + 2));
611 break;
612 }
613 if (escapeflag)
614 continue;
615 }
616
617 tty_buffer_request_room(&port->port, 1);
618 tty_insert_flip_string(&port->port, ch, 1);
619 }
620
621 tty_flip_buffer_push(&port->port);
622}
623
624static void qt2_write_bulk_callback(struct urb *urb)
625{
626 struct usb_serial_port *port;
627 struct qt2_port_private *port_priv;
628
629 port = urb->context;
630 port_priv = usb_get_serial_port_data(port);
631
632 spin_lock(&port_priv->urb_lock);
633
634 port_priv->urb_in_use = false;
635 usb_serial_port_softint(port);
636
637 spin_unlock(&port_priv->urb_lock);
638
639}
640
641static void qt2_read_bulk_callback(struct urb *urb)
642{
643 struct usb_serial *serial = urb->context;
644 int status;
645
646 if (urb->status) {
647 dev_warn(&serial->dev->dev,
648 "%s - non-zero urb status: %i\n", __func__,
649 urb->status);
650 return;
651 }
652
653 qt2_process_read_urb(urb);
654
655 status = usb_submit_urb(urb, GFP_ATOMIC);
656 if (status != 0)
657 dev_err(&serial->dev->dev,
658 "%s - resubmit read urb failed: %i\n",
659 __func__, status);
660}
661
662static int qt2_setup_urbs(struct usb_serial *serial)
663{
664 struct usb_serial_port *port0;
665 struct qt2_serial_private *serial_priv;
666 int status;
667
668 port0 = serial->port[0];
669
670 serial_priv = usb_get_serial_data(serial);
671 serial_priv->read_urb = usb_alloc_urb(0, GFP_KERNEL);
672 if (!serial_priv->read_urb)
673 return -ENOMEM;
674
675 usb_fill_bulk_urb(serial_priv->read_urb, serial->dev,
676 usb_rcvbulkpipe(serial->dev,
677 port0->bulk_in_endpointAddress),
678 serial_priv->read_buffer,
679 QT2_READ_BUFFER_SIZE,
680 qt2_read_bulk_callback, serial);
681
682 status = usb_submit_urb(serial_priv->read_urb, GFP_KERNEL);
683 if (status != 0) {
684 dev_err(&serial->dev->dev,
685 "%s - submit read urb failed %i\n", __func__, status);
686 usb_free_urb(serial_priv->read_urb);
687 return status;
688 }
689
690 return 0;
691}
692
693static int qt2_attach(struct usb_serial *serial)
694{
695 struct qt2_serial_private *serial_priv;
696 int status;
697
698 /* power on unit */
699 status = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
700 0xc2, 0x40, 0x8000, 0, NULL, 0,
701 QT2_USB_TIMEOUT);
702 if (status < 0) {
703 dev_err(&serial->dev->dev,
704 "%s - failed to power on unit: %i\n", __func__, status);
705 return status;
706 }
707
708 serial_priv = kzalloc(sizeof(*serial_priv), GFP_KERNEL);
709 if (!serial_priv)
710 return -ENOMEM;
711
712 serial_priv->read_buffer = kmalloc(QT2_READ_BUFFER_SIZE, GFP_KERNEL);
713 if (!serial_priv->read_buffer) {
714 status = -ENOMEM;
715 goto err_buf;
716 }
717
718 usb_set_serial_data(serial, serial_priv);
719
720 status = qt2_setup_urbs(serial);
721 if (status != 0)
722 goto attach_failed;
723
724 return 0;
725
726attach_failed:
727 kfree(serial_priv->read_buffer);
728err_buf:
729 kfree(serial_priv);
730 return status;
731}
732
733static int qt2_port_probe(struct usb_serial_port *port)
734{
735 struct usb_serial *serial = port->serial;
736 struct qt2_port_private *port_priv;
737 u8 bEndpointAddress;
738
739 port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
740 if (!port_priv)
741 return -ENOMEM;
742
743 spin_lock_init(&port_priv->lock);
744 spin_lock_init(&port_priv->urb_lock);
745 port_priv->port = port;
746
747 port_priv->write_buffer = kmalloc(QT2_WRITE_BUFFER_SIZE, GFP_KERNEL);
748 if (!port_priv->write_buffer)
749 goto err_buf;
750
751 port_priv->write_urb = usb_alloc_urb(0, GFP_KERNEL);
752 if (!port_priv->write_urb)
753 goto err_urb;
754
755 bEndpointAddress = serial->port[0]->bulk_out_endpointAddress;
756 usb_fill_bulk_urb(port_priv->write_urb, serial->dev,
757 usb_sndbulkpipe(serial->dev, bEndpointAddress),
758 port_priv->write_buffer,
759 QT2_WRITE_BUFFER_SIZE,
760 qt2_write_bulk_callback, port);
761
762 usb_set_serial_port_data(port, port_priv);
763
764 return 0;
765err_urb:
766 kfree(port_priv->write_buffer);
767err_buf:
768 kfree(port_priv);
769 return -ENOMEM;
770}
771
772static int qt2_port_remove(struct usb_serial_port *port)
773{
774 struct qt2_port_private *port_priv;
775
776 port_priv = usb_get_serial_port_data(port);
777 usb_free_urb(port_priv->write_urb);
778 kfree(port_priv->write_buffer);
779 kfree(port_priv);
780
781 return 0;
782}
783
784static int qt2_tiocmget(struct tty_struct *tty)
785{
786 struct usb_serial_port *port = tty->driver_data;
787 struct usb_device *dev = port->serial->dev;
788 struct qt2_port_private *port_priv = usb_get_serial_port_data(port);
789 u8 *d;
790 int r;
791
792 d = kzalloc(2, GFP_KERNEL);
793 if (!d)
794 return -ENOMEM;
795
796 r = qt2_getregister(dev, port_priv->device_port, UART_MCR, d);
797 if (r < 0)
798 goto mget_out;
799
800 r = qt2_getregister(dev, port_priv->device_port, UART_MSR, d + 1);
801 if (r < 0)
802 goto mget_out;
803
804 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
805 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
806 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
807 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
808 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
809 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
810
811mget_out:
812 kfree(d);
813 return r;
814}
815
816static int qt2_tiocmset(struct tty_struct *tty,
817 unsigned int set, unsigned int clear)
818{
819 struct qt2_port_private *port_priv;
820
821 port_priv = usb_get_serial_port_data(tty->driver_data);
822 return update_mctrl(port_priv, set, clear);
823}
824
825static void qt2_break_ctl(struct tty_struct *tty, int break_state)
826{
827 struct usb_serial_port *port = tty->driver_data;
828 struct qt2_port_private *port_priv;
829 int status;
830 u16 val;
831
832 port_priv = usb_get_serial_port_data(port);
833
834 val = (break_state == -1) ? 1 : 0;
835
836 status = qt2_control_msg(port->serial->dev, QT2_BREAK_CONTROL,
837 val, port_priv->device_port);
838 if (status < 0)
839 dev_warn(&port->dev,
840 "%s - failed to send control message: %i\n", __func__,
841 status);
842}
843
844
845
846static void qt2_dtr_rts(struct usb_serial_port *port, int on)
847{
848 struct usb_device *dev = port->serial->dev;
849 struct qt2_port_private *port_priv = usb_get_serial_port_data(port);
850
851 /* Disable flow control */
852 if (!on) {
853 if (qt2_setregister(dev, port_priv->device_port,
854 UART_MCR, 0) < 0)
855 dev_warn(&port->dev, "error from flowcontrol urb\n");
856 }
857 /* drop RTS and DTR */
858 if (on)
859 update_mctrl(port_priv, TIOCM_DTR | TIOCM_RTS, 0);
860 else
861 update_mctrl(port_priv, 0, TIOCM_DTR | TIOCM_RTS);
862}
863
864static void qt2_update_msr(struct usb_serial_port *port, unsigned char *ch)
865{
866 struct qt2_port_private *port_priv;
867 u8 newMSR = (u8) *ch;
868 unsigned long flags;
869
870 port_priv = usb_get_serial_port_data(port);
871
872 spin_lock_irqsave(&port_priv->lock, flags);
873 port_priv->shadowMSR = newMSR;
874 spin_unlock_irqrestore(&port_priv->lock, flags);
875
876 if (newMSR & UART_MSR_ANY_DELTA) {
877 /* update input line counters */
878 if (newMSR & UART_MSR_DCTS)
879 port->icount.cts++;
880 if (newMSR & UART_MSR_DDSR)
881 port->icount.dsr++;
882 if (newMSR & UART_MSR_DDCD)
883 port->icount.dcd++;
884 if (newMSR & UART_MSR_TERI)
885 port->icount.rng++;
886
887 wake_up_interruptible(&port->port.delta_msr_wait);
888 }
889}
890
891static void qt2_update_lsr(struct usb_serial_port *port, unsigned char *ch)
892{
893 struct qt2_port_private *port_priv;
894 struct async_icount *icount;
895 unsigned long flags;
896 u8 newLSR = (u8) *ch;
897
898 port_priv = usb_get_serial_port_data(port);
899
900 if (newLSR & UART_LSR_BI)
901 newLSR &= (u8) (UART_LSR_OE | UART_LSR_BI);
902
903 spin_lock_irqsave(&port_priv->lock, flags);
904 port_priv->shadowLSR = newLSR;
905 spin_unlock_irqrestore(&port_priv->lock, flags);
906
907 icount = &port->icount;
908
909 if (newLSR & UART_LSR_BRK_ERROR_BITS) {
910
911 if (newLSR & UART_LSR_BI)
912 icount->brk++;
913
914 if (newLSR & UART_LSR_OE)
915 icount->overrun++;
916
917 if (newLSR & UART_LSR_PE)
918 icount->parity++;
919
920 if (newLSR & UART_LSR_FE)
921 icount->frame++;
922 }
923
924}
925
926static int qt2_write_room(struct tty_struct *tty)
927{
928 struct usb_serial_port *port = tty->driver_data;
929 struct qt2_port_private *port_priv;
930 unsigned long flags = 0;
931 int r;
932
933 port_priv = usb_get_serial_port_data(port);
934
935 spin_lock_irqsave(&port_priv->urb_lock, flags);
936
937 if (port_priv->urb_in_use)
938 r = 0;
939 else
940 r = QT2_WRITE_BUFFER_SIZE - QT2_WRITE_CONTROL_SIZE;
941
942 spin_unlock_irqrestore(&port_priv->urb_lock, flags);
943
944 return r;
945}
946
947static int qt2_write(struct tty_struct *tty,
948 struct usb_serial_port *port,
949 const unsigned char *buf, int count)
950{
951 struct qt2_port_private *port_priv;
952 struct urb *write_urb;
953 unsigned char *data;
954 unsigned long flags;
955 int status;
956 int bytes_out = 0;
957
958 port_priv = usb_get_serial_port_data(port);
959
960 if (port_priv->write_urb == NULL) {
961 dev_err(&port->dev, "%s - no output urb\n", __func__);
962 return 0;
963 }
964 write_urb = port_priv->write_urb;
965
966 count = min(count, QT2_WRITE_BUFFER_SIZE - QT2_WRITE_CONTROL_SIZE);
967
968 data = write_urb->transfer_buffer;
969 spin_lock_irqsave(&port_priv->urb_lock, flags);
970 if (port_priv->urb_in_use) {
971 dev_err(&port->dev, "qt2_write - urb is in use\n");
972 goto write_out;
973 }
974
975 *data++ = QT2_CONTROL_BYTE;
976 *data++ = QT2_CONTROL_BYTE;
977 *data++ = port_priv->device_port;
978 put_unaligned_le16(count, data);
979 data += 2;
980 memcpy(data, buf, count);
981
982 write_urb->transfer_buffer_length = count + QT2_WRITE_CONTROL_SIZE;
983
984 status = usb_submit_urb(write_urb, GFP_ATOMIC);
985 if (status == 0) {
986 port_priv->urb_in_use = true;
987 bytes_out += count;
988 }
989
990write_out:
991 spin_unlock_irqrestore(&port_priv->urb_lock, flags);
992 return bytes_out;
993}
994
995
996static struct usb_serial_driver qt2_device = {
997 .driver = {
998 .owner = THIS_MODULE,
999 .name = "quatech-serial",
1000 },
1001 .description = DRIVER_DESC,
1002 .id_table = id_table,
1003 .open = qt2_open,
1004 .close = qt2_close,
1005 .write = qt2_write,
1006 .write_room = qt2_write_room,
1007 .calc_num_ports = qt2_calc_num_ports,
1008 .attach = qt2_attach,
1009 .release = qt2_release,
1010 .disconnect = qt2_disconnect,
1011 .port_probe = qt2_port_probe,
1012 .port_remove = qt2_port_remove,
1013 .dtr_rts = qt2_dtr_rts,
1014 .break_ctl = qt2_break_ctl,
1015 .tiocmget = qt2_tiocmget,
1016 .tiocmset = qt2_tiocmset,
1017 .tiocmiwait = usb_serial_generic_tiocmiwait,
1018 .get_icount = usb_serial_generic_get_icount,
1019 .ioctl = qt2_ioctl,
1020 .set_termios = qt2_set_termios,
1021};
1022
1023static struct usb_serial_driver *const serial_drivers[] = {
1024 &qt2_device, NULL
1025};
1026
1027module_usb_serial_driver(serial_drivers, id_table);
1028
1029MODULE_DESCRIPTION(DRIVER_DESC);
1030MODULE_LICENSE("GPL");