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
, struct file
*file
);
72 static int klsi_105_tiocmset(struct tty_struct
*tty
, struct file
*file
,
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",
91 .probe
= usb_serial_probe
,
92 .disconnect
= usb_serial_disconnect
,
97 static struct usb_serial_driver kl5kusb105d_device
= {
100 .name
= "kl5kusb105d",
102 .description
= "KL5KUSB105D / PalmConnect",
103 .usb_driver
= &kl5kusb105d_driver
,
104 .id_table
= id_table
,
107 .open
= klsi_105_open
,
108 .close
= klsi_105_close
,
109 .set_termios
= klsi_105_set_termios
,
110 /*.break_ctl = klsi_105_break_ctl,*/
111 .tiocmget
= klsi_105_tiocmget
,
112 .tiocmset
= klsi_105_tiocmset
,
113 .attach
= klsi_105_startup
,
114 .release
= klsi_105_release
,
115 .throttle
= usb_serial_generic_throttle
,
116 .unthrottle
= usb_serial_generic_unthrottle
,
117 .process_read_urb
= klsi_105_process_read_urb
,
118 .prepare_write_buffer
= klsi_105_prepare_write_buffer
,
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
)
285 for (i
= 0; i
< serial
->num_ports
; ++i
)
286 kfree(usb_get_serial_port_data(serial
->port
[i
]));
289 static int klsi_105_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
291 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
295 unsigned long line_state
;
296 struct klsi_105_port_settings
*cfg
;
299 dbg("%s port %d", __func__
, port
->number
);
301 /* Do a defined restart:
302 * Set up sane default baud rate and send the 'READ_ON'
304 * FIXME: set modem line control (how?)
305 * Then read the modem line control and store values in
308 cfg
= kmalloc(sizeof(*cfg
), GFP_KERNEL
);
310 dev_err(&port
->dev
, "%s - out of memory for config buffer.\n",
315 cfg
->baudrate
= kl5kusb105a_sio_b9600
;
316 cfg
->databits
= kl5kusb105a_dtb_8
;
319 klsi_105_chg_port_settings(port
, cfg
);
321 /* set up termios structure */
322 spin_lock_irqsave(&priv
->lock
, flags
);
323 priv
->termios
.c_iflag
= tty
->termios
->c_iflag
;
324 priv
->termios
.c_oflag
= tty
->termios
->c_oflag
;
325 priv
->termios
.c_cflag
= tty
->termios
->c_cflag
;
326 priv
->termios
.c_lflag
= tty
->termios
->c_lflag
;
327 for (i
= 0; i
< NCCS
; i
++)
328 priv
->termios
.c_cc
[i
] = tty
->termios
->c_cc
[i
];
329 priv
->cfg
.pktlen
= cfg
->pktlen
;
330 priv
->cfg
.baudrate
= cfg
->baudrate
;
331 priv
->cfg
.databits
= cfg
->databits
;
332 priv
->cfg
.unknown1
= cfg
->unknown1
;
333 priv
->cfg
.unknown2
= cfg
->unknown2
;
334 spin_unlock_irqrestore(&priv
->lock
, flags
);
336 /* READ_ON and urb submission */
337 rc
= usb_serial_generic_open(tty
, port
);
343 rc
= usb_control_msg(port
->serial
->dev
,
344 usb_sndctrlpipe(port
->serial
->dev
, 0),
345 KL5KUSB105A_SIO_CONFIGURE
,
346 USB_TYPE_VENDOR
|USB_DIR_OUT
|USB_RECIP_INTERFACE
,
347 KL5KUSB105A_SIO_CONFIGURE_READ_ON
,
353 dev_err(&port
->dev
, "Enabling read failed (error = %d)\n", rc
);
356 dbg("%s - enabled reading", __func__
);
358 rc
= klsi_105_get_line_state(port
, &line_state
);
360 spin_lock_irqsave(&priv
->lock
, flags
);
361 priv
->line_state
= line_state
;
362 spin_unlock_irqrestore(&priv
->lock
, flags
);
363 dbg("%s - read line state 0x%lx", __func__
, line_state
);
373 static void klsi_105_close(struct usb_serial_port
*port
)
377 dbg("%s port %d", __func__
, port
->number
);
379 mutex_lock(&port
->serial
->disc_mutex
);
380 if (!port
->serial
->disconnected
) {
382 rc
= usb_control_msg(port
->serial
->dev
,
383 usb_sndctrlpipe(port
->serial
->dev
, 0),
384 KL5KUSB105A_SIO_CONFIGURE
,
385 USB_TYPE_VENDOR
| USB_DIR_OUT
,
386 KL5KUSB105A_SIO_CONFIGURE_READ_OFF
,
392 "Disabling read failed (error = %d)\n", rc
);
394 mutex_unlock(&port
->serial
->disc_mutex
);
396 /* shutdown our bulk reads and writes */
397 usb_serial_generic_close(port
);
399 /* wgg - do I need this? I think so. */
400 usb_kill_urb(port
->interrupt_in_urb
);
403 /* We need to write a complete 64-byte data block and encode the
404 * number actually sent in the first double-byte, LSB-order. That
405 * leaves at most 62 bytes of payload.
407 #define KLSI_HDR_LEN 2
408 static int klsi_105_prepare_write_buffer(struct usb_serial_port
*port
,
409 void *dest
, size_t size
)
411 unsigned char *buf
= dest
;
414 count
= kfifo_out_locked(&port
->write_fifo
, buf
+ KLSI_HDR_LEN
, size
,
416 put_unaligned_le16(count
, buf
);
418 return count
+ KLSI_HDR_LEN
;
421 /* The data received is preceded by a length double-byte in LSB-first order.
423 static void klsi_105_process_read_urb(struct urb
*urb
)
425 struct usb_serial_port
*port
= urb
->context
;
426 unsigned char *data
= urb
->transfer_buffer
;
427 struct tty_struct
*tty
;
430 /* empty urbs seem to happen, we ignore them */
431 if (!urb
->actual_length
)
434 if (urb
->actual_length
<= KLSI_HDR_LEN
) {
435 dbg("%s - malformed packet", __func__
);
439 tty
= tty_port_tty_get(&port
->port
);
443 len
= get_unaligned_le16(data
);
444 if (len
> urb
->actual_length
- KLSI_HDR_LEN
) {
445 dbg("%s - packet length mismatch", __func__
);
446 len
= urb
->actual_length
- KLSI_HDR_LEN
;
449 tty_insert_flip_string(tty
, data
+ KLSI_HDR_LEN
, len
);
450 tty_flip_buffer_push(tty
);
454 static void klsi_105_set_termios(struct tty_struct
*tty
,
455 struct usb_serial_port
*port
,
456 struct ktermios
*old_termios
)
458 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
459 unsigned int iflag
= tty
->termios
->c_iflag
;
460 unsigned int old_iflag
= old_termios
->c_iflag
;
461 unsigned int cflag
= tty
->termios
->c_cflag
;
462 unsigned int old_cflag
= old_termios
->c_cflag
;
463 struct klsi_105_port_settings
*cfg
;
467 cfg
= kmalloc(sizeof(*cfg
), GFP_KERNEL
);
469 dev_err(&port
->dev
, "%s - out of memory for config buffer.\n",
474 /* lock while we are modifying the settings */
475 spin_lock_irqsave(&priv
->lock
, flags
);
480 baud
= tty_get_baud_rate(tty
);
482 if ((cflag
& CBAUD
) != (old_cflag
& CBAUD
)) {
483 /* reassert DTR and (maybe) RTS on transition from B0 */
484 if ((old_cflag
& CBAUD
) == B0
) {
485 dbg("%s: baud was B0", __func__
);
487 priv
->control_state
|= TIOCM_DTR
;
488 /* don't set RTS if using hardware flow control */
489 if (!(old_cflag
& CRTSCTS
))
490 priv
->control_state
|= TIOCM_RTS
;
491 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
496 case 0: /* handled below */
499 priv
->cfg
.baudrate
= kl5kusb105a_sio_b1200
;
502 priv
->cfg
.baudrate
= kl5kusb105a_sio_b2400
;
505 priv
->cfg
.baudrate
= kl5kusb105a_sio_b4800
;
508 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
511 priv
->cfg
.baudrate
= kl5kusb105a_sio_b19200
;
514 priv
->cfg
.baudrate
= kl5kusb105a_sio_b38400
;
517 priv
->cfg
.baudrate
= kl5kusb105a_sio_b57600
;
520 priv
->cfg
.baudrate
= kl5kusb105a_sio_b115200
;
523 dbg("KLSI USB->Serial converter:"
524 " unsupported baudrate request, using default of 9600");
525 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
529 if ((cflag
& CBAUD
) == B0
) {
530 dbg("%s: baud is B0", __func__
);
531 /* Drop RTS and DTR */
532 /* maybe this should be simulated by sending read
533 * disable and read enable messages?
537 priv
->control_state
&= ~(TIOCM_DTR
| TIOCM_RTS
);
538 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
541 tty_encode_baud_rate(tty
, baud
, baud
);
543 if ((cflag
& CSIZE
) != (old_cflag
& CSIZE
)) {
544 /* set the number of data bits */
545 switch (cflag
& CSIZE
) {
547 dbg("%s - 5 bits/byte not supported", __func__
);
548 spin_unlock_irqrestore(&priv
->lock
, flags
);
551 dbg("%s - 6 bits/byte not supported", __func__
);
552 spin_unlock_irqrestore(&priv
->lock
, flags
);
555 priv
->cfg
.databits
= kl5kusb105a_dtb_7
;
558 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
562 "CSIZE was not CS5-CS8, using default of 8\n");
563 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
569 * Update line control register (LCR)
571 if ((cflag
& (PARENB
|PARODD
)) != (old_cflag
& (PARENB
|PARODD
))
572 || (cflag
& CSTOPB
) != (old_cflag
& CSTOPB
)) {
573 /* Not currently supported */
574 tty
->termios
->c_cflag
&= ~(PARENB
|PARODD
|CSTOPB
);
580 priv
->last_lcr
|= (cflag
& PARODD
) ?
581 MCT_U232_PARITY_ODD
: MCT_U232_PARITY_EVEN
;
583 priv
->last_lcr
|= MCT_U232_PARITY_NONE
;
585 /* set the number of stop bits */
586 priv
->last_lcr
|= (cflag
& CSTOPB
) ?
587 MCT_U232_STOP_BITS_2
: MCT_U232_STOP_BITS_1
;
589 mct_u232_set_line_ctrl(serial
, priv
->last_lcr
);
594 * Set flow control: well, I do not really now how to handle DTR/RTS.
595 * Just do what we have seen with SniffUSB on Win98.
597 if ((iflag
& IXOFF
) != (old_iflag
& IXOFF
)
598 || (iflag
& IXON
) != (old_iflag
& IXON
)
599 || (cflag
& CRTSCTS
) != (old_cflag
& CRTSCTS
)) {
600 /* Not currently supported */
601 tty
->termios
->c_cflag
&= ~CRTSCTS
;
602 /* Drop DTR/RTS if no flow control otherwise assert */
604 if ((iflag
& IXOFF
) || (iflag
& IXON
) || (cflag
& CRTSCTS
))
605 priv
->control_state
|= TIOCM_DTR
| TIOCM_RTS
;
607 priv
->control_state
&= ~(TIOCM_DTR
| TIOCM_RTS
);
608 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
612 memcpy(cfg
, &priv
->cfg
, sizeof(*cfg
));
613 spin_unlock_irqrestore(&priv
->lock
, flags
);
615 /* now commit changes to device */
616 klsi_105_chg_port_settings(port
, cfg
);
622 static void mct_u232_break_ctl(struct tty_struct
*tty
, int break_state
)
624 struct usb_serial_port
*port
= tty
->driver_data
;
625 struct usb_serial
*serial
= port
->serial
;
626 struct mct_u232_private
*priv
=
627 (struct mct_u232_private
*)port
->private;
628 unsigned char lcr
= priv
->last_lcr
;
630 dbg("%sstate=%d", __func__
, break_state
);
634 lcr
|= MCT_U232_SET_BREAK
;
636 mct_u232_set_line_ctrl(serial
, lcr
);
640 static int klsi_105_tiocmget(struct tty_struct
*tty
, struct file
*file
)
642 struct usb_serial_port
*port
= tty
->driver_data
;
643 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
646 unsigned long line_state
;
647 dbg("%s - request, just guessing", __func__
);
649 rc
= klsi_105_get_line_state(port
, &line_state
);
652 "Reading line control failed (error = %d)\n", rc
);
653 /* better return value? EAGAIN? */
657 spin_lock_irqsave(&priv
->lock
, flags
);
658 priv
->line_state
= line_state
;
659 spin_unlock_irqrestore(&priv
->lock
, flags
);
660 dbg("%s - read line state 0x%lx", __func__
, line_state
);
661 return (int)line_state
;
664 static int klsi_105_tiocmset(struct tty_struct
*tty
, struct file
*file
,
665 unsigned int set
, unsigned int clear
)
667 int retval
= -EINVAL
;
671 /* if this ever gets implemented, it should be done something like this:
672 struct usb_serial *serial = port->serial;
673 struct klsi_105_private *priv = usb_get_serial_port_data(port);
677 spin_lock_irqsave (&priv->lock, flags);
679 priv->control_state |= TIOCM_RTS;
681 priv->control_state |= TIOCM_DTR;
682 if (clear & TIOCM_RTS)
683 priv->control_state &= ~TIOCM_RTS;
684 if (clear & TIOCM_DTR)
685 priv->control_state &= ~TIOCM_DTR;
686 control = priv->control_state;
687 spin_unlock_irqrestore (&priv->lock, flags);
688 retval = mct_u232_set_modem_ctrl(serial, control);
694 static int __init
klsi_105_init(void)
697 retval
= usb_serial_register(&kl5kusb105d_device
);
699 goto failed_usb_serial_register
;
700 retval
= usb_register(&kl5kusb105d_driver
);
702 goto failed_usb_register
;
704 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_VERSION
":"
708 usb_serial_deregister(&kl5kusb105d_device
);
709 failed_usb_serial_register
:
713 static void __exit
klsi_105_exit(void)
715 usb_deregister(&kl5kusb105d_driver
);
716 usb_serial_deregister(&kl5kusb105d_device
);
720 module_init(klsi_105_init
);
721 module_exit(klsi_105_exit
);
723 MODULE_AUTHOR(DRIVER_AUTHOR
);
724 MODULE_DESCRIPTION(DRIVER_DESC
);
725 MODULE_LICENSE("GPL");
728 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
729 MODULE_PARM_DESC(debug
, "enable extensive debugging messages");