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/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/init.h>
20 #include <linux/slab.h>
21 #include <linux/tty.h>
22 #include <linux/tty_driver.h>
23 #include <linux/tty_flip.h>
24 #include <linux/serial.h>
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/spinlock.h>
28 #include <asm/uaccess.h>
29 #include <linux/usb.h>
30 #include <linux/usb/serial.h>
36 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
40 #define PL2303_CLOSING_WAIT (30*HZ)
42 #define PL2303_BUF_SIZE 1024
43 #define PL2303_TMP_BUF_SIZE 1024
46 unsigned int buf_size
;
52 static struct usb_device_id id_table
[] = {
53 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID
) },
54 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_RSAQ2
) },
55 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_DCU11
) },
56 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_RSAQ3
) },
57 { USB_DEVICE(PL2303_VENDOR_ID
, PL2303_PRODUCT_ID_PHAROS
) },
58 { USB_DEVICE(IODATA_VENDOR_ID
, IODATA_PRODUCT_ID
) },
59 { USB_DEVICE(ATEN_VENDOR_ID
, ATEN_PRODUCT_ID
) },
60 { USB_DEVICE(ATEN_VENDOR_ID2
, ATEN_PRODUCT_ID
) },
61 { USB_DEVICE(ELCOM_VENDOR_ID
, ELCOM_PRODUCT_ID
) },
62 { USB_DEVICE(ELCOM_VENDOR_ID
, ELCOM_PRODUCT_ID_UCSGT
) },
63 { USB_DEVICE(ITEGNO_VENDOR_ID
, ITEGNO_PRODUCT_ID
) },
64 { USB_DEVICE(ITEGNO_VENDOR_ID
, ITEGNO_PRODUCT_ID_2080
) },
65 { USB_DEVICE(MA620_VENDOR_ID
, MA620_PRODUCT_ID
) },
66 { USB_DEVICE(RATOC_VENDOR_ID
, RATOC_PRODUCT_ID
) },
67 { USB_DEVICE(TRIPP_VENDOR_ID
, TRIPP_PRODUCT_ID
) },
68 { USB_DEVICE(RADIOSHACK_VENDOR_ID
, RADIOSHACK_PRODUCT_ID
) },
69 { USB_DEVICE(DCU10_VENDOR_ID
, DCU10_PRODUCT_ID
) },
70 { USB_DEVICE(SITECOM_VENDOR_ID
, SITECOM_PRODUCT_ID
) },
71 { USB_DEVICE(ALCATEL_VENDOR_ID
, ALCATEL_PRODUCT_ID
) },
72 { USB_DEVICE(SAMSUNG_VENDOR_ID
, SAMSUNG_PRODUCT_ID
) },
73 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_SX1
) },
74 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_X65
) },
75 { USB_DEVICE(SIEMENS_VENDOR_ID
, SIEMENS_PRODUCT_ID_X75
) },
76 { USB_DEVICE(SYNTECH_VENDOR_ID
, SYNTECH_PRODUCT_ID
) },
77 { USB_DEVICE(NOKIA_CA42_VENDOR_ID
, NOKIA_CA42_PRODUCT_ID
) },
78 { USB_DEVICE(CA_42_CA42_VENDOR_ID
, CA_42_CA42_PRODUCT_ID
) },
79 { USB_DEVICE(SAGEM_VENDOR_ID
, SAGEM_PRODUCT_ID
) },
80 { USB_DEVICE(LEADTEK_VENDOR_ID
, LEADTEK_9531_PRODUCT_ID
) },
81 { USB_DEVICE(SPEEDDRAGON_VENDOR_ID
, SPEEDDRAGON_PRODUCT_ID
) },
82 { USB_DEVICE(DATAPILOT_U2_VENDOR_ID
, DATAPILOT_U2_PRODUCT_ID
) },
83 { USB_DEVICE(BELKIN_VENDOR_ID
, BELKIN_PRODUCT_ID
) },
84 { USB_DEVICE(ALCOR_VENDOR_ID
, ALCOR_PRODUCT_ID
) },
85 { USB_DEVICE(HUAWEI_VENDOR_ID
, HUAWEI_PRODUCT_ID
) },
86 { USB_DEVICE(WS002IN_VENDOR_ID
, WS002IN_PRODUCT_ID
) },
87 { } /* Terminating entry */
90 MODULE_DEVICE_TABLE(usb
, id_table
);
92 static struct usb_driver pl2303_driver
= {
94 .probe
= usb_serial_probe
,
95 .disconnect
= usb_serial_disconnect
,
100 #define SET_LINE_REQUEST_TYPE 0x21
101 #define SET_LINE_REQUEST 0x20
103 #define SET_CONTROL_REQUEST_TYPE 0x21
104 #define SET_CONTROL_REQUEST 0x22
105 #define CONTROL_DTR 0x01
106 #define CONTROL_RTS 0x02
108 #define BREAK_REQUEST_TYPE 0x21
109 #define BREAK_REQUEST 0x23
110 #define BREAK_ON 0xffff
111 #define BREAK_OFF 0x0000
113 #define GET_LINE_REQUEST_TYPE 0xa1
114 #define GET_LINE_REQUEST 0x21
116 #define VENDOR_WRITE_REQUEST_TYPE 0x40
117 #define VENDOR_WRITE_REQUEST 0x01
119 #define VENDOR_READ_REQUEST_TYPE 0xc0
120 #define VENDOR_READ_REQUEST 0x01
122 #define UART_STATE 0x08
123 #define UART_STATE_TRANSIENT_MASK 0x74
124 #define UART_DCD 0x01
125 #define UART_DSR 0x02
126 #define UART_BREAK_ERROR 0x04
127 #define UART_RING 0x08
128 #define UART_FRAME_ERROR 0x10
129 #define UART_PARITY_ERROR 0x20
130 #define UART_OVERRUN_ERROR 0x40
131 #define UART_CTS 0x80
135 type_0
, /* don't know the difference between type 0 and */
136 type_1
, /* type 1, until someone from prolific tells us... */
137 HX
, /* HX version of the pl2303 chip */
140 struct pl2303_private
{
142 struct pl2303_buf
*buf
;
143 int write_urb_in_use
;
144 wait_queue_head_t delta_msr_wait
;
147 u8 termios_initialized
;
148 enum pl2303_type type
;
154 * Allocate a circular buffer and all associated memory.
156 static struct pl2303_buf
*pl2303_buf_alloc(unsigned int size
)
158 struct pl2303_buf
*pb
;
163 pb
= kmalloc(sizeof(struct pl2303_buf
), GFP_KERNEL
);
167 pb
->buf_buf
= kmalloc(size
, GFP_KERNEL
);
168 if (pb
->buf_buf
== NULL
) {
174 pb
->buf_get
= pb
->buf_put
= pb
->buf_buf
;
182 * Free the buffer and all associated memory.
184 static void pl2303_buf_free(struct pl2303_buf
*pb
)
195 * Clear out all data in the circular buffer.
197 static void pl2303_buf_clear(struct pl2303_buf
*pb
)
200 pb
->buf_get
= pb
->buf_put
;
201 /* equivalent to a get of all data available */
205 * pl2303_buf_data_avail
207 * Return the number of bytes of data available in the circular
210 static unsigned int pl2303_buf_data_avail(struct pl2303_buf
*pb
)
215 return ((pb
->buf_size
+ pb
->buf_put
- pb
->buf_get
) % pb
->buf_size
);
219 * pl2303_buf_space_avail
221 * Return the number of bytes of space available in the circular
224 static unsigned int pl2303_buf_space_avail(struct pl2303_buf
*pb
)
229 return ((pb
->buf_size
+ pb
->buf_get
- pb
->buf_put
- 1) % pb
->buf_size
);
235 * Copy data data from a user buffer and put it into the circular buffer.
236 * Restrict to the amount of space available.
238 * Return the number of bytes copied.
240 static unsigned int pl2303_buf_put(struct pl2303_buf
*pb
, const char *buf
,
248 len
= pl2303_buf_space_avail(pb
);
255 len
= pb
->buf_buf
+ pb
->buf_size
- pb
->buf_put
;
257 memcpy(pb
->buf_put
, buf
, len
);
258 memcpy(pb
->buf_buf
, buf
+len
, count
- len
);
259 pb
->buf_put
= pb
->buf_buf
+ count
- len
;
261 memcpy(pb
->buf_put
, buf
, count
);
263 pb
->buf_put
+= count
;
264 else /* count == len */
265 pb
->buf_put
= pb
->buf_buf
;
274 * Get data from the circular buffer and copy to the given buffer.
275 * Restrict to the amount of data available.
277 * Return the number of bytes copied.
279 static unsigned int pl2303_buf_get(struct pl2303_buf
*pb
, char *buf
,
287 len
= pl2303_buf_data_avail(pb
);
294 len
= pb
->buf_buf
+ pb
->buf_size
- pb
->buf_get
;
296 memcpy(buf
, pb
->buf_get
, len
);
297 memcpy(buf
+len
, pb
->buf_buf
, count
- len
);
298 pb
->buf_get
= pb
->buf_buf
+ count
- len
;
300 memcpy(buf
, pb
->buf_get
, count
);
302 pb
->buf_get
+= count
;
303 else /* count == len */
304 pb
->buf_get
= pb
->buf_buf
;
310 static int pl2303_startup(struct usb_serial
*serial
)
312 struct pl2303_private
*priv
;
313 enum pl2303_type type
= type_0
;
316 if (serial
->dev
->descriptor
.bDeviceClass
== 0x02)
318 else if (serial
->dev
->descriptor
.bMaxPacketSize0
== 0x40)
320 else if (serial
->dev
->descriptor
.bDeviceClass
== 0x00)
322 else if (serial
->dev
->descriptor
.bDeviceClass
== 0xFF)
324 dbg("device type: %d", type
);
326 for (i
= 0; i
< serial
->num_ports
; ++i
) {
327 priv
= kzalloc(sizeof(struct pl2303_private
), GFP_KERNEL
);
330 spin_lock_init(&priv
->lock
);
331 priv
->buf
= pl2303_buf_alloc(PL2303_BUF_SIZE
);
332 if (priv
->buf
== NULL
) {
336 init_waitqueue_head(&priv
->delta_msr_wait
);
338 usb_set_serial_port_data(serial
->port
[i
], priv
);
343 for (--i
; i
>=0; --i
) {
344 priv
= usb_get_serial_port_data(serial
->port
[i
]);
345 pl2303_buf_free(priv
->buf
);
347 usb_set_serial_port_data(serial
->port
[i
], NULL
);
352 static int set_control_lines(struct usb_device
*dev
, u8 value
)
356 retval
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
357 SET_CONTROL_REQUEST
, SET_CONTROL_REQUEST_TYPE
,
358 value
, 0, NULL
, 0, 100);
359 dbg("%s - value = %d, retval = %d", __FUNCTION__
, value
, retval
);
363 static void pl2303_send(struct usb_serial_port
*port
)
366 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
369 dbg("%s - port %d", __FUNCTION__
, port
->number
);
371 spin_lock_irqsave(&priv
->lock
, flags
);
373 if (priv
->write_urb_in_use
) {
374 spin_unlock_irqrestore(&priv
->lock
, flags
);
378 count
= pl2303_buf_get(priv
->buf
, port
->write_urb
->transfer_buffer
,
379 port
->bulk_out_size
);
382 spin_unlock_irqrestore(&priv
->lock
, flags
);
386 priv
->write_urb_in_use
= 1;
388 spin_unlock_irqrestore(&priv
->lock
, flags
);
390 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
, count
,
391 port
->write_urb
->transfer_buffer
);
393 port
->write_urb
->transfer_buffer_length
= count
;
394 port
->write_urb
->dev
= port
->serial
->dev
;
395 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
397 dev_err(&port
->dev
, "%s - failed submitting write urb,"
398 " error %d\n", __FUNCTION__
, result
);
399 priv
->write_urb_in_use
= 0;
400 // TODO: reschedule pl2303_send
403 usb_serial_port_softint(port
);
406 static int pl2303_write(struct usb_serial_port
*port
, const unsigned char *buf
,
409 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
412 dbg("%s - port %d, %d bytes", __FUNCTION__
, port
->number
, count
);
417 spin_lock_irqsave(&priv
->lock
, flags
);
418 count
= pl2303_buf_put(priv
->buf
, buf
, count
);
419 spin_unlock_irqrestore(&priv
->lock
, flags
);
426 static int pl2303_write_room(struct usb_serial_port
*port
)
428 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
432 dbg("%s - port %d", __FUNCTION__
, port
->number
);
434 spin_lock_irqsave(&priv
->lock
, flags
);
435 room
= pl2303_buf_space_avail(priv
->buf
);
436 spin_unlock_irqrestore(&priv
->lock
, flags
);
438 dbg("%s - returns %d", __FUNCTION__
, room
);
442 static int pl2303_chars_in_buffer(struct usb_serial_port
*port
)
444 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
448 dbg("%s - port %d", __FUNCTION__
, port
->number
);
450 spin_lock_irqsave(&priv
->lock
, flags
);
451 chars
= pl2303_buf_data_avail(priv
->buf
);
452 spin_unlock_irqrestore(&priv
->lock
, flags
);
454 dbg("%s - returns %d", __FUNCTION__
, chars
);
458 static void pl2303_set_termios(struct usb_serial_port
*port
,
459 struct ktermios
*old_termios
)
461 struct usb_serial
*serial
= port
->serial
;
462 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
470 dbg("%s - port %d", __FUNCTION__
, port
->number
);
472 if ((!port
->tty
) || (!port
->tty
->termios
)) {
473 dbg("%s - no tty structures", __FUNCTION__
);
477 spin_lock_irqsave(&priv
->lock
, flags
);
478 if (!priv
->termios_initialized
) {
479 *(port
->tty
->termios
) = tty_std_termios
;
480 port
->tty
->termios
->c_cflag
= B9600
| CS8
| CREAD
|
482 priv
->termios_initialized
= 1;
484 spin_unlock_irqrestore(&priv
->lock
, flags
);
486 cflag
= port
->tty
->termios
->c_cflag
;
487 /* check that they really want us to change something */
489 if ((cflag
== old_termios
->c_cflag
) &&
490 (RELEVANT_IFLAG(port
->tty
->termios
->c_iflag
) ==
491 RELEVANT_IFLAG(old_termios
->c_iflag
))) {
492 dbg("%s - nothing to change...", __FUNCTION__
);
497 buf
= kzalloc(7, GFP_KERNEL
);
499 dev_err(&port
->dev
, "%s - out of memory.\n", __FUNCTION__
);
503 i
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
504 GET_LINE_REQUEST
, GET_LINE_REQUEST_TYPE
,
506 dbg("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i
,
507 buf
[0], buf
[1], buf
[2], buf
[3], buf
[4], buf
[5], buf
[6]);
510 switch (cflag
& CSIZE
) {
511 case CS5
: buf
[6] = 5; break;
512 case CS6
: buf
[6] = 6; break;
513 case CS7
: buf
[6] = 7; break;
515 case CS8
: buf
[6] = 8; break;
517 dbg("%s - data bits = %d", __FUNCTION__
, buf
[6]);
521 switch (cflag
& CBAUD
) {
522 case B0
: baud
= 0; break;
523 case B75
: baud
= 75; break;
524 case B150
: baud
= 150; break;
525 case B300
: baud
= 300; break;
526 case B600
: baud
= 600; break;
527 case B1200
: baud
= 1200; break;
528 case B1800
: baud
= 1800; break;
529 case B2400
: baud
= 2400; break;
530 case B4800
: baud
= 4800; break;
531 case B9600
: baud
= 9600; break;
532 case B19200
: baud
= 19200; break;
533 case B38400
: baud
= 38400; break;
534 case B57600
: baud
= 57600; break;
535 case B115200
: baud
= 115200; break;
536 case B230400
: baud
= 230400; break;
537 case B460800
: baud
= 460800; break;
539 dev_err(&port
->dev
, "pl2303 driver does not support"
540 " the baudrate requested (fix it)\n");
543 dbg("%s - baud = %d", __FUNCTION__
, baud
);
545 buf
[0] = baud
& 0xff;
546 buf
[1] = (baud
>> 8) & 0xff;
547 buf
[2] = (baud
>> 16) & 0xff;
548 buf
[3] = (baud
>> 24) & 0xff;
551 /* For reference buf[4]=0 is 1 stop bits */
552 /* For reference buf[4]=1 is 1.5 stop bits */
553 /* For reference buf[4]=2 is 2 stop bits */
554 if (cflag
& CSTOPB
) {
556 dbg("%s - stop bits = 2", __FUNCTION__
);
559 dbg("%s - stop bits = 1", __FUNCTION__
);
562 if (cflag
& PARENB
) {
563 /* For reference buf[5]=0 is none parity */
564 /* For reference buf[5]=1 is odd parity */
565 /* For reference buf[5]=2 is even parity */
566 /* For reference buf[5]=3 is mark parity */
567 /* For reference buf[5]=4 is space parity */
568 if (cflag
& PARODD
) {
570 dbg("%s - parity = odd", __FUNCTION__
);
573 dbg("%s - parity = even", __FUNCTION__
);
577 dbg("%s - parity = none", __FUNCTION__
);
580 i
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
581 SET_LINE_REQUEST
, SET_LINE_REQUEST_TYPE
,
583 dbg("0x21:0x20:0:0 %d", i
);
585 /* change control lines if we are switching to or from B0 */
586 spin_lock_irqsave(&priv
->lock
, flags
);
587 control
= priv
->line_control
;
588 if ((cflag
& CBAUD
) == B0
)
589 priv
->line_control
&= ~(CONTROL_DTR
| CONTROL_RTS
);
591 priv
->line_control
|= (CONTROL_DTR
| CONTROL_RTS
);
592 if (control
!= priv
->line_control
) {
593 control
= priv
->line_control
;
594 spin_unlock_irqrestore(&priv
->lock
, flags
);
595 set_control_lines(serial
->dev
, control
);
597 spin_unlock_irqrestore(&priv
->lock
, flags
);
600 buf
[0] = buf
[1] = buf
[2] = buf
[3] = buf
[4] = buf
[5] = buf
[6] = 0;
602 i
= usb_control_msg(serial
->dev
, usb_rcvctrlpipe(serial
->dev
, 0),
603 GET_LINE_REQUEST
, GET_LINE_REQUEST_TYPE
,
605 dbg("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i
,
606 buf
[0], buf
[1], buf
[2], buf
[3], buf
[4], buf
[5], buf
[6]);
608 if (cflag
& CRTSCTS
) {
610 if (priv
->type
== HX
)
614 i
= usb_control_msg(serial
->dev
,
615 usb_sndctrlpipe(serial
->dev
, 0),
616 VENDOR_WRITE_REQUEST
,
617 VENDOR_WRITE_REQUEST_TYPE
,
618 0x0, index
, NULL
, 0, 100);
619 dbg("0x40:0x1:0x0:0x%x %d", index
, i
);
621 i
= usb_control_msg(serial
->dev
,
622 usb_sndctrlpipe(serial
->dev
, 0),
623 VENDOR_WRITE_REQUEST
,
624 VENDOR_WRITE_REQUEST_TYPE
,
625 0x0, 0x0, NULL
, 0, 100);
626 dbg ("0x40:0x1:0x0:0x0 %d", i
);
632 static void pl2303_close(struct usb_serial_port
*port
, struct file
*filp
)
634 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
636 unsigned int c_cflag
;
641 dbg("%s - port %d", __FUNCTION__
, port
->number
);
643 /* wait for data to drain from the buffer */
644 spin_lock_irqsave(&priv
->lock
, flags
);
645 timeout
= PL2303_CLOSING_WAIT
;
646 init_waitqueue_entry(&wait
, current
);
647 add_wait_queue(&port
->tty
->write_wait
, &wait
);
649 set_current_state(TASK_INTERRUPTIBLE
);
650 if (pl2303_buf_data_avail(priv
->buf
) == 0 ||
651 timeout
== 0 || signal_pending(current
) ||
652 !usb_get_intfdata(port
->serial
->interface
)) /* disconnect */
654 spin_unlock_irqrestore(&priv
->lock
, flags
);
655 timeout
= schedule_timeout(timeout
);
656 spin_lock_irqsave(&priv
->lock
, flags
);
658 set_current_state(TASK_RUNNING
);
659 remove_wait_queue(&port
->tty
->write_wait
, &wait
);
660 /* clear out any remaining data in the buffer */
661 pl2303_buf_clear(priv
->buf
);
662 spin_unlock_irqrestore(&priv
->lock
, flags
);
664 /* wait for characters to drain from the device */
665 /* (this is long enough for the entire 256 byte */
666 /* pl2303 hardware buffer to drain with no flow */
667 /* control for data rates of 1200 bps or more, */
668 /* for lower rates we should really know how much */
669 /* data is in the buffer to compute a delay */
670 /* that is not unnecessarily long) */
671 bps
= tty_get_baud_rate(port
->tty
);
673 timeout
= max((HZ
*2560)/bps
,HZ
/10);
676 schedule_timeout_interruptible(timeout
);
678 /* shutdown our urbs */
679 dbg("%s - shutting down urbs", __FUNCTION__
);
680 usb_kill_urb(port
->write_urb
);
681 usb_kill_urb(port
->read_urb
);
682 usb_kill_urb(port
->interrupt_in_urb
);
685 c_cflag
= port
->tty
->termios
->c_cflag
;
686 if (c_cflag
& HUPCL
) {
687 /* drop DTR and RTS */
688 spin_lock_irqsave(&priv
->lock
, flags
);
689 priv
->line_control
= 0;
690 spin_unlock_irqrestore(&priv
->lock
, flags
);
691 set_control_lines(port
->serial
->dev
, 0);
696 static int pl2303_open(struct usb_serial_port
*port
, struct file
*filp
)
698 struct ktermios tmp_termios
;
699 struct usb_serial
*serial
= port
->serial
;
700 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
704 dbg("%s - port %d", __FUNCTION__
, port
->number
);
706 if (priv
->type
!= HX
) {
707 usb_clear_halt(serial
->dev
, port
->write_urb
->pipe
);
708 usb_clear_halt(serial
->dev
, port
->read_urb
->pipe
);
711 buf
= kmalloc(10, GFP_KERNEL
);
715 #define FISH(a,b,c,d) \
716 result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0), \
717 b, a, c, d, buf, 1, 100); \
718 dbg("0x%x:0x%x:0x%x:0x%x %d - %x",a,b,c,d,result,buf[0]);
720 #define SOUP(a,b,c,d) \
721 result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0), \
722 b, a, c, d, NULL, 0, 100); \
723 dbg("0x%x:0x%x:0x%x:0x%x %d",a,b,c,d,result);
725 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8484, 0);
726 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 0x0404, 0);
727 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8484, 0);
728 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8383, 0);
729 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8484, 0);
730 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 0x0404, 1);
731 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8484, 0);
732 FISH (VENDOR_READ_REQUEST_TYPE
, VENDOR_READ_REQUEST
, 0x8383, 0);
733 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 0, 1);
734 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 1, 0);
736 if (priv
->type
== HX
) {
738 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 2, 0x44);
739 /* reset upstream data pipes */
740 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 8, 0);
741 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 9, 0);
743 SOUP (VENDOR_WRITE_REQUEST_TYPE
, VENDOR_WRITE_REQUEST
, 2, 0x24);
750 pl2303_set_termios(port
, &tmp_termios
);
753 //FIXME: need to assert RTS and DTR if CRTSCTS off
755 dbg("%s - submitting read urb", __FUNCTION__
);
756 port
->read_urb
->dev
= serial
->dev
;
757 result
= usb_submit_urb(port
->read_urb
, GFP_KERNEL
);
759 dev_err(&port
->dev
, "%s - failed submitting read urb,"
760 " error %d\n", __FUNCTION__
, result
);
761 pl2303_close(port
, NULL
);
765 dbg("%s - submitting interrupt urb", __FUNCTION__
);
766 port
->interrupt_in_urb
->dev
= serial
->dev
;
767 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
769 dev_err(&port
->dev
, "%s - failed submitting interrupt urb,"
770 " error %d\n", __FUNCTION__
, result
);
771 pl2303_close(port
, NULL
);
777 static int pl2303_tiocmset(struct usb_serial_port
*port
, struct file
*file
,
778 unsigned int set
, unsigned int clear
)
780 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
784 if (!usb_get_intfdata(port
->serial
->interface
))
787 spin_lock_irqsave(&priv
->lock
, flags
);
789 priv
->line_control
|= CONTROL_RTS
;
791 priv
->line_control
|= CONTROL_DTR
;
792 if (clear
& TIOCM_RTS
)
793 priv
->line_control
&= ~CONTROL_RTS
;
794 if (clear
& TIOCM_DTR
)
795 priv
->line_control
&= ~CONTROL_DTR
;
796 control
= priv
->line_control
;
797 spin_unlock_irqrestore(&priv
->lock
, flags
);
799 return set_control_lines(port
->serial
->dev
, control
);
802 static int pl2303_tiocmget(struct usb_serial_port
*port
, struct file
*file
)
804 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
810 dbg("%s (%d)", __FUNCTION__
, port
->number
);
812 if (!usb_get_intfdata(port
->serial
->interface
))
815 spin_lock_irqsave(&priv
->lock
, flags
);
816 mcr
= priv
->line_control
;
817 status
= priv
->line_status
;
818 spin_unlock_irqrestore(&priv
->lock
, flags
);
820 result
= ((mcr
& CONTROL_DTR
) ? TIOCM_DTR
: 0)
821 | ((mcr
& CONTROL_RTS
) ? TIOCM_RTS
: 0)
822 | ((status
& UART_CTS
) ? TIOCM_CTS
: 0)
823 | ((status
& UART_DSR
) ? TIOCM_DSR
: 0)
824 | ((status
& UART_RING
) ? TIOCM_RI
: 0)
825 | ((status
& UART_DCD
) ? TIOCM_CD
: 0);
827 dbg("%s - result = %x", __FUNCTION__
, result
);
832 static int wait_modem_info(struct usb_serial_port
*port
, unsigned int arg
)
834 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
836 unsigned int prevstatus
;
838 unsigned int changed
;
840 spin_lock_irqsave(&priv
->lock
, flags
);
841 prevstatus
= priv
->line_status
;
842 spin_unlock_irqrestore(&priv
->lock
, flags
);
845 interruptible_sleep_on(&priv
->delta_msr_wait
);
846 /* see if a signal did it */
847 if (signal_pending(current
))
850 spin_lock_irqsave(&priv
->lock
, flags
);
851 status
= priv
->line_status
;
852 spin_unlock_irqrestore(&priv
->lock
, flags
);
854 changed
=prevstatus
^status
;
856 if (((arg
& TIOCM_RNG
) && (changed
& UART_RING
)) ||
857 ((arg
& TIOCM_DSR
) && (changed
& UART_DSR
)) ||
858 ((arg
& TIOCM_CD
) && (changed
& UART_DCD
)) ||
859 ((arg
& TIOCM_CTS
) && (changed
& UART_CTS
)) ) {
868 static int pl2303_ioctl(struct usb_serial_port
*port
, struct file
*file
,
869 unsigned int cmd
, unsigned long arg
)
871 dbg("%s (%d) cmd = 0x%04x", __FUNCTION__
, port
->number
, cmd
);
875 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__
, port
->number
);
876 return wait_modem_info(port
, arg
);
879 dbg("%s not supported = 0x%04x", __FUNCTION__
, cmd
);
886 static void pl2303_break_ctl(struct usb_serial_port
*port
, int break_state
)
888 struct usb_serial
*serial
= port
->serial
;
892 dbg("%s - port %d", __FUNCTION__
, port
->number
);
894 if (break_state
== 0)
898 dbg("%s - turning break %s", __FUNCTION__
, state
==BREAK_OFF
? "off" : "on");
900 result
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
901 BREAK_REQUEST
, BREAK_REQUEST_TYPE
, state
,
904 dbg("%s - error sending break = %d", __FUNCTION__
, result
);
907 static void pl2303_shutdown(struct usb_serial
*serial
)
910 struct pl2303_private
*priv
;
912 dbg("%s", __FUNCTION__
);
914 for (i
= 0; i
< serial
->num_ports
; ++i
) {
915 priv
= usb_get_serial_port_data(serial
->port
[i
]);
917 pl2303_buf_free(priv
->buf
);
919 usb_set_serial_port_data(serial
->port
[i
], NULL
);
924 static void pl2303_update_line_status(struct usb_serial_port
*port
,
926 unsigned int actual_length
)
929 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
931 u8 status_idx
= UART_STATE
;
932 u8 length
= UART_STATE
+ 1;
935 idv
= le16_to_cpu(port
->serial
->dev
->descriptor
.idVendor
);
936 idp
= le16_to_cpu(port
->serial
->dev
->descriptor
.idProduct
);
939 if (idv
== SIEMENS_VENDOR_ID
) {
940 if (idp
== SIEMENS_PRODUCT_ID_X65
||
941 idp
== SIEMENS_PRODUCT_ID_SX1
||
942 idp
== SIEMENS_PRODUCT_ID_X75
) {
949 if (actual_length
< length
)
952 /* Save off the uart status for others to look at */
953 spin_lock_irqsave(&priv
->lock
, flags
);
954 priv
->line_status
= data
[status_idx
];
955 spin_unlock_irqrestore(&priv
->lock
, flags
);
956 wake_up_interruptible(&priv
->delta_msr_wait
);
959 static void pl2303_read_int_callback(struct urb
*urb
)
961 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
962 unsigned char *data
= urb
->transfer_buffer
;
963 unsigned int actual_length
= urb
->actual_length
;
966 dbg("%s (%d)", __FUNCTION__
, port
->number
);
968 switch (urb
->status
) {
975 /* this urb is terminated, clean up */
976 dbg("%s - urb shutting down with status: %d", __FUNCTION__
,
980 dbg("%s - nonzero urb status received: %d", __FUNCTION__
,
985 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
,
986 urb
->actual_length
, urb
->transfer_buffer
);
988 pl2303_update_line_status(port
, data
, actual_length
);
991 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
993 dev_err(&urb
->dev
->dev
,
994 "%s - usb_submit_urb failed with result %d\n",
995 __FUNCTION__
, status
);
998 static void pl2303_read_bulk_callback(struct urb
*urb
)
1000 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
1001 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
1002 struct tty_struct
*tty
;
1003 unsigned char *data
= urb
->transfer_buffer
;
1004 unsigned long flags
;
1010 dbg("%s - port %d", __FUNCTION__
, port
->number
);
1013 dbg("%s - urb->status = %d", __FUNCTION__
, urb
->status
);
1014 if (!port
->open_count
) {
1015 dbg("%s - port is closed, exiting.", __FUNCTION__
);
1018 if (urb
->status
== -EPROTO
) {
1019 /* PL2303 mysteriously fails with -EPROTO reschedule
1021 dbg("%s - caught -EPROTO, resubmitting the urb",
1024 urb
->dev
= port
->serial
->dev
;
1025 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
1027 dev_err(&urb
->dev
->dev
, "%s - failed"
1028 " resubmitting read urb, error %d\n",
1029 __FUNCTION__
, result
);
1032 dbg("%s - unable to handle the error, exiting.", __FUNCTION__
);
1036 usb_serial_debug_data(debug
, &port
->dev
, __FUNCTION__
,
1037 urb
->actual_length
, data
);
1039 /* get tty_flag from status */
1040 tty_flag
= TTY_NORMAL
;
1042 spin_lock_irqsave(&priv
->lock
, flags
);
1043 status
= priv
->line_status
;
1044 priv
->line_status
&= ~UART_STATE_TRANSIENT_MASK
;
1045 spin_unlock_irqrestore(&priv
->lock
, flags
);
1046 wake_up_interruptible(&priv
->delta_msr_wait
);
1048 /* break takes precedence over parity, */
1049 /* which takes precedence over framing errors */
1050 if (status
& UART_BREAK_ERROR
)
1051 tty_flag
= TTY_BREAK
;
1052 else if (status
& UART_PARITY_ERROR
)
1053 tty_flag
= TTY_PARITY
;
1054 else if (status
& UART_FRAME_ERROR
)
1055 tty_flag
= TTY_FRAME
;
1056 dbg("%s - tty_flag = %d", __FUNCTION__
, tty_flag
);
1059 if (tty
&& urb
->actual_length
) {
1060 tty_buffer_request_room(tty
, urb
->actual_length
+ 1);
1061 /* overrun is special, not associated with a char */
1062 if (status
& UART_OVERRUN_ERROR
)
1063 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
1064 for (i
= 0; i
< urb
->actual_length
; ++i
)
1065 tty_insert_flip_char(tty
, data
[i
], tty_flag
);
1066 tty_flip_buffer_push(tty
);
1069 /* Schedule the next read _if_ we are still open */
1070 if (port
->open_count
) {
1071 urb
->dev
= port
->serial
->dev
;
1072 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
1074 dev_err(&urb
->dev
->dev
, "%s - failed resubmitting"
1075 " read urb, error %d\n", __FUNCTION__
, result
);
1081 static void pl2303_write_bulk_callback(struct urb
*urb
)
1083 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
1084 struct pl2303_private
*priv
= usb_get_serial_port_data(port
);
1087 dbg("%s - port %d", __FUNCTION__
, port
->number
);
1089 switch (urb
->status
) {
1096 /* this urb is terminated, clean up */
1097 dbg("%s - urb shutting down with status: %d", __FUNCTION__
,
1099 priv
->write_urb_in_use
= 0;
1102 /* error in the urb, so we have to resubmit it */
1103 dbg("%s - Overflow in write", __FUNCTION__
);
1104 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__
,
1106 port
->write_urb
->transfer_buffer_length
= 1;
1107 port
->write_urb
->dev
= port
->serial
->dev
;
1108 result
= usb_submit_urb(port
->write_urb
, GFP_ATOMIC
);
1110 dev_err(&urb
->dev
->dev
, "%s - failed resubmitting write"
1111 " urb, error %d\n", __FUNCTION__
, result
);
1116 priv
->write_urb_in_use
= 0;
1118 /* send any buffered data */
1122 /* All of the device info needed for the PL2303 SIO serial converter */
1123 static struct usb_serial_driver pl2303_device
= {
1125 .owner
= THIS_MODULE
,
1128 .id_table
= id_table
,
1129 .usb_driver
= &pl2303_driver
,
1130 .num_interrupt_in
= NUM_DONT_CARE
,
1134 .open
= pl2303_open
,
1135 .close
= pl2303_close
,
1136 .write
= pl2303_write
,
1137 .ioctl
= pl2303_ioctl
,
1138 .break_ctl
= pl2303_break_ctl
,
1139 .set_termios
= pl2303_set_termios
,
1140 .tiocmget
= pl2303_tiocmget
,
1141 .tiocmset
= pl2303_tiocmset
,
1142 .read_bulk_callback
= pl2303_read_bulk_callback
,
1143 .read_int_callback
= pl2303_read_int_callback
,
1144 .write_bulk_callback
= pl2303_write_bulk_callback
,
1145 .write_room
= pl2303_write_room
,
1146 .chars_in_buffer
= pl2303_chars_in_buffer
,
1147 .attach
= pl2303_startup
,
1148 .shutdown
= pl2303_shutdown
,
1151 static int __init
pl2303_init(void)
1155 retval
= usb_serial_register(&pl2303_device
);
1157 goto failed_usb_serial_register
;
1158 retval
= usb_register(&pl2303_driver
);
1160 goto failed_usb_register
;
1163 failed_usb_register
:
1164 usb_serial_deregister(&pl2303_device
);
1165 failed_usb_serial_register
:
1169 static void __exit
pl2303_exit(void)
1171 usb_deregister(&pl2303_driver
);
1172 usb_serial_deregister(&pl2303_device
);
1175 module_init(pl2303_init
);
1176 module_exit(pl2303_exit
);
1178 MODULE_DESCRIPTION(DRIVER_DESC
);
1179 MODULE_LICENSE("GPL");
1181 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1182 MODULE_PARM_DESC(debug
, "Debug enabled or not");