.. comment:: SPDX-License-Identifier: MIT comment:: Copyright (C) 2025 Advanced Micro Devices, Inc ##################### 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: .. list-table:: :header-rows: 1 :widths: 30 30 * - 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. .. code-block:: text v80-smi version [-p|--plain] .. option:: -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. .. code-block:: text v80-smi list [-j|--json] [-J|--pretty-json] [-l|--long] [-s|--sensors] .. option:: -j, --json Output as compact JSON. .. option:: -J, --pretty-json Output as indented JSON. .. option:: -l, --long Include additional information (PCI IDs, driver status). .. option:: -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. .. code-block:: text v80-smi inspect [-j|--json] [-J|--pretty-json] .. option:: vbin Path to the vrtbin file. **Required.** .. option:: -j, --json Output as compact JSON. .. option:: -J, --pretty-json Output as indented JSON. query ----- Display the metadata of the vrtbin currently loaded on a device. .. code-block:: text v80-smi query -d [-j|--json] [-J|--pretty-json] .. option:: -d, --device Board address. **Required.** .. option:: -j, --json Output as compact JSON. .. option:: -J, --pretty-json Output as indented JSON. program ------- Load a vrtbin file onto a device, programming the FPGA. .. code-block:: text v80-smi program -d .. option:: vbin Path to the vrtbin file. **Required.** .. option:: -d, --device Board address. **Required.** reset ----- Perform a hardware reset of a V80 board. This executes a full PCIe secondary bus reset and rescan (hotplug) sequence. .. code-block:: text v80-smi reset -d .. option:: -d, --device Board address. **Required.** validate -------- Run memory integrity and bandwidth tests against a board's HBM and DDR subsystems. .. code-block:: text v80-smi validate -d [-j|--threads ] .. option:: -d, --device Board address. **Required.** .. option:: -j, --threads 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. .. code-block:: text v80-smi debug bar-poke -d -b (-r|--read | -w|--write) [-x|--hex] [-W|--word-size ] [-c|--count ]
[value] .. option:: -d, --device Board address. **Required.** .. option:: -b, --bar BAR number (0-5). **Required.** .. option:: -r, --read Read mode. .. option:: -w, --write Write mode. .. option:: -x, --hex Print read output in hexadecimal. .. option:: -W, --word-size Access width in bytes: 1, 2, 4, or 8 (default 4). .. option:: -c, --count 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. .. code-block:: text v80-smi debug mem-poke -d (-r|--read | -w|--write) [-x|--hex] [-W|--word-size ] [-c|--count ]
[value] [-f|--file ] .. option:: -d, --device Board address. **Required.** .. option:: -r, --read Read mode. .. option:: -w, --write Write mode. .. option:: -x, --hex Hex mode. - Read-to-stdout: prints values in hexadecimal. - With ``--file``: treats file payload as hex text/hexdump format. .. option:: -W, --word-size Access width in bytes: 1, 2, 4, or 8 (default 4). .. option:: -c, --count Number of words to transfer (default 1). .. option:: -f, --file 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. .. code-block:: text v80-smi debug clockwiz -d (--get | --set ) [--region ] [-x|--hex] .. option:: -d, --device Board address. **Required.** .. option:: --get Read current clock rate for selected region. .. option:: --set Set requested clock rate in Hz for selected region. .. option:: --region Clock region selector (default: ``user``). .. option:: -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.