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

#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
29
#include <linux/uaccess.h>
Linus Torvalds's avatar
Linus Torvalds committed
30
#include <linux/usb.h>
31
#include <linux/usb/serial.h>
Linus Torvalds's avatar
Linus Torvalds committed
32
33
34
35
36
37
38
39
40
41
42
#include "pl2303.h"

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

static int debug;

#define PL2303_CLOSING_WAIT	(30*HZ)

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

95
MODULE_DEVICE_TABLE(usb, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
96
97
98
99
100
101

static struct usb_driver pl2303_driver = {
	.name =		"pl2303",
	.probe =	usb_serial_probe,
	.disconnect =	usb_serial_disconnect,
	.id_table =	id_table,
102
103
	.suspend =      usb_serial_suspend,
	.resume =       usb_serial_resume,
104
	.no_dynamic_id = 	1,
105
	.supports_autosuspend =	1,
Linus Torvalds's avatar
Linus Torvalds committed
106
107
108
109
110
111
112
113
114
115
116
};

#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
117
#define BREAK_REQUEST			0x23
Linus Torvalds's avatar
Linus Torvalds committed
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
#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 {
	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 */
};

struct pl2303_private {
	spinlock_t lock;
	wait_queue_head_t delta_msr_wait;
	u8 line_control;
	u8 line_status;
	enum pl2303_type type;
};

156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
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);
	dbg("0x%x:0x%x:0x%x:0x%x  %d - %x", VENDOR_READ_REQUEST_TYPE,
			VENDOR_READ_REQUEST, value, index, res, buf[0]);
	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);
	dbg("0x%x:0x%x:0x%x:0x%x  %d", VENDOR_WRITE_REQUEST_TYPE,
			VENDOR_WRITE_REQUEST, value, index, res);
	return res;
}

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

185
186
187
188
	buf = kmalloc(10, GFP_KERNEL);
	if (buf == NULL)
		return -ENOMEM;

Linus Torvalds's avatar
Linus Torvalds committed
189
190
191
192
193
194
195
196
197
198
199
	if (serial->dev->descriptor.bDeviceClass == 0x02)
		type = type_0;
	else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
		type = HX;
	else if (serial->dev->descriptor.bDeviceClass == 0x00)
		type = type_1;
	else if (serial->dev->descriptor.bDeviceClass == 0xFF)
		type = type_1;
	dbg("device type: %d", type);

	for (i = 0; i < serial->num_ports; ++i) {
200
		priv = kzalloc(sizeof(struct pl2303_private), GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
201
202
203
204
205
206
207
		if (!priv)
			goto cleanup;
		spin_lock_init(&priv->lock);
		init_waitqueue_head(&priv->delta_msr_wait);
		priv->type = type;
		usb_set_serial_port_data(serial->port[i], priv);
	}
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

	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);
	if (type == HX)
		pl2303_vendor_write(2, 0x44, serial);
	else
		pl2303_vendor_write(2, 0x24, serial);

	kfree(buf);
Linus Torvalds's avatar
Linus Torvalds committed
225
226
227
	return 0;

cleanup:
228
	kfree(buf);
Alan Cox's avatar
Alan Cox committed
229
	for (--i; i >= 0; --i) {
Linus Torvalds's avatar
Linus Torvalds committed
230
231
232
233
234
235
236
		priv = usb_get_serial_port_data(serial->port[i]);
		kfree(priv);
		usb_set_serial_port_data(serial->port[i], NULL);
	}
	return -ENOMEM;
}

237
static int set_control_lines(struct usb_device *dev, u8 value)
Linus Torvalds's avatar
Linus Torvalds committed
238
239
{
	int retval;
Alan Cox's avatar
Alan Cox committed
240

241
242
243
	retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
				 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
				 value, 0, NULL, 0, 100);
244
	dbg("%s - value = %d, retval = %d", __func__, value, retval);
Linus Torvalds's avatar
Linus Torvalds committed
245
246
247
	return retval;
}

