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 * Copyright (C) 2009, 2013 Frank Schäfer <fschaefer.oss@googlemail.com>
8 * - fixes, improvements and documentation for the baud rate encoding methods
9 * Copyright (C) 2013 Reinhard Max <max@suse.de>
10 * - fixes and improvements for the divisor based baud rate encoding method
12 * Original driver for 2.2.x by anonymous
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License version
16 * 2 as published by the Free Software Foundation.
18 * See Documentation/usb/usb-serial.txt for more information on using this
23 #include <linux/kernel.h>
24 #include <linux/errno.h>
25 #include <linux/init.h>
26 #include <linux/slab.h>
27 #include <linux/tty.h>
28 #include <linux/tty_driver.h>
29 #include <linux/tty_flip.h>
30 #include <linux/serial.h>
31 #include <linux/module.h>
32 #include <linux/moduleparam.h>
33 #include <linux/spinlock.h>
34 #include <linux/uaccess.h>
35 #include <linux/usb.h>
36 #include <linux/usb/serial.h>
37 #include <asm/unaligned.h>
43 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
45 static const struct usb_device_id id_table[] = {
46 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
47 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
48 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
49 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
50 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
51 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ALDIGA) },
52 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MMX) },
53 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GPRS) },
54 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_HCR331) },
55 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MOTOROLA) },
56 { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
57 { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
58 { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
59 { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
60 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
61 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
62 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
63 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
64 { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
65 { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
66 { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
67 { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
68 { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
69 { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
70 { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
71 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
72 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1) },
73 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
74 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75) },
75 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81) },
76 { USB_DEVICE(BENQ_VENDOR_ID, BENQ_PRODUCT_ID_S81) }, /* Benq/Siemens S81 */
77 { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
78 { USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
79 { USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
80 { USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
81 { USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
82 { USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
83 { USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
84 { USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
85 { USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID) },
86 { USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
87 { USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
88 { USB_DEVICE(YCCABLE_VENDOR_ID, YCCABLE_PRODUCT_ID) },
89 { USB_DEVICE(SUPERIAL_VENDOR_ID, SUPERIAL_PRODUCT_ID) },
90 { USB_DEVICE(HP_VENDOR_ID, HP_LD220_PRODUCT_ID) },
91 { USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
92 { USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
93 { USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
94 { USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
95 { USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
96 { USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
97 { } /* Terminating entry */
100 MODULE_DEVICE_TABLE(usb, id_table);
102 #define SET_LINE_REQUEST_TYPE 0x21
103 #define SET_LINE_REQUEST 0x20
105 #define SET_CONTROL_REQUEST_TYPE 0x21
106 #define SET_CONTROL_REQUEST 0x22
107 #define CONTROL_DTR 0x01
108 #define CONTROL_RTS 0x02
110 #define BREAK_REQUEST_TYPE 0x21
111 #define BREAK_REQUEST 0x23
112 #define BREAK_ON 0xffff
113 #define BREAK_OFF 0x0000
115 #define GET_LINE_REQUEST_TYPE 0xa1
116 #define GET_LINE_REQUEST 0x21
118 #define VENDOR_WRITE_REQUEST_TYPE 0x40
119 #define VENDOR_WRITE_REQUEST 0x01
121 #define VENDOR_READ_REQUEST_TYPE 0xc0
122 #define VENDOR_READ_REQUEST 0x01
124 #define UART_STATE 0x08
125 #define UART_STATE_TRANSIENT_MASK 0x74
126 #define UART_DCD 0x01
127 #define UART_DSR 0x02
128 #define UART_BREAK_ERROR 0x04
129 #define UART_RING 0x08
130 #define UART_FRAME_ERROR 0x10
131 #define UART_PARITY_ERROR 0x20
132 #define UART_OVERRUN_ERROR 0x40
133 #define UART_CTS 0x80
137 type_0, /* H version ? */
138 type_1, /* H version ? */
139 HX_TA, /* HX(A) / X(A) / TA version */ /* TODO: improve */
140 HXD_EA_RA_SA, /* HXD / EA / RA / SA version */ /* TODO: improve */
144 * NOTE: don't know the difference between type 0 and type 1,
145 * until someone from Prolific tells us...
146 * TODO: distinguish between X/HX, TA and HXD, EA, RA, SA variants
149 struct pl2303_serial_private {
150 enum pl2303_type type;
153 struct pl2303_private {
159 static int pl2303_vendor_read(__u16 value, __u16 index,
160 struct usb_serial *serial, unsigned char *buf)
162 int res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
163 VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
164 value, index, buf, 1, 100);
165 dev_dbg(&serial->interface->dev, "0x%x:0x%x:0x%x:0x%x %d - %x\n",
166 VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, value, index,
171 static int pl2303_vendor_write(__u16 value, __u16 index,
172 struct usb_serial *serial)
174 int res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
175 VENDOR_WRITE_REQUEST, VENDOR_WRITE_REQUEST_TYPE,
176 value, index, NULL, 0, 100);
177 dev_dbg(&serial->interface->dev, "0x%x:0x%x:0x%x:0x%x %d\n",
178 VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, value, index,
183 static int pl2303_startup(struct usb_serial *serial)
185 struct pl2303_serial_private *spriv;
186 enum pl2303_type type = type_0;
187 char *type_str = "unknown (treating as type_0)";
190 spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
194 buf = kmalloc(10, GFP_KERNEL);
200 if (serial->dev->descriptor.bDeviceClass == 0x02) {
203 } else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40) {
205 * NOTE: The bcdDevice version is the only difference between
206 * the device descriptors of the X/HX, HXD, EA, RA, SA, TA, TB
208 if (le16_to_cpu(serial->dev->descriptor.bcdDevice) == 0x300) {
210 type_str = "X/HX/TA";
211 } else if (le16_to_cpu(serial->dev->descriptor.bcdDevice)
214 type_str = "HXD/EA/RA/SA";
215 } else if (le16_to_cpu(serial->dev->descriptor.bcdDevice)
220 dev_info(&serial->interface->dev,
221 "unknown/unsupported device type\n");
226 } else if (serial->dev->descriptor.bDeviceClass == 0x00
227 || serial->dev->descriptor.bDeviceClass == 0xFF) {
231 dev_dbg(&serial->interface->dev, "device type: %s\n", type_str);
234 usb_set_serial_data(serial, spriv);
236 pl2303_vendor_read(0x8484, 0, serial, buf);
237 pl2303_vendor_write(0x0404, 0, serial);
238 pl2303_vendor_read(0x8484, 0, serial, buf);
239 pl2303_vendor_read(0x8383, 0, serial, buf);
240 pl2303_vendor_read(0x8484, 0, serial, buf);
241 pl2303_vendor_write(0x0404, 1, serial);
242 pl2303_vendor_read(0x8484, 0, serial, buf);
243 pl2303_vendor_read(0x8383, 0, serial, buf);
244 pl2303_vendor_write(0, 1, serial);
245 pl2303_vendor_write(1, 0, serial);
246 if (type == type_0 || type == type_1)
247 pl2303_vendor_write(2, 0x24, serial);
249 pl2303_vendor_write(2, 0x44, serial);
255 static void pl2303_release(struct usb_serial *serial)
257 struct pl2303_serial_private *spriv;
259 spriv = usb_get_serial_data(serial);
263 static int pl2303_port_probe(struct usb_serial_port *port)
265 struct pl2303_private *priv;
267 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
271 spin_lock_init(&priv->lock);
273 usb_set_serial_port_data(port, priv);
275 port->port.drain_delay = 256;
280 static int pl2303_port_remove(struct usb_serial_port *port)
282 struct pl2303_private *priv;
284 priv = usb_get_serial_port_data(port);
290 static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
292 struct usb_device *dev = port->serial->dev;
295 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
296 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
297 value, 0, NULL, 0, 100);
298 dev_dbg(&port->dev, "%s - value = %d, retval = %d\n", __func__,
303 static int pl2303_baudrate_encode_direct(int baud, enum pl2303_type type,
307 * NOTE: Only the values defined in baud_sup are supported !
308 * => if unsupported values are set, the PL2303 seems to
309 * use 9600 baud (at least my PL2303X always does)
311 const int baud_sup[] = { 75, 150, 300, 600, 1200, 1800, 2400, 3600,
312 4800, 7200, 9600, 14400, 19200, 28800, 38400,
313 57600, 115200, 230400, 460800, 614400, 921600,
314 1228800, 2457600, 3000000, 6000000, 12000000 };
316 * NOTE: With the exception of type_0/1 devices, the following
317 * additional baud rates are supported (tested with HX rev. 3A only):
318 * 110*, 56000*, 128000, 134400, 161280, 201600, 256000*, 268800,
319 * 403200, 806400. (*: not HX)
321 * Maximum values: HXD, TB: 12000000; HX, TA: 6000000;
322 * type_0+1: 1228800; RA: 921600; SA: 115200
324 * As long as we are not using this encoding method for anything else
325 * than the type_0+1 and HX chips, there is no point in complicating
326 * the code to support them.
330 /* Set baudrate to nearest supported value */
331 for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
332 if (baud_sup[i] > baud)
335 if (i == ARRAY_SIZE(baud_sup))
336 baud = baud_sup[i - 1];
337 else if (i > 0 && (baud_sup[i] - baud) > (baud - baud_sup[i - 1]))
338 baud = baud_sup[i - 1];
341 /* Respect the chip type specific baud rate limits */
343 * FIXME: as long as we don't know how to distinguish between the
344 * HXD, EA, RA, and SA chip variants, allow the max. value of 12M.
347 baud = min_t(int, baud, 6000000);
348 else if (type == type_0 || type == type_1)
349 baud = min_t(int, baud, 1228800);
350 /* Direct (standard) baud rate encoding method */
351 put_unaligned_le32(baud, buf);
356 static int pl2303_baudrate_encode_divisor(int baud, enum pl2303_type type,
360 * Divisor based baud rate encoding method
362 * NOTE: it's not clear if the type_0/1 chips support this method
364 * divisor = 12MHz * 32 / baudrate = 2^A * B
369 * B = buf[0] + (buf[1] & 0x01) << 8
372 * => 8 < B < 16: device seems to work not properly
373 * => B <= 8: device uses the max. value B = 512 instead
378 * NOTE: The Windows driver allows maximum baud rates of 110% of the
379 * specified maximium value.
380 * Quick tests with early (2004) HX (rev. A) chips suggest, that even
381 * higher baud rates (up to the maximum of 24M baud !) are working fine,
382 * but that should really be tested carefully in "real life" scenarios
383 * before removing the upper limit completely.
384 * Baud rates smaller than the specified 75 baud are definitely working
387 if (type == type_0 || type == type_1)
388 baud = min_t(int, baud, 1228800 * 1.1);
389 else if (type == HX_TA)
390 baud = min_t(int, baud, 6000000 * 1.1);
391 else if (type == HXD_EA_RA_SA)
392 /* HXD, EA: 12Mbps; RA: 1Mbps; SA: 115200 bps */
394 * FIXME: as long as we don't know how to distinguish between
395 * these chip variants, allow the max. of these values
397 baud = min_t(int, baud, 12000000 * 1.1);
399 baud = min_t(int, baud, 12000000 * 1.1);
400 /* Determine factors A and B */
402 B = 12000000 * 32 / baud; /* 12MHz */
403 B <<= 1; /* Add one bit for rounding */
404 while (B > (512 << 1) && A <= 14) {
408 if (A > 14) { /* max. divisor = min. baudrate reached */
413 B = (B + 1) >> 1; /* Round the last bit */
415 /* Handle special cases */
417 B = 0; /* also: 1 to 8 */
420 * NOTE: With the current algorithm this happens
421 * only for A=0 and means that the min. divisor
422 * (respectively: the max. baudrate) is reached.
424 B = 16; /* => 24 MBaud */
425 /* Encode the baud rate */
426 buf[3] = 0x80; /* Select divisor encoding method */
428 buf[1] = (A & 0x0e); /* A */
429 buf[1] |= ((B & 0x100) >> 8); /* MSB of B */
430 buf[0] = B & 0xff; /* 8 LSBs of B */
431 /* Calculate the actual/resulting baud rate */
434 baud = 12000000 * 32 / ((1 << A) * B);
439 static void pl2303_encode_baudrate(struct tty_struct *tty,
440 struct usb_serial_port *port,
441 enum pl2303_type type,
446 baud = tty_get_baud_rate(tty);
447 dev_dbg(&port->dev, "baud requested = %d\n", baud);
451 * There are two methods for setting/encoding the baud rate
452 * 1) Direct method: encodes the baud rate value directly
453 * => supported by all chip types
454 * 2) Divisor based method: encodes a divisor to a base value (12MHz*32)
455 * => supported by HX chips (and likely not by type_0/1 chips)
457 * NOTE: Although the divisor based baud rate encoding method is much
458 * more flexible, some of the standard baud rate values can not be
459 * realized exactly. But the difference is very small (max. 0.2%) and
460 * the device likely uses the same baud rate generator for both methods
461 * so that there is likley no difference.
463 if (type == type_0 || type == type_1)
464 baud = pl2303_baudrate_encode_direct(baud, type, buf);
466 baud = pl2303_baudrate_encode_divisor(baud, type, buf);
467 /* Save resulting baud rate */
468 tty_encode_baud_rate(tty, baud, baud);
469 dev_dbg(&port->dev, "baud set = %d\n", baud);
472 static void pl2303_set_termios(struct tty_struct *tty,
473 struct usb_serial_port *port, struct ktermios *old_termios)
475 struct usb_serial *serial = port->serial;
476 struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
477 struct pl2303_private *priv = usb_get_serial_port_data(port);
484 * The PL2303 is reported to lose bytes if you change serial settings
485 * even to the same values as before. Thus we actually need to filter
486 * in this specific case.
488 if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
491 buf = kzalloc(7, GFP_KERNEL);
493 dev_err(&port->dev, "%s - out of memory.\n", __func__);
494 /* Report back no change occurred */
496 tty->termios = *old_termios;
500 i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
501 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
503 dev_dbg(&port->dev, "0xa1:0x21:0:0 %d - %7ph\n", i, buf);
506 switch (C_CSIZE(tty)) {
520 dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
523 /* For reference: buf[0]:buf[3] baud rate value */
524 pl2303_encode_baudrate(tty, port, spriv->type, buf);
526 /* For reference buf[4]=0 is 1 stop bits */
527 /* For reference buf[4]=1 is 1.5 stop bits */
528 /* For reference buf[4]=2 is 2 stop bits */
531 * NOTE: Comply with "real" UARTs / RS232:
532 * use 1.5 instead of 2 stop bits with 5 data bits
534 if (C_CSIZE(tty) == CS5) {
536 dev_dbg(&port->dev, "stop bits = 1.5\n");
539 dev_dbg(&port->dev, "stop bits = 2\n");
543 dev_dbg(&port->dev, "stop bits = 1\n");
547 /* For reference buf[5]=0 is none parity */
548 /* For reference buf[5]=1 is odd parity */
549 /* For reference buf[5]=2 is even parity */
550 /* For reference buf[5]=3 is mark parity */
551 /* For reference buf[5]=4 is space parity */
553 if (tty->termios.c_cflag & CMSPAR) {
555 dev_dbg(&port->dev, "parity = mark\n");
558 dev_dbg(&port->dev, "parity = odd\n");
561 if (tty->termios.c_cflag & CMSPAR) {
563 dev_dbg(&port->dev, "parity = space\n");
566 dev_dbg(&port->dev, "parity = even\n");
571 dev_dbg(&port->dev, "parity = none\n");
574 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
575 SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
577 dev_dbg(&port->dev, "0x21:0x20:0:0 %d\n", i);
579 /* change control lines if we are switching to or from B0 */
580 spin_lock_irqsave(&priv->lock, flags);
581 control = priv->line_control;
582 if (C_BAUD(tty) == B0)
583 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
584 else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
585 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
586 if (control != priv->line_control) {
587 control = priv->line_control;
588 spin_unlock_irqrestore(&priv->lock, flags);
589 pl2303_set_control_lines(port, control);
591 spin_unlock_irqrestore(&priv->lock, flags);
595 i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
596 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
598 dev_dbg(&port->dev, "0xa1:0x21:0:0 %d - %7ph\n", i, buf);
600 if (C_CRTSCTS(tty)) {
601 if (spriv->type == type_0 || spriv->type == type_1)
602 pl2303_vendor_write(0x0, 0x41, serial);
604 pl2303_vendor_write(0x0, 0x61, serial);
606 pl2303_vendor_write(0x0, 0x0, serial);
612 static void pl2303_dtr_rts(struct usb_serial_port *port, int on)
614 struct pl2303_private *priv = usb_get_serial_port_data(port);
618 spin_lock_irqsave(&priv->lock, flags);
619 /* Change DTR and RTS */
621 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
623 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
624 control = priv->line_control;
625 spin_unlock_irqrestore(&priv->lock, flags);
626 pl2303_set_control_lines(port, control);
629 static void pl2303_close(struct usb_serial_port *port)
631 usb_serial_generic_close(port);
632 usb_kill_urb(port->interrupt_in_urb);
635 static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
637 struct usb_serial *serial = port->serial;
638 struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
641 if (spriv->type == type_0 || spriv->type == type_1) {
642 usb_clear_halt(serial->dev, port->write_urb->pipe);
643 usb_clear_halt(serial->dev, port->read_urb->pipe);
645 /* reset upstream data pipes */
646 pl2303_vendor_write(8, 0, serial);
647 pl2303_vendor_write(9, 0, serial);
652 pl2303_set_termios(tty, port, NULL);
654 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
656 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
657 " error %d\n", __func__, result);
661 result = usb_serial_generic_open(tty, port);
663 usb_kill_urb(port->interrupt_in_urb);
670 static int pl2303_tiocmset(struct tty_struct *tty,
671 unsigned int set, unsigned int clear)
673 struct usb_serial_port *port = tty->driver_data;
674 struct pl2303_private *priv = usb_get_serial_port_data(port);
679 spin_lock_irqsave(&priv->lock, flags);
681 priv->line_control |= CONTROL_RTS;
683 priv->line_control |= CONTROL_DTR;
684 if (clear & TIOCM_RTS)
685 priv->line_control &= ~CONTROL_RTS;
686 if (clear & TIOCM_DTR)
687 priv->line_control &= ~CONTROL_DTR;
688 control = priv->line_control;
689 spin_unlock_irqrestore(&priv->lock, flags);
691 ret = pl2303_set_control_lines(port, control);
693 return usb_translate_errors(ret);
698 static int pl2303_tiocmget(struct tty_struct *tty)
700 struct usb_serial_port *port = tty->driver_data;
701 struct pl2303_private *priv = usb_get_serial_port_data(port);
707 spin_lock_irqsave(&priv->lock, flags);
708 mcr = priv->line_control;
709 status = priv->line_status;
710 spin_unlock_irqrestore(&priv->lock, flags);
712 result = ((mcr & CONTROL_DTR) ? TIOCM_DTR : 0)
713 | ((mcr & CONTROL_RTS) ? TIOCM_RTS : 0)
714 | ((status & UART_CTS) ? TIOCM_CTS : 0)
715 | ((status & UART_DSR) ? TIOCM_DSR : 0)
716 | ((status & UART_RING) ? TIOCM_RI : 0)
717 | ((status & UART_DCD) ? TIOCM_CD : 0);
719 dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
724 static int pl2303_carrier_raised(struct usb_serial_port *port)
726 struct pl2303_private *priv = usb_get_serial_port_data(port);
727 if (priv->line_status & UART_DCD)
732 static int pl2303_tiocmiwait(struct tty_struct *tty, unsigned long arg)
734 struct usb_serial_port *port = tty->driver_data;
735 struct pl2303_private *priv = usb_get_serial_port_data(port);
737 unsigned int prevstatus;
739 unsigned int changed;
741 spin_lock_irqsave(&priv->lock, flags);
742 prevstatus = priv->line_status;
743 spin_unlock_irqrestore(&priv->lock, flags);
746 interruptible_sleep_on(&port->port.delta_msr_wait);
747 /* see if a signal did it */
748 if (signal_pending(current))
751 if (port->serial->disconnected)
754 spin_lock_irqsave(&priv->lock, flags);
755 status = priv->line_status;
756 spin_unlock_irqrestore(&priv->lock, flags);
758 changed = prevstatus ^ status;
760 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
761 ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
762 ((arg & TIOCM_CD) && (changed & UART_DCD)) ||
763 ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
772 static int pl2303_ioctl(struct tty_struct *tty,
773 unsigned int cmd, unsigned long arg)
775 struct serial_struct ser;
776 struct usb_serial_port *port = tty->driver_data;
778 dev_dbg(&port->dev, "%s cmd = 0x%04x\n", __func__, cmd);
782 memset(&ser, 0, sizeof ser);
783 ser.type = PORT_16654;
784 ser.line = port->minor;
785 ser.port = port->port_number;
786 ser.baud_base = 460800;
788 if (copy_to_user((void __user *)arg, &ser, sizeof ser))
793 dev_dbg(&port->dev, "%s not supported = 0x%04x\n", __func__, cmd);
799 static void pl2303_break_ctl(struct tty_struct *tty, int break_state)
801 struct usb_serial_port *port = tty->driver_data;
802 struct usb_serial *serial = port->serial;
806 if (break_state == 0)
810 dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
811 state == BREAK_OFF ? "off" : "on");
813 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
814 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
817 dev_err(&port->dev, "error sending break = %d\n", result);
820 static void pl2303_update_line_status(struct usb_serial_port *port,
822 unsigned int actual_length)
825 struct pl2303_private *priv = usb_get_serial_port_data(port);
826 struct tty_struct *tty;
828 u8 status_idx = UART_STATE;
829 u8 length = UART_STATE + 1;
833 idv = le16_to_cpu(port->serial->dev->descriptor.idVendor);
834 idp = le16_to_cpu(port->serial->dev->descriptor.idProduct);
837 if (idv == SIEMENS_VENDOR_ID) {
838 if (idp == SIEMENS_PRODUCT_ID_X65 ||
839 idp == SIEMENS_PRODUCT_ID_SX1 ||
840 idp == SIEMENS_PRODUCT_ID_X75) {
847 if (actual_length < length)
850 /* Save off the uart status for others to look at */
851 spin_lock_irqsave(&priv->lock, flags);
852 prev_line_status = priv->line_status;
853 priv->line_status = data[status_idx];
854 spin_unlock_irqrestore(&priv->lock, flags);
855 if (priv->line_status & UART_BREAK_ERROR)
856 usb_serial_handle_break(port);
857 wake_up_interruptible(&port->port.delta_msr_wait);
859 tty = tty_port_tty_get(&port->port);
862 if ((priv->line_status ^ prev_line_status) & UART_DCD)
863 usb_serial_handle_dcd_change(port, tty,
864 priv->line_status & UART_DCD);
868 static void pl2303_read_int_callback(struct urb *urb)
870 struct usb_serial_port *port = urb->context;
871 unsigned char *data = urb->transfer_buffer;
872 unsigned int actual_length = urb->actual_length;
873 int status = urb->status;
883 /* this urb is terminated, clean up */
884 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
888 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
893 usb_serial_debug_data(&port->dev, __func__,
894 urb->actual_length, urb->transfer_buffer);
896 pl2303_update_line_status(port, data, actual_length);
899 retval = usb_submit_urb(urb, GFP_ATOMIC);
902 "%s - usb_submit_urb failed with result %d\n",
906 static void pl2303_process_read_urb(struct urb *urb)
908 struct usb_serial_port *port = urb->context;
909 struct pl2303_private *priv = usb_get_serial_port_data(port);
910 unsigned char *data = urb->transfer_buffer;
911 char tty_flag = TTY_NORMAL;
916 /* update line status */
917 spin_lock_irqsave(&priv->lock, flags);
918 line_status = priv->line_status;
919 priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
920 spin_unlock_irqrestore(&priv->lock, flags);
921 wake_up_interruptible(&port->port.delta_msr_wait);
923 if (!urb->actual_length)
926 /* break takes precedence over parity, */
927 /* which takes precedence over framing errors */
928 if (line_status & UART_BREAK_ERROR)
929 tty_flag = TTY_BREAK;
930 else if (line_status & UART_PARITY_ERROR)
931 tty_flag = TTY_PARITY;
932 else if (line_status & UART_FRAME_ERROR)
933 tty_flag = TTY_FRAME;
935 if (tty_flag != TTY_NORMAL)
936 dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
938 /* overrun is special, not associated with a char */
939 if (line_status & UART_OVERRUN_ERROR)
940 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
942 if (port->port.console && port->sysrq) {
943 for (i = 0; i < urb->actual_length; ++i)
944 if (!usb_serial_handle_sysrq_char(port, data[i]))
945 tty_insert_flip_char(&port->port, data[i],
948 tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
952 tty_flip_buffer_push(&port->port);
955 /* All of the device info needed for the PL2303 SIO serial converter */
956 static struct usb_serial_driver pl2303_device = {
958 .owner = THIS_MODULE,
961 .id_table = id_table,
964 .bulk_out_size = 256,
966 .close = pl2303_close,
967 .dtr_rts = pl2303_dtr_rts,
968 .carrier_raised = pl2303_carrier_raised,
969 .ioctl = pl2303_ioctl,
970 .break_ctl = pl2303_break_ctl,
971 .set_termios = pl2303_set_termios,
972 .tiocmget = pl2303_tiocmget,
973 .tiocmset = pl2303_tiocmset,
974 .tiocmiwait = pl2303_tiocmiwait,
975 .process_read_urb = pl2303_process_read_urb,
976 .read_int_callback = pl2303_read_int_callback,
977 .attach = pl2303_startup,
978 .release = pl2303_release,
979 .port_probe = pl2303_port_probe,
980 .port_remove = pl2303_port_remove,
983 static struct usb_serial_driver * const serial_drivers[] = {
987 module_usb_serial_driver(serial_drivers, id_table);
989 MODULE_DESCRIPTION(DRIVER_DESC);
990 MODULE_LICENSE("GPL");