docker-petalinux2

A somehow generic Xilinx PetaLinux & Vivado Docker image, using Ubuntu 18.04 as the base image.

PetaLinux version 2020.1 is the first version handled by this release, and the default version is 2021.2. For former versions, please check docker-petalinux.

In order to use this tool, you need to install Docker in your machine. If you want to use the Vivado/Vitis graphical interface, you will also need the ipconfig utility (on Debian/Ubuntu: sudo apt-get install net-tools).

A Xilinx user ID is required to download the PetaLinux and Vivado installers.

Download the installers

Prepare the PetaLinux installer

The PetaLinux Installer is to be downloaded from the Xilinx's Embedded Design Tools website.

Place the downloaded petalinux-v<VERSION>-final-installer.run file (where <VERSION> can be 2020.1, 2021.2, ...) in the ./installers folder.

Prepare the Vivado / Vitis installer (optional)

Optionally, Vivado and Vitis can be downloaded from the Xilinx's Vivado Design Tools website. Go there and choose the All OS installer Single-File Download (TAR/GZIP).

The file is called something like Xilinx_Unified_<VERSION>_XXXX_YYYY.tar.gz. Place it in the ./installers folder. The building script will guess its exact name automatically.

Note for version 2021.2: You will need two extra files:

• y2k22_patch-1.2.zip, downloadable from https://support.xilinx.com/s/article/76960?language=en_US
• Xilinx_Vivado_Vitis_Update_2021.2.1_1219_1431.tar.gz, downloadable from https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/vivado-design-tools/archive.html Please place both files in the installers/ folder.

The Docker image will be about 210 GB so make sure you have enough space in /var/lib/docker. Be aware that the building process can take some hours.

If this file is present when building the image, the Docker image will be about 138 GB so make sure you have enough space in /var/lib/docker. Be aware that the building process can take some hours.

You can change your Docker disk utilization in the Docker GUI: select the Docker icon and then Preferences > Resources > Advanced, and then click "Apply & Restart".

For other versions than 2021.2, you might need to tune the Vivado installing configuration by modifying the install_config.txt file. Please do not change the Destination=/tools/Xilinx entry. This file can be generated by unzipping the installer somewhere else and running:

./xsetup -b ConfigGen

Then, copy the file generated at ~/.Xilinx/install_config.txt over the file in this repository. Just be sure to set Destination=/tools/Xilinx as the path where Xilinx software will be installed on the image.

If the Vivado installer file is not present in the folder when running the building script, the petalinux-only image will be about 14 GB and the building process will be much faster.

Build the image

Run:

./docker_build.sh <VERSION>

The default for <VERSION>, if not specified, is 2021.2.

Work with a PetaLinux project

A helper script petalin2.sh is provided that should be run inside a petalinux project directory. It basically is a shortcut to:

docker run -ti -v "$PWD":"$PWD" -w "$PWD" --rm -u petalinux docker_petalinux2:<latest version> $@

When run without arguments, a shell will spawn, with PetaLinux settings.sh already sourced, so you can directly execute petalinux-* commands.

user@host:/path/to/petalinux_project$ /path/to/petalin2.sh
petalinux2@host:/path/to/petalinux_project$ petalinux-build

Otherwise, the arguments will be executed as a command. Example:

user@host:/path/to/petalinux_project$ /path/to/petalin2.sh \
"petalinux-create -t project --template zynq --name myproject"

Using Vivado / Vitis graphical interface

If the Vivado installer was present when building the Docker image, you can execute Vivado and Vitis from the shell spawn when running petalin2.sh.

There are some steps on your side if you want to make use of Vivado's graphical interface before running the Docker container.

• If your local machine is running Linux, adjust the permission of the X server host:

  $ sudo apt-get install x11-xserver-utils
  $ xhost +local:root
  

• If your local machine is running macOS:

  • Do this once:

    • Install the latest XQuartz version and run it.
    • Activate the option "Allow connections from network clients" in XQuartz settings.
    • Quit and restart XQuartz to activate the setting.

  • Then, in the host machine:

    • Get your network IP with ipconfig getifaddr en1 for wireless, or ipconfig getifaddr en0 for ethernet.

    • Tell XQuartz to accept connections from that IP:

      $ xhost + 127.0.0.1 ; <- YOUR NETWORK IP HERE, OR REMOTE IP HOST
      

• If you are accessing remotely to the machine running the Docker container via ssh, you need to enable trusted X11 forwarding with the -Y flag:

  $ ssh user@host -Y
  

Now you can try it:

user@host:/path/to/petalinux_project$ /path/to/petalin2.sh
petalinux2@host:/path/to/petalinux_project# vivado

Enjoy!

Copyright and License

Copyright: © 2021-2023 Carles Fernández-Prades, CTTC. All rights reserved.

The content of this repository is published under the MIT license.

Acknowledgements

This work was partially supported by the Spanish Ministry of Science, Innovation, and Universities through the Statistical Learning and Inference for Large Dimensional Communication Systems (ARISTIDES, RTI2018-099722-B-I00) project.