pl2303.c 27.7 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
Linus Torvalds's avatar
Linus Torvalds committed
2
3
4
/*
 * Prolific PL2303 USB to serial adaptor driver
 *
5
 * Copyright (C) 2001-2007 Greg Kroah-Hartman (greg@kroah.com)
Linus Torvalds's avatar
Linus Torvalds committed
6
7
8
9
 * Copyright (C) 2003 IBM Corp.
 *
 * Original driver for 2.2.x by anonymous
 *
Alan Cox's avatar
Alan Cox committed
10
11
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
Linus Torvalds's avatar
Linus Torvalds committed
12
13
14
15
16
17
18
19
20
21
22
23
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/serial.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/spinlock.h>
Alan Cox's avatar
Alan Cox committed
24
#include <linux/uaccess.h>
Linus Torvalds's avatar
Linus Torvalds committed
25
#include <linux/usb.h>
26
#include <linux/usb/serial.h>
27
#include <asm/unaligned.h>
Linus Torvalds's avatar
Linus Torvalds committed
28
29
#include "pl2303.h"

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
37
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
Linus Torvalds's avatar
Linus Torvalds committed
38
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
39
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
Linus Torvalds's avatar
Linus Torvalds committed
40
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
41
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_CHILITAG) },
Linus Torvalds's avatar
Linus Torvalds committed
42
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
Max Arnold's avatar
Max Arnold committed
43
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ALDIGA) },
Steve Murphy's avatar
Steve Murphy committed
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) },
Linus Torvalds's avatar
Linus Torvalds committed
50
	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
51
	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
52
53
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
54
55
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC485),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
56
57
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC232B),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
58
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID2) },
Linus Torvalds's avatar
Linus Torvalds committed
59
60
61
62
	{ USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
	{ USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
	{ USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
	{ USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
63
	{ USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
Linus Torvalds's avatar
Linus Torvalds committed
64
65
66
67
68
69
70
	{ USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
	{ USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
	{ USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
	{ USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
	{ USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
	{ USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
	{ USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
71
72
73
74
75
76
	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1),
		.driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65),
		.driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75),
		.driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
77
78
	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
79
	{ USB_DEVICE(BENQ_VENDOR_ID, BENQ_PRODUCT_ID_S81) }, /* Benq/Siemens S81 */
