Custom Hardware Development

This page walks through Custom Hardware Development: generating a base hardware design and its firmware package, plus application-specific designs in either AMD Vivado RTL or the AMD Vitis software platform, and the handoff artifacts the software and OS domains need to build the complete runtime image. See Development Flows for how this persona fits with the others.

Overview

A hardware developer can create one or more hardware (HW) designs, resulting in one or more firmware bundles.

The firmware bundles (boot.pdi, PL.pdi) can be integrated with or built with the OS and boot images. A software application can interact with the hardened and/or adaptive features of the hardware design.

You can integrate firmware bundles (pl.bin) with the OS and boot images or build them together. A software application can interact with the hard features, adaptive features, or both.

The boot image contains the base HW design firmware. Load application-specific incremental HW design firmware into the PL at Linux runtime to support a specific application.

The following tutorials show how to generate a base HW design and its firmware package and two examples of application-specific HW designs and firmware. One is a Vivado Design Suite based design (RTL), the other a Vitis software platform-based design. We also show how to generate various handoff artifacts needed when moving from HW to the SW or OS domain.

Typically, a hardware design team provides a new custom base HW design/Vivado Design Suite XSA that matches their product requirements, for example, a custom board or even a static PL design if the production image has a fixed function. The XSA is handed off to the OS development team which then generates a new Yocto Project machine configuration based on this base XSA using the provided sdtgen and gen-machine-conf tooling as a starting point (see Software Hardware Exchange Loop (SHEL) Flow).

