pl2303.c 24.7 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
27
 */

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

34
35

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

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

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

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

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


enum pl2303_type {
133
134
	TYPE_01,	/* Type 0 and 1 (difference unknown) */
	TYPE_HX,	/* HX version of the pl2303 chip */
135
136
137
138
139
140
	TYPE_COUNT
};

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

143
struct pl2303_serial_private {
144
	struct pl2303_type_data *type;
145
	unsigned long quirks;
146
147
};

Linus Torvalds's avatar
Linus Torvalds committed
148
149
150
151
struct pl2303_private {
	spinlock_t lock;
	u8 line_control;
	u8 line_status;
152
153

	u8 line_settings[7];
Linus Torvalds's avatar
Linus Torvalds committed
154
155
};

156
157
158
159
160
161
162
static struct pl2303_type_data pl2303_type_data[TYPE_COUNT] = {
	[TYPE_01] = {
		.max_baud_rate =	1228800,
		.quirks =		PL2303_QUIRK_LEGACY,
	},
};

163
164
static int pl2303_vendor_read(struct usb_serial *serial, u16 value,
							unsigned char buf[1])
165
{
166
	struct device *dev = &serial->interface->dev;
167
168
169
	int res;

	res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
170
			VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
171
172
173
174
175
176
177
178
179
			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;
	}
180

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

183
	return 0;
184
185
}

186
static int pl2303_vendor_write(struct usb_serial *serial, u16 value, u16 index)
187
{
188
	struct device *dev = &serial->interface->dev;
189
190
	int res;

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

193
	res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
194
195
			VENDOR_WRITE_REQUEST, VENDOR_WRITE_REQUEST_TYPE,
			value, index, NULL, 0, 100);
196
197
198
199
200
	if (res) {
		dev_err(dev, "%s - failed to write [%04x]: %d\n", __func__,
								value, res);
		return res;
	}
201

202
	return 0;
203
204
}

205
206
207
208
209
210
211
212
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;
}

213
static int pl2303_startup(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
214
{
215
	struct pl2303_serial_private *spriv;
216
	enum pl2303_type type = TYPE_01;
217
	unsigned char *buf;
218
219
220
221

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

223
	buf = kmalloc(1, GFP_KERNEL);
224
225
	if (!buf) {
		kfree(spriv);
226
		return -ENOMEM;
227
	}
228

229
	if (serial->dev->descriptor.bDeviceClass == 0x02)
230
		type = TYPE_01;		/* type 0 */
231
	else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
232
		type = TYPE_HX;
233
	else if (serial->dev->descriptor.bDeviceClass == 0x00)
234
		type = TYPE_01;		/* type 1 */
235
	else if (serial->dev->descriptor.bDeviceClass == 0xFF)
236
		type = TYPE_01;		/* type 1 */
237
	dev_dbg(&serial->interface->dev, "device type: %d\n", type);
Linus Torvalds's avatar
Linus Torvalds committed
238

239
	spriv->type = &pl2303_type_data[type];
240
	spriv->quirks = (unsigned long)usb_get_serial_data(serial);
241
	spriv->quirks |= spriv->type->quirks;
242

243
	usb_set_serial_data(serial, spriv);
244

245
246
247
248
249
250
251
252
253
254
	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);
255
	if (spriv->quirks & PL2303_QUIRK_LEGACY)
256
		pl2303_vendor_write(serial, 2, 0x24);
257
258
	else
		pl2303_vendor_write(serial, 2, 0x44);
259
260

	kfree(buf);
261

Linus Torvalds's avatar
Linus Torvalds committed
262
	return 0;
263
}
Linus Torvalds's avatar
Linus Torvalds committed
264

265
266
static void pl2303_release(struct usb_serial *serial)
{
267
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

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

284
285
	port->port.drain_delay = 256;

286
287
288
289
290
	return 0;
}

static int pl2303_port_remove(struct usb_serial_port *port)
{
291
	struct pl2303_private *priv = usb_get_serial_port_data(port);
292
293
294
295

	kfree(priv);

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
296
297
}

