pl2303.c 28.2 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
149
#define PL2303_FLOWCTRL_MASK		0xf0

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

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

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

164
struct pl2303_serial_private {
165
	const struct pl2303_type_data *type;
166
	unsigned long quirks;
167
168
};

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

	u8 line_settings[7];
Linus Torvalds's avatar
Linus Torvalds committed
175
176
};

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

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

	res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
195
			VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
196
197
198
199
200
201
202
203
204
			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;
	}
205

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

208
	return 0;
209
210
}

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

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

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

227
	return 0;
228
229
}

230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
static int pl2303_update_reg(struct usb_serial *serial, u8 reg, u8 mask, u8 val)
{
	int ret = 0;
	u8 *buf;

	buf = kmalloc(1, GFP_KERNEL);
	if (!buf)
		return -ENOMEM;

	ret = pl2303_vendor_read(serial, reg | 0x80, buf);
	if (ret)
		goto out_free;

	*buf &= ~mask;
	*buf |= val & mask;

	ret = pl2303_vendor_write(serial, reg, *buf);
out_free:
	kfree(buf);

	return ret;
}

253
254
255
256
257
258
259
260
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;
}

261
262
263
264
265
266
/*
 * 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,
267
268
269
270
271
272
273
274
275
					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;

276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
	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;
307
308
309
	}

	if (epds->num_interrupt_in < 1) {
310
		dev_err(dev, "required interrupt-in endpoint missing\n");
311
312
313
314
315
316
		return -ENODEV;
	}

	return 1;
}

317
static int pl2303_startup(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
318
{
319
	struct pl2303_serial_private *spriv;
320
	enum pl2303_type type = TYPE_01;
321
	unsigned char *buf;
322
323
324
325

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

327
	buf = kmalloc(1, GFP_KERNEL);
328
329
	if (!buf) {
		kfree(spriv);
330
		return -ENOMEM;
331
	}
332

333
	if (serial->dev->descriptor.bDeviceClass == 0x02)
334
		type = TYPE_01;		/* type 0 */
335
	else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
336
		type = TYPE_HX;
337
	else if (serial->dev->descriptor.bDeviceClass == 0x00)
338
		type = TYPE_01;		/* type 1 */
339
	else if (serial->dev->descriptor.bDeviceClass == 0xFF)
340
		type = TYPE_01;		/* type 1 */
341
	dev_dbg(&serial->interface->dev, "device type: %d\n", type);
Linus Torvalds's avatar
Linus Torvalds committed
342

343
	spriv->type = &pl2303_type_data[type];
344
	spriv->quirks = (unsigned long)usb_get_serial_data(serial);
345
	spriv->quirks |= spriv->type->quirks;
346

347
	usb_set_serial_data(serial, spriv);
348

349
350
351
352
353
354
355
356
357
358
	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);
359
	if (spriv->quirks & PL2303_QUIRK_LEGACY)
360
		pl2303_vendor_write(serial, 2, 0x24);
361
362
	else
		pl2303_vendor_write(serial, 2, 0x44);
363
364

	kfree(buf);
365

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

369
370
static void pl2303_release(struct usb_serial *serial)
{
371
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387

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

388
389
	port->port.drain_delay = 256;

390
391
392
393
394
	return 0;
}

static int pl2303_port_remove(struct usb_serial_port *port)
{
395
	struct pl2303_private *priv = usb_get_serial_port_data(port);
396
397
398
399

	kfree(priv);

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
400
401
}

402
static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
Linus Torvalds's avatar
Linus Torvalds committed
403
{
404
	struct usb_device *dev = port->serial->dev;
Linus Torvalds's avatar
Linus Torvalds committed
405
	int retval;
Alan Cox's avatar
Alan Cox committed
406

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

409
410
411
	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
				 value, 0, NULL, 0, 100);
412
413
	if (retval)
		dev_err(&port->dev, "%s - failed: %d\n", __func__, retval);
414

Linus Torvalds's avatar
Linus Torvalds committed
415
416
417
	return retval;
}

418
/*
419
420
 * Returns the nearest supported baud rate that can be set directly without
 * using divisors.
421
422
 */
static speed_t pl2303_get_supported_baud_rate(speed_t baud)
Linus Torvalds's avatar
Linus Torvalds committed
423
{
424
425
426
	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,
427
		614400, 921600, 1228800, 2457600, 3000000, 6000000
428
	};
