pl2303.c 24.5 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
2
3
/*
 * Prolific PL2303 USB to serial adaptor driver
 *
4
 * Copyright (C) 2001-2007 Greg Kroah-Hartman (greg@kroah.com)
Linus Torvalds's avatar
Linus Torvalds committed
5
6
7
8
 * Copyright (C) 2003 IBM Corp.
 *
 * Original driver for 2.2.x by anonymous
 *
9
10
11
 *	This program is free software; you can redistribute it and/or
 *	modify it under the terms of the GNU General Public License version
 *	2 as published by the Free Software Foundation.
Linus Torvalds's avatar
Linus Torvalds committed
12
 *
Alan Cox's avatar
Alan Cox committed
13
14
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
Linus Torvalds's avatar
Linus Torvalds committed
15
16
17
18
19
20
21
22
23
24
25
26
 */

#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
27
#include <linux/uaccess.h>
Linus Torvalds's avatar
Linus Torvalds committed
28
#include <linux/usb.h>
29
#include <linux/usb/serial.h>
30
#include <asm/unaligned.h>
Linus Torvalds's avatar
Linus Torvalds committed
31
32
#include "pl2303.h"

33
34

#define PL2303_QUIRK_UART_STATE_IDX0		BIT(0)
35
#define PL2303_QUIRK_LEGACY			BIT(1)
36

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

98
MODULE_DEVICE_TABLE(usb, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
99
100
101
102
103
104
105
106
107
108

#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
109
#define BREAK_REQUEST			0x23
Linus Torvalds's avatar
Linus Torvalds committed
110
111
112
113
114
115
116
117
118
119
120
121
#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

122
#define UART_STATE_INDEX		8
123
#define UART_STATE_MSR_MASK		0x8b
Linus Torvalds's avatar
Linus Torvalds committed
124
125
126
127
128
129
130
131
132
133
#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

134
static void pl2303_set_break(struct usb_serial_port *port, bool enable);
Linus Torvalds's avatar
Linus Torvalds committed
135
136

enum pl2303_type {
137
138
	TYPE_01,	/* Type 0 and 1 (difference unknown) */
	TYPE_HX,	/* HX version of the pl2303 chip */
139
140
141
142
143
144
	TYPE_COUNT
};

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

147
struct pl2303_serial_private {
148
	const struct pl2303_type_data *type;
149
	unsigned long quirks;
150
151
};

Linus Torvalds's avatar
Linus Torvalds committed
152
153
154
155
struct pl2303_private {
	spinlock_t lock;
	u8 line_control;
	u8 line_status;
156
157

	u8 line_settings[7];
Linus Torvalds's avatar
Linus Torvalds committed
158
159
};

160
static const struct pl2303_type_data pl2303_type_data[TYPE_COUNT] = {
161
162
163
164
	[TYPE_01] = {
		.max_baud_rate =	1228800,
		.quirks =		PL2303_QUIRK_LEGACY,
	},
165
166
167
	[TYPE_HX] = {
		.max_baud_rate =	12000000,
	},
168
169
};

170
171
static int pl2303_vendor_read(struct usb_serial *serial, u16 value,
							unsigned char buf[1])
172
{
173
	struct device *dev = &serial->interface->dev;
174
175
176
	int res;

	res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
177
			VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
178
179
180
181
182
183
184
185
186
			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;
	}
187

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

190
	return 0;
191
192
}

193
static int pl2303_vendor_write(struct usb_serial *serial, u16 value, u16 index)
194
{
195
	struct device *dev = &serial->interface->dev;
196
197
	int res;

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

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

209
	return 0;
210
211
}

212
213
214
215
216
217
218
219
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;
}

