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/slab.h>
41 #include <linux/tty.h>
42 #include <linux/tty_driver.h>
43 #include <linux/tty_flip.h>
44 #include <linux/module.h>
45 #include <linux/uaccess.h>
46 #include <asm/unaligned.h>
47 #include <linux/usb.h>
48 #include <linux/usb/serial.h>
49 #include "kl5kusb105.h"
51 #define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>, Johan Hovold <jhovold@gmail.com>"
52 #define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
58 static int klsi_105_port_probe(struct usb_serial_port
*port
);
59 static int klsi_105_port_remove(struct usb_serial_port
*port
);
60 static int klsi_105_open(struct tty_struct
*tty
, struct usb_serial_port
*port
);
61 static void klsi_105_close(struct usb_serial_port
*port
);
62 static void klsi_105_set_termios(struct tty_struct
*tty
,
63 struct usb_serial_port
*port
, struct ktermios
*old
);
64 static int klsi_105_tiocmget(struct tty_struct
*tty
);
65 static int klsi_105_tiocmset(struct tty_struct
*tty
,
66 unsigned int set
, unsigned int clear
);
67 static void klsi_105_process_read_urb(struct urb
*urb
);
68 static int klsi_105_prepare_write_buffer(struct usb_serial_port
*port
,
69 void *dest
, size_t size
);
72 * All of the device info needed for the KLSI converters.
74 static const struct usb_device_id id_table
[] = {
75 { USB_DEVICE(PALMCONNECT_VID
, PALMCONNECT_PID
) },
76 { USB_DEVICE(KLSI_VID
, KLSI_KL5KUSB105D_PID
) },
77 { } /* Terminating entry */
80 MODULE_DEVICE_TABLE(usb
, id_table
);
82 static struct usb_serial_driver kl5kusb105d_device
= {
85 .name
= "kl5kusb105d",
87 .description
= "KL5KUSB105D / PalmConnect",
91 .open
= klsi_105_open
,
92 .close
= klsi_105_close
,
93 .set_termios
= klsi_105_set_termios
,
94 /*.break_ctl = klsi_105_break_ctl,*/
95 .tiocmget
= klsi_105_tiocmget
,
96 .tiocmset
= klsi_105_tiocmset
,
97 .port_probe
= klsi_105_port_probe
,
98 .port_remove
= klsi_105_port_remove
,
99 .throttle
= usb_serial_generic_throttle
,
100 .unthrottle
= usb_serial_generic_unthrottle
,
101 .process_read_urb
= klsi_105_process_read_urb
,
102 .prepare_write_buffer
= klsi_105_prepare_write_buffer
,
105 static struct usb_serial_driver
* const serial_drivers
[] = {
106 &kl5kusb105d_device
, NULL
109 struct klsi_105_port_settings
{
110 __u8 pktlen
; /* always 5, it seems */
115 } __attribute__ ((packed
));
117 struct klsi_105_private
{
118 struct klsi_105_port_settings cfg
;
119 struct ktermios termios
;
120 unsigned long line_state
; /* modem line settings */
126 * Handle vendor specific USB requests
130 #define KLSI_TIMEOUT 5000 /* default urb timeout */
132 static int klsi_105_chg_port_settings(struct usb_serial_port
*port
,
133 struct klsi_105_port_settings
*settings
)
137 rc
= usb_control_msg(port
->serial
->dev
,
138 usb_sndctrlpipe(port
->serial
->dev
, 0),
139 KL5KUSB105A_SIO_SET_DATA
,
140 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_INTERFACE
,
144 sizeof(struct klsi_105_port_settings
),
148 "Change port settings failed (error = %d)\n", rc
);
149 dev_info(&port
->serial
->dev
->dev
,
150 "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
151 settings
->pktlen
, settings
->baudrate
, settings
->databits
,
152 settings
->unknown1
, settings
->unknown2
);
156 /* translate a 16-bit status value from the device to linux's TIO bits */
157 static unsigned long klsi_105_status2linestate(const __u16 status
)
159 unsigned long res
= 0;
161 res
= ((status
& KL5KUSB105A_DSR
) ? TIOCM_DSR
: 0)
162 | ((status
& KL5KUSB105A_CTS
) ? TIOCM_CTS
: 0)
169 * Read line control via vendor command and return result through
172 /* It seems that the status buffer has always only 2 bytes length */
173 #define KLSI_STATUSBUF_LEN 2
174 static int klsi_105_get_line_state(struct usb_serial_port
*port
,
175 unsigned long *line_state_p
)
181 dev_info(&port
->serial
->dev
->dev
, "sending SIO Poll request\n");
183 status_buf
= kmalloc(KLSI_STATUSBUF_LEN
, GFP_KERNEL
);
187 status_buf
[0] = 0xff;
188 status_buf
[1] = 0xff;
189 rc
= usb_control_msg(port
->serial
->dev
,
190 usb_rcvctrlpipe(port
->serial
->dev
, 0),
191 KL5KUSB105A_SIO_POLL
,
192 USB_TYPE_VENDOR
| USB_DIR_IN
,
195 status_buf
, KLSI_STATUSBUF_LEN
,
199 dev_err(&port
->dev
, "Reading line status failed (error = %d)\n",
202 status
= get_unaligned_le16(status_buf
);
204 dev_info(&port
->serial
->dev
->dev
, "read status %x %x",
205 status_buf
[0], status_buf
[1]);
207 *line_state_p
= klsi_105_status2linestate(status
);
216 * Driver's tty interface functions
219 static int klsi_105_port_probe(struct usb_serial_port
*port
)
221 struct klsi_105_private
*priv
;
223 priv
= kmalloc(sizeof(*priv
), GFP_KERNEL
);
227 /* set initial values for control structures */
228 priv
->cfg
.pktlen
= 5;
229 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
230 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
231 priv
->cfg
.unknown1
= 0;
232 priv
->cfg
.unknown2
= 1;
234 priv
->line_state
= 0;
236 spin_lock_init(&priv
->lock
);
238 /* priv->termios is left uninitialized until port opening */
240 usb_set_serial_port_data(port
, priv
);
245 static int klsi_105_port_remove(struct usb_serial_port
*port
)
247 struct klsi_105_private
*priv
;
249 priv
= usb_get_serial_port_data(port
);
255 static int klsi_105_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
257 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
261 unsigned long line_state
;
262 struct klsi_105_port_settings
*cfg
;
265 /* Do a defined restart:
266 * Set up sane default baud rate and send the 'READ_ON'
268 * FIXME: set modem line control (how?)
269 * Then read the modem line control and store values in
272 cfg
= kmalloc(sizeof(*cfg
), GFP_KERNEL
);
277 cfg
->baudrate
= kl5kusb105a_sio_b9600
;
278 cfg
->databits
= kl5kusb105a_dtb_8
;
281 klsi_105_chg_port_settings(port
, cfg
);
283 /* set up termios structure */
284 spin_lock_irqsave(&priv
->lock
, flags
);
285 priv
->termios
.c_iflag
= tty
->termios
.c_iflag
;
286 priv
->termios
.c_oflag
= tty
->termios
.c_oflag
;
287 priv
->termios
.c_cflag
= tty
->termios
.c_cflag
;
288 priv
->termios
.c_lflag
= tty
->termios
.c_lflag
;
289 for (i
= 0; i
< NCCS
; i
++)
290 priv
->termios
.c_cc
[i
] = tty
->termios
.c_cc
[i
];
291 priv
->cfg
.pktlen
= cfg
->pktlen
;
292 priv
->cfg
.baudrate
= cfg
->baudrate
;
293 priv
->cfg
.databits
= cfg
->databits
;
294 priv
->cfg
.unknown1
= cfg
->unknown1
;
295 priv
->cfg
.unknown2
= cfg
->unknown2
;
296 spin_unlock_irqrestore(&priv
->lock
, flags
);
298 /* READ_ON and urb submission */
299 rc
= usb_serial_generic_open(tty
, port
);
305 rc
= usb_control_msg(port
->serial
->dev
,
306 usb_sndctrlpipe(port
->serial
->dev
, 0),
307 KL5KUSB105A_SIO_CONFIGURE
,
308 USB_TYPE_VENDOR
|USB_DIR_OUT
|USB_RECIP_INTERFACE
,
309 KL5KUSB105A_SIO_CONFIGURE_READ_ON
,
315 dev_err(&port
->dev
, "Enabling read failed (error = %d)\n", rc
);
318 dev_dbg(&port
->dev
, "%s - enabled reading\n", __func__
);
320 rc
= klsi_105_get_line_state(port
, &line_state
);
322 spin_lock_irqsave(&priv
->lock
, flags
);
323 priv
->line_state
= line_state
;
324 spin_unlock_irqrestore(&priv
->lock
, flags
);
325 dev_dbg(&port
->dev
, "%s - read line state 0x%lx\n", __func__
, line_state
);
335 static void klsi_105_close(struct usb_serial_port
*port
)
340 rc
= usb_control_msg(port
->serial
->dev
,
341 usb_sndctrlpipe(port
->serial
->dev
, 0),
342 KL5KUSB105A_SIO_CONFIGURE
,
343 USB_TYPE_VENDOR
| USB_DIR_OUT
,
344 KL5KUSB105A_SIO_CONFIGURE_READ_OFF
,
349 dev_err(&port
->dev
, "failed to disable read: %d\n", rc
);
351 /* shutdown our bulk reads and writes */
352 usb_serial_generic_close(port
);
355 /* We need to write a complete 64-byte data block and encode the
356 * number actually sent in the first double-byte, LSB-order. That
357 * leaves at most 62 bytes of payload.
359 #define KLSI_HDR_LEN 2
360 static int klsi_105_prepare_write_buffer(struct usb_serial_port
*port
,
361 void *dest
, size_t size
)
363 unsigned char *buf
= dest
;
366 count
= kfifo_out_locked(&port
->write_fifo
, buf
+ KLSI_HDR_LEN
, size
,
368 put_unaligned_le16(count
, buf
);
370 return count
+ KLSI_HDR_LEN
;
373 /* The data received is preceded by a length double-byte in LSB-first order.
375 static void klsi_105_process_read_urb(struct urb
*urb
)
377 struct usb_serial_port
*port
= urb
->context
;
378 unsigned char *data
= urb
->transfer_buffer
;
381 /* empty urbs seem to happen, we ignore them */
382 if (!urb
->actual_length
)
385 if (urb
->actual_length
<= KLSI_HDR_LEN
) {
386 dev_dbg(&port
->dev
, "%s - malformed packet\n", __func__
);
390 len
= get_unaligned_le16(data
);
391 if (len
> urb
->actual_length
- KLSI_HDR_LEN
) {
392 dev_dbg(&port
->dev
, "%s - packet length mismatch\n", __func__
);
393 len
= urb
->actual_length
- KLSI_HDR_LEN
;
396 tty_insert_flip_string(&port
->port
, data
+ KLSI_HDR_LEN
, len
);
397 tty_flip_buffer_push(&port
->port
);
400 static void klsi_105_set_termios(struct tty_struct
*tty
,
401 struct usb_serial_port
*port
,
402 struct ktermios
*old_termios
)
404 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
405 struct device
*dev
= &port
->dev
;
406 unsigned int iflag
= tty
->termios
.c_iflag
;
407 unsigned int old_iflag
= old_termios
->c_iflag
;
408 unsigned int cflag
= tty
->termios
.c_cflag
;
409 unsigned int old_cflag
= old_termios
->c_cflag
;
410 struct klsi_105_port_settings
*cfg
;
414 cfg
= kmalloc(sizeof(*cfg
), GFP_KERNEL
);
418 /* lock while we are modifying the settings */
419 spin_lock_irqsave(&priv
->lock
, flags
);
424 baud
= tty_get_baud_rate(tty
);
426 if ((cflag
& CBAUD
) != (old_cflag
& CBAUD
)) {
427 /* reassert DTR and (maybe) RTS on transition from B0 */
428 if ((old_cflag
& CBAUD
) == B0
) {
429 dev_dbg(dev
, "%s: baud was B0\n", __func__
);
431 priv
->control_state
|= TIOCM_DTR
;
432 /* don't set RTS if using hardware flow control */
433 if (!(old_cflag
& CRTSCTS
))
434 priv
->control_state
|= TIOCM_RTS
;
435 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
440 case 0: /* handled below */
443 priv
->cfg
.baudrate
= kl5kusb105a_sio_b1200
;
446 priv
->cfg
.baudrate
= kl5kusb105a_sio_b2400
;
449 priv
->cfg
.baudrate
= kl5kusb105a_sio_b4800
;
452 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
455 priv
->cfg
.baudrate
= kl5kusb105a_sio_b19200
;
458 priv
->cfg
.baudrate
= kl5kusb105a_sio_b38400
;
461 priv
->cfg
.baudrate
= kl5kusb105a_sio_b57600
;
464 priv
->cfg
.baudrate
= kl5kusb105a_sio_b115200
;
467 dev_dbg(dev
, "KLSI USB->Serial converter: unsupported baudrate request, using default of 9600");
468 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
472 if ((cflag
& CBAUD
) == B0
) {
473 dev_dbg(dev
, "%s: baud is B0\n", __func__
);
474 /* Drop RTS and DTR */
475 /* maybe this should be simulated by sending read
476 * disable and read enable messages?
480 priv
->control_state
&= ~(TIOCM_DTR
| TIOCM_RTS
);
481 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
484 tty_encode_baud_rate(tty
, baud
, baud
);
486 if ((cflag
& CSIZE
) != (old_cflag
& CSIZE
)) {
487 /* set the number of data bits */
488 switch (cflag
& CSIZE
) {
490 dev_dbg(dev
, "%s - 5 bits/byte not supported\n", __func__
);
491 spin_unlock_irqrestore(&priv
->lock
, flags
);
494 dev_dbg(dev
, "%s - 6 bits/byte not supported\n", __func__
);
495 spin_unlock_irqrestore(&priv
->lock
, flags
);
498 priv
->cfg
.databits
= kl5kusb105a_dtb_7
;
501 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
504 dev_err(dev
, "CSIZE was not CS5-CS8, using default of 8\n");
505 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
511 * Update line control register (LCR)
513 if ((cflag
& (PARENB
|PARODD
)) != (old_cflag
& (PARENB
|PARODD
))
514 || (cflag
& CSTOPB
) != (old_cflag
& CSTOPB
)) {
515 /* Not currently supported */
516 tty
->termios
.c_cflag
&= ~(PARENB
|PARODD
|CSTOPB
);
522 priv
->last_lcr
|= (cflag
& PARODD
) ?
523 MCT_U232_PARITY_ODD
: MCT_U232_PARITY_EVEN
;
525 priv
->last_lcr
|= MCT_U232_PARITY_NONE
;
527 /* set the number of stop bits */
528 priv
->last_lcr
|= (cflag
& CSTOPB
) ?
529 MCT_U232_STOP_BITS_2
: MCT_U232_STOP_BITS_1
;
531 mct_u232_set_line_ctrl(serial
, priv
->last_lcr
);
536 * Set flow control: well, I do not really now how to handle DTR/RTS.
537 * Just do what we have seen with SniffUSB on Win98.
539 if ((iflag
& IXOFF
) != (old_iflag
& IXOFF
)
540 || (iflag
& IXON
) != (old_iflag
& IXON
)
541 || (cflag
& CRTSCTS
) != (old_cflag
& CRTSCTS
)) {
542 /* Not currently supported */
543 tty
->termios
.c_cflag
&= ~CRTSCTS
;
544 /* Drop DTR/RTS if no flow control otherwise assert */
546 if ((iflag
& IXOFF
) || (iflag
& IXON
) || (cflag
& CRTSCTS
))
547 priv
->control_state
|= TIOCM_DTR
| TIOCM_RTS
;
549 priv
->control_state
&= ~(TIOCM_DTR
| TIOCM_RTS
);
550 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
554 memcpy(cfg
, &priv
->cfg
, sizeof(*cfg
));
555 spin_unlock_irqrestore(&priv
->lock
, flags
);
557 /* now commit changes to device */
558 klsi_105_chg_port_settings(port
, cfg
);
564 static void mct_u232_break_ctl(struct tty_struct
*tty
, int break_state
)
566 struct usb_serial_port
*port
= tty
->driver_data
;
567 struct usb_serial
*serial
= port
->serial
;
568 struct mct_u232_private
*priv
=
569 (struct mct_u232_private
*)port
->private;
570 unsigned char lcr
= priv
->last_lcr
;
572 dev_dbg(&port
->dev
, "%s - state=%d\n", __func__
, break_state
);
576 lcr
|= MCT_U232_SET_BREAK
;
578 mct_u232_set_line_ctrl(serial
, lcr
);
582 static int klsi_105_tiocmget(struct tty_struct
*tty
)
584 struct usb_serial_port
*port
= tty
->driver_data
;
585 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
588 unsigned long line_state
;
590 rc
= klsi_105_get_line_state(port
, &line_state
);
593 "Reading line control failed (error = %d)\n", rc
);
594 /* better return value? EAGAIN? */
598 spin_lock_irqsave(&priv
->lock
, flags
);
599 priv
->line_state
= line_state
;
600 spin_unlock_irqrestore(&priv
->lock
, flags
);
601 dev_dbg(&port
->dev
, "%s - read line state 0x%lx\n", __func__
, line_state
);
602 return (int)line_state
;
605 static int klsi_105_tiocmset(struct tty_struct
*tty
,
606 unsigned int set
, unsigned int clear
)
608 int retval
= -EINVAL
;
610 /* if this ever gets implemented, it should be done something like this:
611 struct usb_serial *serial = port->serial;
612 struct klsi_105_private *priv = usb_get_serial_port_data(port);
616 spin_lock_irqsave (&priv->lock, flags);
618 priv->control_state |= TIOCM_RTS;
620 priv->control_state |= TIOCM_DTR;
621 if (clear & TIOCM_RTS)
622 priv->control_state &= ~TIOCM_RTS;
623 if (clear & TIOCM_DTR)
624 priv->control_state &= ~TIOCM_DTR;
625 control = priv->control_state;
626 spin_unlock_irqrestore (&priv->lock, flags);
627 retval = mct_u232_set_modem_ctrl(serial, control);
632 module_usb_serial_driver(serial_drivers
, id_table
);
634 MODULE_AUTHOR(DRIVER_AUTHOR
);
635 MODULE_DESCRIPTION(DRIVER_DESC
);
636 MODULE_LICENSE("GPL");