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