80
	{ USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
81
82
	{ USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
	{ USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
83
	{ USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
84
	{ USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
85
	{ USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
86
	{ USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
87
	{ USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
88
89
	{ USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
90
	{ USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
91
	{ USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
92
	{ USB_DEVICE(YCCABLE_VENDOR_ID, YCCABLE_PRODUCT_ID) },
Matthew Arnold's avatar
Matthew Arnold committed
93
	{ USB_DEVICE(SUPERIAL_VENDOR_ID, SUPERIAL_PRODUCT_ID) },
94
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD220_PRODUCT_ID) },
95
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD220TA_PRODUCT_ID) },
96
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD960_PRODUCT_ID) },
97
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD960TA_PRODUCT_ID) },
98
99
	{ USB_DEVICE(HP_VENDOR_ID, HP_LCM220_PRODUCT_ID) },
	{ USB_DEVICE(HP_VENDOR_ID, HP_LCM960_PRODUCT_ID) },
100
101
102
	{ USB_DEVICE(HP_VENDOR_ID, HP_LM920_PRODUCT_ID) },
	{ USB_DEVICE(HP_VENDOR_ID, HP_LM940_PRODUCT_ID) },
	{ USB_DEVICE(HP_VENDOR_ID, HP_TD620_PRODUCT_ID) },
103
	{ USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
104
	{ USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
105
	{ USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
106
	{ USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
107
	{ USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
108
	{ USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
Linus Torvalds's avatar
Linus Torvalds committed
109
110
111
	{ }					/* Terminating entry */
};

112
MODULE_DEVICE_TABLE(usb, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
113
114
115
116
117
118
119
120
121
122

#define SET_LINE_REQUEST_TYPE		0x21
#define SET_LINE_REQUEST		0x20

#define SET_CONTROL_REQUEST_TYPE	0x21
#define SET_CONTROL_REQUEST		0x22
#define CONTROL_DTR			0x01
#define CONTROL_RTS			0x02

#define BREAK_REQUEST_TYPE		0x21
Alan Cox's avatar
Alan Cox committed
123
#define BREAK_REQUEST			0x23
Linus Torvalds's avatar
Linus Torvalds committed
124
125
126
127
128
129
130
131
132
133
134
135
#define BREAK_ON			0xffff
#define BREAK_OFF			0x0000

#define GET_LINE_REQUEST_TYPE		0xa1
#define GET_LINE_REQUEST		0x21

#define VENDOR_WRITE_REQUEST_TYPE	0x40
#define VENDOR_WRITE_REQUEST		0x01

#define VENDOR_READ_REQUEST_TYPE	0xc0
#define VENDOR_READ_REQUEST		0x01

136
#define UART_STATE_INDEX		8
137
#define UART_STATE_MSR_MASK		0x8b
Linus Torvalds's avatar
Linus Torvalds committed
138
139
140
141
142
143
144
145
146
147
#define UART_STATE_TRANSIENT_MASK	0x74
#define UART_DCD			0x01
#define UART_DSR			0x02
#define UART_BREAK_ERROR		0x04
#define UART_RING			0x08
#define UART_FRAME_ERROR		0x10
#define UART_PARITY_ERROR		0x20
#define UART_OVERRUN_ERROR		0x40
#define UART_CTS			0x80

148
static void pl2303_set_break(struct usb_serial_port *port, bool enable);
Linus Torvalds's avatar
Linus Torvalds committed
149
150

enum pl2303_type {
151
152
	TYPE_01,	/* Type 0 and 1 (difference unknown) */
	TYPE_HX,	/* HX version of the pl2303 chip */
153
154
155
156
157
158
	TYPE_COUNT
};

struct pl2303_type_data {
	speed_t max_baud_rate;
	unsigned long quirks;
159
	unsigned int no_autoxonxoff:1;
Linus Torvalds's avatar
Linus Torvalds committed
160
161
};

162
struct pl2303_serial_private {
163
	const struct pl2303_type_data *type;
164
	unsigned long quirks;
165
166
};

Linus Torvalds's avatar
Linus Torvalds committed
167
168
169
170
struct pl2303_private {
	spinlock_t lock;
	u8 line_control;
	u8 line_status;
171
172

	u8 line_settings[7];
Linus Torvalds's avatar
Linus Torvalds committed
173
174
};

175
static const struct pl2303_type_data pl2303_type_data[TYPE_COUNT] = {
176
	[TYPE_01] = {
177
178
179
		.max_baud_rate		= 1228800,
		.quirks			= PL2303_QUIRK_LEGACY,
		.no_autoxonxoff		= true,
180
	},
181
	[TYPE_HX] = {
182
		.max_baud_rate		= 12000000,
183
	},
184
185
};

186
187
static int pl2303_vendor_read(struct usb_serial *serial, u16 value,
							unsigned char buf[1])
188
{
189
	struct device *dev = &serial->interface->dev;
190
191
192
	int res;

	res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
193
			VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
194
195
196
197
198
199
200
201
202
			value, 0, buf, 1, 100);
	if (res != 1) {
		dev_err(dev, "%s - failed to read [%04x]: %d\n", __func__,
								value, res);
		if (res >= 0)
			res = -EIO;

		return res;
	}
203

204
	dev_dbg(dev, "%s - [%04x] = %02x\n", __func__, value, buf[0]);
205

206
	return 0;
207
208
}

209
static int pl2303_vendor_write(struct usb_serial *serial, u16 value, u16 index)
210
{
211
	struct device *dev = &serial->interface->dev;
212
213
	int res;

214
215
	dev_dbg(dev, "%s - [%04x] = %02x\n", __func__, value, index);

216
	res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
217
218
			VENDOR_WRITE_REQUEST, VENDOR_WRITE_REQUEST_TYPE,
			value, index, NULL, 0, 100);
219
220
221
222
223
	if (res) {
		dev_err(dev, "%s - failed to write [%04x]: %d\n", __func__,
								value, res);
		return res;
	}
224

225
	return 0;
226
227
}

228
229
230
231
232
233
234
235
static int pl2303_probe(struct usb_serial *serial,
					const struct usb_device_id *id)
{
	usb_set_serial_data(serial, (void *)id->driver_info);

	return 0;
}

236
237
238
239
240
241
/*
 * Use interrupt endpoint from first interface if available.
 *
 * This is needed due to the looney way its endpoints are set up.
 */
static int pl2303_endpoint_hack(struct usb_serial *serial,
242
243
244
245
246
247
248
249
250
					struct usb_serial_endpoints *epds)
{
	struct usb_interface *interface = serial->interface;
	struct usb_device *dev = serial->dev;
	struct device *ddev = &interface->dev;
	struct usb_host_interface *iface_desc;
	struct usb_endpoint_descriptor *endpoint;
	unsigned int i;

251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
	if (interface == dev->actconfig->interface[0])
		return 0;

	/* check out the endpoints of the other interface */
	iface_desc = dev->actconfig->interface[0]->cur_altsetting;

	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
		endpoint = &iface_desc->endpoint[i].desc;

		if (!usb_endpoint_is_int_in(endpoint))
			continue;

		dev_dbg(ddev, "found interrupt in on separate interface\n");
		if (epds->num_interrupt_in < ARRAY_SIZE(epds->interrupt_in))
			epds->interrupt_in[epds->num_interrupt_in++] = endpoint;
	}

	return 0;
}

static int pl2303_calc_num_ports(struct usb_serial *serial,
					struct usb_serial_endpoints *epds)
{
	unsigned long quirks = (unsigned long)usb_get_serial_data(serial);
	struct device *dev = &serial->interface->dev;
	int ret;

	if (quirks & PL2303_QUIRK_ENDPOINT_HACK) {
		ret = pl2303_endpoint_hack(serial, epds);
		if (ret)
			return ret;
282
283
284
	}

	if (epds->num_interrupt_in < 1) {
285
		dev_err(dev, "required interrupt-in endpoint missing\n");
286
287
288
289
290
291
		return -ENODEV;
	}

	return 1;
}

292
static int pl2303_startup(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
293
{
294
	struct pl2303_serial_private *spriv;
295
	enum pl2303_type type = TYPE_01;
296
	unsigned char *buf;
297
298
299
300

	spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
	if (!spriv)
		return -ENOMEM;
Linus Torvalds's avatar
Linus Torvalds committed
301

302
	buf = kmalloc(1, GFP_KERNEL);
303
304
	if (!buf) {
		kfree(spriv);
305
		return -ENOMEM;
306
	}
307

308
	if (serial->dev->descriptor.bDeviceClass == 0x02)
309
		type = TYPE_01;		/* type 0 */
310
	else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
311
		type = TYPE_HX;
312
	else if (serial->dev->descriptor.bDeviceClass == 0x00)
313
		type = TYPE_01;		/* type 1 */
314
	else if (serial->dev->descriptor.bDeviceClass == 0xFF)
315
		type = TYPE_01;		/* type 1 */
316
	dev_dbg(&serial->interface->dev, "device type: %d\n", type);
Linus Torvalds's avatar
Linus Torvalds committed
317

318
	spriv->type = &pl2303_type_data[type];
319
	spriv->quirks = (unsigned long)usb_get_serial_data(serial);
320
	spriv->quirks |= spriv->type->quirks;
321

322
	usb_set_serial_data(serial, spriv);
323

324
325
326
327
328
329
330
331
332
333
	pl2303_vendor_read(serial, 0x8484, buf);
	pl2303_vendor_write(serial, 0x0404, 0);
	pl2303_vendor_read(serial, 0x8484, buf);
	pl2303_vendor_read(serial, 0x8383, buf);
	pl2303_vendor_read(serial, 0x8484, buf);
	pl2303_vendor_write(serial, 0x0404, 1);
	pl2303_vendor_read(serial, 0x8484, buf);
	pl2303_vendor_read(serial, 0x8383, buf);
	pl2303_vendor_write(serial, 0, 1);
	pl2303_vendor_write(serial, 1, 0);
334
	if (spriv->quirks & PL2303_QUIRK_LEGACY)
335
		pl2303_vendor_write(serial, 2, 0x24);
336
337
	else
		pl2303_vendor_write(serial, 2, 0x44);
338
339

	kfree(buf);
340

Linus Torvalds's avatar
Linus Torvalds committed
341
	return 0;
342
}
Linus Torvalds's avatar
Linus Torvalds committed
343

344
345
static void pl2303_release(struct usb_serial *serial)
{
346
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362

	kfree(spriv);
}

static int pl2303_port_probe(struct usb_serial_port *port)
{
	struct pl2303_private *priv;

	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
	if (!priv)
		return -ENOMEM;

	spin_lock_init(&priv->lock);

	usb_set_serial_port_data(port, priv);

363
364
	port->port.drain_delay = 256;

365
366
367
368
369
	return 0;
}

static int pl2303_port_remove(struct usb_serial_port *port)
{
370
	struct pl2303_private *priv = usb_get_serial_port_data(port);
371
372
373
374

	kfree(priv);

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
375
376
}

377
static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
Linus Torvalds's avatar
Linus Torvalds committed
378
{
379
	struct usb_device *dev = port->serial->dev;
Linus Torvalds's avatar
Linus Torvalds committed
380
	int retval;
Alan Cox's avatar
Alan Cox committed
381

382
383
	dev_dbg(&port->dev, "%s - %02x\n", __func__, value);

384
385
386
	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
				 value, 0, NULL, 0, 100);
387
388
	if (retval)
		dev_err(&port->dev, "%s - failed: %d\n", __func__, retval);
389

Linus Torvalds's avatar
Linus Torvalds committed
390
391
392
	return retval;
}

393
/*
394
395
 * Returns the nearest supported baud rate that can be set directly without
 * using divisors.
396
397
 */
static speed_t pl2303_get_supported_baud_rate(speed_t baud)
Linus Torvalds's avatar
Linus Torvalds committed
398
{
399
400
401
	static const speed_t baud_sup[] = {
		75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600,
		14400, 19200, 28800, 38400, 57600, 115200, 230400, 460800,
402
		614400, 921600, 1228800, 2457600, 3000000, 6000000
403
	};
Linus Torvalds's avatar
Linus Torvalds committed
404

405
	unsigned i;
406

407
408
409
410
	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
		if (baud_sup[i] > baud)
			break;
	}
411

412
413
414
415
416
417
	if (i == ARRAY_SIZE(baud_sup))
		baud = baud_sup[i - 1];
	else if (i > 0 && (baud_sup[i] - baud) > (baud - baud_sup[i - 1]))
		baud = baud_sup[i - 1];
	else
		baud = baud_sup[i];
418

419
420
421
	return baud;
}

422
423
424
425
426
427
428
429
430
431
432
433
/*
 * NOTE: If unsupported baud rates are set directly, the PL2303 seems to
 *       use 9600 baud.
 */
static speed_t pl2303_encode_baud_rate_direct(unsigned char buf[4],
								speed_t baud)
{
	put_unaligned_le32(baud, buf);

	return baud;
}

434
435
436
static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
								speed_t baud)
{
437
	unsigned int baseline, mantissa, exponent;
438
439
440

	/*
	 * Apparently the formula is:
441
442
443
444
	 *   baudrate = 12M * 32 / (mantissa * 4^exponent)
	 * where
	 *   mantissa = buf[8:0]
	 *   exponent = buf[11:9]
445
	 */
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
	baseline = 12000000 * 32;
	mantissa = baseline / baud;
	if (mantissa == 0)
		mantissa = 1;	/* Avoid dividing by zero if baud > 32*12M. */
	exponent = 0;
	while (mantissa >= 512) {
		if (exponent < 7) {
			mantissa >>= 2;	/* divide by 4 */
			exponent++;
		} else {
			/* Exponent is maxed. Trim mantissa and leave. */
			mantissa = 511;
			break;
		}
	}

462
463
	buf[3] = 0x80;
	buf[2] = 0;
464
465
466
467
468
	buf[1] = exponent << 1 | mantissa >> 8;
	buf[0] = mantissa & 0xff;

	/* Calculate and return the exact baud rate. */
	baud = (baseline / mantissa) >> (exponent << 1);
469
470
471
472

	return baud;
}

473
474
475
476
477
478
static void pl2303_encode_baud_rate(struct tty_struct *tty,
					struct usb_serial_port *port,
					u8 buf[4])
{
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
479
	speed_t	baud_sup;
480
481
482
483
484
485
	speed_t baud;

	baud = tty_get_baud_rate(tty);
	dev_dbg(&port->dev, "baud requested = %u\n", baud);
	if (!baud)
		return;
486
487
488

	if (spriv->type->max_baud_rate)
		baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
489
	/*
490
	 * Use direct method for supported baud rates, otherwise use divisors.
491
492
	 */
	baud_sup = pl2303_get_supported_baud_rate(baud);
493

494
495
	if (baud == baud_sup)
		baud = pl2303_encode_baud_rate_direct(buf, baud);
496
	else
497
		baud = pl2303_encode_baud_rate_divisor(buf, baud);
498

499
	/* Save resulting baud rate */
500
	tty_encode_baud_rate(tty, baud, baud);
501
	dev_dbg(&port->dev, "baud set = %u\n", baud);
502
503
}

504
505
506
507
508
509
510
511
512
513
514
515
static int pl2303_get_line_request(struct usb_serial_port *port,
							unsigned char buf[7])
{
	struct usb_device *udev = port->serial->dev;
	int ret;

	ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
				GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
				0, 0, buf, 7, 100);
	if (ret != 7) {
		dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);

516
		if (ret >= 0)
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
			ret = -EIO;

		return ret;
	}

	dev_dbg(&port->dev, "%s - %7ph\n", __func__, buf);

	return 0;
}

static int pl2303_set_line_request(struct usb_serial_port *port,
							unsigned char buf[7])
{
	struct usb_device *udev = port->serial->dev;
	int ret;

	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
				SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
				0, 0, buf, 7, 100);
536
	if (ret < 0) {
537
538
539
540
541
542
543
544
545
		dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
		return ret;
	}

	dev_dbg(&port->dev, "%s - %7ph\n", __func__, buf);

	return 0;
}

546
547
548
549
550
551
552
553
554
555
556
static bool pl2303_termios_change(const struct ktermios *a, const struct ktermios *b)
{
	bool ixon_change;

	ixon_change = ((a->c_iflag ^ b->c_iflag) & (IXON | IXANY)) ||
			a->c_cc[VSTART] != b->c_cc[VSTART] ||
			a->c_cc[VSTOP] != b->c_cc[VSTOP];

	return tty_termios_hw_change(a, b) || ixon_change;
}

557
558
559
560
561
562
563
564
565
566
567
568
569
570
static bool pl2303_enable_xonxoff(struct tty_struct *tty, const struct pl2303_type_data *type)
{
	if (!I_IXON(tty) || I_IXANY(tty))
		return false;

	if (START_CHAR(tty) != 0x11 || STOP_CHAR(tty) != 0x13)
		return false;

	if (type->no_autoxonxoff)
		return false;

	return true;
}

571
572
573
574
575
576
577
578
static void pl2303_set_termios(struct tty_struct *tty,
		struct usb_serial_port *port, struct ktermios *old_termios)
{
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned char *buf;
579
	int ret;
580
581
	u8 control;

582
	if (old_termios && !pl2303_termios_change(&tty->termios, old_termios))
583
584
585
586
587
588
589
590
591
592
		return;

	buf = kzalloc(7, GFP_KERNEL);
	if (!buf) {
		/* Report back no change occurred */
		if (old_termios)
			tty->termios = *old_termios;
		return;
	}

593
	pl2303_get_line_request(port, buf);
594

595
596
597
598
599
600
601
602
603
604
605
606
607
	switch (C_CSIZE(tty)) {
	case CS5:
		buf[6] = 5;
		break;
	case CS6:
		buf[6] = 6;
		break;
	case CS7:
		buf[6] = 7;
		break;
	default:
	case CS8:
		buf[6] = 8;
608
	}
609
	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
610

611
	/* For reference buf[0]:buf[3] baud rate value */
612
	pl2303_encode_baud_rate(tty, port, &buf[0]);
613

Linus Torvalds's avatar
Linus Torvalds committed
614
615
616
	/* For reference buf[4]=0 is 1 stop bits */
	/* For reference buf[4]=1 is 1.5 stop bits */
	/* For reference buf[4]=2 is 2 stop bits */
617
618
619
	if (C_CSTOPB(tty)) {
		/*
		 * NOTE: Comply with "real" UARTs / RS232:
620
621
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
622
		if (C_CSIZE(tty) == CS5) {
623
			buf[4] = 1;
624
			dev_dbg(&port->dev, "stop bits = 1.5\n");
625
626
		} else {
			buf[4] = 2;
627
			dev_dbg(&port->dev, "stop bits = 2\n");
628
		}
Linus Torvalds's avatar
Linus Torvalds committed
629
630
	} else {
		buf[4] = 0;
631
		dev_dbg(&port->dev, "stop bits = 1\n");
Linus Torvalds's avatar
Linus Torvalds committed
632
633
	}

634
	if (C_PARENB(tty)) {
Linus Torvalds's avatar
Linus Torvalds committed
635
636
637
638
639
		/* For reference buf[5]=0 is none parity */
		/* For reference buf[5]=1 is odd parity */
		/* For reference buf[5]=2 is even parity */
		/* For reference buf[5]=3 is mark parity */
		/* For reference buf[5]=4 is space parity */
640
		if (C_PARODD(tty)) {
Johan Hovold's avatar
Johan Hovold committed
641
			if (C_CMSPAR(tty)) {
642
				buf[5] = 3;
643
				dev_dbg(&port->dev, "parity = mark\n");
644
645
			} else {
				buf[5] = 1;
646
				dev_dbg(&port->dev, "parity = odd\n");
647
			}
Linus Torvalds's avatar
Linus Torvalds committed
648
		} else {
Johan Hovold's avatar
Johan Hovold committed
649
			if (C_CMSPAR(tty)) {
650
				buf[5] = 4;
651
				dev_dbg(&port->dev, "parity = space\n");
652
653
			} else {
				buf[5] = 2;
654
				dev_dbg(&port->dev, "parity = even\n");
655
			}
Linus Torvalds's avatar
Linus Torvalds committed
656
657
658
		}
	} else {
		buf[5] = 0;
659
		dev_dbg(&port->dev, "parity = none\n");
Linus Torvalds's avatar
Linus Torvalds committed
660
661
	}

662
663
664
665
666
667
668
669
670
671
672
673
674
	/*
	 * Some PL2303 are known to lose bytes if you change serial settings
	 * even to the same values as before. Thus we actually need to filter
	 * in this specific case.
	 *
	 * Note that the tty_termios_hw_change check above is not sufficient
	 * as a previously requested baud rate may differ from the one
	 * actually used (and stored in old_termios).
	 *
	 * NOTE: No additional locking needed for line_settings as it is
	 *       only used in set_termios, which is serialised against itself.
	 */
	if (!old_termios || memcmp(buf, priv->line_settings, 7)) {
675
676
		ret = pl2303_set_line_request(port, buf);
		if (!ret)
677
678
			memcpy(priv->line_settings, buf, 7);
	}
Linus Torvalds's avatar
Linus Torvalds committed
679
680
681
682

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
683
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
684
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
685
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
686
687
688
689
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
690
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
691
692
693
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
694

695
	if (C_CRTSCTS(tty)) {
696
		if (spriv->quirks & PL2303_QUIRK_LEGACY)
697
			pl2303_vendor_write(serial, 0x0, 0x41);
698
699
		else
			pl2303_vendor_write(serial, 0x0, 0x61);
700
	} else if (pl2303_enable_xonxoff(tty, spriv->type)) {
701
		pl2303_vendor_write(serial, 0x0, 0xc0);
t.sefzick's avatar
t.sefzick committed
702
	} else {
703
		pl2303_vendor_write(serial, 0x0, 0x0);
Linus Torvalds's avatar
Linus Torvalds committed
704
	}
705
706
707
708

	kfree(buf);
}

709
710
711
712
713
714
715
716
717
718
719
720
721
static void pl2303_dtr_rts(struct usb_serial_port *port, int on)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;

	spin_lock_irqsave(&priv->lock, flags);
	if (on)
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	else
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
	control = priv->line_control;
	spin_unlock_irqrestore(&priv->lock, flags);
722

723
	pl2303_set_control_lines(port, control);
724
725
726
}

