[PATCH] USB: Syntax cleanup for pl2303 (trailing backslash)
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / usb / serial / pl2303.c
blobd88704387202389af2376b848497ee2cf06a3210
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.
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"
32 #include "pl2303.h"
35 * Version Information
37 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
39 static int debug;
41 #define PL2303_CLOSING_WAIT (30*HZ)
43 #define PL2303_BUF_SIZE 1024
44 #define PL2303_TMP_BUF_SIZE 1024
46 struct pl2303_buf {
47 unsigned int buf_size;
48 char *buf_buf;
49 char *buf_get;
50 char *buf_put;
53 static struct usb_device_id id_table [] = {
54 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
55 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
56 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
57 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
58 { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
59 { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
60 { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
61 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
62 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
63 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
64 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
65 { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
66 { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
67 { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
68 { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
69 { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
70 { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
71 { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
72 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
73 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1) },
74 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
75 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75) },
76 { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
77 { USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
78 { USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
79 { USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
80 { USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
81 { USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
82 { USB_DEVICE(OTI_VENDOR_ID, OTI_PRODUCT_ID) },
83 { } /* Terminating entry */
86 MODULE_DEVICE_TABLE (usb, id_table);
88 static struct usb_driver pl2303_driver = {
89 .name = "pl2303",
90 .probe = usb_serial_probe,
91 .disconnect = usb_serial_disconnect,
92 .id_table = id_table,
93 .no_dynamic_id = 1,
96 #define SET_LINE_REQUEST_TYPE 0x21
97 #define SET_LINE_REQUEST 0x20
99 #define SET_CONTROL_REQUEST_TYPE 0x21
100 #define SET_CONTROL_REQUEST 0x22
101 #define CONTROL_DTR 0x01
102 #define CONTROL_RTS 0x02
104 #define BREAK_REQUEST_TYPE 0x21
105 #define BREAK_REQUEST 0x23
106 #define BREAK_ON 0xffff
107 #define BREAK_OFF 0x0000
109 #define GET_LINE_REQUEST_TYPE 0xa1
110 #define GET_LINE_REQUEST 0x21
112 #define VENDOR_WRITE_REQUEST_TYPE 0x40
113 #define VENDOR_WRITE_REQUEST 0x01
115 #define VENDOR_READ_REQUEST_TYPE 0xc0
116 #define VENDOR_READ_REQUEST 0x01
118 #define UART_STATE 0x08
119 #define UART_STATE_TRANSIENT_MASK 0x74
120 #define UART_DCD 0x01
121 #define UART_DSR 0x02
122 #define UART_BREAK_ERROR 0x04
123 #define UART_RING 0x08
124 #define UART_FRAME_ERROR 0x10
125 #define UART_PARITY_ERROR 0x20
126 #define UART_OVERRUN_ERROR 0x40
127 #define UART_CTS 0x80
129 /* function prototypes for a PL2303 serial converter */
130 static int pl2303_open (struct usb_serial_port *port, struct file *filp);
131 static void pl2303_close (struct usb_serial_port *port, struct file *filp);
132 static void pl2303_set_termios (struct usb_serial_port *port,
133 struct termios *old);
134 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file,
135 unsigned int cmd, unsigned long arg);
136 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs);
137 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
138 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
139 static int pl2303_write (struct usb_serial_port *port,
140 const unsigned char *buf, int count);
141 static void pl2303_send (struct usb_serial_port *port);
142 static int pl2303_write_room(struct usb_serial_port *port);
143 static int pl2303_chars_in_buffer(struct usb_serial_port *port);
144 static void pl2303_break_ctl(struct usb_serial_port *port,int break_state);
145 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file);
146 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
147 unsigned int set, unsigned int clear);
148 static int pl2303_startup (struct usb_serial *serial);
149 static void pl2303_shutdown (struct usb_serial *serial);
150 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size);
151 static void pl2303_buf_free(struct pl2303_buf *pb);
152 static void pl2303_buf_clear(struct pl2303_buf *pb);
153 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb);
154 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb);
155 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
156 unsigned int count);
157 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
158 unsigned int count);
161 /* All of the device info needed for the PL2303 SIO serial converter */
162 static struct usb_serial_driver pl2303_device = {
163 .driver = {
164 .owner = THIS_MODULE,
165 .name = "pl2303",
167 .id_table = id_table,
168 .num_interrupt_in = NUM_DONT_CARE,
169 .num_bulk_in = 1,
170 .num_bulk_out = 1,
171 .num_ports = 1,
172 .open = pl2303_open,
173 .close = pl2303_close,
174 .write = pl2303_write,
175 .ioctl = pl2303_ioctl,
176 .break_ctl = pl2303_break_ctl,
177 .set_termios = pl2303_set_termios,
178 .tiocmget = pl2303_tiocmget,
179 .tiocmset = pl2303_tiocmset,
180 .read_bulk_callback = pl2303_read_bulk_callback,
181 .read_int_callback = pl2303_read_int_callback,
182 .write_bulk_callback = pl2303_write_bulk_callback,
183 .write_room = pl2303_write_room,
184 .chars_in_buffer = pl2303_chars_in_buffer,
185 .attach = pl2303_startup,
186 .shutdown = pl2303_shutdown,
189 enum pl2303_type {
190 type_0, /* don't know the difference between type 0 and */
191 type_1, /* type 1, until someone from prolific tells us... */
192 HX, /* HX version of the pl2303 chip */
195 struct pl2303_private {
196 spinlock_t lock;
197 struct pl2303_buf *buf;
198 int write_urb_in_use;
199 wait_queue_head_t delta_msr_wait;
200 u8 line_control;
201 u8 line_status;
202 u8 termios_initialized;
203 enum pl2303_type type;
207 static int pl2303_startup (struct usb_serial *serial)
209 struct pl2303_private *priv;
210 enum pl2303_type type = type_0;
211 int i;
213 if (serial->dev->descriptor.bDeviceClass == 0x02)
214 type = type_0;
215 else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
216 type = HX;
217 else if (serial->dev->descriptor.bDeviceClass == 0x00)
218 type = type_1;
219 else if (serial->dev->descriptor.bDeviceClass == 0xFF)
220 type = type_1;
221 dbg("device type: %d", type);
223 for (i = 0; i < serial->num_ports; ++i) {
224 priv = kzalloc(sizeof(struct pl2303_private), GFP_KERNEL);
225 if (!priv)
226 goto cleanup;
227 spin_lock_init(&priv->lock);
228 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
229 if (priv->buf == NULL) {
230 kfree(priv);
231 goto cleanup;
233 init_waitqueue_head(&priv->delta_msr_wait);
234 priv->type = type;
235 usb_set_serial_port_data(serial->port[i], priv);
237 return 0;
239 cleanup:
240 for (--i; i>=0; --i) {
241 priv = usb_get_serial_port_data(serial->port[i]);
242 pl2303_buf_free(priv->buf);
243 kfree(priv);
244 usb_set_serial_port_data(serial->port[i], NULL);
246 return -ENOMEM;
249 static int set_control_lines (struct usb_device *dev, u8 value)
251 int retval;
253 retval = usb_control_msg (dev, usb_sndctrlpipe (dev, 0),
254 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
255 value, 0, NULL, 0, 100);
256 dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
257 return retval;
260 static int pl2303_write (struct usb_serial_port *port, const unsigned char *buf, int count)
262 struct pl2303_private *priv = usb_get_serial_port_data(port);
263 unsigned long flags;
265 dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
267 if (!count)
268 return count;
270 spin_lock_irqsave(&priv->lock, flags);
271 count = pl2303_buf_put(priv->buf, buf, count);
272 spin_unlock_irqrestore(&priv->lock, flags);
274 pl2303_send(port);
276 return count;
279 static void pl2303_send(struct usb_serial_port *port)
281 int count, result;
282 struct pl2303_private *priv = usb_get_serial_port_data(port);
283 unsigned long flags;
285 dbg("%s - port %d", __FUNCTION__, port->number);
287 spin_lock_irqsave(&priv->lock, flags);
289 if (priv->write_urb_in_use) {
290 spin_unlock_irqrestore(&priv->lock, flags);
291 return;
294 count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
295 port->bulk_out_size);
297 if (count == 0) {
298 spin_unlock_irqrestore(&priv->lock, flags);
299 return;
302 priv->write_urb_in_use = 1;
304 spin_unlock_irqrestore(&priv->lock, flags);
306 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, port->write_urb->transfer_buffer);
308 port->write_urb->transfer_buffer_length = count;
309 port->write_urb->dev = port->serial->dev;
310 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
311 if (result) {
312 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
313 priv->write_urb_in_use = 0;
314 // TODO: reschedule pl2303_send
317 usb_serial_port_softint(port);
320 static int pl2303_write_room(struct usb_serial_port *port)
322 struct pl2303_private *priv = usb_get_serial_port_data(port);
323 int room = 0;
324 unsigned long flags;
326 dbg("%s - port %d", __FUNCTION__, port->number);
328 spin_lock_irqsave(&priv->lock, flags);
329 room = pl2303_buf_space_avail(priv->buf);
330 spin_unlock_irqrestore(&priv->lock, flags);
332 dbg("%s - returns %d", __FUNCTION__, room);
333 return room;
336 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
338 struct pl2303_private *priv = usb_get_serial_port_data(port);
339 int chars = 0;
340 unsigned long flags;
342 dbg("%s - port %d", __FUNCTION__, port->number);
344 spin_lock_irqsave(&priv->lock, flags);
345 chars = pl2303_buf_data_avail(priv->buf);
346 spin_unlock_irqrestore(&priv->lock, flags);
348 dbg("%s - returns %d", __FUNCTION__, chars);
349 return chars;
352 static void pl2303_set_termios (struct usb_serial_port *port, struct termios *old_termios)
354 struct usb_serial *serial = port->serial;
355 struct pl2303_private *priv = usb_get_serial_port_data(port);
356 unsigned long flags;
357 unsigned int cflag;
358 unsigned char *buf;
359 int baud;
360 int i;
361 u8 control;
363 dbg("%s - port %d", __FUNCTION__, port->number);
365 if ((!port->tty) || (!port->tty->termios)) {
366 dbg("%s - no tty structures", __FUNCTION__);
367 return;
370 spin_lock_irqsave(&priv->lock, flags);
371 if (!priv->termios_initialized) {
372 *(port->tty->termios) = tty_std_termios;
373 port->tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
374 priv->termios_initialized = 1;
376 spin_unlock_irqrestore(&priv->lock, flags);
378 cflag = port->tty->termios->c_cflag;
379 /* check that they really want us to change something */
380 if (old_termios) {
381 if ((cflag == old_termios->c_cflag) &&
382 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
383 dbg("%s - nothing to change...", __FUNCTION__);
384 return;
388 buf = kzalloc (7, GFP_KERNEL);
389 if (!buf) {
390 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
391 return;
394 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
395 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
396 0, 0, buf, 7, 100);
397 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
398 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
401 if (cflag & CSIZE) {
402 switch (cflag & CSIZE) {
403 case CS5: buf[6] = 5; break;
404 case CS6: buf[6] = 6; break;
405 case CS7: buf[6] = 7; break;
406 default:
407 case CS8: buf[6] = 8; break;
409 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
412 baud = 0;
413 switch (cflag & CBAUD) {
414 case B0: baud = 0; break;
415 case B75: baud = 75; break;
416 case B150: baud = 150; break;
417 case B300: baud = 300; break;
418 case B600: baud = 600; break;
419 case B1200: baud = 1200; break;
420 case B1800: baud = 1800; break;
421 case B2400: baud = 2400; break;
422 case B4800: baud = 4800; break;
423 case B9600: baud = 9600; break;
424 case B19200: baud = 19200; break;
425 case B38400: baud = 38400; break;
426 case B57600: baud = 57600; break;
427 case B115200: baud = 115200; break;
428 case B230400: baud = 230400; break;
429 case B460800: baud = 460800; break;
430 default:
431 dev_err(&port->dev, "pl2303 driver does not support the baudrate requested (fix it)\n");
432 break;
434 dbg("%s - baud = %d", __FUNCTION__, baud);
435 if (baud) {
436 buf[0] = baud & 0xff;
437 buf[1] = (baud >> 8) & 0xff;
438 buf[2] = (baud >> 16) & 0xff;
439 buf[3] = (baud >> 24) & 0xff;
442 /* For reference buf[4]=0 is 1 stop bits */
443 /* For reference buf[4]=1 is 1.5 stop bits */
444 /* For reference buf[4]=2 is 2 stop bits */
445 if (cflag & CSTOPB) {
446 buf[4] = 2;
447 dbg("%s - stop bits = 2", __FUNCTION__);
448 } else {
449 buf[4] = 0;
450 dbg("%s - stop bits = 1", __FUNCTION__);
453 if (cflag & PARENB) {
454 /* For reference buf[5]=0 is none parity */
455 /* For reference buf[5]=1 is odd parity */
456 /* For reference buf[5]=2 is even parity */
457 /* For reference buf[5]=3 is mark parity */
458 /* For reference buf[5]=4 is space parity */
459 if (cflag & PARODD) {
460 buf[5] = 1;
461 dbg("%s - parity = odd", __FUNCTION__);
462 } else {
463 buf[5] = 2;
464 dbg("%s - parity = even", __FUNCTION__);
466 } else {
467 buf[5] = 0;
468 dbg("%s - parity = none", __FUNCTION__);
471 i = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
472 SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
473 0, 0, buf, 7, 100);
474 dbg ("0x21:0x20:0:0 %d", i);
476 /* change control lines if we are switching to or from B0 */
477 spin_lock_irqsave(&priv->lock, flags);
478 control = priv->line_control;
479 if ((cflag & CBAUD) == B0)
480 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
481 else
482 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
483 if (control != priv->line_control) {
484 control = priv->line_control;
485 spin_unlock_irqrestore(&priv->lock, flags);
486 set_control_lines(serial->dev, control);
487 } else {
488 spin_unlock_irqrestore(&priv->lock, flags);
491 buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
493 i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
494 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
495 0, 0, buf, 7, 100);
496 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i,
497 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
499 if (cflag & CRTSCTS) {
500 __u16 index;
501 if (priv->type == HX)
502 index = 0x61;
503 else
504 index = 0x41;
505 i = usb_control_msg(serial->dev,
506 usb_sndctrlpipe(serial->dev, 0),
507 VENDOR_WRITE_REQUEST,
508 VENDOR_WRITE_REQUEST_TYPE,
509 0x0, index, NULL, 0, 100);
510 dbg ("0x40:0x1:0x0:0x%x %d", index, i);
513 kfree (buf);
516 static int pl2303_open (struct usb_serial_port *port, struct file *filp)
518 struct termios tmp_termios;
519 struct usb_serial *serial = port->serial;
520 struct pl2303_private *priv = usb_get_serial_port_data(port);
521 unsigned char *buf;
522 int result;
524 dbg("%s - port %d", __FUNCTION__, port->number);
526 if (priv->type != HX) {
527 usb_clear_halt(serial->dev, port->write_urb->pipe);
528 usb_clear_halt(serial->dev, port->read_urb->pipe);
531 buf = kmalloc(10, GFP_KERNEL);
532 if (buf==NULL)
533 return -ENOMEM;
535 #define FISH(a,b,c,d) \
536 result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0), \
537 b, a, c, d, buf, 1, 100); \
538 dbg("0x%x:0x%x:0x%x:0x%x %d - %x",a,b,c,d,result,buf[0]);
540 #define SOUP(a,b,c,d) \
541 result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0), \
542 b, a, c, d, NULL, 0, 100); \
543 dbg("0x%x:0x%x:0x%x:0x%x %d",a,b,c,d,result);
545 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
546 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
547 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
548 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
549 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
550 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
551 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
552 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
553 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
554 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
556 if (priv->type == HX) {
557 /* HX chip */
558 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
559 /* reset upstream data pipes */
560 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
561 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
562 } else {
563 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
566 kfree(buf);
568 /* Setup termios */
569 if (port->tty) {
570 pl2303_set_termios (port, &tmp_termios);
573 //FIXME: need to assert RTS and DTR if CRTSCTS off
575 dbg("%s - submitting read urb", __FUNCTION__);
576 port->read_urb->dev = serial->dev;
577 result = usb_submit_urb (port->read_urb, GFP_KERNEL);
578 if (result) {
579 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
580 pl2303_close (port, NULL);
581 return -EPROTO;
584 dbg("%s - submitting interrupt urb", __FUNCTION__);
585 port->interrupt_in_urb->dev = serial->dev;
586 result = usb_submit_urb (port->interrupt_in_urb, GFP_KERNEL);
587 if (result) {
588 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n", __FUNCTION__, result);
589 pl2303_close (port, NULL);
590 return -EPROTO;
592 return 0;
596 static void pl2303_close (struct usb_serial_port *port, struct file *filp)
598 struct pl2303_private *priv = usb_get_serial_port_data(port);
599 unsigned long flags;
600 unsigned int c_cflag;
601 int bps;
602 long timeout;
603 wait_queue_t wait;
605 dbg("%s - port %d", __FUNCTION__, port->number);
607 /* wait for data to drain from the buffer */
608 spin_lock_irqsave(&priv->lock, flags);
609 timeout = PL2303_CLOSING_WAIT;
610 init_waitqueue_entry(&wait, current);
611 add_wait_queue(&port->tty->write_wait, &wait);
612 for (;;) {
613 set_current_state(TASK_INTERRUPTIBLE);
614 if (pl2303_buf_data_avail(priv->buf) == 0
615 || timeout == 0 || signal_pending(current)
616 || !usb_get_intfdata(port->serial->interface)) /* disconnect */
617 break;
618 spin_unlock_irqrestore(&priv->lock, flags);
619 timeout = schedule_timeout(timeout);
620 spin_lock_irqsave(&priv->lock, flags);
622 set_current_state(TASK_RUNNING);
623 remove_wait_queue(&port->tty->write_wait, &wait);
624 /* clear out any remaining data in the buffer */
625 pl2303_buf_clear(priv->buf);
626 spin_unlock_irqrestore(&priv->lock, flags);
628 /* wait for characters to drain from the device */
629 /* (this is long enough for the entire 256 byte */
630 /* pl2303 hardware buffer to drain with no flow */
631 /* control for data rates of 1200 bps or more, */
632 /* for lower rates we should really know how much */
633 /* data is in the buffer to compute a delay */
634 /* that is not unnecessarily long) */
635 bps = tty_get_baud_rate(port->tty);
636 if (bps > 1200)
637 timeout = max((HZ*2560)/bps,HZ/10);
638 else
639 timeout = 2*HZ;
640 schedule_timeout_interruptible(timeout);
642 /* shutdown our urbs */
643 dbg("%s - shutting down urbs", __FUNCTION__);
644 usb_kill_urb(port->write_urb);
645 usb_kill_urb(port->read_urb);
646 usb_kill_urb(port->interrupt_in_urb);
648 if (port->tty) {
649 c_cflag = port->tty->termios->c_cflag;
650 if (c_cflag & HUPCL) {
651 /* drop DTR and RTS */
652 spin_lock_irqsave(&priv->lock, flags);
653 priv->line_control = 0;
654 spin_unlock_irqrestore (&priv->lock, flags);
655 set_control_lines (port->serial->dev, 0);
660 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
661 unsigned int set, unsigned int clear)
663 struct pl2303_private *priv = usb_get_serial_port_data(port);
664 unsigned long flags;
665 u8 control;
667 if (!usb_get_intfdata(port->serial->interface))
668 return -ENODEV;
670 spin_lock_irqsave (&priv->lock, flags);
671 if (set & TIOCM_RTS)
672 priv->line_control |= CONTROL_RTS;
673 if (set & TIOCM_DTR)
674 priv->line_control |= CONTROL_DTR;
675 if (clear & TIOCM_RTS)
676 priv->line_control &= ~CONTROL_RTS;
677 if (clear & TIOCM_DTR)
678 priv->line_control &= ~CONTROL_DTR;
679 control = priv->line_control;
680 spin_unlock_irqrestore (&priv->lock, flags);
682 return set_control_lines (port->serial->dev, control);
685 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file)
687 struct pl2303_private *priv = usb_get_serial_port_data(port);
688 unsigned long flags;
689 unsigned int mcr;
690 unsigned int status;
691 unsigned int result;
693 dbg("%s (%d)", __FUNCTION__, port->number);
695 if (!usb_get_intfdata(port->serial->interface))
696 return -ENODEV;
698 spin_lock_irqsave (&priv->lock, flags);
699 mcr = priv->line_control;
700 status = priv->line_status;
701 spin_unlock_irqrestore (&priv->lock, flags);
703 result = ((mcr & CONTROL_DTR) ? TIOCM_DTR : 0)
704 | ((mcr & CONTROL_RTS) ? TIOCM_RTS : 0)
705 | ((status & UART_CTS) ? TIOCM_CTS : 0)
706 | ((status & UART_DSR) ? TIOCM_DSR : 0)
707 | ((status & UART_RING) ? TIOCM_RI : 0)
708 | ((status & UART_DCD) ? TIOCM_CD : 0);
710 dbg("%s - result = %x", __FUNCTION__, result);
712 return result;
715 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
717 struct pl2303_private *priv = usb_get_serial_port_data(port);
718 unsigned long flags;
719 unsigned int prevstatus;
720 unsigned int status;
721 unsigned int changed;
723 spin_lock_irqsave (&priv->lock, flags);
724 prevstatus = priv->line_status;
725 spin_unlock_irqrestore (&priv->lock, flags);
727 while (1) {
728 interruptible_sleep_on(&priv->delta_msr_wait);
729 /* see if a signal did it */
730 if (signal_pending(current))
731 return -ERESTARTSYS;
733 spin_lock_irqsave (&priv->lock, flags);
734 status = priv->line_status;
735 spin_unlock_irqrestore (&priv->lock, flags);
737 changed=prevstatus^status;
739 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
740 ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
741 ((arg & TIOCM_CD) && (changed & UART_DCD)) ||
742 ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) {
743 return 0;
745 prevstatus = status;
747 /* NOTREACHED */
748 return 0;
751 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg)
753 dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd);
755 switch (cmd) {
756 case TIOCMIWAIT:
757 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__, port->number);
758 return wait_modem_info(port, arg);
760 default:
761 dbg("%s not supported = 0x%04x", __FUNCTION__, cmd);
762 break;
765 return -ENOIOCTLCMD;
768 static void pl2303_break_ctl (struct usb_serial_port *port, int break_state)
770 struct usb_serial *serial = port->serial;
771 u16 state;
772 int result;
774 dbg("%s - port %d", __FUNCTION__, port->number);
776 if (break_state == 0)
777 state = BREAK_OFF;
778 else
779 state = BREAK_ON;
780 dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on");
782 result = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
783 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
784 0, NULL, 0, 100);
785 if (result)
786 dbg("%s - error sending break = %d", __FUNCTION__, result);
790 static void pl2303_shutdown (struct usb_serial *serial)
792 int i;
793 struct pl2303_private *priv;
795 dbg("%s", __FUNCTION__);
797 for (i = 0; i < serial->num_ports; ++i) {
798 priv = usb_get_serial_port_data(serial->port[i]);
799 if (priv) {
800 pl2303_buf_free(priv->buf);
801 kfree(priv);
802 usb_set_serial_port_data(serial->port[i], NULL);
807 static void pl2303_update_line_status(struct usb_serial_port *port,
808 unsigned char *data,
809 unsigned int actual_length)
812 struct pl2303_private *priv = usb_get_serial_port_data(port);
813 unsigned long flags;
814 u8 status_idx = UART_STATE;
815 u8 length = UART_STATE + 1;
817 if ((le16_to_cpu(port->serial->dev->descriptor.idVendor) == SIEMENS_VENDOR_ID) &&
818 (le16_to_cpu(port->serial->dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_X65 ||
819 le16_to_cpu(port->serial->dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_SX1 ||
820 le16_to_cpu(port->serial->dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_X75)) {
821 length = 1;
822 status_idx = 0;
825 if (actual_length < length)
826 goto exit;
828 /* Save off the uart status for others to look at */
829 spin_lock_irqsave(&priv->lock, flags);
830 priv->line_status = data[status_idx];
831 spin_unlock_irqrestore(&priv->lock, flags);
832 wake_up_interruptible (&priv->delta_msr_wait);
834 exit:
835 return;
838 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs)
840 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
841 unsigned char *data = urb->transfer_buffer;
842 unsigned int actual_length = urb->actual_length;
843 int status;
845 dbg("%s (%d)", __FUNCTION__, port->number);
847 switch (urb->status) {
848 case 0:
849 /* success */
850 break;
851 case -ECONNRESET:
852 case -ENOENT:
853 case -ESHUTDOWN:
854 /* this urb is terminated, clean up */
855 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
856 return;
857 default:
858 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
859 goto exit;
862 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
863 pl2303_update_line_status(port, data, actual_length);
865 exit:
866 status = usb_submit_urb (urb, GFP_ATOMIC);
867 if (status)
868 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed with result %d\n",
869 __FUNCTION__, status);
873 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
875 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
876 struct pl2303_private *priv = usb_get_serial_port_data(port);
877 struct tty_struct *tty;
878 unsigned char *data = urb->transfer_buffer;
879 unsigned long flags;
880 int i;
881 int result;
882 u8 status;
883 char tty_flag;
885 dbg("%s - port %d", __FUNCTION__, port->number);
887 if (urb->status) {
888 dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
889 if (!port->open_count) {
890 dbg("%s - port is closed, exiting.", __FUNCTION__);
891 return;
893 if (urb->status == -EPROTO) {
894 /* PL2303 mysteriously fails with -EPROTO reschedule the read */
895 dbg("%s - caught -EPROTO, resubmitting the urb", __FUNCTION__);
896 urb->status = 0;
897 urb->dev = port->serial->dev;
898 result = usb_submit_urb(urb, GFP_ATOMIC);
899 if (result)
900 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
901 return;
903 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
904 return;
907 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
909 /* get tty_flag from status */
910 tty_flag = TTY_NORMAL;
912 spin_lock_irqsave(&priv->lock, flags);
913 status = priv->line_status;
914 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
915 spin_unlock_irqrestore(&priv->lock, flags);
916 wake_up_interruptible (&priv->delta_msr_wait);
918 /* break takes precedence over parity, */
919 /* which takes precedence over framing errors */
920 if (status & UART_BREAK_ERROR )
921 tty_flag = TTY_BREAK;
922 else if (status & UART_PARITY_ERROR)
923 tty_flag = TTY_PARITY;
924 else if (status & UART_FRAME_ERROR)
925 tty_flag = TTY_FRAME;
926 dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
928 tty = port->tty;
929 if (tty && urb->actual_length) {
930 tty_buffer_request_room(tty, urb->actual_length + 1);
931 /* overrun is special, not associated with a char */
932 if (status & UART_OVERRUN_ERROR)
933 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
934 for (i = 0; i < urb->actual_length; ++i)
935 tty_insert_flip_char (tty, data[i], tty_flag);
936 tty_flip_buffer_push (tty);
939 /* Schedule the next read _if_ we are still open */
940 if (port->open_count) {
941 urb->dev = port->serial->dev;
942 result = usb_submit_urb(urb, GFP_ATOMIC);
943 if (result)
944 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
947 return;
952 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
954 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
955 struct pl2303_private *priv = usb_get_serial_port_data(port);
956 int result;
958 dbg("%s - port %d", __FUNCTION__, port->number);
960 switch (urb->status) {
961 case 0:
962 /* success */
963 break;
964 case -ECONNRESET:
965 case -ENOENT:
966 case -ESHUTDOWN:
967 /* this urb is terminated, clean up */
968 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
969 priv->write_urb_in_use = 0;
970 return;
971 default:
972 /* error in the urb, so we have to resubmit it */
973 dbg("%s - Overflow in write", __FUNCTION__);
974 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
975 port->write_urb->transfer_buffer_length = 1;
976 port->write_urb->dev = port->serial->dev;
977 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
978 if (result)
979 dev_err(&urb->dev->dev, "%s - failed resubmitting write urb, error %d\n", __FUNCTION__, result);
980 else
981 return;
984 priv->write_urb_in_use = 0;
986 /* send any buffered data */
987 pl2303_send(port);
992 * pl2303_buf_alloc
994 * Allocate a circular buffer and all associated memory.
997 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
1000 struct pl2303_buf *pb;
1003 if (size == 0)
1004 return NULL;
1006 pb = (struct pl2303_buf *)kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
1007 if (pb == NULL)
1008 return NULL;
1010 pb->buf_buf = kmalloc(size, GFP_KERNEL);
1011 if (pb->buf_buf == NULL) {
1012 kfree(pb);
1013 return NULL;
1016 pb->buf_size = size;
1017 pb->buf_get = pb->buf_put = pb->buf_buf;
1019 return pb;
1025 * pl2303_buf_free
1027 * Free the buffer and all associated memory.
1030 static void pl2303_buf_free(struct pl2303_buf *pb)
1032 if (pb) {
1033 kfree(pb->buf_buf);
1034 kfree(pb);
1040 * pl2303_buf_clear
1042 * Clear out all data in the circular buffer.
1045 static void pl2303_buf_clear(struct pl2303_buf *pb)
1047 if (pb != NULL)
1048 pb->buf_get = pb->buf_put;
1049 /* equivalent to a get of all data available */
1054 * pl2303_buf_data_avail
1056 * Return the number of bytes of data available in the circular
1057 * buffer.
1060 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
1062 if (pb != NULL)
1063 return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
1064 else
1065 return 0;
1070 * pl2303_buf_space_avail
1072 * Return the number of bytes of space available in the circular
1073 * buffer.
1076 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
1078 if (pb != NULL)
1079 return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
1080 else
1081 return 0;
1086 * pl2303_buf_put
1088 * Copy data data from a user buffer and put it into the circular buffer.
1089 * Restrict to the amount of space available.
1091 * Return the number of bytes copied.
1094 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
1095 unsigned int count)
1098 unsigned int len;
1101 if (pb == NULL)
1102 return 0;
1104 len = pl2303_buf_space_avail(pb);
1105 if (count > len)
1106 count = len;
1108 if (count == 0)
1109 return 0;
1111 len = pb->buf_buf + pb->buf_size - pb->buf_put;
1112 if (count > len) {
1113 memcpy(pb->buf_put, buf, len);
1114 memcpy(pb->buf_buf, buf+len, count - len);
1115 pb->buf_put = pb->buf_buf + count - len;
1116 } else {
1117 memcpy(pb->buf_put, buf, count);
1118 if (count < len)
1119 pb->buf_put += count;
1120 else /* count == len */
1121 pb->buf_put = pb->buf_buf;
1124 return count;
1130 * pl2303_buf_get
1132 * Get data from the circular buffer and copy to the given buffer.
1133 * Restrict to the amount of data available.
1135 * Return the number of bytes copied.
1138 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
1139 unsigned int count)
1142 unsigned int len;
1145 if (pb == NULL)
1146 return 0;
1148 len = pl2303_buf_data_avail(pb);
1149 if (count > len)
1150 count = len;
1152 if (count == 0)
1153 return 0;
1155 len = pb->buf_buf + pb->buf_size - pb->buf_get;
1156 if (count > len) {
1157 memcpy(buf, pb->buf_get, len);
1158 memcpy(buf+len, pb->buf_buf, count - len);
1159 pb->buf_get = pb->buf_buf + count - len;
1160 } else {
1161 memcpy(buf, pb->buf_get, count);
1162 if (count < len)
1163 pb->buf_get += count;
1164 else /* count == len */
1165 pb->buf_get = pb->buf_buf;
1168 return count;
1172 static int __init pl2303_init (void)
1174 int retval;
1175 retval = usb_serial_register(&pl2303_device);
1176 if (retval)
1177 goto failed_usb_serial_register;
1178 retval = usb_register(&pl2303_driver);
1179 if (retval)
1180 goto failed_usb_register;
1181 info(DRIVER_DESC);
1182 return 0;
1183 failed_usb_register:
1184 usb_serial_deregister(&pl2303_device);
1185 failed_usb_serial_register:
1186 return retval;
1190 static void __exit pl2303_exit (void)
1192 usb_deregister (&pl2303_driver);
1193 usb_serial_deregister (&pl2303_device);
1197 module_init(pl2303_init);
1198 module_exit(pl2303_exit);
1200 MODULE_DESCRIPTION(DRIVER_DESC);
1201 MODULE_LICENSE("GPL");
1203 module_param(debug, bool, S_IRUGO | S_IWUSR);
1204 MODULE_PARM_DESC(debug, "Debug enabled or not");