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_driver kl5kusb105d_driver = {
90 .name = "kl5kusb105d",
91 .probe = usb_serial_probe,
92 .disconnect = usb_serial_disconnect,
97 static struct usb_serial_driver kl5kusb105d_device = {
100 .name = "kl5kusb105d",
102 .description = "KL5KUSB105D / PalmConnect",
103 .usb_driver = &kl5kusb105d_driver,
104 .id_table = id_table,
107 .open = klsi_105_open,
108 .close = klsi_105_close,
109 .set_termios = klsi_105_set_termios,
110 /*.break_ctl = klsi_105_break_ctl,*/
111 .tiocmget = klsi_105_tiocmget,
112 .tiocmset = klsi_105_tiocmset,
113 .attach = klsi_105_startup,
114 .release = klsi_105_release,
115 .throttle = usb_serial_generic_throttle,
116 .unthrottle = usb_serial_generic_unthrottle,
117 .process_read_urb = klsi_105_process_read_urb,
118 .prepare_write_buffer = klsi_105_prepare_write_buffer,
121 struct klsi_105_port_settings {
122 __u8 pktlen; /* always 5, it seems */
127 } __attribute__ ((packed));
129 struct klsi_105_private {
130 struct klsi_105_port_settings cfg;
131 struct ktermios termios;
132 unsigned long line_state; /* modem line settings */
138 * Handle vendor specific USB requests
142 #define KLSI_TIMEOUT 5000 /* default urb timeout */
144 static int klsi_105_chg_port_settings(struct usb_serial_port *port,
145 struct klsi_105_port_settings *settings)
149 rc = usb_control_msg(port->serial->dev,
150 usb_sndctrlpipe(port->serial->dev, 0),
151 KL5KUSB105A_SIO_SET_DATA,
152 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
156 sizeof(struct klsi_105_port_settings),
160 "Change port settings failed (error = %d)\n", rc);
161 dev_info(&port->serial->dev->dev,
162 "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
163 settings->pktlen, settings->baudrate, settings->databits,
164 settings->unknown1, settings->unknown2);
168 /* translate a 16-bit status value from the device to linux's TIO bits */
169 static unsigned long klsi_105_status2linestate(const __u16 status)
171 unsigned long res = 0;
173 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
174 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
181 * Read line control via vendor command and return result through
184 /* It seems that the status buffer has always only 2 bytes length */
185 #define KLSI_STATUSBUF_LEN 2
186 static int klsi_105_get_line_state(struct usb_serial_port *port,
187 unsigned long *line_state_p)
193 dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
195 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
197 dev_err(&port->dev, "%s - out of memory for status buffer.\n",
201 status_buf[0] = 0xff;
202 status_buf[1] = 0xff;
203 rc = usb_control_msg(port->serial->dev,
204 usb_rcvctrlpipe(port->serial->dev, 0),
205 KL5KUSB105A_SIO_POLL,
206 USB_TYPE_VENDOR | USB_DIR_IN,
209 status_buf, KLSI_STATUSBUF_LEN,
212 if (rc != KLSI_STATUSBUF_LEN) {
213 dev_err(&port->dev, "reading line status failed: %d\n", rc);
217 status = get_unaligned_le16(status_buf);
219 dev_info(&port->serial->dev->dev, "read status %x %x",
220 status_buf[0], status_buf[1]);
222 *line_state_p = klsi_105_status2linestate(status);
231 * Driver's tty interface functions
234 static int klsi_105_startup(struct usb_serial *serial)
236 struct klsi_105_private *priv;
239 /* check if we support the product id (see keyspan.c)
243 /* allocate the private data structure */
244 for (i = 0; i < serial->num_ports; i++) {
245 priv = kmalloc(sizeof(struct klsi_105_private),
248 dbg("%skmalloc for klsi_105_private failed.", __func__);
252 /* set initial values for control structures */
253 priv->cfg.pktlen = 5;
254 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
255 priv->cfg.databits = kl5kusb105a_dtb_8;
256 priv->cfg.unknown1 = 0;
257 priv->cfg.unknown2 = 1;
259 priv->line_state = 0;
261 usb_set_serial_port_data(serial->port[i], priv);
263 spin_lock_init(&priv->lock);
265 /* priv->termios is left uninitialized until port opening */
266 init_waitqueue_head(&serial->port[i]->write_wait);
272 for (; i >= 0; i--) {
273 priv = usb_get_serial_port_data(serial->port[i]);
275 usb_set_serial_port_data(serial->port[i], NULL);
280 static void klsi_105_release(struct usb_serial *serial)
286 for (i = 0; i < serial->num_ports; ++i)
287 kfree(usb_get_serial_port_data(serial->port[i]));
290 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
292 struct klsi_105_private *priv = usb_get_serial_port_data(port);
296 unsigned long line_state;
297 struct klsi_105_port_settings *cfg;
300 dbg("%s port %d", __func__, port->number);
302 /* Do a defined restart:
303 * Set up sane default baud rate and send the 'READ_ON'
305 * FIXME: set modem line control (how?)
306 * Then read the modem line control and store values in
309 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
311 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
316 cfg->baudrate = kl5kusb105a_sio_b9600;
317 cfg->databits = kl5kusb105a_dtb_8;
320 klsi_105_chg_port_settings(port, cfg);
322 /* set up termios structure */
323 spin_lock_irqsave(&priv->lock, flags);
324 priv->termios.c_iflag = tty->termios->c_iflag;
325 priv->termios.c_oflag = tty->termios->c_oflag;
326 priv->termios.c_cflag = tty->termios->c_cflag;
327 priv->termios.c_lflag = tty->termios->c_lflag;
328 for (i = 0; i < NCCS; i++)
329 priv->termios.c_cc[i] = tty->termios->c_cc[i];
330 priv->cfg.pktlen = cfg->pktlen;
331 priv->cfg.baudrate = cfg->baudrate;
332 priv->cfg.databits = cfg->databits;
333 priv->cfg.unknown1 = cfg->unknown1;
334 priv->cfg.unknown2 = cfg->unknown2;
335 spin_unlock_irqrestore(&priv->lock, flags);
337 /* READ_ON and urb submission */
338 rc = usb_serial_generic_open(tty, port);
344 rc = usb_control_msg(port->serial->dev,
345 usb_sndctrlpipe(port->serial->dev, 0),
346 KL5KUSB105A_SIO_CONFIGURE,
347 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
348 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
354 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
357 dbg("%s - enabled reading", __func__);
359 rc = klsi_105_get_line_state(port, &line_state);
361 spin_lock_irqsave(&priv->lock, flags);
362 priv->line_state = line_state;
363 spin_unlock_irqrestore(&priv->lock, flags);
364 dbg("%s - read line state 0x%lx", __func__, line_state);
374 static void klsi_105_close(struct usb_serial_port *port)
378 dbg("%s port %d", __func__, port->number);
380 mutex_lock(&port->serial->disc_mutex);
381 if (!port->serial->disconnected) {
383 rc = usb_control_msg(port->serial->dev,
384 usb_sndctrlpipe(port->serial->dev, 0),
385 KL5KUSB105A_SIO_CONFIGURE,
386 USB_TYPE_VENDOR | USB_DIR_OUT,
387 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
393 "Disabling read failed (error = %d)\n", rc);
395 mutex_unlock(&port->serial->disc_mutex);
397 /* shutdown our bulk reads and writes */
398 usb_serial_generic_close(port);
400 /* wgg - do I need this? I think so. */
401 usb_kill_urb(port->interrupt_in_urb);
404 /* We need to write a complete 64-byte data block and encode the
405 * number actually sent in the first double-byte, LSB-order. That
406 * leaves at most 62 bytes of payload.
408 #define KLSI_HDR_LEN 2
409 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
410 void *dest, size_t size)
412 unsigned char *buf = dest;
415 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
417 put_unaligned_le16(count, buf);
419 return count + KLSI_HDR_LEN;
422 /* The data received is preceded by a length double-byte in LSB-first order.
424 static void klsi_105_process_read_urb(struct urb *urb)
426 struct usb_serial_port *port = urb->context;
427 unsigned char *data = urb->transfer_buffer;
428 struct tty_struct *tty;
431 /* empty urbs seem to happen, we ignore them */
432 if (!urb->actual_length)
435 if (urb->actual_length <= KLSI_HDR_LEN) {
436 dbg("%s - malformed packet", __func__);
440 tty = tty_port_tty_get(&port->port);
444 len = get_unaligned_le16(data);
445 if (len > urb->actual_length - KLSI_HDR_LEN) {
446 dbg("%s - packet length mismatch", __func__);
447 len = urb->actual_length - KLSI_HDR_LEN;
450 tty_insert_flip_string(tty, data + KLSI_HDR_LEN, len);
451 tty_flip_buffer_push(tty);
455 static void klsi_105_set_termios(struct tty_struct *tty,
456 struct usb_serial_port *port,
457 struct ktermios *old_termios)
459 struct klsi_105_private *priv = usb_get_serial_port_data(port);
460 unsigned int iflag = tty->termios->c_iflag;
461 unsigned int old_iflag = old_termios->c_iflag;
462 unsigned int cflag = tty->termios->c_cflag;
463 unsigned int old_cflag = old_termios->c_cflag;
464 struct klsi_105_port_settings *cfg;
468 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
470 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
475 /* lock while we are modifying the settings */
476 spin_lock_irqsave(&priv->lock, flags);
481 baud = tty_get_baud_rate(tty);
483 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
484 /* reassert DTR and (maybe) RTS on transition from B0 */
485 if ((old_cflag & CBAUD) == B0) {
486 dbg("%s: baud was B0", __func__);
488 priv->control_state |= TIOCM_DTR;
489 /* don't set RTS if using hardware flow control */
490 if (!(old_cflag & CRTSCTS))
491 priv->control_state |= TIOCM_RTS;
492 mct_u232_set_modem_ctrl(serial, priv->control_state);
497 case 0: /* handled below */
500 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
503 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
506 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
509 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
512 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
515 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
518 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
521 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
524 dbg("KLSI USB->Serial converter:"
525 " unsupported baudrate request, using default of 9600");
526 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
530 if ((cflag & CBAUD) == B0) {
531 dbg("%s: baud is B0", __func__);
532 /* Drop RTS and DTR */
533 /* maybe this should be simulated by sending read
534 * disable and read enable messages?
538 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
539 mct_u232_set_modem_ctrl(serial, priv->control_state);
542 tty_encode_baud_rate(tty, baud, baud);
544 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
545 /* set the number of data bits */
546 switch (cflag & CSIZE) {
548 dbg("%s - 5 bits/byte not supported", __func__);
549 spin_unlock_irqrestore(&priv->lock, flags);
552 dbg("%s - 6 bits/byte not supported", __func__);
553 spin_unlock_irqrestore(&priv->lock, flags);
556 priv->cfg.databits = kl5kusb105a_dtb_7;
559 priv->cfg.databits = kl5kusb105a_dtb_8;
563 "CSIZE was not CS5-CS8, using default of 8\n");
564 priv->cfg.databits = kl5kusb105a_dtb_8;
570 * Update line control register (LCR)
572 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
573 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
574 /* Not currently supported */
575 tty->termios->c_cflag &= ~(PARENB|PARODD|CSTOPB);
581 priv->last_lcr |= (cflag & PARODD) ?
582 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
584 priv->last_lcr |= MCT_U232_PARITY_NONE;
586 /* set the number of stop bits */
587 priv->last_lcr |= (cflag & CSTOPB) ?
588 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
590 mct_u232_set_line_ctrl(serial, priv->last_lcr);
595 * Set flow control: well, I do not really now how to handle DTR/RTS.
596 * Just do what we have seen with SniffUSB on Win98.
598 if ((iflag & IXOFF) != (old_iflag & IXOFF)
599 || (iflag & IXON) != (old_iflag & IXON)
600 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
601 /* Not currently supported */
602 tty->termios->c_cflag &= ~CRTSCTS;
603 /* Drop DTR/RTS if no flow control otherwise assert */
605 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
606 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
608 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
609 mct_u232_set_modem_ctrl(serial, priv->control_state);
613 memcpy(cfg, &priv->cfg, sizeof(*cfg));
614 spin_unlock_irqrestore(&priv->lock, flags);
616 /* now commit changes to device */
617 klsi_105_chg_port_settings(port, cfg);
623 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
625 struct usb_serial_port *port = tty->driver_data;
626 struct usb_serial *serial = port->serial;
627 struct mct_u232_private *priv =
628 (struct mct_u232_private *)port->private;
629 unsigned char lcr = priv->last_lcr;
631 dbg("%sstate=%d", __func__, break_state);
635 lcr |= MCT_U232_SET_BREAK;
637 mct_u232_set_line_ctrl(serial, lcr);
641 static int klsi_105_tiocmget(struct tty_struct *tty)
643 struct usb_serial_port *port = tty->driver_data;
644 struct klsi_105_private *priv = usb_get_serial_port_data(port);
647 unsigned long line_state;
648 dbg("%s - request, just guessing", __func__);
650 rc = klsi_105_get_line_state(port, &line_state);
653 "Reading line control failed (error = %d)\n", rc);
654 /* better return value? EAGAIN? */
658 spin_lock_irqsave(&priv->lock, flags);
659 priv->line_state = line_state;
660 spin_unlock_irqrestore(&priv->lock, flags);
661 dbg("%s - read line state 0x%lx", __func__, line_state);
662 return (int)line_state;
665 static int klsi_105_tiocmset(struct tty_struct *tty,
666 unsigned int set, unsigned int clear)
668 int retval = -EINVAL;
672 /* if this ever gets implemented, it should be done something like this:
673 struct usb_serial *serial = port->serial;
674 struct klsi_105_private *priv = usb_get_serial_port_data(port);
678 spin_lock_irqsave (&priv->lock, flags);
680 priv->control_state |= TIOCM_RTS;
682 priv->control_state |= TIOCM_DTR;
683 if (clear & TIOCM_RTS)
684 priv->control_state &= ~TIOCM_RTS;
685 if (clear & TIOCM_DTR)
686 priv->control_state &= ~TIOCM_DTR;
687 control = priv->control_state;
688 spin_unlock_irqrestore (&priv->lock, flags);
689 retval = mct_u232_set_modem_ctrl(serial, control);
695 static int __init klsi_105_init(void)
698 retval = usb_serial_register(&kl5kusb105d_device);
700 goto failed_usb_serial_register;
701 retval = usb_register(&kl5kusb105d_driver);
703 goto failed_usb_register;
705 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
709 usb_serial_deregister(&kl5kusb105d_device);
710 failed_usb_serial_register:
714 static void __exit klsi_105_exit(void)
716 usb_deregister(&kl5kusb105d_driver);
717 usb_serial_deregister(&kl5kusb105d_device);
721 module_init(klsi_105_init);
722 module_exit(klsi_105_exit);
724 MODULE_AUTHOR(DRIVER_AUTHOR);
725 MODULE_DESCRIPTION(DRIVER_DESC);
726 MODULE_LICENSE("GPL");
729 module_param(debug, bool, S_IRUGO | S_IWUSR);
730 MODULE_PARM_DESC(debug, "enable extensive debugging messages");