pl2303.c 24.8 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
/*
 * 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;
}

354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
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;
}

376
377
378
379
380
381
382
383
384
385
386
387
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;
388
389
390

	if (spriv->type->max_baud_rate)
		baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
391
392

	/* Set baud rate to nearest supported value. */
393
394
	baud = pl2303_get_supported_baud_rate(baud);

395
	if (baud <= 115200)
396
		baud = pl2303_encode_baud_rate_direct(buf, baud);
397
398
	else
		baud = pl2303_encode_baud_rate_divisor(buf, baud);
399

400
	/* Save resulting baud rate */
401
	tty_encode_baud_rate(tty, baud, baud);
402
	dev_dbg(&port->dev, "baud set = %u\n", baud);
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
443
444
445
446
447
448
449
450
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;
}

451
452
453
454
455
456
457
458
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;
459
	int ret;
460
461
462
463
464
465
466
467
468
469
470
471
472
	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;
	}

473
	pl2303_get_line_request(port, buf);
474

475
476
477
478
479
480
481
482
483
484
485
486
487
	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;
488
	}
489
	dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
490

491
	/* For reference buf[0]:buf[3] baud rate value */
492
	pl2303_encode_baud_rate(tty, port, &buf[0]);
493

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

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

542
543
544
545
546
547
548
549
550
551
552
553
554
	/*
	 * 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)) {
555
556
		ret = pl2303_set_line_request(port, buf);
		if (!ret)
557
558
			memcpy(priv->line_settings, buf, 7);
	}
Linus Torvalds's avatar
Linus Torvalds committed
559
560
561
562

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
563
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
564
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
565
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
566
567
568
569
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
570
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
571
572
573
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
574

575
	if (C_CRTSCTS(tty)) {
576
		if (spriv->quirks & PL2303_QUIRK_LEGACY)
577
			pl2303_vendor_write(serial, 0x0, 0x41);
578
579
		else
			pl2303_vendor_write(serial, 0x0, 0x61);
t.sefzick's avatar
t.sefzick committed
580
	} else {
581
		pl2303_vendor_write(serial, 0x0, 0x0);
Linus Torvalds's avatar
Linus Torvalds committed
582
	}
583
584
585
586

	kfree(buf);
}

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

601
	pl2303_set_control_lines(port, control);
602
603
604
}

static void pl2303_close(struct usb_serial_port *port)
605
{
Johan Hovold's avatar
Johan Hovold committed
606
	usb_serial_generic_close(port);
607
	usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds's avatar
Linus Torvalds committed
608
609
}

610
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
611
612
{
	struct usb_serial *serial = port->serial;
613
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
614
615
	int result;

616
	if (spriv->quirks & PL2303_QUIRK_LEGACY) {
617
618
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
619
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
620
		/* reset upstream data pipes */
621
622
		pl2303_vendor_write(serial, 8, 0);
		pl2303_vendor_write(serial, 9, 0);
Linus Torvalds's avatar
Linus Torvalds committed
623
624
625
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
626
	if (tty)
627
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
628

629
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
630
	if (result) {
631
632
		dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
			result);
633
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
634
	}
635

636
	result = usb_serial_generic_open(tty, port);
637
638
639
640
641
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
642
643
644
	return 0;
}

645
static int pl2303_tiocmset(struct tty_struct *tty,
646
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
647
{
Alan Cox's avatar
Alan Cox committed
648
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
649
650
651
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
652
	int ret;
653

654
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
655
656
657
658
659
660
661
662
663
	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;
664
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
665

666
667
668
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
669

670
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
671
672
}

673
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
674
{
Alan Cox's avatar
Alan Cox committed
675
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
676
677
678
679
680
681
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

682
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
683
684
	mcr = priv->line_control;
	status = priv->line_status;
685
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
686
687
688
689
690
691
692
693

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

694
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
695
696
697
698

	return result;
}

699
700
701
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
702

703
704
	if (priv->line_status & UART_DCD)
		return 1;
705

706
707
708
	return 0;
}