220
static int pl2303_startup(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
221
{
222
	struct pl2303_serial_private *spriv;
223
	enum pl2303_type type = TYPE_01;
224
	unsigned char *buf;
225
226
227
228

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

230
	buf = kmalloc(1, GFP_KERNEL);
231
232
	if (!buf) {
		kfree(spriv);
233
		return -ENOMEM;
234
	}
235

236
	if (serial->dev->descriptor.bDeviceClass == 0x02)
237
		type = TYPE_01;		/* type 0 */
238
	else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
239
		type = TYPE_HX;
240
	else if (serial->dev->descriptor.bDeviceClass == 0x00)
241
		type = TYPE_01;		/* type 1 */
242
	else if (serial->dev->descriptor.bDeviceClass == 0xFF)
243
		type = TYPE_01;		/* type 1 */
244
	dev_dbg(&serial->interface->dev, "device type: %d\n", type);
Linus Torvalds's avatar
Linus Torvalds committed
245

246
	spriv->type = &pl2303_type_data[type];
247
	spriv->quirks = (unsigned long)usb_get_serial_data(serial);
248
	spriv->quirks |= spriv->type->quirks;
249

250
	usb_set_serial_data(serial, spriv);
251

252
253
254
255
256
257
258
259
260
261
	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);
262
	if (spriv->quirks & PL2303_QUIRK_LEGACY)
263
		pl2303_vendor_write(serial, 2, 0x24);
264
265
	else
		pl2303_vendor_write(serial, 2, 0x44);
266
267

	kfree(buf);
268

Linus Torvalds's avatar
Linus Torvalds committed
269
	return 0;
270
}
Linus Torvalds's avatar
Linus Torvalds committed
271

272
273
static void pl2303_release(struct usb_serial *serial)
{
274
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290

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

291
292
	port->port.drain_delay = 256;

293
294
295
296
297
	return 0;
}

static int pl2303_port_remove(struct usb_serial_port *port)
{
298
	struct pl2303_private *priv = usb_get_serial_port_data(port);
299
300
301
302

	kfree(priv);

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
303
304
}

305
static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
Linus Torvalds's avatar
Linus Torvalds committed
306
{
307
	struct usb_device *dev = port->serial->dev;
Linus Torvalds's avatar
Linus Torvalds committed
308
	int retval;
Alan Cox's avatar
Alan Cox committed
309

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

312
313
314
	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
				 value, 0, NULL, 0, 100);
315
316
	if (retval)
		dev_err(&port->dev, "%s - failed: %d\n", __func__, retval);
317

Linus Torvalds's avatar
Linus Torvalds committed
318
319
320
	return retval;
}

321
/*
322
323
 * Returns the nearest supported baud rate that can be set directly without
 * using divisors.
324
325
 */
static speed_t pl2303_get_supported_baud_rate(speed_t baud)
Linus Torvalds's avatar
Linus Torvalds committed
326
{
327
328
329
	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,
330
		614400, 921600, 1228800, 2457600, 3000000, 6000000
331
	};
Linus Torvalds's avatar
Linus Torvalds committed
332

333
	unsigned i;
334

335
336
337
338
	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
		if (baud_sup[i] > baud)
			break;
	}
339

340
341
342
343
344
345
	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];
346

347
348
349
	return baud;
}

350
351
352
353
354
355
356
357
358
359
360
361
/*
 * 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;
}

362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
								speed_t baud)
{
	unsigned int tmp;

	/*
	 * Apparently the formula is:
	 * baudrate = 12M * 32 / (2^buf[1]) / buf[0]
	 */
	tmp = 12000000 * 32 / baud;
	buf[3] = 0x80;
	buf[2] = 0;
	buf[1] = (tmp >= 256);
	while (tmp >= 256) {
		tmp >>= 2;
		buf[1] <<= 1;
	}
	buf[0] = tmp;

	return baud;
}

384
385
386
387
388
389
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);
390
	speed_t	baud_sup;
391
392
393
394
395
396
	speed_t baud;

	baud = tty_get_baud_rate(tty);
	dev_dbg(&port->dev, "baud requested = %u\n", baud);
	if (!baud)
		return;
397
398
399

	if (spriv->type->max_baud_rate)
		baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
400
	/*
401
	 * Use direct method for supported baud rates, otherwise use divisors.
402
403
	 */
	baud_sup = pl2303_get_supported_baud_rate(baud);
404

405
406
	if (baud == baud_sup)
		baud = pl2303_encode_baud_rate_direct(buf, baud);
407
	else
408
		baud = pl2303_encode_baud_rate_divisor(buf, baud);
409

410
	/* Save resulting baud rate */
411
	tty_encode_baud_rate(tty, baud, baud);
412
	dev_dbg(&port->dev, "baud set = %u\n", baud);
413
414
}

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
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);

		if (ret > 0)
			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);
	if (ret != 7) {
		dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);

		if (ret > 0)
			ret = -EIO;

		return ret;
	}

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

	return 0;
}

461
462
463
464
465
466
467
468
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;
469
	int ret;
470
471
472
473
474
475
476
477
478
479
480
481
482
	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;
	}