static void pl2303_close(struct usb_serial_port *port)
727
{
Johan Hovold's avatar
Johan Hovold committed
728
	usb_serial_generic_close(port);
729
	usb_kill_urb(port->interrupt_in_urb);
730
	pl2303_set_break(port, false);
Linus Torvalds's avatar
Linus Torvalds committed
731
732
}

733
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
734
735
{
	struct usb_serial *serial = port->serial;
736
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
737
738
	int result;

739
	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
740
741
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
742
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
743
		/* reset upstream data pipes */
744
745
		pl2303_vendor_write(serial, 8, 0);
		pl2303_vendor_write(serial, 9, 0);
Linus Torvalds's avatar
Linus Torvalds committed
746
747
748
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
749
	if (tty)
750
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
751

752
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
753
	if (result) {
754
755
		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
			result);
756
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
757
	}
758

759
	result = usb_serial_generic_open(tty, port);
760
761
762
763
764
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
765
766
767
	return 0;
}

768
static int pl2303_tiocmset(struct tty_struct *tty,
769
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
770
{
Alan Cox's avatar
Alan Cox committed
771
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
772
773
774
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
775
	int ret;
776

777
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
778
779
780
781
782
783
784
785
786
	if (set & TIOCM_RTS)
		priv->line_control |= CONTROL_RTS;
	if (set & TIOCM_DTR)
		priv->line_control |= CONTROL_DTR;
	if (clear & TIOCM_RTS)
		priv->line_control &= ~CONTROL_RTS;
	if (clear & TIOCM_DTR)
		priv->line_control &= ~CONTROL_DTR;
	control = priv->line_control;
787
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
788

789
790
791
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
792

793
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
794
795
}

796
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
797
{
Alan Cox's avatar
Alan Cox committed
798
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
799
800
801
802
803
804
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

805
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
806
807
	mcr = priv->line_control;
	status = priv->line_status;
808
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
809
810
811
812
813
814
815
816

	result = ((mcr & CONTROL_DTR)		? TIOCM_DTR : 0)
		  | ((mcr & CONTROL_RTS)	? TIOCM_RTS : 0)
		  | ((status & UART_CTS)	? TIOCM_CTS : 0)
		  | ((status & UART_DSR)	? TIOCM_DSR : 0)
		  | ((status & UART_RING)	? TIOCM_RI  : 0)
		  | ((status & UART_DCD)	? TIOCM_CD  : 0);

817
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
818
819
820
821

	return result;
}

822
823
824
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
825

826
827
	if (priv->line_status & UART_DCD)
		return 1;
828

829
830
831
	return 0;
}

