PetaLinux Tools Documentation: Reference Guide - Xilinx

1 PetaLinux ToolsDocumentationReference GuideUG1144 ( ) July 24, 2020 See all versionsof this documentRevision HistoryThe following table shows the revision history for this Summary07/24/2020 Version H: Partitioning and Formatting an SD CardAdded a new Version 2: Setting Up Your EnvironmentAdded the Installing a Preferred eSDK as part of thePetaLinux Tool 4: Configuring and BuildingAdded the PetaLinux Commands with Equivalent devtoolCommands 6: Upgrading the WorkspaceAdded new sections: PetaLinux -upgrade Options, UpgradingBetween Minor Releases ( Tool with Tool) , Upgrading the Installed Tool with More Platforms, and Upgrading the Installed Tool with your 7: Customizing the ProjectAdded new sections: Creating Partitioned Images Using Wicand Configuring SD Card ext File System 8: Customizing the Root File SystemAdded the Appending Root File System Packages 10: Advanced ConfigurationsUpdated PetaLinux Menuconfig 11: Yocto FeaturesAdded the Adding Extra Users to the PetaLinux A: MigrationAdded Tool/Project Directory HistoryUG1144 ( ) July 24, 2020 Tools Documentation Reference Guide 2 Send FeedbackTable of ContentsRevision 1: 2: Setting Up Your 9 Installation Working Environment 14 Design Flow 3: Creating a BSP 17 Configuring Hardware Platform with Vivado Design Hardware Platform to PetaLinux 20 Creating an Empty Project from a 4.

2 Configuring and Hardware System Boot Image for Zynq UltraScale+ Boot Image for Zynq-7000 Boot Image for MicroBlaze Bitstream File for MicroBlaze 31 Build 5: Booting and Prebuilt PetaLinux -boot Command with Prebuilt a PetaLinux Image on a PetaLinux Image on Hardware with an SD a PetaLinux Image on Hardware with a PetaLinux Image on Hardware with ( ) July 24, 2020 Tools Documentation Reference Guide 3 Send FeedbackBSP 6: Upgrading the Between Minor Releases ( Tool with Tool) ..61 Upgrading the Installed Tool with More the Installed Tool with your Customized 7: Customizing the Version File System Type Images Storage Flash Partition Image INITRD 70 Configuring INITRAMFS 71 Configure TFTP NFS JFFS2 SD Card ext File System Partitioned Images Using 79 Chapter 8: Customizing the Root File Prebuilt Prebuilt 83 Creating and Adding Custom User and Adding Custom and Adding Custom Kernel User User User Auto Auto Run at an Existing Recipe into the Root File a Package Root File System ( ) July 24, 2020 Tools Documentation Reference Guide 4 Send FeedbackChapter 9.

3 The Linux Kernel in Applications with TCF Zynq UltraScale+ MPSoC Applications with Individual PetaLinux 10: Advanced Menuconfig Source Bootgen for On-target Use for Zynq Devices and Zynq UltraScale+ Out-of-tree Project 133 Chapter 11: Yocto Generation (Target Sysroot Generation)..139 Accessing BitBake/Devtool in a State Variant RootFS Packages Based on and Adding Patches for Software Components within a PetaLinux Extra Users to the PetaLinux 147 Chapter 12: Technical ..149 Appendix A: Directory 154DT Overlay and U-Boot Default B: PetaLinux Project 157 Project 160UG1144 ( ) July 24, 2020 Tools Documentation Reference Guide 5 Send FeedbackAppendix C: Generating Boot Stage Boot Loader for Zynq UltraScale+ and Zynq-7000 Trusted Firmware (ATF).

4 162 PMU for MicroBlaze Platform D: QEMU Virtual Networking Ports in Non-root the QEMU Virtual 166 Appendix E: Xilinx IP Models Supported by 167 Appendix F: Xen Zynq UltraScale+ MPSoC Prebuilt Linux as Built Linux as 170 Appendix G: Booting Prebuilt H: Partitioning and Formatting an SD 172 Appendix I: Additional Resources and Legal Navigator and Design Read: Important Legal 175UG1144 ( ) July 24, 2020 Tools Documentation Reference Guide 6 Send FeedbackChapter 1 OverviewIntroductionPetaLinux is an embedded Linux Software Development Kit (SDK) targeting FPGA-based system-on-a-chip (SoC) designs. This Guide helps the reader to familiarize with the tool enabling overallusage of are assumed to have basic Linux knowledge, such as how to run Linux commands.

5 Youshould be aware of OS and host system features, such as OS version, Linux distribution, securityprivileges, and basic Yocto PetaLinux tool contains: Yocto Extensible SDK (eSDK) XSCT ( Xilinx Software Command-Line Tool) and toolchains PetaLinux CLI toolsNote: Vitis unified software platform is the integrated design environment (IDE) for creating embeddedapplications on Xilinx microprocessors. Refer to Vitis Unified Software Platform Documentation: EmbeddedSoftware Development (UG1400) for more SDK is a Xilinx development tool that contains everything necessary to build, develop, test, anddeploy embedded Linux Extensible SDKThe following table details the four extensible SDKs 1: Extensible SDKsPathArchitecture$ PetaLinux /component s/yocto/source/aarch64 Zynq UltraScale+ MPSoC$ PetaLinux /components/yocto/source/ armZynq-7000 devices$ PetaLinux /components/yocto/sourc e/microblaze_fullMicroBlaze platform full designs$ PetaLinux /components/yocto/sourc e/microblaze_liteMicroBlaze platform lite designsChapter 1: OverviewUG1144 ( ) July 24, 2020 Tools Documentation Reference Guide 7 Send FeedbackNote.

