platforminfo Utility - 2025.2 English

Vitis Reference Guide (UG1702)
Document ID
UG1702
Release Date
2025-11-20
Version
2025.2 English

The platforminfo command line utility reports platform meta-data, including information on interface, clock, valid SLRs, allocated resources and memory. The information is in a structured format. You can reference the information when, for example, allocating kernels to SLRs or memory resources.

The following command options are available to use with platforminfo:

Table 1. platforminfo Commands
Option Description
-f [ --force ] Overwrite an existing output file.
-h [ --help ] Print help message and exit.
-k [ --keys ] Get keys for a given platform. Returns a list of JSON paths.
-l [ --list ] List platforms. Searches the user repo paths $PLATFORM_REPO_PATHS and then the install locations to find .xpfm files.
-e [ --extended ] List platforms with extended information. Use with '--list'.
-d [ --hw ] <arg> Specify the platform definition (*.xsa) on which to operate. The value must be a full path, including file name and .xsa extension.
-s [ --sw ] <arg> Specify the software platform definition (*.spfm) on which to operate. The value must be a full path, including file name and .spfm extension.
-p [ --platform ] <arg> AMD platform definition (*.xpfm) on which to operate. The value for --platform can be a full path including file name and .xpfm extension, as shown in example 1 below. If supplying a file name and .xpfm extension without a path, this utility will search only the current working directory. You can also specify just the base name for the platform. When the value is a base name, this utility will search the $PLATFORM_REPO_PATHS, and the install locations, to find a corresponding .xpfm file, as shown in example 2 below. 
Example 1: --platform /opt/xilinx/platforms/xilinx_vck190_base_202520_1/xilinx_vck190_base_202520_1.xpfm

Example 2: --platform xilinx_vck190_base_202520_1
-o [ --output ] <arg> Specify an output file. Default: STDOUT.
-j [ --json ] <arg> Use JSON format for output. When used with no value, prints the entire platform as JSON. Accepts an optional adjacent value that specifies a JSON path. The JSON path, when valid, fetches a JSON subtree, list, or value.
Example 1: 
platforminfo --json="hardwarePlatform" --platform <platform base name>

Example 2: Specify the index when referring to an item in a list.
platforminfo --json="hardwarePlatform.devices[0].name" --platform <platform base name>

Example 3: When using the short option form (-j), the value must follow immediately.
platforminfo -j"hardwarePlatform.systemClocks[]" -p <platform base name>
-v [ --verbose ] The platforminfo utility can generate a default, human-readable report for a given platform. The default report contains the most important characteristics of the platform. Use the verbose switch to display the full platform meta-data in human-readable form.
Note: Except when using the --help or --list options, a platform must be specified. You can specify the platform using the --platform option, or using either --hw, --sw. You can also simply insert the platform name or full path into the command line positionally.

To understand the generated report, condensed output logs, based on the following command are reviewed. The report is broken down into specific sections for better understandability.

platforminfo -p $PLATFORM_REPO_PATHS/xilinx_u200_gen3x16_xdma_2_202110_1.xpfm
Tip: See Platform info for vek385_base for an example of embedded processor platforms.