298
static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
Linus Torvalds's avatar
Linus Torvalds committed
299
{
300
	struct usb_device *dev = port->serial->dev;
Linus Torvalds's avatar
Linus Torvalds committed
301
	int retval;
Alan Cox's avatar
Alan Cox committed
302

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

305
306
307
	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
				 value, 0, NULL, 0, 100);
308
309
	if (retval)
		dev_err(&port->dev, "%s - failed: %d\n", __func__, retval);
310

Linus Torvalds's avatar
Linus Torvalds committed
311
312
313
	return retval;
}

314
315
316
317
/*
 * Returns the nearest supported baud rate.
 */
static speed_t pl2303_get_supported_baud_rate(speed_t baud)
Linus Torvalds's avatar
Linus Torvalds committed
318
{
319
320
321
322
323
	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,
		500000, 614400, 921600, 1228800, 2457600, 3000000, 6000000
	};
Linus Torvalds's avatar
Linus Torvalds committed
324

325
	unsigned i;
326

327
328
329
330
	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
		if (baud_sup[i] > baud)
			break;
	}
331

332
333
334
335
336
337
	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];
338

339
340
341
	return baud;
}

342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
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;
}

364
365
366
367
368
369
370
371
372
373
374
375
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);
	speed_t baud;

	baud = tty_get_baud_rate(tty);
	dev_dbg(&port->dev, "baud requested = %u\n", baud);
	if (!baud)
		return;
376
377
378

	if (spriv->type->max_baud_rate)
		baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
379
380
381
382
383
384
385
386
	/*
	 * Set baud rate to nearest supported value.
	 *
	 * NOTE: If unsupported values are set directly, the PL2303 seems to
	 *       use 9600 baud.
	 */
	baud = pl2303_get_supported_baud_rate(baud);

387
	if (baud <= 115200)
388
		put_unaligned_le32(baud, buf);
389
390
	else
		baud = pl2303_encode_baud_rate_divisor(buf, baud);
391

392
	/* Save resulting baud rate */
393
	tty_encode_baud_rate(tty, baud, baud);
394
	dev_dbg(&port->dev, "baud set = %u\n", baud);
395
396
}

397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
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
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;
}

443
444
445
446
447
448
449
450
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;
451
	int ret;
452
453
454
455
456
457
458
459
460
461
462
463
464
	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;
	}

465
	pl2303_get_line_request(port, buf);
466

467
468
469
470
471
472
473
474
475
476
477
478
479
	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;
480
	}
481
	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
482

483
	/* For reference buf[0]:buf[3] baud rate value */
484
	pl2303_encode_baud_rate(tty, port, &buf[0]);
485

Linus Torvalds's avatar
Linus Torvalds committed
486
487
488
	/* 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 */
489
490
491
	if (C_CSTOPB(tty)) {
		/*
		 * NOTE: Comply with "real" UARTs / RS232:
492
493
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
494
		if (C_CSIZE(tty) == CS5) {
495
			buf[4] = 1;
496
			dev_dbg(&port->dev, "stop bits = 1.5\n");
497
498
		} else {
			buf[4] = 2;
499
			dev_dbg(&port->dev, "stop bits = 2\n");
500
		}
Linus Torvalds's avatar
Linus Torvalds committed
501
502
	} else {
		buf[4] = 0;
503
		dev_dbg(&port->dev, "stop bits = 1\n");
Linus Torvalds's avatar
Linus Torvalds committed
504
505
	}

506
	if (C_PARENB(tty)) {
Linus Torvalds's avatar
Linus Torvalds committed
507
508
509
510
511
		/* 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 */
512
513
		if (C_PARODD(tty)) {
			if (tty->termios.c_cflag & CMSPAR) {
514
				buf[5] = 3;
515
				dev_dbg(&port->dev, "parity = mark\n");
516
517
			} else {
				buf[5] = 1;
518
				dev_dbg(&port->dev, "parity = odd\n");
519
			}
Linus Torvalds's avatar
Linus Torvalds committed
520
		} else {
521
			if (tty->termios.c_cflag & CMSPAR) {
522
				buf[5] = 4;
523
				dev_dbg(&port->dev, "parity = space\n");
524
525
			} else {
				buf[5] = 2;
526
				dev_dbg(&port->dev, "parity = even\n");
527
			}
Linus Torvalds's avatar
Linus Torvalds committed
528
529
530
		}
	} else {
		buf[5] = 0;
531
		dev_dbg(&port->dev, "parity = none\n");
Linus Torvalds's avatar
Linus Torvalds committed
532
533
	}

