pl2303.c 27.1 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) },
Linus Torvalds's avatar
Linus Torvalds committed
49
	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
50
	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
51
52
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
53
54
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC485),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
55
56
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC232B),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
57
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID2) },
Linus Torvalds's avatar
Linus Torvalds committed
58
59
60
61
	{ 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) },
62
	{ USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
Linus Torvalds's avatar
Linus Torvalds committed
63
64
65
66
67
68
69
	{ 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) },
70
71
72
73
74
75
	{ 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 },
76
77
	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
78
	{ USB_DEVICE(BENQ_VENDOR_ID, BENQ_PRODUCT_ID_S81) }, /* Benq/Siemens S81 */
79
	{ USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
80
81
	{ USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
	{ USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
82
	{ USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
83
	{ USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
84
	{ USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
85
	{ USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
86
	{ USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
87
88
	{ USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
89
	{ USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
90
	{ USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
91
	{ USB_DEVICE(YCCABLE_VENDOR_ID, YCCABLE_PRODUCT_ID) },
Matthew Arnold's avatar
Matthew Arnold committed
92
	{ USB_DEVICE(SUPERIAL_VENDOR_ID, SUPERIAL_PRODUCT_ID) },
93
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD220_PRODUCT_ID) },
94
95
96
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD960_PRODUCT_ID) },
	{ USB_DEVICE(HP_VENDOR_ID, HP_LCM220_PRODUCT_ID) },
	{ USB_DEVICE(HP_VENDOR_ID, HP_LCM960_PRODUCT_ID) },
97
	{ USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
98
	{ USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
99
	{ USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
100
	{ USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
101
	{ USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
102
	{ USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
Linus Torvalds's avatar
Linus Torvalds committed
103
104
105
	{ }					/* Terminating entry */
};

106
MODULE_DEVICE_TABLE(usb, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
107
108
109
110
111
112
113
114
115
116

#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
117
#define BREAK_REQUEST			0x23
Linus Torvalds's avatar
Linus Torvalds committed
118
119
120
121
122
123
124
125
126
127
128
129
#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

130
#define UART_STATE_INDEX		8
131
#define UART_STATE_MSR_MASK		0x8b
Linus Torvalds's avatar
Linus Torvalds committed
132
133
134
135
136
137
138
139
140
141
#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

142
static void pl2303_set_break(struct usb_serial_port *port, bool enable);
Linus Torvalds's avatar
Linus Torvalds committed
143
144

enum pl2303_type {
145
146
	TYPE_01,	/* Type 0 and 1 (difference unknown) */
	TYPE_HX,	/* HX version of the pl2303 chip */
147
148
149
150
151
152
	TYPE_COUNT
};

struct pl2303_type_data {
	speed_t max_baud_rate;
	unsigned long quirks;
Linus Torvalds's avatar
Linus Torvalds committed
153
154
};

155
struct pl2303_serial_private {
156
	const struct pl2303_type_data *type;
157
	unsigned long quirks;
158
159
};

Linus Torvalds's avatar
Linus Torvalds committed
160
161
162
163
struct pl2303_private {
	spinlock_t lock;
	u8 line_control;
	u8 line_status;
164
165

	u8 line_settings[7];
Linus Torvalds's avatar
Linus Torvalds committed
166
167
};

168
static const struct pl2303_type_data pl2303_type_data[TYPE_COUNT] = {
169
170
171
172
	[TYPE_01] = {
		.max_baud_rate =	1228800,
		.quirks =		PL2303_QUIRK_LEGACY,
	},
173
174
175
	[TYPE_HX] = {
		.max_baud_rate =	12000000,
	},
176
177
};

178
179
static int pl2303_vendor_read(struct usb_serial *serial, u16 value,
							unsigned char buf[1])
180
{
181
	struct device *dev = &serial->interface->dev;
182
183
184
	int res;

	res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
185
			VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
186
187
188
189
190
191
192
193
194
			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;
	}
195

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

198
	return 0;
199
200
}

201
static int pl2303_vendor_write(struct usb_serial *serial, u16 value, u16 index)
202
{
203
	struct device *dev = &serial->interface->dev;
204
205
	int res;

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

208
	res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
209
210
			VENDOR_WRITE_REQUEST, VENDOR_WRITE_REQUEST_TYPE,
			value, index, NULL, 0, 100);
211
212
213
214
215
	if (res) {
		dev_err(dev, "%s - failed to write [%04x]: %d\n", __func__,
								value, res);
		return res;
	}
216

217
	return 0;
218
219
}

220
221
222
223
224
225
226
227
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;
}

228
229
230
231
232
233
/*
 * 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,
234
235
236
237
238
239
240
241
242
					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;

243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
	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;
274
275
276
	}

	if (epds->num_interrupt_in < 1) {
277
		dev_err(dev, "required interrupt-in endpoint missing\n");
278
279
280
281
282
283
		return -ENODEV;
	}

	return 1;
}

284
static int pl2303_startup(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
285
{
286
	struct pl2303_serial_private *spriv;
287
	enum pl2303_type type = TYPE_01;
288
	unsigned char *buf;
289
290
291
292

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

294
	buf = kmalloc(1, GFP_KERNEL);
295
296
	if (!buf) {
		kfree(spriv);
297
		return -ENOMEM;
298
	}
299

300
	if (serial->dev->descriptor.bDeviceClass == 0x02)
301
		type = TYPE_01;		/* type 0 */
302
	else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
303
		type = TYPE_HX;
304
	else if (serial->dev->descriptor.bDeviceClass == 0x00)
305
		type = TYPE_01;		/* type 1 */
306
	else if (serial->dev->descriptor.bDeviceClass == 0xFF)
307
		type = TYPE_01;		/* type 1 */
308
	dev_dbg(&serial->interface->dev, "device type: %d\n", type);
Linus Torvalds's avatar
Linus Torvalds committed
309

310
	spriv->type = &pl2303_type_data[type];
311
	spriv->quirks = (unsigned long)usb_get_serial_data(serial);
312
	spriv->quirks |= spriv->type->quirks;
313

314
	usb_set_serial_data(serial, spriv);
315

316
317
318
319
320
321
322
323
324
325
	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);
326
	if (spriv->quirks & PL2303_QUIRK_LEGACY)
327
		pl2303_vendor_write(serial, 2, 0x24);
328
329
	else
		pl2303_vendor_write(serial, 2, 0x44);
330
331

	kfree(buf);
332

Linus Torvalds's avatar
Linus Torvalds committed
333
	return 0;
334
}
Linus Torvalds's avatar
Linus Torvalds committed
335

336
337
static void pl2303_release(struct usb_serial *serial)
{
338
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354

	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);

355
356
	port->port.drain_delay = 256;

357
358
359
360
361
	return 0;
}

static int pl2303_port_remove(struct usb_serial_port *port)
{
362
	struct pl2303_private *priv = usb_get_serial_port_data(port);
363
364
365
366

	kfree(priv);

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
367
368
}

369
static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
Linus Torvalds's avatar
Linus Torvalds committed
370
{
371
	struct usb_device *dev = port->serial->dev;
Linus Torvalds's avatar
Linus Torvalds committed
372
	int retval;
Alan Cox's avatar
Alan Cox committed
373

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

376
377
378
	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
				 value, 0, NULL, 0, 100);
379
380
	if (retval)
		dev_err(&port->dev, "%s - failed: %d\n", __func__, retval);
381

Linus Torvalds's avatar
Linus Torvalds committed
382
383
384
	return retval;
}

385
/*
386
387
 * Returns the nearest supported baud rate that can be set directly without
 * using divisors.
388
389
 */
static speed_t pl2303_get_supported_baud_rate(speed_t baud)
Linus Torvalds's avatar
Linus Torvalds committed
390
{
391
392
393
	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,
394
		614400, 921600, 1228800, 2457600, 3000000, 6000000
395
	};
Linus Torvalds's avatar
Linus Torvalds committed
396

397
	unsigned i;
398

399
400
401
402
	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
		if (baud_sup[i] > baud)
			break;
	}
403

404
405
406
407
408
409
	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];
410

411
412
413
	return baud;
}

414
415
416
417
418
419
420
421
422
423
424
425
/*
 * 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;
}

426
427
428
static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
								speed_t baud)
{
429
	unsigned int baseline, mantissa, exponent;
430
431
432

	/*
	 * Apparently the formula is:
433
434
435
436
	 *   baudrate = 12M * 32 / (mantissa * 4^exponent)
	 * where
	 *   mantissa = buf[8:0]
	 *   exponent = buf[11:9]
437
	 */
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
	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;
		}
	}

454
455
	buf[3] = 0x80;
	buf[2] = 0;
456
457
458
459
460
	buf[1] = exponent << 1 | mantissa >> 8;
	buf[0] = mantissa & 0xff;

	/* Calculate and return the exact baud rate. */
	baud = (baseline / mantissa) >> (exponent << 1);
461
462
463
464

	return baud;
}

