pl2303.c 25 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
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
52
	{ USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID2) },
Linus Torvalds's avatar
Linus Torvalds committed
53
54
55
56
	{ 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) },
57
	{ USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
Linus Torvalds's avatar
Linus Torvalds committed
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) },
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
88
89
	{ 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) },
90
	{ USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
91
	{ USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
92
	{ USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
93
	{ USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
94
	{ USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
95
	{ USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
Linus Torvalds's avatar
Linus Torvalds committed
96
97
98
	{ }					/* Terminating entry */
};

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

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

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

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

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

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

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

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

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

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

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

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

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

191
	return 0;
192
193
}

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

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

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

210
	return 0;
211
212
}

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

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

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

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

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

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

251
	usb_set_serial_data(serial, spriv);
252

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

	kfree(buf);
269

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

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

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

292
293
	port->port.drain_delay = 256;

294
295
296
297
298
	return 0;
}

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

	kfree(priv);

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

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

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

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

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

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

334
	unsigned i;
335

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

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

348
349
350
	return baud;
}

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

363
364
365
static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
								speed_t baud)
{
366
	unsigned int baseline, mantissa, exponent;
367
368
369

	/*
	 * Apparently the formula is:
370
371
372
373
	 *   baudrate = 12M * 32 / (mantissa * 4^exponent)
	 * where
	 *   mantissa = buf[8:0]
	 *   exponent = buf[11:9]
374
	 */
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
	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;
		}
	}

391
392
	buf[3] = 0x80;
	buf[2] = 0;
393
394
395
396
397
	buf[1] = exponent << 1 | mantissa >> 8;
	buf[0] = mantissa & 0xff;

	/* Calculate and return the exact baud rate. */
	baud = (baseline / mantissa) >> (exponent << 1);
398
399
400
401

	return baud;
}

402
403
404
405
406
407
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);
408
	speed_t	baud_sup;
409
410
411
412
413
414
	speed_t baud;

	baud = tty_get_baud_rate(tty);
	dev_dbg(&port->dev, "baud requested = %u\n", baud);
	if (!baud)
		return;
415
416
417

	if (spriv->type->max_baud_rate)
		baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
418
	/*
419
	 * Use direct method for supported baud rates, otherwise use divisors.
420
421
	 */
	baud_sup = pl2303_get_supported_baud_rate(baud);
422

423
424
	if (baud == baud_sup)
		baud = pl2303_encode_baud_rate_direct(buf, baud);
425
	else
426
		baud = pl2303_encode_baud_rate_divisor(buf, baud);
427

428
	/* Save resulting baud rate */
429
	tty_encode_baud_rate(tty, baud, baud);
430
	dev_dbg(&port->dev, "baud set = %u\n", baud);
431
432
}

433
434
435
436
437
438
439
440
441
442
443
444
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);

445
		if (ret >= 0)
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
			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);
465
	if (ret < 0) {
466
467
468
469
470
471
472
473
474
		dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
		return ret;
	}

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

	return 0;
}

475
476
477
478
479
480
481
482
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;
483
	int ret;
484
485
486
487
488
489
490
491
492
493
494
495
496
	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;
	}

497
	pl2303_get_line_request(port, buf);
498

499
500
501
502
503
504
505
506
507
508
509
510
511
	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;
512
	}
513
	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
514

515
	/* For reference buf[0]:buf[3] baud rate value */
516
	pl2303_encode_baud_rate(tty, port, &buf[0]);
517

Linus Torvalds's avatar
Linus Torvalds committed
518
519
520
	/* 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 */