Alan Cox's avatar
Alan Cox committed
248
249
static void pl2303_set_termios(struct tty_struct *tty,
		struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds's avatar
Linus Torvalds committed
250
251
252
253
254
255
256
257
258
{
	struct usb_serial *serial = port->serial;
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int cflag;
	unsigned char *buf;
	int baud;
	int i;
	u8 control;
259
260
261
262
263
264
	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, 1228800, 2457600, 3000000, 6000000 };
	int baud_floor, baud_ceil;
	int k;
Linus Torvalds's avatar
Linus Torvalds committed
265

266
	dbg("%s -  port %d", __func__, port->number);
Linus Torvalds's avatar
Linus Torvalds committed
267

268
269
270
271
	/* 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 */

Alan Cox's avatar
Alan Cox committed
272
	if (!tty_termios_hw_change(tty->termios, old_termios))
273
274
		return;

Alan Cox's avatar
Alan Cox committed
275
	cflag = tty->termios->c_cflag;
Linus Torvalds's avatar
Linus Torvalds committed
276

277
	buf = kzalloc(7, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
278
	if (!buf) {
279
		dev_err(&port->dev, "%s - out of memory.\n", __func__);
280
		/* Report back no change occurred */
Alan Cox's avatar
Alan Cox committed
281
		*tty->termios = *old_termios;
Linus Torvalds's avatar
Linus Torvalds committed
282
283
284
		return;
	}

285
286
287
288
289
	i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
			    GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
			    0, 0, buf, 7, 100);
	dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
	    buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
Linus Torvalds's avatar
Linus Torvalds committed
290
291
292

	if (cflag & CSIZE) {
		switch (cflag & CSIZE) {
Alan Cox's avatar
Alan Cox committed
293
294
295
296
297
298
299
300
301
302
303
304
305
		case CS5:
			buf[6] = 5;
			break;
		case CS6:
			buf[6] = 6;
			break;
		case CS7:
			buf[6] = 7;
			break;
		default:
		case CS8:
			buf[6] = 8;
			break;
Linus Torvalds's avatar
Linus Torvalds committed
306
		}
307
		dbg("%s - data bits = %d", __func__, buf[6]);
Linus Torvalds's avatar
Linus Torvalds committed
308
309
	}

310
311
312
313
314
	/* For reference buf[0]:buf[3] baud rate value */
	/* NOTE: Only the values defined in baud_sup are supported !
	 *       => if unsupported values are set, the PL2303 seems to use
	 *          9600 baud (at least my PL2303X always does)
	 */
Alan Cox's avatar
Alan Cox committed
315
	baud = tty_get_baud_rate(tty);
316
	dbg("%s - baud requested = %d", __func__, baud);
Linus Torvalds's avatar
Linus Torvalds committed
317
	if (baud) {
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
		/* Set baudrate to nearest supported value */
		for (k=0; k<ARRAY_SIZE(baud_sup); k++) {
			if (baud_sup[k] / baud) {
				baud_ceil = baud_sup[k];
				if (k==0) {
					baud = baud_ceil;
				} else {
					baud_floor = baud_sup[k-1];
					if ((baud_ceil % baud)
					    > (baud % baud_floor))
						baud = baud_floor;
					else
						baud = baud_ceil;
				}
				break;
			}
		}
		if (baud > 1228800) {
			/* type_0, type_1 only support up to 1228800 baud */
			if (priv->type != HX)
				baud = 1228800;
			else if (baud > 6000000)
				baud = 6000000;
		}
		dbg("%s - baud set = %d", __func__, baud);
Linus Torvalds's avatar
Linus Torvalds committed
343
344
345
346
347
348
349
350
351
352
		buf[0] = baud & 0xff;
		buf[1] = (baud >> 8) & 0xff;
		buf[2] = (baud >> 16) & 0xff;
		buf[3] = (baud >> 24) & 0xff;
	}

	/* 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 */
	if (cflag & CSTOPB) {
353
354
355
356
357
358
359
360
361
362
		/* NOTE: Comply with "real" UARTs / RS232:
		 *       use 1.5 instead of 2 stop bits with 5 data bits
		 */
		if ((cflag & CSIZE) == CS5) {
			buf[4] = 1;
			dbg("%s - stop bits = 1.5", __func__);
		} else {
			buf[4] = 2;
			dbg("%s - stop bits = 2", __func__);
		}
Linus Torvalds's avatar
Linus Torvalds committed
363
364
	} else {
		buf[4] = 0;
365
		dbg("%s - stop bits = 1", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
366
367
368
369
370
371
372
373
374
	}

	if (cflag & PARENB) {
		/* 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 */
		if (cflag & PARODD) {
375
376
377
378
379
380
381
			if (cflag & CMSPAR) {
				buf[5] = 3;
				dbg("%s - parity = mark", __func__);
			} else {
				buf[5] = 1;
				dbg("%s - parity = odd", __func__);
			}
Linus Torvalds's avatar
Linus Torvalds committed
382
		} else {
383
384
385
386
387
388
389
			if (cflag & CMSPAR) {
				buf[5] = 4;
				dbg("%s - parity = space", __func__);
			} else {
				buf[5] = 2;
				dbg("%s - parity = even", __func__);
			}
Linus Torvalds's avatar
Linus Torvalds committed
390
391
392
		}
	} else {
		buf[5] = 0;
393
		dbg("%s - parity = none", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
394
395
	}

396
397
398
399
	i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
			    SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
			    0, 0, buf, 7, 100);
	dbg("0x21:0x20:0:0  %d", i);
Linus Torvalds's avatar
Linus Torvalds committed
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414

	/* change control lines if we are switching to or from B0 */
	spin_lock_irqsave(&priv->lock, flags);
	control = priv->line_control;
	if ((cflag & CBAUD) == B0)
		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
	else
		priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
	if (control != priv->line_control) {
		control = priv->line_control;
		spin_unlock_irqrestore(&priv->lock, flags);
		set_control_lines(serial->dev, control);
	} else {
		spin_unlock_irqrestore(&priv->lock, flags);
	}
415

Linus Torvalds's avatar
Linus Torvalds committed
416
417
	buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;

418
419
420
421
	i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
			    GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
			    0, 0, buf, 7, 100);
	dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
Linus Torvalds's avatar
Linus Torvalds committed
422
423
424
425
	     buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);

	if (cflag & CRTSCTS) {
		if (priv->type == HX)
426
			pl2303_vendor_write(0x0, 0x61, serial);
Linus Torvalds's avatar
Linus Torvalds committed
427
		else
428
			pl2303_vendor_write(0x0, 0x41, serial);
t.sefzick's avatar
t.sefzick committed
429
	} else {
430
		pl2303_vendor_write(0x0, 0x0, serial);
Linus Torvalds's avatar
Linus Torvalds committed
431
	}
