1. esccp_2009_02_26.zip Driver
2. README.TXT File Contents

README.TXT Driver File Contents (esccp_2009_02_26.zip)

--BETA--BETA--BETA--BETA--BETA--
This driver and information is subject to change.
Initial tests show that this driver does function.  However, if
you do too much outside of what has been tested it will probably fail.
If it does fail, details about what failed and how you achieved it would
be helpful, email bug reports to custserv@commtech-fastcom.com.
--BETA--BETA--BETA--BETA--BETA--

Windows 95
FASTCOM:ESCC-P driver highlights

Maximum number of ESCC-P boards supported: 3 (6 ports)
ESCC operating modes supported: HDLC(Auto mode, Transparent mode),BISYNC,ASYNC
Data rates:     IRQ driven to 1Mbps (depends alot on cpu/system speed, and can be as higher than 1Mbps)


Installation:
No install notes are really necessary, just make sure that the esccpdrv.vxd is 
somewhere in the path, or in the directory of the program that opens it.
When you first boot up with the escc-p board in a pci slot win95 will indicate
that a new pci device is found you should select the 
"Do not install a driver (Windows will not prompt you again)" option.
Note also that W95 will keep track of the ports by which slot was used first
so if you have multiple boards and rearrange them the port numbers will be fixed
by the order that the slots were used, not the physical boards.
To wipe this information (like if you started at slot3 and want 
the slot1 board to be ports 0 and 1), run regedit.exe and open
HKEY_LOCAL_MACHINE
Enum
PCI
delete the following key (and its subkeys):
VEN_10E8&DEV_814C
then plug in the board you want to be port0 and 1 and restart your PC.
shutdown
then plug in the board you want to be port 2 and port 3 and restart.


Interface:
The Driver is based on the Win32 CreateFile() / DeviceIoControl() interface.
The driver is loaded when CreateFile is called as:

hESCC = CreateFile("\\\\.\\ESCCPDRV.VXD", 0,0,0,
		   CREATE_NEW, FILE_FLAG_DELETE_ON_CLOSE|FILE_FLAG_OVERLAPPED, 0);

The driver will automatically locate any ESCC-P boards
To determine how many ports the driver found use:

DeviceIoControl(hESCC, ESCC_GET_MAX_PORT,
		(LPVOID)NULL,0,
				&i, sizeof(DWORD),
		&cbBytesReturned, NULL))
//returns true and i = maximum usable port # (starting at 0)
//or ERROR_INVALID_PARAMETER if a DWORD is not given for the output buffer
//or ERROR_NO_PORTS_DEFINED if no ports are known to the driver

Now give the port settings for a port using:

The SETUP structure is defined in the esccdrv.h file and is basically the 82532
registers, with the port and buffering information.

DeviceIoControl(hESCC, ESCC_INITIALIZE,(LPVOID)&settings, sizeof(SETUP),(LPVOID)NULL, 0,&cbBytesReturned, NULL) )
//returns true if settings successfull
//returns ERROR_INVALID_PARAMETER if SETUP struct not passed
//returns ERROR_BAD_PORT_NUMBER if port is out of range
//returns ERROR_CEC_TIMEOUT if the command executing bit times out(ie no core clock)
//returns ERROR_TOO_MANY_RBUFS if n_rbufs > 1000
//returns ERROR_TOO_MANY_TBUFS if n_tbufs > 1000
//returns ERROR_MAX_FRAME_SIZE if n_rfsize_max or n_tfsize_max > 4096
//returns ERROR_MIN_FRAME_SIZE if n_rfsize_max or n_tfsize_max < 32
//returns ERROR_MEM_ALLOCATION if the driver cannot get enough memory to fill the requested sizes

Now it is possible to read/write to the device and have it actually do something.

To read a frame use:

DeviceIoControl(hESCC, ESCC_READ,&Port, sizeof(DWORD),buffer, sizeof(buffer),&cbBytesReturned, &osr);
//returns true if a frame is received and copied to the buffer (in HDLC mode the last byte is the contents of the RSTA register)
//cbBytesReturned will be the number of bytes copied to the buffer
//or ERROR_INVALID_PARAMETER if not a DWORD and char array passed
//or ERROR_BAD_PORT_NUMBER if the port is out of range
//or ERROR_NO_DATA_RECEIVED if there are not any valid receive buffers waiting in the driver
//or ERROR_USER_BUFFER_TOO_SMALL if the received frame is bigger than the buffer passed.
//or ERROR_IO_PENDING (if overlapped was specified and given and the driver is not currently holding a received frame)