521
522
523
	if (C_CSTOPB(tty)) {
		/*
		 * NOTE: Comply with "real" UARTs / RS232:
524
525
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
526
		if (C_CSIZE(tty) == CS5) {
527
			buf[4] = 1;
528
			dev_dbg(&port->dev, "stop bits = 1.5\n");
529
530
		} else {
			buf[4] = 2;
531
			dev_dbg(&port->dev, "stop bits = 2\n");
532
		}
Linus Torvalds's avatar
Linus Torvalds committed
533
534
	} else {
		buf[4] = 0;
535
		dev_dbg(&port->dev, "stop bits = 1\n");
Linus Torvalds's avatar
Linus Torvalds committed
536
537
	}

538
	if (C_PARENB(tty)) {
Linus Torvalds's avatar
Linus Torvalds committed
539
540
541
542
543
		/* 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 */
544
		if (C_PARODD(tty)) {
Johan Hovold's avatar
Johan Hovold committed
545
			if (C_CMSPAR(tty)) {
546
				buf[5] = 3;
547
				dev_dbg(&port->dev, "parity = mark\n");
548
549
			} else {
				buf[5] = 1;
550
				dev_dbg(&port->dev, "parity = odd\n");
551
			}
Linus Torvalds's avatar
Linus Torvalds committed
552
		} else {
Johan Hovold's avatar
Johan Hovold committed
553
			if (C_CMSPAR(tty)) {
554
				buf[5] = 4;
555
				dev_dbg(&port->dev, "parity = space\n");
556
557
			} else {
				buf[5] = 2;
558
				dev_dbg(&port->dev, "parity = even\n");
559
			}
Linus Torvalds's avatar
Linus Torvalds committed
560
561
562
		}
	} else {
		buf[5] = 0;
563
		dev_dbg(&port->dev, "parity = none\n");
Linus Torvalds's avatar
Linus Torvalds committed
564
565
	}

566
567
568
569
570
571
572
573
574
575
576
577
578
	/*
	 * 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)) {
579
580
		ret = pl2303_set_line_request(port, buf);
		if (!ret)
581
582
			memcpy(priv->line_settings, buf, 7);
	}
Linus Torvalds's avatar
Linus Torvalds committed
583
584
585
586

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
587
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
588
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
589
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
590
591
592
593
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
594
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
595
596
597
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
598

599
	if (C_CRTSCTS(tty)) {
600
		if (spriv->quirks & PL2303_QUIRK_LEGACY)
601
			pl2303_vendor_write(serial, 0x0, 0x41);
602
603
		else
			pl2303_vendor_write(serial, 0x0, 0x61);
t.sefzick's avatar
t.sefzick committed
604
	} else {
605
		pl2303_vendor_write(serial, 0x0, 0x0);
Linus Torvalds's avatar
Linus Torvalds committed
606
	}
607
608
609
610

	kfree(buf);
}

611
612
613
614
615
616
617
618
619
620
621
622
623
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);
624

625
	pl2303_set_control_lines(port, control);
626
627
628
}

static void pl2303_close(struct usb_serial_port *port)
629
{
Johan Hovold's avatar
Johan Hovold committed
630
	usb_serial_generic_close(port);
631
	usb_kill_urb(port->interrupt_in_urb);
632
	pl2303_set_break(port, false);
Linus Torvalds's avatar
Linus Torvalds committed
633
634
}

635
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
636
637
{
	struct usb_serial *serial = port->serial;
638
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
639
640
	int result;

641
	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
642
643
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
644
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
645
		/* reset upstream data pipes */
646
647
		pl2303_vendor_write(serial, 8, 0);
		pl2303_vendor_write(serial, 9, 0);
Linus Torvalds's avatar
Linus Torvalds committed
648
649
650
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
651
	if (tty)
652
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
653

654
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
655
	if (result) {
656
657
		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
			result);
658
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
659
	}
660

661
	result = usb_serial_generic_open(tty, port);
662
663
664
665
666
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
667
668
669
	return 0;
}

