diff --git a/README.md b/README.md index cfce166f6a66d2122de47c585caff82ec6bb77b4..3d6c8b3fa08fd1d7ae7aeb6a09978cceecfb862b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ -# Template Structure for SystemReady Compliance Reports +# Template Structure for SystemReady IR Compliance Reports This repo structure is the template for collecting compliance evidence for a -SystemReady certification. +SystemReady IR certification. + +(For the ES and SR bands, see the [systemready-es-sr-template].) + +[systemready-es-sr-template]: https://gitlab.arm.com/systemready/systemready-es-sr-template ## Verification script A `check-sr-results.py` verification script is available in the [SystemReady @@ -10,7 +14,7 @@ this template. [SystemReady scripts]: https://gitlab.arm.com/systemready/systemready-scripts ## General Instructions -General instructions for collecting SystemReady compliance logs: +General instructions for collecting SystemReady IR compliance logs: ### `./report.txt` Fill in with information about the system being certified @@ -21,20 +25,9 @@ until completion of ACS tests. Must include all output from firmware. Should end at a Linux busybox shell prompt after running FWTS tests. ### `./acs_results/` -Place an entire copy of the `LUV-Results` or `acs_results` partitions, as +Place an entire copy of the `acs_results` partitions, as follows: -For Enterprise ACS, under the `LUV-Results` partition: - - /luv-results- - /sbsa_results - /uefi - /linux - /SCT_RUN - /sdei_results - -For ACS-ES and ACS-IR, under the `acs_results` partition: - /fwts /linux /linux_dump @@ -42,8 +35,8 @@ For ACS-ES and ACS-IR, under the `acs_results` partition: /uefi /uefi_dump -For ACS-IR, also include the `result.md` output from running the SCT results -parser script from https://gitlab.arm.com/systemready/edk2-test-parser. +Also include the `result.md` output from running the SCT results parser script +from https://gitlab.arm.com/systemready/edk2-test-parser. ### `./manual-results/` @@ -53,42 +46,11 @@ executed and the result files (if any) generated by the test. ### `./manual-results/bsa-linux/` -Place any BSA or SBSA results collected manually from Linux. - -#### Enterprise-ACS Examples: - -SBSA Linux results can be collected by running the following commands -after booting LUVOS: - - insmod /lib/modules/4.18.0-luv/extra/sbsa_acs.ko - sbsa -l 3 - -You can include verbose output (-v): - - sbsa -l 3 -v 2 - -To skip a specific problematic test, use -skip . For example: - - sbsa -l 3 -v 2 -skip 20,36 +Place any BSA results collected manually from Linux. ### `./manual-results/bsa-uefi/` -Place any BSA or SBSA results collected manually from UEFI Shell - -#### Enterprise-ACS Examples: - -SBSA UEFI results can be collected by running the following -commands after booting LUVOS: - - sbsa.efi -l 3 - -You can include verbose output (-v): - - sbsa.efi -l 3 -v 2 - -To skip a specific problematic test, use -skip - - sbsa.efi -l 3 -v 2 -skip 407 +Place any BSA results collected manually from UEFI Shell ### `./manual-results/fwts/` Place any additional FWTS results collected manually by running: @@ -151,11 +113,6 @@ execute. Shell> dh -d -v Shell> memmap Shell> smbiosview - Shell> acpiview -l - Shell> acpiview - Shell> acpiview -r 2 - Shell> acpiview -s DSDT -d (if DSDT table is present) - Shell> acpiview -s SSDT -d (if SSDT table is present) Shell> CapsuleApp.efi -P Shell> CapsuleApp.efi -E @@ -208,38 +165,9 @@ tar cfz sys-firmware.tar.gz /sys/firmware Copy the resulting `sys-firmware.tar.gz` into the results directory. -#### `./os-logs/esxi/` -Install VMWare ESXi to a disk, and boot it. -Connect to vSphere web console over network and capture screenshots. -Run the following commands and attach the logs: - -``` -dmesg -lspci -irqinfo -localcli hardware pci list -localcli storage core adapter list -``` - -#### `./os-logs/winpe/` -Boot WinPE from USB key, or Install Windows a disk, and boot it. -Include screenshots and video of WinPE booting (from FW menu to OS startup, -and keyboard working in command prompt) - -Run the following commands and attach the logs: - -``` -pnputil/enum-devices -pnputil/enum-drivers -Systeminfo -ver -``` - -## Band Specific Examples - -## SystemReady IR results +## SystemReady IR results example -For IR, after collecting the results the directory tree should look like this: +After collecting the results the directory tree should look like this: ``` . @@ -282,17 +210,15 @@ For IR, after collecting the results the directory tree should look like this: │   └── u-boot-sniff.log ├── manual-results/ ├── os-logs/ -│   ├── esxi/ │   ├── linux-distro1-version/ │   │   ├── console.log │   │   └── sys-firmware.tar.gz │   ├── linux-distro2-version/ │   │   ├── console.log │   │   └── sys-firmware.tar.gz -│   ├── screenshots/ -│   └── winpe/ +│   └── screenshots/ ├── README.md └── report.txt -19 directories, 28 files +17 directories, 28 files ``` diff --git a/os-logs/esxi/.keep b/os-logs/esxi/.keep deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000 diff --git a/os-logs/winpe/.keep b/os-logs/winpe/.keep deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000 diff --git a/report.txt b/report.txt index bdceae443dc246537ab6800ab459a3bd68437954..3d177d046382efd14ebecd6279a594b1e97666c2 100644 --- a/report.txt +++ b/report.txt @@ -1,6 +1,6 @@ General information ------------------- -- Arm SystemReady Band: SR|ES|IR|LS +- Arm SystemReady Band: IR - System name: - Prepared by: - E-mail: @@ -25,8 +25,8 @@ Test Logs and Results - Test Logs collected [ ] ACS - SCT -[ ] ACS - (S)BSA - UEFI -[ ] ACS - (S)BSA - Linux +[ ] ACS - BSA - UEFI +[ ] ACS - BSA - Linux [ ] ACS - FWTS [ ] ACS - Linux boot log [ ] ACS - Linux dumps