pl2303.c 25.3 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
 * Copyright (C) 2003 IBM Corp.
 *
7
8
9
10
11
 * Copyright (C) 2009, 2013 Frank Schäfer <fschaefer.oss@googlemail.com>
 *  - fixes, improvements and documentation for the baud rate encoding methods
 * Copyright (C) 2013 Reinhard Max <max@suse.de>
 *  - fixes and improvements for the divisor based baud rate encoding method
 *
Linus Torvalds's avatar
Linus Torvalds committed
12
13
 * Original driver for 2.2.x by anonymous
 *
14
15
16
 *	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
17
 *
Alan Cox's avatar
Alan Cox committed
18
19
 * See Documentation/usb/usb-serial.txt for more information on using this
 * driver
Linus Torvalds's avatar
Linus Torvalds committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 *
 */

#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
34
#include <linux/uaccess.h>
Linus Torvalds's avatar
Linus Torvalds committed
35
#include <linux/usb.h>
36
#include <linux/usb/serial.h>
37
#include <asm/unaligned.h>
Linus Torvalds's avatar
Linus Torvalds committed
38
39
40
41
42
43
44
#include "pl2303.h"

/*
 * Version Information
 */
#define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"

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

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

#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
111
#define BREAK_REQUEST			0x23
Linus Torvalds's avatar
Linus Torvalds committed
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#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

#define UART_STATE			0x08
#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 {
137
138
139
	type_0,		/* don't know the difference between type 0 and */
	type_1,		/* type 1, until someone from prolific tells us... */
	HX,		/* HX version of the pl2303 chip */
Linus Torvalds's avatar
Linus Torvalds committed
140
141
};

142
143
144
145
struct pl2303_serial_private {
	enum pl2303_type type;
};

Linus Torvalds's avatar
Linus Torvalds committed
146
147
148
149
150
151
struct pl2303_private {
	spinlock_t lock;
	u8 line_control;
	u8 line_status;
};

152
153
154
155
156
157
static int pl2303_vendor_read(__u16 value, __u16 index,
		struct usb_serial *serial, unsigned char *buf)
{
	int res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
			VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
			value, index, buf, 1, 100);
158
	dev_dbg(&serial->interface->dev, "0x%x:0x%x:0x%x:0x%x  %d - %x\n",
159
160
		VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, value, index,
		res, buf[0]);
161
162
163
164
165
166
167
168
169
	return res;
}

static int pl2303_vendor_write(__u16 value, __u16 index,
		struct usb_serial *serial)
{
	int res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
			VENDOR_WRITE_REQUEST, VENDOR_WRITE_REQUEST_TYPE,
			value, index, NULL, 0, 100);
170
	dev_dbg(&serial->interface->dev, "0x%x:0x%x:0x%x:0x%x  %d\n",
171
172
		VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, value, index,
		res);
173
174
175
	return res;
}

