Merge pull request #20 from edhay/main

SystemReady SR v1.0 ACS

Author: prasanth-pulla

ES/README.md

@@ -34,6 +34,8 @@ This section contains the build scripts and the live-images for the SystemReady
 - The prebuilt images are archived after compression to the .xz format. On Linux, use the xz utility to uncompress the image `xz -d es_acs_live_image.img.xz`. On Windows, use the 7zip or a similar utility.
 - If you choose to use the prebuilt image, skip the build steps, and navigate to the "Verification" section below.
 
+Note: The latest pre-built image contains Linux kernel version 5.13. To build a image with a different Linux kernel version, update the `LINUX_KERNEL_VERSION` in the configuration file `<path to arm-systemready>/common/config/common_config.cfg` before the build (after step 3 below). To see the list of kernel versions for which Linux BSA patches are available, see the [folder](https://gitlab.arm.com/linux-arm/linux-acs/-/tree/master/kernel/src)
+
 ### Prerequisites
 Before starting the ACS build, ensure that the following requirements are met:
  - Ubuntu 18.04 or 20.04 LTS with at least 32GB of free disk space.
@@ -153,5 +155,5 @@ System Ready ACS is distributed under Apache v2.0 License.
 
 --------------
 
-*Copyright (c) 2021, Arm Limited and Contributors. All rights reserved.*
+*Copyright (c) 2021-2022, Arm Limited and Contributors. All rights reserved.*
 

ES/patches/es_bsa.patch

@@ -1,6 +1,18 @@
---- ShellPkg/ShellPkg.dsc	2021-01-13 14:46:03.875244238 +0530
-+++ ShellPkg/ShellPkg_bsa.dsc	2021-01-13 14:44:19.407220595 +0530
-@@ -59,6 +59,8 @@
+From d06c0865e5c5fcf4d28d9e2f220e7e985dabb3ad Mon Sep 17 00:00:00 2001
+From: Amrathesh <[email protected]>
+Date: Wed, 22 Dec 2021 17:06:51 +0530
+Subject: [PATCH] EDK2 ES BSA Patch
+
+Signed-off-by: Amrathesh <[email protected]>
+---
+ ShellPkg/ShellPkg.dsc | 3 +++
+ 1 file changed, 3 insertions(+)
+
+diff --git a/ShellPkg/ShellPkg.dsc b/ShellPkg/ShellPkg.dsc
+index a8b6de3..85dc2c0 100644
+--- a/ShellPkg/ShellPkg.dsc
++++ b/ShellPkg/ShellPkg.dsc
+@@ -60,6 +60,8 @@
    DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.inf
    DxeServicesLib|MdePkg/Library/DxeServicesLib/DxeServicesLib.inf
    ReportStatusCodeLib|MdePkg/Library/BaseReportStatusCodeLibNull/BaseReportStatusCodeLibNull.inf
@@ -9,12 +21,14 @@
 
  [LibraryClasses.ARM,LibraryClasses.AARCH64]
    #
-@@ -97,7 +99,7 @@
+@@ -98,6 +100,7 @@
    ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.inf
    ShellPkg/Library/UefiShellNetwork1CommandsLib/UefiShellNetwork1CommandsLib.inf
    ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2CommandsLib.inf
--
 +  ShellPkg/Application/bsa-acs/uefi_app/BsaAcs.inf
+ 
    ShellPkg/Application/Shell/Shell.inf {
      <PcdsFixedAtBuild>
-       gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|FALSE
+-- 
+2.17.1
+

IR/README.md

@@ -34,6 +34,8 @@ This section of the repository contains the build scripts and the live-images fo
 - The prebuilt images are archived after compression to the .xz format. On Linux, use the xz utility to uncompress the image `xz -d es_acs_live_image.img.xz`. On Windows, use the 7zip or a similar utility.
 - If you choose to use the prebuilt image, skip the build steps, and navigate to the "Verification" section below.
 
+Note: The latest pre-built image contains Linux kernel version 5.13. To build a image with a different Linux kernel version, update the `LINUX_KERNEL_VERSION` in the configuration file `<path to arm-systemready>/common/config/common_config.cfg` before the build (after step 3 below). To see the list of kernel versions for which Linux BSA patches are available, see the [folder](https://gitlab.arm.com/linux-arm/linux-acs/-/tree/master/kernel/src)
+
 ### Prerequisites
 Before starting the ACS build, ensure that the following requirements are met:
  - Ubuntu 18.04 or 20.04 LTS with at least 32GB of free disk space.
@@ -138,5 +140,5 @@ System Ready ACS is distributed under Apache v2.0 License.
 
 --------------
 
-*Copyright (c) 2021, Arm Limited and Contributors. All rights reserved.*
+*Copyright (c) 2021-2022, Arm Limited and Contributors. All rights reserved.*
 

IR/patches/ir_bsa.patch

@@ -1,21 +1,35 @@
---- ShellPkg/ShellPkg.dsc	2021-01-13 14:46:03.875244238 +0530
-+++ ShellPkg/ShellPkg_bsa.dsc	2021-01-13 14:44:19.407220595 +0530
-@@ -59,6 +59,9 @@
+From 4099a09e9dcc759c3703d759c6b7840a33386b1a Mon Sep 17 00:00:00 2001
+From: Amrathesh <[email protected]>
+Date: Wed, 22 Dec 2021 17:01:59 +0530
+Subject: [PATCH] EDK2 IR BSA Patch
+
+Signed-off-by: Amrathesh <[email protected]>
+---
+ ShellPkg/ShellPkg.dsc | 4 ++++
+ 1 file changed, 4 insertions(+)
+
+diff --git a/ShellPkg/ShellPkg.dsc b/ShellPkg/ShellPkg.dsc
+index a8b6de3..e717591 100644
+--- a/ShellPkg/ShellPkg.dsc
++++ b/ShellPkg/ShellPkg.dsc
+@@ -60,6 +60,9 @@
    DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.inf
    DxeServicesLib|MdePkg/Library/DxeServicesLib/DxeServicesLib.inf
    ReportStatusCodeLib|MdePkg/Library/BaseReportStatusCodeLibNull/BaseReportStatusCodeLibNull.inf
 +  BsaValLib|ShellPkg/Application/bsa-acs/val/BsaValLib.inf
-+  BsaPalLib|ShellPkg/Application/bsa-acs/platform/pal_uefi_dt/BsaPalLib.inf
++  BsaPalLib|ShellPkg/Application/bsa-acs/platform/pal_uefi_dt/BsaPalLib.inf
 +  FdtLib|EmbeddedPkg/Library/FdtLib/FdtLib.inf
 
  [LibraryClasses.ARM,LibraryClasses.AARCH64]
    #
-@@ -97,7 +99,7 @@
+@@ -98,6 +101,7 @@
    ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.inf
    ShellPkg/Library/UefiShellNetwork1CommandsLib/UefiShellNetwork1CommandsLib.inf
    ShellPkg/Library/UefiShellNetwork2CommandsLib/UefiShellNetwork2CommandsLib.inf
--
 +  ShellPkg/Application/bsa-acs/uefi_app/BsaAcs.inf
+ 
    ShellPkg/Application/Shell/Shell.inf {
      <PcdsFixedAtBuild>
-       gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|FALSE
+-- 
+2.17.1
+

README.md

@@ -3,7 +3,7 @@
 ## Introduction to Arm SystemReady
 Systems that are designed to just work for the end user with the ability to install and run generic, off-the-shelf operating systems out of the box, must follow a set of minimum hardware and firmware requirements.
 
-For the Arm ecosystem, this requirement first surfaced in the server segment. The Arm ServerReady compliance certification program provides this “just works” solution for servers, allowing you to deploy Arm servers with confidence. The program is based on industry standards and is accompanied by a compliance test suite, and a process for certification.
+For the Arm ecosystem, this requirement first surfaced in the server segment. The Arm ServerReady compliance certification program provides this 'just works' solution for servers, allowing you to deploy Arm servers with confidence. The program is based on industry standards and is accompanied by a compliance test suite, and a process for certification.
 
 The Arm SystemReady program is a natural extension of the Arm ServerReady program. Different market segments may target different sets of operating systems and hypervisors with different hardware and firmware requirements. We use the term band to identify these differences, with a shorthand notation for each band. The bands are:
 * [SystemReady SR](https://developer.arm.com/architectures/system-architectures/arm-systemready/sr)
@@ -13,15 +13,16 @@ The Arm SystemReady program is a natural extension of the Arm ServerReady progra
 
 For more information, visit: [Arm SystemReady](https://developer.arm.com/architectures/system-architectures/arm-systemready)
 
-This repository contains the infrastructure to build the Architecture Compliance Suite and the bootable prebuilt images to be used for the certifications of various bands of SystemReady.
-Note:  Currently SystemReady ES and IR bands are supported in this repository
+This repository contains the infrastructure to build the Architecture Compliance Suite (ACS) and the bootable prebuilt images to be used for the certifications of various bands of SystemReady.<br />
+Note:  Currently SystemReady ES, IR and SR  bands are supported in this repository
 
-For SystemReady SR, refer to the [Arm Enterprise ACS repository](https://github.com/ARM-software/arm-enterprise-acs)
+For the legacy SystemReady SR ACS, refer to the [Arm Enterprise ACS repository](https://github.com/ARM-software/arm-enterprise-acs)
 
-## System Ready bands:
-Navigate to the ES or IR band for further details on specific scripts and prebuilt images, through the directories below:
+## SystemReady bands:
+Navigate to the ES, IR, or SR band for further details on specific scripts and prebuilt images through the directories below:
 * [ES](./ES)
 * [IR](./IR)
+* [SR](./SR)
 
 ## SystemReady Security Interface Extension:
 The SystemReady Security Interface Extension certifies that firmware meets the requirements specified by the Arm [Base Boot Security Requirements specification](https://developer.arm.com/documentation/den0107/latest) (BBSR). The Security Interface Extension is optionally applicable to SystemReady SR, ES and IR bands, but not the LS band.
@@ -30,11 +31,33 @@ Further details on Security Interface Extension, including pre-built images, are
 
 ## Limitations
 
+### BSA
 Validating the compliance of certain PCIe rules defined in the BSA specification require the PCIe end-point generate specific stimulus during the runtime of the test. Examples of such stimulus are  P2P, PASID, ATC, etc. The tests that requires these stimuli are grouped together in the exerciser module. The exerciser layer is an abstraction layer that enables the integration of hardware capable of generating such stimuli to the test framework.
 The details of the hardware or Verification IP which enable these exerciser tests platform specific and are beyond the scope of this document.
 
 The Live image does not allow customizations, hence, the exerciser module is not included in the Live image. To enable exerciser tests for greater coverage of PCIe rules, please refer to [BSA](https://github.com/ARM-software/bsa-acs) Or contact your Arm representative for details.
 
+### SBSA
+Validating the compliance of certain PCIe rules defined in the SBSA specification requires the PCIe end-point to generate specific stimulus during the runtime of the test. Examples of such stimulus are  P2P, PASID, ATC, etc. The tests that requires these stimuli are grouped together in the exerciser module. The exerciser layer is an abstraction layer that enables the integration of hardware capable of generating such stimuli to the test framework.
+The details of the hardware or Verification IP which enable these exerciser tests are platform specific and are beyond the scope of this document.
+
+ - Some PCIe and Exerciser test are dependent on PCIe features supported by the test system.
+   Please fill the required API's with test system information.
+
+|APIs                         |Description                                                                   |Affected tests          |
+|-----------------------------|------------------------------------------------------------------------------|------------------------|
+|pal_pcie_p2p_support         |Return 0 if the test system PCIe supports peer to peer transaction, else 1    |453, 454, 456, 812, 813 |
+|pal_pcie_is_cache_present    |Return 1 if the test system supports PCIe address translation cache, else 0   |452                     |
+|pal_pcie_get_legacy_irq_map  |Return 0 if system legacy irq map is filled, else 1                           |412, 450, 806           |
+
+   Below exerciser capabilities are required by exerciser test.
+   - MSI-X interrupt generation.
+   - Incoming Transaction Monitoring(order, type).
+   - Initiating transacions from and to the exerciser.
+   - Ability to check on BDF and register address seen for each configuration address along with access type.
+
+ - SBSA Test 403 (Check ECAM Memory accessibility) execution time depends on the system PCIe hierarchy. For systems with multiple ECAMs the time taken to complete can be long which is normal. Please wait until the test completes.
+
 ## License
 
 Arm SystemReady ACS is distributed under Apache v2.0 License.
@@ -48,5 +71,5 @@ Arm SystemReady ACS is distributed under Apache v2.0 License.
 
 --------------
 
-*Copyright (c) 2021, Arm Limited and Contributors. All rights reserved.*
+*Copyright (c) 2021-2022, Arm Limited and Contributors. All rights reserved.*