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,
96 static struct usb_serial_driver kl5kusb105d_device = {
99 .name = "kl5kusb105d",
101 .description = "KL5KUSB105D / PalmConnect",
102 .id_table = id_table,
105 .open = klsi_105_open,
106 .close = klsi_105_close,
107 .set_termios = klsi_105_set_termios,
108 /*.break_ctl = klsi_105_break_ctl,*/
109 .tiocmget = klsi_105_tiocmget,
110 .tiocmset = klsi_105_tiocmset,
111 .attach = klsi_105_startup,
112 .release = klsi_105_release,
113 .throttle = usb_serial_generic_throttle,
114 .unthrottle = usb_serial_generic_unthrottle,
115 .process_read_urb = klsi_105_process_read_urb,
116 .prepare_write_buffer = klsi_105_prepare_write_buffer,
119 static struct usb_serial_driver * const serial_drivers[] = {
120 &kl5kusb105d_device, NULL
123 struct klsi_105_port_settings {
124 __u8 pktlen; /* always 5, it seems */
129 } __attribute__ ((packed));
131 struct klsi_105_private {
132 struct klsi_105_port_settings cfg;
133 struct ktermios termios;
134 unsigned long line_state; /* modem line settings */
140 * Handle vendor specific USB requests
144 #define KLSI_TIMEOUT 5000 /* default urb timeout */
146 static int klsi_105_chg_port_settings(struct usb_serial_port *port,
147 struct klsi_105_port_settings *settings)
151 rc = usb_control_msg(port->serial->dev,
152 usb_sndctrlpipe(port->serial->dev, 0),
153 KL5KUSB105A_SIO_SET_DATA,
154 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
158 sizeof(struct klsi_105_port_settings),
162 "Change port settings failed (error = %d)\n", rc);
163 dev_info(&port->serial->dev->dev,
164 "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
165 settings->pktlen, settings->baudrate, settings->databits,
166 settings->unknown1, settings->unknown2);
170 /* translate a 16-bit status value from the device to linux's TIO bits */
171 static unsigned long klsi_105_status2linestate(const __u16 status)
173 unsigned long res = 0;
175 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
176 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
183 * Read line control via vendor command and return result through
186 /* It seems that the status buffer has always only 2 bytes length */
187 #define KLSI_STATUSBUF_LEN 2
188 static int klsi_105_get_line_state(struct usb_serial_port *port,
189 unsigned long *line_state_p)
195 dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
197 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
199 dev_err(&port->dev, "%s - out of memory for status buffer.\n",
203 status_buf[0] = 0xff;
204 status_buf[1] = 0xff;
205 rc = usb_control_msg(port->serial->dev,
206 usb_rcvctrlpipe(port->serial->dev, 0),
207 KL5KUSB105A_SIO_POLL,
208 USB_TYPE_VENDOR | USB_DIR_IN,
211 status_buf, KLSI_STATUSBUF_LEN,
215 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
218 status = get_unaligned_le16(status_buf);
220 dev_info(&port->serial->dev->dev, "read status %x %x",
221 status_buf[0], status_buf[1]);
223 *line_state_p = klsi_105_status2linestate(status);
232 * Driver's tty interface functions
235 static int klsi_105_startup(struct usb_serial *serial)
237 struct klsi_105_private *priv;
240 /* check if we support the product id (see keyspan.c)
244 /* allocate the private data structure */
245 for (i = 0; i < serial->num_ports; i++) {
246 priv = kmalloc(sizeof(struct klsi_105_private),
249 dbg("%skmalloc for klsi_105_private failed.", __func__);
253 /* set initial values for control structures */
254 priv->cfg.pktlen = 5;
255 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
256 priv->cfg.databits = kl5kusb105a_dtb_8;
257 priv->cfg.unknown1 = 0;
258 priv->cfg.unknown2 = 1;
260 priv->line_state = 0;
262 usb_set_serial_port_data(serial->port[i], priv);
264 spin_lock_init(&priv->lock);
266 /* priv->termios is left uninitialized until port opening */
267 init_waitqueue_head(&serial->port[i]->write_wait);
273 for (; i >= 0; i--) {
274 priv = usb_get_serial_port_data(serial->port[i]);
276 usb_set_serial_port_data(serial->port[i], NULL);
281 static void klsi_105_release(struct usb_serial *serial)
285 for (i = 0; i < serial->num_ports; ++i)
286 kfree(usb_get_serial_port_data(serial->port[i]));
289 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
291 struct klsi_105_private *priv = usb_get_serial_port_data(port);
295 unsigned long line_state;
296 struct klsi_105_port_settings *cfg;
299 /* Do a defined restart:
300 * Set up sane default baud rate and send the 'READ_ON'
302 * FIXME: set modem line control (how?)
303 * Then read the modem line control and store values in
306 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
308 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
313 cfg->baudrate = kl5kusb105a_sio_b9600;
314 cfg->databits = kl5kusb105a_dtb_8;
317 klsi_105_chg_port_settings(port, cfg);
319 /* set up termios structure */
320 spin_lock_irqsave(&priv->lock, flags);
321 priv->termios.c_iflag = tty->termios->c_iflag;
322 priv->termios.c_oflag = tty->termios->c_oflag;
323 priv->termios.c_cflag = tty->termios->c_cflag;
324 priv->termios.c_lflag = tty->termios->c_lflag;
325 for (i = 0; i < NCCS; i++)
326 priv->termios.c_cc[i] = tty->termios->c_cc[i];
327 priv->cfg.pktlen = cfg->pktlen;
328 priv->cfg.baudrate = cfg->baudrate;
329 priv->cfg.databits = cfg->databits;
330 priv->cfg.unknown1 = cfg->unknown1;
331 priv->cfg.unknown2 = cfg->unknown2;
332 spin_unlock_irqrestore(&priv->lock, flags);
334 /* READ_ON and urb submission */
335 rc = usb_serial_generic_open(tty, port);
341 rc = usb_control_msg(port->serial->dev,
342 usb_sndctrlpipe(port->serial->dev, 0),
343 KL5KUSB105A_SIO_CONFIGURE,
344 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
345 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
351 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
354 dbg("%s - enabled reading", __func__);
356 rc = klsi_105_get_line_state(port, &line_state);
358 spin_lock_irqsave(&priv->lock, flags);
359 priv->line_state = line_state;
360 spin_unlock_irqrestore(&priv->lock, flags);
361 dbg("%s - read line state 0x%lx", __func__, line_state);
371 static void klsi_105_close(struct usb_serial_port *port)
375 mutex_lock(&port->serial->disc_mutex);
376 if (!port->serial->disconnected) {
378 rc = usb_control_msg(port->serial->dev,
379 usb_sndctrlpipe(port->serial->dev, 0),
380 KL5KUSB105A_SIO_CONFIGURE,
381 USB_TYPE_VENDOR | USB_DIR_OUT,
382 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
388 "Disabling read failed (error = %d)\n", rc);
390 mutex_unlock(&port->serial->disc_mutex);
392 /* shutdown our bulk reads and writes */
393 usb_serial_generic_close(port);
395 /* wgg - do I need this? I think so. */
396 usb_kill_urb(port->interrupt_in_urb);
399 /* We need to write a complete 64-byte data block and encode the
400 * number actually sent in the first double-byte, LSB-order. That
401 * leaves at most 62 bytes of payload.
403 #define KLSI_HDR_LEN 2
404 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
405 void *dest, size_t size)
407 unsigned char *buf = dest;
410 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
412 put_unaligned_le16(count, buf);
414 return count + KLSI_HDR_LEN;
417 /* The data received is preceded by a length double-byte in LSB-first order.
419 static void klsi_105_process_read_urb(struct urb *urb)
421 struct usb_serial_port *port = urb->context;
422 unsigned char *data = urb->transfer_buffer;
423 struct tty_struct *tty;
426 /* empty urbs seem to happen, we ignore them */
427 if (!urb->actual_length)
430 if (urb->actual_length <= KLSI_HDR_LEN) {
431 dbg("%s - malformed packet", __func__);
435 tty = tty_port_tty_get(&port->port);
439 len = get_unaligned_le16(data);
440 if (len > urb->actual_length - KLSI_HDR_LEN) {
441 dbg("%s - packet length mismatch", __func__);
442 len = urb->actual_length - KLSI_HDR_LEN;
445 tty_insert_flip_string(tty, data + KLSI_HDR_LEN, len);
446 tty_flip_buffer_push(tty);
450 static void klsi_105_set_termios(struct tty_struct *tty,
451 struct usb_serial_port *port,
452 struct ktermios *old_termios)
454 struct klsi_105_private *priv = usb_get_serial_port_data(port);
455 unsigned int iflag = tty->termios->c_iflag;
456 unsigned int old_iflag = old_termios->c_iflag;
457 unsigned int cflag = tty->termios->c_cflag;
458 unsigned int old_cflag = old_termios->c_cflag;
459 struct klsi_105_port_settings *cfg;
463 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
465 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
470 /* lock while we are modifying the settings */
471 spin_lock_irqsave(&priv->lock, flags);
476 baud = tty_get_baud_rate(tty);
478 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
479 /* reassert DTR and (maybe) RTS on transition from B0 */
480 if ((old_cflag & CBAUD) == B0) {
481 dbg("%s: baud was B0", __func__);
483 priv->control_state |= TIOCM_DTR;
484 /* don't set RTS if using hardware flow control */
485 if (!(old_cflag & CRTSCTS))
486 priv->control_state |= TIOCM_RTS;
487 mct_u232_set_modem_ctrl(serial, priv->control_state);
492 case 0: /* handled below */
495 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
498 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
501 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
504 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
507 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
510 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
513 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
516 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
519 dbg("KLSI USB->Serial converter:"
520 " unsupported baudrate request, using default of 9600");
521 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
525 if ((cflag & CBAUD) == B0) {
526 dbg("%s: baud is B0", __func__);
527 /* Drop RTS and DTR */
528 /* maybe this should be simulated by sending read
529 * disable and read enable messages?
533 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
534 mct_u232_set_modem_ctrl(serial, priv->control_state);
537 tty_encode_baud_rate(tty, baud, baud);
539 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
540 /* set the number of data bits */
541 switch (cflag & CSIZE) {
543 dbg("%s - 5 bits/byte not supported", __func__);
544 spin_unlock_irqrestore(&priv->lock, flags);
547 dbg("%s - 6 bits/byte not supported", __func__);
548 spin_unlock_irqrestore(&priv->lock, flags);
551 priv->cfg.databits = kl5kusb105a_dtb_7;
554 priv->cfg.databits = kl5kusb105a_dtb_8;
558 "CSIZE was not CS5-CS8, using default of 8\n");
559 priv->cfg.databits = kl5kusb105a_dtb_8;
565 * Update line control register (LCR)
567 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
568 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
569 /* Not currently supported */
570 tty->termios->c_cflag &= ~(PARENB|PARODD|CSTOPB);
576 priv->last_lcr |= (cflag & PARODD) ?
577 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
579 priv->last_lcr |= MCT_U232_PARITY_NONE;
581 /* set the number of stop bits */
582 priv->last_lcr |= (cflag & CSTOPB) ?
583 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
585 mct_u232_set_line_ctrl(serial, priv->last_lcr);
590 * Set flow control: well, I do not really now how to handle DTR/RTS.
591 * Just do what we have seen with SniffUSB on Win98.
593 if ((iflag & IXOFF) != (old_iflag & IXOFF)
594 || (iflag & IXON) != (old_iflag & IXON)
595 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
596 /* Not currently supported */
597 tty->termios->c_cflag &= ~CRTSCTS;
598 /* Drop DTR/RTS if no flow control otherwise assert */
600 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
601 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
603 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
604 mct_u232_set_modem_ctrl(serial, priv->control_state);
608 memcpy(cfg, &priv->cfg, sizeof(*cfg));
609 spin_unlock_irqrestore(&priv->lock, flags);
611 /* now commit changes to device */
612 klsi_105_chg_port_settings(port, cfg);
618 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
620 struct usb_serial_port *port = tty->driver_data;
621 struct usb_serial *serial = port->serial;
622 struct mct_u232_private *priv =
623 (struct mct_u232_private *)port->private;
624 unsigned char lcr = priv->last_lcr;
626 dbg("%sstate=%d", __func__, break_state);
630 lcr |= MCT_U232_SET_BREAK;
632 mct_u232_set_line_ctrl(serial, lcr);
636 static int klsi_105_tiocmget(struct tty_struct *tty)
638 struct usb_serial_port *port = tty->driver_data;
639 struct klsi_105_private *priv = usb_get_serial_port_data(port);
642 unsigned long line_state;
644 rc = klsi_105_get_line_state(port, &line_state);
647 "Reading line control failed (error = %d)\n", rc);
648 /* better return value? EAGAIN? */
652 spin_lock_irqsave(&priv->lock, flags);
653 priv->line_state = line_state;
654 spin_unlock_irqrestore(&priv->lock, flags);
655 dbg("%s - read line state 0x%lx", __func__, line_state);
656 return (int)line_state;
659 static int klsi_105_tiocmset(struct tty_struct *tty,
660 unsigned int set, unsigned int clear)
662 int retval = -EINVAL;
664 /* if this ever gets implemented, it should be done something like this:
665 struct usb_serial *serial = port->serial;
666 struct klsi_105_private *priv = usb_get_serial_port_data(port);
670 spin_lock_irqsave (&priv->lock, flags);
672 priv->control_state |= TIOCM_RTS;
674 priv->control_state |= TIOCM_DTR;
675 if (clear & TIOCM_RTS)
676 priv->control_state &= ~TIOCM_RTS;
677 if (clear & TIOCM_DTR)
678 priv->control_state &= ~TIOCM_DTR;
679 control = priv->control_state;
680 spin_unlock_irqrestore (&priv->lock, flags);
681 retval = mct_u232_set_modem_ctrl(serial, control);
686 module_usb_serial_driver(kl5kusb105d_driver, serial_drivers);
688 MODULE_AUTHOR(DRIVER_AUTHOR);
689 MODULE_DESCRIPTION(DRIVER_DESC);
690 MODULE_LICENSE("GPL");
692 module_param(debug, bool, S_IRUGO | S_IWUSR);
693 MODULE_PARM_DESC(debug, "enable extensive debugging messages");