Commit 17930c81 authored by Grant Likely's avatar Grant Likely
Browse files

Simplify template and provide IR example



Simplify the directory tree so that ACS results get copied into a top
level folder and is easier to find. Remove the remaining /acs/*
directories like `fwts` and `sct` to avoid confusion about where results
need to go. Instead create an empty top level /manual-results/ tree
which is where manual test results should be placed, but don't
pre-populate the directories because in most cases this is not needed
and instructions are covered in the README.

Also update the README to reflect the new guidance and to list
directories with a trailing '/' so that they are recognized as
directories and not files.
Signed-off-by: Grant Likely's avatarGrant Likely <grant.likely@arm.com>
parent 62317374
......@@ -10,12 +10,12 @@ General instructions for collecting SystemReady compliance logs:
./report.txt
Fill in with information about the system being certified
./acs
./acs-console.log
If using serial console, capture a full console log from first power on
until completion of ACS tests. Must include all output from firmware.
Should end at a Linux busybox shell prompt after running FWTS tests.
./acs/acs-results
./acs-results/
Place an entire copy of the 'LUV-Results' or 'acs-results' partitions, as
follows:
......@@ -35,9 +35,15 @@ General instructions for collecting SystemReady compliance logs:
/uefi
/uefi_dump
./acs/bsa-linux
./manual-results/
Place any BSA or SBSA results collected manually, from UEFI or Linux.
Place any results from manually performed tests in this directory tree.
Manual test results must include both a console log of the commands
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.
Examples:
......@@ -54,7 +60,7 @@ General instructions for collecting SystemReady compliance logs:
To skip a specific problematic test, use -skip <testnum>. For example:
sbsa -l 3 -v 2 -skip 20,36
./acs/bsa-uefi
./manual-results/bsa-uefi/
Place any BSA or SBSA results collected manually from UEFI Shell
......@@ -72,11 +78,11 @@ General instructions for collecting SystemReady compliance logs:
To skip a specific problematic test, use -skip <testnum>
sbsa.efi -l 3 -v 2 -skip 407
./acs/fwts
./manual-results/fwts/
Place any additional FWTS results collected manually by running:
fwts -r stdout -q –sbbr
./acs/sct
./manual-results/sct/
Place any additional SCT results collected manually
FS2:\SCT>SCT.efi -a –v
......@@ -84,17 +90,17 @@ General instructions for collecting SystemReady compliance logs:
and selecting/unselecting specific test cases
./docs
./docs/
Place any firmware or device documentation, manuals, user guides, build instructions, etc..
./fw
./fw/screenshots
./fw/
./fw/screenshots/
Place some screenshots showing the FW menus (such as UEFI Setup, BMC
web console, uboot shell)
./fw/u-boot
./fw/u-boot-sniff.log
Run the following commands at U-Boot prompt and attach the logs:
u-boot=> help
......@@ -118,9 +124,7 @@ General instructions for collecting SystemReady compliance logs:
u-boot=> bootefi hello ${fdtcontroladdr}
u-boot=> bootefi selftest ${fdtcontroladdr}
./fw/uefi_shell
./fw/uefi-sniff.log
Run the following commands in UEFI Shell and attach the logs (if not
already done by ACS). The UEFI Shell can be run from the ACS image by
pressing a key at the UEFI timeout prompt before tests begin to
......@@ -141,9 +145,9 @@ General instructions for collecting SystemReady compliance logs:
Shell> CapsuleApp.efi -P
Shell> CapsuleApp.efi -E
./os_logs
./os-logs/
./os_logs/linux_[distroname]_[distroversion]
./os-logs/linux-[distroname]-[distroversion]/
Create a directory for each Linux distro used for testing.
......@@ -151,11 +155,13 @@ General instructions for collecting SystemReady compliance logs:
Collect the installation and OS boot logs and save in single text file.
The install log must begin when the platform is released from reset and
must include:
- all firmware output
- output from Linux installer
- reboot into installed OS.
- All firmware output
- Output from Linux installer
- Output of reboot into installed OS.
- Output of following commands from Linux shell:
```
dmesg
lspci -vvv
lscpu
......@@ -163,9 +169,12 @@ General instructions for collecting SystemReady compliance logs:
dmidecode
uname -a
efibootmgr
copy the entire content of /sys/firmware and attach zipped/archive file
tar cfz sys-firmware.tar.gz /sys/firmware
```
Copy the resulting sys-firmware.tar.gz into the results directory.
./os_logs/esxi
./os-logs/esxi/
Install VMWare ESXi to a disk, and boot it
Connect to vSphere web console over network and capture screenshots
......@@ -176,8 +185,7 @@ General instructions for collecting SystemReady compliance logs:
localcli hardware pci list
localcli storage core adapter list
./os_logs/winpe
./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,
......@@ -188,3 +196,64 @@ General instructions for collecting SystemReady compliance logs:
pnputil/enum-drivers
Systeminfo
ver
## Band Specific Examples
## SystemReady IR results
For IR, after collecting the results the directory tree should look like this:
```
.
├── acs-console.log
├── acs-results/
│   ├── app_output/
│   │   ├── CapsuleApp_ESRT_table_info.log
│   │   └── CapsuleApp_FMP_protocol_info.log
│   ├── fwts/
│   │   └── FWTSResults.log
│   ├── linux_dump/
│   │   └── lspci.log
│   ├── sct_results/
│   │   ├── EfiCompliantBBTest/
│   │   │   └── EfiCompliant.ini
│   │   ├── Overall/
│   │   │   ├── Summary.ekl
│   │   │   └── Summary.log
│   │   └── Sequence/
│   │   ├── EBBR_manual.seq
│   │   └── EBBR.seq
│   ├── uefi/
│   │   └── BsaResults.log
│   └── uefi_dump/
│   ├── acpiview_l.log
│   ├── acpiview.log
│   ├── acpiview_r.log
│   ├── bcfg.log
│   ├── devices.log
│   ├── dh.log
│   ├── dmpstore.log
│   ├── drivers.log
│   ├── memmap.log
│   ├── pci.log
│   └── smbiosview.log
├── docs/
├── fw/
│   ├── readme.txt
│   └── 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/
├── README.md
└── report.txt
19 directories, 28 files
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment