2 * Prolific PL2303 USB to serial adaptor driver
4 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
5 * Copyright (C) 2003 IBM Corp.
7 * Original driver for 2.2.x by anonymous
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License.
13 * See Documentation/usb/usb-serial.txt for more information on using this driver
17 #include <linux/config.h>
18 #include <linux/kernel.h>
19 #include <linux/errno.h>
20 #include <linux/init.h>
21 #include <linux/slab.h>
22 #include <linux/tty.h>
23 #include <linux/tty_driver.h>
24 #include <linux/tty_flip.h>
25 #include <linux/serial.h>
26 #include <linux/module.h>
27 #include <linux/moduleparam.h>
28 #include <linux/spinlock.h>
29 #include <asm/uaccess.h>
30 #include <linux/usb.h>
31 #include "usb-serial.h"
37 #define DRIVER_VERSION "v0.12"
38 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
42 #define PL2303_CLOSING_WAIT (30*HZ)
44 #define PL2303_BUF_SIZE 1024
45 #define PL2303_TMP_BUF_SIZE 1024
47 static DECLARE_MUTEX(pl2303_tmp_buf_sem);
50 unsigned int buf_size;
56 static struct usb_device_id id_table [] = {
57 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
58 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
59 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
60 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
61 { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
62 { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
63 { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
64 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
65 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
66 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
67 { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
68 { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
69 { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
70 { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
71 { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
72 { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
73 { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
74 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
75 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
76 { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
77 { USB_DEVICE( NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID ) },
78 { } /* Terminating entry */
81 MODULE_DEVICE_TABLE (usb, id_table);
83 static struct usb_driver pl2303_driver = {
86 .probe = usb_serial_probe,
87 .disconnect = usb_serial_disconnect,
91 #define SET_LINE_REQUEST_TYPE 0x21
92 #define SET_LINE_REQUEST 0x20
94 #define SET_CONTROL_REQUEST_TYPE 0x21
95 #define SET_CONTROL_REQUEST 0x22
96 #define CONTROL_DTR 0x01
97 #define CONTROL_RTS 0x02
99 #define BREAK_REQUEST_TYPE 0x21
100 #define BREAK_REQUEST 0x23
101 #define BREAK_ON 0xffff
102 #define BREAK_OFF 0x0000
104 #define GET_LINE_REQUEST_TYPE 0xa1
105 #define GET_LINE_REQUEST 0x21
107 #define VENDOR_WRITE_REQUEST_TYPE 0x40
108 #define VENDOR_WRITE_REQUEST 0x01
110 #define VENDOR_READ_REQUEST_TYPE 0xc0
111 #define VENDOR_READ_REQUEST 0x01
113 #define UART_STATE 0x08
114 #define UART_STATE_TRANSIENT_MASK 0x74
115 #define UART_DCD 0x01
116 #define UART_DSR 0x02
117 #define UART_BREAK_ERROR 0x04
118 #define UART_RING 0x08
119 #define UART_FRAME_ERROR 0x10
120 #define UART_PARITY_ERROR 0x20
121 #define UART_OVERRUN_ERROR 0x40
122 #define UART_CTS 0x80
124 /* function prototypes for a PL2303 serial converter */
125 static int pl2303_open (struct usb_serial_port *port, struct file *filp);
126 static void pl2303_close (struct usb_serial_port *port, struct file *filp);
127 static void pl2303_set_termios (struct usb_serial_port *port,
128 struct termios *old);
129 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file,
130 unsigned int cmd, unsigned long arg);
131 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs);
132 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
133 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
134 static int pl2303_write (struct usb_serial_port *port,
135 const unsigned char *buf, int count);
136 static void pl2303_send (struct usb_serial_port *port);
137 static int pl2303_write_room(struct usb_serial_port *port);
138 static int pl2303_chars_in_buffer(struct usb_serial_port *port);
139 static void pl2303_break_ctl(struct usb_serial_port *port,int break_state);
140 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file);
141 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
142 unsigned int set, unsigned int clear);
143 static int pl2303_startup (struct usb_serial *serial);
144 static void pl2303_shutdown (struct usb_serial *serial);
145 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size);
146 static void pl2303_buf_free(struct pl2303_buf *pb);
147 static void pl2303_buf_clear(struct pl2303_buf *pb);
148 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb);
149 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb);
150 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
152 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
156 /* All of the device info needed for the PL2303 SIO serial converter */
157 static struct usb_serial_driver pl2303_device = {
159 .owner = THIS_MODULE,
162 .id_table = id_table,
163 .num_interrupt_in = NUM_DONT_CARE,
168 .close = pl2303_close,
169 .write = pl2303_write,
170 .ioctl = pl2303_ioctl,
171 .break_ctl = pl2303_break_ctl,
172 .set_termios = pl2303_set_termios,
173 .tiocmget = pl2303_tiocmget,
174 .tiocmset = pl2303_tiocmset,
175 .read_bulk_callback = pl2303_read_bulk_callback,
176 .read_int_callback = pl2303_read_int_callback,
177 .write_bulk_callback = pl2303_write_bulk_callback,
178 .write_room = pl2303_write_room,
179 .chars_in_buffer = pl2303_chars_in_buffer,
180 .attach = pl2303_startup,
181 .shutdown = pl2303_shutdown,
185 type_0, /* don't know the difference between type 0 and */
186 type_1, /* type 1, until someone from prolific tells us... */
187 HX, /* HX version of the pl2303 chip */
190 struct pl2303_private {
192 struct pl2303_buf *buf;
193 int write_urb_in_use;
194 wait_queue_head_t delta_msr_wait;
197 u8 termios_initialized;
198 enum pl2303_type type;
202 static int pl2303_startup (struct usb_serial *serial)
204 struct pl2303_private *priv;
205 enum pl2303_type type = type_0;
208 if (serial->dev->descriptor.bDeviceClass == 0x02)
210 else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
212 else if (serial->dev->descriptor.bDeviceClass == 0x00)
214 else if (serial->dev->descriptor.bDeviceClass == 0xFF)
216 dbg("device type: %d", type);
218 for (i = 0; i < serial->num_ports; ++i) {
219 priv = kmalloc (sizeof (struct pl2303_private), GFP_KERNEL);
222 memset (priv, 0x00, sizeof (struct pl2303_private));
223 spin_lock_init(&priv->lock);
224 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
225 if (priv->buf == NULL) {
229 init_waitqueue_head(&priv->delta_msr_wait);
231 usb_set_serial_port_data(serial->port[i], priv);
236 for (--i; i>=0; --i) {
237 priv = usb_get_serial_port_data(serial->port[i]);
238 pl2303_buf_free(priv->buf);
240 usb_set_serial_port_data(serial->port[i], NULL);
245 static int set_control_lines (struct usb_device *dev, u8 value)
249 retval = usb_control_msg (dev, usb_sndctrlpipe (dev, 0),
250 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
251 value, 0, NULL, 0, 100);
252 dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
256 static int pl2303_write (struct usb_serial_port *port, const unsigned char *buf, int count)
258 struct pl2303_private *priv = usb_get_serial_port_data(port);
261 dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
266 spin_lock_irqsave(&priv->lock, flags);
267 count = pl2303_buf_put(priv->buf, buf, count);
268 spin_unlock_irqrestore(&priv->lock, flags);
275 static void pl2303_send(struct usb_serial_port *port)
278 struct pl2303_private *priv = usb_get_serial_port_data(port);
281 dbg("%s - port %d", __FUNCTION__, port->number);
283 spin_lock_irqsave(&priv->lock, flags);
285 if (priv->write_urb_in_use) {
286 spin_unlock_irqrestore(&priv->lock, flags);
290 count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
291 port->bulk_out_size);
294 spin_unlock_irqrestore(&priv->lock, flags);
298 priv->write_urb_in_use = 1;
300 spin_unlock_irqrestore(&priv->lock, flags);
302 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, port->write_urb->transfer_buffer);
304 port->write_urb->transfer_buffer_length = count;
305 port->write_urb->dev = port->serial->dev;
306 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
308 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
309 priv->write_urb_in_use = 0;
310 // TODO: reschedule pl2303_send
313 schedule_work(&port->work);
316 static int pl2303_write_room(struct usb_serial_port *port)
318 struct pl2303_private *priv = usb_get_serial_port_data(port);
322 dbg("%s - port %d", __FUNCTION__, port->number);
324 spin_lock_irqsave(&priv->lock, flags);
325 room = pl2303_buf_space_avail(priv->buf);
326 spin_unlock_irqrestore(&priv->lock, flags);
328 dbg("%s - returns %d", __FUNCTION__, room);
332 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
334 struct pl2303_private *priv = usb_get_serial_port_data(port);
338 dbg("%s - port %d", __FUNCTION__, port->number);
340 spin_lock_irqsave(&priv->lock, flags);
341 chars = pl2303_buf_data_avail(priv->buf);
342 spin_unlock_irqrestore(&priv->lock, flags);
344 dbg("%s - returns %d", __FUNCTION__, chars);
348 static void pl2303_set_termios (struct usb_serial_port *port, struct termios *old_termios)
350 struct usb_serial *serial = port->serial;
351 struct pl2303_private *priv = usb_get_serial_port_data(port);
359 dbg("%s - port %d", __FUNCTION__, port->number);
361 if ((!port->tty) || (!port->tty->termios)) {
362 dbg("%s - no tty structures", __FUNCTION__);
366 spin_lock_irqsave(&priv->lock, flags);
367 if (!priv->termios_initialized) {
368 *(port->tty->termios) = tty_std_termios;
369 port->tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
370 priv->termios_initialized = 1;
372 spin_unlock_irqrestore(&priv->lock, flags);
374 cflag = port->tty->termios->c_cflag;
375 /* check that they really want us to change something */
377 if ((cflag == old_termios->c_cflag) &&
378 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
379 dbg("%s - nothing to change...", __FUNCTION__);
384 buf = kmalloc (7, GFP_KERNEL);
386 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
389 memset (buf, 0x00, 0x07);
391 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
392 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
394 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
395 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
399 switch (cflag & CSIZE) {
400 case CS5: buf[6] = 5; break;
401 case CS6: buf[6] = 6; break;
402 case CS7: buf[6] = 7; break;
404 case CS8: buf[6] = 8; break;
406 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
410 switch (cflag & CBAUD) {
411 case B0: baud = 0; break;
412 case B75: baud = 75; break;
413 case B150: baud = 150; break;
414 case B300: baud = 300; break;
415 case B600: baud = 600; break;
416 case B1200: baud = 1200; break;
417 case B1800: baud = 1800; break;
418 case B2400: baud = 2400; break;
419 case B4800: baud = 4800; break;
420 case B9600: baud = 9600; break;
421 case B19200: baud = 19200; break;
422 case B38400: baud = 38400; break;
423 case B57600: baud = 57600; break;
424 case B115200: baud = 115200; break;
425 case B230400: baud = 230400; break;
426 case B460800: baud = 460800; break;
428 dev_err(&port->dev, "pl2303 driver does not support the baudrate requested (fix it)\n");
431 dbg("%s - baud = %d", __FUNCTION__, baud);
433 buf[0] = baud & 0xff;
434 buf[1] = (baud >> 8) & 0xff;
435 buf[2] = (baud >> 16) & 0xff;
436 buf[3] = (baud >> 24) & 0xff;
439 /* For reference buf[4]=0 is 1 stop bits */
440 /* For reference buf[4]=1 is 1.5 stop bits */
441 /* For reference buf[4]=2 is 2 stop bits */
442 if (cflag & CSTOPB) {
444 dbg("%s - stop bits = 2", __FUNCTION__);
447 dbg("%s - stop bits = 1", __FUNCTION__);
450 if (cflag & PARENB) {
451 /* For reference buf[5]=0 is none parity */
452 /* For reference buf[5]=1 is odd parity */
453 /* For reference buf[5]=2 is even parity */
454 /* For reference buf[5]=3 is mark parity */
455 /* For reference buf[5]=4 is space parity */
456 if (cflag & PARODD) {
458 dbg("%s - parity = odd", __FUNCTION__);
461 dbg("%s - parity = even", __FUNCTION__);
465 dbg("%s - parity = none", __FUNCTION__);
468 i = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
469 SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
471 dbg ("0x21:0x20:0:0 %d", i);
473 /* change control lines if we are switching to or from B0 */
474 spin_lock_irqsave(&priv->lock, flags);
475 control = priv->line_control;
476 if ((cflag & CBAUD) == B0)
477 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
479 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
480 if (control != priv->line_control) {
481 control = priv->line_control;
482 spin_unlock_irqrestore(&priv->lock, flags);
483 set_control_lines(serial->dev, control);
485 spin_unlock_irqrestore(&priv->lock, flags);
488 buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
490 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
491 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
493 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
494 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
496 if (cflag & CRTSCTS) {
498 if (priv->type == HX)
502 i = usb_control_msg(serial->dev,
503 usb_sndctrlpipe(serial->dev, 0),
504 VENDOR_WRITE_REQUEST,
505 VENDOR_WRITE_REQUEST_TYPE,
506 0x0, index, NULL, 0, 100);
507 dbg ("0x40:0x1:0x0:0x%x %d", index, i);
513 static int pl2303_open (struct usb_serial_port *port, struct file *filp)
515 struct termios tmp_termios;
516 struct usb_serial *serial = port->serial;
517 struct pl2303_private *priv = usb_get_serial_port_data(port);
521 dbg("%s - port %d", __FUNCTION__, port->number);
523 if (priv->type != HX) {
524 usb_clear_halt(serial->dev, port->write_urb->pipe);
525 usb_clear_halt(serial->dev, port->read_urb->pipe);
528 buf = kmalloc(10, GFP_KERNEL);
532 #define FISH(a,b,c,d) \
533 result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0), \
534 b, a, c, d, buf, 1, 100); \
535 dbg("0x%x:0x%x:0x%x:0x%x %d - %x",a,b,c,d,result,buf[0]);
537 #define SOUP(a,b,c,d) \
538 result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0), \
539 b, a, c, d, NULL, 0, 100); \
540 dbg("0x%x:0x%x:0x%x:0x%x %d",a,b,c,d,result);
542 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
543 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
544 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
545 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
546 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
547 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
548 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
549 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
550 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
551 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
553 if (priv->type == HX) {
555 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
556 /* reset upstream data pipes */
557 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
558 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
560 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
567 pl2303_set_termios (port, &tmp_termios);
570 //FIXME: need to assert RTS and DTR if CRTSCTS off
572 dbg("%s - submitting read urb", __FUNCTION__);
573 port->read_urb->dev = serial->dev;
574 result = usb_submit_urb (port->read_urb, GFP_KERNEL);
576 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
577 pl2303_close (port, NULL);
581 dbg("%s - submitting interrupt urb", __FUNCTION__);
582 port->interrupt_in_urb->dev = serial->dev;
583 result = usb_submit_urb (port->interrupt_in_urb, GFP_KERNEL);
585 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n", __FUNCTION__, result);
586 pl2303_close (port, NULL);
593 static void pl2303_close (struct usb_serial_port *port, struct file *filp)
595 struct pl2303_private *priv = usb_get_serial_port_data(port);
597 unsigned int c_cflag;
602 dbg("%s - port %d", __FUNCTION__, port->number);
604 /* wait for data to drain from the buffer */
605 spin_lock_irqsave(&priv->lock, flags);
606 timeout = PL2303_CLOSING_WAIT;
607 init_waitqueue_entry(&wait, current);
608 add_wait_queue(&port->tty->write_wait, &wait);
610 set_current_state(TASK_INTERRUPTIBLE);
611 if (pl2303_buf_data_avail(priv->buf) == 0
612 || timeout == 0 || signal_pending(current)
613 || !usb_get_intfdata(port->serial->interface)) /* disconnect */
615 spin_unlock_irqrestore(&priv->lock, flags);
616 timeout = schedule_timeout(timeout);
617 spin_lock_irqsave(&priv->lock, flags);
619 set_current_state(TASK_RUNNING);
620 remove_wait_queue(&port->tty->write_wait, &wait);
621 /* clear out any remaining data in the buffer */
622 pl2303_buf_clear(priv->buf);
623 spin_unlock_irqrestore(&priv->lock, flags);
625 /* wait for characters to drain from the device */
626 /* (this is long enough for the entire 256 byte */
627 /* pl2303 hardware buffer to drain with no flow */
628 /* control for data rates of 1200 bps or more, */
629 /* for lower rates we should really know how much */
630 /* data is in the buffer to compute a delay */
631 /* that is not unnecessarily long) */
632 bps = tty_get_baud_rate(port->tty);
634 timeout = max((HZ*2560)/bps,HZ/10);
637 schedule_timeout_interruptible(timeout);
639 /* shutdown our urbs */
640 dbg("%s - shutting down urbs", __FUNCTION__);
641 usb_kill_urb(port->write_urb);
642 usb_kill_urb(port->read_urb);
643 usb_kill_urb(port->interrupt_in_urb);
646 c_cflag = port->tty->termios->c_cflag;
647 if (c_cflag & HUPCL) {
648 /* drop DTR and RTS */
649 spin_lock_irqsave(&priv->lock, flags);
650 priv->line_control = 0;
651 spin_unlock_irqrestore (&priv->lock, flags);
652 set_control_lines (port->serial->dev, 0);
657 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
658 unsigned int set, unsigned int clear)
660 struct pl2303_private *priv = usb_get_serial_port_data(port);
664 if (!usb_get_intfdata(port->serial->interface))
667 spin_lock_irqsave (&priv->lock, flags);
669 priv->line_control |= CONTROL_RTS;
671 priv->line_control |= CONTROL_DTR;
672 if (clear & TIOCM_RTS)
673 priv->line_control &= ~CONTROL_RTS;
674 if (clear & TIOCM_DTR)
675 priv->line_control &= ~CONTROL_DTR;
676 control = priv->line_control;
677 spin_unlock_irqrestore (&priv->lock, flags);
679 return set_control_lines (port->serial->dev, control);
682 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file)
684 struct pl2303_private *priv = usb_get_serial_port_data(port);
690 dbg("%s (%d)", __FUNCTION__, port->number);
692 if (!usb_get_intfdata(port->serial->interface))
695 spin_lock_irqsave (&priv->lock, flags);
696 mcr = priv->line_control;
697 status = priv->line_status;
698 spin_unlock_irqrestore (&priv->lock, flags);
700 result = ((mcr & CONTROL_DTR) ? TIOCM_DTR : 0)
701 | ((mcr & CONTROL_RTS) ? TIOCM_RTS : 0)
702 | ((status & UART_CTS) ? TIOCM_CTS : 0)
703 | ((status & UART_DSR) ? TIOCM_DSR : 0)
704 | ((status & UART_RING) ? TIOCM_RI : 0)
705 | ((status & UART_DCD) ? TIOCM_CD : 0);
707 dbg("%s - result = %x", __FUNCTION__, result);
712 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
714 struct pl2303_private *priv = usb_get_serial_port_data(port);
716 unsigned int prevstatus;
718 unsigned int changed;
720 spin_lock_irqsave (&priv->lock, flags);
721 prevstatus = priv->line_status;
722 spin_unlock_irqrestore (&priv->lock, flags);
725 interruptible_sleep_on(&priv->delta_msr_wait);
726 /* see if a signal did it */
727 if (signal_pending(current))
730 spin_lock_irqsave (&priv->lock, flags);
731 status = priv->line_status;
732 spin_unlock_irqrestore (&priv->lock, flags);
734 changed=prevstatus^status;
736 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
737 ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
738 ((arg & TIOCM_CD) && (changed & UART_DCD)) ||
739 ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) {
748 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg)
750 dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd);
754 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__, port->number);
755 return wait_modem_info(port, arg);
758 dbg("%s not supported = 0x%04x", __FUNCTION__, cmd);
765 static void pl2303_break_ctl (struct usb_serial_port *port, int break_state)
767 struct usb_serial *serial = port->serial;
771 dbg("%s - port %d", __FUNCTION__, port->number);
773 if (break_state == 0)
777 dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on");
779 result = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
780 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
783 dbg("%s - error sending break = %d", __FUNCTION__, result);
787 static void pl2303_shutdown (struct usb_serial *serial)
790 struct pl2303_private *priv;
792 dbg("%s", __FUNCTION__);
794 for (i = 0; i < serial->num_ports; ++i) {
795 priv = usb_get_serial_port_data(serial->port[i]);
797 pl2303_buf_free(priv->buf);
799 usb_set_serial_port_data(serial->port[i], NULL);
804 static void pl2303_update_line_status(struct usb_serial_port *port,
806 unsigned int actual_length)
809 struct pl2303_private *priv = usb_get_serial_port_data(port);
811 u8 status_idx = UART_STATE;
812 u8 length = UART_STATE;
814 if ((le16_to_cpu(port->serial->dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
815 (le16_to_cpu(port->serial->dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_X65)) {
820 if (actual_length < length)
823 /* Save off the uart status for others to look at */
824 spin_lock_irqsave(&priv->lock, flags);
825 priv->line_status = data[status_idx];
826 spin_unlock_irqrestore(&priv->lock, flags);
832 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs)
834 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
835 unsigned char *data = urb->transfer_buffer;
836 unsigned int actual_length = urb->actual_length;
839 dbg("%s (%d)", __FUNCTION__, port->number);
841 switch (urb->status) {
848 /* this urb is terminated, clean up */
849 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
852 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
856 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
857 pl2303_update_line_status(port, data, actual_length);
860 status = usb_submit_urb (urb, GFP_ATOMIC);
862 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed with result %d\n",
863 __FUNCTION__, status);
867 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
869 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
870 struct pl2303_private *priv = usb_get_serial_port_data(port);
871 struct tty_struct *tty;
872 unsigned char *data = urb->transfer_buffer;
879 dbg("%s - port %d", __FUNCTION__, port->number);
882 dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
883 if (!port->open_count) {
884 dbg("%s - port is closed, exiting.", __FUNCTION__);
887 if (urb->status == -EPROTO) {
888 /* PL2303 mysteriously fails with -EPROTO reschedule the read */
889 dbg("%s - caught -EPROTO, resubmitting the urb", __FUNCTION__);
891 urb->dev = port->serial->dev;
892 result = usb_submit_urb(urb, GFP_ATOMIC);
894 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
897 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
901 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
903 /* get tty_flag from status */
904 tty_flag = TTY_NORMAL;
906 spin_lock_irqsave(&priv->lock, flags);
907 status = priv->line_status;
908 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
909 spin_unlock_irqrestore(&priv->lock, flags);
910 wake_up_interruptible (&priv->delta_msr_wait);
912 /* break takes precedence over parity, */
913 /* which takes precedence over framing errors */
914 if (status & UART_BREAK_ERROR )
915 tty_flag = TTY_BREAK;
916 else if (status & UART_PARITY_ERROR)
917 tty_flag = TTY_PARITY;
918 else if (status & UART_FRAME_ERROR)
919 tty_flag = TTY_FRAME;
920 dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
923 if (tty && urb->actual_length) {
924 /* overrun is special, not associated with a char */
925 if (status & UART_OVERRUN_ERROR)
926 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
928 for (i = 0; i < urb->actual_length; ++i) {
929 if (tty->flip.count >= TTY_FLIPBUF_SIZE) {
930 tty_flip_buffer_push(tty);
932 tty_insert_flip_char (tty, data[i], tty_flag);
934 tty_flip_buffer_push (tty);
937 /* Schedule the next read _if_ we are still open */
938 if (port->open_count) {
939 urb->dev = port->serial->dev;
940 result = usb_submit_urb(urb, GFP_ATOMIC);
942 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
950 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
952 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
953 struct pl2303_private *priv = usb_get_serial_port_data(port);
956 dbg("%s - port %d", __FUNCTION__, port->number);
958 switch (urb->status) {
965 /* this urb is terminated, clean up */
966 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
967 priv->write_urb_in_use = 0;
970 /* error in the urb, so we have to resubmit it */
971 dbg("%s - Overflow in write", __FUNCTION__);
972 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
973 port->write_urb->transfer_buffer_length = 1;
974 port->write_urb->dev = port->serial->dev;
975 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
977 dev_err(&urb->dev->dev, "%s - failed resubmitting write urb, error %d\n", __FUNCTION__, result);
982 priv->write_urb_in_use = 0;
984 /* send any buffered data */
992 * Allocate a circular buffer and all associated memory.
995 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
998 struct pl2303_buf *pb;
1004 pb = (struct pl2303_buf *)kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
1008 pb->buf_buf = kmalloc(size, GFP_KERNEL);
1009 if (pb->buf_buf == NULL) {
1014 pb->buf_size = size;
1015 pb->buf_get = pb->buf_put = pb->buf_buf;
1025 * Free the buffer and all associated memory.
1028 static void pl2303_buf_free(struct pl2303_buf *pb)
1040 * Clear out all data in the circular buffer.
1043 static void pl2303_buf_clear(struct pl2303_buf *pb)
1046 pb->buf_get = pb->buf_put;
1047 /* equivalent to a get of all data available */
1052 * pl2303_buf_data_avail
1054 * Return the number of bytes of data available in the circular
1058 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
1061 return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
1068 * pl2303_buf_space_avail
1070 * Return the number of bytes of space available in the circular
1074 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
1077 return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
1086 * Copy data data from a user buffer and put it into the circular buffer.
1087 * Restrict to the amount of space available.
1089 * Return the number of bytes copied.
1092 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
1102 len = pl2303_buf_space_avail(pb);
1109 len = pb->buf_buf + pb->buf_size - pb->buf_put;
1111 memcpy(pb->buf_put, buf, len);
1112 memcpy(pb->buf_buf, buf+len, count - len);
1113 pb->buf_put = pb->buf_buf + count - len;
1115 memcpy(pb->buf_put, buf, count);
1117 pb->buf_put += count;
1118 else /* count == len */
1119 pb->buf_put = pb->buf_buf;
1130 * Get data from the circular buffer and copy to the given buffer.
1131 * Restrict to the amount of data available.
1133 * Return the number of bytes copied.
1136 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
1146 len = pl2303_buf_data_avail(pb);
1153 len = pb->buf_buf + pb->buf_size - pb->buf_get;
1155 memcpy(buf, pb->buf_get, len);
1156 memcpy(buf+len, pb->buf_buf, count - len);
1157 pb->buf_get = pb->buf_buf + count - len;
1159 memcpy(buf, pb->buf_get, count);
1161 pb->buf_get += count;
1162 else /* count == len */
1163 pb->buf_get = pb->buf_buf;
1170 static int __init pl2303_init (void)
1173 retval = usb_serial_register(&pl2303_device);
1175 goto failed_usb_serial_register;
1176 retval = usb_register(&pl2303_driver);
1178 goto failed_usb_register;
1179 info(DRIVER_DESC " " DRIVER_VERSION);
1181 failed_usb_register:
1182 usb_serial_deregister(&pl2303_device);
1183 failed_usb_serial_register:
1188 static void __exit pl2303_exit (void)
1190 usb_deregister (&pl2303_driver);
1191 usb_serial_deregister (&pl2303_device);
1195 module_init(pl2303_init);
1196 module_exit(pl2303_exit);
1198 MODULE_DESCRIPTION(DRIVER_DESC);
1199 MODULE_VERSION(DRIVER_VERSION);
1200 MODULE_LICENSE("GPL");
1202 module_param(debug, bool, S_IRUGO | S_IWUSR);
1203 MODULE_PARM_DESC(debug, "Debug enabled or not");