zynqmp-arch

Arch Linux ARM for Xilinx Zynq UltraScale+ devices.

Installation

Required tools:

Linux-based host PC
Vitis 2024.1 or later
Statically-linked QEMU User space emulator for AArch64 + binfmt_misc configurations
- If you are using Arch Linux, you can use binfmt-qemu-static and qemu-user-static packages from the AUR (ArchWiki).
- You can also use the tonistiigi/binfmt container image.
arch-install-scripts
- We will use arch-chroot(8) to chroot into the target system.

Step1: Prepare the Hardware Design

Use Vivado to create the hardware design. After synth, impl, and generating bitstream, export the .xsa file by following the TCL command.

Vivado% write_hw_platform -fixed -include_bit system.xsa

Step2: Build Boot Loaders and Firmwares

Generate First Stage Boot Loader (fsbl) and PMU Firmware (pmufw) sources:

$ mkdir xsct && cd $_
$ cp /path/to/system.xsa .

$ xsct -nodisp -interactive <<'EOS'
hsi open_hw_design system.xsa

hsi create_sw_design fsbl -proc psu_cortexa53_0 -app zynqmp_fsbl
hsi set_property CONFIG.stdin  psu_uart_1 [hsi get_os]
hsi set_property CONFIG.stdout psu_uart_1 [hsi get_os]
hsi generate_app -app zynqmp_fsbl -dir fsbl
hsi close_sw_design [hsi current_sw_design]

hsi create_sw_design pmufw -proc psu_pmu_0 -app zynqmp_pmufw
hsi set_property CONFIG.stdin  psu_uart_1 [hsi get_os]
hsi set_property CONFIG.stdout psu_uart_1 [hsi get_os]
hsi generate_app -app zynqmp_pmufw -dir pmufw
hsi close_sw_design [hsi current_sw_design]
EOS

$ cd ..

Buils fsbl:
```
$ make -C xsct/fsbl
```

Build pmufw:

$ make -C xsct/pmufw

# or enabling Ultra96 customizations
$ make -C xsct/pmufw CFLAGS="-DENABLE_MOD_ULTRA96 -DULTRA96_VERSION=2 -DPMU_MIO_INPUT_PIN_VAL=1 -DBOARD_SHUTDOWN_PIN_VAL=1 -DBOARD_SHUTDOWN_PIN_STATE_VAL=1"

Build Xilinx/arm-trusted-firmware:

$ mkdir arm-trusted-firmware && cd $_
$ curl -L https://github.com/Xilinx/arm-trusted-firmware/archive/xilinx-v2024.1.tar.gz | \
    tar xz --strip-components=1 -C .

$ make CROSS_COMPILE=aarch64-linux-gnu- ARCH=aarch64 PLAT=zynqmp RESET_TO_BL31=1 ZYNQMP_CONSOLE=cadence1 -j16

$ cd ..

Build Xilinx/u-boot-xlnx:

$ mkdir u-boot-xlnx && cd $_
$ curl -L https://github.com/Xilinx/u-boot-xlnx/archive/xilinx-v2024.1.tar.gz | \
    tar xz --strip-components=1 -C .

$ make CROSS_COMPILE=aarch64-linux-gnu- ARCH=arm xilinx_zynqmp_virt_defconfig
$ make CROSS_COMPILE=aarch64-linux-gnu- ARCH=arm \
    DEVICE_TREE="<your-target-device-tree-name>" \
    -j16 u-boot.elf

$ cd ..

Create BOOT.BIN:

$ mkdir boot && cd $_
$ cp ../xsct/fsbl/executable.elf fsbl.elf
$ cp ../xsct/pmufw/executable.elf pmufw.elf
$ cp ../xsct/<bitstream_name>.bit bitstream.bit
$ cp ../arm-trusted-firmware/build/zynqmp/release/bl31/bl31.elf .
$ cp ../u-boot-xlnx/u-boot.elf .

$ cat > boot.bif <<EOS
all:
{
  [destination_cpu=a53-0, bootloader]                       fsbl.elf
  [destination_cpu=pmu]                                     pmufw.elf
  [destination_device=pl]                                   bitstream.bit
  [destination_cpu=a53-0, exception_level=el-3, trustzone]  bl31.elf
  [destination_cpu=a53-0, exception_level=el-2]             u-boot.elf
}
EOS

$ bootgen -arch zynqmp -image boot.bif -w -o BOOT.BIN

$ cd ..

Step3: Create Bootable SD Card