432

433
	/* Save resulting baud rate */
434
	if (baud)
Alan Cox's avatar
Alan Cox committed
435
		tty_encode_baud_rate(tty, baud, baud);
436

437
438
439
	kfree(buf);
}

440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
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);
	set_control_lines(port->serial->dev, control);
}

static void pl2303_close(struct usb_serial_port *port)
458
459
460
{
	unsigned long flags;

461
	dbg("%s - port %d", __func__, port->number);
462

463
	spin_lock_irqsave(&port->lock, flags);
464
	/* clear out any remaining data in the buffer */
465
466
	kfifo_reset_out(&port->write_fifo);
	spin_unlock_irqrestore(&port->lock, flags);
467
468

	/* shutdown our urbs */
469
	dbg("%s - shutting down urbs", __func__);
470
471
472
473
	usb_kill_urb(port->write_urb);
	usb_kill_urb(port->read_urb);
	usb_kill_urb(port->interrupt_in_urb);

Linus Torvalds's avatar
Linus Torvalds committed
474
475
}

476
static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
477
{
Alan Cox's avatar
Alan Cox committed
478
	struct ktermios tmp_termios;
Linus Torvalds's avatar
Linus Torvalds committed
479
480
481
482
	struct usb_serial *serial = port->serial;
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	int result;

483
	dbg("%s -  port %d", __func__, port->number);
Linus Torvalds's avatar
Linus Torvalds committed
484

485
486
487
	if (priv->type != HX) {
		usb_clear_halt(serial->dev, port->write_urb->pipe);
		usb_clear_halt(serial->dev, port->read_urb->pipe);
488
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
489
		/* reset upstream data pipes */
490
491
		pl2303_vendor_write(8, 0, serial);
		pl2303_vendor_write(9, 0, serial);
Linus Torvalds's avatar
Linus Torvalds committed
492
493
494
	}

	/* Setup termios */
Alan Cox's avatar
Alan Cox committed
495
496
	if (tty)
		pl2303_set_termios(tty, port, &tmp_termios);
Linus Torvalds's avatar
Linus Torvalds committed
497

498
	dbg("%s - submitting read urb", __func__);
499
	result = usb_serial_generic_submit_read_urb(port, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
500
	if (result) {
501
		pl2303_close(port);
Linus Torvalds's avatar
Linus Torvalds committed
502
503
504
		return -EPROTO;
	}

505
	dbg("%s - submitting interrupt urb", __func__);
506
	result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
507
	if (result) {
508
		dev_err(&port->dev, "%s - failed submitting interrupt urb,"
509
			" error %d\n", __func__, result);
510
		pl2303_close(port);
Linus Torvalds's avatar
Linus Torvalds committed
511
512
		return -EPROTO;
	}
513
	port->port.drain_delay = 256;
Linus Torvalds's avatar
Linus Torvalds committed
514
515
516
	return 0;
}

Alan Cox's avatar
Alan Cox committed
517
static int pl2303_tiocmset(struct tty_struct *tty, struct file *file,
518
			   unsigned int set, unsigned int clear)
Linus Torvalds's avatar
Linus Torvalds committed
519
{
Alan Cox's avatar
Alan Cox committed
520
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
521
522
523
524
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	u8 control;

525
526
527
	if (!usb_get_intfdata(port->serial->interface))
		return -ENODEV;

528
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
529
530
531
532
533
534
535
536
537
	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;
538
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
539

540
	return set_control_lines(port->serial->dev, control);
Linus Torvalds's avatar
Linus Torvalds committed
541
542
}

Alan Cox's avatar
Alan Cox committed
543
static int pl2303_tiocmget(struct tty_struct *tty, struct file *file)
Linus Torvalds's avatar
Linus Torvalds committed
544
{
Alan Cox's avatar
Alan Cox committed
545
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
546
547
548
549
550
551
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int mcr;
	unsigned int status;
	unsigned int result;

552
	dbg("%s (%d)", __func__, port->number);
Linus Torvalds's avatar
Linus Torvalds committed
553

554
555
556
	if (!usb_get_intfdata(port->serial->interface))
		return -ENODEV;

557
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
558
559
	mcr = priv->line_control;
	status = priv->line_status;
560
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
561
562
563
564
565
566
567
568

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

569
	dbg("%s - result = %x", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
570
571
572
573

	return result;
}

574
575
576
577
578
579
580
581
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;
}

Linus Torvalds's avatar
Linus Torvalds committed
582
583
584
585
586
587
588
589
static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
{
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	unsigned long flags;
	unsigned int prevstatus;
	unsigned int status;
	unsigned int changed;

590
	spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
591
	prevstatus = priv->line_status;
592
	spin_unlock_irqrestore(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
593
594
595
596
597
598

	while (1) {
		interruptible_sleep_on(&priv->delta_msr_wait);
		/* see if a signal did it */
		if (signal_pending(current))
			return -ERESTARTSYS;
599
600

		spin_lock_irqsave(&priv->lock, flags);
Linus Torvalds's avatar
Linus Torvalds committed
601
		status = priv->line_status;
602
603
		spin_unlock_irqrestore(&priv->lock, flags);

Alan Cox's avatar
Alan Cox committed
604
		changed = prevstatus ^ status;
605

Linus Torvalds's avatar
Linus Torvalds committed
606
607
608
		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
609
		    ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
Linus Torvalds's avatar
Linus Torvalds committed
610
611
612
613
614
615
616
617
			return 0;
		}
		prevstatus = status;
	}
	/* NOTREACHED */
	return 0;
}

Alan Cox's avatar
Alan Cox committed
618
static int pl2303_ioctl(struct tty_struct *tty, struct file *file,
619
			unsigned int cmd, unsigned long arg)
Linus Torvalds's avatar
Linus Torvalds committed
620
{
621
	struct serial_struct ser;
Alan Cox's avatar
Alan Cox committed
622
	struct usb_serial_port *port = tty->driver_data;
623
	dbg("%s (%d) cmd = 0x%04x", __func__, port->number, cmd);
Linus Torvalds's avatar
Linus Torvalds committed
624
625

	switch (cmd) {
626
627
628
629
630
631
632
633
634
635
636
637
	case TIOCGSERIAL:
		memset(&ser, 0, sizeof ser);
		ser.type = PORT_16654;
		ser.line = port->serial->minor;
		ser.port = port->number;
		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
638
639
640
641
642
643
	case TIOCMIWAIT:
		dbg("%s (%d) TIOCMIWAIT", __func__,  port->number);
		return wait_modem_info(port, arg);
	default:
		dbg("%s not supported = 0x%04x", __func__, cmd);
		break;
Linus Torvalds's avatar
Linus Torvalds committed
644
645
646
647
	}
	return -ENOIOCTLCMD;
}

Alan Cox's avatar
Alan Cox committed
648
static void pl2303_break_ctl(struct tty_struct *tty, int break_state)
Linus Torvalds's avatar
Linus Torvalds committed
649
{
Alan Cox's avatar
Alan Cox committed
650
	struct usb_serial_port *port = tty->driver_data;
Linus Torvalds's avatar
Linus Torvalds committed
651
652
653
654
	struct usb_serial *serial = port->serial;
	u16 state;
	int result;

655
	dbg("%s - port %d", __func__, port->number);
Linus Torvalds's avatar
Linus Torvalds committed
656
657
658
659
660

	if (break_state == 0)
		state = BREAK_OFF;
	else
		state = BREAK_ON;
Alan Cox's avatar
Alan Cox committed
661
662
	dbg("%s - turning break %s", __func__,
			state == BREAK_OFF ? "off" : "on");
Linus Torvalds's avatar
Linus Torvalds committed
663

664
665
666
	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
667
	if (result)
668
		dbg("%s - error sending break = %d", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
669
670
}

671
static void pl2303_release(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
672
673
674
675
{
	int i;
	struct pl2303_private *priv;

676
	dbg("%s", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
677
678
679

	for (i = 0; i < serial->num_ports; ++i) {
		priv = usb_get_serial_port_data(serial->port[i]);
680
		kfree(priv);
681
	}
Linus Torvalds's avatar
Linus Torvalds committed
682
683
}

Flavio Leitner's avatar
Flavio Leitner committed
684
685
686
687
688
689
690
691
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);
	unsigned long flags;
	u8 status_idx = UART_STATE;
692
	u8 length = UART_STATE + 1;
693
	u16 idv, idp;
Flavio Leitner's avatar
Flavio Leitner committed
694

695
696
697
698
699
700
701
702
703
704
705
706
	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
707
708
709
	}

	if (actual_length < length)
710
		return;
Flavio Leitner's avatar
Flavio Leitner committed
711

Alan Cox's avatar
Alan Cox committed
712
	/* Save off the uart status for others to look at */
Flavio Leitner's avatar
Flavio Leitner committed
713
714
715
	spin_lock_irqsave(&priv->lock, flags);
	priv->line_status = data[status_idx];
	spin_unlock_irqrestore(&priv->lock, flags);
716
717
	if (priv->line_status & UART_BREAK_ERROR)
		usb_serial_handle_break(port);
718
	wake_up_interruptible(&priv->delta_msr_wait);
Flavio Leitner's avatar
Flavio Leitner committed
719
}
Linus Torvalds's avatar
Linus Torvalds committed
720

721
static void pl2303_read_int_callback(struct urb *urb)
Linus Torvalds's avatar
Linus Torvalds committed
722
{
723
	struct usb_serial_port *port =  urb->context;
Linus Torvalds's avatar
Linus Torvalds committed
724
	unsigned char *data = urb->transfer_buffer;
Flavio Leitner's avatar
Flavio Leitner committed
725
	unsigned int actual_length = urb->actual_length;
726
727
	int status = urb->status;
	int retval;
Linus Torvalds's avatar
Linus Torvalds committed
728

729
	dbg("%s (%d)", __func__, port->number);
Linus Torvalds's avatar
Linus Torvalds committed
730

731
	switch (status) {
Linus Torvalds's avatar
Linus Torvalds committed
732
733
734
735
736
737
738
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
739
		dbg("%s - urb shutting down with status: %d", __func__,
740
		    status);
Linus Torvalds's avatar
Linus Torvalds committed
741
742
		return;
	default:
743
		dbg("%s - nonzero urb status received: %d", __func__,
744
		    status);
Linus Torvalds's avatar
Linus Torvalds committed
745
746
747
		goto exit;
	}

748
	usb_serial_debug_data(debug, &port->dev, __func__,
749
750
			      urb->actual_length, urb->transfer_buffer);

Flavio Leitner's avatar
Flavio Leitner committed
751
	pl2303_update_line_status(port, data, actual_length);
Linus Torvalds's avatar
Linus Torvalds committed
752
753

exit:
754
755
	retval = usb_submit_urb(urb, GFP_ATOMIC);
	if (retval)
756
757
		dev_err(&urb->dev->dev,
			"%s - usb_submit_urb failed with result %d\n",
758
			__func__, retval);
Linus Torvalds's avatar
Linus Torvalds committed
759
760
}

761
static void pl2303_process_read_urb(struct urb *urb)
762
{
763
764
765
	struct usb_serial_port *port = urb->context;
	struct pl2303_private *priv = usb_get_serial_port_data(port);
	struct tty_struct *tty;
766
767
	unsigned char *data = urb->transfer_buffer;
	char tty_flag = TTY_NORMAL;
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
	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);
	wake_up_interruptible(&priv->delta_msr_wait);

	if (!urb->actual_length)
		return;

	tty = tty_port_tty_get(&port->port);
	if (!tty)
		return;

786
787
788
789
790
791
792
793
794
795
796
797
798
	/* 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;
	dbg("%s - tty_flag = %d", __func__, tty_flag);

	/* overrun is special, not associated with a char */
	if (line_status & UART_OVERRUN_ERROR)
		tty_insert_flip_char(tty, 0, TTY_OVERRUN);
799

800
	if (tty_flag == TTY_NORMAL && !(port->port.console && port->sysrq))
801
802
		tty_insert_flip_string(tty, data, urb->actual_length);
	else {
803
804
805
		for (i = 0; i < urb->actual_length; ++i)
			if (!usb_serial_handle_sysrq_char(tty, port, data[i]))
				tty_insert_flip_char(tty, data[i], tty_flag);
806
	}
Linus Torvalds's avatar
Linus Torvalds committed
807

808
	tty_flip_buffer_push(tty);
Alan Cox's avatar
Alan Cox committed
809
	tty_kref_put(tty);
Linus Torvalds's avatar
Linus Torvalds committed
810
811
}

