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