Linux Audio

Check our new training course

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