Linux 3.18.86
[linux/fpc-iii.git] / drivers / usb / serial / kl5kusb105.c
blob53c90131764d6cfa24d0f28bb25a98853bba0efc
1 /*
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
13 * on Windows98.
14 * It was written out of frustration with the PalmConnect USB Serial adapter
15 * sold by Palm Inc.
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
26 * let me know.
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!
33 /* TODO:
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"
56 * Function prototypes
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 = {
81 .driver = {
82 .owner = THIS_MODULE,
83 .name = "kl5kusb105d",
85 .description = "KL5KUSB105D / PalmConnect",
86 .id_table = id_table,
87 .num_ports = 1,
88 .bulk_out_size = 64,
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 */
108 __u8 baudrate;
109 __u8 databits;
110 __u8 unknown1;
111 __u8 unknown2;
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 */
118 spinlock_t lock;
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)
132 int rc;
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,
138 0, /* value */
139 0, /* index */
140 settings,
141 sizeof(struct klsi_105_port_settings),
142 KLSI_TIMEOUT);
143 if (rc < 0)
144 dev_err(&port->dev,
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);
150 return rc;
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)
162 return res;
166 * Read line control via vendor command and return result through
167 * *line_state_p
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)
174 int rc;
175 u8 *status_buf;
176 __u16 status;
178 dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
180 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
181 if (!status_buf)
182 return -ENOMEM;
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,
190 0, /* value */
191 0, /* index */
192 status_buf, KLSI_STATUSBUF_LEN,
193 10000
195 if (rc < 0)
196 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
197 rc);
198 else {
199 status = get_unaligned_le16(status_buf);
201 dev_info(&port->serial->dev->dev, "read status %x %x\n",
202 status_buf[0], status_buf[1]);
204 *line_state_p = klsi_105_status2linestate(status);
207 kfree(status_buf);
208 return rc;
213 * Driver's tty interface functions
216 static int klsi_105_port_probe(struct usb_serial_port *port)
218 struct klsi_105_private *priv;
220 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
221 if (!priv)
222 return -ENOMEM;
224 /* set initial values for control structures */
225 priv->cfg.pktlen = 5;
226 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
227 priv->cfg.databits = kl5kusb105a_dtb_8;
228 priv->cfg.unknown1 = 0;
229 priv->cfg.unknown2 = 1;
231 priv->line_state = 0;
233 spin_lock_init(&priv->lock);
235 /* priv->termios is left uninitialized until port opening */
237 usb_set_serial_port_data(port, priv);
239 return 0;
242 static int klsi_105_port_remove(struct usb_serial_port *port)
244 struct klsi_105_private *priv;
246 priv = usb_get_serial_port_data(port);
247 kfree(priv);
249 return 0;
252 static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
254 struct klsi_105_private *priv = usb_get_serial_port_data(port);
255 int retval = 0;
256 int rc;
257 int i;
258 unsigned long line_state;
259 struct klsi_105_port_settings *cfg;
260 unsigned long flags;
262 /* Do a defined restart:
263 * Set up sane default baud rate and send the 'READ_ON'
264 * vendor command.
265 * FIXME: set modem line control (how?)
266 * Then read the modem line control and store values in
267 * priv->line_state.
269 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
270 if (!cfg)
271 return -ENOMEM;
273 cfg->pktlen = 5;
274 cfg->baudrate = kl5kusb105a_sio_b9600;
275 cfg->databits = kl5kusb105a_dtb_8;
276 cfg->unknown1 = 0;
277 cfg->unknown2 = 1;
278 klsi_105_chg_port_settings(port, cfg);
280 /* set up termios structure */
281 spin_lock_irqsave(&priv->lock, flags);
282 priv->termios.c_iflag = tty->termios.c_iflag;
283 priv->termios.c_oflag = tty->termios.c_oflag;
284 priv->termios.c_cflag = tty->termios.c_cflag;
285 priv->termios.c_lflag = tty->termios.c_lflag;
286 for (i = 0; i < NCCS; i++)
287 priv->termios.c_cc[i] = tty->termios.c_cc[i];
288 priv->cfg.pktlen = cfg->pktlen;
289 priv->cfg.baudrate = cfg->baudrate;
290 priv->cfg.databits = cfg->databits;
291 priv->cfg.unknown1 = cfg->unknown1;
292 priv->cfg.unknown2 = cfg->unknown2;
293 spin_unlock_irqrestore(&priv->lock, flags);
295 /* READ_ON and urb submission */
296 rc = usb_serial_generic_open(tty, port);
297 if (rc) {
298 retval = rc;
299 goto err_free_cfg;
302 rc = usb_control_msg(port->serial->dev,
303 usb_sndctrlpipe(port->serial->dev, 0),
304 KL5KUSB105A_SIO_CONFIGURE,
305 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
306 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
307 0, /* index */
308 NULL,
310 KLSI_TIMEOUT);
311 if (rc < 0) {
312 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
313 retval = rc;
314 } else
315 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
317 rc = klsi_105_get_line_state(port, &line_state);
318 if (rc < 0) {
319 retval = rc;
320 goto err_disable_read;
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__,
327 line_state);
329 return 0;
331 err_disable_read:
332 usb_control_msg(port->serial->dev,
333 usb_sndctrlpipe(port->serial->dev, 0),
334 KL5KUSB105A_SIO_CONFIGURE,
335 USB_TYPE_VENDOR | USB_DIR_OUT,
336 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
337 0, /* index */
338 NULL, 0,
339 KLSI_TIMEOUT);
340 usb_serial_generic_close(port);
341 err_free_cfg:
342 kfree(cfg);
344 return retval;
347 static void klsi_105_close(struct usb_serial_port *port)
349 int rc;
351 /* send READ_OFF */
352 rc = usb_control_msg(port->serial->dev,
353 usb_sndctrlpipe(port->serial->dev, 0),
354 KL5KUSB105A_SIO_CONFIGURE,
355 USB_TYPE_VENDOR | USB_DIR_OUT,
356 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
357 0, /* index */
358 NULL, 0,
359 KLSI_TIMEOUT);
360 if (rc < 0)
361 dev_err(&port->dev, "failed to disable read: %d\n", rc);
363 /* shutdown our bulk reads and writes */
364 usb_serial_generic_close(port);
367 /* We need to write a complete 64-byte data block and encode the
368 * number actually sent in the first double-byte, LSB-order. That
369 * leaves at most 62 bytes of payload.
371 #define KLSI_HDR_LEN 2
372 static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
373 void *dest, size_t size)
375 unsigned char *buf = dest;
376 int count;
378 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
379 &port->lock);
380 put_unaligned_le16(count, buf);
382 return count + KLSI_HDR_LEN;
385 /* The data received is preceded by a length double-byte in LSB-first order.
387 static void klsi_105_process_read_urb(struct urb *urb)
389 struct usb_serial_port *port = urb->context;
390 unsigned char *data = urb->transfer_buffer;
391 unsigned len;
393 /* empty urbs seem to happen, we ignore them */
394 if (!urb->actual_length)
395 return;
397 if (urb->actual_length <= KLSI_HDR_LEN) {
398 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
399 return;
402 len = get_unaligned_le16(data);
403 if (len > urb->actual_length - KLSI_HDR_LEN) {
404 dev_dbg(&port->dev, "%s - packet length mismatch\n", __func__);
405 len = urb->actual_length - KLSI_HDR_LEN;
408 tty_insert_flip_string(&port->port, data + KLSI_HDR_LEN, len);
409 tty_flip_buffer_push(&port->port);
412 static void klsi_105_set_termios(struct tty_struct *tty,
413 struct usb_serial_port *port,
414 struct ktermios *old_termios)
416 struct klsi_105_private *priv = usb_get_serial_port_data(port);
417 struct device *dev = &port->dev;
418 unsigned int iflag = tty->termios.c_iflag;
419 unsigned int old_iflag = old_termios->c_iflag;
420 unsigned int cflag = tty->termios.c_cflag;
421 unsigned int old_cflag = old_termios->c_cflag;
422 struct klsi_105_port_settings *cfg;
423 unsigned long flags;
424 speed_t baud;
426 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
427 if (!cfg)
428 return;
430 /* lock while we are modifying the settings */
431 spin_lock_irqsave(&priv->lock, flags);
434 * Update baud rate
436 baud = tty_get_baud_rate(tty);
438 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
439 /* reassert DTR and (maybe) RTS on transition from B0 */
440 if ((old_cflag & CBAUD) == B0) {
441 dev_dbg(dev, "%s: baud was B0\n", __func__);
442 #if 0
443 priv->control_state |= TIOCM_DTR;
444 /* don't set RTS if using hardware flow control */
445 if (!(old_cflag & CRTSCTS))
446 priv->control_state |= TIOCM_RTS;
447 mct_u232_set_modem_ctrl(serial, priv->control_state);
448 #endif
451 switch (baud) {
452 case 0: /* handled below */
453 break;
454 case 1200:
455 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
456 break;
457 case 2400:
458 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
459 break;
460 case 4800:
461 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
462 break;
463 case 9600:
464 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
465 break;
466 case 19200:
467 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
468 break;
469 case 38400:
470 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
471 break;
472 case 57600:
473 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
474 break;
475 case 115200:
476 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
477 break;
478 default:
479 dev_dbg(dev, "unsupported baudrate, using 9600\n");
480 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
481 baud = 9600;
482 break;
484 if ((cflag & CBAUD) == B0) {
485 dev_dbg(dev, "%s: baud is B0\n", __func__);
486 /* Drop RTS and DTR */
487 /* maybe this should be simulated by sending read
488 * disable and read enable messages?
491 #if 0
492 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
493 mct_u232_set_modem_ctrl(serial, priv->control_state);
494 #endif
496 tty_encode_baud_rate(tty, baud, baud);
498 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
499 /* set the number of data bits */
500 switch (cflag & CSIZE) {
501 case CS5:
502 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
503 spin_unlock_irqrestore(&priv->lock, flags);
504 goto err;
505 case CS6:
506 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
507 spin_unlock_irqrestore(&priv->lock, flags);
508 goto err;
509 case CS7:
510 priv->cfg.databits = kl5kusb105a_dtb_7;
511 break;
512 case CS8:
513 priv->cfg.databits = kl5kusb105a_dtb_8;
514 break;
515 default:
516 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
517 priv->cfg.databits = kl5kusb105a_dtb_8;
518 break;
523 * Update line control register (LCR)
525 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
526 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
527 /* Not currently supported */
528 tty->termios.c_cflag &= ~(PARENB|PARODD|CSTOPB);
529 #if 0
530 priv->last_lcr = 0;
532 /* set the parity */
533 if (cflag & PARENB)
534 priv->last_lcr |= (cflag & PARODD) ?
535 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
536 else
537 priv->last_lcr |= MCT_U232_PARITY_NONE;
539 /* set the number of stop bits */
540 priv->last_lcr |= (cflag & CSTOPB) ?
541 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
543 mct_u232_set_line_ctrl(serial, priv->last_lcr);
544 #endif
548 * Set flow control: well, I do not really now how to handle DTR/RTS.
549 * Just do what we have seen with SniffUSB on Win98.
551 if ((iflag & IXOFF) != (old_iflag & IXOFF)
552 || (iflag & IXON) != (old_iflag & IXON)
553 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
554 /* Not currently supported */
555 tty->termios.c_cflag &= ~CRTSCTS;
556 /* Drop DTR/RTS if no flow control otherwise assert */
557 #if 0
558 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
559 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
560 else
561 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
562 mct_u232_set_modem_ctrl(serial, priv->control_state);
563 #endif
566 memcpy(cfg, &priv->cfg, sizeof(*cfg));
567 spin_unlock_irqrestore(&priv->lock, flags);
569 /* now commit changes to device */
570 klsi_105_chg_port_settings(port, cfg);
571 err:
572 kfree(cfg);
575 #if 0
576 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
578 struct usb_serial_port *port = tty->driver_data;
579 struct usb_serial *serial = port->serial;
580 struct mct_u232_private *priv =
581 (struct mct_u232_private *)port->private;
582 unsigned char lcr = priv->last_lcr;
584 dev_dbg(&port->dev, "%s - state=%d\n", __func__, break_state);
586 /* LOCKING */
587 if (break_state)
588 lcr |= MCT_U232_SET_BREAK;
590 mct_u232_set_line_ctrl(serial, lcr);
592 #endif
594 static int klsi_105_tiocmget(struct tty_struct *tty)
596 struct usb_serial_port *port = tty->driver_data;
597 struct klsi_105_private *priv = usb_get_serial_port_data(port);
598 unsigned long flags;
599 int rc;
600 unsigned long line_state;
602 rc = klsi_105_get_line_state(port, &line_state);
603 if (rc < 0) {
604 dev_err(&port->dev,
605 "Reading line control failed (error = %d)\n", rc);
606 /* better return value? EAGAIN? */
607 return rc;
610 spin_lock_irqsave(&priv->lock, flags);
611 priv->line_state = line_state;
612 spin_unlock_irqrestore(&priv->lock, flags);
613 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
614 return (int)line_state;
617 module_usb_serial_driver(serial_drivers, id_table);
619 MODULE_AUTHOR(DRIVER_AUTHOR);
620 MODULE_DESCRIPTION(DRIVER_DESC);
621 MODULE_LICENSE("GPL");