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
32 * - implement correct flushing for ioctls and oti6858_close()
33 * - check how errors (rx overflow, parity error, framing error) are reported
34 * - implement oti6858_break_ctl()
35 * - implement more ioctls
36 * - test/implement flow control
37 * - allow setting custom baud rates
40 #include <linux/kernel.h>
41 #include <linux/errno.h>
42 #include <linux/init.h>
43 #include <linux/slab.h>
44 #include <linux/tty.h>
45 #include <linux/tty_driver.h>
46 #include <linux/tty_flip.h>
47 #include <linux/serial.h>
48 #include <linux/module.h>
49 #include <linux/moduleparam.h>
50 #include <linux/spinlock.h>
51 #include <linux/usb.h>
52 #include <linux/usb/serial.h>
53 #include <linux/uaccess.h>
56 #define OTI6858_DESCRIPTION \
57 "Ours Technology Inc. OTi-6858 USB to serial adapter driver"
58 #define OTI6858_AUTHOR "Tomasz Michal Lukaszewski <FIXME@FIXME>"
59 #define OTI6858_VERSION "0.1"
61 static const struct usb_device_id id_table[] = {
62 { USB_DEVICE(OTI6858_VENDOR_ID, OTI6858_PRODUCT_ID) },
66 MODULE_DEVICE_TABLE(usb, id_table);
68 static struct usb_driver oti6858_driver = {
70 .probe = usb_serial_probe,
71 .disconnect = usb_serial_disconnect,
79 /* buffering code, copied from pl2303 driver */
80 #define PL2303_BUF_SIZE 1024
81 #define PL2303_TMP_BUF_SIZE 1024
84 unsigned int buf_size;
91 #define OTI6858_REQ_GET_STATUS (USB_DIR_IN | USB_TYPE_VENDOR | 0x00)
92 #define OTI6858_REQ_T_GET_STATUS 0x01
94 #define OTI6858_REQ_SET_LINE (USB_DIR_OUT | USB_TYPE_VENDOR | 0x00)
95 #define OTI6858_REQ_T_SET_LINE 0x00
97 #define OTI6858_REQ_CHECK_TXBUFF (USB_DIR_IN | USB_TYPE_VENDOR | 0x01)
98 #define OTI6858_REQ_T_CHECK_TXBUFF 0x00
100 /* format of the control packet */
101 struct oti6858_control_pkt {
102 __le16 divisor; /* baud rate = 96000000 / (16 * divisor), LE */
103 #define OTI6858_MAX_BAUD_RATE 3000000
105 #define FMT_STOP_BITS_MASK 0xc0
106 #define FMT_STOP_BITS_1 0x00
107 #define FMT_STOP_BITS_2 0x40 /* 1.5 stop bits if FMT_DATA_BITS_5 */
108 #define FMT_PARITY_MASK 0x38
109 #define FMT_PARITY_NONE 0x00
110 #define FMT_PARITY_ODD 0x08
111 #define FMT_PARITY_EVEN 0x18
112 #define FMT_PARITY_MARK 0x28
113 #define FMT_PARITY_SPACE 0x38
114 #define FMT_DATA_BITS_MASK 0x03
115 #define FMT_DATA_BITS_5 0x00
116 #define FMT_DATA_BITS_6 0x01
117 #define FMT_DATA_BITS_7 0x02
118 #define FMT_DATA_BITS_8 0x03
119 u8 something; /* always equals 0x43 */
120 u8 control; /* settings of flow control lines */
121 #define CONTROL_MASK 0x0c
122 #define CONTROL_DTR_HIGH 0x08
123 #define CONTROL_RTS_HIGH 0x04
125 #define TX_BUFFER_EMPTIED 0x09
127 #define PIN_MASK 0x3f
128 #define PIN_RTS 0x20 /* output pin */
129 #define PIN_CTS 0x10 /* input pin, active low */
130 #define PIN_DSR 0x08 /* input pin, active low */
131 #define PIN_DTR 0x04 /* output pin */
132 #define PIN_RI 0x02 /* input pin, active low */
133 #define PIN_DCD 0x01 /* input pin, active low */
134 u8 rx_bytes_avail; /* number of bytes in rx buffer */;
137 #define OTI6858_CTRL_PKT_SIZE sizeof(struct oti6858_control_pkt)
138 #define OTI6858_CTRL_EQUALS_PENDING(a, priv) \
139 (((a)->divisor == (priv)->pending_setup.divisor) \
140 && ((a)->control == (priv)->pending_setup.control) \
141 && ((a)->frame_fmt == (priv)->pending_setup.frame_fmt))
143 /* function prototypes */
144 static int oti6858_open(struct tty_struct *tty, struct usb_serial_port *port);
145 static void oti6858_close(struct usb_serial_port *port);
146 static void oti6858_set_termios(struct tty_struct *tty,
147 struct usb_serial_port *port, struct ktermios *old);
148 static void oti6858_init_termios(struct tty_struct *tty);
149 static int oti6858_ioctl(struct tty_struct *tty, struct file *file,
150 unsigned int cmd, unsigned long arg);
151 static void oti6858_read_int_callback(struct urb *urb);
152 static void oti6858_read_bulk_callback(struct urb *urb);
153 static void oti6858_write_bulk_callback(struct urb *urb);
154 static int oti6858_write(struct tty_struct *tty, struct usb_serial_port *port,
155 const unsigned char *buf, int count);
156 static int oti6858_write_room(struct tty_struct *tty);
157 static int oti6858_chars_in_buffer(struct tty_struct *tty);
158 static int oti6858_tiocmget(struct tty_struct *tty, struct file *file);
159 static int oti6858_tiocmset(struct tty_struct *tty, struct file *file,
160 unsigned int set, unsigned int clear);
161 static int oti6858_startup(struct usb_serial *serial);
162 static void oti6858_release(struct usb_serial *serial);
164 /* functions operating on buffers */
165 static struct oti6858_buf *oti6858_buf_alloc(unsigned int size);
166 static void oti6858_buf_free(struct oti6858_buf *pb);
167 static void oti6858_buf_clear(struct oti6858_buf *pb);
168 static unsigned int oti6858_buf_data_avail(struct oti6858_buf *pb);
169 static unsigned int oti6858_buf_space_avail(struct oti6858_buf *pb);
170 static unsigned int oti6858_buf_put(struct oti6858_buf *pb, const char *buf,
172 static unsigned int oti6858_buf_get(struct oti6858_buf *pb, char *buf,
177 static struct usb_serial_driver oti6858_device = {
179 .owner = THIS_MODULE,
182 .id_table = id_table,
184 .open = oti6858_open,
185 .close = oti6858_close,
186 .write = oti6858_write,
187 .ioctl = oti6858_ioctl,
188 .set_termios = oti6858_set_termios,
189 .init_termios = oti6858_init_termios,
190 .tiocmget = oti6858_tiocmget,
191 .tiocmset = oti6858_tiocmset,
192 .read_bulk_callback = oti6858_read_bulk_callback,
193 .read_int_callback = oti6858_read_int_callback,
194 .write_bulk_callback = oti6858_write_bulk_callback,
195 .write_room = oti6858_write_room,
196 .chars_in_buffer = oti6858_chars_in_buffer,
197 .attach = oti6858_startup,
198 .release = oti6858_release,
201 struct oti6858_private {
204 struct oti6858_buf *buf;
205 struct oti6858_control_pkt status;
211 struct delayed_work delayed_write_work;
220 struct delayed_work delayed_setup_work;
222 wait_queue_head_t intr_wait;
223 struct usb_serial_port *port; /* USB port with which associated */
226 static void setup_line(struct work_struct *work)
228 struct oti6858_private *priv = container_of(work,
229 struct oti6858_private, delayed_setup_work.work);
230 struct usb_serial_port *port = priv->port;
231 struct oti6858_control_pkt *new_setup;
235 dbg("%s(port = %d)", __func__, port->number);
237 new_setup = kmalloc(OTI6858_CTRL_PKT_SIZE, GFP_KERNEL);
238 if (new_setup == NULL) {
239 dev_err(&port->dev, "%s(): out of memory!\n", __func__);
240 /* we will try again */
241 schedule_delayed_work(&priv->delayed_setup_work,
242 msecs_to_jiffies(2));
246 result = usb_control_msg(port->serial->dev,
247 usb_rcvctrlpipe(port->serial->dev, 0),
248 OTI6858_REQ_T_GET_STATUS,
249 OTI6858_REQ_GET_STATUS,
251 new_setup, OTI6858_CTRL_PKT_SIZE,
254 if (result != OTI6858_CTRL_PKT_SIZE) {
255 dev_err(&port->dev, "%s(): error reading status\n", __func__);
257 /* we will try again */
258 schedule_delayed_work(&priv->delayed_setup_work,
259 msecs_to_jiffies(2));
263 spin_lock_irqsave(&priv->lock, flags);
264 if (!OTI6858_CTRL_EQUALS_PENDING(new_setup, priv)) {
265 new_setup->divisor = priv->pending_setup.divisor;
266 new_setup->control = priv->pending_setup.control;
267 new_setup->frame_fmt = priv->pending_setup.frame_fmt;
269 spin_unlock_irqrestore(&priv->lock, flags);
270 result = usb_control_msg(port->serial->dev,
271 usb_sndctrlpipe(port->serial->dev, 0),
272 OTI6858_REQ_T_SET_LINE,
273 OTI6858_REQ_SET_LINE,
275 new_setup, OTI6858_CTRL_PKT_SIZE,
278 spin_unlock_irqrestore(&priv->lock, flags);
283 spin_lock_irqsave(&priv->lock, flags);
284 if (result != OTI6858_CTRL_PKT_SIZE)
286 priv->setup_done = 1;
287 spin_unlock_irqrestore(&priv->lock, flags);
289 dbg("%s(): submitting interrupt urb", __func__);
290 port->interrupt_in_urb->dev = port->serial->dev;
291 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
293 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
294 " with error %d\n", __func__, result);
298 void send_data(struct work_struct *work)
300 struct oti6858_private *priv = container_of(work,
301 struct oti6858_private, delayed_write_work.work);
302 struct usb_serial_port *port = priv->port;
303 int count = 0, result;
307 dbg("%s(port = %d)", __func__, port->number);
309 spin_lock_irqsave(&priv->lock, flags);
310 if (priv->flags.write_urb_in_use) {
311 spin_unlock_irqrestore(&priv->lock, flags);
312 schedule_delayed_work(&priv->delayed_write_work,
313 msecs_to_jiffies(2));
316 priv->flags.write_urb_in_use = 1;
318 count = oti6858_buf_data_avail(priv->buf);
319 spin_unlock_irqrestore(&priv->lock, flags);
320 if (count > port->bulk_out_size)
321 count = port->bulk_out_size;
324 allow = kmalloc(1, GFP_KERNEL);
326 dev_err(&port->dev, "%s(): kmalloc failed\n",
330 result = usb_control_msg(port->serial->dev,
331 usb_rcvctrlpipe(port->serial->dev, 0),
332 OTI6858_REQ_T_CHECK_TXBUFF,
333 OTI6858_REQ_CHECK_TXBUFF,
334 count, 0, allow, 1, 100);
335 if (result != 1 || *allow != 0)
341 priv->flags.write_urb_in_use = 0;
343 dbg("%s(): submitting interrupt urb", __func__);
344 port->interrupt_in_urb->dev = port->serial->dev;
345 result = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
347 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
348 " with error %d\n", __func__, result);
353 spin_lock_irqsave(&priv->lock, flags);
354 oti6858_buf_get(priv->buf, port->write_urb->transfer_buffer, count);
355 spin_unlock_irqrestore(&priv->lock, flags);
357 port->write_urb->transfer_buffer_length = count;
358 port->write_urb->dev = port->serial->dev;
359 result = usb_submit_urb(port->write_urb, GFP_NOIO);
361 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
362 " with error %d\n", __func__, result);
363 priv->flags.write_urb_in_use = 0;
366 usb_serial_port_softint(port);
369 static int oti6858_startup(struct usb_serial *serial)
371 struct usb_serial_port *port = serial->port[0];
372 struct oti6858_private *priv;
375 for (i = 0; i < serial->num_ports; ++i) {
376 priv = kzalloc(sizeof(struct oti6858_private), GFP_KERNEL);
379 priv->buf = oti6858_buf_alloc(PL2303_BUF_SIZE);
380 if (priv->buf == NULL) {
385 spin_lock_init(&priv->lock);
386 init_waitqueue_head(&priv->intr_wait);
387 /* INIT_WORK(&priv->setup_work, setup_line, serial->port[i]); */
388 /* INIT_WORK(&priv->write_work, send_data, serial->port[i]); */
390 INIT_DELAYED_WORK(&priv->delayed_setup_work, setup_line);
391 INIT_DELAYED_WORK(&priv->delayed_write_work, send_data);
393 usb_set_serial_port_data(serial->port[i], priv);
395 if (i == serial->num_ports)
398 for (--i; i >= 0; --i) {
399 priv = usb_get_serial_port_data(serial->port[i]);
400 oti6858_buf_free(priv->buf);
402 usb_set_serial_port_data(serial->port[i], NULL);
407 static int oti6858_write(struct tty_struct *tty, struct usb_serial_port *port,
408 const unsigned char *buf, int count)
410 struct oti6858_private *priv = usb_get_serial_port_data(port);
413 dbg("%s(port = %d, count = %d)", __func__, port->number, count);
418 spin_lock_irqsave(&priv->lock, flags);
419 count = oti6858_buf_put(priv->buf, buf, count);
420 spin_unlock_irqrestore(&priv->lock, flags);
425 static int oti6858_write_room(struct tty_struct *tty)
427 struct usb_serial_port *port = tty->driver_data;
428 struct oti6858_private *priv = usb_get_serial_port_data(port);
432 dbg("%s(port = %d)", __func__, port->number);
434 spin_lock_irqsave(&priv->lock, flags);
435 room = oti6858_buf_space_avail(priv->buf);
436 spin_unlock_irqrestore(&priv->lock, flags);
441 static int oti6858_chars_in_buffer(struct tty_struct *tty)
443 struct usb_serial_port *port = tty->driver_data;
444 struct oti6858_private *priv = usb_get_serial_port_data(port);
448 dbg("%s(port = %d)", __func__, port->number);
450 spin_lock_irqsave(&priv->lock, flags);
451 chars = oti6858_buf_data_avail(priv->buf);
452 spin_unlock_irqrestore(&priv->lock, flags);
457 static void oti6858_init_termios(struct tty_struct *tty)
459 *(tty->termios) = tty_std_termios;
460 tty->termios->c_cflag = B38400 | CS8 | CREAD | HUPCL | CLOCAL;
461 tty->termios->c_ispeed = 38400;
462 tty->termios->c_ospeed = 38400;
465 static void oti6858_set_termios(struct tty_struct *tty,
466 struct usb_serial_port *port, struct ktermios *old_termios)
468 struct oti6858_private *priv = usb_get_serial_port_data(port);
471 u8 frame_fmt, control;
475 dbg("%s(port = %d)", __func__, port->number);
478 dbg("%s(): no tty structures", __func__);
482 cflag = tty->termios->c_cflag;
484 spin_lock_irqsave(&priv->lock, flags);
485 divisor = priv->pending_setup.divisor;
486 frame_fmt = priv->pending_setup.frame_fmt;
487 control = priv->pending_setup.control;
488 spin_unlock_irqrestore(&priv->lock, flags);
490 frame_fmt &= ~FMT_DATA_BITS_MASK;
491 switch (cflag & CSIZE) {
493 frame_fmt |= FMT_DATA_BITS_5;
496 frame_fmt |= FMT_DATA_BITS_6;
499 frame_fmt |= FMT_DATA_BITS_7;
503 frame_fmt |= FMT_DATA_BITS_8;
507 /* manufacturer claims that this device can work with baud rates
508 * up to 3 Mbps; I've tested it only on 115200 bps, so I can't
509 * guarantee that any other baud rate will work (especially
512 br = tty_get_baud_rate(tty);
518 br = min(br, OTI6858_MAX_BAUD_RATE);
520 new_divisor = (96000000 + 8 * br) / (16 * br);
521 real_br = 96000000 / (16 * new_divisor);
522 divisor = cpu_to_le16(new_divisor);
523 tty_encode_baud_rate(tty, real_br, real_br);
526 frame_fmt &= ~FMT_STOP_BITS_MASK;
527 if ((cflag & CSTOPB) != 0)
528 frame_fmt |= FMT_STOP_BITS_2;
530 frame_fmt |= FMT_STOP_BITS_1;
532 frame_fmt &= ~FMT_PARITY_MASK;
533 if ((cflag & PARENB) != 0) {
534 if ((cflag & PARODD) != 0)
535 frame_fmt |= FMT_PARITY_ODD;
537 frame_fmt |= FMT_PARITY_EVEN;
539 frame_fmt |= FMT_PARITY_NONE;
542 control &= ~CONTROL_MASK;
543 if ((cflag & CRTSCTS) != 0)
544 control |= (CONTROL_DTR_HIGH | CONTROL_RTS_HIGH);
546 /* change control lines if we are switching to or from B0 */
548 spin_lock_irqsave(&priv->lock, flags);
549 control = priv->line_control;
550 if ((cflag & CBAUD) == B0)
551 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
553 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
554 if (control != priv->line_control) {
555 control = priv->line_control;
556 spin_unlock_irqrestore(&priv->lock, flags);
557 set_control_lines(serial->dev, control);
559 spin_unlock_irqrestore(&priv->lock, flags);
563 spin_lock_irqsave(&priv->lock, flags);
564 if (divisor != priv->pending_setup.divisor
565 || control != priv->pending_setup.control
566 || frame_fmt != priv->pending_setup.frame_fmt) {
567 priv->pending_setup.divisor = divisor;
568 priv->pending_setup.control = control;
569 priv->pending_setup.frame_fmt = frame_fmt;
571 spin_unlock_irqrestore(&priv->lock, flags);
574 static int oti6858_open(struct tty_struct *tty, struct usb_serial_port *port)
576 struct oti6858_private *priv = usb_get_serial_port_data(port);
577 struct ktermios tmp_termios;
578 struct usb_serial *serial = port->serial;
579 struct oti6858_control_pkt *buf;
583 dbg("%s(port = %d)", __func__, port->number);
585 usb_clear_halt(serial->dev, port->write_urb->pipe);
586 usb_clear_halt(serial->dev, port->read_urb->pipe);
588 if (port->port.count != 1)
591 buf = kmalloc(OTI6858_CTRL_PKT_SIZE, GFP_KERNEL);
593 dev_err(&port->dev, "%s(): out of memory!\n", __func__);
597 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
598 OTI6858_REQ_T_GET_STATUS,
599 OTI6858_REQ_GET_STATUS,
601 buf, OTI6858_CTRL_PKT_SIZE,
603 if (result != OTI6858_CTRL_PKT_SIZE) {
604 /* assume default (after power-on reset) values */
605 buf->divisor = cpu_to_le16(0x009c); /* 38400 bps */
606 buf->frame_fmt = 0x03; /* 8N1 */
607 buf->something = 0x43;
608 buf->control = 0x4c; /* DTR, RTS */
609 buf->tx_status = 0x00;
610 buf->pin_state = 0x5b; /* RTS, CTS, DSR, DTR, RI, DCD */
611 buf->rx_bytes_avail = 0x00;
614 spin_lock_irqsave(&priv->lock, flags);
615 memcpy(&priv->status, buf, OTI6858_CTRL_PKT_SIZE);
616 priv->pending_setup.divisor = buf->divisor;
617 priv->pending_setup.frame_fmt = buf->frame_fmt;
618 priv->pending_setup.control = buf->control;
619 spin_unlock_irqrestore(&priv->lock, flags);
622 dbg("%s(): submitting interrupt urb", __func__);
623 port->interrupt_in_urb->dev = serial->dev;
624 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
626 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
627 " with error %d\n", __func__, result);
634 oti6858_set_termios(tty, port, &tmp_termios);
635 port->port.drain_delay = 256; /* FIXME: check the FIFO length */
639 static void oti6858_close(struct usb_serial_port *port)
641 struct oti6858_private *priv = usb_get_serial_port_data(port);
644 dbg("%s(port = %d)", __func__, port->number);
646 spin_lock_irqsave(&priv->lock, flags);
647 /* clear out any remaining data in the buffer */
648 oti6858_buf_clear(priv->buf);
649 spin_unlock_irqrestore(&priv->lock, flags);
651 dbg("%s(): after buf_clear()", __func__);
653 /* cancel scheduled setup */
654 cancel_delayed_work(&priv->delayed_setup_work);
655 cancel_delayed_work(&priv->delayed_write_work);
656 flush_scheduled_work();
658 /* shutdown our urbs */
659 dbg("%s(): shutting down urbs", __func__);
660 usb_kill_urb(port->write_urb);
661 usb_kill_urb(port->read_urb);
662 usb_kill_urb(port->interrupt_in_urb);
665 static int oti6858_tiocmset(struct tty_struct *tty, struct file *file,
666 unsigned int set, unsigned int clear)
668 struct usb_serial_port *port = tty->driver_data;
669 struct oti6858_private *priv = usb_get_serial_port_data(port);
673 dbg("%s(port = %d, set = 0x%08x, clear = 0x%08x)",
674 __func__, port->number, set, clear);
676 if (!usb_get_intfdata(port->serial->interface))
679 /* FIXME: check if this is correct (active high/low) */
680 spin_lock_irqsave(&priv->lock, flags);
681 control = priv->pending_setup.control;
682 if ((set & TIOCM_RTS) != 0)
683 control |= CONTROL_RTS_HIGH;
684 if ((set & TIOCM_DTR) != 0)
685 control |= CONTROL_DTR_HIGH;
686 if ((clear & TIOCM_RTS) != 0)
687 control &= ~CONTROL_RTS_HIGH;
688 if ((clear & TIOCM_DTR) != 0)
689 control &= ~CONTROL_DTR_HIGH;
691 if (control != priv->pending_setup.control)
692 priv->pending_setup.control = control;
694 spin_unlock_irqrestore(&priv->lock, flags);
698 static int oti6858_tiocmget(struct tty_struct *tty, struct file *file)
700 struct usb_serial_port *port = tty->driver_data;
701 struct oti6858_private *priv = usb_get_serial_port_data(port);
706 dbg("%s(port = %d)", __func__, port->number);
708 if (!usb_get_intfdata(port->serial->interface))
711 spin_lock_irqsave(&priv->lock, flags);
712 pin_state = priv->status.pin_state & PIN_MASK;
713 spin_unlock_irqrestore(&priv->lock, flags);
715 /* FIXME: check if this is correct (active high/low) */
716 if ((pin_state & PIN_RTS) != 0)
718 if ((pin_state & PIN_CTS) != 0)
720 if ((pin_state & PIN_DSR) != 0)
722 if ((pin_state & PIN_DTR) != 0)
724 if ((pin_state & PIN_RI) != 0)
726 if ((pin_state & PIN_DCD) != 0)
729 dbg("%s() = 0x%08x", __func__, result);
734 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
736 struct oti6858_private *priv = usb_get_serial_port_data(port);
738 unsigned int prev, status;
739 unsigned int changed;
741 spin_lock_irqsave(&priv->lock, flags);
742 prev = priv->status.pin_state;
743 spin_unlock_irqrestore(&priv->lock, flags);
746 wait_event_interruptible(priv->intr_wait,
747 priv->status.pin_state != prev);
748 if (signal_pending(current))
751 spin_lock_irqsave(&priv->lock, flags);
752 status = priv->status.pin_state & PIN_MASK;
753 spin_unlock_irqrestore(&priv->lock, flags);
755 changed = prev ^ status;
756 /* FIXME: check if this is correct (active high/low) */
757 if (((arg & TIOCM_RNG) && (changed & PIN_RI)) ||
758 ((arg & TIOCM_DSR) && (changed & PIN_DSR)) ||
759 ((arg & TIOCM_CD) && (changed & PIN_DCD)) ||
760 ((arg & TIOCM_CTS) && (changed & PIN_CTS)))
769 static int oti6858_ioctl(struct tty_struct *tty, struct file *file,
770 unsigned int cmd, unsigned long arg)
772 struct usb_serial_port *port = tty->driver_data;
774 dbg("%s(port = %d, cmd = 0x%04x, arg = 0x%08lx)",
775 __func__, port->number, cmd, arg);
779 dbg("%s(): TIOCMIWAIT", __func__);
780 return wait_modem_info(port, arg);
782 dbg("%s(): 0x%04x not supported", __func__, cmd);
789 static void oti6858_release(struct usb_serial *serial)
791 struct oti6858_private *priv;
794 dbg("%s()", __func__);
796 for (i = 0; i < serial->num_ports; ++i) {
797 priv = usb_get_serial_port_data(serial->port[i]);
799 oti6858_buf_free(priv->buf);
805 static void oti6858_read_int_callback(struct urb *urb)
807 struct usb_serial_port *port = urb->context;
808 struct oti6858_private *priv = usb_get_serial_port_data(port);
809 int transient = 0, can_recv = 0, resubmit = 1;
810 int status = urb->status;
812 dbg("%s(port = %d, status = %d)",
813 __func__, port->number, status);
822 /* this urb is terminated, clean up */
823 dbg("%s(): urb shutting down with status: %d",
827 dbg("%s(): nonzero urb status received: %d",
832 if (status == 0 && urb->actual_length == OTI6858_CTRL_PKT_SIZE) {
833 struct oti6858_control_pkt *xs = urb->transfer_buffer;
836 spin_lock_irqsave(&priv->lock, flags);
838 if (!priv->transient) {
839 if (!OTI6858_CTRL_EQUALS_PENDING(xs, priv)) {
840 if (xs->rx_bytes_avail == 0) {
842 priv->setup_done = 0;
844 dbg("%s(): scheduling setup_line()",
846 schedule_delayed_work(&priv->delayed_setup_work, 0);
850 if (OTI6858_CTRL_EQUALS_PENDING(xs, priv)) {
852 } else if (!priv->setup_done) {
854 } else if (--priv->transient == 0) {
855 if (xs->rx_bytes_avail == 0) {
857 priv->setup_done = 0;
859 dbg("%s(): scheduling setup_line()",
861 schedule_delayed_work(&priv->delayed_setup_work, 0);
866 if (!priv->transient) {
867 if (xs->pin_state != priv->status.pin_state)
868 wake_up_interruptible(&priv->intr_wait);
869 memcpy(&priv->status, xs, OTI6858_CTRL_PKT_SIZE);
872 if (!priv->transient && xs->rx_bytes_avail != 0) {
873 can_recv = xs->rx_bytes_avail;
874 priv->flags.read_urb_in_use = 1;
877 transient = priv->transient;
878 spin_unlock_irqrestore(&priv->lock, flags);
884 port->read_urb->dev = port->serial->dev;
885 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
887 priv->flags.read_urb_in_use = 0;
888 dev_err(&port->dev, "%s(): usb_submit_urb() failed,"
889 " error %d\n", __func__, result);
893 } else if (!transient) {
896 spin_lock_irqsave(&priv->lock, flags);
897 if (priv->flags.write_urb_in_use == 0
898 && oti6858_buf_data_avail(priv->buf) != 0) {
899 schedule_delayed_work(&priv->delayed_write_work, 0);
902 spin_unlock_irqrestore(&priv->lock, flags);
908 /* dbg("%s(): submitting interrupt urb", __func__); */
909 urb->dev = port->serial->dev;
910 result = usb_submit_urb(urb, GFP_ATOMIC);
912 dev_err(&urb->dev->dev,
913 "%s(): usb_submit_urb() failed with"
914 " error %d\n", __func__, result);
919 static void oti6858_read_bulk_callback(struct urb *urb)
921 struct usb_serial_port *port = urb->context;
922 struct oti6858_private *priv = usb_get_serial_port_data(port);
923 struct tty_struct *tty;
924 unsigned char *data = urb->transfer_buffer;
926 int status = urb->status;
929 dbg("%s(port = %d, status = %d)",
930 __func__, port->number, status);
932 spin_lock_irqsave(&priv->lock, flags);
933 priv->flags.read_urb_in_use = 0;
934 spin_unlock_irqrestore(&priv->lock, flags);
937 if (!port->port.count) {
938 dbg("%s(): port is closed, exiting", __func__);
942 if (status == -EPROTO) {
943 * PL2303 mysteriously fails with -EPROTO reschedule
945 dbg("%s - caught -EPROTO, resubmitting the urb",
947 result = usb_submit_urb(urb, GFP_ATOMIC);
949 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __func__, result);
953 dbg("%s(): unable to handle the error, exiting", __func__);
957 tty = tty_port_tty_get(&port->port);
958 if (tty != NULL && urb->actual_length > 0) {
959 tty_insert_flip_string(tty, data, urb->actual_length);
960 tty_flip_buffer_push(tty);
964 /* schedule the interrupt urb if we are still open */
965 if (port->port.count != 0) {
966 port->interrupt_in_urb->dev = port->serial->dev;
967 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
969 dev_err(&port->dev, "%s(): usb_submit_urb() failed,"
970 " error %d\n", __func__, result);
975 static void oti6858_write_bulk_callback(struct urb *urb)
977 struct usb_serial_port *port = urb->context;
978 struct oti6858_private *priv = usb_get_serial_port_data(port);
979 int status = urb->status;
982 dbg("%s(port = %d, status = %d)",
983 __func__, port->number, status);
992 /* this urb is terminated, clean up */
993 dbg("%s(): urb shutting down with status: %d",
995 priv->flags.write_urb_in_use = 0;
998 /* error in the urb, so we have to resubmit it */
999 dbg("%s(): nonzero write bulk status received: %d",
1001 dbg("%s(): overflow in write", __func__);
1003 port->write_urb->transfer_buffer_length = 1;
1004 port->write_urb->dev = port->serial->dev;
1005 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1007 dev_err(&port->dev, "%s(): usb_submit_urb() failed,"
1008 " error %d\n", __func__, result);
1014 priv->flags.write_urb_in_use = 0;
1016 /* schedule the interrupt urb if we are still open */
1017 port->interrupt_in_urb->dev = port->serial->dev;
1018 dbg("%s(): submitting interrupt urb", __func__);
1019 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1021 dev_err(&port->dev, "%s(): failed submitting int urb,"
1022 " error %d\n", __func__, result);
1030 * Allocate a circular buffer and all associated memory.
1032 static struct oti6858_buf *oti6858_buf_alloc(unsigned int size)
1034 struct oti6858_buf *pb;
1039 pb = kmalloc(sizeof(struct oti6858_buf), GFP_KERNEL);
1043 pb->buf_buf = kmalloc(size, GFP_KERNEL);
1044 if (pb->buf_buf == NULL) {
1049 pb->buf_size = size;
1050 pb->buf_get = pb->buf_put = pb->buf_buf;
1058 * Free the buffer and all associated memory.
1060 static void oti6858_buf_free(struct oti6858_buf *pb)
1071 * Clear out all data in the circular buffer.
1073 static void oti6858_buf_clear(struct oti6858_buf *pb)
1076 /* equivalent to a get of all data available */
1077 pb->buf_get = pb->buf_put;
1082 * oti6858_buf_data_avail
1084 * Return the number of bytes of data available in the circular
1087 static unsigned int oti6858_buf_data_avail(struct oti6858_buf *pb)
1091 return (pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size;
1095 * oti6858_buf_space_avail
1097 * Return the number of bytes of space available in the circular
1100 static unsigned int oti6858_buf_space_avail(struct oti6858_buf *pb)
1104 return (pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size;
1110 * Copy data data from a user buffer and put it into the circular buffer.
1111 * Restrict to the amount of space available.
1113 * Return the number of bytes copied.
1115 static unsigned int oti6858_buf_put(struct oti6858_buf *pb, const char *buf,
1123 len = oti6858_buf_space_avail(pb);
1130 len = pb->buf_buf + pb->buf_size - pb->buf_put;
1132 memcpy(pb->buf_put, buf, len);
1133 memcpy(pb->buf_buf, buf+len, count - len);
1134 pb->buf_put = pb->buf_buf + count - len;
1136 memcpy(pb->buf_put, buf, count);
1138 pb->buf_put += count;
1139 else /* count == len */
1140 pb->buf_put = pb->buf_buf;
1149 * Get data from the circular buffer and copy to the given buffer.
1150 * Restrict to the amount of data available.
1152 * Return the number of bytes copied.
1154 static unsigned int oti6858_buf_get(struct oti6858_buf *pb, char *buf,
1162 len = oti6858_buf_data_avail(pb);
1169 len = pb->buf_buf + pb->buf_size - pb->buf_get;
1171 memcpy(buf, pb->buf_get, len);
1172 memcpy(buf+len, pb->buf_buf, count - len);
1173 pb->buf_get = pb->buf_buf + count - len;
1175 memcpy(buf, pb->buf_get, count);
1177 pb->buf_get += count;
1178 else /* count == len */
1179 pb->buf_get = pb->buf_buf;
1185 /* module description and (de)initialization */
1187 static int __init oti6858_init(void)
1191 retval = usb_serial_register(&oti6858_device);
1193 retval = usb_register(&oti6858_driver);
1195 usb_serial_deregister(&oti6858_device);
1200 static void __exit oti6858_exit(void)
1202 usb_deregister(&oti6858_driver);
1203 usb_serial_deregister(&oti6858_device);
1206 module_init(oti6858_init);
1207 module_exit(oti6858_exit);
1209 MODULE_DESCRIPTION(OTI6858_DESCRIPTION);
1210 MODULE_AUTHOR(OTI6858_AUTHOR);
1211 MODULE_VERSION(OTI6858_VERSION);
1212 MODULE_LICENSE("GPL");
1214 module_param(debug, bool, S_IRUGO | S_IWUSR);
1215 MODULE_PARM_DESC(debug, "enable debug output");