%%alias%%
USAGE:		
	alias <alias-name, command-name>  

ARGUMENTS:	
	alias-name	(string < 38 char)
	command-name	(a vmeio command-name)

DESCRIPTION:
	Defines an alias for a command within the diagnostics.  It protects
        users from using an existing alias-name or command-name as an alias
	for another command.

RELATED COMMANDS:	
	list-commands
	help list-commands

%%help%%
USAGE:		
	help <command-name>

ARGUMENTS:	
	command-name

DESCRIPTION:
	If any command name available in the diagnostic is supplied as an
	argument to 'help' command, it will give information on usage
	of that command. Otherwise it will give this printout.

	- To get command names available in the diagnostic, just enter
	  'list-commands' at the prompt.

	- Use 'whatis' command to get a description of commands available.

RELATED COMMANDS:	
	list-commands
	whatis

%%list-commands%%
USAGE:		
	list-commands

DESCRIPTION:	
	Displays commands available to user on screen.  The screen output
        is piped through UNIX 'more' command.

RELATED COMMANDS:
	help
	whatis

%%list-groups%%
USAGE:		
	list-groups

DESCRIPTION:	
	Displays on the screen tests available to user organized into groups
        by similar.   The screen output is piped through UNIX 'more' command.

RELATED COMMANDS:
	help
	whatis

%%set-diag-environment%%
USAGE:
	set-diag-environment

ARGUMENTS:	
	They are supplied interactively.

DESCRIPTION:
	Sets or resets global variables in the diagnostics program to provide
	the desired environment for the user. Default values are shown
	in brackets.

	Loop-forever   = [OFF]
	   Used to loop on the test forever (scope loops) when ON.

	Ignore-errors  = [OFF]
	   Stops the diagnostic from printing errors when ON.

	Halt-on-error  = [OFF]
	   Used to abort the test if an error occurs when ON.

	Break-on-error = [ON]
	   Used to stop the test with option to continue from that point if
	   an error occurs when ON.

	Loop-on-error  = [OFF]
	   Used to loop on the error detected by diagnostics when ON.

	Log-errors     = [ON]
           Writes error messages to the file './diag-error-log' when ON.

        Display_trace  = [OFF]
           Display progress messages on the screen as the test is running
           when ON.

        Display_error_count = [16]
           When this number is exceeded, only the message 'FAILED' is
           printed on the screen.

RELATED COMMANDS:
	show-diag-environment

%%show-all-errors%%
USAGE:		
	show-all-errors

DESCRIPTION:
	Displays a summery of error log for all the test which have failures.
	It includes test-name, error count and latest error message.


RELATED COMMANDS:
	set-diag-environment

%%show-diag-environment%%
USAGE:		
	show-diag-environment

DESCRIPTION:
	Shows current state of all diagnostics flag set by
	set-diag-environment. (default values are shown in brackets) 

	Loop-forever   = [OFF]
	Ignore-errors  = [OFF]
	Halt-on-error  = [OFF]
	Break-on-error = [ON]
	Loop-on-error  = [OFF]
        Log-errors     = [ON]
        Display_trace  = [OFF]
        Display_error_count = [16]


RELATED COMMANDS:
	set-diag-environment

%%whatis%%
USAGE:
	whatis <command>

ARGUMENTS:
	command		name of any diagnostic command

DESCRIPTION:
	Provides help on all interactive commands in the diagnostic.

RELATED COMMANDS:
	help

%%display-board-status%%
USAGE:		
	display-board-status

DESCRIPTION:
	Shows the state of all the bits in all the registers of the VMEIO
	using text to describe the states (eg. ON, ENABLED, EMPTY).
	
RELATED COMMANDS:
	display-cmio-status

%%set-training-mode%%
USAGE:		
	set-training-mode

DESCRIPTION:
	This mode forces a test to pretend that it has an error so that
	every possible error message is displayed on the screen.  This
 	allows a novice user the ability to study the test with an
	experienced user who can describe what could be the actual cause
	of the failure if this error occurs under real conditions.
	These messages describe what the test is about to do.  This mode
	stays in effect until 'clear-training-mode' is entered at the prompt.

RELATED COMMANDS:
	clear-training-mode

%%clear-training-mode%%
USAGE:		
	clear-training-mode                   

DESCRIPTION:
	Clears the environment variable set by 'set-training-mode'.

RELATED COMMANDS:
	set-training-mode

%%display-cmio-status%%
USAGE:		
	display-cmio-status

DESCRIPTION:
	Shows the state of all the bits in all the registers of the VMEIO
	associated with the CMIO bus using text to describe the states
	(eg. ON, ENABLED, EMPTY).

RELATED COMMANDS:
	display-board-status

%%display-dram-contents%%
USAGE:		
	display-dram-contents                 

