1 // SPDX-License-Identifier: GPL-2.0+
3 * KLSI KL5KUSB105 chip RS232 converter driver
5 * Copyright (C) 2010 Johan Hovold <jhovold@gmail.com>
6 * Copyright (C) 2001 Utz-Uwe Haus <haus@uuhaus.de>
8 * All information about the device was acquired using SniffUSB ans snoopUSB
10 * It was written out of frustration with the PalmConnect USB Serial adapter
12 * Neither Palm, nor their contractor (MCCI) or their supplier (KLSI) provided
13 * information that was not already available.
15 * It seems that KLSI bought some silicon-design information from ScanLogic,
16 * whose SL11R processor is at the core of the KL5KUSB chipset from KLSI.
17 * KLSI has firmware available for their devices; it is probable that the
18 * firmware differs from that used by KLSI in their products. If you have an
19 * original KLSI device and can provide some information on it, I would be
20 * most interested in adding support for it here. If you have any information
21 * on the protocol used (or find errors in my reverse-engineered stuff), please
24 * The code was only tested with a PalmConnect USB adapter; if you
25 * are adventurous, try it with any KLSI-based device and let me know how it
26 * breaks so that I can fix it!
30 * check modem line signals
31 * implement handshaking or decide that we do not support it
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/slab.h>
37 #include <linux/tty.h>
38 #include <linux/tty_driver.h>
39 #include <linux/tty_flip.h>
40 #include <linux/module.h>
41 #include <linux/uaccess.h>
42 #include <asm/unaligned.h>
43 #include <linux/usb.h>
44 #include <linux/usb/serial.h>
45 #include "kl5kusb105.h"
47 #define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>, Johan Hovold <jhovold@gmail.com>"
48 #define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
54 static int klsi_105_port_probe(struct usb_serial_port *port);
55 static void klsi_105_port_remove(struct usb_serial_port *port);
56 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
57 static void klsi_105_close(struct usb_serial_port *port);
58 static void klsi_105_set_termios(struct tty_struct *tty,
59 struct usb_serial_port *port,
60 const struct ktermios *old_termios);
61 static int klsi_105_tiocmget(struct tty_struct *tty);
62 static void klsi_105_process_read_urb(struct urb *urb);
63 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
64 void *dest, size_t size);
67 * All of the device info needed for the KLSI converters.
69 static const struct usb_device_id id_table[] = {
70 { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
71 { } /* Terminating entry */
74 MODULE_DEVICE_TABLE(usb, id_table);
76 static struct usb_serial_driver kl5kusb105d_device = {
79 .name = "kl5kusb105d",
81 .description = "KL5KUSB105D / PalmConnect",
85 .open = klsi_105_open,
86 .close = klsi_105_close,
87 .set_termios = klsi_105_set_termios,
88 .tiocmget = klsi_105_tiocmget,
89 .port_probe = klsi_105_port_probe,
90 .port_remove = klsi_105_port_remove,
91 .throttle = usb_serial_generic_throttle,
92 .unthrottle = usb_serial_generic_unthrottle,
93 .process_read_urb = klsi_105_process_read_urb,
94 .prepare_write_buffer = klsi_105_prepare_write_buffer,
97 static struct usb_serial_driver * const serial_drivers[] = {
98 &kl5kusb105d_device, NULL
101 struct klsi_105_port_settings {
102 u8 pktlen; /* always 5, it seems */
109 struct klsi_105_private {
110 struct klsi_105_port_settings cfg;
111 unsigned long line_state; /* modem line settings */
117 * Handle vendor specific USB requests
121 #define KLSI_TIMEOUT 5000 /* default urb timeout */
123 static int klsi_105_chg_port_settings(struct usb_serial_port *port,
124 struct klsi_105_port_settings *settings)
128 rc = usb_control_msg_send(port->serial->dev,
130 KL5KUSB105A_SIO_SET_DATA,
131 USB_TYPE_VENDOR | USB_DIR_OUT |
136 sizeof(struct klsi_105_port_settings),
141 "Change port settings failed (error = %d)\n", rc);
144 "pktlen %u, baudrate 0x%02x, databits %u, u1 %u, u2 %u\n",
145 settings->pktlen, settings->baudrate, settings->databits,
146 settings->unknown1, settings->unknown2);
152 * Read line control via vendor command and return result through
155 static int klsi_105_get_line_state(struct usb_serial_port *port,
156 unsigned long *state)
161 rc = usb_control_msg_recv(port->serial->dev, 0,
162 KL5KUSB105A_SIO_POLL,
163 USB_TYPE_VENDOR | USB_DIR_IN,
166 &status, sizeof(status),
170 dev_err(&port->dev, "reading line status failed: %d\n", rc);
174 le16_to_cpus(&status);
176 dev_dbg(&port->dev, "read status %04x\n", status);
178 *state = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0) |
179 ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0);
186 * Driver's tty interface functions
189 static int klsi_105_port_probe(struct usb_serial_port *port)
191 struct klsi_105_private *priv;
193 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
197 /* set initial values for control structures */
198 priv->cfg.pktlen = 5;
199 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
200 priv->cfg.databits = kl5kusb105a_dtb_8;
201 priv->cfg.unknown1 = 0;
202 priv->cfg.unknown2 = 1;
204 priv->line_state = 0;
206 spin_lock_init(&priv->lock);
208 usb_set_serial_port_data(port, priv);
213 static void klsi_105_port_remove(struct usb_serial_port *port)
215 struct klsi_105_private *priv;
217 priv = usb_get_serial_port_data(port);
221 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
223 struct klsi_105_private *priv = usb_get_serial_port_data(port);
226 unsigned long line_state;
227 struct klsi_105_port_settings cfg;
230 /* Do a defined restart:
231 * Set up sane default baud rate and send the 'READ_ON'
233 * FIXME: set modem line control (how?)
234 * Then read the modem line control and store values in
239 cfg.baudrate = kl5kusb105a_sio_b9600;
240 cfg.databits = kl5kusb105a_dtb_8;
243 klsi_105_chg_port_settings(port, &cfg);
245 spin_lock_irqsave(&priv->lock, flags);
246 priv->cfg.pktlen = cfg.pktlen;
247 priv->cfg.baudrate = cfg.baudrate;
248 priv->cfg.databits = cfg.databits;
249 priv->cfg.unknown1 = cfg.unknown1;
250 priv->cfg.unknown2 = cfg.unknown2;
251 spin_unlock_irqrestore(&priv->lock, flags);
253 /* READ_ON and urb submission */
254 rc = usb_serial_generic_open(tty, port);
258 rc = usb_control_msg(port->serial->dev,
259 usb_sndctrlpipe(port->serial->dev, 0),
260 KL5KUSB105A_SIO_CONFIGURE,
261 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
262 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
268 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
270 goto err_generic_close;
272 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
274 rc = klsi_105_get_line_state(port, &line_state);
277 goto err_disable_read;
280 spin_lock_irqsave(&priv->lock, flags);
281 priv->line_state = line_state;
282 spin_unlock_irqrestore(&priv->lock, flags);
283 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__,
289 usb_control_msg(port->serial->dev,
290 usb_sndctrlpipe(port->serial->dev, 0),
291 KL5KUSB105A_SIO_CONFIGURE,
292 USB_TYPE_VENDOR | USB_DIR_OUT,
293 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
298 usb_serial_generic_close(port);
303 static void klsi_105_close(struct usb_serial_port *port)
308 rc = usb_control_msg(port->serial->dev,
309 usb_sndctrlpipe(port->serial->dev, 0),
310 KL5KUSB105A_SIO_CONFIGURE,
311 USB_TYPE_VENDOR | USB_DIR_OUT,
312 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
317 dev_err(&port->dev, "failed to disable read: %d\n", rc);
319 /* shutdown our bulk reads and writes */
320 usb_serial_generic_close(port);
323 /* We need to write a complete 64-byte data block and encode the
324 * number actually sent in the first double-byte, LSB-order. That
325 * leaves at most 62 bytes of payload.
327 #define KLSI_HDR_LEN 2
328 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
329 void *dest, size_t size)
331 unsigned char *buf = dest;
334 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
336 put_unaligned_le16(count, buf);
338 return count + KLSI_HDR_LEN;
341 /* The data received is preceded by a length double-byte in LSB-first order.
343 static void klsi_105_process_read_urb(struct urb *urb)
345 struct usb_serial_port *port = urb->context;
346 unsigned char *data = urb->transfer_buffer;
349 /* empty urbs seem to happen, we ignore them */
350 if (!urb->actual_length)
353 if (urb->actual_length <= KLSI_HDR_LEN) {
354 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
358 len = get_unaligned_le16(data);
359 if (len > urb->actual_length - KLSI_HDR_LEN) {
360 dev_dbg(&port->dev, "%s - packet length mismatch\n", __func__);
361 len = urb->actual_length - KLSI_HDR_LEN;
364 tty_insert_flip_string(&port->port, data + KLSI_HDR_LEN, len);
365 tty_flip_buffer_push(&port->port);
368 static void klsi_105_set_termios(struct tty_struct *tty,
369 struct usb_serial_port *port,
370 const struct ktermios *old_termios)
372 struct klsi_105_private *priv = usb_get_serial_port_data(port);
373 struct device *dev = &port->dev;
374 unsigned int iflag = tty->termios.c_iflag;
375 unsigned int old_iflag = old_termios->c_iflag;
376 unsigned int cflag = tty->termios.c_cflag;
377 unsigned int old_cflag = old_termios->c_cflag;
378 struct klsi_105_port_settings *cfg;
382 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
386 /* lock while we are modifying the settings */
387 spin_lock_irqsave(&priv->lock, flags);
392 baud = tty_get_baud_rate(tty);
395 case 0: /* handled below */
398 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
401 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
404 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
407 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
410 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
413 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
416 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
419 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
422 dev_dbg(dev, "unsupported baudrate, using 9600\n");
423 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
429 * FIXME: implement B0 handling
431 * Maybe this should be simulated by sending read disable and read
435 tty_encode_baud_rate(tty, baud, baud);
437 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
438 /* set the number of data bits */
439 switch (cflag & CSIZE) {
441 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
442 spin_unlock_irqrestore(&priv->lock, flags);
445 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
446 spin_unlock_irqrestore(&priv->lock, flags);
449 priv->cfg.databits = kl5kusb105a_dtb_7;
452 priv->cfg.databits = kl5kusb105a_dtb_8;
455 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
456 priv->cfg.databits = kl5kusb105a_dtb_8;
462 * Update line control register (LCR)
464 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
465 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
466 /* Not currently supported */
467 tty->termios.c_cflag &= ~(PARENB|PARODD|CSTOPB);
470 * Set flow control: well, I do not really now how to handle DTR/RTS.
471 * Just do what we have seen with SniffUSB on Win98.
473 if ((iflag & IXOFF) != (old_iflag & IXOFF)
474 || (iflag & IXON) != (old_iflag & IXON)
475 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
476 /* Not currently supported */
477 tty->termios.c_cflag &= ~CRTSCTS;
479 memcpy(cfg, &priv->cfg, sizeof(*cfg));
480 spin_unlock_irqrestore(&priv->lock, flags);
482 /* now commit changes to device */
483 klsi_105_chg_port_settings(port, cfg);
488 static int klsi_105_tiocmget(struct tty_struct *tty)
490 struct usb_serial_port *port = tty->driver_data;
491 struct klsi_105_private *priv = usb_get_serial_port_data(port);
494 unsigned long line_state;
496 rc = klsi_105_get_line_state(port, &line_state);
499 "Reading line control failed (error = %d)\n", rc);
500 /* better return value? EAGAIN? */
504 spin_lock_irqsave(&priv->lock, flags);
505 priv->line_state = line_state;
506 spin_unlock_irqrestore(&priv->lock, flags);
507 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
508 return (int)line_state;
511 module_usb_serial_driver(serial_drivers, id_table);
513 MODULE_AUTHOR(DRIVER_AUTHOR);
514 MODULE_DESCRIPTION(DRIVER_DESC);
515 MODULE_LICENSE("GPL");