Scroll to navigation

XCLBINUTIL(1) User Commands XCLBINUTIL(1)

NAME

xclbinutil - manual page for xclbinutil XRT Build Version: 2.21.0

DESCRIPTION

This utility operates on a xclbin produced by v++.

For example:

1) Reporting xclbin information
: xclbinutil --info --input binary_container_1.xclbin
2) Extracting the bitstream image: xclbinutil --dump-section BITSTREAM:RAW:bitstream.bit --input binary_container_1.xclbin 3) Extracting the build metadata : xclbinutil --dump-section BUILD_METADATA:HTML:buildMetadata.json --input binary_container_1.xclbin 4) Removing a section : xclbinutil --remove-section BITSTREAM --input binary_container_1.xclbin --output binary_container_modified.xclbin 5) Signing xclbin : xclbinutil --private-key key.priv --certificate cert.pem --input binary_container_1.xclbin --output signed.xclbin

Command Line Options Options:

Section name to add or merge. Format: <section>:<format>:<file>
Helper option to add PS kernels. Format: [<mem_banks>]:[<symbol_name>]:[<instances>]:<path_t o_shared_library>
Format: <section>:<format>:<file>
Section name to add. Format: <section>:<format>:<file>
Adds a user defined signature to the given xclbin image.
Certificate used in signing and validating the xclbin image.
Digest algorithm. Default: sha512
Section to dump. Format: <section>:<format>:<file>
Forces a file overwrite.
Returns the user defined signature (if set) of the xclbin image.
Print help messages
Including: generation and packaging data, kernel signatures, connectivity, clocks, sections, etc. Note: Optionally an output file can be specified. If none is specified, then the output will go to the console.
Input file name. Reads xclbin into memory.
Key value pairs. Format: [USER|SYS]:<key>:<value>
List all possible section names (Stand Alone Option)
Migrate the xclbin archive forward to the new binary format.
Output file name. Writes in memory xclbin image to a file.
Private key used in signing the xclbin image.
Minimize reporting information.
Removes the given user key from the xclbin archive.
Section name to remove.
Removes the signature from the xclbin image.
Section to replace.
Target flow for this image. Valid values: hw, hw_emu, and sw_emu.
Validates the signature for the given xclbin archive.
Display verbose/debug information.
Version of this executable.
Check for Linux file command utility compliance

Addition Syntax Information --------------------------- Syntax: <section>:<format>:<file>

<section> - The section to add or dump (e.g., BUILD_METADATA, BITSTREAM, etc.)
If so, then
In addition, only sections that are found in the JSON file will be reported.
<format>
- The format to be used. Currently, there are three formats available:
RAW: Binary Image; JSON: JSON file format; and HTML: Browser visible.
Note: Only selected operations and sections supports these file types.
<file>
- The name of the input/output file to use.
Used By: --add_section and --dump_section Example: xclbinutil --add-section BITSTREAM:RAW:mybitstream.bit
Build Version Branch:
Build Version Hash:
Build Version Hash Date:
Build Version Date: Wed, 29 Oct 2025 15:29:42 -0500

SEE ALSO

The full documentation for xclbinutil is maintained as a Texinfo manual. If the info and xclbinutil programs are properly installed at your site, the command

info xclbinutil

should give you access to the complete manual.

October 2025 xclbinutil XRT Build Version: 2.21.0