• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
79 struct 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 
88 static 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 
99 static 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 };
109 MODULE_DEVICE_TABLE(usb, id_table);
110 
111 struct 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 
118 struct 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 
133 static void qt2_update_lsr(struct usb_serial_port *port, unsigned char *ch);
134 static void qt2_update_msr(struct usb_serial_port *port, unsigned char *ch);
135 static void qt2_write_bulk_callback(struct urb *urb);
136 static void qt2_read_bulk_callback(struct urb *urb);
137 
qt2_release(struct usb_serial * serial)138 static 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 
calc_baud_divisor(int baudrate)150 static 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 
qt2_set_port_config(struct usb_device * dev,unsigned char port_number,u16 baudrate,u16 lcr)163 static 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 
qt2_control_msg(struct usb_device * dev,u8 request,u16 data,u16 index)175 static 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 
qt2_setdevice(struct usb_device * dev,u8 * data)183 static 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 
qt2_getregister(struct usb_device * dev,u8 uart,u8 reg,u8 * data)191 static inline int qt2_getregister(struct usb_device *dev,
192 				  u8 uart,
193 				  u8 reg,
194 				  u8 *data)
195 {
196 	int ret;
197 
198 	ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
199 			      QT_SET_GET_REGISTER, 0xc0, reg,
200 			      uart, data, sizeof(*data), QT2_USB_TIMEOUT);
201 	if (ret < sizeof(*data)) {
202 		if (ret >= 0)
203 			ret = -EIO;
204 	}
205 
206 	return ret;
207 }
208 
qt2_setregister(struct usb_device * dev,u8 uart,u8 reg,u16 data)209 static 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 
update_mctrl(struct qt2_port_private * port_priv,unsigned int set,unsigned int clear)219 static 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 
qt2_calc_num_ports(struct usb_serial * serial)249 static 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 
qt2_set_termios(struct tty_struct * tty,struct usb_serial_port * port,struct ktermios * old_termios)266 static 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 
qt2_open(struct tty_struct * tty,struct usb_serial_port * port)339 static 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 < 2) {
376 		dev_err(&port->dev, "%s - open port failed %i\n", __func__,
377 			status);
378 		if (status >= 0)
379 			status = -EIO;
380 		kfree(data);
381 		return status;
382 	}
383 
384 	spin_lock_irqsave(&port_priv->lock, flags);
385 	port_priv->shadowLSR = data[0];
386 	port_priv->shadowMSR = data[1];
387 	spin_unlock_irqrestore(&port_priv->lock, flags);
388 
389 	kfree(data);
390 
391 	/* set to default speed and 8bit word size */
392 	status = qt2_set_port_config(serial->dev, device_port,
393 				     DEFAULT_BAUD_RATE, UART_LCR_WLEN8);
394 	if (status < 0) {
395 		dev_err(&port->dev, "%s - initial setup failed (%i)\n",
396 			__func__, device_port);
397 		return status;
398 	}
399 
400 	port_priv->device_port = (u8) device_port;
401 
402 	if (tty)
403 		qt2_set_termios(tty, port, &tty->termios);
404 
405 	return 0;
406 
407 }
408 
qt2_close(struct usb_serial_port * port)409 static void qt2_close(struct usb_serial_port *port)
410 {
411 	struct usb_serial *serial;
412 	struct qt2_port_private *port_priv;
413 	unsigned long flags;
414 	int i;
415 
416 	serial = port->serial;
417 	port_priv = usb_get_serial_port_data(port);
418 
419 	spin_lock_irqsave(&port_priv->urb_lock, flags);
420 	usb_kill_urb(port_priv->write_urb);
421 	port_priv->urb_in_use = false;
422 	spin_unlock_irqrestore(&port_priv->urb_lock, flags);
423 
424 	/* flush the port transmit buffer */
425 	i = usb_control_msg(serial->dev,
426 			    usb_rcvctrlpipe(serial->dev, 0),
427 			    QT2_FLUSH_DEVICE, 0x40, 1,
428 			    port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
429 
430 	if (i < 0)
431 		dev_err(&port->dev, "%s - transmit buffer flush failed: %i\n",
432 			__func__, i);
433 
434 	/* flush the port receive buffer */
435 	i = usb_control_msg(serial->dev,
436 			    usb_rcvctrlpipe(serial->dev, 0),
437 			    QT2_FLUSH_DEVICE, 0x40, 0,
438 			    port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
439 
440 	if (i < 0)
441 		dev_err(&port->dev, "%s - receive buffer flush failed: %i\n",
442 			__func__, i);
443 
444 	/* close the port */
445 	i = usb_control_msg(serial->dev,
446 			    usb_sndctrlpipe(serial->dev, 0),
447 			    QT_OPEN_CLOSE_CHANNEL,
448 			    0x40, 0,
449 			    port_priv->device_port, NULL, 0, QT2_USB_TIMEOUT);
450 
451 	if (i < 0)
452 		dev_err(&port->dev, "%s - close port failed %i\n",
453 			__func__, i);
454 }
455 
qt2_disconnect(struct usb_serial * serial)456 static void qt2_disconnect(struct usb_serial *serial)
457 {
458 	struct qt2_serial_private *serial_priv = usb_get_serial_data(serial);
459 
460 	usb_kill_urb(serial_priv->read_urb);
461 }
462 
get_serial_info(struct usb_serial_port * port,struct serial_struct __user * retinfo)463 static int get_serial_info(struct usb_serial_port *port,
464 			   struct serial_struct __user *retinfo)
465 {
466 	struct serial_struct tmp;
467 
468 	if (!retinfo)
469 		return -EFAULT;
470 
471 	memset(&tmp, 0, sizeof(tmp));
472 	tmp.line		= port->minor;
473 	tmp.port		= 0;
474 	tmp.irq			= 0;
475 	tmp.flags		= ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
476 	tmp.xmit_fifo_size	= port->bulk_out_size;
477 	tmp.baud_base		= 9600;
478 	tmp.close_delay		= 5*HZ;
479 	tmp.closing_wait	= 30*HZ;
480 
481 	if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
482 		return -EFAULT;
483 	return 0;
484 }
485 
qt2_ioctl(struct tty_struct * tty,unsigned int cmd,unsigned long arg)486 static int qt2_ioctl(struct tty_struct *tty,
487 		     unsigned int cmd, unsigned long arg)
488 {
489 	struct usb_serial_port *port = tty->driver_data;
490 
491 	switch (cmd) {
492 	case TIOCGSERIAL:
493 		return get_serial_info(port,
494 				       (struct serial_struct __user *)arg);
495 	default:
496 		break;
497 	}
498 
499 	return -ENOIOCTLCMD;
500 }
501 
qt2_process_status(struct usb_serial_port * port,unsigned char * ch)502 static void qt2_process_status(struct usb_serial_port *port, unsigned char *ch)
503 {
504 	switch (*ch) {
505 	case QT2_LINE_STATUS:
506 		qt2_update_lsr(port, ch + 1);
507 		break;
508 	case QT2_MODEM_STATUS:
509 		qt2_update_msr(port, ch + 1);
510 		break;
511 	}
512 }
513 
514 /* not needed, kept to document functionality */
qt2_process_xmit_empty(struct usb_serial_port * port,unsigned char * ch)515 static void qt2_process_xmit_empty(struct usb_serial_port *port,
516 				   unsigned char *ch)
517 {
518 	int bytes_written;
519 
520 	bytes_written = (int)(*ch) + (int)(*(ch + 1) << 4);
521 }
522 
523 /* not needed, kept to document functionality */
qt2_process_flush(struct usb_serial_port * port,unsigned char * ch)524 static void qt2_process_flush(struct usb_serial_port *port, unsigned char *ch)
525 {
526 	return;
527 }
528 
qt2_process_read_urb(struct urb * urb)529 static void qt2_process_read_urb(struct urb *urb)
530 {
531 	struct usb_serial *serial;
532 	struct qt2_serial_private *serial_priv;
533 	struct usb_serial_port *port;
534 	struct qt2_port_private *port_priv;
535 	bool escapeflag;
536 	unsigned char *ch;
537 	int i;
538 	unsigned char newport;
539 	int len = urb->actual_length;
540 
541 	if (!len)
542 		return;
543 
544 	ch = urb->transfer_buffer;
545 	serial = urb->context;
546 	serial_priv = usb_get_serial_data(serial);
547 	port = serial->port[serial_priv->current_port];
548 	port_priv = usb_get_serial_port_data(port);
549 
550 	for (i = 0; i < urb->actual_length; i++) {
551 		ch = (unsigned char *)urb->transfer_buffer + i;
552 		if ((i <= (len - 3)) &&
553 		    (*ch == QT2_CONTROL_BYTE) &&
554 		    (*(ch + 1) == QT2_CONTROL_BYTE)) {
555 			escapeflag = false;
556 			switch (*(ch + 2)) {
557 			case QT2_LINE_STATUS:
558 			case QT2_MODEM_STATUS:
559 				if (i > (len - 4)) {
560 					dev_warn(&port->dev,
561 						 "%s - status message too short\n",
562 						__func__);
563 					break;
564 				}
565 				qt2_process_status(port, ch + 2);
566 				i += 3;
567 				escapeflag = true;
568 				break;
569 			case QT2_XMIT_HOLD:
570 				if (i > (len - 5)) {
571 					dev_warn(&port->dev,
572 						 "%s - xmit_empty message too short\n",
573 						 __func__);
574 					break;
575 				}
576 				qt2_process_xmit_empty(port, ch + 3);
577 				i += 4;
578 				escapeflag = true;
579 				break;
580 			case QT2_CHANGE_PORT:
581 				if (i > (len - 4)) {
582 					dev_warn(&port->dev,
583 						 "%s - change_port message too short\n",
584 						 __func__);
585 					break;
586 				}
587 				tty_flip_buffer_push(&port->port);
588 
589 				newport = *(ch + 3);
590 
591 				if (newport > serial->num_ports) {
592 					dev_err(&port->dev,
593 						"%s - port change to invalid port: %i\n",
594 						__func__, newport);
595 					break;
596 				}
597 
598 				serial_priv->current_port = newport;
599 				port = serial->port[serial_priv->current_port];
600 				port_priv = usb_get_serial_port_data(port);
601 				i += 3;
602 				escapeflag = true;
603 				break;
604 			case QT2_REC_FLUSH:
605 			case QT2_XMIT_FLUSH:
606 				qt2_process_flush(port, ch + 2);
607 				i += 2;
608 				escapeflag = true;
609 				break;
610 			case QT2_CONTROL_ESCAPE:
611 				tty_buffer_request_room(&port->port, 2);
612 				tty_insert_flip_string(&port->port, ch, 2);
613 				i += 2;
614 				escapeflag = true;
615 				break;
616 			default:
617 				dev_warn(&port->dev,
618 					 "%s - unsupported command %i\n",
619 					 __func__, *(ch + 2));
620 				break;
621 			}
622 			if (escapeflag)
623 				continue;
624 		}
625 
626 		tty_buffer_request_room(&port->port, 1);
627 		tty_insert_flip_string(&port->port, ch, 1);
628 	}
629 
630 	tty_flip_buffer_push(&port->port);
631 }
632 
qt2_write_bulk_callback(struct urb * urb)633 static void qt2_write_bulk_callback(struct urb *urb)
634 {
635 	struct usb_serial_port *port;
636 	struct qt2_port_private *port_priv;
637 
638 	port = urb->context;
639 	port_priv = usb_get_serial_port_data(port);
640 
641 	spin_lock(&port_priv->urb_lock);
642 
643 	port_priv->urb_in_use = false;
644 	usb_serial_port_softint(port);
645 
646 	spin_unlock(&port_priv->urb_lock);
647 
648 }
649 
qt2_read_bulk_callback(struct urb * urb)650 static void qt2_read_bulk_callback(struct urb *urb)
651 {
652 	struct usb_serial *serial = urb->context;
653 	int status;
654 
655 	if (urb->status) {
656 		dev_warn(&serial->dev->dev,
657 			 "%s - non-zero urb status: %i\n", __func__,
658 			 urb->status);
659 		return;
660 	}
661 
662 	qt2_process_read_urb(urb);
663 
664 	status = usb_submit_urb(urb, GFP_ATOMIC);
665 	if (status != 0)
666 		dev_err(&serial->dev->dev,
667 			"%s - resubmit read urb failed: %i\n",
668 			__func__, status);
669 }
670 
qt2_setup_urbs(struct usb_serial * serial)671 static int qt2_setup_urbs(struct usb_serial *serial)
672 {
673 	struct usb_serial_port *port0;
674 	struct qt2_serial_private *serial_priv;
675 	int status;
676 
677 	port0 = serial->port[0];
678 
679 	serial_priv = usb_get_serial_data(serial);
680 	serial_priv->read_urb = usb_alloc_urb(0, GFP_KERNEL);
681 	if (!serial_priv->read_urb)
682 		return -ENOMEM;
683 
684 	usb_fill_bulk_urb(serial_priv->read_urb, serial->dev,
685 			  usb_rcvbulkpipe(serial->dev,
686 					  port0->bulk_in_endpointAddress),
687 			  serial_priv->read_buffer,
688 			  QT2_READ_BUFFER_SIZE,
689 			  qt2_read_bulk_callback, serial);
690 
691 	status = usb_submit_urb(serial_priv->read_urb, GFP_KERNEL);
692 	if (status != 0) {
693 		dev_err(&serial->dev->dev,
694 			"%s - submit read urb failed %i\n", __func__, status);
695 		usb_free_urb(serial_priv->read_urb);
696 		return status;
697 	}
698 
699 	return 0;
700 }
701 
qt2_attach(struct usb_serial * serial)702 static int qt2_attach(struct usb_serial *serial)
703 {
704 	struct qt2_serial_private *serial_priv;
705 	int status;
706 
707 	/* power on unit */
708 	status = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
709 				 0xc2, 0x40, 0x8000, 0, NULL, 0,
710 				 QT2_USB_TIMEOUT);
711 	if (status < 0) {
712 		dev_err(&serial->dev->dev,
713 			"%s - failed to power on unit: %i\n", __func__, status);
714 		return status;
715 	}
716 
717 	serial_priv = kzalloc(sizeof(*serial_priv), GFP_KERNEL);
718 	if (!serial_priv)
719 		return -ENOMEM;
720 
721 	serial_priv->read_buffer = kmalloc(QT2_READ_BUFFER_SIZE, GFP_KERNEL);
722 	if (!serial_priv->read_buffer) {
723 		status = -ENOMEM;
724 		goto err_buf;
725 	}
726 
727 	usb_set_serial_data(serial, serial_priv);
728 
729 	status = qt2_setup_urbs(serial);
730 	if (status != 0)
731 		goto attach_failed;
732 
733 	return 0;
734 
735 attach_failed:
736 	kfree(serial_priv->read_buffer);
737 err_buf:
738 	kfree(serial_priv);
739 	return status;
740 }
741 
qt2_port_probe(struct usb_serial_port * port)742 static int qt2_port_probe(struct usb_serial_port *port)
743 {
744 	struct usb_serial *serial = port->serial;
745 	struct qt2_port_private *port_priv;
746 	u8 bEndpointAddress;
747 
748 	port_priv = kzalloc(sizeof(*port_priv), GFP_KERNEL);
749 	if (!port_priv)
750 		return -ENOMEM;
751 
752 	spin_lock_init(&port_priv->lock);
753 	spin_lock_init(&port_priv->urb_lock);
754 	port_priv->port = port;
755 
756 	port_priv->write_buffer = kmalloc(QT2_WRITE_BUFFER_SIZE, GFP_KERNEL);
757 	if (!port_priv->write_buffer)
758 		goto err_buf;
759 
760 	port_priv->write_urb = usb_alloc_urb(0, GFP_KERNEL);
761 	if (!port_priv->write_urb)
762 		goto err_urb;
763 
764 	bEndpointAddress = serial->port[0]->bulk_out_endpointAddress;
765 	usb_fill_bulk_urb(port_priv->write_urb, serial->dev,
766 				usb_sndbulkpipe(serial->dev, bEndpointAddress),
767 				port_priv->write_buffer,
768 				QT2_WRITE_BUFFER_SIZE,
769 				qt2_write_bulk_callback, port);
770 
771 	usb_set_serial_port_data(port, port_priv);
772 
773 	return 0;
774 err_urb:
775 	kfree(port_priv->write_buffer);
776 err_buf:
777 	kfree(port_priv);
778 	return -ENOMEM;
779 }
780 
qt2_port_remove(struct usb_serial_port * port)781 static int qt2_port_remove(struct usb_serial_port *port)
782 {
783 	struct qt2_port_private *port_priv;
784 
785 	port_priv = usb_get_serial_port_data(port);
786 	usb_free_urb(port_priv->write_urb);
787 	kfree(port_priv->write_buffer);
788 	kfree(port_priv);
789 
790 	return 0;
791 }
792 
qt2_tiocmget(struct tty_struct * tty)793 static int qt2_tiocmget(struct tty_struct *tty)
794 {
795 	struct usb_serial_port *port = tty->driver_data;
796 	struct usb_device *dev = port->serial->dev;
797 	struct qt2_port_private *port_priv = usb_get_serial_port_data(port);
798 	u8 *d;
799 	int r;
800 
801 	d = kzalloc(2, GFP_KERNEL);
802 	if (!d)
803 		return -ENOMEM;
804 
805 	r = qt2_getregister(dev, port_priv->device_port, UART_MCR, d);
806 	if (r < 0)
807 		goto mget_out;
808 
809 	r = qt2_getregister(dev, port_priv->device_port, UART_MSR, d + 1);
810 	if (r < 0)
811 		goto mget_out;
812 
813 	r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
814 	    (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
815 	    (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
816 	    (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
817 	    (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
818 	    (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
819 
820 mget_out:
821 	kfree(d);
822 	return r;
823 }
824 
qt2_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)825 static int qt2_tiocmset(struct tty_struct *tty,
826 			unsigned int set, unsigned int clear)
827 {
828 	struct qt2_port_private *port_priv;
829 
830 	port_priv = usb_get_serial_port_data(tty->driver_data);
831 	return update_mctrl(port_priv, set, clear);
832 }
833 
qt2_break_ctl(struct tty_struct * tty,int break_state)834 static void qt2_break_ctl(struct tty_struct *tty, int break_state)
835 {
836 	struct usb_serial_port *port = tty->driver_data;
837 	struct qt2_port_private *port_priv;
838 	int status;
839 	u16 val;
840 
841 	port_priv = usb_get_serial_port_data(port);
842 
843 	val = (break_state == -1) ? 1 : 0;
844 
845 	status = qt2_control_msg(port->serial->dev, QT2_BREAK_CONTROL,
846 				 val, port_priv->device_port);
847 	if (status < 0)
848 		dev_warn(&port->dev,
849 			 "%s - failed to send control message: %i\n", __func__,
850 			 status);
851 }
852 
853 
854 
qt2_dtr_rts(struct usb_serial_port * port,int on)855 static void qt2_dtr_rts(struct usb_serial_port *port, int on)
856 {
857 	struct usb_device *dev = port->serial->dev;
858 	struct qt2_port_private *port_priv = usb_get_serial_port_data(port);
859 
860 	/* Disable flow control */
861 	if (!on) {
862 		if (qt2_setregister(dev, port_priv->device_port,
863 					   UART_MCR, 0) < 0)
864 			dev_warn(&port->dev, "error from flowcontrol urb\n");
865 	}
866 	/* drop RTS and DTR */
867 	if (on)
868 		update_mctrl(port_priv, TIOCM_DTR | TIOCM_RTS, 0);
869 	else
870 		update_mctrl(port_priv, 0, TIOCM_DTR | TIOCM_RTS);
871 }
872 
qt2_update_msr(struct usb_serial_port * port,unsigned char * ch)873 static void qt2_update_msr(struct usb_serial_port *port, unsigned char *ch)
874 {
875 	struct qt2_port_private *port_priv;
876 	u8 newMSR = (u8) *ch;
877 	unsigned long flags;
878 
879 	port_priv = usb_get_serial_port_data(port);
880 
881 	spin_lock_irqsave(&port_priv->lock, flags);
882 	port_priv->shadowMSR = newMSR;
883 	spin_unlock_irqrestore(&port_priv->lock, flags);
884 
885 	if (newMSR & UART_MSR_ANY_DELTA) {
886 		/* update input line counters */
887 		if (newMSR & UART_MSR_DCTS)
888 			port->icount.cts++;
889 		if (newMSR & UART_MSR_DDSR)
890 			port->icount.dsr++;
891 		if (newMSR & UART_MSR_DDCD)
892 			port->icount.dcd++;
893 		if (newMSR & UART_MSR_TERI)
894 			port->icount.rng++;
895 
896 		wake_up_interruptible(&port->port.delta_msr_wait);
897 	}
898 }
899 
qt2_update_lsr(struct usb_serial_port * port,unsigned char * ch)900 static void qt2_update_lsr(struct usb_serial_port *port, unsigned char *ch)
901 {
902 	struct qt2_port_private *port_priv;
903 	struct async_icount *icount;
904 	unsigned long flags;
905 	u8 newLSR = (u8) *ch;
906 
907 	port_priv = usb_get_serial_port_data(port);
908 
909 	if (newLSR & UART_LSR_BI)
910 		newLSR &= (u8) (UART_LSR_OE | UART_LSR_BI);
911 
912 	spin_lock_irqsave(&port_priv->lock, flags);
913 	port_priv->shadowLSR = newLSR;
914 	spin_unlock_irqrestore(&port_priv->lock, flags);
915 
916 	icount = &port->icount;
917 
918 	if (newLSR & UART_LSR_BRK_ERROR_BITS) {
919 
920 		if (newLSR & UART_LSR_BI)
921 			icount->brk++;
922 
923 		if (newLSR & UART_LSR_OE)
924 			icount->overrun++;
925 
926 		if (newLSR & UART_LSR_PE)
927 			icount->parity++;
928 
929 		if (newLSR & UART_LSR_FE)
930 			icount->frame++;
931 	}
932 
933 }
934 
qt2_write_room(struct tty_struct * tty)935 static int qt2_write_room(struct tty_struct *tty)
936 {
937 	struct usb_serial_port *port = tty->driver_data;
938 	struct qt2_port_private *port_priv;
939 	unsigned long flags = 0;
940 	int r;
941 
942 	port_priv = usb_get_serial_port_data(port);
943 
944 	spin_lock_irqsave(&port_priv->urb_lock, flags);
945 
946 	if (port_priv->urb_in_use)
947 		r = 0;
948 	else
949 		r = QT2_WRITE_BUFFER_SIZE - QT2_WRITE_CONTROL_SIZE;
950 
951 	spin_unlock_irqrestore(&port_priv->urb_lock, flags);
952 
953 	return r;
954 }
955 
qt2_write(struct tty_struct * tty,struct usb_serial_port * port,const unsigned char * buf,int count)956 static int qt2_write(struct tty_struct *tty,
957 		     struct usb_serial_port *port,
958 		     const unsigned char *buf, int count)
959 {
960 	struct qt2_port_private *port_priv;
961 	struct urb *write_urb;
962 	unsigned char *data;
963 	unsigned long flags;
964 	int status;
965 	int bytes_out = 0;
966 
967 	port_priv = usb_get_serial_port_data(port);
968 
969 	if (port_priv->write_urb == NULL) {
970 		dev_err(&port->dev, "%s - no output urb\n", __func__);
971 		return 0;
972 	}
973 	write_urb = port_priv->write_urb;
974 
975 	count = min(count, QT2_WRITE_BUFFER_SIZE - QT2_WRITE_CONTROL_SIZE);
976 
977 	data = write_urb->transfer_buffer;
978 	spin_lock_irqsave(&port_priv->urb_lock, flags);
979 	if (port_priv->urb_in_use == true) {
980 		dev_err(&port->dev, "qt2_write - urb is in use\n");
981 		goto write_out;
982 	}
983 
984 	*data++ = QT2_CONTROL_BYTE;
985 	*data++ = QT2_CONTROL_BYTE;
986 	*data++ = port_priv->device_port;
987 	put_unaligned_le16(count, data);
988 	data += 2;
989 	memcpy(data, buf, count);
990 
991 	write_urb->transfer_buffer_length = count + QT2_WRITE_CONTROL_SIZE;
992 
993 	status = usb_submit_urb(write_urb, GFP_ATOMIC);
994 	if (status == 0) {
995 		port_priv->urb_in_use = true;
996 		bytes_out += count;
997 	}
998 
999 write_out:
1000 	spin_unlock_irqrestore(&port_priv->urb_lock, flags);
1001 	return bytes_out;
1002 }
1003 
1004 
1005 static struct usb_serial_driver qt2_device = {
1006 	.driver = {
1007 		.owner = THIS_MODULE,
1008 		.name = "quatech-serial",
1009 	},
1010 	.description	     = DRIVER_DESC,
1011 	.id_table	     = id_table,
1012 	.open		     = qt2_open,
1013 	.close		     = qt2_close,
1014 	.write               = qt2_write,
1015 	.write_room          = qt2_write_room,
1016 	.calc_num_ports      = qt2_calc_num_ports,
1017 	.attach              = qt2_attach,
1018 	.release             = qt2_release,
1019 	.disconnect          = qt2_disconnect,
1020 	.port_probe          = qt2_port_probe,
1021 	.port_remove         = qt2_port_remove,
1022 	.dtr_rts             = qt2_dtr_rts,
1023 	.break_ctl           = qt2_break_ctl,
1024 	.tiocmget            = qt2_tiocmget,
1025 	.tiocmset            = qt2_tiocmset,
1026 	.tiocmiwait          = usb_serial_generic_tiocmiwait,
1027 	.get_icount	     = usb_serial_generic_get_icount,
1028 	.ioctl               = qt2_ioctl,
1029 	.set_termios         = qt2_set_termios,
1030 };
1031 
1032 static struct usb_serial_driver *const serial_drivers[] = {
1033 	&qt2_device, NULL
1034 };
1035 
1036 module_usb_serial_driver(serial_drivers, id_table);
1037 
1038 MODULE_DESCRIPTION(DRIVER_DESC);
1039 MODULE_LICENSE("GPL");
1040