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