176
static int pl2303_startup(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
177
{
178
	struct pl2303_serial_private *spriv;
Linus Torvalds's avatar
Linus Torvalds committed
179
	enum pl2303_type type = type_0;
180
	unsigned char *buf;
181
182
183
184

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

186
	buf = kmalloc(10, GFP_KERNEL);
187
188
	if (!buf) {
		kfree(spriv);
189
		return -ENOMEM;
190
	}
191

192
	if (serial->dev->descriptor.bDeviceClass == 0x02)
Linus Torvalds's avatar
Linus Torvalds committed
193
		type = type_0;
194
	else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
195
		type = HX;
196
197
198
	else if (serial->dev->descriptor.bDeviceClass == 0x00)
		type = type_1;
	else if (serial->dev->descriptor.bDeviceClass == 0xFF)
Linus Torvalds's avatar
Linus Torvalds committed
199
		type = type_1;
200
	dev_dbg(&serial->interface->dev, "device type: %d\n", type);
Linus Torvalds's avatar
Linus Torvalds committed
201

202
203
	spriv->type = type;
	usb_set_serial_data(serial, spriv);
204
205
206
207
208
209
210
211
212
213
214

	pl2303_vendor_read(0x8484, 0, serial, buf);
	pl2303_vendor_write(0x0404, 0, serial);
	pl2303_vendor_read(0x8484, 0, serial, buf);
	pl2303_vendor_read(0x8383, 0, serial, buf);
	pl2303_vendor_read(0x8484, 0, serial, buf);
	pl2303_vendor_write(0x0404, 1, serial);
	pl2303_vendor_read(0x8484, 0, serial, buf);
	pl2303_vendor_read(0x8383, 0, serial, buf);
	pl2303_vendor_write(0, 1, serial);
	pl2303_vendor_write(1, 0, serial);
215
	if (type == HX)
216
		pl2303_vendor_write(2, 0x44, serial);
217
218
	else
		pl2303_vendor_write(2, 0x24, serial);
219
220

	kfree(buf);
Linus Torvalds's avatar
Linus Torvalds committed
221
	return 0;
222
}
Linus Torvalds's avatar
Linus Torvalds committed
223

224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
static void pl2303_release(struct usb_serial *serial)
{
	struct pl2303_serial_private *spriv;

	spriv = usb_get_serial_data(serial);
	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);

244
245
	port->port.drain_delay = 256;

246
247
248
249
250
251
252
253
254
255
256
	return 0;
}

static int pl2303_port_remove(struct usb_serial_port *port)
{
	struct pl2303_private *priv;

	priv = usb_get_serial_port_data(port);
	kfree(priv);

	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
257
258
}

259
static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
Linus Torvalds's avatar
Linus Torvalds committed
260
{
261
	struct usb_device *dev = port->serial->dev;
Linus Torvalds's avatar
Linus Torvalds committed
262
	int retval;
Alan Cox's avatar
Alan Cox committed
263

264
265
266
	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
				 value, 0, NULL, 0, 100);
267
	dev_dbg(&port->dev, "%s - value = %d, retval = %d\n", __func__,
268
		value, retval);
Linus Torvalds's avatar
Linus Torvalds committed
269
270
271
	return retval;
}

272
273
274
275
276
static int pl2303_baudrate_encode_direct(int baud, enum pl2303_type type,
								      u8 buf[4])
{
	/*
	 * NOTE: Only the values defined in baud_sup are supported !
277
278
	 *       => if unsupported values are set, the PL2303 seems to
	 *	    use 9600 baud (at least my PL2303X always does)
279
280
281
282
	 */
	const int baud_sup[] = { 75, 150, 300, 600, 1200, 1800, 2400, 3600,
				 4800, 7200, 9600, 14400, 19200, 28800, 38400,
				 57600, 115200, 230400, 460800, 614400, 921600,
283
				 1228800, 2457600, 3000000, 6000000 };
284
285
286
287
288
289
290
291
292
293
294
295
296
	int i;

	/* Set baudrate to nearest supported value */
	for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
		if (baud_sup[i] > baud)
			break;
	}
	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];
297
298
	/* type_0, type_1 only support up to 1228800 baud */
	if (type != HX)
299
300
301
302
303
304
305
306
307
308
309
310
311
		baud = min_t(int, baud, 1228800);
	/* Direct (standard) baud rate encoding method */
	put_unaligned_le32(baud, buf);

	return baud;
}