465
466
467
468
469
470
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);
471
	speed_t	baud_sup;
472
473
474
475
476
477
	speed_t baud;

	baud = tty_get_baud_rate(tty);
	dev_dbg(&port->dev, "baud requested = %u\n", baud);
	if (!baud)
		return;
478
479
480

	if (spriv->type->max_baud_rate)
		baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
481
	/*
482
	 * Use direct method for supported baud rates, otherwise use divisors.
483
484
	 */
	baud_sup = pl2303_get_supported_baud_rate(baud);
485

486
487
	if (baud == baud_sup)
		baud = pl2303_encode_baud_rate_direct(buf, baud);
488
	else
489
		baud = pl2303_encode_baud_rate_divisor(buf, baud);
490

491
	/* Save resulting baud rate */
492
	tty_encode_baud_rate(tty, baud, baud);
493
	dev_dbg(&port->dev, "baud set = %u\n", baud);
494
495
}

496
497
498
499
500
501
502
503
504
505
506
507
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);

508
		if (ret >= 0)
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
			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);
528
	if (ret < 0) {
529
530
531
532
533
534
535
536
537
		dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
		return ret;
	}

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

	return 0;
}

538
539
540
541
542
543
544
545
546
547
548
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;
}

549
550
551
552
553
554
555
556
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;
557
	int ret;
