Skip to content

Commit

Permalink
Platform/Ampere: Add scripts to help building and flashing firmware
Browse files Browse the repository at this point in the history 
Add scripts which help users to build and flash firmware images for
platforms based on the Ampere Altra SoC.

'buildfw.sh' can be used to build images containing just UEFI, or if
the TF-A (ATF) binary is present TF-A + UEFI and complete 32MB SPI-NOR
images. If the SYS (SMPro and PMPro microprocessors) binary is also
present then a capsule update file for the SYS/SCP component of the SOC
will also be built. Usage:

Usage:
  ./Platform/Ampere/buildfw.sh [options]

Options:
  -b <bldtype>, --build <bldtype>  Specify the build type: DEBUG or
                                   RELEASE
  -t <tc>, --toolchain <tc>        Specify the toolchain to use: GCC or
                                   CLANG
  -m <mfg>, --manufacturer <mfg>   Specify platform manufacturer
                                   (e.g. Ampere)
  -p <plat>, --platform <plat>     Specify platform to build (e.g. Jade)
  -l <kern>, --linuxboot <kern>    Build LinuxBoot firmware instead of
           full EDK2 with UEFI Shell, specifying path to flashkernel
  -f, --flash                      Copy firmware to BMC and flash
           firmware (keeping EFI variables and NVPARAMs) after building
  -F, --full-flash                 Copy firmware to BMC and flash full
           EEPROM (resetting EFI variables and NVPARAMs) after building

  Note: flash options require bmc.sh file with env vars BMC_HOST, BMC_USER and BMC_PASS defined

  Available manufacturers:
    ADLINK
    Ampere
    ASRockRack

  Available platforms:
    ADLINK     -> ComHpcAlt
    Ampere     -> Jade
    ASRockRack -> Altrad8ud2

'fwver.sh' is used by buildfw.sh to keep track of the number of builds
done, so that firmware files of the format e.g.
comhpcalt_uefi_2024-10-22-5.bin are created along with displaying the
date including build number during boot.

'fwflash.sh' automates flashing the host firmware when the target
system is running a BMC with OpenBMC. 'fwflash.exp' is a helper
script used by 'fwflash.sh' to ssh into the BMC and run the
ampere_flash_bios.sh utility. Usage:

Copies firmware to the BMC (running OpenBMC) and runs
               ampere_flash_bios.sh to flash the host.
Usage:
  fwflash.sh [options] <Host firmware file>

Options:
  -f, --full   Flash the entire SPI-NOR chip (default)
  -c, --code   Flash the code (TF-A + UEFI) area
  -t, --tfa    Flash the TF-A (ATF) area
  -u, --uefi   Flash the UEFI area
  -h, --help   This help message

Note: TF-A (Trusted Firmware for ARMv8-A) is the same as ATF
      (ARM Trusted Firmware).

Signed-off-by: Rebecca Cran <[email protected]>
  • Loading branch information
Rebecca Cran committed Oct 22, 2024
1 parent 82794ca commit b6d9ce2
Show file tree
Hide file tree
Showing 4 changed files with 406 additions and 0 deletions.
283 changes: 283 additions & 0 deletions Platform/Ampere/buildfw.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
#!/usr/bin/env bash

set -e

tfa_usage () {
echo -n "cert_create or fiptool could not be found. If running on a "
echo -n "Debian-based distro (e.g. Ubuntu) you can get them by "
echo "installing the arm-trusted-firmware-tools package."
echo -n "Otherwise, you can build them and add them to the \$PATH by "
echo "running the following commands:"
echo
echo " git clone --depth 1 https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git"
echo " pushd trusted-firmware-a"
echo " ${MAKE_COMMAND} fiptool"
echo " ${MAKE_COMMAND} certtool"
echo " export PATH=\$PWD/tools/cert_create:\$PWD/tools/fiptool:\$PATH"
echo " popd"
exit 1
}

