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