static int pl2303_baudrate_encode_divisor(int baud, enum pl2303_type type,
								      u8 buf[4])
{
	/*
	 * Divisor based baud rate encoding method
	 *
312
	 * NOTE: it's not clear if the type_0/1 chips support this method
313
314
315
316
317
318
319
320
321
322
323
324
325
326
	 *
	 * divisor = 12MHz * 32 / baudrate = 2^A * B
	 *
	 * with
	 *
	 * A = buf[1] & 0x0e
	 * B = buf[0]  +  (buf[1] & 0x01) << 8
	 *
	 * Special cases:
	 * => 8 < B < 16: device seems to work not properly
	 * => B <= 8: device uses the max. value B = 512 instead
	 */
	unsigned int A, B;

327
328
	/* Respect the specified baud rate limits */
	baud = max_t(int, baud, 75);
329
	if (type == HX)
330
		baud = min_t(int, baud, 6000000);
331
	else
332
		baud = min_t(int, baud, 1228800);
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
	/* Determine factors A and B */
	A = 0;
	B = 12000000 * 32 / baud;  /* 12MHz */
	B <<= 1; /* Add one bit for rounding */
	while (B > (512 << 1) && A <= 14) {
		A += 2;
		B >>= 2;
	}
	if (A > 14) { /* max. divisor = min. baudrate reached */
		A = 14;
		B = 512;
		/* => ~45.78 baud */
	} else {
		B = (B + 1) >> 1; /* Round the last bit */
	}
	/* Handle special cases */
	if (B == 512)
		B = 0; /* also: 1 to 8 */
	else if (B < 16)
		/*
		 * NOTE: With the current algorithm this happens
		 * only for A=0 and means that the min. divisor
		 * (respectively: the max. baudrate) is reached.
		 */
		B = 16;		/* => 24 MBaud */
	/* Encode the baud rate */
	buf[3] = 0x80;     /* Select divisor encoding method */
	buf[2] = 0;
	buf[1] = (A & 0x0e);		/* A */
	buf[1] |= ((B & 0x100) >> 8);	/* MSB of B */
	buf[0] = B & 0xff;		/* 8 LSBs of B */
	/* Calculate the actual/resulting baud rate */
	if (B <= 8)
		B = 512;
	baud = 12000000 * 32 / ((1 << A) * B);

	return baud;
}

372
373
static void pl2303_encode_baudrate(struct tty_struct *tty,
					struct usb_serial_port *port,
374
					enum pl2303_type type,
375
					u8 buf[4])
Linus Torvalds's avatar
Linus Torvalds committed
376
{
377
	int baud;
Linus Torvalds's avatar
Linus Torvalds committed
378

Alan Cox's avatar
Alan Cox committed
379
	baud = tty_get_baud_rate(tty);
380
	dev_dbg(&port->dev, "baud requested = %d\n", baud);
381
382
	if (!baud)
		return;
383
384
385
386
387
	/*
	 * There are two methods for setting/encoding the baud rate
	 * 1) Direct method: encodes the baud rate value directly
	 *    => supported by all chip types
	 * 2) Divisor based method: encodes a divisor to a base value (12MHz*32)
388
	 *    => supported by HX chips (and likely not by type_0/1 chips)
389
	 */
390
	if (type != HX || baud <= 115200)
391
392
393
		baud = pl2303_baudrate_encode_direct(baud, type, buf);
	else
		baud = pl2303_baudrate_encode_divisor(baud, type, buf);
394
	/* Save resulting baud rate */
395
396
	tty_encode_baud_rate(tty, baud, baud);
	dev_dbg(&port->dev, "baud set = %d\n", baud);
397
398
399
400
401
402
403
404
405
406
407
408
409
}

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;
	int i;
	u8 control;

410
411
412
413
414
	/*
	 * The PL2303 is reported 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.
	 */
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
	if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
		return;

	buf = kzalloc(7, GFP_KERNEL);
	if (!buf) {
		dev_err(&port->dev, "%s - out of memory.\n", __func__);
		/* Report back no change occurred */
		if (old_termios)
			tty->termios = *old_termios;
		return;
	}

	i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
			    GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
			    0, 0, buf, 7, 100);
	dev_dbg(&port->dev, "0xa1:0x21:0:0  %d - %7ph\n", i, buf);

432
433
	if (C_CSIZE(tty)) {
		switch (C_CSIZE(tty)) {
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
		case CS5:
			buf[6] = 5;
			break;
		case CS6:
			buf[6] = 6;
			break;
		case CS7:
			buf[6] = 7;
			break;
		default:
		case CS8:
			buf[6] = 8;
		}
		dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
	}