558
559
	u8 control;

560
	if (old_termios && !pl2303_termios_change(&tty->termios, old_termios))
561
562
563
564
565
566
567
568
569
570
		return;

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

571
	pl2303_get_line_request(port, buf);
572

573
574
575
576
577
578
579
580
581
582
583
584
585
	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;
586
	}
587
	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
588

589
	/* For reference buf[0]:buf[3] baud rate value */
590
	pl2303_encode_baud_rate(tty, port, &buf[0]);
591

Linus Torvalds's avatar
Linus Torvalds committed
592
593
594
	/* 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 */
595
596
597
	if (C_CSTOPB(tty)) {
		/*
		 * NOTE: Comply with "real" UARTs / RS232:
598
599
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
600
		if (C_CSIZE(tty) == CS5) {
601
			buf[4] = 1;
602
			dev_dbg(&port->dev, "stop bits = 1.5\n");
603
604
		} else {
			buf[4] = 2;
605
			dev_dbg(&port->dev, "stop bits = 2\n");
606
		}
Linus Torvalds's avatar
Linus Torvalds committed
607
608
	} else {
		buf[4] = 0;
609
		dev_dbg(&port->dev, "stop bits = 1\n");
Linus Torvalds's avatar
Linus Torvalds committed
610
611
	}

612
	if (C_PARENB(tty)) {
Linus Torvalds's avatar
Linus Torvalds committed
613
614
615
616
617
		/* 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 */
618
		if (C_PARODD(tty)) {
Johan Hovold's avatar
Johan Hovold committed
619
			if (C_CMSPAR(tty)) {
620
				buf[5] = 3;
621
				dev_dbg(&port->dev, "parity = mark\n");
622
623
			} else {
				buf[5] = 1;
624
				dev_dbg(&port->dev, "parity = odd\n");
625
			}
Linus Torvalds's avatar
Linus Torvalds committed
626
		} else {
Johan Hovold's avatar
Johan Hovold committed
627
			if (C_CMSPAR(tty)) {
628
				buf[5] = 4;
629
				dev_dbg(&port->dev, "parity = space\n");
630
631
			} else {
				buf[5] = 2;
632
				dev_dbg(&port->dev, "parity = even\n");
633
			}
Linus Torvalds's avatar
Linus Torvalds committed
634
635
636
		}
	} else {
		buf[5] = 0;
637
		dev_dbg(&port->dev, "parity = none\n");
Linus Torvalds's avatar
Linus Torvalds committed
638
639
	}

