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 <linux/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 .name = "kl5kusb105d",
79 },
80 .description = "KL5KUSB105D / PalmConnect",
81 .id_table = id_table,
82 .num_ports = 1,
83 .bulk_out_size = 64,
84 .open = klsi_105_open,
85 .close = klsi_105_close,
86 .set_termios = klsi_105_set_termios,
87 .tiocmget = klsi_105_tiocmget,
88 .port_probe = klsi_105_port_probe,
89 .port_remove = klsi_105_port_remove,
90 .throttle = usb_serial_generic_throttle,
91 .unthrottle = usb_serial_generic_unthrottle,
92 .process_read_urb = klsi_105_process_read_urb,
93 .prepare_write_buffer = klsi_105_prepare_write_buffer,
94};
95
96static struct usb_serial_driver * const serial_drivers[] = {
97 &kl5kusb105d_device, NULL
98};
99
100struct klsi_105_port_settings {
101 u8 pktlen; /* always 5, it seems */
102 u8 baudrate;
103 u8 databits;
104 u8 unknown1;
105 u8 unknown2;
106};
107
108struct klsi_105_private {
109 struct klsi_105_port_settings cfg;
110 unsigned long line_state; /* modem line settings */
111 spinlock_t lock;
112};
113
114
115/*
116 * Handle vendor specific USB requests
117 */
118
119
120#define KLSI_TIMEOUT 5000 /* default urb timeout */
121
122static int klsi_105_chg_port_settings(struct usb_serial_port *port,
123 struct klsi_105_port_settings *settings)
124{
125 int rc;
126
127 rc = usb_control_msg_send(port->serial->dev,
128 0,
129 KL5KUSB105A_SIO_SET_DATA,
130 USB_TYPE_VENDOR | USB_DIR_OUT |
131 USB_RECIP_INTERFACE,
132 0, /* value */
133 0, /* index */
134 settings,
135 sizeof(struct klsi_105_port_settings),
136 KLSI_TIMEOUT,
137 GFP_KERNEL);
138 if (rc)
139 dev_err(&port->dev,
140 "Change port settings failed (error = %d)\n", rc);
141
142 dev_dbg(&port->dev,
143 "pktlen %u, baudrate 0x%02x, databits %u, u1 %u, u2 %u\n",
144 settings->pktlen, settings->baudrate, settings->databits,
145 settings->unknown1, settings->unknown2);
146
147 return rc;
148}
149
150/*
151 * Read line control via vendor command and return result through
152 * the state pointer.
153 */
154static int klsi_105_get_line_state(struct usb_serial_port *port,
155 unsigned long *state)
156{
157 u16 status;
158 int rc;
159
160 rc = usb_control_msg_recv(port->serial->dev, 0,
161 KL5KUSB105A_SIO_POLL,
162 USB_TYPE_VENDOR | USB_DIR_IN,
163 0, /* value */
164 0, /* index */
165 &status, sizeof(status),
166 10000,
167 GFP_KERNEL);
168 if (rc) {
169 dev_err(&port->dev, "reading line status failed: %d\n", rc);
170 return rc;
171 }
172
173 le16_to_cpus(&status);
174
175 dev_dbg(&port->dev, "read status %04x\n", status);
176
177 *state = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0) |
178 ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0);
179
180 return 0;
181}
182
183
184/*
185 * Driver's tty interface functions
186 */
187
188static int klsi_105_port_probe(struct usb_serial_port *port)
189{
190 struct klsi_105_private *priv;
191
192 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
193 if (!priv)
194 return -ENOMEM;
195
196 /* set initial values for control structures */
197 priv->cfg.pktlen = 5;
198 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
199 priv->cfg.databits = kl5kusb105a_dtb_8;
200 priv->cfg.unknown1 = 0;
201 priv->cfg.unknown2 = 1;
202
203 priv->line_state = 0;
204
205 spin_lock_init(&priv->lock);
206
207 usb_set_serial_port_data(port, priv);
208
209 return 0;
210}
211
212static void klsi_105_port_remove(struct usb_serial_port *port)
213{
214 struct klsi_105_private *priv;
215
216 priv = usb_get_serial_port_data(port);
217 kfree(priv);
218}
219
220static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
221{
222 struct klsi_105_private *priv = usb_get_serial_port_data(port);
223 int retval = 0;
224 int rc;
225 unsigned long line_state;
226 struct klsi_105_port_settings cfg;
227 unsigned long flags;
228
229 /* Do a defined restart:
230 * Set up sane default baud rate and send the 'READ_ON'
231 * vendor command.
232 * FIXME: set modem line control (how?)
233 * Then read the modem line control and store values in
234 * priv->line_state.
235 */
236
237 cfg.pktlen = 5;
238 cfg.baudrate = kl5kusb105a_sio_b9600;
239 cfg.databits = kl5kusb105a_dtb_8;
240 cfg.unknown1 = 0;
241 cfg.unknown2 = 1;
242 klsi_105_chg_port_settings(port, &cfg);
243
244 spin_lock_irqsave(&priv->lock, flags);
245 priv->cfg.pktlen = cfg.pktlen;
246 priv->cfg.baudrate = cfg.baudrate;
247 priv->cfg.databits = cfg.databits;
248 priv->cfg.unknown1 = cfg.unknown1;
249 priv->cfg.unknown2 = cfg.unknown2;
250 spin_unlock_irqrestore(&priv->lock, flags);
251
252 /* READ_ON and urb submission */
253 rc = usb_serial_generic_open(tty, port);
254 if (rc)
255 return rc;
256
257 rc = usb_control_msg(port->serial->dev,
258 usb_sndctrlpipe(port->serial->dev, 0),
259 KL5KUSB105A_SIO_CONFIGURE,
260 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
261 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
262 0, /* index */
263 NULL,
264 0,
265 KLSI_TIMEOUT);
266 if (rc < 0) {
267 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
268 retval = rc;
269 goto err_generic_close;
270 } else
271 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
272
273 rc = klsi_105_get_line_state(port, &line_state);
274 if (rc < 0) {
275 retval = rc;
276 goto err_disable_read;
277 }
278
279 spin_lock_irqsave(&priv->lock, flags);
280 priv->line_state = line_state;
281 spin_unlock_irqrestore(&priv->lock, flags);
282 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__,
283 line_state);
284
285 return 0;
286
287err_disable_read:
288 usb_control_msg(port->serial->dev,
289 usb_sndctrlpipe(port->serial->dev, 0),
290 KL5KUSB105A_SIO_CONFIGURE,
291 USB_TYPE_VENDOR | USB_DIR_OUT,
292 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
293 0, /* index */
294 NULL, 0,
295 KLSI_TIMEOUT);
296err_generic_close:
297 usb_serial_generic_close(port);
298
299 return retval;
300}
301
302static void klsi_105_close(struct usb_serial_port *port)
303{
304 int rc;
305
306 /* send READ_OFF */
307 rc = usb_control_msg(port->serial->dev,
308 usb_sndctrlpipe(port->serial->dev, 0),
309 KL5KUSB105A_SIO_CONFIGURE,
310 USB_TYPE_VENDOR | USB_DIR_OUT,
311 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
312 0, /* index */
313 NULL, 0,
314 KLSI_TIMEOUT);
315 if (rc < 0)
316 dev_err(&port->dev, "failed to disable read: %d\n", rc);
317
318 /* shutdown our bulk reads and writes */
319 usb_serial_generic_close(port);
320}
321
322/* We need to write a complete 64-byte data block and encode the
323 * number actually sent in the first double-byte, LSB-order. That
324 * leaves at most 62 bytes of payload.
325 */
326#define KLSI_HDR_LEN 2
327static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
328 void *dest, size_t size)
329{
330 unsigned char *buf = dest;
331 int count;
332
333 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
334 &port->lock);
335 put_unaligned_le16(count, buf);
336
337 return count + KLSI_HDR_LEN;
338}
339
340/* The data received is preceded by a length double-byte in LSB-first order.
341 */
342static void klsi_105_process_read_urb(struct urb *urb)
343{
344 struct usb_serial_port *port = urb->context;
345 unsigned char *data = urb->transfer_buffer;
346 unsigned len;
347
348 /* empty urbs seem to happen, we ignore them */
349 if (!urb->actual_length)
350 return;
351
352 if (urb->actual_length <= KLSI_HDR_LEN) {
353 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
354 return;
355 }
356
357 len = get_unaligned_le16(data);
358 if (len > urb->actual_length - KLSI_HDR_LEN) {
359 dev_dbg(&port->dev, "%s - packet length mismatch\n", __func__);
360 len = urb->actual_length - KLSI_HDR_LEN;
361 }
362
363 tty_insert_flip_string(&port->port, data + KLSI_HDR_LEN, len);
364 tty_flip_buffer_push(&port->port);
365}
366
367static void klsi_105_set_termios(struct tty_struct *tty,
368 struct usb_serial_port *port,
369 const struct ktermios *old_termios)
370{
371 struct klsi_105_private *priv = usb_get_serial_port_data(port);
372 struct device *dev = &port->dev;
373 unsigned int iflag = tty->termios.c_iflag;
374 unsigned int old_iflag = old_termios->c_iflag;
375 unsigned int cflag = tty->termios.c_cflag;
376 unsigned int old_cflag = old_termios->c_cflag;
377 struct klsi_105_port_settings *cfg;
378 unsigned long flags;
379 speed_t baud;
380
381 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
382 if (!cfg)
383 return;
384
385 /* lock while we are modifying the settings */
386 spin_lock_irqsave(&priv->lock, flags);
387
388 /*
389 * Update baud rate
390 */
391 baud = tty_get_baud_rate(tty);
392
393 switch (baud) {
394 case 0: /* handled below */
395 break;
396 case 1200:
397 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
398 break;
399 case 2400:
400 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
401 break;
402 case 4800:
403 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
404 break;
405 case 9600:
406 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
407 break;
408 case 19200:
409 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
410 break;
411 case 38400:
412 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
413 break;
414 case 57600:
415 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
416 break;
417 case 115200:
418 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
419 break;
420 default:
421 dev_dbg(dev, "unsupported baudrate, using 9600\n");
422 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
423 baud = 9600;
424 break;
425 }
426
427 /*
428 * FIXME: implement B0 handling
429 *
430 * Maybe this should be simulated by sending read disable and read
431 * enable messages?
432 */
433
434 tty_encode_baud_rate(tty, baud, baud);
435
436 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
437 /* set the number of data bits */
438 switch (cflag & CSIZE) {
439 case CS5:
440 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
441 spin_unlock_irqrestore(&priv->lock, flags);
442 goto err;
443 case CS6:
444 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
445 spin_unlock_irqrestore(&priv->lock, flags);
446 goto err;
447 case CS7:
448 priv->cfg.databits = kl5kusb105a_dtb_7;
449 break;
450 case CS8:
451 priv->cfg.databits = kl5kusb105a_dtb_8;
452 break;
453 default:
454 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
455 priv->cfg.databits = kl5kusb105a_dtb_8;
456 break;
457 }
458 }
459
460 /*
461 * Update line control register (LCR)
462 */
463 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
464 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
465 /* Not currently supported */
466 tty->termios.c_cflag &= ~(PARENB|PARODD|CSTOPB);
467 }
468 /*
469 * Set flow control: well, I do not really now how to handle DTR/RTS.
470 * Just do what we have seen with SniffUSB on Win98.
471 */
472 if ((iflag & IXOFF) != (old_iflag & IXOFF)
473 || (iflag & IXON) != (old_iflag & IXON)
474 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
475 /* Not currently supported */
476 tty->termios.c_cflag &= ~CRTSCTS;
477 }
478 memcpy(cfg, &priv->cfg, sizeof(*cfg));
479 spin_unlock_irqrestore(&priv->lock, flags);
480
481 /* now commit changes to device */
482 klsi_105_chg_port_settings(port, cfg);
483err:
484 kfree(cfg);
485}
486
487static int klsi_105_tiocmget(struct tty_struct *tty)
488{
489 struct usb_serial_port *port = tty->driver_data;
490 struct klsi_105_private *priv = usb_get_serial_port_data(port);
491 unsigned long flags;
492 int rc;
493 unsigned long line_state;
494
495 rc = klsi_105_get_line_state(port, &line_state);
496 if (rc < 0) {
497 dev_err(&port->dev,
498 "Reading line control failed (error = %d)\n", rc);
499 /* better return value? EAGAIN? */
500 return rc;
501 }
502
503 spin_lock_irqsave(&priv->lock, flags);
504 priv->line_state = line_state;
505 spin_unlock_irqrestore(&priv->lock, flags);
506 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
507 return (int)line_state;
508}
509
510module_usb_serial_driver(serial_drivers, id_table);
511
512MODULE_AUTHOR(DRIVER_AUTHOR);
513MODULE_DESCRIPTION(DRIVER_DESC);
514MODULE_LICENSE("GPL");
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, struct ktermios *old);
60static int klsi_105_tiocmget(struct tty_struct *tty);
61static void klsi_105_process_read_urb(struct urb *urb);
62static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
63 void *dest, size_t size);
64
65/*
66 * All of the device info needed for the KLSI converters.
67 */
68static const struct usb_device_id id_table[] = {
69 { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
70 { } /* Terminating entry */
71};
72
73MODULE_DEVICE_TABLE(usb, id_table);
74
75static struct usb_serial_driver kl5kusb105d_device = {
76 .driver = {
77 .owner = THIS_MODULE,
78 .name = "kl5kusb105d",
79 },
80 .description = "KL5KUSB105D / PalmConnect",
81 .id_table = id_table,
82 .num_ports = 1,
83 .bulk_out_size = 64,
84 .open = klsi_105_open,
85 .close = klsi_105_close,
86 .set_termios = klsi_105_set_termios,
87 .tiocmget = klsi_105_tiocmget,
88 .port_probe = klsi_105_port_probe,
89 .port_remove = klsi_105_port_remove,
90 .throttle = usb_serial_generic_throttle,
91 .unthrottle = usb_serial_generic_unthrottle,
92 .process_read_urb = klsi_105_process_read_urb,
93 .prepare_write_buffer = klsi_105_prepare_write_buffer,
94};
95
96static struct usb_serial_driver * const serial_drivers[] = {
97 &kl5kusb105d_device, NULL
98};
99
100struct klsi_105_port_settings {
101 u8 pktlen; /* always 5, it seems */
102 u8 baudrate;
103 u8 databits;
104 u8 unknown1;
105 u8 unknown2;
106};
107
108struct klsi_105_private {
109 struct klsi_105_port_settings cfg;
110 unsigned long line_state; /* modem line settings */
111 spinlock_t lock;
112};
113
114
115/*
116 * Handle vendor specific USB requests
117 */
118
119
120#define KLSI_TIMEOUT 5000 /* default urb timeout */
121
122static int klsi_105_chg_port_settings(struct usb_serial_port *port,
123 struct klsi_105_port_settings *settings)
124{
125 int rc;
126
127 rc = usb_control_msg(port->serial->dev,
128 usb_sndctrlpipe(port->serial->dev, 0),
129 KL5KUSB105A_SIO_SET_DATA,
130 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
131 0, /* value */
132 0, /* index */
133 settings,
134 sizeof(struct klsi_105_port_settings),
135 KLSI_TIMEOUT);
136 if (rc < 0)
137 dev_err(&port->dev,
138 "Change port settings failed (error = %d)\n", rc);
139
140 dev_dbg(&port->dev,
141 "pktlen %u, baudrate 0x%02x, databits %u, u1 %u, u2 %u\n",
142 settings->pktlen, settings->baudrate, settings->databits,
143 settings->unknown1, settings->unknown2);
144
145 return rc;
146}
147
148/* translate a 16-bit status value from the device to linux's TIO bits */
149static unsigned long klsi_105_status2linestate(const __u16 status)
150{
151 unsigned long res = 0;
152
153 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
154 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
155 ;
156
157 return res;
158}
159
160/*
161 * Read line control via vendor command and return result through
162 * *line_state_p
163 */
164/* It seems that the status buffer has always only 2 bytes length */
165#define KLSI_STATUSBUF_LEN 2
166static int klsi_105_get_line_state(struct usb_serial_port *port,
167 unsigned long *line_state_p)
168{
169 int rc;
170 u8 *status_buf;
171 __u16 status;
172
173 status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
174 if (!status_buf)
175 return -ENOMEM;
176
177 status_buf[0] = 0xff;
178 status_buf[1] = 0xff;
179 rc = usb_control_msg(port->serial->dev,
180 usb_rcvctrlpipe(port->serial->dev, 0),
181 KL5KUSB105A_SIO_POLL,
182 USB_TYPE_VENDOR | USB_DIR_IN,
183 0, /* value */
184 0, /* index */
185 status_buf, KLSI_STATUSBUF_LEN,
186 10000
187 );
188 if (rc != KLSI_STATUSBUF_LEN) {
189 dev_err(&port->dev, "reading line status failed: %d\n", rc);
190 if (rc >= 0)
191 rc = -EIO;
192 } else {
193 status = get_unaligned_le16(status_buf);
194
195 dev_dbg(&port->dev, "read status %02x %02x\n",
196 status_buf[0], status_buf[1]);
197
198 *line_state_p = klsi_105_status2linestate(status);
199 }
200
201 kfree(status_buf);
202 return rc;
203}
204
205
206/*
207 * Driver's tty interface functions
208 */
209
210static int klsi_105_port_probe(struct usb_serial_port *port)
211{
212 struct klsi_105_private *priv;
213
214 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
215 if (!priv)
216 return -ENOMEM;
217
218 /* set initial values for control structures */
219 priv->cfg.pktlen = 5;
220 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
221 priv->cfg.databits = kl5kusb105a_dtb_8;
222 priv->cfg.unknown1 = 0;
223 priv->cfg.unknown2 = 1;
224
225 priv->line_state = 0;
226
227 spin_lock_init(&priv->lock);
228
229 usb_set_serial_port_data(port, priv);
230
231 return 0;
232}
233
234static void klsi_105_port_remove(struct usb_serial_port *port)
235{
236 struct klsi_105_private *priv;
237
238 priv = usb_get_serial_port_data(port);
239 kfree(priv);
240}
241
242static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
243{
244 struct klsi_105_private *priv = usb_get_serial_port_data(port);
245 int retval = 0;
246 int rc;
247 unsigned long line_state;
248 struct klsi_105_port_settings *cfg;
249 unsigned long flags;
250
251 /* Do a defined restart:
252 * Set up sane default baud rate and send the 'READ_ON'
253 * vendor command.
254 * FIXME: set modem line control (how?)
255 * Then read the modem line control and store values in
256 * priv->line_state.
257 */
258 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
259 if (!cfg)
260 return -ENOMEM;
261
262 cfg->pktlen = 5;
263 cfg->baudrate = kl5kusb105a_sio_b9600;
264 cfg->databits = kl5kusb105a_dtb_8;
265 cfg->unknown1 = 0;
266 cfg->unknown2 = 1;
267 klsi_105_chg_port_settings(port, cfg);
268
269 spin_lock_irqsave(&priv->lock, flags);
270 priv->cfg.pktlen = cfg->pktlen;
271 priv->cfg.baudrate = cfg->baudrate;
272 priv->cfg.databits = cfg->databits;
273 priv->cfg.unknown1 = cfg->unknown1;
274 priv->cfg.unknown2 = cfg->unknown2;
275 spin_unlock_irqrestore(&priv->lock, flags);
276
277 kfree(cfg);
278
279 /* READ_ON and urb submission */
280 rc = usb_serial_generic_open(tty, port);
281 if (rc)
282 return rc;
283
284 rc = usb_control_msg(port->serial->dev,
285 usb_sndctrlpipe(port->serial->dev, 0),
286 KL5KUSB105A_SIO_CONFIGURE,
287 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
288 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
289 0, /* index */
290 NULL,
291 0,
292 KLSI_TIMEOUT);
293 if (rc < 0) {
294 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
295 retval = rc;
296 goto err_generic_close;
297 } else
298 dev_dbg(&port->dev, "%s - enabled reading\n", __func__);
299
300 rc = klsi_105_get_line_state(port, &line_state);
301 if (rc < 0) {
302 retval = rc;
303 goto err_disable_read;
304 }
305
306 spin_lock_irqsave(&priv->lock, flags);
307 priv->line_state = line_state;
308 spin_unlock_irqrestore(&priv->lock, flags);
309 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__,
310 line_state);
311
312 return 0;
313
314err_disable_read:
315 usb_control_msg(port->serial->dev,
316 usb_sndctrlpipe(port->serial->dev, 0),
317 KL5KUSB105A_SIO_CONFIGURE,
318 USB_TYPE_VENDOR | USB_DIR_OUT,
319 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
320 0, /* index */
321 NULL, 0,
322 KLSI_TIMEOUT);
323err_generic_close:
324 usb_serial_generic_close(port);
325
326 return retval;
327}
328
329static void klsi_105_close(struct usb_serial_port *port)
330{
331 int rc;
332
333 /* send READ_OFF */
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,
338 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
339 0, /* index */
340 NULL, 0,
341 KLSI_TIMEOUT);
342 if (rc < 0)
343 dev_err(&port->dev, "failed to disable read: %d\n", rc);
344
345 /* shutdown our bulk reads and writes */
346 usb_serial_generic_close(port);
347}
348
349/* We need to write a complete 64-byte data block and encode the
350 * number actually sent in the first double-byte, LSB-order. That
351 * leaves at most 62 bytes of payload.
352 */
353#define KLSI_HDR_LEN 2
354static int klsi_105_prepare_write_buffer(struct usb_serial_port *port,
355 void *dest, size_t size)
356{
357 unsigned char *buf = dest;
358 int count;
359
360 count = kfifo_out_locked(&port->write_fifo, buf + KLSI_HDR_LEN, size,
361 &port->lock);
362 put_unaligned_le16(count, buf);
363
364 return count + KLSI_HDR_LEN;
365}
366
367/* The data received is preceded by a length double-byte in LSB-first order.
368 */
369static void klsi_105_process_read_urb(struct urb *urb)
370{
371 struct usb_serial_port *port = urb->context;
372 unsigned char *data = urb->transfer_buffer;
373 unsigned len;
374
375 /* empty urbs seem to happen, we ignore them */
376 if (!urb->actual_length)
377 return;
378
379 if (urb->actual_length <= KLSI_HDR_LEN) {
380 dev_dbg(&port->dev, "%s - malformed packet\n", __func__);
381 return;
382 }
383
384 len = get_unaligned_le16(data);
385 if (len > urb->actual_length - KLSI_HDR_LEN) {
386 dev_dbg(&port->dev, "%s - packet length mismatch\n", __func__);
387 len = urb->actual_length - KLSI_HDR_LEN;
388 }
389
390 tty_insert_flip_string(&port->port, data + KLSI_HDR_LEN, len);
391 tty_flip_buffer_push(&port->port);
392}
393
394static void klsi_105_set_termios(struct tty_struct *tty,
395 struct usb_serial_port *port,
396 struct ktermios *old_termios)
397{
398 struct klsi_105_private *priv = usb_get_serial_port_data(port);
399 struct device *dev = &port->dev;
400 unsigned int iflag = tty->termios.c_iflag;
401 unsigned int old_iflag = old_termios->c_iflag;
402 unsigned int cflag = tty->termios.c_cflag;
403 unsigned int old_cflag = old_termios->c_cflag;
404 struct klsi_105_port_settings *cfg;
405 unsigned long flags;
406 speed_t baud;
407
408 cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
409 if (!cfg)
410 return;
411
412 /* lock while we are modifying the settings */
413 spin_lock_irqsave(&priv->lock, flags);
414
415 /*
416 * Update baud rate
417 */
418 baud = tty_get_baud_rate(tty);
419
420 switch (baud) {
421 case 0: /* handled below */
422 break;
423 case 1200:
424 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
425 break;
426 case 2400:
427 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
428 break;
429 case 4800:
430 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
431 break;
432 case 9600:
433 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
434 break;
435 case 19200:
436 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
437 break;
438 case 38400:
439 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
440 break;
441 case 57600:
442 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
443 break;
444 case 115200:
445 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
446 break;
447 default:
448 dev_dbg(dev, "unsupported baudrate, using 9600\n");
449 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
450 baud = 9600;
451 break;
452 }
453
454 /*
455 * FIXME: implement B0 handling
456 *
457 * Maybe this should be simulated by sending read disable and read
458 * enable messages?
459 */
460
461 tty_encode_baud_rate(tty, baud, baud);
462
463 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
464 /* set the number of data bits */
465 switch (cflag & CSIZE) {
466 case CS5:
467 dev_dbg(dev, "%s - 5 bits/byte not supported\n", __func__);
468 spin_unlock_irqrestore(&priv->lock, flags);
469 goto err;
470 case CS6:
471 dev_dbg(dev, "%s - 6 bits/byte not supported\n", __func__);
472 spin_unlock_irqrestore(&priv->lock, flags);
473 goto err;
474 case CS7:
475 priv->cfg.databits = kl5kusb105a_dtb_7;
476 break;
477 case CS8:
478 priv->cfg.databits = kl5kusb105a_dtb_8;
479 break;
480 default:
481 dev_err(dev, "CSIZE was not CS5-CS8, using default of 8\n");
482 priv->cfg.databits = kl5kusb105a_dtb_8;
483 break;
484 }
485 }
486
487 /*
488 * Update line control register (LCR)
489 */
490 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
491 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
492 /* Not currently supported */
493 tty->termios.c_cflag &= ~(PARENB|PARODD|CSTOPB);
494 }
495 /*
496 * Set flow control: well, I do not really now how to handle DTR/RTS.
497 * Just do what we have seen with SniffUSB on Win98.
498 */
499 if ((iflag & IXOFF) != (old_iflag & IXOFF)
500 || (iflag & IXON) != (old_iflag & IXON)
501 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
502 /* Not currently supported */
503 tty->termios.c_cflag &= ~CRTSCTS;
504 }
505 memcpy(cfg, &priv->cfg, sizeof(*cfg));
506 spin_unlock_irqrestore(&priv->lock, flags);
507
508 /* now commit changes to device */
509 klsi_105_chg_port_settings(port, cfg);
510err:
511 kfree(cfg);
512}
513
514static int klsi_105_tiocmget(struct tty_struct *tty)
515{
516 struct usb_serial_port *port = tty->driver_data;
517 struct klsi_105_private *priv = usb_get_serial_port_data(port);
518 unsigned long flags;
519 int rc;
520 unsigned long line_state;
521
522 rc = klsi_105_get_line_state(port, &line_state);
523 if (rc < 0) {
524 dev_err(&port->dev,
525 "Reading line control failed (error = %d)\n", rc);
526 /* better return value? EAGAIN? */
527 return rc;
528 }
529
530 spin_lock_irqsave(&priv->lock, flags);
531 priv->line_state = line_state;
532 spin_unlock_irqrestore(&priv->lock, flags);
533 dev_dbg(&port->dev, "%s - read line state 0x%lx\n", __func__, line_state);
534 return (int)line_state;
535}
536
537module_usb_serial_driver(serial_drivers, id_table);
538
539MODULE_AUTHOR(DRIVER_AUTHOR);
540MODULE_DESCRIPTION(DRIVER_DESC);
541MODULE_LICENSE("GPL");