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/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"
51
52static bool debug;
53
54/*
55 * Version Information
56 */
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"
60
61
62/*
63 * Function prototypes
64 */
65static int klsi_105_startup(struct usb_serial *serial);
66static void klsi_105_release(struct usb_serial *serial);
67static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
68static void klsi_105_close(struct usb_serial_port *port);
69static void klsi_105_set_termios(struct tty_struct *tty,
70 struct usb_serial_port *port, struct ktermios *old);
71static int klsi_105_tiocmget(struct tty_struct *tty);
72static int klsi_105_tiocmset(struct tty_struct *tty,
73 unsigned int set, unsigned int clear);
74static void klsi_105_process_read_urb(struct urb *urb);
75static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
76 void *dest, size_t size);
77
78/*
79 * All of the device info needed for the KLSI converters.
80 */
81static 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 */
85};
86
87MODULE_DEVICE_TABLE(usb, id_table);
88
89static struct usb_serial_driver kl5kusb105d_device = {
90 .driver = {
91 .owner = THIS_MODULE,
92 .name = "kl5kusb105d",
93 },
94 .description = "KL5KUSB105D / PalmConnect",
95 .id_table = id_table,
96 .num_ports = 1,
97 .bulk_out_size = 64,
98 .open = klsi_105_open,
99 .close = klsi_105_close,
100 .set_termios = klsi_105_set_termios,
101 /*.break_ctl = klsi_105_break_ctl,*/
102 .tiocmget = klsi_105_tiocmget,
103 .tiocmset = klsi_105_tiocmset,
104 .attach = klsi_105_startup,
105 .release = klsi_105_release,
106 .throttle = usb_serial_generic_throttle,
107 .unthrottle = usb_serial_generic_unthrottle,
108 .process_read_urb = klsi_105_process_read_urb,
109 .prepare_write_buffer = klsi_105_prepare_write_buffer,
110};
111
112static struct usb_serial_driver * const serial_drivers[] = {
113 &kl5kusb105d_device, NULL
114};
115
116struct klsi_105_port_settings {
117 __u8 pktlen; /* always 5, it seems */
118 __u8 baudrate;
119 __u8 databits;
120 __u8 unknown1;
121 __u8 unknown2;
122} __attribute__ ((packed));
123
124struct klsi_105_private {
125 struct klsi_105_port_settings cfg;
126 struct ktermios termios;
127 unsigned long line_state; /* modem line settings */
128 spinlock_t lock;
129};
130
131
132/*
133 * Handle vendor specific USB requests
134 */
135
136
137#define KLSI_TIMEOUT 5000 /* default urb timeout */
138
139static int klsi_105_chg_port_settings(struct usb_serial_port *port,
140 struct klsi_105_port_settings *settings)
141{
142 int rc;
143
144 rc = usb_control_msg(port->serial->dev,
145 usb_sndctrlpipe(port->serial->dev, 0),
146 KL5KUSB105A_SIO_SET_DATA,
147 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
148 0, /* value */
149 0, /* index */
150 settings,
151 sizeof(struct klsi_105_port_settings),
152 KLSI_TIMEOUT);
153 if (rc < 0)
154 dev_err(&port->dev,
155 "Change port settings failed (error = %d)\n", rc);
156 dev_info(&port->serial->dev->dev,
157 "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
158 settings->pktlen, settings->baudrate, settings->databits,
159 settings->unknown1, settings->unknown2);
160 return rc;
161}
162
163/* translate a 16-bit status value from the device to linux's TIO bits */
164static unsigned long klsi_105_status2linestate(const __u16 status)
165{
166 unsigned long res = 0;
167
168 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
169 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
170 ;
171
172 return res;
173}
174
175/*
176 * Read line control via vendor command and return result through
177 * *line_state_p
178 */
179/* It seems that the status buffer has always only 2 bytes length */
180#define KLSI_STATUSBUF_LEN 2
181static int klsi_105_get_line_state(struct usb_serial_port *port,
182 unsigned long *line_state_p)
183{
184 int rc;
185 u8 *status_buf;
186 __u16 status;
187
188 dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
189
190 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
191 if (!status_buf) {
192 dev_err(&port->dev, "%s - out of memory for status buffer.\n",
193 __func__);
194 return -ENOMEM;
195 }
196 status_buf[0] = 0xff;
197 status_buf[1] = 0xff;
198 rc = usb_control_msg(port->serial->dev,
199 usb_rcvctrlpipe(port->serial->dev, 0),
200 KL5KUSB105A_SIO_POLL,
201 USB_TYPE_VENDOR | USB_DIR_IN,
202 0, /* value */
203 0, /* index */
204 status_buf, KLSI_STATUSBUF_LEN,
205 10000
206 );
207 if (rc < 0)
208 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
209 rc);
210 else {
211 status = get_unaligned_le16(status_buf);
212
213 dev_info(&port->serial->dev->dev, "read status %x %x",
214 status_buf[0], status_buf[1]);
215
216 *line_state_p = klsi_105_status2linestate(status);
217 }
218
219 kfree(status_buf);
220 return rc;
221}
222
223
224/*
225 * Driver's tty interface functions
226 */
227
228static int klsi_105_startup(struct usb_serial *serial)
229{
230 struct klsi_105_private *priv;
231 int i;
232
233 /* check if we support the product id (see keyspan.c)
234 * FIXME
235 */
236
237 /* allocate the private data structure */
238 for (i = 0; i < serial->num_ports; i++) {
239 priv = kmalloc(sizeof(struct klsi_105_private),
240 GFP_KERNEL);
241 if (!priv) {
242 dbg("%skmalloc for klsi_105_private failed.", __func__);
243 i--;
244 goto err_cleanup;
245 }
246 /* set initial values for control structures */
247 priv->cfg.pktlen = 5;
248 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
249 priv->cfg.databits = kl5kusb105a_dtb_8;
250 priv->cfg.unknown1 = 0;
251 priv->cfg.unknown2 = 1;
252
253 priv->line_state = 0;
254
255 usb_set_serial_port_data(serial->port[i], priv);
256
257 spin_lock_init(&priv->lock);
258
259 /* priv->termios is left uninitialized until port opening */
260 init_waitqueue_head(&serial->port[i]->write_wait);
261 }
262
263 return 0;
264
265err_cleanup:
266 for (; i >= 0; i--) {
267 priv = usb_get_serial_port_data(serial->port[i]);
268 kfree(priv);
269 usb_set_serial_port_data(serial->port[i], NULL);
270 }
271 return -ENOMEM;
272}
273
274static void klsi_105_release(struct usb_serial *serial)
275{
276 int i;
277
278 for (i = 0; i < serial->num_ports; ++i)
279 kfree(usb_get_serial_port_data(serial->port[i]));
280}
281
282static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
283{
284 struct klsi_105_private *priv = usb_get_serial_port_data(port);
285 int retval = 0;
286 int rc;
287 int i;
288 unsigned long line_state;
289 struct klsi_105_port_settings *cfg;
290 unsigned long flags;
291
292 /* Do a defined restart:
293 * Set up sane default baud rate and send the 'READ_ON'
294 * vendor command.
295 * FIXME: set modem line control (how?)
296 * Then read the modem line control and store values in
297 * priv->line_state.
298 */
299 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
300 if (!cfg) {
301 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
302 __func__);
303 return -ENOMEM;
304 }
305 cfg->pktlen = 5;
306 cfg->baudrate = kl5kusb105a_sio_b9600;
307 cfg->databits = kl5kusb105a_dtb_8;
308 cfg->unknown1 = 0;
309 cfg->unknown2 = 1;
310 klsi_105_chg_port_settings(port, cfg);
311
312 /* set up termios structure */
313 spin_lock_irqsave(&priv->lock, flags);
314 priv->termios.c_iflag = tty->termios->c_iflag;
315 priv->termios.c_oflag = tty->termios->c_oflag;
316 priv->termios.c_cflag = tty->termios->c_cflag;
317 priv->termios.c_lflag = tty->termios->c_lflag;
318 for (i = 0; i < NCCS; i++)
319 priv->termios.c_cc[i] = tty->termios->c_cc[i];
320 priv->cfg.pktlen = cfg->pktlen;
321 priv->cfg.baudrate = cfg->baudrate;
322 priv->cfg.databits = cfg->databits;
323 priv->cfg.unknown1 = cfg->unknown1;
324 priv->cfg.unknown2 = cfg->unknown2;
325 spin_unlock_irqrestore(&priv->lock, flags);
326
327 /* READ_ON and urb submission */
328 rc = usb_serial_generic_open(tty, port);
329 if (rc) {
330 retval = rc;
331 goto exit;
332 }
333
334 rc = usb_control_msg(port->serial->dev,
335 usb_sndctrlpipe(port->serial->dev, 0),
336 KL5KUSB105A_SIO_CONFIGURE,
337 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
338 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
339 0, /* index */
340 NULL,
341 0,
342 KLSI_TIMEOUT);
343 if (rc < 0) {
344 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
345 retval = rc;
346 } else
347 dbg("%s - enabled reading", __func__);
348
349 rc = klsi_105_get_line_state(port, &line_state);
350 if (rc >= 0) {
351 spin_lock_irqsave(&priv->lock, flags);
352 priv->line_state = line_state;
353 spin_unlock_irqrestore(&priv->lock, flags);
354 dbg("%s - read line state 0x%lx", __func__, line_state);
355 retval = 0;
356 } else
357 retval = rc;
358
359exit:
360 kfree(cfg);
361 return retval;
362}
363
364static void klsi_105_close(struct usb_serial_port *port)
365{
366 int rc;
367
368 mutex_lock(&port->serial->disc_mutex);
369 if (!port->serial->disconnected) {
370 /* send READ_OFF */
371 rc = usb_control_msg(port->serial->dev,
372 usb_sndctrlpipe(port->serial->dev, 0),
373 KL5KUSB105A_SIO_CONFIGURE,
374 USB_TYPE_VENDOR | USB_DIR_OUT,
375 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
376 0, /* index */
377 NULL, 0,
378 KLSI_TIMEOUT);
379 if (rc < 0)
380 dev_err(&port->dev,
381 "Disabling read failed (error = %d)\n", rc);
382 }
383 mutex_unlock(&port->serial->disc_mutex);
384
385 /* shutdown our bulk reads and writes */
386 usb_serial_generic_close(port);
387
388 /* wgg - do I need this? I think so. */
389 usb_kill_urb(port->interrupt_in_urb);
390}
391
392/* We need to write a complete 64-byte data block and encode the
393 * number actually sent in the first double-byte, LSB-order. That
394 * leaves at most 62 bytes of payload.
395 */
396#define KLSI_HDR_LEN 2
397static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
398 void *dest, size_t size)
399{
400 unsigned char *buf = dest;
401 int count;
402
403 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
404 &port->lock);
405 put_unaligned_le16(count, buf);
406
407 return count + KLSI_HDR_LEN;
408}
409
410/* The data received is preceded by a length double-byte in LSB-first order.
411 */
412static void klsi_105_process_read_urb(struct urb *urb)
413{
414 struct usb_serial_port *port = urb->context;
415 unsigned char *data = urb->transfer_buffer;
416 struct tty_struct *tty;
417 unsigned len;
418
419 /* empty urbs seem to happen, we ignore them */
420 if (!urb->actual_length)
421 return;
422
423 if (urb->actual_length <= KLSI_HDR_LEN) {
424 dbg("%s - malformed packet", __func__);
425 return;
426 }
427
428 tty = tty_port_tty_get(&port->port);
429 if (!tty)
430 return;
431
432 len = get_unaligned_le16(data);
433 if (len > urb->actual_length - KLSI_HDR_LEN) {
434 dbg("%s - packet length mismatch", __func__);
435 len = urb->actual_length - KLSI_HDR_LEN;
436 }
437
438 tty_insert_flip_string(tty, data + KLSI_HDR_LEN, len);
439 tty_flip_buffer_push(tty);
440 tty_kref_put(tty);
441}
442
443static void klsi_105_set_termios(struct tty_struct *tty,
444 struct usb_serial_port *port,
445 struct ktermios *old_termios)
446{
447 struct klsi_105_private *priv = usb_get_serial_port_data(port);
448 unsigned int iflag = tty->termios->c_iflag;
449 unsigned int old_iflag = old_termios->c_iflag;
450 unsigned int cflag = tty->termios->c_cflag;
451 unsigned int old_cflag = old_termios->c_cflag;
452 struct klsi_105_port_settings *cfg;
453 unsigned long flags;
454 speed_t baud;
455
456 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
457 if (!cfg) {
458 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
459 __func__);
460 return;
461 }
462
463 /* lock while we are modifying the settings */
464 spin_lock_irqsave(&priv->lock, flags);
465
466 /*
467 * Update baud rate
468 */
469 baud = tty_get_baud_rate(tty);
470
471 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
472 /* reassert DTR and (maybe) RTS on transition from B0 */
473 if ((old_cflag & CBAUD) == B0) {
474 dbg("%s: baud was B0", __func__);
475#if 0
476 priv->control_state |= TIOCM_DTR;
477 /* don't set RTS if using hardware flow control */
478 if (!(old_cflag & CRTSCTS))
479 priv->control_state |= TIOCM_RTS;
480 mct_u232_set_modem_ctrl(serial, priv->control_state);
481#endif
482 }
483 }
484 switch (baud) {
485 case 0: /* handled below */
486 break;
487 case 1200:
488 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
489 break;
490 case 2400:
491 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
492 break;
493 case 4800:
494 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
495 break;
496 case 9600:
497 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
498 break;
499 case 19200:
500 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
501 break;
502 case 38400:
503 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
504 break;
505 case 57600:
506 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
507 break;
508 case 115200:
509 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
510 break;
511 default:
512 dbg("KLSI USB->Serial converter:"
513 " unsupported baudrate request, using default of 9600");
514 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
515 baud = 9600;
516 break;
517 }
518 if ((cflag & CBAUD) == B0) {
519 dbg("%s: baud is B0", __func__);
520 /* Drop RTS and DTR */
521 /* maybe this should be simulated by sending read
522 * disable and read enable messages?
523 */
524 ;
525#if 0
526 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
527 mct_u232_set_modem_ctrl(serial, priv->control_state);
528#endif
529 }
530 tty_encode_baud_rate(tty, baud, baud);
531
532 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
533 /* set the number of data bits */
534 switch (cflag & CSIZE) {
535 case CS5:
536 dbg("%s - 5 bits/byte not supported", __func__);
537 spin_unlock_irqrestore(&priv->lock, flags);
538 goto err;
539 case CS6:
540 dbg("%s - 6 bits/byte not supported", __func__);
541 spin_unlock_irqrestore(&priv->lock, flags);
542 goto err;
543 case CS7:
544 priv->cfg.databits = kl5kusb105a_dtb_7;
545 break;
546 case CS8:
547 priv->cfg.databits = kl5kusb105a_dtb_8;
548 break;
549 default:
550 dev_err(&port->dev,
551 "CSIZE was not CS5-CS8, using default of 8\n");
552 priv->cfg.databits = kl5kusb105a_dtb_8;
553 break;
554 }
555 }
556
557 /*
558 * Update line control register (LCR)
559 */
560 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
561 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
562 /* Not currently supported */
563 tty->termios->c_cflag &= ~(PARENB|PARODD|CSTOPB);
564#if 0
565 priv->last_lcr = 0;
566
567 /* set the parity */
568 if (cflag & PARENB)
569 priv->last_lcr |= (cflag & PARODD) ?
570 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
571 else
572 priv->last_lcr |= MCT_U232_PARITY_NONE;
573
574 /* set the number of stop bits */
575 priv->last_lcr |= (cflag & CSTOPB) ?
576 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
577
578 mct_u232_set_line_ctrl(serial, priv->last_lcr);
579#endif
580 ;
581 }
582 /*
583 * Set flow control: well, I do not really now how to handle DTR/RTS.
584 * Just do what we have seen with SniffUSB on Win98.
585 */
586 if ((iflag & IXOFF) != (old_iflag & IXOFF)
587 || (iflag & IXON) != (old_iflag & IXON)
588 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
589 /* Not currently supported */
590 tty->termios->c_cflag &= ~CRTSCTS;
591 /* Drop DTR/RTS if no flow control otherwise assert */
592#if 0
593 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
594 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
595 else
596 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
597 mct_u232_set_modem_ctrl(serial, priv->control_state);
598#endif
599 ;
600 }
601 memcpy(cfg, &priv->cfg, sizeof(*cfg));
602 spin_unlock_irqrestore(&priv->lock, flags);
603
604 /* now commit changes to device */
605 klsi_105_chg_port_settings(port, cfg);
606err:
607 kfree(cfg);
608}
609
610#if 0
611static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
612{
613 struct usb_serial_port *port = tty->driver_data;
614 struct usb_serial *serial = port->serial;
615 struct mct_u232_private *priv =
616 (struct mct_u232_private *)port->private;
617 unsigned char lcr = priv->last_lcr;
618
619 dbg("%sstate=%d", __func__, break_state);
620
621 /* LOCKING */
622 if (break_state)
623 lcr |= MCT_U232_SET_BREAK;
624
625 mct_u232_set_line_ctrl(serial, lcr);
626}
627#endif
628
629static int klsi_105_tiocmget(struct tty_struct *tty)
630{
631 struct usb_serial_port *port = tty->driver_data;
632 struct klsi_105_private *priv = usb_get_serial_port_data(port);
633 unsigned long flags;
634 int rc;
635 unsigned long line_state;
636
637 rc = klsi_105_get_line_state(port, &line_state);
638 if (rc < 0) {
639 dev_err(&port->dev,
640 "Reading line control failed (error = %d)\n", rc);
641 /* better return value? EAGAIN? */
642 return rc;
643 }
644
645 spin_lock_irqsave(&priv->lock, flags);
646 priv->line_state = line_state;
647 spin_unlock_irqrestore(&priv->lock, flags);
648 dbg("%s - read line state 0x%lx", __func__, line_state);
649 return (int)line_state;
650}
651
652static int klsi_105_tiocmset(struct tty_struct *tty,
653 unsigned int set, unsigned int clear)
654{
655 int retval = -EINVAL;
656
657/* if this ever gets implemented, it should be done something like this:
658 struct usb_serial *serial = port->serial;
659 struct klsi_105_private *priv = usb_get_serial_port_data(port);
660 unsigned long flags;
661 int control;
662
663 spin_lock_irqsave (&priv->lock, flags);
664 if (set & TIOCM_RTS)
665 priv->control_state |= TIOCM_RTS;
666 if (set & TIOCM_DTR)
667 priv->control_state |= TIOCM_DTR;
668 if (clear & TIOCM_RTS)
669 priv->control_state &= ~TIOCM_RTS;
670 if (clear & TIOCM_DTR)
671 priv->control_state &= ~TIOCM_DTR;
672 control = priv->control_state;
673 spin_unlock_irqrestore (&priv->lock, flags);
674 retval = mct_u232_set_modem_ctrl(serial, control);
675*/
676 return retval;
677}
678
679module_usb_serial_driver(serial_drivers, id_table);
680
681MODULE_AUTHOR(DRIVER_AUTHOR);
682MODULE_DESCRIPTION(DRIVER_DESC);
683MODULE_LICENSE("GPL");
684
685module_param(debug, bool, S_IRUGO | S_IWUSR);
686MODULE_PARM_DESC(debug, "enable extensive debugging messages");