2 * Prolific PL2303 USB to serial adaptor driver
4 * Copyright (C) 2001-2007 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
10 * modify it under the terms of the GNU General Public License version
11 * 2 as published by the Free Software Foundation.
13 * See Documentation/usb/usb-serial.txt for more information on using this
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 <linux/uaccess.h>
30 #include <linux/usb.h>
31 #include <linux/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
47 unsigned int buf_size
;
53 static const 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_DCU11
) },
57 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_RSAQ3
) },
58 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_PHAROS
) },
59 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_ALDIGA
) },
60 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_MMX
) },
61 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_GPRS
) },
62 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_HCR331
) },
63 { USB_DEVICE(IODATA_VENDOR_ID
, IODATA_PRODUCT_ID
) },
64 { USB_DEVICE(IODATA_VENDOR_ID
, IODATA_PRODUCT_ID_RSAQ5
) },
65 { USB_DEVICE(ATEN_VENDOR_ID
, ATEN_PRODUCT_ID
) },
66 { USB_DEVICE(ATEN_VENDOR_ID2
, ATEN_PRODUCT_ID
) },
67 { USB_DEVICE(ELCOM_VENDOR_ID
, ELCOM_PRODUCT_ID
) },
68 { USB_DEVICE(ELCOM_VENDOR_ID
, ELCOM_PRODUCT_ID_UCSGT
) },
69 { USB_DEVICE(ITEGNO_VENDOR_ID
, ITEGNO_PRODUCT_ID
) },
70 { USB_DEVICE(ITEGNO_VENDOR_ID
, ITEGNO_PRODUCT_ID_2080
) },
71 { USB_DEVICE(MA620_VENDOR_ID
, MA620_PRODUCT_ID
) },
72 { USB_DEVICE(RATOC_VENDOR_ID
, RATOC_PRODUCT_ID
) },
73 { USB_DEVICE(TRIPP_VENDOR_ID
, TRIPP_PRODUCT_ID
) },
74 { USB_DEVICE(RADIOSHACK_VENDOR_ID
, RADIOSHACK_PRODUCT_ID
) },
75 { USB_DEVICE(DCU10_VENDOR_ID
, DCU10_PRODUCT_ID
) },
76 { USB_DEVICE(SITECOM_VENDOR_ID
, SITECOM_PRODUCT_ID
) },
77 { USB_DEVICE(ALCATEL_VENDOR_ID
, ALCATEL_PRODUCT_ID
) },
78 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_PRODUCT_ID
) },
79 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_SX1
) },
80 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_X65
) },
81 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_X75
) },
82 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_EF81
) },
83 { USB_DEVICE(BENQ_VENDOR_ID
, BENQ_PRODUCT_ID_S81
) }, /* Benq/Siemens S81 */
84 { USB_DEVICE(SYNTECH_VENDOR_ID
, SYNTECH_PRODUCT_ID
) },
85 { USB_DEVICE(NOKIA_CA42_VENDOR_ID
, NOKIA_CA42_PRODUCT_ID
) },
86 { USB_DEVICE(CA_42_CA42_VENDOR_ID
, CA_42_CA42_PRODUCT_ID
) },
87 { USB_DEVICE(SAGEM_VENDOR_ID
, SAGEM_PRODUCT_ID
) },
88 { USB_DEVICE(LEADTEK_VENDOR_ID
, LEADTEK_9531_PRODUCT_ID
) },
89 { USB_DEVICE(SPEEDDRAGON_VENDOR_ID
, SPEEDDRAGON_PRODUCT_ID
) },
90 { USB_DEVICE(DATAPILOT_U2_VENDOR_ID
, DATAPILOT_U2_PRODUCT_ID
) },
91 { USB_DEVICE(BELKIN_VENDOR_ID
, BELKIN_PRODUCT_ID
) },
92 { USB_DEVICE(ALCOR_VENDOR_ID
, ALCOR_PRODUCT_ID
) },
93 { USB_DEVICE(WS002IN_VENDOR_ID
, WS002IN_PRODUCT_ID
) },
94 { USB_DEVICE(COREGA_VENDOR_ID
, COREGA_PRODUCT_ID
) },
95 { USB_DEVICE(YCCABLE_VENDOR_ID
, YCCABLE_PRODUCT_ID
) },
96 { USB_DEVICE(SUPERIAL_VENDOR_ID
, SUPERIAL_PRODUCT_ID
) },
97 { USB_DEVICE(HP_VENDOR_ID
, HP_LD220_PRODUCT_ID
) },
98 { USB_DEVICE(CRESSI_VENDOR_ID
, CRESSI_EDY_PRODUCT_ID
) },
99 { USB_DEVICE(ZEAGLE_VENDOR_ID
, ZEAGLE_N2ITION3_PRODUCT_ID
) },
100 { USB_DEVICE(SONY_VENDOR_ID
, SONY_QN3USB_PRODUCT_ID
) },
101 { USB_DEVICE(SANWA_VENDOR_ID
, SANWA_PRODUCT_ID
) },
102 { USB_DEVICE(ADLINK_VENDOR_ID
, ADLINK_ND6530_PRODUCT_ID
) },
103 { } /* Terminating entry */
106 MODULE_DEVICE_TABLE(usb
, id_table
);
108 static struct usb_driver pl2303_driver
= {
110 .probe
= usb_serial_probe
,
111 .disconnect
= usb_serial_disconnect
,
112 .id_table
= id_table
,
113 .suspend
= usb_serial_suspend
,
114 .resume
= usb_serial_resume
,
116 .supports_autosuspend
= 1,
119 #define SET_LINE_REQUEST_TYPE 0x21
120 #define SET_LINE_REQUEST 0x20
122 #define SET_CONTROL_REQUEST_TYPE 0x21
123 #define SET_CONTROL_REQUEST 0x22
124 #define CONTROL_DTR 0x01
125 #define CONTROL_RTS 0x02
127 #define BREAK_REQUEST_TYPE 0x21
128 #define BREAK_REQUEST 0x23
129 #define BREAK_ON 0xffff
130 #define BREAK_OFF 0x0000
132 #define GET_LINE_REQUEST_TYPE 0xa1
133 #define GET_LINE_REQUEST 0x21
135 #define VENDOR_WRITE_REQUEST_TYPE 0x40
136 #define VENDOR_WRITE_REQUEST 0x01
138 #define VENDOR_READ_REQUEST_TYPE 0xc0
139 #define VENDOR_READ_REQUEST 0x01
141 #define UART_STATE 0x08
142 #define UART_STATE_TRANSIENT_MASK 0x74
143 #define UART_DCD 0x01
144 #define UART_DSR 0x02
145 #define UART_BREAK_ERROR 0x04
146 #define UART_RING 0x08
147 #define UART_FRAME_ERROR 0x10
148 #define UART_PARITY_ERROR 0x20
149 #define UART_OVERRUN_ERROR 0x40
150 #define UART_CTS 0x80
154 type_0
, /* don't know the difference between type 0 and */
155 type_1
, /* type 1, until someone from prolific tells us... */
156 HX
, /* HX version of the pl2303 chip */
159 struct pl2303_private
{
161 struct pl2303_buf
*buf
;
162 int write_urb_in_use
;
163 wait_queue_head_t delta_msr_wait
;
166 enum pl2303_type type
;
172 * Allocate a circular buffer and all associated memory.
174 static struct pl2303_buf
*pl2303_buf_alloc(unsigned int size
)
176 struct pl2303_buf
*pb
;
181 pb
= kmalloc(sizeof(struct pl2303_buf
), GFP_KERNEL
);
185 pb
->buf_buf
= kmalloc(size
, GFP_KERNEL
);
186 if (pb
->buf_buf
== NULL
) {
192 pb
->buf_get
= pb
->buf_put
= pb
->buf_buf
;
200 * Free the buffer and all associated memory.
202 static void pl2303_buf_free(struct pl2303_buf
*pb
)
213 * Clear out all data in the circular buffer.
215 static void pl2303_buf_clear(struct pl2303_buf
*pb
)
218 pb
->buf_get
= pb
->buf_put
;
219 /* equivalent to a get of all data available */
223 * pl2303_buf_data_avail
225 * Return the number of bytes of data available in the circular
228 static unsigned int pl2303_buf_data_avail(struct pl2303_buf
*pb
)
233 return (pb
->buf_size
+ pb
->buf_put
- pb
->buf_get
) % pb
->buf_size
;
237 * pl2303_buf_space_avail
239 * Return the number of bytes of space available in the circular
242 static unsigned int pl2303_buf_space_avail(struct pl2303_buf
*pb
)
247 return (pb
->buf_size
+ pb
->buf_get
- pb
->buf_put
- 1) % pb
->buf_size
;
253 * Copy data data from a user buffer and put it into the circular buffer.
254 * Restrict to the amount of space available.
256 * Return the number of bytes copied.
258 static unsigned int pl2303_buf_put(struct pl2303_buf
*pb
, const char *buf
,
266 len
= pl2303_buf_space_avail(pb
);
273 len
= pb
->buf_buf
+ pb
->buf_size
- pb
->buf_put
;
275 memcpy(pb
->buf_put
, buf
, len
);
276 memcpy(pb
->buf_buf
, buf
+len
, count
- len
);
277 pb
->buf_put
= pb
->buf_buf
+ count
- len
;
279 memcpy(pb
->buf_put
, buf
, count
);
281 pb
->buf_put
+= count
;
282 else /* count == len */
283 pb
->buf_put
= pb
->buf_buf
;
292 * Get data from the circular buffer and copy to the given buffer.
293 * Restrict to the amount of data available.
295 * Return the number of bytes copied.
297 static unsigned int pl2303_buf_get(struct pl2303_buf
*pb
, char *buf
,
305 len
= pl2303_buf_data_avail(pb
);
312 len
= pb
->buf_buf
+ pb
->buf_size
- pb
->buf_get
;
314 memcpy(buf
, pb
->buf_get
, len
);
315 memcpy(buf
+len
, pb
->buf_buf
, count
- len
);
316 pb
->buf_get
= pb
->buf_buf
+ count
- len
;
318 memcpy(buf
, pb
->buf_get
, count
);
320 pb
->buf_get
+= count
;
321 else /* count == len */
322 pb
->buf_get
= pb
->buf_buf
;
328 static int pl2303_vendor_read(__u16 value
, __u16 index
,
329 struct usb_serial
*serial
, unsigned char *buf
)
331 int res
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
332 VENDOR_READ_REQUEST
, VENDOR_READ_REQUEST_TYPE
,
333 value
, index
, buf
, 1, 100);
334 dbg("0x%x:0x%x:0x%x:0x%x %d - %x", VENDOR_READ_REQUEST_TYPE
,
335 VENDOR_READ_REQUEST
, value
, index
, res
, buf
[0]);
339 static int pl2303_vendor_write(__u16 value
, __u16 index
,
340 struct usb_serial
*serial
)
342 int res
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
343 VENDOR_WRITE_REQUEST
, VENDOR_WRITE_REQUEST_TYPE
,
344 value
, index
, NULL
, 0, 100);
345 dbg("0x%x:0x%x:0x%x:0x%x %d", VENDOR_WRITE_REQUEST_TYPE
,
346 VENDOR_WRITE_REQUEST
, value
, index
, res
);
350 static int pl2303_startup(struct usb_serial
*serial
)
352 struct pl2303_private
*priv
;
353 enum pl2303_type type
= type_0
;
357 buf
= kmalloc(10, GFP_KERNEL
);
361 if (serial
->dev
->descriptor
.bDeviceClass
== 0x02)
363 else if (serial
->dev
->descriptor
.bMaxPacketSize0
== 0x40)
365 else if (serial
->dev
->descriptor
.bDeviceClass
== 0x00)
367 else if (serial
->dev
->descriptor
.bDeviceClass
== 0xFF)
369 dbg("device type: %d", type
);
371 for (i
= 0; i
< serial
->num_ports
; ++i
) {
372 priv
= kzalloc(sizeof(struct pl2303_private
), GFP_KERNEL
);
375 spin_lock_init(&priv
->lock
);
376 priv
->buf
= pl2303_buf_alloc(PL2303_BUF_SIZE
);
377 if (priv
->buf
== NULL
) {
381 init_waitqueue_head(&priv
->delta_msr_wait
);
383 usb_set_serial_port_data(serial
->port
[i
], priv
);
386 pl2303_vendor_read(0x8484, 0, serial
, buf
);
387 pl2303_vendor_write(0x0404, 0, serial
);
388 pl2303_vendor_read(0x8484, 0, serial
, buf
);
389 pl2303_vendor_read(0x8383, 0, serial
, buf
);
390 pl2303_vendor_read(0x8484, 0, serial
, buf
);
391 pl2303_vendor_write(0x0404, 1, serial
);
392 pl2303_vendor_read(0x8484, 0, serial
, buf
);
393 pl2303_vendor_read(0x8383, 0, serial
, buf
);
394 pl2303_vendor_write(0, 1, serial
);
395 pl2303_vendor_write(1, 0, serial
);
397 pl2303_vendor_write(2, 0x44, serial
);
399 pl2303_vendor_write(2, 0x24, serial
);
406 for (--i
; i
>= 0; --i
) {
407 priv
= usb_get_serial_port_data(serial
->port
[i
]);
408 pl2303_buf_free(priv
->buf
);
410 usb_set_serial_port_data(serial
->port
[i
], NULL
);
415 static int set_control_lines(struct usb_device
*dev
, u8 value
)
419 retval
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
420 SET_CONTROL_REQUEST
, SET_CONTROL_REQUEST_TYPE
,
421 value
, 0, NULL
, 0, 100);
422 dbg("%s - value = %d, retval = %d", __func__
, value
, retval
);
426 static void pl2303_send(struct usb_serial_port
*port
)
429 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
432 dbg("%s - port %d", __func__
, port
->number
);
434 spin_lock_irqsave(&priv
->lock
, flags
);
436 if (priv
->write_urb_in_use
) {
437 spin_unlock_irqrestore(&priv
->lock
, flags
);
441 count
= pl2303_buf_get(priv
->buf
, port
->write_urb
->transfer_buffer
,
442 port
->bulk_out_size
);
445 spin_unlock_irqrestore(&priv
->lock
, flags
);
449 priv
->write_urb_in_use
= 1;
451 spin_unlock_irqrestore(&priv
->lock
, flags
);
453 usb_serial_debug_data(debug
, &port
->dev
, __func__
, count
,
454 port
->write_urb
->transfer_buffer
);
456 port
->write_urb
->transfer_buffer_length
= count
;
457 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
459 dev_err(&port
->dev
, "%s - failed submitting write urb,"
460 " error %d\n", __func__
, result
);
461 priv
->write_urb_in_use
= 0;
462 /* TODO: reschedule pl2303_send */
465 usb_serial_port_softint(port
);
468 static int pl2303_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
469 const unsigned char *buf
, int count
)
471 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
474 dbg("%s - port %d, %d bytes", __func__
, port
->number
, count
);
479 spin_lock_irqsave(&priv
->lock
, flags
);
480 count
= pl2303_buf_put(priv
->buf
, buf
, count
);
481 spin_unlock_irqrestore(&priv
->lock
, flags
);
488 static int pl2303_write_room(struct tty_struct
*tty
)
490 struct usb_serial_port
*port
= tty
->driver_data
;
491 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
495 dbg("%s - port %d", __func__
, port
->number
);
497 spin_lock_irqsave(&priv
->lock
, flags
);
498 room
= pl2303_buf_space_avail(priv
->buf
);
499 spin_unlock_irqrestore(&priv
->lock
, flags
);
501 dbg("%s - returns %d", __func__
, room
);
505 static int pl2303_chars_in_buffer(struct tty_struct
*tty
)
507 struct usb_serial_port
*port
= tty
->driver_data
;
508 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
512 dbg("%s - port %d", __func__
, port
->number
);
514 spin_lock_irqsave(&priv
->lock
, flags
);
515 chars
= pl2303_buf_data_avail(priv
->buf
);
516 spin_unlock_irqrestore(&priv
->lock
, flags
);
518 dbg("%s - returns %d", __func__
, chars
);
522 static void pl2303_set_termios(struct tty_struct
*tty
,
523 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
525 struct usb_serial
*serial
= port
->serial
;
526 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
533 const int baud_sup
[] = { 75, 150, 300, 600, 1200, 1800, 2400, 3600,
534 4800, 7200, 9600, 14400, 19200, 28800, 38400,
535 57600, 115200, 230400, 460800, 614400,
536 921600, 1228800, 2457600, 3000000, 6000000 };
537 int baud_floor
, baud_ceil
;
540 dbg("%s - port %d", __func__
, port
->number
);
542 /* The PL2303 is reported to lose bytes if you change
543 serial settings even to the same values as before. Thus
544 we actually need to filter in this specific case */
546 if (!tty_termios_hw_change(tty
->termios
, old_termios
))
549 cflag
= tty
->termios
->c_cflag
;
551 buf
= kzalloc(7, GFP_KERNEL
);
553 dev_err(&port
->dev
, "%s - out of memory.\n", __func__
);
554 /* Report back no change occurred */
555 *tty
->termios
= *old_termios
;
559 i
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
560 GET_LINE_REQUEST
, GET_LINE_REQUEST_TYPE
,
562 dbg("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i
,
563 buf
[0], buf
[1], buf
[2], buf
[3], buf
[4], buf
[5], buf
[6]);
566 switch (cflag
& CSIZE
) {
581 dbg("%s - data bits = %d", __func__
, buf
[6]);
584 /* For reference buf[0]:buf[3] baud rate value */
585 /* NOTE: Only the values defined in baud_sup are supported !
586 * => if unsupported values are set, the PL2303 seems to use
587 * 9600 baud (at least my PL2303X always does)
589 baud
= tty_get_baud_rate(tty
);
590 dbg("%s - baud requested = %d", __func__
, baud
);
592 /* Set baudrate to nearest supported value */
593 for (k
=0; k
<ARRAY_SIZE(baud_sup
); k
++) {
594 if (baud_sup
[k
] / baud
) {
595 baud_ceil
= baud_sup
[k
];
599 baud_floor
= baud_sup
[k
-1];
600 if ((baud_ceil
% baud
)
601 > (baud
% baud_floor
))
609 if (baud
> 1228800) {
610 /* type_0, type_1 only support up to 1228800 baud */
611 if (priv
->type
!= HX
)
613 else if (baud
> 6000000)
616 dbg("%s - baud set = %d", __func__
, baud
);
617 buf
[0] = baud
& 0xff;
618 buf
[1] = (baud
>> 8) & 0xff;
619 buf
[2] = (baud
>> 16) & 0xff;
620 buf
[3] = (baud
>> 24) & 0xff;
623 /* For reference buf[4]=0 is 1 stop bits */
624 /* For reference buf[4]=1 is 1.5 stop bits */
625 /* For reference buf[4]=2 is 2 stop bits */
626 if (cflag
& CSTOPB
) {
627 /* NOTE: Comply with "real" UARTs / RS232:
628 * use 1.5 instead of 2 stop bits with 5 data bits
630 if ((cflag
& CSIZE
) == CS5
) {
632 dbg("%s - stop bits = 1.5", __func__
);
635 dbg("%s - stop bits = 2", __func__
);
639 dbg("%s - stop bits = 1", __func__
);
642 if (cflag
& PARENB
) {
643 /* For reference buf[5]=0 is none parity */
644 /* For reference buf[5]=1 is odd parity */
645 /* For reference buf[5]=2 is even parity */
646 /* For reference buf[5]=3 is mark parity */
647 /* For reference buf[5]=4 is space parity */
648 if (cflag
& PARODD
) {
649 if (cflag
& CMSPAR
) {
651 dbg("%s - parity = mark", __func__
);
654 dbg("%s - parity = odd", __func__
);
657 if (cflag
& CMSPAR
) {
659 dbg("%s - parity = space", __func__
);
662 dbg("%s - parity = even", __func__
);
667 dbg("%s - parity = none", __func__
);
670 i
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
671 SET_LINE_REQUEST
, SET_LINE_REQUEST_TYPE
,
673 dbg("0x21:0x20:0:0 %d", i
);
675 /* change control lines if we are switching to or from B0 */
676 spin_lock_irqsave(&priv
->lock
, flags
);
677 control
= priv
->line_control
;
678 if ((cflag
& CBAUD
) == B0
)
679 priv
->line_control
&= ~(CONTROL_DTR
| CONTROL_RTS
);
681 priv
->line_control
|= (CONTROL_DTR
| CONTROL_RTS
);
682 if (control
!= priv
->line_control
) {
683 control
= priv
->line_control
;
684 spin_unlock_irqrestore(&priv
->lock
, flags
);
685 set_control_lines(serial
->dev
, control
);
687 spin_unlock_irqrestore(&priv
->lock
, flags
);
690 buf
[0] = buf
[1] = buf
[2] = buf
[3] = buf
[4] = buf
[5] = buf
[6] = 0;
692 i
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
693 GET_LINE_REQUEST
, GET_LINE_REQUEST_TYPE
,
695 dbg("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i
,
696 buf
[0], buf
[1], buf
[2], buf
[3], buf
[4], buf
[5], buf
[6]);
698 if (cflag
& CRTSCTS
) {
699 if (priv
->type
== HX
)
700 pl2303_vendor_write(0x0, 0x61, serial
);
702 pl2303_vendor_write(0x0, 0x41, serial
);
704 pl2303_vendor_write(0x0, 0x0, serial
);
707 /* Save resulting baud rate */
709 tty_encode_baud_rate(tty
, baud
, baud
);
714 static void pl2303_dtr_rts(struct usb_serial_port
*port
, int on
)
716 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
720 spin_lock_irqsave(&priv
->lock
, flags
);
721 /* Change DTR and RTS */
723 priv
->line_control
|= (CONTROL_DTR
| CONTROL_RTS
);
725 priv
->line_control
&= ~(CONTROL_DTR
| CONTROL_RTS
);
726 control
= priv
->line_control
;
727 spin_unlock_irqrestore(&priv
->lock
, flags
);
728 set_control_lines(port
->serial
->dev
, control
);
731 static void pl2303_close(struct usb_serial_port
*port
)
733 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
736 dbg("%s - port %d", __func__
, port
->number
);
738 spin_lock_irqsave(&priv
->lock
, flags
);
739 /* clear out any remaining data in the buffer */
740 pl2303_buf_clear(priv
->buf
);
741 spin_unlock_irqrestore(&priv
->lock
, flags
);
743 /* shutdown our urbs */
744 dbg("%s - shutting down urbs", __func__
);
745 usb_kill_urb(port
->write_urb
);
746 usb_kill_urb(port
->read_urb
);
747 usb_kill_urb(port
->interrupt_in_urb
);
751 static int pl2303_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
753 struct ktermios tmp_termios
;
754 struct usb_serial
*serial
= port
->serial
;
755 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
758 dbg("%s - port %d", __func__
, port
->number
);
760 if (priv
->type
!= HX
) {
761 usb_clear_halt(serial
->dev
, port
->write_urb
->pipe
);
762 usb_clear_halt(serial
->dev
, port
->read_urb
->pipe
);
764 /* reset upstream data pipes */
765 pl2303_vendor_write(8, 0, serial
);
766 pl2303_vendor_write(9, 0, serial
);
771 pl2303_set_termios(tty
, port
, &tmp_termios
);
773 dbg("%s - submitting read urb", __func__
);
774 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
776 dev_err(&port
->dev
, "%s - failed submitting read urb,"
777 " error %d\n", __func__
, result
);
782 dbg("%s - submitting interrupt urb", __func__
);
783 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
785 dev_err(&port
->dev
, "%s - failed submitting interrupt urb,"
786 " error %d\n", __func__
, result
);
790 port
->port
.drain_delay
= 256;
794 static int pl2303_tiocmset(struct tty_struct
*tty
, struct file
*file
,
795 unsigned int set
, unsigned int clear
)
797 struct usb_serial_port
*port
= tty
->driver_data
;
798 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
802 if (!usb_get_intfdata(port
->serial
->interface
))
805 spin_lock_irqsave(&priv
->lock
, flags
);
807 priv
->line_control
|= CONTROL_RTS
;
809 priv
->line_control
|= CONTROL_DTR
;
810 if (clear
& TIOCM_RTS
)
811 priv
->line_control
&= ~CONTROL_RTS
;
812 if (clear
& TIOCM_DTR
)
813 priv
->line_control
&= ~CONTROL_DTR
;
814 control
= priv
->line_control
;
815 spin_unlock_irqrestore(&priv
->lock
, flags
);
817 return set_control_lines(port
->serial
->dev
, control
);
820 static int pl2303_tiocmget(struct tty_struct
*tty
, struct file
*file
)
822 struct usb_serial_port
*port
= tty
->driver_data
;
823 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
829 dbg("%s (%d)", __func__
, port
->number
);
831 if (!usb_get_intfdata(port
->serial
->interface
))
834 spin_lock_irqsave(&priv
->lock
, flags
);
835 mcr
= priv
->line_control
;
836 status
= priv
->line_status
;
837 spin_unlock_irqrestore(&priv
->lock
, flags
);
839 result
= ((mcr
& CONTROL_DTR
) ? TIOCM_DTR
: 0)
840 | ((mcr
& CONTROL_RTS
) ? TIOCM_RTS
: 0)
841 | ((status
& UART_CTS
) ? TIOCM_CTS
: 0)
842 | ((status
& UART_DSR
) ? TIOCM_DSR
: 0)
843 | ((status
& UART_RING
) ? TIOCM_RI
: 0)
844 | ((status
& UART_DCD
) ? TIOCM_CD
: 0);
846 dbg("%s - result = %x", __func__
, result
);
851 static int pl2303_carrier_raised(struct usb_serial_port
*port
)
853 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
854 if (priv
->line_status
& UART_DCD
)
859 static int wait_modem_info(struct usb_serial_port
*port
, unsigned int arg
)
861 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
863 unsigned int prevstatus
;
865 unsigned int changed
;
867 spin_lock_irqsave(&priv
->lock
, flags
);
868 prevstatus
= priv
->line_status
;
869 spin_unlock_irqrestore(&priv
->lock
, flags
);
872 interruptible_sleep_on(&priv
->delta_msr_wait
);
873 /* see if a signal did it */
874 if (signal_pending(current
))
877 spin_lock_irqsave(&priv
->lock
, flags
);
878 status
= priv
->line_status
;
879 spin_unlock_irqrestore(&priv
->lock
, flags
);
881 changed
= prevstatus
^ status
;
883 if (((arg
& TIOCM_RNG
) && (changed
& UART_RING
)) ||
884 ((arg
& TIOCM_DSR
) && (changed
& UART_DSR
)) ||
885 ((arg
& TIOCM_CD
) && (changed
& UART_DCD
)) ||
886 ((arg
& TIOCM_CTS
) && (changed
& UART_CTS
))) {
895 static int pl2303_ioctl(struct tty_struct
*tty
, struct file
*file
,
896 unsigned int cmd
, unsigned long arg
)
898 struct serial_struct ser
;
899 struct usb_serial_port
*port
= tty
->driver_data
;
900 dbg("%s (%d) cmd = 0x%04x", __func__
, port
->number
, cmd
);
904 memset(&ser
, 0, sizeof ser
);
905 ser
.type
= PORT_16654
;
906 ser
.line
= port
->serial
->minor
;
907 ser
.port
= port
->number
;
908 ser
.baud_base
= 460800;
910 if (copy_to_user((void __user
*)arg
, &ser
, sizeof ser
))
916 dbg("%s (%d) TIOCMIWAIT", __func__
, port
->number
);
917 return wait_modem_info(port
, arg
);
919 dbg("%s not supported = 0x%04x", __func__
, cmd
);
925 static void pl2303_break_ctl(struct tty_struct
*tty
, int break_state
)
927 struct usb_serial_port
*port
= tty
->driver_data
;
928 struct usb_serial
*serial
= port
->serial
;
932 dbg("%s - port %d", __func__
, port
->number
);
934 if (break_state
== 0)
938 dbg("%s - turning break %s", __func__
,
939 state
== BREAK_OFF
? "off" : "on");
941 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
942 BREAK_REQUEST
, BREAK_REQUEST_TYPE
, state
,
945 dbg("%s - error sending break = %d", __func__
, result
);
948 static void pl2303_release(struct usb_serial
*serial
)
951 struct pl2303_private
*priv
;
955 for (i
= 0; i
< serial
->num_ports
; ++i
) {
956 priv
= usb_get_serial_port_data(serial
->port
[i
]);
958 pl2303_buf_free(priv
->buf
);
964 static void pl2303_update_line_status(struct usb_serial_port
*port
,
966 unsigned int actual_length
)
969 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
971 u8 status_idx
= UART_STATE
;
972 u8 length
= UART_STATE
+ 1;
975 idv
= le16_to_cpu(port
->serial
->dev
->descriptor
.idVendor
);
976 idp
= le16_to_cpu(port
->serial
->dev
->descriptor
.idProduct
);
979 if (idv
== SIEMENS_VENDOR_ID
) {
980 if (idp
== SIEMENS_PRODUCT_ID_X65
||
981 idp
== SIEMENS_PRODUCT_ID_SX1
||
982 idp
== SIEMENS_PRODUCT_ID_X75
) {
989 if (actual_length
< length
)
992 /* Save off the uart status for others to look at */
993 spin_lock_irqsave(&priv
->lock
, flags
);
994 priv
->line_status
= data
[status_idx
];
995 spin_unlock_irqrestore(&priv
->lock
, flags
);
996 if (priv
->line_status
& UART_BREAK_ERROR
)
997 usb_serial_handle_break(port
);
998 wake_up_interruptible(&priv
->delta_msr_wait
);
1001 static void pl2303_read_int_callback(struct urb
*urb
)
1003 struct usb_serial_port
*port
= urb
->context
;
1004 unsigned char *data
= urb
->transfer_buffer
;
1005 unsigned int actual_length
= urb
->actual_length
;
1006 int status
= urb
->status
;
1009 dbg("%s (%d)", __func__
, port
->number
);
1018 /* this urb is terminated, clean up */
1019 dbg("%s - urb shutting down with status: %d", __func__
,
1023 dbg("%s - nonzero urb status received: %d", __func__
,
1028 usb_serial_debug_data(debug
, &port
->dev
, __func__
,
1029 urb
->actual_length
, urb
->transfer_buffer
);
1031 pl2303_update_line_status(port
, data
, actual_length
);
1034 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
1036 dev_err(&urb
->dev
->dev
,
1037 "%s - usb_submit_urb failed with result %d\n",
1041 static void pl2303_push_data(struct tty_struct
*tty
,
1042 struct usb_serial_port
*port
, struct urb
*urb
,
1045 unsigned char *data
= urb
->transfer_buffer
;
1046 /* get tty_flag from status */
1047 char tty_flag
= TTY_NORMAL
;
1048 /* break takes precedence over parity, */
1049 /* which takes precedence over framing errors */
1050 if (line_status
& UART_BREAK_ERROR
)
1051 tty_flag
= TTY_BREAK
;
1052 else if (line_status
& UART_PARITY_ERROR
)
1053 tty_flag
= TTY_PARITY
;
1054 else if (line_status
& UART_FRAME_ERROR
)
1055 tty_flag
= TTY_FRAME
;
1056 dbg("%s - tty_flag = %d", __func__
, tty_flag
);
1058 /* overrun is special, not associated with a char */
1059 if (line_status
& UART_OVERRUN_ERROR
)
1060 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
1062 if (tty_flag
== TTY_NORMAL
&& !(port
->console
&& port
->sysrq
))
1063 tty_insert_flip_string(tty
, data
, urb
->actual_length
);
1066 for (i
= 0; i
< urb
->actual_length
; ++i
)
1067 if (!usb_serial_handle_sysrq_char(tty
, port
, data
[i
]))
1068 tty_insert_flip_char(tty
, data
[i
], tty_flag
);
1070 tty_flip_buffer_push(tty
);
1073 static void pl2303_read_bulk_callback(struct urb
*urb
)
1075 struct usb_serial_port
*port
= urb
->context
;
1076 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
1077 struct tty_struct
*tty
;
1078 unsigned long flags
;
1080 int status
= urb
->status
;
1083 dbg("%s - port %d", __func__
, port
->number
);
1086 dbg("%s - urb status = %d", __func__
, status
);
1087 if (status
== -EPROTO
) {
1088 /* PL2303 mysteriously fails with -EPROTO reschedule
1090 dbg("%s - caught -EPROTO, resubmitting the urb",
1092 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
1094 dev_err(&urb
->dev
->dev
, "%s - failed"
1095 " resubmitting read urb, error %d\n",
1099 dbg("%s - unable to handle the error, exiting.", __func__
);
1103 usb_serial_debug_data(debug
, &port
->dev
, __func__
,
1104 urb
->actual_length
, urb
->transfer_buffer
);
1106 spin_lock_irqsave(&priv
->lock
, flags
);
1107 line_status
= priv
->line_status
;
1108 priv
->line_status
&= ~UART_STATE_TRANSIENT_MASK
;
1109 spin_unlock_irqrestore(&priv
->lock
, flags
);
1110 wake_up_interruptible(&priv
->delta_msr_wait
);
1112 tty
= tty_port_tty_get(&port
->port
);
1113 if (tty
&& urb
->actual_length
) {
1114 pl2303_push_data(tty
, port
, urb
, line_status
);
1117 /* Schedule the next read _if_ we are still open */
1118 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
1119 if (result
&& result
!= -EPERM
)
1120 dev_err(&urb
->dev
->dev
, "%s - failed resubmitting"
1121 " read urb, error %d\n", __func__
, result
);
1124 static void pl2303_write_bulk_callback(struct urb
*urb
)
1126 struct usb_serial_port
*port
= urb
->context
;
1127 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
1129 int status
= urb
->status
;
1131 dbg("%s - port %d", __func__
, port
->number
);
1140 /* this urb is terminated, clean up */
1141 dbg("%s - urb shutting down with status: %d", __func__
,
1143 priv
->write_urb_in_use
= 0;
1146 /* error in the urb, so we have to resubmit it */
1147 dbg("%s - Overflow in write", __func__
);
1148 dbg("%s - nonzero write bulk status received: %d", __func__
,
1150 port
->write_urb
->transfer_buffer_length
= 1;
1151 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
1153 dev_err(&urb
->dev
->dev
, "%s - failed resubmitting write"
1154 " urb, error %d\n", __func__
, result
);
1159 priv
->write_urb_in_use
= 0;
1161 /* send any buffered data */
1165 /* All of the device info needed for the PL2303 SIO serial converter */
1166 static struct usb_serial_driver pl2303_device
= {
1168 .owner
= THIS_MODULE
,
1171 .id_table
= id_table
,
1172 .usb_driver
= &pl2303_driver
,
1174 .open
= pl2303_open
,
1175 .close
= pl2303_close
,
1176 .dtr_rts
= pl2303_dtr_rts
,
1177 .carrier_raised
= pl2303_carrier_raised
,
1178 .write
= pl2303_write
,
1179 .ioctl
= pl2303_ioctl
,
1180 .break_ctl
= pl2303_break_ctl
,
1181 .set_termios
= pl2303_set_termios
,
1182 .tiocmget
= pl2303_tiocmget
,
1183 .tiocmset
= pl2303_tiocmset
,
1184 .read_bulk_callback
= pl2303_read_bulk_callback
,
1185 .read_int_callback
= pl2303_read_int_callback
,
1186 .write_bulk_callback
= pl2303_write_bulk_callback
,
1187 .write_room
= pl2303_write_room
,
1188 .chars_in_buffer
= pl2303_chars_in_buffer
,
1189 .attach
= pl2303_startup
,
1190 .release
= pl2303_release
,
1193 static int __init
pl2303_init(void)
1197 retval
= usb_serial_register(&pl2303_device
);
1199 goto failed_usb_serial_register
;
1200 retval
= usb_register(&pl2303_driver
);
1202 goto failed_usb_register
;
1203 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1205 failed_usb_register
:
1206 usb_serial_deregister(&pl2303_device
);
1207 failed_usb_serial_register
:
1211 static void __exit
pl2303_exit(void)
1213 usb_deregister(&pl2303_driver
);
1214 usb_serial_deregister(&pl2303_device
);
1217 module_init(pl2303_init
);
1218 module_exit(pl2303_exit
);
1220 MODULE_DESCRIPTION(DRIVER_DESC
);
1221 MODULE_LICENSE("GPL");
1223 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1224 MODULE_PARM_DESC(debug
, "Debug enabled or not");