cp210x.c 25.1 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
/*
2
 * Silicon Laboratories CP210x USB to RS232 serial adaptor driver
Linus Torvalds's avatar
Linus Torvalds committed
3
4
5
6
7
8
9
 *
 * Copyright (C) 2005 Craig Shelley (craig@microtron.org.uk)
 *
 *	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.
 *
10
11
12
13
 * Support to set flow control line levels using TIOCMGET and TIOCMSET
 * thanks to Karl Hiramoto karl@hiramoto.org. RTSCTS hardware flow
 * control thanks to Munir Nassar nassarmu@real-time.com
 *
Linus Torvalds's avatar
Linus Torvalds committed
14
15
16
17
18
19
20
21
22
23
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/usb.h>
Alan Cox's avatar
Alan Cox committed
24
#include <linux/uaccess.h>
25
#include <linux/usb/serial.h>
Linus Torvalds's avatar
Linus Torvalds committed
26
27
28
29

/*
 * Version Information
 */
30
#define DRIVER_VERSION "v0.09"
31
#define DRIVER_DESC "Silicon Labs CP210x RS232 serial adaptor driver"
Linus Torvalds's avatar
Linus Torvalds committed
32
33
34
35

/*
 * Function Prototypes
 */
36
static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *);
37
38
39
static void cp210x_cleanup(struct usb_serial_port *);
static void cp210x_close(struct usb_serial_port *);
static void cp210x_get_termios(struct tty_struct *,
40
	struct usb_serial_port *port);
41
static void cp210x_get_termios_port(struct usb_serial_port *port,
42
	unsigned int *cflagp, unsigned int *baudp);
43
static void cp210x_set_termios(struct tty_struct *, struct usb_serial_port *,
Alan Cox's avatar
Alan Cox committed
44
							struct ktermios*);
45
46
static int cp210x_tiocmget(struct tty_struct *, struct file *);
static int cp210x_tiocmset(struct tty_struct *, struct file *,
47
		unsigned int, unsigned int);
48
static int cp210x_tiocmset_port(struct usb_serial_port *port, struct file *,
49
		unsigned int, unsigned int);
50
51
static void cp210x_break_ctl(struct tty_struct *, int);
static int cp210x_startup(struct usb_serial *);
52
static void cp210x_disconnect(struct usb_serial *);
Alan Cox's avatar
Alan Cox committed
53
54
static void cp210x_dtr_rts(struct usb_serial_port *p, int on);
static int cp210x_carrier_raised(struct usb_serial_port *p);
Linus Torvalds's avatar
Linus Torvalds committed
55
56
57
58

static int debug;

