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

103
MODULE_DEVICE_TABLE(usb, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
104
105
106
107
108
109
110
111
112
113

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

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

139
static void pl2303_set_break(struct usb_serial_port *port, bool enable);
Linus Torvalds's avatar
Linus Torvalds committed
140
141

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

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

152
struct pl2303_serial_private {
153
	const struct pl2303_type_data *type;
154
	unsigned long quirks;
155
156
};

Linus Torvalds's avatar
Linus Torvalds committed
157
158
159
160
struct pl2303_private {
	spinlock_t lock;
	u8 line_control;
	u8 line_status;
161
162

	u8 line_settings[7];
Linus Torvalds's avatar
Linus Torvalds committed
163
164
};

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

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

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

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

195
	return 0;
196
197
}

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

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

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

214
	return 0;
215
216
}

217
218
219
220
221
222
223
224
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;
}

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

240
241
242
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
	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;
271
272
273
	}

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

	return 1;
}

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

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

291
	buf = kmalloc(1, GFP_KERNEL);
292
293
	if (!buf) {
		kfree(spriv);
294
		return -ENOMEM;
295
	}
296

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

307
	spriv->type = &pl2303_type_data[type];
308
	spriv->quirks = (unsigned long)usb_get_serial_data(serial);
309
	spriv->quirks |= spriv->type->quirks;
310

311
	usb_set_serial_data(serial, spriv);
312

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

	kfree(buf);
329

Linus Torvalds's avatar
Linus Torvalds committed
330
	return 0;
331
}
Linus Torvalds's avatar
Linus Torvalds committed
332

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

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

352
353
	port->port.drain_delay = 256;

354
355
356
357
358
	return 0;
}

static int pl2303_port_remove(struct usb_serial_port *port)
{
359
	struct pl2303_private *priv = usb_get_serial_port_data(port);
360
361
362
363

	kfree(priv);

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
364
365
}

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

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

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

Linus Torvalds's avatar
Linus Torvalds committed
379
380
381
	return retval;
}

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

394
	unsigned i;
395

396
397
398
399
	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
		if (baud_sup[i] > baud)
			break;
	}
400

401
402
403
404
405
406
	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];
407

408
409
410
	return baud;
}

411
412
413
414
415
416
417
418
419
420
421
422
/*
 * 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;
}

423
424
425
static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
								speed_t baud)
{
426
	unsigned int baseline, mantissa, exponent;
427
428
429

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

451
452
	buf[3] = 0x80;
	buf[2] = 0;
453
454
455
456
457
	buf[1] = exponent << 1 | mantissa >> 8;
	buf[0] = mantissa & 0xff;

	/* Calculate and return the exact baud rate. */
	baud = (baseline / mantissa) >> (exponent << 1);
458
459
460
461

	return baud;
}

462
463
464
465
466
467
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);
468
	speed_t	baud_sup;
469
470
471
472
473
474
	speed_t baud;

	baud = tty_get_baud_rate(tty);
	dev_dbg(&port->dev, "baud requested = %u\n", baud);
	if (!baud)
		return;
475
476
477

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

483
484
	if (baud == baud_sup)
		baud = pl2303_encode_baud_rate_direct(buf, baud);
485
	else
486
		baud = pl2303_encode_baud_rate_divisor(buf, baud);
487

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

493
494
495
496
497
498
499
500
501
502
503
504
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);

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

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

	return 0;
}

535
536
537
538
539
540
541
542
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;
543
	int ret;
544
545
546
547
548
549
550
551
552
553
554
555
556
	u8 control;

	if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
		return;

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

557
	pl2303_get_line_request(port, buf);
558

559
560
561
562
563
564
565
566
567
568
569
570
571
	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;
572
	}
573
	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
574

575
	/* For reference buf[0]:buf[3] baud rate value */
576
	pl2303_encode_baud_rate(tty, port, &buf[0]);
577

Linus Torvalds's avatar
Linus Torvalds committed
578
579
580
	/* 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 */
581
582
583
	if (C_CSTOPB(tty)) {
		/*
		 * NOTE: Comply with "real" UARTs / RS232:
584
585
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
586
		if (C_CSIZE(tty) == CS5) {
587
			buf[4] = 1;
588
			dev_dbg(&port->dev, "stop bits = 1.5\n");
589
590
		} else {
			buf[4] = 2;
591
			dev_dbg(&port->dev, "stop bits = 2\n");
592
		}
Linus Torvalds's avatar
Linus Torvalds committed
593
594
	} else {
		buf[4] = 0;
595
		dev_dbg(&port->dev, "stop bits = 1\n");
Linus Torvalds's avatar
Linus Torvalds committed
596
597
	}

598
	if (C_PARENB(tty)) {
Linus Torvalds's avatar
Linus Torvalds committed
599
600
601
602
603
		/* 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 */
604
		if (C_PARODD(tty)) {
Johan Hovold's avatar
Johan Hovold committed
605
			if (C_CMSPAR(tty)) {
606
				buf[5] = 3;
607
				dev_dbg(&port->dev, "parity = mark\n");
608
609
			} else {
				buf[5] = 1;
610
				dev_dbg(&port->dev, "parity = odd\n");
611
			}
Linus Torvalds's avatar
Linus Torvalds committed
612
		} else {
Johan Hovold's avatar
Johan Hovold committed
613
			if (C_CMSPAR(tty)) {
614
				buf[5] = 4;
615
				dev_dbg(&port->dev, "parity = space\n");
616
617
			} else {
				buf[5] = 2;
618
				dev_dbg(&port->dev, "parity = even\n");
619
			}
Linus Torvalds's avatar
Linus Torvalds committed
620
621
622
		}
	} else {
		buf[5] = 0;
623
		dev_dbg(&port->dev, "parity = none\n");
Linus Torvalds's avatar
Linus Torvalds committed
624
625
	}