Al Viro's avatar
Al Viro committed
832
833
static int pl2303_get_serial(struct tty_struct *tty,
			struct serial_struct *ss)
Linus Torvalds's avatar
Linus Torvalds committed
834
{
Alan Cox's avatar
Alan Cox committed
835
	struct usb_serial_port *port = tty->driver_data;
836

Al Viro's avatar
Al Viro committed
837
838
839
840
841
	ss->type = PORT_16654;
	ss->line = port->minor;
	ss->port = port->port_number;
	ss->baud_base = 460800;
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
842
843
}

844
static void pl2303_set_break(struct usb_serial_port *port, bool enable)
Linus Torvalds's avatar
Linus Torvalds committed
845
846
847
848
849
{
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

850
	if (enable)
Linus Torvalds's avatar
Linus Torvalds committed
851
		state = BREAK_ON;
852
853
	else
		state = BREAK_OFF;
854

855
	dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
Alan Cox's avatar
Alan Cox committed
856
			state == BREAK_OFF ? "off" : "on");
Linus Torvalds's avatar
Linus Torvalds committed
857

858
859
860
	result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
				 BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
				 0, NULL, 0, 100);
Linus Torvalds's avatar
Linus Torvalds committed
861
	if (result)
862
		dev_err(&port->dev, "error sending break = %d\n", result);
