Command Reference

v80-smi is the command-line system management interface for AMD Alveo V80 boards. Running v80-smi with no subcommand prints usage help.

Device Addressing

Several commands accept a -d/--device option that takes a BDF (Bus:Device.Function) address. The following formats are supported:

Format

Example

BB:DD (short)

03:00

BB:DD.F (short with function)

03:00.0

DDDD:BB:DD (domain:bus:device)

0000:03:00

DDDD:BB:DD.F (full)

0000:03:00.0

Commands

version

Print the v80-smi version and exit.

v80-smi version [-p|--plain]
-p, --plain

Print only the version in x.y.z format with no prefix. Useful for scripting.

list

Enumerate V80 boards visible on the system and report their readiness status.

v80-smi list [-j|--json] [-J|--pretty-json] [-l|--long] [-s|--sensors]
-j, --json

Output as compact JSON.

-J, --pretty-json

Output as indented JSON.

-l, --long

Include additional information (PCI IDs, driver status).

-s, --sensors

Include sensor readings (temperature, power). Requires the vrtd daemon to be running.

inspect

Display metadata from a vrtbin file on disk without programming it onto a device.

v80-smi inspect <vbin> [-j|--json] [-J|--pretty-json]
vbin

Path to the vrtbin file. Required.

-j, --json

Output as compact JSON.

-J, --pretty-json

Output as indented JSON.

query

Display the metadata of the vrtbin currently loaded on a device.

v80-smi query -d <BDF> [-j|--json] [-J|--pretty-json]
-d, --device <BDF>

Board address. Required.

-j, --json

Output as compact JSON.

-J, --pretty-json

Output as indented JSON.

program

Load a vrtbin file onto a device, programming the FPGA.

v80-smi program <vbin> -d <BDF>
vbin

Path to the vrtbin file. Required.

-d, --device <BDF>

Board address. Required.

reset

Perform a hardware reset of a V80 board. This executes a full PCIe secondary bus reset and rescan (hotplug) sequence.

v80-smi reset -d <BDF>
-d, --device <BDF>

Board address. Required.

validate

Run memory integrity and bandwidth tests against a board’s HBM and DDR subsystems.

v80-smi validate -d <BDF> [-j|--threads <N>]
-d, --device <BDF>

Board address. Required.

-j, --threads <N>

Number of parallel buffers/threads for the validation test (1–64, default 8).

debug

Low-level troubleshooting commands.

debug bar-poke

Read or write BAR words.

v80-smi debug bar-poke -d <BDF> -b <BAR> (-r|--read | -w|--write) [-x|--hex] [-W|--word-size <N>] [-c|--count <N>] <address> [value]
-d, --device <BDF>

Board address. Required.

-b, --bar <BAR>

BAR number (0-5). Required.

-r, --read

Read mode.

-w, --write

Write mode.

-x, --hex

Print read output in hexadecimal.

-W, --word-size <N>

Access width in bytes: 1, 2, 4, or 8 (default 4).

-c, --count <N>

Number of words to read (default 1; must be 1 for write).

Rules:

  • Exactly one of --read or --write must be provided.

  • value is required for write and forbidden for read.

  • address is a BAR-relative byte offset.

debug mem-poke

Read or write device memory at a raw physical address. This bypasses the allocator and requires raw-mem-access permission in vrtd.

v80-smi debug mem-poke -d <BDF> (-r|--read | -w|--write) [-x|--hex] [-W|--word-size <N>] [-c|--count <N>] <address> [value] [-f|--file <path>]
-d, --device <BDF>

Board address. Required.

-r, --read

Read mode.

-w, --write

Write mode.

-x, --hex

Hex mode.

  • Read-to-stdout: prints values in hexadecimal.

  • With --file: treats file payload as hex text/hexdump format.

-W, --word-size <N>

Access width in bytes: 1, 2, 4, or 8 (default 4).

-c, --count <N>

Number of words to transfer (default 1).

-f, --file <path>

File mode transfer path.

  • In read mode: destination file.

  • In write mode: source file.

Rules:

  • Exactly one of --read or --write must be provided.

  • address is a device physical address.

  • word-size must be 1, 2, 4, or 8.

  • count must be greater than zero.

  • Scalar mode (no --file): - write requires value and forces count == 1 - read forbids value - address must be aligned to word-size

  • File mode (--file present): - value is forbidden - transfer size is exactly word-size * count bytes - with --hex file is text hex/hexdump; without --hex file is raw binary

debug clockwiz

Read or set clock rate for a device clock region using vrtd clock-op.

v80-smi debug clockwiz -d <BDF> (--get | --set <rate_hz>) [--region <user|service>] [-x|--hex]
-d, --device <BDF>

Board address. Required.

--get

Read current clock rate for selected region.

--set <rate_hz>

Set requested clock rate in Hz for selected region.

--region <user|service>

Clock region selector (default: user).

-x, --hex

Print --get output in hexadecimal.

Rules:

  • Exactly one of --get or --set must be provided.

  • --set value is in Hz and must be greater than zero.

  • --hex is valid only with --get.

  • --set prints requested and achieved frequencies.