ARGUMENTS:
 	'word_count'   = 32-bit, decimal
 	'offset'       = 64-bit, decimal

DESCRIPTION:
	Displays the contents of the VMEIO RAM as 32 bit words.  The offset
	argument is relative to the beginning of the RAM.  An offset of 0
	starts the display at the first location of memory.

RELATED COMMANDS:
	read-pmem-block
	read-pmem-long
	read-vmem-byte
	read-vmem-block

%%search-dram-contents%%
USAGE:		
	search-dram-contents

ARGUMENTS:
 	'pattern'      = 32-bit, hex
 	'offset'       = 32-bit, decimal
 	'upper'        = 32-bit, decimal

DESCRIPTION:
	This command will search the VMEIO RAM for a 32 bit pattern.

%%display-fifo-status%%
USAGE:		
	display-fifo-status                   

DESCRIPTION:
	Displays the status of the CMIO Input FIFOs on the screen in text.

RELATED COMMANDS:
	display-ram-fifo-contents
	display-cmio-status
	display-board-status

%%display-interrupt-status%%
USAGE:		
	display-interrupt-status

DESCRIPTION:
	Displays the state of the VME STATUS register's bits 0 - 8 in text.

RELATED COMMANDS:
	display-board-status
	display-cmio-status

%%display-ram-fifo-contents%%
USAGE:		
	display-ram-fifo-contents             

ARGUMENTS:
 	'word_count'   = 32-bit, decimal
 	'offset'       = 32-bit, decimal

DESCRIPTION:
	Displays the contents of the VMEIO RAM starting at the relative
	offset.

RELATED COMMANDS:
	display-dram-contents

%%display-ram-status%%
USAGE:		
	display-ram-status

DESCRIPTION:
	Displays the state of the RAM fifo flags and the contents of the
	READ Pointer, the WRITE pointer, and the WORD counter.

RELATED COMMANDS:
	display-board-status

%%cmio-read-register%%
USAGE:		
	cmio-read-register                    

ARGUMENTS:
 	'backplane_mask' = hex
 	'board'          = hex
 	'address'        = hex

DESCRIPTION:
	This command will allow one to read the registers on the CMIOC if
	one is attached to a CM.

%%quit%%
USAGE:		
	quit

DESCRIPTION:
	Exit the diagnostic.

%%read-pmem-block%%
USAGE:		
	read-pmem-block

ARGUMENTS:
 	'address'      = hex
 	'word_count'   = decimal

DESCRIPTION:
	Returns 'word_count' 32 bit data from the VMEIO's memory using
	'address' as the starting physical addess into the VMEIO's extended
	memory space.

RELATED COMMANDS:
	read-pmem-long

%%read-pmem-long%%
USAGE:		
	read-pmem-long

ARGUMENTS:
 	'address'      = hex

DESCRIPTION:
	Returns 32 bit data from the VMEIO's memory using 'address' as a
	physical addess into the VMEIO's extended memory space.

RELATED COMMANDS:
	read-pmem-block

%%read-register%%
USAGE:		
	read-register

ARGUMENTS:
 	'address'      = hex

DESCRIPTION:
	This function returns the contents of the VMEIO I/O register as
	specified by 'address'.

RELATED COMMANDS:
	write-register

%%read-vmem-block%%
USAGE:		
	read-vmem-block                       

ARGUMENTS:
 	'address'      = hex
 	'word_count'   = decimal

DESCRIPTION:
	Displays VMEIO RAM starting at relative address.  This command	
	accesses memory from the VME extended address space.

RELATED COMMANDS:
	read-vmem-byte

%%read-vmem-byte%%
USAGE:		
	read-vmem-byte

ARGUMENTS:
 	'address'      = hex

DESCRIPTION:
	Displays the byte value at relative RAM address. This command
	access memory from the VME extended address space.

RELATED COMMANDS:
	read-vmem-block

%%reset%%
USAGE:		
	reset

DESCRIPTION:
	This function clears the VMIO registers, initializes the CMIO bus IDs,
	enables the CMIO TIMER ERROR Interrupt, and enables the CMIO input
 	FIFO.

%%test-leds%%
USAGE:		
	test-leds                             

ARGUMENTS:
 	'Repeat_count' = 0 to 65535

DESCRIPTION:
	Causes the LEDs to blink SOS the number of times specified by
	'Repeat_count'. This is an INTERACTIVE command and will not be
	included in the regression unless the -i option is used.

%%test-vme-setup-bits-with-scope%%
USAGE:		
	test-vme-setup-bits-with-scope

DESCRIPTION:
	This test is used to test bits 0 - 20 of the VME SETUP register.
	A walking one pattern is used to test each bit and the user
	is asked to check the value of the bit with a scope.  This is an
	INTERACTIVE command and will not be included in the regression unless
	the -i option is used.

