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