static struct usb_device_id id_table [] = {
M Kondrin's avatar
M Kondrin committed
59
	{ USB_DEVICE(0x0471, 0x066A) }, /* AKTAKOM ACE-1001 cable */
Craig Shelley's avatar
Craig Shelley committed
60
	{ USB_DEVICE(0x0489, 0xE000) }, /* Pirelli Broadband S.p.A, DP-L10 SIP/GSM Mobile */
Craig Shelley's avatar
Craig Shelley committed
61
	{ USB_DEVICE(0x0745, 0x1000) }, /* CipherLab USB CCD Barcode Scanner 1000 */
62
	{ USB_DEVICE(0x08e6, 0x5501) }, /* Gemalto Prox-PU/CU contactless smartcard reader */
Craig Shelley's avatar
Craig Shelley committed
63
	{ USB_DEVICE(0x08FD, 0x000A) }, /* Digianswer A/S , ZigBee/802.15.4 MAC Device */
64
	{ USB_DEVICE(0x0FCF, 0x1003) }, /* Dynastream ANT development board */
65
	{ USB_DEVICE(0x0FCF, 0x1004) }, /* Dynastream ANT2USB */
Craig Shelley's avatar
Craig Shelley committed
66
	{ USB_DEVICE(0x0FCF, 0x1006) }, /* Dynastream ANT development board */
67
	{ USB_DEVICE(0x10A6, 0xAA26) }, /* Knock-off DCU-11 cable */
68
69
	{ USB_DEVICE(0x10AB, 0x10C5) }, /* Siemens MC60 Cable */
	{ USB_DEVICE(0x10B5, 0xAC70) }, /* Nokia CA-42 USB */
Craig Shelley's avatar
Craig Shelley committed
70
	{ USB_DEVICE(0x10C4, 0x0F91) }, /* Vstabi */
71
72
	{ USB_DEVICE(0x10C4, 0x1101) }, /* Arkham Technology DS101 Bus Monitor */
	{ USB_DEVICE(0x10C4, 0x1601) }, /* Arkham Technology DS101 Adapter */
Craig Shelley's avatar
Craig Shelley committed
73
	{ USB_DEVICE(0x10C4, 0x800A) }, /* SPORTident BSM7-D-USB main station */
74
	{ USB_DEVICE(0x10C4, 0x803B) }, /* Pololu USB-serial converter */
Craig Shelley's avatar
Craig Shelley committed
75
	{ USB_DEVICE(0x10C4, 0x8053) }, /* Enfora EDG1228 */
76
	{ USB_DEVICE(0x10C4, 0x8054) }, /* Enfora GSM2228 */
Vitja Makarov's avatar
Vitja Makarov committed
77
	{ USB_DEVICE(0x10C4, 0x8066) }, /* Argussoft In-System Programmer */
78
79
	{ USB_DEVICE(0x10C4, 0x807A) }, /* Crumb128 board */
	{ USB_DEVICE(0x10C4, 0x80CA) }, /* Degree Controls Inc */
Craig Shelley's avatar
Craig Shelley committed
80
	{ USB_DEVICE(0x10C4, 0x80DD) }, /* Tracient RFID */
81
	{ USB_DEVICE(0x10C4, 0x80F6) }, /* Suunto sports instrument */
82
	{ USB_DEVICE(0x10C4, 0x8115) }, /* Arygon NFC/Mifare Reader */
83
	{ USB_DEVICE(0x10C4, 0x813D) }, /* Burnside Telecom Deskmobile */
Craig Shelley's avatar
Craig Shelley committed
84
	{ USB_DEVICE(0x10C4, 0x813F) }, /* Tams Master Easy Control */
85
86
	{ USB_DEVICE(0x10C4, 0x814A) }, /* West Mountain Radio RIGblaster P&P */
	{ USB_DEVICE(0x10C4, 0x814B) }, /* West Mountain Radio RIGtalk */
87
	{ USB_DEVICE(0x10C4, 0x815E) }, /* Helicomm IP-Link 1220-DVM */
88
	{ USB_DEVICE(0x10C4, 0x819F) }, /* MJS USB Toslink Switcher */
89
	{ USB_DEVICE(0x10C4, 0x81A6) }, /* ThinkOptics WavIt */
Craig Shelley's avatar
Craig Shelley committed
90
	{ USB_DEVICE(0x10C4, 0x81AC) }, /* MSD Dash Hawk */
91
92
	{ USB_DEVICE(0x10C4, 0x81C8) }, /* Lipowsky Industrie Elektronik GmbH, Baby-JTAG */
	{ USB_DEVICE(0x10C4, 0x81E2) }, /* Lipowsky Industrie Elektronik GmbH, Baby-LIN */
Jeff Long's avatar
Jeff Long committed
93
	{ USB_DEVICE(0x10C4, 0x81E7) }, /* Aerocomm Radio */
Craig Shelley's avatar
Craig Shelley committed
94
	{ USB_DEVICE(0x10C4, 0x81F2) }, /* C1007 HF band RFID controller */
95
	{ USB_DEVICE(0x10C4, 0x8218) }, /* Lipowsky Industrie Elektronik GmbH, HARP-1 */
Tomasz K's avatar
Tomasz K committed
96
	{ USB_DEVICE(0x10C4, 0x822B) }, /* Modem EDGE(GSM) Comander 2 */
97
	{ USB_DEVICE(0x10C4, 0x826B) }, /* Cygnal Integrated Products, Inc., Fasttrax GPS demostration module */
98
	{ USB_DEVICE(0x10c4, 0x8293) }, /* Telegesys ETRX2USB */
Craig Shelley's avatar
Craig Shelley committed
99
	{ USB_DEVICE(0x10C4, 0x82F9) }, /* Procyon AVS */
100
	{ USB_DEVICE(0x10C4, 0x8341) }, /* Siemens MC35PU GPRS Modem */
Craig Shelley's avatar
Craig Shelley committed
101
	{ USB_DEVICE(0x10C4, 0x8382) }, /* Cygnal Integrated Products, Inc. */
102
	{ USB_DEVICE(0x10C4, 0x83A8) }, /* Amber Wireless AMB2560 */
Craig Shelley's avatar
Craig Shelley committed
103
	{ USB_DEVICE(0x10C4, 0x8411) }, /* Kyocera GPS Module */
Alex Stephens's avatar
Alex Stephens committed
104
	{ USB_DEVICE(0x10C4, 0x846E) }, /* BEI USB Sensor Interface (VCP) */
105
	{ USB_DEVICE(0x10C4, 0xEA60) }, /* Silicon Labs factory default */
106
	{ USB_DEVICE(0x10C4, 0xEA61) }, /* Silicon Labs factory default */
Craig Shelley's avatar
Craig Shelley committed
107
108
109
110
	{ USB_DEVICE(0x10C4, 0xF001) }, /* Elan Digital Systems USBscope50 */
	{ USB_DEVICE(0x10C4, 0xF002) }, /* Elan Digital Systems USBwave12 */
	{ USB_DEVICE(0x10C4, 0xF003) }, /* Elan Digital Systems USBpulse100 */
	{ USB_DEVICE(0x10C4, 0xF004) }, /* Elan Digital Systems USBcount50 */
111
	{ USB_DEVICE(0x10C5, 0xEA61) }, /* Silicon Labs MobiData GPRS USB Modem */
Craig Shelley's avatar
Craig Shelley committed
112
	{ USB_DEVICE(0x10CE, 0xEA6A) }, /* Silicon Labs MobiData GPRS USB Modem 100EU */
113
	{ USB_DEVICE(0x13AD, 0x9999) }, /* Baltech card reader */
Craig Shelley's avatar
Craig Shelley committed
114
	{ USB_DEVICE(0x1555, 0x0004) }, /* Owen AC4 USB-RS485 Converter */
Craig Shelley's avatar
Craig Shelley committed
115
	{ USB_DEVICE(0x166A, 0x0303) }, /* Clipsal 5500PCU C-Bus USB interface */
116
	{ USB_DEVICE(0x16D6, 0x0001) }, /* Jablotron serial interface */
117
	{ USB_DEVICE(0x18EF, 0xE00F) }, /* ELV USB-I2C-Interface */
118
	{ USB_DEVICE(0x413C, 0x9500) }, /* DW700 GPS USB interface */
119
	{ } /* Terminating Entry */
Linus Torvalds's avatar
Linus Torvalds committed
120
121
};