%%test-vme-data-bus%%
USAGE:		
	test-vme-data-bus                     

DESCRIPTION:
	This test checks for stuck at faults and shorts on the VME bus and
	internal VM bus by writing and reading walking one's and walking 0's
	to the VME SETUP register.

%%test-cm-data-bus-low%%
USAGE:		
	test-cm-data-bus-low

DESCRIPTION:
	This test checks for stuck at faults and shorts on the lower half of
	the internal CM bus by writing and reading walking one's and walking
	0's to the TEST LOW DATA BUS register.

RELATED COMMANDS:
	test-cm-data-bus-high

%%test-cm-data-bus-high%%
USAGE:		
	test-cm-data-bus-high                 

DESCRIPTION:
	This test checks for stuck at faults and shorts on the upper half of
	the internal CM bus by writing and reading walking one's and walking
	0's to the TEST HIGH DATA BUS register.

RELATED COMMANDS:
	test-cm-data-bus-low

%%test-cmio-data-bus%%
USAGE:		
	test-cmio-data-bus

DESCRIPTION:
	This test checks for stuck at faults and shorts on the CMIO data bus
	by sending and receiving data in loopback mode over the bus.

RELATED COMMANDS:
	test-cmio-port-data-loopback


%%test-cmio-slave-busy-nak%%
USAGE:		
	test-cmio-slave-busy-nak              

DESCRIPTION:
	This test verifys that a CMIO SLAVE will NAK if target selected	when
	its CMIO SLAVE BUSY bit int the CMIO SETUP REGISTER is set.


%%test-cmio-input-empty-flag%%
USAGE:		
	test-cmio-input-empty-flag

ARGUMENTS:
 	'RAM_mode'      = [f]ifo | [m]apped | [b]ypass
 	'byte_count'    = 8-4096 decimal -modulo 8
 	'speed_code'    = 2 - 7

DESCRIPTION:
	This test verifys that the CMIO Input FIFO Empty Flag will change
	state when data is loopbacked through the FIFO.

RELATED COMMANDS:
	test-cmio-input-half-full-flag        

%%test-cmio-input-half-full-flag%%
USAGE:		
	test-cmio-input-half-full-flag        

ARGUMENTS:
	'RAM_mode'     = [f]ifo | [m]apped | [b]ypass
 	'speed_code'   = 2 - 7

DESCRIPTION:
	This test verifys that the CMIO Input FIFO Half Full Flag will change
 	state when enough data is loopbacked to the FIFO to cause it to 
	become half full.  This is done by not emptying the FIFO.

RELATED COMMANDS:
	test-cmio-input-empty-flag

%%test-cmio-no-arbiter-interrupt%%
USAGE:		
	test-cmio-no-arbiter-interrupt

DESCRIPTION:
	This test verifys that the VMEIO will generate an interrupt if the
	'CMIO NO ARBITER' bit is enabled and there is no arbiter on the CMIO
	bus.

%%test-cmio-master-done-interrupt%%
USAGE:		
	test-cmio-master-done-interrupt       

ARGUMENTS:
 	'RAM_mode'     = [f]ifo | [m]apped | [b]ypass
 	'byte_count'   = 8-4096 decimal -modulo 8

DESCRIPTION:
	This test verifys that the VMEIO will generate an interrupt if the
	'CMIO MASTER DONE' bit is enabled and data is loopbacked to the CMIO
	Input FIFO and the FIFOs are then emptied.

RELATED COMMANDS:
	test-cmio-slave-done-interrupt

%%test-cmio-slave-done-interrupt%%
USAGE:		
	test-cmio-slave-done-interrupt

ARGUMENTS:
 	'RAM_mode'     = [f]ifo | [m]apped | [b]ypass
 	'byte_count'   = 8-4096 decimal -modulo 8

DESCRIPTION:
	This test verifys that the VMEIO will generate an interrupt if the
	'CMIO SLAVE DONE' bit is enabled and data is loopbacked to the CMIO
	Input FIFO and the FIFOs are then emptied.

RELATED COMMANDS:
	test-cmio-master-done-interrupt       

%%test-cmio-overflow-timeout-interrupt%%
USAGE:		
	test-cmio-overflow-timeout-interrupt  

ARGUMENTS:
 	'RAM_mode'     = [f]ifo | [m]apped

DESCRIPTION:
	This test verifys that no CMIO TIMER Interrupt is generated during
	DATA TRANSFER cycle since the hardware temporarily disables an
	enabled timer during that cycle.

%%test-cmio-port-data-loopback%%
USAGE:		
	test-cmio-port-data-loopback

