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(io_driver, serial_drivers);
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");
3196