483
	pl2303_get_line_request(port, buf);
484

485
486
487
488
489
490
491
492
493
494
495
496
497
	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;
498
	}
499
	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
500

501
	/* For reference buf[0]:buf[3] baud rate value */
502
	pl2303_encode_baud_rate(tty, port, &buf[0]);
503

Linus Torvalds's avatar
Linus Torvalds committed
504
505
506
	/* 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 */
507
508
509
	if (C_CSTOPB(tty)) {
		/*
		 * NOTE: Comply with "real" UARTs / RS232:
510
511
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
512
		if (C_CSIZE(tty) == CS5) {
513
			buf[4] = 1;
514
			dev_dbg(&port->dev, "stop bits = 1.5\n");
515
516
		} else {
			buf[4] = 2;
517
			dev_dbg(&port->dev, "stop bits = 2\n");
518
		}
Linus Torvalds's avatar
Linus Torvalds committed
519
520
	} else {
		buf[4] = 0;
521
		dev_dbg(&port->dev, "stop bits = 1\n");
Linus Torvalds's avatar
Linus Torvalds committed
522
523
	}

524
	if (C_PARENB(tty)) {
Linus Torvalds's avatar
Linus Torvalds committed
525
526
527
528
529
		/* 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 */
530
		if (C_PARODD(tty)) {
Johan Hovold's avatar
Johan Hovold committed
531
			if (C_CMSPAR(tty)) {
532
				buf[5] = 3;
533
				dev_dbg(&port->dev, "parity = mark\n");
534
535
			} else {
				buf[5] = 1;
536
				dev_dbg(&port->dev, "parity = odd\n");
537
			}
Linus Torvalds's avatar
Linus Torvalds committed
538
		} else {
Johan Hovold's avatar
Johan Hovold committed
539
			if (C_CMSPAR(tty)) {
540
				buf[5] = 4;
541
				dev_dbg(&port->dev, "parity = space\n");
542
543
			} else {
				buf[5] = 2;
544
				dev_dbg(&port->dev, "parity = even\n");
545
			}
Linus Torvalds's avatar
Linus Torvalds committed
546
547
548
		}
	} else {
		buf[5] = 0;
549
		dev_dbg(&port->dev, "parity = none\n");
Linus Torvalds's avatar
Linus Torvalds committed
550
551
	}

552
553
554
555
556
557
558
559
560
561
562
563
564
	/*
	 * 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)) {
565
566
		ret = pl2303_set_line_request(port, buf);
		if (!ret)
567
568
			memcpy(priv->line_settings, buf, 7);
	}
Linus Torvalds's avatar
Linus Torvalds committed
569
570
571
572

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
573
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
574
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
575
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
576
577
578
579
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
580
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
581
582
583
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
584

585
	if (C_CRTSCTS(tty)) {
586
		if (spriv->quirks & PL2303_QUIRK_LEGACY)
587
			pl2303_vendor_write(serial, 0x0, 0x41);
588
589
		else
			pl2303_vendor_write(serial, 0x0, 0x61);
t.sefzick's avatar
t.sefzick committed
590
	} else {
591
		pl2303_vendor_write(serial, 0x0, 0x0);
Linus Torvalds's avatar
Linus Torvalds committed
592
	}
593
594
595
596

	kfree(buf);
}

597
598
599
600
601
602
603
604
605
606
607
608
609
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);
610

611
	pl2303_set_control_lines(port, control);
612
613
614
}

static void pl2303_close(struct usb_serial_port *port)
615
{
Johan Hovold's avatar
Johan Hovold committed
616
	usb_serial_generic_close(port);
617
	usb_kill_urb(port->interrupt_in_urb);
618
	pl2303_set_break(port, false);
Linus Torvalds's avatar
Linus Torvalds committed
619
620
}

621
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
622
623
{
	struct usb_serial *serial = port->serial;
624
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
625
626
	int result;

627
	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
628
629
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
630
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
631
		/* reset upstream data pipes */
632
633
		pl2303_vendor_write(serial, 8, 0);
		pl2303_vendor_write(serial, 9, 0);
Linus Torvalds's avatar
Linus Torvalds committed
634
635
636
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
637
	if (tty)
638
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
639

640
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
641
	if (result) {
642
643
		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
			result);
644
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
645
	}
646

647
	result = usb_serial_generic_open(tty, port);
648
649
650
651
652
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
653
654
655
	return 0;
}

