pl2303.c 30.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
 *
10
 * See Documentation/usb/usb-serial.rst for more information on using this
Alan Cox's avatar
Alan Cox committed
11
 * 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) },
50
51
52
53
54
55
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GC) },
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GB) },
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GT) },
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GL) },
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GE) },
	{ USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GS) },
Linus Torvalds's avatar
Linus Torvalds committed
56
	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
57
	{ USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
58
59
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
60
61
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC485),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
62
63
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC232B),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
64
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID2) },
Linus Torvalds's avatar
Linus Torvalds committed
65
66
67
68
	{ 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) },
69
	{ USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
Linus Torvalds's avatar
Linus Torvalds committed
70
71
72
73
74
75
76
	{ 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) },
77
78
79
80
81
82
	{ 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 },
83
84
	{ USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
85
	{ USB_DEVICE(BENQ_VENDOR_ID, BENQ_PRODUCT_ID_S81) }, /* Benq/Siemens S81 */
86
	{ USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
87
88
	{ USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
	{ USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
89
	{ USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
90
	{ USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
91
	{ USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
92
	{ USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
93
	{ USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
94
95
	{ USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID),
		.driver_info = PL2303_QUIRK_ENDPOINT_HACK },
96
	{ USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
97
	{ USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
98
	{ USB_DEVICE(YCCABLE_VENDOR_ID, YCCABLE_PRODUCT_ID) },
Matthew Arnold's avatar
Matthew Arnold committed
99
	{ USB_DEVICE(SUPERIAL_VENDOR_ID, SUPERIAL_PRODUCT_ID) },
100
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD220_PRODUCT_ID) },
101
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD220TA_PRODUCT_ID) },
102
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD381_PRODUCT_ID) },
103
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD960_PRODUCT_ID) },
104
	{ USB_DEVICE(HP_VENDOR_ID, HP_LD960TA_PRODUCT_ID) },
105
106
	{ USB_DEVICE(HP_VENDOR_ID, HP_LCM220_PRODUCT_ID) },
	{ USB_DEVICE(HP_VENDOR_ID, HP_LCM960_PRODUCT_ID) },
107
108
109
	{ 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) },
110
	{ USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
111
	{ USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
112
	{ USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
113
	{ USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
114
	{ USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
115
	{ USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
116
	{ USB_DEVICE(AT_VENDOR_ID, AT_VTKIT3_PRODUCT_ID) },
Linus Torvalds's avatar
Linus Torvalds committed
117
118
119
	{ }					/* Terminating entry */
};

120
MODULE_DEVICE_TABLE(usb, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
121
122
123
124
125
126
127
128
129
130

#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
131
#define BREAK_REQUEST			0x23
Linus Torvalds's avatar
Linus Torvalds committed
132
133
134
135
136
137
138
139
#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
140
#define VENDOR_WRITE_NREQUEST		0x80
Linus Torvalds's avatar
Linus Torvalds committed
141
142
143

#define VENDOR_READ_REQUEST_TYPE	0xc0
#define VENDOR_READ_REQUEST		0x01
144
#define VENDOR_READ_NREQUEST		0x81
Linus Torvalds's avatar
Linus Torvalds committed
145

146
#define UART_STATE_INDEX		8
147
#define UART_STATE_MSR_MASK		0x8b
Linus Torvalds's avatar
Linus Torvalds committed
148
149
150
151
152
153
154
155
156
157
#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

158
159
#define PL2303_FLOWCTRL_MASK		0xf0

160
161
162
163
164
165
166
167
168
169
170
171
#define PL2303_READ_TYPE_HX_STATUS	0x8080

#define PL2303_HXN_RESET_REG		0x07
#define PL2303_HXN_RESET_UPSTREAM_PIPE	0x02
#define PL2303_HXN_RESET_DOWNSTREAM_PIPE	0x01

#define PL2303_HXN_FLOWCTRL_REG		0x0a
#define PL2303_HXN_FLOWCTRL_MASK	0x1c
#define PL2303_HXN_FLOWCTRL_NONE	0x1c
#define PL2303_HXN_FLOWCTRL_RTS_CTS	0x18
#define PL2303_HXN_FLOWCTRL_XON_XOFF	0x0c

172
static void pl2303_set_break(struct usb_serial_port *port, bool enable);
Linus Torvalds's avatar
Linus Torvalds committed
173
174

enum pl2303_type {
175
176
	TYPE_01,	/* Type 0 and 1 (difference unknown) */
	TYPE_HX,	/* HX version of the pl2303 chip */
177
	TYPE_HXN,	/* HXN version of the pl2303 chip */
178
179
180
181
182
183
	TYPE_COUNT
};

struct pl2303_type_data {
	speed_t max_baud_rate;
	unsigned long quirks;
184
	unsigned int no_autoxonxoff:1;
Linus Torvalds's avatar
Linus Torvalds committed
185
186
};

187
struct pl2303_serial_private {
188
	const struct pl2303_type_data *type;
189
	unsigned long quirks;
190
191
};

Linus Torvalds's avatar
Linus Torvalds committed
192
193
194
195
struct pl2303_private {
	spinlock_t lock;
	u8 line_control;
	u8 line_status;
196
197

	u8 line_settings[7];
Linus Torvalds's avatar
Linus Torvalds committed
198
199
};

200
static const struct pl2303_type_data pl2303_type_data[TYPE_COUNT] = {
201
	[TYPE_01] = {
202
203
204
		.max_baud_rate		= 1228800,
		.quirks			= PL2303_QUIRK_LEGACY,
		.no_autoxonxoff		= true,
205
	},
206
	[TYPE_HX] = {
207
		.max_baud_rate		= 12000000,
208
	},
209
210
211
	[TYPE_HXN] = {
		.max_baud_rate		= 12000000,
	},
212
213
};

214
215
static int pl2303_vendor_read(struct usb_serial *serial, u16 value,
							unsigned char buf[1])
216
{
217
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
218
	struct device *dev = &serial->interface->dev;
219
	u8 request;
220
221
	int res;

222
223
224
225
226
	if (spriv->type == &pl2303_type_data[TYPE_HXN])
		request = VENDOR_READ_NREQUEST;
	else
		request = VENDOR_READ_REQUEST;

227
	res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
228
			request, VENDOR_READ_REQUEST_TYPE,
229
230
231
232
233
234
235
236
237
			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;
	}
238

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

241
	return 0;
242
243
}

244
static int pl2303_vendor_write(struct usb_serial *serial, u16 value, u16 index)
245
{
246
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
247
	struct device *dev = &serial->interface->dev;
248
	u8 request;
249
250
	int res;

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

253
254
255
256
257
	if (spriv->type == &pl2303_type_data[TYPE_HXN])
		request = VENDOR_WRITE_NREQUEST;
	else
		request = VENDOR_WRITE_REQUEST;

258
	res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
259
			request, VENDOR_WRITE_REQUEST_TYPE,
260
			value, index, NULL, 0, 100);
261
262
263
264
265
	if (res) {
		dev_err(dev, "%s - failed to write [%04x]: %d\n", __func__,
								value, res);
		return res;
	}
266

267
	return 0;
268
269
}

270
271
static int pl2303_update_reg(struct usb_serial *serial, u8 reg, u8 mask, u8 val)
{
272
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
273
274
275
276
277
278
279
	int ret = 0;
	u8 *buf;

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

280
281
282
283
284
	if (spriv->type == &pl2303_type_data[TYPE_HXN])
		ret = pl2303_vendor_read(serial, reg, buf);
	else
		ret = pl2303_vendor_read(serial, reg | 0x80, buf);

285
286
287
288
289
290
291
292
293
294
295
296
297
	if (ret)
		goto out_free;

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

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

	return ret;
}

298
299
300
301
302
303
304
305
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;
}

306
307
308
309
310
311
/*
 * 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,
312
313
314
315
316
317
318
319
320
					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;

321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
	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;
352
353
354
	}

	if (epds->num_interrupt_in < 1) {
355
		dev_err(dev, "required interrupt-in endpoint missing\n");
356
357
358
359
360
361
		return -ENODEV;
	}

	return 1;
}

362
static int pl2303_startup(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
363
{
364
	struct pl2303_serial_private *spriv;
365
	enum pl2303_type type = TYPE_01;
366
	unsigned char *buf;
367
	int res;
368
369
370
371

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

373
	buf = kmalloc(1, GFP_KERNEL);
374
375
	if (!buf) {
		kfree(spriv);
376
		return -ENOMEM;
377
	}
378

379
	if (serial->dev->descriptor.bDeviceClass == 0x02)
380
		type = TYPE_01;		/* type 0 */
381
	else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
382
		type = TYPE_HX;
383
	else if (serial->dev->descriptor.bDeviceClass == 0x00)
384
		type = TYPE_01;		/* type 1 */
385
	else if (serial->dev->descriptor.bDeviceClass == 0xFF)
386
		type = TYPE_01;		/* type 1 */
387
	dev_dbg(&serial->interface->dev, "device type: %d\n", type);
Linus Torvalds's avatar
Linus Torvalds committed
388

389
390
391
392
393
394
395
396
397
	if (type == TYPE_HX) {
		res = usb_control_msg(serial->dev,
				usb_rcvctrlpipe(serial->dev, 0),
				VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
				PL2303_READ_TYPE_HX_STATUS, 0, buf, 1, 100);
		if (res != 1)
			type = TYPE_HXN;
	}

398
	spriv->type = &pl2303_type_data[type];
399
	spriv->quirks = (unsigned long)usb_get_serial_data(serial);
400
	spriv->quirks |= spriv->type->quirks;
401

402
	usb_set_serial_data(serial, spriv);
403

404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
	if (type != TYPE_HXN) {
		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);
		if (spriv->quirks & PL2303_QUIRK_LEGACY)
			pl2303_vendor_write(serial, 2, 0x24);
		else
			pl2303_vendor_write(serial, 2, 0x44);
	}
420
421

	kfree(buf);
422

Linus Torvalds's avatar
Linus Torvalds committed
423
	return 0;
424
}
Linus Torvalds's avatar
Linus Torvalds committed
425

426
427
static void pl2303_release(struct usb_serial *serial)
{
428
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444

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

445
446
	port->port.drain_delay = 256;

447
448
449
450
451
	return 0;
}

static int pl2303_port_remove(struct usb_serial_port *port)
{
452
	struct pl2303_private *priv = usb_get_serial_port_data(port);
453
454
455
456

	kfree(priv);

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
457
458
}

459
static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
Linus Torvalds's avatar
Linus Torvalds committed
460
{
461
	struct usb_device *dev = port->serial->dev;
Linus Torvalds's avatar
Linus Torvalds committed
462
	int retval;
Alan Cox's avatar
Alan Cox committed
463

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

466
467
468
	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
				 value, 0, NULL, 0, 100);
469
470
	if (retval)
		dev_err(&port->dev, "%s - failed: %d\n", __func__, retval);
471

Linus Torvalds's avatar
Linus Torvalds committed
472
473
474
	return retval;
}

475
/*
476
477
 * Returns the nearest supported baud rate that can be set directly without
 * using divisors.
478
479
 */
static speed_t pl2303_get_supported_baud_rate(speed_t baud)
Linus Torvalds's avatar
Linus Torvalds committed
480
{
481
482
483
	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,
484
		614400, 921600, 1228800, 2457600, 3000000, 6000000
485
	};
Linus Torvalds's avatar
Linus Torvalds committed
486

487
	unsigned i;
488

489
490
491
492
	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
		if (baud_sup[i] > baud)
			break;
	}