usage () {
echo "Usage:"
echo " $0 [options]"
echo
echo "Options:"
echo " -b <bldtype>, --build <bldtype> Specify the build type: DEBUG or RELEASE"
echo " -t <tc>, --toolchain <tc> Specify the toolchain to use: GCC or CLANG"
echo " -m <mfg>, --manufacturer <mfg> Specify platform manufacturer (e.g. Ampere)"
echo " -p <plat>, --platform <plat> Specify platform to build (e.g. Jade)"
echo " -l <kern>, --linuxboot <kern> Build LinuxBoot firmware instead of full EDK2 with UEFI Shell, specifying path to flashkernel"
echo " -f, --flash Copy firmware to BMC and flash firmware (keeping EFI variables and NVPARAMs) after building"
echo " -F, --full-flash Copy firmware to BMC and flash full EEPROM (resetting EFI variables and NVPARAMs) after building"
echo ""
echo " Note: flash options require bmc.sh file with env vars BMC_HOST, BMC_USER and BMC_PASS defined"
echo ""
echo " Available manufacturers:"
echo " ADLINK"
echo " Ampere"
echo " ASRockRack"
echo ""
echo " Available platforms:"
echo " ADLINK -> ComHpcAlt"
echo " Ampere -> Jade"
echo " ASRockRack -> Altrad8ud2"

exit 1
}

ctrl_c() {
popd
}

TFA_VERSION=2.10.20230517
SCP_VERSION=2.10.20230517

TFA_SLIM=$PWD/altra_atf_signed_${TFA_VERSION}.slim
SCP_SLIM=$PWD/altra_scp_signed_${SCP_VERSION}.slim

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && pwd)"
ROOT_DIR=$(realpath ${SCRIPT_DIR}/../../..)
trap ctrl_c INT
pushd "${ROOT_DIR}"

SPI_SIZE_MB=32

MANUFACTURER=Ampere
BOARD_NAME=Jade
SCRIPTS_DIR=$PWD/edk2-ampere-tools/

FLASHFW=0
RESET_NV_STORAGE=0
TOOLCHAIN=GCC
BLDTYPE=RELEASE
BUILD_THREADS=$(getconf _NPROCESSORS_ONLN)

export PYTHON_COMMAND=python3
export WORKSPACE=$PWD

RENESAS_UPD720202_FIRMWARE="${WORKSPACE}/K2026090.mem"

if [ "$(uname -o)" = "FreeBSD" ]; then
MAKE_COMMAND=gmake
GETOPT_COMMAND=/usr/local/bin/getopt
if ! command -v ${GETOPT_COMMAND} >/dev/null 2>&1; then
echo "GNU getopt is required. Please install the getopt package."
exit 1
fi
if ! command -v ${MAKE_COMMAND} >/dev/null 2>&1; then
echo "GNU make is required. Please install the gmake package."
exit 1
fi
mkdir bin || true
ln -sfv /usr/local/bin/gmake bin/make
export PATH=$PWD/bin:$PATH
else
MAKE_COMMAND=make
GETOPT_COMMAND=getopt
fi

if ! command -v cert_create >/dev/null 2>&1; then
tfa_usage
fi

if ! command -v fiptool >/dev/null 2>&1; then
tfa_usage
fi

if ! command -v python3 >/dev/null 2>&1; then
echo "Could not find python3. Please install the python3 package."
exit 1
fi

OPTIONS=$(${GETOPT_COMMAND} -o t:b:fFhl:m:p: --long toolchain:,build:,linuxboot:,manufacturer:,platform:,flash,full-flash,help -- "$@")
eval set -- "$OPTIONS"

while true; do
case "$1" in
-t|--toolchain)
TOOLCHAIN=$2; shift 2;;
-b|--build)
BLDTYPE=$2; shift 2;;
-f|--flash)
FLASHFW=1; shift;;
-F|--full-flash)
FLASHFW=1; RESET_NV_STORAGE=1; shift;;
-l|--linuxboot)
LINUXBOOT=LinuxBoot; FLASHKERNEL=$2; shift 2;;
-m|--manufacturer)
MANUFACTURER=$2; shift 2;;
-p|--platform)
BOARD_NAME=$2; shift 2;;
-h|--help)
usage; shift;;
--) shift; break;;
*) echo "Internal error ($1)!"; exit 1;;
esac
done

eval set -- ""