Linus Torvalds's avatar
Linus Torvalds committed
863
864
}

865
866
867
868
869
870
871
static void pl2303_break_ctl(struct tty_struct *tty, int state)
{
	struct usb_serial_port *port = tty->driver_data;

	pl2303_set_break(port, state);
}

Flavio Leitner's avatar
Flavio Leitner committed
872
873
874
875
static void pl2303_update_line_status(struct usb_serial_port *port,
				      unsigned char *data,
				      unsigned int actual_length)
{
876
877
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Flavio Leitner's avatar
Flavio Leitner committed
878
	struct pl2303_private *priv = usb_get_serial_port_data(port);
879
	struct tty_struct *tty;
Flavio Leitner's avatar
Flavio Leitner committed
880
	unsigned long flags;
881
	unsigned int status_idx = UART_STATE_INDEX;
882
883
	u8 status;
	u8 delta;
Flavio Leitner's avatar
Flavio Leitner committed
884

885
886
	if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
		status_idx = 0;
Flavio Leitner's avatar
Flavio Leitner committed
887

888
	if (actual_length < status_idx + 1)
889
		return;
Flavio Leitner's avatar
Flavio Leitner committed
890

891
892
	status = data[status_idx];

Alan Cox's avatar
Alan Cox committed
893
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
894
	spin_lock_irqsave(&priv->lock, flags);
895
896
	delta = priv->line_status ^ status;
	priv->line_status = status;
Flavio Leitner's avatar
Flavio Leitner committed
897
	spin_unlock_irqrestore(&priv->lock, flags);
898

899
	if (status & UART_BREAK_ERROR)
900
		usb_serial_handle_break(port);
901

902
	if (delta & UART_STATE_MSR_MASK) {
903
904
905
906
907
908
		if (delta & UART_CTS)
			port->icount.cts++;
		if (delta & UART_DSR)
			port->icount.dsr++;
		if (delta & UART_RING)
			port->icount.rng++;
909
		if (delta & UART_DCD) {
910
			port->icount.dcd++;
911
912
913
			tty = tty_port_tty_get(&port->port);
			if (tty) {
				usb_serial_handle_dcd_change(port, tty,
914
							status & UART_DCD);
915
916
				tty_kref_put(tty);
			}
917
		}
918
919

		wake_up_interruptible(&port->port.delta_msr_wait);
920
	}
Flavio Leitner's avatar
Flavio Leitner committed
921
}
Linus Torvalds's avatar
Linus Torvalds committed
922