450
451
	/* For reference:   buf[0]:buf[3] baud rate value */
	pl2303_encode_baudrate(tty, port, spriv->type, buf);
452

Linus Torvalds's avatar
Linus Torvalds committed
453
454
455
	/* 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 */
456
457
458
	if (C_CSTOPB(tty)) {
		/*
		 * NOTE: Comply with "real" UARTs / RS232:
459
460
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
461
		if (C_CSIZE(tty) == CS5) {
462
			buf[4] = 1;
463
			dev_dbg(&port->dev, "stop bits = 1.5\n");
464
465
		} else {
			buf[4] = 2;
466
			dev_dbg(&port->dev, "stop bits = 2\n");
467
		}
Linus Torvalds's avatar
Linus Torvalds committed
468
469
	} else {
		buf[4] = 0;
470
		dev_dbg(&port->dev, "stop bits = 1\n");
Linus Torvalds's avatar
Linus Torvalds committed
471
472
	}

473
	if (C_PARENB(tty)) {
Linus Torvalds's avatar
Linus Torvalds committed
474
475
476
477
478
		/* 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 */
479
480
		if (C_PARODD(tty)) {
			if (tty->termios.c_cflag & CMSPAR) {
481
				buf[5] = 3;
482
				dev_dbg(&port->dev, "parity = mark\n");
483
484
			} else {
				buf[5] = 1;
485
				dev_dbg(&port->dev, "parity = odd\n");
486
			}
Linus Torvalds's avatar
Linus Torvalds committed
487
		} else {
488
			if (tty->termios.c_cflag & CMSPAR) {
489
				buf[5] = 4;
490
				dev_dbg(&port->dev, "parity = space\n");
491
492
			} else {
				buf[5] = 2;
493
				dev_dbg(&port->dev, "parity = even\n");
494
			}
Linus Torvalds's avatar
Linus Torvalds committed
495
496
497
		}
	} else {
		buf[5] = 0;
498
		dev_dbg(&port->dev, "parity = none\n");
Linus Torvalds's avatar
Linus Torvalds committed
499
500
	}

501
502
503
	i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
			    SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
			    0, 0, buf, 7, 100);
504
	dev_dbg(&port->dev, "0x21:0x20:0:0  %d\n", i);
Linus Torvalds's avatar
Linus Torvalds committed
505
506
507
508

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
509
	if (C_BAUD(tty) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
510
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
511
	else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
Linus Torvalds's avatar
Linus Torvalds committed
512
513
514
515
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
516
		pl2303_set_control_lines(port, control);
Linus Torvalds's avatar
Linus Torvalds committed
517
518
519
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
520

521
	memset(buf, 0, 7);
522
523
524
	i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
			    GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
			    0, 0, buf, 7, 100);
525
	dev_dbg(&port->dev, "0xa1:0x21:0:0  %d - %7ph\n", i, buf);
Linus Torvalds's avatar
Linus Torvalds committed
526

527
	if (C_CRTSCTS(tty)) {
528
		if (spriv->type == HX)
529
			pl2303_vendor_write(0x0, 0x61, serial);
530
531
		else
			pl2303_vendor_write(0x0, 0x41, serial);
t.sefzick's avatar
t.sefzick committed
532
	} else {
533
		pl2303_vendor_write(0x0, 0x0, serial);
Linus Torvalds's avatar
Linus Torvalds committed
534
	}
535
536
537
538

	kfree(buf);
}

539
540
541
542
543
544
545
546
547
548
549
550
551
552
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);
	/* Change DTR and RTS */
	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);
553
	pl2303_set_control_lines(port, control);
554
555
556
}

static void pl2303_close(struct usb_serial_port *port)
557
{
Johan Hovold's avatar
Johan Hovold committed
558
	usb_serial_generic_close(port);
559
	usb_kill_urb(port->interrupt_in_urb);
Linus Torvalds's avatar
Linus Torvalds committed
560
561
}