534
535
536
537
538
539
540
541
542
543
544
545
546
	/*
	 * 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)) {
547
548
		ret = pl2303_set_line_request(port, buf);
		if (!ret)
549
550
			memcpy(priv->line_settings, buf, 7);
	}
Linus Torvalds's avatar
Linus Torvalds committed
551
552
553
554

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
555
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
556
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
557
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
558
559
560
561
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
562
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
563
564
565
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
566

567
	if (C_CRTSCTS(tty)) {
568
		if (spriv->quirks & PL2303_QUIRK_LEGACY)
569
			pl2303_vendor_write(serial, 0x0, 0x41);
570
571
		else
			pl2303_vendor_write(serial, 0x0, 0x61);
t.sefzick's avatar
t.sefzick committed
572
	} else {
573
		pl2303_vendor_write(serial, 0x0, 0x0);
Linus Torvalds's avatar
Linus Torvalds committed
574
	}
575
576
577
578

	kfree(buf);
}

579
580
581
582
583
584
585
586
587
588
589
590
591
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);
592

593
	pl2303_set_control_lines(port, control);
594
595
596
}

static void pl2303_close(struct usb_serial_port *port)
597
{
Johan Hovold's avatar
Johan Hovold committed
598
	usb_serial_generic_close(port);
599
	usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds's avatar
Linus Torvalds committed
600
601
}

602
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
603
604
{
	struct usb_serial *serial = port->serial;
605
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
606
607
	int result;

608
	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
609
610
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
611
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
612
		/* reset upstream data pipes */
613
614
		pl2303_vendor_write(serial, 8, 0);
		pl2303_vendor_write(serial, 9, 0);
Linus Torvalds's avatar
Linus Torvalds committed
615
616
617
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
618
	if (tty)
619
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
620

621
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
622
	if (result) {
623
624
		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
			result);
625
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
626
	}
627

628
	result = usb_serial_generic_open(tty, port);
629
630
631
632
633
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
634
635
636
	return 0;
}

637
static int pl2303_tiocmset(struct tty_struct *tty,
638
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
639
{
Alan Cox's avatar
Alan Cox committed
640
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
641
642
643
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
644
	int ret;
645

646
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
647
648
649
650
651
652
653
654
655
	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;
656
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
657

658
659
660
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
661

662
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
663
664
}

665
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
666
{
Alan Cox's avatar
Alan Cox committed
667
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
668
669
670
671
672
673
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

674
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
675
676
	mcr = priv->line_control;
	status = priv->line_status;
677
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
678
679
680
681
682
683
684
685

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

686
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
687
688
689
690

	return result;
}

691
692
693
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
694

695
696
	if (priv->line_status & UART_DCD)
		return 1;
697

698
699
700
	return 0;
}

701
static int pl2303_tiocmiwait(struct tty_struct *tty, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
702
{
703
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
704
705
706
707
708
709
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int prevstatus;
	unsigned int status;
	unsigned int changed;

710
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
711
	prevstatus = priv->line_status;
712
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
713
714

	while (1) {
715
		interruptible_sleep_on(&port->port.delta_msr_wait);
Linus Torvalds's avatar
Linus Torvalds committed
716
717
718
		/* see if a signal did it */
		if (signal_pending(current))
			return -ERESTARTSYS;
719

720
721
722
		if (port->serial->disconnected)
			return -EIO;

723
		spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
724
		status = priv->line_status;
725
726
		spin_unlock_irqrestore(&priv->lock, flags);

Alan Cox's avatar
Alan Cox committed
727
		changed = prevstatus ^ status;
728

Linus Torvalds's avatar
Linus Torvalds committed
729
730
731
		if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
		    ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
		    ((arg & TIOCM_CD)  && (changed & UART_DCD)) ||
Alan Cox's avatar
Alan Cox committed
732
		    ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
Linus Torvalds's avatar
Linus Torvalds committed
733
734
735
736
737
738
739
740
			return 0;
		}
		prevstatus = status;
	}
	/* NOTREACHED */
	return 0;
}