To write a frame out a port use:

DeviceIoControl(hESCC, ESCC_WRITE,&tbuf, bytestosend,(LPVOID)NULL,0,&cbBytesReturned, &osw);
//returns true if a frame is written or queued
//ERROR_INVALID_PARAMETER if the bytestosend is not at least a sizeof(DWORD)(indicating a port value)
//ERROR_BAD_PORT_NUMBER if the port is out of range
//ERROR_TRANSMIT_FRAME_TOO_LARGE if bytestosend is > sizeof(DWORD)+4096
//ERROR_TRANSMIT_BUFFERS_FULL if all of the internal buffers are used and queued for transmit
//ERROR_TRANSMITTER_LOCKED_UP if the driver thinks that it is not transmitting but a valid transmit buffer is found.(requires a flush to transmit anything)
//ERROR_CEC_TIMEOUT if a command is executing (probably no core clock source (clock mode dependant))
//ERROR_IO_PENDING (if overlapped was specified and given and the driver transmit buffers are full)
make sure that your tbuf is setup as (or something similar):

struct mydata
{
DWORD port;
char data[n_tfsize_max];
};
and bytestosend = # bytes you want to go out in the frame plus sizeof(DWORD)
so if you want to send 256 bytes in your frame you would have:
bytestosend = 256 + sizeof(DWORD);
Be carefull of structure alignment, the driver expects the port number to be
the first DWORD in the buffer that is passed, and assumes that the next byte is
the start of data.


To check the status of a port use:

DeviceIoControl(hESCC, ESCC_STATUS,
		&Port,sizeof(DWORD),
		&stat, sizeof(unsigned long),
		&cbBytesReturned, NULL);
//returns true with unsigned long status or (reads and clears the internal status value)
//ERROR_INVALID_PARAMETER if DWORD and unsigned long not passed
//ERROR_BAD_PORT_NUMBER if the port is out of range
//ERROR_IO_PENDING if overlapped was specified and overlapped struct is passed, and no status events have occured.

This returns the status values as defined in the esccdrv.h file.  Most
of these values are reflections of 82532 interrupt sources.

The Full list of available DeviceIoControl functions:

ESCC_READ                       -- used to read a buffer/frame from the driver
ESCC_WRITE                      -- used to write a buffer/frame to the driver
ESCC_INITIALIZE         -- used to initialize the port (register settings)
ESCC_SET_CLOCK          -- used to set the ICD2053b clock generator (changes the OSC input to the 82532)
ESCC_READ_REGISTER      -- used to obtain a single register from the 82532
ESCC_WRITE_REGISTER -- used to write a single register to the 82532
ESCC_STATUS                     -- used to get the port status from the driver
ESCC_FLUSH_RX           -- used to flush the receive buffers for the port
ESCC_FLUSH_TX           -- used to flush the transmit buffers for the port
ESCC_ADD_BOARD          -- used to add ports to the drivers list of known ports(does nothing for the -P driver only applicable to the ISA ESCC driver)
ESCC_GET_MAX_PORT       -- used to find out how many ports the driver knows about

The READ_REGISTER and WRITE_REGISTER functions should not be used to change
operating modes.  In general you should be very careful with these functions, as
they have very little protection and can cause many bad things to happen internally 
with the driver.  They can safely be used to set/change the address registers, and 
to send some commands (like STI, RHR, RNR) but should not be used with RMC,RHR,XTF,XIF,XME, or XRES commands,
or to change any of the configuration registers (MODE,CCR0,CCR1,CCR2,CCR3,CCR4,IPC
IMR0,IMR1,PVR,PIM,PCR).  You have been warned.

Examples of usage of these functions can be found in the escctest.c file.


changes and modifications:

09/15/98 Initial Beta release

09/29/98 fixed initilization bug when using async or bisync modes the 
82532 registers were not getting set correctly.

2/11/99 Fixed Tx/Rx queuing routines.  Fixed short frame sends.

12/14/99 Fixed multiboard "received data overflow" interrupt problem
	 Also fixed problems with outstanding read/write/status calls
	 when init is called again.(now all pending read/write/status 
	 calls are canceled prior to a re-init).