Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * KLSI KL5KUSB105 chip RS232 converter driver
4 *
5 * Copyright (C) 2010 Johan Hovold <jhovold@gmail.com>
6 * Copyright (C) 2001 Utz-Uwe Haus <haus@uuhaus.de>
7 *
8 * All information about the device was acquired using SniffUSB ans snoopUSB
9 * on Windows98.
10 * It was written out of frustration with the PalmConnect USB Serial adapter
11 * sold by Palm Inc.
12 * Neither Palm, nor their contractor (MCCI) or their supplier (KLSI) provided
13 * information that was not already available.
14 *
15 * It seems that KLSI bought some silicon-design information from ScanLogic,
16 * whose SL11R processor is at the core of the KL5KUSB chipset from KLSI.
17 * KLSI has firmware available for their devices; it is probable that the
18 * firmware differs from that used by KLSI in their products. If you have an
19 * original KLSI device and can provide some information on it, I would be
20 * most interested in adding support for it here. If you have any information
21 * on the protocol used (or find errors in my reverse-engineered stuff), please
22 * let me know.
23 *
24 * The code was only tested with a PalmConnect USB adapter; if you
25 * are adventurous, try it with any KLSI-based device and let me know how it
26 * breaks so that I can fix it!
27 */
28
29/* TODO:
30 * check modem line signals
31 * implement handshaking or decide that we do not support it
32 */
33
34#include <linux/kernel.h>
35#include <linux/errno.h>
36#include <linux/slab.h>
37#include <linux/tty.h>
38#include <linux/tty_driver.h>
39#include <linux/tty_flip.h>
40#include <linux/module.h>
41#include <linux/uaccess.h>
42#include <asm/unaligned.h>
43#include <linux/usb.h>
44#include <linux/usb/serial.h>
45#include "kl5kusb105.h"
46
47#define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>, Johan Hovold <jhovold@gmail.com>"
48#define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
49
50
51/*
52 * Function prototypes
53 */
54static int klsi_105_port_probe(struct usb_serial_port *port);
55static void klsi_105_port_remove(struct usb_serial_port *port);
56static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
57static void klsi_105_close(struct usb_serial_port *port);
58static void klsi_105_set_termios(struct tty_struct *tty,
59 struct usb_serial_port *port,
60 const struct ktermios *old_termios);
61static int klsi_105_tiocmget(struct tty_struct *tty);
62static void klsi_105_process_read_urb(struct urb *urb);
63static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
64 void *dest, size_t size);
65
66/*
67 * All of the device info needed for the KLSI converters.
68 */
69static const struct usb_device_id id_table[] = {
70 { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
71 { } /* Terminating entry */
72};
73
74MODULE_DEVICE_TABLE(usb, id_table);
75
76static struct usb_serial_driver kl5kusb105d_device = {
77 .driver = {
78 .owner = THIS_MODULE,
79 .name = "kl5kusb105d",
80 },
81 .description = "KL5KUSB105D / PalmConnect",
82 .id_table = id_table,
83 .num_ports = 1,
84 .bulk_out_size = 64,
85 .open = klsi_105_open,
86 .close = klsi_105_close,
87 .set_termios = klsi_105_set_termios,
88 .tiocmget = klsi_105_tiocmget,
89 .port_probe = klsi_105_port_probe,
90 .port_remove = klsi_105_port_remove,
91 .throttle = usb_serial_generic_throttle,
92 .unthrottle = usb_serial_generic_unthrottle,
93 .process_read_urb = klsi_105_process_read_urb,
94 .prepare_write_buffer = klsi_105_prepare_write_buffer,
95};
96
97static struct usb_serial_driver * const serial_drivers[] = {
98 &kl5kusb105d_device, NULL
99};
100
101struct klsi_105_port_settings {
102 u8 pktlen; /* always 5, it seems */
103 u8 baudrate;
104 u8 databits;
105 u8 unknown1;
106 u8 unknown2;
107};
108
109struct klsi_105_private {
110 struct klsi_105_port_settings cfg;
111 unsigned long line_state; /* modem line settings */
112 spinlock_t lock;
113};
114
115
116/*
117 * Handle vendor specific USB requests
118 */
119
120
121#define KLSI_TIMEOUT 5000 /* default urb timeout */
122
123static int klsi_105_chg_port_settings(struct usb_serial_port *port,
124 struct klsi_105_port_settings *settings)
125{
126 int rc;
127
128 rc = usb_control_msg_send(port->serial->dev,
129 0,
130 KL5KUSB105A_SIO_SET_DATA,
131 USB_TYPE_VENDOR | USB_DIR_OUT |
132 USB_RECIP_INTERFACE,
133 0, /* value */
134 0, /* index */
135 settings,
136 sizeof(struct klsi_105_port_settings),
137 KLSI_TIMEOUT,
138 GFP_KERNEL);
139 if (rc)
140 dev_err(&port->dev,
141 "Change port settings failed (error = %d)\n", rc);
142
143 dev_dbg(&port->dev,
144 "pktlen %u, baudrate 0x%02x, databits %u, u1 %u, u2 %u\n",
145 settings->pktlen, settings->baudrate, settings->databits,
146 settings->unknown1, settings->unknown2);
147
148 return rc;
149}
150
151/*
152 * Read line control via vendor command and return result through
153 * the state pointer.
154 */
155static int klsi_105_get_line_state(struct usb_serial_port *port,
156 unsigned long *state)
157{
158 u16 status;
159 int rc;
160
161 rc = usb_control_msg_recv(port->serial->dev, 0,
162 KL5KUSB105A_SIO_POLL,
163 USB_TYPE_VENDOR | USB_DIR_IN,
164 0, /* value */
165 0, /* index */
166 &status, sizeof(status),
167 10000,
168 GFP_KERNEL);
169 if (rc) {
170 dev_err(&port->dev, "reading line status failed: %d\n", rc);
171 return rc;
172 }
173
174 le16_to_cpus(&status);
175
176 dev_dbg(&port->dev, "read status %04x\n", status);
177
178 *state = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0) |
179 ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0);
180
181 return 0;
182}
183
184
185/*
186 * Driver's tty interface functions
187 */
188
189static int klsi_105_port_probe(struct usb_serial_port *port)
190{
191 struct klsi_105_private *priv;
192
193 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
194 if (!priv)
195 return -ENOMEM;
196
197 /* set initial values for control structures */
198 priv->cfg.pktlen = 5;
199 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
200 priv->cfg.databits = kl5kusb105a_dtb_8;
201 priv->cfg.unknown1 = 0;
202 priv->cfg.unknown2 = 1;
203
204 priv->line_state = 0;
205
206 spin_lock_init(&priv->lock);
207
208 usb_set_serial_port_data(port, priv);
209
210 return 0;
211}
212
213static void klsi_105_port_remove(struct usb_serial_port *port)
214{
215 struct klsi_105_private *priv;
216
217 priv = usb_get_serial_port_data(port);
218 kfree(priv);
219}
220
221static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
222{
223 struct klsi_105_private *priv = usb_get_serial_port_data(port);
224 int retval = 0;
225 int rc;
226 unsigned long line_state;
227 struct klsi_105_port_settings cfg;
228 unsigned long flags;
229
230 /* Do a defined restart:
231 * Set up sane default baud rate and send the 'READ_ON'
232 * vendor command.
233 * FIXME: set modem line control (how?)
234 * Then read the modem line control and store values in
235 * priv->line_state.
236 */
237
238 cfg.pktlen = 5;
239 cfg.baudrate = kl5kusb105a_sio_b9600;
240 cfg.databits = kl5kusb105a_dtb_8;
241 cfg.unknown1 = 0;
242 cfg.unknown2 = 1;
243 klsi_105_chg_port_settings(port, &cfg);
244
245 spin_lock_irqsave(&priv->lock, flags);
246 priv->cfg.pktlen = cfg.pktlen;
247 priv->cfg.baudrate = cfg.baudrate;
248 priv->cfg.databits = cfg.databits;
249 priv->cfg.unknown1 = cfg.unknown1;
250 priv->cfg.unknown2 = cfg.unknown2;
251 spin_unlock_irqrestore(&priv->lock, flags);
252
253 /* READ_ON and urb submission */
254 rc = usb_serial_generic_open(tty, port);
255 if (rc)
256 return rc;
257
258 rc = usb_control_msg(port->serial->dev,
259 usb_sndctrlpipe(port->serial->dev, 0),
260 KL5KUSB105A_SIO_CONFIGURE,
261 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
262 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
263 0, /* index */
264 NULL,
265 0,
266 KLSI_TIMEOUT);
267 if (rc < 0) {
268 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
269 retval = rc;
270 goto err_generic_close;
271 } else
272 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
273
274 rc = klsi_105_get_line_state(port, &line_state);
275 if (rc < 0) {
276 retval = rc;
277 goto err_disable_read;
278 }
279
280 spin_lock_irqsave(&priv->lock, flags);
281 priv->line_state = line_state;
282 spin_unlock_irqrestore(&priv->lock, flags);
283 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__,
284 line_state);
285
286 return 0;
287
288err_disable_read:
289 usb_control_msg(port->serial->dev,
290 usb_sndctrlpipe(port->serial->dev, 0),
291 KL5KUSB105A_SIO_CONFIGURE,
292 USB_TYPE_VENDOR | USB_DIR_OUT,
293 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
294 0, /* index */
295 NULL, 0,
296 KLSI_TIMEOUT);
297err_generic_close:
298 usb_serial_generic_close(port);
299
300 return retval;
301}
302
303static void klsi_105_close(struct usb_serial_port *port)
304{
305 int rc;
306
307 /* send READ_OFF */
308 rc = usb_control_msg(port->serial->dev,
309 usb_sndctrlpipe(port->serial->dev, 0),
310 KL5KUSB105A_SIO_CONFIGURE,
311 USB_TYPE_VENDOR | USB_DIR_OUT,
312 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
313 0, /* index */
314 NULL, 0,
315 KLSI_TIMEOUT);
316 if (rc < 0)
317 dev_err(&port->dev, "failed to disable read: %d\n", rc);
318
319 /* shutdown our bulk reads and writes */
320 usb_serial_generic_close(port);
321}
322
323/* We need to write a complete 64-byte data block and encode the
324 * number actually sent in the first double-byte, LSB-order. That
325 * leaves at most 62 bytes of payload.
326 */
327#define KLSI_HDR_LEN 2
328static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
329 void *dest, size_t size)
330{
331 unsigned char *buf = dest;
332 int count;
333
334 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
335 &port->lock);
336 put_unaligned_le16(count, buf);
337
338 return count + KLSI_HDR_LEN;
339}
340
341/* The data received is preceded by a length double-byte in LSB-first order.
342 */
343static void klsi_105_process_read_urb(struct urb *urb)
344{
345 struct usb_serial_port *port = urb->context;
346 unsigned char *data = urb->transfer_buffer;
347 unsigned len;
348
349 /* empty urbs seem to happen, we ignore them */
350 if (!urb->actual_length)
351 return;
352
353 if (urb->actual_length <= KLSI_HDR_LEN) {
354 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
355 return;
356 }
357
358 len = get_unaligned_le16(data);
359 if (len > urb->actual_length - KLSI_HDR_LEN) {
360 dev_dbg(&port->dev, "%s - packet length mismatch\n", __func__);
361 len = urb->actual_length - KLSI_HDR_LEN;
362 }
363
364 tty_insert_flip_string(&port->port, data + KLSI_HDR_LEN, len);
365 tty_flip_buffer_push(&port->port);
366}
367
368static void klsi_105_set_termios(struct tty_struct *tty,
369 struct usb_serial_port *port,
370 const struct ktermios *old_termios)
371{
372 struct klsi_105_private *priv = usb_get_serial_port_data(port);
373 struct device *dev = &port->dev;
374 unsigned int iflag = tty->termios.c_iflag;
375 unsigned int old_iflag = old_termios->c_iflag;
376 unsigned int cflag = tty->termios.c_cflag;
377 unsigned int old_cflag = old_termios->c_cflag;
378 struct klsi_105_port_settings *cfg;
379 unsigned long flags;
380 speed_t baud;
381
382 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
383 if (!cfg)
384 return;
385
386 /* lock while we are modifying the settings */
387 spin_lock_irqsave(&priv->lock, flags);
388
389 /*
390 * Update baud rate
391 */
392 baud = tty_get_baud_rate(tty);
393
394 switch (baud) {
395 case 0: /* handled below */
396 break;
397 case 1200:
398 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
399 break;
400 case 2400:
401 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
402 break;
403 case 4800:
404 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
405 break;
406 case 9600:
407 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
408 break;
409 case 19200:
410 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
411 break;
412 case 38400:
413 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
414 break;
415 case 57600:
416 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
417 break;
418 case 115200:
419 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
420 break;
421 default:
422 dev_dbg(dev, "unsupported baudrate, using 9600\n");
423 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
424 baud = 9600;
425 break;
426 }
427
428 /*
429 * FIXME: implement B0 handling
430 *
431 * Maybe this should be simulated by sending read disable and read
432 * enable messages?
433 */
434
435 tty_encode_baud_rate(tty, baud, baud);
436
437 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
438 /* set the number of data bits */
439 switch (cflag & CSIZE) {
440 case CS5:
441 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
442 spin_unlock_irqrestore(&priv->lock, flags);
443 goto err;
444 case CS6:
445 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
446 spin_unlock_irqrestore(&priv->lock, flags);
447 goto err;
448 case CS7:
449 priv->cfg.databits = kl5kusb105a_dtb_7;
450 break;
451 case CS8:
452 priv->cfg.databits = kl5kusb105a_dtb_8;
453 break;
454 default:
455 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
456 priv->cfg.databits = kl5kusb105a_dtb_8;
457 break;
458 }
459 }
460
461 /*
462 * Update line control register (LCR)
463 */
464 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
465 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
466 /* Not currently supported */
467 tty->termios.c_cflag &= ~(PARENB|PARODD|CSTOPB);
468 }
469 /*
470 * Set flow control: well, I do not really now how to handle DTR/RTS.
471 * Just do what we have seen with SniffUSB on Win98.
472 */
473 if ((iflag & IXOFF) != (old_iflag & IXOFF)
474 || (iflag & IXON) != (old_iflag & IXON)
475 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
476 /* Not currently supported */
477 tty->termios.c_cflag &= ~CRTSCTS;
478 }
479 memcpy(cfg, &priv->cfg, sizeof(*cfg));
480 spin_unlock_irqrestore(&priv->lock, flags);
481
482 /* now commit changes to device */
483 klsi_105_chg_port_settings(port, cfg);
484err:
485 kfree(cfg);
486}
487
488static int klsi_105_tiocmget(struct tty_struct *tty)
489{
490 struct usb_serial_port *port = tty->driver_data;
491 struct klsi_105_private *priv = usb_get_serial_port_data(port);
492 unsigned long flags;
493 int rc;
494 unsigned long line_state;
495
496 rc = klsi_105_get_line_state(port, &line_state);
497 if (rc < 0) {
498 dev_err(&port->dev,
499 "Reading line control failed (error = %d)\n", rc);
500 /* better return value? EAGAIN? */
501 return rc;
502 }
503
504 spin_lock_irqsave(&priv->lock, flags);
505 priv->line_state = line_state;
506 spin_unlock_irqrestore(&priv->lock, flags);
507 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
508 return (int)line_state;
509}
510
511module_usb_serial_driver(serial_drivers, id_table);
512
513MODULE_AUTHOR(DRIVER_AUTHOR);
514MODULE_DESCRIPTION(DRIVER_DESC);
515MODULE_LICENSE("GPL");
1/*
2 * KLSI KL5KUSB105 chip RS232 converter driver
3 *
4 * Copyright (C) 2010 Johan Hovold <jhovold@gmail.com>
5 * Copyright (C) 2001 Utz-Uwe Haus <haus@uuhaus.de>
6 *
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.
11 *
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.
18 *
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.
27 *
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!
31 */
32
33/* TODO:
34 * check modem line signals
35 * implement handshaking or decide that we do not support it
36 */
37
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"
50
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"
53
54
55/*
56 * Function prototypes
57 */
58static int klsi_105_port_probe(struct usb_serial_port *port);
59static int klsi_105_port_remove(struct usb_serial_port *port);
60static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
61static void klsi_105_close(struct usb_serial_port *port);
62static void klsi_105_set_termios(struct tty_struct *tty,
63 struct usb_serial_port *port, struct ktermios *old);
64static int klsi_105_tiocmget(struct tty_struct *tty);
65static int klsi_105_tiocmset(struct tty_struct *tty,
66 unsigned int set, unsigned int clear);
67static void klsi_105_process_read_urb(struct urb *urb);
68static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
69 void *dest, size_t size);
70
71/*
72 * All of the device info needed for the KLSI converters.
73 */
74static 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 */
78};
79
80MODULE_DEVICE_TABLE(usb, id_table);
81
82static struct usb_serial_driver kl5kusb105d_device = {
83 .driver = {
84 .owner = THIS_MODULE,
85 .name = "kl5kusb105d",
86 },
87 .description = "KL5KUSB105D / PalmConnect",
88 .id_table = id_table,
89 .num_ports = 1,
90 .bulk_out_size = 64,
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,
103};
104
105static struct usb_serial_driver * const serial_drivers[] = {
106 &kl5kusb105d_device, NULL
107};
108
109struct klsi_105_port_settings {
110 __u8 pktlen; /* always 5, it seems */
111 __u8 baudrate;
112 __u8 databits;
113 __u8 unknown1;
114 __u8 unknown2;
115} __attribute__ ((packed));
116
117struct klsi_105_private {
118 struct klsi_105_port_settings cfg;
119 struct ktermios termios;
120 unsigned long line_state; /* modem line settings */
121 spinlock_t lock;
122};
123
124
125/*
126 * Handle vendor specific USB requests
127 */
128
129
130#define KLSI_TIMEOUT 5000 /* default urb timeout */
131
132static int klsi_105_chg_port_settings(struct usb_serial_port *port,
133 struct klsi_105_port_settings *settings)
134{
135 int rc;
136
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,
141 0, /* value */
142 0, /* index */
143 settings,
144 sizeof(struct klsi_105_port_settings),
145 KLSI_TIMEOUT);
146 if (rc < 0)
147 dev_err(&port->dev,
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);
153 return rc;
154}
155
156/* translate a 16-bit status value from the device to linux's TIO bits */
157static unsigned long klsi_105_status2linestate(const __u16 status)
158{
159 unsigned long res = 0;
160
161 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
162 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
163 ;
164
165 return res;
166}
167
168/*
169 * Read line control via vendor command and return result through
170 * *line_state_p
171 */
172/* It seems that the status buffer has always only 2 bytes length */
173#define KLSI_STATUSBUF_LEN 2
174static int klsi_105_get_line_state(struct usb_serial_port *port,
175 unsigned long *line_state_p)
176{
177 int rc;
178 u8 *status_buf;
179 __u16 status;
180
181 dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
182
183 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
184 if (!status_buf)
185 return -ENOMEM;
186
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,
193 0, /* value */
194 0, /* index */
195 status_buf, KLSI_STATUSBUF_LEN,
196 10000
197 );
198 if (rc < 0)
199 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
200 rc);
201 else {
202 status = get_unaligned_le16(status_buf);
203
204 dev_info(&port->serial->dev->dev, "read status %x %x\n",
205 status_buf[0], status_buf[1]);
206
207 *line_state_p = klsi_105_status2linestate(status);
208 }
209
210 kfree(status_buf);
211 return rc;
212}
213
214
215/*
216 * Driver's tty interface functions
217 */
218
219static int klsi_105_port_probe(struct usb_serial_port *port)
220{
221 struct klsi_105_private *priv;
222
223 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
224 if (!priv)
225 return -ENOMEM;
226
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;
233
234 priv->line_state = 0;
235
236 spin_lock_init(&priv->lock);
237
238 /* priv->termios is left uninitialized until port opening */
239
240 usb_set_serial_port_data(port, priv);
241
242 return 0;
243}
244
245static int klsi_105_port_remove(struct usb_serial_port *port)
246{
247 struct klsi_105_private *priv;
248
249 priv = usb_get_serial_port_data(port);
250 kfree(priv);
251
252 return 0;
253}
254
255static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
256{
257 struct klsi_105_private *priv = usb_get_serial_port_data(port);
258 int retval = 0;
259 int rc;
260 int i;
261 unsigned long line_state;
262 struct klsi_105_port_settings *cfg;
263 unsigned long flags;
264
265 /* Do a defined restart:
266 * Set up sane default baud rate and send the 'READ_ON'
267 * vendor command.
268 * FIXME: set modem line control (how?)
269 * Then read the modem line control and store values in
270 * priv->line_state.
271 */
272 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
273 if (!cfg)
274 return -ENOMEM;
275
276 cfg->pktlen = 5;
277 cfg->baudrate = kl5kusb105a_sio_b9600;
278 cfg->databits = kl5kusb105a_dtb_8;
279 cfg->unknown1 = 0;
280 cfg->unknown2 = 1;
281 klsi_105_chg_port_settings(port, cfg);
282
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);
297
298 /* READ_ON and urb submission */
299 rc = usb_serial_generic_open(tty, port);
300 if (rc) {
301 retval = rc;
302 goto exit;
303 }
304
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,
310 0, /* index */
311 NULL,
312 0,
313 KLSI_TIMEOUT);
314 if (rc < 0) {
315 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
316 retval = rc;
317 } else
318 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
319
320 rc = klsi_105_get_line_state(port, &line_state);
321 if (rc >= 0) {
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);
326 retval = 0;
327 } else
328 retval = rc;
329
330exit:
331 kfree(cfg);
332 return retval;
333}
334
335static void klsi_105_close(struct usb_serial_port *port)
336{
337 int rc;
338
339 /* send READ_OFF */
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,
345 0, /* index */
346 NULL, 0,
347 KLSI_TIMEOUT);
348 if (rc < 0)
349 dev_err(&port->dev, "failed to disable read: %d\n", rc);
350
351 /* shutdown our bulk reads and writes */
352 usb_serial_generic_close(port);
353}
354
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.
358 */
359#define KLSI_HDR_LEN 2
360static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
361 void *dest, size_t size)
362{
363 unsigned char *buf = dest;
364 int count;
365
366 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
367 &port->lock);
368 put_unaligned_le16(count, buf);
369
370 return count + KLSI_HDR_LEN;
371}
372
373/* The data received is preceded by a length double-byte in LSB-first order.
374 */
375static void klsi_105_process_read_urb(struct urb *urb)
376{
377 struct usb_serial_port *port = urb->context;
378 unsigned char *data = urb->transfer_buffer;
379 unsigned len;
380
381 /* empty urbs seem to happen, we ignore them */
382 if (!urb->actual_length)
383 return;
384
385 if (urb->actual_length <= KLSI_HDR_LEN) {
386 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
387 return;
388 }
389
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;
394 }
395
396 tty_insert_flip_string(&port->port, data + KLSI_HDR_LEN, len);
397 tty_flip_buffer_push(&port->port);
398}
399
400static void klsi_105_set_termios(struct tty_struct *tty,
401 struct usb_serial_port *port,
402 struct ktermios *old_termios)
403{
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;
411 unsigned long flags;
412 speed_t baud;
413
414 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
415 if (!cfg)
416 return;
417
418 /* lock while we are modifying the settings */
419 spin_lock_irqsave(&priv->lock, flags);
420
421 /*
422 * Update baud rate
423 */
424 baud = tty_get_baud_rate(tty);
425
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__);
430#if 0
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);
436#endif
437 }
438 }
439 switch (baud) {
440 case 0: /* handled below */
441 break;
442 case 1200:
443 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
444 break;
445 case 2400:
446 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
447 break;
448 case 4800:
449 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
450 break;
451 case 9600:
452 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
453 break;
454 case 19200:
455 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
456 break;
457 case 38400:
458 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
459 break;
460 case 57600:
461 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
462 break;
463 case 115200:
464 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
465 break;
466 default:
467 dev_dbg(dev, "unsupported baudrate, using 9600\n");
468 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
469 baud = 9600;
470 break;
471 }
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?
477 */
478 ;
479#if 0
480 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
481 mct_u232_set_modem_ctrl(serial, priv->control_state);
482#endif
483 }
484 tty_encode_baud_rate(tty, baud, baud);
485
486 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
487 /* set the number of data bits */
488 switch (cflag & CSIZE) {
489 case CS5:
490 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
491 spin_unlock_irqrestore(&priv->lock, flags);
492 goto err;
493 case CS6:
494 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
495 spin_unlock_irqrestore(&priv->lock, flags);
496 goto err;
497 case CS7:
498 priv->cfg.databits = kl5kusb105a_dtb_7;
499 break;
500 case CS8:
501 priv->cfg.databits = kl5kusb105a_dtb_8;
502 break;
503 default:
504 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
505 priv->cfg.databits = kl5kusb105a_dtb_8;
506 break;
507 }
508 }
509
510 /*
511 * Update line control register (LCR)
512 */
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);
517#if 0
518 priv->last_lcr = 0;
519
520 /* set the parity */
521 if (cflag & PARENB)
522 priv->last_lcr |= (cflag & PARODD) ?
523 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
524 else
525 priv->last_lcr |= MCT_U232_PARITY_NONE;
526
527 /* set the number of stop bits */
528 priv->last_lcr |= (cflag & CSTOPB) ?
529 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
530
531 mct_u232_set_line_ctrl(serial, priv->last_lcr);
532#endif
533 ;
534 }
535 /*
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.
538 */
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 */
545#if 0
546 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
547 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
548 else
549 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
550 mct_u232_set_modem_ctrl(serial, priv->control_state);
551#endif
552 ;
553 }
554 memcpy(cfg, &priv->cfg, sizeof(*cfg));
555 spin_unlock_irqrestore(&priv->lock, flags);
556
557 /* now commit changes to device */
558 klsi_105_chg_port_settings(port, cfg);
559err:
560 kfree(cfg);
561}
562
563#if 0
564static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
565{
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;
571
572 dev_dbg(&port->dev, "%s - state=%d\n", __func__, break_state);
573
574 /* LOCKING */
575 if (break_state)
576 lcr |= MCT_U232_SET_BREAK;
577
578 mct_u232_set_line_ctrl(serial, lcr);
579}
580#endif
581
582static int klsi_105_tiocmget(struct tty_struct *tty)
583{
584 struct usb_serial_port *port = tty->driver_data;
585 struct klsi_105_private *priv = usb_get_serial_port_data(port);
586 unsigned long flags;
587 int rc;
588 unsigned long line_state;
589
590 rc = klsi_105_get_line_state(port, &line_state);
591 if (rc < 0) {
592 dev_err(&port->dev,
593 "Reading line control failed (error = %d)\n", rc);
594 /* better return value? EAGAIN? */
595 return rc;
596 }
597
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;
603}
604
605static int klsi_105_tiocmset(struct tty_struct *tty,
606 unsigned int set, unsigned int clear)
607{
608 int retval = -EINVAL;
609
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);
613 unsigned long flags;
614 int control;
615
616 spin_lock_irqsave (&priv->lock, flags);
617 if (set & TIOCM_RTS)
618 priv->control_state |= TIOCM_RTS;
619 if (set & TIOCM_DTR)
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);
628*/
629 return retval;
630}
631
632module_usb_serial_driver(serial_drivers, id_table);
633
634MODULE_AUTHOR(DRIVER_AUTHOR);
635MODULE_DESCRIPTION(DRIVER_DESC);
636MODULE_LICENSE("GPL");