Skip to content

README.md

Latest commit

 

History

History
152 lines (114 loc) · 6.13 KB

README.md

File metadata and controls

152 lines (114 loc) · 6.13 KB
Raw

Agilex™ 7 Precision Time Protocol System Example Design - Software

Description

The System Example Design software repo helps in building the required software pieces to run Linux on the HPS subsystem to enable 1588PTP on Agilex™ 7 FPGA I-Series Transceiver-SoC Development Kit. This repository is based out of the GSRD Yocto repository. A particular Yocto version is chosen which is both supported long term and is stable for this release. It builds the following SW entities

  • Linux kernel - A branch out of the socfpga-linux repo which has all the drivers and kernel code
  • U-Boot - A long term stable version supported by GSRD on this Yocto version
  • ATF - A long term stable version supported by GSRD on this Yocto version
  • Root filesystem - File system built by Yocto with all required SW components for SD-Card boot up.

Directory Structure used in this example design:

.
├── artifacts
│   └── u-boot-spl-dtb.hex
└── yocto
   ├── meta-agilex7-sed
   ├── meta-clang
   ├── meta-intel-fpga
   ├── meta-intel-fpga-refdes
   ├── meta-openembedded
   ├── poky
   ├── agilex7_dk_si_agi027fc-PTP_2P100G_MCQ_ANLT-build.sh -> build.sh
   ├── agilex7_dk_si_agi027fc-PTP_2P100G_MCQ-build.sh -> build.sh
   ├── agilex7_dk_si_agi027fc-PTP_2P10G_MCQ_ANLT-build.sh -> build.sh
   ├── agilex7_dk_si_agi027fc-PTP_2P10G_MCQ-build.sh -> build.sh
   ├── agilex7_dk_si_agi027fc-PTP_2P25G_MCQ_ANLT-build.sh -> build.sh
   ├── agilex7_dk_si_agi027fc-PTP_2P25G_MCQ-build.sh -> build.sh
   ├── agilex7_dk_si_agi027fc-PTP_2P50G_MCQ_ANLT-build.sh -> build.sh
   ├── agilex7_dk_si_agi027fc-PTP_2P50G_MCQ-build.sh -> build.sh
   ├── agilex7_dk_si_agi027fc-PTP_2P_MCQ_DR-build.sh -> build.sh
   ├── build.sh

Getting Started

Configuring the Board

Please refer to Running the GSRD to get details on how to setup the board. At the end of this setup, the system needs to be a HPS first boot system with its SD card programmed to boot the design after a power cycle. The link provides description to do the following

  • Burn the HPS first jic file to the QSFP flash to setup HPS first boot system
  • Burn the sd card wic image to the bootable SD card.

Please use the specific file provided in the release directory tag to burn the images for direct boot up. The below procedure assumes that this repo has been cloned.

Yocto Build

As described earlier, the Yocto builds everything required for a boot of the devkit with the design. To start building please use the devkit and configuration specific script based on the Datarate and ANLT option.

Start the Yocto build process by executing the following command:

For an ANLT configuration(10GbE),

cd <BASEDIR>/src/sw/yocto
. agilex7_dk_si_agi027fc-PTP_2P10G_MCQ_ANLT-build.sh
build_default

For a non-ANLT configuration, use the following commands instead:

cd <BASEDIR>/src/sw/yocto
. agilex7_dk_si_agi027fc-PTP_2P10G_MCQ-build.sh
build_default

After a successful build, all required images are stored in the <BASEDIR>/src/sw/yocto/agilex7_dk_si_agi027fc-gsrd-images` directory. Build time varies depending on the host system's resource specifications.

You can use below scripts for other datarates for configuration specific compilation.

  • For 100GbE with ANLT : agilex7_dk_si_agi027fc-PTP_2P100G_MCQ_ANLT-build.sh
  • For 100GbE with non-ANLT : agilex7_dk_si_agi027fc-PTP_2P100G_MCQ-build.sh
  • For 50GbE with ANLT : agilex7_dk_si_agi027fc-PTP_2P50G_MCQ_ANLT-build.sh
  • For 50GbE with non-ANLT : agilex7_dk_si_agi027fc-PTP_2P50G_MCQ-build.sh
  • For 25GbE with ANLT : agilex7_dk_si_agi027fc-PTP_2P25G_MCQ_ANLT-build.sh
  • For 25GbE with non-ANLT : agilex7_dk_si_agi027fc-PTP_2P25G_MCQ-build.sh
  • For 10G/25G DR supported image : 'agilex7_dk_si_agi027fc-PTP_2P_MCQ_DR-build.sh `

Linux kernel build

You can build the Linux kernel alone for debugging purposes. The below steps will help you create a new Linux kernel from the base linux repo. Download toolchain from https://developer.arm.com/-/media/Files/downloads/gnu/11.3.rel1/binrel/arm-gnu-toolchain-11.3.rel1-x86_64-aarch64-none-linux-gnu.tar.xz extract it.

$ export ARCH=arm64;
$ export CROSS_COMPILE=`pwd`/arm-gnu-toolchain-11.3.rel1-x86_64-aarch64-none-linux-gnu/bin/aarch64-none-linux-gnu-
$ git clone https://github.com/altera-fpga/linux-socfpga.git -b socfpga-6.12.19-lts-ethernet-sed
$ cd linux-socfpga/
$ git checkout <tag>
$ make defconfig
$ make menuconfig

Enable the configs listed:

  • <yocto>/meta-agilex7-sed/recipes-kernel/linux/linux-socfpga-lts/config_eth.cfg
  • <yocto>/meta-agilex7-sed/recipes-kernel/linux/linux-socfpga-lts/config_mcq.cfg You can also copy the example .config present at <BASEDIR>/agi027fc-si-devkit/src/sw/artifacts/
$ make -j32

Generating the kernel_sed.itb

$ mkdir kernel
$ cd kernel

Copy fit_kernel_agilex7_dk_si_agi027fc_sed_PTP_2P25G_MCQ.its and ghrd.core.rbf from release content

$ cp ../arch/arm64/boot/dts/intel/socfpga_fm87_ftile_25g_2port_mcq_ptp.dtb .
$ cp ../arch/arm64/boot/Image Image
$ xz --format=lzma Image
$ mkimage -f fit_kernel_agilex7_dk_si_agi027fc_sed_PTP_2P25G_MCQ.its kernel_sed.itb

Building the ATF - Arm Trusted Firmware from source

Follow the steps below to build the ATF from source

$ git clone https://github.com/altera-fpga/arm-trusted-firmware.git
$ cd arm-trusted-firmware
$ git checkout <tag>
$ make bl31 CROSS_COMPILE=$CROSS_COMPILE PLAT=agilex DEPRECATED=1

Building u-boot from source

Follow the steps below to build UBoot

$ git clone https://github.com/altera-fpga/u-boot-socfpga.git
$ cd u-boot-socfpga
$ git checkout <tag>

Copy the generated bl31.bin (generated during build from ATF source or Yocto build) to u-boot home folder. Copy the gsrd-console-image-agilex7.cpio from the release folder.

$ make socfpga_agilex_defconfig
$ make -j32

u-boot.itb will be created, you can replace the u-boot.itb present on the target with this file.