ARGUMENTS:
 	'VME_access mode' = [m]aster | [s]lave
 	'RAM_mode'        = [f]ifo | [m]apped | [b]ypass
 	'pattern_name'    = all-zeros | all-ones | alternating | walking-ones |
       		            walking-zeros | marching-ones | marching-zeros |
       		            data-equal-address | ones-and-zeros | random
 	'word_count'      = 2 - 514
 	'speed_code'      = 2 - 7

DESCRIPTION:
	This test loops 'word_count' data of 'pattern_name' over the CMIO bus
	and checks that a CMIO DONE and CMIO SLAVE DONE status is received.
	The data is also compared to check the data bus.

%%test-cmio-port-parity-gen%%
USAGE:		
	test-cmio-port-parity-gen             

DESCRIPTION:
	This test verifys that the CMIO PARITY ERROR in the CMIO SETUP register
	will set if the INVERT CMIO PARITY bit in the CMIO SETUP register is
	set during data loopback.

%%test-cmio-status%%
USAGE:		
	test-cmio-status                      

ARGUMENTS:
 	'speed_code'   =  0 - 7

DESCRIPTION:
	This test verifys the following:
	  * The initial state of the CMIO STATUS bits after reset.
 	  * That each of the CMIO STATUS bits can be set.
	  * CONTROL bus goes through each of it phases.

RELATED COMMANDS:
	test-cmio-status-latches-control-bus-on-exp

%%test-cmio-status-latches-control-bus-on-exp%%
USAGE:		
	test-cmio-status-latches-control-bus-on-exp

ARGUMENTS:
 	'speed_code'   = 2 - 7

DESCRIPTION:
	This test verifys that the CMIO STATUS register can latch
	the CONTROL bus state after an exception.

RELATED COMMANDS:
	test-cmio-status                      

%%test-cmio-setup-reg%%
USAGE:		
	test-cmio-setup-reg                   

DESCRIPTION:
	This test verifys that one can write and read each bit of the CMIO
	SETUP register.

%%test-cmio-target-select-timeout%%
USAGE:		
	test-cmio-target-select-timeout

DESCRIPTION:
	This test verifys that an interrupt will occur if the CMIO TIMER ERROR
	interrupt is enabled and the CMIO MASTER tries to TARGET Select a
	TARGET which doesn't exist.

%%test-command-reg%%
USAGE:		
	test-command-reg                      

DESCRIPTION:
	This test verifys that one can write and read each bit of the VME
	COMMAND register.

%%test-data-overflow-vme-timeout%%
USAGE:		
	test-data-overflow-vme-timeout

DESCRIPTION:
	This test verifys that if a VME TIMEOUT interrupt is enabled, then
	an interupt should occur if a full RAM FIFO is written to through the
	RAM PORT.

RELATED COMMANDS:
	test-data-underflow-vme-timeout

%%test-data-reg%%
USAGE:		
	test-data-reg                         

DESCRIPTION:
	This test verifys that one can write and read each bit of the 
	TEST LOW DATA BUS register and the TEST HIGH DATA BUS register using
	different patterns.

%%test-data-underflow-vme-timeout%%
USAGE:		
	test-data-underflow-vme-timeout

DESCRIPTION:
	This test verifys that if a VME TIMEOUT interrupt is enabled, then
	an interupt should occur if an empty RAM FIFO is read through the
	RAM PORT.

RELATED COMMANDS:
	test-data-overflow-vme-timeout

%%test-ram-loop-master-transfer%%
USAGE:		
	test-ram-loop-master-transfer         

ARGUMENTS:
 	'RAM_mode'        = [f]ifo | [m]apped
 	'pattern_name'    = all-zeros | all-ones | alternating | walking-ones |
                     	    walking-zeros | marching-ones | marching-zeros |
                            data-equal-address | ones-and-zeros | random
 	'byte_count'      = 4-8388608 decimal -modulo 4

DESCRIPTION:
	This test writes and reads data from the VMEIO RAM to the VME memory
	as VME Master.

RELATED COMMANDS:
	test-ram-loop-master-read
	test-ram-loop-master-write            

%%test-ram-loop-master-read%%
USAGE:		
	test-ram-loop-master-read

ARGUMENTS:
 	'RAM_mode'     = [f]ifo | [m]apped
 	'pattern_name' = all-zeros | all-ones | alternating | walking-ones |
                         walking-zeros | marching-ones | marching-zeros |
                         data-equal-address | ones-and-zeros | random
 	'byte_count'   = 4-8388608 decimal -modulo 4

DESCRIPTION:
	This test transfers data from the VME memory to the VMEIO's memory
	as VME Master and then read the data back out of the VMEIO' memory
	through the Extended Address space and compares the data.

RELATED COMMANDS:
	test-ram-loop-master-write            
	test-ram-loop-master-transfer         

