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