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