%%test-ram-loop-master-write%%
USAGE:		
	test-ram-loop-master-write            

ARGUMENTS:
 	'Ram_mode'      = [f]ifo | [m]apped]
 	'pattern_name'  = all-zeros | all-ones | alternating | walking-ones |
                          walking-zeros | marching-ones | marching-zeros |
                          data-equal-address | ones-and-zeros | random
 	'byte_count'    = 4-8388608 decimal -modulo 4

DESCRIPTION:
	This test transfers data from the VMEIO memory to the VME memory
	through the Extended Address space and then read the data back out
	of the VMEIO' memory as a VME Master and compares the data.

RELATED COMMANDS:
	test-ram-loop-master-read
	test-ram-loop-master-transfer         

%%test-ram-parity-gen%%
USAGE:		
	test-ram-parity-gen

DESCRIPTION:
	This test verifys that the RAM Parity Generators will generate
	Parity Error Status if the parity polarity is inverted.

RELATED COMMANDS:
	test-ram-parity-rams
	test-ram-parity-interrupt             

%%test-ram-parity-interrupt%%
USAGE:		
	test-ram-parity-interrupt             

DESCRIPTION:
	This test verifys that the RAM Parity Generators will generate
	Parity Error Status if the parity polarity is inverted and a RAM
	Parity Interrupt if the interrupt is enabled.
	
RELATED COMMANDS:
	test-ram-parity-rams
	test-ram-parity-gen

%%test-ram-parity-rams%%
USAGE:		
	test-ram-parity-rams

ARGUMENTS:
 	'data_pattern' = hex

DESCRIPTION:
	This test performs a 'Knaizuk' memory test with Parity Enabled.

RELATED COMMANDS:
	test-ram-parity-interrupt             
	test-ram-parity-gen

%%test-ram-port-register%%
USAGE:		
	test-ram-port-register                

DESCRIPTION:
	This test verifys that the RAM PORT can be written to and read from
	by using various patterns.

%%test-fifo-ram-slave-wr-slave-rd%%
USAGE:		
	test-fifo-ram-slave-wr-slave-rd

ARGUMENTS:
 	'pattern_name'  = all-zeros | all-ones | alternating | walking-ones |
                          walking-zeros | marching-ones | marching-zeros |
                          data-equal-address | ones-and-zeros | random
 	'transfer_size' = 4-8388608, modulo 4 - decimal

DESCRIPTION:
	This test will put the VMEIO RAM into FIFO mode and write and read
	'transfer_size' words to the the RAM PORT using the 'pattern_name'.
	This is done as a VME Slave.

%%test-mapped-ram%%
USAGE:		
	test-mapped-ram                       

ARGUMENTS:
 	'data_pattern' = hex

DESCRIPTION:
	This test performs a 'Knaizuk' memory test using the 'data_pattern'.
	If there is a data miscompare while writing and reading from the RAMs,
	the test will try to determine if its an Addressing or Data problem
	and print out the location of the potentially bad device.

%%test-master-wr-shutoff-on-fifo-empty%%
USAGE:		
	test-master-wr-shutoff-on-fifo-empty

ARGUMENTS:
 	'RAM_mode'     = [f]ifo | [m]apped

DESCRIPTION:
	This test transfers twice as much data as there is data in the RAM
	and verifys that the VME Master does not indicate a Master Done
	Status.

%%test-ram-fifo-empty-flag%%
USAGE:		
	test-ram-fifo-empty-flag              

DESCRIPTION:
	This test writes and read from the VMEIO RAM FIFO and verifys that
	the RAM FIFO Empty Flag toggles.

RELATED COMMANDS:
	test-ram-fifo-full-flag

%%test-ram-fifo-full-flag%%
USAGE:		
	test-ram-fifo-full-flag

DESCRIPTION:
	This test presets the VMEIO RAM counters and then writes and read
	the RAM FIFO to verify that the RAM FIFO FULL Flag toggles.

RELATED COMMANDS:
	test-ram-fifo-empty-flag              

%%test-read-pointer-reg%%
USAGE:		
	test-read-pointer-reg                 

DESCRIPTION:
	This test verifys that the various patterns can be written to and
	read from the RAM READ POINTER register.

%%test-read-pointer-increment%%
USAGE:		
	test-read-pointer-increment

ARGUMENTS:
 	'mem_offset'   = 0-100000, hex
 	'byte_count'   = 4-800000, modulo 4 -hex
 	'RAM_mode'     = [f]ifo | [m]apped

DESCRIPTION:
	This test verifys that the RAM READ POINTER register will increment
 	by loading a value into the register, reading from the TEST RAM
	POINTER register twice, and reading out the value of the RAM READ
	POINTER. It does this for all four BLOCK sizes.  The test also load
	'mem_offset' into the RAM READ POINTER, 'byte_count' into the VME
	BYTE COUNT register, and read from the TEST RAM POINTER the
	appropriate number of times.  Then the value of RAM READ POINTER is
	checked.
	