493

494
495
496
497
498
499
	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];
500

501
502
503
	return baud;
}

504
505
506
507
508
509
510
511
512
513
514
515
/*
 * 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;
}

516
517
518
static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
								speed_t baud)
{
519
	unsigned int baseline, mantissa, exponent;
520
521
522

	/*
	 * Apparently the formula is:
523
524
525
526
	 *   baudrate = 12M * 32 / (mantissa * 4^exponent)
	 * where
	 *   mantissa = buf[8:0]
	 *   exponent = buf[11:9]
527
	 */
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
	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;
		}
	}

544
545
	buf[3] = 0x80;
	buf[2] = 0;
546
547
548
549
550
	buf[1] = exponent << 1 | mantissa >> 8;
	buf[0] = mantissa & 0xff;

	/* Calculate and return the exact baud rate. */
	baud = (baseline / mantissa) >> (exponent << 1);
551
552
553
554

	return baud;
}

555
556
557
558
559
560
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);
561
	speed_t	baud_sup;
562
563
564
565
566
567
	speed_t baud;

	baud = tty_get_baud_rate(tty);
	dev_dbg(&port->dev, "baud requested = %u\n", baud);
	if (!baud)
		return;
568
569
570

	if (spriv->type->max_baud_rate)
		baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
571
	/*
572
	 * Use direct method for supported baud rates, otherwise use divisors.
573
574
	 */
	baud_sup = pl2303_get_supported_baud_rate(baud);