562
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
563
564
{
	struct usb_serial *serial = port->serial;
565
	struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
Linus Torvalds's avatar
Linus Torvalds committed
566
567
	int result;

568
	if (spriv->type != HX) {
569
570
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
571
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
572
		/* reset upstream data pipes */
573
574
		pl2303_vendor_write(8, 0, serial);
		pl2303_vendor_write(9, 0, serial);
Linus Torvalds's avatar
Linus Torvalds committed
575
576
577
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
578
	if (tty)
579
		pl2303_set_termios(tty, port, NULL);
Linus Torvalds's avatar
Linus Torvalds committed
580

581
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
582
	if (result) {
583
		dev_err(&port->dev, "%s - failed submitting interrupt urb,"
584
			" error %d\n", __func__, result);
585
		return result;
Linus Torvalds's avatar
Linus Torvalds committed
586
	}
587

588
	result = usb_serial_generic_open(tty, port);
589
590
591
592
593
	if (result) {
		usb_kill_urb(port->interrupt_in_urb);
		return result;
	}

Linus Torvalds's avatar
Linus Torvalds committed
594
595
596
	return 0;
}

597
static int pl2303_tiocmset(struct tty_struct *tty,
598
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
599
{
Alan Cox's avatar
Alan Cox committed
600
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
601
602
603
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;
604
	int ret;
605

606
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
607
608
609
610
611
612
613
614
615
	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;
616
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
617

618
619
620
	ret = pl2303_set_control_lines(port, control);
	if (ret)
		return usb_translate_errors(ret);
621

622
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
623
624
}

625
static int pl2303_tiocmget(struct tty_struct *tty)
Linus Torvalds's avatar
Linus Torvalds committed
626
{
Alan Cox's avatar
Alan Cox committed
627
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
628
629
630
631
632
633
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

634
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
635
636
	mcr = priv->line_control;
	status = priv->line_status;
637
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
638
639
640
641
642
643
644
645

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

646
	dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
647
648
649
650

	return result;
}

651
652
653
654
655
656
657
658
static int pl2303_carrier_raised(struct usb_serial_port *port)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	if (priv->line_status & UART_DCD)
		return 1;
	return 0;
}

659
static int pl2303_tiocmiwait(struct tty_struct *tty, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
660
{
661
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
662
663
664
665
666
667
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int prevstatus;
	unsigned int status;
	unsigned int changed;

668
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
669
	prevstatus = priv->line_status;
670
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
671
672

	while (1) {
673
		interruptible_sleep_on(&port->port.delta_msr_wait);
Linus Torvalds's avatar
Linus Torvalds committed
674
675
676
		/* see if a signal did it */
		if (signal_pending(current))
			return -ERESTARTSYS;
677

678
679
680
		if (port->serial->disconnected)
			return -EIO;

681
		spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
682
		status = priv->line_status;
683
684
		spin_unlock_irqrestore(&priv->lock, flags);

Alan Cox's avatar
Alan Cox committed
685
		changed = prevstatus ^ status;
686

Linus Torvalds's avatar
Linus Torvalds committed
687
688
689
		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
690
		    ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
Linus Torvalds's avatar
Linus Torvalds committed
691
692
693
694
695
696
697
698
			return 0;
		}
		prevstatus = status;
	}
	/* NOTREACHED */
	return 0;
}

699
static int pl2303_ioctl(struct tty_struct *tty,
700
			unsigned int cmd, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
701
{
702
	struct serial_struct ser;
Alan Cox's avatar
Alan Cox committed
703
	struct usb_serial_port *port = tty->driver_data;
704
705

	dev_dbg(&port->dev, "%s cmd = 0x%04x\n", __func__, cmd);
Linus Torvalds's avatar
Linus Torvalds committed
706
707

	switch (cmd) {
708
709
710
	case TIOCGSERIAL:
		memset(&ser, 0, sizeof ser);
		ser.type = PORT_16654;
711
		ser.line = port->minor;
712
		ser.port = port->port_number;
713
714
715
716
717
718
		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
719
	default:
720
		dev_dbg(&port->dev, "%s not supported = 0x%04x\n", __func__, cmd);
Alan Cox's avatar
Alan Cox committed
721
		break;
Linus Torvalds's avatar
Linus Torvalds committed
722
723
724
725
	}
	return -ENOIOCTLCMD;
}

Alan Cox's avatar
Alan Cox committed
726
static void pl2303_break_ctl(struct tty_struct *tty, int break_state)
Linus Torvalds's avatar
Linus Torvalds committed
727
{
Alan Cox's avatar
Alan Cox committed
728
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
729
730
731
732
733
734
735
736
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

	if (break_state == 0)
		state = BREAK_OFF;
	else
		state = BREAK_ON;
737
	dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
Alan Cox's avatar
Alan Cox committed
738
			state == BREAK_OFF ? "off" : "on");
Linus Torvalds's avatar
Linus Torvalds committed
739

740
741
742
	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
743
	if (result)
744
		dev_err(&port->dev, "error sending break = %d\n", result);
Linus Torvalds's avatar
Linus Torvalds committed
745
746
}

Flavio Leitner's avatar
Flavio Leitner committed
747
748
749
750
751
752
static void pl2303_update_line_status(struct usb_serial_port *port,
				      unsigned char *data,
				      unsigned int actual_length)
{

	struct pl2303_private *priv = usb_get_serial_port_data(port);
753
	struct tty_struct *tty;
Flavio Leitner's avatar
Flavio Leitner committed
754
755
	unsigned long flags;
	u8 status_idx = UART_STATE;
756
	u8 length = UART_STATE + 1;
757
	u8 prev_line_status;
758
	u16 idv, idp;
Flavio Leitner's avatar
Flavio Leitner committed
759

760
761
762
763
764
765
766
767
768
769
770
771
	idv = le16_to_cpu(port->serial->dev->descriptor.idVendor);
	idp = le16_to_cpu(port->serial->dev->descriptor.idProduct);


	if (idv == SIEMENS_VENDOR_ID) {
		if (idp == SIEMENS_PRODUCT_ID_X65 ||
		    idp == SIEMENS_PRODUCT_ID_SX1 ||
		    idp == SIEMENS_PRODUCT_ID_X75) {

			length = 1;
			status_idx = 0;
		}
Flavio Leitner's avatar
Flavio Leitner committed
772
773
774
	}

	if (actual_length < length)
775
		return;
Flavio Leitner's avatar
Flavio Leitner committed
776

Alan Cox's avatar
Alan Cox committed
777
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
778
	spin_lock_irqsave(&priv->lock, flags);
779
	prev_line_status = priv->line_status;
Flavio Leitner's avatar
Flavio Leitner committed
780
781
	priv->line_status = data[status_idx];
	spin_unlock_irqrestore(&priv->lock, flags);
782
783
	if (priv->line_status & UART_BREAK_ERROR)
		usb_serial_handle_break(port);
784
	wake_up_interruptible(&port->port.delta_msr_wait);
785
786
787
788
789
790
791
792

	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
793
}
Linus Torvalds's avatar
Linus Torvalds committed
794

795
static void pl2303_read_int_callback(struct urb *urb)
Linus Torvalds's avatar
Linus Torvalds committed
796
{
797
	struct usb_serial_port *port =  urb->context;
Linus Torvalds's avatar
Linus Torvalds committed
798
	unsigned char *data = urb->transfer_buffer;
Flavio Leitner's avatar
Flavio Leitner committed
799
	unsigned int actual_length = urb->actual_length;
800
801
	int status = urb->status;
	int retval;
Linus Torvalds's avatar
Linus Torvalds committed
802

803
	switch (status) {
Linus Torvalds's avatar
Linus Torvalds committed
804
805
806
807
808
809
810
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
811
812
		dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
813
814
		return;
	default:
815
816
		dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
			__func__, status);
Linus Torvalds's avatar
Linus Torvalds committed
817
818
819
		goto exit;
	}

820
	usb_serial_debug_data(&port->dev, __func__,
821
822
			      urb->actual_length, urb->transfer_buffer);

Flavio Leitner's avatar
Flavio Leitner committed
823
	pl2303_update_line_status(port, data, actual_length);
Linus Torvalds's avatar
Linus Torvalds committed
824
825

exit:
826
827
	retval = usb_submit_urb(urb, GFP_ATOMIC);
	if (retval)
828
		dev_err(&port->dev,
829
			"%s - usb_submit_urb failed with result %d\n",
830
			__func__, retval);
Linus Torvalds's avatar
Linus Torvalds committed
831
832
}

