domain - 2024.2 English - UG1400

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)
Document ID
UG1400
Release Date
2025-01-20
Version
2024.2 English

Create, configure, list and report domains

Table 1. domain- Create, configure, list and report domains
XSCT methods Arguments Corresponding Python API Arguments Comments
domain create

-name <domain-name> Name of the domain.

-display-name <display_name> The name to be displayed in the report for the domain.

-desc <description> Brief description of the domain.

-proc <processor> Processor core to be used for creating the domain. For SMP Linux, this can be a Tcl list of processor cores.

-arch <processor architecture> 32-bit or 64-bit. This option is valid only for A53 processors.

-os <os> OS type. Default type is standalone.

 platform.add_domain

Required Arguments:

cpu = <cpu_core> Processor core to be used for creating the domain. For SMP Linux, this can be a list of processor cores

  
domain create (cont'd)

-support-app <app-name> Create a domain with BSP settings needed for application specified by <app-name>. This option is valid only for standalone domains. The "repo -apps" command can be used to list the available application.

-auto-generate-linux Generate the Linux artifacts automatically.

-sd-dir <location> For domain with Linux as OS, use pre-built Linux images from this directory, while creating the PetaLinux project. This option is valid only for Linux domains.

-sysroot <sysroot-dir> The Linux sysroot directory that should be added to the platform. This sysroot is consumed during application build.

  

Optional Arguments:

os = <os> OS type. OS is standalone (default).

name = <domain_name> Name of the domain to be added.

display_name = <display_name> Display name for the domain

support_app = ["app1",..]** Create a domain with BSP settings needed for application specified by <app-name>. This option is valid only for standalone domains.

sd_dir = <location> For domain with Linux as OS, use pre-built Linux images from this directory, while creating the PetaLinux project. This option is valid only for Linux domains.

  
domain active domain-name platform.get_domain

Required Arguments:

name = <domain_name> Name of the domain

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

-display-name <display name> Display name of the domain.

-desc <description> Brief description of the domain.

-sd-dir <location> For domain with Linux as OS, use pre-built Linux images from this directory, while creating the PetaLinux project. This option is valid only for Linux domains.

-generate-bif Generate a standard bif for the domain. Domain report shows the location of the generated bif. This option is valid only for Linux domains.

-sw-repo <repositories-list> List of repositories to be used to pick software components like drivers and libraries while generating this domain. Repository list should be a tcl list of software repository paths.

-mss <mss-file> Use mss from specified by <mss-file>, instead of generating mss file for the domain.

-readme <file-name> Add a README file for the domain, with boot instructions and so on.
  1. update_name
  2. add_custom_dtb
  3. set_sd_dir
  4. add_boot_di
  5. add_bif
  6. add_qemu_args
  7. add_qemu_data
 Required Arguments:
  1. name = <new_name> New display name for the domain
  2. path = <dtb_file> Path for the custom DTB file.
  3. path = <path> Path for the pre-built linux image directory
  4. boot_dir = <boot_dir> Boot directory to be added
  5. path = <file_path> Bif file to be added
  6. qemu_option = <"PS"/"PMC"/"PMU"> Valid qemu option are "PS", "PMC" or "PMU".

    file_name

    = <file_name> File with all pmu/pmc/ps qemu args listed.
  7. data_dir = <data_dir> Directory containing all the files provided as a part of qemu-args
  
domain config (cont'd)

-inc-path <include-path> Additional include path which should be added while building the application created for this domain.

-lib-path <library-path> Additional library search path which should be added to the linker settings of the application created for this domain.

-sysroot <sysroot-dir> The Linux sysroot directory that should be added to the platform. This sysroot will be consumed during application build.

-boot <boot-dir> Directory to generate components after Linux image build.

-bif <file-name> Bif file used to create boot image for Linux boot.

-qemu-args <file-name> File with all PS QEMU args listed. This is used to start PS QEMU.

-pmuqemu-args <file-name> File with all PMC QEMU args listed. This is used to start PMU QEMU.

-pmcqemu-args <file-name> File with all pmcqemu args listed. This is used to start pmcqemu.

-qemu-data <data-dir> Directory which has all the files listed in file-name provided as part of qemu-args and pmuqemu-args options.

      
list   platform.list_domain    
report domain-name domain.report Required Arguments:

name = <domain_name> Name of the domain to be deleted

  
remove domain-name