709
static int pl2303_tiocmiwait(struct tty_struct *tty, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
710
{
711
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
712
713
714
715
716
717
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int prevstatus;
	unsigned int status;
	unsigned int changed;

718
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
719
	prevstatus = priv->line_status;
720
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
721
722

	while (1) {
723
		interruptible_sleep_on(&port->port.delta_msr_wait);
Linus Torvalds's avatar
Linus Torvalds committed
724
725
726
		/* see if a signal did it */
		if (signal_pending(current))
			return -ERESTARTSYS;
727

728
729
730
		if (port->serial->disconnected)
			return -EIO;

731
		spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
732
		status = priv->line_status;
733
734
		spin_unlock_irqrestore(&priv->lock, flags);

Alan Cox's avatar
Alan Cox committed
735
		changed = prevstatus ^ status;
736

Linus Torvalds's avatar
Linus Torvalds committed
737
738
739
		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
740
		    ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
Linus Torvalds's avatar
Linus Torvalds committed
741
742
743
744
745
746
747
748
			return 0;
		}
		prevstatus = status;
	}
	/* NOTREACHED */
	return 0;
}

749
static int pl2303_ioctl(struct tty_struct *tty,
750
			unsigned int cmd, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
751
{
752
	struct serial_struct ser;
Alan Cox's avatar
Alan Cox committed
753
	struct usb_serial_port *port = tty->driver_data;
754

Linus Torvalds's avatar
Linus Torvalds committed
755
	switch (cmd) {
756
757
758
	case TIOCGSERIAL:
		memset(&ser, 0, sizeof ser);
		ser.type = PORT_16654;
759
		ser.line = port->minor;
760
		ser.port = port->port_number;
761
762
763
764
765
766
		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
767
768
	default:
		break;
Linus Torvalds's avatar
Linus Torvalds committed
769
	}
770

Linus Torvalds's avatar
Linus Torvalds committed
771
772
773
	return -ENOIOCTLCMD;
}

Alan Cox's avatar
Alan Cox committed
774
static void pl2303_break_ctl(struct tty_struct *tty, int break_state)
Linus Torvalds's avatar
Linus Torvalds committed
775
{
Alan Cox's avatar
Alan Cox committed
776
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
777
778
779
780
781
782
783
784
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

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

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

789
790
791
	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
792
	if (result)
793
		dev_err(&port->dev, "error sending break = %d\n", result);
Linus Torvalds's avatar
Linus Torvalds committed
794
795
}

Flavio Leitner's avatar
Flavio Leitner committed
796
797
798
799
static void pl2303_update_line_status(struct usb_serial_port *port,
				      unsigned char *data,
				      unsigned int actual_length)
{
800
801
	struct usb_serial *serial = port->serial;
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Flavio Leitner's avatar
Flavio Leitner committed
802
	struct pl2303_private *priv = usb_get_serial_port_data(port);
803
	struct tty_struct *tty;
Flavio Leitner's avatar
Flavio Leitner committed
804
	unsigned long flags;
805
	unsigned int status_idx = UART_STATE_INDEX;
806
	u8 prev_line_status;
Flavio Leitner's avatar
Flavio Leitner committed
807

808
809
	if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
		status_idx = 0;
Flavio Leitner's avatar
Flavio Leitner committed
810

811
	if (actual_length < status_idx + 1)
812
		return;
Flavio Leitner's avatar
Flavio Leitner committed
813

Alan Cox's avatar
Alan Cox committed
814
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
815
	spin_lock_irqsave(&priv->lock, flags);
816
	prev_line_status = priv->line_status;
Flavio Leitner's avatar
Flavio Leitner committed
817
818
	priv->line_status = data[status_idx];
	spin_unlock_irqrestore(&priv->lock, flags);
819

820
821
	if (priv->line_status & UART_BREAK_ERROR)
		usb_serial_handle_break(port);
822

823
	wake_up_interruptible(&port->port.delta_msr_wait);
824
825
826
827
828
829
830
831

	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
832
}
Linus Torvalds's avatar
Linus Torvalds committed
833

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

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

859
	usb_serial_debug_data(&port->dev, __func__,
860
861
			      urb->actual_length, urb->transfer_buffer);

Flavio Leitner's avatar
Flavio Leitner committed
862
	pl2303_update_line_status(port, data, actual_length);
Linus Torvalds's avatar
Linus Torvalds committed
863
864

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

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

892
893
894
895
	/*
	 * Break takes precedence over parity, which takes precedence over
	 * framing errors.
	 */
896
897
898
899
900
901
902
	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;

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

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

Jiri Slaby's avatar
Jiri Slaby committed
920
	tty_flip_buffer_push(&port->port);
Linus Torvalds's avatar
Linus Torvalds committed
921
922
}

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

951
952
953
954
static struct usb_serial_driver * const serial_drivers[] = {
	&pl2303_device, NULL
};

955
module_usb_serial_driver(serial_drivers, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
956

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