]> bbs.cooldavid.org Git - net-next-2.6.git/blame - drivers/usb/serial/kl5kusb105.c
trivial: fix typo "to to" in multiple files
[net-next-2.6.git] / drivers / usb / serial / kl5kusb105.c
CommitLineData
1da177e4
LT
1/*
2 * KLSI KL5KUSB105 chip RS232 converter driver
3 *
4 * Copyright (C) 2001 Utz-Uwe Haus <haus@uuhaus.de>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * All information about the device was acquired using SniffUSB ans snoopUSB
12 * on Windows98.
13 * It was written out of frustration with the PalmConnect USB Serial adapter
14 * sold by Palm Inc.
15 * Neither Palm, nor their contractor (MCCI) or their supplier (KLSI) provided
16 * information that was not already available.
17 *
0c265f4e 18 * It seems that KLSI bought some silicon-design information from ScanLogic,
1da177e4
LT
19 * whose SL11R processor is at the core of the KL5KUSB chipset from KLSI.
20 * KLSI has firmware available for their devices; it is probable that the
21 * firmware differs from that used by KLSI in their products. If you have an
0c265f4e
AC
22 * original KLSI device and can provide some information on it, I would be
23 * most interested in adding support for it here. If you have any information
1da177e4
LT
24 * on the protocol used (or find errors in my reverse-engineered stuff), please
25 * let me know.
26 *
27 * The code was only tested with a PalmConnect USB adapter; if you
28 * are adventurous, try it with any KLSI-based device and let me know how it
29 * breaks so that I can fix it!
30 */
31
32/* TODO:
33 * check modem line signals
34 * implement handshaking or decide that we do not support it
35 */
36
37/* History:
38 * 0.3a - implemented pools of write URBs
39 * 0.3 - alpha version for public testing
40 * 0.2 - TIOCMGET works, so autopilot(1) can be used!
fd589a8f 41 * 0.1 - can be used to do pilot-xfer -p /dev/ttyUSB0 -l
1da177e4 42 *
0c265f4e 43 * The driver skeleton is mainly based on mct_u232.c and various other
1da177e4
LT
44 * pieces of code shamelessly copied from the drivers/usb/serial/ directory.
45 */
46
47
1da177e4
LT
48#include <linux/kernel.h>
49#include <linux/errno.h>
50#include <linux/init.h>
51#include <linux/slab.h>
52#include <linux/tty.h>
53#include <linux/tty_driver.h>
54#include <linux/tty_flip.h>
55#include <linux/module.h>
0c265f4e 56#include <linux/uaccess.h>
fd05e720 57#include <asm/unaligned.h>
1da177e4 58#include <linux/usb.h>
a969888c 59#include <linux/usb/serial.h>
1da177e4
LT
60#include "kl5kusb105.h"
61
62static int debug;
63
64/*
65 * Version Information
66 */
67#define DRIVER_VERSION "v0.3a"
68#define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>"
69#define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
70
71
72/*
73 * Function prototypes
74 */
0c265f4e 75static int klsi_105_startup(struct usb_serial *serial);
f9c99bb8
AS
76static void klsi_105_disconnect(struct usb_serial *serial);
77static void klsi_105_release(struct usb_serial *serial);
a509a7e4 78static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
335f8514 79static void klsi_105_close(struct usb_serial_port *port);
0c265f4e
AC
80static int klsi_105_write(struct tty_struct *tty,
81 struct usb_serial_port *port, const unsigned char *buf, int count);
82static void klsi_105_write_bulk_callback(struct urb *urb);
83static int klsi_105_chars_in_buffer(struct tty_struct *tty);
84static int klsi_105_write_room(struct tty_struct *tty);
85static void klsi_105_read_bulk_callback(struct urb *urb);
86static void klsi_105_set_termios(struct tty_struct *tty,
87 struct usb_serial_port *port, struct ktermios *old);
88static void klsi_105_throttle(struct tty_struct *tty);
89static void klsi_105_unthrottle(struct tty_struct *tty);
90static int klsi_105_tiocmget(struct tty_struct *tty, struct file *file);
91static int klsi_105_tiocmset(struct tty_struct *tty, struct file *file,
92 unsigned int set, unsigned int clear);
1da177e4
LT
93
94/*
95 * All of the device info needed for the KLSI converters.
96 */
97static struct usb_device_id id_table [] = {
98 { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
99 { USB_DEVICE(KLSI_VID, KLSI_KL5KUSB105D_PID) },
100 { } /* Terminating entry */
101};
102
0c265f4e 103MODULE_DEVICE_TABLE(usb, id_table);
1da177e4
LT
104
105static struct usb_driver kl5kusb105d_driver = {
1da177e4
LT
106 .name = "kl5kusb105d",
107 .probe = usb_serial_probe,
108 .disconnect = usb_serial_disconnect,
109 .id_table = id_table,
ba9dc657 110 .no_dynamic_id = 1,
1da177e4
LT
111};
112
ea65370d 113static struct usb_serial_driver kl5kusb105d_device = {
18fcac35
GKH
114 .driver = {
115 .owner = THIS_MODULE,
269bda1c 116 .name = "kl5kusb105d",
18fcac35 117 },
269bda1c 118 .description = "KL5KUSB105D / PalmConnect",
d9b1b787 119 .usb_driver = &kl5kusb105d_driver,
1da177e4 120 .id_table = id_table,
1da177e4
LT
121 .num_ports = 1,
122 .open = klsi_105_open,
123 .close = klsi_105_close,
124 .write = klsi_105_write,
125 .write_bulk_callback = klsi_105_write_bulk_callback,
126 .chars_in_buffer = klsi_105_chars_in_buffer,
127 .write_room = klsi_105_write_room,
0c265f4e 128 .read_bulk_callback = klsi_105_read_bulk_callback,
1da177e4
LT
129 .set_termios = klsi_105_set_termios,
130 /*.break_ctl = klsi_105_break_ctl,*/
131 .tiocmget = klsi_105_tiocmget,
132 .tiocmset = klsi_105_tiocmset,
133 .attach = klsi_105_startup,
f9c99bb8
AS
134 .disconnect = klsi_105_disconnect,
135 .release = klsi_105_release,
1da177e4
LT
136 .throttle = klsi_105_throttle,
137 .unthrottle = klsi_105_unthrottle,
138};
139
140struct klsi_105_port_settings {
141 __u8 pktlen; /* always 5, it seems */
142 __u8 baudrate;
143 __u8 databits;
144 __u8 unknown1;
145 __u8 unknown2;
146} __attribute__ ((packed));
147
148/* we implement a pool of NUM_URBS urbs per usb_serial */
149#define NUM_URBS 1
150#define URB_TRANSFER_BUFFER_SIZE 64
151struct klsi_105_private {
152 struct klsi_105_port_settings cfg;
606d099c 153 struct ktermios termios;
1da177e4
LT
154 unsigned long line_state; /* modem line settings */
155 /* write pool */
0c265f4e 156 struct urb *write_urb_pool[NUM_URBS];
1da177e4
LT
157 spinlock_t lock;
158 unsigned long bytes_in;
159 unsigned long bytes_out;
160};
161
162
163/*
164 * Handle vendor specific USB requests
165 */
166
167
168#define KLSI_TIMEOUT 5000 /* default urb timeout */
169
170static int klsi_105_chg_port_settings(struct usb_serial_port *port,
171 struct klsi_105_port_settings *settings)
172{
173 int rc;
174
0c265f4e
AC
175 rc = usb_control_msg(port->serial->dev,
176 usb_sndctrlpipe(port->serial->dev, 0),
177 KL5KUSB105A_SIO_SET_DATA,
178 USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
179 0, /* value */
180 0, /* index */
181 settings,
182 sizeof(struct klsi_105_port_settings),
183 KLSI_TIMEOUT);
1da177e4 184 if (rc < 0)
194343d9
GKH
185 dev_err(&port->dev,
186 "Change port settings failed (error = %d)\n", rc);
c197a8db
GKH
187 dev_info(&port->serial->dev->dev,
188 "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
189 settings->pktlen, settings->baudrate, settings->databits,
190 settings->unknown1, settings->unknown2);
0c265f4e 191 return rc;
1da177e4
LT
192} /* klsi_105_chg_port_settings */
193
194/* translate a 16-bit status value from the device to linux's TIO bits */
195static unsigned long klsi_105_status2linestate(const __u16 status)
196{
197 unsigned long res = 0;
198
199 res = ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
200 | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
201 ;
202
203 return res;
204}
0c265f4e 205/*
1da177e4 206 * Read line control via vendor command and return result through
0c265f4e 207 * *line_state_p
1da177e4
LT
208 */
209/* It seems that the status buffer has always only 2 bytes length */
210#define KLSI_STATUSBUF_LEN 2
211static int klsi_105_get_line_state(struct usb_serial_port *port,
212 unsigned long *line_state_p)
213{
214 int rc;
0c265f4e 215 __u8 status_buf[KLSI_STATUSBUF_LEN] = { -1, -1};
1da177e4
LT
216 __u16 status;
217
c197a8db 218 dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
0c265f4e 219 rc = usb_control_msg(port->serial->dev,
1da177e4
LT
220 usb_rcvctrlpipe(port->serial->dev, 0),
221 KL5KUSB105A_SIO_POLL,
0c265f4e 222 USB_TYPE_VENDOR | USB_DIR_IN,
1da177e4
LT
223 0, /* value */
224 0, /* index */
225 status_buf, KLSI_STATUSBUF_LEN,
226 10000
227 );
228 if (rc < 0)
194343d9
GKH
229 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
230 rc);
1da177e4 231 else {
bd2c7845 232 status = get_unaligned_le16(status_buf);
1da177e4 233
c197a8db
GKH
234 dev_info(&port->serial->dev->dev, "read status %x %x",
235 status_buf[0], status_buf[1]);
1da177e4
LT
236
237 *line_state_p = klsi_105_status2linestate(status);
238 }
0c265f4e 239 return rc;
1da177e4
LT
240}
241
242
243/*
244 * Driver's tty interface functions
245 */
246
0c265f4e 247static int klsi_105_startup(struct usb_serial *serial)
1da177e4
LT
248{
249 struct klsi_105_private *priv;
9306fff1 250 int i, j;
1da177e4
LT
251
252 /* check if we support the product id (see keyspan.c)
253 * FIXME
254 */
255
256 /* allocate the private data structure */
0c265f4e 257 for (i = 0; i < serial->num_ports; i++) {
1da177e4
LT
258 priv = kmalloc(sizeof(struct klsi_105_private),
259 GFP_KERNEL);
260 if (!priv) {
441b62c1 261 dbg("%skmalloc for klsi_105_private failed.", __func__);
9306fff1
ON
262 i--;
263 goto err_cleanup;
1da177e4
LT
264 }
265 /* set initial values for control structures */
266 priv->cfg.pktlen = 5;
267 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
268 priv->cfg.databits = kl5kusb105a_dtb_8;
269 priv->cfg.unknown1 = 0;
270 priv->cfg.unknown2 = 1;
271
272 priv->line_state = 0;
273
274 priv->bytes_in = 0;
275 priv->bytes_out = 0;
276 usb_set_serial_port_data(serial->port[i], priv);
277
0c265f4e
AC
278 spin_lock_init(&priv->lock);
279 for (j = 0; j < NUM_URBS; j++) {
280 struct urb *urb = usb_alloc_urb(0, GFP_KERNEL);
1da177e4
LT
281
282 priv->write_urb_pool[j] = urb;
283 if (urb == NULL) {
194343d9 284 dev_err(&serial->dev->dev, "No more urbs???\n");
9306fff1 285 goto err_cleanup;
1da177e4
LT
286 }
287
0c265f4e
AC
288 urb->transfer_buffer =
289 kmalloc(URB_TRANSFER_BUFFER_SIZE, GFP_KERNEL);
1da177e4 290 if (!urb->transfer_buffer) {
194343d9
GKH
291 dev_err(&serial->dev->dev,
292 "%s - out of memory for urb buffers.\n",
293 __func__);
9306fff1 294 goto err_cleanup;
1da177e4
LT
295 }
296 }
297
298 /* priv->termios is left uninitalized until port opening */
299 init_waitqueue_head(&serial->port[i]->write_wait);
300 }
0c265f4e 301
9306fff1
ON
302 return 0;
303
304err_cleanup:
305 for (; i >= 0; i--) {
306 priv = usb_get_serial_port_data(serial->port[i]);
0c265f4e 307 for (j = 0; j < NUM_URBS; j++) {
9306fff1
ON
308 if (priv->write_urb_pool[j]) {
309 kfree(priv->write_urb_pool[j]->transfer_buffer);
310 usb_free_urb(priv->write_urb_pool[j]);
311 }
312 }
313 usb_set_serial_port_data(serial->port[i], NULL);
314 }
315 return -ENOMEM;
1da177e4
LT
316} /* klsi_105_startup */
317
318
f9c99bb8 319static void klsi_105_disconnect(struct usb_serial *serial)
1da177e4
LT
320{
321 int i;
0c265f4e 322
441b62c1 323 dbg("%s", __func__);
1da177e4
LT
324
325 /* stop reads and writes on all ports */
0c265f4e
AC
326 for (i = 0; i < serial->num_ports; ++i) {
327 struct klsi_105_private *priv =
328 usb_get_serial_port_data(serial->port[i]);
1da177e4
LT
329
330 if (priv) {
331 /* kill our write urb pool */
332 int j;
333 struct urb **write_urbs = priv->write_urb_pool;
1da177e4
LT
334
335 for (j = 0; j < NUM_URBS; j++) {
336 if (write_urbs[j]) {
f9c99bb8 337 usb_kill_urb(write_urbs[j]);
0c265f4e 338 usb_free_urb(write_urbs[j]);
1da177e4
LT
339 }
340 }
1da177e4
LT
341 }
342 }
f9c99bb8
AS
343} /* klsi_105_disconnect */
344
345
346static void klsi_105_release(struct usb_serial *serial)
347{
348 int i;
349
350 dbg("%s", __func__);
351
352 for (i = 0; i < serial->num_ports; ++i) {
353 struct klsi_105_private *priv =
354 usb_get_serial_port_data(serial->port[i]);
355
356 kfree(priv);
357 }
358} /* klsi_105_release */
1da177e4 359
a509a7e4 360static int klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
1da177e4
LT
361{
362 struct klsi_105_private *priv = usb_get_serial_port_data(port);
363 int retval = 0;
364 int rc;
365 int i;
366 unsigned long line_state;
367 struct klsi_105_port_settings cfg;
368 unsigned long flags;
369
441b62c1 370 dbg("%s port %d", __func__, port->number);
1da177e4 371
1da177e4
LT
372 /* Do a defined restart:
373 * Set up sane default baud rate and send the 'READ_ON'
0c265f4e 374 * vendor command.
1da177e4
LT
375 * FIXME: set modem line control (how?)
376 * Then read the modem line control and store values in
377 * priv->line_state.
378 */
379 cfg.pktlen = 5;
380 cfg.baudrate = kl5kusb105a_sio_b9600;
381 cfg.databits = kl5kusb105a_dtb_8;
382 cfg.unknown1 = 0;
383 cfg.unknown2 = 1;
384 klsi_105_chg_port_settings(port, &cfg);
0c265f4e 385
1da177e4 386 /* set up termios structure */
0c265f4e 387 spin_lock_irqsave(&priv->lock, flags);
95da310e
AC
388 priv->termios.c_iflag = tty->termios->c_iflag;
389 priv->termios.c_oflag = tty->termios->c_oflag;
390 priv->termios.c_cflag = tty->termios->c_cflag;
391 priv->termios.c_lflag = tty->termios->c_lflag;
0c265f4e 392 for (i = 0; i < NCCS; i++)
95da310e 393 priv->termios.c_cc[i] = tty->termios->c_cc[i];
1da177e4
LT
394 priv->cfg.pktlen = cfg.pktlen;
395 priv->cfg.baudrate = cfg.baudrate;
396 priv->cfg.databits = cfg.databits;
397 priv->cfg.unknown1 = cfg.unknown1;
398 priv->cfg.unknown2 = cfg.unknown2;
0c265f4e 399 spin_unlock_irqrestore(&priv->lock, flags);
1da177e4
LT
400
401 /* READ_ON and urb submission */
0c265f4e 402 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
1da177e4
LT
403 usb_rcvbulkpipe(port->serial->dev,
404 port->bulk_in_endpointAddress),
405 port->read_urb->transfer_buffer,
406 port->read_urb->transfer_buffer_length,
407 klsi_105_read_bulk_callback,
408 port);
409
410 rc = usb_submit_urb(port->read_urb, GFP_KERNEL);
411 if (rc) {
194343d9
GKH
412 dev_err(&port->dev, "%s - failed submitting read urb, "
413 "error %d\n", __func__, rc);
1da177e4
LT
414 retval = rc;
415 goto exit;
416 }
417
418 rc = usb_control_msg(port->serial->dev,
0c265f4e 419 usb_sndctrlpipe(port->serial->dev, 0),
1da177e4
LT
420 KL5KUSB105A_SIO_CONFIGURE,
421 USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
422 KL5KUSB105A_SIO_CONFIGURE_READ_ON,
423 0, /* index */
424 NULL,
425 0,
426 KLSI_TIMEOUT);
427 if (rc < 0) {
194343d9 428 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
1da177e4 429 retval = rc;
0c265f4e 430 } else
441b62c1 431 dbg("%s - enabled reading", __func__);
1da177e4
LT
432
433 rc = klsi_105_get_line_state(port, &line_state);
434 if (rc >= 0) {
0c265f4e 435 spin_lock_irqsave(&priv->lock, flags);
1da177e4 436 priv->line_state = line_state;
0c265f4e 437 spin_unlock_irqrestore(&priv->lock, flags);
441b62c1 438 dbg("%s - read line state 0x%lx", __func__, line_state);
1da177e4
LT
439 retval = 0;
440 } else
441 retval = rc;
442
443exit:
444 return retval;
445} /* klsi_105_open */
446
447
335f8514 448static void klsi_105_close(struct usb_serial_port *port)
1da177e4
LT
449{
450 struct klsi_105_private *priv = usb_get_serial_port_data(port);
451 int rc;
452
441b62c1 453 dbg("%s port %d", __func__, port->number);
1da177e4 454
3edbc986
ON
455 mutex_lock(&port->serial->disc_mutex);
456 if (!port->serial->disconnected) {
457 /* send READ_OFF */
0c265f4e
AC
458 rc = usb_control_msg(port->serial->dev,
459 usb_sndctrlpipe(port->serial->dev, 0),
460 KL5KUSB105A_SIO_CONFIGURE,
461 USB_TYPE_VENDOR | USB_DIR_OUT,
462 KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
463 0, /* index */
464 NULL, 0,
465 KLSI_TIMEOUT);
3edbc986 466 if (rc < 0)
194343d9
GKH
467 dev_err(&port->dev,
468 "Disabling read failed (error = %d)\n", rc);
3edbc986
ON
469 }
470 mutex_unlock(&port->serial->disc_mutex);
1da177e4
LT
471
472 /* shutdown our bulk reads and writes */
473 usb_kill_urb(port->write_urb);
474 usb_kill_urb(port->read_urb);
475 /* unlink our write pool */
476 /* FIXME */
477 /* wgg - do I need this? I think so. */
478 usb_kill_urb(port->interrupt_in_urb);
c197a8db
GKH
479 dev_info(&port->serial->dev->dev,
480 "port stats: %ld bytes in, %ld bytes out\n",
481 priv->bytes_in, priv->bytes_out);
1da177e4
LT
482} /* klsi_105_close */
483
484
485/* We need to write a complete 64-byte data block and encode the
0c265f4e 486 * number actually sent in the first double-byte, LSB-order. That
1da177e4
LT
487 * leaves at most 62 bytes of payload.
488 */
489#define KLSI_105_DATA_OFFSET 2 /* in the bulk urb data block */
490
491
95da310e
AC
492static int klsi_105_write(struct tty_struct *tty,
493 struct usb_serial_port *port, const unsigned char *buf, int count)
1da177e4
LT
494{
495 struct klsi_105_private *priv = usb_get_serial_port_data(port);
496 int result, size;
0c265f4e 497 int bytes_sent = 0;
1da177e4 498
441b62c1 499 dbg("%s - port %d", __func__, port->number);
1da177e4
LT
500
501 while (count > 0) {
502 /* try to find a free urb (write 0 bytes if none) */
503 struct urb *urb = NULL;
504 unsigned long flags;
505 int i;
0c265f4e
AC
506 /* since the pool is per-port we might not need
507 the spin lock !? */
508 spin_lock_irqsave(&priv->lock, flags);
509 for (i = 0; i < NUM_URBS; i++) {
1da177e4
LT
510 if (priv->write_urb_pool[i]->status != -EINPROGRESS) {
511 urb = priv->write_urb_pool[i];
441b62c1 512 dbg("%s - using pool URB %d", __func__, i);
1da177e4
LT
513 break;
514 }
515 }
0c265f4e 516 spin_unlock_irqrestore(&priv->lock, flags);
1da177e4 517
0c265f4e 518 if (urb == NULL) {
441b62c1 519 dbg("%s - no more free urbs", __func__);
1da177e4
LT
520 goto exit;
521 }
522
523 if (urb->transfer_buffer == NULL) {
0c265f4e
AC
524 urb->transfer_buffer =
525 kmalloc(URB_TRANSFER_BUFFER_SIZE, GFP_ATOMIC);
1da177e4 526 if (urb->transfer_buffer == NULL) {
194343d9
GKH
527 dev_err(&port->dev,
528 "%s - no more kernel memory...\n",
529 __func__);
1da177e4
LT
530 goto exit;
531 }
532 }
533
0c265f4e
AC
534 size = min(count, port->bulk_out_size - KLSI_105_DATA_OFFSET);
535 size = min(size, URB_TRANSFER_BUFFER_SIZE -
536 KLSI_105_DATA_OFFSET);
1da177e4 537
0c265f4e 538 memcpy(urb->transfer_buffer + KLSI_105_DATA_OFFSET, buf, size);
1da177e4
LT
539
540 /* write payload size into transfer buffer */
541 ((__u8 *)urb->transfer_buffer)[0] = (__u8) (size & 0xFF);
542 ((__u8 *)urb->transfer_buffer)[1] = (__u8) ((size & 0xFF00)>>8);
543
544 /* set up our urb */
545 usb_fill_bulk_urb(urb, port->serial->dev,
546 usb_sndbulkpipe(port->serial->dev,
547 port->bulk_out_endpointAddress),
548 urb->transfer_buffer,
549 URB_TRANSFER_BUFFER_SIZE,
550 klsi_105_write_bulk_callback,
551 port);
552
553 /* send the data out the bulk port */
554 result = usb_submit_urb(urb, GFP_ATOMIC);
555 if (result) {
194343d9
GKH
556 dev_err(&port->dev,
557 "%s - failed submitting write urb, error %d\n",
558 __func__, result);
1da177e4
LT
559 goto exit;
560 }
561 buf += size;
562 bytes_sent += size;
563 count -= size;
564 }
565exit:
566 /* lockless, but it's for debug info only... */
0c265f4e 567 priv->bytes_out += bytes_sent;
1da177e4
LT
568
569 return bytes_sent; /* that's how much we wrote */
570} /* klsi_105_write */
571
0c265f4e 572static void klsi_105_write_bulk_callback(struct urb *urb)
1da177e4 573{
cdc97792 574 struct usb_serial_port *port = urb->context;
17c1b35a 575 int status = urb->status;
1da177e4 576
441b62c1 577 dbg("%s - port %d", __func__, port->number);
17c1b35a
GKH
578
579 if (status) {
441b62c1 580 dbg("%s - nonzero write bulk status received: %d", __func__,
17c1b35a 581 status);
1da177e4
LT
582 return;
583 }
584
cf2c7481 585 usb_serial_port_softint(port);
1da177e4
LT
586} /* klsi_105_write_bulk_completion_callback */
587
588
589/* return number of characters currently in the writing process */
0c265f4e 590static int klsi_105_chars_in_buffer(struct tty_struct *tty)
1da177e4 591{
95da310e 592 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
593 int chars = 0;
594 int i;
595 unsigned long flags;
596 struct klsi_105_private *priv = usb_get_serial_port_data(port);
597
0c265f4e 598 spin_lock_irqsave(&priv->lock, flags);
1da177e4
LT
599
600 for (i = 0; i < NUM_URBS; ++i) {
0c265f4e 601 if (priv->write_urb_pool[i]->status == -EINPROGRESS)
1da177e4 602 chars += URB_TRANSFER_BUFFER_SIZE;
1da177e4
LT
603 }
604
0c265f4e 605 spin_unlock_irqrestore(&priv->lock, flags);
1da177e4 606
441b62c1 607 dbg("%s - returns %d", __func__, chars);
0c265f4e 608 return chars;
1da177e4
LT
609}
610
0c265f4e 611static int klsi_105_write_room(struct tty_struct *tty)
1da177e4 612{
95da310e 613 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
614 unsigned long flags;
615 int i;
616 int room = 0;
617 struct klsi_105_private *priv = usb_get_serial_port_data(port);
618
0c265f4e 619 spin_lock_irqsave(&priv->lock, flags);
1da177e4 620 for (i = 0; i < NUM_URBS; ++i) {
0c265f4e 621 if (priv->write_urb_pool[i]->status != -EINPROGRESS)
1da177e4 622 room += URB_TRANSFER_BUFFER_SIZE;
1da177e4
LT
623 }
624
0c265f4e 625 spin_unlock_irqrestore(&priv->lock, flags);
1da177e4 626
441b62c1 627 dbg("%s - returns %d", __func__, room);
0c265f4e 628 return room;
1da177e4
LT
629}
630
631
632
0c265f4e 633static void klsi_105_read_bulk_callback(struct urb *urb)
1da177e4 634{
cdc97792 635 struct usb_serial_port *port = urb->context;
1da177e4
LT
636 struct klsi_105_private *priv = usb_get_serial_port_data(port);
637 struct tty_struct *tty;
638 unsigned char *data = urb->transfer_buffer;
639 int rc;
17c1b35a 640 int status = urb->status;
1da177e4 641
441b62c1 642 dbg("%s - port %d", __func__, port->number);
1da177e4
LT
643
644 /* The urb might have been killed. */
17c1b35a 645 if (status) {
441b62c1 646 dbg("%s - nonzero read bulk status received: %d", __func__,
17c1b35a
GKH
647 status);
648 return;
649 }
650
1da177e4
LT
651 /* The data received is again preceded by a length double-byte in LSB-
652 * first order (see klsi_105_write() )
653 */
654 if (urb->actual_length == 0) {
655 /* empty urbs seem to happen, we ignore them */
441b62c1 656 /* dbg("%s - emtpy URB", __func__); */
1da177e4
LT
657 ;
658 } else if (urb->actual_length <= 2) {
441b62c1 659 dbg("%s - size %d URB not understood", __func__,
1da177e4 660 urb->actual_length);
441b62c1 661 usb_serial_debug_data(debug, &port->dev, __func__,
1da177e4
LT
662 urb->actual_length, data);
663 } else {
1da177e4
LT
664 int bytes_sent = ((__u8 *) data)[0] +
665 ((unsigned int) ((__u8 *) data)[1] << 8);
4a90f09b 666 tty = tty_port_tty_get(&port->port);
1da177e4
LT
667 /* we should immediately resubmit the URB, before attempting
668 * to pass the data on to the tty layer. But that needs locking
669 * against re-entry an then mixed-up data because of
670 * intermixed tty_flip_buffer_push()s
671 * FIXME
0c265f4e 672 */
441b62c1 673 usb_serial_debug_data(debug, &port->dev, __func__,
1da177e4
LT
674 urb->actual_length, data);
675
676 if (bytes_sent + 2 > urb->actual_length) {
677 dbg("%s - trying to read more data than available"
441b62c1 678 " (%d vs. %d)", __func__,
1da177e4
LT
679 bytes_sent+2, urb->actual_length);
680 /* cap at implied limit */
681 bytes_sent = urb->actual_length - 2;
682 }
683
33f0f88f
AC
684 tty_buffer_request_room(tty, bytes_sent);
685 tty_insert_flip_string(tty, data + 2, bytes_sent);
1da177e4 686 tty_flip_buffer_push(tty);
4a90f09b 687 tty_kref_put(tty);
1da177e4
LT
688
689 /* again lockless, but debug info only */
690 priv->bytes_in += bytes_sent;
691 }
692 /* Continue trying to always read */
0c265f4e 693 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
1da177e4
LT
694 usb_rcvbulkpipe(port->serial->dev,
695 port->bulk_in_endpointAddress),
696 port->read_urb->transfer_buffer,
697 port->read_urb->transfer_buffer_length,
698 klsi_105_read_bulk_callback,
699 port);
700 rc = usb_submit_urb(port->read_urb, GFP_ATOMIC);
701 if (rc)
194343d9
GKH
702 dev_err(&port->dev,
703 "%s - failed resubmitting read urb, error %d\n",
704 __func__, rc);
1da177e4
LT
705} /* klsi_105_read_bulk_callback */
706
707
0c265f4e
AC
708static void klsi_105_set_termios(struct tty_struct *tty,
709 struct usb_serial_port *port,
710 struct ktermios *old_termios)
1da177e4
LT
711{
712 struct klsi_105_private *priv = usb_get_serial_port_data(port);
a5b6f60c 713 unsigned int iflag = tty->termios->c_iflag;
1da177e4 714 unsigned int old_iflag = old_termios->c_iflag;
a5b6f60c 715 unsigned int cflag = tty->termios->c_cflag;
1da177e4
LT
716 unsigned int old_cflag = old_termios->c_cflag;
717 struct klsi_105_port_settings cfg;
718 unsigned long flags;
a5b6f60c 719 speed_t baud;
0c265f4e 720
1da177e4 721 /* lock while we are modifying the settings */
0c265f4e
AC
722 spin_lock_irqsave(&priv->lock, flags);
723
1da177e4
LT
724 /*
725 * Update baud rate
726 */
a5b6f60c
AC
727 baud = tty_get_baud_rate(tty);
728
0c265f4e
AC
729 if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
730 /* reassert DTR and (maybe) RTS on transition from B0 */
731 if ((old_cflag & CBAUD) == B0) {
441b62c1 732 dbg("%s: baud was B0", __func__);
1da177e4
LT
733#if 0
734 priv->control_state |= TIOCM_DTR;
735 /* don't set RTS if using hardware flow control */
0c265f4e 736 if (!(old_cflag & CRTSCTS))
1da177e4 737 priv->control_state |= TIOCM_RTS;
1da177e4
LT
738 mct_u232_set_modem_ctrl(serial, priv->control_state);
739#endif
740 }
a5b6f60c 741 }
0c265f4e
AC
742 switch (baud) {
743 case 0: /* handled below */
744 break;
745 case 1200:
746 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
747 break;
748 case 2400:
749 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
750 break;
751 case 4800:
752 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
753 break;
754 case 9600:
755 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
756 break;
757 case 19200:
758 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
759 break;
760 case 38400:
761 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
762 break;
763 case 57600:
764 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
765 break;
766 case 115200:
767 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
768 break;
769 default:
770 dbg("KLSI USB->Serial converter:"
771 " unsupported baudrate request, using default of 9600");
3f6ff6ef 772 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
0c265f4e
AC
773 baud = 9600;
774 break;
a5b6f60c 775 }
0c265f4e 776 if ((cflag & CBAUD) == B0) {
a5b6f60c
AC
777 dbg("%s: baud is B0", __func__);
778 /* Drop RTS and DTR */
779 /* maybe this should be simulated by sending read
780 * disable and read enable messages?
781 */
782 ;
1da177e4 783#if 0
a5b6f60c 784 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
0c265f4e 785 mct_u232_set_modem_ctrl(serial, priv->control_state);
1da177e4 786#endif
1da177e4 787 }
a5b6f60c 788 tty_encode_baud_rate(tty, baud, baud);
1da177e4
LT
789
790 if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
791 /* set the number of data bits */
792 switch (cflag & CSIZE) {
793 case CS5:
441b62c1 794 dbg("%s - 5 bits/byte not supported", __func__);
0c265f4e 795 spin_unlock_irqrestore(&priv->lock, flags);
1da177e4
LT
796 return ;
797 case CS6:
441b62c1 798 dbg("%s - 6 bits/byte not supported", __func__);
0c265f4e 799 spin_unlock_irqrestore(&priv->lock, flags);
1da177e4
LT
800 return ;
801 case CS7:
802 priv->cfg.databits = kl5kusb105a_dtb_7;
803 break;
804 case CS8:
805 priv->cfg.databits = kl5kusb105a_dtb_8;
806 break;
807 default:
194343d9
GKH
808 dev_err(&port->dev,
809 "CSIZE was not CS5-CS8, using default of 8\n");
1da177e4
LT
810 priv->cfg.databits = kl5kusb105a_dtb_8;
811 break;
812 }
813 }
814
815 /*
816 * Update line control register (LCR)
817 */
818 if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
0c265f4e 819 || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
a5b6f60c
AC
820 /* Not currently supported */
821 tty->termios->c_cflag &= ~(PARENB|PARODD|CSTOPB);
1da177e4
LT
822#if 0
823 priv->last_lcr = 0;
824
825 /* set the parity */
826 if (cflag & PARENB)
827 priv->last_lcr |= (cflag & PARODD) ?
828 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
829 else
830 priv->last_lcr |= MCT_U232_PARITY_NONE;
831
832 /* set the number of stop bits */
833 priv->last_lcr |= (cflag & CSTOPB) ?
834 MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
835
836 mct_u232_set_line_ctrl(serial, priv->last_lcr);
837#endif
838 ;
839 }
1da177e4
LT
840 /*
841 * Set flow control: well, I do not really now how to handle DTR/RTS.
842 * Just do what we have seen with SniffUSB on Win98.
843 */
0c265f4e 844 if ((iflag & IXOFF) != (old_iflag & IXOFF)
1da177e4 845 || (iflag & IXON) != (old_iflag & IXON)
0c265f4e 846 || (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
a5b6f60c
AC
847 /* Not currently supported */
848 tty->termios->c_cflag &= ~CRTSCTS;
1da177e4
LT
849 /* Drop DTR/RTS if no flow control otherwise assert */
850#if 0
0c265f4e 851 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
1da177e4
LT
852 priv->control_state |= TIOCM_DTR | TIOCM_RTS;
853 else
854 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
855 mct_u232_set_modem_ctrl(serial, priv->control_state);
856#endif
857 ;
858 }
0c265f4e
AC
859 memcpy(&cfg, &priv->cfg, sizeof(cfg));
860 spin_unlock_irqrestore(&priv->lock, flags);
861
1da177e4
LT
862 /* now commit changes to device */
863 klsi_105_chg_port_settings(port, &cfg);
864} /* klsi_105_set_termios */
865
866
867#if 0
0c265f4e 868static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
1da177e4 869{
95da310e 870 struct usb_serial_port *port = tty->driver_data;
1da177e4 871 struct usb_serial *serial = port->serial;
0c265f4e
AC
872 struct mct_u232_private *priv =
873 (struct mct_u232_private *)port->private;
1da177e4
LT
874 unsigned char lcr = priv->last_lcr;
875
441b62c1 876 dbg("%sstate=%d", __func__, break_state);
1da177e4 877
6b447f04 878 /* LOCKING */
1da177e4
LT
879 if (break_state)
880 lcr |= MCT_U232_SET_BREAK;
881
882 mct_u232_set_line_ctrl(serial, lcr);
883} /* mct_u232_break_ctl */
884#endif
885
0c265f4e 886static int klsi_105_tiocmget(struct tty_struct *tty, struct file *file)
1da177e4 887{
95da310e 888 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
889 struct klsi_105_private *priv = usb_get_serial_port_data(port);
890 unsigned long flags;
891 int rc;
892 unsigned long line_state;
441b62c1 893 dbg("%s - request, just guessing", __func__);
1da177e4
LT
894
895 rc = klsi_105_get_line_state(port, &line_state);
896 if (rc < 0) {
194343d9
GKH
897 dev_err(&port->dev,
898 "Reading line control failed (error = %d)\n", rc);
1da177e4
LT
899 /* better return value? EAGAIN? */
900 return rc;
901 }
902
0c265f4e 903 spin_lock_irqsave(&priv->lock, flags);
1da177e4 904 priv->line_state = line_state;
0c265f4e 905 spin_unlock_irqrestore(&priv->lock, flags);
441b62c1 906 dbg("%s - read line state 0x%lx", __func__, line_state);
1da177e4
LT
907 return (int)line_state;
908}
909
0c265f4e
AC
910static int klsi_105_tiocmset(struct tty_struct *tty, struct file *file,
911 unsigned int set, unsigned int clear)
1da177e4
LT
912{
913 int retval = -EINVAL;
0c265f4e 914
441b62c1 915 dbg("%s", __func__);
1da177e4
LT
916
917/* if this ever gets implemented, it should be done something like this:
918 struct usb_serial *serial = port->serial;
919 struct klsi_105_private *priv = usb_get_serial_port_data(port);
920 unsigned long flags;
921 int control;
922
923 spin_lock_irqsave (&priv->lock, flags);
924 if (set & TIOCM_RTS)
925 priv->control_state |= TIOCM_RTS;
926 if (set & TIOCM_DTR)
927 priv->control_state |= TIOCM_DTR;
928 if (clear & TIOCM_RTS)
929 priv->control_state &= ~TIOCM_RTS;
930 if (clear & TIOCM_DTR)
931 priv->control_state &= ~TIOCM_DTR;
932 control = priv->control_state;
933 spin_unlock_irqrestore (&priv->lock, flags);
934 retval = mct_u232_set_modem_ctrl(serial, control);
935*/
936 return retval;
937}
1da177e4 938
0c265f4e 939static void klsi_105_throttle(struct tty_struct *tty)
1da177e4 940{
95da310e 941 struct usb_serial_port *port = tty->driver_data;
441b62c1 942 dbg("%s - port %d", __func__, port->number);
1da177e4
LT
943 usb_kill_urb(port->read_urb);
944}
945
0c265f4e 946static void klsi_105_unthrottle(struct tty_struct *tty)
1da177e4 947{
95da310e 948 struct usb_serial_port *port = tty->driver_data;
1da177e4
LT
949 int result;
950
441b62c1 951 dbg("%s - port %d", __func__, port->number);
1da177e4
LT
952
953 port->read_urb->dev = port->serial->dev;
954 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
955 if (result)
194343d9
GKH
956 dev_err(&port->dev,
957 "%s - failed submitting read urb, error %d\n",
958 __func__, result);
1da177e4
LT
959}
960
961
962
0c265f4e 963static int __init klsi_105_init(void)
1da177e4
LT
964{
965 int retval;
966 retval = usb_serial_register(&kl5kusb105d_device);
967 if (retval)
968 goto failed_usb_serial_register;
969 retval = usb_register(&kl5kusb105d_driver);
970 if (retval)
971 goto failed_usb_register;
972
c197a8db
GKH
973 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
974 DRIVER_DESC "\n");
1da177e4
LT
975 return 0;
976failed_usb_register:
977 usb_serial_deregister(&kl5kusb105d_device);
978failed_usb_serial_register:
979 return retval;
980}
981
982
0c265f4e 983static void __exit klsi_105_exit(void)
1da177e4 984{
0c265f4e
AC
985 usb_deregister(&kl5kusb105d_driver);
986 usb_serial_deregister(&kl5kusb105d_device);
1da177e4
LT
987}
988
989
0c265f4e
AC
990module_init(klsi_105_init);
991module_exit(klsi_105_exit);
1da177e4 992
0c265f4e
AC
993MODULE_AUTHOR(DRIVER_AUTHOR);
994MODULE_DESCRIPTION(DRIVER_DESC);
995MODULE_LICENSE("GPL");
1da177e4
LT
996
997
998module_param(debug, bool, S_IRUGO | S_IWUSR);
999MODULE_PARM_DESC(debug, "enable extensive debugging messages");
1000
1001/* vim: set sts=8 ts=8 sw=8: */