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/init.h>
41 #include <linux/slab.h>
42 #include <linux/tty.h>
43 #include <linux/tty_driver.h>
44 #include <linux/tty_flip.h>
45 #include <linux/module.h>
46 #include <linux/uaccess.h>
47 #include <asm/unaligned.h>
48 #include <linux/usb.h>
49 #include <linux/usb/serial.h>
50 #include "kl5kusb105.h"
55 #define DRIVER_VERSION "v0.4"
56 #define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>, Johan Hovold <jhovold@gmail.com>"
57 #define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
63 static int klsi_105_startup(struct usb_serial *serial);
64 static void klsi_105_release(struct usb_serial *serial);
65 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
66 static void klsi_105_close(struct usb_serial_port *port);
67 static void klsi_105_set_termios(struct tty_struct *tty,
68 struct usb_serial_port *port, struct ktermios *old);
69 static int klsi_105_tiocmget(struct tty_struct *tty);
70 static int klsi_105_tiocmset(struct tty_struct *tty,
71 unsigned int set, unsigned int clear);
72 static void klsi_105_process_read_urb(struct urb *urb);
73 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
74 void *dest, size_t size);
77 * All of the device info needed for the KLSI converters.
79 static const struct usb_device_id id_table[] = {
80 { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
81 { USB_DEVICE(KLSI_VID, KLSI_KL5KUSB105D_PID) },
82 { } /* Terminating entry */
85 MODULE_DEVICE_TABLE(usb, id_table);
87 static struct usb_serial_driver kl5kusb105d_device = {
90 .name = "kl5kusb105d",
92 .description = "KL5KUSB105D / PalmConnect",
96 .open = klsi_105_open,
97 .close = klsi_105_close,
98 .set_termios = klsi_105_set_termios,
99 /*.break_ctl = klsi_105_break_ctl,*/
100 .tiocmget = klsi_105_tiocmget,
101 .tiocmset = klsi_105_tiocmset,
102 .attach = klsi_105_startup,
103 .release = klsi_105_release,
104 .throttle = usb_serial_generic_throttle,
105 .unthrottle = usb_serial_generic_unthrottle,
106 .process_read_urb = klsi_105_process_read_urb,
107 .prepare_write_buffer = klsi_105_prepare_write_buffer,
110 static struct usb_serial_driver * const serial_drivers[] = {
111 &kl5kusb105d_device, NULL
114 struct klsi_105_port_settings {
115 __u8 pktlen; /* always 5, it seems */
120 } __attribute__ ((packed));
122 struct klsi_105_private {
123 struct klsi_105_port_settings cfg;
124 struct ktermios termios;
125 unsigned long line_state; /* modem line settings */
131 * Handle vendor specific USB requests
135 #define KLSI_TIMEOUT 5000 /* default urb timeout */
137 static int klsi_105_chg_port_settings(struct usb_serial_port *port,
138 struct klsi_105_port_settings *settings)
142 rc = usb_control_msg(port->serial->dev,
143 usb_sndctrlpipe(port->serial->dev, 0),
144 KL5KUSB105A_SIO_SET_DATA,
145 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
149 sizeof(struct klsi_105_port_settings),
153 "Change port settings failed (error = %d)\n", rc);
154 dev_info(&port->serial->dev->dev,
155 "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
156 settings->pktlen, settings->baudrate, settings->databits,
157 settings->unknown1, settings->unknown2);
161 /* translate a 16-bit status value from the device to linux's TIO bits */
162 static unsigned long klsi_105_status2linestate(const __u16 status)
164 unsigned long res = 0;
166 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
167 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
174 * Read line control via vendor command and return result through
177 /* It seems that the status buffer has always only 2 bytes length */
178 #define KLSI_STATUSBUF_LEN 2
179 static int klsi_105_get_line_state(struct usb_serial_port *port,
180 unsigned long *line_state_p)
186 dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
188 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
190 dev_err(&port->dev, "%s - out of memory for status buffer.\n",
194 status_buf[0] = 0xff;
195 status_buf[1] = 0xff;
196 rc = usb_control_msg(port->serial->dev,
197 usb_rcvctrlpipe(port->serial->dev, 0),
198 KL5KUSB105A_SIO_POLL,
199 USB_TYPE_VENDOR | USB_DIR_IN,
202 status_buf, KLSI_STATUSBUF_LEN,
206 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
209 status = get_unaligned_le16(status_buf);
211 dev_info(&port->serial->dev->dev, "read status %x %x",
212 status_buf[0], status_buf[1]);
214 *line_state_p = klsi_105_status2linestate(status);
223 * Driver's tty interface functions
226 static int klsi_105_startup(struct usb_serial *serial)
228 struct klsi_105_private *priv;
231 /* check if we support the product id (see keyspan.c)
235 /* allocate the private data structure */
236 for (i = 0; i < serial->num_ports; i++) {
237 priv = kmalloc(sizeof(struct klsi_105_private),
240 dev_dbg(&serial->interface->dev,
241 "%s - kmalloc for klsi_105_private failed.\n",
246 /* set initial values for control structures */
247 priv->cfg.pktlen = 5;
248 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
249 priv->cfg.databits = kl5kusb105a_dtb_8;
250 priv->cfg.unknown1 = 0;
251 priv->cfg.unknown2 = 1;
253 priv->line_state = 0;
255 usb_set_serial_port_data(serial->port[i], priv);
257 spin_lock_init(&priv->lock);
259 /* priv->termios is left uninitialized until port opening */
260 init_waitqueue_head(&serial->port[i]->write_wait);
266 for (; i >= 0; i--) {
267 priv = usb_get_serial_port_data(serial->port[i]);
269 usb_set_serial_port_data(serial->port[i], NULL);
274 static void klsi_105_release(struct usb_serial *serial)
278 for (i = 0; i < serial->num_ports; ++i)
279 kfree(usb_get_serial_port_data(serial->port[i]));
282 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
284 struct klsi_105_private *priv = usb_get_serial_port_data(port);
288 unsigned long line_state;
289 struct klsi_105_port_settings *cfg;
292 /* Do a defined restart:
293 * Set up sane default baud rate and send the 'READ_ON'
295 * FIXME: set modem line control (how?)
296 * Then read the modem line control and store values in
299 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
301 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
306 cfg->baudrate = kl5kusb105a_sio_b9600;
307 cfg->databits = kl5kusb105a_dtb_8;
310 klsi_105_chg_port_settings(port, cfg);
312 /* set up termios structure */
313 spin_lock_irqsave(&priv->lock, flags);
314 priv->termios.c_iflag = tty->termios.c_iflag;
315 priv->termios.c_oflag = tty->termios.c_oflag;
316 priv->termios.c_cflag = tty->termios.c_cflag;
317 priv->termios.c_lflag = tty->termios.c_lflag;
318 for (i = 0; i < NCCS; i++)
319 priv->termios.c_cc[i] = tty->termios.c_cc[i];
320 priv->cfg.pktlen = cfg->pktlen;
321 priv->cfg.baudrate = cfg->baudrate;
322 priv->cfg.databits = cfg->databits;
323 priv->cfg.unknown1 = cfg->unknown1;
324 priv->cfg.unknown2 = cfg->unknown2;
325 spin_unlock_irqrestore(&priv->lock, flags);
327 /* READ_ON and urb submission */
328 rc = usb_serial_generic_open(tty, port);
334 rc = usb_control_msg(port->serial->dev,
335 usb_sndctrlpipe(port->serial->dev, 0),
336 KL5KUSB105A_SIO_CONFIGURE,
337 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
338 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
344 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
347 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
349 rc = klsi_105_get_line_state(port, &line_state);
351 spin_lock_irqsave(&priv->lock, flags);
352 priv->line_state = line_state;
353 spin_unlock_irqrestore(&priv->lock, flags);
354 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
364 static void klsi_105_close(struct usb_serial_port *port)
368 mutex_lock(&port->serial->disc_mutex);
369 if (!port->serial->disconnected) {
371 rc = usb_control_msg(port->serial->dev,
372 usb_sndctrlpipe(port->serial->dev, 0),
373 KL5KUSB105A_SIO_CONFIGURE,
374 USB_TYPE_VENDOR | USB_DIR_OUT,
375 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
381 "Disabling read failed (error = %d)\n", rc);
383 mutex_unlock(&port->serial->disc_mutex);
385 /* shutdown our bulk reads and writes */
386 usb_serial_generic_close(port);
388 /* wgg - do I need this? I think so. */
389 usb_kill_urb(port->interrupt_in_urb);
392 /* We need to write a complete 64-byte data block and encode the
393 * number actually sent in the first double-byte, LSB-order. That
394 * leaves at most 62 bytes of payload.
396 #define KLSI_HDR_LEN 2
397 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
398 void *dest, size_t size)
400 unsigned char *buf = dest;
403 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
405 put_unaligned_le16(count, buf);
407 return count + KLSI_HDR_LEN;
410 /* The data received is preceded by a length double-byte in LSB-first order.
412 static void klsi_105_process_read_urb(struct urb *urb)
414 struct usb_serial_port *port = urb->context;
415 unsigned char *data = urb->transfer_buffer;
416 struct tty_struct *tty;
419 /* empty urbs seem to happen, we ignore them */
420 if (!urb->actual_length)
423 if (urb->actual_length <= KLSI_HDR_LEN) {
424 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
428 tty = tty_port_tty_get(&port->port);
432 len = get_unaligned_le16(data);
433 if (len > urb->actual_length - KLSI_HDR_LEN) {
434 dev_dbg(&port->dev, "%s - packet length mismatch\n", __func__);
435 len = urb->actual_length - KLSI_HDR_LEN;
438 tty_insert_flip_string(tty, data + KLSI_HDR_LEN, len);
439 tty_flip_buffer_push(tty);
443 static void klsi_105_set_termios(struct tty_struct *tty,
444 struct usb_serial_port *port,
445 struct ktermios *old_termios)
447 struct klsi_105_private *priv = usb_get_serial_port_data(port);
448 struct device *dev = &port->dev;
449 unsigned int iflag = tty->termios.c_iflag;
450 unsigned int old_iflag = old_termios->c_iflag;
451 unsigned int cflag = tty->termios.c_cflag;
452 unsigned int old_cflag = old_termios->c_cflag;
453 struct klsi_105_port_settings *cfg;
457 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
459 dev_err(dev, "%s - out of memory for config buffer.\n", __func__);
463 /* lock while we are modifying the settings */
464 spin_lock_irqsave(&priv->lock, flags);
469 baud = tty_get_baud_rate(tty);
471 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
472 /* reassert DTR and (maybe) RTS on transition from B0 */
473 if ((old_cflag & CBAUD) == B0) {
474 dev_dbg(dev, "%s: baud was B0\n", __func__);
476 priv->control_state |= TIOCM_DTR;
477 /* don't set RTS if using hardware flow control */
478 if (!(old_cflag & CRTSCTS))
479 priv->control_state |= TIOCM_RTS;
480 mct_u232_set_modem_ctrl(serial, priv->control_state);
485 case 0: /* handled below */
488 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
491 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
494 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
497 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
500 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
503 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
506 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
509 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
512 dev_dbg(dev, "KLSI USB->Serial converter: unsupported baudrate request, using default of 9600");
513 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
517 if ((cflag & CBAUD) == B0) {
518 dev_dbg(dev, "%s: baud is B0\n", __func__);
519 /* Drop RTS and DTR */
520 /* maybe this should be simulated by sending read
521 * disable and read enable messages?
525 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
526 mct_u232_set_modem_ctrl(serial, priv->control_state);
529 tty_encode_baud_rate(tty, baud, baud);
531 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
532 /* set the number of data bits */
533 switch (cflag & CSIZE) {
535 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
536 spin_unlock_irqrestore(&priv->lock, flags);
539 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
540 spin_unlock_irqrestore(&priv->lock, flags);
543 priv->cfg.databits = kl5kusb105a_dtb_7;
546 priv->cfg.databits = kl5kusb105a_dtb_8;
549 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
550 priv->cfg.databits = kl5kusb105a_dtb_8;
556 * Update line control register (LCR)
558 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
559 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
560 /* Not currently supported */
561 tty->termios.c_cflag &= ~(PARENB|PARODD|CSTOPB);
567 priv->last_lcr |= (cflag & PARODD) ?
568 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
570 priv->last_lcr |= MCT_U232_PARITY_NONE;
572 /* set the number of stop bits */
573 priv->last_lcr |= (cflag & CSTOPB) ?
574 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
576 mct_u232_set_line_ctrl(serial, priv->last_lcr);
581 * Set flow control: well, I do not really now how to handle DTR/RTS.
582 * Just do what we have seen with SniffUSB on Win98.
584 if ((iflag & IXOFF) != (old_iflag & IXOFF)
585 || (iflag & IXON) != (old_iflag & IXON)
586 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
587 /* Not currently supported */
588 tty->termios.c_cflag &= ~CRTSCTS;
589 /* Drop DTR/RTS if no flow control otherwise assert */
591 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
592 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
594 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
595 mct_u232_set_modem_ctrl(serial, priv->control_state);
599 memcpy(cfg, &priv->cfg, sizeof(*cfg));
600 spin_unlock_irqrestore(&priv->lock, flags);
602 /* now commit changes to device */
603 klsi_105_chg_port_settings(port, cfg);
609 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
611 struct usb_serial_port *port = tty->driver_data;
612 struct usb_serial *serial = port->serial;
613 struct mct_u232_private *priv =
614 (struct mct_u232_private *)port->private;
615 unsigned char lcr = priv->last_lcr;
617 dev_dbg(&port->dev, "%s - state=%d\n", __func__, break_state);
621 lcr |= MCT_U232_SET_BREAK;
623 mct_u232_set_line_ctrl(serial, lcr);
627 static int klsi_105_tiocmget(struct tty_struct *tty)
629 struct usb_serial_port *port = tty->driver_data;
630 struct klsi_105_private *priv = usb_get_serial_port_data(port);
633 unsigned long line_state;
635 rc = klsi_105_get_line_state(port, &line_state);
638 "Reading line control failed (error = %d)\n", rc);
639 /* better return value? EAGAIN? */
643 spin_lock_irqsave(&priv->lock, flags);
644 priv->line_state = line_state;
645 spin_unlock_irqrestore(&priv->lock, flags);
646 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
647 return (int)line_state;
650 static int klsi_105_tiocmset(struct tty_struct *tty,
651 unsigned int set, unsigned int clear)
653 int retval = -EINVAL;
655 /* if this ever gets implemented, it should be done something like this:
656 struct usb_serial *serial = port->serial;
657 struct klsi_105_private *priv = usb_get_serial_port_data(port);
661 spin_lock_irqsave (&priv->lock, flags);
663 priv->control_state |= TIOCM_RTS;
665 priv->control_state |= TIOCM_DTR;
666 if (clear & TIOCM_RTS)
667 priv->control_state &= ~TIOCM_RTS;
668 if (clear & TIOCM_DTR)
669 priv->control_state &= ~TIOCM_DTR;
670 control = priv->control_state;
671 spin_unlock_irqrestore (&priv->lock, flags);
672 retval = mct_u232_set_modem_ctrl(serial, control);
677 module_usb_serial_driver(serial_drivers, id_table);
679 MODULE_AUTHOR(DRIVER_AUTHOR);
680 MODULE_DESCRIPTION(DRIVER_DESC);
681 MODULE_LICENSE("GPL");