Alan Cox's avatar
Alan Cox committed
122
MODULE_DEVICE_TABLE(usb, id_table);
Linus Torvalds's avatar
Linus Torvalds committed
123

124
125
static struct usb_driver cp210x_driver = {
	.name		= "cp210x",
Linus Torvalds's avatar
Linus Torvalds committed
126
127
128
	.probe		= usb_serial_probe,
	.disconnect	= usb_serial_disconnect,
	.id_table	= id_table,
129
	.no_dynamic_id	= 	1,
Linus Torvalds's avatar
Linus Torvalds committed
130
131
};

132
static struct usb_serial_driver cp210x_device = {
133
134
	.driver = {
		.owner =	THIS_MODULE,
135
		.name = 	"cp210x",
136
	},
137
	.usb_driver		= &cp210x_driver,
Linus Torvalds's avatar
Linus Torvalds committed
138
139
	.id_table		= id_table,
	.num_ports		= 1,
140
141
142
143
144
145
146
	.open			= cp210x_open,
	.close			= cp210x_close,
	.break_ctl		= cp210x_break_ctl,
	.set_termios		= cp210x_set_termios,
	.tiocmget 		= cp210x_tiocmget,
	.tiocmset		= cp210x_tiocmset,
	.attach			= cp210x_startup,
147
	.disconnect		= cp210x_disconnect,
Alan Cox's avatar
Alan Cox committed
148
149
	.dtr_rts		= cp210x_dtr_rts,
	.carrier_raised		= cp210x_carrier_raised
Linus Torvalds's avatar
Linus Torvalds committed
150
151
};

152
/* Config request types */
Linus Torvalds's avatar
Linus Torvalds committed
153
154
155
#define REQTYPE_HOST_TO_DEVICE	0x41
#define REQTYPE_DEVICE_TO_HOST	0xc1

156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/* Config request codes */
#define CP210X_IFC_ENABLE	0x00
#define CP210X_SET_BAUDDIV	0x01
#define CP210X_GET_BAUDDIV	0x02
#define CP210X_SET_LINE_CTL	0x03
#define CP210X_GET_LINE_CTL	0x04
#define CP210X_SET_BREAK	0x05
#define CP210X_IMM_CHAR		0x06
#define CP210X_SET_MHS		0x07
#define CP210X_GET_MDMSTS	0x08
#define CP210X_SET_XON		0x09
#define CP210X_SET_XOFF		0x0A
#define CP210X_SET_EVENTMASK	0x0B
#define CP210X_GET_EVENTMASK	0x0C
#define CP210X_SET_CHAR		0x0D
#define CP210X_GET_CHARS	0x0E
#define CP210X_GET_PROPS	0x0F
#define CP210X_GET_COMM_STATUS	0x10
#define CP210X_RESET		0x11
#define CP210X_PURGE		0x12
#define CP210X_SET_FLOW		0x13
#define CP210X_GET_FLOW		0x14
#define CP210X_EMBED_EVENTS	0x15
#define CP210X_GET_EVENTSTATE	0x16
#define CP210X_SET_CHARS	0x19

/* CP210X_IFC_ENABLE */
Linus Torvalds's avatar
Linus Torvalds committed
183
184
185
#define UART_ENABLE		0x0001
#define UART_DISABLE		0x0000

186
/* CP210X_(SET|GET)_BAUDDIV */
Linus Torvalds's avatar
Linus Torvalds committed
187
188
#define BAUD_RATE_GEN_FREQ	0x384000

189
/* CP210X_(SET|GET)_LINE_CTL */
Linus Torvalds's avatar
Linus Torvalds committed
190
#define BITS_DATA_MASK		0X0f00
191
#define BITS_DATA_5		0X0500
Linus Torvalds's avatar
Linus Torvalds committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
#define BITS_DATA_6		0X0600
#define BITS_DATA_7		0X0700
#define BITS_DATA_8		0X0800
#define BITS_DATA_9		0X0900

#define BITS_PARITY_MASK	0x00f0
#define BITS_PARITY_NONE	0x0000
#define BITS_PARITY_ODD		0x0010
#define BITS_PARITY_EVEN	0x0020
#define BITS_PARITY_MARK	0x0030
#define BITS_PARITY_SPACE	0x0040

#define BITS_STOP_MASK		0x000f
#define BITS_STOP_1		0x0000
#define BITS_STOP_1_5		0x0001
#define BITS_STOP_2		0x0002
208

209
/* CP210X_SET_BREAK */
Linus Torvalds's avatar
Linus Torvalds committed
210
211
212
#define BREAK_ON		0x0000
#define BREAK_OFF		0x0001

213
/* CP210X_(SET_MHS|GET_MDMSTS) */
214
215
216
217
218
219
220
221
#define CONTROL_DTR		0x0001
#define CONTROL_RTS		0x0002
#define CONTROL_CTS		0x0010
#define CONTROL_DSR		0x0020
#define CONTROL_RING		0x0040
#define CONTROL_DCD		0x0080
#define CONTROL_WRITE_DTR	0x0100
#define CONTROL_WRITE_RTS	0x0200
Linus Torvalds's avatar
Linus Torvalds committed
222

223
/*
224
225
 * cp210x_get_config
 * Reads from the CP210x configuration registers
226
227
228
229
 * 'size' is specified in bytes.
 * 'data' is a pointer to a pre-allocated array of integers large
 * enough to hold 'size' bytes (with 4 bytes to each integer)
 */