626
627
628
629
630
631
632
633
634
635
636
637
638
	/*
	 * 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)) {
639
640
		ret = pl2303_set_line_request(port, buf);
		if (!ret)
641
642
			memcpy(priv->line_settings, buf, 7);
	}
Linus Torvalds's avatar
Linus Torvalds committed
643
644
645
646

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
647
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
648
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
649
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
650
651
652
653
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
654
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
655
656
657
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
658

659
	if (C_CRTSCTS(tty)) {
660
		if (spriv->quirks & PL2303_QUIRK_LEGACY)
661
			pl2303_vendor_write(serial, 0x0, 0x41);
662
663
		else
			pl2303_vendor_write(serial, 0x0, 0x61);
t.sefzick's avatar
t.sefzick committed
664
	} else {
665
		pl2303_vendor_write(serial, 0x0, 0x0);
Linus Torvalds's avatar
Linus Torvalds committed
666
	}
667
668
669
670

	kfree(buf);
}

671
672
673
674
675
676
677
678
679
680
681
682
683
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);
684

685
	pl2303_set_control_lines(port, control);
686
687
688
}

static void pl2303_close(struct usb_serial_port *port)
689
{
Johan Hovold's avatar
Johan Hovold committed
690
	usb_serial_generic_close(port);
691
	usb_kill_urb(port->interrupt_in_urb);
692
	pl2303_set_break(port, false);
Linus Torvalds's avatar
Linus Torvalds committed
693
694
}

695
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
696
697
{
	struct usb_serial *serial = port->serial;
698
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
699
700
	int result;

701
	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
702
703
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
704
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
705
		/* reset upstream data pipes */
706
707
		pl2303_vendor_write(serial, 8, 0);
		pl2303_vendor_write(serial, 9, 0);
Linus Torvalds's avatar
Linus Torvalds committed
708
709
710
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
711
	if (tty)
712
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
713

714
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
715
	if (result) {
716
717
		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
			result);
718
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
719
	}
720

721
	result = usb_serial_generic_open(tty, port);
722
723
724
725
726
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
727
728
729
	return 0;
}

730
static int pl2303_tiocmset(struct tty_struct *tty,
731
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
732
{
Alan Cox's avatar
Alan Cox committed
733
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
734
735
736
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
737
	int ret;
738

739
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
740
741
742
743
744
745
746
747
748
	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;
749
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
750

751
752
753
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
754

755
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
756
757
}

758
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
759
{
Alan Cox's avatar
Alan Cox committed
760
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
761
762
763
764
765
766
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

767
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
768
769
	mcr = priv->line_control;
	status = priv->line_status;
770
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
771
772
773
774
775
776
777
778

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

779
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
780
781
782
783

	return result;
}

784
785
786
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
787

788
789
	if (priv->line_status & UART_DCD)
		return 1;
790

791
792
793
	return 0;
}

794
static int pl2303_ioctl(struct tty_struct *tty,
795
			unsigned int cmd, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
796
{
797
	struct serial_struct ser;
Alan Cox's avatar
Alan Cox committed
798
	struct usb_serial_port *port = tty->driver_data;
799

Linus Torvalds's avatar
Linus Torvalds committed
800
	switch (cmd) {
801
802
803
	case TIOCGSERIAL:
		memset(&ser, 0, sizeof ser);
		ser.type = PORT_16654;
804
		ser.line = port->minor;
805
		ser.port = port->port_number;
806
807
808
809
810
811
		ser.baud_base = 460800;

		if (copy_to_user((void __user *)arg, &ser, sizeof ser))
			return -EFAULT;

		return 0;
Alan Cox's avatar
Alan Cox committed
812
813
	default:
		break;
Linus Torvalds's avatar
Linus Torvalds committed
814
	}
815

Linus Torvalds's avatar
Linus Torvalds committed
816
817
818
	return -ENOIOCTLCMD;
}

819
static void pl2303_set_break(struct usb_serial_port *port, bool enable)
Linus Torvalds's avatar
Linus Torvalds committed
820
821
822
823
824
{
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

825
	if (enable)
Linus Torvalds's avatar
Linus Torvalds committed
826
		state = BREAK_ON;
827
828
	else
		state = BREAK_OFF;
829

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

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

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

860
861
	if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
		status_idx = 0;
Flavio Leitner's avatar
Flavio Leitner committed
862

863
	if (actual_length < status_idx + 1)
864
		return;
Flavio Leitner's avatar
Flavio Leitner committed
865

866
867
	status = data[status_idx];

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

874
	if (status & UART_BREAK_ERROR)
875
		usb_serial_handle_break(port);
876

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

		wake_up_interruptible(&port->port.delta_msr_wait);
895
	}
Flavio Leitner's avatar
Flavio Leitner committed
896
}
Linus Torvalds's avatar
Linus Torvalds committed
897

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

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

923
	usb_serial_debug_data(&port->dev, __func__,
924
925
			      urb->actual_length, urb->transfer_buffer);

Flavio Leitner's avatar
Flavio Leitner committed
926
	pl2303_update_line_status(port, data, actual_length);
Linus Torvalds's avatar
Linus Torvalds committed
927
928

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

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

956
957
958
959
	/*
	 * Break takes precedence over parity, which takes precedence over
	 * framing errors.
	 */
960
961
962
963
964
965
966
	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;

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

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

Jiri Slaby's avatar
Jiri Slaby committed
984
	tty_flip_buffer_push(&port->port);
Linus Torvalds's avatar
Linus Torvalds committed
985
986
}

987
988
989
990