2 * Prolific PL2303 USB to serial adaptor driver
4 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
5 * Copyright (C) 2003 IBM Corp.
7 * Original driver for 2.2.x by anonymous
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.
13 * See Documentation/usb/usb-serial.txt for more information on using this driver
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"
37 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
41 #define PL2303_CLOSING_WAIT (30*HZ)
43 #define PL2303_BUF_SIZE 1024
44 #define PL2303_TMP_BUF_SIZE 1024
46 static DECLARE_MUTEX(pl2303_tmp_buf_sem
);
49 unsigned int buf_size
;
55 static struct usb_device_id id_table
[] = {
56 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID
) },
57 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_RSAQ2
) },
58 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_RSAQ3
) },
59 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_PHAROS
) },
60 { USB_DEVICE(IODATA_VENDOR_ID
, IODATA_PRODUCT_ID
) },
61 { USB_DEVICE(ATEN_VENDOR_ID
, ATEN_PRODUCT_ID
) },
62 { USB_DEVICE(ATEN_VENDOR_ID2
, ATEN_PRODUCT_ID
) },
63 { USB_DEVICE(ELCOM_VENDOR_ID
, ELCOM_PRODUCT_ID
) },
64 { USB_DEVICE(ELCOM_VENDOR_ID
, ELCOM_PRODUCT_ID_UCSGT
) },
65 { USB_DEVICE(ITEGNO_VENDOR_ID
, ITEGNO_PRODUCT_ID
) },
66 { USB_DEVICE(MA620_VENDOR_ID
, MA620_PRODUCT_ID
) },
67 { USB_DEVICE(RATOC_VENDOR_ID
, RATOC_PRODUCT_ID
) },
68 { USB_DEVICE(TRIPP_VENDOR_ID
, TRIPP_PRODUCT_ID
) },
69 { USB_DEVICE(RADIOSHACK_VENDOR_ID
, RADIOSHACK_PRODUCT_ID
) },
70 { USB_DEVICE(DCU10_VENDOR_ID
, DCU10_PRODUCT_ID
) },
71 { USB_DEVICE(SITECOM_VENDOR_ID
, SITECOM_PRODUCT_ID
) },
72 { USB_DEVICE(ALCATEL_VENDOR_ID
, ALCATEL_PRODUCT_ID
) },
73 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_PRODUCT_ID
) },
74 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_SX1
) },
75 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_X65
) },
76 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_X75
) },
77 { USB_DEVICE(SYNTECH_VENDOR_ID
, SYNTECH_PRODUCT_ID
) },
78 { USB_DEVICE( NOKIA_CA42_VENDOR_ID
, NOKIA_CA42_PRODUCT_ID
) },
79 { } /* Terminating entry */
82 MODULE_DEVICE_TABLE (usb
, id_table
);
84 static struct usb_driver pl2303_driver
= {
86 .probe
= usb_serial_probe
,
87 .disconnect
= usb_serial_disconnect
,
92 #define SET_LINE_REQUEST_TYPE 0x21
93 #define SET_LINE_REQUEST 0x20
95 #define SET_CONTROL_REQUEST_TYPE 0x21
96 #define SET_CONTROL_REQUEST 0x22
97 #define CONTROL_DTR 0x01
98 #define CONTROL_RTS 0x02
100 #define BREAK_REQUEST_TYPE 0x21
101 #define BREAK_REQUEST 0x23
102 #define BREAK_ON 0xffff
103 #define BREAK_OFF 0x0000
105 #define GET_LINE_REQUEST_TYPE 0xa1
106 #define GET_LINE_REQUEST 0x21
108 #define VENDOR_WRITE_REQUEST_TYPE 0x40
109 #define VENDOR_WRITE_REQUEST 0x01
111 #define VENDOR_READ_REQUEST_TYPE 0xc0
112 #define VENDOR_READ_REQUEST 0x01
114 #define UART_STATE 0x08
115 #define UART_STATE_TRANSIENT_MASK 0x74
116 #define UART_DCD 0x01
117 #define UART_DSR 0x02
118 #define UART_BREAK_ERROR 0x04
119 #define UART_RING 0x08
120 #define UART_FRAME_ERROR 0x10
121 #define UART_PARITY_ERROR 0x20
122 #define UART_OVERRUN_ERROR 0x40
123 #define UART_CTS 0x80
125 /* function prototypes for a PL2303 serial converter */
126 static int pl2303_open (struct usb_serial_port
*port
, struct file
*filp
);
127 static void pl2303_close (struct usb_serial_port
*port
, struct file
*filp
);
128 static void pl2303_set_termios (struct usb_serial_port
*port
,
129 struct termios
*old
);
130 static int pl2303_ioctl (struct usb_serial_port
*port
, struct file
*file
,
131 unsigned int cmd
, unsigned long arg
);
132 static void pl2303_read_int_callback (struct urb
*urb
, struct pt_regs
*regs
);
133 static void pl2303_read_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
);
134 static void pl2303_write_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
);
135 static int pl2303_write (struct usb_serial_port
*port
,
136 const unsigned char *buf
, int count
);
137 static void pl2303_send (struct usb_serial_port
*port
);
138 static int pl2303_write_room(struct usb_serial_port
*port
);
139 static int pl2303_chars_in_buffer(struct usb_serial_port
*port
);
140 static void pl2303_break_ctl(struct usb_serial_port
*port
,int break_state
);
141 static int pl2303_tiocmget (struct usb_serial_port
*port
, struct file
*file
);
142 static int pl2303_tiocmset (struct usb_serial_port
*port
, struct file
*file
,
143 unsigned int set
, unsigned int clear
);
144 static int pl2303_startup (struct usb_serial
*serial
);
145 static void pl2303_shutdown (struct usb_serial
*serial
);
146 static struct pl2303_buf
*pl2303_buf_alloc(unsigned int size
);
147 static void pl2303_buf_free(struct pl2303_buf
*pb
);
148 static void pl2303_buf_clear(struct pl2303_buf
*pb
);
149 static unsigned int pl2303_buf_data_avail(struct pl2303_buf
*pb
);
150 static unsigned int pl2303_buf_space_avail(struct pl2303_buf
*pb
);
151 static unsigned int pl2303_buf_put(struct pl2303_buf
*pb
, const char *buf
,
153 static unsigned int pl2303_buf_get(struct pl2303_buf
*pb
, char *buf
,
157 /* All of the device info needed for the PL2303 SIO serial converter */
158 static struct usb_serial_driver pl2303_device
= {
160 .owner
= THIS_MODULE
,
163 .id_table
= id_table
,
164 .num_interrupt_in
= NUM_DONT_CARE
,
169 .close
= pl2303_close
,
170 .write
= pl2303_write
,
171 .ioctl
= pl2303_ioctl
,
172 .break_ctl
= pl2303_break_ctl
,
173 .set_termios
= pl2303_set_termios
,
174 .tiocmget
= pl2303_tiocmget
,
175 .tiocmset
= pl2303_tiocmset
,
176 .read_bulk_callback
= pl2303_read_bulk_callback
,
177 .read_int_callback
= pl2303_read_int_callback
,
178 .write_bulk_callback
= pl2303_write_bulk_callback
,
179 .write_room
= pl2303_write_room
,
180 .chars_in_buffer
= pl2303_chars_in_buffer
,
181 .attach
= pl2303_startup
,
182 .shutdown
= pl2303_shutdown
,
186 type_0
, /* don't know the difference between type 0 and */
187 type_1
, /* type 1, until someone from prolific tells us... */
188 HX
, /* HX version of the pl2303 chip */
191 struct pl2303_private
{
193 struct pl2303_buf
*buf
;
194 int write_urb_in_use
;
195 wait_queue_head_t delta_msr_wait
;
198 u8 termios_initialized
;
199 enum pl2303_type type
;
203 static int pl2303_startup (struct usb_serial
*serial
)
205 struct pl2303_private
*priv
;
206 enum pl2303_type type
= type_0
;
209 if (serial
->dev
->descriptor
.bDeviceClass
== 0x02)
211 else if (serial
->dev
->descriptor
.bMaxPacketSize0
== 0x40)
213 else if (serial
->dev
->descriptor
.bDeviceClass
== 0x00)
215 else if (serial
->dev
->descriptor
.bDeviceClass
== 0xFF)
217 dbg("device type: %d", type
);
219 for (i
= 0; i
< serial
->num_ports
; ++i
) {
220 priv
= kmalloc (sizeof (struct pl2303_private
), GFP_KERNEL
);
223 memset (priv
, 0x00, sizeof (struct pl2303_private
));
224 spin_lock_init(&priv
->lock
);
225 priv
->buf
= pl2303_buf_alloc(PL2303_BUF_SIZE
);
226 if (priv
->buf
== NULL
) {
230 init_waitqueue_head(&priv
->delta_msr_wait
);
232 usb_set_serial_port_data(serial
->port
[i
], priv
);
237 for (--i
; i
>=0; --i
) {
238 priv
= usb_get_serial_port_data(serial
->port
[i
]);
239 pl2303_buf_free(priv
->buf
);
241 usb_set_serial_port_data(serial
->port
[i
], NULL
);
246 static int set_control_lines (struct usb_device
*dev
, u8 value
)
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
);
257 static int pl2303_write (struct usb_serial_port
*port
, const unsigned char *buf
, int count
)
259 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
262 dbg("%s - port %d, %d bytes", __FUNCTION__
, port
->number
, count
);
267 spin_lock_irqsave(&priv
->lock
, flags
);
268 count
= pl2303_buf_put(priv
->buf
, buf
, count
);
269 spin_unlock_irqrestore(&priv
->lock
, flags
);
276 static void pl2303_send(struct usb_serial_port
*port
)
279 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
282 dbg("%s - port %d", __FUNCTION__
, port
->number
);
284 spin_lock_irqsave(&priv
->lock
, flags
);
286 if (priv
->write_urb_in_use
) {
287 spin_unlock_irqrestore(&priv
->lock
, flags
);
291 count
= pl2303_buf_get(priv
->buf
, port
->write_urb
->transfer_buffer
,
292 port
->bulk_out_size
);
295 spin_unlock_irqrestore(&priv
->lock
, flags
);
299 priv
->write_urb_in_use
= 1;
301 spin_unlock_irqrestore(&priv
->lock
, flags
);
303 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, count
, port
->write_urb
->transfer_buffer
);
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
);
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
314 schedule_work(&port
->work
);
317 static int pl2303_write_room(struct usb_serial_port
*port
)
319 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
323 dbg("%s - port %d", __FUNCTION__
, port
->number
);
325 spin_lock_irqsave(&priv
->lock
, flags
);
326 room
= pl2303_buf_space_avail(priv
->buf
);
327 spin_unlock_irqrestore(&priv
->lock
, flags
);
329 dbg("%s - returns %d", __FUNCTION__
, room
);
333 static int pl2303_chars_in_buffer(struct usb_serial_port
*port
)
335 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
339 dbg("%s - port %d", __FUNCTION__
, port
->number
);
341 spin_lock_irqsave(&priv
->lock
, flags
);
342 chars
= pl2303_buf_data_avail(priv
->buf
);
343 spin_unlock_irqrestore(&priv
->lock
, flags
);
345 dbg("%s - returns %d", __FUNCTION__
, chars
);
349 static void pl2303_set_termios (struct usb_serial_port
*port
, struct termios
*old_termios
)
351 struct usb_serial
*serial
= port
->serial
;
352 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
360 dbg("%s - port %d", __FUNCTION__
, port
->number
);
362 if ((!port
->tty
) || (!port
->tty
->termios
)) {
363 dbg("%s - no tty structures", __FUNCTION__
);
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;
373 spin_unlock_irqrestore(&priv
->lock
, flags
);
375 cflag
= port
->tty
->termios
->c_cflag
;
376 /* check that they really want us to change something */
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__
);
385 buf
= kmalloc (7, GFP_KERNEL
);
387 dev_err(&port
->dev
, "%s - out of memory.\n", __FUNCTION__
);
390 memset (buf
, 0x00, 0x07);
392 i
= usb_control_msg (serial
->dev
, usb_rcvctrlpipe (serial
->dev
, 0),
393 GET_LINE_REQUEST
, GET_LINE_REQUEST_TYPE
,
395 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i
,
396 buf
[0], buf
[1], buf
[2], buf
[3], buf
[4], buf
[5], buf
[6]);
400 switch (cflag
& CSIZE
) {
401 case CS5
: buf
[6] = 5; break;
402 case CS6
: buf
[6] = 6; break;
403 case CS7
: buf
[6] = 7; break;
405 case CS8
: buf
[6] = 8; break;
407 dbg("%s - data bits = %d", __FUNCTION__
, buf
[6]);
411 switch (cflag
& CBAUD
) {
412 case B0
: baud
= 0; break;
413 case B75
: baud
= 75; break;
414 case B150
: baud
= 150; break;
415 case B300
: baud
= 300; break;
416 case B600
: baud
= 600; break;
417 case B1200
: baud
= 1200; break;
418 case B1800
: baud
= 1800; break;
419 case B2400
: baud
= 2400; break;
420 case B4800
: baud
= 4800; break;
421 case B9600
: baud
= 9600; break;
422 case B19200
: baud
= 19200; break;
423 case B38400
: baud
= 38400; break;
424 case B57600
: baud
= 57600; break;
425 case B115200
: baud
= 115200; break;
426 case B230400
: baud
= 230400; break;
427 case B460800
: baud
= 460800; break;
429 dev_err(&port
->dev
, "pl2303 driver does not support the baudrate requested (fix it)\n");
432 dbg("%s - baud = %d", __FUNCTION__
, baud
);
434 buf
[0] = baud
& 0xff;
435 buf
[1] = (baud
>> 8) & 0xff;
436 buf
[2] = (baud
>> 16) & 0xff;
437 buf
[3] = (baud
>> 24) & 0xff;
440 /* For reference buf[4]=0 is 1 stop bits */
441 /* For reference buf[4]=1 is 1.5 stop bits */
442 /* For reference buf[4]=2 is 2 stop bits */
443 if (cflag
& CSTOPB
) {
445 dbg("%s - stop bits = 2", __FUNCTION__
);
448 dbg("%s - stop bits = 1", __FUNCTION__
);
451 if (cflag
& PARENB
) {
452 /* For reference buf[5]=0 is none parity */
453 /* For reference buf[5]=1 is odd parity */
454 /* For reference buf[5]=2 is even parity */
455 /* For reference buf[5]=3 is mark parity */
456 /* For reference buf[5]=4 is space parity */
457 if (cflag
& PARODD
) {
459 dbg("%s - parity = odd", __FUNCTION__
);
462 dbg("%s - parity = even", __FUNCTION__
);
466 dbg("%s - parity = none", __FUNCTION__
);
469 i
= usb_control_msg (serial
->dev
, usb_sndctrlpipe (serial
->dev
, 0),
470 SET_LINE_REQUEST
, SET_LINE_REQUEST_TYPE
,
472 dbg ("0x21:0x20:0:0 %d", i
);
474 /* change control lines if we are switching to or from B0 */
475 spin_lock_irqsave(&priv
->lock
, flags
);
476 control
= priv
->line_control
;
477 if ((cflag
& CBAUD
) == B0
)
478 priv
->line_control
&= ~(CONTROL_DTR
| CONTROL_RTS
);
480 priv
->line_control
|= (CONTROL_DTR
| CONTROL_RTS
);
481 if (control
!= priv
->line_control
) {
482 control
= priv
->line_control
;
483 spin_unlock_irqrestore(&priv
->lock
, flags
);
484 set_control_lines(serial
->dev
, control
);
486 spin_unlock_irqrestore(&priv
->lock
, flags
);
489 buf
[0] = buf
[1] = buf
[2] = buf
[3] = buf
[4] = buf
[5] = buf
[6] = 0;
491 i
= usb_control_msg (serial
->dev
, usb_rcvctrlpipe (serial
->dev
, 0),
492 GET_LINE_REQUEST
, GET_LINE_REQUEST_TYPE
,
494 dbg ("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i
,
495 buf
[0], buf
[1], buf
[2], buf
[3], buf
[4], buf
[5], buf
[6]);
497 if (cflag
& CRTSCTS
) {
499 if (priv
->type
== HX
)
503 i
= usb_control_msg(serial
->dev
,
504 usb_sndctrlpipe(serial
->dev
, 0),
505 VENDOR_WRITE_REQUEST
,
506 VENDOR_WRITE_REQUEST_TYPE
,
507 0x0, index
, NULL
, 0, 100);
508 dbg ("0x40:0x1:0x0:0x%x %d", index
, i
);
514 static int pl2303_open (struct usb_serial_port
*port
, struct file
*filp
)
516 struct termios tmp_termios
;
517 struct usb_serial
*serial
= port
->serial
;
518 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
522 dbg("%s - port %d", __FUNCTION__
, port
->number
);
524 if (priv
->type
!= HX
) {
525 usb_clear_halt(serial
->dev
, port
->write_urb
->pipe
);
526 usb_clear_halt(serial
->dev
, port
->read_urb
->pipe
);
529 buf
= kmalloc(10, GFP_KERNEL
);
533 #define FISH(a,b,c,d) \
534 result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0), \
535 b, a, c, d, buf, 1, 100); \
536 dbg("0x%x:0x%x:0x%x:0x%x %d - %x",a,b,c,d,result,buf[0]);
538 #define SOUP(a,b,c,d) \
539 result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0), \
540 b, a, c, d, NULL, 0, 100); \
541 dbg("0x%x:0x%x:0x%x:0x%x %d",a,b,c,d,result);
543 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8484, 0);
544 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 0x0404, 0);
545 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8484, 0);
546 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8383, 0);
547 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8484, 0);
548 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 0x0404, 1);
549 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8484, 0);
550 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8383, 0);
551 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 0, 1);
552 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 1, 0);
554 if (priv
->type
== HX
) {
556 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 2, 0x44);
557 /* reset upstream data pipes */
558 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 8, 0);
559 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 9, 0);
561 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 2, 0x24);
568 pl2303_set_termios (port
, &tmp_termios
);
571 //FIXME: need to assert RTS and DTR if CRTSCTS off
573 dbg("%s - submitting read urb", __FUNCTION__
);
574 port
->read_urb
->dev
= serial
->dev
;
575 result
= usb_submit_urb (port
->read_urb
, GFP_KERNEL
);
577 dev_err(&port
->dev
, "%s - failed submitting read urb, error %d\n", __FUNCTION__
, result
);
578 pl2303_close (port
, NULL
);
582 dbg("%s - submitting interrupt urb", __FUNCTION__
);
583 port
->interrupt_in_urb
->dev
= serial
->dev
;
584 result
= usb_submit_urb (port
->interrupt_in_urb
, GFP_KERNEL
);
586 dev_err(&port
->dev
, "%s - failed submitting interrupt urb, error %d\n", __FUNCTION__
, result
);
587 pl2303_close (port
, NULL
);
594 static void pl2303_close (struct usb_serial_port
*port
, struct file
*filp
)
596 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
598 unsigned int c_cflag
;
603 dbg("%s - port %d", __FUNCTION__
, port
->number
);
605 /* wait for data to drain from the buffer */
606 spin_lock_irqsave(&priv
->lock
, flags
);
607 timeout
= PL2303_CLOSING_WAIT
;
608 init_waitqueue_entry(&wait
, current
);
609 add_wait_queue(&port
->tty
->write_wait
, &wait
);
611 set_current_state(TASK_INTERRUPTIBLE
);
612 if (pl2303_buf_data_avail(priv
->buf
) == 0
613 || timeout
== 0 || signal_pending(current
)
614 || !usb_get_intfdata(port
->serial
->interface
)) /* disconnect */
616 spin_unlock_irqrestore(&priv
->lock
, flags
);
617 timeout
= schedule_timeout(timeout
);
618 spin_lock_irqsave(&priv
->lock
, flags
);
620 set_current_state(TASK_RUNNING
);
621 remove_wait_queue(&port
->tty
->write_wait
, &wait
);
622 /* clear out any remaining data in the buffer */
623 pl2303_buf_clear(priv
->buf
);
624 spin_unlock_irqrestore(&priv
->lock
, flags
);
626 /* wait for characters to drain from the device */
627 /* (this is long enough for the entire 256 byte */
628 /* pl2303 hardware buffer to drain with no flow */
629 /* control for data rates of 1200 bps or more, */
630 /* for lower rates we should really know how much */
631 /* data is in the buffer to compute a delay */
632 /* that is not unnecessarily long) */
633 bps
= tty_get_baud_rate(port
->tty
);
635 timeout
= max((HZ
*2560)/bps
,HZ
/10);
638 schedule_timeout_interruptible(timeout
);
640 /* shutdown our urbs */
641 dbg("%s - shutting down urbs", __FUNCTION__
);
642 usb_kill_urb(port
->write_urb
);
643 usb_kill_urb(port
->read_urb
);
644 usb_kill_urb(port
->interrupt_in_urb
);
647 c_cflag
= port
->tty
->termios
->c_cflag
;
648 if (c_cflag
& HUPCL
) {
649 /* drop DTR and RTS */
650 spin_lock_irqsave(&priv
->lock
, flags
);
651 priv
->line_control
= 0;
652 spin_unlock_irqrestore (&priv
->lock
, flags
);
653 set_control_lines (port
->serial
->dev
, 0);
658 static int pl2303_tiocmset (struct usb_serial_port
*port
, struct file
*file
,
659 unsigned int set
, unsigned int clear
)
661 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
665 if (!usb_get_intfdata(port
->serial
->interface
))
668 spin_lock_irqsave (&priv
->lock
, flags
);
670 priv
->line_control
|= CONTROL_RTS
;
672 priv
->line_control
|= CONTROL_DTR
;
673 if (clear
& TIOCM_RTS
)
674 priv
->line_control
&= ~CONTROL_RTS
;
675 if (clear
& TIOCM_DTR
)
676 priv
->line_control
&= ~CONTROL_DTR
;
677 control
= priv
->line_control
;
678 spin_unlock_irqrestore (&priv
->lock
, flags
);
680 return set_control_lines (port
->serial
->dev
, control
);
683 static int pl2303_tiocmget (struct usb_serial_port
*port
, struct file
*file
)
685 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
691 dbg("%s (%d)", __FUNCTION__
, port
->number
);
693 if (!usb_get_intfdata(port
->serial
->interface
))
696 spin_lock_irqsave (&priv
->lock
, flags
);
697 mcr
= priv
->line_control
;
698 status
= priv
->line_status
;
699 spin_unlock_irqrestore (&priv
->lock
, flags
);
701 result
= ((mcr
& CONTROL_DTR
) ? TIOCM_DTR
: 0)
702 | ((mcr
& CONTROL_RTS
) ? TIOCM_RTS
: 0)
703 | ((status
& UART_CTS
) ? TIOCM_CTS
: 0)
704 | ((status
& UART_DSR
) ? TIOCM_DSR
: 0)
705 | ((status
& UART_RING
) ? TIOCM_RI
: 0)
706 | ((status
& UART_DCD
) ? TIOCM_CD
: 0);
708 dbg("%s - result = %x", __FUNCTION__
, result
);
713 static int wait_modem_info(struct usb_serial_port
*port
, unsigned int arg
)
715 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
717 unsigned int prevstatus
;
719 unsigned int changed
;
721 spin_lock_irqsave (&priv
->lock
, flags
);
722 prevstatus
= priv
->line_status
;
723 spin_unlock_irqrestore (&priv
->lock
, flags
);
726 interruptible_sleep_on(&priv
->delta_msr_wait
);
727 /* see if a signal did it */
728 if (signal_pending(current
))
731 spin_lock_irqsave (&priv
->lock
, flags
);
732 status
= priv
->line_status
;
733 spin_unlock_irqrestore (&priv
->lock
, flags
);
735 changed
=prevstatus
^status
;
737 if (((arg
& TIOCM_RNG
) && (changed
& UART_RING
)) ||
738 ((arg
& TIOCM_DSR
) && (changed
& UART_DSR
)) ||
739 ((arg
& TIOCM_CD
) && (changed
& UART_DCD
)) ||
740 ((arg
& TIOCM_CTS
) && (changed
& UART_CTS
)) ) {
749 static int pl2303_ioctl (struct usb_serial_port
*port
, struct file
*file
, unsigned int cmd
, unsigned long arg
)
751 dbg("%s (%d) cmd = 0x%04x", __FUNCTION__
, port
->number
, cmd
);
755 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__
, port
->number
);
756 return wait_modem_info(port
, arg
);
759 dbg("%s not supported = 0x%04x", __FUNCTION__
, cmd
);
766 static void pl2303_break_ctl (struct usb_serial_port
*port
, int break_state
)
768 struct usb_serial
*serial
= port
->serial
;
772 dbg("%s - port %d", __FUNCTION__
, port
->number
);
774 if (break_state
== 0)
778 dbg("%s - turning break %s", __FUNCTION__
, state
==BREAK_OFF
? "off" : "on");
780 result
= usb_control_msg (serial
->dev
, usb_sndctrlpipe (serial
->dev
, 0),
781 BREAK_REQUEST
, BREAK_REQUEST_TYPE
, state
,
784 dbg("%s - error sending break = %d", __FUNCTION__
, result
);
788 static void pl2303_shutdown (struct usb_serial
*serial
)
791 struct pl2303_private
*priv
;
793 dbg("%s", __FUNCTION__
);
795 for (i
= 0; i
< serial
->num_ports
; ++i
) {
796 priv
= usb_get_serial_port_data(serial
->port
[i
]);
798 pl2303_buf_free(priv
->buf
);
800 usb_set_serial_port_data(serial
->port
[i
], NULL
);
805 static void pl2303_update_line_status(struct usb_serial_port
*port
,
807 unsigned int actual_length
)
810 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
812 u8 status_idx
= UART_STATE
;
813 u8 length
= UART_STATE
+ 1;
815 if ((le16_to_cpu(port
->serial
->dev
->descriptor
.idVendor
) == SIEMENS_VENDOR_ID
) &&
816 (le16_to_cpu(port
->serial
->dev
->descriptor
.idProduct
) == SIEMENS_PRODUCT_ID_X65
||
817 le16_to_cpu(port
->serial
->dev
->descriptor
.idProduct
) == SIEMENS_PRODUCT_ID_SX1
||
818 le16_to_cpu(port
->serial
->dev
->descriptor
.idProduct
) == SIEMENS_PRODUCT_ID_X75
)) {
823 if (actual_length
< length
)
826 /* Save off the uart status for others to look at */
827 spin_lock_irqsave(&priv
->lock
, flags
);
828 priv
->line_status
= data
[status_idx
];
829 spin_unlock_irqrestore(&priv
->lock
, flags
);
835 static void pl2303_read_int_callback (struct urb
*urb
, struct pt_regs
*regs
)
837 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
838 unsigned char *data
= urb
->transfer_buffer
;
839 unsigned int actual_length
= urb
->actual_length
;
842 dbg("%s (%d)", __FUNCTION__
, port
->number
);
844 switch (urb
->status
) {
851 /* this urb is terminated, clean up */
852 dbg("%s - urb shutting down with status: %d", __FUNCTION__
, urb
->status
);
855 dbg("%s - nonzero urb status received: %d", __FUNCTION__
, urb
->status
);
859 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, urb
->actual_length
, urb
->transfer_buffer
);
860 pl2303_update_line_status(port
, data
, actual_length
);
863 status
= usb_submit_urb (urb
, GFP_ATOMIC
);
865 dev_err(&urb
->dev
->dev
, "%s - usb_submit_urb failed with result %d\n",
866 __FUNCTION__
, status
);
870 static void pl2303_read_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
)
872 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
873 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
874 struct tty_struct
*tty
;
875 unsigned char *data
= urb
->transfer_buffer
;
882 dbg("%s - port %d", __FUNCTION__
, port
->number
);
885 dbg("%s - urb->status = %d", __FUNCTION__
, urb
->status
);
886 if (!port
->open_count
) {
887 dbg("%s - port is closed, exiting.", __FUNCTION__
);
890 if (urb
->status
== -EPROTO
) {
891 /* PL2303 mysteriously fails with -EPROTO reschedule the read */
892 dbg("%s - caught -EPROTO, resubmitting the urb", __FUNCTION__
);
894 urb
->dev
= port
->serial
->dev
;
895 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
897 dev_err(&urb
->dev
->dev
, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__
, result
);
900 dbg("%s - unable to handle the error, exiting.", __FUNCTION__
);
904 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, urb
->actual_length
, data
);
906 /* get tty_flag from status */
907 tty_flag
= TTY_NORMAL
;
909 spin_lock_irqsave(&priv
->lock
, flags
);
910 status
= priv
->line_status
;
911 priv
->line_status
&= ~UART_STATE_TRANSIENT_MASK
;
912 spin_unlock_irqrestore(&priv
->lock
, flags
);
913 wake_up_interruptible (&priv
->delta_msr_wait
);
915 /* break takes precedence over parity, */
916 /* which takes precedence over framing errors */
917 if (status
& UART_BREAK_ERROR
)
918 tty_flag
= TTY_BREAK
;
919 else if (status
& UART_PARITY_ERROR
)
920 tty_flag
= TTY_PARITY
;
921 else if (status
& UART_FRAME_ERROR
)
922 tty_flag
= TTY_FRAME
;
923 dbg("%s - tty_flag = %d", __FUNCTION__
, tty_flag
);
926 if (tty
&& urb
->actual_length
) {
927 /* overrun is special, not associated with a char */
928 if (status
& UART_OVERRUN_ERROR
)
929 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
931 for (i
= 0; i
< urb
->actual_length
; ++i
) {
932 if (tty
->flip
.count
>= TTY_FLIPBUF_SIZE
) {
933 tty_flip_buffer_push(tty
);
935 tty_insert_flip_char (tty
, data
[i
], tty_flag
);
937 tty_flip_buffer_push (tty
);
940 /* Schedule the next read _if_ we are still open */
941 if (port
->open_count
) {
942 urb
->dev
= port
->serial
->dev
;
943 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
945 dev_err(&urb
->dev
->dev
, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__
, result
);
953 static void pl2303_write_bulk_callback (struct urb
*urb
, struct pt_regs
*regs
)
955 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
956 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
959 dbg("%s - port %d", __FUNCTION__
, port
->number
);
961 switch (urb
->status
) {
968 /* this urb is terminated, clean up */
969 dbg("%s - urb shutting down with status: %d", __FUNCTION__
, urb
->status
);
970 priv
->write_urb_in_use
= 0;
973 /* error in the urb, so we have to resubmit it */
974 dbg("%s - Overflow in write", __FUNCTION__
);
975 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__
, urb
->status
);
976 port
->write_urb
->transfer_buffer_length
= 1;
977 port
->write_urb
->dev
= port
->serial
->dev
;
978 result
= usb_submit_urb (port
->write_urb
, GFP_ATOMIC
);
980 dev_err(&urb
->dev
->dev
, "%s - failed resubmitting write urb, error %d\n", __FUNCTION__
, result
);
985 priv
->write_urb_in_use
= 0;
987 /* send any buffered data */
995 * Allocate a circular buffer and all associated memory.
998 static struct pl2303_buf
*pl2303_buf_alloc(unsigned int size
)
1001 struct pl2303_buf
*pb
;
1007 pb
= (struct pl2303_buf
*)kmalloc(sizeof(struct pl2303_buf
), GFP_KERNEL
);
1011 pb
->buf_buf
= kmalloc(size
, GFP_KERNEL
);
1012 if (pb
->buf_buf
== NULL
) {
1017 pb
->buf_size
= size
;
1018 pb
->buf_get
= pb
->buf_put
= pb
->buf_buf
;
1028 * Free the buffer and all associated memory.
1031 static void pl2303_buf_free(struct pl2303_buf
*pb
)
1043 * Clear out all data in the circular buffer.
1046 static void pl2303_buf_clear(struct pl2303_buf
*pb
)
1049 pb
->buf_get
= pb
->buf_put
;
1050 /* equivalent to a get of all data available */
1055 * pl2303_buf_data_avail
1057 * Return the number of bytes of data available in the circular
1061 static unsigned int pl2303_buf_data_avail(struct pl2303_buf
*pb
)
1064 return ((pb
->buf_size
+ pb
->buf_put
- pb
->buf_get
) % pb
->buf_size
);
1071 * pl2303_buf_space_avail
1073 * Return the number of bytes of space available in the circular
1077 static unsigned int pl2303_buf_space_avail(struct pl2303_buf
*pb
)
1080 return ((pb
->buf_size
+ pb
->buf_get
- pb
->buf_put
- 1) % pb
->buf_size
);
1089 * Copy data data from a user buffer and put it into the circular buffer.
1090 * Restrict to the amount of space available.
1092 * Return the number of bytes copied.
1095 static unsigned int pl2303_buf_put(struct pl2303_buf
*pb
, const char *buf
,
1105 len
= pl2303_buf_space_avail(pb
);
1112 len
= pb
->buf_buf
+ pb
->buf_size
- pb
->buf_put
;
1114 memcpy(pb
->buf_put
, buf
, len
);
1115 memcpy(pb
->buf_buf
, buf
+len
, count
- len
);
1116 pb
->buf_put
= pb
->buf_buf
+ count
- len
;
1118 memcpy(pb
->buf_put
, buf
, count
);
1120 pb
->buf_put
+= count
;
1121 else /* count == len */
1122 pb
->buf_put
= pb
->buf_buf
;
1133 * Get data from the circular buffer and copy to the given buffer.
1134 * Restrict to the amount of data available.
1136 * Return the number of bytes copied.
1139 static unsigned int pl2303_buf_get(struct pl2303_buf
*pb
, char *buf
,
1149 len
= pl2303_buf_data_avail(pb
);
1156 len
= pb
->buf_buf
+ pb
->buf_size
- pb
->buf_get
;
1158 memcpy(buf
, pb
->buf_get
, len
);
1159 memcpy(buf
+len
, pb
->buf_buf
, count
- len
);
1160 pb
->buf_get
= pb
->buf_buf
+ count
- len
;
1162 memcpy(buf
, pb
->buf_get
, count
);
1164 pb
->buf_get
+= count
;
1165 else /* count == len */
1166 pb
->buf_get
= pb
->buf_buf
;
1173 static int __init
pl2303_init (void)
1176 retval
= usb_serial_register(&pl2303_device
);
1178 goto failed_usb_serial_register
;
1179 retval
= usb_register(&pl2303_driver
);
1181 goto failed_usb_register
;
1184 failed_usb_register
:
1185 usb_serial_deregister(&pl2303_device
);
1186 failed_usb_serial_register
:
1191 static void __exit
pl2303_exit (void)
1193 usb_deregister (&pl2303_driver
);
1194 usb_serial_deregister (&pl2303_device
);
1198 module_init(pl2303_init
);
1199 module_exit(pl2303_exit
);
1201 MODULE_DESCRIPTION(DRIVER_DESC
);
1202 MODULE_LICENSE("GPL");
1204 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1205 MODULE_PARM_DESC(debug
, "Debug enabled or not");