812
813
814
815
816
817
818
/* 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,
819
	.usb_driver = 		&pl2303_driver,
820
	.num_ports =		1,
821
	.bulk_in_size =		256,
822
	.bulk_out_size =	256,
823
824
	.open =			pl2303_open,
	.close =		pl2303_close,
825
826
	.dtr_rts = 		pl2303_dtr_rts,
	.carrier_raised =	pl2303_carrier_raised,
827
828
829
830
831
	.ioctl =		pl2303_ioctl,
	.break_ctl =		pl2303_break_ctl,
	.set_termios =		pl2303_set_termios,
	.tiocmget =		pl2303_tiocmget,
	.tiocmset =		pl2303_tiocmset,
832
	.process_read_urb =	pl2303_process_read_urb,
833
834
	.read_int_callback =	pl2303_read_int_callback,
	.attach =		pl2303_startup,
835
	.release =		pl2303_release,
836
};
Linus Torvalds's avatar
Linus Torvalds committed
837

838
static int __init pl2303_init(void)
Linus Torvalds's avatar
Linus Torvalds committed
839
840
{
	int retval;
841

Linus Torvalds's avatar
Linus Torvalds committed
842
843
844
845
846
847
	retval = usb_serial_register(&pl2303_device);
	if (retval)
		goto failed_usb_serial_register;
	retval = usb_register(&pl2303_driver);
	if (retval)
		goto failed_usb_register;
848
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
Linus Torvalds's avatar
Linus Torvalds committed
849
850
851
852
853
854
855
	return 0;
failed_usb_register:
	usb_serial_deregister(&pl2303_device);
failed_usb_serial_register:
	return retval;
}

856
static void __exit pl2303_exit(void)
Linus Torvalds's avatar
Linus Torvalds committed
857
{
858
859
	usb_deregister(&pl2303_driver);
	usb_serial_deregister(&pl2303_device);
Linus Torvalds's avatar
Linus Torvalds committed
860
861
862
863
864
865
866
867
868
869
870
}

module_init(pl2303_init);
module_exit(pl2303_exit);

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

module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Debug enabled or not");