search

ARM-software / bsa-acs

Arm SystemReady : BSA Architecture Compliance Suite
Apache License 2.0
14 stars 40 forks source link

readme

Base System Architecture - Architecture Compliance Suite

BSA-ACS Build Check

Base System Architecture

Base System Architecture (BSA) specification describes a hardware system architecture based on the Arm 64-bit architecture. System software such as operating systems, hypervisors, and firmware rely on this. It addresses PE features and key aspects of system architecture.

For more information, download the BSA specification

BSA - Architecture Compliance Suite

BSA Architecture Compliance Suite (ACS) is a collection of self-checking, portable C-based tests. This suite includes a set of examples of the invariant behaviors that are provided by the BSA specification, so that you can verify if these behaviour have been interpreted correctly.

Most of the tests are executed from UEFI (Unified Extensible Firmware Interface) Shell by executing the BSA UEFI shell application. A few tests are executed by running the BSA ACS Linux application which in turn depends on the BSA ACS Linux kernel module. The tests can also be executed in a Bare-metal environment. The initialization of the Bare-metal environment is specific to the environment and is out of scope of this document.

Release details

GitHub branch

Additional reading

Running Exerciser tests for complete coverage

Exerciser is a client device wrapped up by PCIe Endpoint. This device is created to meet BSA requirements for various PCIe capability validation tests. Running the Exerciser tests provides additional test coverage on the platform.

Note: To run the exerciser tests on a UEFI Based platform with Exerciser, the Exerciser PAL API's need to be implemented. For details on the reference Exerciser implementation and support, see the Exerciser.md and Exerciser_API_porting_guide.md

ACS build steps - UEFI Shell application

Prebuilt images

Prebuilt images for each release are available in the prebuilt_images folder of the main branch. You can choose to use these images or build your own image by following the steps below. If you choose to use the prebuilt image, see the Test suite execution section below for details on how to run the application.

1. Building from source

Before you start the ACS build, ensure that the following requirements are met.

1.1 Target Platform

To start the ACS build for platform using ACPI table, perform the following steps:

  1. cd local_edk2_path

  2. git submodule update --init --recursive

  3. git clone https://github.com/ARM-software/bsa-acs.git ShellPkg/Application/bsa-acs

  4. Add the following to the [LibraryClasses.common] section in ShellPkg/ShellPkg.dsc

         BsaValLib|ShellPkg/Application/bsa-acs/val/BsaValLib.inf
     BsaPalLib|ShellPkg/Application/bsa-acs/pal/uefi_acpi/BsaPalLib.inf

  5. Add the following in the [components] section of ShellPkg/ShellPkg.dsc

         ShellPkg/Application/bsa-acs/uefi_app/BsaAcs.inf
To start the ACS build for platform using Device tree, perform the following steps:

  1. cd local_edk2_path

  2. git submodule update --init --recursive

  3. git clone https://github.com/ARM-software/bsa-acs.git ShellPkg/Application/bsa-acs

  4. Add the following to the [LibraryClasses.common] section in ShellPkg/ShellPkg.dsc

         FdtLib|EmbeddedPkg/Library/FdtLib/FdtLib.inf
     BsaValLib|ShellPkg/Application/bsa-acs/val/BsaValLib.inf
     BsaPalLib|ShellPkg/Application/bsa-acs/pal/uefi_dt/BsaPalLib.inf

  5. Add the following in the [components] section of ShellPkg/ShellPkg.dsc

         ShellPkg/Application/bsa-acs/uefi_app/BsaAcs.inf

  6. In IR systems, ACS efi application runs on top of efi shell which runs on u-boot as efi payload.

    • Below change in edk2 code MdeModulePkg/Library/UefiHiiServicesLib/UefiHiiServicesLib.c is required before compiling for IR system. 
           -Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &gHiiConfigRouting);
     -ASSERT_EFI_ERROR (Status);
     +//Status = gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &gHiiConfigRouting);
     +//ASSERT_EFI_ERROR (Status);

1.2 Build environment

If the build environment is Linux, perform the following steps:
  1. export GCC49_AARCH64_PREFIX= GCC13.2 toolchain path pointing to /bin/aarch64-linux-gnu- in case of x86 machine.
    For an AArch64 build it should point to /usr/bin/
  2. export PACKAGES_PATH= path pointing to edk2-libc
  3. source edksetup.sh
  4. make -C BaseTools/Source/C
  5. source ShellPkg/Application/bsa-acs/tools/scripts/acsbuild.sh

1.3 Build output

The EFI executable file is generated at /Build/Shell/DEBUG_GCC49/AARCH64/Bsa.efi

2. Test suite execution

Prerequisites

The execution of the compliance suite varies depending on the test environment. The following steps assume that the test suite is invoked through the ACS UEFI shell application.

2.1 Silicon

On a system where a USB port is available and functional, perform the following steps:

For IR Systems:

  1. Copy 'Bsa.efi' and 'Shell.efi' to a USB Flash drive.
  2. Boot the system to U-Boot shell.
  3. Plug in the USB flash drive to one of the functional USB ports on the system.
  4. To determine the file system number of the plugged-in USB drive, execute command
    usb start
  5. Copy the 'Shell.efi' to memory location using the command
    Syntax: fatload usb <dev_num> ${kernel_addr_r} Shell.efi
    Eg: fatload usb 0 ${kernel_addr_r} Shell.efi
    This boots the system to UEFI Shell.
  6. To determine the file system number of the plugged-in USB drive, execute 'map -r' command.
  7. Type 'fs' where '' is replaced by the number determined in step 5.
  8. To start the compliance tests, run the executable Bsa.efi with the appropriate parameters.
  9. Copy the UART console output to a log file. Note: 'Shell.efi' is available in the pebuilt_images/IR

