2 * Ours Technology Inc. OTi-6858 USB to serial adapter driver.
4 * Copyleft (C) 2007 Kees Lemmens (adapted for kernel 2.6.20)
5 * Copyright (C) 2006 Tomasz Michal Lukaszewski (FIXME: add e-mail)
6 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
7 * Copyright (C) 2003 IBM Corp.
9 * Many thanks to the authors of pl2303 driver: all functions in this file
10 * are heavily based on pl2303 code, buffering code is a 1-to-1 copy.
12 * Warning! You use this driver on your own risk! The only official
13 * description of this device I have is datasheet from manufacturer,
14 * and it doesn't contain almost any information needed to write a driver.
15 * Almost all knowlegde used while writing this driver was gathered by:
16 * - analyzing traffic between device and the M$ Windows 2000 driver,
17 * - trying different bit combinations and checking pin states
19 * - receiving malformed frames and producing buffer overflows
20 * to learn how errors are reported,
21 * So, THIS CODE CAN DESTROY OTi-6858 AND ANY OTHER DEVICES, THAT ARE
24 * This program is free software; you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation; either version 2 of the License.
28 * See Documentation/usb/usb-serial.txt for more information on using this driver
31 * - implement correct flushing for ioctls and oti6858_close()
32 * - check how errors (rx overflow, parity error, framing error) are reported
33 * - implement oti6858_break_ctl()
34 * - implement more ioctls
35 * - test/implement flow control
36 * - allow setting custom baud rates
39 #include <linux/kernel.h>
40 #include <linux/errno.h>
41 #include <linux/init.h>
42 #include <linux/slab.h>
43 #include <linux/tty.h>
44 #include <linux/tty_driver.h>
45 #include <linux/tty_flip.h>
46 #include <linux/serial.h>
47 #include <linux/module.h>
48 #include <linux/moduleparam.h>
49 #include <linux/spinlock.h>
50 #include <linux/usb.h>
51 #include <linux/usb/serial.h>
52 #include <asm/uaccess.h>
55 #define OTI6858_DESCRIPTION \
56 "Ours Technology Inc. OTi-6858 USB to serial adapter driver"
57 #define OTI6858_AUTHOR "Tomasz Michal Lukaszewski <FIXME@FIXME>"
58 #define OTI6858_VERSION "0.1"
60 static struct usb_device_id id_table
[] = {
61 { USB_DEVICE(OTI6858_VENDOR_ID
, OTI6858_PRODUCT_ID
) },
65 MODULE_DEVICE_TABLE(usb
, id_table
);
67 static struct usb_driver oti6858_driver
= {
69 .probe
= usb_serial_probe
,
70 .disconnect
= usb_serial_disconnect
,
78 /* buffering code, copied from pl2303 driver */
79 #define PL2303_BUF_SIZE 1024
80 #define PL2303_TMP_BUF_SIZE 1024
83 unsigned int buf_size
;
90 #define OTI6858_REQ_GET_STATUS (USB_DIR_IN | USB_TYPE_VENDOR | 0x00)
91 #define OTI6858_REQ_T_GET_STATUS 0x01
93 #define OTI6858_REQ_SET_LINE (USB_DIR_OUT | USB_TYPE_VENDOR | 0x00)
94 #define OTI6858_REQ_T_SET_LINE 0x00
96 #define OTI6858_REQ_CHECK_TXBUFF (USB_DIR_IN | USB_TYPE_VENDOR | 0x01)
97 #define OTI6858_REQ_T_CHECK_TXBUFF 0x00
99 /* format of the control packet */
100 struct oti6858_control_pkt
{
101 u16 divisor
; /* baud rate = 96000000 / (16 * divisor), LE */
102 #define OTI6858_MAX_BAUD_RATE 3000000
104 #define FMT_STOP_BITS_MASK 0xc0
105 #define FMT_STOP_BITS_1 0x00
106 #define FMT_STOP_BITS_2 0x40 /* 1.5 stop bits if FMT_DATA_BITS_5 */
107 #define FMT_PARITY_MASK 0x38
108 #define FMT_PARITY_NONE 0x00
109 #define FMT_PARITY_ODD 0x08
110 #define FMT_PARITY_EVEN 0x18
111 #define FMT_PARITY_MARK 0x28
112 #define FMT_PARITY_SPACE 0x38
113 #define FMT_DATA_BITS_MASK 0x03
114 #define FMT_DATA_BITS_5 0x00
115 #define FMT_DATA_BITS_6 0x01
116 #define FMT_DATA_BITS_7 0x02
117 #define FMT_DATA_BITS_8 0x03
118 u8 something
; /* always equals 0x43 */
119 u8 control
; /* settings of flow control lines */
120 #define CONTROL_MASK 0x0c
121 #define CONTROL_DTR_HIGH 0x08
122 #define CONTROL_RTS_HIGH 0x04
124 #define TX_BUFFER_EMPTIED 0x09
126 #define PIN_MASK 0x3f
127 #define PIN_RTS 0x20 /* output pin */
128 #define PIN_CTS 0x10 /* input pin, active low */
129 #define PIN_DSR 0x08 /* input pin, active low */
130 #define PIN_DTR 0x04 /* output pin */
131 #define PIN_RI 0x02 /* input pin, active low */
132 #define PIN_DCD 0x01 /* input pin, active low */
133 u8 rx_bytes_avail
; /* number of bytes in rx buffer */;
136 #define OTI6858_CTRL_PKT_SIZE sizeof(struct oti6858_control_pkt)
137 #define OTI6858_CTRL_EQUALS_PENDING(a, priv) \
138 ( ((a)->divisor == (priv)->pending_setup.divisor) \
139 && ((a)->control == (priv)->pending_setup.control) \
140 && ((a)->frame_fmt == (priv)->pending_setup.frame_fmt) )
142 /* function prototypes */
143 static int oti6858_open(struct usb_serial_port
*port
, struct file
*filp
);
144 static void oti6858_close(struct usb_serial_port
*port
, struct file
*filp
);
145 static void oti6858_set_termios(struct usb_serial_port
*port
,
146 struct ktermios
*old
);
147 static int oti6858_ioctl(struct usb_serial_port
*port
, struct file
*file
,
148 unsigned int cmd
, unsigned long arg
);
149 static void oti6858_read_int_callback(struct urb
*urb
);
150 static void oti6858_read_bulk_callback(struct urb
*urb
);
151 static void oti6858_write_bulk_callback(struct urb
*urb
);
152 static int oti6858_write(struct usb_serial_port
*port
,
153 const unsigned char *buf
, int count
);
154 static int oti6858_write_room(struct usb_serial_port
*port
);
155 static void oti6858_break_ctl(struct usb_serial_port
*port
, int break_state
);
156 static int oti6858_chars_in_buffer(struct usb_serial_port
*port
);
157 static int oti6858_tiocmget(struct usb_serial_port
*port
, struct file
*file
);
158 static int oti6858_tiocmset(struct usb_serial_port
*port
, struct file
*file
,
159 unsigned int set
, unsigned int clear
);
160 static int oti6858_startup(struct usb_serial
*serial
);
161 static void oti6858_shutdown(struct usb_serial
*serial
);
163 /* functions operating on buffers */
164 static struct pl2303_buf
*pl2303_buf_alloc(unsigned int size
);
165 static void pl2303_buf_free(struct pl2303_buf
*pb
);
166 static void pl2303_buf_clear(struct pl2303_buf
*pb
);
167 static unsigned int pl2303_buf_data_avail(struct pl2303_buf
*pb
);
168 static unsigned int pl2303_buf_space_avail(struct pl2303_buf
*pb
);
169 static unsigned int pl2303_buf_put(struct pl2303_buf
*pb
, const char *buf
,
171 static unsigned int pl2303_buf_get(struct pl2303_buf
*pb
, char *buf
,
176 static struct usb_serial_driver oti6858_device
= {
178 .owner
= THIS_MODULE
,
181 .id_table
= id_table
,
182 .num_interrupt_in
= 1,
186 .open
= oti6858_open
,
187 .close
= oti6858_close
,
188 .write
= oti6858_write
,
189 .ioctl
= oti6858_ioctl
,
190 .break_ctl
= oti6858_break_ctl
,
191 .set_termios
= oti6858_set_termios
,
192 .tiocmget
= oti6858_tiocmget
,
193 .tiocmset
= oti6858_tiocmset
,
194 .read_bulk_callback
= oti6858_read_bulk_callback
,
195 .read_int_callback
= oti6858_read_int_callback
,
196 .write_bulk_callback
= oti6858_write_bulk_callback
,
197 .write_room
= oti6858_write_room
,
198 .chars_in_buffer
= oti6858_chars_in_buffer
,
199 .attach
= oti6858_startup
,
200 .shutdown
= oti6858_shutdown
,
203 struct oti6858_private
{
206 struct pl2303_buf
*buf
;
207 struct oti6858_control_pkt status
;
212 u8 termios_initialized
;
214 struct delayed_work delayed_write_work
;
223 struct delayed_work delayed_setup_work
;
225 wait_queue_head_t intr_wait
;
226 struct usb_serial_port
*port
; /* USB port with which associated */
230 /* #define dbg(format, arg...) printk(KERN_INFO "%s: " format "\n", __FILE__, ## arg) */
231 #define dbg(format, arg...) printk(KERN_INFO "" format "\n", ## arg)
233 static void setup_line(struct work_struct
*work
)
235 struct oti6858_private
*priv
= container_of(work
, struct oti6858_private
, delayed_setup_work
.work
);
236 struct usb_serial_port
*port
= priv
->port
;
237 struct oti6858_control_pkt
*new_setup
;
241 dbg("%s(port = %d)", __FUNCTION__
, port
->number
);
243 if ((new_setup
= kmalloc(OTI6858_CTRL_PKT_SIZE
, GFP_KERNEL
)) == NULL
) {
244 dev_err(&port
->dev
, "%s(): out of memory!\n", __FUNCTION__
);
245 /* we will try again */
246 schedule_delayed_work(&priv
->delayed_setup_work
, msecs_to_jiffies(2));
250 result
= usb_control_msg(port
->serial
->dev
,
251 usb_rcvctrlpipe(port
->serial
->dev
, 0),
252 OTI6858_REQ_T_GET_STATUS
,
253 OTI6858_REQ_GET_STATUS
,
255 new_setup
, OTI6858_CTRL_PKT_SIZE
,
258 if (result
!= OTI6858_CTRL_PKT_SIZE
) {
259 dev_err(&port
->dev
, "%s(): error reading status", __FUNCTION__
);
261 /* we will try again */
262 schedule_delayed_work(&priv
->delayed_setup_work
, msecs_to_jiffies(2));
266 spin_lock_irqsave(&priv
->lock
, flags
);
267 if (!OTI6858_CTRL_EQUALS_PENDING(new_setup
, priv
)) {
268 new_setup
->divisor
= priv
->pending_setup
.divisor
;
269 new_setup
->control
= priv
->pending_setup
.control
;
270 new_setup
->frame_fmt
= priv
->pending_setup
.frame_fmt
;
272 spin_unlock_irqrestore(&priv
->lock
, flags
);
273 result
= usb_control_msg(port
->serial
->dev
,
274 usb_sndctrlpipe(port
->serial
->dev
, 0),
275 OTI6858_REQ_T_SET_LINE
,
276 OTI6858_REQ_SET_LINE
,
278 new_setup
, OTI6858_CTRL_PKT_SIZE
,
281 spin_unlock_irqrestore(&priv
->lock
, flags
);
286 spin_lock_irqsave(&priv
->lock
, flags
);
287 if (result
!= OTI6858_CTRL_PKT_SIZE
)
289 priv
->setup_done
= 1;
290 spin_unlock_irqrestore(&priv
->lock
, flags
);
292 dbg("%s(): submitting interrupt urb", __FUNCTION__
);
293 port
->interrupt_in_urb
->dev
= port
->serial
->dev
;
294 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
296 dev_err(&port
->dev
, "%s(): usb_submit_urb() failed"
297 " with error %d\n", __FUNCTION__
, result
);
301 void send_data(struct work_struct
*work
)
303 struct oti6858_private
*priv
= container_of(work
, struct oti6858_private
, delayed_write_work
.work
);
304 struct usb_serial_port
*port
= priv
->port
;
305 int count
= 0, result
;
309 dbg("%s(port = %d)", __FUNCTION__
, port
->number
);
311 spin_lock_irqsave(&priv
->lock
, flags
);
312 if (priv
->flags
.write_urb_in_use
) {
313 spin_unlock_irqrestore(&priv
->lock
, flags
);
314 schedule_delayed_work(&priv
->delayed_write_work
, msecs_to_jiffies(2));
317 priv
->flags
.write_urb_in_use
= 1;
319 count
= pl2303_buf_data_avail(priv
->buf
);
320 spin_unlock_irqrestore(&priv
->lock
, flags
);
321 if (count
> port
->bulk_out_size
)
322 count
= port
->bulk_out_size
;
325 result
= usb_control_msg(port
->serial
->dev
,
326 usb_rcvctrlpipe(port
->serial
->dev
, 0),
327 OTI6858_REQ_T_CHECK_TXBUFF
,
328 OTI6858_REQ_CHECK_TXBUFF
,
329 count
, 0, &allow
, 1, 100);
330 if (result
!= 1 || allow
!= 0)
335 priv
->flags
.write_urb_in_use
= 0;
337 dbg("%s(): submitting interrupt urb", __FUNCTION__
);
338 port
->interrupt_in_urb
->dev
= port
->serial
->dev
;
339 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
341 dev_err(&port
->dev
, "%s(): usb_submit_urb() failed"
342 " with error %d\n", __FUNCTION__
, result
);
347 spin_lock_irqsave(&priv
->lock
, flags
);
348 pl2303_buf_get(priv
->buf
, port
->write_urb
->transfer_buffer
, count
);
349 spin_unlock_irqrestore(&priv
->lock
, flags
);
351 port
->write_urb
->transfer_buffer_length
= count
;
352 port
->write_urb
->dev
= port
->serial
->dev
;
353 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
355 dev_err(&port
->dev
, "%s(): usb_submit_urb() failed"
356 " with error %d\n", __FUNCTION__
, result
);
357 priv
->flags
.write_urb_in_use
= 0;
360 usb_serial_port_softint(port
);
363 static int oti6858_startup(struct usb_serial
*serial
)
365 struct usb_serial_port
*port
= serial
->port
[0];
366 struct oti6858_private
*priv
;
369 for (i
= 0; i
< serial
->num_ports
; ++i
) {
370 priv
= kzalloc(sizeof(struct oti6858_private
), GFP_KERNEL
);
373 priv
->buf
= pl2303_buf_alloc(PL2303_BUF_SIZE
);
374 if (priv
->buf
== NULL
) {
379 spin_lock_init(&priv
->lock
);
380 init_waitqueue_head(&priv
->intr_wait
);
381 // INIT_WORK(&priv->setup_work, setup_line, serial->port[i]);
382 // INIT_WORK(&priv->write_work, send_data, serial->port[i]);
384 INIT_DELAYED_WORK(&priv
->delayed_setup_work
, setup_line
);
385 INIT_DELAYED_WORK(&priv
->delayed_write_work
, send_data
);
387 usb_set_serial_port_data(serial
->port
[i
], priv
);
389 if (i
== serial
->num_ports
)
392 for (--i
; i
>= 0; --i
) {
393 priv
= usb_get_serial_port_data(serial
->port
[i
]);
394 pl2303_buf_free(priv
->buf
);
396 usb_set_serial_port_data(serial
->port
[i
], NULL
);
401 static int oti6858_write(struct usb_serial_port
*port
,
402 const unsigned char *buf
, int count
)
404 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
407 dbg("%s(port = %d, count = %d)", __FUNCTION__
, port
->number
, count
);
412 spin_lock_irqsave(&priv
->lock
, flags
);
413 count
= pl2303_buf_put(priv
->buf
, buf
, count
);
414 spin_unlock_irqrestore(&priv
->lock
, flags
);
419 static int oti6858_write_room(struct usb_serial_port
*port
)
421 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
425 dbg("%s(port = %d)", __FUNCTION__
, port
->number
);
427 spin_lock_irqsave(&priv
->lock
, flags
);
428 room
= pl2303_buf_space_avail(priv
->buf
);
429 spin_unlock_irqrestore(&priv
->lock
, flags
);
434 static int oti6858_chars_in_buffer(struct usb_serial_port
*port
)
436 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
440 dbg("%s(port = %d)", __FUNCTION__
, port
->number
);
442 spin_lock_irqsave(&priv
->lock
, flags
);
443 chars
= pl2303_buf_data_avail(priv
->buf
);
444 spin_unlock_irqrestore(&priv
->lock
, flags
);
449 static void oti6858_set_termios(struct usb_serial_port
*port
,
450 struct ktermios
*old_termios
)
452 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
455 u8 frame_fmt
, control
;
459 dbg("%s(port = %d)", __FUNCTION__
, port
->number
);
461 if ((!port
->tty
) || (!port
->tty
->termios
)) {
462 dbg("%s(): no tty structures", __FUNCTION__
);
466 spin_lock_irqsave(&priv
->lock
, flags
);
467 if (!priv
->flags
.termios_initialized
) {
468 *(port
->tty
->termios
) = tty_std_termios
;
469 port
->tty
->termios
->c_cflag
= B38400
| CS8
| CREAD
| HUPCL
| CLOCAL
;
470 priv
->flags
.termios_initialized
= 1;
472 spin_unlock_irqrestore(&priv
->lock
, flags
);
474 cflag
= port
->tty
->termios
->c_cflag
;
476 spin_lock_irqsave(&priv
->lock
, flags
);
477 divisor
= priv
->pending_setup
.divisor
;
478 frame_fmt
= priv
->pending_setup
.frame_fmt
;
479 control
= priv
->pending_setup
.control
;
480 spin_unlock_irqrestore(&priv
->lock
, flags
);
482 frame_fmt
&= ~FMT_DATA_BITS_MASK
;
483 switch (cflag
& CSIZE
) {
485 frame_fmt
|= FMT_DATA_BITS_5
;
488 frame_fmt
|= FMT_DATA_BITS_6
;
491 frame_fmt
|= FMT_DATA_BITS_7
;
495 frame_fmt
|= FMT_DATA_BITS_8
;
499 /* manufacturer claims that this device can work with baud rates
500 * up to 3 Mbps; I've tested it only on 115200 bps, so I can't
501 * guarantee that any other baud rate will work (especially
504 br
= tty_get_baud_rate(port
->tty
);
507 } else if (br
<= OTI6858_MAX_BAUD_RATE
) {
510 divisor
= (96000000 + 8 * br
) / (16 * br
);
511 real_br
= 96000000 / (16 * divisor
);
512 if ((((real_br
- br
) * 100 + br
- 1) / br
) > 2) {
513 dbg("%s(): baud rate %d is invalid", __FUNCTION__
, br
);
516 divisor
= cpu_to_le16(divisor
);
518 dbg("%s(): baud rate %d is too high", __FUNCTION__
, br
);
522 frame_fmt
&= ~FMT_STOP_BITS_MASK
;
523 if ((cflag
& CSTOPB
) != 0) {
524 frame_fmt
|= FMT_STOP_BITS_2
;
526 frame_fmt
|= FMT_STOP_BITS_1
;
529 frame_fmt
&= ~FMT_PARITY_MASK
;
530 if ((cflag
& PARENB
) != 0) {
531 if ((cflag
& PARODD
) != 0) {
532 frame_fmt
|= FMT_PARITY_ODD
;
534 frame_fmt
|= FMT_PARITY_EVEN
;
537 frame_fmt
|= FMT_PARITY_NONE
;
540 control
&= ~CONTROL_MASK
;
541 if ((cflag
& CRTSCTS
) != 0)
542 control
|= (CONTROL_DTR_HIGH
| CONTROL_RTS_HIGH
);
544 /* change control lines if we are switching to or from B0 */
546 spin_lock_irqsave(&priv->lock, flags);
547 control = priv->line_control;
548 if ((cflag & CBAUD) == B0)
549 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
551 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
552 if (control != priv->line_control) {
553 control = priv->line_control;
554 spin_unlock_irqrestore(&priv->lock, flags);
555 set_control_lines(serial->dev, control);
557 spin_unlock_irqrestore(&priv->lock, flags);
561 spin_lock_irqsave(&priv
->lock
, flags
);
562 if (divisor
!= priv
->pending_setup
.divisor
563 || control
!= priv
->pending_setup
.control
564 || frame_fmt
!= priv
->pending_setup
.frame_fmt
) {
565 priv
->pending_setup
.divisor
= divisor
;
566 priv
->pending_setup
.control
= control
;
567 priv
->pending_setup
.frame_fmt
= frame_fmt
;
569 spin_unlock_irqrestore(&priv
->lock
, flags
);
572 static int oti6858_open(struct usb_serial_port
*port
, struct file
*filp
)
574 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
575 struct ktermios tmp_termios
;
576 struct usb_serial
*serial
= port
->serial
;
577 struct oti6858_control_pkt
*buf
;
581 dbg("%s(port = %d)", __FUNCTION__
, port
->number
);
583 usb_clear_halt(serial
->dev
, port
->write_urb
->pipe
);
584 usb_clear_halt(serial
->dev
, port
->read_urb
->pipe
);
586 if (port
->open_count
!= 1)
589 if ((buf
= kmalloc(OTI6858_CTRL_PKT_SIZE
, GFP_KERNEL
)) == NULL
) {
590 dev_err(&port
->dev
, "%s(): out of memory!\n", __FUNCTION__
);
594 result
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
595 OTI6858_REQ_T_GET_STATUS
,
596 OTI6858_REQ_GET_STATUS
,
598 buf
, OTI6858_CTRL_PKT_SIZE
,
600 if (result
!= OTI6858_CTRL_PKT_SIZE
) {
601 /* assume default (after power-on reset) values */
602 buf
->divisor
= cpu_to_le16(0x009c); /* 38400 bps */
603 buf
->frame_fmt
= 0x03; /* 8N1 */
604 buf
->something
= 0x43;
605 buf
->control
= 0x4c; /* DTR, RTS */
606 buf
->tx_status
= 0x00;
607 buf
->pin_state
= 0x5b; /* RTS, CTS, DSR, DTR, RI, DCD */
608 buf
->rx_bytes_avail
= 0x00;
611 spin_lock_irqsave(&priv
->lock
, flags
);
612 memcpy(&priv
->status
, buf
, OTI6858_CTRL_PKT_SIZE
);
613 priv
->pending_setup
.divisor
= buf
->divisor
;
614 priv
->pending_setup
.frame_fmt
= buf
->frame_fmt
;
615 priv
->pending_setup
.control
= buf
->control
;
616 spin_unlock_irqrestore(&priv
->lock
, flags
);
619 dbg("%s(): submitting interrupt urb", __FUNCTION__
);
620 port
->interrupt_in_urb
->dev
= serial
->dev
;
621 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
623 dev_err(&port
->dev
, "%s(): usb_submit_urb() failed"
624 " with error %d\n", __FUNCTION__
, result
);
625 oti6858_close(port
, NULL
);
631 oti6858_set_termios(port
, &tmp_termios
);
636 static void oti6858_close(struct usb_serial_port
*port
, struct file
*filp
)
638 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
643 dbg("%s(port = %d)", __FUNCTION__
, port
->number
);
645 /* wait for data to drain from the buffer */
646 spin_lock_irqsave(&priv
->lock
, flags
);
647 timeout
= 30 * HZ
; /* PL2303_CLOSING_WAIT */
648 init_waitqueue_entry(&wait
, current
);
649 add_wait_queue(&port
->tty
->write_wait
, &wait
);
650 dbg("%s(): entering wait loop", __FUNCTION__
);
652 set_current_state(TASK_INTERRUPTIBLE
);
653 if (pl2303_buf_data_avail(priv
->buf
) == 0
654 || timeout
== 0 || signal_pending(current
)
655 || !usb_get_intfdata(port
->serial
->interface
)) /* disconnect */
657 spin_unlock_irqrestore(&priv
->lock
, flags
);
658 timeout
= schedule_timeout(timeout
);
659 spin_lock_irqsave(&priv
->lock
, flags
);
661 set_current_state(TASK_RUNNING
);
662 remove_wait_queue(&port
->tty
->write_wait
, &wait
);
663 dbg("%s(): after wait loop", __FUNCTION__
);
665 /* clear out any remaining data in the buffer */
666 pl2303_buf_clear(priv
->buf
);
667 spin_unlock_irqrestore(&priv
->lock
, flags
);
669 /* wait for characters to drain from the device */
670 /* (this is long enough for the entire 256 byte */
671 /* pl2303 hardware buffer to drain with no flow */
672 /* control for data rates of 1200 bps or more, */
673 /* for lower rates we should really know how much */
674 /* data is in the buffer to compute a delay */
675 /* that is not unnecessarily long) */
677 bps = tty_get_baud_rate(port->tty);
679 timeout = max((HZ*2560)/bps,HZ/10);
683 schedule_timeout_interruptible(timeout
);
684 dbg("%s(): after schedule_timeout_interruptible()", __FUNCTION__
);
686 /* cancel scheduled setup */
687 cancel_delayed_work(&priv
->delayed_setup_work
);
688 cancel_delayed_work(&priv
->delayed_write_work
);
689 flush_scheduled_work();
691 /* shutdown our urbs */
692 dbg("%s(): shutting down urbs", __FUNCTION__
);
693 usb_kill_urb(port
->write_urb
);
694 usb_kill_urb(port
->read_urb
);
695 usb_kill_urb(port
->interrupt_in_urb
);
698 if (port->tty && (port->tty->termios->c_cflag) & HUPCL) {
700 spin_lock_irqsave(&priv->lock, flags);
701 priv->pending_setup.control &= ~CONTROL_MASK;
702 spin_unlock_irqrestore(&priv->lock, flags);
707 static int oti6858_tiocmset(struct usb_serial_port
*port
, struct file
*file
,
708 unsigned int set
, unsigned int clear
)
710 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
714 dbg("%s(port = %d, set = 0x%08x, clear = 0x%08x)",
715 __FUNCTION__
, port
->number
, set
, clear
);
717 if (!usb_get_intfdata(port
->serial
->interface
))
720 /* FIXME: check if this is correct (active high/low) */
721 spin_lock_irqsave(&priv
->lock
, flags
);
722 control
= priv
->pending_setup
.control
;
723 if ((set
& TIOCM_RTS
) != 0)
724 control
|= CONTROL_RTS_HIGH
;
725 if ((set
& TIOCM_DTR
) != 0)
726 control
|= CONTROL_DTR_HIGH
;
727 if ((clear
& TIOCM_RTS
) != 0)
728 control
&= ~CONTROL_RTS_HIGH
;
729 if ((clear
& TIOCM_DTR
) != 0)
730 control
&= ~CONTROL_DTR_HIGH
;
732 if (control
!= priv
->pending_setup
.control
) {
733 priv
->pending_setup
.control
= control
;
735 spin_unlock_irqrestore(&priv
->lock
, flags
);
740 static int oti6858_tiocmget(struct usb_serial_port
*port
, struct file
*file
)
742 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
747 dbg("%s(port = %d)", __FUNCTION__
, port
->number
);
749 if (!usb_get_intfdata(port
->serial
->interface
))
752 spin_lock_irqsave(&priv
->lock
, flags
);
753 pin_state
= priv
->status
.pin_state
& PIN_MASK
;
754 spin_unlock_irqrestore(&priv
->lock
, flags
);
756 /* FIXME: check if this is correct (active high/low) */
757 if ((pin_state
& PIN_RTS
) != 0)
759 if ((pin_state
& PIN_CTS
) != 0)
761 if ((pin_state
& PIN_DSR
) != 0)
763 if ((pin_state
& PIN_DTR
) != 0)
765 if ((pin_state
& PIN_RI
) != 0)
767 if ((pin_state
& PIN_DCD
) != 0)
770 dbg("%s() = 0x%08x", __FUNCTION__
, result
);
775 static int wait_modem_info(struct usb_serial_port
*port
, unsigned int arg
)
777 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
779 unsigned int prev
, status
;
780 unsigned int changed
;
782 spin_lock_irqsave(&priv
->lock
, flags
);
783 prev
= priv
->status
.pin_state
;
784 spin_unlock_irqrestore(&priv
->lock
, flags
);
787 wait_event_interruptible(priv
->intr_wait
, priv
->status
.pin_state
!= prev
);
788 if (signal_pending(current
))
791 spin_lock_irqsave(&priv
->lock
, flags
);
792 status
= priv
->status
.pin_state
& PIN_MASK
;
793 spin_unlock_irqrestore(&priv
->lock
, flags
);
795 changed
= prev
^ status
;
796 /* FIXME: check if this is correct (active high/low) */
797 if ( ((arg
& TIOCM_RNG
) && (changed
& PIN_RI
)) ||
798 ((arg
& TIOCM_DSR
) && (changed
& PIN_DSR
)) ||
799 ((arg
& TIOCM_CD
) && (changed
& PIN_DCD
)) ||
800 ((arg
& TIOCM_CTS
) && (changed
& PIN_CTS
))) {
810 static int oti6858_ioctl(struct usb_serial_port
*port
, struct file
*file
,
811 unsigned int cmd
, unsigned long arg
)
813 void __user
*user_arg
= (void __user
*) arg
;
816 dbg("%s(port = %d, cmd = 0x%04x, arg = 0x%08lx)",
817 __FUNCTION__
, port
->number
, cmd
, arg
);
825 if (copy_from_user(&x
, user_arg
, sizeof(x
)))
827 return oti6858_tiocmset(port
, NULL
, x
, 0);
830 if (copy_from_user(&x
, user_arg
, sizeof(x
)))
832 return oti6858_tiocmset(port
, NULL
, 0, x
);
835 if (copy_to_user(user_arg
, port
->tty
->termios
,
836 sizeof(struct ktermios
))) {
842 if (copy_from_user(port
->tty
->termios
, user_arg
,
843 sizeof(struct ktermios
))) {
846 oti6858_set_termios(port
, NULL
);
850 dbg("%s(): TIOCMIWAIT", __FUNCTION__
);
851 return wait_modem_info(port
, arg
);
854 dbg("%s(): 0x%04x not supported", __FUNCTION__
, cmd
);
861 static void oti6858_break_ctl(struct usb_serial_port
*port
, int break_state
)
865 dbg("%s(port = %d)", __FUNCTION__
, port
->number
);
867 state
= (break_state
== 0) ? 0 : 1;
868 dbg("%s(): turning break %s", __FUNCTION__
, state
? "on" : "off");
872 result = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
873 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
876 dbg("%s(): error sending break", __FUNCTION__);
880 static void oti6858_shutdown(struct usb_serial
*serial
)
882 struct oti6858_private
*priv
;
885 dbg("%s()", __FUNCTION__
);
887 for (i
= 0; i
< serial
->num_ports
; ++i
) {
888 priv
= usb_get_serial_port_data(serial
->port
[i
]);
890 pl2303_buf_free(priv
->buf
);
892 usb_set_serial_port_data(serial
->port
[i
], NULL
);
897 static void oti6858_read_int_callback(struct urb
*urb
)
899 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
900 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
901 int transient
= 0, can_recv
= 0, resubmit
= 1;
902 int status
= urb
->status
;
904 dbg("%s(port = %d, status = %d)",
905 __FUNCTION__
, port
->number
, status
);
914 /* this urb is terminated, clean up */
915 dbg("%s(): urb shutting down with status: %d",
916 __FUNCTION__
, status
);
919 dbg("%s(): nonzero urb status received: %d",
920 __FUNCTION__
, status
);
924 if (status
== 0 && urb
->actual_length
== OTI6858_CTRL_PKT_SIZE
) {
925 struct oti6858_control_pkt
*xs
= urb
->transfer_buffer
;
928 spin_lock_irqsave(&priv
->lock
, flags
);
930 if (!priv
->transient
) {
931 if (!OTI6858_CTRL_EQUALS_PENDING(xs
, priv
)) {
932 if (xs
->rx_bytes_avail
== 0) {
934 priv
->setup_done
= 0;
936 dbg("%s(): scheduling setup_line()",
938 schedule_delayed_work(&priv
->delayed_setup_work
, 0);
942 if (OTI6858_CTRL_EQUALS_PENDING(xs
, priv
)) {
944 } else if (!priv
->setup_done
) {
946 } else if (--priv
->transient
== 0) {
947 if (xs
->rx_bytes_avail
== 0) {
949 priv
->setup_done
= 0;
951 dbg("%s(): scheduling setup_line()",
953 schedule_delayed_work(&priv
->delayed_setup_work
, 0);
958 if (!priv
->transient
) {
959 if (xs
->pin_state
!= priv
->status
.pin_state
)
960 wake_up_interruptible(&priv
->intr_wait
);
961 memcpy(&priv
->status
, xs
, OTI6858_CTRL_PKT_SIZE
);
964 if (!priv
->transient
&& xs
->rx_bytes_avail
!= 0) {
965 can_recv
= xs
->rx_bytes_avail
;
966 priv
->flags
.read_urb_in_use
= 1;
969 transient
= priv
->transient
;
970 spin_unlock_irqrestore(&priv
->lock
, flags
);
976 port
->read_urb
->dev
= port
->serial
->dev
;
977 result
= usb_submit_urb(port
->read_urb
, GFP_ATOMIC
);
979 priv
->flags
.read_urb_in_use
= 0;
980 dev_err(&port
->dev
, "%s(): usb_submit_urb() failed,"
981 " error %d\n", __FUNCTION__
, result
);
985 } else if (!transient
) {
988 spin_lock_irqsave(&priv
->lock
, flags
);
989 if (priv
->flags
.write_urb_in_use
== 0
990 && pl2303_buf_data_avail(priv
->buf
) != 0) {
991 schedule_delayed_work(&priv
->delayed_write_work
,0);
994 spin_unlock_irqrestore(&priv
->lock
, flags
);
1000 // dbg("%s(): submitting interrupt urb", __FUNCTION__);
1001 urb
->dev
= port
->serial
->dev
;
1002 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
1004 dev_err(&urb
->dev
->dev
,
1005 "%s(): usb_submit_urb() failed with"
1006 " error %d\n", __FUNCTION__
, result
);
1011 static void oti6858_read_bulk_callback(struct urb
*urb
)
1013 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
1014 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
1015 struct tty_struct
*tty
;
1016 unsigned char *data
= urb
->transfer_buffer
;
1017 unsigned long flags
;
1019 int status
= urb
->status
;
1022 dbg("%s(port = %d, status = %d)",
1023 __FUNCTION__
, port
->number
, status
);
1025 spin_lock_irqsave(&priv
->lock
, flags
);
1026 priv
->flags
.read_urb_in_use
= 0;
1027 spin_unlock_irqrestore(&priv
->lock
, flags
);
1030 if (!port
->open_count
) {
1031 dbg("%s(): port is closed, exiting", __FUNCTION__
);
1035 if (status == -EPROTO) {
1036 // PL2303 mysteriously fails with -EPROTO reschedule the read
1037 dbg("%s - caught -EPROTO, resubmitting the urb", __FUNCTION__);
1038 result = usb_submit_urb(urb, GFP_ATOMIC);
1040 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
1044 dbg("%s(): unable to handle the error, exiting", __FUNCTION__
);
1048 // get tty_flag from status
1049 tty_flag
= TTY_NORMAL
;
1051 /* FIXME: probably, errors will be signalled using interrupt pipe! */
1053 // break takes precedence over parity,
1054 // which takes precedence over framing errors
1055 if (status & UART_BREAK_ERROR )
1056 tty_flag = TTY_BREAK;
1057 else if (status & UART_PARITY_ERROR)
1058 tty_flag = TTY_PARITY;
1059 else if (status & UART_FRAME_ERROR)
1060 tty_flag = TTY_FRAME;
1061 dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
1065 if (tty
!= NULL
&& urb
->actual_length
> 0) {
1066 tty_buffer_request_room(tty
, urb
->actual_length
);
1067 for (i
= 0; i
< urb
->actual_length
; ++i
)
1068 tty_insert_flip_char(tty
, data
[i
], tty_flag
);
1069 tty_flip_buffer_push(tty
);
1072 // schedule the interrupt urb if we are still open */
1073 if (port
->open_count
!= 0) {
1074 port
->interrupt_in_urb
->dev
= port
->serial
->dev
;
1075 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
1077 dev_err(&port
->dev
, "%s(): usb_submit_urb() failed,"
1078 " error %d\n", __FUNCTION__
, result
);
1083 static void oti6858_write_bulk_callback(struct urb
*urb
)
1085 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
1086 struct oti6858_private
*priv
= usb_get_serial_port_data(port
);
1087 int status
= urb
->status
;
1090 dbg("%s(port = %d, status = %d)",
1091 __FUNCTION__
, port
->number
, status
);
1100 /* this urb is terminated, clean up */
1101 dbg("%s(): urb shutting down with status: %d",
1102 __FUNCTION__
, status
);
1103 priv
->flags
.write_urb_in_use
= 0;
1106 /* error in the urb, so we have to resubmit it */
1107 dbg("%s(): nonzero write bulk status received: %d",
1108 __FUNCTION__
, status
);
1109 dbg("%s(): overflow in write", __FUNCTION__
);
1111 port
->write_urb
->transfer_buffer_length
= 1;
1112 port
->write_urb
->dev
= port
->serial
->dev
;
1113 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
1115 dev_err(&port
->dev
, "%s(): usb_submit_urb() failed,"
1116 " error %d\n", __FUNCTION__
, result
);
1122 priv
->flags
.write_urb_in_use
= 0;
1124 // schedule the interrupt urb if we are still open */
1125 port
->interrupt_in_urb
->dev
= port
->serial
->dev
;
1126 dbg("%s(): submitting interrupt urb", __FUNCTION__
);
1127 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
1129 dev_err(&port
->dev
, "%s(): failed submitting int urb,"
1130 " error %d\n", __FUNCTION__
, result
);
1138 * Allocate a circular buffer and all associated memory.
1140 static struct pl2303_buf
*pl2303_buf_alloc(unsigned int size
)
1142 struct pl2303_buf
*pb
;
1147 pb
= kmalloc(sizeof(struct pl2303_buf
), GFP_KERNEL
);
1151 pb
->buf_buf
= kmalloc(size
, GFP_KERNEL
);
1152 if (pb
->buf_buf
== NULL
) {
1157 pb
->buf_size
= size
;
1158 pb
->buf_get
= pb
->buf_put
= pb
->buf_buf
;
1166 * Free the buffer and all associated memory.
1168 static void pl2303_buf_free(struct pl2303_buf
*pb
)
1179 * Clear out all data in the circular buffer.
1181 static void pl2303_buf_clear(struct pl2303_buf
*pb
)
1184 /* equivalent to a get of all data available */
1185 pb
->buf_get
= pb
->buf_put
;
1190 * pl2303_buf_data_avail
1192 * Return the number of bytes of data available in the circular
1195 static unsigned int pl2303_buf_data_avail(struct pl2303_buf
*pb
)
1199 return ((pb
->buf_size
+ pb
->buf_put
- pb
->buf_get
) % pb
->buf_size
);
1203 * pl2303_buf_space_avail
1205 * Return the number of bytes of space available in the circular
1208 static unsigned int pl2303_buf_space_avail(struct pl2303_buf
*pb
)
1212 return ((pb
->buf_size
+ pb
->buf_get
- pb
->buf_put
- 1) % pb
->buf_size
);
1218 * Copy data data from a user buffer and put it into the circular buffer.
1219 * Restrict to the amount of space available.
1221 * Return the number of bytes copied.
1223 static unsigned int pl2303_buf_put(struct pl2303_buf
*pb
, const char *buf
,
1231 len
= pl2303_buf_space_avail(pb
);
1238 len
= pb
->buf_buf
+ pb
->buf_size
- pb
->buf_put
;
1240 memcpy(pb
->buf_put
, buf
, len
);
1241 memcpy(pb
->buf_buf
, buf
+len
, count
- len
);
1242 pb
->buf_put
= pb
->buf_buf
+ count
- len
;
1244 memcpy(pb
->buf_put
, buf
, count
);
1246 pb
->buf_put
+= count
;
1247 else /* count == len */
1248 pb
->buf_put
= pb
->buf_buf
;
1257 * Get data from the circular buffer and copy to the given buffer.
1258 * Restrict to the amount of data available.
1260 * Return the number of bytes copied.
1262 static unsigned int pl2303_buf_get(struct pl2303_buf
*pb
, char *buf
,
1270 len
= pl2303_buf_data_avail(pb
);
1277 len
= pb
->buf_buf
+ pb
->buf_size
- pb
->buf_get
;
1279 memcpy(buf
, pb
->buf_get
, len
);
1280 memcpy(buf
+len
, pb
->buf_buf
, count
- len
);
1281 pb
->buf_get
= pb
->buf_buf
+ count
- len
;
1283 memcpy(buf
, pb
->buf_get
, count
);
1285 pb
->buf_get
+= count
;
1286 else /* count == len */
1287 pb
->buf_get
= pb
->buf_buf
;
1293 /* module description and (de)initialization */
1295 static int __init
oti6858_init(void)
1299 if ((retval
= usb_serial_register(&oti6858_device
)) == 0) {
1300 if ((retval
= usb_register(&oti6858_driver
)) != 0)
1301 usb_serial_deregister(&oti6858_device
);
1309 static void __exit
oti6858_exit(void)
1311 usb_deregister(&oti6858_driver
);
1312 usb_serial_deregister(&oti6858_device
);
1315 module_init(oti6858_init
);
1316 module_exit(oti6858_exit
);
1318 MODULE_DESCRIPTION(OTI6858_DESCRIPTION
);
1319 MODULE_AUTHOR(OTI6858_AUTHOR
);
1320 MODULE_VERSION(OTI6858_VERSION
);
1321 MODULE_LICENSE("GPL");
1323 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1324 MODULE_PARM_DESC(debug
, "enable debug output");