741
static int pl2303_ioctl(struct tty_struct *tty,
742
			unsigned int cmd, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
743
{
744
	struct serial_struct ser;
Alan Cox's avatar
Alan Cox committed
745
	struct usb_serial_port *port = tty->driver_data;
746

Linus Torvalds's avatar
Linus Torvalds committed
747
	switch (cmd) {
748
749
750
	case TIOCGSERIAL:
		memset(&ser, 0, sizeof ser);
		ser.type = PORT_16654;
751
		ser.line = port->minor;
752
		ser.port = port->port_number;
753
754
755
756
757
758
		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
759
760
	default:
		break;
Linus Torvalds's avatar
Linus Torvalds committed
761
	}
762

Linus Torvalds's avatar
Linus Torvalds committed
763
764
765
	return -ENOIOCTLCMD;
}

Alan Cox's avatar
Alan Cox committed
766
static void pl2303_break_ctl(struct tty_struct *tty, int break_state)
Linus Torvalds's avatar
Linus Torvalds committed
767
{
Alan Cox's avatar
Alan Cox committed
768
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
769
770
771
772
773
774
775
776
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

	if (break_state == 0)
		state = BREAK_OFF;
	else
		state = BREAK_ON;
777

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

781
782
783
	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
784
	if (result)
785
		dev_err(&port->dev, "error sending break = %d\n", result);
Linus Torvalds's avatar
Linus Torvalds committed
786
787
}

Flavio Leitner's avatar
Flavio Leitner committed
788
789
790
791
static void pl2303_update_line_status(struct usb_serial_port *port,
				      unsigned char *data,
				      unsigned int actual_length)
{
792
793
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Flavio Leitner's avatar
Flavio Leitner committed
794
	struct pl2303_private *priv = usb_get_serial_port_data(port);
795
	struct tty_struct *tty;
Flavio Leitner's avatar
Flavio Leitner committed
796
	unsigned long flags;
797
	unsigned int status_idx = UART_STATE_INDEX;
798
	u8 prev_line_status;
Flavio Leitner's avatar
Flavio Leitner committed
799

800
801
	if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
		status_idx = 0;
Flavio Leitner's avatar
Flavio Leitner committed
802

803
	if (actual_length < status_idx + 1)
804
		return;
Flavio Leitner's avatar
Flavio Leitner committed
805

Alan Cox's avatar
Alan Cox committed
806
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
807
	spin_lock_irqsave(&priv->lock, flags);
808
	prev_line_status = priv->line_status;
Flavio Leitner's avatar
Flavio Leitner committed
809
810
	priv->line_status = data[status_idx];
	spin_unlock_irqrestore(&priv->lock, flags);
811

812
813
	if (priv->line_status & UART_BREAK_ERROR)
		usb_serial_handle_break(port);
814

815
	wake_up_interruptible(&port->port.delta_msr_wait);
816
817
818
819
820
821
822
823

	tty = tty_port_tty_get(&port->port);
	if (!tty)
		return;
	if ((priv->line_status ^ prev_line_status) & UART_DCD)
		usb_serial_handle_dcd_change(port, tty,
				priv->line_status & UART_DCD);
	tty_kref_put(tty);
Flavio Leitner's avatar
Flavio Leitner committed
824
}
Linus Torvalds's avatar
Linus Torvalds committed
825

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

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

851
	usb_serial_debug_data(&port->dev, __func__,
852
853
			      urb->actual_length, urb->transfer_buffer);

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

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

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

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

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

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

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

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

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

947
module_usb_serial_driver(serial_drivers, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
948

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