RELATED COMMANDS:
	test-write-pointer-increment

%%test-self-target-select%%
USAGE:		
	test-self-target-select               

DESCRIPTION:
	This test sets the Station ID equal to the Target ID and loopbacks
	back data over the CMIO bus.  It does this for each of the 16
	Station IDs.

%%test-sender-id-check%%
USAGE:		
	test-sender-id-check

DESCRIPTION:
	This test sets the Sender ID to each of 16 values and tries to
 	loopback data over the CMIO bus.  If the Sender ID matches the
	Station ID, then the test makes sure that the bus wasn't NAKed. If
	the Sender ID is different from the Station ID, then the test
	makes sure that the CMIO bus was NAKed.

%%test-setup-reg%%
USAGE:		
	test-setup-reg                        

DESCRIPTION:
	This test verifys that the various patterns can be written to and
	read from the VME SETUP register.

%%test-status-reg-after-reset%%
USAGE:		
	test-status-reg-after-reset

DESCRIPTION:
	This test resets the board and then verifys that no interrupt
	status bits are set in the VME STATUS register and that only the
	RAM FIFO EMPTY flag is set.

%%test-unaligned-ram-transfer%%
USAGE:		
	test-unaligned-ram-transfer           

DESCRIPTION:
	This test verifys that the VMEIO memory can be accessed through
	Extended Address space and that unaligned 8 bit and 16 bit data
	transfers can take place.

RELATED COMMANDS:
	test-mapped-ram

%%test-vio-master-read-vme-timeout%%
USAGE:		
	test-vio-master-read-vme-timeout

ARGUMENTS:
 	'RAM_mode'     = [f]ifo | [m]apped

DESCRIPTION:
	This test verifys that the VMEIO will generate a VME TIMEOUT
	if the VME MASTER interface is told to transfer too much data
	into the RAM.

RELATED COMMANDS:
	test-vio-master-write-vme-timeout     

%%test-vio-master-write-vme-timeout%%
USAGE:		
	test-vio-master-write-vme-timeout     

ARGUMENTS:
 	'RAM_mode'     = [f]ifo | [m]apped

DESCRIPTION:
	This test verifys that the VMEIO will generate a VME TIMEOUT
	if the VME MASTER interface is transfer more data than is in the
	RAM FIFO.

%%test-vme-address-generator%%
USAGE:		
	test-vme-address-generator

ARGUMENTS:
 	'vme_address'    = hex
 	'byte_count'     = 4-8388608, modulo 4 -decimal
 	'RAM_mode'       = [f]ifo | [m]apped

DESCRIPTION:
	This test verifys that the VME ADDRESS GENERATOR register will
	increment by loading a value into the register, writing to the TEST
	VME ADDRESS COUNTER register, and reading out the value of the VME
	ADDRESS COUNTER. The test also load 'vme_address' into the VME ADDRESS
	COUNTER, 'byte_count' into the VME BYTE COUNT register, and write to
	the TEST VME ADDRESS COUNTER the appropriate number of times.  Then
 	the value of VME ADDRESS COUNTER is checked.

%%test-vme-address-gen-master-rd%%
USAGE:		
	test-vme-address-gen-master-rd        

ARGUMENTS:
 	'byte_count'     = 4-64512, modulo 4 -decimal
 	'RAM_mode'       = [f]ifo | [m]apped

DESCRIPTION:
	This test transfers 'byte_count' patterns from the VME memory
	to the VMEIO RAM as VME Master and then the VME ADDRESS COUNTER
	and the VME BYTE COUNTER are then checked to make sure they are
	the correct values.

RELATED COMMANDS:
	test-vme-address-gen-master-wr

%%test-vme-address-gen-master-wr%%
USAGE:		
	test-vme-address-gen-master-wr

ARGUMENTS:
 	'byte_count'     =  4-64512, modulo 4 -decimal
 	'RAM_mode'       = [f]ifo | [m]apped

DESCRIPTION:
	This test transfers 'byte_count' patterns into the VMEIO RAM through
	the RAM PORT and then transfers it out to VME memory as VME Master.
	The VME ADDRESS COUNTER and the VME BYTE COUNTER are then checked
	to make sure they are the correct values.

RELATED COMMANDS:
	test-vme-address-gen-master-rd        

%%test-vme-address-reg%%
USAGE:		
	test-vme-address-reg

DESCRIPTION:
	This test verifys that one can write and read each bit of the 
	VME ADDRESS COUNTER register by using different patterns.

%%test-vme-count-reg%%
USAGE:		
	test-vme-count-reg

