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