575

576
577
	if (baud == baud_sup)
		baud = pl2303_encode_baud_rate_direct(buf, baud);
578
	else
579
		baud = pl2303_encode_baud_rate_divisor(buf, baud);
580

581
	/* Save resulting baud rate */
582
	tty_encode_baud_rate(tty, baud, baud);
583
	dev_dbg(&port->dev, "baud set = %u\n", baud);
584
585
}

586
587
588
589
590
591
592
593
594
595
596
597
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);

598
		if (ret >= 0)
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
			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);
618
	if (ret < 0) {
619
620
621
622
623
624
625
626
627
		dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
		return ret;
	}

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

	return 0;
}

628
629
630
631
632
633
634
635
636
637
638
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;
}

639
640
641
642
643
644
645
646
647
648
649
650
651
652
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;
}

653
654
655
656
657
658
659
660
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;
661
	int ret;
662
663
	u8 control;

664
	if (old_termios && !pl2303_termios_change(&tty->termios, old_termios))
665
666
667
668
669
670
671
672
673
674
		return;

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

675
	pl2303_get_line_request(port, buf);
676

677
678
679
680
681
682
683
684
685
686
687
688
689
	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;
690
	}
691
	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
692

693
	/* For reference buf[0]:buf[3] baud rate value */
694
	pl2303_encode_baud_rate(tty, port, &buf[0]);
