Xilscript Manual

NAME

xilscript - read, interpret and execute xilinx configuration scripts

SYNOPSIS

xilscript [-e «expression»]* [«scriptname»]*

xilscript -h

xilscript -l

DESCRIPTION

xilscript is used to setup the test memory, configure the xilinx chips, control the output pins and read out the results from the test memory.

xilscript is line-oriented and accepts commands from the command line and from script files.

xilscript will try to determine the size of the input and output memories. If the size it reports does not match your configuration, you are in trouble.

OPTIONS

	-h	Displays usage
	-l	Displays all signal names
	-e	Sends the expression for the interpreter and execution

SCRIPT COMMANDS

# comment
Empty lines and every line starting with a hash mark ('#'), a semicolon (';') or a percent mark ('%') are ignored.

failat «error level»
Failat sets the return code that causes the script to stop execution. Usually 5==warnings, 10==errors, 20==fatal erros.

«signal name» = «signal state»
Sets the signal state. If the corresponding pin is configured to be an input, no change is seen in the pin, but the internal state of the output latch is set.

«signal name»
Reads the signal state. If the corresponding pin is configured to be an input, the state of the pin is displayed, otherwise the state of the output latch is displayed.

configure (flow | clock) «file»
Configures the specified subsystem (the dataflow Xilinxs or the auxiliary Xilinx) with the .bit-format configuration data. (There is a separate xilbitcat program to concatenate the four dataflow Xilinx designs into one .bit-format file.)

input «file»
Reads a file's contents to the input test memory. The clock Xilinx should be inactive at the time.

output «file» «size»
Writes the output test memory contents to a file. The clock Xilinx should be inactive at the time. Size is optional.

delay «10ms»
Waits for the specified number of 10 ms slices.

read «file» «address»
Reads a file contents into DSP memories. See the memory map for the location.

write «file» «address» «size»
Writes DSP memory contents into a file. See the memory map for the location.

load (dsp1 | dsp2) «file»
Loads a COFF executable into the specified DSP. DSP hold and reset signals should be asserted. The program execution begins when the reset and hold signals are deasserted.

All numbers can be entered in either decimal or hexadecimal format. Hexadecimal values have 0x prepended in them.

Syntax errors are 'errors', i.e. they return the error value 10.

If argument values are out of range, these are 'warnings' and they return the error value 5.

Memory allocation errors, Xilinx framing errors and alike are 'fatal'. These return the error value 20.

If the Xilinxs do not go to the DONE-state after the configuration process, error value 10 is returned.

XILINX EXAMPLE

#
# First set the reset state on the clock-xilinx
#
# Reset the clock Xilinx so that we can write to the input memory
xilc_program = 0
# Get some data to the input memory
input test.dat
# Select the dataflow point after the master Xilinx to the output mem
xilc_testsel0 = 1
xilc_testsel1 = 1
# Clock Xilinx 'reset' signal
xilc_tdi
xilc_tdi = 0
# Configure the dataflow
configure flow data.bit
# Check the dataflow status
xil_done
# Configure the clock Xilinx
configure clock clockx_001.bit
# Check its status
xilc_done
# should wait for some time.. 5 = 50ms
delay 5
# Release the reset - clockxilinx will start to feed the dataflow
xilc_tdi = 1
xilc_tdi

DSP EXAMPLE

# Reset DSP1
dsp1_hold = 0
dsp1_reset = 0
# Load the code to DSP1
load dsp1 test
# Let it run the code
dsp1_hold = 1
dsp1_reset = 1
delay 50
# Reset DSP1 so that we can read the memory
dsp1_hold = 0
dsp1_reset = 0
# Write a part of the data memory into a file
write ram:out 0x680000 0x8000