656
static int pl2303_tiocmset(struct tty_struct *tty,
657
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
658
{
Alan Cox's avatar
Alan Cox committed
659
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
660
661
662
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
663
	int ret;
664

665
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
666
667
668
669
670
671
672
673
674
	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;
675
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
676

677
678
679
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
680

681
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
682
683
}

684
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
685
{
Alan Cox's avatar
Alan Cox committed
686
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
687
688
689
690
691
692
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

693
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
694
695
	mcr = priv->line_control;
	status = priv->line_status;
696
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
697
698
699
700
701
702
703
704

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

705
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
706
707
708
709

	return result;
}

710
711
712
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
713

714
715
	if (priv->line_status & UART_DCD)
		return 1;
716

717
718
719
	return 0;
}

720
static int pl2303_ioctl(struct tty_struct *tty,
721
			unsigned int cmd, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
722
{
723
	struct serial_struct ser;
Alan Cox's avatar
Alan Cox committed
724
	struct usb_serial_port *port = tty->driver_data;
725

Linus Torvalds's avatar
Linus Torvalds committed
726
	switch (cmd) {
727
728
729
	case TIOCGSERIAL:
		memset(&ser, 0, sizeof ser);
		ser.type = PORT_16654;
730
		ser.line = port->minor;
731
		ser.port = port->port_number;
732
733
734
735
736
737
		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
738
739
	default:
		break;
Linus Torvalds's avatar
Linus Torvalds committed
740
	}
741

Linus Torvalds's avatar
Linus Torvalds committed
742
743
744
	return -ENOIOCTLCMD;
}

745
static void pl2303_set_break(struct usb_serial_port *port, bool enable)
Linus Torvalds's avatar
Linus Torvalds committed
746
747
748
749
750
{
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

751
	if (enable)
Linus Torvalds's avatar
Linus Torvalds committed
752
		state = BREAK_ON;
753
754
	else
		state = BREAK_OFF;
755

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

759
760
761
	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
762
	if (result)
763
		dev_err(&port->dev, "error sending break = %d\n", result);
Linus Torvalds's avatar
Linus Torvalds committed
764
765
}

766
767
768
769
770
771
772
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
773
774
775
776
static void pl2303_update_line_status(struct usb_serial_port *port,
				      unsigned char *data,
				      unsigned int actual_length)
{
777
778
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Flavio Leitner's avatar
Flavio Leitner committed
779
	struct pl2303_private *priv = usb_get_serial_port_data(port);
780
	struct tty_struct *tty;
Flavio Leitner's avatar
Flavio Leitner committed
781
	unsigned long flags;
782
	unsigned int status_idx = UART_STATE_INDEX;
783
784
	u8 status;
	u8 delta;
Flavio Leitner's avatar
Flavio Leitner committed
785

786
787
	if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
		status_idx = 0;
Flavio Leitner's avatar
Flavio Leitner committed
788

789
	if (actual_length < status_idx + 1)
790
		return;
Flavio Leitner's avatar
Flavio Leitner committed
791

792
793
	status = data[status_idx];

Alan Cox's avatar
Alan Cox committed
794
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
795
	spin_lock_irqsave(&priv->lock, flags);
796
797
	delta = priv->line_status ^ status;
	priv->line_status = status;
Flavio Leitner's avatar
Flavio Leitner committed
798
	spin_unlock_irqrestore(&priv->lock, flags);
799

800
	if (status & UART_BREAK_ERROR)
801
		usb_serial_handle_break(port);
802

803
	if (delta & UART_STATE_MSR_MASK) {
804
805
806
807
808
809
		if (delta & UART_CTS)
			port->icount.cts++;
		if (delta & UART_DSR)
			port->icount.dsr++;
		if (delta & UART_RING)
			port->icount.rng++;
810
		if (delta & UART_DCD) {
811
			port->icount.dcd++;
812
813
814
			tty = tty_port_tty_get(&port->port);
			if (tty) {
				usb_serial_handle_dcd_change(port, tty,
815
							status & UART_DCD);
816
817
				tty_kref_put(tty);
			}
818
		}
819
820

		wake_up_interruptible(&port->port.delta_msr_wait);
821
	}
Flavio Leitner's avatar
Flavio Leitner committed
822
}
Linus Torvalds's avatar
Linus Torvalds committed
823

824
static void pl2303_read_int_callback(struct urb *urb)
Linus Torvalds's avatar
Linus Torvalds committed
825
{
826
	struct usb_serial_port *port =  urb->context;
Linus Torvalds's avatar
Linus Torvalds committed
827
	unsigned char *data = urb->transfer_buffer;
Flavio Leitner's avatar
Flavio Leitner committed
828
	unsigned int actual_length = urb->actual_length;
829
830
	int status = urb->status;
	int retval;
Linus Torvalds's avatar
Linus Torvalds committed
831

832
	switch (status) {
Linus Torvalds's avatar
Linus Torvalds committed
833
834
835
836
837
838
839
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
840
841
		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
842
843
		return;
	default:
844
845
		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
846
847
848
		goto exit;
	}

849
	usb_serial_debug_data(&port->dev, __func__,
850
851
			      urb->actual_length, urb->transfer_buffer);

Flavio Leitner's avatar
Flavio Leitner committed
852
	pl2303_update_line_status(port, data, actual_length);
Linus Torvalds's avatar
Linus Torvalds committed
853
854

exit:
855
	retval = usb_submit_urb(urb, GFP_ATOMIC);
856
	if (retval) {
857
		dev_err(&port->dev,
858
			"%s - usb_submit_urb failed with result %d\n",
859
			__func__, retval);
860
	}
Linus Torvalds's avatar
Linus Torvalds committed
861
862
}

863
static void pl2303_process_read_urb(struct urb *urb)
864
{
865
866
	struct usb_serial_port *port = urb->context;
	struct pl2303_private *priv = usb_get_serial_port_data(port);
867
868
	unsigned char *data = urb->transfer_buffer;
	char tty_flag = TTY_NORMAL;
869
870
871
872
873
874
875
876
877
878
879
880
881
	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;

882
883
884
885
	/*
	 * Break takes precedence over parity, which takes precedence over
	 * framing errors.
	 */
886
887
888
889
890
891
892
	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;

893
894
895
	if (tty_flag != TTY_NORMAL)
		dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
								tty_flag);
896
897
	/* overrun is special, not associated with a char */
	if (line_status & UART_OVERRUN_ERROR)
Jiri Slaby's avatar
Jiri Slaby committed
898
		tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
899

900
	if (port->port.console && port->sysrq) {
901
		for (i = 0; i < urb->actual_length; ++i)
902
			if (!usb_serial_handle_sysrq_char(port, data[i]))
Jiri Slaby's avatar
Jiri Slaby committed
903
904
				tty_insert_flip_char(&port->port, data[i],
						tty_flag);
905
	} else {
906
		tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
907
							urb->actual_length);
908
	}