230
static int cp210x_get_config(struct usb_serial_port *port, u8 request,
231
		unsigned int *data, int size)
Linus Torvalds's avatar
Linus Torvalds committed
232
233
{
	struct usb_serial *serial = port->serial;
234
	__le32 *buf;
235
236
237
238
239
	int result, i, length;

	/* Number of integers required to contain the array */
	length = (((size - 1) | 3) + 1)/4;

240
	buf = kcalloc(length, sizeof(__le32), GFP_KERNEL);
241
	if (!buf) {
242
		dev_err(&port->dev, "%s - out of memory.\n", __func__);
243
244
		return -ENOMEM;
	}
Linus Torvalds's avatar
Linus Torvalds committed
245

246
	/* Issue the request, attempting to read 'size' bytes */
Alan Cox's avatar
Alan Cox committed
247
	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
Linus Torvalds's avatar
Linus Torvalds committed
248
				request, REQTYPE_DEVICE_TO_HOST, 0x0000,
249
				0, buf, size, 300);
Linus Torvalds's avatar
Linus Torvalds committed
250

251
	/* Convert data into an array of integers */
Alan Cox's avatar
Alan Cox committed
252
	for (i = 0; i < length; i++)
253
		data[i] = le32_to_cpu(buf[i]);
Linus Torvalds's avatar
Linus Torvalds committed
254

255
	kfree(buf);
Linus Torvalds's avatar
Linus Torvalds committed
256

257
	if (result != size) {
258
		dbg("%s - Unable to send config request, "
259
				"request=0x%x size=%d result=%d\n",
260
				__func__, request, size, result);
261
262
		return -EPROTO;
	}
Linus Torvalds's avatar
Linus Torvalds committed
263

264
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
265
266
}

267
/*
268
269
 * cp210x_set_config
 * Writes to the CP210x configuration registers
270
271
272
 * Values less than 16 bits wide are sent directly
 * 'size' is specified in bytes.
 */
273
static int cp210x_set_config(struct usb_serial_port *port, u8 request,
274
		unsigned int *data, int size)
Linus Torvalds's avatar
Linus Torvalds committed
275
276
{
	struct usb_serial *serial = port->serial;
277
	__le32 *buf;
278
	int result, i, length;
Linus Torvalds's avatar
Linus Torvalds committed
279

280
281
282
	/* Number of integers required to contain the array */
	length = (((size - 1) | 3) + 1)/4;

283
	buf = kmalloc(length * sizeof(__le32), GFP_KERNEL);
284
285
	if (!buf) {
		dev_err(&port->dev, "%s - out of memory.\n",
286
				__func__);
287
288
289
290
291
292
293
294
		return -ENOMEM;
	}

	/* Array of integers into bytes */
	for (i = 0; i < length; i++)
		buf[i] = cpu_to_le32(data[i]);

	if (size > 2) {
Alan Cox's avatar
Alan Cox committed
295
		result = usb_control_msg(serial->dev,
296
297
298
299
				usb_sndctrlpipe(serial->dev, 0),
				request, REQTYPE_HOST_TO_DEVICE, 0x0000,
				0, buf, size, 300);
	} else {
Alan Cox's avatar
Alan Cox committed
300
		result = usb_control_msg(serial->dev,
301
302
303
				usb_sndctrlpipe(serial->dev, 0),
				request, REQTYPE_HOST_TO_DEVICE, data[0],
				0, NULL, 0, 300);
Linus Torvalds's avatar
Linus Torvalds committed
304
305
	}

306
307
308
	kfree(buf);

	if ((size > 2 && result != size) || result < 0) {
309
		dbg("%s - Unable to send request, "
310
				"request=0x%x size=%d result=%d\n",
311
				__func__, request, size, result);
312
313
		return -EPROTO;
	}
Linus Torvalds's avatar
Linus Torvalds committed
314

315
	/* Single data value */
Alan Cox's avatar
Alan Cox committed
316
	result = usb_control_msg(serial->dev,
317
318
319
			usb_sndctrlpipe(serial->dev, 0),
			request, REQTYPE_HOST_TO_DEVICE, data[0],
			0, NULL, 0, 300);
Linus Torvalds's avatar
Linus Torvalds committed
320
321
322
	return 0;
}

323
/*
324
325
 * cp210x_set_config_single
 * Convenience function for calling cp210x_set_config on single data values
326
327
 * without requiring an integer pointer
 */
328
static inline int cp210x_set_config_single(struct usb_serial_port *port,
329
330
		u8 request, unsigned int data)
{
331
	return cp210x_set_config(port, request, &data, 2);
332
333
}

334
/*
335
 * cp210x_quantise_baudrate
336
337
 * Quantises the baud rate as per AN205 Table 1
 */
