platform - 2024.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
Release Date
2024-11-13
Version
2024.2 English
Create, configure, list, and report platforms.
Table 1. platform- Create, configure, list, and report platforms
XSCT methods Arguments Corresponding Python API Arguments Comments
active platform-name client.get_platform_component

Required Arguments: name = <platform_name> Name of the platform.

Get command returns the platform object that can be used to run platform commands.
clean   platform.clean    
config

-desc <description>

Add a brief description about the platform.

-updatehw <hw-spec>

Update the platform to use a new hardware specification file specified by <hw-spec>.

-samples <samples-dir>

Make the application template specified in <samples-dir> part of the platform. This option can only be used for acceleratable applications. "repo -apps <platform-name>" can be used to list the application templates available for the given platform-name.

-prebuilt-data <directory-name>

For expandable platforms, pre-generated hardware data specified in directory-name is used for building user applications that do not contain accelerators. This reduces the build time.

-make-local

Make the referenced SW components local to the platform.

-fsbl-target <processor-type>

Processor-type for which the existing fsbl has to be re-generated. This option is valid only for ZU+.

-create-boot-bsp

Generate boot components for the platform.

  1. update_desc
  2. update_hw
  3. Not supported
  4. Not supported
  5. Not supported
  6. retarget_fsbl
  7. generate_boot_bsp
  8. remove_boot_bsp

    (For 9 and 10, remove_boot_bsp uses fsbl_elf and pmufw_elf options)

Required Arguments:

desc = <description> Description of the platform

Required Arguments

hw = <hw_spec> or emulation_xsa_path = <xsa_path> Hardware specification file or emulation xsa path.

Optional Arguments

target_processor = <target> Processor for which the existing fsbl has to be re-generated.

 
config (cont'd)

-remove-boot-bsp

Remove all the boot components generated during platform creation.

-fsbl-elf <fsbl.elf>

Prebuilt fsbl.elf to be used as boot component when "remove-boot-bsp" option is specified.

-pmufw-elf <pmufw.elf>

Prebuilt pmufw.elf to be used as boot component when "remove-boot-bsp" option is specified.

-extra-compiler-flags <param> <value>

Set extra compiler flag for the parameter with a provided value.

Only FSBL and PMUFW are the supported parameters. If the value is not passed, the existing value returns.

-extra-linker-flags <param> <value>

Set extra linker flag for the parameter with a provided value.

Only FSBL and PMUFW are the supported parameters. If the value is not passed, the existing value returns.

-reset-user-defined-flags <param>

Resets the extra compiler and linker flags. Only FSBL and PMUFW are the supported parameters.

-report <param>

Return the list of extra compiler and linker flags set to the given parameter. Only FSBL and PMUFW are the supported parameters.

 

Optional Arguments

target_processor = <processor>Target procesor for generating boot bsp. zynqmp_fsbl (default)

Optional Arguments

fsbl_path = <path> Prebuilt fsbl.elf to be used as boot component when boot components are removed.

pmufw_elf = <pmufw.elf> Prebuilt pmufw.elf to be used as boot component when boot components are removed.

 
list   client.list_platforms    
report   platform.report    
remove   platform-name    
read   Not supported in Python CLI    
write   Not supported in Python CLI