DESCRIPTION:
	This test verifys that one can write and read each bit of the 
	VME BYTE COUNTER register by using different patterns.


%%test-vme-master-done-interrupt%%
USAGE:		
	test-vme-master-done-interrupt        

ARGUMENTS:
	'vmeio_byte_count'  =  4-64512, modulo 4 -decimal

DESCRIPTION:
	This test transfers data from VME memory to the VMEIO RAM as VME
	Master while the VME MASTER Interrupt is enabled and verifys that the
	interrupt is received when the transfer is complete.

%%test-data-transfer-vmeio-to-from-cmioc%%
USAGE:		
	test-data-transfer-vmeio-to-from-cmioc

ARGUMENTS:
 'VME_access_mode' = [m]aster | [s]lave
 'direction'       = [v]meio-to-cmioc | [c]mioc-to-vmeio |
                     [r]ound trip from vmeio-to-cmioc-to-vmeio
 'RAM_mode'        = [b]ypass | [m]apped | [f]ifo
 'pattern_name'    = all-zeros | all-ones | alternating | walking-ones |
                     walking-zeros | marching-ones | marching-zeros |
                     data-equal-address | ones-and-zeros | random
 'super_count'     = 1 to 2016 superwords  for VME Master: vmeio -> cmioc |
                     1 to 8    superblocks for VME Slave:  vmeio -> cmioc |
                     1 to 16   superblocks for VME Master: cmioc -> vmeio |
                     1 to 4    superblocks for VME Slave:  cmioc -> vmeio |
                     1 to 32   superblocks for VME Master: round trip |
                     1 to 4    superblocks for VME Slave:  round trip
 'speed_code'      = 2 - 7


DESCRIPTION:
	This test is used to check the integrity of the CMIO bus between
	the VMEIO and a CM.  Both the VMEIO and the VBI interfaces must
	reside in the same backplane.  When the direction is 'v', the
	data is sent from the VMEIO to the CM over the CMIO bus, read
	back via the VBI and the data compared. When the direction is 'c',
	the data is sent to the CM via the VBI, read back into the VMEIO
	from the CMIO bus, and then the data is compared.  When the direction
	is 'r' the data is sent and received over the CMIO bus.

%%test-vmeio-exception-generation%%
USAGE:		
	test-vmeio-exception-generation       

DESCRIPTION:
	This test verifys that it can generate an Exception to the CMIO
	BU when connected to a CM.

RELATED COMMANDS:
	test-vmeio-exception-reception        

%%test-vmeio-exception-reception%%
USAGE:		
	test-vmeio-exception-reception        

DESCRIPTION:
	This test verifys that it can receive an Exception from the CMIO
	BU when connected to a CM.

RELATED COMMANDS:
	test-vmeio-exception-generation       

%%test-vmeio-generate-exception-interrupt%%
USAGE:		
	test-vmeio-generate-exception-interrupt

DESCRIPTION:
	This test forces an Exception while looping data to itself over the
	CMIO bus and then verifys that it received the Exception interrupt.

RELATED COMMANDS:
	test-vmeio-received-exception-interrupt

%%test-vmeio-received-exception-interrupt%%
USAGE:		
	test-vmeio-received-exception-interrupt

DESCRIPTION:
	This test verifys that the VMEIO can receive an exception from the
	CM while connected to it.

RELATED COMMANDS:
	test-vmeio-generate-exception-interrupt

%%test-vmeio-slaveship%%
USAGE:		
	test-vmeio-slaveship                  

ARGUMENTS:
 	'RAM_mode'      = [f]ifo | [m]apped | [b]ypass
 	'speed_code'    = 2 - 7

DESCRIPTION:
	This test verifies that the SLAVE ACTIVE bit is asserted during
	a transfer from the CM to the VMEIO.

%%test-vmeio-master-status-write-mode%%
USAGE:		
	test-vmeio-master-status-write-mode

ARGUMENTS:
 	'vmeio_byte_count'  = 4-64512, modulo 4 -decimal

DESCRIPTION:
	This test verifys that VME DONE status is set after 'vmeio_byte_count'
	bytes are transfered from the VMEIO RAM as VME Master.

RELATED COMMANDS:
	test-vmeio-master-status-read-mode    

%%test-vmeio-master-status-read-mode%%
USAGE:		
	test-vmeio-master-status-read-mode    

ARGUMENTS:
 	'vmeio_byte_count'  = 4-64512, modulo 4 -decimal

DESCRIPTION:
	This test verifys that VME DONE status is set after 'vmeio_byte_count'
	bytes are transfered to the VMEIO RAM as VME Master.

RELATED COMMANDS:
	test-vmeio-master-status-write-mode

%%test-word-count-reg%%
USAGE:		
	test-word-count-reg