670
static int pl2303_tiocmset(struct tty_struct *tty,
671
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
672
{
Alan Cox's avatar
Alan Cox committed
673
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
674
675
676
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
677
	int ret;
678

679
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
680
681
682
683
684
685
686
687
688
	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;
689
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
690

691
692
693
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
694

695
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
696
697
}

698
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
699
{
Alan Cox's avatar
Alan Cox committed
700
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
701
702
703
704
705
706
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

707
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
708
709
	mcr = priv->line_control;
	status = priv->line_status;
710
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
711
712
713
714
715
716
717
718

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

719
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
720
721
722
723

	return result;
}

724
725
726
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
727

728
729
	if (priv->line_status & UART_DCD)
		return 1;
730

731
732
733
	return 0;
}

734
static int pl2303_ioctl(struct tty_struct *tty,
735
			unsigned int cmd, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
736
{
737
	struct serial_struct ser;
Alan Cox's avatar
Alan Cox committed
738
	struct usb_serial_port *port = tty->driver_data;
739

Linus Torvalds's avatar
Linus Torvalds committed
740
	switch (cmd) {
741
742
743
	case TIOCGSERIAL:
		memset(&ser, 0, sizeof ser);
		ser.type = PORT_16654;
744
		ser.line = port->minor;
745
		ser.port = port->port_number;
746
747
748
749
750
751
		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
752
753
	default:
		break;
Linus Torvalds's avatar
Linus Torvalds committed
754
	}
755

Linus Torvalds's avatar
Linus Torvalds committed
756
757
758
	return -ENOIOCTLCMD;
}

759
static void pl2303_set_break(struct usb_serial_port *port, bool enable)
Linus Torvalds's avatar
Linus Torvalds committed
760
761
762
763
764
{
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

765
	if (enable)
Linus Torvalds's avatar
Linus Torvalds committed
766
		state = BREAK_ON;
767
768
	else
		state = BREAK_OFF;
769

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

773
774
775
	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
776
	if (result)
777
		dev_err(&port->dev, "error sending break = %d\n", result);
Linus Torvalds's avatar
Linus Torvalds committed
778
779
}

780
781
782
783
784
785
786
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
787
788
789
790
static void pl2303_update_line_status(struct usb_serial_port *port,
				      unsigned char *data,
				      unsigned int actual_length)
{
791
792
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Flavio Leitner's avatar
Flavio Leitner committed
793
	struct pl2303_private *priv = usb_get_serial_port_data(port);
794
	struct tty_struct *tty;
Flavio Leitner's avatar
Flavio Leitner committed
795
	unsigned long flags;
796
	unsigned int status_idx = UART_STATE_INDEX;
797
798
	u8 status;
	u8 delta;
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

806
807
	status = data[status_idx];

Alan Cox's avatar
Alan Cox committed
808
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
809
	spin_lock_irqsave(&priv->lock, flags);
810
811
	delta = priv->line_status ^ status;
	priv->line_status = status;
Flavio Leitner's avatar
Flavio Leitner committed
812
	spin_unlock_irqrestore(&priv->lock, flags);
813

814
	if (status & UART_BREAK_ERROR)
815
		usb_serial_handle_break(port);
816

817
	if (delta & UART_STATE_MSR_MASK) {
818
819
820
821
822
823
		if (delta & UART_CTS)
			port->icount.cts++;
		if (delta & UART_DSR)
			port->icount.dsr++;
		if (delta & UART_RING)
			port->icount.rng++;
824
		if (delta & UART_DCD) {
825
			port->icount.dcd++;
826
827
828
			tty = tty_port_tty_get(&port->port);
			if (tty) {
				usb_serial_handle_dcd_change(port, tty,
829
							status & UART_DCD);
830
831
				tty_kref_put(tty);
			}
832
		}
833
834

		wake_up_interruptible(&port->port.delta_msr_wait);
835
	}
Flavio Leitner's avatar
Flavio Leitner committed
836
}
Linus Torvalds's avatar
Linus Torvalds committed
837

838
static void pl2303_read_int_callback(struct urb *urb)
Linus Torvalds's avatar
Linus Torvalds committed
839
{
840
	struct usb_serial_port *port =  urb->context;
Linus Torvalds's avatar
Linus Torvalds committed
841
	unsigned char *data = urb->transfer_buffer;
Flavio Leitner's avatar
Flavio Leitner committed
842
	unsigned int actual_length = urb->actual_length;
843
844
	int status = urb->status;
	int retval;
Linus Torvalds's avatar
Linus Torvalds committed
845

846
	switch (status) {
Linus Torvalds's avatar
Linus Torvalds committed
847
848
849
850
851
852
853
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
854
855
		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
856
857
		return;
	default:
858
859
		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
860
861
862
		goto exit;
	}

863
	usb_serial_debug_data(&port->dev, __func__,
864
865
			      urb->actual_length, urb->transfer_buffer);

Flavio Leitner's avatar
Flavio Leitner committed
866
	pl2303_update_line_status(port, data, actual_length);
Linus Torvalds's avatar
Linus Torvalds committed
867
868

exit:
869
	retval = usb_submit_urb(urb, GFP_ATOMIC);
870
	if (retval) {
871
		dev_err(&port->dev,
872
			"%s - usb_submit_urb failed with result %d\n",
873
			__func__, retval);
874
	}
Linus Torvalds's avatar
Linus Torvalds committed
875
876
}

877
static void pl2303_process_read_urb(struct urb *urb)
878
{
879
880
	struct usb_serial_port *port = urb->context;
	struct pl2303_private *priv = usb_get_serial_port_data(port);
881
882
	unsigned char *data = urb->transfer_buffer;
	char tty_flag = TTY_NORMAL;
883
884
885
886
887
888
889
890
891
892
893
894
895
	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;

896
897
898
899
	/*
	 * Break takes precedence over parity, which takes precedence over
	 * framing errors.
	 */
900
901
902
903
904
905
906
	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;

907
908
909
	if (tty_flag != TTY_NORMAL)
		dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
								tty_flag);
910
911
	/* overrun is special, not associated with a char */
	if (line_status & UART_OVERRUN_ERROR)
Jiri Slaby's avatar
Jiri Slaby committed
912
		tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
913

914
	if (port->port.console && port->sysrq) {
915
		for (i = 0; i < urb->actual_length; ++i)
916
			if (!usb_serial_handle_sysrq_char(port, data[i]))
Jiri Slaby's avatar
Jiri Slaby committed
917
918
				tty_insert_flip_char(&port->port, data[i],
						tty_flag);
919
	} else {
920
		tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
921
							urb->actual_length);
922
	}
