2 * KLSI KL5KUSB105 chip RS232 converter driver
4 * Copyright (C) 2010 Johan Hovold <jhovold@gmail.com>
5 * Copyright (C) 2001 Utz-Uwe Haus <haus@uuhaus.de>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * All information about the device was acquired using SniffUSB ans snoopUSB
14 * It was written out of frustration with the PalmConnect USB Serial adapter
16 * Neither Palm, nor their contractor (MCCI) or their supplier (KLSI) provided
17 * information that was not already available.
19 * It seems that KLSI bought some silicon-design information from ScanLogic,
20 * whose SL11R processor is at the core of the KL5KUSB chipset from KLSI.
21 * KLSI has firmware available for their devices; it is probable that the
22 * firmware differs from that used by KLSI in their products. If you have an
23 * original KLSI device and can provide some information on it, I would be
24 * most interested in adding support for it here. If you have any information
25 * on the protocol used (or find errors in my reverse-engineered stuff), please
28 * The code was only tested with a PalmConnect USB adapter; if you
29 * are adventurous, try it with any KLSI-based device and let me know how it
30 * breaks so that I can fix it!
34 * check modem line signals
35 * implement handshaking or decide that we do not support it
38 #include <linux/kernel.h>
39 #include <linux/errno.h>
40 #include <linux/slab.h>
41 #include <linux/tty.h>
42 #include <linux/tty_driver.h>
43 #include <linux/tty_flip.h>
44 #include <linux/module.h>
45 #include <linux/uaccess.h>
46 #include <asm/unaligned.h>
47 #include <linux/usb.h>
48 #include <linux/usb/serial.h>
49 #include "kl5kusb105.h"
51 #define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>, Johan Hovold <jhovold@gmail.com>"
52 #define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
58 static int klsi_105_port_probe(struct usb_serial_port *port);
59 static int klsi_105_port_remove(struct usb_serial_port *port);
60 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
61 static void klsi_105_close(struct usb_serial_port *port);
62 static void klsi_105_set_termios(struct tty_struct *tty,
63 struct usb_serial_port *port, struct ktermios *old);
64 static int klsi_105_tiocmget(struct tty_struct *tty);
65 static void klsi_105_process_read_urb(struct urb *urb);
66 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
67 void *dest, size_t size);
70 * All of the device info needed for the KLSI converters.
72 static const struct usb_device_id id_table[] = {
73 { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
74 { USB_DEVICE(KLSI_VID, KLSI_KL5KUSB105D_PID) },
75 { } /* Terminating entry */
78 MODULE_DEVICE_TABLE(usb, id_table);
80 static struct usb_serial_driver kl5kusb105d_device = {
83 .name = "kl5kusb105d",
85 .description = "KL5KUSB105D / PalmConnect",
89 .open = klsi_105_open,
90 .close = klsi_105_close,
91 .set_termios = klsi_105_set_termios,
92 .tiocmget = klsi_105_tiocmget,
93 .port_probe = klsi_105_port_probe,
94 .port_remove = klsi_105_port_remove,
95 .throttle = usb_serial_generic_throttle,
96 .unthrottle = usb_serial_generic_unthrottle,
97 .process_read_urb = klsi_105_process_read_urb,
98 .prepare_write_buffer = klsi_105_prepare_write_buffer,
101 static struct usb_serial_driver * const serial_drivers[] = {
102 &kl5kusb105d_device, NULL
105 struct klsi_105_port_settings {
106 u8 pktlen; /* always 5, it seems */
113 struct klsi_105_private {
114 struct klsi_105_port_settings cfg;
115 unsigned long line_state; /* modem line settings */
121 * Handle vendor specific USB requests
125 #define KLSI_TIMEOUT 5000 /* default urb timeout */
127 static int klsi_105_chg_port_settings(struct usb_serial_port *port,
128 struct klsi_105_port_settings *settings)
132 rc = usb_control_msg(port->serial->dev,
133 usb_sndctrlpipe(port->serial->dev, 0),
134 KL5KUSB105A_SIO_SET_DATA,
135 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
139 sizeof(struct klsi_105_port_settings),
143 "Change port settings failed (error = %d)\n", rc);
146 "pktlen %u, baudrate 0x%02x, databits %u, u1 %u, u2 %u\n",
147 settings->pktlen, settings->baudrate, settings->databits,
148 settings->unknown1, settings->unknown2);
153 /* translate a 16-bit status value from the device to linux's TIO bits */
154 static unsigned long klsi_105_status2linestate(const __u16 status)
156 unsigned long res = 0;
158 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
159 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
166 * Read line control via vendor command and return result through
169 /* It seems that the status buffer has always only 2 bytes length */
170 #define KLSI_STATUSBUF_LEN 2
171 static int klsi_105_get_line_state(struct usb_serial_port *port,
172 unsigned long *line_state_p)
178 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
182 status_buf[0] = 0xff;
183 status_buf[1] = 0xff;
184 rc = usb_control_msg(port->serial->dev,
185 usb_rcvctrlpipe(port->serial->dev, 0),
186 KL5KUSB105A_SIO_POLL,
187 USB_TYPE_VENDOR | USB_DIR_IN,
190 status_buf, KLSI_STATUSBUF_LEN,
193 if (rc != KLSI_STATUSBUF_LEN) {
194 dev_err(&port->dev, "reading line status failed: %d\n", rc);
198 status = get_unaligned_le16(status_buf);
200 dev_dbg(&port->dev, "read status %02x %02x\n",
201 status_buf[0], status_buf[1]);
203 *line_state_p = klsi_105_status2linestate(status);
212 * Driver's tty interface functions
215 static int klsi_105_port_probe(struct usb_serial_port *port)
217 struct klsi_105_private *priv;
219 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
223 /* set initial values for control structures */
224 priv->cfg.pktlen = 5;
225 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
226 priv->cfg.databits = kl5kusb105a_dtb_8;
227 priv->cfg.unknown1 = 0;
228 priv->cfg.unknown2 = 1;
230 priv->line_state = 0;
232 spin_lock_init(&priv->lock);
234 usb_set_serial_port_data(port, priv);
239 static int klsi_105_port_remove(struct usb_serial_port *port)
241 struct klsi_105_private *priv;
243 priv = usb_get_serial_port_data(port);
249 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
251 struct klsi_105_private *priv = usb_get_serial_port_data(port);
254 unsigned long line_state;
255 struct klsi_105_port_settings *cfg;
258 /* Do a defined restart:
259 * Set up sane default baud rate and send the 'READ_ON'
261 * FIXME: set modem line control (how?)
262 * Then read the modem line control and store values in
265 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
270 cfg->baudrate = kl5kusb105a_sio_b9600;
271 cfg->databits = kl5kusb105a_dtb_8;
274 klsi_105_chg_port_settings(port, cfg);
276 spin_lock_irqsave(&priv->lock, flags);
277 priv->cfg.pktlen = cfg->pktlen;
278 priv->cfg.baudrate = cfg->baudrate;
279 priv->cfg.databits = cfg->databits;
280 priv->cfg.unknown1 = cfg->unknown1;
281 priv->cfg.unknown2 = cfg->unknown2;
282 spin_unlock_irqrestore(&priv->lock, flags);
284 /* READ_ON and urb submission */
285 rc = usb_serial_generic_open(tty, port);
291 rc = usb_control_msg(port->serial->dev,
292 usb_sndctrlpipe(port->serial->dev, 0),
293 KL5KUSB105A_SIO_CONFIGURE,
294 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
295 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
301 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
303 goto err_generic_close;
305 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
307 rc = klsi_105_get_line_state(port, &line_state);
310 goto err_disable_read;
313 spin_lock_irqsave(&priv->lock, flags);
314 priv->line_state = line_state;
315 spin_unlock_irqrestore(&priv->lock, flags);
316 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__,
322 usb_control_msg(port->serial->dev,
323 usb_sndctrlpipe(port->serial->dev, 0),
324 KL5KUSB105A_SIO_CONFIGURE,
325 USB_TYPE_VENDOR | USB_DIR_OUT,
326 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
331 usb_serial_generic_close(port);
338 static void klsi_105_close(struct usb_serial_port *port)
343 rc = usb_control_msg(port->serial->dev,
344 usb_sndctrlpipe(port->serial->dev, 0),
345 KL5KUSB105A_SIO_CONFIGURE,
346 USB_TYPE_VENDOR | USB_DIR_OUT,
347 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
352 dev_err(&port->dev, "failed to disable read: %d\n", rc);
354 /* shutdown our bulk reads and writes */
355 usb_serial_generic_close(port);
358 /* We need to write a complete 64-byte data block and encode the
359 * number actually sent in the first double-byte, LSB-order. That
360 * leaves at most 62 bytes of payload.
362 #define KLSI_HDR_LEN 2
363 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
364 void *dest, size_t size)
366 unsigned char *buf = dest;
369 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
371 put_unaligned_le16(count, buf);
373 return count + KLSI_HDR_LEN;
376 /* The data received is preceded by a length double-byte in LSB-first order.
378 static void klsi_105_process_read_urb(struct urb *urb)
380 struct usb_serial_port *port = urb->context;
381 unsigned char *data = urb->transfer_buffer;
384 /* empty urbs seem to happen, we ignore them */
385 if (!urb->actual_length)
388 if (urb->actual_length <= KLSI_HDR_LEN) {
389 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
393 len = get_unaligned_le16(data);
394 if (len > urb->actual_length - KLSI_HDR_LEN) {
395 dev_dbg(&port->dev, "%s - packet length mismatch\n", __func__);
396 len = urb->actual_length - KLSI_HDR_LEN;
399 tty_insert_flip_string(&port->port, data + KLSI_HDR_LEN, len);
400 tty_flip_buffer_push(&port->port);
403 static void klsi_105_set_termios(struct tty_struct *tty,
404 struct usb_serial_port *port,
405 struct ktermios *old_termios)
407 struct klsi_105_private *priv = usb_get_serial_port_data(port);
408 struct device *dev = &port->dev;
409 unsigned int iflag = tty->termios.c_iflag;
410 unsigned int old_iflag = old_termios->c_iflag;
411 unsigned int cflag = tty->termios.c_cflag;
412 unsigned int old_cflag = old_termios->c_cflag;
413 struct klsi_105_port_settings *cfg;
417 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
421 /* lock while we are modifying the settings */
422 spin_lock_irqsave(&priv->lock, flags);
427 baud = tty_get_baud_rate(tty);
430 case 0: /* handled below */
433 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
436 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
439 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
442 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
445 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
448 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
451 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
454 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
457 dev_dbg(dev, "unsupported baudrate, using 9600\n");
458 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
464 * FIXME: implement B0 handling
466 * Maybe this should be simulated by sending read disable and read
470 tty_encode_baud_rate(tty, baud, baud);
472 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
473 /* set the number of data bits */
474 switch (cflag & CSIZE) {
476 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
477 spin_unlock_irqrestore(&priv->lock, flags);
480 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
481 spin_unlock_irqrestore(&priv->lock, flags);
484 priv->cfg.databits = kl5kusb105a_dtb_7;
487 priv->cfg.databits = kl5kusb105a_dtb_8;
490 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
491 priv->cfg.databits = kl5kusb105a_dtb_8;
497 * Update line control register (LCR)
499 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
500 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
501 /* Not currently supported */
502 tty->termios.c_cflag &= ~(PARENB|PARODD|CSTOPB);
505 * Set flow control: well, I do not really now how to handle DTR/RTS.
506 * Just do what we have seen with SniffUSB on Win98.
508 if ((iflag & IXOFF) != (old_iflag & IXOFF)
509 || (iflag & IXON) != (old_iflag & IXON)
510 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
511 /* Not currently supported */
512 tty->termios.c_cflag &= ~CRTSCTS;
514 memcpy(cfg, &priv->cfg, sizeof(*cfg));
515 spin_unlock_irqrestore(&priv->lock, flags);
517 /* now commit changes to device */
518 klsi_105_chg_port_settings(port, cfg);
523 static int klsi_105_tiocmget(struct tty_struct *tty)
525 struct usb_serial_port *port = tty->driver_data;
526 struct klsi_105_private *priv = usb_get_serial_port_data(port);
529 unsigned long line_state;
531 rc = klsi_105_get_line_state(port, &line_state);
534 "Reading line control failed (error = %d)\n", rc);
535 /* better return value? EAGAIN? */
539 spin_lock_irqsave(&priv->lock, flags);
540 priv->line_state = line_state;
541 spin_unlock_irqrestore(&priv->lock, flags);
542 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
543 return (int)line_state;
546 module_usb_serial_driver(serial_drivers, id_table);
548 MODULE_AUTHOR(DRIVER_AUTHOR);
549 MODULE_DESCRIPTION(DRIVER_DESC);
550 MODULE_LICENSE("GPL");