833
static void pl2303_process_read_urb(struct urb *urb)
834
{
835
836
	struct usb_serial_port *port = urb->context;
	struct pl2303_private *priv = usb_get_serial_port_data(port);
837
838
	unsigned char *data = urb->transfer_buffer;
	char tty_flag = TTY_NORMAL;
839
840
841
842
843
844
845
846
847
	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);
848
	wake_up_interruptible(&port->port.delta_msr_wait);
849
850
851
852

	if (!urb->actual_length)
		return;

853
854
855
856
857
858
859
860
861
	/* break takes precedence over parity, */
	/* which takes precedence over framing errors */
	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;

862
863
864
	if (tty_flag != TTY_NORMAL)
		dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
								tty_flag);
865
866
	/* overrun is special, not associated with a char */
	if (line_status & UART_OVERRUN_ERROR)
Jiri Slaby's avatar
Jiri Slaby committed
867
		tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
868

869
	if (port->port.console && port->sysrq) {
870
		for (i = 0; i < urb->actual_length; ++i)
871
			if (!usb_serial_handle_sysrq_char(port, data[i]))
Jiri Slaby's avatar
Jiri Slaby committed
872
873
				tty_insert_flip_char(&port->port, data[i],
						tty_flag);
874
	} else {
875
		tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
876
							urb->actual_length);