Linus Torvalds's avatar
Linus Torvalds committed
909

Jiri Slaby's avatar
Jiri Slaby committed
910
	tty_flip_buffer_push(&port->port);
Linus Torvalds's avatar
Linus Torvalds committed
911
912
}

913
914
915
916
917
918
919
static struct usb_serial_driver pl2303_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"pl2303",
	},
	.id_table =		id_table,
	.num_ports =		1,
920
	.bulk_in_size =		256,
921
	.bulk_out_size =	256,
922
923
	.open =			pl2303_open,
	.close =		pl2303_close,
924
	.dtr_rts =		pl2303_dtr_rts,
925
	.carrier_raised =	pl2303_carrier_raised,
926
927
928
929
930
	.ioctl =		pl2303_ioctl,
	.break_ctl =		pl2303_break_ctl,
	.set_termios =		pl2303_set_termios,
	.tiocmget =		pl2303_tiocmget,
	.tiocmset =		pl2303_tiocmset,
931
	.tiocmiwait =		usb_serial_generic_tiocmiwait,
932
	.process_read_urb =	pl2303_process_read_urb,
933
	.read_int_callback =	pl2303_read_int_callback,
934
	.probe =		pl2303_probe,
935
	.attach =		pl2303_startup,
936
	.release =		pl2303_release,
937
938
	.port_probe =		pl2303_port_probe,
	.port_remove =		pl2303_port_remove,
939
};
Linus Torvalds's avatar
Linus Torvalds committed
940

941
942
943
944
static struct usb_serial_driver * const serial_drivers[] = {
	&pl2303_device, NULL
};

945
module_usb_serial_driver(serial_drivers, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
946

947
MODULE_DESCRIPTION("Prolific PL2303 USB to serial adaptor driver");
Linus Torvalds's avatar
Linus Torvalds committed
948
MODULE_LICENSE("GPL");