[PATCH] USB: kzalloc() conversion for rest of drivers/usb
[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 struct pl2303_buf {
47         unsigned int    buf_size;
48         char            *buf_buf;
49         char            *buf_get;
50         char            *buf_put;
51 };
52
53 static struct usb_device_id id_table [] = {
54         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
55         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
56         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
57         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
58         { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
59         { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
60         { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
61         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
62         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
63         { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
64         { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
65         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
66         { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
67         { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
68         { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
69         { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
70         { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
71         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
72         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1) },
73         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
74         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75) },
75         { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
76         { USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
77         { USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
78         { USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
79         { USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
80         { }                                     /* Terminating entry */
81 };
82
83 MODULE_DEVICE_TABLE (usb, id_table);
84
85 static struct usb_driver pl2303_driver = {
86         .name =         "pl2303",
87         .probe =        usb_serial_probe,
88         .disconnect =   usb_serial_disconnect,
89         .id_table =     id_table,
90         .no_dynamic_id =        1,
91 };
92
93 #define SET_LINE_REQUEST_TYPE           0x21
94 #define SET_LINE_REQUEST                0x20
95
96 #define SET_CONTROL_REQUEST_TYPE        0x21
97 #define SET_CONTROL_REQUEST             0x22
98 #define CONTROL_DTR                     0x01
99 #define CONTROL_RTS                     0x02
100
101 #define BREAK_REQUEST_TYPE              0x21
102 #define BREAK_REQUEST                   0x23    
103 #define BREAK_ON                        0xffff
104 #define BREAK_OFF                       0x0000
105
106 #define GET_LINE_REQUEST_TYPE           0xa1
107 #define GET_LINE_REQUEST                0x21
108
109 #define VENDOR_WRITE_REQUEST_TYPE       0x40
110 #define VENDOR_WRITE_REQUEST            0x01
111
112 #define VENDOR_READ_REQUEST_TYPE        0xc0
113 #define VENDOR_READ_REQUEST             0x01
114
115 #define UART_STATE                      0x08
116 #define UART_STATE_TRANSIENT_MASK       0x74
117 #define UART_DCD                        0x01
118 #define UART_DSR                        0x02
119 #define UART_BREAK_ERROR                0x04
120 #define UART_RING                       0x08
121 #define UART_FRAME_ERROR                0x10
122 #define UART_PARITY_ERROR               0x20
123 #define UART_OVERRUN_ERROR              0x40
124 #define UART_CTS                        0x80
125
126 /* function prototypes for a PL2303 serial converter */
127 static int pl2303_open (struct usb_serial_port *port, struct file *filp);
128 static void pl2303_close (struct usb_serial_port *port, struct file *filp);
129 static void pl2303_set_termios (struct usb_serial_port *port,
130                                 struct termios *old);
131 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file,
132                          unsigned int cmd, unsigned long arg);
133 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs);
134 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
135 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
136 static int pl2303_write (struct usb_serial_port *port,
137                          const unsigned char *buf, int count);
138 static void pl2303_send (struct usb_serial_port *port);
139 static int pl2303_write_room(struct usb_serial_port *port);
140 static int pl2303_chars_in_buffer(struct usb_serial_port *port);
141 static void pl2303_break_ctl(struct usb_serial_port *port,int break_state);
142 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file);
143 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
144                             unsigned int set, unsigned int clear);
145 static int pl2303_startup (struct usb_serial *serial);
146 static void pl2303_shutdown (struct usb_serial *serial);
147 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size);
148 static void pl2303_buf_free(struct pl2303_buf *pb);
149 static void pl2303_buf_clear(struct pl2303_buf *pb);
150 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb);
151 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb);
152 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
153         unsigned int count);
154 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
155         unsigned int count);
156
157
158 /* All of the device info needed for the PL2303 SIO serial converter */
159 static struct usb_serial_driver pl2303_device = {
160         .driver = {
161                 .owner =        THIS_MODULE,
162                 .name =         "pl2303",
163         },
164         .id_table =             id_table,
165         .num_interrupt_in =     NUM_DONT_CARE,
166         .num_bulk_in =          1,
167         .num_bulk_out =         1,
168         .num_ports =            1,
169         .open =                 pl2303_open,
170         .close =                pl2303_close,
171         .write =                pl2303_write,
172         .ioctl =                pl2303_ioctl,
173         .break_ctl =            pl2303_break_ctl,
174         .set_termios =          pl2303_set_termios,
175         .tiocmget =             pl2303_tiocmget,
176         .tiocmset =             pl2303_tiocmset,
177         .read_bulk_callback =   pl2303_read_bulk_callback,
178         .read_int_callback =    pl2303_read_int_callback,
179         .write_bulk_callback =  pl2303_write_bulk_callback,
180         .write_room =           pl2303_write_room,
181         .chars_in_buffer =      pl2303_chars_in_buffer,
182         .attach =               pl2303_startup,
183         .shutdown =             pl2303_shutdown,
184 };
185
186 enum pl2303_type {
187         type_0,         /* don't know the difference between type 0 and */
188         type_1,         /* type 1, until someone from prolific tells us... */
189         HX,             /* HX version of the pl2303 chip */
190 };
191
192 struct pl2303_private {
193         spinlock_t lock;
194         struct pl2303_buf *buf;
195         int write_urb_in_use;
196         wait_queue_head_t delta_msr_wait;
197         u8 line_control;
198         u8 line_status;
199         u8 termios_initialized;
200         enum pl2303_type type;
201 };
202
203
204 static int pl2303_startup (struct usb_serial *serial)
205 {
206         struct pl2303_private *priv;
207         enum pl2303_type type = type_0;
208         int i;
209
210         if (serial->dev->descriptor.bDeviceClass == 0x02)
211                 type = type_0;
212         else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
213                 type = HX;
214         else if (serial->dev->descriptor.bDeviceClass == 0x00)
215                 type = type_1;
216         else if (serial->dev->descriptor.bDeviceClass == 0xFF)
217                 type = type_1;
218         dbg("device type: %d", type);
219
220         for (i = 0; i < serial->num_ports; ++i) {
221                 priv = kzalloc(sizeof(struct pl2303_private), GFP_KERNEL);
222                 if (!priv)
223                         goto cleanup;
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 = kzalloc (7, GFP_KERNEL);
386         if (!buf) {
387                 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
388                 return;
389         }
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 + 1;
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              le16_to_cpu(port->serial->dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_SX1 ||
817              le16_to_cpu(port->serial->dev->descriptor.idProduct) == SIEMENS_PRODUCT_ID_X75)) {
818                 length = 1;
819                 status_idx = 0;
820         }
821
822         if (actual_length < length)
823                 goto exit;
824
825         /* Save off the uart status for others to look at */
826         spin_lock_irqsave(&priv->lock, flags);
827         priv->line_status = data[status_idx];
828         spin_unlock_irqrestore(&priv->lock, flags);
829
830 exit:
831         return;
832 }
833
834 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs)
835 {
836         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
837         unsigned char *data = urb->transfer_buffer;
838         unsigned int actual_length = urb->actual_length;
839         int status;
840
841         dbg("%s (%d)", __FUNCTION__, port->number);
842
843         switch (urb->status) {
844         case 0:
845                 /* success */
846                 break;
847         case -ECONNRESET:
848         case -ENOENT:
849         case -ESHUTDOWN:
850                 /* this urb is terminated, clean up */
851                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
852                 return;
853         default:
854                 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
855                 goto exit;
856         }
857
858         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
859         pl2303_update_line_status(port, data, actual_length);
860
861 exit:
862         status = usb_submit_urb (urb, GFP_ATOMIC);
863         if (status)
864                 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed with result %d\n",
865                         __FUNCTION__, status);
866 }
867
868
869 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
870 {
871         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
872         struct pl2303_private *priv = usb_get_serial_port_data(port);
873         struct tty_struct *tty;
874         unsigned char *data = urb->transfer_buffer;
875         unsigned long flags;
876         int i;
877         int result;
878         u8 status;
879         char tty_flag;
880
881         dbg("%s - port %d", __FUNCTION__, port->number);
882
883         if (urb->status) {
884                 dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
885                 if (!port->open_count) {
886                         dbg("%s - port is closed, exiting.", __FUNCTION__);
887                         return;
888                 }
889                 if (urb->status == -EPROTO) {
890                         /* PL2303 mysteriously fails with -EPROTO reschedule the read */
891                         dbg("%s - caught -EPROTO, resubmitting the urb", __FUNCTION__);
892                         urb->status = 0;
893                         urb->dev = port->serial->dev;
894                         result = usb_submit_urb(urb, GFP_ATOMIC);
895                         if (result)
896                                 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
897                         return;
898                 }
899                 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
900                 return;
901         }
902
903         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
904
905         /* get tty_flag from status */
906         tty_flag = TTY_NORMAL;
907
908         spin_lock_irqsave(&priv->lock, flags);
909         status = priv->line_status;
910         priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
911         spin_unlock_irqrestore(&priv->lock, flags);
912         wake_up_interruptible (&priv->delta_msr_wait);
913
914         /* break takes precedence over parity, */
915         /* which takes precedence over framing errors */
916         if (status & UART_BREAK_ERROR )
917                 tty_flag = TTY_BREAK;
918         else if (status & UART_PARITY_ERROR)
919                 tty_flag = TTY_PARITY;
920         else if (status & UART_FRAME_ERROR)
921                 tty_flag = TTY_FRAME;
922         dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
923
924         tty = port->tty;
925         if (tty && urb->actual_length) {
926                 tty_buffer_request_room(tty, urb->actual_length + 1);
927                 /* overrun is special, not associated with a char */
928                 if (status & UART_OVERRUN_ERROR)
929                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
930                 for (i = 0; i < urb->actual_length; ++i)
931                         tty_insert_flip_char (tty, data[i], tty_flag);
932                 tty_flip_buffer_push (tty);
933         }
934
935         /* Schedule the next read _if_ we are still open */
936         if (port->open_count) {
937                 urb->dev = port->serial->dev;
938                 result = usb_submit_urb(urb, GFP_ATOMIC);
939                 if (result)
940                         dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
941         }
942
943         return;
944 }
945
946
947
948 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
949 {
950         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
951         struct pl2303_private *priv = usb_get_serial_port_data(port);
952         int result;
953
954         dbg("%s - port %d", __FUNCTION__, port->number);
955
956         switch (urb->status) {
957         case 0:
958                 /* success */
959                 break;
960         case -ECONNRESET:
961         case -ENOENT:
962         case -ESHUTDOWN:
963                 /* this urb is terminated, clean up */
964                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
965                 priv->write_urb_in_use = 0;
966                 return;
967         default:
968                 /* error in the urb, so we have to resubmit it */
969                 dbg("%s - Overflow in write", __FUNCTION__);
970                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
971                 port->write_urb->transfer_buffer_length = 1;
972                 port->write_urb->dev = port->serial->dev;
973                 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
974                 if (result)
975                         dev_err(&urb->dev->dev, "%s - failed resubmitting write urb, error %d\n", __FUNCTION__, result);
976                 else
977                         return;
978         }
979
980         priv->write_urb_in_use = 0;
981
982         /* send any buffered data */
983         pl2303_send(port);
984 }
985
986
987 /*
988  * pl2303_buf_alloc
989  *
990  * Allocate a circular buffer and all associated memory.
991  */
992
993 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
994 {
995
996         struct pl2303_buf *pb;
997
998
999         if (size == 0)
1000                 return NULL;
1001
1002         pb = (struct pl2303_buf *)kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
1003         if (pb == NULL)
1004                 return NULL;
1005
1006         pb->buf_buf = kmalloc(size, GFP_KERNEL);
1007         if (pb->buf_buf == NULL) {
1008                 kfree(pb);
1009                 return NULL;
1010         }
1011
1012         pb->buf_size = size;
1013         pb->buf_get = pb->buf_put = pb->buf_buf;
1014
1015         return pb;
1016
1017 }
1018
1019
1020 /*
1021  * pl2303_buf_free
1022  *
1023  * Free the buffer and all associated memory.
1024  */
1025
1026 static void pl2303_buf_free(struct pl2303_buf *pb)
1027 {
1028         if (pb) {
1029                 kfree(pb->buf_buf);
1030                 kfree(pb);
1031         }
1032 }
1033
1034
1035 /*
1036  * pl2303_buf_clear
1037  *
1038  * Clear out all data in the circular buffer.
1039  */
1040
1041 static void pl2303_buf_clear(struct pl2303_buf *pb)
1042 {
1043         if (pb != NULL)
1044                 pb->buf_get = pb->buf_put;
1045                 /* equivalent to a get of all data available */
1046 }
1047
1048
1049 /*
1050  * pl2303_buf_data_avail
1051  *
1052  * Return the number of bytes of data available in the circular
1053  * buffer.
1054  */
1055
1056 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
1057 {
1058         if (pb != NULL)
1059                 return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
1060         else
1061                 return 0;
1062 }
1063
1064
1065 /*
1066  * pl2303_buf_space_avail
1067  *
1068  * Return the number of bytes of space available in the circular
1069  * buffer.
1070  */
1071
1072 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
1073 {
1074         if (pb != NULL)
1075                 return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
1076         else
1077                 return 0;
1078 }
1079
1080
1081 /*
1082  * pl2303_buf_put
1083  *
1084  * Copy data data from a user buffer and put it into the circular buffer.
1085  * Restrict to the amount of space available.
1086  *
1087  * Return the number of bytes copied.
1088  */
1089
1090 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
1091         unsigned int count)
1092 {
1093
1094         unsigned int len;
1095
1096
1097         if (pb == NULL)
1098                 return 0;
1099
1100         len  = pl2303_buf_space_avail(pb);
1101         if (count > len)
1102                 count = len;
1103
1104         if (count == 0)
1105                 return 0;
1106
1107         len = pb->buf_buf + pb->buf_size - pb->buf_put;
1108         if (count > len) {
1109                 memcpy(pb->buf_put, buf, len);
1110                 memcpy(pb->buf_buf, buf+len, count - len);
1111                 pb->buf_put = pb->buf_buf + count - len;
1112         } else {
1113                 memcpy(pb->buf_put, buf, count);
1114                 if (count < len)
1115                         pb->buf_put += count;
1116                 else /* count == len */
1117                         pb->buf_put = pb->buf_buf;
1118         }
1119
1120         return count;
1121
1122 }
1123
1124
1125 /*
1126  * pl2303_buf_get
1127  *
1128  * Get data from the circular buffer and copy to the given buffer.
1129  * Restrict to the amount of data available.
1130  *
1131  * Return the number of bytes copied.
1132  */
1133
1134 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
1135         unsigned int count)
1136 {
1137
1138         unsigned int len;
1139
1140
1141         if (pb == NULL)
1142                 return 0;
1143
1144         len = pl2303_buf_data_avail(pb);
1145         if (count > len)
1146                 count = len;
1147
1148         if (count == 0)
1149                 return 0;
1150
1151         len = pb->buf_buf + pb->buf_size - pb->buf_get;
1152         if (count > len) {
1153                 memcpy(buf, pb->buf_get, len);
1154                 memcpy(buf+len, pb->buf_buf, count - len);
1155                 pb->buf_get = pb->buf_buf + count - len;
1156         } else {
1157                 memcpy(buf, pb->buf_get, count);
1158                 if (count < len)
1159                         pb->buf_get += count;
1160                 else /* count == len */
1161                         pb->buf_get = pb->buf_buf;
1162         }
1163
1164         return count;
1165
1166 }
1167
1168 static int __init pl2303_init (void)
1169 {
1170         int retval;
1171         retval = usb_serial_register(&pl2303_device);
1172         if (retval)
1173                 goto failed_usb_serial_register;
1174         retval = usb_register(&pl2303_driver);
1175         if (retval)
1176                 goto failed_usb_register;
1177         info(DRIVER_DESC);
1178         return 0;
1179 failed_usb_register:
1180         usb_serial_deregister(&pl2303_device);
1181 failed_usb_serial_register:
1182         return retval;
1183 }
1184
1185
1186 static void __exit pl2303_exit (void)
1187 {
1188         usb_deregister (&pl2303_driver);
1189         usb_serial_deregister (&pl2303_device);
1190 }
1191
1192
1193 module_init(pl2303_init);
1194 module_exit(pl2303_exit);
1195
1196 MODULE_DESCRIPTION(DRIVER_DESC);
1197 MODULE_LICENSE("GPL");
1198
1199 module_param(debug, bool, S_IRUGO | S_IWUSR);
1200 MODULE_PARM_DESC(debug, "Debug enabled or not");
1201