Linus Torvalds's avatar
Linus Torvalds committed
429

430
	unsigned i;
431

432
433
434
435
	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
		if (baud_sup[i] > baud)
			break;
	}
436

437
438
439
440
441
442
	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];
443

444
445
446
	return baud;
}

447
448
449
450
451
452
453
454
455
456
457
458
/*
 * 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;
}

459
460
461
static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
								speed_t baud)
{
462
	unsigned int baseline, mantissa, exponent;
463
464
465

	/*
	 * Apparently the formula is:
466
467
468
469
	 *   baudrate = 12M * 32 / (mantissa * 4^exponent)
	 * where
	 *   mantissa = buf[8:0]
	 *   exponent = buf[11:9]
470
	 */
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
	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;
		}
	}

487
488
	buf[3] = 0x80;
	buf[2] = 0;
489
490
491
492
493
	buf[1] = exponent << 1 | mantissa >> 8;
	buf[0] = mantissa & 0xff;

	/* Calculate and return the exact baud rate. */
	baud = (baseline / mantissa) >> (exponent << 1);
494
495
496
497

	return baud;
}

498
499
500
501
502
503
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);
504
	speed_t	baud_sup;
505
506
507
508
509
510
	speed_t baud;

	baud = tty_get_baud_rate(tty);
	dev_dbg(&port->dev, "baud requested = %u\n", baud);
	if (!baud)
		return;
511
512
513

	if (spriv->type->max_baud_rate)
		baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
514
	/*
515
	 * Use direct method for supported baud rates, otherwise use divisors.
516
517
	 */
	baud_sup = pl2303_get_supported_baud_rate(baud);
518

519
520
	if (baud == baud_sup)
		baud = pl2303_encode_baud_rate_direct(buf, baud);
521
	else
522
		baud = pl2303_encode_baud_rate_divisor(buf, baud);
523

524
	/* Save resulting baud rate */
525
	tty_encode_baud_rate(tty, baud, baud);
526
	dev_dbg(&port->dev, "baud set = %u\n", baud);
527
528
}

529
530
531
532
533
534
535
536
537
538
539
540
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);

541
		if (ret >= 0)
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
			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);
561
	if (ret < 0) {
562
563
564
565
566
567
568
569
570
		dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
		return ret;
	}

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

	return 0;
}

571
572
573
574
575
576
577
578
579
580
581
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;
}

582
583
584
585
586
587
588
589
590
591
592
593
594
595
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;
}

596
597
598
599
600
601
602
603
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;
604
	int ret;
605
606
	u8 control;

607
	if (old_termios && !pl2303_termios_change(&tty->termios, old_termios))
608
609
610
611
612
613
614
615
616
617
		return;

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

618
	pl2303_get_line_request(port, buf);
619

620
621
622
623
624
625
626
627
628
629
630
631
632
	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;
633
	}
634
	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
635

636
	/* For reference buf[0]:buf[3] baud rate value */
637
	pl2303_encode_baud_rate(tty, port, &buf[0]);
638

Linus Torvalds's avatar
Linus Torvalds committed
639
640
641
	/* 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 */
642
643
644
	if (C_CSTOPB(tty)) {
		/*
		 * NOTE: Comply with "real" UARTs / RS232:
645
646
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
647
		if (C_CSIZE(tty) == CS5) {
648
			buf[4] = 1;
649
			dev_dbg(&port->dev, "stop bits = 1.5\n");
650
651
		} else {
			buf[4] = 2;
652
			dev_dbg(&port->dev, "stop bits = 2\n");
653
		}
Linus Torvalds's avatar
Linus Torvalds committed
654
655
	} else {
		buf[4] = 0;
656
		dev_dbg(&port->dev, "stop bits = 1\n");
Linus Torvalds's avatar
Linus Torvalds committed
657
658
	}

659
	if (C_PARENB(tty)) {
Linus Torvalds's avatar
Linus Torvalds committed
660
661
662
663
664
		/* 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 */
665
		if (C_PARODD(tty)) {
Johan Hovold's avatar
Johan Hovold committed
666
			if (C_CMSPAR(tty)) {
667
				buf[5] = 3;
668
				dev_dbg(&port->dev, "parity = mark\n");
669
670
			} else {
				buf[5] = 1;
671
				dev_dbg(&port->dev, "parity = odd\n");
672
			}
Linus Torvalds's avatar
Linus Torvalds committed
673
		} else {
Johan Hovold's avatar
Johan Hovold committed
674
			if (C_CMSPAR(tty)) {
675
				buf[5] = 4;
676
				dev_dbg(&port->dev, "parity = space\n");
677
678
			} else {
				buf[5] = 2;
679
				dev_dbg(&port->dev, "parity = even\n");
680
			}
Linus Torvalds's avatar
Linus Torvalds committed
681
682
683
		}
	} else {
		buf[5] = 0;
684
		dev_dbg(&port->dev, "parity = none\n");
Linus Torvalds's avatar
Linus Torvalds committed
685
686
	}