640
641
642
643
644
645
646
647
648
649
650
651
652
	/*
	 * 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)) {
653
654
		ret = pl2303_set_line_request(port, buf);
		if (!ret)
655
656
			memcpy(priv->line_settings, buf, 7);
	}
Linus Torvalds's avatar
Linus Torvalds committed
657
658
659
660

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
661
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
662
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
663
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
664
665
666
667
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
668
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
669
670
671
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
672

673
	if (C_CRTSCTS(tty)) {
674
		if (spriv->quirks & PL2303_QUIRK_LEGACY)
675
			pl2303_vendor_write(serial, 0x0, 0x41);
676
677
		else
			pl2303_vendor_write(serial, 0x0, 0x61);
678
679
680
	} else if (I_IXON(tty) && !I_IXANY(tty) && START_CHAR(tty) == 0x11 &&
			STOP_CHAR(tty) == 0x13) {
		pl2303_vendor_write(serial, 0x0, 0xc0);
t.sefzick's avatar
t.sefzick committed
681
	} else {
682
		pl2303_vendor_write(serial, 0x0, 0x0);
Linus Torvalds's avatar
Linus Torvalds committed
683
	}
684
685
686
687

	kfree(buf);
}

688
689
690
691
692
693
694
695
696
697
698
699
700
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);
701

702
	pl2303_set_control_lines(port, control);
703
704
705
}

static void pl2303_close(struct usb_serial_port *port)
706
{
Johan Hovold's avatar
Johan Hovold committed
707
	usb_serial_generic_close(port);
708
	usb_kill_urb(port->interrupt_in_urb);
709
	pl2303_set_break(port, false);
Linus Torvalds's avatar
Linus Torvalds committed
710
711
}

712
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
713
714
{
	struct usb_serial *serial = port->serial;
715
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
716
717
	int result;

718
	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
719
720
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
721
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
722
		/* reset upstream data pipes */
723
724
		pl2303_vendor_write(serial, 8, 0);
		pl2303_vendor_write(serial, 9, 0);
Linus Torvalds's avatar
Linus Torvalds committed
725
726
727
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
728
	if (tty)
729
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
730

731
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
732
	if (result) {
733
734
		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
			result);
735
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
736
	}
737

738
	result = usb_serial_generic_open(tty, port);
739
740
741
742
743
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
744
745
746
	return 0;
}

747
static int pl2303_tiocmset(struct tty_struct *tty,
748
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
749
{
Alan Cox's avatar
Alan Cox committed
750
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
751
752
753
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
754
	int ret;
755

756
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
757
758
759
760
761
762
763
764
765
	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;
766
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
767

768
769
770
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
771

772
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
773
774
}

775
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
776
{
Alan Cox's avatar
Alan Cox committed
777
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
778
779
780
781
782
783
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

784
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
785
786
	mcr = priv->line_control;
	status = priv->line_status;
787
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
788
789
790
791
792
793
794
795

	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);

796
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
797
798
799
800

	return result;
}

801
802
803
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
804

805
806
	if (priv->line_status & UART_DCD)
		return 1;
807

808
809
810
	return 0;
}

Al Viro's avatar
Al Viro committed
811
812
static int pl2303_get_serial(struct tty_struct *tty,
			struct serial_struct *ss)
Linus Torvalds's avatar
Linus Torvalds committed
813
{
Alan Cox's avatar
Alan Cox committed
814
	struct usb_serial_port *port = tty->driver_data;
815

Al Viro's avatar
Al Viro committed
816
817
818
819
820
	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
821
822
}

823
static void pl2303_set_break(struct usb_serial_port *port, bool enable)
Linus Torvalds's avatar
Linus Torvalds committed
824
825
826
827
828
{
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

829
	if (enable)
Linus Torvalds's avatar
Linus Torvalds committed
830
		state = BREAK_ON;
831
832
	else
		state = BREAK_OFF;
833

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

837
838
839
	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
840
	if (result)
841
		dev_err(&port->dev, "error sending break = %d\n", result);
Linus Torvalds's avatar
Linus Torvalds committed
842
843
}

