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