BOARD_SETTINGS_CFG=edk2-platforms/Platform/${MANUFACTURER}/${BOARD_NAME}Pkg/${BOARD_NAME}BoardSetting.cfg
OUTPUT_BIN_DIR=$PWD/Build/${BOARD_NAME}
OUTPUT_BOARD_SETTINGS_BIN=${OUTPUT_BIN_DIR}/$(basename ${BOARD_SETTINGS_CFG}).bin

export PACKAGES_PATH=$PWD:$PWD/edk2:$PWD/edk2-non-osi:$PWD/edk2-platforms:$PWD/edk2-platforms/Platform/${MANUFACTURER}/${BOARD_NAME}Pkg:$PWD/edk2-platforms/Features/Intel/Debugging:$PWD/edk2-platforms/Features:$PWD/edk2-platforms/Features/Intel

case $(uname -m) in
"x86_64")
if [ "$TOOLCHAIN" = "GCC" -a -z "${GCC_AARCH64_PREFIX}" ]; then
echo "Error: need to define \$GCC_AARCH64_PREFIX since the native compiler won't work"
exit 1
fi
;;
esac

if [ "${TOOLCHAIN}" = "CLANG" ]; then
TOOLCHAIN=CLANGDWARF
fi

if [ -n "${LINUXBOOT}" ]; then
if [ ! -f "${FLASHKERNEL}" ]; then
echo "LinuxBoot flashkernel file \"${FLASHKERNEL}\" does not exist."
exit 1
else
cp -vf "${FLASHKERNEL}" "${WORKSPACE}/edk2-platforms/Platform/Ampere/LinuxBootPkg/AArch64/flashkernel"
fi
fi

mkdir -p "${OUTPUT_BIN_DIR}"
cp -v "${BOARD_SETTINGS_CFG}" "${OUTPUT_BIN_DIR}/$(basename ${BOARD_SETTINGS_CFG}).txt"
python3 "${SCRIPTS_DIR}/nvparam.py" -f "${BOARD_SETTINGS_CFG}" -o "${OUTPUT_BOARD_SETTINGS_BIN}"
rm -fv "${OUTPUT_BOARD_SETTINGS_BIN}.padded"

${MAKE_COMMAND} -C edk2/BaseTools -j ${BUILD_THREADS}

. "${WORKSPACE}/edk2-platforms/Platform/Ampere/fw_ver.sh" UPDATE
. edk2/edksetup.sh

EDK2_SECURE_BOOT_ENABLE=${EDK2_SECURE_BOOT_ENABLE:-TRUE}
EDK2_NETWORK_ENABLE=${EDK2_NETWORK_ENABLE:-FALSE}
EDK2_INCLUDE_TFTP_COMMAND=${EDK2_INCLUDE_TFTP_COMMAND:-FALSE}
EDK2_NETWORK_IP6_ENABLE=${EDK2_NETWORK_IP6_ENABLE:-FALSE}
EDK2_NETWORK_ALLOW_HTTP_CONNECTIONS=${EDK2_NETWORK_ALLOW_HTTP_CONNECTIONS:-FALSE}
EDK2_NETWORK_TLS_ENABLE=${EDK2_NETWORK_TLS_ENABLE:-FALSE}
EDK2_REDFISH_ENABLE=${EDK2_REDFISH_ENABLE:-FALSE}
EDK2_PERFORMANCE_MEASUREMENT_ENABLE=${EDK2_PERFORMANCE_MEASUREMENT_ENABLE:-FALSE}
EDK2_TPM2_ENABLE=${EDK2_TPM2_ENABLE:-TRUE}

if [ "${BLDTYPE}" = "RELEASE" ]; then
EDK2_HEAP_GUARD_ENABLE=FALSE
else
EDK2_HEAP_GUARD_ENABLE=TRUE
fi

EXTRA_BUILD_FLAGS=""
if [ -e "${RENESAS_UPD720202_FIRMWARE}" ]; then
EXTRA_BUILD_FLAGS="-D RENESAS_XHCI_FW_DIR=${WORKSPACE}"
fi