338
static unsigned int cp210x_quantise_baudrate(unsigned int baud) {
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
372
373
374
	if      (baud <= 56)       baud = 0;
	else if (baud <= 300)      baud = 300;
	else if (baud <= 600)      baud = 600;
	else if (baud <= 1200)     baud = 1200;
	else if (baud <= 1800)     baud = 1800;
	else if (baud <= 2400)     baud = 2400;
	else if (baud <= 4000)     baud = 4000;
	else if (baud <= 4803)     baud = 4800;
	else if (baud <= 7207)     baud = 7200;
	else if (baud <= 9612)     baud = 9600;
	else if (baud <= 14428)    baud = 14400;
	else if (baud <= 16062)    baud = 16000;
	else if (baud <= 19250)    baud = 19200;
	else if (baud <= 28912)    baud = 28800;
	else if (baud <= 38601)    baud = 38400;
	else if (baud <= 51558)    baud = 51200;
	else if (baud <= 56280)    baud = 56000;
	else if (baud <= 58053)    baud = 57600;
	else if (baud <= 64111)    baud = 64000;
	else if (baud <= 77608)    baud = 76800;
	else if (baud <= 117028)   baud = 115200;
	else if (baud <= 129347)   baud = 128000;
	else if (baud <= 156868)   baud = 153600;
	else if (baud <= 237832)   baud = 230400;
	else if (baud <= 254234)   baud = 250000;
	else if (baud <= 273066)   baud = 256000;
	else if (baud <= 491520)   baud = 460800;
	else if (baud <= 567138)   baud = 500000;
	else if (baud <= 670254)   baud = 576000;
	else if (baud <= 1053257)  baud = 921600;
	else if (baud <= 1474560)  baud = 1228800;
	else if (baud <= 2457600)  baud = 1843200;
	else                       baud = 3686400;
	return baud;
}

375
static int cp210x_open(struct tty_struct *tty, struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
376
377
378
379
{
	struct usb_serial *serial = port->serial;
	int result;

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

382
	if (cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_ENABLE)) {
Linus Torvalds's avatar
Linus Torvalds committed
383
		dev_err(&port->dev, "%s - Unable to enable UART\n",
384
				__func__);
Linus Torvalds's avatar
Linus Torvalds committed
385
386
387
388
		return -EPROTO;
	}

	/* Start reading from the device */
Alan Cox's avatar
Alan Cox committed
389
	usb_fill_bulk_urb(port->read_urb, serial->dev,
Linus Torvalds's avatar
Linus Torvalds committed
390
391
392
393
394
395
396
397
398
			usb_rcvbulkpipe(serial->dev,
			port->bulk_in_endpointAddress),
			port->read_urb->transfer_buffer,
			port->read_urb->transfer_buffer_length,
			serial->type->read_bulk_callback,
			port);
	result = usb_submit_urb(port->read_urb, GFP_KERNEL);
	if (result) {
		dev_err(&port->dev, "%s - failed resubmitting read urb, "
399
				"error %d\n", __func__, result);
Linus Torvalds's avatar
Linus Torvalds committed
400
401
402
		return result;
	}

403
	/* Configure the termios structure */
404
	cp210x_get_termios(tty, port);
Linus Torvalds's avatar
Linus Torvalds committed
405
406
407
	return 0;
}

