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"
57 #define DRIVER_VERSION "v0.4"
58 #define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>, Johan Hovold <jhovold@gmail.com>"
59 #define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
65 static int klsi_105_startup(struct usb_serial *serial);
66 static void klsi_105_release(struct usb_serial *serial);
67 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
68 static void klsi_105_close(struct usb_serial_port *port);
69 static void klsi_105_set_termios(struct tty_struct *tty,
70 struct usb_serial_port *port, struct ktermios *old);
71 static int klsi_105_tiocmget(struct tty_struct *tty);
72 static int klsi_105_tiocmset(struct tty_struct *tty,
73 unsigned int set, unsigned int clear);
74 static void klsi_105_process_read_urb(struct urb *urb);
75 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
76 void *dest, size_t size);
79 * All of the device info needed for the KLSI converters.
81 static const struct usb_device_id id_table[] = {
82 { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
83 { USB_DEVICE(KLSI_VID, KLSI_KL5KUSB105D_PID) },
84 { } /* Terminating entry */
87 MODULE_DEVICE_TABLE(usb, id_table);
89 static struct usb_serial_driver kl5kusb105d_device = {
92 .name = "kl5kusb105d",
94 .description = "KL5KUSB105D / PalmConnect",
98 .open = klsi_105_open,
99 .close = klsi_105_close,
100 .set_termios = klsi_105_set_termios,
101 /*.break_ctl = klsi_105_break_ctl,*/
102 .tiocmget = klsi_105_tiocmget,
103 .tiocmset = klsi_105_tiocmset,
104 .attach = klsi_105_startup,
105 .release = klsi_105_release,
106 .throttle = usb_serial_generic_throttle,
107 .unthrottle = usb_serial_generic_unthrottle,
108 .process_read_urb = klsi_105_process_read_urb,
109 .prepare_write_buffer = klsi_105_prepare_write_buffer,
112 static struct usb_serial_driver * const serial_drivers[] = {
113 &kl5kusb105d_device, NULL
116 struct klsi_105_port_settings {
117 __u8 pktlen; /* always 5, it seems */
122 } __attribute__ ((packed));
124 struct klsi_105_private {
125 struct klsi_105_port_settings cfg;
126 struct ktermios termios;
127 unsigned long line_state; /* modem line settings */
133 * Handle vendor specific USB requests
137 #define KLSI_TIMEOUT 5000 /* default urb timeout */
139 static int klsi_105_chg_port_settings(struct usb_serial_port *port,
140 struct klsi_105_port_settings *settings)
144 rc = usb_control_msg(port->serial->dev,
145 usb_sndctrlpipe(port->serial->dev, 0),
146 KL5KUSB105A_SIO_SET_DATA,
147 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
151 sizeof(struct klsi_105_port_settings),
155 "Change port settings failed (error = %d)\n", rc);
156 dev_info(&port->serial->dev->dev,
157 "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
158 settings->pktlen, settings->baudrate, settings->databits,
159 settings->unknown1, settings->unknown2);
163 /* translate a 16-bit status value from the device to linux's TIO bits */
164 static unsigned long klsi_105_status2linestate(const __u16 status)
166 unsigned long res = 0;
168 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
169 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
176 * Read line control via vendor command and return result through
179 /* It seems that the status buffer has always only 2 bytes length */
180 #define KLSI_STATUSBUF_LEN 2
181 static int klsi_105_get_line_state(struct usb_serial_port *port,
182 unsigned long *line_state_p)
188 dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
190 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
192 dev_err(&port->dev, "%s - out of memory for status buffer.\n",
196 status_buf[0] = 0xff;
197 status_buf[1] = 0xff;
198 rc = usb_control_msg(port->serial->dev,
199 usb_rcvctrlpipe(port->serial->dev, 0),
200 KL5KUSB105A_SIO_POLL,
201 USB_TYPE_VENDOR | USB_DIR_IN,
204 status_buf, KLSI_STATUSBUF_LEN,
208 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
211 status = get_unaligned_le16(status_buf);
213 dev_info(&port->serial->dev->dev, "read status %x %x",
214 status_buf[0], status_buf[1]);
216 *line_state_p = klsi_105_status2linestate(status);
225 * Driver's tty interface functions
228 static int klsi_105_startup(struct usb_serial *serial)
230 struct klsi_105_private *priv;
233 /* check if we support the product id (see keyspan.c)
237 /* allocate the private data structure */
238 for (i = 0; i < serial->num_ports; i++) {
239 priv = kmalloc(sizeof(struct klsi_105_private),
242 dbg("%skmalloc for klsi_105_private failed.", __func__);
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 dbg("%s - enabled reading", __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 dbg("%s - read line state 0x%lx", __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 dbg("%s - malformed packet", __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 dbg("%s - packet length mismatch", __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 unsigned int iflag = tty->termios->c_iflag;
449 unsigned int old_iflag = old_termios->c_iflag;
450 unsigned int cflag = tty->termios->c_cflag;
451 unsigned int old_cflag = old_termios->c_cflag;
452 struct klsi_105_port_settings *cfg;
456 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
458 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
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 dbg("%s: baud was B0", __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 dbg("KLSI USB->Serial converter:"
513 " unsupported baudrate request, using default of 9600");
514 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
518 if ((cflag & CBAUD) == B0) {
519 dbg("%s: baud is B0", __func__);
520 /* Drop RTS and DTR */
521 /* maybe this should be simulated by sending read
522 * disable and read enable messages?
526 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
527 mct_u232_set_modem_ctrl(serial, priv->control_state);
530 tty_encode_baud_rate(tty, baud, baud);
532 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
533 /* set the number of data bits */
534 switch (cflag & CSIZE) {
536 dbg("%s - 5 bits/byte not supported", __func__);
537 spin_unlock_irqrestore(&priv->lock, flags);
540 dbg("%s - 6 bits/byte not supported", __func__);
541 spin_unlock_irqrestore(&priv->lock, flags);
544 priv->cfg.databits = kl5kusb105a_dtb_7;
547 priv->cfg.databits = kl5kusb105a_dtb_8;
551 "CSIZE was not CS5-CS8, using default of 8\n");
552 priv->cfg.databits = kl5kusb105a_dtb_8;
558 * Update line control register (LCR)
560 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
561 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
562 /* Not currently supported */
563 tty->termios->c_cflag &= ~(PARENB|PARODD|CSTOPB);
569 priv->last_lcr |= (cflag & PARODD) ?
570 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
572 priv->last_lcr |= MCT_U232_PARITY_NONE;
574 /* set the number of stop bits */
575 priv->last_lcr |= (cflag & CSTOPB) ?
576 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
578 mct_u232_set_line_ctrl(serial, priv->last_lcr);
583 * Set flow control: well, I do not really now how to handle DTR/RTS.
584 * Just do what we have seen with SniffUSB on Win98.
586 if ((iflag & IXOFF) != (old_iflag & IXOFF)
587 || (iflag & IXON) != (old_iflag & IXON)
588 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
589 /* Not currently supported */
590 tty->termios->c_cflag &= ~CRTSCTS;
591 /* Drop DTR/RTS if no flow control otherwise assert */
593 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
594 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
596 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
597 mct_u232_set_modem_ctrl(serial, priv->control_state);
601 memcpy(cfg, &priv->cfg, sizeof(*cfg));
602 spin_unlock_irqrestore(&priv->lock, flags);
604 /* now commit changes to device */
605 klsi_105_chg_port_settings(port, cfg);
611 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
613 struct usb_serial_port *port = tty->driver_data;
614 struct usb_serial *serial = port->serial;
615 struct mct_u232_private *priv =
616 (struct mct_u232_private *)port->private;
617 unsigned char lcr = priv->last_lcr;
619 dbg("%sstate=%d", __func__, break_state);
623 lcr |= MCT_U232_SET_BREAK;
625 mct_u232_set_line_ctrl(serial, lcr);
629 static int klsi_105_tiocmget(struct tty_struct *tty)
631 struct usb_serial_port *port = tty->driver_data;
632 struct klsi_105_private *priv = usb_get_serial_port_data(port);
635 unsigned long line_state;
637 rc = klsi_105_get_line_state(port, &line_state);
640 "Reading line control failed (error = %d)\n", rc);
641 /* better return value? EAGAIN? */
645 spin_lock_irqsave(&priv->lock, flags);
646 priv->line_state = line_state;
647 spin_unlock_irqrestore(&priv->lock, flags);
648 dbg("%s - read line state 0x%lx", __func__, line_state);
649 return (int)line_state;
652 static int klsi_105_tiocmset(struct tty_struct *tty,
653 unsigned int set, unsigned int clear)
655 int retval = -EINVAL;
657 /* if this ever gets implemented, it should be done something like this:
658 struct usb_serial *serial = port->serial;
659 struct klsi_105_private *priv = usb_get_serial_port_data(port);
663 spin_lock_irqsave (&priv->lock, flags);
665 priv->control_state |= TIOCM_RTS;
667 priv->control_state |= TIOCM_DTR;
668 if (clear & TIOCM_RTS)
669 priv->control_state &= ~TIOCM_RTS;
670 if (clear & TIOCM_DTR)
671 priv->control_state &= ~TIOCM_DTR;
672 control = priv->control_state;
673 spin_unlock_irqrestore (&priv->lock, flags);
674 retval = mct_u232_set_modem_ctrl(serial, control);
679 module_usb_serial_driver(serial_drivers, id_table);
681 MODULE_AUTHOR(DRIVER_AUTHOR);
682 MODULE_DESCRIPTION(DRIVER_DESC);
683 MODULE_LICENSE("GPL");
685 module_param(debug, bool, S_IRUGO | S_IWUSR);
686 MODULE_PARM_DESC(debug, "enable extensive debugging messages");