Command Reference
The following commands are available in the shell. For detailed usage of each command, use the help command within the shell or refer to the generated command reference below.
clear
Clear the terminal screen
Synopsis
clear
Description
The current terminal screen is cleared using the host’s operating system’s respective clear command. For Linux, ‘clear’ is used while for NT-based operating systems ‘cls’ is used. On Linux-based systems, the terminal is cleared using direct control commands. If the clearing process fails on either OS, the clear function inserts newline statements to give the appearance of a cleared screen.
Examples
clear
connect
Connect to a XiBIF board
Synopsis
connect IP UUID [OPTIONS]
Options
- -t, --timeout <seconds>
Set the socket timeout in seconds
- -v, --verbose
Connect in verbose mode
Description
connect establishes a connection to a XiBIF board at a given IP address that uses the given UUID. The UUID is bound to a XiBIF project and prevents accidental interference with another board on the same network. The UUID is not a security feature!
Examples
connect 192.168.1.10 0xDEADCAFE
connect 192.168.1.10 0xDEADCAFE --timeout 10 --verbose
disconnect
Disconnect from a XiBIF board
Synopsis
disconnect
Description
disconnect disconnects from an active connection to a XiBIF board if it exists.
Examples
disconnect
exit
Quit the shell
Synopsis
exit
Description
exit is an alias for quit
ping
Ping a XiBIF board
Synopsis
ping OPTIONS
Options
- -c, --count <count>
The number of times to repeat the ping test. Defaults to 3
- -i, --interval <interval>
Time to wait between sending pings to the XiBIF board. Defaults to 1s.
Description
ping tests the connection between the host and a XiBIF board and prints the round-trip-time of the ping to the console. The number of times to repeat the ping test and the interval in between pings can be specified using the appropriate options. When pinging more than once, the minimum, maximum and average RTT per ping are reported.
Examples
ping
ping --count 10 --interval 0.5
quit
Quit the shell
Synopsis
quit
Description
quit closes any existing connection to a XiBIF board and terminates the active shell.
read
Read one or multiple values from a hardware register
Synopsis
read ADDRESS [COUNT]
read REGNAME [COUNT]
read REGNAME.FIELDNAME
read FIELDNAME
Description
read reads one or multiple values from a hardware register on a XiBIF board or a field of such a register. The first argument identifies the register/field to read. If operating on a whole register, the second argument identifies how many following registers should be read. A register may be identified by its address or its name. A field can only be identified by its name. When only a field name is provided the name must be unique for the whole register map.
Examples
read 0
read register
read 0 4
read register 4
read register.field
regmap
Operate on the register map of a XiBIF board
Synopsis
regmap [OPTIONS]
Options
- -p, --print
Print the register map to stdout
- -f, --force
Force load the register map when one is already loaded
Description
regmap loads a register map from a XiBIF board if none is loaded already. The register map can be reloaded forcefully by specifying the appropriate flag.
Examples
regmap
regmap --force
regmap --print
reset
Reset the PL system of the XiBIF board
Synopsis
reset
Description
reset performs a reset operation on the programmable logic part of a connected XiBIF board.
Examples
reset
status
Read and print board status
Synopsis
status
Description
status reads status information from a XiBIF board and prints the status to stdout of the active console.
Examples
status
unwatch
Stop watching a register
Synopsis
unwatch REGNAME
unwatch REGNAME.FIELDNAME
unwatch FIELDNAME
Description
unwatch stops observing a register that is currently being observed by terminating the background thread periodically reading the observed registers.
Examples
unwatch register
unwatch register.field
unwatch field
watch
Observe a register
Synopsis
watch REGNAME [INTERVAL]
watch REGNAME.FIELDNAME [INTERVAL]
watch FIELDNAME [INTERVAL]
Description
watch periodically reads a register to print a notification as soon as the specified register/field value changes. The register read task is added as a background thread and triggers at the specified interval.
All background threads are terminated when the connection is closed.
Examples
watch register
watch register 0.1
watch register.field
watch field 0.1
write
Write values to a hardware register
Synopsis
write ADDRESS VALUE
write REGNAME VALUE
write REGNAME.FIELDNAME VALUE
write FIELDNAME VALUE
Description
write writes a value to a hardware register on a XiBIF board The first argument of the command identifies the register to write, the second argument specifies the value to write. The first argument can either be a register address or the name of a register/register field. If only a field name is provided, it must be unique in the register map.
Examples
write 0 12
write register 12
write register.field 12
write field 12