Linux v2.6.13
[linux-2.6/next.git] / drivers / usb / serial / pl2303.c
blob7eab5d4cf3a8c674a84ebafd73c8e4aaa4e2da27
1 /*
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, or
12 * (at your option) any later version.
14 * See Documentation/usb/usb-serial.txt for more information on using this driver
16 * 2002_Mar_26 gkh
17 * allowed driver to work properly if there is no tty assigned to a port
18 * (this happens for serial console devices.)
20 * 2001_Oct_06 gkh
21 * Added RTS and DTR line control. Thanks to joe@bndlg.de for parts of it.
23 * 2001_Sep_19 gkh
24 * Added break support.
26 * 2001_Aug_30 gkh
27 * fixed oops in write_bulk_callback.
29 * 2001_Aug_28 gkh
30 * reworked buffer logic to be like other usb-serial drivers. Hopefully
31 * removing some reported problems.
33 * 2001_Jun_06 gkh
34 * finished porting to 2.4 format.
38 #include <linux/config.h>
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 <asm/uaccess.h>
51 #include <linux/usb.h>
52 #include "usb-serial.h"
53 #include "pl2303.h"
56 * Version Information
58 #define DRIVER_VERSION "v0.12"
59 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
61 static int debug;
63 #define PL2303_CLOSING_WAIT (30*HZ)
65 #define PL2303_BUF_SIZE 1024
66 #define PL2303_TMP_BUF_SIZE 1024
68 static DECLARE_MUTEX(pl2303_tmp_buf_sem);
70 struct pl2303_buf {
71 unsigned int buf_size;
72 char *buf_buf;
73 char *buf_get;
74 char *buf_put;
77 static struct usb_device_id id_table [] = {
78 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
79 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
80 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
81 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
82 { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
83 { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
84 { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
85 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
86 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
87 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
88 { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
89 { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
90 { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
91 { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
92 { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
93 { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
94 { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
95 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
96 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
97 { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
98 { } /* Terminating entry */
101 MODULE_DEVICE_TABLE (usb, id_table);
103 static struct usb_driver pl2303_driver = {
104 .owner = THIS_MODULE,
105 .name = "pl2303",
106 .probe = usb_serial_probe,
107 .disconnect = usb_serial_disconnect,
108 .id_table = id_table,
111 #define SET_LINE_REQUEST_TYPE 0x21
112 #define SET_LINE_REQUEST 0x20
114 #define SET_CONTROL_REQUEST_TYPE 0x21
115 #define SET_CONTROL_REQUEST 0x22
116 #define CONTROL_DTR 0x01
117 #define CONTROL_RTS 0x02
119 #define BREAK_REQUEST_TYPE 0x21
120 #define BREAK_REQUEST 0x23
121 #define BREAK_ON 0xffff
122 #define BREAK_OFF 0x0000
124 #define GET_LINE_REQUEST_TYPE 0xa1
125 #define GET_LINE_REQUEST 0x21
127 #define VENDOR_WRITE_REQUEST_TYPE 0x40
128 #define VENDOR_WRITE_REQUEST 0x01
130 #define VENDOR_READ_REQUEST_TYPE 0xc0
131 #define VENDOR_READ_REQUEST 0x01
133 #define UART_STATE 0x08
134 #define UART_STATE_TRANSIENT_MASK 0x74
135 #define UART_DCD 0x01
136 #define UART_DSR 0x02
137 #define UART_BREAK_ERROR 0x04
138 #define UART_RING 0x08
139 #define UART_FRAME_ERROR 0x10
140 #define UART_PARITY_ERROR 0x20
141 #define UART_OVERRUN_ERROR 0x40
142 #define UART_CTS 0x80
144 /* function prototypes for a PL2303 serial converter */
145 static int pl2303_open (struct usb_serial_port *port, struct file *filp);
146 static void pl2303_close (struct usb_serial_port *port, struct file *filp);
147 static void pl2303_set_termios (struct usb_serial_port *port,
148 struct termios *old);
149 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file,
150 unsigned int cmd, unsigned long arg);
151 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs);
152 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
153 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
154 static int pl2303_write (struct usb_serial_port *port,
155 const unsigned char *buf, int count);
156 static void pl2303_send (struct usb_serial_port *port);
157 static int pl2303_write_room(struct usb_serial_port *port);
158 static int pl2303_chars_in_buffer(struct usb_serial_port *port);
159 static void pl2303_break_ctl(struct usb_serial_port *port,int break_state);
160 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file);
161 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
162 unsigned int set, unsigned int clear);
163 static int pl2303_startup (struct usb_serial *serial);
164 static void pl2303_shutdown (struct usb_serial *serial);
165 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size);
166 static void pl2303_buf_free(struct pl2303_buf *pb);
167 static void pl2303_buf_clear(struct pl2303_buf *pb);
168 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb);
169 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb);
170 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
171 unsigned int count);
172 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
173 unsigned int count);
176 /* All of the device info needed for the PL2303 SIO serial converter */
177 static struct usb_serial_device_type pl2303_device = {
178 .owner = THIS_MODULE,
179 .name = "PL-2303",
180 .id_table = id_table,
181 .num_interrupt_in = NUM_DONT_CARE,
182 .num_bulk_in = 1,
183 .num_bulk_out = 1,
184 .num_ports = 1,
185 .open = pl2303_open,
186 .close = pl2303_close,
187 .write = pl2303_write,
188 .ioctl = pl2303_ioctl,
189 .break_ctl = pl2303_break_ctl,
190 .set_termios = pl2303_set_termios,
191 .tiocmget = pl2303_tiocmget,
192 .tiocmset = pl2303_tiocmset,
193 .read_bulk_callback = pl2303_read_bulk_callback,
194 .read_int_callback = pl2303_read_int_callback,
195 .write_bulk_callback = pl2303_write_bulk_callback,
196 .write_room = pl2303_write_room,
197 .chars_in_buffer = pl2303_chars_in_buffer,
198 .attach = pl2303_startup,
199 .shutdown = pl2303_shutdown,
202 enum pl2303_type {
203 type_0, /* don't know the difference between type 0 and */
204 type_1, /* type 1, until someone from prolific tells us... */
205 HX, /* HX version of the pl2303 chip */
208 struct pl2303_private {
209 spinlock_t lock;
210 struct pl2303_buf *buf;
211 int write_urb_in_use;
212 wait_queue_head_t delta_msr_wait;
213 u8 line_control;
214 u8 line_status;
215 u8 termios_initialized;
216 enum pl2303_type type;
220 static int pl2303_startup (struct usb_serial *serial)
222 struct pl2303_private *priv;
223 enum pl2303_type type = type_0;
224 int i;
226 if (serial->dev->descriptor.bDeviceClass == 0x02)
227 type = type_0;
228 else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
229 type = HX;
230 else if (serial->dev->descriptor.bDeviceClass == 0x00)
231 type = type_1;
232 else if (serial->dev->descriptor.bDeviceClass == 0xFF)
233 type = type_1;
234 dbg("device type: %d", type);
236 for (i = 0; i < serial->num_ports; ++i) {
237 priv = kmalloc (sizeof (struct pl2303_private), GFP_KERNEL);
238 if (!priv)
239 goto cleanup;
240 memset (priv, 0x00, sizeof (struct pl2303_private));
241 spin_lock_init(&priv->lock);
242 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
243 if (priv->buf == NULL) {
244 kfree(priv);
245 goto cleanup;
247 init_waitqueue_head(&priv->delta_msr_wait);
248 priv->type = type;
249 usb_set_serial_port_data(serial->port[i], priv);
251 return 0;
253 cleanup:
254 for (--i; i>=0; --i) {
255 priv = usb_get_serial_port_data(serial->port[i]);
256 pl2303_buf_free(priv->buf);
257 kfree(priv);
258 usb_set_serial_port_data(serial->port[i], NULL);
260 return -ENOMEM;
263 static int set_control_lines (struct usb_device *dev, u8 value)
265 int retval;
267 retval = usb_control_msg (dev, usb_sndctrlpipe (dev, 0),
268 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
269 value, 0, NULL, 0, 100);
270 dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
271 return retval;
274 static int pl2303_write (struct usb_serial_port *port, const unsigned char *buf, int count)
276 struct pl2303_private *priv = usb_get_serial_port_data(port);
277 unsigned long flags;
279 dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
281 if (!count)
282 return count;
284 spin_lock_irqsave(&priv->lock, flags);
285 count = pl2303_buf_put(priv->buf, buf, count);
286 spin_unlock_irqrestore(&priv->lock, flags);
288 pl2303_send(port);
290 return count;
293 static void pl2303_send(struct usb_serial_port *port)
295 int count, result;
296 struct pl2303_private *priv = usb_get_serial_port_data(port);
297 unsigned long flags;
299 dbg("%s - port %d", __FUNCTION__, port->number);
301 spin_lock_irqsave(&priv->lock, flags);
303 if (priv->write_urb_in_use) {
304 spin_unlock_irqrestore(&priv->lock, flags);
305 return;
308 count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
309 port->bulk_out_size);
311 if (count == 0) {
312 spin_unlock_irqrestore(&priv->lock, flags);
313 return;
316 priv->write_urb_in_use = 1;
318 spin_unlock_irqrestore(&priv->lock, flags);
320 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, port->write_urb->transfer_buffer);
322 port->write_urb->transfer_buffer_length = count;
323 port->write_urb->dev = port->serial->dev;
324 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
325 if (result) {
326 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
327 priv->write_urb_in_use = 0;
328 // TODO: reschedule pl2303_send
331 schedule_work(&port->work);
334 static int pl2303_write_room(struct usb_serial_port *port)
336 struct pl2303_private *priv = usb_get_serial_port_data(port);
337 int room = 0;
338 unsigned long flags;
340 dbg("%s - port %d", __FUNCTION__, port->number);
342 spin_lock_irqsave(&priv->lock, flags);
343 room = pl2303_buf_space_avail(priv->buf);
344 spin_unlock_irqrestore(&priv->lock, flags);
346 dbg("%s - returns %d", __FUNCTION__, room);
347 return room;
350 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
352 struct pl2303_private *priv = usb_get_serial_port_data(port);
353 int chars = 0;
354 unsigned long flags;
356 dbg("%s - port %d", __FUNCTION__, port->number);
358 spin_lock_irqsave(&priv->lock, flags);
359 chars = pl2303_buf_data_avail(priv->buf);
360 spin_unlock_irqrestore(&priv->lock, flags);
362 dbg("%s - returns %d", __FUNCTION__, chars);
363 return chars;
366 static void pl2303_set_termios (struct usb_serial_port *port, struct termios *old_termios)
368 struct usb_serial *serial = port->serial;
369 struct pl2303_private *priv = usb_get_serial_port_data(port);
370 unsigned long flags;
371 unsigned int cflag;
372 unsigned char *buf;
373 int baud;
374 int i;
375 u8 control;
377 dbg("%s - port %d", __FUNCTION__, port->number);
379 if ((!port->tty) || (!port->tty->termios)) {
380 dbg("%s - no tty structures", __FUNCTION__);
381 return;
384 spin_lock_irqsave(&priv->lock, flags);
385 if (!priv->termios_initialized) {
386 *(port->tty->termios) = tty_std_termios;
387 port->tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
388 priv->termios_initialized = 1;
390 spin_unlock_irqrestore(&priv->lock, flags);
392 cflag = port->tty->termios->c_cflag;
393 /* check that they really want us to change something */
394 if (old_termios) {
395 if ((cflag == old_termios->c_cflag) &&
396 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
397 dbg("%s - nothing to change...", __FUNCTION__);
398 return;
402 buf = kmalloc (7, GFP_KERNEL);
403 if (!buf) {
404 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
405 return;
407 memset (buf, 0x00, 0x07);
409 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
410 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
411 0, 0, buf, 7, 100);
412 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
413 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
416 if (cflag & CSIZE) {
417 switch (cflag & CSIZE) {
418 case CS5: buf[6] = 5; break;
419 case CS6: buf[6] = 6; break;
420 case CS7: buf[6] = 7; break;
421 default:
422 case CS8: buf[6] = 8; break;
424 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
427 baud = 0;
428 switch (cflag & CBAUD) {
429 case B0: baud = 0; break;
430 case B75: baud = 75; break;
431 case B150: baud = 150; break;
432 case B300: baud = 300; break;
433 case B600: baud = 600; break;
434 case B1200: baud = 1200; break;
435 case B1800: baud = 1800; break;
436 case B2400: baud = 2400; break;
437 case B4800: baud = 4800; break;
438 case B9600: baud = 9600; break;
439 case B19200: baud = 19200; break;
440 case B38400: baud = 38400; break;
441 case B57600: baud = 57600; break;
442 case B115200: baud = 115200; break;
443 case B230400: baud = 230400; break;
444 case B460800: baud = 460800; break;
445 default:
446 dev_err(&port->dev, "pl2303 driver does not support the baudrate requested (fix it)\n");
447 break;
449 dbg("%s - baud = %d", __FUNCTION__, baud);
450 if (baud) {
451 buf[0] = baud & 0xff;
452 buf[1] = (baud >> 8) & 0xff;
453 buf[2] = (baud >> 16) & 0xff;
454 buf[3] = (baud >> 24) & 0xff;
457 /* For reference buf[4]=0 is 1 stop bits */
458 /* For reference buf[4]=1 is 1.5 stop bits */
459 /* For reference buf[4]=2 is 2 stop bits */
460 if (cflag & CSTOPB) {
461 buf[4] = 2;
462 dbg("%s - stop bits = 2", __FUNCTION__);
463 } else {
464 buf[4] = 0;
465 dbg("%s - stop bits = 1", __FUNCTION__);
468 if (cflag & PARENB) {
469 /* For reference buf[5]=0 is none parity */
470 /* For reference buf[5]=1 is odd parity */
471 /* For reference buf[5]=2 is even parity */
472 /* For reference buf[5]=3 is mark parity */
473 /* For reference buf[5]=4 is space parity */
474 if (cflag & PARODD) {
475 buf[5] = 1;
476 dbg("%s - parity = odd", __FUNCTION__);
477 } else {
478 buf[5] = 2;
479 dbg("%s - parity = even", __FUNCTION__);
481 } else {
482 buf[5] = 0;
483 dbg("%s - parity = none", __FUNCTION__);
486 i = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
487 SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
488 0, 0, buf, 7, 100);
489 dbg ("0x21:0x20:0:0 %d", i);
491 /* change control lines if we are switching to or from B0 */
492 spin_lock_irqsave(&priv->lock, flags);
493 control = priv->line_control;
494 if ((cflag & CBAUD) == B0)
495 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
496 else
497 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
498 if (control != priv->line_control) {
499 control = priv->line_control;
500 spin_unlock_irqrestore(&priv->lock, flags);
501 set_control_lines(serial->dev, control);
502 } else {
503 spin_unlock_irqrestore(&priv->lock, flags);
506 buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
508 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
509 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
510 0, 0, buf, 7, 100);
511 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
512 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
514 if (cflag & CRTSCTS) {
515 __u16 index;
516 if (priv->type == HX)
517 index = 0x61;
518 else
519 index = 0x41;
520 i = usb_control_msg(serial->dev,
521 usb_sndctrlpipe(serial->dev, 0),
522 VENDOR_WRITE_REQUEST,
523 VENDOR_WRITE_REQUEST_TYPE,
524 0x0, index, NULL, 0, 100);
525 dbg ("0x40:0x1:0x0:0x%x %d", index, i);
528 kfree (buf);
531 static int pl2303_open (struct usb_serial_port *port, struct file *filp)
533 struct termios tmp_termios;
534 struct usb_serial *serial = port->serial;
535 struct pl2303_private *priv = usb_get_serial_port_data(port);
536 unsigned char *buf;
537 int result;
539 dbg("%s - port %d", __FUNCTION__, port->number);
541 usb_clear_halt(serial->dev, port->write_urb->pipe);
542 usb_clear_halt(serial->dev, port->read_urb->pipe);
544 buf = kmalloc(10, GFP_KERNEL);
545 if (buf==NULL)
546 return -ENOMEM;
548 #define FISH(a,b,c,d) \
549 result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0), \
550 b, a, c, d, buf, 1, 100); \
551 dbg("0x%x:0x%x:0x%x:0x%x %d - %x",a,b,c,d,result,buf[0]);
553 #define SOUP(a,b,c,d) \
554 result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0), \
555 b, a, c, d, NULL, 0, 100); \
556 dbg("0x%x:0x%x:0x%x:0x%x %d",a,b,c,d,result);
558 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
559 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
560 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
561 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
562 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
563 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
564 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
565 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
566 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
567 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
569 if (priv->type == HX) {
570 /* HX chip */
571 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
572 /* reset upstream data pipes */
573 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
574 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
575 } else {
576 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
579 kfree(buf);
581 /* Setup termios */
582 if (port->tty) {
583 pl2303_set_termios (port, &tmp_termios);
586 //FIXME: need to assert RTS and DTR if CRTSCTS off
588 dbg("%s - submitting read urb", __FUNCTION__);
589 port->read_urb->dev = serial->dev;
590 result = usb_submit_urb (port->read_urb, GFP_KERNEL);
591 if (result) {
592 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
593 pl2303_close (port, NULL);
594 return -EPROTO;
597 dbg("%s - submitting interrupt urb", __FUNCTION__);
598 port->interrupt_in_urb->dev = serial->dev;
599 result = usb_submit_urb (port->interrupt_in_urb, GFP_KERNEL);
600 if (result) {
601 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n", __FUNCTION__, result);
602 pl2303_close (port, NULL);
603 return -EPROTO;
605 return 0;
609 static void pl2303_close (struct usb_serial_port *port, struct file *filp)
611 struct pl2303_private *priv = usb_get_serial_port_data(port);
612 unsigned long flags;
613 unsigned int c_cflag;
614 int bps;
615 long timeout;
616 wait_queue_t wait; \
618 dbg("%s - port %d", __FUNCTION__, port->number);
620 /* wait for data to drain from the buffer */
621 spin_lock_irqsave(&priv->lock, flags);
622 timeout = PL2303_CLOSING_WAIT;
623 init_waitqueue_entry(&wait, current);
624 add_wait_queue(&port->tty->write_wait, &wait);
625 for (;;) {
626 set_current_state(TASK_INTERRUPTIBLE);
627 if (pl2303_buf_data_avail(priv->buf) == 0
628 || timeout == 0 || signal_pending(current)
629 || !usb_get_intfdata(port->serial->interface)) /* disconnect */
630 break;
631 spin_unlock_irqrestore(&priv->lock, flags);
632 timeout = schedule_timeout(timeout);
633 spin_lock_irqsave(&priv->lock, flags);
635 set_current_state(TASK_RUNNING);
636 remove_wait_queue(&port->tty->write_wait, &wait);
637 /* clear out any remaining data in the buffer */
638 pl2303_buf_clear(priv->buf);
639 spin_unlock_irqrestore(&priv->lock, flags);
641 /* wait for characters to drain from the device */
642 /* (this is long enough for the entire 256 byte */
643 /* pl2303 hardware buffer to drain with no flow */
644 /* control for data rates of 1200 bps or more, */
645 /* for lower rates we should really know how much */
646 /* data is in the buffer to compute a delay */
647 /* that is not unnecessarily long) */
648 bps = tty_get_baud_rate(port->tty);
649 if (bps > 1200)
650 timeout = max((HZ*2560)/bps,HZ/10);
651 else
652 timeout = 2*HZ;
653 set_current_state(TASK_INTERRUPTIBLE);
654 schedule_timeout(timeout);
656 /* shutdown our urbs */
657 dbg("%s - shutting down urbs", __FUNCTION__);
658 usb_kill_urb(port->write_urb);
659 usb_kill_urb(port->read_urb);
660 usb_kill_urb(port->interrupt_in_urb);
662 if (port->tty) {
663 c_cflag = port->tty->termios->c_cflag;
664 if (c_cflag & HUPCL) {
665 /* drop DTR and RTS */
666 spin_lock_irqsave(&priv->lock, flags);
667 priv->line_control = 0;
668 spin_unlock_irqrestore (&priv->lock, flags);
669 set_control_lines (port->serial->dev, 0);
674 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
675 unsigned int set, unsigned int clear)
677 struct pl2303_private *priv = usb_get_serial_port_data(port);
678 unsigned long flags;
679 u8 control;
681 if (!usb_get_intfdata(port->serial->interface))
682 return -ENODEV;
684 spin_lock_irqsave (&priv->lock, flags);
685 if (set & TIOCM_RTS)
686 priv->line_control |= CONTROL_RTS;
687 if (set & TIOCM_DTR)
688 priv->line_control |= CONTROL_DTR;
689 if (clear & TIOCM_RTS)
690 priv->line_control &= ~CONTROL_RTS;
691 if (clear & TIOCM_DTR)
692 priv->line_control &= ~CONTROL_DTR;
693 control = priv->line_control;
694 spin_unlock_irqrestore (&priv->lock, flags);
696 return set_control_lines (port->serial->dev, control);
699 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file)
701 struct pl2303_private *priv = usb_get_serial_port_data(port);
702 unsigned long flags;
703 unsigned int mcr;
704 unsigned int status;
705 unsigned int result;
707 dbg("%s (%d)", __FUNCTION__, port->number);
709 if (!usb_get_intfdata(port->serial->interface))
710 return -ENODEV;
712 spin_lock_irqsave (&priv->lock, flags);
713 mcr = priv->line_control;
714 status = priv->line_status;
715 spin_unlock_irqrestore (&priv->lock, flags);
717 result = ((mcr & CONTROL_DTR) ? TIOCM_DTR : 0)
718 | ((mcr & CONTROL_RTS) ? TIOCM_RTS : 0)
719 | ((status & UART_CTS) ? TIOCM_CTS : 0)
720 | ((status & UART_DSR) ? TIOCM_DSR : 0)
721 | ((status & UART_RING) ? TIOCM_RI : 0)
722 | ((status & UART_DCD) ? TIOCM_CD : 0);
724 dbg("%s - result = %x", __FUNCTION__, result);
726 return result;
729 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
731 struct pl2303_private *priv = usb_get_serial_port_data(port);
732 unsigned long flags;
733 unsigned int prevstatus;
734 unsigned int status;
735 unsigned int changed;
737 spin_lock_irqsave (&priv->lock, flags);
738 prevstatus = priv->line_status;
739 spin_unlock_irqrestore (&priv->lock, flags);
741 while (1) {
742 interruptible_sleep_on(&priv->delta_msr_wait);
743 /* see if a signal did it */
744 if (signal_pending(current))
745 return -ERESTARTSYS;
747 spin_lock_irqsave (&priv->lock, flags);
748 status = priv->line_status;
749 spin_unlock_irqrestore (&priv->lock, flags);
751 changed=prevstatus^status;
753 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
754 ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
755 ((arg & TIOCM_CD) && (changed & UART_DCD)) ||
756 ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) {
757 return 0;
759 prevstatus = status;
761 /* NOTREACHED */
762 return 0;
765 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg)
767 dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd);
769 switch (cmd) {
770 case TIOCMIWAIT:
771 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__, port->number);
772 return wait_modem_info(port, arg);
774 default:
775 dbg("%s not supported = 0x%04x", __FUNCTION__, cmd);
776 break;
779 return -ENOIOCTLCMD;
782 static void pl2303_break_ctl (struct usb_serial_port *port, int break_state)
784 struct usb_serial *serial = port->serial;
785 u16 state;
786 int result;
788 dbg("%s - port %d", __FUNCTION__, port->number);
790 if (break_state == 0)
791 state = BREAK_OFF;
792 else
793 state = BREAK_ON;
794 dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on");
796 result = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
797 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
798 0, NULL, 0, 100);
799 if (result)
800 dbg("%s - error sending break = %d", __FUNCTION__, result);
804 static void pl2303_shutdown (struct usb_serial *serial)
806 int i;
807 struct pl2303_private *priv;
809 dbg("%s", __FUNCTION__);
811 for (i = 0; i < serial->num_ports; ++i) {
812 priv = usb_get_serial_port_data(serial->port[i]);
813 if (priv) {
814 pl2303_buf_free(priv->buf);
815 kfree(priv);
816 usb_set_serial_port_data(serial->port[i], NULL);
821 static void pl2303_update_line_status(struct usb_serial_port *port,
822 unsigned char *data,
823 unsigned int actual_length)
826 struct pl2303_private *priv = usb_get_serial_port_data(port);
827 unsigned long flags;
828 u8 status_idx = UART_STATE;
829 u8 length = UART_STATE;
831 if ((le16_to_cpu(port->serial->dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
832 (le16_to_cpu(port->serial->dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_X65)) {
833 length = 1;
834 status_idx = 0;
837 if (actual_length < length)
838 goto exit;
840 /* Save off the uart status for others to look at */
841 spin_lock_irqsave(&priv->lock, flags);
842 priv->line_status = data[status_idx];
843 spin_unlock_irqrestore(&priv->lock, flags);
845 exit:
846 return;
849 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs)
851 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
852 unsigned char *data = urb->transfer_buffer;
853 unsigned int actual_length = urb->actual_length;
854 int status;
856 dbg("%s (%d)", __FUNCTION__, port->number);
858 switch (urb->status) {
859 case 0:
860 /* success */
861 break;
862 case -ECONNRESET:
863 case -ENOENT:
864 case -ESHUTDOWN:
865 /* this urb is terminated, clean up */
866 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
867 return;
868 default:
869 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
870 goto exit;
873 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
874 pl2303_update_line_status(port, data, actual_length);
876 exit:
877 status = usb_submit_urb (urb, GFP_ATOMIC);
878 if (status)
879 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed with result %d\n",
880 __FUNCTION__, status);
884 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
886 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
887 struct pl2303_private *priv = usb_get_serial_port_data(port);
888 struct tty_struct *tty;
889 unsigned char *data = urb->transfer_buffer;
890 unsigned long flags;
891 int i;
892 int result;
893 u8 status;
894 char tty_flag;
896 dbg("%s - port %d", __FUNCTION__, port->number);
898 if (urb->status) {
899 dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
900 if (!port->open_count) {
901 dbg("%s - port is closed, exiting.", __FUNCTION__);
902 return;
904 if (urb->status == -EPROTO) {
905 /* PL2303 mysteriously fails with -EPROTO reschedule the read */
906 dbg("%s - caught -EPROTO, resubmitting the urb", __FUNCTION__);
907 urb->status = 0;
908 urb->dev = port->serial->dev;
909 result = usb_submit_urb(urb, GFP_ATOMIC);
910 if (result)
911 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
912 return;
914 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
915 return;
918 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
920 /* get tty_flag from status */
921 tty_flag = TTY_NORMAL;
923 spin_lock_irqsave(&priv->lock, flags);
924 status = priv->line_status;
925 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
926 spin_unlock_irqrestore(&priv->lock, flags);
927 wake_up_interruptible (&priv->delta_msr_wait);
929 /* break takes precedence over parity, */
930 /* which takes precedence over framing errors */
931 if (status & UART_BREAK_ERROR )
932 tty_flag = TTY_BREAK;
933 else if (status & UART_PARITY_ERROR)
934 tty_flag = TTY_PARITY;
935 else if (status & UART_FRAME_ERROR)
936 tty_flag = TTY_FRAME;
937 dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
939 tty = port->tty;
940 if (tty && urb->actual_length) {
941 /* overrun is special, not associated with a char */
942 if (status & UART_OVERRUN_ERROR)
943 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
945 for (i = 0; i < urb->actual_length; ++i) {
946 if (tty->flip.count >= TTY_FLIPBUF_SIZE) {
947 tty_flip_buffer_push(tty);
949 tty_insert_flip_char (tty, data[i], tty_flag);
951 tty_flip_buffer_push (tty);
954 /* Schedule the next read _if_ we are still open */
955 if (port->open_count) {
956 urb->dev = port->serial->dev;
957 result = usb_submit_urb(urb, GFP_ATOMIC);
958 if (result)
959 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
962 return;
967 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
969 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
970 struct pl2303_private *priv = usb_get_serial_port_data(port);
971 int result;
973 dbg("%s - port %d", __FUNCTION__, port->number);
975 switch (urb->status) {
976 case 0:
977 /* success */
978 break;
979 case -ECONNRESET:
980 case -ENOENT:
981 case -ESHUTDOWN:
982 /* this urb is terminated, clean up */
983 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
984 priv->write_urb_in_use = 0;
985 return;
986 default:
987 /* error in the urb, so we have to resubmit it */
988 dbg("%s - Overflow in write", __FUNCTION__);
989 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
990 port->write_urb->transfer_buffer_length = 1;
991 port->write_urb->dev = port->serial->dev;
992 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
993 if (result)
994 dev_err(&urb->dev->dev, "%s - failed resubmitting write urb, error %d\n", __FUNCTION__, result);
995 else
996 return;
999 priv->write_urb_in_use = 0;
1001 /* send any buffered data */
1002 pl2303_send(port);
1007 * pl2303_buf_alloc
1009 * Allocate a circular buffer and all associated memory.
1012 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
1015 struct pl2303_buf *pb;
1018 if (size == 0)
1019 return NULL;
1021 pb = (struct pl2303_buf *)kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
1022 if (pb == NULL)
1023 return NULL;
1025 pb->buf_buf = kmalloc(size, GFP_KERNEL);
1026 if (pb->buf_buf == NULL) {
1027 kfree(pb);
1028 return NULL;
1031 pb->buf_size = size;
1032 pb->buf_get = pb->buf_put = pb->buf_buf;
1034 return pb;
1040 * pl2303_buf_free
1042 * Free the buffer and all associated memory.
1045 static void pl2303_buf_free(struct pl2303_buf *pb)
1047 if (pb) {
1048 kfree(pb->buf_buf);
1049 kfree(pb);
1055 * pl2303_buf_clear
1057 * Clear out all data in the circular buffer.
1060 static void pl2303_buf_clear(struct pl2303_buf *pb)
1062 if (pb != NULL)
1063 pb->buf_get = pb->buf_put;
1064 /* equivalent to a get of all data available */
1069 * pl2303_buf_data_avail
1071 * Return the number of bytes of data available in the circular
1072 * buffer.
1075 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
1077 if (pb != NULL)
1078 return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
1079 else
1080 return 0;
1085 * pl2303_buf_space_avail
1087 * Return the number of bytes of space available in the circular
1088 * buffer.
1091 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
1093 if (pb != NULL)
1094 return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
1095 else
1096 return 0;
1101 * pl2303_buf_put
1103 * Copy data data from a user buffer and put it into the circular buffer.
1104 * Restrict to the amount of space available.
1106 * Return the number of bytes copied.
1109 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
1110 unsigned int count)
1113 unsigned int len;
1116 if (pb == NULL)
1117 return 0;
1119 len = pl2303_buf_space_avail(pb);
1120 if (count > len)
1121 count = len;
1123 if (count == 0)
1124 return 0;
1126 len = pb->buf_buf + pb->buf_size - pb->buf_put;
1127 if (count > len) {
1128 memcpy(pb->buf_put, buf, len);
1129 memcpy(pb->buf_buf, buf+len, count - len);
1130 pb->buf_put = pb->buf_buf + count - len;
1131 } else {
1132 memcpy(pb->buf_put, buf, count);
1133 if (count < len)
1134 pb->buf_put += count;
1135 else /* count == len */
1136 pb->buf_put = pb->buf_buf;
1139 return count;
1145 * pl2303_buf_get
1147 * Get data from the circular buffer and copy to the given buffer.
1148 * Restrict to the amount of data available.
1150 * Return the number of bytes copied.
1153 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
1154 unsigned int count)
1157 unsigned int len;
1160 if (pb == NULL)
1161 return 0;
1163 len = pl2303_buf_data_avail(pb);
1164 if (count > len)
1165 count = len;
1167 if (count == 0)
1168 return 0;
1170 len = pb->buf_buf + pb->buf_size - pb->buf_get;
1171 if (count > len) {
1172 memcpy(buf, pb->buf_get, len);
1173 memcpy(buf+len, pb->buf_buf, count - len);
1174 pb->buf_get = pb->buf_buf + count - len;
1175 } else {
1176 memcpy(buf, pb->buf_get, count);
1177 if (count < len)
1178 pb->buf_get += count;
1179 else /* count == len */
1180 pb->buf_get = pb->buf_buf;
1183 return count;
1187 static int __init pl2303_init (void)
1189 int retval;
1190 retval = usb_serial_register(&pl2303_device);
1191 if (retval)
1192 goto failed_usb_serial_register;
1193 retval = usb_register(&pl2303_driver);
1194 if (retval)
1195 goto failed_usb_register;
1196 info(DRIVER_DESC " " DRIVER_VERSION);
1197 return 0;
1198 failed_usb_register:
1199 usb_serial_deregister(&pl2303_device);
1200 failed_usb_serial_register:
1201 return retval;
1205 static void __exit pl2303_exit (void)
1207 usb_deregister (&pl2303_driver);
1208 usb_serial_deregister (&pl2303_device);
1212 module_init(pl2303_init);
1213 module_exit(pl2303_exit);
1215 MODULE_DESCRIPTION(DRIVER_DESC);
1216 MODULE_VERSION(DRIVER_VERSION);
1217 MODULE_LICENSE("GPL");
1219 module_param(debug, bool, S_IRUGO | S_IWUSR);
1220 MODULE_PARM_DESC(debug, "Debug enabled or not");