The EDF Linux distribution (distro) can be used as a starting point for the OS build, but the end-user can also opt to use the upstream Yocto Project poky distro or their own custom distro for their final product based on their product requirements. Customizing the OS configuration might require expert knowledge. Some common items are covered here Development Flows, and there is extensive documentation available online for this purpose (https://docs.yoctoproject.org/wrynose/singleindex.html ).

Similarly, creating and customizing a Vivado Design Suite/RTL design can require expert knowledge, and extensive documentation is available on this subject.

AMD EDF v26.11 - AMD Vivado Design Suite 2026.2

  • A Vitis software platform-based design is not included in this release. This is scheduled for inclusion after the AMD Vivado Design Suite 2026.2 release.

AMD EDF v26.11 - AMD Vivado Design Suite 2026.2

  • The ZCU104 base design does not include a default PL payload

Custom Hardware Development column from the persona-based development flows diagram, listing options for a custom design in Vivado / Vitis (not compatible with the prebuilt image, custom board, custom isolation and protection) and part-based CED options that align with the EDF software stack, with a new boot firmware / OS image and new HW design artifacts as the outputs.

Custom Hardware Development persona summary card.

EDF Hardware Design Repository Overview

The following section gives an overview of the hardware design repository which provides the baseline for the Yocto Project machine configuration used in this tutorial.

$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vck190_base/
eval_board_base/vck190_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vek280_base/
eval_board_base/vek280_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vek385_base/
eval_board_base/vek385_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vek385_revb_base/
eval_board_base/vek385_revb_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vek386_base/
eval_board_base/vek386_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vmk180_base/
eval_board_base/vmk180_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vmk365_base/
eval_board_base/vmk365_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vm-p-m1369-00_base/
eval_board_base/vm-p-m1369-00_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vpk120_base/
eval_board_base/vpk120_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vpk180_base/
eval_board_base/vpk180_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/vpk360_base/
eval_board_base/vpk360_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl

Ensure you use the release tag of amd-yocto-hw-platforms that matches the EDF version in use. See Cloning a Release Tag for how to list the available tags.

Use the latest version available.

See Downloads and Release Notes for details on released versions.

The directory structure lists the base design for your board that can be built from the EDF Hardware Design repo:

  1. <board name>_base – This is the embedded common platform CED design mapped to a target evaluation board. It enables segmented configuration which allows deployment of a common boot PDI (loaded from the primary boot device by the EDF Boot Firmware), and a PL PDI loaded at Linux runtime (deferred PL load).

    The embedded common platform CED includes a minimal PL payload that has some basic peripherals mapped to the evaluation board: PL UART, DIP switch, push buttons, and user LEDs via a pair of AXI GPIO controllers, and a simple BRAM controller. The PL payload firmware (PL PDI, and device tree PL .dtbo) is loaded after Linux boot from the user space.

$ git clone git@github.com:Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/zcu102_base/
eval_board_base/zcu102_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone git@github.com:Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/zcu104_base/
eval_board_base/zcu104_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone git@github.com:Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/zcu106_base/
eval_board_base/zcu106_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone git@github.com:Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/zcu111_base/
eval_board_base/zcu111_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone git@github.com:Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/zcu208_base/
eval_board_base/zcu208_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone git@github.com:Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree eval_board_base/zcu216_base/
eval_board_base/zcu216_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl

The directory structure lists the base design that can be built from the EDF Hardware Design repo:

<board name>_base - This is the embedded common platform CED design mapped to a target evaluation board. It enables deferred PL load which allows for deployment of a common boot PDI (loaded from the primary boot device by the EDF Boot Firmware) and a PL .bin loaded at Linux runtime (deferred PL load).


The embedded common platform CED includes a minimal PL payload that has some basic peripherals mapped to the evaluation board: PL UART, DIP switch, push buttons, and user LEDs via a pair of AXI GPIO controllers, and a simple BRAM controller. The PL payload firmware (PL PDI, and device tree PL .dtbo) is loaded after Linux boot from the user space.

The Kria base designs are held apart from the evaluation board designs, under a directory for the SoM the carrier board carries:

$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree kria_base/k24/kd240_base/
kria_base/k24/kd240_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree kria_base/k26/kr260_base/
kria_base/k26/kr260_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl
$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ tree kria_base/k26/kv260_base/
kria_base/k26/kv260_base/
├── Makefile
└── scripts
    ├── gen_sdt.tcl
    └── main.tcl

The design is the embedded common platform CED mapped to the carrier board, and it generates the SDT the k24-smk-kd-sdt machine is built from. Its gen_sdt.tcl passes zynqmp-smk-k24-reva.dtsi, which describes the SoM rather than the carrier.

The design is the embedded common platform CED mapped to the carrier board, and it generates the SDT the k26-smk-kr-sdt machine is built from. Its gen_sdt.tcl passes zynqmp-smk-k26-reva.dtsi, which describes the SoM rather than the carrier.

The design is the embedded common platform CED mapped to the carrier board, and it generates the SDT the k26-smk-kv-sdt machine is built from. Its gen_sdt.tcl passes zynqmp-smk-k26-reva.dtsi, which describes the SoM rather than the carrier.

The rest of this page is written against the evaluation board designs. The commands are the same, but the paths and the generated machine names are not, so read them with your own design directory substituted.

A top-level Makefile is provided for easy build orchestration. Each of the preceding designs can be built with a single make command. The make command builds a series of artifacts:

  1. The hardware design which typically ends with exporting a Vivado Design Suite XSA.

  2. The system device tree (SDT) artifacts directory which is needed for handoff to the software build flow - Yocto Project build

  3. A firmware (FW) bundle which is needed to dynamically load the PL designs from Linux

While the Makefile is convenient, we also provide step-by-step instructions for running the respective commands by hand.

The following design examples are compatible with the AMD Vivado Design Suite 2026.2 EA tools version.

The following design examples are compatible with the AMD Vivado Design Suite 2026.2 EA tools version.

Cloning a Release Tag

Development of the amd-yocto-hw-platforms repository happens on its main branch. For the current release cycle, each release ships as a tag on that branch rather than as a per-release branch. The preceding git clone commands pass -b with a release tag rather than a branch name; git accepts either for that argument, and here it resolves to the xilinx_v2026.2 tag. The GitHub branch selector for the repository therefore lists no branch of that name; switch the selector to tags.

Use the release tag that matches the EDF version in use. See Downloads and Release Notes for details on released versions.

To list the release tags that exist before cloning:

$ git ls-remote --tags https://github.com/Xilinx/amd-yocto-hw-platforms.git

After cloning, git tag --list reports the same set from the local clone.

Cloning a tag leaves the clone on a detached HEAD at the commit that produced the release, the correct starting point for reproducing a released design. Create a local branch from the tag before modifying a design:

$ git clone https://github.com/Xilinx/amd-yocto-hw-platforms.git -b xilinx_v2026.2
$ cd amd-yocto-hw-platforms
$ git switch -c my-design xilinx_v2026.2

Vivado Base Design and Base Platform

The following tutorial shows how to generate the Vivado Design Suite base design XSA from a Tcl based project and how to generate the system device tree handoff artifacts that are needed to set up the Yocto build.

Refer to EDF Hardware Design Repository Overview for details on setting up the hardware design repo and the tools.

From the top-level directory, use make to build the base design project from Tcl. This step takes some time because it runs implementation to generate the routed dcp which is used later by pr_verify for checking design compatibility for segmented config when creating alternative compatible PL payloads.

Also, the build reads a NoC solution file from the Vivado install area for the CED to re-seed the NoC solution, and checks the unique ID of boot.pdi for the prebuilt Vivado CED against the newly generated boot.pdi to confirm if it has same unique ID or not. This ensures compatibility between the prebuilt boot firmware and users who created their custom design from the Vivado CED (and can then deploy the PL image directly to a system running the re-built boot firmware and boot image).

Note

See the output directory for the .dcp file used to check for compatibility of designs in the Segmented Configuration flow (pr_verify).

The following command uses JOBS=8 to run 8 parallel compiles, with each compile spawning multiple threads, where the maximum number of threads is by default limited to the number of CPU cores detected. This requires significant RAM and Processor resources.

For example: JOBS=8 - The number of processes = 8 x <number of cores>, with matching RAM requirements.

  • If you are running on a system with limited resources, it is recommend to set JOBS=1

$ cd eval_board_base/vck190_base
$ make all JOBS=8
$ cd eval_board_base/vek280_base
$ make all JOBS=8
$ cd eval_board_base/vek385_base
$ make all JOBS=8
$ cd eval_board_base/vek385_revb_base
$ make all JOBS=8
$ cd eval_board_base/vek386_base
$ make all JOBS=8
$ cd eval_board_base/vmk180_base
$ make all JOBS=8
$ cd eval_board_base/vmk365_base
$ make all JOBS=8
$ cd eval_board_base/vpk120_base
$ make all JOBS=8
$ cd eval_board_base/vpk180_base
$ make all JOBS=8
$ cd eval_board_base/vpk360_base
$ make all JOBS=8
$ cd eval_board_examples/zcu104_pl_vcu_extensible/
$ make all JOBS=8
$ cd eval_board_base/zcu102_base
$ make all JOBS=8
$ cd eval_board_base/zcu106_base
$ make all JOBS=8
$ cd eval_board_base/zcu111_base
$ make all JOBS=8
$ cd eval_board_base/zcu208_base
$ make all JOBS=8
$ cd eval_board_base/zcu216_base
$ make all JOBS=8

Note

The walkthrough that follows uses the ZCU104 VCU example design. The designs under eval_board_examples/ exist per board rather than per family, so your board may have none, or may have one of a different kind - the ZCU111 has a PL IP example. Build your own base design, as above, and read the rest of this section for the shape of the flow.

The make command generates the following artifacts inside the base/ directory:

  1. Project directory hw_project - The directory contains the Vivado .xpr project file which can be used to open and edit the project in the Vivado Design Suite

  2. SDT artifacts directory hw_project_sdt - The SDT directory is used as handoff artifact to set up the Yocto Project disk image build

You can now open the generated Vivado Design Suite project to view the generated design:

  1. Open the generated xpr project file from the command line (See the Vivado Design Suite documentation for other ways to open the project)

$ cd hw_project/vck190_base
$ vivado vck190_base.xpr &
$ cd hw_project/vek280_base
$ vivado vek280_base.xpr &
$ cd hw_project/vek385_base
$ vivado vek385_base.xpr &
$ cd hw_project/vek385_revb_base
$ vivado vek385_revb_base.xpr &
$ cd hw_project/vek386_base
$ vivado vek386_base.xpr &
$ cd hw_project/vmk180_base
$ vivado vmk180_base.xpr &
$ cd hw_project/vmk365_base
$ vivado vmk365_base.xpr &
$ cd hw_project/vpk120_base
$ vivado vpk120_base.xpr &
$ cd hw_project/vpk180_base
$ vivado vpk180_base.xpr &
$ cd hw_project/vpk360_base
$ vivado vpk360_base.xpr &

The block design differs from board to board.

Vivado IP Integrator block design for the VEK385 base CED (versal_gen2_platform), showing the Versal Processing System Wizard feeding the Master NoC, AXI NoC instances on the LPDDR5X channels, an AI Engine block, AXI BRAM Controller, and three AXI GPIO blocks driving gpio_led, gpio_dip, and gpio_pb.

VEK385 base CED block design as opened in Vivado.

The output of the generated sdt artifacts directory looks as follows. You can see that two different PDIs were generated for the segmented configuration flow:

  1. boot PDI <board name>_base_boot.pdi - this PDI is used in the boot image (boot.bin) and is stored in the OSPI as a boot image to be loaded by the EDF Boot Firmware.

  2. pld PDI <board_name>_base_pld.pdi - This is the PL PDI used to load the PL. This file is one of the input files to create the firmware bundle to load the PL from Linux userspace or U-Boot, and can be added to the rootfs build or copied directly to the running system. See Firmware Bundle and Hardware Application Development for the steps to create the firmware bundle.

$ cd hw_project/zcu104_pl_vcu_extensible/
$ vivado zcu104_pl_vcu_extensible.xpr &
Vivado IP Integrator block design for zcu104_pl_vcu_extensible showing the Zynq UltraScale+ MPSoC, multiple AXI Interconnects, Video Frame Buffer Read/Write, VCU codec, clocking wizards, and processor system reset blocks wired to the c0_ddr4 controller.

ZCU104 PL VCU extensible base block design.

$ cd hw_project/zcu102_base
$ vivado zcu102_base.xpr &
$ cd hw_project/zcu106_base
$ vivado zcu106_base.xpr &
$ cd hw_project/zcu111_base
$ vivado zcu111_base.xpr &
$ cd hw_project/zcu208_base
$ vivado zcu208_base.xpr &
$ cd hw_project/zcu216_base
$ vivado zcu216_base.xpr &

The output of the generated sdt artifacts directory looks as follows. You can see that the pl.bin file was generated for the deferred load flow:

  1. <design>.bit - This is the PL PDI used to load the PL. This file is one of the input files to create the firmware bundle to load the PL from the Linux user space or U-Boot, and can be added to the rootfs build or copied directly to the running system. See Hardware Application Development for the steps to create the firmware bundle.

Note

Operating System Integration and Development expects the following:

  • SDTGen to have been run to generate a System Device Tree directory (containing the PL.:term:PDI and hardware project derived Device Trees)

  • <system Device Tree Directory>/pl.dtsi(PL Device Tree) to have been manually updated to reflect PL content if needed

  • gen-machine-conf to have been run to populate the Yocto Project build directory

See Segmented Configuration or Dynamic Function eXchange.

The Yocto Project build recipes (created by recipetool-create) then handle the file conversion, Device Tree Overlay, and integration into the root fs as part of the Image build process

The firmware package can also be created manually, and copied directly to the running image for testing using SCP, tftp, or through SD Card.

SDTGen is run as part of the build process in the Makefile, the contents of the System Device Tree Handoff Directory are shown in the following listing.

It contains a series of device tree files with system-top.dts being the top-level device tree.

$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vck190_base_boot.pdi
├── vck190_base.isd
├── vck190_base.mmi
├── vck190_base_pld.pdi
├── versal-clk-ccf.dtsi
├── versal.dtsi
└── versal-vck190-rev1.1-x-ebm-01-reva.dtsi
$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vek280_base_boot.pdi
├── vek280_base.isd
├── vek280_base.mmi
├── vek280_base_pld.pdi
├── versal-clk-ccf.dtsi
├── versal.dtsi
└── versal-vek280-revb.dtsi
$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vek385_base_boot.pdi
├── vek385_base.isd
├── vek385_base.mmi
├── vek385_base_pld.pdi
├── versal2-clk-ccf.dtsi
├── versal2.dtsi
└── versal2-vek385-reva.dtsi
$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vek385_revb_base_boot.pdi
├── vek385_revb_base.isd
├── vek385_revb_base.mmi
├── vek385_revb_base_pld.pdi
├── versal2-clk-ccf.dtsi
├── versal2.dtsi
└── versal2-vek385-revb.dtsi
$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vek386_base_boot.pdi
├── vek386_base.isd
├── vek386_base.mmi
├── vek386_base_pld.pdi
├── versal2-clk-ccf.dtsi
├── versal2.dtsi
└── versal2-vek385-revb.dtsi
$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vmk180_base_boot.pdi
├── vmk180_base.isd
├── vmk180_base.mmi
├── vmk180_base_pld.pdi
├── versal-clk-ccf.dtsi
├── versal.dtsi
└── versal-vmk180-rev1.1-x-ebm-01-reva.dtsi
$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vmk365_base_boot.pdi
├── vmk365_base.isd
├── vmk365_base.mmi
├── vmk365_base_pld.pdi
├── versal2-clk-ccf.dtsi
├── versal2.dtsi
└── versal2-vmk365-reva.dtsi
$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vpk120_base_boot.pdi
├── vpk120_base.isd
├── vpk120_base.mmi
├── vpk120_base_pld.pdi
├── versal-clk-ccf.dtsi
├── versal.dtsi
└── versal-vpk120-revb.dtsi
$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vpk180_base_boot.pdi
├── vpk180_base.isd
├── vpk180_base.mmi
├── vpk180_base_pld.pdi
├── versal-clk-ccf.dtsi
├── versal.dtsi
└── versal-vpk180-reva.dtsi
$ tree -L 1 hw_project_sdt/
hw_project_sdt/
├── aie_primitive.json
├── extracted
├── HashBlock0.bin
├── include
├── pcw.dtsi
├── pl.dtsi
├── system-top.dts
├── vpk360_base_boot.pdi
├── vpk360_base.isd
├── vpk360_base.mmi
├── vpk360_base_pld.pdi
├── versal2-clk-ccf.dtsi
├── versal2.dtsi
└── versal-vpk360-reva.dtsi

Generating the SDT Handoff Directory by Hand for Versal Boards

The following tutorial shows the steps for generating the sdt handoff directory by hand using the SDTGen tool. The commands are for your board; the console output below them was captured on a VEK385, so the IP block names in the warnings are that board’s.

bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vck190_base/outputs/vck190_base.xsa
sdtgen% set_dt_param -user_dts versal-vck190-rev1.1-x-ebm-01-reva.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vek280_base/outputs/vek280_base.xsa
sdtgen% set_dt_param -user_dts versal-vek280-revb.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vek385_base/outputs/vek385_base.xsa
sdtgen% set_dt_param -user_dts versal2-vek385-reva.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vek385_revb_base/outputs/vek385_revb_base.xsa
sdtgen% set_dt_param -user_dts versal2-vek385-revb.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vek386_base/outputs/vek386_base.xsa
sdtgen% set_dt_param -user_dts versal2-vek385-revb.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vmk180_base/outputs/vmk180_base.xsa
sdtgen% set_dt_param -user_dts versal-vmk180-rev1.1-x-ebm-01-reva.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vmk365_base/outputs/vmk365_base.xsa
sdtgen% set_dt_param -user_dts versal2-vmk365-reva.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vpk120_base/outputs/vpk120_base.xsa
sdtgen% set_dt_param -user_dts versal-vpk120-revb.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vpk180_base/outputs/vpk180_base.xsa
sdtgen% set_dt_param -user_dts versal-vpk180-reva.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt
sdtgen% set_dt_param -xsa ./hw_project/vpk360_base/outputs/vpk360_base.xsa
sdtgen% set_dt_param -user_dts versal-vpk360-reva.dtsi
sdtgen% generate_sdt
INFO: [Hsi 55-2053] elapsed time for repository (/opt/Vivado/data/embeddedsw) loading 1 seconds
hsi::open_hw_design: Time (s): cpu = 00:00:13 ; elapsed = 00:00:15 . Memory (MB): peak = 671.430 ; gain = 94.055 ; free physical = 70545 ; free virtual = 350031
WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

WARNING: no s_axi_aclk for clockwizard IP block: " clkx5_wiz_0"

INFO: Reading AIE hardware properties from XSA.
WARNING: ps_wizard_0_mmi_0_mmi_10gbe: No reset found
WARNING: ps_wizard_0_ps11_0_ethernet_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_0: No reset found
WARNING: ps_wizard_0_ps11_0_i2c_1: No reset found
sdtgen% exit
exit

You can inspect the generated output in the hw_project_sdt2 directory which should match the output of the hw_project_sdt directory generated as part of the make command.

Generating the SDT Handoff Directory Using SDTGen for Zynq-7000 Boards

The following example builds the base design and generates its SDT handoff directory using SDTGen. Run these commands from the hardware design repository:

$ cd eval_board_base/zc702_base
$ make all JOBS=8
$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -dir ./hw_project_sdt2
sdtgen% set_dt_param -xsa ./hw_project/zc702_base/outputs/zc702_base.xsa
sdtgen% set_dt_param -user_dts zc702.dtsi
sdtgen% generate_sdt
sdtgen% exit
$ cd eval_board_base/zc706_base
$ make all JOBS=8
$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -dir ./hw_project_sdt2
sdtgen% set_dt_param -xsa ./hw_project/zc706_base/outputs/zc706_base.xsa
sdtgen% set_dt_param -user_dts zc706.dtsi
sdtgen% generate_sdt
sdtgen% exit

Inspect the generated output in hw_project_sdt2. It should match the hw_project_sdt directory generated by make all.

Note

The directory structure below is the ZCU104 VCU example design. Your board’s base design has the same shape with its own names in place of the ZCU104 ones.

$ tree
.
├── extracted
│   └── zcu104_pl_vcu_extensible_wrapper
├── include
│   └── dt-bindings
│       ├── clock
│       │   ├── xlnx-versal-clk.h
│       │   ├── xlnx-versal-net-clk.h
│       │   └── xlnx-zynqmp-clk.h
│       ├── dma
│       │   └── xlnx-zynqmp-dpdma.h
│       ├── gpio
│       │   └── gpio.h
│       ├── input
│       │   ├── input.h
│       │   └── linux-event-codes.h
│       ├── interrupt-controller
│       │   ├── arm-gic.h
│       │   └── irq.h
│       ├── net
│       │   ├── mscc-phy-vsc8531.h
│       │   └── ti-dp83867.h
│       ├── phy
│       │   └── phy.h
│       ├── pinctrl
│       │   └── pinctrl-zynqmp.h
│       ├── power
│       │   ├── xlnx-versal-net-power.h
│       │   ├── xlnx-versal-power.h
│       │   ├── xlnx-versal-regnode.h
│       │   └── xlnx-zynqmp-power.h
│       └── reset
│           ├── xlnx-versal-net-resets.h
│           ├── xlnx-versal-resets.h
│           └── xlnx-zynqmp-resets.h
├── pcw.dtsi
├── pl.dtsi
├── psu_init.c
├── psu_init.h
├── psu_init.html
├── psu_init.tcl
├── psu_init_gpl.c
├── psu_init_gpl.h
├── system-top.dts
├── zcu104-reva.dtsi
├── zcu104_pl_vcu_extensible.bit
├── zcu104_pl_vcu_extensible.mmi
├── zynqmp-clk-ccf.dtsi
└── zynqmp.dtsi

Generating the sdt handoff directory by hand using the SDTGen tool

The following tutorial shows the steps for generating the sdt handoff directory by hand using the SDTGen tool

bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt2
sdtgen% set_dt_param -xsa hw_project/zcu102_base/outputs/zcu102_base.xsa
sdtgen% set_dt_param -user_dts zynqmp-zcu102-rev1.1.dtsi
sdtgen% generate_sdt
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt2
sdtgen% set_dt_param -xsa hw_project/zcu104_base/outputs/zcu104_base.xsa
sdtgen% set_dt_param -user_dts zcu104-reva.dtsi
sdtgen% generate_sdt
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt2
sdtgen% set_dt_param -xsa hw_project/zcu106_base/outputs/zcu106_base.xsa
sdtgen% set_dt_param -user_dts zynqmp-zcu106-rev1.0.dtsi
sdtgen% generate_sdt
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt2
sdtgen% set_dt_param -xsa hw_project/zcu111_base/outputs/zcu111_base.xsa
sdtgen% set_dt_param -user_dts zcu111-reva.dtsi
sdtgen% generate_sdt
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt2
sdtgen% set_dt_param -xsa hw_project/zcu208_base/outputs/zcu208_base.xsa
sdtgen% set_dt_param -user_dts zcu208-reva.dtsi
sdtgen% generate_sdt
bash-4.4$ sdtgen
sdtgen% set_dt_param -debug enable
sdtgen% set_dt_param -zocl enable
sdtgen% set_dt_param -dir ./hw_project_sdt2
sdtgen% set_dt_param -xsa hw_project/zcu216_base/outputs/zcu216_base.xsa
sdtgen% set_dt_param -user_dts zcu216-reva.dtsi
sdtgen% generate_sdt

You can inspect the generated output in the hw_project_sdt2 directory which should match the output of the hw_project_sdt directory generated as part of the make command.

Generating a new Yocto Project Machine Configuration

Alternatively to using the prebuilt Yocto machine configuration based on cached SDT artifacts as described in the previous tutorial, you can generate your own Yocto machine configuration. This section describes how to generate a Yocto machine configuration using the gen-machine-conf tool from an SDT handoff directory.

Note

The previous tutorial (Operating System Integration and Development) generated a disk image using a prebuilt Yocto Project machine configuration based on cached SDT artifacts.

This tutorial shows how to generate a new machine configuration based on a Vivado project, as would be done for a custom board using the XSA, SDT handoff directory, and the gen-machine-conf tool.

Note

The previous tutorial (Operating System Integration and Development AMD ZynqMP device portfolio) generated a disk image using a prebuilt Yocto Project machine configuration based on cached SDT artifacts.

When importing the sdtgen output or system device tree into gen-machine-conf, make sure to start a new shell and set up the Yocto/gen-machine-conf environment separately.
Never mix environments between Vivado, Yocto, and PetaLinux, doing so can lead to unpredictable behavior.

For custom machines, the BOOT.BIN generated using the xilinx-bootbin recipe is sufficient. It provides the same core functionality as edf-ospi, except for the image selector and image recovery applications. The same BOOT.BIN can be used for both SD boot and OSPI boot, For OSPI boot, flash the BOOT.BIN file into the OSPI partition.

  1. Follow the instructions at Operating System Integration and Development AMD Versal device portfolio to set up your Yocto build environment.

  1. Setup the build environment and Yocto Project pre-requisites by following Operating System Integration and Development AMD ZynqMP device portfolio

Machine generation with gen-machine-conf supports two paths. Creating a custom BSP layer is optional for this flow. Use the quick path to place generated configuration in ${BUILDDIR}/conf. Use the recommended path to place generated configuration in a custom layer. For long-term maintenance, a custom layer is recommended so custom additions live outside the build directory and survive a make clean.

Quick path (no custom layer):

  1. From inside the Yocto build/ directory, run gen-machine-conf. The generated machine configuration is placed in ${BUILDDIR}/conf.

    $ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
        --machine-name <unique-machine-name>
    

Recommended path (with custom layer):

  1. Create a new BSP layer for your custom XSA and add this new layer to build as shown below.

    bitbake-layers-create-add-layer

    $ bitbake-layers create-layer <path-to-layer>/sources/meta-custom-bsp
    $ bitbake-layers add-layer <path-to-layer>/sources/meta-custom-bsp
    
  2. After the custom BSP layer is created, the content of the newly created layer looks like the following. You can remove the recipes-example directory because those recipes are only for reference and are not used in EDF builds.

    meta-custom-bsp

    $ tree ../sources/meta-custom-bsp/
    ../sources/meta-custom-bsp/
    ├── conf
    │   └── layer.conf
    ├── COPYING.MIT
    ├── README
    └── recipes-example
        └── example
              └── example_0.1.bb
    
  3. Run the gen-machine-conf help commands for detailed usage - this step is optional. For more information, refer to https://github.com/Xilinx/gen-machine-conf/blob/main/docs/options.rst

    gen-machine-conf-help:

    $ gen-machine-conf -h
    $ gen-machine-conf parse-sdt -h
    

Guidance for either path:

  1. Generate a Yocto Project machine configuration using the gen-machine-conf tool as shown below. The primary input to gen-machine-conf is the SDT handoff directory from the Vivado Design Suite base design, see Vivado Base Design and Base Platform for steps on how to generate the SDT directory. Internally it calls the lopper tool to prune dts files.

  2. If you are using a custom XSA (CED-based design) on an evaluation board, use the --template option with the -O <prebuilt eval board machine name> to obtain the evaluation board machine override.

  3. If you are using a custom XSA (non-CED-based design) on an AMD/Xilinx evaluation board, use the --template option without the -O <prebuilt eval board machine name> . The user must ensure that the load address values are adjusted to match the custom design.

  4. If you are using a custom XSA for custom boards use the --template option but create your own template yaml file by referring prebuilt machine template yaml files.

  5. The <machine-name> should be unique for all the above cases.

  • If -c is not provided, gen-machine-conf places the newly generated machine configuration into the Yocto ${BUILDDIR}/conf directory.

  • If you specify a custom BSP layer using -c (for example, -c <path-to-layer>/sources/meta-custom-bsp/conf), the configuration is placed in the specified layer conf directory. If you use the same machine name as an existing prebuilt machine, the new configuration supersedes the machine configuration available in the existing Yocto meta layers.

  • A custom BSP layer lets you version the generated machine configuration alongside the rest of your BSP layer.

  • When generating a new machine for a custom design, it is recommended to use a unique machine name by specifying the --machine-name <machine-name> option, ensuring it does not conflict with any existing prebuilt machine names in the meta layers.

  • For subsequent build steps, always use the unique machine name

    $ MACHINE=<machine-name> bitbake <foo>
    

Multitarget Build Configuration options for custom builds

To build bare-metal, FreeRTOS, or OpenAMP targets alongside your custom build, enable the multi-config options below for your use case.

  1. --add-config :

    • CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y: Enables FreeRTOS for Core R5-1.

    • CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y: Enables Bare Metal for Core R5-0.

  2. --domain-file: The domain file specifies the hardware abstraction and configuration for OpenAMP communication:

    • File Path: ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-openamp-overlay.yaml

  3. Detailed gen-machine-conf options can be found in https://github.com/Xilinx/gen-machine-conf/blob/main/docs/options.rst

FPGA Device Tree Configuration Options: -g {full,dfx}, --gen-pl-overlay {full,dfx}

This option invokes the Lopper tool’s xlnx_overlay_pl_dt script to generate programmable logic (PL) overlays for AMD FPGA devices. The two components represent different PL configuration approaches:

full Component

Purpose: Generates a complete PL overlay that includes all programmable logic IP blocks.

Use Case:

  • When you want all PL (FPGA fabric) IP blocks to be loaded as an overlay once Linux boot is completed

  • Suitable for static FPGA designs where all PL resources are programmed together

  • The entire PL configuration is treated as a single unit

What it does:

  • Removes all PL device tree nodes from the main PS device tree

  • Creates a separate pl.dtso file containing all PL IP blocks

  • This overlay can be applied to program the FPGA and register all PL peripherals with the kernel

  • Stored as pl-overlay-full/pl.dtso

Command:

$ gen-machine-conf --hw-description ./sdt_output/ -g full

dfx Component

Purpose: Generates a DFX (Dynamic Function eXchange) static overlay for partial reconfiguration designs.

Use Case:

  • For designs using DFX/partial reconfiguration where parts of the FPGA can be reprogrammed at runtime

  • Creates the static region overlay - the parts of the PL that remain constant

  • Dynamic regions can be loaded independently at runtime without affecting the static logic

What it does:

  • Extracts only the static (non-reconfigurable) PL IP blocks into the overlay

  • Allows dynamic partial bitstreams to be loaded later for the reconfigurable regions

Note

File generation conditions:

gen-machine-conf generates PL device tree files only when the hardware design contains enabled PL IP blocks. A PS-only design produces none.

With -g full, gen-machine-conf writes pl.dtso to build/conf/dts/${MACHINE}/pl-overlay-full/pl.dtso.

With -g dfx, gen-machine-conf writes the static overlay to build/conf/dts/${MACHINE}/pl-overlay-dfx/pl.dtso when the static region contains enabled PL IP blocks.

These paths assume the default -c and --dts-path settings. A custom -c places the files under that configuration directory.

gen-machine-conf does not generate or copy reconfigurable partition (RP) partial overlays into pl-overlay-dfx/. Use the partial overlays and matching partial PDI or bitstream files from the SDT handoff for RP firmware recipes.

Command:

$ gen-machine-conf --hw-description ./sdt_output/ -g dfx

For more information, see:

Boot Mode Configuration Options: --add-config

A custom board often boots from different media than the evaluation board the design started from, so set the primary boot mode when you generate the machine configuration. gen-machine-conf records the selection as DEFAULT_HW_BOOT_MODE in the generated <machine-name>.conf, and the build uses it to decide whether BOOT.BIN is packaged onto the boot media and which boot mode QEMU emulates.

Select the boot mode non-interactively with --add-config:

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf \
    --machine-name <unique-machine-name> \
    --add-config CONFIG_SUBSYSTEM_BOOTMODE_<value>=y

The numeric <value> is SoC-family specific. For example, CONFIG_SUBSYSTEM_BOOTMODE_8=y selects OSPI boot on Versal and Versal Gen 2, and CONFIG_SUBSYSTEM_BOOTMODE_5=y selects SD boot on Zynq-7000.

Available Boot Modes by SoC Family

The following table summarizes the boot media modes the generated Kconfig menu offers per SoC family, with the <value> to pass in CONFIG_SUBSYSTEM_BOOTMODE_<value>=y shown in parentheses. (For JTAG, see the note below the table.)

SoC Family

Primary Boot Mode (value)

Zynq-7000

QSPI (1), NOR (2), NAND (4), SD (5)

ZynqMP

QSPI 24b (1), QSPI 32b (2), SD0 2.0 (3), NAND (4), SD1 2.0 (5), eMMC 1.8 V (6), SD1 LS 3.0 (14)

Versal and Versal Net

QSPI24 (1), QSPI32 (2), SD0 v3.0 (3), SD1 v2.0 (5), eMMC1 v4.51 (6), OSPI (8), SD1 v3.0 (14)

Versal 2VE/2VM

QSPI24 (1), QSPI32 (2), SD0 v3.0 (3), SD0 v2.0 (5), eMMC v5.1 (6), OSPI (8), UFS (11), SD1 v3.0 (14)

The values are the boot mode encodings from the device documentation: UG585 (Zynq-7000), UG1085 (ZynqMP), AM011 (Versal), and AM026 (Versal Gen 2).

Note

JTAG (value 0) is not a primary boot mode. Selecting it leaves DEFAULT_HW_BOOT_MODE empty, so BOOT.BIN is not packaged into the generated disk image.

Interactive Selection

To pick the boot mode interactively instead, add --menuconfig to the same command and go to Subsystem Hardware Settings -> Boot Mode Settings -> Primary Boot Mode. Without an explicit selection, gen-machine-conf applies the Kconfig default for the detected SoC family.

gen-machine-conf Syntax for Custom Hardware

Using --template option:

$ gen-machine-conf parse-sdt \
    --template <path-to-your-own-template-yaml-file> \
    --hw-description <path-to-sdt-handoff-dir> \
    --machine-name <unique-machine-name>

Without template (default output location):

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    --machine-name <unique-machine-name>

Without template (custom layer output using -c):

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf \
    --machine-name <unique-machine-name>

gen-machine-conf Syntax for CED Based Designs for Eval Boards

Using --template option:

$ gen-machine-conf parse-sdt \
    --template <path-to-template-yaml-file> \
    --hw-description <path-to-sdt-handoff-dir> \
    -O <machine-override> \
    --machine-name <unique-machine-name>

Without template (default output location):

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -g full -O <machine-override> \
    --machine-name <unique-machine-name>

Without template (custom layer output using -c):

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full \
    -O <machine-override> --machine-name <unique-machine-name>

gen-machine-conf Syntax for Non CED Based Designs for Eval Boards

Using --template option:

$ gen-machine-conf parse-sdt \
    --template <path-to-template-yaml-file> \
    --hw-description <path-to-sdt-handoff-dir> \
    --machine-name <unique-machine-name>

Without template (default output location):

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -g full --machine-name <unique-machine-name>

Without template (custom layer output using -c):

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full \
    --machine-name <unique-machine-name>

gen-machine-conf Examples for Custom Hardware

The following examples demonstrate how to use gen-machine-conf with custom hardware across different platforms.

For VPK360 / Versal 2VP, use the Linux-only or multidomain BSP template and the shared Versal overlays described in Versal Premium Series Gen 2 (VPK360 / 2VP). The multidomain template selects the VPK360 Linux overlay and the PS Wizard OpenAMP overlay.

Versal:

versal-sdt-machine-file-example

Using a custom XSA for an eval board, with the --template option:

$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/versal-vck190-sdt-seg.yaml --hw-description <path-to-sdt-handoff-dir> -O versal-vck190-sdt-seg
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/versal-vek280-sdt-seg.yaml --hw-description <path-to-sdt-handoff-dir> -O versal-vek280-sdt-seg
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/versal-vmk180-sdt-seg.yaml --hw-description <path-to-sdt-handoff-dir> -O versal-vmk180-sdt-seg
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/versal-vpk120-sdt-seg.yaml --hw-description <path-to-sdt-handoff-dir> -O versal-vpk120-sdt-seg
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/versal-vpk180-sdt-seg.yaml --hw-description <path-to-sdt-handoff-dir> -O versal-vpk180-sdt-seg

Or, using the full command with multi-config options for an eval board with CED designs:

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-openamp-overlay.yaml \
    -O versal-vck190-sdt-seg
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-openamp-overlay.yaml \
    -O versal-vek280-sdt-seg
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-openamp-overlay.yaml \
    -O versal-vmk180-sdt-seg
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-openamp-overlay.yaml \
    -O versal-vpk120-sdt-seg
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-openamp-overlay.yaml \
    -O versal-vpk180-sdt-seg

Versal-2ve-2vm:

versal-2ve-2vm-sdt-machine-file-example

Using a custom XSA for an eval board, with the --template option:

$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/versal-2ve-2vm-vek385-sdt-seg.yaml --hw-description <path-to-sdt-handoff-dir> -O versal-2ve-2vm-vek385-sdt-seg
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/versal-2ve-2vm-vek385-revb-sdt-seg.yaml --hw-description <path-to-sdt-handoff-dir> -O versal-2ve-2vm-vek385-revb-sdt-seg
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/versal-2ve-2vm-vek386-sdt-seg.yaml --hw-description <path-to-sdt-handoff-dir> -O versal-2ve-2vm-vek386-sdt-seg
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/versal-2ve-2vm-vmk365-sdt-seg.yaml --hw-description <path-to-sdt-handoff-dir> -O versal-2ve-2vm-vmk365-sdt-seg

Or, using the full command with multi-config options for an eval board with CED designs:

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR52_1_BAREMETAL=y \
    --add-config CONFIG_SUBSYSTEM_TF-A_SERIAL_SERIAL1_SELECT=y \
    --add-config CONFIG_SUBSYSTEM_SERIAL_TF-A_IP_NAME="pl011_1" \
    --add-config CONFIG_SUBSYSTEM_OP-TEE_SERIAL_SERIAL1_SELECT=y \
    --add-config CONFIG_SUBSYSTEM_SERIAL_OP-TEE_IP_NAME="1" \
    --add-config CONFIG_SUBSYSTEM_UBOOT_APPEND_BASEADDR=disable \
    --add-config CONFIG_YOCTO_BBMC_MICROBLAZE_RISCV_ASU=disable \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-2ve-2vm-openamp-overlay.yaml \
    -O versal-2ve-2vm-vek385-sdt-seg
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR52_1_BAREMETAL=y \
    --add-config CONFIG_SUBSYSTEM_TF-A_SERIAL_SERIAL1_SELECT=y \
    --add-config CONFIG_SUBSYSTEM_SERIAL_TF-A_IP_NAME="pl011_1" \
    --add-config CONFIG_SUBSYSTEM_OP-TEE_SERIAL_SERIAL1_SELECT=y \
    --add-config CONFIG_SUBSYSTEM_SERIAL_OP-TEE_IP_NAME="1" \
    --add-config CONFIG_SUBSYSTEM_UBOOT_APPEND_BASEADDR=disable \
    --add-config CONFIG_YOCTO_BBMC_MICROBLAZE_RISCV_ASU=disable \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-2ve-2vm-openamp-overlay.yaml \
    -O versal-2ve-2vm-vek385-revb-sdt-seg
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR52_1_BAREMETAL=y \
    --add-config CONFIG_SUBSYSTEM_TF-A_SERIAL_SERIAL1_SELECT=y \
    --add-config CONFIG_SUBSYSTEM_SERIAL_TF-A_IP_NAME="pl011_1" \
    --add-config CONFIG_SUBSYSTEM_OP-TEE_SERIAL_SERIAL1_SELECT=y \
    --add-config CONFIG_SUBSYSTEM_SERIAL_OP-TEE_IP_NAME="1" \
    --add-config CONFIG_SUBSYSTEM_UBOOT_APPEND_BASEADDR=disable \
    --add-config CONFIG_YOCTO_BBMC_MICROBLAZE_RISCV_ASU=disable \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-2ve-2vm-openamp-overlay.yaml \
    -O versal-2ve-2vm-vek386-sdt-seg
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR52_1_BAREMETAL=y \
    --add-config CONFIG_SUBSYSTEM_TF-A_SERIAL_SERIAL1_SELECT=y \
    --add-config CONFIG_SUBSYSTEM_SERIAL_TF-A_IP_NAME="pl011_1" \
    --add-config CONFIG_SUBSYSTEM_OP-TEE_SERIAL_SERIAL1_SELECT=y \
    --add-config CONFIG_SUBSYSTEM_SERIAL_OP-TEE_IP_NAME="1" \
    --add-config CONFIG_SUBSYSTEM_UBOOT_APPEND_BASEADDR=disable \
    --add-config CONFIG_YOCTO_BBMC_MICROBLAZE_RISCV_ASU=disable \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/versal-2ve-2vm-openamp-overlay.yaml \
    -O versal-2ve-2vm-vmk365-sdt-seg

Note

If you are using the versal-2ve-2vm-vek385-sdt-seg machine override (the -O versal-2ve-2vm-vek385-sdt-seg option in the gen-machine-conf step), then you must make the following changes by modifying ./<path-to-layer>/sources/meta-custom-bsp/conf/machine/<machine-name>.conf for the 2026.2 release.

Update UBOOT_ENTRYPOINT and UBOOT_LOADADDRESS values to 0x20200000. If you fail to update this value, then Linux does not boot, as the EDF amd-cortexa78-mali-common machine boot.scr uses this address. See meta-amd-edf-core/recipes-bsp/u-boot/versal-2ve-2vm/amd_edf.h.

UBOOT_ENTRYPOINT ?= "0x20200000"
UBOOT_LOADADDRESS ?= "0x20200000"

Note

If you are using the versal-2ve-2vm-vek385-revb-sdt-seg machine override (the -O versal-2ve-2vm-vek385-revb-sdt-seg option in the gen-machine-conf step), then you must make the following changes by modifying ./<path-to-layer>/sources/meta-custom-bsp/conf/machine/<machine-name>.conf for the 2026.2 release.

Update UBOOT_ENTRYPOINT and UBOOT_LOADADDRESS values to 0x20200000. If you fail to update this value, then Linux does not boot, as the EDF amd-cortexa78-mali-common machine boot.scr uses this address. See meta-amd-edf-core/recipes-bsp/u-boot/versal-2ve-2vm/amd_edf.h.

UBOOT_ENTRYPOINT ?= "0x20200000"
UBOOT_LOADADDRESS ?= "0x20200000"

Note

If you are using the versal-2ve-2vm-vek386-sdt-seg machine override (the -O versal-2ve-2vm-vek386-sdt-seg option in the gen-machine-conf step), then you must make the following changes by modifying ./<path-to-layer>/sources/meta-custom-bsp/conf/machine/<machine-name>.conf for the 2026.2 release.

Update UBOOT_ENTRYPOINT and UBOOT_LOADADDRESS values to 0x20200000. If you fail to update this value, then Linux does not boot, as the EDF amd-cortexa78-mali-common machine boot.scr uses this address. See meta-amd-edf-core/recipes-bsp/u-boot/versal-2ve-2vm/amd_edf.h.

UBOOT_ENTRYPOINT ?= "0x20200000"
UBOOT_LOADADDRESS ?= "0x20200000"

Note

If you are using the versal-2ve-2vm-vmk365-sdt-seg machine override (the -O versal-2ve-2vm-vmk365-sdt-seg option in the gen-machine-conf step), then you must make the following changes by modifying ./<path-to-layer>/sources/meta-custom-bsp/conf/machine/<machine-name>.conf for the 2026.2 release.

Update UBOOT_ENTRYPOINT and UBOOT_LOADADDRESS values to 0x20200000. If you fail to update this value, then Linux does not boot, as the EDF amd-cortexa78-mali-common machine boot.scr uses this address. See meta-amd-edf-core/recipes-bsp/u-boot/versal-2ve-2vm/amd_edf.h.

UBOOT_ENTRYPOINT ?= "0x20200000"
UBOOT_LOADADDRESS ?= "0x20200000"

ZynqMP:

zynqmp-sdt-machine-file-example

Using a custom XSA for an eval board, with the --template option:

$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/zynqmp-zcu102-sdt-full.yaml --hw-description <path-to-sdt-handoff-dir> -O zynqmp-zcu102-sdt-full
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/zynqmp-zcu104-sdt-full.yaml --hw-description <path-to-sdt-handoff-dir> -O zynqmp-zcu104-sdt-full
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/zynqmp-zcu106-sdt-full.yaml --hw-description <path-to-sdt-handoff-dir> -O zynqmp-zcu106-sdt-full
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/zynqmp-zcu111-sdt-full.yaml --hw-description <path-to-sdt-handoff-dir> -O zynqmp-zcu111-sdt-full
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/zynqmp-zcu208-sdt-full.yaml --hw-description <path-to-sdt-handoff-dir> -O zynqmp-zcu208-sdt-full
$ gen-machine-conf parse-sdt --template ../sources/meta-amd-adaptive-socs/meta-amd-adaptive-socs-bsp/conf/machineyaml/zynqmp-zcu216-sdt-full.yaml --hw-description <path-to-sdt-handoff-dir> -O zynqmp-zcu216-sdt-full

Or, using the full command:

$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/zynqmp-openamp-overlay.yaml \
    -O zynqmp-zcu102-sdt-full
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/zynqmp-openamp-overlay.yaml \
    -O zynqmp-zcu104-sdt-full
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/zynqmp-openamp-overlay.yaml \
    -O zynqmp-zcu106-sdt-full
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/zynqmp-openamp-overlay.yaml \
    -O zynqmp-zcu111-sdt-full
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/zynqmp-openamp-overlay.yaml \
    -O zynqmp-zcu208-sdt-full
$ gen-machine-conf parse-sdt --hw-description <path-to-sdt-handoff-dir> \
    -c <path-to-layer>/sources/meta-custom-bsp/conf -g full --machine-name <machine-name> \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_1_FREERTOS=y \
    --add-config CONFIG_YOCTO_BBMC_CORTEXR5_0_BAREMETAL=y \
    --domain-file ../sources/meta-xilinx/meta-xilinx-standalone-sdt/conf/domainyaml/zynqmp-openamp-overlay.yaml \
    -O zynqmp-zcu216-sdt-full
  1. The newly generated machine configuration is placed in the build directory, and it supersedes the machine configuration available in existing Yocto Project meta layers. If you generate a new machine for a custom design, it is best practice to use a unique machine-name that does not conflict with any of the existing machines available in our meta layers.

For VEK280 and VCK190, follow Creating a Multi-stage Boot Image for the default EDF boot architecture. You can also use Creating a Bootable Single-stage Image if single-stage boot is preferred for your custom-hardware path.

For VPK120, VPK180, and VMK180, follow Creating a Bootable Single-stage Image for step-by-step instructions to build boot.bin, build the Linux disk image, and assemble bootable media.

For VPK360, follow Creating a Multi-stage Boot Image for step-by-step instructions to build boot.bin and boot firmware, build the Linux disk image, then flash and boot the board.

For the VEK385, VEK386 and VMK365, follow Creating a Multi-stage Boot Image for step-by-step instructions to build boot.bin and the boot firmware, build the Linux disk image, then flash and boot the board.

  1. Build Linux and BOOT.bin images the same way as described in Operating System Integration and Development AMD ZynqMP device portfolio

Building Images for Custom Hardware

After you generate the machine configuration, use the generated machine-name from the gen-machine-conf command above when you build the board-specific boot.bin. Build the Linux disk image with the common Yocto MACHINE for the device family.