6 Earlier, the eSDKs were extracted in the specified path but now they are in tar. For and futurereleases, your eSDK scripts have the same name and are extracted into <plnx-proj-root>/components/yocto when you run the PetaLinux -config or the PetaLinux -build command inthe PetaLinux project. The project extracts the corresponding eSDK, for example, if you create a ZynqUltraScale+ MPSoC project, then only the aarch64 eSDK is extracted into the <plnx-proj-root>/components/yocto and toolchainsFor all embedded software applications (non-Linux), the PetaLinux tool uses XSCT Linux toolchain for all three architectures is from Command Line Interface (CLI) toolsThis contains all the PetaLinux commands that you require. The CLI command Tools are: PetaLinux -create PetaLinux -config PetaLinux -build PetaLinux -util PetaLinux -package PetaLinux -upgradeChapter 1: OverviewUG1144 ( ) July 24, 2020 Tools Documentation Reference Guide 8 Send FeedbackChapter 2 Setting Up Your EnvironmentInstallation StepsInstallation RequirementsThe PetaLinux Tools installation requirements are: Minimum workstation requirements: 8 GB RAM (recommended minimum for Xilinx Tools ) 2 GHz CPU clock or equivalent (minimum of eight cores) 100 GB free HDD space Supported OS.

7 - Red Hat Enterprise Workstation/Server , , , (64-bit)- CentOS Workstation/Server , , , (64-bit)- Ubuntu Linux Workstation/Server , , , , , (64-bit) You need to have root access to install the required packages mentioned in the followingtable. The PetaLinux Tools need to be installed as a non-root user. PetaLinux requires a number of standard development Tools and libraries to be installed onyour Linux host workstation. Install the libraries and Tools listed in the following table on thehost Linux. PetaLinux Tools require that your host system /bin/sh is 'bash'. If you are using Ubuntudistribution and your /bin/sh is 'dash', consult your system administrator to change yourdefault system shell /bin/sh with the sudo dpkg-reconfigure dash 2: Setting Up Your EnvironmentUG1144 ( ) July 24, 2020 Tools Documentation Reference Guide 9 Send FeedbackTable 2: Packages and Linux Workstation EnvironmentsTool / LibraryCentOS Workstation/Server , , , (64-bit)Red Hat EnterpriseWorkstation/Server , , , , (64-bit)Ubuntu , , , , , (64-bit)ipiprouteiprouteiproute2gccgccgc cgccg++ (gcc-c++)gcc-c++gcc-c++g++netstatnet-too lsnet-toolsnet-toolsncursesdevelncurses- develncurses-devellibncurses5-devzlib devel (also,install 32-bit ofthis version)zlib-develzlib-develzlib1g.

8 I386openssldevelopenssl-developenssl-dev el ++libstdc++.x86_64libstdc++.i686libstdc+ +.x86_64libstdc++.i686-gawkgawkgawkgawkp ython3python3python3python3python3-pexpe ctpython3-pexpectpython3-pippython3-pipp ython3-pippython3-pippython3-GitPythonpy thon3-GitPythonpython3-GitPythonpython3- gitpython3-jinja2python3-jinja2python3-j inja2python3-jinja2perlperlperl_Chapter 2: Setting Up Your EnvironmentUG1144 ( ) July 24, 2020 Tools Documentation Reference Guide 10 Send FeedbackTable 2: Packages and Linux Workstation Environments (cont'd)Tool / LibraryCentOS Workstation/Server , , , (64-bit)Red Hat EnterpriseWorkstation/Server , , , , (64-bit)Ubuntu , , , , , (64-bit) : For the exact package versions, refer to the PetaLinux Release Notes and Master AnswerRecord: !

9 Consult your system administrator if you are not sure about the correct procedures for host systempackage ! PetaLinux works only with hardware designs exported from Vivado Design The PetaLinux Tools installation requirements are met. See the Installation Requirements formore information. The PetaLinux installer is downloaded. You can download PetaLinux installer from the PetaLinux ToolWithout any options, the PetaLinux tool are installed into the current working < PetaLinux -version> Chapter 2: Setting Up Your EnvironmentUG1144 ( ) July 24, 2020 Tools Documentation Reference Guide 11 Send FeedbackAlternatively, you can specify an installation < PetaLinux -version> [--log <LOGFILE>] [-d|--dir <INSTALL_DIR>] [options]Table 3: PetaLinux Installer OptionsOptionsDescription--log <LOGFILE>Specifies where the logfile should be created.

10 By default, it ispetalinux_installation_log in your working |--dir [INSTALL_DIR]Specifies the directory where you want to install the tool not specified, the tool kit is installed in your |--platform <arch_name>Specifies the architecture:aarch64: Sources for Zynq UltraScale+ MPSoC : sources for Zynq : sources for microblaze_litemicroblaze_full: sources for microblaze_fullFor example: To install PetaLinux Tools under /opt/pkg/ PetaLinux /< PetaLinux -version>:$ mkdir -p /opt/pkg/ PetaLinux /< PetaLinux -version>$ ./ PetaLinux -v< PetaLinux -version> --dir /opt/pkg/ PetaLinux /< PetaLinux -version>Note: Do not change the install directory permissions to CHMOD 775 as it might cause BitBake installs the PetaLinux tool into the /opt/pkg/ PetaLinux /< PetaLinux -version>directory.