923
static void pl2303_read_int_callback(struct urb *urb)
Linus Torvalds's avatar
Linus Torvalds committed
924
{
925
	struct usb_serial_port *port =  urb->context;
Linus Torvalds's avatar
Linus Torvalds committed
926
	unsigned char *data = urb->transfer_buffer;
Flavio Leitner's avatar
Flavio Leitner committed
927
	unsigned int actual_length = urb->actual_length;
928
929
	int status = urb->status;
	int retval;
Linus Torvalds's avatar
Linus Torvalds committed
930

931
	switch (status) {
Linus Torvalds's avatar
Linus Torvalds committed
932
933
934
935
936
937
938
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
939
940
		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
941
942
		return;
	default:
943
944
		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
945
946
947
		goto exit;
	}

948
	usb_serial_debug_data(&port->dev, __func__,
949
950
			      urb->actual_length, urb->transfer_buffer);

Flavio Leitner's avatar
Flavio Leitner committed
951
	pl2303_update_line_status(port, data, actual_length);
Linus Torvalds's avatar
Linus Torvalds committed
952
953

exit:
954
	retval = usb_submit_urb(urb, GFP_ATOMIC);
955
	if (retval) {
956
		dev_err(&port->dev,
957
			"%s - usb_submit_urb failed with result %d\n",
958
			__func__, retval);
959
	}
Linus Torvalds's avatar
Linus Torvalds committed
960
961
}