844
845
846
847
848
849
850
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
851
852
853
854
static void pl2303_update_line_status(struct usb_serial_port *port,
				      unsigned char *data,
				      unsigned int actual_length)
{
855
856
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Flavio Leitner's avatar
Flavio Leitner committed
857
	struct pl2303_private *priv = usb_get_serial_port_data(port);
858
	struct tty_struct *tty;
Flavio Leitner's avatar
Flavio Leitner committed
859
	unsigned long flags;
860
	unsigned int status_idx = UART_STATE_INDEX;
861
862
	u8 status;
	u8 delta;
Flavio Leitner's avatar
Flavio Leitner committed
863

864
865
	if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
		status_idx = 0;
Flavio Leitner's avatar
Flavio Leitner committed
866

867
	if (actual_length < status_idx + 1)
868
		return;
Flavio Leitner's avatar
Flavio Leitner committed
869

870
871
	status = data[status_idx];

Alan Cox's avatar
Alan Cox committed
872
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
873
	spin_lock_irqsave(&priv->lock, flags);
874
875
	delta = priv->line_status ^ status;
	priv->line_status = status;
Flavio Leitner's avatar
Flavio Leitner committed
876
	spin_unlock_irqrestore(&priv->lock, flags);
877

878
	if (status & UART_BREAK_ERROR)
879
		usb_serial_handle_break(port);
880

881
	if (delta & UART_STATE_MSR_MASK) {
882
883
884
885
886
887
		if (delta & UART_CTS)
			port->icount.cts++;
		if (delta & UART_DSR)
			port->icount.dsr++;
		if (delta & UART_RING)
			port->icount.rng++;
888
		if (delta & UART_DCD) {
889
			port->icount.dcd++;
890
891
892
			tty = tty_port_tty_get(&port->port);
			if (tty) {
				usb_serial_handle_dcd_change(port, tty,
893
							status & UART_DCD);
894
895
				tty_kref_put(tty);
			}
896
		}
897
898

		wake_up_interruptible(&port->port.delta_msr_wait);
899
	}
Flavio Leitner's avatar
Flavio Leitner committed
900
}
Linus Torvalds's avatar
Linus Torvalds committed
901

902
static void pl2303_read_int_callback(struct urb *urb)
Linus Torvalds's avatar
Linus Torvalds committed
903
{
904
	struct usb_serial_port *port =  urb->context;
Linus Torvalds's avatar
Linus Torvalds committed
905
	unsigned char *data = urb->transfer_buffer;
Flavio Leitner's avatar
Flavio Leitner committed
906
	unsigned int actual_length = urb->actual_length;
907
908
	int status = urb->status;
	int retval;
Linus Torvalds's avatar
Linus Torvalds committed
909

910
	switch (status) {
Linus Torvalds's avatar
Linus Torvalds committed
911
912
913
914
915
916
917
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
918
919
		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
920
921
		return;
	default:
922
923
		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
924
925
926
		goto exit;
	}

927
	usb_serial_debug_data(&port->dev, __func__,
928
929
			      urb->actual_length, urb->transfer_buffer);

Flavio Leitner's avatar
Flavio Leitner committed
930
	pl2303_update_line_status(port, data, actual_length);
Linus Torvalds's avatar
Linus Torvalds committed
931
932

exit:
933
	retval = usb_submit_urb(urb, GFP_ATOMIC);
934
	if (retval) {
935
		dev_err(&port->dev,
936
			"%s - usb_submit_urb failed with result %d\n",
937
			__func__, retval);
938
	}
Linus Torvalds's avatar
Linus Torvalds committed
939
940
}

941
static void pl2303_process_read_urb(struct urb *urb)
942
{
943
944
	struct usb_serial_port *port = urb->context;
	struct pl2303_private *priv = usb_get_serial_port_data(port);
945
946
	unsigned char *data = urb->transfer_buffer;
	char tty_flag = TTY_NORMAL;
947
948
949
950
951
952
953
954
955
956
957
958
959
	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;

960
961
962
963
	/*
	 * Break takes precedence over parity, which takes precedence over
	 * framing errors.
	 */
964
965
966
967
968
969
970
	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;

971
972
973
	if (tty_flag != TTY_NORMAL)
		dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
								tty_flag);
974
975
	/* overrun is special, not associated with a char */
	if (line_status & UART_OVERRUN_ERROR)
Jiri Slaby's avatar
Jiri Slaby committed
976
		tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
977

978
	if (port->port.console && port->sysrq) {
979
		for (i = 0; i < urb->actual_length; ++i)
980
			if (!usb_serial_handle_sysrq_char(port, data[i]))
Jiri Slaby's avatar
Jiri Slaby committed
981
982
				tty_insert_flip_char(&port->port, data[i],
						tty_flag);
983
	} else {
984
		tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
985
							urb->actual_length);
986
	}
Linus Torvalds's avatar
Linus Torvalds committed
987

Jiri Slaby's avatar
Jiri Slaby committed
988
	tty_flip_buffer_push(&port->port);
Linus Torvalds's avatar
Linus Torvalds committed
989
990
}

99