2.2 Emulation environment with secondary storage

On an emulation environment with secondary storage, perform the following steps:

  1. Create an image file which contains the 'Bsa.efi' file. For example:
    • mkfs.vfat -C -n HD0 hda.img 2097152
    • sudo mount -o rw,loop=/dev/loop0,uid=`whoami`,gid=`whoami` hda.img /mnt/bsa In case loop0 is busy, please specify the one that is free.
    • sudo cp "/Bsa.efi" /mnt/bsa/
    • sudo umount /mnt/bsa
  2. Load the image file to the secondary storage using a backdoor. The steps to load the image file are emulation environment-specific and beyond the scope of this document.
  3. Boot the system to UEFI shell.
  4. To determine the file system number of the secondary storage, execute 'map -r' command.
  5. Type 'fs' where '' is replaced by the number determined in step 4.
  6. To start the compliance tests, run the executable Bsa.efi with the appropriate parameters.

  7. Copy the UART console output to a log file for analysis and certification.

    • For information on the BSA uefi shell application parameters, see the User Guide.

2.3 Emulation environment without secondary storage

On an emulation platform where secondary storage is not available, perform the following steps:

  1. Add the path to 'Bsa.efi' file in the UEFI FD file.
  2. Build UEFI image including the UEFI Shell.
  3. Boot the system to UEFI shell.
  4. Run the executable 'Bsa.efi' to start the compliance tests. For details about the parameters,see the User Guide.
  5. Copy the UART console output to a log file for analysis and certification.

ACS build steps - Linux application

Certain Peripheral, PCIe and Memory map tests require Linux operating system.This chapter provides information on building and executing these tests from the Linux application.

1. Build steps and environment setup

This section lists the porting and build steps for the kernel module. The patch for the kernel tree and the Linux PAL are hosted separately on linux-acs repo

1.1 Building the kernel module

Prerequisites

Porting steps for Linux kernel

  1. git clone https://git.gitlab.arm.com/linux-arm/linux-acs.git linux-acs
  2. git clone https://github.com/ARM-software/bsa-acs.git bsa-acs
  3. git clone https://github.com/torvalds/linux.git -b v6.8
  4. export CROSS_COMPILE= pointing to /bin/aarch64-linux-gnu-
  5. git apply /linux-acs/kernel/src/0001-BSA-ACS-Linux-6.8.patch to your kernel source tree.
  6. make ARCH=arm64 defconfig && make -j $(nproc) ARCH=arm64

NOTE: The steps mentions Linux version 6.8, as it is latest version which is verified at ACS end.

1.2 Build steps for BSA kernel module

  1. cd /linux-acs/files
  2. export CROSS_COMPILE=/bin/aarch64-linux-gnu-
  3. export KERNEL_SRC=
  4. ./bsa_setup.sh <local_dir/bsa-acs>
  5. ./linux_bsa_acs.sh

Successful completion of above steps will generate bsa_acs.ko

1.3 BSA Linux application build

  1. cd /linux_app/bsa-acs-app
  2. export CROSS_COMPILE=/bin/aarch64-linux-gnu-
  3. make

Successful completion of above steps will generate executable file bsa

2. Loading the kernel module

Before the BSA ACS Linux application can be run, load the BSA ACS kernel module using the insmod command.

shell> insmod bsa_acs.ko

3. Running BSA ACS

shell> ./bsa

ACS build steps - Bare-metal abstraction

The Bare-metal build environment is platform specific.

To provide a baseline, the build steps to integrate and run the Bare-metal tests from UEFI shell are provided in README.md.

For details on generating the binaries to run on Bare-metal environment, refer README.md

ACS build steps - Memory model consistency tests

To evaluate the correctness and consistency of a system's memory model, memory model consistency tests (litmus tests) can be optionally built into BSA UEFI application, the build and run steps are provided in mem_test/README.md.

Security implication

The Arm SystemReady ACS test suite may run at a higher privilege level. An attacker may utilize these tests to elevate the privilege which can potentially reveal the platform security assets. To prevent the leakage of Secure information, Arm strongly recommends that you run the ACS test suite only on development platforms. If it is run on production systems, the system should be scrubbed after running the test suite.

Limitations

BSA ACS version mapping

BSA Spec Version BSA ACS Version BSA Tag ID Pre-Si Support
BSA v1.0(c) v1.0.8 v24.03_REL1.0.8 Yes
BSA v1.0(c) v1.0.7 v23.12_REL1.0.7 Yes
BSA v1.0(c) v1.0.6 v23.11_BootFramework Yes
BSA v1.0(c) v1.0.6 v23.09_REL1.0.6 Yes
BSA v1.0(c) v1.0.5 v23.07_REL1.0.5 Yes
BSA v1.0(c) v1.0.4 v23.03_REL1.0.4 Yes
BSA v1.0 v1.0.3 v23.01_REL1.0.3 No
BSA v1.0 v1.0.2 v22.10_REL1.0.2 No
BSA v1.0 v1.0.1 v22.06_REL1.0.1 No
BSA v1.0 v1.0 v21.09_REL1.0 No

License

BSA ACS is distributed under Apache v2.0 License.

Feedback, contributions, and support

Copyright (c) 2021-2024, Arm Limited and Contributors. All rights reserved.