962
static void pl2303_process_read_urb(struct urb *urb)
963
{
964
965
	struct usb_serial_port *port = urb->context;
	struct pl2303_private *priv = usb_get_serial_port_data(port);
966
967
	unsigned char *data = urb->transfer_buffer;
	char tty_flag = TTY_NORMAL;
968
969
970
971
972
973
974
975
976
977
978
979
980
	unsigned long flags;
	u8 line_status;
	int i;

	/* update line status */
	spin_lock_irqsave(&priv->lock, flags);
	line_status = priv->line_status;
	priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
	spin_unlock_irqrestore(&priv->lock, flags);

	if (!urb->actual_length)
		return;

981
982
983
984
	/*
	 * Break takes precedence over parity, which takes precedence over
	 * framing errors.
	 */
985
986
987
988
989
990
991
	if (line_status & UART_BREAK_ERROR)
		tty_flag = TTY_BREAK;
	else if (line_status & UART_PARITY_ERROR)
		tty_flag = TTY_PARITY;
	else if (line_status & UART_FRAME_ERROR)
		tty_flag = TTY_FRAME;

992
993
994
	if (tty_flag != TTY_NORMAL)
		dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
								tty_flag);
995
996
	/* overrun is special, not associated with a char */
	if (line_status & UART_OVERRUN_ERROR)