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"
52 #define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>, Johan Hovold <jhovold@gmail.com>"
53 #define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
59 static int klsi_105_port_probe(struct usb_serial_port *port);
60 static int klsi_105_port_remove(struct usb_serial_port *port);
61 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
62 static void klsi_105_close(struct usb_serial_port *port);
63 static void klsi_105_set_termios(struct tty_struct *tty,
64 struct usb_serial_port *port, struct ktermios *old);
65 static int klsi_105_tiocmget(struct tty_struct *tty);
66 static int klsi_105_tiocmset(struct tty_struct *tty,
67 unsigned int set, unsigned int clear);
68 static void klsi_105_process_read_urb(struct urb *urb);
69 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
70 void *dest, size_t size);
73 * All of the device info needed for the KLSI converters.
75 static const struct usb_device_id id_table[] = {
76 { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
77 { USB_DEVICE(KLSI_VID, KLSI_KL5KUSB105D_PID) },
78 { } /* Terminating entry */
81 MODULE_DEVICE_TABLE(usb, id_table);
83 static struct usb_serial_driver kl5kusb105d_device = {
86 .name = "kl5kusb105d",
88 .description = "KL5KUSB105D / PalmConnect",
92 .open = klsi_105_open,
93 .close = klsi_105_close,
94 .set_termios = klsi_105_set_termios,
95 /*.break_ctl = klsi_105_break_ctl,*/
96 .tiocmget = klsi_105_tiocmget,
97 .tiocmset = klsi_105_tiocmset,
98 .port_probe = klsi_105_port_probe,
99 .port_remove = klsi_105_port_remove,
100 .throttle = usb_serial_generic_throttle,
101 .unthrottle = usb_serial_generic_unthrottle,
102 .process_read_urb = klsi_105_process_read_urb,
103 .prepare_write_buffer = klsi_105_prepare_write_buffer,
106 static struct usb_serial_driver * const serial_drivers[] = {
107 &kl5kusb105d_device, NULL
110 struct klsi_105_port_settings {
111 __u8 pktlen; /* always 5, it seems */
116 } __attribute__ ((packed));
118 struct klsi_105_private {
119 struct klsi_105_port_settings cfg;
120 struct ktermios termios;
121 unsigned long line_state; /* modem line settings */
127 * Handle vendor specific USB requests
131 #define KLSI_TIMEOUT 5000 /* default urb timeout */
133 static int klsi_105_chg_port_settings(struct usb_serial_port *port,
134 struct klsi_105_port_settings *settings)
138 rc = usb_control_msg(port->serial->dev,
139 usb_sndctrlpipe(port->serial->dev, 0),
140 KL5KUSB105A_SIO_SET_DATA,
141 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
145 sizeof(struct klsi_105_port_settings),
149 "Change port settings failed (error = %d)\n", rc);
150 dev_info(&port->serial->dev->dev,
151 "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
152 settings->pktlen, settings->baudrate, settings->databits,
153 settings->unknown1, settings->unknown2);
157 /* translate a 16-bit status value from the device to linux's TIO bits */
158 static unsigned long klsi_105_status2linestate(const __u16 status)
160 unsigned long res = 0;
162 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
163 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
170 * Read line control via vendor command and return result through
173 /* It seems that the status buffer has always only 2 bytes length */
174 #define KLSI_STATUSBUF_LEN 2
175 static int klsi_105_get_line_state(struct usb_serial_port *port,
176 unsigned long *line_state_p)
182 dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
184 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
188 status_buf[0] = 0xff;
189 status_buf[1] = 0xff;
190 rc = usb_control_msg(port->serial->dev,
191 usb_rcvctrlpipe(port->serial->dev, 0),
192 KL5KUSB105A_SIO_POLL,
193 USB_TYPE_VENDOR | USB_DIR_IN,
196 status_buf, KLSI_STATUSBUF_LEN,
200 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
203 status = get_unaligned_le16(status_buf);
205 dev_info(&port->serial->dev->dev, "read status %x %x",
206 status_buf[0], status_buf[1]);
208 *line_state_p = klsi_105_status2linestate(status);
217 * Driver's tty interface functions
220 static int klsi_105_port_probe(struct usb_serial_port *port)
222 struct klsi_105_private *priv;
224 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
228 /* set initial values for control structures */
229 priv->cfg.pktlen = 5;
230 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
231 priv->cfg.databits = kl5kusb105a_dtb_8;
232 priv->cfg.unknown1 = 0;
233 priv->cfg.unknown2 = 1;
235 priv->line_state = 0;
237 spin_lock_init(&priv->lock);
239 /* priv->termios is left uninitialized until port opening */
241 usb_set_serial_port_data(port, priv);
246 static int klsi_105_port_remove(struct usb_serial_port *port)
248 struct klsi_105_private *priv;
250 priv = usb_get_serial_port_data(port);
256 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
258 struct klsi_105_private *priv = usb_get_serial_port_data(port);
262 unsigned long line_state;
263 struct klsi_105_port_settings *cfg;
266 /* Do a defined restart:
267 * Set up sane default baud rate and send the 'READ_ON'
269 * FIXME: set modem line control (how?)
270 * Then read the modem line control and store values in
273 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
278 cfg->baudrate = kl5kusb105a_sio_b9600;
279 cfg->databits = kl5kusb105a_dtb_8;
282 klsi_105_chg_port_settings(port, cfg);
284 /* set up termios structure */
285 spin_lock_irqsave(&priv->lock, flags);
286 priv->termios.c_iflag = tty->termios.c_iflag;
287 priv->termios.c_oflag = tty->termios.c_oflag;
288 priv->termios.c_cflag = tty->termios.c_cflag;
289 priv->termios.c_lflag = tty->termios.c_lflag;
290 for (i = 0; i < NCCS; i++)
291 priv->termios.c_cc[i] = tty->termios.c_cc[i];
292 priv->cfg.pktlen = cfg->pktlen;
293 priv->cfg.baudrate = cfg->baudrate;
294 priv->cfg.databits = cfg->databits;
295 priv->cfg.unknown1 = cfg->unknown1;
296 priv->cfg.unknown2 = cfg->unknown2;
297 spin_unlock_irqrestore(&priv->lock, flags);
299 /* READ_ON and urb submission */
300 rc = usb_serial_generic_open(tty, port);
306 rc = usb_control_msg(port->serial->dev,
307 usb_sndctrlpipe(port->serial->dev, 0),
308 KL5KUSB105A_SIO_CONFIGURE,
309 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
310 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
316 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
319 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
321 rc = klsi_105_get_line_state(port, &line_state);
323 spin_lock_irqsave(&priv->lock, flags);
324 priv->line_state = line_state;
325 spin_unlock_irqrestore(&priv->lock, flags);
326 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
336 static void klsi_105_close(struct usb_serial_port *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,
345 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
350 dev_err(&port->dev, "failed to disable read: %d\n", rc);
352 /* shutdown our bulk reads and writes */
353 usb_serial_generic_close(port);
356 /* We need to write a complete 64-byte data block and encode the
357 * number actually sent in the first double-byte, LSB-order. That
358 * leaves at most 62 bytes of payload.
360 #define KLSI_HDR_LEN 2
361 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
362 void *dest, size_t size)
364 unsigned char *buf = dest;
367 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
369 put_unaligned_le16(count, buf);
371 return count + KLSI_HDR_LEN;
374 /* The data received is preceded by a length double-byte in LSB-first order.
376 static void klsi_105_process_read_urb(struct urb *urb)
378 struct usb_serial_port *port = urb->context;
379 unsigned char *data = urb->transfer_buffer;
382 /* empty urbs seem to happen, we ignore them */
383 if (!urb->actual_length)
386 if (urb->actual_length <= KLSI_HDR_LEN) {
387 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
391 len = get_unaligned_le16(data);
392 if (len > urb->actual_length - KLSI_HDR_LEN) {
393 dev_dbg(&port->dev, "%s - packet length mismatch\n", __func__);
394 len = urb->actual_length - KLSI_HDR_LEN;
397 tty_insert_flip_string(&port->port, data + KLSI_HDR_LEN, len);
398 tty_flip_buffer_push(&port->port);
401 static void klsi_105_set_termios(struct tty_struct *tty,
402 struct usb_serial_port *port,
403 struct ktermios *old_termios)
405 struct klsi_105_private *priv = usb_get_serial_port_data(port);
406 struct device *dev = &port->dev;
407 unsigned int iflag = tty->termios.c_iflag;
408 unsigned int old_iflag = old_termios->c_iflag;
409 unsigned int cflag = tty->termios.c_cflag;
410 unsigned int old_cflag = old_termios->c_cflag;
411 struct klsi_105_port_settings *cfg;
415 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
419 /* lock while we are modifying the settings */
420 spin_lock_irqsave(&priv->lock, flags);
425 baud = tty_get_baud_rate(tty);
427 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
428 /* reassert DTR and (maybe) RTS on transition from B0 */
429 if ((old_cflag & CBAUD) == B0) {
430 dev_dbg(dev, "%s: baud was B0\n", __func__);
432 priv->control_state |= TIOCM_DTR;
433 /* don't set RTS if using hardware flow control */
434 if (!(old_cflag & CRTSCTS))
435 priv->control_state |= TIOCM_RTS;
436 mct_u232_set_modem_ctrl(serial, priv->control_state);
441 case 0: /* handled below */
444 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
447 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
450 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
453 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
456 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
459 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
462 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
465 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
468 dev_dbg(dev, "KLSI USB->Serial converter: unsupported baudrate request, using default of 9600");
469 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
473 if ((cflag & CBAUD) == B0) {
474 dev_dbg(dev, "%s: baud is B0\n", __func__);
475 /* Drop RTS and DTR */
476 /* maybe this should be simulated by sending read
477 * disable and read enable messages?
481 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
482 mct_u232_set_modem_ctrl(serial, priv->control_state);
485 tty_encode_baud_rate(tty, baud, baud);
487 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
488 /* set the number of data bits */
489 switch (cflag & CSIZE) {
491 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
492 spin_unlock_irqrestore(&priv->lock, flags);
495 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
496 spin_unlock_irqrestore(&priv->lock, flags);
499 priv->cfg.databits = kl5kusb105a_dtb_7;
502 priv->cfg.databits = kl5kusb105a_dtb_8;
505 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
506 priv->cfg.databits = kl5kusb105a_dtb_8;
512 * Update line control register (LCR)
514 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
515 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
516 /* Not currently supported */
517 tty->termios.c_cflag &= ~(PARENB|PARODD|CSTOPB);
523 priv->last_lcr |= (cflag & PARODD) ?
524 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
526 priv->last_lcr |= MCT_U232_PARITY_NONE;
528 /* set the number of stop bits */
529 priv->last_lcr |= (cflag & CSTOPB) ?
530 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
532 mct_u232_set_line_ctrl(serial, priv->last_lcr);
537 * Set flow control: well, I do not really now how to handle DTR/RTS.
538 * Just do what we have seen with SniffUSB on Win98.
540 if ((iflag & IXOFF) != (old_iflag & IXOFF)
541 || (iflag & IXON) != (old_iflag & IXON)
542 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
543 /* Not currently supported */
544 tty->termios.c_cflag &= ~CRTSCTS;
545 /* Drop DTR/RTS if no flow control otherwise assert */
547 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
548 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
550 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
551 mct_u232_set_modem_ctrl(serial, priv->control_state);
555 memcpy(cfg, &priv->cfg, sizeof(*cfg));
556 spin_unlock_irqrestore(&priv->lock, flags);
558 /* now commit changes to device */
559 klsi_105_chg_port_settings(port, cfg);
565 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
567 struct usb_serial_port *port = tty->driver_data;
568 struct usb_serial *serial = port->serial;
569 struct mct_u232_private *priv =
570 (struct mct_u232_private *)port->private;
571 unsigned char lcr = priv->last_lcr;
573 dev_dbg(&port->dev, "%s - state=%d\n", __func__, break_state);
577 lcr |= MCT_U232_SET_BREAK;
579 mct_u232_set_line_ctrl(serial, lcr);
583 static int klsi_105_tiocmget(struct tty_struct *tty)
585 struct usb_serial_port *port = tty->driver_data;
586 struct klsi_105_private *priv = usb_get_serial_port_data(port);
589 unsigned long line_state;
591 rc = klsi_105_get_line_state(port, &line_state);
594 "Reading line control failed (error = %d)\n", rc);
595 /* better return value? EAGAIN? */
599 spin_lock_irqsave(&priv->lock, flags);
600 priv->line_state = line_state;
601 spin_unlock_irqrestore(&priv->lock, flags);
602 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
603 return (int)line_state;
606 static int klsi_105_tiocmset(struct tty_struct *tty,
607 unsigned int set, unsigned int clear)
609 int retval = -EINVAL;
611 /* if this ever gets implemented, it should be done something like this:
612 struct usb_serial *serial = port->serial;
613 struct klsi_105_private *priv = usb_get_serial_port_data(port);
617 spin_lock_irqsave (&priv->lock, flags);
619 priv->control_state |= TIOCM_RTS;
621 priv->control_state |= TIOCM_DTR;
622 if (clear & TIOCM_RTS)
623 priv->control_state &= ~TIOCM_RTS;
624 if (clear & TIOCM_DTR)
625 priv->control_state &= ~TIOCM_DTR;
626 control = priv->control_state;
627 spin_unlock_irqrestore (&priv->lock, flags);
628 retval = mct_u232_set_modem_ctrl(serial, control);
633 module_usb_serial_driver(serial_drivers, id_table);
635 MODULE_AUTHOR(DRIVER_AUTHOR);
636 MODULE_DESCRIPTION(DRIVER_DESC);
637 MODULE_LICENSE("GPL");