if [ "${BOARD_NAME}" = "ComHpcAlt" ] && [ ! -e "${RENESAS_UPD720202_FIRMWARE}" ]; then
echo "Error: Renesas UPD720202 USB3 Controller firmware file ${RENESAS_UPD720202_FIRMWARE} not found."
echo "See edk2-platforms/Drivers/OptionRomPkg/RenesasFirmwarePD720202/README.md for details on how to obtain it."
exit 1
fi

build -a AARCH64 -t ${TOOLCHAIN} -b ${BLDTYPE} -n ${BUILD_THREADS} \
-D FIRMWARE_VER="${VER}-${BUILD} TF-A ${TFA_VERSION}" \
-D MAJOR_VER=${MAJOR_VER} -D MINOR_VER=${MINOR_VER} \
-D SECURE_BOOT_ENABLE=${EDK2_SECURE_BOOT_ENABLE} \
-D NETWORK_ENABLE=${EDK2_NETWORK_ENABLE} \
-D INCLUDE_TFTP_COMMAND=${EDK2_INCLUDE_TFTP_COMMAND} \
-D NETWORK_IP6_ENABLE=${EDK2_NETWORK_IP6_ENABLE} \
-D NETWORK_ALLOW_HTTP_CONNECTIONS=${EDK2_NETWORK_ALLOW_HTTP_CONNECTIONS} \
-D NETWORK_TLS_ENABLE=${EDK2_NETWORK_TLS_ENABLE} \
-D REDFISH_ENABLE=${EDK2_REDFISH_ENABLE} \
-D PERFORMANCE_MEASUREMENT_ENABLE=${EDK2_PERFORMANCE_MEASUREMENT_ENABLE} \
-D TPM2_ENABLE=${EDK2_TPM2_ENABLE} \
-D HEAP_GUARD_ENABLE=${EDK2_HEAP_GUARD_ENABLE} \
-Y COMPILE_INFO -y BuildReport.log \
-p Platform/${MANUFACTURER}/${BOARD_NAME}Pkg/${BOARD_NAME}${LINUXBOOT}.dsc \
${EXTRA_BUILD_FLAGS}

OUTPUT_BASENAME=${OUTPUT_BIN_DIR}/${BOARD_NAME,,}_tfa_uefi_${BLDTYPE,,}_${VER}-${BUILD}

OUTPUT_UEFI_IMAGE=Build/${BOARD_NAME}/${BOARD_NAME,,}_uefi_${BLDTYPE,,}_${VER}-${BUILD}.bin
OUTPUT_TFA_UEFI_IMAGE=Build/${BOARD_NAME}/${BOARD_NAME,,}_tfa_uefi_${BLDTYPE,,}_${VER}-${BUILD}.bin
OUTPUT_SPINOR_IMAGE=Build/${BOARD_NAME}/${BOARD_NAME,,}_rom_${BLDTYPE,,}_${VER}-${BUILD}.bin

cp -v "Build/${BOARD_NAME}/${BLDTYPE}_${TOOLCHAIN}/FV/BL33_${BOARD_NAME^^}_UEFI.fd" "${OUTPUT_UEFI_IMAGE}"

if [ -f "${TFA_SLIM}" ]; then
# Create a 2MB file with 0xff
dd bs=1024 count=2048 if=/dev/zero | tr "\000" "\377" > "${OUTPUT_TFA_UEFI_IMAGE}"
dd bs=1024 conv=notrunc if="${TFA_SLIM}" of="${OUTPUT_TFA_UEFI_IMAGE}"
dd bs=1 seek=2031616 conv=notrunc if="${OUTPUT_BOARD_SETTINGS_BIN}" of="${OUTPUT_TFA_UEFI_IMAGE}"
fi

rm -f "${OUTPUT_BOARD_SETTINGS_BIN}"
rm -f "${OUTPUT_BIN_DIR}/$(basename ${BOARD_SETTINGS_CFG}).txt"

if [ -f "${TFA_SLIM}" ]; then
# Write the UEFI image
dd bs=1024 seek=2048 if="${OUTPUT_UEFI_IMAGE}" of="${OUTPUT_TFA_UEFI_IMAGE}"

