xref: /linux/drivers/usb/serial/pl2303.c (revision 2ac74c6db40adaa29c50cbb281ae9a6f63de18e1)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Prolific PL2303 USB to serial adaptor driver
4  *
5  * Copyright (C) 2001-2007 Greg Kroah-Hartman (greg@kroah.com)
6  * Copyright (C) 2003 IBM Corp.
7  *
8  * Original driver for 2.2.x by anonymous
9  *
10  * See Documentation/usb/usb-serial.rst for more information on using this
11  * driver
12  */
13 
14 #include <linux/kernel.h>
15 #include <linux/errno.h>
16 #include <linux/slab.h>
17 #include <linux/tty.h>
18 #include <linux/tty_flip.h>
19 #include <linux/serial.h>
20 #include <linux/module.h>
21 #include <linux/spinlock.h>
22 #include <linux/usb.h>
23 #include <linux/usb/serial.h>
24 #include <linux/unaligned.h>
25 #include "pl2303.h"
26 
27 
28 #define PL2303_QUIRK_UART_STATE_IDX0		BIT(0)
29 #define PL2303_QUIRK_LEGACY			BIT(1)
30 #define PL2303_QUIRK_ENDPOINT_HACK		BIT(2)
31 #define PL2303_QUIRK_NO_BREAK_GETLINE		BIT(3)
32 
33 static const struct usb_device_id id_table[] = {
34 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID),
35 		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
36 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
37 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
38 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
39 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_CHILITAG) },
40 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
41 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ALDIGA) },
42 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MMX) },
43 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GPRS) },
44 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_HCR331) },
45 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MOTOROLA) },
46 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ZTEK) },
47 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_TB) },
48 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GC) },
49 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GB) },
50 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GT) },
51 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GL) },
52 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GE) },
53 	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GS) },
54 	{ USB_DEVICE(PL2303_VENDOR_ID, PL256X_PRODUCT_ID_4P) },
55 	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
56 	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
57 	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID),
58 		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
59 	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC485),
60 		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
61 	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC232B),
62 		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
63 	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID2) },
64 	{ USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
65 	{ USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
66 	{ USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
67 	{ USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
68 	{ USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
69 	{ USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
70 	{ USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
71 	{ USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
72 	{ USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
73 	{ USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
74 	{ USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
75 	{ USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
76 	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1),
77 		.driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
78 	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65),
79 		.driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
80 	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75),
81 		.driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
82 	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81),
83 		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
84 	{ USB_DEVICE(BENQ_VENDOR_ID, BENQ_PRODUCT_ID_S81) }, /* Benq/Siemens S81 */
85 	{ USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
86 	{ USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
87 	{ USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
88 	{ USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
89 	{ USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
90 	{ USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
91 	{ USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
92 	{ USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
93 	{ USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID),
94 		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
95 	{ USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
96 	{ USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
97 	{ USB_DEVICE(YCCABLE_VENDOR_ID, YCCABLE_PRODUCT_ID) },
98 	{ USB_DEVICE(SUPERIAL_VENDOR_ID, SUPERIAL_PRODUCT_ID) },
99 	{ USB_DEVICE(HP_VENDOR_ID, HP_LD220_PRODUCT_ID) },
100 	{ USB_DEVICE(HP_VENDOR_ID, HP_LD220TA_PRODUCT_ID) },
101 	{ USB_DEVICE(HP_VENDOR_ID, HP_LD381_PRODUCT_ID) },
102 	{ USB_DEVICE(HP_VENDOR_ID, HP_LD381GC_PRODUCT_ID) },
103 	{ USB_DEVICE(HP_VENDOR_ID, HP_LD960_PRODUCT_ID) },
104 	{ USB_DEVICE(HP_VENDOR_ID, HP_LD960TA_PRODUCT_ID) },
105 	{ USB_DEVICE(HP_VENDOR_ID, HP_LCM220_PRODUCT_ID) },
106 	{ USB_DEVICE(HP_VENDOR_ID, HP_LCM960_PRODUCT_ID) },
107 	{ USB_DEVICE(HP_VENDOR_ID, HP_LM920_PRODUCT_ID) },
108 	{ USB_DEVICE(HP_VENDOR_ID, HP_LM930_PRODUCT_ID) },
109 	{ USB_DEVICE(HP_VENDOR_ID, HP_LM940_PRODUCT_ID) },
110 	{ USB_DEVICE(HP_VENDOR_ID, HP_TD620_PRODUCT_ID) },
111 	{ USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
112 	{ USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
113 	{ USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
114 	{ USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
115 	{ USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
116 	{ USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530GC_PRODUCT_ID) },
117 	{ USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
118 	{ USB_DEVICE(AT_VENDOR_ID, AT_VTKIT3_PRODUCT_ID) },
119 	{ USB_DEVICE(IBM_VENDOR_ID, IBM_PRODUCT_ID) },
120 	{ USB_DEVICE(MACROSILICON_VENDOR_ID, MACROSILICON_MS3020_PRODUCT_ID) },
121 	{ }					/* Terminating entry */
122 };
123 
124 MODULE_DEVICE_TABLE(usb, id_table);
125 
126 #define SET_LINE_REQUEST_TYPE		0x21
127 #define SET_LINE_REQUEST		0x20
128 
129 #define SET_CONTROL_REQUEST_TYPE	0x21
130 #define SET_CONTROL_REQUEST		0x22
131 #define CONTROL_DTR			0x01
132 #define CONTROL_RTS			0x02
133 
134 #define BREAK_REQUEST_TYPE		0x21
135 #define BREAK_REQUEST			0x23
136 #define BREAK_ON			0xffff
137 #define BREAK_OFF			0x0000
138 
139 #define GET_LINE_REQUEST_TYPE		0xa1
140 #define GET_LINE_REQUEST		0x21
141 
142 #define VENDOR_WRITE_REQUEST_TYPE	0x40
143 #define VENDOR_WRITE_REQUEST		0x01
144 #define VENDOR_WRITE_NREQUEST		0x80
145 #define VENDOR_WRITE_MPREQUEST		0x80
146 
147 #define VENDOR_READ_REQUEST_TYPE	0xc0
148 #define VENDOR_READ_REQUEST		0x01
149 #define VENDOR_READ_NREQUEST		0x81
150 #define VENDOR_READ_MPREQUEST		0x80
151 
152 #define PL256X_RESET_REQUEST_TYPE	0x40
153 #define PL256X_RESET_REQUEST		0x96
154 
155 #define UART_STATE_INDEX		8
156 #define UART_STATE_MSR_MASK		0x8b
157 #define UART_STATE_TRANSIENT_MASK	0x74
158 #define UART_DCD			0x01
159 #define UART_DSR			0x02
160 #define UART_BREAK_ERROR		0x04
161 #define UART_RING			0x08
162 #define UART_FRAME_ERROR		0x10
163 #define UART_PARITY_ERROR		0x20
164 #define UART_OVERRUN_ERROR		0x40
165 #define UART_CTS			0x80
166 
167 #define PL2303_FLOWCTRL_MASK		0xf0
168 
169 #define PL2303_READ_TYPE_HX_STATUS	0x8080
170 
171 #define PL2303_HXN_RESET_REG		0x07
172 #define PL2303_HXN_RESET_UPSTREAM_PIPE	0x02
173 #define PL2303_HXN_RESET_DOWNSTREAM_PIPE	0x01
174 
175 #define PL2303_HXN_FLOWCTRL_REG		0x0a
176 #define PL2303_HXN_FLOWCTRL_MASK	0x1c
177 #define PL2303_HXN_FLOWCTRL_NONE	0x1c
178 #define PL2303_HXN_FLOWCTRL_RTS_CTS	0x18
179 #define PL2303_HXN_FLOWCTRL_XON_XOFF	0x0c
180 
181 #define PL256X_PORT_A_FLOWCTRL_REG	0xc005
182 #define PL256X_PORT_B_FLOWCTRL_REG	0xd005
183 #define PL256X_PORT_C_FLOWCTRL_REG	0xe005
184 #define PL256X_PORT_D_FLOWCTRL_REG	0xf005
185 
186 #define PL256X_FLOWCTRL_MASK		0x43
187 #define PL256X_FLOWCTRL_XON_XOFF	0x40
188 #define PL256X_FLOWCTRL_RTS_CTS		0x03
189 #define PL256X_FLOWCTRL_NONE		0x00
190 
191 static int pl2303_set_break(struct usb_serial_port *port, bool enable);
192 
193 enum pl2303_type {
194 	TYPE_H,
195 	TYPE_HX,
196 	TYPE_TA,
197 	TYPE_TB,
198 	TYPE_HXD,
199 	TYPE_HXN,
200 	TYPE_MP,
201 	TYPE_COUNT
202 };
203 
204 struct pl2303_type_data {
205 	const char *name;
206 	speed_t max_baud_rate;
207 	unsigned long quirks;
208 	unsigned int no_autoxonxoff:1;
209 	unsigned int no_divisors:1;
210 	unsigned int alt_divisors:1;
211 };
212 
213 struct pl2303_serial_private {
214 	const struct pl2303_type_data *type;
215 	unsigned long quirks;
216 	u16 interface_num;
217 	u16 flowctrl_reg;
218 };
219 
220 struct pl2303_private {
221 	spinlock_t lock;
222 	u8 line_control;
223 	u8 line_status;
224 
225 	u8 line_settings[7];
226 };
227 
228 static const struct pl2303_type_data pl2303_type_data[TYPE_COUNT] = {
229 	[TYPE_H] = {
230 		.name			= "H",
231 		.max_baud_rate		= 1228800,
232 		.quirks			= PL2303_QUIRK_LEGACY,
233 		.no_autoxonxoff		= true,
234 	},
235 	[TYPE_HX] = {
236 		.name			= "HX",
237 		.max_baud_rate		= 6000000,
238 	},
239 	[TYPE_TA] = {
240 		.name			= "TA",
241 		.max_baud_rate		= 6000000,
242 		.alt_divisors		= true,
243 	},
244 	[TYPE_TB] = {
245 		.name			= "TB",
246 		.max_baud_rate		= 12000000,
247 		.alt_divisors		= true,
248 	},
249 	[TYPE_HXD] = {
250 		.name			= "HXD",
251 		.max_baud_rate		= 12000000,
252 	},
253 	[TYPE_HXN] = {
254 		.name			= "G",
255 		.max_baud_rate		= 12000000,
256 		.no_divisors		= true,
257 	},
258 	[TYPE_MP] = {
259 		.name			= "MP",
260 		.max_baud_rate		= 24000000,
261 		.no_divisors		= true,
262 	},
263 };
264 
265 static int pl256x_uart_reset(struct usb_serial *serial)
266 {
267 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
268 	struct device *dev = &serial->interface->dev;
269 	int res;
270 
271 	res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
272 			PL256X_RESET_REQUEST, PL256X_RESET_REQUEST_TYPE,
273 			0, spriv->interface_num, NULL, 0, 100);
274 	if (res) {
275 		dev_err(dev, "failed to reset device: %d\n", res);
276 		return res;
277 	}
278 
279 	return 0;
280 }
281 
282 static int pl2303_vendor_read(struct usb_serial *serial, u16 value,
283 							unsigned char buf[1])
284 {
285 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
286 	struct device *dev = &serial->interface->dev;
287 	u8 request;
288 	int res;
289 
290 	if (spriv->type == &pl2303_type_data[TYPE_HXN])
291 		request = VENDOR_READ_NREQUEST;
292 	else if (spriv->type == &pl2303_type_data[TYPE_MP])
293 		request = VENDOR_READ_MPREQUEST;
294 	else
295 		request = VENDOR_READ_REQUEST;
296 
297 	res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
298 			request, VENDOR_READ_REQUEST_TYPE,
299 			value, 0, buf, 1, 100);
300 	if (res != 1) {
301 		dev_err(dev, "%s - failed to read [%04x]: %d\n", __func__,
302 								value, res);
303 		if (res >= 0)
304 			res = -EIO;
305 
306 		return res;
307 	}
308 
309 	dev_dbg(dev, "%s - [%04x] = %02x\n", __func__, value, buf[0]);
310 
311 	return 0;
312 }
313 
314 static int pl2303_vendor_write(struct usb_serial *serial, u16 value, u16 index)
315 {
316 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
317 	struct device *dev = &serial->interface->dev;
318 	u8 request;
319 	int res;
320 
321 	dev_dbg(dev, "%s - [%04x] = %02x\n", __func__, value, index);
322 
323 	if (spriv->type == &pl2303_type_data[TYPE_HXN])
324 		request = VENDOR_WRITE_NREQUEST;
325 	else if (spriv->type == &pl2303_type_data[TYPE_MP])
326 		request = VENDOR_WRITE_MPREQUEST;
327 	else
328 		request = VENDOR_WRITE_REQUEST;
329 
330 	res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
331 			request, VENDOR_WRITE_REQUEST_TYPE,
332 			value, index, NULL, 0, 100);
333 	if (res) {
334 		dev_err(dev, "%s - failed to write [%04x]: %d\n", __func__,
335 								value, res);
336 		return res;
337 	}
338 
339 	return 0;
340 }
341 
342 static int pl2303_update_reg(struct usb_serial *serial, u8 reg, u8 mask, u8 val)
343 {
344 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
345 	int ret = 0;
346 	u8 *buf;
347 
348 	buf = kmalloc(1, GFP_KERNEL);
349 	if (!buf)
350 		return -ENOMEM;
351 
352 	if (spriv->type == &pl2303_type_data[TYPE_HXN] ||
353 			spriv->type == &pl2303_type_data[TYPE_MP]) {
354 		ret = pl2303_vendor_read(serial, reg, buf);
355 	} else {
356 		ret = pl2303_vendor_read(serial, reg | 0x80, buf);
357 	}
358 
359 	if (ret)
360 		goto out_free;
361 
362 	*buf &= ~mask;
363 	*buf |= val & mask;
364 
365 	ret = pl2303_vendor_write(serial, reg, *buf);
366 out_free:
367 	kfree(buf);
368 
369 	return ret;
370 }
371 
372 static int pl2303_probe(struct usb_serial *serial,
373 					const struct usb_device_id *id)
374 {
375 	usb_set_serial_data(serial, (void *)id->driver_info);
376 
377 	return 0;
378 }
379 
380 /*
381  * Use interrupt endpoint from first interface if available.
382  *
383  * This is needed due to the looney way its endpoints are set up.
384  */
385 static int pl2303_endpoint_hack(struct usb_serial *serial,
386 					struct usb_serial_endpoints *epds)
387 {
388 	struct usb_interface *interface = serial->interface;
389 	struct usb_device *dev = serial->dev;
390 	struct device *ddev = &interface->dev;
391 	struct usb_host_interface *iface_desc;
392 	struct usb_endpoint_descriptor *endpoint;
393 	unsigned int i;
394 
395 	if (interface == dev->actconfig->interface[0])
396 		return 0;
397 
398 	/* check out the endpoints of the other interface */
399 	iface_desc = dev->actconfig->interface[0]->cur_altsetting;
400 
401 	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
402 		endpoint = &iface_desc->endpoint[i].desc;
403 
404 		if (!usb_endpoint_is_int_in(endpoint))
405 			continue;
406 
407 		dev_dbg(ddev, "found interrupt in on separate interface\n");
408 		if (epds->num_interrupt_in < ARRAY_SIZE(epds->interrupt_in))
409 			epds->interrupt_in[epds->num_interrupt_in++] = endpoint;
410 	}
411 
412 	return 0;
413 }
414 
415 static int pl2303_calc_num_ports(struct usb_serial *serial,
416 					struct usb_serial_endpoints *epds)
417 {
418 	unsigned long quirks = (unsigned long)usb_get_serial_data(serial);
419 	struct device *dev = &serial->interface->dev;
420 	int ret;
421 
422 	if (quirks & PL2303_QUIRK_ENDPOINT_HACK) {
423 		ret = pl2303_endpoint_hack(serial, epds);
424 		if (ret)
425 			return ret;
426 	}
427 
428 	if (epds->num_interrupt_in < 1) {
429 		dev_err(dev, "required interrupt-in endpoint missing\n");
430 		return -ENODEV;
431 	}
432 
433 	return 1;
434 }
435 
436 static bool pl2303_supports_hx_status(struct usb_serial *serial)
437 {
438 	int ret;
439 	u8 buf;
440 
441 	ret = usb_control_msg_recv(serial->dev, 0, VENDOR_READ_REQUEST,
442 			VENDOR_READ_REQUEST_TYPE, PL2303_READ_TYPE_HX_STATUS,
443 			0, &buf, 1, 100, GFP_KERNEL);
444 
445 	return ret == 0;
446 }
447 
448 static int pl2303_detect_type(struct usb_serial *serial)
449 {
450 	struct usb_device_descriptor *desc = &serial->dev->descriptor;
451 	u16 bcdDevice, bcdUSB;
452 
453 	/*
454 	 * Legacy PL2303H, variants 0 and 1 (difference unknown).
455 	 */
456 	if (desc->bDeviceClass == 0x02)
457 		return TYPE_H;		/* variant 0 */
458 
459 	if (desc->bMaxPacketSize0 != 0x40) {
460 		if (desc->bDeviceClass == 0x00 || desc->bDeviceClass == 0xff)
461 			return TYPE_H;	/* variant 1 */
462 
463 		return TYPE_H;		/* variant 0 */
464 	}
465 
466 	bcdDevice = le16_to_cpu(desc->bcdDevice);
467 	bcdUSB = le16_to_cpu(desc->bcdUSB);
468 
469 	switch (bcdUSB) {
470 	case 0x101:
471 		/* USB 1.0.1? Let's assume they meant 1.1... */
472 		fallthrough;
473 	case 0x110:
474 		switch (bcdDevice) {
475 		case 0x300:
476 			return TYPE_HX;
477 		case 0x400:
478 			return TYPE_HXD;
479 		default:
480 			return TYPE_HX;
481 		}
482 		break;
483 	case 0x200:
484 		switch (bcdDevice) {
485 		case 0x100:	/* GC */
486 		case 0x105:
487 			return TYPE_HXN;
488 		case 0x300:	/* GT / TA */
489 			if (pl2303_supports_hx_status(serial))
490 				return TYPE_TA;
491 			fallthrough;
492 		case 0x305:
493 		case 0x400:	/* GL */
494 		case 0x405:
495 			return TYPE_HXN;
496 		case 0x500:	/* GE / TB */
497 			if (pl2303_supports_hx_status(serial))
498 				return TYPE_TB;
499 			fallthrough;
500 		case 0x505:
501 		case 0x600:	/* GS */
502 		case 0x605:
503 		case 0x700:	/* GR */
504 		case 0x705:
505 		case 0x905:	/* GT-2AB */
506 		case 0x1005:	/* GC-Q20 */
507 			return TYPE_HXN;
508 		case 0x3302:	/* PL2533 VC 2 Port */
509 		case 0x3304:	/* PL2533 VC 4 Port */
510 		case 0x4302:	/* PL2543 VC 2 Port */
511 		case 0x4304:	/* PL2543 VC 4 Port */
512 		case 0x6502:	/* PL2565 VC 2 Port */
513 		case 0x6504:	/* PL2565 VC 4 Port */
514 		case 0x6506:	/* PL2565 VC 4 Port QFN64 package */
515 			return TYPE_MP;
516 		}
517 		break;
518 	}
519 
520 	dev_err(&serial->interface->dev,
521 			"unknown device type, please report to linux-usb@vger.kernel.org\n");
522 	return -ENODEV;
523 }
524 
525 static bool pl2303_is_hxd_clone(struct usb_serial *serial)
526 {
527 	struct usb_device *udev = serial->dev;
528 	unsigned char *buf;
529 	int ret;
530 
531 	buf = kmalloc(7, GFP_KERNEL);
532 	if (!buf)
533 		return false;
534 
535 	ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
536 			      GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
537 			      0, 0, buf, 7, 100);
538 
539 	kfree(buf);
540 
541 	return ret == -EPIPE;
542 }
543 
544 static int pl2303_startup(struct usb_serial *serial)
545 {
546 	struct pl2303_serial_private *spriv;
547 	enum pl2303_type type;
548 	unsigned char *buf;
549 	unsigned int ifnum;
550 	int ret;
551 
552 	ret = pl2303_detect_type(serial);
553 	if (ret < 0)
554 		return ret;
555 
556 	type = ret;
557 	dev_dbg(&serial->interface->dev, "device type: %s\n", pl2303_type_data[type].name);
558 
559 	ifnum = serial->interface->altsetting->desc.bInterfaceNumber;
560 
561 	spriv = kzalloc_obj(*spriv);
562 	if (!spriv)
563 		return -ENOMEM;
564 
565 	if (type == TYPE_MP) {
566 		switch (ifnum) {
567 		case 0:
568 			spriv->flowctrl_reg = PL256X_PORT_A_FLOWCTRL_REG;
569 			break;
570 		case 1:
571 			spriv->flowctrl_reg = PL256X_PORT_B_FLOWCTRL_REG;
572 			break;
573 		case 2:
574 			spriv->flowctrl_reg = PL256X_PORT_C_FLOWCTRL_REG;
575 			break;
576 		case 3:
577 			spriv->flowctrl_reg = PL256X_PORT_D_FLOWCTRL_REG;
578 			break;
579 		default:
580 			kfree(spriv);
581 			return -ENODEV;
582 		}
583 	}
584 
585 	spriv->type = &pl2303_type_data[type];
586 	spriv->quirks = (unsigned long)usb_get_serial_data(serial);
587 	spriv->quirks |= spriv->type->quirks;
588 	spriv->interface_num = ifnum;
589 
590 	if (type == TYPE_HXD && pl2303_is_hxd_clone(serial))
591 		spriv->quirks |= PL2303_QUIRK_NO_BREAK_GETLINE;
592 
593 	usb_set_serial_data(serial, spriv);
594 
595 	if (type != TYPE_HXN && type != TYPE_MP) {
596 		buf = kmalloc(1, GFP_KERNEL);
597 		if (!buf) {
598 			kfree(spriv);
599 			return -ENOMEM;
600 		}
601 
602 		pl2303_vendor_read(serial, 0x8484, buf);
603 		pl2303_vendor_write(serial, 0x0404, 0);
604 		pl2303_vendor_read(serial, 0x8484, buf);
605 		pl2303_vendor_read(serial, 0x8383, buf);
606 		pl2303_vendor_read(serial, 0x8484, buf);
607 		pl2303_vendor_write(serial, 0x0404, 1);
608 		pl2303_vendor_read(serial, 0x8484, buf);
609 		pl2303_vendor_read(serial, 0x8383, buf);
610 		pl2303_vendor_write(serial, 0, 1);
611 		pl2303_vendor_write(serial, 1, 0);
612 		if (spriv->quirks & PL2303_QUIRK_LEGACY)
613 			pl2303_vendor_write(serial, 2, 0x24);
614 		else
615 			pl2303_vendor_write(serial, 2, 0x44);
616 
617 		kfree(buf);
618 	}
619 
620 	return 0;
621 }
622 
623 static void pl2303_release(struct usb_serial *serial)
624 {
625 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
626 
627 	kfree(spriv);
628 }
629 
630 static int pl2303_port_probe(struct usb_serial_port *port)
631 {
632 	struct pl2303_private *priv;
633 
634 	priv = kzalloc_obj(*priv);
635 	if (!priv)
636 		return -ENOMEM;
637 
638 	spin_lock_init(&priv->lock);
639 
640 	usb_set_serial_port_data(port, priv);
641 
642 	port->port.drain_delay = 256;
643 
644 	return 0;
645 }
646 
647 static void pl2303_port_remove(struct usb_serial_port *port)
648 {
649 	struct pl2303_private *priv = usb_get_serial_port_data(port);
650 
651 	kfree(priv);
652 }
653 
654 static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
655 {
656 	struct usb_device *dev = port->serial->dev;
657 	struct usb_serial *serial = port->serial;
658 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
659 	int retval;
660 
661 	dev_dbg(&port->dev, "%s - %02x\n", __func__, value);
662 
663 	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
664 				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
665 				 value, spriv->interface_num, NULL, 0, 100);
666 	if (retval)
667 		dev_err(&port->dev, "%s - failed: %d\n", __func__, retval);
668 
669 	return retval;
670 }
671 
672 /*
673  * Returns the nearest supported baud rate that can be set directly without
674  * using divisors.
675  */
676 static speed_t pl2303_get_supported_baud_rate(speed_t baud)
677 {
678 	static const speed_t baud_sup[] = {
679 		75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600,
680 		14400, 19200, 28800, 38400, 57600, 115200, 230400, 460800,
681 		614400, 921600, 1228800, 2457600, 3000000, 6000000
682 	};
683 
684 	unsigned i;
685 
686 	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
687 		if (baud_sup[i] > baud)
688 			break;
689 	}
690 
691 	if (i == ARRAY_SIZE(baud_sup))
692 		baud = baud_sup[i - 1];
693 	else if (i > 0 && (baud_sup[i] - baud) > (baud - baud_sup[i - 1]))
694 		baud = baud_sup[i - 1];
695 	else
696 		baud = baud_sup[i];
697 
698 	return baud;
699 }
700 
701 /*
702  * NOTE: If unsupported baud rates are set directly, the PL2303 seems to
703  *       use 9600 baud.
704  */
705 static speed_t pl2303_encode_baud_rate_direct(unsigned char buf[4],
706 								speed_t baud)
707 {
708 	put_unaligned_le32(baud, buf);
709 
710 	return baud;
711 }
712 
713 static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
714 								speed_t baud)
715 {
716 	unsigned int baseline, mantissa, exponent;
717 
718 	/*
719 	 * Apparently the formula is:
720 	 *   baudrate = 12M * 32 / (mantissa * 4^exponent)
721 	 * where
722 	 *   mantissa = buf[8:0]
723 	 *   exponent = buf[11:9]
724 	 */
725 	baseline = 12000000 * 32;
726 	mantissa = baseline / baud;
727 	if (mantissa == 0)
728 		mantissa = 1;	/* Avoid dividing by zero if baud > 32*12M. */
729 	exponent = 0;
730 	while (mantissa >= 512) {
731 		if (exponent < 7) {
732 			mantissa >>= 2;	/* divide by 4 */
733 			exponent++;
734 		} else {
735 			/* Exponent is maxed. Trim mantissa and leave. */
736 			mantissa = 511;
737 			break;
738 		}
739 	}
740 
741 	buf[3] = 0x80;
742 	buf[2] = 0;
743 	buf[1] = exponent << 1 | mantissa >> 8;
744 	buf[0] = mantissa & 0xff;
745 
746 	/* Calculate and return the exact baud rate. */
747 	baud = (baseline / mantissa) >> (exponent << 1);
748 
749 	return baud;
750 }
751 
752 static speed_t pl2303_encode_baud_rate_divisor_alt(unsigned char buf[4],
753 								speed_t baud)
754 {
755 	unsigned int baseline, mantissa, exponent;
756 
757 	/*
758 	 * Apparently, for the TA version the formula is:
759 	 *   baudrate = 12M * 32 / (mantissa * 2^exponent)
760 	 * where
761 	 *   mantissa = buf[10:0]
762 	 *   exponent = buf[15:13 16]
763 	 */
764 	baseline = 12000000 * 32;
765 	mantissa = baseline / baud;
766 	if (mantissa == 0)
767 		mantissa = 1;   /* Avoid dividing by zero if baud > 32*12M. */
768 	exponent = 0;
769 	while (mantissa >= 2048) {
770 		if (exponent < 15) {
771 			mantissa >>= 1; /* divide by 2 */
772 			exponent++;
773 		} else {
774 			/* Exponent is maxed. Trim mantissa and leave. */
775 			mantissa = 2047;
776 			break;
777 		}
778 	}
779 
780 	buf[3] = 0x80;
781 	buf[2] = exponent & 0x01;
782 	buf[1] = (exponent & ~0x01) << 4 | mantissa >> 8;
783 	buf[0] = mantissa & 0xff;
784 
785 	/* Calculate and return the exact baud rate. */
786 	baud = (baseline / mantissa) >> exponent;
787 
788 	return baud;
789 }
790 
791 static void pl2303_encode_baud_rate(struct tty_struct *tty,
792 					struct usb_serial_port *port,
793 					u8 buf[4])
794 {
795 	struct usb_serial *serial = port->serial;
796 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
797 	speed_t	baud_sup;
798 	speed_t baud;
799 
800 	baud = tty_get_baud_rate(tty);
801 	dev_dbg(&port->dev, "baud requested = %u\n", baud);
802 	if (!baud)
803 		return;
804 
805 	if (spriv->type->max_baud_rate)
806 		baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
807 	/*
808 	 * Use direct method for supported baud rates, otherwise use divisors.
809 	 * Newer chip types do not support divisor encoding.
810 	 */
811 	if (spriv->type->no_divisors)
812 		baud_sup = baud;
813 	else
814 		baud_sup = pl2303_get_supported_baud_rate(baud);
815 
816 	if (baud == baud_sup)
817 		baud = pl2303_encode_baud_rate_direct(buf, baud);
818 	else if (spriv->type->alt_divisors)
819 		baud = pl2303_encode_baud_rate_divisor_alt(buf, baud);
820 	else
821 		baud = pl2303_encode_baud_rate_divisor(buf, baud);
822 
823 	/* Save resulting baud rate */
824 	tty_encode_baud_rate(tty, baud, baud);
825 	dev_dbg(&port->dev, "baud set = %u\n", baud);
826 }
827 
828 static int pl2303_get_line_request(struct usb_serial_port *port,
829 							unsigned char buf[7])
830 {
831 	struct usb_serial *serial = port->serial;
832 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
833 	struct usb_device *udev = serial->dev;
834 	int ret;
835 
836 	if (spriv->quirks & PL2303_QUIRK_NO_BREAK_GETLINE) {
837 		struct pl2303_private *priv = usb_get_serial_port_data(port);
838 
839 		memcpy(buf, priv->line_settings, 7);
840 		return 0;
841 	}
842 
843 	ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
844 				GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
845 				0, spriv->interface_num, buf, 7, 100);
846 	if (ret != 7) {
847 		dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
848 
849 		if (ret >= 0)
850 			ret = -EIO;
851 
852 		return ret;
853 	}
854 
855 	dev_dbg(&port->dev, "%s - %7ph\n", __func__, buf);
856 
857 	return 0;
858 }
859 
860 static int pl2303_set_line_request(struct usb_serial_port *port,
861 							unsigned char buf[7])
862 {
863 	struct usb_device *udev = port->serial->dev;
864 	struct usb_serial *serial = port->serial;
865 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
866 	int ret;
867 
868 	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
869 				SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
870 				0, spriv->interface_num, buf, 7, 100);
871 	if (ret < 0) {
872 		dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
873 		return ret;
874 	}
875 
876 	dev_dbg(&port->dev, "%s - %7ph\n", __func__, buf);
877 
878 	return 0;
879 }
880 
881 static bool pl2303_termios_change(const struct ktermios *a, const struct ktermios *b)
882 {
883 	bool ixon_change;
884 
885 	ixon_change = ((a->c_iflag ^ b->c_iflag) & (IXON | IXANY)) ||
886 			a->c_cc[VSTART] != b->c_cc[VSTART] ||
887 			a->c_cc[VSTOP] != b->c_cc[VSTOP];
888 
889 	return tty_termios_hw_change(a, b) || ixon_change;
890 }
891 
892 static bool pl2303_enable_xonxoff(struct tty_struct *tty, const struct pl2303_type_data *type)
893 {
894 	if (!I_IXON(tty) || I_IXANY(tty))
895 		return false;
896 
897 	if (START_CHAR(tty) != 0x11 || STOP_CHAR(tty) != 0x13)
898 		return false;
899 
900 	if (type->no_autoxonxoff)
901 		return false;
902 
903 	return true;
904 }
905 
906 static void pl2303_set_termios(struct tty_struct *tty,
907 			       struct usb_serial_port *port,
908 			       const struct ktermios *old_termios)
909 {
910 	struct usb_serial *serial = port->serial;
911 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
912 	struct pl2303_private *priv = usb_get_serial_port_data(port);
913 	unsigned long flags;
914 	unsigned char *buf;
915 	int ret;
916 	u8 control;
917 
918 	if (old_termios && !pl2303_termios_change(&tty->termios, old_termios))
919 		return;
920 
921 	buf = kzalloc(7, GFP_KERNEL);
922 	if (!buf) {
923 		/* Report back no change occurred */
924 		if (old_termios)
925 			tty->termios = *old_termios;
926 		return;
927 	}
928 
929 	pl2303_get_line_request(port, buf);
930 
931 	buf[6] = tty_get_char_size(tty->termios.c_cflag);
932 	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
933 
934 	/* For reference buf[0]:buf[3] baud rate value */
935 	pl2303_encode_baud_rate(tty, port, &buf[0]);
936 
937 	/* For reference buf[4]=0 is 1 stop bits */
938 	/* For reference buf[4]=1 is 1.5 stop bits */
939 	/* For reference buf[4]=2 is 2 stop bits */
940 	if (C_CSTOPB(tty)) {
941 		/*
942 		 * NOTE: Comply with "real" UARTs / RS232:
943 		 *       use 1.5 instead of 2 stop bits with 5 data bits
944 		 */
945 		if (C_CSIZE(tty) == CS5) {
946 			buf[4] = 1;
947 			dev_dbg(&port->dev, "stop bits = 1.5\n");
948 		} else {
949 			buf[4] = 2;
950 			dev_dbg(&port->dev, "stop bits = 2\n");
951 		}
952 	} else {
953 		buf[4] = 0;
954 		dev_dbg(&port->dev, "stop bits = 1\n");
955 	}
956 
957 	if (C_PARENB(tty)) {
958 		/* For reference buf[5]=0 is none parity */
959 		/* For reference buf[5]=1 is odd parity */
960 		/* For reference buf[5]=2 is even parity */
961 		/* For reference buf[5]=3 is mark parity */
962 		/* For reference buf[5]=4 is space parity */
963 		if (C_PARODD(tty)) {
964 			if (C_CMSPAR(tty)) {
965 				buf[5] = 3;
966 				dev_dbg(&port->dev, "parity = mark\n");
967 			} else {
968 				buf[5] = 1;
969 				dev_dbg(&port->dev, "parity = odd\n");
970 			}
971 		} else {
972 			if (C_CMSPAR(tty)) {
973 				buf[5] = 4;
974 				dev_dbg(&port->dev, "parity = space\n");
975 			} else {
976 				buf[5] = 2;
977 				dev_dbg(&port->dev, "parity = even\n");
978 			}
979 		}
980 	} else {
981 		buf[5] = 0;
982 		dev_dbg(&port->dev, "parity = none\n");
983 	}
984 
985 	/*
986 	 * Some PL2303 are known to lose bytes if you change serial settings
987 	 * even to the same values as before. Thus we actually need to filter
988 	 * in this specific case.
989 	 *
990 	 * Note that the tty_termios_hw_change check above is not sufficient
991 	 * as a previously requested baud rate may differ from the one
992 	 * actually used (and stored in old_termios).
993 	 *
994 	 * NOTE: No additional locking needed for line_settings as it is
995 	 *       only used in set_termios, which is serialised against itself.
996 	 */
997 	if (!old_termios || memcmp(buf, priv->line_settings, 7)) {
998 		ret = pl2303_set_line_request(port, buf);
999 		if (!ret)
1000 			memcpy(priv->line_settings, buf, 7);
1001 	}
1002 
1003 	/* change control lines if we are switching to or from B0 */
1004 	spin_lock_irqsave(&priv->lock, flags);
1005 	control = priv->line_control;
1006 	if (C_BAUD(tty) == B0)
1007 		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
1008 	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
1009 		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
1010 	if (control != priv->line_control) {
1011 		control = priv->line_control;
1012 		spin_unlock_irqrestore(&priv->lock, flags);
1013 		pl2303_set_control_lines(port, control);
1014 	} else {
1015 		spin_unlock_irqrestore(&priv->lock, flags);
1016 	}
1017 
1018 	if (C_CRTSCTS(tty)) {
1019 		if (spriv->quirks & PL2303_QUIRK_LEGACY) {
1020 			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0x40);
1021 		} else if (spriv->type == &pl2303_type_data[TYPE_HXN]) {
1022 			pl2303_update_reg(serial, PL2303_HXN_FLOWCTRL_REG,
1023 					PL2303_HXN_FLOWCTRL_MASK,
1024 					PL2303_HXN_FLOWCTRL_RTS_CTS);
1025 		} else if (spriv->type == &pl2303_type_data[TYPE_MP]) {
1026 			pl2303_vendor_write(serial, spriv->flowctrl_reg,
1027 					PL256X_FLOWCTRL_RTS_CTS);
1028 		} else {
1029 			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0x60);
1030 		}
1031 	} else if (pl2303_enable_xonxoff(tty, spriv->type)) {
1032 		if (spriv->type == &pl2303_type_data[TYPE_HXN]) {
1033 			pl2303_update_reg(serial, PL2303_HXN_FLOWCTRL_REG,
1034 					PL2303_HXN_FLOWCTRL_MASK,
1035 					PL2303_HXN_FLOWCTRL_XON_XOFF);
1036 		} else if (spriv->type == &pl2303_type_data[TYPE_MP]) {
1037 			pl2303_vendor_write(serial, spriv->flowctrl_reg,
1038 					PL256X_FLOWCTRL_XON_XOFF);
1039 		} else {
1040 			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0xc0);
1041 		}
1042 	} else {
1043 		if (spriv->type == &pl2303_type_data[TYPE_HXN]) {
1044 			pl2303_update_reg(serial, PL2303_HXN_FLOWCTRL_REG,
1045 					PL2303_HXN_FLOWCTRL_MASK,
1046 					PL2303_HXN_FLOWCTRL_NONE);
1047 		} else if (spriv->type == &pl2303_type_data[TYPE_MP]) {
1048 			pl2303_vendor_write(serial, spriv->flowctrl_reg,
1049 					PL256X_FLOWCTRL_NONE);
1050 		} else {
1051 			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0);
1052 		}
1053 	}
1054 
1055 	kfree(buf);
1056 }
1057 
1058 static void pl2303_dtr_rts(struct usb_serial_port *port, int on)
1059 {
1060 	struct pl2303_private *priv = usb_get_serial_port_data(port);
1061 	unsigned long flags;
1062 	u8 control;
1063 
1064 	spin_lock_irqsave(&priv->lock, flags);
1065 	if (on)
1066 		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
1067 	else
1068 		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
1069 	control = priv->line_control;
1070 	spin_unlock_irqrestore(&priv->lock, flags);
1071 
1072 	pl2303_set_control_lines(port, control);
1073 }
1074 
1075 static void pl2303_close(struct usb_serial_port *port)
1076 {
1077 	usb_serial_generic_close(port);
1078 	usb_kill_urb(port->interrupt_in_urb);
1079 	pl2303_set_break(port, false);
1080 }
1081 
1082 static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
1083 {
1084 	struct usb_serial *serial = port->serial;
1085 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
1086 	int result;
1087 
1088 	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
1089 		usb_clear_halt(serial->dev, port->write_urb->pipe);
1090 		usb_clear_halt(serial->dev, port->read_urb->pipe);
1091 	} else {
1092 		/* reset upstream data pipes */
1093 		if (spriv->type == &pl2303_type_data[TYPE_HXN]) {
1094 			pl2303_vendor_write(serial, PL2303_HXN_RESET_REG,
1095 					PL2303_HXN_RESET_UPSTREAM_PIPE |
1096 					PL2303_HXN_RESET_DOWNSTREAM_PIPE);
1097 		} else if (spriv->type == &pl2303_type_data[TYPE_MP]) {
1098 			pl256x_uart_reset(serial);
1099 		} else {
1100 			pl2303_vendor_write(serial, 8, 0);
1101 			pl2303_vendor_write(serial, 9, 0);
1102 		}
1103 	}
1104 
1105 	/* Setup termios */
1106 	if (tty)
1107 		pl2303_set_termios(tty, port, NULL);
1108 
1109 	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
1110 	if (result) {
1111 		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
1112 			result);
1113 		return result;
1114 	}
1115 
1116 	result = usb_serial_generic_open(tty, port);
1117 	if (result) {
1118 		usb_kill_urb(port->interrupt_in_urb);
1119 		return result;
1120 	}
1121 
1122 	return 0;
1123 }
1124 
1125 static int pl2303_tiocmset(struct tty_struct *tty,
1126 			   unsigned int set, unsigned int clear)
1127 {
1128 	struct usb_serial_port *port = tty->driver_data;
1129 	struct pl2303_private *priv = usb_get_serial_port_data(port);
1130 	unsigned long flags;
1131 	u8 control;
1132 	int ret;
1133 
1134 	spin_lock_irqsave(&priv->lock, flags);
1135 	if (set & TIOCM_RTS)
1136 		priv->line_control |= CONTROL_RTS;
1137 	if (set & TIOCM_DTR)
1138 		priv->line_control |= CONTROL_DTR;
1139 	if (clear & TIOCM_RTS)
1140 		priv->line_control &= ~CONTROL_RTS;
1141 	if (clear & TIOCM_DTR)
1142 		priv->line_control &= ~CONTROL_DTR;
1143 	control = priv->line_control;
1144 	spin_unlock_irqrestore(&priv->lock, flags);
1145 
1146 	ret = pl2303_set_control_lines(port, control);
1147 	if (ret)
1148 		return usb_translate_errors(ret);
1149 
1150 	return 0;
1151 }
1152 
1153 static int pl2303_tiocmget(struct tty_struct *tty)
1154 {
1155 	struct usb_serial_port *port = tty->driver_data;
1156 	struct pl2303_private *priv = usb_get_serial_port_data(port);
1157 	unsigned long flags;
1158 	unsigned int mcr;
1159 	unsigned int status;
1160 	unsigned int result;
1161 
1162 	spin_lock_irqsave(&priv->lock, flags);
1163 	mcr = priv->line_control;
1164 	status = priv->line_status;
1165 	spin_unlock_irqrestore(&priv->lock, flags);
1166 
1167 	result = ((mcr & CONTROL_DTR)		? TIOCM_DTR : 0)
1168 		  | ((mcr & CONTROL_RTS)	? TIOCM_RTS : 0)
1169 		  | ((status & UART_CTS)	? TIOCM_CTS : 0)
1170 		  | ((status & UART_DSR)	? TIOCM_DSR : 0)
1171 		  | ((status & UART_RING)	? TIOCM_RI  : 0)
1172 		  | ((status & UART_DCD)	? TIOCM_CD  : 0);
1173 
1174 	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
1175 
1176 	return result;
1177 }
1178 
1179 static int pl2303_carrier_raised(struct usb_serial_port *port)
1180 {
1181 	struct pl2303_private *priv = usb_get_serial_port_data(port);
1182 
1183 	if (priv->line_status & UART_DCD)
1184 		return 1;
1185 
1186 	return 0;
1187 }
1188 
1189 static int pl2303_set_break(struct usb_serial_port *port, bool enable)
1190 {
1191 	struct usb_serial *serial = port->serial;
1192 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
1193 	u16 state;
1194 	int result;
1195 
1196 	if (spriv->quirks & PL2303_QUIRK_NO_BREAK_GETLINE)
1197 		return -ENOTTY;
1198 
1199 	if (enable)
1200 		state = BREAK_ON;
1201 	else
1202 		state = BREAK_OFF;
1203 
1204 	dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
1205 			state == BREAK_OFF ? "off" : "on");
1206 
1207 	result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
1208 				 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
1209 				 spriv->interface_num, NULL, 0, 100);
1210 	if (result) {
1211 		dev_err(&port->dev, "error sending break = %d\n", result);
1212 		return result;
1213 	}
1214 
1215 	return 0;
1216 }
1217 
1218 static int pl2303_break_ctl(struct tty_struct *tty, int state)
1219 {
1220 	struct usb_serial_port *port = tty->driver_data;
1221 
1222 	return pl2303_set_break(port, state);
1223 }
1224 
1225 static void pl2303_update_line_status(struct usb_serial_port *port,
1226 				      unsigned char *data,
1227 				      unsigned int actual_length)
1228 {
1229 	struct usb_serial *serial = port->serial;
1230 	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
1231 	struct pl2303_private *priv = usb_get_serial_port_data(port);
1232 	struct tty_struct *tty;
1233 	unsigned long flags;
1234 	unsigned int status_idx = UART_STATE_INDEX;
1235 	u8 status;
1236 	u8 delta;
1237 
1238 	if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
1239 		status_idx = 0;
1240 
1241 	if (actual_length < status_idx + 1)
1242 		return;
1243 
1244 	status = data[status_idx];
1245 
1246 	/* Save off the uart status for others to look at */
1247 	spin_lock_irqsave(&priv->lock, flags);
1248 	delta = priv->line_status ^ status;
1249 	priv->line_status = status;
1250 	spin_unlock_irqrestore(&priv->lock, flags);
1251 
1252 	if (status & UART_BREAK_ERROR)
1253 		usb_serial_handle_break(port);
1254 
1255 	if (delta & UART_STATE_MSR_MASK) {
1256 		if (delta & UART_CTS)
1257 			port->icount.cts++;
1258 		if (delta & UART_DSR)
1259 			port->icount.dsr++;
1260 		if (delta & UART_RING)
1261 			port->icount.rng++;
1262 		if (delta & UART_DCD) {
1263 			port->icount.dcd++;
1264 			tty = tty_port_tty_get(&port->port);
1265 			if (tty) {
1266 				usb_serial_handle_dcd_change(port, tty,
1267 							status & UART_DCD);
1268 				tty_kref_put(tty);
1269 			}
1270 		}
1271 
1272 		wake_up_interruptible(&port->port.delta_msr_wait);
1273 	}
1274 }
1275 
1276 static void pl2303_read_int_callback(struct urb *urb)
1277 {
1278 	struct usb_serial_port *port =  urb->context;
1279 	unsigned char *data = urb->transfer_buffer;
1280 	unsigned int actual_length = urb->actual_length;
1281 	int status = urb->status;
1282 	int retval;
1283 
1284 	switch (status) {
1285 	case 0:
1286 		/* success */
1287 		break;
1288 	case -ECONNRESET:
1289 	case -ENOENT:
1290 	case -ESHUTDOWN:
1291 		/* this urb is terminated, clean up */
1292 		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
1293 			__func__, status);
1294 		return;
1295 	default:
1296 		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
1297 			__func__, status);
1298 		goto exit;
1299 	}
1300 
1301 	usb_serial_debug_data(&port->dev, __func__,
1302 			      urb->actual_length, urb->transfer_buffer);
1303 
1304 	pl2303_update_line_status(port, data, actual_length);
1305 
1306 exit:
1307 	retval = usb_submit_urb(urb, GFP_ATOMIC);
1308 	if (retval) {
1309 		dev_err(&port->dev,
1310 			"%s - usb_submit_urb failed with result %d\n",
1311 			__func__, retval);
1312 	}
1313 }
1314 
1315 static void pl2303_process_read_urb(struct urb *urb)
1316 {
1317 	struct usb_serial_port *port = urb->context;
1318 	struct pl2303_private *priv = usb_get_serial_port_data(port);
1319 	unsigned char *data = urb->transfer_buffer;
1320 	char tty_flag = TTY_NORMAL;
1321 	unsigned long flags;
1322 	u8 line_status;
1323 	int i;
1324 
1325 	/* update line status */
1326 	spin_lock_irqsave(&priv->lock, flags);
1327 	line_status = priv->line_status;
1328 	priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
1329 	spin_unlock_irqrestore(&priv->lock, flags);
1330 
1331 	if (!urb->actual_length)
1332 		return;
1333 
1334 	/*
1335 	 * Break takes precedence over parity, which takes precedence over
1336 	 * framing errors.
1337 	 */
1338 	if (line_status & UART_BREAK_ERROR)
1339 		tty_flag = TTY_BREAK;
1340 	else if (line_status & UART_PARITY_ERROR)
1341 		tty_flag = TTY_PARITY;
1342 	else if (line_status & UART_FRAME_ERROR)
1343 		tty_flag = TTY_FRAME;
1344 
1345 	if (tty_flag != TTY_NORMAL)
1346 		dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
1347 								tty_flag);
1348 	/* overrun is special, not associated with a char */
1349 	if (line_status & UART_OVERRUN_ERROR)
1350 		tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
1351 
1352 	if (port->sysrq) {
1353 		for (i = 0; i < urb->actual_length; ++i)
1354 			if (!usb_serial_handle_sysrq_char(port, data[i]))
1355 				tty_insert_flip_char(&port->port, data[i],
1356 						tty_flag);
1357 	} else {
1358 		tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
1359 							urb->actual_length);
1360 	}
1361 
1362 	tty_flip_buffer_push(&port->port);
1363 }
1364 
1365 static struct usb_serial_driver pl2303_device = {
1366 	.driver = {
1367 		.name =		"pl2303",
1368 	},
1369 	.id_table =		id_table,
1370 	.num_bulk_in =		1,
1371 	.num_bulk_out =		1,
1372 	.num_interrupt_in =	0,	/* see pl2303_calc_num_ports */
1373 	.bulk_in_size =		256,
1374 	.bulk_out_size =	256,
1375 	.open =			pl2303_open,
1376 	.close =		pl2303_close,
1377 	.dtr_rts =		pl2303_dtr_rts,
1378 	.carrier_raised =	pl2303_carrier_raised,
1379 	.break_ctl =		pl2303_break_ctl,
1380 	.set_termios =		pl2303_set_termios,
1381 	.tiocmget =		pl2303_tiocmget,
1382 	.tiocmset =		pl2303_tiocmset,
1383 	.tiocmiwait =		usb_serial_generic_tiocmiwait,
1384 	.process_read_urb =	pl2303_process_read_urb,
1385 	.read_int_callback =	pl2303_read_int_callback,
1386 	.probe =		pl2303_probe,
1387 	.calc_num_ports =	pl2303_calc_num_ports,
1388 	.attach =		pl2303_startup,
1389 	.release =		pl2303_release,
1390 	.port_probe =		pl2303_port_probe,
1391 	.port_remove =		pl2303_port_remove,
1392 };
1393 
1394 static struct usb_serial_driver * const serial_drivers[] = {
1395 	&pl2303_device, NULL
1396 };
1397 
1398 module_usb_serial_driver(serial_drivers, id_table);
1399 
1400 MODULE_DESCRIPTION("Prolific PL2303 USB to serial adaptor driver");
1401 MODULE_LICENSE("GPL v2");
1402