687
688
689
690
691
692
693
694
695
696
697
698
699
	/*
	 * 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)) {
700
701
		ret = pl2303_set_line_request(port, buf);
		if (!ret)
702
703
			memcpy(priv->line_settings, buf, 7);
	}
Linus Torvalds's avatar
Linus Torvalds committed
704
705
706
707

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
708
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
709
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
710
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
711
712
713
714
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
715
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
716
717
718
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
719

720
	if (C_CRTSCTS(tty)) {
721
		if (spriv->quirks & PL2303_QUIRK_LEGACY)
722
			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0x40);
723
		else
724
			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0x60);
725
	} else if (pl2303_enable_xonxoff(tty, spriv->type)) {
726
		pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0xc0);
t.sefzick's avatar
t.sefzick committed
727
	} else {
728
		pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0);
Linus Torvalds's avatar
Linus Torvalds committed
729
	}
730
731
732
733

	kfree(buf);
}

734
735
736
737
738
739
740
741
742
743
744
745
746
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);
747

748
	pl2303_set_control_lines(port, control);
749
750
751
}

static void pl2303_close(struct usb_serial_port *port)
752
{
Johan Hovold's avatar
Johan Hovold committed
753
	usb_serial_generic_close(port);
754
	usb_kill_urb(port->interrupt_in_urb);
755
	pl2303_set_break(port, false);
Linus Torvalds's avatar
Linus Torvalds committed
756
757
}

758
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
759
760
{
	struct usb_serial *serial = port->serial;
761
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
762
763
	int result;

764
	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
765
766
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
767
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
768
		/* reset upstream data pipes */
769
770
		pl2303_vendor_write(serial, 8, 0);
		pl2303_vendor_write(serial, 9, 0);
Linus Torvalds's avatar
Linus Torvalds committed
771
772
773
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
774
	if (tty)
775
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
776

777
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
778
	if (result) {
779
780
		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
			result);
781
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
782
	}
783

784
	result = usb_serial_generic_open(tty, port);
785
786
787
788
789
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
790
791
792
	return 0;
}

793
static int pl2303_tiocmset(struct tty_struct *tty,
794
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
795
{
Alan Cox's avatar
Alan Cox committed
796
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
797
798
799
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
800
	int ret;
801

802
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
803
804
805
806
807
808
809
810
811
	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;
812
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
813

814
815
816
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
817

818
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
819
820
}

821
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
822
{
Alan Cox's avatar
Alan Cox committed
823
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
824
825
826
827
828
829
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

830
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
831
832
	mcr = priv->line_control;
	status = priv->line_status;
833
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
834
835
836
837
838
839
840
841

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

842
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
843
844
845
846

	return result;
}

847
848
849
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
850

851
852
	if (priv->line_status & UART_DCD)
		return 1;
853

854
855
856
	return 0;
}

Al Viro's avatar
Al Viro committed
857
858
static int pl2303_get_serial(struct tty_struct *tty,
			struct serial_struct *ss)
Linus Torvalds's avatar
Linus Torvalds committed
859
{
Alan Cox's avatar
Alan Cox committed
860
	struct usb_serial_port *port = tty->driver_data;
861

Al Viro's avatar
Al Viro committed
862
863
864
865
866
	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
867
868
}

