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 void klsi_105_process_read_urb(struct urb
*urb
);
66 static int klsi_105_prepare_write_buffer(struct usb_serial_port
*port
,
67 void *dest
, size_t size
);
70 * All of the device info needed for the KLSI converters.
72 static const struct usb_device_id id_table
[] = {
73 { USB_DEVICE(PALMCONNECT_VID
, PALMCONNECT_PID
) },
74 { USB_DEVICE(KLSI_VID
, KLSI_KL5KUSB105D_PID
) },
75 { } /* Terminating entry */
78 MODULE_DEVICE_TABLE(usb
, id_table
);
80 static struct usb_serial_driver kl5kusb105d_device
= {
83 .name
= "kl5kusb105d",
85 .description
= "KL5KUSB105D / PalmConnect",
89 .open
= klsi_105_open
,
90 .close
= klsi_105_close
,
91 .set_termios
= klsi_105_set_termios
,
92 /*.break_ctl = klsi_105_break_ctl,*/
93 .tiocmget
= klsi_105_tiocmget
,
94 .port_probe
= klsi_105_port_probe
,
95 .port_remove
= klsi_105_port_remove
,
96 .throttle
= usb_serial_generic_throttle
,
97 .unthrottle
= usb_serial_generic_unthrottle
,
98 .process_read_urb
= klsi_105_process_read_urb
,
99 .prepare_write_buffer
= klsi_105_prepare_write_buffer
,
102 static struct usb_serial_driver
* const serial_drivers
[] = {
103 &kl5kusb105d_device
, NULL
106 struct klsi_105_port_settings
{
107 __u8 pktlen
; /* always 5, it seems */
112 } __attribute__ ((packed
));
114 struct klsi_105_private
{
115 struct klsi_105_port_settings cfg
;
116 struct ktermios termios
;
117 unsigned long line_state
; /* modem line settings */
123 * Handle vendor specific USB requests
127 #define KLSI_TIMEOUT 5000 /* default urb timeout */
129 static int klsi_105_chg_port_settings(struct usb_serial_port
*port
,
130 struct klsi_105_port_settings
*settings
)
134 rc
= usb_control_msg(port
->serial
->dev
,
135 usb_sndctrlpipe(port
->serial
->dev
, 0),
136 KL5KUSB105A_SIO_SET_DATA
,
137 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_INTERFACE
,
141 sizeof(struct klsi_105_port_settings
),
145 "Change port settings failed (error = %d)\n", rc
);
146 dev_info(&port
->serial
->dev
->dev
,
147 "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
148 settings
->pktlen
, settings
->baudrate
, settings
->databits
,
149 settings
->unknown1
, settings
->unknown2
);
153 /* translate a 16-bit status value from the device to linux's TIO bits */
154 static unsigned long klsi_105_status2linestate(const __u16 status
)
156 unsigned long res
= 0;
158 res
= ((status
& KL5KUSB105A_DSR
) ? TIOCM_DSR
: 0)
159 | ((status
& KL5KUSB105A_CTS
) ? TIOCM_CTS
: 0)
166 * Read line control via vendor command and return result through
169 /* It seems that the status buffer has always only 2 bytes length */
170 #define KLSI_STATUSBUF_LEN 2
171 static int klsi_105_get_line_state(struct usb_serial_port
*port
,
172 unsigned long *line_state_p
)
178 dev_info(&port
->serial
->dev
->dev
, "sending SIO Poll request\n");
180 status_buf
= kmalloc(KLSI_STATUSBUF_LEN
, GFP_KERNEL
);
184 status_buf
[0] = 0xff;
185 status_buf
[1] = 0xff;
186 rc
= usb_control_msg(port
->serial
->dev
,
187 usb_rcvctrlpipe(port
->serial
->dev
, 0),
188 KL5KUSB105A_SIO_POLL
,
189 USB_TYPE_VENDOR
| USB_DIR_IN
,
192 status_buf
, KLSI_STATUSBUF_LEN
,
195 if (rc
!= KLSI_STATUSBUF_LEN
) {
196 dev_err(&port
->dev
, "reading line status failed: %d\n", rc
);
200 status
= get_unaligned_le16(status_buf
);
202 dev_info(&port
->serial
->dev
->dev
, "read status %x %x\n",
203 status_buf
[0], status_buf
[1]);
205 *line_state_p
= klsi_105_status2linestate(status
);
214 * Driver's tty interface functions
217 static int klsi_105_port_probe(struct usb_serial_port
*port
)
219 struct klsi_105_private
*priv
;
221 priv
= kmalloc(sizeof(*priv
), GFP_KERNEL
);
225 /* set initial values for control structures */
226 priv
->cfg
.pktlen
= 5;
227 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
228 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
229 priv
->cfg
.unknown1
= 0;
230 priv
->cfg
.unknown2
= 1;
232 priv
->line_state
= 0;
234 spin_lock_init(&priv
->lock
);
236 /* priv->termios is left uninitialized until port opening */
238 usb_set_serial_port_data(port
, priv
);
243 static int klsi_105_port_remove(struct usb_serial_port
*port
)
245 struct klsi_105_private
*priv
;
247 priv
= usb_get_serial_port_data(port
);
253 static int klsi_105_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
255 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
259 unsigned long line_state
;
260 struct klsi_105_port_settings
*cfg
;
263 /* Do a defined restart:
264 * Set up sane default baud rate and send the 'READ_ON'
266 * FIXME: set modem line control (how?)
267 * Then read the modem line control and store values in
270 cfg
= kmalloc(sizeof(*cfg
), GFP_KERNEL
);
275 cfg
->baudrate
= kl5kusb105a_sio_b9600
;
276 cfg
->databits
= kl5kusb105a_dtb_8
;
279 klsi_105_chg_port_settings(port
, cfg
);
281 /* set up termios structure */
282 spin_lock_irqsave(&priv
->lock
, flags
);
283 priv
->termios
.c_iflag
= tty
->termios
.c_iflag
;
284 priv
->termios
.c_oflag
= tty
->termios
.c_oflag
;
285 priv
->termios
.c_cflag
= tty
->termios
.c_cflag
;
286 priv
->termios
.c_lflag
= tty
->termios
.c_lflag
;
287 for (i
= 0; i
< NCCS
; i
++)
288 priv
->termios
.c_cc
[i
] = tty
->termios
.c_cc
[i
];
289 priv
->cfg
.pktlen
= cfg
->pktlen
;
290 priv
->cfg
.baudrate
= cfg
->baudrate
;
291 priv
->cfg
.databits
= cfg
->databits
;
292 priv
->cfg
.unknown1
= cfg
->unknown1
;
293 priv
->cfg
.unknown2
= cfg
->unknown2
;
294 spin_unlock_irqrestore(&priv
->lock
, flags
);
296 /* READ_ON and urb submission */
297 rc
= usb_serial_generic_open(tty
, port
);
303 rc
= usb_control_msg(port
->serial
->dev
,
304 usb_sndctrlpipe(port
->serial
->dev
, 0),
305 KL5KUSB105A_SIO_CONFIGURE
,
306 USB_TYPE_VENDOR
|USB_DIR_OUT
|USB_RECIP_INTERFACE
,
307 KL5KUSB105A_SIO_CONFIGURE_READ_ON
,
313 dev_err(&port
->dev
, "Enabling read failed (error = %d)\n", rc
);
315 goto err_generic_close
;
317 dev_dbg(&port
->dev
, "%s - enabled reading\n", __func__
);
319 rc
= klsi_105_get_line_state(port
, &line_state
);
322 goto err_disable_read
;
325 spin_lock_irqsave(&priv
->lock
, flags
);
326 priv
->line_state
= line_state
;
327 spin_unlock_irqrestore(&priv
->lock
, flags
);
328 dev_dbg(&port
->dev
, "%s - read line state 0x%lx\n", __func__
,
334 usb_control_msg(port
->serial
->dev
,
335 usb_sndctrlpipe(port
->serial
->dev
, 0),
336 KL5KUSB105A_SIO_CONFIGURE
,
337 USB_TYPE_VENDOR
| USB_DIR_OUT
,
338 KL5KUSB105A_SIO_CONFIGURE_READ_OFF
,
343 usb_serial_generic_close(port
);
350 static void klsi_105_close(struct usb_serial_port
*port
)
355 rc
= usb_control_msg(port
->serial
->dev
,
356 usb_sndctrlpipe(port
->serial
->dev
, 0),
357 KL5KUSB105A_SIO_CONFIGURE
,
358 USB_TYPE_VENDOR
| USB_DIR_OUT
,
359 KL5KUSB105A_SIO_CONFIGURE_READ_OFF
,
364 dev_err(&port
->dev
, "failed to disable read: %d\n", rc
);
366 /* shutdown our bulk reads and writes */
367 usb_serial_generic_close(port
);
370 /* We need to write a complete 64-byte data block and encode the
371 * number actually sent in the first double-byte, LSB-order. That
372 * leaves at most 62 bytes of payload.
374 #define KLSI_HDR_LEN 2
375 static int klsi_105_prepare_write_buffer(struct usb_serial_port
*port
,
376 void *dest
, size_t size
)
378 unsigned char *buf
= dest
;
381 count
= kfifo_out_locked(&port
->write_fifo
, buf
+ KLSI_HDR_LEN
, size
,
383 put_unaligned_le16(count
, buf
);
385 return count
+ KLSI_HDR_LEN
;
388 /* The data received is preceded by a length double-byte in LSB-first order.
390 static void klsi_105_process_read_urb(struct urb
*urb
)
392 struct usb_serial_port
*port
= urb
->context
;
393 unsigned char *data
= urb
->transfer_buffer
;
396 /* empty urbs seem to happen, we ignore them */
397 if (!urb
->actual_length
)
400 if (urb
->actual_length
<= KLSI_HDR_LEN
) {
401 dev_dbg(&port
->dev
, "%s - malformed packet\n", __func__
);
405 len
= get_unaligned_le16(data
);
406 if (len
> urb
->actual_length
- KLSI_HDR_LEN
) {
407 dev_dbg(&port
->dev
, "%s - packet length mismatch\n", __func__
);
408 len
= urb
->actual_length
- KLSI_HDR_LEN
;
411 tty_insert_flip_string(&port
->port
, data
+ KLSI_HDR_LEN
, len
);
412 tty_flip_buffer_push(&port
->port
);
415 static void klsi_105_set_termios(struct tty_struct
*tty
,
416 struct usb_serial_port
*port
,
417 struct ktermios
*old_termios
)
419 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
420 struct device
*dev
= &port
->dev
;
421 unsigned int iflag
= tty
->termios
.c_iflag
;
422 unsigned int old_iflag
= old_termios
->c_iflag
;
423 unsigned int cflag
= tty
->termios
.c_cflag
;
424 unsigned int old_cflag
= old_termios
->c_cflag
;
425 struct klsi_105_port_settings
*cfg
;
429 cfg
= kmalloc(sizeof(*cfg
), GFP_KERNEL
);
433 /* lock while we are modifying the settings */
434 spin_lock_irqsave(&priv
->lock
, flags
);
439 baud
= tty_get_baud_rate(tty
);
441 if ((cflag
& CBAUD
) != (old_cflag
& CBAUD
)) {
442 /* reassert DTR and (maybe) RTS on transition from B0 */
443 if ((old_cflag
& CBAUD
) == B0
) {
444 dev_dbg(dev
, "%s: baud was B0\n", __func__
);
446 priv
->control_state
|= TIOCM_DTR
;
447 /* don't set RTS if using hardware flow control */
448 if (!(old_cflag
& CRTSCTS
))
449 priv
->control_state
|= TIOCM_RTS
;
450 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
455 case 0: /* handled below */
458 priv
->cfg
.baudrate
= kl5kusb105a_sio_b1200
;
461 priv
->cfg
.baudrate
= kl5kusb105a_sio_b2400
;
464 priv
->cfg
.baudrate
= kl5kusb105a_sio_b4800
;
467 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
470 priv
->cfg
.baudrate
= kl5kusb105a_sio_b19200
;
473 priv
->cfg
.baudrate
= kl5kusb105a_sio_b38400
;
476 priv
->cfg
.baudrate
= kl5kusb105a_sio_b57600
;
479 priv
->cfg
.baudrate
= kl5kusb105a_sio_b115200
;
482 dev_dbg(dev
, "unsupported baudrate, using 9600\n");
483 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
487 if ((cflag
& CBAUD
) == B0
) {
488 dev_dbg(dev
, "%s: baud is B0\n", __func__
);
489 /* Drop RTS and DTR */
490 /* maybe this should be simulated by sending read
491 * disable and read enable messages?
495 priv
->control_state
&= ~(TIOCM_DTR
| TIOCM_RTS
);
496 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
499 tty_encode_baud_rate(tty
, baud
, baud
);
501 if ((cflag
& CSIZE
) != (old_cflag
& CSIZE
)) {
502 /* set the number of data bits */
503 switch (cflag
& CSIZE
) {
505 dev_dbg(dev
, "%s - 5 bits/byte not supported\n", __func__
);
506 spin_unlock_irqrestore(&priv
->lock
, flags
);
509 dev_dbg(dev
, "%s - 6 bits/byte not supported\n", __func__
);
510 spin_unlock_irqrestore(&priv
->lock
, flags
);
513 priv
->cfg
.databits
= kl5kusb105a_dtb_7
;
516 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
519 dev_err(dev
, "CSIZE was not CS5-CS8, using default of 8\n");
520 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
526 * Update line control register (LCR)
528 if ((cflag
& (PARENB
|PARODD
)) != (old_cflag
& (PARENB
|PARODD
))
529 || (cflag
& CSTOPB
) != (old_cflag
& CSTOPB
)) {
530 /* Not currently supported */
531 tty
->termios
.c_cflag
&= ~(PARENB
|PARODD
|CSTOPB
);
537 priv
->last_lcr
|= (cflag
& PARODD
) ?
538 MCT_U232_PARITY_ODD
: MCT_U232_PARITY_EVEN
;
540 priv
->last_lcr
|= MCT_U232_PARITY_NONE
;
542 /* set the number of stop bits */
543 priv
->last_lcr
|= (cflag
& CSTOPB
) ?
544 MCT_U232_STOP_BITS_2
: MCT_U232_STOP_BITS_1
;
546 mct_u232_set_line_ctrl(serial
, priv
->last_lcr
);
551 * Set flow control: well, I do not really now how to handle DTR/RTS.
552 * Just do what we have seen with SniffUSB on Win98.
554 if ((iflag
& IXOFF
) != (old_iflag
& IXOFF
)
555 || (iflag
& IXON
) != (old_iflag
& IXON
)
556 || (cflag
& CRTSCTS
) != (old_cflag
& CRTSCTS
)) {
557 /* Not currently supported */
558 tty
->termios
.c_cflag
&= ~CRTSCTS
;
559 /* Drop DTR/RTS if no flow control otherwise assert */
561 if ((iflag
& IXOFF
) || (iflag
& IXON
) || (cflag
& CRTSCTS
))
562 priv
->control_state
|= TIOCM_DTR
| TIOCM_RTS
;
564 priv
->control_state
&= ~(TIOCM_DTR
| TIOCM_RTS
);
565 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
569 memcpy(cfg
, &priv
->cfg
, sizeof(*cfg
));
570 spin_unlock_irqrestore(&priv
->lock
, flags
);
572 /* now commit changes to device */
573 klsi_105_chg_port_settings(port
, cfg
);
579 static void mct_u232_break_ctl(struct tty_struct
*tty
, int break_state
)
581 struct usb_serial_port
*port
= tty
->driver_data
;
582 struct usb_serial
*serial
= port
->serial
;
583 struct mct_u232_private
*priv
=
584 (struct mct_u232_private
*)port
->private;
585 unsigned char lcr
= priv
->last_lcr
;
587 dev_dbg(&port
->dev
, "%s - state=%d\n", __func__
, break_state
);
591 lcr
|= MCT_U232_SET_BREAK
;
593 mct_u232_set_line_ctrl(serial
, lcr
);
597 static int klsi_105_tiocmget(struct tty_struct
*tty
)
599 struct usb_serial_port
*port
= tty
->driver_data
;
600 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
603 unsigned long line_state
;
605 rc
= klsi_105_get_line_state(port
, &line_state
);
608 "Reading line control failed (error = %d)\n", rc
);
609 /* better return value? EAGAIN? */
613 spin_lock_irqsave(&priv
->lock
, flags
);
614 priv
->line_state
= line_state
;
615 spin_unlock_irqrestore(&priv
->lock
, flags
);
616 dev_dbg(&port
->dev
, "%s - read line state 0x%lx\n", __func__
, line_state
);
617 return (int)line_state
;
620 module_usb_serial_driver(serial_drivers
, id_table
);
622 MODULE_AUTHOR(DRIVER_AUTHOR
);
623 MODULE_DESCRIPTION(DRIVER_DESC
);
624 MODULE_LICENSE("GPL");