Partition the SD card:

Start fdisk:
```
$ sudo fdisk /dev/sdX
```
Clear out all partitions:
```
Command (m for help): o
```

Create the first partition (32 MiB, FAT16, for BOOT.BIN):

Command (m for help): n
Partition type
p   primary (0 primary, 0 extended, 4 free)
e   extended (container for logical partitions)
Select (default p): p
Partition number (1-4, default 1): 1
First sector (2048-15661055, default 2048):
Last sector, +/-sectors or +/-size{K,M,G,T,P} (2048-15661055, default 15661055): +32M

Created a new partition 1 of type 'Linux' and of size 32 MiB.

Command (m for help): t
Selected partition 1
Hex code or alias (type L to list all): e
Changed type of partition 'Linux' to 'W95 FAT16 (LBA)'.

Create the second partition (remaining space, bootable, for Linux rootfs):

Command (m for help): n
Partition type
p   primary (1 primary, 0 extended, 3 free)
e   extended (container for logical partitions)
Select (default p): p
Partition number (2-4, default 2):
First sector (67584-15661055, default 67584):
Last sector, +/-sectors or +/-size{K,M,G,T,P} (67584-15661055, default 15661055):

Created a new partition 2 of type 'Linux' and of size 7.4 GiB.

Command (m for help): a
Partition number (1,2, default 2):

The bootable flag on partition 2 is enabled now.

Write the partition table and exit:

Command (m for help): w
The partition table has been altered.
Calling ioctl() to re-read partition table.
Syncing disks.

Format partitions:

$ sudo mkfs.vfat -F 16 /dev/sdX1
$ sudo mkfs.ext4 /dev/sdX2

Download the latest Arch Linux ARM tarball and extract to the second partiton:

$ curl -LO http://os.archlinuxarm.org/os/ArchLinuxARM-aarch64-latest.tar.gz
$ curl -LO http://os.archlinuxarm.org/os/ArchLinuxARM-aarch64-latest.tar.gz.md5
$ md5sum -c ArchLinuxARM-aarch64-latest.tar.gz.md5

$ sudo mount /dev/sdX2 /mnt
$ sudo bsdtar -xpf ArchLinuxARM-aarch64-latest.tar.gz -C /mnt
$ sync

Chroot into the target system:

$ sudo arch-chroot /mnt /bin/bash

(chroot)# uname -m
aarch64

Initialize the pacman keyring:

(chroot)# pacman-key --init
(chroot)# pacman-key --populate archlinuxarm

Add zynqmp-arch package repository:

(chroot)# cat >> /etc/pacman.conf <<EOS

[zynqmp-arch]
SigLevel = Never
Server = https://zynqmp-arch.myon.info/\$arch
EOS

Add/Remove/Update packages:

Remove unneeded utilities:

(chroot)# pacman -Rncs netctl dhcpcd net-tools

Remove pre-installed kernel:
```
(chroot)# pacman -Rnd linux-aarch64
```
Update the system:
```
(chroot)# pacman -Syu
```
Install the kernel (linux-zynqmp):
```
(chroot)# pacman -S linux-zynqmp
```
Install Ultra96-V2 Wifi/BT driver (wilc3000-ultra96v2) and firmware (wilc-firmware):
```
(chroot)# pacman -S wilc3000-ultra96v2 wilc-firmware
```

Install wpa_supplicant for connecting Wifi:

(chroot)# pacman -S wireless_tools wpa_supplicant

Remove unrequired packages:
```
(chroot)# pacman -Rncs $(pacman -Qdtq)
```

Set passwords:

(chroot)# passwd
(chroot)# passwd alarm

Configure /etc/fstab and exit the chroot environment:

(chroot)# cat >> /etc/fstab <<EOS
/dev/mmcblk0p2 /     ext4 defaults 0 1
EOS

(chroot)# exit

Copy boot.scr to /boot:

$ vim /path/to/zynqmp-arch/boot/boot.cmd    # modify if needed
$ /path/to/u-boot-xlnx/tools/mkimage -c none -A arm64 -T script -d /path/to/zynqmp-arch/boot/boot.cmd boot.scr
$ sudo mv boot.scr /mnt/boot/
$ sudo umount /mnt

Copy BOOT.BIN (created in step2) to the first partition:

$ sudo mount /dev/sdX2 /mnt
$ sudo cp BOOT.BIN /mnt
$ sudo umount /mnt

Step4: Boot!

Insert the SD card and turn on the power. You will see the following messages via serial console.