Merge branch 'upstream-linus' of master.kernel.org:/pub/scm/linux/kernel/git/jgarzik...
[linux-2.6] / drivers / usb / serial / pl2303.c
1 /*
2  * Prolific PL2303 USB to serial adaptor driver
3  *
4  * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
5  * Copyright (C) 2003 IBM Corp.
6  *
7  * Original driver for 2.2.x by anonymous
8  *
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.
12  *
13  * See Documentation/usb/usb-serial.txt for more information on using this driver
14  *
15  */
16
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/init.h>
20 #include <linux/slab.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/tty_flip.h>
24 #include <linux/serial.h>
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/spinlock.h>
28 #include <asm/uaccess.h>
29 #include <linux/usb.h>
30 #include <linux/usb/serial.h>
31 #include "pl2303.h"
32
33 /*
34  * Version Information
35  */
36 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
37
38 static int debug;
39
40 #define PL2303_CLOSING_WAIT     (30*HZ)
41
42 #define PL2303_BUF_SIZE         1024
43 #define PL2303_TMP_BUF_SIZE     1024
44
45 struct pl2303_buf {
46         unsigned int    buf_size;
47         char            *buf_buf;
48         char            *buf_get;
49         char            *buf_put;
50 };
51
52 static struct usb_device_id id_table [] = {
53         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
54         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
55         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
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(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
83         { USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
84         { USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID) },
85         { }                                     /* Terminating entry */
86 };
87
88 MODULE_DEVICE_TABLE(usb, id_table);
89
90 static struct usb_driver pl2303_driver = {
91         .name =         "pl2303",
92         .probe =        usb_serial_probe,
93         .disconnect =   usb_serial_disconnect,
94         .id_table =     id_table,
95         .no_dynamic_id =        1,
96 };
97
98 #define SET_LINE_REQUEST_TYPE           0x21
99 #define SET_LINE_REQUEST                0x20
100
101 #define SET_CONTROL_REQUEST_TYPE        0x21
102 #define SET_CONTROL_REQUEST             0x22
103 #define CONTROL_DTR                     0x01
104 #define CONTROL_RTS                     0x02
105
106 #define BREAK_REQUEST_TYPE              0x21
107 #define BREAK_REQUEST                   0x23    
108 #define BREAK_ON                        0xffff
109 #define BREAK_OFF                       0x0000
110
111 #define GET_LINE_REQUEST_TYPE           0xa1
112 #define GET_LINE_REQUEST                0x21
113
114 #define VENDOR_WRITE_REQUEST_TYPE       0x40
115 #define VENDOR_WRITE_REQUEST            0x01
116
117 #define VENDOR_READ_REQUEST_TYPE        0xc0
118 #define VENDOR_READ_REQUEST             0x01
119
120 #define UART_STATE                      0x08
121 #define UART_STATE_TRANSIENT_MASK       0x74
122 #define UART_DCD                        0x01
123 #define UART_DSR                        0x02
124 #define UART_BREAK_ERROR                0x04
125 #define UART_RING                       0x08
126 #define UART_FRAME_ERROR                0x10
127 #define UART_PARITY_ERROR               0x20
128 #define UART_OVERRUN_ERROR              0x40
129 #define UART_CTS                        0x80
130
131
132 enum pl2303_type {
133         type_0,         /* don't know the difference between type 0 and */
134         type_1,         /* type 1, until someone from prolific tells us... */
135         HX,             /* HX version of the pl2303 chip */
136 };
137
138 struct pl2303_private {
139         spinlock_t lock;
140         struct pl2303_buf *buf;
141         int write_urb_in_use;
142         wait_queue_head_t delta_msr_wait;
143         u8 line_control;
144         u8 line_status;
145         u8 termios_initialized;
146         enum pl2303_type type;
147 };
148
149 /*
150  * pl2303_buf_alloc
151  *
152  * Allocate a circular buffer and all associated memory.
153  */
154 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
155 {
156         struct pl2303_buf *pb;
157
158         if (size == 0)
159                 return NULL;
160
161         pb = (struct pl2303_buf *)kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
162         if (pb == NULL)
163                 return NULL;
164
165         pb->buf_buf = kmalloc(size, GFP_KERNEL);
166         if (pb->buf_buf == NULL) {
167                 kfree(pb);
168                 return NULL;
169         }
170
171         pb->buf_size = size;
172         pb->buf_get = pb->buf_put = pb->buf_buf;
173
174         return pb;
175 }
176
177 /*
178  * pl2303_buf_free
179  *
180  * Free the buffer and all associated memory.
181  */
182 static void pl2303_buf_free(struct pl2303_buf *pb)
183 {
184         if (pb) {
185                 kfree(pb->buf_buf);
186                 kfree(pb);
187         }
188 }
189
190 /*
191  * pl2303_buf_clear
192  *
193  * Clear out all data in the circular buffer.
194  */
195 static void pl2303_buf_clear(struct pl2303_buf *pb)
196 {
197         if (pb != NULL)
198                 pb->buf_get = pb->buf_put;
199                 /* equivalent to a get of all data available */
200 }
201
202 /*
203  * pl2303_buf_data_avail
204  *
205  * Return the number of bytes of data available in the circular
206  * buffer.
207  */
208 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
209 {
210         if (pb == NULL)
211                 return 0;
212
213         return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
214 }
215
216 /*
217  * pl2303_buf_space_avail
218  *
219  * Return the number of bytes of space available in the circular
220  * buffer.
221  */
222 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
223 {
224         if (pb == NULL)
225                 return 0;
226
227         return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
228 }
229
230 /*
231  * pl2303_buf_put
232  *
233  * Copy data data from a user buffer and put it into the circular buffer.
234  * Restrict to the amount of space available.
235  *
236  * Return the number of bytes copied.
237  */
238 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
239                                    unsigned int count)
240 {
241         unsigned int len;
242
243         if (pb == NULL)
244                 return 0;
245
246         len  = pl2303_buf_space_avail(pb);
247         if (count > len)
248                 count = len;
249
250         if (count == 0)
251                 return 0;
252
253         len = pb->buf_buf + pb->buf_size - pb->buf_put;
254         if (count > len) {
255                 memcpy(pb->buf_put, buf, len);
256                 memcpy(pb->buf_buf, buf+len, count - len);
257                 pb->buf_put = pb->buf_buf + count - len;
258         } else {
259                 memcpy(pb->buf_put, buf, count);
260                 if (count < len)
261                         pb->buf_put += count;
262                 else /* count == len */
263                         pb->buf_put = pb->buf_buf;
264         }
265
266         return count;
267 }
268
269 /*
270  * pl2303_buf_get
271  *
272  * Get data from the circular buffer and copy to the given buffer.
273  * Restrict to the amount of data available.
274  *
275  * Return the number of bytes copied.
276  */
277 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
278                                    unsigned int count)
279 {
280         unsigned int len;
281
282         if (pb == NULL)
283                 return 0;
284
285         len = pl2303_buf_data_avail(pb);
286         if (count > len)
287                 count = len;
288
289         if (count == 0)
290                 return 0;
291
292         len = pb->buf_buf + pb->buf_size - pb->buf_get;
293         if (count > len) {
294                 memcpy(buf, pb->buf_get, len);
295                 memcpy(buf+len, pb->buf_buf, count - len);
296                 pb->buf_get = pb->buf_buf + count - len;
297         } else {
298                 memcpy(buf, pb->buf_get, count);
299                 if (count < len)
300                         pb->buf_get += count;
301                 else /* count == len */
302                         pb->buf_get = pb->buf_buf;
303         }
304
305         return count;
306 }
307
308 static int pl2303_startup(struct usb_serial *serial)
309 {
310         struct pl2303_private *priv;
311         enum pl2303_type type = type_0;
312         int i;
313
314         if (serial->dev->descriptor.bDeviceClass == 0x02)
315                 type = type_0;
316         else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
317                 type = HX;
318         else if (serial->dev->descriptor.bDeviceClass == 0x00)
319                 type = type_1;
320         else if (serial->dev->descriptor.bDeviceClass == 0xFF)
321                 type = type_1;
322         dbg("device type: %d", type);
323
324         for (i = 0; i < serial->num_ports; ++i) {
325                 priv = kzalloc(sizeof(struct pl2303_private), GFP_KERNEL);
326                 if (!priv)
327                         goto cleanup;
328                 spin_lock_init(&priv->lock);
329                 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
330                 if (priv->buf == NULL) {
331                         kfree(priv);
332                         goto cleanup;
333                 }
334                 init_waitqueue_head(&priv->delta_msr_wait);
335                 priv->type = type;
336                 usb_set_serial_port_data(serial->port[i], priv);
337         }
338         return 0;
339
340 cleanup:
341         for (--i; i>=0; --i) {
342                 priv = usb_get_serial_port_data(serial->port[i]);
343                 pl2303_buf_free(priv->buf);
344                 kfree(priv);
345                 usb_set_serial_port_data(serial->port[i], NULL);
346         }
347         return -ENOMEM;
348 }
349
350 static int set_control_lines(struct usb_device *dev, u8 value)
351 {
352         int retval;
353         
354         retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
355                                  SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
356                                  value, 0, NULL, 0, 100);
357         dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
358         return retval;
359 }
360
361 static void pl2303_send(struct usb_serial_port *port)
362 {
363         int count, result;
364         struct pl2303_private *priv = usb_get_serial_port_data(port);
365         unsigned long flags;
366
367         dbg("%s - port %d", __FUNCTION__, port->number);
368
369         spin_lock_irqsave(&priv->lock, flags);
370
371         if (priv->write_urb_in_use) {
372                 spin_unlock_irqrestore(&priv->lock, flags);
373                 return;
374         }
375
376         count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
377                                port->bulk_out_size);
378
379         if (count == 0) {
380                 spin_unlock_irqrestore(&priv->lock, flags);
381                 return;
382         }
383
384         priv->write_urb_in_use = 1;
385
386         spin_unlock_irqrestore(&priv->lock, flags);
387
388         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count,
389                               port->write_urb->transfer_buffer);
390
391         port->write_urb->transfer_buffer_length = count;
392         port->write_urb->dev = port->serial->dev;
393         result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
394         if (result) {
395                 dev_err(&port->dev, "%s - failed submitting write urb,"
396                         " error %d\n", __FUNCTION__, result);
397                 priv->write_urb_in_use = 0;
398                 // TODO: reschedule pl2303_send
399         }
400
401         usb_serial_port_softint(port);
402 }
403
404 static int pl2303_write(struct usb_serial_port *port, const unsigned char *buf,
405                         int count)
406 {
407         struct pl2303_private *priv = usb_get_serial_port_data(port);
408         unsigned long flags;
409
410         dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
411
412         if (!count)
413                 return count;
414
415         spin_lock_irqsave(&priv->lock, flags);
416         count = pl2303_buf_put(priv->buf, buf, count);
417         spin_unlock_irqrestore(&priv->lock, flags);
418
419         pl2303_send(port);
420
421         return count;
422 }
423
424 static int pl2303_write_room(struct usb_serial_port *port)
425 {
426         struct pl2303_private *priv = usb_get_serial_port_data(port);
427         int room = 0;
428         unsigned long flags;
429
430         dbg("%s - port %d", __FUNCTION__, port->number);
431
432         spin_lock_irqsave(&priv->lock, flags);
433         room = pl2303_buf_space_avail(priv->buf);
434         spin_unlock_irqrestore(&priv->lock, flags);
435
436         dbg("%s - returns %d", __FUNCTION__, room);
437         return room;
438 }
439
440 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
441 {
442         struct pl2303_private *priv = usb_get_serial_port_data(port);
443         int chars = 0;
444         unsigned long flags;
445
446         dbg("%s - port %d", __FUNCTION__, port->number);
447
448         spin_lock_irqsave(&priv->lock, flags);
449         chars = pl2303_buf_data_avail(priv->buf);
450         spin_unlock_irqrestore(&priv->lock, flags);
451
452         dbg("%s - returns %d", __FUNCTION__, chars);
453         return chars;
454 }
455
456 static void pl2303_set_termios(struct usb_serial_port *port,
457                                struct termios *old_termios)
458 {
459         struct usb_serial *serial = port->serial;
460         struct pl2303_private *priv = usb_get_serial_port_data(port);
461         unsigned long flags;
462         unsigned int cflag;
463         unsigned char *buf;
464         int baud;
465         int i;
466         u8 control;
467
468         dbg("%s -  port %d", __FUNCTION__, port->number);
469
470         if ((!port->tty) || (!port->tty->termios)) {
471                 dbg("%s - no tty structures", __FUNCTION__);
472                 return;
473         }
474
475         spin_lock_irqsave(&priv->lock, flags);
476         if (!priv->termios_initialized) {
477                 *(port->tty->termios) = tty_std_termios;
478                 port->tty->termios->c_cflag = B9600 | CS8 | CREAD |
479                                               HUPCL | CLOCAL;
480                 priv->termios_initialized = 1;
481         }
482         spin_unlock_irqrestore(&priv->lock, flags);
483
484         cflag = port->tty->termios->c_cflag;
485         /* check that they really want us to change something */
486         if (old_termios) {
487                 if ((cflag == old_termios->c_cflag) &&
488                     (RELEVANT_IFLAG(port->tty->termios->c_iflag) ==
489                      RELEVANT_IFLAG(old_termios->c_iflag))) {
490                         dbg("%s - nothing to change...", __FUNCTION__);
491                         return;
492                 }
493         }
494
495         buf = kzalloc(7, GFP_KERNEL);
496         if (!buf) {
497                 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
498                 return;
499         }
500
501         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
502                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
503                             0, 0, buf, 7, 100);
504         dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
505             buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
506
507         if (cflag & CSIZE) {
508                 switch (cflag & CSIZE) {
509                         case CS5:       buf[6] = 5;     break;
510                         case CS6:       buf[6] = 6;     break;
511                         case CS7:       buf[6] = 7;     break;
512                         default:
513                         case CS8:       buf[6] = 8;     break;
514                 }
515                 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
516         }
517
518         baud = 0;
519         switch (cflag & CBAUD) {
520                 case B0:        baud = 0;       break;
521                 case B75:       baud = 75;      break;
522                 case B150:      baud = 150;     break;
523                 case B300:      baud = 300;     break;
524                 case B600:      baud = 600;     break;
525                 case B1200:     baud = 1200;    break;
526                 case B1800:     baud = 1800;    break;
527                 case B2400:     baud = 2400;    break;
528                 case B4800:     baud = 4800;    break;
529                 case B9600:     baud = 9600;    break;
530                 case B19200:    baud = 19200;   break;
531                 case B38400:    baud = 38400;   break;
532                 case B57600:    baud = 57600;   break;
533                 case B115200:   baud = 115200;  break;
534                 case B230400:   baud = 230400;  break;
535                 case B460800:   baud = 460800;  break;
536                 default:
537                         dev_err(&port->dev, "pl2303 driver does not support"
538                                 " the baudrate requested (fix it)\n");
539                         break;
540         }
541         dbg("%s - baud = %d", __FUNCTION__, baud);
542         if (baud) {
543                 buf[0] = baud & 0xff;
544                 buf[1] = (baud >> 8) & 0xff;
545                 buf[2] = (baud >> 16) & 0xff;
546                 buf[3] = (baud >> 24) & 0xff;
547         }
548
549         /* For reference buf[4]=0 is 1 stop bits */
550         /* For reference buf[4]=1 is 1.5 stop bits */
551         /* For reference buf[4]=2 is 2 stop bits */
552         if (cflag & CSTOPB) {
553                 buf[4] = 2;
554                 dbg("%s - stop bits = 2", __FUNCTION__);
555         } else {
556                 buf[4] = 0;
557                 dbg("%s - stop bits = 1", __FUNCTION__);
558         }
559
560         if (cflag & PARENB) {
561                 /* For reference buf[5]=0 is none parity */
562                 /* For reference buf[5]=1 is odd parity */
563                 /* For reference buf[5]=2 is even parity */
564                 /* For reference buf[5]=3 is mark parity */
565                 /* For reference buf[5]=4 is space parity */
566                 if (cflag & PARODD) {
567                         buf[5] = 1;
568                         dbg("%s - parity = odd", __FUNCTION__);
569                 } else {
570                         buf[5] = 2;
571                         dbg("%s - parity = even", __FUNCTION__);
572                 }
573         } else {
574                 buf[5] = 0;
575                 dbg("%s - parity = none", __FUNCTION__);
576         }
577
578         i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
579                             SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
580                             0, 0, buf, 7, 100);
581         dbg("0x21:0x20:0:0  %d", i);
582
583         /* change control lines if we are switching to or from B0 */
584         spin_lock_irqsave(&priv->lock, flags);
585         control = priv->line_control;
586         if ((cflag & CBAUD) == B0)
587                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
588         else
589                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
590         if (control != priv->line_control) {
591                 control = priv->line_control;
592                 spin_unlock_irqrestore(&priv->lock, flags);
593                 set_control_lines(serial->dev, control);
594         } else {
595                 spin_unlock_irqrestore(&priv->lock, flags);
596         }
597
598         buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
599
600         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
601                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
602                             0, 0, buf, 7, 100);
603         dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
604              buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
605
606         if (cflag & CRTSCTS) {
607                 __u16 index;
608                 if (priv->type == HX)
609                         index = 0x61;
610                 else
611                         index = 0x41;
612                 i = usb_control_msg(serial->dev,
613                                     usb_sndctrlpipe(serial->dev, 0),
614                                     VENDOR_WRITE_REQUEST,
615                                     VENDOR_WRITE_REQUEST_TYPE,
616                                     0x0, index, NULL, 0, 100);
617                 dbg("0x40:0x1:0x0:0x%x  %d", index, i);
618         }
619
620         kfree(buf);
621 }
622
623 static void pl2303_close(struct usb_serial_port *port, struct file *filp)
624 {
625         struct pl2303_private *priv = usb_get_serial_port_data(port);
626         unsigned long flags;
627         unsigned int c_cflag;
628         int bps;
629         long timeout;
630         wait_queue_t wait;
631
632         dbg("%s - port %d", __FUNCTION__, port->number);
633
634         /* wait for data to drain from the buffer */
635         spin_lock_irqsave(&priv->lock, flags);
636         timeout = PL2303_CLOSING_WAIT;
637         init_waitqueue_entry(&wait, current);
638         add_wait_queue(&port->tty->write_wait, &wait);
639         for (;;) {
640                 set_current_state(TASK_INTERRUPTIBLE);
641                 if (pl2303_buf_data_avail(priv->buf) == 0 ||
642                     timeout == 0 || signal_pending(current) ||
643                     !usb_get_intfdata(port->serial->interface)) /* disconnect */
644                         break;
645                 spin_unlock_irqrestore(&priv->lock, flags);
646                 timeout = schedule_timeout(timeout);
647                 spin_lock_irqsave(&priv->lock, flags);
648         }
649         set_current_state(TASK_RUNNING);
650         remove_wait_queue(&port->tty->write_wait, &wait);
651         /* clear out any remaining data in the buffer */
652         pl2303_buf_clear(priv->buf);
653         spin_unlock_irqrestore(&priv->lock, flags);
654
655         /* wait for characters to drain from the device */
656         /* (this is long enough for the entire 256 byte */
657         /* pl2303 hardware buffer to drain with no flow */
658         /* control for data rates of 1200 bps or more, */
659         /* for lower rates we should really know how much */
660         /* data is in the buffer to compute a delay */
661         /* that is not unnecessarily long) */
662         bps = tty_get_baud_rate(port->tty);
663         if (bps > 1200)
664                 timeout = max((HZ*2560)/bps,HZ/10);
665         else
666                 timeout = 2*HZ;
667         schedule_timeout_interruptible(timeout);
668
669         /* shutdown our urbs */
670         dbg("%s - shutting down urbs", __FUNCTION__);
671         usb_kill_urb(port->write_urb);
672         usb_kill_urb(port->read_urb);
673         usb_kill_urb(port->interrupt_in_urb);
674
675         if (port->tty) {
676                 c_cflag = port->tty->termios->c_cflag;
677                 if (c_cflag & HUPCL) {
678                         /* drop DTR and RTS */
679                         spin_lock_irqsave(&priv->lock, flags);
680                         priv->line_control = 0;
681                         spin_unlock_irqrestore(&priv->lock, flags);
682                         set_control_lines(port->serial->dev, 0);
683                 }
684         }
685 }
686
687 static int pl2303_open(struct usb_serial_port *port, struct file *filp)
688 {
689         struct termios tmp_termios;
690         struct usb_serial *serial = port->serial;
691         struct pl2303_private *priv = usb_get_serial_port_data(port);
692         unsigned char *buf;
693         int result;
694
695         dbg("%s -  port %d", __FUNCTION__, port->number);
696
697         if (priv->type != HX) {
698                 usb_clear_halt(serial->dev, port->write_urb->pipe);
699                 usb_clear_halt(serial->dev, port->read_urb->pipe);
700         }
701
702         buf = kmalloc(10, GFP_KERNEL);
703         if (buf==NULL)
704                 return -ENOMEM;
705
706 #define FISH(a,b,c,d)                                                           \
707         result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0),     \
708                                b, a, c, d, buf, 1, 100);                        \
709         dbg("0x%x:0x%x:0x%x:0x%x  %d - %x",a,b,c,d,result,buf[0]);
710
711 #define SOUP(a,b,c,d)                                                           \
712         result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0),     \
713                                b, a, c, d, NULL, 0, 100);                       \
714         dbg("0x%x:0x%x:0x%x:0x%x  %d",a,b,c,d,result);
715
716         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
717         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
718         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
719         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
720         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
721         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
722         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
723         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
724         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
725         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
726
727         if (priv->type == HX) {
728                 /* HX chip */
729                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
730                 /* reset upstream data pipes */
731                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
732                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
733         } else {
734                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
735         }
736
737         kfree(buf);
738
739         /* Setup termios */
740         if (port->tty) {
741                 pl2303_set_termios(port, &tmp_termios);
742         }
743
744         //FIXME: need to assert RTS and DTR if CRTSCTS off
745
746         dbg("%s - submitting read urb", __FUNCTION__);
747         port->read_urb->dev = serial->dev;
748         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
749         if (result) {
750                 dev_err(&port->dev, "%s - failed submitting read urb,"
751                         " error %d\n", __FUNCTION__, result);
752                 pl2303_close(port, NULL);
753                 return -EPROTO;
754         }
755
756         dbg("%s - submitting interrupt urb", __FUNCTION__);
757         port->interrupt_in_urb->dev = serial->dev;
758         result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
759         if (result) {
760                 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
761                         " error %d\n", __FUNCTION__, result);
762                 pl2303_close(port, NULL);
763                 return -EPROTO;
764         }
765         return 0;
766 }
767
768 static int pl2303_tiocmset(struct usb_serial_port *port, struct file *file,
769                            unsigned int set, unsigned int clear)
770 {
771         struct pl2303_private *priv = usb_get_serial_port_data(port);
772         unsigned long flags;
773         u8 control;
774
775         if (!usb_get_intfdata(port->serial->interface))
776                 return -ENODEV;
777
778         spin_lock_irqsave(&priv->lock, flags);
779         if (set & TIOCM_RTS)
780                 priv->line_control |= CONTROL_RTS;
781         if (set & TIOCM_DTR)
782                 priv->line_control |= CONTROL_DTR;
783         if (clear & TIOCM_RTS)
784                 priv->line_control &= ~CONTROL_RTS;
785         if (clear & TIOCM_DTR)
786                 priv->line_control &= ~CONTROL_DTR;
787         control = priv->line_control;
788         spin_unlock_irqrestore(&priv->lock, flags);
789
790         return set_control_lines(port->serial->dev, control);
791 }
792
793 static int pl2303_tiocmget(struct usb_serial_port *port, struct file *file)
794 {
795         struct pl2303_private *priv = usb_get_serial_port_data(port);
796         unsigned long flags;
797         unsigned int mcr;
798         unsigned int status;
799         unsigned int result;
800
801         dbg("%s (%d)", __FUNCTION__, port->number);
802
803         if (!usb_get_intfdata(port->serial->interface))
804                 return -ENODEV;
805
806         spin_lock_irqsave(&priv->lock, flags);
807         mcr = priv->line_control;
808         status = priv->line_status;
809         spin_unlock_irqrestore(&priv->lock, flags);
810
811         result = ((mcr & CONTROL_DTR)           ? TIOCM_DTR : 0)
812                   | ((mcr & CONTROL_RTS)        ? TIOCM_RTS : 0)
813                   | ((status & UART_CTS)        ? TIOCM_CTS : 0)
814                   | ((status & UART_DSR)        ? TIOCM_DSR : 0)
815                   | ((status & UART_RING)       ? TIOCM_RI  : 0)
816                   | ((status & UART_DCD)        ? TIOCM_CD  : 0);
817
818         dbg("%s - result = %x", __FUNCTION__, result);
819
820         return result;
821 }
822
823 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
824 {
825         struct pl2303_private *priv = usb_get_serial_port_data(port);
826         unsigned long flags;
827         unsigned int prevstatus;
828         unsigned int status;
829         unsigned int changed;
830
831         spin_lock_irqsave(&priv->lock, flags);
832         prevstatus = priv->line_status;
833         spin_unlock_irqrestore(&priv->lock, flags);
834
835         while (1) {
836                 interruptible_sleep_on(&priv->delta_msr_wait);
837                 /* see if a signal did it */
838                 if (signal_pending(current))
839                         return -ERESTARTSYS;
840
841                 spin_lock_irqsave(&priv->lock, flags);
842                 status = priv->line_status;
843                 spin_unlock_irqrestore(&priv->lock, flags);
844
845                 changed=prevstatus^status;
846
847                 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
848                     ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
849                     ((arg & TIOCM_CD)  && (changed & UART_DCD)) ||
850                     ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) {
851                         return 0;
852                 }
853                 prevstatus = status;
854         }
855         /* NOTREACHED */
856         return 0;
857 }
858
859 static int pl2303_ioctl(struct usb_serial_port *port, struct file *file,
860                         unsigned int cmd, unsigned long arg)
861 {
862         dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd);
863
864         switch (cmd) {
865                 case TIOCMIWAIT:
866                         dbg("%s (%d) TIOCMIWAIT", __FUNCTION__,  port->number);
867                         return wait_modem_info(port, arg);
868
869                 default:
870                         dbg("%s not supported = 0x%04x", __FUNCTION__, cmd);
871                         break;
872         }
873
874         return -ENOIOCTLCMD;
875 }
876
877 static void pl2303_break_ctl(struct usb_serial_port *port, int break_state)
878 {
879         struct usb_serial *serial = port->serial;
880         u16 state;
881         int result;
882
883         dbg("%s - port %d", __FUNCTION__, port->number);
884
885         if (break_state == 0)
886                 state = BREAK_OFF;
887         else
888                 state = BREAK_ON;
889         dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on");
890
891         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
892                                  BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
893                                  0, NULL, 0, 100);
894         if (result)
895                 dbg("%s - error sending break = %d", __FUNCTION__, result);
896 }
897
898 static void pl2303_shutdown(struct usb_serial *serial)
899 {
900         int i;
901         struct pl2303_private *priv;
902
903         dbg("%s", __FUNCTION__);
904
905         for (i = 0; i < serial->num_ports; ++i) {
906                 priv = usb_get_serial_port_data(serial->port[i]);
907                 if (priv) {
908                         pl2303_buf_free(priv->buf);
909                         kfree(priv);
910                         usb_set_serial_port_data(serial->port[i], NULL);
911                 }
912         }
913 }
914
915 static void pl2303_update_line_status(struct usb_serial_port *port,
916                                       unsigned char *data,
917                                       unsigned int actual_length)
918 {
919
920         struct pl2303_private *priv = usb_get_serial_port_data(port);
921         unsigned long flags;
922         u8 status_idx = UART_STATE;
923         u8 length = UART_STATE + 1;
924         u16 idv, idp;
925
926         idv = le16_to_cpu(port->serial->dev->descriptor.idVendor);
927         idp = le16_to_cpu(port->serial->dev->descriptor.idProduct);
928
929
930         if (idv == SIEMENS_VENDOR_ID) {
931                 if (idp == SIEMENS_PRODUCT_ID_X65 ||
932                     idp == SIEMENS_PRODUCT_ID_SX1 ||
933                     idp == SIEMENS_PRODUCT_ID_X75) {
934
935                         length = 1;
936                         status_idx = 0;
937                 }
938         }
939
940         if (actual_length < length)
941                 return;
942
943         /* Save off the uart status for others to look at */
944         spin_lock_irqsave(&priv->lock, flags);
945         priv->line_status = data[status_idx];
946         spin_unlock_irqrestore(&priv->lock, flags);
947         wake_up_interruptible(&priv->delta_msr_wait);
948 }
949
950 static void pl2303_read_int_callback(struct urb *urb, struct pt_regs *regs)
951 {
952         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
953         unsigned char *data = urb->transfer_buffer;
954         unsigned int actual_length = urb->actual_length;
955         int status;
956
957         dbg("%s (%d)", __FUNCTION__, port->number);
958
959         switch (urb->status) {
960         case 0:
961                 /* success */
962                 break;
963         case -ECONNRESET:
964         case -ENOENT:
965         case -ESHUTDOWN:
966                 /* this urb is terminated, clean up */
967                 dbg("%s - urb shutting down with status: %d", __FUNCTION__,
968                     urb->status);
969                 return;
970         default:
971                 dbg("%s - nonzero urb status received: %d", __FUNCTION__,
972                     urb->status);
973                 goto exit;
974         }
975
976         usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
977                               urb->actual_length, urb->transfer_buffer);
978
979         pl2303_update_line_status(port, data, actual_length);
980
981 exit:
982         status = usb_submit_urb(urb, GFP_ATOMIC);
983         if (status)
984                 dev_err(&urb->dev->dev,
985                         "%s - usb_submit_urb failed with result %d\n",
986                         __FUNCTION__, status);
987 }
988
989 static void pl2303_read_bulk_callback(struct urb *urb, struct pt_regs *regs)
990 {
991         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
992         struct pl2303_private *priv = usb_get_serial_port_data(port);
993         struct tty_struct *tty;
994         unsigned char *data = urb->transfer_buffer;
995         unsigned long flags;
996         int i;
997         int result;
998         u8 status;
999         char tty_flag;
1000
1001         dbg("%s - port %d", __FUNCTION__, port->number);
1002
1003         if (urb->status) {
1004                 dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
1005                 if (!port->open_count) {
1006                         dbg("%s - port is closed, exiting.", __FUNCTION__);
1007                         return;
1008                 }
1009                 if (urb->status == -EPROTO) {
1010                         /* PL2303 mysteriously fails with -EPROTO reschedule
1011                          * the read */
1012                         dbg("%s - caught -EPROTO, resubmitting the urb",
1013                             __FUNCTION__);
1014                         urb->status = 0;
1015                         urb->dev = port->serial->dev;
1016                         result = usb_submit_urb(urb, GFP_ATOMIC);
1017                         if (result)
1018                                 dev_err(&urb->dev->dev, "%s - failed"
1019                                         " resubmitting read urb, error %d\n",
1020                                         __FUNCTION__, result);
1021                         return;
1022                 }
1023                 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
1024                 return;
1025         }
1026
1027         usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
1028                               urb->actual_length, data);
1029
1030         /* get tty_flag from status */
1031         tty_flag = TTY_NORMAL;
1032
1033         spin_lock_irqsave(&priv->lock, flags);
1034         status = priv->line_status;
1035         priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
1036         spin_unlock_irqrestore(&priv->lock, flags);
1037         wake_up_interruptible(&priv->delta_msr_wait);
1038
1039         /* break takes precedence over parity, */
1040         /* which takes precedence over framing errors */
1041         if (status & UART_BREAK_ERROR )
1042                 tty_flag = TTY_BREAK;
1043         else if (status & UART_PARITY_ERROR)
1044                 tty_flag = TTY_PARITY;
1045         else if (status & UART_FRAME_ERROR)
1046                 tty_flag = TTY_FRAME;
1047         dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
1048
1049         tty = port->tty;
1050         if (tty && urb->actual_length) {
1051                 tty_buffer_request_room(tty, urb->actual_length + 1);
1052                 /* overrun is special, not associated with a char */
1053                 if (status & UART_OVERRUN_ERROR)
1054                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1055                 for (i = 0; i < urb->actual_length; ++i)
1056                         tty_insert_flip_char(tty, data[i], tty_flag);
1057                 tty_flip_buffer_push(tty);
1058         }
1059
1060         /* Schedule the next read _if_ we are still open */
1061         if (port->open_count) {
1062                 urb->dev = port->serial->dev;
1063                 result = usb_submit_urb(urb, GFP_ATOMIC);
1064                 if (result)
1065                         dev_err(&urb->dev->dev, "%s - failed resubmitting"
1066                                 " read urb, error %d\n", __FUNCTION__, result);
1067         }
1068
1069         return;
1070 }
1071
1072 static void pl2303_write_bulk_callback(struct urb *urb, struct pt_regs *regs)
1073 {
1074         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
1075         struct pl2303_private *priv = usb_get_serial_port_data(port);
1076         int result;
1077
1078         dbg("%s - port %d", __FUNCTION__, port->number);
1079
1080         switch (urb->status) {
1081         case 0:
1082                 /* success */
1083                 break;
1084         case -ECONNRESET:
1085         case -ENOENT:
1086         case -ESHUTDOWN:
1087                 /* this urb is terminated, clean up */
1088                 dbg("%s - urb shutting down with status: %d", __FUNCTION__,
1089                     urb->status);
1090                 priv->write_urb_in_use = 0;
1091                 return;
1092         default:
1093                 /* error in the urb, so we have to resubmit it */
1094                 dbg("%s - Overflow in write", __FUNCTION__);
1095                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__,
1096                     urb->status);
1097                 port->write_urb->transfer_buffer_length = 1;
1098                 port->write_urb->dev = port->serial->dev;
1099                 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1100                 if (result)
1101                         dev_err(&urb->dev->dev, "%s - failed resubmitting write"
1102                                 " urb, error %d\n", __FUNCTION__, result);
1103                 else
1104                         return;
1105         }
1106
1107         priv->write_urb_in_use = 0;
1108
1109         /* send any buffered data */
1110         pl2303_send(port);
1111 }
1112
1113 /* All of the device info needed for the PL2303 SIO serial converter */
1114 static struct usb_serial_driver pl2303_device = {
1115         .driver = {
1116                 .owner =        THIS_MODULE,
1117                 .name =         "pl2303",
1118         },
1119         .id_table =             id_table,
1120         .num_interrupt_in =     NUM_DONT_CARE,
1121         .num_bulk_in =          1,
1122         .num_bulk_out =         1,
1123         .num_ports =            1,
1124         .open =                 pl2303_open,
1125         .close =                pl2303_close,
1126         .write =                pl2303_write,
1127         .ioctl =                pl2303_ioctl,
1128         .break_ctl =            pl2303_break_ctl,
1129         .set_termios =          pl2303_set_termios,
1130         .tiocmget =             pl2303_tiocmget,
1131         .tiocmset =             pl2303_tiocmset,
1132         .read_bulk_callback =   pl2303_read_bulk_callback,
1133         .read_int_callback =    pl2303_read_int_callback,
1134         .write_bulk_callback =  pl2303_write_bulk_callback,
1135         .write_room =           pl2303_write_room,
1136         .chars_in_buffer =      pl2303_chars_in_buffer,
1137         .attach =               pl2303_startup,
1138         .shutdown =             pl2303_shutdown,
1139 };
1140
1141 static int __init pl2303_init(void)
1142 {
1143         int retval;
1144
1145         retval = usb_serial_register(&pl2303_device);
1146         if (retval)
1147                 goto failed_usb_serial_register;
1148         retval = usb_register(&pl2303_driver);
1149         if (retval)
1150                 goto failed_usb_register;
1151         info(DRIVER_DESC);
1152         return 0;
1153 failed_usb_register:
1154         usb_serial_deregister(&pl2303_device);
1155 failed_usb_serial_register:
1156         return retval;
1157 }
1158
1159 static void __exit pl2303_exit(void)
1160 {
1161         usb_deregister(&pl2303_driver);
1162         usb_serial_deregister(&pl2303_device);
1163 }
1164
1165 module_init(pl2303_init);
1166 module_exit(pl2303_exit);
1167
1168 MODULE_DESCRIPTION(DRIVER_DESC);
1169 MODULE_LICENSE("GPL");
1170
1171 module_param(debug, bool, S_IRUGO | S_IWUSR);
1172 MODULE_PARM_DESC(debug, "Debug enabled or not");
1173