869
static void pl2303_set_break(struct usb_serial_port *port, bool enable)
Linus Torvalds's avatar
Linus Torvalds committed
870
871
872
873
874
{
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

875
	if (enable)
Linus Torvalds's avatar
Linus Torvalds committed
876
		state = BREAK_ON;
877
878
	else
		state = BREAK_OFF;
879

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

883
884
885
	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
886
	if (result)
887
		dev_err(&port->dev, "error sending break = %d\n", result);
Linus Torvalds's avatar
Linus Torvalds committed
888
889
}

890
891
892
893
894
895
896
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
897
898
899
900
static void pl2303_update_line_status(struct usb_serial_port *port,
				      unsigned char *data,
				      unsigned int actual_length)
{
901
902
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Flavio Leitner's avatar
Flavio Leitner committed
903
	struct pl2303_private *priv = usb_get_serial_port_data(port);
904
	struct tty_struct *tty;
Flavio Leitner's avatar
Flavio Leitner committed
905
	unsigned long flags;
906
	unsigned int status_idx = UART_STATE_INDEX;
907
908
	u8 status;
	u8 delta;
Flavio Leitner's avatar
Flavio Leitner committed
909

910
911
	if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
		status_idx = 0;
Flavio Leitner's avatar
Flavio Leitner committed
912

913
	if (actual_length < status_idx + 1)
914
		return;
Flavio Leitner's avatar
Flavio Leitner committed
915

916
917
	status = data[status_idx];

Alan Cox's avatar
Alan Cox committed
918
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
919
	spin_lock_irqsave(&priv->lock, flags);
920
921
	delta = priv->line_status ^ status;
	priv->line_status = status;
Flavio Leitner's avatar
Flavio Leitner committed
922
	spin_unlock_irqrestore(&priv->lock, flags);
923

924
	if (status & UART_BREAK_ERROR)
925
		usb_serial_handle_break(port);
926

927
	if (delta & UART_STATE_MSR_MASK) {
928
929
930
931
932
933
		if (delta & UART_CTS)
			port->icount.cts++;
		if (delta & UART_DSR)
			port->icount.dsr++;
		if (delta & UART_RING)
			port->icount.rng++;
934
		if (delta & UART_DCD) {
935
			port->icount.dcd++;
936
937
938
			tty = tty_port_tty_get(&port->port);
			if (tty) {
				usb_serial_handle_dcd_change(port, tty,
939
							status & UART_DCD);
940
941
				tty_kref_put(tty);
			}
942
		}
943
944

		wake_up_interruptible(&port->port.delta_msr_wait);
945
	}
Flavio Leitner's avatar
Flavio Leitner committed
946
}
Linus Torvalds's avatar
Linus Torvalds committed
947

948
static void pl2303_read_int_callback(struct urb *urb)
Linus Torvalds's avatar
Linus Torvalds committed
949
{
950
	struct usb_serial_port *port =  urb->context;
Linus Torvalds's avatar
Linus Torvalds committed
951
	unsigned char *data = urb->transfer_buffer;
Flavio Leitner's avatar
Flavio Leitner committed
952
	unsigned int actual_length = urb->actual_length;
953
954
	int status = urb->status;
	int retval;
Linus Torvalds's avatar
Linus Torvalds committed
955

956
	switch (status) {
Linus Torvalds's avatar
Linus Torvalds committed
957
958
959
960
961
962
963
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
964
965
		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
966
967
		return;
	default:
968
969
		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
970
971
972
		goto exit;
	}

973
	usb_serial_debug_data(&port->dev, __func__,
974
975
			      urb->actual_length, urb->transfer_buffer);

Flavio Leitner's avatar
Flavio Leitner committed
976
	pl2303_update_line_status(port, data, actual_length);
Linus Torvalds's avatar
Linus Torvalds committed
977
978

exit:
979
	retval = usb_submit_urb(urb, GFP_ATOMIC);
980
	if (retval) {
981
		dev_err(&port->dev,
982
			"%s - usb_submit_urb failed with result %d\n",
983
			__func__, retval);
984
	}
Linus Torvalds's avatar
Linus Torvalds committed
985
986
}

987
static void pl2303_process_read_urb(struct urb *urb)
988
{
989
990
	struct usb_serial_port *port = urb->context;
	struct pl2303_private *priv = usb_get_serial_port_data(port);
991
992
	unsigned char *data = urb->transfer_buffer;
	char tty_flag = TTY_NORMAL;
993
994
995
996
997
998
999
1000
	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;
For faster browsing, not all history is shown. View entire blame