DESCRIPTION:
	This test verifys that one can write and read each bit of the 
	RAM WORD COUNTER register by using different patterns.

%%test-write-pointer-reg%%
USAGE:		
	test-write-pointer-reg                

DESCRIPTION:
	This test verifys that one can write and read each bit of the 
	RAM WRITE POINTER register by using different patterns.

%%test-write-pointer-increment%%
USAGE:		
	test-write-pointer-increment

ARGUMENTS:
 	'mem_offset'     = 0-100000, hex
 	'byte_count'     = 4-800000, modulo 4 -hex
 	'RAM_mode'       = [f]ifo | [m]apped

DESCRIPTION:
	This test verifys that the RAM WRITE POINTER register will increment
 	by loading a value into the register, writing to the TEST RAM
	POINTER register twice, and reading out the value of the RAM READ
	POINTER. It does this for all four BLOCK sizes.  The test also load
	'mem_offset' into the RAM WRITE POINTER, 'byte_count' into the VME
	BYTE COUNT register, and writes to the TEST RAM POINTER the
	appropriate number of times.  Then the value of RAM READ POINTER is
	checked.
	
RELATED COMMANDS:
	test-read-pointer-increment

%%write-pmem-long%%
USAGE:		
	write-pmem-long

ARGUMENTS:
 	'address'       = hex
 	'value'         = hex

DESCRIPTION:
	This function writes 'value' to the VMEIO's memory using 'address'
	as a physical addess into the VMEIO's extended memory space.

RELATED COMMANDS:
	read-pmem-long
	read-pmem-block

%%write-vmem-byte%%
USAGE:		
	write-vmem-byte                       

ARGUMENTS:
 	'address'        = hex
 	'value'          = hex

DESCRIPTION:
	This function writes 'value' to the byte at relative RAM address.
	This command accesses memory from the VME extended address space.

RELATED COMMANDS:
	read-vmem-byte
	read-vmem-block

%%write-register%%
USAGE:		
	write-register

ARGUMENTS:
 	'address'        = hex
 	'value'          = hex

DESCRIPTION:
	This function writes 'value' to the VMEIO I/O register as
	specified by 'address'.

RELATED COMMANDS:
	read-register

%%wr-rd-ver-cmio-setup-reg%%
USAGE:		
	wr-rd-ver-cmio-setup-reg

ARGUMENTS:
 	'value'          = hex

DESCRIPTION:
	This test verifys that the `value` can be written to and read from the
	CMIO SETUP register.
	
%%wr-rd-ver-command-reg%%
USAGE:		
	wr-rd-ver-command-reg                 

ARGUMENTS:
        'value'          = hex 
 
DESCRIPTION:
	This test verifys that the `value` can be written to and read from the
	VME COMMAND register.

%%wr-rd-ver-data-reg%%
USAGE:		
	wr-rd-ver-data-reg

ARGUMENTS:
        'value'          = hex

DESCRIPTION:
	This test verifys that the `value` can be written to and read from the
	TEST LOW DATA BUS register and the TEST HIGH DATA BUS register.

RELATED COMMANDS:
%%wr-rd-ver-ram-port-reg%%
USAGE:		
	wr-rd-ver-ram-port-reg                

ARGUMENTS:
        'value'          = hex 
 
DESCRIPTION:
	This test verifys that the `value` can be written to and read from the
	RAM PORT register.

%%wr-rd-ver-setup-reg%%
USAGE:		
	wr-rd-ver-setup-reg

ARGUMENTS:
        'value'          = hex 

DESCRIPTION:
	This test verifys that the `value` can be written to and read from the
	VME SETUP COUNTER register.

%%wr-rd-ver-vme-address-reg%%
USAGE:		
	wr-rd-ver-vme-address-reg             

ARGUMENTS:
        'value'          = hex 

DESCRIPTION:
	This test verifys that the `value` can be written to and read from the
	VME ADDRESS COUNTER register.

%%wr-rd-ver-vme-count-reg%%
USAGE:		
	wr-rd-ver-vme-count-reg

ARGUMENTS:
        'value'          = hex 

DESCRIPTION:
	This test verifys that the `value` can be written to and read from the
	VME BYTE COUNTER register.

%%wr-rd-ver-word-count-reg%%
USAGE:		
	wr-rd-ver-word-count-reg              

ARGUMENTS:
	'value'          = hex

DESCRIPTION:
	This test verifys that the `value` can be written to and read from the
	RAM WORD COUNTER register.

%%wr-rd-ver-write-pointer-reg%%
USAGE:		
	wr-rd-ver-write-pointer-reg

ARGUMENTS:
 	'value'          = hex

DESCRIPTION:
	This test verifys that the `value` can be written to and read from the
	RAM WRITE POINTER register.