Linus Torvalds's avatar
Linus Torvalds committed
923

Jiri Slaby's avatar
Jiri Slaby committed
924
	tty_flip_buffer_push(&port->port);
Linus Torvalds's avatar
Linus Torvalds committed
925
926
}

927
928
929
930
931
932
933
static struct usb_serial_driver pl2303_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"pl2303",
	},
	.id_table =		id_table,
	.num_ports =		1,
934
935
936
	.num_bulk_in =		1,
	.num_bulk_out =		1,
	.num_interrupt_in =	1,
937
	.bulk_in_size =		256,
938
	.bulk_out_size =	256,
939
940
	.open =			pl2303_open,
	.close =		pl2303_close,
941
	.dtr_rts =		pl2303_dtr_rts,
942
	.carrier_raised =	pl2303_carrier_raised,
943
944
945
946
947
	.ioctl =		pl2303_ioctl,
	.break_ctl =		pl2303_break_ctl,
	.set_termios =		pl2303_set_termios,
	.tiocmget =		pl2303_tiocmget,
	.tiocmset =		pl2303_tiocmset,
948
	.tiocmiwait =		usb_serial_generic_tiocmiwait,
949
	.process_read_urb =	pl2303_process_read_urb,
950
	.read_int_callback =	pl2303_read_int_callback,
951
	.probe =		pl2303_probe,
952
	.attach =		pl2303_startup,
953
	.release =		pl2303_release,
954
955
	.port_probe =		pl2303_port_probe,
	.port_remove =		pl2303_port_remove,
956
};