695

Linus Torvalds's avatar
Linus Torvalds committed
696
697
698
	/* 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 */
699
700
701
	if (C_CSTOPB(tty)) {
		/*
		 * NOTE: Comply with "real" UARTs / RS232:
702
703
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
704
		if (C_CSIZE(tty) == CS5) {
705
			buf[4] = 1;
706
			dev_dbg(&port->dev, "stop bits = 1.5\n");
707
708
		} else {
			buf[4] = 2;
709
			dev_dbg(&port->dev, "stop bits = 2\n");
710
		}
Linus Torvalds's avatar
Linus Torvalds committed
711
712
	} else {
		buf[4] = 0;
713
		dev_dbg(&port->dev, "stop bits = 1\n");
Linus Torvalds's avatar
Linus Torvalds committed
714
715
	}

716
	if (C_PARENB(tty)) {
Linus Torvalds's avatar
Linus Torvalds committed
717
718
719
720
721
		/* 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 */
722
		if (C_PARODD(tty)) {
Johan Hovold's avatar
Johan Hovold committed
723
			if (C_CMSPAR(tty)) {
724
				buf[5] = 3;
725
				dev_dbg(&port->dev, "parity = mark\n");
726
727
			} else {
				buf[5] = 1;
728
				dev_dbg(&port->dev, "parity = odd\n");
729
			}
Linus Torvalds's avatar
Linus Torvalds committed
730
		} else {
Johan Hovold's avatar
Johan Hovold committed
731
			if (C_CMSPAR(tty)) {
732
				buf[5] = 4;
733
				dev_dbg(&port->dev, "parity = space\n");
734
735
			} else {
				buf[5] = 2;
736
				dev_dbg(&port->dev, "parity = even\n");
737
			}
Linus Torvalds's avatar
Linus Torvalds committed
738
739
740
		}
	} else {
		buf[5] = 0;
741
		dev_dbg(&port->dev, "parity = none\n");
Linus Torvalds's avatar
Linus Torvalds committed
742
743
	}

744
745
746
747
748
749
750
751
752
753
754
755
756
	/*
	 * 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)) {
757
758
		ret = pl2303_set_line_request(port, buf);
		if (!ret)
759
760
			memcpy(priv->line_settings, buf, 7);
	}
Linus Torvalds's avatar
Linus Torvalds committed
761
762
763
764

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
765
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
766
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
767
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
768
769
770
771
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
772
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
773
774
775
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
776

777
	if (C_CRTSCTS(tty)) {
778
		if (spriv->quirks & PL2303_QUIRK_LEGACY) {
779
			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0x40);
780
781
782
783
784
		} else if (spriv->type == &pl2303_type_data[TYPE_HXN]) {
			pl2303_update_reg(serial, PL2303_HXN_FLOWCTRL_REG,
					PL2303_HXN_FLOWCTRL_MASK,
					PL2303_HXN_FLOWCTRL_RTS_CTS);
		} else {
785
			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0x60);
786
		}
787
	} else if (pl2303_enable_xonxoff(tty, spriv->type)) {
788
789
790
791
792
793
794
		if (spriv->type == &pl2303_type_data[TYPE_HXN]) {
			pl2303_update_reg(serial, PL2303_HXN_FLOWCTRL_REG,
					PL2303_HXN_FLOWCTRL_MASK,
					PL2303_HXN_FLOWCTRL_XON_XOFF);
		} else {
			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0xc0);
		}
t.sefzick's avatar
t.sefzick committed
795
	} else {
796
797
798
799
800
801
802
		if (spriv->type == &pl2303_type_data[TYPE_HXN]) {
			pl2303_update_reg(serial, PL2303_HXN_FLOWCTRL_REG,
					PL2303_HXN_FLOWCTRL_MASK,
					PL2303_HXN_FLOWCTRL_NONE);
		} else {
			pl2303_update_reg(serial, 0, PL2303_FLOWCTRL_MASK, 0);
		}
Linus Torvalds's avatar
Linus Torvalds committed
803
	}
804
805
806
807

	kfree(buf);
}

808
809
810
811
812
813
814
815
816
817
818
819
820
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);
821

822
	pl2303_set_control_lines(port, control);
823
824
825
}

static void pl2303_close(struct usb_serial_port *port)
826
{
Johan Hovold's avatar
Johan Hovold committed
827
	usb_serial_generic_close(port);
828
	usb_kill_urb(port->interrupt_in_urb);
829
	pl2303_set_break(port, false);
Linus Torvalds's avatar
Linus Torvalds committed
830
831
}

832
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
833
834
{
	struct usb_serial *serial = port->serial;
835
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
836
837
	int result;

838
	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
839
840
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
841
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
842
		/* reset upstream data pipes */
