			Applied MicroCircuits Corporation
				6195 Lusk Blvd.
			      San Diego, CA 92121


This file includes notes on the software and other files included with 
the AMCC PCI Developer's Kit.  Supplemental information on using the 
AMCCDIAG and NVBUILD software is also included in this file.

-------------------------------------------------------------------------------
PLD equations for U1 and U4 on the PCI card and IU3 on the ISA card have 
changed:  

	The CUPL .PLD files are included in the \PLDS directory along with 
	PLD_DOC.TXT.  The PLD_DOC.TXT explains the detailed functionality of 
	all of the Developer's Kit programmable logic devices.

Using the 29C512 Flash memory with the S5933 developer's kit:

	There are two versions of the program called NVBUILD.EXE 
	included with the Developer's Kit.  Version 0.5 should be used
	for programming 29C512 or 29C256 Flash memories and version
	1.0 should be used for programming serial devices or operating
	on files.  Only version 1.0 can access the S5933 operation
	registers when they are mapped to memory space above 1 megabyte.
	
	Known problems with NVBUILD.EXE:
	The program NVBUILD.EXE v1.0 reads but does not program
	the Atmel 29C256 and 29C512 flash memories.  Version 1.0
	will fail and exit if the [F5] key is pressed to select
	options for choosing the sub-class field when editing the
	configuration header space.
	
	The program NVBUILD.EXE v0.5 programs the Atmel 29C512
	Flash memory provided in the developer's kit, however,
	the WE# pin (pin 31) of the 29C512 must be disconnected
	from the S5933 in order to permit the 29C512 to be bootable.
	This is accomplished by removing the 29C512 from the 
	socket and then reinserting it with pin 31 lifted.  This 
	procedure is necessary due to the pulsing of the shared 
	signal WE#/SDA on the S5933 when the S5933 initially 
	searches for a serial device.


Installing the Developer's Kit hardware into a PC:

	The Developer's Kit does not contain an ISA slot bracket. 
	Other than for shipping purposes within the machine,
	the ISA board may still be installed.


Developer's Kit User's Guide Errata:

	The Program PCIDIAG.EXE is referred to in the documentation.
	This program is actually named AMCCDIAG.EXE on the diskette
	included with the developer's kit.  To use AMCCDIAG.EXE you
	must have the line
	
		DEVICE=C:\DOS\ANSI.SYS
	
	within your system's config.sys file.

Merging a file in NVBUILD.EXE:

	a. Create the configuration register space by either loading 
	   an Intel Hex or Binary file that contains a previously 
	   defined image, or just edit the default image that is 
	   defined at program startup.
 
	b. Select "Save Memory Image" on Main Menu
 
	c. Select "Merge with File"
 
	d. Select Intel Hex or Binary file to merge current image with.
 
	e. The file is loaded and the current image overwrites the 
	   area from 0x40 to 0x80 and a checksum is generated at the
	   location: 
			(Image_Byte_2 * 512) - 1
       
	   The merged image is then saved to the original filename and
	   the previous disk image backed up in a file with the same 
	   name and an extension of ".BAK".
 
	f. The merged file is now also in memory, so you can proceed 
	   to select "Write to Device" to program NVRAM.
 

Files for the developer's kit:

\SCH\*.SCH      ;OrCAD Schematic Files
     *.BOM      ;Bill of Materials File (TEXT)
     *.LIB      ;OrCAD parts library
     *.NET      ;Netlist (TEXT)
	

\SDTOOLS\AMCCDIAG.EXE   
	 IDFILE.DOC
	 \VER1\NVBUILD.EXE
	       NVBUILD.HLP
	 \VER0\NVBUILD.EXE
	       NVBUILD.HLP

\PLDS\U1DKC.PLD  ;CUPL Program File (TEXT)
      U1DKC.JED  ;JEDEC File
      U1DKC.ABS  ;CUPL Absolute File
      U1DKC.DOC  ;CUPL PLD Information File (TEXT)

      U4DKC.PLD  ;CUPL Program File (TEXT)
      U4DKC.JED  ;JEDEC File
      U4DKC.ABS  ;CUPL Absolute File
      U4DKC.DOC  ;CUPL PLD Information File (TEXT)
 
      IU3A.PLD   ;CUPL Program File (TEXT)
      IU3A.SI    ;CUPL Simulation Input File (TEXT)
      IU3A.JED   ;JEDEC File
      IU3A.SO    ;CUPL Simulation Output File (TEXT)
      IU3A.ABS   ;CUPL Absolute File
      IU3A.DOC   ;CUPL PLD Information File (TEXT)
