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