408
static void cp210x_cleanup(struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
409
410
411
{
	struct usb_serial *serial = port->serial;

412
	dbg("%s - port %d", __func__, port->number);
Linus Torvalds's avatar
Linus Torvalds committed
413
414
415
416
417
418
419
420
421
422

	if (serial->dev) {
		/* shutdown any bulk reads that might be going on */
		if (serial->num_bulk_out)
			usb_kill_urb(port->write_urb);
		if (serial->num_bulk_in)
			usb_kill_urb(port->read_urb);
	}
}

423
static void cp210x_close(struct usb_serial_port *port)
Linus Torvalds's avatar
Linus Torvalds committed
424
{
425
	dbg("%s - port %d", __func__, port->number);
Linus Torvalds's avatar
Linus Torvalds committed
426
427

	/* shutdown our urbs */
428
	dbg("%s - shutting down urbs", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
429
430
431
	usb_kill_urb(port->write_urb);
	usb_kill_urb(port->read_urb);

432
433
	mutex_lock(&port->serial->disc_mutex);
	if (!port->serial->disconnected)
434
		cp210x_set_config_single(port, CP210X_IFC_ENABLE, UART_DISABLE);
435
	mutex_unlock(&port->serial->disc_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
436
437
}

438
/*
439
 * cp210x_get_termios
440
441
442
443
 * Reads the baud rate, data bits, parity, stop bits and flow control mode
 * from the device, corrects any unsupported values, and configures the
 * termios structure to reflect the state of the device
 */
444
static void cp210x_get_termios(struct tty_struct *tty,
445
446
447
448
449
	struct usb_serial_port *port)
{
	unsigned int baud;

	if (tty) {
450
		cp210x_get_termios_port(tty->driver_data,
451
452
453
454
455
456
457
			&tty->termios->c_cflag, &baud);
		tty_encode_baud_rate(tty, baud, baud);
	}

	else {
		unsigned int cflag;
		cflag = 0;
458
		cp210x_get_termios_port(port, &cflag, &baud);
459
460
461
462
	}
}

/*
463
464
 * cp210x_get_termios_port
 * This is the heart of cp210x_get_termios which always uses a &usb_serial_port.
465
 */
466
static void cp210x_get_termios_port(struct usb_serial_port *port,
467
	unsigned int *cflagp, unsigned int *baudp)
Linus Torvalds's avatar
Linus Torvalds committed
468
{
469
	unsigned int cflag, modem_ctl[4];
470
471
	unsigned int baud;
	unsigned int bits;
Linus Torvalds's avatar
Linus Torvalds committed
472

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

475
	cp210x_get_config(port, CP210X_GET_BAUDDIV, &baud, 2);
476
	/* Convert to baudrate */
Linus Torvalds's avatar
Linus Torvalds committed
477
	if (baud)
478
		baud = cp210x_quantise_baudrate((BAUD_RATE_GEN_FREQ + baud/2)/ baud);
Linus Torvalds's avatar
Linus Torvalds committed
479

480
	dbg("%s - baud rate = %d", __func__, baud);
481
	*baudp = baud;
482

483
	cflag = *cflagp;
Linus Torvalds's avatar
Linus Torvalds committed
484

485
	cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
Linus Torvalds's avatar
Linus Torvalds committed
486
	cflag &= ~CSIZE;
Alan Cox's avatar
Alan Cox committed
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
	switch (bits & BITS_DATA_MASK) {
	case BITS_DATA_5:
		dbg("%s - data bits = 5", __func__);
		cflag |= CS5;
		break;
	case BITS_DATA_6:
		dbg("%s - data bits = 6", __func__);
		cflag |= CS6;
		break;
	case BITS_DATA_7:
		dbg("%s - data bits = 7", __func__);
		cflag |= CS7;
		break;
	case BITS_DATA_8:
		dbg("%s - data bits = 8", __func__);
		cflag |= CS8;
		break;
	case BITS_DATA_9:
		dbg("%s - data bits = 9 (not supported, using 8 data bits)",
								__func__);
		cflag |= CS8;
		bits &= ~BITS_DATA_MASK;
		bits |= BITS_DATA_8;
510
		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
Alan Cox's avatar
Alan Cox committed
511
512
513
514
515
516
		break;
	default:
		dbg("%s - Unknown number of data bits, using 8", __func__);
		cflag |= CS8;
		bits &= ~BITS_DATA_MASK;
		bits |= BITS_DATA_8;
517
		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
Alan Cox's avatar
Alan Cox committed
518
		break;
Linus Torvalds's avatar
Linus Torvalds committed
519
520
	}

Alan Cox's avatar
Alan Cox committed
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
	switch (bits & BITS_PARITY_MASK) {
	case BITS_PARITY_NONE:
		dbg("%s - parity = NONE", __func__);
		cflag &= ~PARENB;
		break;
	case BITS_PARITY_ODD:
		dbg("%s - parity = ODD", __func__);
		cflag |= (PARENB|PARODD);
		break;
	case BITS_PARITY_EVEN:
		dbg("%s - parity = EVEN", __func__);
		cflag &= ~PARODD;
		cflag |= PARENB;
		break;
	case BITS_PARITY_MARK:
		dbg("%s - parity = MARK (not supported, disabling parity)",
				__func__);
		cflag &= ~PARENB;
		bits &= ~BITS_PARITY_MASK;
540
		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
Alan Cox's avatar
Alan Cox committed
541
542
543
544
545
546
		break;
	case BITS_PARITY_SPACE:
		dbg("%s - parity = SPACE (not supported, disabling parity)",
				__func__);
		cflag &= ~PARENB;
		bits &= ~BITS_PARITY_MASK;
547
		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
Alan Cox's avatar
Alan Cox committed
548
549
550
551
552
		break;
	default:
		dbg("%s - Unknown parity mode, disabling parity", __func__);
		cflag &= ~PARENB;
		bits &= ~BITS_PARITY_MASK;
553
		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
Alan Cox's avatar
Alan Cox committed
554
		break;
Linus Torvalds's avatar
Linus Torvalds committed
555
556
557
	}

	cflag &= ~CSTOPB;
Alan Cox's avatar
Alan Cox committed
558
559
560
561
562
563
564
565
	switch (bits & BITS_STOP_MASK) {
	case BITS_STOP_1:
		dbg("%s - stop bits = 1", __func__);
		break;
	case BITS_STOP_1_5:
		dbg("%s - stop bits = 1.5 (not supported, using 1 stop bit)",
								__func__);
		bits &= ~BITS_STOP_MASK;
566
		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
Alan Cox's avatar
Alan Cox committed
567
568
569
570
571
572
573
574
575
		break;
	case BITS_STOP_2:
		dbg("%s - stop bits = 2", __func__);
		cflag |= CSTOPB;
		break;
	default:
		dbg("%s - Unknown number of stop bits, using 1 stop bit",
								__func__);
		bits &= ~BITS_STOP_MASK;
576
		cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2);
Alan Cox's avatar
Alan Cox committed
577
		break;
Linus Torvalds's avatar
Linus Torvalds committed
578
579
	}

580
	cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
581
	if (modem_ctl[0] & 0x0008) {
582
		dbg("%s - flow control = CRTSCTS", __func__);
583
584
		cflag |= CRTSCTS;
	} else {
585
		dbg("%s - flow control = NONE", __func__);
586
587
588
		cflag &= ~CRTSCTS;
	}

589
	*cflagp = cflag;
Linus Torvalds's avatar
Linus Torvalds committed
590
591
}

592
static void cp210x_set_termios(struct tty_struct *tty,
Alan Cox's avatar
Alan Cox committed
593
		struct usb_serial_port *port, struct ktermios *old_termios)
Linus Torvalds's avatar
Linus Torvalds committed
594
{
595
	unsigned int cflag, old_cflag;
596
	unsigned int baud = 0, bits;
597
	unsigned int modem_ctl[4];
Linus Torvalds's avatar
Linus Torvalds committed
598

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

Alan Cox's avatar
Alan Cox committed
601
	if (!tty)
Linus Torvalds's avatar
Linus Torvalds committed
602
		return;
603

Alan Cox's avatar
Alan Cox committed
604
605
	tty->termios->c_cflag &= ~CMSPAR;
	cflag = tty->termios->c_cflag;
606
	old_cflag = old_termios->c_cflag;
607
	baud = cp210x_quantise_baudrate(tty_get_baud_rate(tty));
Linus Torvalds's avatar
Linus Torvalds committed
608
609

	/* If the baud rate is to be updated*/
610
611
612
	if (baud != tty_termios_baud_rate(old_termios) && baud != 0) {
		dbg("%s - Setting baud rate to %d baud", __func__,
				baud);
613
		if (cp210x_set_config_single(port, CP210X_SET_BAUDDIV,
614
					((BAUD_RATE_GEN_FREQ + baud/2) / baud))) {
615
			dbg("Baud rate requested not supported by device\n");
616
			baud = tty_termios_baud_rate(old_termios);
Linus Torvalds's avatar
Linus Torvalds committed
617
618
		}
	}
619
	/* Report back the resulting baud rate */
Alan Cox's avatar
Alan Cox committed
620
	tty_encode_baud_rate(tty, baud, baud);
Linus Torvalds's avatar
Linus Torvalds committed
621

622
	/* If the number of data bits is to be updated */
Linus Torvalds's avatar
Linus Torvalds committed
623
	if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
624
		cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
Linus Torvalds's avatar
Linus Torvalds committed
625
626
		bits &= ~BITS_DATA_MASK;
		switch (cflag & CSIZE) {
Alan Cox's avatar
Alan Cox committed
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
		case CS5:
			bits |= BITS_DATA_5;
			dbg("%s - data bits = 5", __func__);
			break;
		case CS6:
			bits |= BITS_DATA_6;
			dbg("%s - data bits = 6", __func__);
			break;
		case CS7:
			bits |= BITS_DATA_7;
			dbg("%s - data bits = 7", __func__);
			break;
		case CS8:
			bits |= BITS_DATA_8;
			dbg("%s - data bits = 8", __func__);
			break;
		/*case CS9:
			bits |= BITS_DATA_9;
			dbg("%s - data bits = 9", __func__);
			break;*/
		default:
648
			dbg("cp210x driver does not "
Linus Torvalds's avatar
Linus Torvalds committed
649
650
651
652
653
					"support the number of bits requested,"
					" using 8 bit mode\n");
				bits |= BITS_DATA_8;
				break;
		}
654
		if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
655
			dbg("Number of data bits requested "
Linus Torvalds's avatar
Linus Torvalds committed
656
657
658
659
					"not supported by device\n");
	}

	if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))) {
660
		cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
Linus Torvalds's avatar
Linus Torvalds committed
661
662
663
664
		bits &= ~BITS_PARITY_MASK;
		if (cflag & PARENB) {
			if (cflag & PARODD) {
				bits |= BITS_PARITY_ODD;
665
				dbg("%s - parity = ODD", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
666
667
			} else {
				bits |= BITS_PARITY_EVEN;
668
				dbg("%s - parity = EVEN", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
669
670
			}
		}
671
		if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
672
			dbg("Parity mode not supported "
Linus Torvalds's avatar
Linus Torvalds committed
673
674
675
676
					"by device\n");
	}

	if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
677
		cp210x_get_config(port, CP210X_GET_LINE_CTL, &bits, 2);
Linus Torvalds's avatar
Linus Torvalds committed
678
679
680
		bits &= ~BITS_STOP_MASK;
		if (cflag & CSTOPB) {
			bits |= BITS_STOP_2;
681
			dbg("%s - stop bits = 2", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
682
683
		} else {
			bits |= BITS_STOP_1;
684
			dbg("%s - stop bits = 1", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
685
		}
686
		if (cp210x_set_config(port, CP210X_SET_LINE_CTL, &bits, 2))
687
			dbg("Number of stop bits requested "
Linus Torvalds's avatar
Linus Torvalds committed
688
689
					"not supported by device\n");
	}
690
691

	if ((cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
692
		cp210x_get_config(port, CP210X_GET_FLOW, modem_ctl, 16);
693
		dbg("%s - read modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
694
				__func__, modem_ctl[0], modem_ctl[1],
695
696
697
698
699
700
				modem_ctl[2], modem_ctl[3]);

		if (cflag & CRTSCTS) {
			modem_ctl[0] &= ~0x7B;
			modem_ctl[0] |= 0x09;
			modem_ctl[1] = 0x80;
701
			dbg("%s - flow control = CRTSCTS", __func__);
702
703
704
705
		} else {
			modem_ctl[0] &= ~0x7B;
			modem_ctl[0] |= 0x01;
			modem_ctl[1] |= 0x40;
706
			dbg("%s - flow control = NONE", __func__);
707
708
709
		}

		dbg("%s - write modem controls = 0x%.4x 0x%.4x 0x%.4x 0x%.4x",
710
				__func__, modem_ctl[0], modem_ctl[1],
711
				modem_ctl[2], modem_ctl[3]);
712
		cp210x_set_config(port, CP210X_SET_FLOW, modem_ctl, 16);
713
714
715
716
	}

}

717
static int cp210x_tiocmset (struct tty_struct *tty, struct file *file,
718
719
		unsigned int set, unsigned int clear)
{
Alan Cox's avatar
Alan Cox committed
720
	struct usb_serial_port *port = tty->driver_data;
721
	return cp210x_tiocmset_port(port, file, set, clear);
722
723
}

724
static int cp210x_tiocmset_port(struct usb_serial_port *port, struct file *file,
725
726
		unsigned int set, unsigned int clear)
{
727
	unsigned int control = 0;
728

729
	dbg("%s - port %d", __func__, port->number);
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747

	if (set & TIOCM_RTS) {
		control |= CONTROL_RTS;
		control |= CONTROL_WRITE_RTS;
	}
	if (set & TIOCM_DTR) {
		control |= CONTROL_DTR;
		control |= CONTROL_WRITE_DTR;
	}
	if (clear & TIOCM_RTS) {
		control &= ~CONTROL_RTS;
		control |= CONTROL_WRITE_RTS;
	}
	if (clear & TIOCM_DTR) {
		control &= ~CONTROL_DTR;
		control |= CONTROL_WRITE_DTR;
	}

748
	dbg("%s - control = 0x%.4x", __func__, control);
749

750
	return cp210x_set_config(port, CP210X_SET_MHS, &control, 2);
751
752
}

Alan Cox's avatar
Alan Cox committed
753
754
755
756
757
758
759
760
static void cp210x_dtr_rts(struct usb_serial_port *p, int on)
{
	if (on)
		cp210x_tiocmset_port(p, NULL,  TIOCM_DTR|TIOCM_RTS, 0);
	else
		cp210x_tiocmset_port(p, NULL,  0, TIOCM_DTR|TIOCM_RTS);
}

761
static int cp210x_tiocmget (struct tty_struct *tty, struct file *file)
762
{
Alan Cox's avatar
Alan Cox committed
763
	struct usb_serial_port *port = tty->driver_data;
764
765
	unsigned int control;
	int result;
766

767
	dbg("%s - port %d", __func__, port->number);
768

769
	cp210x_get_config(port, CP210X_GET_MDMSTS, &control, 1);
770
771
772
773
774
775
776
777

	result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
		|((control & CONTROL_RTS) ? TIOCM_RTS : 0)
		|((control & CONTROL_CTS) ? TIOCM_CTS : 0)
		|((control & CONTROL_DSR) ? TIOCM_DSR : 0)
		|((control & CONTROL_RING)? TIOCM_RI  : 0)
		|((control & CONTROL_DCD) ? TIOCM_CD  : 0);

778
	dbg("%s - control = 0x%.2x", __func__, control);
779
780

	return result;
Linus Torvalds's avatar
Linus Torvalds committed
781
782
}

Alan Cox's avatar
Alan Cox committed
783
784
785
786
787
788
789
790
791
static int cp210x_carrier_raised(struct usb_serial_port *p)
{
	unsigned int control;
	cp210x_get_config(p, CP210X_GET_MDMSTS, &control, 1);
	if (control & CONTROL_DCD)
		return 1;
	return 0;
}

792
static void cp210x_break_ctl (struct tty_struct *tty, int break_state)
Linus Torvalds's avatar
Linus Torvalds committed
793
{
Alan Cox's avatar
Alan Cox committed
794
	struct usb_serial_port *port = tty->driver_data;
795
	unsigned int state;
Linus Torvalds's avatar
Linus Torvalds committed
796

797
	dbg("%s - port %d", __func__, port->number);
Linus Torvalds's avatar
Linus Torvalds committed
798
799
800
801
	if (break_state == 0)
		state = BREAK_OFF;
	else
		state = BREAK_ON;
802
	dbg("%s - turning break %s", __func__,
Alan Cox's avatar
Alan Cox committed
803
			state == BREAK_OFF ? "off" : "on");
804
	cp210x_set_config(port, CP210X_SET_BREAK, &state, 2);
Linus Torvalds's avatar
Linus Torvalds committed
805
806
}

807
static int cp210x_startup(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
808
{
809
	/* cp210x buffers behave strangely unless device is reset */
Linus Torvalds's avatar
Linus Torvalds committed
810
811
812
813
	usb_reset_device(serial->dev);
	return 0;
}

814
static void cp210x_disconnect(struct usb_serial *serial)
Linus Torvalds's avatar
Linus Torvalds committed
815
816
817
{
	int i;

818
	dbg("%s", __func__);
Linus Torvalds's avatar
Linus Torvalds committed
819

820
	/* Stop reads and writes on all ports */
Alan Cox's avatar
Alan Cox committed
821
	for (i = 0; i < serial->num_ports; ++i)
822
		cp210x_cleanup(serial->port[i]);
Linus Torvalds's avatar
Linus Torvalds committed
823
824
}

825
static int __init cp210x_init(void)
Linus Torvalds's avatar
Linus Torvalds committed
826
827
828
{
	int retval;

829
	retval = usb_serial_register(&cp210x_device);
Linus Torvalds's avatar
Linus Torvalds committed
830
	if (retval)
831
		return retval; /* Failed to register */
Linus Torvalds's avatar
Linus Torvalds committed
832

833
	retval = usb_register(&cp210x_driver);
Linus Torvalds's avatar
Linus Torvalds committed
834
	if (retval) {
835
		/* Failed to register */
836
		usb_serial_deregister(&cp210x_device);
Linus Torvalds's avatar
Linus Torvalds committed
837
838
839
		return retval;
	}

840
	/* Success */
841
842
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
	       DRIVER_DESC "\n");
Linus Torvalds's avatar
Linus Torvalds committed
843
844
845
	return 0;
}

846
static void __exit cp210x_exit(void)
Linus Torvalds's avatar
Linus Torvalds committed
847
{
848
849
	usb_deregister(&cp210x_driver);
	usb_serial_deregister(&cp210x_device);
Linus Torvalds's avatar
Linus Torvalds committed
850
851
}

852
853
module_init(cp210x_init);
module_exit(cp210x_exit);
Linus Torvalds's avatar
Linus Torvalds committed
854
855
856
857
858
859
860

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

module_param(debug, bool, S_IRUGO | S_IWUSR);
MODULE_PARM_DESC(debug, "Enable verbose debugging messages");