xref: /openbmc/linux/drivers/usb/serial/pl2303.c (revision bc000245)
1 /*
2  * Prolific PL2303 USB to serial adaptor driver
3  *
4  * Copyright (C) 2001-2007 Greg Kroah-Hartman (greg@kroah.com)
5  * Copyright (C) 2003 IBM Corp.
6  *
7  * Original driver for 2.2.x by anonymous
8  *
9  *	This program is free software; you can redistribute it and/or
10  *	modify it under the terms of the GNU General Public License version
11  *	2 as published by the Free Software Foundation.
12  *
13  * See Documentation/usb/usb-serial.txt for more information on using this
14  * driver
15  *
16  */
17 
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>
32 #include <asm/unaligned.h>
33 #include "pl2303.h"
34 
35 /*
36  * Version Information
37  */
38 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
39 
40 static const struct usb_device_id id_table[] = {
41 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
42 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
43 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
44 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
45 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
46 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ALDIGA) },
47 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MMX) },
48 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GPRS) },
49 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_HCR331) },
50 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MOTOROLA) },
51 	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
52 	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
53 	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
54 	{ USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
55 	{ USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
56 	{ USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
57 	{ USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
58 	{ USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
59 	{ USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
60 	{ USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
61 	{ USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
62 	{ USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
63 	{ USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
64 	{ USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
65 	{ USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
66 	{ USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
67 	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1) },
68 	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
69 	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75) },
70 	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81) },
71 	{ USB_DEVICE(BENQ_VENDOR_ID, BENQ_PRODUCT_ID_S81) }, /* Benq/Siemens S81 */
72 	{ USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
73 	{ USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
74 	{ USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
75 	{ USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
76 	{ USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
77 	{ USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
78 	{ USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
79 	{ USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
80 	{ USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID) },
81 	{ USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
82 	{ USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
83 	{ USB_DEVICE(YCCABLE_VENDOR_ID, YCCABLE_PRODUCT_ID) },
84 	{ USB_DEVICE(SUPERIAL_VENDOR_ID, SUPERIAL_PRODUCT_ID) },
85 	{ USB_DEVICE(HP_VENDOR_ID, HP_LD220_PRODUCT_ID) },
86 	{ USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
87 	{ USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
88 	{ USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
89 	{ USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
90 	{ USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
91 	{ USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
92 	{ }					/* Terminating entry */
93 };
94 
95 MODULE_DEVICE_TABLE(usb, id_table);
96 
97 #define SET_LINE_REQUEST_TYPE		0x21
98 #define SET_LINE_REQUEST		0x20
99 
100 #define SET_CONTROL_REQUEST_TYPE	0x21
101 #define SET_CONTROL_REQUEST		0x22
102 #define CONTROL_DTR			0x01
103 #define CONTROL_RTS			0x02
104 
105 #define BREAK_REQUEST_TYPE		0x21
106 #define BREAK_REQUEST			0x23
107 #define BREAK_ON			0xffff
108 #define BREAK_OFF			0x0000
109 
110 #define GET_LINE_REQUEST_TYPE		0xa1
111 #define GET_LINE_REQUEST		0x21
112 
113 #define VENDOR_WRITE_REQUEST_TYPE	0x40
114 #define VENDOR_WRITE_REQUEST		0x01
115 
116 #define VENDOR_READ_REQUEST_TYPE	0xc0
117 #define VENDOR_READ_REQUEST		0x01
118 
119 #define UART_STATE			0x08
120 #define UART_STATE_TRANSIENT_MASK	0x74
121 #define UART_DCD			0x01
122 #define UART_DSR			0x02
123 #define UART_BREAK_ERROR		0x04
124 #define UART_RING			0x08
125 #define UART_FRAME_ERROR		0x10
126 #define UART_PARITY_ERROR		0x20
127 #define UART_OVERRUN_ERROR		0x40
128 #define UART_CTS			0x80
129 
130 
131 enum pl2303_type {
132 	type_0,		/* don't know the difference between type 0 and */
133 	type_1,		/* type 1, until someone from prolific tells us... */
134 	HX,		/* HX version of the pl2303 chip */
135 };
136 
137 struct pl2303_serial_private {
138 	enum pl2303_type type;
139 };
140 
141 struct pl2303_private {
142 	spinlock_t lock;
143 	u8 line_control;
144 	u8 line_status;
145 };
146 
147 static int pl2303_vendor_read(__u16 value, __u16 index,
148 		struct usb_serial *serial, unsigned char *buf)
149 {
150 	int res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
151 			VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
152 			value, index, buf, 1, 100);
153 	dev_dbg(&serial->interface->dev, "0x%x:0x%x:0x%x:0x%x  %d - %x\n",
154 		VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, value, index,
155 		res, buf[0]);
156 	return res;
157 }
158 
159 static int pl2303_vendor_write(__u16 value, __u16 index,
160 		struct usb_serial *serial)
161 {
162 	int res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
163 			VENDOR_WRITE_REQUEST, VENDOR_WRITE_REQUEST_TYPE,
164 			value, index, NULL, 0, 100);
165 	dev_dbg(&serial->interface->dev, "0x%x:0x%x:0x%x:0x%x  %d\n",
166 		VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, value, index,
167 		res);
168 	return res;
169 }
170 
171 static int pl2303_startup(struct usb_serial *serial)
172 {
173 	struct pl2303_serial_private *spriv;
174 	enum pl2303_type type = type_0;
175 	unsigned char *buf;
176 
177 	spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
178 	if (!spriv)
179 		return -ENOMEM;
180 
181 	buf = kmalloc(10, GFP_KERNEL);
182 	if (!buf) {
183 		kfree(spriv);
184 		return -ENOMEM;
185 	}
186 
187 	if (serial->dev->descriptor.bDeviceClass == 0x02)
188 		type = type_0;
189 	else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
190 		type = HX;
191 	else if (serial->dev->descriptor.bDeviceClass == 0x00)
192 		type = type_1;
193 	else if (serial->dev->descriptor.bDeviceClass == 0xFF)
194 		type = type_1;
195 	dev_dbg(&serial->interface->dev, "device type: %d\n", type);
196 
197 	spriv->type = type;
198 	usb_set_serial_data(serial, spriv);
199 
200 	pl2303_vendor_read(0x8484, 0, serial, buf);
201 	pl2303_vendor_write(0x0404, 0, serial);
202 	pl2303_vendor_read(0x8484, 0, serial, buf);
203 	pl2303_vendor_read(0x8383, 0, serial, buf);
204 	pl2303_vendor_read(0x8484, 0, serial, buf);
205 	pl2303_vendor_write(0x0404, 1, serial);
206 	pl2303_vendor_read(0x8484, 0, serial, buf);
207 	pl2303_vendor_read(0x8383, 0, serial, buf);
208 	pl2303_vendor_write(0, 1, serial);
209 	pl2303_vendor_write(1, 0, serial);
210 	if (type == HX)
211 		pl2303_vendor_write(2, 0x44, serial);
212 	else
213 		pl2303_vendor_write(2, 0x24, serial);
214 
215 	kfree(buf);
216 	return 0;
217 }
218 
219 static void pl2303_release(struct usb_serial *serial)
220 {
221 	struct pl2303_serial_private *spriv;
222 
223 	spriv = usb_get_serial_data(serial);
224 	kfree(spriv);
225 }
226 
227 static int pl2303_port_probe(struct usb_serial_port *port)
228 {
229 	struct pl2303_private *priv;
230 
231 	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
232 	if (!priv)
233 		return -ENOMEM;
234 
235 	spin_lock_init(&priv->lock);
236 
237 	usb_set_serial_port_data(port, priv);
238 
239 	port->port.drain_delay = 256;
240 
241 	return 0;
242 }
243 
244 static int pl2303_port_remove(struct usb_serial_port *port)
245 {
246 	struct pl2303_private *priv;
247 
248 	priv = usb_get_serial_port_data(port);
249 	kfree(priv);
250 
251 	return 0;
252 }
253 
254 static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
255 {
256 	struct usb_device *dev = port->serial->dev;
257 	int retval;
258 
259 	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
260 				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
261 				 value, 0, NULL, 0, 100);
262 	dev_dbg(&port->dev, "%s - value = %d, retval = %d\n", __func__,
263 		value, retval);
264 	return retval;
265 }
266 
267 static void pl2303_encode_baudrate(struct tty_struct *tty,
268 					struct usb_serial_port *port,
269 					u8 buf[4])
270 {
271 	const int baud_sup[] = { 75, 150, 300, 600, 1200, 1800, 2400, 3600,
272 	                         4800, 7200, 9600, 14400, 19200, 28800, 38400,
273 	                         57600, 115200, 230400, 460800, 500000, 614400,
274 	                         921600, 1228800, 2457600, 3000000, 6000000 };
275 
276 	struct usb_serial *serial = port->serial;
277 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
278 	int baud;
279 	int i;
280 
281 	/*
282 	 * NOTE: Only the values defined in baud_sup are supported!
283 	 *       => if unsupported values are set, the PL2303 seems to use
284 	 *          9600 baud (at least my PL2303X always does)
285 	 */
286 	baud = tty_get_baud_rate(tty);
287 	dev_dbg(&port->dev, "baud requested = %d\n", baud);
288 	if (!baud)
289 		return;
290 
291 	/* Set baudrate to nearest supported value */
292 	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
293 		if (baud_sup[i] > baud)
294 			break;
295 	}
296 
297 	if (i == ARRAY_SIZE(baud_sup))
298 		baud = baud_sup[i - 1];
299 	else if (i > 0 && (baud_sup[i] - baud) > (baud - baud_sup[i - 1]))
300 		baud = baud_sup[i - 1];
301 	else
302 		baud = baud_sup[i];
303 
304 	/* type_0, type_1 only support up to 1228800 baud */
305 	if (spriv->type != HX)
306 		baud = min_t(int, baud, 1228800);
307 
308 	if (baud <= 115200) {
309 		put_unaligned_le32(baud, buf);
310 	} else {
311 		/*
312 		 * Apparently the formula for higher speeds is:
313 		 * baudrate = 12M * 32 / (2^buf[1]) / buf[0]
314 		 */
315 		unsigned tmp = 12000000 * 32 / baud;
316 		buf[3] = 0x80;
317 		buf[2] = 0;
318 		buf[1] = (tmp >= 256);
319 		while (tmp >= 256) {
320 			tmp >>= 2;
321 			buf[1] <<= 1;
322 		}
323 		buf[0] = tmp;
324 	}
325 
326 	/* Save resulting baud rate */
327 	tty_encode_baud_rate(tty, baud, baud);
328 	dev_dbg(&port->dev, "baud set = %d\n", baud);
329 }
330 
331 static void pl2303_set_termios(struct tty_struct *tty,
332 		struct usb_serial_port *port, struct ktermios *old_termios)
333 {
334 	struct usb_serial *serial = port->serial;
335 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
336 	struct pl2303_private *priv = usb_get_serial_port_data(port);
337 	unsigned long flags;
338 	unsigned char *buf;
339 	int i;
340 	u8 control;
341 
342 	/*
343 	 * The PL2303 is reported to lose bytes if you change serial settings
344 	 * even to the same values as before. Thus we actually need to filter
345 	 * in this specific case.
346 	 */
347 	if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
348 		return;
349 
350 	buf = kzalloc(7, GFP_KERNEL);
351 	if (!buf) {
352 		dev_err(&port->dev, "%s - out of memory.\n", __func__);
353 		/* Report back no change occurred */
354 		if (old_termios)
355 			tty->termios = *old_termios;
356 		return;
357 	}
358 
359 	i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
360 			    GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
361 			    0, 0, buf, 7, 100);
362 	dev_dbg(&port->dev, "0xa1:0x21:0:0  %d - %7ph\n", i, buf);
363 
364 	switch (C_CSIZE(tty)) {
365 	case CS5:
366 		buf[6] = 5;
367 		break;
368 	case CS6:
369 		buf[6] = 6;
370 		break;
371 	case CS7:
372 		buf[6] = 7;
373 		break;
374 	default:
375 	case CS8:
376 		buf[6] = 8;
377 	}
378 	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
379 
380 	/* For reference buf[0]:buf[3] baud rate value */
381 	pl2303_encode_baudrate(tty, port, &buf[0]);
382 
383 	/* For reference buf[4]=0 is 1 stop bits */
384 	/* For reference buf[4]=1 is 1.5 stop bits */
385 	/* For reference buf[4]=2 is 2 stop bits */
386 	if (C_CSTOPB(tty)) {
387 		/*
388 		 * NOTE: Comply with "real" UARTs / RS232:
389 		 *       use 1.5 instead of 2 stop bits with 5 data bits
390 		 */
391 		if (C_CSIZE(tty) == CS5) {
392 			buf[4] = 1;
393 			dev_dbg(&port->dev, "stop bits = 1.5\n");
394 		} else {
395 			buf[4] = 2;
396 			dev_dbg(&port->dev, "stop bits = 2\n");
397 		}
398 	} else {
399 		buf[4] = 0;
400 		dev_dbg(&port->dev, "stop bits = 1\n");
401 	}
402 
403 	if (C_PARENB(tty)) {
404 		/* For reference buf[5]=0 is none parity */
405 		/* For reference buf[5]=1 is odd parity */
406 		/* For reference buf[5]=2 is even parity */
407 		/* For reference buf[5]=3 is mark parity */
408 		/* For reference buf[5]=4 is space parity */
409 		if (C_PARODD(tty)) {
410 			if (tty->termios.c_cflag & CMSPAR) {
411 				buf[5] = 3;
412 				dev_dbg(&port->dev, "parity = mark\n");
413 			} else {
414 				buf[5] = 1;
415 				dev_dbg(&port->dev, "parity = odd\n");
416 			}
417 		} else {
418 			if (tty->termios.c_cflag & CMSPAR) {
419 				buf[5] = 4;
420 				dev_dbg(&port->dev, "parity = space\n");
421 			} else {
422 				buf[5] = 2;
423 				dev_dbg(&port->dev, "parity = even\n");
424 			}
425 		}
426 	} else {
427 		buf[5] = 0;
428 		dev_dbg(&port->dev, "parity = none\n");
429 	}
430 
431 	i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
432 			    SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
433 			    0, 0, buf, 7, 100);
434 	dev_dbg(&port->dev, "0x21:0x20:0:0  %d\n", i);
435 
436 	/* change control lines if we are switching to or from B0 */
437 	spin_lock_irqsave(&priv->lock, flags);
438 	control = priv->line_control;
439 	if (C_BAUD(tty) == B0)
440 		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
441 	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
442 		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
443 	if (control != priv->line_control) {
444 		control = priv->line_control;
445 		spin_unlock_irqrestore(&priv->lock, flags);
446 		pl2303_set_control_lines(port, control);
447 	} else {
448 		spin_unlock_irqrestore(&priv->lock, flags);
449 	}
450 
451 	memset(buf, 0, 7);
452 	i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
453 			    GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
454 			    0, 0, buf, 7, 100);
455 	dev_dbg(&port->dev, "0xa1:0x21:0:0  %d - %7ph\n", i, buf);
456 
457 	if (C_CRTSCTS(tty)) {
458 		if (spriv->type == HX)
459 			pl2303_vendor_write(0x0, 0x61, serial);
460 		else
461 			pl2303_vendor_write(0x0, 0x41, serial);
462 	} else {
463 		pl2303_vendor_write(0x0, 0x0, serial);
464 	}
465 
466 	kfree(buf);
467 }
468 
469 static void pl2303_dtr_rts(struct usb_serial_port *port, int on)
470 {
471 	struct pl2303_private *priv = usb_get_serial_port_data(port);
472 	unsigned long flags;
473 	u8 control;
474 
475 	spin_lock_irqsave(&priv->lock, flags);
476 	/* Change DTR and RTS */
477 	if (on)
478 		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
479 	else
480 		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
481 	control = priv->line_control;
482 	spin_unlock_irqrestore(&priv->lock, flags);
483 	pl2303_set_control_lines(port, control);
484 }
485 
486 static void pl2303_close(struct usb_serial_port *port)
487 {
488 	usb_serial_generic_close(port);
489 	usb_kill_urb(port->interrupt_in_urb);
490 }
491 
492 static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
493 {
494 	struct usb_serial *serial = port->serial;
495 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
496 	int result;
497 
498 	if (spriv->type != HX) {
499 		usb_clear_halt(serial->dev, port->write_urb->pipe);
500 		usb_clear_halt(serial->dev, port->read_urb->pipe);
501 	} else {
502 		/* reset upstream data pipes */
503 		pl2303_vendor_write(8, 0, serial);
504 		pl2303_vendor_write(9, 0, serial);
505 	}
506 
507 	/* Setup termios */
508 	if (tty)
509 		pl2303_set_termios(tty, port, NULL);
510 
511 	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
512 	if (result) {
513 		dev_err(&port->dev, "%s - failed submitting interrupt urb,"
514 			" error %d\n", __func__, result);
515 		return result;
516 	}
517 
518 	result = usb_serial_generic_open(tty, port);
519 	if (result) {
520 		usb_kill_urb(port->interrupt_in_urb);
521 		return result;
522 	}
523 
524 	return 0;
525 }
526 
527 static int pl2303_tiocmset(struct tty_struct *tty,
528 			   unsigned int set, unsigned int clear)
529 {
530 	struct usb_serial_port *port = tty->driver_data;
531 	struct pl2303_private *priv = usb_get_serial_port_data(port);
532 	unsigned long flags;
533 	u8 control;
534 	int ret;
535 
536 	spin_lock_irqsave(&priv->lock, flags);
537 	if (set & TIOCM_RTS)
538 		priv->line_control |= CONTROL_RTS;
539 	if (set & TIOCM_DTR)
540 		priv->line_control |= CONTROL_DTR;
541 	if (clear & TIOCM_RTS)
542 		priv->line_control &= ~CONTROL_RTS;
543 	if (clear & TIOCM_DTR)
544 		priv->line_control &= ~CONTROL_DTR;
545 	control = priv->line_control;
546 	spin_unlock_irqrestore(&priv->lock, flags);
547 
548 	ret = pl2303_set_control_lines(port, control);
549 	if (ret)
550 		return usb_translate_errors(ret);
551 
552 	return 0;
553 }
554 
555 static int pl2303_tiocmget(struct tty_struct *tty)
556 {
557 	struct usb_serial_port *port = tty->driver_data;
558 	struct pl2303_private *priv = usb_get_serial_port_data(port);
559 	unsigned long flags;
560 	unsigned int mcr;
561 	unsigned int status;
562 	unsigned int result;
563 
564 	spin_lock_irqsave(&priv->lock, flags);
565 	mcr = priv->line_control;
566 	status = priv->line_status;
567 	spin_unlock_irqrestore(&priv->lock, flags);
568 
569 	result = ((mcr & CONTROL_DTR)		? TIOCM_DTR : 0)
570 		  | ((mcr & CONTROL_RTS)	? TIOCM_RTS : 0)
571 		  | ((status & UART_CTS)	? TIOCM_CTS : 0)
572 		  | ((status & UART_DSR)	? TIOCM_DSR : 0)
573 		  | ((status & UART_RING)	? TIOCM_RI  : 0)
574 		  | ((status & UART_DCD)	? TIOCM_CD  : 0);
575 
576 	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
577 
578 	return result;
579 }
580 
581 static int pl2303_carrier_raised(struct usb_serial_port *port)
582 {
583 	struct pl2303_private *priv = usb_get_serial_port_data(port);
584 	if (priv->line_status & UART_DCD)
585 		return 1;
586 	return 0;
587 }
588 
589 static int pl2303_tiocmiwait(struct tty_struct *tty, unsigned long arg)
590 {
591 	struct usb_serial_port *port = tty->driver_data;
592 	struct pl2303_private *priv = usb_get_serial_port_data(port);
593 	unsigned long flags;
594 	unsigned int prevstatus;
595 	unsigned int status;
596 	unsigned int changed;
597 
598 	spin_lock_irqsave(&priv->lock, flags);
599 	prevstatus = priv->line_status;
600 	spin_unlock_irqrestore(&priv->lock, flags);
601 
602 	while (1) {
603 		interruptible_sleep_on(&port->port.delta_msr_wait);
604 		/* see if a signal did it */
605 		if (signal_pending(current))
606 			return -ERESTARTSYS;
607 
608 		if (port->serial->disconnected)
609 			return -EIO;
610 
611 		spin_lock_irqsave(&priv->lock, flags);
612 		status = priv->line_status;
613 		spin_unlock_irqrestore(&priv->lock, flags);
614 
615 		changed = prevstatus ^ status;
616 
617 		if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
618 		    ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
619 		    ((arg & TIOCM_CD)  && (changed & UART_DCD)) ||
620 		    ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
621 			return 0;
622 		}
623 		prevstatus = status;
624 	}
625 	/* NOTREACHED */
626 	return 0;
627 }
628 
629 static int pl2303_ioctl(struct tty_struct *tty,
630 			unsigned int cmd, unsigned long arg)
631 {
632 	struct serial_struct ser;
633 	struct usb_serial_port *port = tty->driver_data;
634 
635 	dev_dbg(&port->dev, "%s cmd = 0x%04x\n", __func__, cmd);
636 
637 	switch (cmd) {
638 	case TIOCGSERIAL:
639 		memset(&ser, 0, sizeof ser);
640 		ser.type = PORT_16654;
641 		ser.line = port->minor;
642 		ser.port = port->port_number;
643 		ser.baud_base = 460800;
644 
645 		if (copy_to_user((void __user *)arg, &ser, sizeof ser))
646 			return -EFAULT;
647 
648 		return 0;
649 	default:
650 		dev_dbg(&port->dev, "%s not supported = 0x%04x\n", __func__, cmd);
651 		break;
652 	}
653 	return -ENOIOCTLCMD;
654 }
655 
656 static void pl2303_break_ctl(struct tty_struct *tty, int break_state)
657 {
658 	struct usb_serial_port *port = tty->driver_data;
659 	struct usb_serial *serial = port->serial;
660 	u16 state;
661 	int result;
662 
663 	if (break_state == 0)
664 		state = BREAK_OFF;
665 	else
666 		state = BREAK_ON;
667 	dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
668 			state == BREAK_OFF ? "off" : "on");
669 
670 	result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
671 				 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
672 				 0, NULL, 0, 100);
673 	if (result)
674 		dev_err(&port->dev, "error sending break = %d\n", result);
675 }
676 
677 static void pl2303_update_line_status(struct usb_serial_port *port,
678 				      unsigned char *data,
679 				      unsigned int actual_length)
680 {
681 
682 	struct pl2303_private *priv = usb_get_serial_port_data(port);
683 	struct tty_struct *tty;
684 	unsigned long flags;
685 	u8 status_idx = UART_STATE;
686 	u8 length = UART_STATE + 1;
687 	u8 prev_line_status;
688 	u16 idv, idp;
689 
690 	idv = le16_to_cpu(port->serial->dev->descriptor.idVendor);
691 	idp = le16_to_cpu(port->serial->dev->descriptor.idProduct);
692 
693 
694 	if (idv == SIEMENS_VENDOR_ID) {
695 		if (idp == SIEMENS_PRODUCT_ID_X65 ||
696 		    idp == SIEMENS_PRODUCT_ID_SX1 ||
697 		    idp == SIEMENS_PRODUCT_ID_X75) {
698 
699 			length = 1;
700 			status_idx = 0;
701 		}
702 	}
703 
704 	if (actual_length < length)
705 		return;
706 
707 	/* Save off the uart status for others to look at */
708 	spin_lock_irqsave(&priv->lock, flags);
709 	prev_line_status = priv->line_status;
710 	priv->line_status = data[status_idx];
711 	spin_unlock_irqrestore(&priv->lock, flags);
712 	if (priv->line_status & UART_BREAK_ERROR)
713 		usb_serial_handle_break(port);
714 	wake_up_interruptible(&port->port.delta_msr_wait);
715 
716 	tty = tty_port_tty_get(&port->port);
717 	if (!tty)
718 		return;
719 	if ((priv->line_status ^ prev_line_status) & UART_DCD)
720 		usb_serial_handle_dcd_change(port, tty,
721 				priv->line_status & UART_DCD);
722 	tty_kref_put(tty);
723 }
724 
725 static void pl2303_read_int_callback(struct urb *urb)
726 {
727 	struct usb_serial_port *port =  urb->context;
728 	unsigned char *data = urb->transfer_buffer;
729 	unsigned int actual_length = urb->actual_length;
730 	int status = urb->status;
731 	int retval;
732 
733 	switch (status) {
734 	case 0:
735 		/* success */
736 		break;
737 	case -ECONNRESET:
738 	case -ENOENT:
739 	case -ESHUTDOWN:
740 		/* this urb is terminated, clean up */
741 		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
742 			__func__, status);
743 		return;
744 	default:
745 		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
746 			__func__, status);
747 		goto exit;
748 	}
749 
750 	usb_serial_debug_data(&port->dev, __func__,
751 			      urb->actual_length, urb->transfer_buffer);
752 
753 	pl2303_update_line_status(port, data, actual_length);
754 
755 exit:
756 	retval = usb_submit_urb(urb, GFP_ATOMIC);
757 	if (retval)
758 		dev_err(&port->dev,
759 			"%s - usb_submit_urb failed with result %d\n",
760 			__func__, retval);
761 }
762 
763 static void pl2303_process_read_urb(struct urb *urb)
764 {
765 	struct usb_serial_port *port = urb->context;
766 	struct pl2303_private *priv = usb_get_serial_port_data(port);
767 	unsigned char *data = urb->transfer_buffer;
768 	char tty_flag = TTY_NORMAL;
769 	unsigned long flags;
770 	u8 line_status;
771 	int i;
772 
773 	/* update line status */
774 	spin_lock_irqsave(&priv->lock, flags);
775 	line_status = priv->line_status;
776 	priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
777 	spin_unlock_irqrestore(&priv->lock, flags);
778 	wake_up_interruptible(&port->port.delta_msr_wait);
779 
780 	if (!urb->actual_length)
781 		return;
782 
783 	/* break takes precedence over parity, */
784 	/* which takes precedence over framing errors */
785 	if (line_status & UART_BREAK_ERROR)
786 		tty_flag = TTY_BREAK;
787 	else if (line_status & UART_PARITY_ERROR)
788 		tty_flag = TTY_PARITY;
789 	else if (line_status & UART_FRAME_ERROR)
790 		tty_flag = TTY_FRAME;
791 
792 	if (tty_flag != TTY_NORMAL)
793 		dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
794 								tty_flag);
795 	/* overrun is special, not associated with a char */
796 	if (line_status & UART_OVERRUN_ERROR)
797 		tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
798 
799 	if (port->port.console && port->sysrq) {
800 		for (i = 0; i < urb->actual_length; ++i)
801 			if (!usb_serial_handle_sysrq_char(port, data[i]))
802 				tty_insert_flip_char(&port->port, data[i],
803 						tty_flag);
804 	} else {
805 		tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
806 							urb->actual_length);
807 	}
808 
809 	tty_flip_buffer_push(&port->port);
810 }
811 
812 /* All of the device info needed for the PL2303 SIO serial converter */
813 static struct usb_serial_driver pl2303_device = {
814 	.driver = {
815 		.owner =	THIS_MODULE,
816 		.name =		"pl2303",
817 	},
818 	.id_table =		id_table,
819 	.num_ports =		1,
820 	.bulk_in_size =		256,
821 	.bulk_out_size =	256,
822 	.open =			pl2303_open,
823 	.close =		pl2303_close,
824 	.dtr_rts = 		pl2303_dtr_rts,
825 	.carrier_raised =	pl2303_carrier_raised,
826 	.ioctl =		pl2303_ioctl,
827 	.break_ctl =		pl2303_break_ctl,
828 	.set_termios =		pl2303_set_termios,
829 	.tiocmget =		pl2303_tiocmget,
830 	.tiocmset =		pl2303_tiocmset,
831 	.tiocmiwait =		pl2303_tiocmiwait,
832 	.process_read_urb =	pl2303_process_read_urb,
833 	.read_int_callback =	pl2303_read_int_callback,
834 	.attach =		pl2303_startup,
835 	.release =		pl2303_release,
836 	.port_probe =		pl2303_port_probe,
837 	.port_remove =		pl2303_port_remove,
838 };
839 
840 static struct usb_serial_driver * const serial_drivers[] = {
841 	&pl2303_device, NULL
842 };
843 
844 module_usb_serial_driver(serial_drivers, id_table);
845 
846 MODULE_DESCRIPTION(DRIVER_DESC);
847 MODULE_LICENSE("GPL");
848