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