1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * usb-serial driver for Quatech SSU-100
4 *
5 * based on ftdi_sio.c and the original serqt_usb.c from Quatech
6 *
7 */
8
9 #include <linux/errno.h>
10 #include <linux/slab.h>
11 #include <linux/tty.h>
12 #include <linux/tty_flip.h>
13 #include <linux/module.h>
14 #include <linux/serial.h>
15 #include <linux/usb.h>
16 #include <linux/usb/serial.h>
17 #include <linux/serial_reg.h>
18
19 #define QT_OPEN_CLOSE_CHANNEL 0xca
20 #define QT_SET_GET_DEVICE 0xc2
21 #define QT_SET_GET_REGISTER 0xc0
22 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
23 #define QT_SET_ATF 0xcd
24 #define QT_GET_SET_UART 0xc1
25 #define QT_TRANSFER_IN 0xc0
26 #define QT_HW_FLOW_CONTROL_MASK 0xc5
27 #define QT_SW_FLOW_CONTROL_MASK 0xc6
28
29 #define SERIAL_MSR_MASK 0xf0
30
31 #define SERIAL_CRTSCTS ((UART_MCR_RTS << 8) | UART_MSR_CTS)
32
33 #define SERIAL_EVEN_PARITY (UART_LCR_PARITY | UART_LCR_EPAR)
34
35 #define MIN_BAUD_RATE 50
36 #define MAX_BAUD_RATE 460800
37
38 #define ATC_DISABLED 0x00
39 #define DUPMODE_BITS 0xc0
40 #define RR_BITS 0x03
41 #define LOOPMODE_BITS 0x41
42 #define RS232_MODE 0x00
43 #define RTSCTS_TO_CONNECTOR 0x40
44 #define CLKS_X4 0x02
45 #define FULLPWRBIT 0x00000080
46 #define NEXT_BOARD_POWER_BIT 0x00000004
47
48 #define DRIVER_DESC "Quatech SSU-100 USB to Serial Driver"
49
50 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
51 #define QUATECH_SSU100 0xC020 /* SSU100 */
52
53 static const struct usb_device_id id_table[] = {
54 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100)},
55 {} /* Terminating entry */
56 };
57 MODULE_DEVICE_TABLE(usb, id_table);
58
59 struct ssu100_port_private {
60 spinlock_t status_lock;
61 u8 shadowLSR;
62 u8 shadowMSR;
63 };
64
ssu100_control_msg(struct usb_device * dev,u8 request,u16 data,u16 index)65 static inline int ssu100_control_msg(struct usb_device *dev,
66 u8 request, u16 data, u16 index)
67 {
68 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
69 request, 0x40, data, index,
70 NULL, 0, 300);
71 }
72
ssu100_setdevice(struct usb_device * dev,u8 * data)73 static inline int ssu100_setdevice(struct usb_device *dev, u8 *data)
74 {
75 u16 x = ((u16)(data[1] << 8) | (u16)(data[0]));
76
77 return ssu100_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
78 }
79
80
ssu100_getdevice(struct usb_device * dev,u8 * data)81 static inline int ssu100_getdevice(struct usb_device *dev, u8 *data)
82 {
83 int ret;
84
85 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
86 QT_SET_GET_DEVICE, 0xc0, 0, 0,
87 data, 3, 300);
88 if (ret < 3) {
89 if (ret >= 0)
90 ret = -EIO;
91 }
92
93 return ret;
94 }
95
ssu100_getregister(struct usb_device * dev,unsigned short uart,unsigned short reg,u8 * data)96 static inline int ssu100_getregister(struct usb_device *dev,
97 unsigned short uart,
98 unsigned short reg,
99 u8 *data)
100 {
101 int ret;
102
103 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
104 QT_SET_GET_REGISTER, 0xc0, reg,
105 uart, data, sizeof(*data), 300);
106 if (ret < (int)sizeof(*data)) {
107 if (ret >= 0)
108 ret = -EIO;
109 }
110
111 return ret;
112 }
113
114
ssu100_setregister(struct usb_device * dev,unsigned short uart,unsigned short reg,u16 data)115 static inline int ssu100_setregister(struct usb_device *dev,
116 unsigned short uart,
117 unsigned short reg,
118 u16 data)
119 {
120 u16 value = (data << 8) | reg;
121
122 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
123 QT_SET_GET_REGISTER, 0x40, value, uart,
124 NULL, 0, 300);
125
126 }
127
128 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
129 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
130
131 /* these do not deal with device that have more than 1 port */
update_mctrl(struct usb_device * dev,unsigned int set,unsigned int clear)132 static inline int update_mctrl(struct usb_device *dev, unsigned int set,
133 unsigned int clear)
134 {
135 unsigned urb_value;
136 int result;
137
138 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
139 dev_dbg(&dev->dev, "%s - DTR|RTS not being set|cleared\n", __func__);
140 return 0; /* no change */
141 }
142
143 clear &= ~set; /* 'set' takes precedence over 'clear' */
144 urb_value = 0;
145 if (set & TIOCM_DTR)
146 urb_value |= UART_MCR_DTR;
147 if (set & TIOCM_RTS)
148 urb_value |= UART_MCR_RTS;
149
150 result = ssu100_setregister(dev, 0, UART_MCR, urb_value);
151 if (result < 0)
152 dev_dbg(&dev->dev, "%s Error from MODEM_CTRL urb\n", __func__);
153
154 return result;
155 }
156
ssu100_initdevice(struct usb_device * dev)157 static int ssu100_initdevice(struct usb_device *dev)
158 {
159 u8 *data;
160 int result = 0;
161
162 data = kzalloc(3, GFP_KERNEL);
163 if (!data)
164 return -ENOMEM;
165
166 result = ssu100_getdevice(dev, data);
167 if (result < 0) {
168 dev_dbg(&dev->dev, "%s - get_device failed %i\n", __func__, result);
169 goto out;
170 }
171
172 data[1] &= ~FULLPWRBIT;
173
174 result = ssu100_setdevice(dev, data);
175 if (result < 0) {
176 dev_dbg(&dev->dev, "%s - setdevice failed %i\n", __func__, result);
177 goto out;
178 }
179
180 result = ssu100_control_msg(dev, QT_GET_SET_PREBUF_TRIG_LVL, 128, 0);
181 if (result < 0) {
182 dev_dbg(&dev->dev, "%s - set prebuffer level failed %i\n", __func__, result);
183 goto out;
184 }
185
186 result = ssu100_control_msg(dev, QT_SET_ATF, ATC_DISABLED, 0);
187 if (result < 0) {
188 dev_dbg(&dev->dev, "%s - set ATFprebuffer level failed %i\n", __func__, result);
189 goto out;
190 }
191
192 result = ssu100_getdevice(dev, data);
193 if (result < 0) {
194 dev_dbg(&dev->dev, "%s - get_device failed %i\n", __func__, result);
195 goto out;
196 }
197
198 data[0] &= ~(RR_BITS | DUPMODE_BITS);
199 data[0] |= CLKS_X4;
200 data[1] &= ~(LOOPMODE_BITS);
201 data[1] |= RS232_MODE;
202
203 result = ssu100_setdevice(dev, data);
204 if (result < 0) {
205 dev_dbg(&dev->dev, "%s - setdevice failed %i\n", __func__, result);
206 goto out;
207 }
208
209 out: kfree(data);
210 return result;
211
212 }
213
214
ssu100_set_termios(struct tty_struct * tty,struct usb_serial_port * port,const struct ktermios * old_termios)215 static void ssu100_set_termios(struct tty_struct *tty,
216 struct usb_serial_port *port,
217 const struct ktermios *old_termios)
218 {
219 struct usb_device *dev = port->serial->dev;
220 struct ktermios *termios = &tty->termios;
221 speed_t baud, remainder;
222 unsigned int cflag = termios->c_cflag;
223 u16 urb_value = 0; /* will hold the new flags */
224 u16 divisor;
225 int result;
226
227 if (cflag & PARENB) {
228 if (cflag & PARODD)
229 urb_value |= UART_LCR_PARITY;
230 else
231 urb_value |= SERIAL_EVEN_PARITY;
232 }
233
234 urb_value |= UART_LCR_WLEN(tty_get_char_size(cflag));
235
236 baud = tty_get_baud_rate(tty);
237 if (!baud)
238 baud = 9600;
239
240 if (baud < MIN_BAUD_RATE || baud > MAX_BAUD_RATE) {
241 if (old_termios)
242 baud = tty_termios_baud_rate(old_termios);
243 else
244 baud = clamp(baud, MIN_BAUD_RATE, MAX_BAUD_RATE);
245
246 tty_encode_baud_rate(tty, baud, baud);
247
248 if (!baud)
249 baud = 9600;
250 }
251
252 dev_dbg(&port->dev, "%s - got baud = %d\n", __func__, baud);
253
254
255 divisor = MAX_BAUD_RATE / baud;
256 remainder = MAX_BAUD_RATE % baud;
257 if (((remainder * 2) >= baud) && (baud != 110))
258 divisor++;
259
260 urb_value = urb_value << 8;
261
262 result = ssu100_control_msg(dev, QT_GET_SET_UART, divisor, urb_value);
263 if (result < 0)
264 dev_dbg(&port->dev, "%s - set uart failed\n", __func__);
265
266 if (cflag & CRTSCTS)
267 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
268 SERIAL_CRTSCTS, 0);
269 else
270 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
271 0, 0);
272 if (result < 0)
273 dev_dbg(&port->dev, "%s - set HW flow control failed\n", __func__);
274
275 if (I_IXOFF(tty) || I_IXON(tty)) {
276 u16 x = ((u16)(START_CHAR(tty) << 8) | (u16)(STOP_CHAR(tty)));
277
278 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
279 x, 0);
280 } else
281 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
282 0, 0);
283
284 if (result < 0)
285 dev_dbg(&port->dev, "%s - set SW flow control failed\n", __func__);
286
287 }
288
289
ssu100_open(struct tty_struct * tty,struct usb_serial_port * port)290 static int ssu100_open(struct tty_struct *tty, struct usb_serial_port *port)
291 {
292 struct usb_device *dev = port->serial->dev;
293 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
294 u8 *data;
295 int result;
296 unsigned long flags;
297
298 data = kzalloc(2, GFP_KERNEL);
299 if (!data)
300 return -ENOMEM;
301
302 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
303 QT_OPEN_CLOSE_CHANNEL,
304 QT_TRANSFER_IN, 0x01,
305 0, data, 2, 300);
306 if (result < 2) {
307 dev_dbg(&port->dev, "%s - open failed %i\n", __func__, result);
308 if (result >= 0)
309 result = -EIO;
310 kfree(data);
311 return result;
312 }
313
314 spin_lock_irqsave(&priv->status_lock, flags);
315 priv->shadowLSR = data[0];
316 priv->shadowMSR = data[1];
317 spin_unlock_irqrestore(&priv->status_lock, flags);
318
319 kfree(data);
320
321 /* set to 9600 */
322 result = ssu100_control_msg(dev, QT_GET_SET_UART, 0x30, 0x0300);
323 if (result < 0)
324 dev_dbg(&port->dev, "%s - set uart failed\n", __func__);
325
326 if (tty)
327 ssu100_set_termios(tty, port, NULL);
328
329 return usb_serial_generic_open(tty, port);
330 }
331
ssu100_attach(struct usb_serial * serial)332 static int ssu100_attach(struct usb_serial *serial)
333 {
334 return ssu100_initdevice(serial->dev);
335 }
336
ssu100_port_probe(struct usb_serial_port * port)337 static int ssu100_port_probe(struct usb_serial_port *port)
338 {
339 struct ssu100_port_private *priv;
340
341 priv = kzalloc_obj(*priv);
342 if (!priv)
343 return -ENOMEM;
344
345 spin_lock_init(&priv->status_lock);
346
347 usb_set_serial_port_data(port, priv);
348
349 return 0;
350 }
351
ssu100_port_remove(struct usb_serial_port * port)352 static void ssu100_port_remove(struct usb_serial_port *port)
353 {
354 struct ssu100_port_private *priv;
355
356 priv = usb_get_serial_port_data(port);
357 kfree(priv);
358 }
359
ssu100_tiocmget(struct tty_struct * tty)360 static int ssu100_tiocmget(struct tty_struct *tty)
361 {
362 struct usb_serial_port *port = tty->driver_data;
363 struct usb_device *dev = port->serial->dev;
364 u8 *d;
365 int r;
366
367 d = kzalloc(2, GFP_KERNEL);
368 if (!d)
369 return -ENOMEM;
370
371 r = ssu100_getregister(dev, 0, UART_MCR, d);
372 if (r < 0)
373 goto mget_out;
374
375 r = ssu100_getregister(dev, 0, UART_MSR, d+1);
376 if (r < 0)
377 goto mget_out;
378
379 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
380 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
381 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
382 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
383 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
384 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
385
386 mget_out:
387 kfree(d);
388 return r;
389 }
390
ssu100_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)391 static int ssu100_tiocmset(struct tty_struct *tty,
392 unsigned int set, unsigned int clear)
393 {
394 struct usb_serial_port *port = tty->driver_data;
395 struct usb_device *dev = port->serial->dev;
396
397 return update_mctrl(dev, set, clear);
398 }
399
ssu100_dtr_rts(struct usb_serial_port * port,int on)400 static void ssu100_dtr_rts(struct usb_serial_port *port, int on)
401 {
402 struct usb_device *dev = port->serial->dev;
403
404 /* Disable flow control */
405 if (!on) {
406 if (ssu100_setregister(dev, 0, UART_MCR, 0) < 0)
407 dev_err(&port->dev, "error from flowcontrol urb\n");
408 }
409 /* drop RTS and DTR */
410 if (on)
411 set_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
412 else
413 clear_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
414 }
415
ssu100_update_msr(struct usb_serial_port * port,u8 msr)416 static void ssu100_update_msr(struct usb_serial_port *port, u8 msr)
417 {
418 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
419 unsigned long flags;
420
421 spin_lock_irqsave(&priv->status_lock, flags);
422 priv->shadowMSR = msr;
423 spin_unlock_irqrestore(&priv->status_lock, flags);
424
425 if (msr & UART_MSR_ANY_DELTA) {
426 /* update input line counters */
427 if (msr & UART_MSR_DCTS)
428 port->icount.cts++;
429 if (msr & UART_MSR_DDSR)
430 port->icount.dsr++;
431 if (msr & UART_MSR_DDCD)
432 port->icount.dcd++;
433 if (msr & UART_MSR_TERI)
434 port->icount.rng++;
435 wake_up_interruptible(&port->port.delta_msr_wait);
436 }
437 }
438
ssu100_update_lsr(struct usb_serial_port * port,u8 lsr,char * tty_flag)439 static void ssu100_update_lsr(struct usb_serial_port *port, u8 lsr,
440 char *tty_flag)
441 {
442 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
443 unsigned long flags;
444
445 spin_lock_irqsave(&priv->status_lock, flags);
446 priv->shadowLSR = lsr;
447 spin_unlock_irqrestore(&priv->status_lock, flags);
448
449 *tty_flag = TTY_NORMAL;
450 if (lsr & UART_LSR_BRK_ERROR_BITS) {
451 /* we always want to update icount, but we only want to
452 * update tty_flag for one case */
453 if (lsr & UART_LSR_BI) {
454 port->icount.brk++;
455 *tty_flag = TTY_BREAK;
456 usb_serial_handle_break(port);
457 }
458 if (lsr & UART_LSR_PE) {
459 port->icount.parity++;
460 if (*tty_flag == TTY_NORMAL)
461 *tty_flag = TTY_PARITY;
462 }
463 if (lsr & UART_LSR_FE) {
464 port->icount.frame++;
465 if (*tty_flag == TTY_NORMAL)
466 *tty_flag = TTY_FRAME;
467 }
468 if (lsr & UART_LSR_OE) {
469 port->icount.overrun++;
470 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
471 }
472 }
473
474 }
475
ssu100_process_read_urb(struct urb * urb)476 static void ssu100_process_read_urb(struct urb *urb)
477 {
478 struct usb_serial_port *port = urb->context;
479 char *packet = urb->transfer_buffer;
480 char flag = TTY_NORMAL;
481 u32 len = urb->actual_length;
482 int i;
483 char *ch;
484
485 if ((len >= 4) &&
486 (packet[0] == 0x1b) && (packet[1] == 0x1b) &&
487 ((packet[2] == 0x00) || (packet[2] == 0x01))) {
488 if (packet[2] == 0x00)
489 ssu100_update_lsr(port, packet[3], &flag);
490 if (packet[2] == 0x01)
491 ssu100_update_msr(port, packet[3]);
492
493 len -= 4;
494 ch = packet + 4;
495 } else
496 ch = packet;
497
498 if (!len)
499 return; /* status only */
500
501 if (port->sysrq) {
502 for (i = 0; i < len; i++, ch++) {
503 if (!usb_serial_handle_sysrq_char(port, *ch))
504 tty_insert_flip_char(&port->port, *ch, flag);
505 }
506 } else {
507 tty_insert_flip_string_fixed_flag(&port->port, ch, flag, len);
508 }
509
510 tty_flip_buffer_push(&port->port);
511 }
512
513 static struct usb_serial_driver ssu100_device = {
514 .driver = {
515 .name = "ssu100",
516 },
517 .description = DRIVER_DESC,
518 .id_table = id_table,
519 .num_ports = 1,
520 .open = ssu100_open,
521 .attach = ssu100_attach,
522 .port_probe = ssu100_port_probe,
523 .port_remove = ssu100_port_remove,
524 .dtr_rts = ssu100_dtr_rts,
525 .process_read_urb = ssu100_process_read_urb,
526 .tiocmget = ssu100_tiocmget,
527 .tiocmset = ssu100_tiocmset,
528 .tiocmiwait = usb_serial_generic_tiocmiwait,
529 .get_icount = usb_serial_generic_get_icount,
530 .set_termios = ssu100_set_termios,
531 };
532
533 static struct usb_serial_driver * const serial_drivers[] = {
534 &ssu100_device, NULL
535 };
536
537 module_usb_serial_driver(serial_drivers, id_table);
538
539 MODULE_DESCRIPTION(DRIVER_DESC);
540 MODULE_LICENSE("GPL v2");
541