xref: /openbmc/linux/drivers/usb/serial/io_edgeport.c (revision 407e7517)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Edgeport USB Serial Converter driver
4  *
5  * Copyright (C) 2000 Inside Out Networks, All rights reserved.
6  * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
7  *
8  * Supports the following devices:
9  *	Edgeport/4
10  *	Edgeport/4t
11  *	Edgeport/2
12  *	Edgeport/4i
13  *	Edgeport/2i
14  *	Edgeport/421
15  *	Edgeport/21
16  *	Rapidport/4
17  *	Edgeport/8
18  *	Edgeport/2D8
19  *	Edgeport/4D8
20  *	Edgeport/8i
21  *
22  * For questions or problems with this driver, contact Inside Out
23  * Networks technical support, or Peter Berger <pberger@brimson.com>,
24  * or Al Borchers <alborchers@steinerpoint.com>.
25  *
26  */
27 
28 #include <linux/kernel.h>
29 #include <linux/jiffies.h>
30 #include <linux/errno.h>
31 #include <linux/slab.h>
32 #include <linux/tty.h>
33 #include <linux/tty_driver.h>
34 #include <linux/tty_flip.h>
35 #include <linux/module.h>
36 #include <linux/spinlock.h>
37 #include <linux/serial.h>
38 #include <linux/ioctl.h>
39 #include <linux/wait.h>
40 #include <linux/firmware.h>
41 #include <linux/ihex.h>
42 #include <linux/uaccess.h>
43 #include <linux/usb.h>
44 #include <linux/usb/serial.h>
45 #include "io_edgeport.h"
46 #include "io_ionsp.h"		/* info for the iosp messages */
47 #include "io_16654.h"		/* 16654 UART defines */
48 
49 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com> and David Iacovelli"
50 #define DRIVER_DESC "Edgeport USB Serial Driver"
51 
52 #define MAX_NAME_LEN		64
53 
54 #define OPEN_TIMEOUT		(5*HZ)		/* 5 seconds */
55 
56 static const struct usb_device_id edgeport_2port_id_table[] = {
57 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_2) },
58 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_2I) },
59 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_421) },
60 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_21) },
61 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_2_DIN) },
62 	{ }
63 };
64 
65 static const struct usb_device_id edgeport_4port_id_table[] = {
66 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_4) },
67 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_RAPIDPORT_4) },
68 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_4T) },
69 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_MT4X56USB) },
70 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_4I) },
71 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU) },
72 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_4_DIN) },
73 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_22I) },
74 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_412_4) },
75 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_COMPATIBLE) },
76 	{ }
77 };
78 
79 static const struct usb_device_id edgeport_8port_id_table[] = {
80 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_8) },
81 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU) },
82 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_8I) },
83 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_8R) },
84 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_8RR) },
85 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_412_8) },
86 	{ }
87 };
88 
89 static const struct usb_device_id Epic_port_id_table[] = {
90 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0202) },
91 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0203) },
92 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0310) },
93 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0311) },
94 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0312) },
95 	{ USB_DEVICE(USB_VENDOR_ID_AXIOHM, AXIOHM_DEVICE_ID_EPIC_A758) },
96 	{ USB_DEVICE(USB_VENDOR_ID_AXIOHM, AXIOHM_DEVICE_ID_EPIC_A794) },
97 	{ USB_DEVICE(USB_VENDOR_ID_AXIOHM, AXIOHM_DEVICE_ID_EPIC_A225) },
98 	{ }
99 };
100 
101 /* Devices that this driver supports */
102 static const struct usb_device_id id_table_combined[] = {
103 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_4) },
104 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_RAPIDPORT_4) },
105 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_4T) },
106 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_MT4X56USB) },
107 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_2) },
108 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_4I) },
109 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_2I) },
110 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_421) },
111 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_21) },
112 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU) },
113 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_8) },
114 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_2_DIN) },
115 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_4_DIN) },
116 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU) },
117 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_22I) },
118 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_412_4) },
119 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_COMPATIBLE) },
120 	{ USB_DEVICE(USB_VENDOR_ID_ION,	ION_DEVICE_ID_EDGEPORT_8I) },
121 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_8R) },
122 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_8RR) },
123 	{ USB_DEVICE(USB_VENDOR_ID_ION, ION_DEVICE_ID_EDGEPORT_412_8) },
124 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0202) },
125 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0203) },
126 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0310) },
127 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0311) },
128 	{ USB_DEVICE(USB_VENDOR_ID_NCR, NCR_DEVICE_ID_EPIC_0312) },
129 	{ USB_DEVICE(USB_VENDOR_ID_AXIOHM, AXIOHM_DEVICE_ID_EPIC_A758) },
130 	{ USB_DEVICE(USB_VENDOR_ID_AXIOHM, AXIOHM_DEVICE_ID_EPIC_A794) },
131 	{ USB_DEVICE(USB_VENDOR_ID_AXIOHM, AXIOHM_DEVICE_ID_EPIC_A225) },
132 	{ } /* Terminating entry */
133 };
134 
135 MODULE_DEVICE_TABLE(usb, id_table_combined);
136 
137 
138 /* receive port state */
139 enum RXSTATE {
140 	EXPECT_HDR1 = 0,    /* Expect header byte 1 */
141 	EXPECT_HDR2 = 1,    /* Expect header byte 2 */
142 	EXPECT_DATA = 2,    /* Expect 'RxBytesRemaining' data */
143 	EXPECT_HDR3 = 3,    /* Expect header byte 3 (for status hdrs only) */
144 };
145 
146 
147 /* Transmit Fifo
148  * This Transmit queue is an extension of the edgeport Rx buffer.
149  * The maximum amount of data buffered in both the edgeport
150  * Rx buffer (maxTxCredits) and this buffer will never exceed maxTxCredits.
151  */
152 struct TxFifo {
153 	unsigned int	head;	/* index to head pointer (write) */
154 	unsigned int	tail;	/* index to tail pointer (read)  */
155 	unsigned int	count;	/* Bytes in queue */
156 	unsigned int	size;	/* Max size of queue (equal to Max number of TxCredits) */
157 	unsigned char	*fifo;	/* allocated Buffer */
158 };
159 
160 /* This structure holds all of the local port information */
161 struct edgeport_port {
162 	__u16			txCredits;		/* our current credits for this port */
163 	__u16			maxTxCredits;		/* the max size of the port */
164 
165 	struct TxFifo		txfifo;			/* transmit fifo -- size will be maxTxCredits */
166 	struct urb		*write_urb;		/* write URB for this port */
167 	bool			write_in_progress;	/* 'true' while a write URB is outstanding */
168 	spinlock_t		ep_lock;
169 
170 	__u8			shadowLCR;		/* last LCR value received */
171 	__u8			shadowMCR;		/* last MCR value received */
172 	__u8			shadowMSR;		/* last MSR value received */
173 	__u8			shadowLSR;		/* last LSR value received */
174 	__u8			shadowXonChar;		/* last value set as XON char in Edgeport */
175 	__u8			shadowXoffChar;		/* last value set as XOFF char in Edgeport */
176 	__u8			validDataMask;
177 	__u32			baudRate;
178 
179 	bool			open;
180 	bool			openPending;
181 	bool			commandPending;
182 	bool			closePending;
183 	bool			chaseResponsePending;
184 
185 	wait_queue_head_t	wait_chase;		/* for handling sleeping while waiting for chase to finish */
186 	wait_queue_head_t	wait_open;		/* for handling sleeping while waiting for open to finish */
187 	wait_queue_head_t	wait_command;		/* for handling sleeping while waiting for command to finish */
188 
189 	struct usb_serial_port	*port;			/* loop back to the owner of this object */
190 };
191 
192 
193 /* This structure holds all of the individual device information */
194 struct edgeport_serial {
195 	char			name[MAX_NAME_LEN+2];		/* string name of this device */
196 
197 	struct edge_manuf_descriptor	manuf_descriptor;	/* the manufacturer descriptor */
198 	struct edge_boot_descriptor	boot_descriptor;	/* the boot firmware descriptor */
199 	struct edgeport_product_info	product_info;		/* Product Info */
200 	struct edge_compatibility_descriptor epic_descriptor;	/* Edgeport compatible descriptor */
201 	int			is_epic;			/* flag if EPiC device or not */
202 
203 	__u8			interrupt_in_endpoint;		/* the interrupt endpoint handle */
204 	unsigned char		*interrupt_in_buffer;		/* the buffer we use for the interrupt endpoint */
205 	struct urb		*interrupt_read_urb;		/* our interrupt urb */
206 
207 	__u8			bulk_in_endpoint;		/* the bulk in endpoint handle */
208 	unsigned char		*bulk_in_buffer;		/* the buffer we use for the bulk in endpoint */
209 	struct urb		*read_urb;			/* our bulk read urb */
210 	bool			read_in_progress;
211 	spinlock_t		es_lock;
212 
213 	__u8			bulk_out_endpoint;		/* the bulk out endpoint handle */
214 
215 	__s16			rxBytesAvail;			/* the number of bytes that we need to read from this device */
216 
217 	enum RXSTATE		rxState;			/* the current state of the bulk receive processor */
218 	__u8			rxHeader1;			/* receive header byte 1 */
219 	__u8			rxHeader2;			/* receive header byte 2 */
220 	__u8			rxHeader3;			/* receive header byte 3 */
221 	__u8			rxPort;				/* the port that we are currently receiving data for */
222 	__u8			rxStatusCode;			/* the receive status code */
223 	__u8			rxStatusParam;			/* the receive status paramater */
224 	__s16			rxBytesRemaining;		/* the number of port bytes left to read */
225 	struct usb_serial	*serial;			/* loop back to the owner of this object */
226 };
227 
228 /* baud rate information */
229 struct divisor_table_entry {
230 	__u32   BaudRate;
231 	__u16  Divisor;
232 };
233 
234 /*
235  * Define table of divisors for Rev A EdgePort/4 hardware
236  * These assume a 3.6864MHz crystal, the standard /16, and
237  * MCR.7 = 0.
238  */
239 
240 static const struct divisor_table_entry divisor_table[] = {
241 	{   50,		4608},
242 	{   75,		3072},
243 	{   110,	2095},	/* 2094.545455 => 230450   => .0217 % over */
244 	{   134,	1713},	/* 1713.011152 => 230398.5 => .00065% under */
245 	{   150,	1536},
246 	{   300,	768},
247 	{   600,	384},
248 	{   1200,	192},
249 	{   1800,	128},
250 	{   2400,	96},
251 	{   4800,	48},
252 	{   7200,	32},
253 	{   9600,	24},
254 	{   14400,	16},
255 	{   19200,	12},
256 	{   38400,	6},
257 	{   57600,	4},
258 	{   115200,	2},
259 	{   230400,	1},
260 };
261 
262 /* Number of outstanding Command Write Urbs */
263 static atomic_t CmdUrbs = ATOMIC_INIT(0);
264 
265 
266 /* local function prototypes */
267 
268 /* function prototypes for all URB callbacks */
269 static void edge_interrupt_callback(struct urb *urb);
270 static void edge_bulk_in_callback(struct urb *urb);
271 static void edge_bulk_out_data_callback(struct urb *urb);
272 static void edge_bulk_out_cmd_callback(struct urb *urb);
273 
274 /* function prototypes for the usbserial callbacks */
275 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port);
276 static void edge_close(struct usb_serial_port *port);
277 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
278 					const unsigned char *buf, int count);
279 static int edge_write_room(struct tty_struct *tty);
280 static int edge_chars_in_buffer(struct tty_struct *tty);
281 static void edge_throttle(struct tty_struct *tty);
282 static void edge_unthrottle(struct tty_struct *tty);
283 static void edge_set_termios(struct tty_struct *tty,
284 					struct usb_serial_port *port,
285 					struct ktermios *old_termios);
286 static int  edge_ioctl(struct tty_struct *tty,
287 					unsigned int cmd, unsigned long arg);
288 static void edge_break(struct tty_struct *tty, int break_state);
289 static int  edge_tiocmget(struct tty_struct *tty);
290 static int  edge_tiocmset(struct tty_struct *tty,
291 					unsigned int set, unsigned int clear);
292 static int  edge_startup(struct usb_serial *serial);
293 static void edge_disconnect(struct usb_serial *serial);
294 static void edge_release(struct usb_serial *serial);
295 static int edge_port_probe(struct usb_serial_port *port);
296 static int edge_port_remove(struct usb_serial_port *port);
297 
298 /* function prototypes for all of our local functions */
299 
300 static void  process_rcvd_data(struct edgeport_serial *edge_serial,
301 				unsigned char *buffer, __u16 bufferLength);
302 static void process_rcvd_status(struct edgeport_serial *edge_serial,
303 				__u8 byte2, __u8 byte3);
304 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
305 		int length);
306 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr);
307 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData,
308 				__u8 lsr, __u8 data);
309 static int  send_iosp_ext_cmd(struct edgeport_port *edge_port, __u8 command,
310 				__u8 param);
311 static int  calc_baud_rate_divisor(struct device *dev, int baud_rate, int *divisor);
312 static int  send_cmd_write_baud_rate(struct edgeport_port *edge_port,
313 				int baudRate);
314 static void change_port_settings(struct tty_struct *tty,
315 				struct edgeport_port *edge_port,
316 				struct ktermios *old_termios);
317 static int  send_cmd_write_uart_register(struct edgeport_port *edge_port,
318 				__u8 regNum, __u8 regValue);
319 static int  write_cmd_usb(struct edgeport_port *edge_port,
320 				unsigned char *buffer, int writeLength);
321 static void send_more_port_data(struct edgeport_serial *edge_serial,
322 				struct edgeport_port *edge_port);
323 
324 static int sram_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
325 					__u16 length, const __u8 *data);
326 static int rom_read(struct usb_serial *serial, __u16 extAddr, __u16 addr,
327 						__u16 length, __u8 *data);
328 static int rom_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
329 					__u16 length, const __u8 *data);
330 static void get_manufacturing_desc(struct edgeport_serial *edge_serial);
331 static void get_boot_desc(struct edgeport_serial *edge_serial);
332 static void load_application_firmware(struct edgeport_serial *edge_serial);
333 
334 static void unicode_to_ascii(char *string, int buflen,
335 				__le16 *unicode, int unicode_size);
336 
337 
338 /* ************************************************************************ */
339 /* ************************************************************************ */
340 /* ************************************************************************ */
341 /* ************************************************************************ */
342 
343 /************************************************************************
344  *									*
345  * update_edgeport_E2PROM()	Compare current versions of		*
346  *				Boot ROM and Manufacture 		*
347  *				Descriptors with versions		*
348  *				embedded in this driver			*
349  *									*
350  ************************************************************************/
351 static void update_edgeport_E2PROM(struct edgeport_serial *edge_serial)
352 {
353 	struct device *dev = &edge_serial->serial->dev->dev;
354 	__u32 BootCurVer;
355 	__u32 BootNewVer;
356 	__u8 BootMajorVersion;
357 	__u8 BootMinorVersion;
358 	__u16 BootBuildNumber;
359 	__u32 Bootaddr;
360 	const struct ihex_binrec *rec;
361 	const struct firmware *fw;
362 	const char *fw_name;
363 	int response;
364 
365 	switch (edge_serial->product_info.iDownloadFile) {
366 	case EDGE_DOWNLOAD_FILE_I930:
367 		fw_name	= "edgeport/boot.fw";
368 		break;
369 	case EDGE_DOWNLOAD_FILE_80251:
370 		fw_name	= "edgeport/boot2.fw";
371 		break;
372 	default:
373 		return;
374 	}
375 
376 	response = request_ihex_firmware(&fw, fw_name,
377 					 &edge_serial->serial->dev->dev);
378 	if (response) {
379 		dev_err(dev, "Failed to load image \"%s\" err %d\n",
380 		       fw_name, response);
381 		return;
382 	}
383 
384 	rec = (const struct ihex_binrec *)fw->data;
385 	BootMajorVersion = rec->data[0];
386 	BootMinorVersion = rec->data[1];
387 	BootBuildNumber = (rec->data[2] << 8) | rec->data[3];
388 
389 	/* Check Boot Image Version */
390 	BootCurVer = (edge_serial->boot_descriptor.MajorVersion << 24) +
391 		     (edge_serial->boot_descriptor.MinorVersion << 16) +
392 		      le16_to_cpu(edge_serial->boot_descriptor.BuildNumber);
393 
394 	BootNewVer = (BootMajorVersion << 24) +
395 		     (BootMinorVersion << 16) +
396 		      BootBuildNumber;
397 
398 	dev_dbg(dev, "Current Boot Image version %d.%d.%d\n",
399 	    edge_serial->boot_descriptor.MajorVersion,
400 	    edge_serial->boot_descriptor.MinorVersion,
401 	    le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
402 
403 
404 	if (BootNewVer > BootCurVer) {
405 		dev_dbg(dev, "**Update Boot Image from %d.%d.%d to %d.%d.%d\n",
406 		    edge_serial->boot_descriptor.MajorVersion,
407 		    edge_serial->boot_descriptor.MinorVersion,
408 		    le16_to_cpu(edge_serial->boot_descriptor.BuildNumber),
409 		    BootMajorVersion, BootMinorVersion, BootBuildNumber);
410 
411 		dev_dbg(dev, "Downloading new Boot Image\n");
412 
413 		for (rec = ihex_next_binrec(rec); rec;
414 		     rec = ihex_next_binrec(rec)) {
415 			Bootaddr = be32_to_cpu(rec->addr);
416 			response = rom_write(edge_serial->serial,
417 					     Bootaddr >> 16,
418 					     Bootaddr & 0xFFFF,
419 					     be16_to_cpu(rec->len),
420 					     &rec->data[0]);
421 			if (response < 0) {
422 				dev_err(&edge_serial->serial->dev->dev,
423 					"rom_write failed (%x, %x, %d)\n",
424 					Bootaddr >> 16, Bootaddr & 0xFFFF,
425 					be16_to_cpu(rec->len));
426 				break;
427 			}
428 		}
429 	} else {
430 		dev_dbg(dev, "Boot Image -- already up to date\n");
431 	}
432 	release_firmware(fw);
433 }
434 
435 #if 0
436 /************************************************************************
437  *
438  *  Get string descriptor from device
439  *
440  ************************************************************************/
441 static int get_string_desc(struct usb_device *dev, int Id,
442 				struct usb_string_descriptor **pRetDesc)
443 {
444 	struct usb_string_descriptor StringDesc;
445 	struct usb_string_descriptor *pStringDesc;
446 
447 	dev_dbg(&dev->dev, "%s - USB String ID = %d\n", __func__, Id);
448 
449 	if (!usb_get_descriptor(dev, USB_DT_STRING, Id, &StringDesc,
450 						sizeof(StringDesc)))
451 		return 0;
452 
453 	pStringDesc = kmalloc(StringDesc.bLength, GFP_KERNEL);
454 	if (!pStringDesc)
455 		return -1;
456 
457 	if (!usb_get_descriptor(dev, USB_DT_STRING, Id, pStringDesc,
458 							StringDesc.bLength)) {
459 		kfree(pStringDesc);
460 		return -1;
461 	}
462 
463 	*pRetDesc = pStringDesc;
464 	return 0;
465 }
466 #endif
467 
468 static void dump_product_info(struct edgeport_serial *edge_serial,
469 			      struct edgeport_product_info *product_info)
470 {
471 	struct device *dev = &edge_serial->serial->dev->dev;
472 
473 	/* Dump Product Info structure */
474 	dev_dbg(dev, "**Product Information:\n");
475 	dev_dbg(dev, "  ProductId             %x\n", product_info->ProductId);
476 	dev_dbg(dev, "  NumPorts              %d\n", product_info->NumPorts);
477 	dev_dbg(dev, "  ProdInfoVer           %d\n", product_info->ProdInfoVer);
478 	dev_dbg(dev, "  IsServer              %d\n", product_info->IsServer);
479 	dev_dbg(dev, "  IsRS232               %d\n", product_info->IsRS232);
480 	dev_dbg(dev, "  IsRS422               %d\n", product_info->IsRS422);
481 	dev_dbg(dev, "  IsRS485               %d\n", product_info->IsRS485);
482 	dev_dbg(dev, "  RomSize               %d\n", product_info->RomSize);
483 	dev_dbg(dev, "  RamSize               %d\n", product_info->RamSize);
484 	dev_dbg(dev, "  CpuRev                %x\n", product_info->CpuRev);
485 	dev_dbg(dev, "  BoardRev              %x\n", product_info->BoardRev);
486 	dev_dbg(dev, "  BootMajorVersion      %d.%d.%d\n",
487 		product_info->BootMajorVersion,
488 		product_info->BootMinorVersion,
489 		le16_to_cpu(product_info->BootBuildNumber));
490 	dev_dbg(dev, "  FirmwareMajorVersion  %d.%d.%d\n",
491 		product_info->FirmwareMajorVersion,
492 		product_info->FirmwareMinorVersion,
493 		le16_to_cpu(product_info->FirmwareBuildNumber));
494 	dev_dbg(dev, "  ManufactureDescDate   %d/%d/%d\n",
495 		product_info->ManufactureDescDate[0],
496 		product_info->ManufactureDescDate[1],
497 		product_info->ManufactureDescDate[2]+1900);
498 	dev_dbg(dev, "  iDownloadFile         0x%x\n",
499 		product_info->iDownloadFile);
500 	dev_dbg(dev, "  EpicVer               %d\n", product_info->EpicVer);
501 }
502 
503 static void get_product_info(struct edgeport_serial *edge_serial)
504 {
505 	struct edgeport_product_info *product_info = &edge_serial->product_info;
506 
507 	memset(product_info, 0, sizeof(struct edgeport_product_info));
508 
509 	product_info->ProductId = (__u16)(le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct) & ~ION_DEVICE_ID_80251_NETCHIP);
510 	product_info->NumPorts = edge_serial->manuf_descriptor.NumPorts;
511 	product_info->ProdInfoVer = 0;
512 
513 	product_info->RomSize = edge_serial->manuf_descriptor.RomSize;
514 	product_info->RamSize = edge_serial->manuf_descriptor.RamSize;
515 	product_info->CpuRev = edge_serial->manuf_descriptor.CpuRev;
516 	product_info->BoardRev = edge_serial->manuf_descriptor.BoardRev;
517 
518 	product_info->BootMajorVersion =
519 				edge_serial->boot_descriptor.MajorVersion;
520 	product_info->BootMinorVersion =
521 				edge_serial->boot_descriptor.MinorVersion;
522 	product_info->BootBuildNumber =
523 				edge_serial->boot_descriptor.BuildNumber;
524 
525 	memcpy(product_info->ManufactureDescDate,
526 			edge_serial->manuf_descriptor.DescDate,
527 			sizeof(edge_serial->manuf_descriptor.DescDate));
528 
529 	/* check if this is 2nd generation hardware */
530 	if (le16_to_cpu(edge_serial->serial->dev->descriptor.idProduct)
531 					    & ION_DEVICE_ID_80251_NETCHIP)
532 		product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_80251;
533 	else
534 		product_info->iDownloadFile = EDGE_DOWNLOAD_FILE_I930;
535 
536 	/* Determine Product type and set appropriate flags */
537 	switch (DEVICE_ID_FROM_USB_PRODUCT_ID(product_info->ProductId)) {
538 	case ION_DEVICE_ID_EDGEPORT_COMPATIBLE:
539 	case ION_DEVICE_ID_EDGEPORT_4T:
540 	case ION_DEVICE_ID_EDGEPORT_4:
541 	case ION_DEVICE_ID_EDGEPORT_2:
542 	case ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU:
543 	case ION_DEVICE_ID_EDGEPORT_8:
544 	case ION_DEVICE_ID_EDGEPORT_421:
545 	case ION_DEVICE_ID_EDGEPORT_21:
546 	case ION_DEVICE_ID_EDGEPORT_2_DIN:
547 	case ION_DEVICE_ID_EDGEPORT_4_DIN:
548 	case ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU:
549 		product_info->IsRS232 = 1;
550 		break;
551 
552 	case ION_DEVICE_ID_EDGEPORT_2I:	/* Edgeport/2 RS422/RS485 */
553 		product_info->IsRS422 = 1;
554 		product_info->IsRS485 = 1;
555 		break;
556 
557 	case ION_DEVICE_ID_EDGEPORT_8I:	/* Edgeport/4 RS422 */
558 	case ION_DEVICE_ID_EDGEPORT_4I:	/* Edgeport/4 RS422 */
559 		product_info->IsRS422 = 1;
560 		break;
561 	}
562 
563 	dump_product_info(edge_serial, product_info);
564 }
565 
566 static int get_epic_descriptor(struct edgeport_serial *ep)
567 {
568 	int result;
569 	struct usb_serial *serial = ep->serial;
570 	struct edgeport_product_info *product_info = &ep->product_info;
571 	struct edge_compatibility_descriptor *epic;
572 	struct edge_compatibility_bits *bits;
573 	struct device *dev = &serial->dev->dev;
574 
575 	ep->is_epic = 0;
576 
577 	epic = kmalloc(sizeof(*epic), GFP_KERNEL);
578 	if (!epic)
579 		return -ENOMEM;
580 
581 	result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
582 				 USB_REQUEST_ION_GET_EPIC_DESC,
583 				 0xC0, 0x00, 0x00,
584 				 epic, sizeof(*epic),
585 				 300);
586 	if (result == sizeof(*epic)) {
587 		ep->is_epic = 1;
588 		memcpy(&ep->epic_descriptor, epic, sizeof(*epic));
589 		memset(product_info, 0, sizeof(struct edgeport_product_info));
590 
591 		product_info->NumPorts = epic->NumPorts;
592 		product_info->ProdInfoVer = 0;
593 		product_info->FirmwareMajorVersion = epic->MajorVersion;
594 		product_info->FirmwareMinorVersion = epic->MinorVersion;
595 		product_info->FirmwareBuildNumber = epic->BuildNumber;
596 		product_info->iDownloadFile = epic->iDownloadFile;
597 		product_info->EpicVer = epic->EpicVer;
598 		product_info->Epic = epic->Supports;
599 		product_info->ProductId = ION_DEVICE_ID_EDGEPORT_COMPATIBLE;
600 		dump_product_info(ep, product_info);
601 
602 		bits = &ep->epic_descriptor.Supports;
603 		dev_dbg(dev, "**EPIC descriptor:\n");
604 		dev_dbg(dev, "  VendEnableSuspend: %s\n", bits->VendEnableSuspend ? "TRUE": "FALSE");
605 		dev_dbg(dev, "  IOSPOpen         : %s\n", bits->IOSPOpen	? "TRUE": "FALSE");
606 		dev_dbg(dev, "  IOSPClose        : %s\n", bits->IOSPClose	? "TRUE": "FALSE");
607 		dev_dbg(dev, "  IOSPChase        : %s\n", bits->IOSPChase	? "TRUE": "FALSE");
608 		dev_dbg(dev, "  IOSPSetRxFlow    : %s\n", bits->IOSPSetRxFlow	? "TRUE": "FALSE");
609 		dev_dbg(dev, "  IOSPSetTxFlow    : %s\n", bits->IOSPSetTxFlow	? "TRUE": "FALSE");
610 		dev_dbg(dev, "  IOSPSetXChar     : %s\n", bits->IOSPSetXChar	? "TRUE": "FALSE");
611 		dev_dbg(dev, "  IOSPRxCheck      : %s\n", bits->IOSPRxCheck	? "TRUE": "FALSE");
612 		dev_dbg(dev, "  IOSPSetClrBreak  : %s\n", bits->IOSPSetClrBreak	? "TRUE": "FALSE");
613 		dev_dbg(dev, "  IOSPWriteMCR     : %s\n", bits->IOSPWriteMCR	? "TRUE": "FALSE");
614 		dev_dbg(dev, "  IOSPWriteLCR     : %s\n", bits->IOSPWriteLCR	? "TRUE": "FALSE");
615 		dev_dbg(dev, "  IOSPSetBaudRate  : %s\n", bits->IOSPSetBaudRate	? "TRUE": "FALSE");
616 		dev_dbg(dev, "  TrueEdgeport     : %s\n", bits->TrueEdgeport	? "TRUE": "FALSE");
617 
618 		result = 0;
619 	} else if (result >= 0) {
620 		dev_warn(&serial->interface->dev, "short epic descriptor received: %d\n",
621 			 result);
622 		result = -EIO;
623 	}
624 
625 	kfree(epic);
626 
627 	return result;
628 }
629 
630 
631 /************************************************************************/
632 /************************************************************************/
633 /*            U S B  C A L L B A C K   F U N C T I O N S                */
634 /*            U S B  C A L L B A C K   F U N C T I O N S                */
635 /************************************************************************/
636 /************************************************************************/
637 
638 /*****************************************************************************
639  * edge_interrupt_callback
640  *	this is the callback function for when we have received data on the
641  *	interrupt endpoint.
642  *****************************************************************************/
643 static void edge_interrupt_callback(struct urb *urb)
644 {
645 	struct edgeport_serial *edge_serial = urb->context;
646 	struct device *dev;
647 	struct edgeport_port *edge_port;
648 	struct usb_serial_port *port;
649 	unsigned char *data = urb->transfer_buffer;
650 	int length = urb->actual_length;
651 	int bytes_avail;
652 	int position;
653 	int txCredits;
654 	int portNumber;
655 	int result;
656 	int status = urb->status;
657 
658 	switch (status) {
659 	case 0:
660 		/* success */
661 		break;
662 	case -ECONNRESET:
663 	case -ENOENT:
664 	case -ESHUTDOWN:
665 		/* this urb is terminated, clean up */
666 		dev_dbg(&urb->dev->dev, "%s - urb shutting down with status: %d\n", __func__, status);
667 		return;
668 	default:
669 		dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
670 		goto exit;
671 	}
672 
673 	dev = &edge_serial->serial->dev->dev;
674 
675 	/* process this interrupt-read even if there are no ports open */
676 	if (length) {
677 		usb_serial_debug_data(dev, __func__, length, data);
678 
679 		if (length > 1) {
680 			bytes_avail = data[0] | (data[1] << 8);
681 			if (bytes_avail) {
682 				spin_lock(&edge_serial->es_lock);
683 				edge_serial->rxBytesAvail += bytes_avail;
684 				dev_dbg(dev,
685 					"%s - bytes_avail=%d, rxBytesAvail=%d, read_in_progress=%d\n",
686 					__func__, bytes_avail,
687 					edge_serial->rxBytesAvail,
688 					edge_serial->read_in_progress);
689 
690 				if (edge_serial->rxBytesAvail > 0 &&
691 				    !edge_serial->read_in_progress) {
692 					dev_dbg(dev, "%s - posting a read\n", __func__);
693 					edge_serial->read_in_progress = true;
694 
695 					/* we have pending bytes on the
696 					   bulk in pipe, send a request */
697 					result = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
698 					if (result) {
699 						dev_err(dev,
700 							"%s - usb_submit_urb(read bulk) failed with result = %d\n",
701 							__func__, result);
702 						edge_serial->read_in_progress = false;
703 					}
704 				}
705 				spin_unlock(&edge_serial->es_lock);
706 			}
707 		}
708 		/* grab the txcredits for the ports if available */
709 		position = 2;
710 		portNumber = 0;
711 		while ((position < length) &&
712 				(portNumber < edge_serial->serial->num_ports)) {
713 			txCredits = data[position] | (data[position+1] << 8);
714 			if (txCredits) {
715 				port = edge_serial->serial->port[portNumber];
716 				edge_port = usb_get_serial_port_data(port);
717 				if (edge_port->open) {
718 					spin_lock(&edge_port->ep_lock);
719 					edge_port->txCredits += txCredits;
720 					spin_unlock(&edge_port->ep_lock);
721 					dev_dbg(dev, "%s - txcredits for port%d = %d\n",
722 						__func__, portNumber,
723 						edge_port->txCredits);
724 
725 					/* tell the tty driver that something
726 					   has changed */
727 					tty_port_tty_wakeup(&edge_port->port->port);
728 					/* Since we have more credit, check
729 					   if more data can be sent */
730 					send_more_port_data(edge_serial,
731 								edge_port);
732 				}
733 			}
734 			position += 2;
735 			++portNumber;
736 		}
737 	}
738 
739 exit:
740 	result = usb_submit_urb(urb, GFP_ATOMIC);
741 	if (result)
742 		dev_err(&urb->dev->dev,
743 			"%s - Error %d submitting control urb\n",
744 						__func__, result);
745 }
746 
747 
748 /*****************************************************************************
749  * edge_bulk_in_callback
750  *	this is the callback function for when we have received data on the
751  *	bulk in endpoint.
752  *****************************************************************************/
753 static void edge_bulk_in_callback(struct urb *urb)
754 {
755 	struct edgeport_serial	*edge_serial = urb->context;
756 	struct device *dev;
757 	unsigned char		*data = urb->transfer_buffer;
758 	int			retval;
759 	__u16			raw_data_length;
760 	int status = urb->status;
761 
762 	if (status) {
763 		dev_dbg(&urb->dev->dev, "%s - nonzero read bulk status received: %d\n",
764 			__func__, status);
765 		edge_serial->read_in_progress = false;
766 		return;
767 	}
768 
769 	if (urb->actual_length == 0) {
770 		dev_dbg(&urb->dev->dev, "%s - read bulk callback with no data\n", __func__);
771 		edge_serial->read_in_progress = false;
772 		return;
773 	}
774 
775 	dev = &edge_serial->serial->dev->dev;
776 	raw_data_length = urb->actual_length;
777 
778 	usb_serial_debug_data(dev, __func__, raw_data_length, data);
779 
780 	spin_lock(&edge_serial->es_lock);
781 
782 	/* decrement our rxBytes available by the number that we just got */
783 	edge_serial->rxBytesAvail -= raw_data_length;
784 
785 	dev_dbg(dev, "%s - Received = %d, rxBytesAvail %d\n", __func__,
786 		raw_data_length, edge_serial->rxBytesAvail);
787 
788 	process_rcvd_data(edge_serial, data, urb->actual_length);
789 
790 	/* check to see if there's any more data for us to read */
791 	if (edge_serial->rxBytesAvail > 0) {
792 		dev_dbg(dev, "%s - posting a read\n", __func__);
793 		retval = usb_submit_urb(edge_serial->read_urb, GFP_ATOMIC);
794 		if (retval) {
795 			dev_err(dev,
796 				"%s - usb_submit_urb(read bulk) failed, retval = %d\n",
797 				__func__, retval);
798 			edge_serial->read_in_progress = false;
799 		}
800 	} else {
801 		edge_serial->read_in_progress = false;
802 	}
803 
804 	spin_unlock(&edge_serial->es_lock);
805 }
806 
807 
808 /*****************************************************************************
809  * edge_bulk_out_data_callback
810  *	this is the callback function for when we have finished sending
811  *	serial data on the bulk out endpoint.
812  *****************************************************************************/
813 static void edge_bulk_out_data_callback(struct urb *urb)
814 {
815 	struct edgeport_port *edge_port = urb->context;
816 	int status = urb->status;
817 
818 	if (status) {
819 		dev_dbg(&urb->dev->dev,
820 			"%s - nonzero write bulk status received: %d\n",
821 			__func__, status);
822 	}
823 
824 	if (edge_port->open)
825 		tty_port_tty_wakeup(&edge_port->port->port);
826 
827 	/* Release the Write URB */
828 	edge_port->write_in_progress = false;
829 
830 	/* Check if more data needs to be sent */
831 	send_more_port_data((struct edgeport_serial *)
832 		(usb_get_serial_data(edge_port->port->serial)), edge_port);
833 }
834 
835 
836 /*****************************************************************************
837  * BulkOutCmdCallback
838  *	this is the callback function for when we have finished sending a
839  *	command	on the bulk out endpoint.
840  *****************************************************************************/
841 static void edge_bulk_out_cmd_callback(struct urb *urb)
842 {
843 	struct edgeport_port *edge_port = urb->context;
844 	int status = urb->status;
845 
846 	atomic_dec(&CmdUrbs);
847 	dev_dbg(&urb->dev->dev, "%s - FREE URB %p (outstanding %d)\n",
848 		__func__, urb, atomic_read(&CmdUrbs));
849 
850 
851 	/* clean up the transfer buffer */
852 	kfree(urb->transfer_buffer);
853 
854 	/* Free the command urb */
855 	usb_free_urb(urb);
856 
857 	if (status) {
858 		dev_dbg(&urb->dev->dev,
859 			"%s - nonzero write bulk status received: %d\n",
860 			__func__, status);
861 		return;
862 	}
863 
864 	/* tell the tty driver that something has changed */
865 	if (edge_port->open)
866 		tty_port_tty_wakeup(&edge_port->port->port);
867 
868 	/* we have completed the command */
869 	edge_port->commandPending = false;
870 	wake_up(&edge_port->wait_command);
871 }
872 
873 
874 /*****************************************************************************
875  * Driver tty interface functions
876  *****************************************************************************/
877 
878 /*****************************************************************************
879  * SerialOpen
880  *	this function is called by the tty driver when a port is opened
881  *	If successful, we return 0
882  *	Otherwise we return a negative error number.
883  *****************************************************************************/
884 static int edge_open(struct tty_struct *tty, struct usb_serial_port *port)
885 {
886 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
887 	struct device *dev = &port->dev;
888 	struct usb_serial *serial;
889 	struct edgeport_serial *edge_serial;
890 	int response;
891 
892 	if (edge_port == NULL)
893 		return -ENODEV;
894 
895 	/* see if we've set up our endpoint info yet (can't set it up
896 	   in edge_startup as the structures were not set up at that time.) */
897 	serial = port->serial;
898 	edge_serial = usb_get_serial_data(serial);
899 	if (edge_serial == NULL)
900 		return -ENODEV;
901 	if (edge_serial->interrupt_in_buffer == NULL) {
902 		struct usb_serial_port *port0 = serial->port[0];
903 
904 		/* not set up yet, so do it now */
905 		edge_serial->interrupt_in_buffer =
906 					port0->interrupt_in_buffer;
907 		edge_serial->interrupt_in_endpoint =
908 					port0->interrupt_in_endpointAddress;
909 		edge_serial->interrupt_read_urb = port0->interrupt_in_urb;
910 		edge_serial->bulk_in_buffer = port0->bulk_in_buffer;
911 		edge_serial->bulk_in_endpoint =
912 					port0->bulk_in_endpointAddress;
913 		edge_serial->read_urb = port0->read_urb;
914 		edge_serial->bulk_out_endpoint =
915 					port0->bulk_out_endpointAddress;
916 
917 		/* set up our interrupt urb */
918 		usb_fill_int_urb(edge_serial->interrupt_read_urb,
919 		      serial->dev,
920 		      usb_rcvintpipe(serial->dev,
921 				port0->interrupt_in_endpointAddress),
922 		      port0->interrupt_in_buffer,
923 		      edge_serial->interrupt_read_urb->transfer_buffer_length,
924 		      edge_interrupt_callback, edge_serial,
925 		      edge_serial->interrupt_read_urb->interval);
926 
927 		/* set up our bulk in urb */
928 		usb_fill_bulk_urb(edge_serial->read_urb, serial->dev,
929 			usb_rcvbulkpipe(serial->dev,
930 				port0->bulk_in_endpointAddress),
931 			port0->bulk_in_buffer,
932 			edge_serial->read_urb->transfer_buffer_length,
933 			edge_bulk_in_callback, edge_serial);
934 		edge_serial->read_in_progress = false;
935 
936 		/* start interrupt read for this edgeport
937 		 * this interrupt will continue as long
938 		 * as the edgeport is connected */
939 		response = usb_submit_urb(edge_serial->interrupt_read_urb,
940 								GFP_KERNEL);
941 		if (response) {
942 			dev_err(dev, "%s - Error %d submitting control urb\n",
943 				__func__, response);
944 		}
945 	}
946 
947 	/* initialize our wait queues */
948 	init_waitqueue_head(&edge_port->wait_open);
949 	init_waitqueue_head(&edge_port->wait_chase);
950 	init_waitqueue_head(&edge_port->wait_command);
951 
952 	/* initialize our port settings */
953 	edge_port->txCredits = 0;	/* Can't send any data yet */
954 	/* Must always set this bit to enable ints! */
955 	edge_port->shadowMCR = MCR_MASTER_IE;
956 	edge_port->chaseResponsePending = false;
957 
958 	/* send a open port command */
959 	edge_port->openPending = true;
960 	edge_port->open        = false;
961 	response = send_iosp_ext_cmd(edge_port, IOSP_CMD_OPEN_PORT, 0);
962 
963 	if (response < 0) {
964 		dev_err(dev, "%s - error sending open port command\n", __func__);
965 		edge_port->openPending = false;
966 		return -ENODEV;
967 	}
968 
969 	/* now wait for the port to be completely opened */
970 	wait_event_timeout(edge_port->wait_open, !edge_port->openPending,
971 								OPEN_TIMEOUT);
972 
973 	if (!edge_port->open) {
974 		/* open timed out */
975 		dev_dbg(dev, "%s - open timedout\n", __func__);
976 		edge_port->openPending = false;
977 		return -ENODEV;
978 	}
979 
980 	/* create the txfifo */
981 	edge_port->txfifo.head	= 0;
982 	edge_port->txfifo.tail	= 0;
983 	edge_port->txfifo.count	= 0;
984 	edge_port->txfifo.size	= edge_port->maxTxCredits;
985 	edge_port->txfifo.fifo	= kmalloc(edge_port->maxTxCredits, GFP_KERNEL);
986 
987 	if (!edge_port->txfifo.fifo) {
988 		edge_close(port);
989 		return -ENOMEM;
990 	}
991 
992 	/* Allocate a URB for the write */
993 	edge_port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
994 	edge_port->write_in_progress = false;
995 
996 	if (!edge_port->write_urb) {
997 		edge_close(port);
998 		return -ENOMEM;
999 	}
1000 
1001 	dev_dbg(dev, "%s - Initialize TX fifo to %d bytes\n",
1002 		__func__, edge_port->maxTxCredits);
1003 
1004 	return 0;
1005 }
1006 
1007 
1008 /************************************************************************
1009  *
1010  * block_until_chase_response
1011  *
1012  *	This function will block the close until one of the following:
1013  *		1. Response to our Chase comes from Edgeport
1014  *		2. A timeout of 10 seconds without activity has expired
1015  *		   (1K of Edgeport data @ 2400 baud ==> 4 sec to empty)
1016  *
1017  ************************************************************************/
1018 static void block_until_chase_response(struct edgeport_port *edge_port)
1019 {
1020 	struct device *dev = &edge_port->port->dev;
1021 	DEFINE_WAIT(wait);
1022 	__u16 lastCredits;
1023 	int timeout = 1*HZ;
1024 	int loop = 10;
1025 
1026 	while (1) {
1027 		/* Save Last credits */
1028 		lastCredits = edge_port->txCredits;
1029 
1030 		/* Did we get our Chase response */
1031 		if (!edge_port->chaseResponsePending) {
1032 			dev_dbg(dev, "%s - Got Chase Response\n", __func__);
1033 
1034 			/* did we get all of our credit back? */
1035 			if (edge_port->txCredits == edge_port->maxTxCredits) {
1036 				dev_dbg(dev, "%s - Got all credits\n", __func__);
1037 				return;
1038 			}
1039 		}
1040 
1041 		/* Block the thread for a while */
1042 		prepare_to_wait(&edge_port->wait_chase, &wait,
1043 						TASK_UNINTERRUPTIBLE);
1044 		schedule_timeout(timeout);
1045 		finish_wait(&edge_port->wait_chase, &wait);
1046 
1047 		if (lastCredits == edge_port->txCredits) {
1048 			/* No activity.. count down. */
1049 			loop--;
1050 			if (loop == 0) {
1051 				edge_port->chaseResponsePending = false;
1052 				dev_dbg(dev, "%s - Chase TIMEOUT\n", __func__);
1053 				return;
1054 			}
1055 		} else {
1056 			/* Reset timeout value back to 10 seconds */
1057 			dev_dbg(dev, "%s - Last %d, Current %d\n", __func__,
1058 					lastCredits, edge_port->txCredits);
1059 			loop = 10;
1060 		}
1061 	}
1062 }
1063 
1064 
1065 /************************************************************************
1066  *
1067  * block_until_tx_empty
1068  *
1069  *	This function will block the close until one of the following:
1070  *		1. TX count are 0
1071  *		2. The edgeport has stopped
1072  *		3. A timeout of 3 seconds without activity has expired
1073  *
1074  ************************************************************************/
1075 static void block_until_tx_empty(struct edgeport_port *edge_port)
1076 {
1077 	struct device *dev = &edge_port->port->dev;
1078 	DEFINE_WAIT(wait);
1079 	struct TxFifo *fifo = &edge_port->txfifo;
1080 	__u32 lastCount;
1081 	int timeout = HZ/10;
1082 	int loop = 30;
1083 
1084 	while (1) {
1085 		/* Save Last count */
1086 		lastCount = fifo->count;
1087 
1088 		/* Is the Edgeport Buffer empty? */
1089 		if (lastCount == 0) {
1090 			dev_dbg(dev, "%s - TX Buffer Empty\n", __func__);
1091 			return;
1092 		}
1093 
1094 		/* Block the thread for a while */
1095 		prepare_to_wait(&edge_port->wait_chase, &wait,
1096 						TASK_UNINTERRUPTIBLE);
1097 		schedule_timeout(timeout);
1098 		finish_wait(&edge_port->wait_chase, &wait);
1099 
1100 		dev_dbg(dev, "%s wait\n", __func__);
1101 
1102 		if (lastCount == fifo->count) {
1103 			/* No activity.. count down. */
1104 			loop--;
1105 			if (loop == 0) {
1106 				dev_dbg(dev, "%s - TIMEOUT\n", __func__);
1107 				return;
1108 			}
1109 		} else {
1110 			/* Reset timeout value back to seconds */
1111 			loop = 30;
1112 		}
1113 	}
1114 }
1115 
1116 
1117 /*****************************************************************************
1118  * edge_close
1119  *	this function is called by the tty driver when a port is closed
1120  *****************************************************************************/
1121 static void edge_close(struct usb_serial_port *port)
1122 {
1123 	struct edgeport_serial *edge_serial;
1124 	struct edgeport_port *edge_port;
1125 	int status;
1126 
1127 	edge_serial = usb_get_serial_data(port->serial);
1128 	edge_port = usb_get_serial_port_data(port);
1129 	if (edge_serial == NULL || edge_port == NULL)
1130 		return;
1131 
1132 	/* block until tx is empty */
1133 	block_until_tx_empty(edge_port);
1134 
1135 	edge_port->closePending = true;
1136 
1137 	if (!edge_serial->is_epic ||
1138 	    edge_serial->epic_descriptor.Supports.IOSPChase) {
1139 		/* flush and chase */
1140 		edge_port->chaseResponsePending = true;
1141 
1142 		dev_dbg(&port->dev, "%s - Sending IOSP_CMD_CHASE_PORT\n", __func__);
1143 		status = send_iosp_ext_cmd(edge_port, IOSP_CMD_CHASE_PORT, 0);
1144 		if (status == 0)
1145 			/* block until chase finished */
1146 			block_until_chase_response(edge_port);
1147 		else
1148 			edge_port->chaseResponsePending = false;
1149 	}
1150 
1151 	if (!edge_serial->is_epic ||
1152 	    edge_serial->epic_descriptor.Supports.IOSPClose) {
1153 	       /* close the port */
1154 		dev_dbg(&port->dev, "%s - Sending IOSP_CMD_CLOSE_PORT\n", __func__);
1155 		send_iosp_ext_cmd(edge_port, IOSP_CMD_CLOSE_PORT, 0);
1156 	}
1157 
1158 	/* port->close = true; */
1159 	edge_port->closePending = false;
1160 	edge_port->open = false;
1161 	edge_port->openPending = false;
1162 
1163 	usb_kill_urb(edge_port->write_urb);
1164 
1165 	if (edge_port->write_urb) {
1166 		/* if this urb had a transfer buffer already
1167 				(old transfer) free it */
1168 		kfree(edge_port->write_urb->transfer_buffer);
1169 		usb_free_urb(edge_port->write_urb);
1170 		edge_port->write_urb = NULL;
1171 	}
1172 	kfree(edge_port->txfifo.fifo);
1173 	edge_port->txfifo.fifo = NULL;
1174 }
1175 
1176 /*****************************************************************************
1177  * SerialWrite
1178  *	this function is called by the tty driver when data should be written
1179  *	to the port.
1180  *	If successful, we return the number of bytes written, otherwise we
1181  *	return a negative error number.
1182  *****************************************************************************/
1183 static int edge_write(struct tty_struct *tty, struct usb_serial_port *port,
1184 					const unsigned char *data, int count)
1185 {
1186 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1187 	struct TxFifo *fifo;
1188 	int copySize;
1189 	int bytesleft;
1190 	int firsthalf;
1191 	int secondhalf;
1192 	unsigned long flags;
1193 
1194 	if (edge_port == NULL)
1195 		return -ENODEV;
1196 
1197 	/* get a pointer to the Tx fifo */
1198 	fifo = &edge_port->txfifo;
1199 
1200 	spin_lock_irqsave(&edge_port->ep_lock, flags);
1201 
1202 	/* calculate number of bytes to put in fifo */
1203 	copySize = min((unsigned int)count,
1204 				(edge_port->txCredits - fifo->count));
1205 
1206 	dev_dbg(&port->dev, "%s of %d byte(s) Fifo room  %d -- will copy %d bytes\n",
1207 		__func__, count, edge_port->txCredits - fifo->count, copySize);
1208 
1209 	/* catch writes of 0 bytes which the tty driver likes to give us,
1210 	   and when txCredits is empty */
1211 	if (copySize == 0) {
1212 		dev_dbg(&port->dev, "%s - copySize = Zero\n", __func__);
1213 		goto finish_write;
1214 	}
1215 
1216 	/* queue the data
1217 	 * since we can never overflow the buffer we do not have to check for a
1218 	 * full condition
1219 	 *
1220 	 * the copy is done is two parts -- first fill to the end of the buffer
1221 	 * then copy the reset from the start of the buffer
1222 	 */
1223 	bytesleft = fifo->size - fifo->head;
1224 	firsthalf = min(bytesleft, copySize);
1225 	dev_dbg(&port->dev, "%s - copy %d bytes of %d into fifo \n", __func__,
1226 		firsthalf, bytesleft);
1227 
1228 	/* now copy our data */
1229 	memcpy(&fifo->fifo[fifo->head], data, firsthalf);
1230 	usb_serial_debug_data(&port->dev, __func__, firsthalf, &fifo->fifo[fifo->head]);
1231 
1232 	/* update the index and size */
1233 	fifo->head  += firsthalf;
1234 	fifo->count += firsthalf;
1235 
1236 	/* wrap the index */
1237 	if (fifo->head == fifo->size)
1238 		fifo->head = 0;
1239 
1240 	secondhalf = copySize-firsthalf;
1241 
1242 	if (secondhalf) {
1243 		dev_dbg(&port->dev, "%s - copy rest of data %d\n", __func__, secondhalf);
1244 		memcpy(&fifo->fifo[fifo->head], &data[firsthalf], secondhalf);
1245 		usb_serial_debug_data(&port->dev, __func__, secondhalf, &fifo->fifo[fifo->head]);
1246 		/* update the index and size */
1247 		fifo->count += secondhalf;
1248 		fifo->head  += secondhalf;
1249 		/* No need to check for wrap since we can not get to end of
1250 		 * the fifo in this part
1251 		 */
1252 	}
1253 
1254 finish_write:
1255 	spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1256 
1257 	send_more_port_data((struct edgeport_serial *)
1258 			usb_get_serial_data(port->serial), edge_port);
1259 
1260 	dev_dbg(&port->dev, "%s wrote %d byte(s) TxCredits %d, Fifo %d\n",
1261 		__func__, copySize, edge_port->txCredits, fifo->count);
1262 
1263 	return copySize;
1264 }
1265 
1266 
1267 /************************************************************************
1268  *
1269  * send_more_port_data()
1270  *
1271  *	This routine attempts to write additional UART transmit data
1272  *	to a port over the USB bulk pipe. It is called (1) when new
1273  *	data has been written to a port's TxBuffer from higher layers
1274  *	(2) when the peripheral sends us additional TxCredits indicating
1275  *	that it can accept more	Tx data for a given port; and (3) when
1276  *	a bulk write completes successfully and we want to see if we
1277  *	can transmit more.
1278  *
1279  ************************************************************************/
1280 static void send_more_port_data(struct edgeport_serial *edge_serial,
1281 					struct edgeport_port *edge_port)
1282 {
1283 	struct TxFifo	*fifo = &edge_port->txfifo;
1284 	struct device	*dev = &edge_port->port->dev;
1285 	struct urb	*urb;
1286 	unsigned char	*buffer;
1287 	int		status;
1288 	int		count;
1289 	int		bytesleft;
1290 	int		firsthalf;
1291 	int		secondhalf;
1292 	unsigned long	flags;
1293 
1294 	spin_lock_irqsave(&edge_port->ep_lock, flags);
1295 
1296 	if (edge_port->write_in_progress ||
1297 	    !edge_port->open             ||
1298 	    (fifo->count == 0)) {
1299 		dev_dbg(dev, "%s EXIT - fifo %d, PendingWrite = %d\n",
1300 			__func__, fifo->count, edge_port->write_in_progress);
1301 		goto exit_send;
1302 	}
1303 
1304 	/* since the amount of data in the fifo will always fit into the
1305 	 * edgeport buffer we do not need to check the write length
1306 	 *
1307 	 * Do we have enough credits for this port to make it worthwhile
1308 	 * to bother queueing a write. If it's too small, say a few bytes,
1309 	 * it's better to wait for more credits so we can do a larger write.
1310 	 */
1311 	if (edge_port->txCredits < EDGE_FW_GET_TX_CREDITS_SEND_THRESHOLD(edge_port->maxTxCredits, EDGE_FW_BULK_MAX_PACKET_SIZE)) {
1312 		dev_dbg(dev, "%s Not enough credit - fifo %d TxCredit %d\n",
1313 			__func__, fifo->count, edge_port->txCredits);
1314 		goto exit_send;
1315 	}
1316 
1317 	/* lock this write */
1318 	edge_port->write_in_progress = true;
1319 
1320 	/* get a pointer to the write_urb */
1321 	urb = edge_port->write_urb;
1322 
1323 	/* make sure transfer buffer is freed */
1324 	kfree(urb->transfer_buffer);
1325 	urb->transfer_buffer = NULL;
1326 
1327 	/* build the data header for the buffer and port that we are about
1328 	   to send out */
1329 	count = fifo->count;
1330 	buffer = kmalloc(count+2, GFP_ATOMIC);
1331 	if (!buffer) {
1332 		edge_port->write_in_progress = false;
1333 		goto exit_send;
1334 	}
1335 	buffer[0] = IOSP_BUILD_DATA_HDR1(edge_port->port->port_number, count);
1336 	buffer[1] = IOSP_BUILD_DATA_HDR2(edge_port->port->port_number, count);
1337 
1338 	/* now copy our data */
1339 	bytesleft =  fifo->size - fifo->tail;
1340 	firsthalf = min(bytesleft, count);
1341 	memcpy(&buffer[2], &fifo->fifo[fifo->tail], firsthalf);
1342 	fifo->tail  += firsthalf;
1343 	fifo->count -= firsthalf;
1344 	if (fifo->tail == fifo->size)
1345 		fifo->tail = 0;
1346 
1347 	secondhalf = count-firsthalf;
1348 	if (secondhalf) {
1349 		memcpy(&buffer[2+firsthalf], &fifo->fifo[fifo->tail],
1350 								secondhalf);
1351 		fifo->tail  += secondhalf;
1352 		fifo->count -= secondhalf;
1353 	}
1354 
1355 	if (count)
1356 		usb_serial_debug_data(&edge_port->port->dev, __func__, count, &buffer[2]);
1357 
1358 	/* fill up the urb with all of our data and submit it */
1359 	usb_fill_bulk_urb(urb, edge_serial->serial->dev,
1360 			usb_sndbulkpipe(edge_serial->serial->dev,
1361 					edge_serial->bulk_out_endpoint),
1362 			buffer, count+2,
1363 			edge_bulk_out_data_callback, edge_port);
1364 
1365 	/* decrement the number of credits we have by the number we just sent */
1366 	edge_port->txCredits -= count;
1367 	edge_port->port->icount.tx += count;
1368 
1369 	status = usb_submit_urb(urb, GFP_ATOMIC);
1370 	if (status) {
1371 		/* something went wrong */
1372 		dev_err_console(edge_port->port,
1373 			"%s - usb_submit_urb(write bulk) failed, status = %d, data lost\n",
1374 				__func__, status);
1375 		edge_port->write_in_progress = false;
1376 
1377 		/* revert the credits as something bad happened. */
1378 		edge_port->txCredits += count;
1379 		edge_port->port->icount.tx -= count;
1380 	}
1381 	dev_dbg(dev, "%s wrote %d byte(s) TxCredit %d, Fifo %d\n",
1382 		__func__, count, edge_port->txCredits, fifo->count);
1383 
1384 exit_send:
1385 	spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1386 }
1387 
1388 
1389 /*****************************************************************************
1390  * edge_write_room
1391  *	this function is called by the tty driver when it wants to know how
1392  *	many bytes of data we can accept for a specific port. If successful,
1393  *	we return the amount of room that we have for this port	(the txCredits)
1394  *	otherwise we return a negative error number.
1395  *****************************************************************************/
1396 static int edge_write_room(struct tty_struct *tty)
1397 {
1398 	struct usb_serial_port *port = tty->driver_data;
1399 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1400 	int room;
1401 	unsigned long flags;
1402 
1403 	if (edge_port == NULL)
1404 		return 0;
1405 	if (edge_port->closePending)
1406 		return 0;
1407 
1408 	if (!edge_port->open) {
1409 		dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1410 		return 0;
1411 	}
1412 
1413 	/* total of both buffers is still txCredit */
1414 	spin_lock_irqsave(&edge_port->ep_lock, flags);
1415 	room = edge_port->txCredits - edge_port->txfifo.count;
1416 	spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1417 
1418 	dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
1419 	return room;
1420 }
1421 
1422 
1423 /*****************************************************************************
1424  * edge_chars_in_buffer
1425  *	this function is called by the tty driver when it wants to know how
1426  *	many bytes of data we currently have outstanding in the port (data that
1427  *	has been written, but hasn't made it out the port yet)
1428  *	If successful, we return the number of bytes left to be written in the
1429  *	system,
1430  *	Otherwise we return a negative error number.
1431  *****************************************************************************/
1432 static int edge_chars_in_buffer(struct tty_struct *tty)
1433 {
1434 	struct usb_serial_port *port = tty->driver_data;
1435 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1436 	int num_chars;
1437 	unsigned long flags;
1438 
1439 	if (edge_port == NULL)
1440 		return 0;
1441 	if (edge_port->closePending)
1442 		return 0;
1443 
1444 	if (!edge_port->open) {
1445 		dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1446 		return 0;
1447 	}
1448 
1449 	spin_lock_irqsave(&edge_port->ep_lock, flags);
1450 	num_chars = edge_port->maxTxCredits - edge_port->txCredits +
1451 						edge_port->txfifo.count;
1452 	spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1453 	if (num_chars) {
1454 		dev_dbg(&port->dev, "%s - returns %d\n", __func__, num_chars);
1455 	}
1456 
1457 	return num_chars;
1458 }
1459 
1460 
1461 /*****************************************************************************
1462  * SerialThrottle
1463  *	this function is called by the tty driver when it wants to stop the data
1464  *	being read from the port.
1465  *****************************************************************************/
1466 static void edge_throttle(struct tty_struct *tty)
1467 {
1468 	struct usb_serial_port *port = tty->driver_data;
1469 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1470 	int status;
1471 
1472 	if (edge_port == NULL)
1473 		return;
1474 
1475 	if (!edge_port->open) {
1476 		dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1477 		return;
1478 	}
1479 
1480 	/* if we are implementing XON/XOFF, send the stop character */
1481 	if (I_IXOFF(tty)) {
1482 		unsigned char stop_char = STOP_CHAR(tty);
1483 		status = edge_write(tty, port, &stop_char, 1);
1484 		if (status <= 0)
1485 			return;
1486 	}
1487 
1488 	/* if we are implementing RTS/CTS, toggle that line */
1489 	if (C_CRTSCTS(tty)) {
1490 		edge_port->shadowMCR &= ~MCR_RTS;
1491 		status = send_cmd_write_uart_register(edge_port, MCR,
1492 							edge_port->shadowMCR);
1493 		if (status != 0)
1494 			return;
1495 	}
1496 }
1497 
1498 
1499 /*****************************************************************************
1500  * edge_unthrottle
1501  *	this function is called by the tty driver when it wants to resume the
1502  *	data being read from the port (called after SerialThrottle is called)
1503  *****************************************************************************/
1504 static void edge_unthrottle(struct tty_struct *tty)
1505 {
1506 	struct usb_serial_port *port = tty->driver_data;
1507 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1508 	int status;
1509 
1510 	if (edge_port == NULL)
1511 		return;
1512 
1513 	if (!edge_port->open) {
1514 		dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1515 		return;
1516 	}
1517 
1518 	/* if we are implementing XON/XOFF, send the start character */
1519 	if (I_IXOFF(tty)) {
1520 		unsigned char start_char = START_CHAR(tty);
1521 		status = edge_write(tty, port, &start_char, 1);
1522 		if (status <= 0)
1523 			return;
1524 	}
1525 	/* if we are implementing RTS/CTS, toggle that line */
1526 	if (C_CRTSCTS(tty)) {
1527 		edge_port->shadowMCR |= MCR_RTS;
1528 		send_cmd_write_uart_register(edge_port, MCR,
1529 						edge_port->shadowMCR);
1530 	}
1531 }
1532 
1533 
1534 /*****************************************************************************
1535  * SerialSetTermios
1536  *	this function is called by the tty driver when it wants to change
1537  * the termios structure
1538  *****************************************************************************/
1539 static void edge_set_termios(struct tty_struct *tty,
1540 	struct usb_serial_port *port, struct ktermios *old_termios)
1541 {
1542 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1543 
1544 	if (edge_port == NULL)
1545 		return;
1546 
1547 	if (!edge_port->open) {
1548 		dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1549 		return;
1550 	}
1551 
1552 	/* change the port settings to the new ones specified */
1553 	change_port_settings(tty, edge_port, old_termios);
1554 }
1555 
1556 
1557 /*****************************************************************************
1558  * get_lsr_info - get line status register info
1559  *
1560  * Purpose: Let user call ioctl() to get info when the UART physically
1561  * 	    is emptied.  On bus types like RS485, the transmitter must
1562  * 	    release the bus after transmitting. This must be done when
1563  * 	    the transmit shift register is empty, not be done when the
1564  * 	    transmit holding register is empty.  This functionality
1565  * 	    allows an RS485 driver to be written in user space.
1566  *****************************************************************************/
1567 static int get_lsr_info(struct edgeport_port *edge_port,
1568 						unsigned int __user *value)
1569 {
1570 	unsigned int result = 0;
1571 	unsigned long flags;
1572 
1573 	spin_lock_irqsave(&edge_port->ep_lock, flags);
1574 	if (edge_port->maxTxCredits == edge_port->txCredits &&
1575 	    edge_port->txfifo.count == 0) {
1576 		dev_dbg(&edge_port->port->dev, "%s -- Empty\n", __func__);
1577 		result = TIOCSER_TEMT;
1578 	}
1579 	spin_unlock_irqrestore(&edge_port->ep_lock, flags);
1580 
1581 	if (copy_to_user(value, &result, sizeof(int)))
1582 		return -EFAULT;
1583 	return 0;
1584 }
1585 
1586 static int edge_tiocmset(struct tty_struct *tty,
1587 					unsigned int set, unsigned int clear)
1588 {
1589 	struct usb_serial_port *port = tty->driver_data;
1590 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1591 	unsigned int mcr;
1592 
1593 	mcr = edge_port->shadowMCR;
1594 	if (set & TIOCM_RTS)
1595 		mcr |= MCR_RTS;
1596 	if (set & TIOCM_DTR)
1597 		mcr |= MCR_DTR;
1598 	if (set & TIOCM_LOOP)
1599 		mcr |= MCR_LOOPBACK;
1600 
1601 	if (clear & TIOCM_RTS)
1602 		mcr &= ~MCR_RTS;
1603 	if (clear & TIOCM_DTR)
1604 		mcr &= ~MCR_DTR;
1605 	if (clear & TIOCM_LOOP)
1606 		mcr &= ~MCR_LOOPBACK;
1607 
1608 	edge_port->shadowMCR = mcr;
1609 
1610 	send_cmd_write_uart_register(edge_port, MCR, edge_port->shadowMCR);
1611 
1612 	return 0;
1613 }
1614 
1615 static int edge_tiocmget(struct tty_struct *tty)
1616 {
1617 	struct usb_serial_port *port = tty->driver_data;
1618 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1619 	unsigned int result = 0;
1620 	unsigned int msr;
1621 	unsigned int mcr;
1622 
1623 	msr = edge_port->shadowMSR;
1624 	mcr = edge_port->shadowMCR;
1625 	result = ((mcr & MCR_DTR)	? TIOCM_DTR: 0)	  /* 0x002 */
1626 		  | ((mcr & MCR_RTS)	? TIOCM_RTS: 0)   /* 0x004 */
1627 		  | ((msr & EDGEPORT_MSR_CTS)	? TIOCM_CTS: 0)   /* 0x020 */
1628 		  | ((msr & EDGEPORT_MSR_CD)	? TIOCM_CAR: 0)   /* 0x040 */
1629 		  | ((msr & EDGEPORT_MSR_RI)	? TIOCM_RI:  0)   /* 0x080 */
1630 		  | ((msr & EDGEPORT_MSR_DSR)	? TIOCM_DSR: 0);  /* 0x100 */
1631 
1632 	return result;
1633 }
1634 
1635 static int get_serial_info(struct edgeport_port *edge_port,
1636 				struct serial_struct __user *retinfo)
1637 {
1638 	struct serial_struct tmp;
1639 
1640 	memset(&tmp, 0, sizeof(tmp));
1641 
1642 	tmp.type		= PORT_16550A;
1643 	tmp.line		= edge_port->port->minor;
1644 	tmp.port		= edge_port->port->port_number;
1645 	tmp.irq			= 0;
1646 	tmp.xmit_fifo_size	= edge_port->maxTxCredits;
1647 	tmp.baud_base		= 9600;
1648 	tmp.close_delay		= 5*HZ;
1649 	tmp.closing_wait	= 30*HZ;
1650 
1651 	if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1652 		return -EFAULT;
1653 	return 0;
1654 }
1655 
1656 
1657 /*****************************************************************************
1658  * SerialIoctl
1659  *	this function handles any ioctl calls to the driver
1660  *****************************************************************************/
1661 static int edge_ioctl(struct tty_struct *tty,
1662 					unsigned int cmd, unsigned long arg)
1663 {
1664 	struct usb_serial_port *port = tty->driver_data;
1665 	DEFINE_WAIT(wait);
1666 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1667 
1668 	switch (cmd) {
1669 	case TIOCSERGETLSR:
1670 		dev_dbg(&port->dev, "%s TIOCSERGETLSR\n", __func__);
1671 		return get_lsr_info(edge_port, (unsigned int __user *) arg);
1672 
1673 	case TIOCGSERIAL:
1674 		dev_dbg(&port->dev, "%s TIOCGSERIAL\n", __func__);
1675 		return get_serial_info(edge_port, (struct serial_struct __user *) arg);
1676 	}
1677 	return -ENOIOCTLCMD;
1678 }
1679 
1680 
1681 /*****************************************************************************
1682  * SerialBreak
1683  *	this function sends a break to the port
1684  *****************************************************************************/
1685 static void edge_break(struct tty_struct *tty, int break_state)
1686 {
1687 	struct usb_serial_port *port = tty->driver_data;
1688 	struct edgeport_port *edge_port = usb_get_serial_port_data(port);
1689 	struct edgeport_serial *edge_serial = usb_get_serial_data(port->serial);
1690 	int status;
1691 
1692 	if (!edge_serial->is_epic ||
1693 	    edge_serial->epic_descriptor.Supports.IOSPChase) {
1694 		/* flush and chase */
1695 		edge_port->chaseResponsePending = true;
1696 
1697 		dev_dbg(&port->dev, "%s - Sending IOSP_CMD_CHASE_PORT\n", __func__);
1698 		status = send_iosp_ext_cmd(edge_port, IOSP_CMD_CHASE_PORT, 0);
1699 		if (status == 0) {
1700 			/* block until chase finished */
1701 			block_until_chase_response(edge_port);
1702 		} else {
1703 			edge_port->chaseResponsePending = false;
1704 		}
1705 	}
1706 
1707 	if (!edge_serial->is_epic ||
1708 	    edge_serial->epic_descriptor.Supports.IOSPSetClrBreak) {
1709 		if (break_state == -1) {
1710 			dev_dbg(&port->dev, "%s - Sending IOSP_CMD_SET_BREAK\n", __func__);
1711 			status = send_iosp_ext_cmd(edge_port,
1712 						IOSP_CMD_SET_BREAK, 0);
1713 		} else {
1714 			dev_dbg(&port->dev, "%s - Sending IOSP_CMD_CLEAR_BREAK\n", __func__);
1715 			status = send_iosp_ext_cmd(edge_port,
1716 						IOSP_CMD_CLEAR_BREAK, 0);
1717 		}
1718 		if (status)
1719 			dev_dbg(&port->dev, "%s - error sending break set/clear command.\n",
1720 				__func__);
1721 	}
1722 }
1723 
1724 
1725 /*****************************************************************************
1726  * process_rcvd_data
1727  *	this function handles the data received on the bulk in pipe.
1728  *****************************************************************************/
1729 static void process_rcvd_data(struct edgeport_serial *edge_serial,
1730 				unsigned char *buffer, __u16 bufferLength)
1731 {
1732 	struct device *dev = &edge_serial->serial->dev->dev;
1733 	struct usb_serial_port *port;
1734 	struct edgeport_port *edge_port;
1735 	__u16 lastBufferLength;
1736 	__u16 rxLen;
1737 
1738 	lastBufferLength = bufferLength + 1;
1739 
1740 	while (bufferLength > 0) {
1741 		/* failsafe incase we get a message that we don't understand */
1742 		if (lastBufferLength == bufferLength) {
1743 			dev_dbg(dev, "%s - stuck in loop, exiting it.\n", __func__);
1744 			break;
1745 		}
1746 		lastBufferLength = bufferLength;
1747 
1748 		switch (edge_serial->rxState) {
1749 		case EXPECT_HDR1:
1750 			edge_serial->rxHeader1 = *buffer;
1751 			++buffer;
1752 			--bufferLength;
1753 
1754 			if (bufferLength == 0) {
1755 				edge_serial->rxState = EXPECT_HDR2;
1756 				break;
1757 			}
1758 			/* otherwise, drop on through */
1759 		case EXPECT_HDR2:
1760 			edge_serial->rxHeader2 = *buffer;
1761 			++buffer;
1762 			--bufferLength;
1763 
1764 			dev_dbg(dev, "%s - Hdr1=%02X Hdr2=%02X\n", __func__,
1765 				edge_serial->rxHeader1, edge_serial->rxHeader2);
1766 			/* Process depending on whether this header is
1767 			 * data or status */
1768 
1769 			if (IS_CMD_STAT_HDR(edge_serial->rxHeader1)) {
1770 				/* Decode this status header and go to
1771 				 * EXPECT_HDR1 (if we can process the status
1772 				 * with only 2 bytes), or go to EXPECT_HDR3 to
1773 				 * get the third byte. */
1774 				edge_serial->rxPort =
1775 				    IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
1776 				edge_serial->rxStatusCode =
1777 				    IOSP_GET_STATUS_CODE(
1778 						edge_serial->rxHeader1);
1779 
1780 				if (!IOSP_STATUS_IS_2BYTE(
1781 						edge_serial->rxStatusCode)) {
1782 					/* This status needs additional bytes.
1783 					 * Save what we have and then wait for
1784 					 * more data.
1785 					 */
1786 					edge_serial->rxStatusParam
1787 						= edge_serial->rxHeader2;
1788 					edge_serial->rxState = EXPECT_HDR3;
1789 					break;
1790 				}
1791 				/* We have all the header bytes, process the
1792 				   status now */
1793 				process_rcvd_status(edge_serial,
1794 						edge_serial->rxHeader2, 0);
1795 				edge_serial->rxState = EXPECT_HDR1;
1796 				break;
1797 			} else {
1798 				edge_serial->rxPort =
1799 				    IOSP_GET_HDR_PORT(edge_serial->rxHeader1);
1800 				edge_serial->rxBytesRemaining =
1801 				    IOSP_GET_HDR_DATA_LEN(
1802 						edge_serial->rxHeader1,
1803 						edge_serial->rxHeader2);
1804 				dev_dbg(dev, "%s - Data for Port %u Len %u\n",
1805 					__func__,
1806 					edge_serial->rxPort,
1807 					edge_serial->rxBytesRemaining);
1808 
1809 				/* ASSERT(DevExt->RxPort < DevExt->NumPorts);
1810 				 * ASSERT(DevExt->RxBytesRemaining <
1811 				 *		IOSP_MAX_DATA_LENGTH);
1812 				 */
1813 
1814 				if (bufferLength == 0) {
1815 					edge_serial->rxState = EXPECT_DATA;
1816 					break;
1817 				}
1818 				/* Else, drop through */
1819 			}
1820 		case EXPECT_DATA: /* Expect data */
1821 			if (bufferLength < edge_serial->rxBytesRemaining) {
1822 				rxLen = bufferLength;
1823 				/* Expect data to start next buffer */
1824 				edge_serial->rxState = EXPECT_DATA;
1825 			} else {
1826 				/* BufLen >= RxBytesRemaining */
1827 				rxLen = edge_serial->rxBytesRemaining;
1828 				/* Start another header next time */
1829 				edge_serial->rxState = EXPECT_HDR1;
1830 			}
1831 
1832 			bufferLength -= rxLen;
1833 			edge_serial->rxBytesRemaining -= rxLen;
1834 
1835 			/* spit this data back into the tty driver if this
1836 			   port is open */
1837 			if (rxLen) {
1838 				port = edge_serial->serial->port[
1839 							edge_serial->rxPort];
1840 				edge_port = usb_get_serial_port_data(port);
1841 				if (edge_port->open) {
1842 					dev_dbg(dev, "%s - Sending %d bytes to TTY for port %d\n",
1843 						__func__, rxLen,
1844 						edge_serial->rxPort);
1845 					edge_tty_recv(edge_port->port, buffer,
1846 							rxLen);
1847 					edge_port->port->icount.rx += rxLen;
1848 				}
1849 				buffer += rxLen;
1850 			}
1851 			break;
1852 
1853 		case EXPECT_HDR3:	/* Expect 3rd byte of status header */
1854 			edge_serial->rxHeader3 = *buffer;
1855 			++buffer;
1856 			--bufferLength;
1857 
1858 			/* We have all the header bytes, process the
1859 			   status now */
1860 			process_rcvd_status(edge_serial,
1861 				edge_serial->rxStatusParam,
1862 				edge_serial->rxHeader3);
1863 			edge_serial->rxState = EXPECT_HDR1;
1864 			break;
1865 		}
1866 	}
1867 }
1868 
1869 
1870 /*****************************************************************************
1871  * process_rcvd_status
1872  *	this function handles the any status messages received on the
1873  *	bulk in pipe.
1874  *****************************************************************************/
1875 static void process_rcvd_status(struct edgeport_serial *edge_serial,
1876 						__u8 byte2, __u8 byte3)
1877 {
1878 	struct usb_serial_port *port;
1879 	struct edgeport_port *edge_port;
1880 	struct tty_struct *tty;
1881 	struct device *dev;
1882 	__u8 code = edge_serial->rxStatusCode;
1883 
1884 	/* switch the port pointer to the one being currently talked about */
1885 	port = edge_serial->serial->port[edge_serial->rxPort];
1886 	edge_port = usb_get_serial_port_data(port);
1887 	if (edge_port == NULL) {
1888 		dev_err(&edge_serial->serial->dev->dev,
1889 			"%s - edge_port == NULL for port %d\n",
1890 					__func__, edge_serial->rxPort);
1891 		return;
1892 	}
1893 	dev = &port->dev;
1894 
1895 	if (code == IOSP_EXT_STATUS) {
1896 		switch (byte2) {
1897 		case IOSP_EXT_STATUS_CHASE_RSP:
1898 			/* we want to do EXT status regardless of port
1899 			 * open/closed */
1900 			dev_dbg(dev, "%s - Port %u EXT CHASE_RSP Data = %02x\n",
1901 				__func__, edge_serial->rxPort, byte3);
1902 			/* Currently, the only EXT_STATUS is Chase, so process
1903 			 * here instead of one more call to one more subroutine
1904 			 * If/when more EXT_STATUS, there'll be more work to do
1905 			 * Also, we currently clear flag and close the port
1906 			 * regardless of content of above's Byte3.
1907 			 * We could choose to do something else when Byte3 says
1908 			 * Timeout on Chase from Edgeport, like wait longer in
1909 			 * block_until_chase_response, but for now we don't.
1910 			 */
1911 			edge_port->chaseResponsePending = false;
1912 			wake_up(&edge_port->wait_chase);
1913 			return;
1914 
1915 		case IOSP_EXT_STATUS_RX_CHECK_RSP:
1916 			dev_dbg(dev, "%s ========== Port %u CHECK_RSP Sequence = %02x =============\n",
1917 				__func__, edge_serial->rxPort, byte3);
1918 			/* Port->RxCheckRsp = true; */
1919 			return;
1920 		}
1921 	}
1922 
1923 	if (code == IOSP_STATUS_OPEN_RSP) {
1924 		edge_port->txCredits = GET_TX_BUFFER_SIZE(byte3);
1925 		edge_port->maxTxCredits = edge_port->txCredits;
1926 		dev_dbg(dev, "%s - Port %u Open Response Initial MSR = %02x TxBufferSize = %d\n",
1927 			__func__, edge_serial->rxPort, byte2, edge_port->txCredits);
1928 		handle_new_msr(edge_port, byte2);
1929 
1930 		/* send the current line settings to the port so we are
1931 		   in sync with any further termios calls */
1932 		tty = tty_port_tty_get(&edge_port->port->port);
1933 		if (tty) {
1934 			change_port_settings(tty,
1935 				edge_port, &tty->termios);
1936 			tty_kref_put(tty);
1937 		}
1938 
1939 		/* we have completed the open */
1940 		edge_port->openPending = false;
1941 		edge_port->open = true;
1942 		wake_up(&edge_port->wait_open);
1943 		return;
1944 	}
1945 
1946 	/* If port is closed, silently discard all rcvd status. We can
1947 	 * have cases where buffered status is received AFTER the close
1948 	 * port command is sent to the Edgeport.
1949 	 */
1950 	if (!edge_port->open || edge_port->closePending)
1951 		return;
1952 
1953 	switch (code) {
1954 	/* Not currently sent by Edgeport */
1955 	case IOSP_STATUS_LSR:
1956 		dev_dbg(dev, "%s - Port %u LSR Status = %02x\n",
1957 			__func__, edge_serial->rxPort, byte2);
1958 		handle_new_lsr(edge_port, false, byte2, 0);
1959 		break;
1960 
1961 	case IOSP_STATUS_LSR_DATA:
1962 		dev_dbg(dev, "%s - Port %u LSR Status = %02x, Data = %02x\n",
1963 			__func__, edge_serial->rxPort, byte2, byte3);
1964 		/* byte2 is LSR Register */
1965 		/* byte3 is broken data byte */
1966 		handle_new_lsr(edge_port, true, byte2, byte3);
1967 		break;
1968 	/*
1969 	 *	case IOSP_EXT_4_STATUS:
1970 	 *		dev_dbg(dev, "%s - Port %u LSR Status = %02x Data = %02x\n",
1971 	 *			__func__, edge_serial->rxPort, byte2, byte3);
1972 	 *		break;
1973 	 */
1974 	case IOSP_STATUS_MSR:
1975 		dev_dbg(dev, "%s - Port %u MSR Status = %02x\n",
1976 			__func__, edge_serial->rxPort, byte2);
1977 		/*
1978 		 * Process this new modem status and generate appropriate
1979 		 * events, etc, based on the new status. This routine
1980 		 * also saves the MSR in Port->ShadowMsr.
1981 		 */
1982 		handle_new_msr(edge_port, byte2);
1983 		break;
1984 
1985 	default:
1986 		dev_dbg(dev, "%s - Unrecognized IOSP status code %u\n", __func__, code);
1987 		break;
1988 	}
1989 }
1990 
1991 
1992 /*****************************************************************************
1993  * edge_tty_recv
1994  *	this function passes data on to the tty flip buffer
1995  *****************************************************************************/
1996 static void edge_tty_recv(struct usb_serial_port *port, unsigned char *data,
1997 		int length)
1998 {
1999 	int cnt;
2000 
2001 	cnt = tty_insert_flip_string(&port->port, data, length);
2002 	if (cnt < length) {
2003 		dev_err(&port->dev, "%s - dropping data, %d bytes lost\n",
2004 				__func__, length - cnt);
2005 	}
2006 	data += cnt;
2007 	length -= cnt;
2008 
2009 	tty_flip_buffer_push(&port->port);
2010 }
2011 
2012 
2013 /*****************************************************************************
2014  * handle_new_msr
2015  *	this function handles any change to the msr register for a port.
2016  *****************************************************************************/
2017 static void handle_new_msr(struct edgeport_port *edge_port, __u8 newMsr)
2018 {
2019 	struct  async_icount *icount;
2020 
2021 	if (newMsr & (EDGEPORT_MSR_DELTA_CTS | EDGEPORT_MSR_DELTA_DSR |
2022 			EDGEPORT_MSR_DELTA_RI | EDGEPORT_MSR_DELTA_CD)) {
2023 		icount = &edge_port->port->icount;
2024 
2025 		/* update input line counters */
2026 		if (newMsr & EDGEPORT_MSR_DELTA_CTS)
2027 			icount->cts++;
2028 		if (newMsr & EDGEPORT_MSR_DELTA_DSR)
2029 			icount->dsr++;
2030 		if (newMsr & EDGEPORT_MSR_DELTA_CD)
2031 			icount->dcd++;
2032 		if (newMsr & EDGEPORT_MSR_DELTA_RI)
2033 			icount->rng++;
2034 		wake_up_interruptible(&edge_port->port->port.delta_msr_wait);
2035 	}
2036 
2037 	/* Save the new modem status */
2038 	edge_port->shadowMSR = newMsr & 0xf0;
2039 }
2040 
2041 
2042 /*****************************************************************************
2043  * handle_new_lsr
2044  *	this function handles any change to the lsr register for a port.
2045  *****************************************************************************/
2046 static void handle_new_lsr(struct edgeport_port *edge_port, __u8 lsrData,
2047 							__u8 lsr, __u8 data)
2048 {
2049 	__u8 newLsr = (__u8) (lsr & (__u8)
2050 		(LSR_OVER_ERR | LSR_PAR_ERR | LSR_FRM_ERR | LSR_BREAK));
2051 	struct async_icount *icount;
2052 
2053 	edge_port->shadowLSR = lsr;
2054 
2055 	if (newLsr & LSR_BREAK) {
2056 		/*
2057 		 * Parity and Framing errors only count if they
2058 		 * occur exclusive of a break being
2059 		 * received.
2060 		 */
2061 		newLsr &= (__u8)(LSR_OVER_ERR | LSR_BREAK);
2062 	}
2063 
2064 	/* Place LSR data byte into Rx buffer */
2065 	if (lsrData)
2066 		edge_tty_recv(edge_port->port, &data, 1);
2067 
2068 	/* update input line counters */
2069 	icount = &edge_port->port->icount;
2070 	if (newLsr & LSR_BREAK)
2071 		icount->brk++;
2072 	if (newLsr & LSR_OVER_ERR)
2073 		icount->overrun++;
2074 	if (newLsr & LSR_PAR_ERR)
2075 		icount->parity++;
2076 	if (newLsr & LSR_FRM_ERR)
2077 		icount->frame++;
2078 }
2079 
2080 
2081 /****************************************************************************
2082  * sram_write
2083  *	writes a number of bytes to the Edgeport device's sram starting at the
2084  *	given address.
2085  *	If successful returns the number of bytes written, otherwise it returns
2086  *	a negative error number of the problem.
2087  ****************************************************************************/
2088 static int sram_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
2089 					__u16 length, const __u8 *data)
2090 {
2091 	int result;
2092 	__u16 current_length;
2093 	unsigned char *transfer_buffer;
2094 
2095 	dev_dbg(&serial->dev->dev, "%s - %x, %x, %d\n", __func__, extAddr, addr, length);
2096 
2097 	transfer_buffer =  kmalloc(64, GFP_KERNEL);
2098 	if (!transfer_buffer)
2099 		return -ENOMEM;
2100 
2101 	/* need to split these writes up into 64 byte chunks */
2102 	result = 0;
2103 	while (length > 0) {
2104 		if (length > 64)
2105 			current_length = 64;
2106 		else
2107 			current_length = length;
2108 
2109 /*		dev_dbg(&serial->dev->dev, "%s - writing %x, %x, %d\n", __func__, extAddr, addr, current_length); */
2110 		memcpy(transfer_buffer, data, current_length);
2111 		result = usb_control_msg(serial->dev,
2112 					usb_sndctrlpipe(serial->dev, 0),
2113 					USB_REQUEST_ION_WRITE_RAM,
2114 					0x40, addr, extAddr, transfer_buffer,
2115 					current_length, 300);
2116 		if (result < 0)
2117 			break;
2118 		length -= current_length;
2119 		addr += current_length;
2120 		data += current_length;
2121 	}
2122 
2123 	kfree(transfer_buffer);
2124 	return result;
2125 }
2126 
2127 
2128 /****************************************************************************
2129  * rom_write
2130  *	writes a number of bytes to the Edgeport device's ROM starting at the
2131  *	given address.
2132  *	If successful returns the number of bytes written, otherwise it returns
2133  *	a negative error number of the problem.
2134  ****************************************************************************/
2135 static int rom_write(struct usb_serial *serial, __u16 extAddr, __u16 addr,
2136 					__u16 length, const __u8 *data)
2137 {
2138 	int result;
2139 	__u16 current_length;
2140 	unsigned char *transfer_buffer;
2141 
2142 	transfer_buffer =  kmalloc(64, GFP_KERNEL);
2143 	if (!transfer_buffer)
2144 		return -ENOMEM;
2145 
2146 	/* need to split these writes up into 64 byte chunks */
2147 	result = 0;
2148 	while (length > 0) {
2149 		if (length > 64)
2150 			current_length = 64;
2151 		else
2152 			current_length = length;
2153 		memcpy(transfer_buffer, data, current_length);
2154 		result = usb_control_msg(serial->dev,
2155 					usb_sndctrlpipe(serial->dev, 0),
2156 					USB_REQUEST_ION_WRITE_ROM, 0x40,
2157 					addr, extAddr,
2158 					transfer_buffer, current_length, 300);
2159 		if (result < 0)
2160 			break;
2161 		length -= current_length;
2162 		addr += current_length;
2163 		data += current_length;
2164 	}
2165 
2166 	kfree(transfer_buffer);
2167 	return result;
2168 }
2169 
2170 
2171 /****************************************************************************
2172  * rom_read
2173  *	reads a number of bytes from the Edgeport device starting at the given
2174  *	address.
2175  *	Returns zero on success or a negative error number.
2176  ****************************************************************************/
2177 static int rom_read(struct usb_serial *serial, __u16 extAddr,
2178 					__u16 addr, __u16 length, __u8 *data)
2179 {
2180 	int result;
2181 	__u16 current_length;
2182 	unsigned char *transfer_buffer;
2183 
2184 	transfer_buffer =  kmalloc(64, GFP_KERNEL);
2185 	if (!transfer_buffer)
2186 		return -ENOMEM;
2187 
2188 	/* need to split these reads up into 64 byte chunks */
2189 	result = 0;
2190 	while (length > 0) {
2191 		if (length > 64)
2192 			current_length = 64;
2193 		else
2194 			current_length = length;
2195 		result = usb_control_msg(serial->dev,
2196 					usb_rcvctrlpipe(serial->dev, 0),
2197 					USB_REQUEST_ION_READ_ROM,
2198 					0xC0, addr, extAddr, transfer_buffer,
2199 					current_length, 300);
2200 		if (result < current_length) {
2201 			if (result >= 0)
2202 				result = -EIO;
2203 			break;
2204 		}
2205 		memcpy(data, transfer_buffer, current_length);
2206 		length -= current_length;
2207 		addr += current_length;
2208 		data += current_length;
2209 
2210 		result = 0;
2211 	}
2212 
2213 	kfree(transfer_buffer);
2214 	return result;
2215 }
2216 
2217 
2218 /****************************************************************************
2219  * send_iosp_ext_cmd
2220  *	Is used to send a IOSP message to the Edgeport device
2221  ****************************************************************************/
2222 static int send_iosp_ext_cmd(struct edgeport_port *edge_port,
2223 						__u8 command, __u8 param)
2224 {
2225 	unsigned char   *buffer;
2226 	unsigned char   *currentCommand;
2227 	int             length = 0;
2228 	int             status = 0;
2229 
2230 	buffer = kmalloc(10, GFP_ATOMIC);
2231 	if (!buffer)
2232 		return -ENOMEM;
2233 
2234 	currentCommand = buffer;
2235 
2236 	MAKE_CMD_EXT_CMD(&currentCommand, &length, edge_port->port->port_number,
2237 			 command, param);
2238 
2239 	status = write_cmd_usb(edge_port, buffer, length);
2240 	if (status) {
2241 		/* something bad happened, let's free up the memory */
2242 		kfree(buffer);
2243 	}
2244 
2245 	return status;
2246 }
2247 
2248 
2249 /*****************************************************************************
2250  * write_cmd_usb
2251  *	this function writes the given buffer out to the bulk write endpoint.
2252  *****************************************************************************/
2253 static int write_cmd_usb(struct edgeport_port *edge_port,
2254 					unsigned char *buffer, int length)
2255 {
2256 	struct edgeport_serial *edge_serial =
2257 				usb_get_serial_data(edge_port->port->serial);
2258 	struct device *dev = &edge_port->port->dev;
2259 	int status = 0;
2260 	struct urb *urb;
2261 
2262 	usb_serial_debug_data(dev, __func__, length, buffer);
2263 
2264 	/* Allocate our next urb */
2265 	urb = usb_alloc_urb(0, GFP_ATOMIC);
2266 	if (!urb)
2267 		return -ENOMEM;
2268 
2269 	atomic_inc(&CmdUrbs);
2270 	dev_dbg(dev, "%s - ALLOCATE URB %p (outstanding %d)\n",
2271 		__func__, urb, atomic_read(&CmdUrbs));
2272 
2273 	usb_fill_bulk_urb(urb, edge_serial->serial->dev,
2274 			usb_sndbulkpipe(edge_serial->serial->dev,
2275 					edge_serial->bulk_out_endpoint),
2276 			buffer, length, edge_bulk_out_cmd_callback, edge_port);
2277 
2278 	edge_port->commandPending = true;
2279 	status = usb_submit_urb(urb, GFP_ATOMIC);
2280 
2281 	if (status) {
2282 		/* something went wrong */
2283 		dev_err(dev, "%s - usb_submit_urb(write command) failed, status = %d\n",
2284 			__func__, status);
2285 		usb_free_urb(urb);
2286 		atomic_dec(&CmdUrbs);
2287 		return status;
2288 	}
2289 
2290 #if 0
2291 	wait_event(&edge_port->wait_command, !edge_port->commandPending);
2292 
2293 	if (edge_port->commandPending) {
2294 		/* command timed out */
2295 		dev_dbg(dev, "%s - command timed out\n", __func__);
2296 		status = -EINVAL;
2297 	}
2298 #endif
2299 	return status;
2300 }
2301 
2302 
2303 /*****************************************************************************
2304  * send_cmd_write_baud_rate
2305  *	this function sends the proper command to change the baud rate of the
2306  *	specified port.
2307  *****************************************************************************/
2308 static int send_cmd_write_baud_rate(struct edgeport_port *edge_port,
2309 								int baudRate)
2310 {
2311 	struct edgeport_serial *edge_serial =
2312 				usb_get_serial_data(edge_port->port->serial);
2313 	struct device *dev = &edge_port->port->dev;
2314 	unsigned char *cmdBuffer;
2315 	unsigned char *currCmd;
2316 	int cmdLen = 0;
2317 	int divisor;
2318 	int status;
2319 	u32 number = edge_port->port->port_number;
2320 
2321 	if (edge_serial->is_epic &&
2322 	    !edge_serial->epic_descriptor.Supports.IOSPSetBaudRate) {
2323 		dev_dbg(dev, "SendCmdWriteBaudRate - NOT Setting baud rate for port, baud = %d\n",
2324 			baudRate);
2325 		return 0;
2326 	}
2327 
2328 	dev_dbg(dev, "%s - baud = %d\n", __func__, baudRate);
2329 
2330 	status = calc_baud_rate_divisor(dev, baudRate, &divisor);
2331 	if (status) {
2332 		dev_err(dev, "%s - bad baud rate\n", __func__);
2333 		return status;
2334 	}
2335 
2336 	/* Alloc memory for the string of commands. */
2337 	cmdBuffer =  kmalloc(0x100, GFP_ATOMIC);
2338 	if (!cmdBuffer)
2339 		return -ENOMEM;
2340 
2341 	currCmd = cmdBuffer;
2342 
2343 	/* Enable access to divisor latch */
2344 	MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, LCR, LCR_DL_ENABLE);
2345 
2346 	/* Write the divisor itself */
2347 	MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, DLL, LOW8(divisor));
2348 	MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, DLM, HIGH8(divisor));
2349 
2350 	/* Restore original value to disable access to divisor latch */
2351 	MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, number, LCR,
2352 						edge_port->shadowLCR);
2353 
2354 	status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
2355 	if (status) {
2356 		/* something bad happened, let's free up the memory */
2357 		kfree(cmdBuffer);
2358 	}
2359 
2360 	return status;
2361 }
2362 
2363 
2364 /*****************************************************************************
2365  * calc_baud_rate_divisor
2366  *	this function calculates the proper baud rate divisor for the specified
2367  *	baud rate.
2368  *****************************************************************************/
2369 static int calc_baud_rate_divisor(struct device *dev, int baudrate, int *divisor)
2370 {
2371 	int i;
2372 	__u16 custom;
2373 
2374 	for (i = 0; i < ARRAY_SIZE(divisor_table); i++) {
2375 		if (divisor_table[i].BaudRate == baudrate) {
2376 			*divisor = divisor_table[i].Divisor;
2377 			return 0;
2378 		}
2379 	}
2380 
2381 	/* We have tried all of the standard baud rates
2382 	 * lets try to calculate the divisor for this baud rate
2383 	 * Make sure the baud rate is reasonable */
2384 	if (baudrate > 50 && baudrate < 230400) {
2385 		/* get divisor */
2386 		custom = (__u16)((230400L + baudrate/2) / baudrate);
2387 
2388 		*divisor = custom;
2389 
2390 		dev_dbg(dev, "%s - Baud %d = %d\n", __func__, baudrate, custom);
2391 		return 0;
2392 	}
2393 
2394 	return -1;
2395 }
2396 
2397 
2398 /*****************************************************************************
2399  * send_cmd_write_uart_register
2400  *  this function builds up a uart register message and sends to the device.
2401  *****************************************************************************/
2402 static int send_cmd_write_uart_register(struct edgeport_port *edge_port,
2403 						__u8 regNum, __u8 regValue)
2404 {
2405 	struct edgeport_serial *edge_serial =
2406 				usb_get_serial_data(edge_port->port->serial);
2407 	struct device *dev = &edge_port->port->dev;
2408 	unsigned char *cmdBuffer;
2409 	unsigned char *currCmd;
2410 	unsigned long cmdLen = 0;
2411 	int status;
2412 
2413 	dev_dbg(dev, "%s - write to %s register 0x%02x\n",
2414 		(regNum == MCR) ? "MCR" : "LCR", __func__, regValue);
2415 
2416 	if (edge_serial->is_epic &&
2417 	    !edge_serial->epic_descriptor.Supports.IOSPWriteMCR &&
2418 	    regNum == MCR) {
2419 		dev_dbg(dev, "SendCmdWriteUartReg - Not writing to MCR Register\n");
2420 		return 0;
2421 	}
2422 
2423 	if (edge_serial->is_epic &&
2424 	    !edge_serial->epic_descriptor.Supports.IOSPWriteLCR &&
2425 	    regNum == LCR) {
2426 		dev_dbg(dev, "SendCmdWriteUartReg - Not writing to LCR Register\n");
2427 		return 0;
2428 	}
2429 
2430 	/* Alloc memory for the string of commands. */
2431 	cmdBuffer = kmalloc(0x10, GFP_ATOMIC);
2432 	if (cmdBuffer == NULL)
2433 		return -ENOMEM;
2434 
2435 	currCmd = cmdBuffer;
2436 
2437 	/* Build a cmd in the buffer to write the given register */
2438 	MAKE_CMD_WRITE_REG(&currCmd, &cmdLen, edge_port->port->port_number,
2439 			   regNum, regValue);
2440 
2441 	status = write_cmd_usb(edge_port, cmdBuffer, cmdLen);
2442 	if (status) {
2443 		/* something bad happened, let's free up the memory */
2444 		kfree(cmdBuffer);
2445 	}
2446 
2447 	return status;
2448 }
2449 
2450 
2451 /*****************************************************************************
2452  * change_port_settings
2453  *	This routine is called to set the UART on the device to match the
2454  *	specified new settings.
2455  *****************************************************************************/
2456 
2457 static void change_port_settings(struct tty_struct *tty,
2458 	struct edgeport_port *edge_port, struct ktermios *old_termios)
2459 {
2460 	struct device *dev = &edge_port->port->dev;
2461 	struct edgeport_serial *edge_serial =
2462 			usb_get_serial_data(edge_port->port->serial);
2463 	int baud;
2464 	unsigned cflag;
2465 	__u8 mask = 0xff;
2466 	__u8 lData;
2467 	__u8 lParity;
2468 	__u8 lStop;
2469 	__u8 rxFlow;
2470 	__u8 txFlow;
2471 	int status;
2472 
2473 	if (!edge_port->open &&
2474 	    !edge_port->openPending) {
2475 		dev_dbg(dev, "%s - port not opened\n", __func__);
2476 		return;
2477 	}
2478 
2479 	cflag = tty->termios.c_cflag;
2480 
2481 	switch (cflag & CSIZE) {
2482 	case CS5:
2483 		lData = LCR_BITS_5; mask = 0x1f;
2484 		dev_dbg(dev, "%s - data bits = 5\n", __func__);
2485 		break;
2486 	case CS6:
2487 		lData = LCR_BITS_6; mask = 0x3f;
2488 		dev_dbg(dev, "%s - data bits = 6\n", __func__);
2489 		break;
2490 	case CS7:
2491 		lData = LCR_BITS_7; mask = 0x7f;
2492 		dev_dbg(dev, "%s - data bits = 7\n", __func__);
2493 		break;
2494 	default:
2495 	case CS8:
2496 		lData = LCR_BITS_8;
2497 		dev_dbg(dev, "%s - data bits = 8\n", __func__);
2498 		break;
2499 	}
2500 
2501 	lParity = LCR_PAR_NONE;
2502 	if (cflag & PARENB) {
2503 		if (cflag & CMSPAR) {
2504 			if (cflag & PARODD) {
2505 				lParity = LCR_PAR_MARK;
2506 				dev_dbg(dev, "%s - parity = mark\n", __func__);
2507 			} else {
2508 				lParity = LCR_PAR_SPACE;
2509 				dev_dbg(dev, "%s - parity = space\n", __func__);
2510 			}
2511 		} else if (cflag & PARODD) {
2512 			lParity = LCR_PAR_ODD;
2513 			dev_dbg(dev, "%s - parity = odd\n", __func__);
2514 		} else {
2515 			lParity = LCR_PAR_EVEN;
2516 			dev_dbg(dev, "%s - parity = even\n", __func__);
2517 		}
2518 	} else {
2519 		dev_dbg(dev, "%s - parity = none\n", __func__);
2520 	}
2521 
2522 	if (cflag & CSTOPB) {
2523 		lStop = LCR_STOP_2;
2524 		dev_dbg(dev, "%s - stop bits = 2\n", __func__);
2525 	} else {
2526 		lStop = LCR_STOP_1;
2527 		dev_dbg(dev, "%s - stop bits = 1\n", __func__);
2528 	}
2529 
2530 	/* figure out the flow control settings */
2531 	rxFlow = txFlow = 0x00;
2532 	if (cflag & CRTSCTS) {
2533 		rxFlow |= IOSP_RX_FLOW_RTS;
2534 		txFlow |= IOSP_TX_FLOW_CTS;
2535 		dev_dbg(dev, "%s - RTS/CTS is enabled\n", __func__);
2536 	} else {
2537 		dev_dbg(dev, "%s - RTS/CTS is disabled\n", __func__);
2538 	}
2539 
2540 	/* if we are implementing XON/XOFF, set the start and stop character
2541 	   in the device */
2542 	if (I_IXOFF(tty) || I_IXON(tty)) {
2543 		unsigned char stop_char  = STOP_CHAR(tty);
2544 		unsigned char start_char = START_CHAR(tty);
2545 
2546 		if (!edge_serial->is_epic ||
2547 		    edge_serial->epic_descriptor.Supports.IOSPSetXChar) {
2548 			send_iosp_ext_cmd(edge_port,
2549 					IOSP_CMD_SET_XON_CHAR, start_char);
2550 			send_iosp_ext_cmd(edge_port,
2551 					IOSP_CMD_SET_XOFF_CHAR, stop_char);
2552 		}
2553 
2554 		/* if we are implementing INBOUND XON/XOFF */
2555 		if (I_IXOFF(tty)) {
2556 			rxFlow |= IOSP_RX_FLOW_XON_XOFF;
2557 			dev_dbg(dev, "%s - INBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2558 				__func__, start_char, stop_char);
2559 		} else {
2560 			dev_dbg(dev, "%s - INBOUND XON/XOFF is disabled\n", __func__);
2561 		}
2562 
2563 		/* if we are implementing OUTBOUND XON/XOFF */
2564 		if (I_IXON(tty)) {
2565 			txFlow |= IOSP_TX_FLOW_XON_XOFF;
2566 			dev_dbg(dev, "%s - OUTBOUND XON/XOFF is enabled, XON = %2x, XOFF = %2x\n",
2567 				__func__, start_char, stop_char);
2568 		} else {
2569 			dev_dbg(dev, "%s - OUTBOUND XON/XOFF is disabled\n", __func__);
2570 		}
2571 	}
2572 
2573 	/* Set flow control to the configured value */
2574 	if (!edge_serial->is_epic ||
2575 	    edge_serial->epic_descriptor.Supports.IOSPSetRxFlow)
2576 		send_iosp_ext_cmd(edge_port, IOSP_CMD_SET_RX_FLOW, rxFlow);
2577 	if (!edge_serial->is_epic ||
2578 	    edge_serial->epic_descriptor.Supports.IOSPSetTxFlow)
2579 		send_iosp_ext_cmd(edge_port, IOSP_CMD_SET_TX_FLOW, txFlow);
2580 
2581 
2582 	edge_port->shadowLCR &= ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
2583 	edge_port->shadowLCR |= (lData | lParity | lStop);
2584 
2585 	edge_port->validDataMask = mask;
2586 
2587 	/* Send the updated LCR value to the EdgePort */
2588 	status = send_cmd_write_uart_register(edge_port, LCR,
2589 							edge_port->shadowLCR);
2590 	if (status != 0)
2591 		return;
2592 
2593 	/* set up the MCR register and send it to the EdgePort */
2594 	edge_port->shadowMCR = MCR_MASTER_IE;
2595 	if (cflag & CBAUD)
2596 		edge_port->shadowMCR |= (MCR_DTR | MCR_RTS);
2597 
2598 	status = send_cmd_write_uart_register(edge_port, MCR,
2599 						edge_port->shadowMCR);
2600 	if (status != 0)
2601 		return;
2602 
2603 	/* Determine divisor based on baud rate */
2604 	baud = tty_get_baud_rate(tty);
2605 	if (!baud) {
2606 		/* pick a default, any default... */
2607 		baud = 9600;
2608 	}
2609 
2610 	dev_dbg(dev, "%s - baud rate = %d\n", __func__, baud);
2611 	status = send_cmd_write_baud_rate(edge_port, baud);
2612 	if (status == -1) {
2613 		/* Speed change was not possible - put back the old speed */
2614 		baud = tty_termios_baud_rate(old_termios);
2615 		tty_encode_baud_rate(tty, baud, baud);
2616 	}
2617 }
2618 
2619 
2620 /****************************************************************************
2621  * unicode_to_ascii
2622  *	Turns a string from Unicode into ASCII.
2623  *	Doesn't do a good job with any characters that are outside the normal
2624  *	ASCII range, but it's only for debugging...
2625  *	NOTE: expects the unicode in LE format
2626  ****************************************************************************/
2627 static void unicode_to_ascii(char *string, int buflen,
2628 					__le16 *unicode, int unicode_size)
2629 {
2630 	int i;
2631 
2632 	if (buflen <= 0)	/* never happens, but... */
2633 		return;
2634 	--buflen;		/* space for nul */
2635 
2636 	for (i = 0; i < unicode_size; i++) {
2637 		if (i >= buflen)
2638 			break;
2639 		string[i] = (char)(le16_to_cpu(unicode[i]));
2640 	}
2641 	string[i] = 0x00;
2642 }
2643 
2644 
2645 /****************************************************************************
2646  * get_manufacturing_desc
2647  *	reads in the manufacturing descriptor and stores it into the serial
2648  *	structure.
2649  ****************************************************************************/
2650 static void get_manufacturing_desc(struct edgeport_serial *edge_serial)
2651 {
2652 	struct device *dev = &edge_serial->serial->dev->dev;
2653 	int response;
2654 
2655 	dev_dbg(dev, "getting manufacturer descriptor\n");
2656 
2657 	response = rom_read(edge_serial->serial,
2658 				(EDGE_MANUF_DESC_ADDR & 0xffff0000) >> 16,
2659 				(__u16)(EDGE_MANUF_DESC_ADDR & 0x0000ffff),
2660 				EDGE_MANUF_DESC_LEN,
2661 				(__u8 *)(&edge_serial->manuf_descriptor));
2662 
2663 	if (response < 0) {
2664 		dev_err(dev, "error in getting manufacturer descriptor: %d\n",
2665 				response);
2666 	} else {
2667 		char string[30];
2668 		dev_dbg(dev, "**Manufacturer Descriptor\n");
2669 		dev_dbg(dev, "  RomSize:        %dK\n",
2670 			edge_serial->manuf_descriptor.RomSize);
2671 		dev_dbg(dev, "  RamSize:        %dK\n",
2672 			edge_serial->manuf_descriptor.RamSize);
2673 		dev_dbg(dev, "  CpuRev:         %d\n",
2674 			edge_serial->manuf_descriptor.CpuRev);
2675 		dev_dbg(dev, "  BoardRev:       %d\n",
2676 			edge_serial->manuf_descriptor.BoardRev);
2677 		dev_dbg(dev, "  NumPorts:       %d\n",
2678 			edge_serial->manuf_descriptor.NumPorts);
2679 		dev_dbg(dev, "  DescDate:       %d/%d/%d\n",
2680 			edge_serial->manuf_descriptor.DescDate[0],
2681 			edge_serial->manuf_descriptor.DescDate[1],
2682 			edge_serial->manuf_descriptor.DescDate[2]+1900);
2683 		unicode_to_ascii(string, sizeof(string),
2684 			edge_serial->manuf_descriptor.SerialNumber,
2685 			edge_serial->manuf_descriptor.SerNumLength/2);
2686 		dev_dbg(dev, "  SerialNumber: %s\n", string);
2687 		unicode_to_ascii(string, sizeof(string),
2688 			edge_serial->manuf_descriptor.AssemblyNumber,
2689 			edge_serial->manuf_descriptor.AssemblyNumLength/2);
2690 		dev_dbg(dev, "  AssemblyNumber: %s\n", string);
2691 		unicode_to_ascii(string, sizeof(string),
2692 		    edge_serial->manuf_descriptor.OemAssyNumber,
2693 		    edge_serial->manuf_descriptor.OemAssyNumLength/2);
2694 		dev_dbg(dev, "  OemAssyNumber:  %s\n", string);
2695 		dev_dbg(dev, "  UartType:       %d\n",
2696 			edge_serial->manuf_descriptor.UartType);
2697 		dev_dbg(dev, "  IonPid:         %d\n",
2698 			edge_serial->manuf_descriptor.IonPid);
2699 		dev_dbg(dev, "  IonConfig:      %d\n",
2700 			edge_serial->manuf_descriptor.IonConfig);
2701 	}
2702 }
2703 
2704 
2705 /****************************************************************************
2706  * get_boot_desc
2707  *	reads in the bootloader descriptor and stores it into the serial
2708  *	structure.
2709  ****************************************************************************/
2710 static void get_boot_desc(struct edgeport_serial *edge_serial)
2711 {
2712 	struct device *dev = &edge_serial->serial->dev->dev;
2713 	int response;
2714 
2715 	dev_dbg(dev, "getting boot descriptor\n");
2716 
2717 	response = rom_read(edge_serial->serial,
2718 				(EDGE_BOOT_DESC_ADDR & 0xffff0000) >> 16,
2719 				(__u16)(EDGE_BOOT_DESC_ADDR & 0x0000ffff),
2720 				EDGE_BOOT_DESC_LEN,
2721 				(__u8 *)(&edge_serial->boot_descriptor));
2722 
2723 	if (response < 0) {
2724 		dev_err(dev, "error in getting boot descriptor: %d\n",
2725 				response);
2726 	} else {
2727 		dev_dbg(dev, "**Boot Descriptor:\n");
2728 		dev_dbg(dev, "  BootCodeLength: %d\n",
2729 			le16_to_cpu(edge_serial->boot_descriptor.BootCodeLength));
2730 		dev_dbg(dev, "  MajorVersion:   %d\n",
2731 			edge_serial->boot_descriptor.MajorVersion);
2732 		dev_dbg(dev, "  MinorVersion:   %d\n",
2733 			edge_serial->boot_descriptor.MinorVersion);
2734 		dev_dbg(dev, "  BuildNumber:    %d\n",
2735 			le16_to_cpu(edge_serial->boot_descriptor.BuildNumber));
2736 		dev_dbg(dev, "  Capabilities:   0x%x\n",
2737 		      le16_to_cpu(edge_serial->boot_descriptor.Capabilities));
2738 		dev_dbg(dev, "  UConfig0:       %d\n",
2739 			edge_serial->boot_descriptor.UConfig0);
2740 		dev_dbg(dev, "  UConfig1:       %d\n",
2741 			edge_serial->boot_descriptor.UConfig1);
2742 	}
2743 }
2744 
2745 
2746 /****************************************************************************
2747  * load_application_firmware
2748  *	This is called to load the application firmware to the device
2749  ****************************************************************************/
2750 static void load_application_firmware(struct edgeport_serial *edge_serial)
2751 {
2752 	struct device *dev = &edge_serial->serial->dev->dev;
2753 	const struct ihex_binrec *rec;
2754 	const struct firmware *fw;
2755 	const char *fw_name;
2756 	const char *fw_info;
2757 	int response;
2758 	__u32 Operaddr;
2759 	__u16 build;
2760 
2761 	switch (edge_serial->product_info.iDownloadFile) {
2762 		case EDGE_DOWNLOAD_FILE_I930:
2763 			fw_info = "downloading firmware version (930)";
2764 			fw_name	= "edgeport/down.fw";
2765 			break;
2766 
2767 		case EDGE_DOWNLOAD_FILE_80251:
2768 			fw_info = "downloading firmware version (80251)";
2769 			fw_name	= "edgeport/down2.fw";
2770 			break;
2771 
2772 		case EDGE_DOWNLOAD_FILE_NONE:
2773 			dev_dbg(dev, "No download file specified, skipping download\n");
2774 			return;
2775 
2776 		default:
2777 			return;
2778 	}
2779 
2780 	response = request_ihex_firmware(&fw, fw_name,
2781 				    &edge_serial->serial->dev->dev);
2782 	if (response) {
2783 		dev_err(dev, "Failed to load image \"%s\" err %d\n",
2784 		       fw_name, response);
2785 		return;
2786 	}
2787 
2788 	rec = (const struct ihex_binrec *)fw->data;
2789 	build = (rec->data[2] << 8) | rec->data[3];
2790 
2791 	dev_dbg(dev, "%s %d.%d.%d\n", fw_info, rec->data[0], rec->data[1], build);
2792 
2793 	edge_serial->product_info.FirmwareMajorVersion = rec->data[0];
2794 	edge_serial->product_info.FirmwareMinorVersion = rec->data[1];
2795 	edge_serial->product_info.FirmwareBuildNumber = cpu_to_le16(build);
2796 
2797 	for (rec = ihex_next_binrec(rec); rec;
2798 	     rec = ihex_next_binrec(rec)) {
2799 		Operaddr = be32_to_cpu(rec->addr);
2800 		response = sram_write(edge_serial->serial,
2801 				     Operaddr >> 16,
2802 				     Operaddr & 0xFFFF,
2803 				     be16_to_cpu(rec->len),
2804 				     &rec->data[0]);
2805 		if (response < 0) {
2806 			dev_err(&edge_serial->serial->dev->dev,
2807 				"sram_write failed (%x, %x, %d)\n",
2808 				Operaddr >> 16, Operaddr & 0xFFFF,
2809 				be16_to_cpu(rec->len));
2810 			break;
2811 		}
2812 	}
2813 
2814 	dev_dbg(dev, "sending exec_dl_code\n");
2815 	response = usb_control_msg (edge_serial->serial->dev,
2816 				    usb_sndctrlpipe(edge_serial->serial->dev, 0),
2817 				    USB_REQUEST_ION_EXEC_DL_CODE,
2818 				    0x40, 0x4000, 0x0001, NULL, 0, 3000);
2819 
2820 	release_firmware(fw);
2821 }
2822 
2823 
2824 /****************************************************************************
2825  * edge_startup
2826  ****************************************************************************/
2827 static int edge_startup(struct usb_serial *serial)
2828 {
2829 	struct edgeport_serial *edge_serial;
2830 	struct usb_device *dev;
2831 	struct device *ddev = &serial->dev->dev;
2832 	int i;
2833 	int response;
2834 	bool interrupt_in_found;
2835 	bool bulk_in_found;
2836 	bool bulk_out_found;
2837 	static const __u32 descriptor[3] = {	EDGE_COMPATIBILITY_MASK0,
2838 						EDGE_COMPATIBILITY_MASK1,
2839 						EDGE_COMPATIBILITY_MASK2 };
2840 
2841 	dev = serial->dev;
2842 
2843 	/* create our private serial structure */
2844 	edge_serial = kzalloc(sizeof(struct edgeport_serial), GFP_KERNEL);
2845 	if (!edge_serial)
2846 		return -ENOMEM;
2847 
2848 	spin_lock_init(&edge_serial->es_lock);
2849 	edge_serial->serial = serial;
2850 	usb_set_serial_data(serial, edge_serial);
2851 
2852 	/* get the name for the device from the device */
2853 	i = usb_string(dev, dev->descriptor.iManufacturer,
2854 	    &edge_serial->name[0], MAX_NAME_LEN+1);
2855 	if (i < 0)
2856 		i = 0;
2857 	edge_serial->name[i++] = ' ';
2858 	usb_string(dev, dev->descriptor.iProduct,
2859 	    &edge_serial->name[i], MAX_NAME_LEN+2 - i);
2860 
2861 	dev_info(&serial->dev->dev, "%s detected\n", edge_serial->name);
2862 
2863 	/* Read the epic descriptor */
2864 	if (get_epic_descriptor(edge_serial) < 0) {
2865 		/* memcpy descriptor to Supports structures */
2866 		memcpy(&edge_serial->epic_descriptor.Supports, descriptor,
2867 		       sizeof(struct edge_compatibility_bits));
2868 
2869 		/* get the manufacturing descriptor for this device */
2870 		get_manufacturing_desc(edge_serial);
2871 
2872 		/* get the boot descriptor */
2873 		get_boot_desc(edge_serial);
2874 
2875 		get_product_info(edge_serial);
2876 	}
2877 
2878 	/* set the number of ports from the manufacturing description */
2879 	/* serial->num_ports = serial->product_info.NumPorts; */
2880 	if ((!edge_serial->is_epic) &&
2881 	    (edge_serial->product_info.NumPorts != serial->num_ports)) {
2882 		dev_warn(ddev,
2883 			"Device Reported %d serial ports vs. core thinking we have %d ports, email greg@kroah.com this information.\n",
2884 			 edge_serial->product_info.NumPorts,
2885 			 serial->num_ports);
2886 	}
2887 
2888 	dev_dbg(ddev, "%s - time 1 %ld\n", __func__, jiffies);
2889 
2890 	/* If not an EPiC device */
2891 	if (!edge_serial->is_epic) {
2892 		/* now load the application firmware into this device */
2893 		load_application_firmware(edge_serial);
2894 
2895 		dev_dbg(ddev, "%s - time 2 %ld\n", __func__, jiffies);
2896 
2897 		/* Check current Edgeport EEPROM and update if necessary */
2898 		update_edgeport_E2PROM(edge_serial);
2899 
2900 		dev_dbg(ddev, "%s - time 3 %ld\n", __func__, jiffies);
2901 
2902 		/* set the configuration to use #1 */
2903 /*		dev_dbg(ddev, "set_configuration 1\n"); */
2904 /*		usb_set_configuration (dev, 1); */
2905 	}
2906 	dev_dbg(ddev, "  FirmwareMajorVersion  %d.%d.%d\n",
2907 	    edge_serial->product_info.FirmwareMajorVersion,
2908 	    edge_serial->product_info.FirmwareMinorVersion,
2909 	    le16_to_cpu(edge_serial->product_info.FirmwareBuildNumber));
2910 
2911 	/* we set up the pointers to the endpoints in the edge_open function,
2912 	 * as the structures aren't created yet. */
2913 
2914 	response = 0;
2915 
2916 	if (edge_serial->is_epic) {
2917 		/* EPIC thing, set up our interrupt polling now and our read
2918 		 * urb, so that the device knows it really is connected. */
2919 		interrupt_in_found = bulk_in_found = bulk_out_found = false;
2920 		for (i = 0; i < serial->interface->altsetting[0]
2921 						.desc.bNumEndpoints; ++i) {
2922 			struct usb_endpoint_descriptor *endpoint;
2923 			int buffer_size;
2924 
2925 			endpoint = &serial->interface->altsetting[0].
2926 							endpoint[i].desc;
2927 			buffer_size = usb_endpoint_maxp(endpoint);
2928 			if (!interrupt_in_found &&
2929 			    (usb_endpoint_is_int_in(endpoint))) {
2930 				/* we found a interrupt in endpoint */
2931 				dev_dbg(ddev, "found interrupt in\n");
2932 
2933 				/* not set up yet, so do it now */
2934 				edge_serial->interrupt_read_urb =
2935 						usb_alloc_urb(0, GFP_KERNEL);
2936 				if (!edge_serial->interrupt_read_urb) {
2937 					response = -ENOMEM;
2938 					break;
2939 				}
2940 
2941 				edge_serial->interrupt_in_buffer =
2942 					kmalloc(buffer_size, GFP_KERNEL);
2943 				if (!edge_serial->interrupt_in_buffer) {
2944 					response = -ENOMEM;
2945 					break;
2946 				}
2947 				edge_serial->interrupt_in_endpoint =
2948 						endpoint->bEndpointAddress;
2949 
2950 				/* set up our interrupt urb */
2951 				usb_fill_int_urb(
2952 					edge_serial->interrupt_read_urb,
2953 					dev,
2954 					usb_rcvintpipe(dev,
2955 						endpoint->bEndpointAddress),
2956 					edge_serial->interrupt_in_buffer,
2957 					buffer_size,
2958 					edge_interrupt_callback,
2959 					edge_serial,
2960 					endpoint->bInterval);
2961 
2962 				interrupt_in_found = true;
2963 			}
2964 
2965 			if (!bulk_in_found &&
2966 				(usb_endpoint_is_bulk_in(endpoint))) {
2967 				/* we found a bulk in endpoint */
2968 				dev_dbg(ddev, "found bulk in\n");
2969 
2970 				/* not set up yet, so do it now */
2971 				edge_serial->read_urb =
2972 						usb_alloc_urb(0, GFP_KERNEL);
2973 				if (!edge_serial->read_urb) {
2974 					response = -ENOMEM;
2975 					break;
2976 				}
2977 
2978 				edge_serial->bulk_in_buffer =
2979 					kmalloc(buffer_size, GFP_KERNEL);
2980 				if (!edge_serial->bulk_in_buffer) {
2981 					response = -ENOMEM;
2982 					break;
2983 				}
2984 				edge_serial->bulk_in_endpoint =
2985 						endpoint->bEndpointAddress;
2986 
2987 				/* set up our bulk in urb */
2988 				usb_fill_bulk_urb(edge_serial->read_urb, dev,
2989 					usb_rcvbulkpipe(dev,
2990 						endpoint->bEndpointAddress),
2991 					edge_serial->bulk_in_buffer,
2992 					usb_endpoint_maxp(endpoint),
2993 					edge_bulk_in_callback,
2994 					edge_serial);
2995 				bulk_in_found = true;
2996 			}
2997 
2998 			if (!bulk_out_found &&
2999 			    (usb_endpoint_is_bulk_out(endpoint))) {
3000 				/* we found a bulk out endpoint */
3001 				dev_dbg(ddev, "found bulk out\n");
3002 				edge_serial->bulk_out_endpoint =
3003 						endpoint->bEndpointAddress;
3004 				bulk_out_found = true;
3005 			}
3006 		}
3007 
3008 		if (response || !interrupt_in_found || !bulk_in_found ||
3009 							!bulk_out_found) {
3010 			if (!response) {
3011 				dev_err(ddev, "expected endpoints not found\n");
3012 				response = -ENODEV;
3013 			}
3014 
3015 			usb_free_urb(edge_serial->interrupt_read_urb);
3016 			kfree(edge_serial->interrupt_in_buffer);
3017 
3018 			usb_free_urb(edge_serial->read_urb);
3019 			kfree(edge_serial->bulk_in_buffer);
3020 
3021 			kfree(edge_serial);
3022 
3023 			return response;
3024 		}
3025 
3026 		/* start interrupt read for this edgeport this interrupt will
3027 		 * continue as long as the edgeport is connected */
3028 		response = usb_submit_urb(edge_serial->interrupt_read_urb,
3029 								GFP_KERNEL);
3030 		if (response)
3031 			dev_err(ddev, "%s - Error %d submitting control urb\n",
3032 				__func__, response);
3033 	}
3034 	return response;
3035 }
3036 
3037 
3038 /****************************************************************************
3039  * edge_disconnect
3040  *	This function is called whenever the device is removed from the usb bus.
3041  ****************************************************************************/
3042 static void edge_disconnect(struct usb_serial *serial)
3043 {
3044 	struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
3045 
3046 	if (edge_serial->is_epic) {
3047 		usb_kill_urb(edge_serial->interrupt_read_urb);
3048 		usb_kill_urb(edge_serial->read_urb);
3049 	}
3050 }
3051 
3052 
3053 /****************************************************************************
3054  * edge_release
3055  *	This function is called when the device structure is deallocated.
3056  ****************************************************************************/
3057 static void edge_release(struct usb_serial *serial)
3058 {
3059 	struct edgeport_serial *edge_serial = usb_get_serial_data(serial);
3060 
3061 	if (edge_serial->is_epic) {
3062 		usb_kill_urb(edge_serial->interrupt_read_urb);
3063 		usb_free_urb(edge_serial->interrupt_read_urb);
3064 		kfree(edge_serial->interrupt_in_buffer);
3065 
3066 		usb_kill_urb(edge_serial->read_urb);
3067 		usb_free_urb(edge_serial->read_urb);
3068 		kfree(edge_serial->bulk_in_buffer);
3069 	}
3070 
3071 	kfree(edge_serial);
3072 }
3073 
3074 static int edge_port_probe(struct usb_serial_port *port)
3075 {
3076 	struct edgeport_port *edge_port;
3077 
3078 	edge_port = kzalloc(sizeof(*edge_port), GFP_KERNEL);
3079 	if (!edge_port)
3080 		return -ENOMEM;
3081 
3082 	spin_lock_init(&edge_port->ep_lock);
3083 	edge_port->port = port;
3084 
3085 	usb_set_serial_port_data(port, edge_port);
3086 
3087 	return 0;
3088 }
3089 
3090 static int edge_port_remove(struct usb_serial_port *port)
3091 {
3092 	struct edgeport_port *edge_port;
3093 
3094 	edge_port = usb_get_serial_port_data(port);
3095 	kfree(edge_port);
3096 
3097 	return 0;
3098 }
3099 
3100 static struct usb_serial_driver edgeport_2port_device = {
3101 	.driver = {
3102 		.owner		= THIS_MODULE,
3103 		.name		= "edgeport_2",
3104 	},
3105 	.description		= "Edgeport 2 port adapter",
3106 	.id_table		= edgeport_2port_id_table,
3107 	.num_ports		= 2,
3108 	.num_bulk_in		= 1,
3109 	.num_bulk_out		= 1,
3110 	.num_interrupt_in	= 1,
3111 	.open			= edge_open,
3112 	.close			= edge_close,
3113 	.throttle		= edge_throttle,
3114 	.unthrottle		= edge_unthrottle,
3115 	.attach			= edge_startup,
3116 	.disconnect		= edge_disconnect,
3117 	.release		= edge_release,
3118 	.port_probe		= edge_port_probe,
3119 	.port_remove		= edge_port_remove,
3120 	.ioctl			= edge_ioctl,
3121 	.set_termios		= edge_set_termios,
3122 	.tiocmget		= edge_tiocmget,
3123 	.tiocmset		= edge_tiocmset,
3124 	.tiocmiwait		= usb_serial_generic_tiocmiwait,
3125 	.get_icount		= usb_serial_generic_get_icount,
3126 	.write			= edge_write,
3127 	.write_room		= edge_write_room,
3128 	.chars_in_buffer	= edge_chars_in_buffer,
3129 	.break_ctl		= edge_break,
3130 	.read_int_callback	= edge_interrupt_callback,
3131 	.read_bulk_callback	= edge_bulk_in_callback,
3132 	.write_bulk_callback	= edge_bulk_out_data_callback,
3133 };
3134 
3135 static struct usb_serial_driver edgeport_4port_device = {
3136 	.driver = {
3137 		.owner		= THIS_MODULE,
3138 		.name		= "edgeport_4",
3139 	},
3140 	.description		= "Edgeport 4 port adapter",
3141 	.id_table		= edgeport_4port_id_table,
3142 	.num_ports		= 4,
3143 	.num_bulk_in		= 1,
3144 	.num_bulk_out		= 1,
3145 	.num_interrupt_in	= 1,
3146 	.open			= edge_open,
3147 	.close			= edge_close,
3148 	.throttle		= edge_throttle,
3149 	.unthrottle		= edge_unthrottle,
3150 	.attach			= edge_startup,
3151 	.disconnect		= edge_disconnect,
3152 	.release		= edge_release,
3153 	.port_probe		= edge_port_probe,
3154 	.port_remove		= edge_port_remove,
3155 	.ioctl			= edge_ioctl,
3156 	.set_termios		= edge_set_termios,
3157 	.tiocmget		= edge_tiocmget,
3158 	.tiocmset		= edge_tiocmset,
3159 	.tiocmiwait		= usb_serial_generic_tiocmiwait,
3160 	.get_icount		= usb_serial_generic_get_icount,
3161 	.write			= edge_write,
3162 	.write_room		= edge_write_room,
3163 	.chars_in_buffer	= edge_chars_in_buffer,
3164 	.break_ctl		= edge_break,
3165 	.read_int_callback	= edge_interrupt_callback,
3166 	.read_bulk_callback	= edge_bulk_in_callback,
3167 	.write_bulk_callback	= edge_bulk_out_data_callback,
3168 };
3169 
3170 static struct usb_serial_driver edgeport_8port_device = {
3171 	.driver = {
3172 		.owner		= THIS_MODULE,
3173 		.name		= "edgeport_8",
3174 	},
3175 	.description		= "Edgeport 8 port adapter",
3176 	.id_table		= edgeport_8port_id_table,
3177 	.num_ports		= 8,
3178 	.num_bulk_in		= 1,
3179 	.num_bulk_out		= 1,
3180 	.num_interrupt_in	= 1,
3181 	.open			= edge_open,
3182 	.close			= edge_close,
3183 	.throttle		= edge_throttle,
3184 	.unthrottle		= edge_unthrottle,
3185 	.attach			= edge_startup,
3186 	.disconnect		= edge_disconnect,
3187 	.release		= edge_release,
3188 	.port_probe		= edge_port_probe,
3189 	.port_remove		= edge_port_remove,
3190 	.ioctl			= edge_ioctl,
3191 	.set_termios		= edge_set_termios,
3192 	.tiocmget		= edge_tiocmget,
3193 	.tiocmset		= edge_tiocmset,
3194 	.tiocmiwait		= usb_serial_generic_tiocmiwait,
3195 	.get_icount		= usb_serial_generic_get_icount,
3196 	.write			= edge_write,
3197 	.write_room		= edge_write_room,
3198 	.chars_in_buffer	= edge_chars_in_buffer,
3199 	.break_ctl		= edge_break,
3200 	.read_int_callback	= edge_interrupt_callback,
3201 	.read_bulk_callback	= edge_bulk_in_callback,
3202 	.write_bulk_callback	= edge_bulk_out_data_callback,
3203 };
3204 
3205 static struct usb_serial_driver epic_device = {
3206 	.driver = {
3207 		.owner		= THIS_MODULE,
3208 		.name		= "epic",
3209 	},
3210 	.description		= "EPiC device",
3211 	.id_table		= Epic_port_id_table,
3212 	.num_ports		= 1,
3213 	.num_bulk_in		= 1,
3214 	.num_bulk_out		= 1,
3215 	.num_interrupt_in	= 1,
3216 	.open			= edge_open,
3217 	.close			= edge_close,
3218 	.throttle		= edge_throttle,
3219 	.unthrottle		= edge_unthrottle,
3220 	.attach			= edge_startup,
3221 	.disconnect		= edge_disconnect,
3222 	.release		= edge_release,
3223 	.port_probe		= edge_port_probe,
3224 	.port_remove		= edge_port_remove,
3225 	.ioctl			= edge_ioctl,
3226 	.set_termios		= edge_set_termios,
3227 	.tiocmget		= edge_tiocmget,
3228 	.tiocmset		= edge_tiocmset,
3229 	.tiocmiwait		= usb_serial_generic_tiocmiwait,
3230 	.get_icount		= usb_serial_generic_get_icount,
3231 	.write			= edge_write,
3232 	.write_room		= edge_write_room,
3233 	.chars_in_buffer	= edge_chars_in_buffer,
3234 	.break_ctl		= edge_break,
3235 	.read_int_callback	= edge_interrupt_callback,
3236 	.read_bulk_callback	= edge_bulk_in_callback,
3237 	.write_bulk_callback	= edge_bulk_out_data_callback,
3238 };
3239 
3240 static struct usb_serial_driver * const serial_drivers[] = {
3241 	&edgeport_2port_device, &edgeport_4port_device,
3242 	&edgeport_8port_device, &epic_device, NULL
3243 };
3244 
3245 module_usb_serial_driver(serial_drivers, id_table_combined);
3246 
3247 MODULE_AUTHOR(DRIVER_AUTHOR);
3248 MODULE_DESCRIPTION(DRIVER_DESC);
3249 MODULE_LICENSE("GPL");
3250 MODULE_FIRMWARE("edgeport/boot.fw");
3251 MODULE_FIRMWARE("edgeport/boot2.fw");
3252 MODULE_FIRMWARE("edgeport/down.fw");
3253 MODULE_FIRMWARE("edgeport/down2.fw");
3254