********************************************************************
		    AMCC PCI Matchmaker(R) Package
			     Version 1.2
	   Copyright 1994, Applied Micro Circuits Corporation


IDFILE.DOC
---------------
This file is read by AMCCDIAG for the vendor and device ids to use to look
for the PCI device. This file must be in the same directory as the AMCCDIAG
software to be located.  If not the program will indicate the PCI
Matchmaker was not found and prompt the user for a Vendor and Device ID
combination.  This is a simple text file that has the following format:
	VID DID

example:
	1234 5678



INFORMATION ON PROGRAM AMCCDIAG.EXE.
-------------------------------------
	
			AMCCDIAG

PURPOSE
---------------------------------------------------
The program is designed to allow the user to interface with the
AMCC PCI Controller. The user can read and write the PCI configuration 
registers. The user can also read and write the S593X operation registers
on both the PCI and add-on interfaces.The user can also run diagnostics 
on the controller to test the integrity of the registers.


OPERATION
---------------------------------------------------
To run the program, type "amccdiag". The program checks for the existance
of a PCI BIOS in the system. If the PCI BIOS is not found, the program 
aborts. If the PCI BIOS is found, the program attempts to identify
all PCI devices that are in the system and display relevant information about
each device (class code, location, type of device, etc.). The program
then searches for the file "IDFILE.DOC," reads the VID and DID from 
that file and uses that information to search for the AMCC PCI controller.
If the file IDFILE.DOC is not found the program uses the default AMCC values 
for the VID and DID. If the AMCC PCI controller is not found using the 
default values the program prompts the user for a new VID and DID to search 
for the device.

Once the AMCC PCI controller is found the program displays the following
menu:

			1. Configuration registers
			2. Operation registers
			3. Diagnostics
			q. Exit


Option 1 
--------------
Configuration Registers:

Displays the contents of all the configuration registers. To write to
a configuration register use the arrow keys to move the cursor to the
register (name displayed on the screen) press "w" and enter the new value
for the register. Writes to read-only registers will be ignored. Only 
writeable bits of read/write registers will be written.

To re-read a register use the arrow keys to move the cursor to the register
and press "r".

Press <ESC> to return to the main menu.


Option 2
--------------
Operation Registers:

Displays the contents of the operation registers. If the ISA add-on board
is installed, the contents of both the PCI and add-on operation registers
are displayed. If both PCI and add-on registers are displayed, the user
can toggle the cursor between both sets of registers by pressing the "F1" key.

To write to an operation register use the arrow keys to move the cursor to the
register (name displayed on the screen) press "w" and enter the new value for
the register. Individual bytes can be written to (0,1,2,3) or individual words
can be written (upper 16 bits, lower 16 bits).  If an 8-bit or 16-bit hex
value is entered, the user will be prompted for this information.

To read a register use the arrow keys to move the cursor to the register
and press "r". To update the value of all the registers at the same time
press "a".

Press <ESC> to return to the main menu.


Option 3
--------------
Diagnostics:

Tests the integrity of the operation registers. Diagnostic tests are run on the 
mailbox registers and the mailbox status register. The FIFO regsiters is also
tested. Any errors that result during the tests are displayed. The FIFO test
will normally not work from a Windows DOS prompt, because the system is operating
in Virtual 86 mode, not Real Mode.


Option 4
--------------
Exit:

Exits the program. The program can be exited by pressing "q" during
any of the above operations.



Files for AMCCDIAG.EXE
--------------------------------

The following four .ASM files make up AMCCDIAG.

AMCCDIAG.ASM
	This file contains the main functions and functions that read 
	and write to operation registers.

PCILIB1.ASM
	Contains the functions that print strings and handle menu display.

PCILIB2.ASM
	Contains the functions that read and write to configuration registers.

PCIDIAG.ASM
	Contains the functions that search for PCI BIOS, search for the AMCC
	MatchMaker, identify all PCI devices in the system, and functions that
	perform the diagnostics.

PCIINCL.INC
	This is an include file that contains the PCI function values, PCI return
	codes, Configuration and Operation and Addon register offsets.

If changes are made to any of these files the file(s) must be compiled and all
four files must be linked to create a new AMCCDIAG.EXE. The files must be
linked as follows:
	Using Borland Turbo Assembler
	tlink amccdiag pcilib1 pcilib2 pcidiag, amccdiag /3



Other source code included in this diskette
-------------------------------------------------
These files are located in the directory SW_DEV:

AMCCLIB.C
	PCI function source code samples in C (Borland).
       
AMCCLIB.H
	Include file for AMCCLIB.C

AMCCLIB.ASM
	PCI function source code samples in Assembly language.



