2 * KLSI KL5KUSB105 chip RS232 converter driver
4 * Copyright (C) 2001 Utz-Uwe Haus <haus@uuhaus.de>
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.
11 * All information about the device was acquired using SniffUSB ans snoopUSB
13 * It was written out of frustration with the PalmConnect USB Serial adapter
15 * Neither Palm, nor their contractor (MCCI) or their supplier (KLSI) provided
16 * information that was not already available.
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
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!
33 * check modem line signals
34 * implement handshaking or decide that we do not support it
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
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.
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>
56 #include <asm/uaccess.h>
57 #include <linux/usb.h>
58 #include <linux/usb/serial.h>
59 #include "kl5kusb105.h"
66 #define DRIVER_VERSION "v0.3a"
67 #define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>"
68 #define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
74 static int klsi_105_startup (struct usb_serial
*serial
);
75 static void klsi_105_shutdown (struct usb_serial
*serial
);
76 static int klsi_105_open (struct usb_serial_port
*port
,
78 static void klsi_105_close (struct usb_serial_port
*port
,
80 static int klsi_105_write (struct usb_serial_port
*port
,
81 const unsigned char *buf
,
83 static void klsi_105_write_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
);
84 static int klsi_105_chars_in_buffer (struct usb_serial_port
*port
);
85 static int klsi_105_write_room (struct usb_serial_port
*port
);
87 static void klsi_105_read_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
);
88 static void klsi_105_set_termios (struct usb_serial_port
*port
,
89 struct termios
* old
);
90 static int klsi_105_ioctl (struct usb_serial_port
*port
,
94 static void klsi_105_throttle (struct usb_serial_port
*port
);
95 static void klsi_105_unthrottle (struct usb_serial_port
*port
);
97 static void klsi_105_break_ctl (struct usb_serial_port *port,
100 static int klsi_105_tiocmget (struct usb_serial_port
*port
,
102 static int klsi_105_tiocmset (struct usb_serial_port
*port
,
103 struct file
*file
, unsigned int set
,
107 * All of the device info needed for the KLSI converters.
109 static struct usb_device_id id_table
[] = {
110 { USB_DEVICE(PALMCONNECT_VID
, PALMCONNECT_PID
) },
111 { USB_DEVICE(KLSI_VID
, KLSI_KL5KUSB105D_PID
) },
112 { } /* Terminating entry */
115 MODULE_DEVICE_TABLE (usb
, id_table
);
117 static struct usb_driver kl5kusb105d_driver
= {
118 .name
= "kl5kusb105d",
119 .probe
= usb_serial_probe
,
120 .disconnect
= usb_serial_disconnect
,
121 .id_table
= id_table
,
125 static struct usb_serial_driver kl5kusb105d_device
= {
127 .owner
= THIS_MODULE
,
128 .name
= "kl5kusb105d",
130 .description
= "KL5KUSB105D / PalmConnect",
131 .id_table
= id_table
,
132 .num_interrupt_in
= 1,
136 .open
= klsi_105_open
,
137 .close
= klsi_105_close
,
138 .write
= klsi_105_write
,
139 .write_bulk_callback
= klsi_105_write_bulk_callback
,
140 .chars_in_buffer
= klsi_105_chars_in_buffer
,
141 .write_room
= klsi_105_write_room
,
142 .read_bulk_callback
=klsi_105_read_bulk_callback
,
143 .ioctl
= klsi_105_ioctl
,
144 .set_termios
= klsi_105_set_termios
,
145 /*.break_ctl = klsi_105_break_ctl,*/
146 .tiocmget
= klsi_105_tiocmget
,
147 .tiocmset
= klsi_105_tiocmset
,
148 .attach
= klsi_105_startup
,
149 .shutdown
= klsi_105_shutdown
,
150 .throttle
= klsi_105_throttle
,
151 .unthrottle
= klsi_105_unthrottle
,
154 struct klsi_105_port_settings
{
155 __u8 pktlen
; /* always 5, it seems */
160 } __attribute__ ((packed
));
162 /* we implement a pool of NUM_URBS urbs per usb_serial */
164 #define URB_TRANSFER_BUFFER_SIZE 64
165 struct klsi_105_private
{
166 struct klsi_105_port_settings cfg
;
167 struct termios termios
;
168 unsigned long line_state
; /* modem line settings */
170 struct urb
* write_urb_pool
[NUM_URBS
];
172 unsigned long bytes_in
;
173 unsigned long bytes_out
;
178 * Handle vendor specific USB requests
182 #define KLSI_TIMEOUT 5000 /* default urb timeout */
184 static int klsi_105_chg_port_settings(struct usb_serial_port
*port
,
185 struct klsi_105_port_settings
*settings
)
189 rc
= usb_control_msg(port
->serial
->dev
,
190 usb_sndctrlpipe(port
->serial
->dev
, 0),
191 KL5KUSB105A_SIO_SET_DATA
,
192 USB_TYPE_VENDOR
| USB_DIR_OUT
| USB_RECIP_INTERFACE
,
196 sizeof(struct klsi_105_port_settings
),
199 err("Change port settings failed (error = %d)", rc
);
200 info("%s - %d byte block, baudrate %x, databits %d, u1 %d, u2 %d",
203 settings
->baudrate
, settings
->databits
,
204 settings
->unknown1
, settings
->unknown2
);
206 } /* klsi_105_chg_port_settings */
208 /* translate a 16-bit status value from the device to linux's TIO bits */
209 static unsigned long klsi_105_status2linestate(const __u16 status
)
211 unsigned long res
= 0;
213 res
= ((status
& KL5KUSB105A_DSR
) ? TIOCM_DSR
: 0)
214 | ((status
& KL5KUSB105A_CTS
) ? TIOCM_CTS
: 0)
220 * Read line control via vendor command and return result through
223 /* It seems that the status buffer has always only 2 bytes length */
224 #define KLSI_STATUSBUF_LEN 2
225 static int klsi_105_get_line_state(struct usb_serial_port
*port
,
226 unsigned long *line_state_p
)
229 __u8 status_buf
[KLSI_STATUSBUF_LEN
] = { -1,-1};
232 info("%s - sending SIO Poll request", __FUNCTION__
);
233 rc
= usb_control_msg(port
->serial
->dev
,
234 usb_rcvctrlpipe(port
->serial
->dev
, 0),
235 KL5KUSB105A_SIO_POLL
,
236 USB_TYPE_VENDOR
| USB_DIR_IN
,
239 status_buf
, KLSI_STATUSBUF_LEN
,
243 err("Reading line status failed (error = %d)", rc
);
245 status
= status_buf
[0] + (status_buf
[1]<<8);
247 info("%s - read status %x %x", __FUNCTION__
,
248 status_buf
[0], status_buf
[1]);
250 *line_state_p
= klsi_105_status2linestate(status
);
258 * Driver's tty interface functions
261 static int klsi_105_startup (struct usb_serial
*serial
)
263 struct klsi_105_private
*priv
;
266 /* check if we support the product id (see keyspan.c)
270 /* allocate the private data structure */
271 for (i
=0; i
<serial
->num_ports
; i
++) {
273 priv
= kmalloc(sizeof(struct klsi_105_private
),
276 dbg("%skmalloc for klsi_105_private failed.", __FUNCTION__
);
279 /* set initial values for control structures */
280 priv
->cfg
.pktlen
= 5;
281 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
282 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
283 priv
->cfg
.unknown1
= 0;
284 priv
->cfg
.unknown2
= 1;
286 priv
->line_state
= 0;
290 usb_set_serial_port_data(serial
->port
[i
], priv
);
292 spin_lock_init (&priv
->lock
);
293 for (j
=0; j
<NUM_URBS
; j
++) {
294 struct urb
* urb
= usb_alloc_urb(0, GFP_KERNEL
);
296 priv
->write_urb_pool
[j
] = urb
;
298 err("No more urbs???");
302 urb
->transfer_buffer
= NULL
;
303 urb
->transfer_buffer
= kmalloc (URB_TRANSFER_BUFFER_SIZE
,
305 if (!urb
->transfer_buffer
) {
306 err("%s - out of memory for urb buffers.", __FUNCTION__
);
311 /* priv->termios is left uninitalized until port opening */
312 init_waitqueue_head(&serial
->port
[i
]->write_wait
);
316 } /* klsi_105_startup */
319 static void klsi_105_shutdown (struct usb_serial
*serial
)
323 dbg("%s", __FUNCTION__
);
325 /* stop reads and writes on all ports */
326 for (i
=0; i
< serial
->num_ports
; ++i
) {
327 struct klsi_105_private
*priv
= usb_get_serial_port_data(serial
->port
[i
]);
331 /* kill our write urb pool */
333 struct urb
**write_urbs
= priv
->write_urb_pool
;
334 spin_lock_irqsave(&priv
->lock
,flags
);
336 for (j
= 0; j
< NUM_URBS
; j
++) {
338 /* FIXME - uncomment the following
339 * usb_kill_urb call when the host
340 * controllers get fixed to set
341 * urb->dev = NULL after the urb is
342 * finished. Otherwise this call
344 /* usb_kill_urb(write_urbs[j]); */
345 kfree(write_urbs
[j
]->transfer_buffer
);
346 usb_free_urb (write_urbs
[j
]);
350 spin_unlock_irqrestore (&priv
->lock
, flags
);
353 usb_set_serial_port_data(serial
->port
[i
], NULL
);
356 } /* klsi_105_shutdown */
358 static int klsi_105_open (struct usb_serial_port
*port
, struct file
*filp
)
360 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
364 unsigned long line_state
;
365 struct klsi_105_port_settings cfg
;
368 dbg("%s port %d", __FUNCTION__
, port
->number
);
370 /* force low_latency on so that our tty_push actually forces
372 * port->tty->low_latency = 1; */
374 /* Do a defined restart:
375 * Set up sane default baud rate and send the 'READ_ON'
377 * FIXME: set modem line control (how?)
378 * Then read the modem line control and store values in
382 cfg
.baudrate
= kl5kusb105a_sio_b9600
;
383 cfg
.databits
= kl5kusb105a_dtb_8
;
386 klsi_105_chg_port_settings(port
, &cfg
);
388 /* set up termios structure */
389 spin_lock_irqsave (&priv
->lock
, flags
);
390 priv
->termios
.c_iflag
= port
->tty
->termios
->c_iflag
;
391 priv
->termios
.c_oflag
= port
->tty
->termios
->c_oflag
;
392 priv
->termios
.c_cflag
= port
->tty
->termios
->c_cflag
;
393 priv
->termios
.c_lflag
= port
->tty
->termios
->c_lflag
;
394 for (i
=0; i
<NCCS
; i
++)
395 priv
->termios
.c_cc
[i
] = port
->tty
->termios
->c_cc
[i
];
396 priv
->cfg
.pktlen
= cfg
.pktlen
;
397 priv
->cfg
.baudrate
= cfg
.baudrate
;
398 priv
->cfg
.databits
= cfg
.databits
;
399 priv
->cfg
.unknown1
= cfg
.unknown1
;
400 priv
->cfg
.unknown2
= cfg
.unknown2
;
401 spin_unlock_irqrestore (&priv
->lock
, flags
);
403 /* READ_ON and urb submission */
404 usb_fill_bulk_urb(port
->read_urb
, port
->serial
->dev
,
405 usb_rcvbulkpipe(port
->serial
->dev
,
406 port
->bulk_in_endpointAddress
),
407 port
->read_urb
->transfer_buffer
,
408 port
->read_urb
->transfer_buffer_length
,
409 klsi_105_read_bulk_callback
,
412 rc
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
414 err("%s - failed submitting read urb, error %d", __FUNCTION__
, rc
);
419 rc
= usb_control_msg(port
->serial
->dev
,
420 usb_sndctrlpipe(port
->serial
->dev
,0),
421 KL5KUSB105A_SIO_CONFIGURE
,
422 USB_TYPE_VENDOR
|USB_DIR_OUT
|USB_RECIP_INTERFACE
,
423 KL5KUSB105A_SIO_CONFIGURE_READ_ON
,
429 err("Enabling read failed (error = %d)", rc
);
432 dbg("%s - enabled reading", __FUNCTION__
);
434 rc
= klsi_105_get_line_state(port
, &line_state
);
436 spin_lock_irqsave (&priv
->lock
, flags
);
437 priv
->line_state
= line_state
;
438 spin_unlock_irqrestore (&priv
->lock
, flags
);
439 dbg("%s - read line state 0x%lx", __FUNCTION__
, line_state
);
446 } /* klsi_105_open */
449 static void klsi_105_close (struct usb_serial_port
*port
, struct file
*filp
)
451 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
454 dbg("%s port %d", __FUNCTION__
, port
->number
);
457 rc
= usb_control_msg (port
->serial
->dev
,
458 usb_sndctrlpipe(port
->serial
->dev
, 0),
459 KL5KUSB105A_SIO_CONFIGURE
,
460 USB_TYPE_VENDOR
| USB_DIR_OUT
,
461 KL5KUSB105A_SIO_CONFIGURE_READ_OFF
,
466 err("Disabling read failed (error = %d)", rc
);
468 /* shutdown our bulk reads and writes */
469 usb_kill_urb(port
->write_urb
);
470 usb_kill_urb(port
->read_urb
);
471 /* unlink our write pool */
473 /* wgg - do I need this? I think so. */
474 usb_kill_urb(port
->interrupt_in_urb
);
475 info("kl5kusb105 port stats: %ld bytes in, %ld bytes out", priv
->bytes_in
, priv
->bytes_out
);
476 } /* klsi_105_close */
479 /* We need to write a complete 64-byte data block and encode the
480 * number actually sent in the first double-byte, LSB-order. That
481 * leaves at most 62 bytes of payload.
483 #define KLSI_105_DATA_OFFSET 2 /* in the bulk urb data block */
486 static int klsi_105_write (struct usb_serial_port
*port
,
487 const unsigned char *buf
, int count
)
489 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
493 dbg("%s - port %d", __FUNCTION__
, port
->number
);
496 /* try to find a free urb (write 0 bytes if none) */
497 struct urb
*urb
= NULL
;
500 /* since the pool is per-port we might not need the spin lock !? */
501 spin_lock_irqsave (&priv
->lock
, flags
);
502 for (i
=0; i
<NUM_URBS
; i
++) {
503 if (priv
->write_urb_pool
[i
]->status
!= -EINPROGRESS
) {
504 urb
= priv
->write_urb_pool
[i
];
505 dbg("%s - using pool URB %d", __FUNCTION__
, i
);
509 spin_unlock_irqrestore (&priv
->lock
, flags
);
512 dbg("%s - no more free urbs", __FUNCTION__
);
516 if (urb
->transfer_buffer
== NULL
) {
517 urb
->transfer_buffer
= kmalloc (URB_TRANSFER_BUFFER_SIZE
, GFP_ATOMIC
);
518 if (urb
->transfer_buffer
== NULL
) {
519 err("%s - no more kernel memory...", __FUNCTION__
);
524 size
= min (count
, port
->bulk_out_size
- KLSI_105_DATA_OFFSET
);
525 size
= min (size
, URB_TRANSFER_BUFFER_SIZE
- KLSI_105_DATA_OFFSET
);
527 memcpy (urb
->transfer_buffer
+ KLSI_105_DATA_OFFSET
, buf
, size
);
529 /* write payload size into transfer buffer */
530 ((__u8
*)urb
->transfer_buffer
)[0] = (__u8
) (size
& 0xFF);
531 ((__u8
*)urb
->transfer_buffer
)[1] = (__u8
) ((size
& 0xFF00)>>8);
534 usb_fill_bulk_urb(urb
, port
->serial
->dev
,
535 usb_sndbulkpipe(port
->serial
->dev
,
536 port
->bulk_out_endpointAddress
),
537 urb
->transfer_buffer
,
538 URB_TRANSFER_BUFFER_SIZE
,
539 klsi_105_write_bulk_callback
,
542 /* send the data out the bulk port */
543 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
545 err("%s - failed submitting write urb, error %d", __FUNCTION__
, result
);
553 /* lockless, but it's for debug info only... */
554 priv
->bytes_out
+=bytes_sent
;
556 return bytes_sent
; /* that's how much we wrote */
557 } /* klsi_105_write */
559 static void klsi_105_write_bulk_callback ( struct urb
*urb
, struct pt_regs
*regs
)
561 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
563 dbg("%s - port %d", __FUNCTION__
, port
->number
);
566 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__
,
571 usb_serial_port_softint(port
);
572 } /* klsi_105_write_bulk_completion_callback */
575 /* return number of characters currently in the writing process */
576 static int klsi_105_chars_in_buffer (struct usb_serial_port
*port
)
581 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
583 spin_lock_irqsave (&priv
->lock
, flags
);
585 for (i
= 0; i
< NUM_URBS
; ++i
) {
586 if (priv
->write_urb_pool
[i
]->status
== -EINPROGRESS
) {
587 chars
+= URB_TRANSFER_BUFFER_SIZE
;
591 spin_unlock_irqrestore (&priv
->lock
, flags
);
593 dbg("%s - returns %d", __FUNCTION__
, chars
);
597 static int klsi_105_write_room (struct usb_serial_port
*port
)
602 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
604 spin_lock_irqsave (&priv
->lock
, flags
);
605 for (i
= 0; i
< NUM_URBS
; ++i
) {
606 if (priv
->write_urb_pool
[i
]->status
!= -EINPROGRESS
) {
607 room
+= URB_TRANSFER_BUFFER_SIZE
;
611 spin_unlock_irqrestore (&priv
->lock
, flags
);
613 dbg("%s - returns %d", __FUNCTION__
, room
);
619 static void klsi_105_read_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
)
621 struct usb_serial_port
*port
= (struct usb_serial_port
*)urb
->context
;
622 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
623 struct tty_struct
*tty
;
624 unsigned char *data
= urb
->transfer_buffer
;
627 dbg("%s - port %d", __FUNCTION__
, port
->number
);
629 /* The urb might have been killed. */
631 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__
,
636 /* The data received is again preceded by a length double-byte in LSB-
637 * first order (see klsi_105_write() )
639 if (urb
->actual_length
== 0) {
640 /* empty urbs seem to happen, we ignore them */
641 /* dbg("%s - emtpy URB", __FUNCTION__); */
643 } else if (urb
->actual_length
<= 2) {
644 dbg("%s - size %d URB not understood", __FUNCTION__
,
646 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
,
647 urb
->actual_length
, data
);
649 int bytes_sent
= ((__u8
*) data
)[0] +
650 ((unsigned int) ((__u8
*) data
)[1] << 8);
652 /* we should immediately resubmit the URB, before attempting
653 * to pass the data on to the tty layer. But that needs locking
654 * against re-entry an then mixed-up data because of
655 * intermixed tty_flip_buffer_push()s
658 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
,
659 urb
->actual_length
, data
);
661 if (bytes_sent
+ 2 > urb
->actual_length
) {
662 dbg("%s - trying to read more data than available"
663 " (%d vs. %d)", __FUNCTION__
,
664 bytes_sent
+2, urb
->actual_length
);
665 /* cap at implied limit */
666 bytes_sent
= urb
->actual_length
- 2;
669 tty_buffer_request_room(tty
, bytes_sent
);
670 tty_insert_flip_string(tty
, data
+ 2, bytes_sent
);
671 tty_flip_buffer_push(tty
);
673 /* again lockless, but debug info only */
674 priv
->bytes_in
+= bytes_sent
;
676 /* Continue trying to always read */
677 usb_fill_bulk_urb(port
->read_urb
, port
->serial
->dev
,
678 usb_rcvbulkpipe(port
->serial
->dev
,
679 port
->bulk_in_endpointAddress
),
680 port
->read_urb
->transfer_buffer
,
681 port
->read_urb
->transfer_buffer_length
,
682 klsi_105_read_bulk_callback
,
684 rc
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
686 err("%s - failed resubmitting read urb, error %d", __FUNCTION__
, rc
);
687 } /* klsi_105_read_bulk_callback */
690 static void klsi_105_set_termios (struct usb_serial_port
*port
,
691 struct termios
*old_termios
)
693 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
694 unsigned int iflag
= port
->tty
->termios
->c_iflag
;
695 unsigned int old_iflag
= old_termios
->c_iflag
;
696 unsigned int cflag
= port
->tty
->termios
->c_cflag
;
697 unsigned int old_cflag
= old_termios
->c_cflag
;
698 struct klsi_105_port_settings cfg
;
701 /* lock while we are modifying the settings */
702 spin_lock_irqsave (&priv
->lock
, flags
);
707 if( (cflag
& CBAUD
) != (old_cflag
& CBAUD
) ) {
708 /* reassert DTR and (maybe) RTS on transition from B0 */
709 if( (old_cflag
& CBAUD
) == B0
) {
710 dbg("%s: baud was B0", __FUNCTION__
);
712 priv
->control_state
|= TIOCM_DTR
;
713 /* don't set RTS if using hardware flow control */
714 if (!(old_cflag
& CRTSCTS
)) {
715 priv
->control_state
|= TIOCM_RTS
;
717 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
721 switch(cflag
& CBAUD
) {
722 case B0
: /* handled below */
724 case B1200
: priv
->cfg
.baudrate
= kl5kusb105a_sio_b1200
;
726 case B2400
: priv
->cfg
.baudrate
= kl5kusb105a_sio_b2400
;
728 case B4800
: priv
->cfg
.baudrate
= kl5kusb105a_sio_b4800
;
730 case B9600
: priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
732 case B19200
: priv
->cfg
.baudrate
= kl5kusb105a_sio_b19200
;
734 case B38400
: priv
->cfg
.baudrate
= kl5kusb105a_sio_b38400
;
736 case B57600
: priv
->cfg
.baudrate
= kl5kusb105a_sio_b57600
;
738 case B115200
: priv
->cfg
.baudrate
= kl5kusb105a_sio_b115200
;
741 err("KLSI USB->Serial converter:"
742 " unsupported baudrate request, using default"
744 priv
->cfg
.baudrate
= kl5kusb105a_sio_b9600
;
747 if ((cflag
& CBAUD
) == B0
) {
748 dbg("%s: baud is B0", __FUNCTION__
);
749 /* Drop RTS and DTR */
750 /* maybe this should be simulated by sending read
751 * disable and read enable messages?
755 priv
->control_state
&= ~(TIOCM_DTR
| TIOCM_RTS
);
756 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
761 if ((cflag
& CSIZE
) != (old_cflag
& CSIZE
)) {
762 /* set the number of data bits */
763 switch (cflag
& CSIZE
) {
765 dbg("%s - 5 bits/byte not supported", __FUNCTION__
);
766 spin_unlock_irqrestore (&priv
->lock
, flags
);
769 dbg("%s - 6 bits/byte not supported", __FUNCTION__
);
770 spin_unlock_irqrestore (&priv
->lock
, flags
);
773 priv
->cfg
.databits
= kl5kusb105a_dtb_7
;
776 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
779 err("CSIZE was not CS5-CS8, using default of 8");
780 priv
->cfg
.databits
= kl5kusb105a_dtb_8
;
786 * Update line control register (LCR)
788 if ((cflag
& (PARENB
|PARODD
)) != (old_cflag
& (PARENB
|PARODD
))
789 || (cflag
& CSTOPB
) != (old_cflag
& CSTOPB
) ) {
796 priv
->last_lcr
|= (cflag
& PARODD
) ?
797 MCT_U232_PARITY_ODD
: MCT_U232_PARITY_EVEN
;
799 priv
->last_lcr
|= MCT_U232_PARITY_NONE
;
801 /* set the number of stop bits */
802 priv
->last_lcr
|= (cflag
& CSTOPB
) ?
803 MCT_U232_STOP_BITS_2
: MCT_U232_STOP_BITS_1
;
805 mct_u232_set_line_ctrl(serial
, priv
->last_lcr
);
811 * Set flow control: well, I do not really now how to handle DTR/RTS.
812 * Just do what we have seen with SniffUSB on Win98.
814 if( (iflag
& IXOFF
) != (old_iflag
& IXOFF
)
815 || (iflag
& IXON
) != (old_iflag
& IXON
)
816 || (cflag
& CRTSCTS
) != (old_cflag
& CRTSCTS
) ) {
818 /* Drop DTR/RTS if no flow control otherwise assert */
820 if ((iflag
& IXOFF
) || (iflag
& IXON
) || (cflag
& CRTSCTS
) )
821 priv
->control_state
|= TIOCM_DTR
| TIOCM_RTS
;
823 priv
->control_state
&= ~(TIOCM_DTR
| TIOCM_RTS
);
824 mct_u232_set_modem_ctrl(serial
, priv
->control_state
);
828 memcpy (&cfg
, &priv
->cfg
, sizeof(cfg
));
829 spin_unlock_irqrestore (&priv
->lock
, flags
);
831 /* now commit changes to device */
832 klsi_105_chg_port_settings(port
, &cfg
);
833 } /* klsi_105_set_termios */
837 static void mct_u232_break_ctl( struct usb_serial_port
*port
, int break_state
)
839 struct usb_serial
*serial
= port
->serial
;
840 struct mct_u232_private
*priv
= (struct mct_u232_private
*)port
->private;
841 unsigned char lcr
= priv
->last_lcr
;
843 dbg("%sstate=%d", __FUNCTION__
, break_state
);
846 lcr
|= MCT_U232_SET_BREAK
;
848 mct_u232_set_line_ctrl(serial
, lcr
);
849 } /* mct_u232_break_ctl */
852 static int klsi_105_tiocmget (struct usb_serial_port
*port
, struct file
*file
)
854 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
857 unsigned long line_state
;
858 dbg("%s - request, just guessing", __FUNCTION__
);
860 rc
= klsi_105_get_line_state(port
, &line_state
);
862 err("Reading line control failed (error = %d)", rc
);
863 /* better return value? EAGAIN? */
867 spin_lock_irqsave (&priv
->lock
, flags
);
868 priv
->line_state
= line_state
;
869 spin_unlock_irqrestore (&priv
->lock
, flags
);
870 dbg("%s - read line state 0x%lx", __FUNCTION__
, line_state
);
871 return (int)line_state
;
874 static int klsi_105_tiocmset (struct usb_serial_port
*port
, struct file
*file
,
875 unsigned int set
, unsigned int clear
)
877 int retval
= -EINVAL
;
879 dbg("%s", __FUNCTION__
);
881 /* if this ever gets implemented, it should be done something like this:
882 struct usb_serial *serial = port->serial;
883 struct klsi_105_private *priv = usb_get_serial_port_data(port);
887 spin_lock_irqsave (&priv->lock, flags);
889 priv->control_state |= TIOCM_RTS;
891 priv->control_state |= TIOCM_DTR;
892 if (clear & TIOCM_RTS)
893 priv->control_state &= ~TIOCM_RTS;
894 if (clear & TIOCM_DTR)
895 priv->control_state &= ~TIOCM_DTR;
896 control = priv->control_state;
897 spin_unlock_irqrestore (&priv->lock, flags);
898 retval = mct_u232_set_modem_ctrl(serial, control);
903 static int klsi_105_ioctl (struct usb_serial_port
*port
, struct file
* file
,
904 unsigned int cmd
, unsigned long arg
)
906 struct klsi_105_private
*priv
= usb_get_serial_port_data(port
);
907 void __user
*user_arg
= (void __user
*)arg
;
909 dbg("%scmd=0x%x", __FUNCTION__
, cmd
);
911 /* Based on code from acm.c and others */
914 /* wait for any of the 4 modem inputs (DCD,RI,DSR,CTS)*/
916 dbg("%s - TIOCMIWAIT not handled", __FUNCTION__
);
919 /* return count of modemline transitions */
921 dbg("%s - TIOCGICOUNT not handled", __FUNCTION__
);
924 /* return current info to caller */
925 dbg("%s - TCGETS data faked/incomplete", __FUNCTION__
);
927 if (!access_ok(VERIFY_WRITE
, user_arg
, sizeof(struct termios
)))
930 if (kernel_termios_to_user_termios((struct termios __user
*)arg
,
935 /* set port termios to the one given by the user */
936 dbg("%s - TCSETS not handled", __FUNCTION__
);
938 if (!access_ok(VERIFY_READ
, user_arg
, sizeof(struct termios
)))
941 if (user_termios_to_kernel_termios(&priv
->termios
,
942 (struct termios __user
*)arg
))
944 klsi_105_set_termios(port
, &priv
->termios
);
947 /* set port termios and try to wait for completion of last
949 /* We guess here. If there are not too many write urbs
950 * outstanding, we lie. */
951 /* what is the right way to wait here? schedule() ? */
953 while (klsi_105_chars_in_buffer(port) > (NUM_URBS / 4 ) * URB_TRANSFER_BUFFER_SIZE)
959 dbg("%s: arg not supported - 0x%04x", __FUNCTION__
,cmd
);
960 return(-ENOIOCTLCMD
);
964 } /* klsi_105_ioctl */
966 static void klsi_105_throttle (struct usb_serial_port
*port
)
968 dbg("%s - port %d", __FUNCTION__
, port
->number
);
969 usb_kill_urb(port
->read_urb
);
972 static void klsi_105_unthrottle (struct usb_serial_port
*port
)
976 dbg("%s - port %d", __FUNCTION__
, port
->number
);
978 port
->read_urb
->dev
= port
->serial
->dev
;
979 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
981 err("%s - failed submitting read urb, error %d", __FUNCTION__
,
987 static int __init
klsi_105_init (void)
990 retval
= usb_serial_register(&kl5kusb105d_device
);
992 goto failed_usb_serial_register
;
993 retval
= usb_register(&kl5kusb105d_driver
);
995 goto failed_usb_register
;
997 info(DRIVER_DESC
" " DRIVER_VERSION
);
1000 usb_serial_deregister(&kl5kusb105d_device
);
1001 failed_usb_serial_register
:
1006 static void __exit
klsi_105_exit (void)
1008 usb_deregister (&kl5kusb105d_driver
);
1009 usb_serial_deregister (&kl5kusb105d_device
);
1013 module_init (klsi_105_init
);
1014 module_exit (klsi_105_exit
);
1016 MODULE_AUTHOR( DRIVER_AUTHOR
);
1017 MODULE_DESCRIPTION( DRIVER_DESC
);
1018 MODULE_LICENSE("GPL");
1021 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1022 MODULE_PARM_DESC(debug
, "enable extensive debugging messages");
1024 /* vim: set sts=8 ts=8 sw=8: */