# Create the full SPI-NOR image
dd bs=1M count=${SPI_SIZE_MB} if=/dev/zero | tr "\000" "\377" > "${OUTPUT_SPINOR_IMAGE}"
# Write the code (TF-A+UEFI) area
dd bs=1M seek=4 conv=notrunc if="${OUTPUT_TFA_UEFI_IMAGE}" of="${OUTPUT_SPINOR_IMAGE}"

cp -vf "${OUTPUT_TFA_UEFI_IMAGE}" "Build/${BOARD_NAME}/${BOARD_NAME,,}_tfa_uefi.bin"

cp -vf "${SCP_SLIM}" "Build/${BOARD_NAME}/altra_scp.slim"
cp -vf "${TFA_SLIM}" "Build/${BOARD_NAME}/altra_atf.slim"
fi

# LinuxBoot doesn't support capsule updates
if [ -z "${LINUXBOOT}" ] && [ -f "${TFA_SLIM}" ] && [ -f "${SCP_SLIM}" ]; then
# Build the capsule (for upgrading from the UEFI Shell or Linux)
build -a AARCH64 -t ${TOOLCHAIN} -b ${BLDTYPE} -n ${BUILD_THREADS} \
-D FIRMWARE_VER="${VER}-${BUILD} TF-A ${TFA_VERSION}" \
-D MAJOR_VER=${MAJOR_VER} \
-D MINOR_VER=${MINOR_VER} \
-D SECURE_BOOT_ENABLE \
-p Platform/${MANUFACTURER}/${BOARD_NAME}Pkg/${BOARD_NAME}Capsule.dsc

cp -vf "Build/${BOARD_NAME}/${BLDTYPE}_${TOOLCHAIN}/FV/${BOARD_NAME^^}UEFIATFFIRMWAREUPDATECAPSULEFMPPKCS7.Cap" "${OUTPUT_BASENAME}.cap"
cp -vf "Build/${BOARD_NAME}/${BLDTYPE}_${TOOLCHAIN}/FV/${BOARD_NAME^^}SCPFIRMWAREUPDATECAPSULEFMPPKCS7.Cap" "${OUTPUT_BIN_DIR}/${BOARD_NAME,,}_scp_${SCP_VERSION}.cap"
fi

if [ ! -e "${TFA_SLIM}" ]; then
echo "Warning: the TF-A (Trusted Firmware) binary wasn't found. Only the UEFI firmware was built."
fi

echo "Done. Firmware is in Build/${BOARD_NAME}/"

if [ "${FLASHFW}" = "1" ]; then
echo "Copying firmware to BMC and flashing host."
if [ "$RESET_NV_STORAGE" = "1" ]; then
./fwflash.sh "${OUTPUT_BASENAME}.bin"
else
./fwflash.sh "${OUTPUT_BASENAME}.img"
fi
fi
14 changes: 14 additions & 0 deletions Platform/Ampere/fw_ver.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
touch .fw_bld
BUILD="$(cat .fw_bld)"

if [ "${BUILD}" = "" ]; then
BUILD="1"
echo ${BUILD} > .fw_bld
elif [ "$1" == "UPDATE" ]; then
BUILD=$((BUILD + 1))
echo ${BUILD} > .fw_bld
fi

MAJOR_VER="$(date +%y)"
MINOR_VER="$(date +%m)"
VER="$(date +%Y.%m.%d)"
21 changes: 21 additions & 0 deletions Platform/Ampere/fwflash.exp
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
set ARG [lindex $argv 0]
set DIR [lindex $argv 1]
set FILE [lindex $argv 2]

set timeout -1

spawn scp $DIR/$FILE $::env(BMC_USER)@$::env(BMC_HOST):/tmp
match_max 100000
expect "*?assword:*"
send -- "$::env(BMC_PASS)\r"
expect eof
spawn ssh $::env(BMC_USER)@$::env(BMC_HOST)
expect "*?assword:*"
send -- "$::env(BMC_PASS)\r"
expect "root@*~#"
send -- "ampere_flash_bios.sh $ARG /tmp/$FILE\r"
expect "root@*~#"
send -- "rm -fv /tmp/$FILE\r"
expect "root@*~#"
send -- "logout\r"
expect eof
Loading

0 comments on commit b6d9ce2

Please sign in to comment.