BBR Release changes (#87)

* Deprecate 32-bit support

* Pivot and Hive related changes

* Moving bbr tests from EFI/BOOT to acs_tests

* added standalone sct version patches

 - added patches for sbbr and ebbr
 - script changes to apply the patches.

Signed-off-by: Amrathesh <[email protected]>
Change-Id: Iae7d5895ab337ccb784514b9158dd6a00d663ba9

---------

Signed-off-by: Amrathesh <[email protected]>
Co-authored-by: Amrathesh <[email protected]>

README.md

@@ -33,11 +33,11 @@ To run SCT manually, follow these steps:
 
 
 1. `Shell>FS(X):`
-- `FS(X):>cd EFI\BOOT\bbr\SCT`
+- `FS(X):>cd acs_tests\bbr\SCT`
 - To run EBBR or SBBR tests
- `FS(X):EFI\BOOT\bbr\SCT>SCT -s <ebbr.seq/sbbr.seq>`
+ `FS(X):acs_tests\bbr\SCT>SCT -s <ebbr.seq/sbbr.seq>`
  - To run all tests
- `FS(X):EFI\BOOT\bbr\SCT>SCT -a -v`
+ `FS(X):acs_tests\bbr\SCT>SCT -a -v`
 
 
 You can also select and run tests individually. For more information on running the tests, see the [SCT User Guide](http://www.uefi.org/testtools).
@@ -60,7 +60,7 @@ To run the tests, follow these steps.
 
 2. Run manual tests.
 
-	- `FS(X):EFI\BOOT\bbr\SCT>SCT -s <ebbr_manual.seq/sbbr_manual.seq>`
+	- `FS(X):acs_tests\bbr\SCT>SCT -s <ebbr_manual.seq/sbbr_manual.seq>`
 
 3. While the system runs the reset tests, you may have to manually reset the system if it hangs.
 

bbsr/config/BBSRStartup.nsh

@@ -0,0 +1,98 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2024, Arm Limited or its affiliates. All rights reserved.
+#  SPDX-License-Identifier : Apache-2.0
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+##
+
+echo -off
+
+for %i in 0 1 2 3 4 5 6 7 8 9 A B C D E F
+  if exist FS%i:\acs_tests\bbr\SCT then
+    #
+    # Found EFI SCT harness
+    #
+    FS%i:
+    cd FS%i:\acs_tests\bbr\SCT
+    echo "Press any key to stop the BBSR SCT running"
+    stallforkey.efi 5
+    if %lasterror% == 0 then
+      goto Done
+    endif
+    for %j in 0 1 2 3 4 5 6 7 8 9 A B C D E F then
+        if exists FS%j:\acs_results\ then
+            if exists FS%j:\acs_results\BBSR\sct_results then
+
+                #Check if SCT run has already completed
+                if  exist FS%j:\acs_results\BBSR\sct_results\Overall\Summary.log then
+                    echo "BBSR SCT has completed run."
+                    echo "Press any key to start BBSR SCT execution from the beginning."
+                    echo "WARNING: Ensure you have backed up the existing logs."
+                    stallforkey.efi 5
+                    if %lasterror% == 0 then
+                        #Backup the existing logs
+                        rm -q FS%j:\acs_results\BBSR\sct_results_previous_run
+                        mkdir FS%j:\acs_results\BBSR\sct_results_previous_run
+                        cp -r FS%j:\acs_results\BBSR\sct_results FS%j:\acs_results\sct_results_previous_run
+                        rm -q FS%j:\acs_results\BBSR\sct_results
+                        goto StartSCT
+                    else
+                        goto Done
+                    endif
+                endif
+
+                if exist FS%i:\acs_tests\bbr\SCT\.passive.mode then
+                    if exist FS%i:\acs_tests\bbr\SCT\.verbose.mode then
+                        Sct -c -p mnp -v
+                    else
+                        Sct -c -p mnp
+                    endif
+                    else
+                    if exist FS%i:\acs_tests\bbr\SCT\.verbose.mode then
+                        Sct -c -v
+                    else
+                        Sct -c
+                    endif
+
+                    #SCT execution has finished. Copy the logs to acs_results
+                    if  exist FS%j:\acs_results\sct_results\ then
+                        if  exist FS%i:\acs_tests\bbr\SCT\Overall then
+                            cp -r FS%i:\acs_tests\bbr\SCT\Overall FS%j:\acs_results\BBSR\sct_results\
+                        endif
+                        if  exist FS%i:\acs_tests\bbr\SCT\Sequence then
+                            cp -r FS%i:\acs_tests\bbr\SCT\Sequence\BBSR.seq FS%j:\acs_results\BBSR\sct_results\
+                        endif
+                        #Restart to avoid an impact of running SCT tests on rest of the suites
+                        echo "Reset the system ..."
+                        reset
+                    endif
+                endif
+            else
+:StartSCT
+            FS%j:
+            cd FS%j:\acs_results
+            mkdir BBSR
+            cd FS%j:\acs_results\BBSR
+            mkdir sct_results
+            FS%i:
+            cd FS%i:\acs_tests\bbr\SCT
+            Sct -s BBSR.seq
+            goto Done
+            endif
+        endif
+    endfor
+  endif
+endfor
+
+:Done

common/config/ScrtStartup.nsh

@@ -1,40 +1,31 @@
-# Copyright (c) 2023, ARM Limited and Contributors. All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# Redistributions of source code must retain the above copyright notice, this
-# list of conditions and the following disclaimer.
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2024, Arm Limited or its affiliates. All rights reserved.
+#  SPDX-License-Identifier : Apache-2.0
 #
-# Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
 #
-# Neither the name of ARM nor the names of its contributors may be used
-# to endorse or promote products derived from this software without specific
-# prior written permission.
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+##
+
 
 echo -off
 
 for %i in 0 1 2 3 4 5 6 7 8 9 A B C D E F
-  if exist FS%i:\EFI\BOOT\bbr\SCT\SCRT then
+  if exist FS%i:\acs_tests\bbr\SCT\SCRT then
     #
     # Found EFI SCRT harness
     #
     FS%i:
-    cd FS%i:\EFI\BOOT\bbr\SCT\SCRT
+    cd FS%i:\acs_tests\bbr\SCT\SCRT
 
     #Check if SCRT run is already in progress
     if  exist SCRT_run_progress.flag then
@@ -47,27 +38,29 @@ for %i in 0 1 2 3 4 5 6 7 8 9 A B C D E F
         #Save the logs in acs_results
         for %j in 0 1 2 3 4 5 6 7 8 9 A B C D E F then
             if exists FS%j:\acs_results\ then
-                mkdir FS%j:\acs_results\sct_results
-                mkdir FS%j:\acs_results\sct_results\SCRT
-                cp SCRT.log  FS%j:\acs_results\sct_results\SCRT\SCRT.log
-                cp SCRT.conf FS%j:\acs_results\sct_results\SCRT\SCRT.conf
+                mkdir FS%j:\acs_results\scrt_results
+                mkdir FS%j:\acs_results\scrt_results
+                cp SCRT.log  FS%j:\acs_results\scrt_results\SCRT.log
+                cp SCRT.conf FS%j:\acs_results\scrt_results\SCRT.conf
             endif
         endfor
 
         goto Done
     endif
 
     echo SCRT run. Press any key to stop the EFI SCRT running
-    FS%i:\EFI\BOOT\bbr\SCT\stallforkey.efi 5
+    FS%i:\acs_tests\bbr\SCT\stallforkey.efi 5
     if %lasterror% == 0 then
       goto Done
     endif
 
     echo "Note: The System will automatically reset as part of SCRT testing"
 
     if  exist SCRT.log then
-        echo SCRT is already run. Press any key to run SCRT again. WARNING: Ensure you have backed up the existing logs.
-        FS%i:\EFI\BOOT\bbr\SCT\stallforkey.efi 5
+        echo "SCRT is already run."
+        echo "Press any key to run SCRT again."
+        echo "WARNING: Ensure you have backed up the existing logs."
+        FS%i:\acs_tests\bbr\SCT\stallforkey.efi 5
         if %lasterror% == 0 then
             #Backup the existing logs
             cp SCRT.log SCRT.log_previous_run

common/config/bbr_common_config.cfg → common/config/bbr_source.cfg

@@ -41,4 +41,4 @@ SCT_SRC_TAG=abb54c667fe6ae2a41144c010871569ef519c459
 FWTS_SRC_TAG=V23.01.00
 
 # EDK2 source tag from https://github.com/tianocore/edk2.git
-EDK2_SRC_VERSION=edk2-stable202208
+EDK2_SRC_VERSION=edk2-stable202208