877
	}
Linus Torvalds's avatar
Linus Torvalds committed
878

Jiri Slaby's avatar
Jiri Slaby committed
879
	tty_flip_buffer_push(&port->port);
Linus Torvalds's avatar
Linus Torvalds committed
880
881
}

882
883
884
885
886
887
888
889
/* All of the device info needed for the PL2303 SIO serial converter */
static struct usb_serial_driver pl2303_device = {
	.driver = {
		.owner =	THIS_MODULE,
		.name =		"pl2303",
	},
	.id_table =		id_table,
	.num_ports =		1,
890
	.bulk_in_size =		256,
891
	.bulk_out_size =	256,
892
893
	.open =			pl2303_open,
	.close =		pl2303_close,
894
895
	.dtr_rts = 		pl2303_dtr_rts,
	.carrier_raised =	pl2303_carrier_raised,
896
897
898
899
900
	.ioctl =		pl2303_ioctl,
	.break_ctl =		pl2303_break_ctl,
	.set_termios =		pl2303_set_termios,
	.tiocmget =		pl2303_tiocmget,
	.tiocmset =		pl2303_tiocmset,
901
	.tiocmiwait =		pl2303_tiocmiwait,
902
	.process_read_urb =	pl2303_process_read_urb,
903
904
	.read_int_callback =	pl2303_read_int_callback,
	.attach =		pl2303_startup,
905
	.release =		pl2303_release,
906
907
	.port_probe =		pl2303_port_probe,
	.port_remove =		pl2303_port_remove,
908
};
Linus Torvalds's avatar
Linus Torvalds committed
909

910
911
912
913
static struct usb_serial_driver * const serial_drivers[] = {
	&pl2303_device, NULL
};

914
module_usb_serial_driver(serial_drivers, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
915
916
917

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL");