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