843
844
845
846
847
848
849
850
		if (spriv->type == &pl2303_type_data[TYPE_HXN]) {
			pl2303_vendor_write(serial, PL2303_HXN_RESET_REG,
					PL2303_HXN_RESET_UPSTREAM_PIPE |
					PL2303_HXN_RESET_DOWNSTREAM_PIPE);
		} else {
			pl2303_vendor_write(serial, 8, 0);
			pl2303_vendor_write(serial, 9, 0);
		}
Linus Torvalds's avatar
Linus Torvalds committed
851
852
853
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
854
	if (tty)
855
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
856

857
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
858
	if (result) {
859
860
		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
			result);
861
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
862
	}
863

864
	result = usb_serial_generic_open(tty, port);
865
866
867
868
869
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
870
871
872
	return 0;
}

873
static int pl2303_tiocmset(struct tty_struct *tty,
874
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
875
{
Alan Cox's avatar
Alan Cox committed
876
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
877
878
879
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
880
	int ret;
881

882
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
883
884
885
886
887
888
889
890
891
	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;
892
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
893

894
895
896
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
897

898
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
899
900
}

901
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
902
{
Alan Cox's avatar
Alan Cox committed
903
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
904
905
906
907
908
909
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

910
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
911
912
	mcr = priv->line_control;
	status = priv->line_status;
913
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
914
915
916
917
918
919
920
921

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

922
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
923
924
925
926

	return result;
}

927
928
929
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
930

931
932
	if (priv->line_status & UART_DCD)
		return 1;
933

934
935
936
	return 0;
}

Al Viro's avatar
Al Viro committed
937
938
static int pl2303_get_serial(struct tty_struct *tty,
			struct serial_struct *ss)
Linus Torvalds's avatar
Linus Torvalds committed
939
{
Alan Cox's avatar
Alan Cox committed
940
	struct usb_serial_port *port = tty->driver_data;
941

Al Viro's avatar
Al Viro committed
942
943
944
945
946
	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
947
948
}

949
static void pl2303_set_break(struct usb_serial_port *port, bool enable)
Linus Torvalds's avatar
Linus Torvalds committed
950
951
952
953
954
{
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

955
	if (enable)
Linus Torvalds's avatar
Linus Torvalds committed
956
		state = BREAK_ON;
957
958
	else
		state = BREAK_OFF;
959

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

963
964
965
	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
966
	if (result)
967
		dev_err(&port->dev, "error sending break = %d\n", result);
Linus Torvalds's avatar
Linus Torvalds committed
968
969
}

970
971
972
973
974
975
976
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
977
978
979
980
static void pl2303_update_line_status(struct usb_serial_port *port,
				      unsigned char *data,
				      unsigned int actual_length)
{
981
982
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Flavio Leitner's avatar
Flavio Leitner committed
983
	struct pl2303_private *priv = usb_get_serial_port_data(port);
984
	struct tty_struct *tty;
Flavio Leitner's avatar
Flavio Leitner committed
985
	unsigned long flags;
986
	unsigned int status_idx = UART_STATE_INDEX;
987
988
	u8 status;
	u8 delta;
Flavio Leitner's avatar
Flavio Leitner committed
989

990
991
	if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
		status_idx = 0;
Flavio Leitner's avatar
Flavio Leitner committed
992

993
	if (actual_length < status_idx + 1)
994
		return;
Flavio Leitner's avatar
Flavio Leitner committed
995

996
997
	status = data[status_idx];

Alan Cox's avatar
Alan Cox committed
998
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
999
	spin_lock_irqsave(&priv->lock, flags);
1000
	delta = priv->line_status ^ status;
For faster browsing, not all history is shown. View entire blame