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_port_probe(struct usb_serial_port *port);
64 static int klsi_105_port_remove(struct usb_serial_port *port);
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 .port_probe = klsi_105_port_probe,
103 .port_remove = klsi_105_port_remove,
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_port_probe(struct usb_serial_port *port)
228 struct klsi_105_private *priv;
230 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
234 /* set initial values for control structures */
235 priv->cfg.pktlen = 5;
236 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
237 priv->cfg.databits = kl5kusb105a_dtb_8;
238 priv->cfg.unknown1 = 0;
239 priv->cfg.unknown2 = 1;
241 priv->line_state = 0;
243 spin_lock_init(&priv->lock);
245 /* priv->termios is left uninitialized until port opening */
247 usb_set_serial_port_data(port, priv);
252 static int klsi_105_port_remove(struct usb_serial_port *port)
254 struct klsi_105_private *priv;
256 priv = usb_get_serial_port_data(port);
262 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
264 struct klsi_105_private *priv = usb_get_serial_port_data(port);
268 unsigned long line_state;
269 struct klsi_105_port_settings *cfg;
272 /* Do a defined restart:
273 * Set up sane default baud rate and send the 'READ_ON'
275 * FIXME: set modem line control (how?)
276 * Then read the modem line control and store values in
279 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
281 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
286 cfg->baudrate = kl5kusb105a_sio_b9600;
287 cfg->databits = kl5kusb105a_dtb_8;
290 klsi_105_chg_port_settings(port, cfg);
292 /* set up termios structure */
293 spin_lock_irqsave(&priv->lock, flags);
294 priv->termios.c_iflag = tty->termios.c_iflag;
295 priv->termios.c_oflag = tty->termios.c_oflag;
296 priv->termios.c_cflag = tty->termios.c_cflag;
297 priv->termios.c_lflag = tty->termios.c_lflag;
298 for (i = 0; i < NCCS; i++)
299 priv->termios.c_cc[i] = tty->termios.c_cc[i];
300 priv->cfg.pktlen = cfg->pktlen;
301 priv->cfg.baudrate = cfg->baudrate;
302 priv->cfg.databits = cfg->databits;
303 priv->cfg.unknown1 = cfg->unknown1;
304 priv->cfg.unknown2 = cfg->unknown2;
305 spin_unlock_irqrestore(&priv->lock, flags);
307 /* READ_ON and urb submission */
308 rc = usb_serial_generic_open(tty, port);
314 rc = usb_control_msg(port->serial->dev,
315 usb_sndctrlpipe(port->serial->dev, 0),
316 KL5KUSB105A_SIO_CONFIGURE,
317 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
318 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
324 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
327 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
329 rc = klsi_105_get_line_state(port, &line_state);
331 spin_lock_irqsave(&priv->lock, flags);
332 priv->line_state = line_state;
333 spin_unlock_irqrestore(&priv->lock, flags);
334 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
344 static void klsi_105_close(struct usb_serial_port *port)
348 mutex_lock(&port->serial->disc_mutex);
349 if (!port->serial->disconnected) {
351 rc = usb_control_msg(port->serial->dev,
352 usb_sndctrlpipe(port->serial->dev, 0),
353 KL5KUSB105A_SIO_CONFIGURE,
354 USB_TYPE_VENDOR | USB_DIR_OUT,
355 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
361 "Disabling read failed (error = %d)\n", rc);
363 mutex_unlock(&port->serial->disc_mutex);
365 /* shutdown our bulk reads and writes */
366 usb_serial_generic_close(port);
368 /* wgg - do I need this? I think so. */
369 usb_kill_urb(port->interrupt_in_urb);
372 /* We need to write a complete 64-byte data block and encode the
373 * number actually sent in the first double-byte, LSB-order. That
374 * leaves at most 62 bytes of payload.
376 #define KLSI_HDR_LEN 2
377 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
378 void *dest, size_t size)
380 unsigned char *buf = dest;
383 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
385 put_unaligned_le16(count, buf);
387 return count + KLSI_HDR_LEN;
390 /* The data received is preceded by a length double-byte in LSB-first order.
392 static void klsi_105_process_read_urb(struct urb *urb)
394 struct usb_serial_port *port = urb->context;
395 unsigned char *data = urb->transfer_buffer;
396 struct tty_struct *tty;
399 /* empty urbs seem to happen, we ignore them */
400 if (!urb->actual_length)
403 if (urb->actual_length <= KLSI_HDR_LEN) {
404 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
408 tty = tty_port_tty_get(&port->port);
412 len = get_unaligned_le16(data);
413 if (len > urb->actual_length - KLSI_HDR_LEN) {
414 dev_dbg(&port->dev, "%s - packet length mismatch\n", __func__);
415 len = urb->actual_length - KLSI_HDR_LEN;
418 tty_insert_flip_string(tty, data + KLSI_HDR_LEN, len);
419 tty_flip_buffer_push(tty);
423 static void klsi_105_set_termios(struct tty_struct *tty,
424 struct usb_serial_port *port,
425 struct ktermios *old_termios)
427 struct klsi_105_private *priv = usb_get_serial_port_data(port);
428 struct device *dev = &port->dev;
429 unsigned int iflag = tty->termios.c_iflag;
430 unsigned int old_iflag = old_termios->c_iflag;
431 unsigned int cflag = tty->termios.c_cflag;
432 unsigned int old_cflag = old_termios->c_cflag;
433 struct klsi_105_port_settings *cfg;
437 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
439 dev_err(dev, "%s - out of memory for config buffer.\n", __func__);
443 /* lock while we are modifying the settings */
444 spin_lock_irqsave(&priv->lock, flags);
449 baud = tty_get_baud_rate(tty);
451 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
452 /* reassert DTR and (maybe) RTS on transition from B0 */
453 if ((old_cflag & CBAUD) == B0) {
454 dev_dbg(dev, "%s: baud was B0\n", __func__);
456 priv->control_state |= TIOCM_DTR;
457 /* don't set RTS if using hardware flow control */
458 if (!(old_cflag & CRTSCTS))
459 priv->control_state |= TIOCM_RTS;
460 mct_u232_set_modem_ctrl(serial, priv->control_state);
465 case 0: /* handled below */
468 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
471 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
474 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
477 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
480 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
483 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
486 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
489 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
492 dev_dbg(dev, "KLSI USB->Serial converter: unsupported baudrate request, using default of 9600");
493 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
497 if ((cflag & CBAUD) == B0) {
498 dev_dbg(dev, "%s: baud is B0\n", __func__);
499 /* Drop RTS and DTR */
500 /* maybe this should be simulated by sending read
501 * disable and read enable messages?
505 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
506 mct_u232_set_modem_ctrl(serial, priv->control_state);
509 tty_encode_baud_rate(tty, baud, baud);
511 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
512 /* set the number of data bits */
513 switch (cflag & CSIZE) {
515 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
516 spin_unlock_irqrestore(&priv->lock, flags);
519 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
520 spin_unlock_irqrestore(&priv->lock, flags);
523 priv->cfg.databits = kl5kusb105a_dtb_7;
526 priv->cfg.databits = kl5kusb105a_dtb_8;
529 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
530 priv->cfg.databits = kl5kusb105a_dtb_8;
536 * Update line control register (LCR)
538 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
539 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
540 /* Not currently supported */
541 tty->termios.c_cflag &= ~(PARENB|PARODD|CSTOPB);
547 priv->last_lcr |= (cflag & PARODD) ?
548 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
550 priv->last_lcr |= MCT_U232_PARITY_NONE;
552 /* set the number of stop bits */
553 priv->last_lcr |= (cflag & CSTOPB) ?
554 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
556 mct_u232_set_line_ctrl(serial, priv->last_lcr);
561 * Set flow control: well, I do not really now how to handle DTR/RTS.
562 * Just do what we have seen with SniffUSB on Win98.
564 if ((iflag & IXOFF) != (old_iflag & IXOFF)
565 || (iflag & IXON) != (old_iflag & IXON)
566 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
567 /* Not currently supported */
568 tty->termios.c_cflag &= ~CRTSCTS;
569 /* Drop DTR/RTS if no flow control otherwise assert */
571 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
572 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
574 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
575 mct_u232_set_modem_ctrl(serial, priv->control_state);
579 memcpy(cfg, &priv->cfg, sizeof(*cfg));
580 spin_unlock_irqrestore(&priv->lock, flags);
582 /* now commit changes to device */
583 klsi_105_chg_port_settings(port, cfg);
589 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
591 struct usb_serial_port *port = tty->driver_data;
592 struct usb_serial *serial = port->serial;
593 struct mct_u232_private *priv =
594 (struct mct_u232_private *)port->private;
595 unsigned char lcr = priv->last_lcr;
597 dev_dbg(&port->dev, "%s - state=%d\n", __func__, break_state);
601 lcr |= MCT_U232_SET_BREAK;
603 mct_u232_set_line_ctrl(serial, lcr);
607 static int klsi_105_tiocmget(struct tty_struct *tty)
609 struct usb_serial_port *port = tty->driver_data;
610 struct klsi_105_private *priv = usb_get_serial_port_data(port);
613 unsigned long line_state;
615 rc = klsi_105_get_line_state(port, &line_state);
618 "Reading line control failed (error = %d)\n", rc);
619 /* better return value? EAGAIN? */
623 spin_lock_irqsave(&priv->lock, flags);
624 priv->line_state = line_state;
625 spin_unlock_irqrestore(&priv->lock, flags);
626 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
627 return (int)line_state;
630 static int klsi_105_tiocmset(struct tty_struct *tty,
631 unsigned int set, unsigned int clear)
633 int retval = -EINVAL;
635 /* if this ever gets implemented, it should be done something like this:
636 struct usb_serial *serial = port->serial;
637 struct klsi_105_private *priv = usb_get_serial_port_data(port);
641 spin_lock_irqsave (&priv->lock, flags);
643 priv->control_state |= TIOCM_RTS;
645 priv->control_state |= TIOCM_DTR;
646 if (clear & TIOCM_RTS)
647 priv->control_state &= ~TIOCM_RTS;
648 if (clear & TIOCM_DTR)
649 priv->control_state &= ~TIOCM_DTR;
650 control = priv->control_state;
651 spin_unlock_irqrestore (&priv->lock, flags);
652 retval = mct_u232_set_modem_ctrl(serial, control);
657 module_usb_serial_driver(serial_drivers, id_table);
659 MODULE_AUTHOR(DRIVER_AUTHOR);
660 MODULE_DESCRIPTION(DRIVER_DESC);
661 MODULE_LICENSE("GPL");