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",
94 static struct usb_serial_driver kl5kusb105d_device = {
97 .name = "kl5kusb105d",
99 .description = "KL5KUSB105D / PalmConnect",
100 .id_table = id_table,
103 .open = klsi_105_open,
104 .close = klsi_105_close,
105 .set_termios = klsi_105_set_termios,
106 /*.break_ctl = klsi_105_break_ctl,*/
107 .tiocmget = klsi_105_tiocmget,
108 .tiocmset = klsi_105_tiocmset,
109 .attach = klsi_105_startup,
110 .release = klsi_105_release,
111 .throttle = usb_serial_generic_throttle,
112 .unthrottle = usb_serial_generic_unthrottle,
113 .process_read_urb = klsi_105_process_read_urb,
114 .prepare_write_buffer = klsi_105_prepare_write_buffer,
117 static struct usb_serial_driver * const serial_drivers[] = {
118 &kl5kusb105d_device, NULL
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,
213 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
216 status = get_unaligned_le16(status_buf);
218 dev_info(&port->serial->dev->dev, "read status %x %x",
219 status_buf[0], status_buf[1]);
221 *line_state_p = klsi_105_status2linestate(status);
230 * Driver's tty interface functions
233 static int klsi_105_startup(struct usb_serial *serial)
235 struct klsi_105_private *priv;
238 /* check if we support the product id (see keyspan.c)
242 /* allocate the private data structure */
243 for (i = 0; i < serial->num_ports; i++) {
244 priv = kmalloc(sizeof(struct klsi_105_private),
247 dbg("%skmalloc for klsi_105_private failed.", __func__);
251 /* set initial values for control structures */
252 priv->cfg.pktlen = 5;
253 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
254 priv->cfg.databits = kl5kusb105a_dtb_8;
255 priv->cfg.unknown1 = 0;
256 priv->cfg.unknown2 = 1;
258 priv->line_state = 0;
260 usb_set_serial_port_data(serial->port[i], priv);
262 spin_lock_init(&priv->lock);
264 /* priv->termios is left uninitialized until port opening */
265 init_waitqueue_head(&serial->port[i]->write_wait);
271 for (; i >= 0; i--) {
272 priv = usb_get_serial_port_data(serial->port[i]);
274 usb_set_serial_port_data(serial->port[i], NULL);
279 static void klsi_105_release(struct usb_serial *serial)
283 for (i = 0; i < serial->num_ports; ++i)
284 kfree(usb_get_serial_port_data(serial->port[i]));
287 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
289 struct klsi_105_private *priv = usb_get_serial_port_data(port);
293 unsigned long line_state;
294 struct klsi_105_port_settings *cfg;
297 /* Do a defined restart:
298 * Set up sane default baud rate and send the 'READ_ON'
300 * FIXME: set modem line control (how?)
301 * Then read the modem line control and store values in
304 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
306 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
311 cfg->baudrate = kl5kusb105a_sio_b9600;
312 cfg->databits = kl5kusb105a_dtb_8;
315 klsi_105_chg_port_settings(port, cfg);
317 /* set up termios structure */
318 spin_lock_irqsave(&priv->lock, flags);
319 priv->termios.c_iflag = tty->termios->c_iflag;
320 priv->termios.c_oflag = tty->termios->c_oflag;
321 priv->termios.c_cflag = tty->termios->c_cflag;
322 priv->termios.c_lflag = tty->termios->c_lflag;
323 for (i = 0; i < NCCS; i++)
324 priv->termios.c_cc[i] = tty->termios->c_cc[i];
325 priv->cfg.pktlen = cfg->pktlen;
326 priv->cfg.baudrate = cfg->baudrate;
327 priv->cfg.databits = cfg->databits;
328 priv->cfg.unknown1 = cfg->unknown1;
329 priv->cfg.unknown2 = cfg->unknown2;
330 spin_unlock_irqrestore(&priv->lock, flags);
332 /* READ_ON and urb submission */
333 rc = usb_serial_generic_open(tty, port);
339 rc = usb_control_msg(port->serial->dev,
340 usb_sndctrlpipe(port->serial->dev, 0),
341 KL5KUSB105A_SIO_CONFIGURE,
342 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
343 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
349 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
352 dbg("%s - enabled reading", __func__);
354 rc = klsi_105_get_line_state(port, &line_state);
356 spin_lock_irqsave(&priv->lock, flags);
357 priv->line_state = line_state;
358 spin_unlock_irqrestore(&priv->lock, flags);
359 dbg("%s - read line state 0x%lx", __func__, line_state);
369 static void klsi_105_close(struct usb_serial_port *port)
373 mutex_lock(&port->serial->disc_mutex);
374 if (!port->serial->disconnected) {
376 rc = usb_control_msg(port->serial->dev,
377 usb_sndctrlpipe(port->serial->dev, 0),
378 KL5KUSB105A_SIO_CONFIGURE,
379 USB_TYPE_VENDOR | USB_DIR_OUT,
380 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
386 "Disabling read failed (error = %d)\n", rc);
388 mutex_unlock(&port->serial->disc_mutex);
390 /* shutdown our bulk reads and writes */
391 usb_serial_generic_close(port);
393 /* wgg - do I need this? I think so. */
394 usb_kill_urb(port->interrupt_in_urb);
397 /* We need to write a complete 64-byte data block and encode the
398 * number actually sent in the first double-byte, LSB-order. That
399 * leaves at most 62 bytes of payload.
401 #define KLSI_HDR_LEN 2
402 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
403 void *dest, size_t size)
405 unsigned char *buf = dest;
408 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
410 put_unaligned_le16(count, buf);
412 return count + KLSI_HDR_LEN;
415 /* The data received is preceded by a length double-byte in LSB-first order.
417 static void klsi_105_process_read_urb(struct urb *urb)
419 struct usb_serial_port *port = urb->context;
420 unsigned char *data = urb->transfer_buffer;
421 struct tty_struct *tty;
424 /* empty urbs seem to happen, we ignore them */
425 if (!urb->actual_length)
428 if (urb->actual_length <= KLSI_HDR_LEN) {
429 dbg("%s - malformed packet", __func__);
433 tty = tty_port_tty_get(&port->port);
437 len = get_unaligned_le16(data);
438 if (len > urb->actual_length - KLSI_HDR_LEN) {
439 dbg("%s - packet length mismatch", __func__);
440 len = urb->actual_length - KLSI_HDR_LEN;
443 tty_insert_flip_string(tty, data + KLSI_HDR_LEN, len);
444 tty_flip_buffer_push(tty);
448 static void klsi_105_set_termios(struct tty_struct *tty,
449 struct usb_serial_port *port,
450 struct ktermios *old_termios)
452 struct klsi_105_private *priv = usb_get_serial_port_data(port);
453 unsigned int iflag = tty->termios->c_iflag;
454 unsigned int old_iflag = old_termios->c_iflag;
455 unsigned int cflag = tty->termios->c_cflag;
456 unsigned int old_cflag = old_termios->c_cflag;
457 struct klsi_105_port_settings *cfg;
461 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
463 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
468 /* lock while we are modifying the settings */
469 spin_lock_irqsave(&priv->lock, flags);
474 baud = tty_get_baud_rate(tty);
476 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
477 /* reassert DTR and (maybe) RTS on transition from B0 */
478 if ((old_cflag & CBAUD) == B0) {
479 dbg("%s: baud was B0", __func__);
481 priv->control_state |= TIOCM_DTR;
482 /* don't set RTS if using hardware flow control */
483 if (!(old_cflag & CRTSCTS))
484 priv->control_state |= TIOCM_RTS;
485 mct_u232_set_modem_ctrl(serial, priv->control_state);
490 case 0: /* handled below */
493 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
496 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
499 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
502 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
505 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
508 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
511 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
514 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
517 dbg("KLSI USB->Serial converter:"
518 " unsupported baudrate request, using default of 9600");
519 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
523 if ((cflag & CBAUD) == B0) {
524 dbg("%s: baud is B0", __func__);
525 /* Drop RTS and DTR */
526 /* maybe this should be simulated by sending read
527 * disable and read enable messages?
531 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
532 mct_u232_set_modem_ctrl(serial, priv->control_state);
535 tty_encode_baud_rate(tty, baud, baud);
537 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
538 /* set the number of data bits */
539 switch (cflag & CSIZE) {
541 dbg("%s - 5 bits/byte not supported", __func__);
542 spin_unlock_irqrestore(&priv->lock, flags);
545 dbg("%s - 6 bits/byte not supported", __func__);
546 spin_unlock_irqrestore(&priv->lock, flags);
549 priv->cfg.databits = kl5kusb105a_dtb_7;
552 priv->cfg.databits = kl5kusb105a_dtb_8;
556 "CSIZE was not CS5-CS8, using default of 8\n");
557 priv->cfg.databits = kl5kusb105a_dtb_8;
563 * Update line control register (LCR)
565 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
566 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
567 /* Not currently supported */
568 tty->termios->c_cflag &= ~(PARENB|PARODD|CSTOPB);
574 priv->last_lcr |= (cflag & PARODD) ?
575 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
577 priv->last_lcr |= MCT_U232_PARITY_NONE;
579 /* set the number of stop bits */
580 priv->last_lcr |= (cflag & CSTOPB) ?
581 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
583 mct_u232_set_line_ctrl(serial, priv->last_lcr);
588 * Set flow control: well, I do not really now how to handle DTR/RTS.
589 * Just do what we have seen with SniffUSB on Win98.
591 if ((iflag & IXOFF) != (old_iflag & IXOFF)
592 || (iflag & IXON) != (old_iflag & IXON)
593 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
594 /* Not currently supported */
595 tty->termios->c_cflag &= ~CRTSCTS;
596 /* Drop DTR/RTS if no flow control otherwise assert */
598 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
599 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
601 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
602 mct_u232_set_modem_ctrl(serial, priv->control_state);
606 memcpy(cfg, &priv->cfg, sizeof(*cfg));
607 spin_unlock_irqrestore(&priv->lock, flags);
609 /* now commit changes to device */
610 klsi_105_chg_port_settings(port, cfg);
616 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
618 struct usb_serial_port *port = tty->driver_data;
619 struct usb_serial *serial = port->serial;
620 struct mct_u232_private *priv =
621 (struct mct_u232_private *)port->private;
622 unsigned char lcr = priv->last_lcr;
624 dbg("%sstate=%d", __func__, break_state);
628 lcr |= MCT_U232_SET_BREAK;
630 mct_u232_set_line_ctrl(serial, lcr);
634 static int klsi_105_tiocmget(struct tty_struct *tty)
636 struct usb_serial_port *port = tty->driver_data;
637 struct klsi_105_private *priv = usb_get_serial_port_data(port);
640 unsigned long line_state;
642 rc = klsi_105_get_line_state(port, &line_state);
645 "Reading line control failed (error = %d)\n", rc);
646 /* better return value? EAGAIN? */
650 spin_lock_irqsave(&priv->lock, flags);
651 priv->line_state = line_state;
652 spin_unlock_irqrestore(&priv->lock, flags);
653 dbg("%s - read line state 0x%lx", __func__, line_state);
654 return (int)line_state;
657 static int klsi_105_tiocmset(struct tty_struct *tty,
658 unsigned int set, unsigned int clear)
660 int retval = -EINVAL;
662 /* if this ever gets implemented, it should be done something like this:
663 struct usb_serial *serial = port->serial;
664 struct klsi_105_private *priv = usb_get_serial_port_data(port);
668 spin_lock_irqsave (&priv->lock, flags);
670 priv->control_state |= TIOCM_RTS;
672 priv->control_state |= TIOCM_DTR;
673 if (clear & TIOCM_RTS)
674 priv->control_state &= ~TIOCM_RTS;
675 if (clear & TIOCM_DTR)
676 priv->control_state &= ~TIOCM_DTR;
677 control = priv->control_state;
678 spin_unlock_irqrestore (&priv->lock, flags);
679 retval = mct_u232_set_modem_ctrl(serial, control);
684 module_usb_serial_driver(kl5kusb105d_driver, serial_drivers);
686 MODULE_AUTHOR(DRIVER_AUTHOR);
687 MODULE_DESCRIPTION(DRIVER_DESC);
688 MODULE_LICENSE("GPL");
690 module_param(debug, bool, S_IRUGO | S_IWUSR);
691 MODULE_PARM_DESC(debug, "enable extensive debugging messages");