Skip to content

Commit cde98f4

Browse files
Guides path updated and pre built folder (#388)
* Updates to README.md: Correcting guides docs folder is moved one level up to be easily accessible. * pre-built folder --------- Co-authored-by: cherat01 <chetan.singh2@arm.com>
1 parent 534428a commit cde98f4

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

SystemReady-band/README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,8 @@ This image comprise of single FAT file system partition recognized by UEFI: <br
177177
│ Linux Boot │
178178
│*SystemReady band ACS (Automation) │
179179
│ BBSR Compliance (Automation) │
180+
│ UEFI Execution Enviroment │
181+
│ Linux Execution Enviroment │
180182
│ Linux Boot with SetVirtualAddressMap enabled |
181183
```
182184
- **Linux Boot** : This option will boot the ACS Linux kernel and run the default Linux tool (linux debug dump, fwts, linux bsa, linux sbsa (if selected))
@@ -185,21 +187,22 @@ This image comprise of single FAT file system partition recognized by UEFI: <br
185187
- **SystemReady band ACS (Automation)** : This is **default** option and will run the automated compliance
186188
- UEFI compliance run - SCT, BSA UEFI, SBSA UEFI (if selected)
187189
- Boots to Linux and run Linux compliance run - FWTS, BSA Linux, SBSA Linux (if selected)
188-
- **BBSR Compliance (Automation)** : This option will run the SCT and FWTS tests required for BBSR compliance, perform a Linux secure boot, and, if a TPM is present, evaluate the measured boot log. For the verification steps of BBSR ACS, refer to the [BBSR ACS Verification](../common/docs/BBSR_ACS_Verification.md).
190+
- **UEFI Execution Enviroment** : This option is introduced to manually run the selective UEFI test suites like SCT, BSA and SBSA with desired configuration.
191+
- **Linux Execution Enviroment** : This option is introduced to manually run the selective Linux test suites like FWTS, BSA and SBSA with desired configuration
192+
For more details on the Execution Enviroment and acs run config, refer to the [SystemReady_Execution_Enviroment_and_Config_Guide](../docs/SystemReady_Execution_Enviroment_and_Config_Guide.md)
193+
- UEFI compliance run - SCT, BSA UEFI, SBSA UEFI (if selected)
194+
- Boots to Linux and run Linux compliance run - FWTS, BSA Linux, SBSA Linux (if selected)
195+
- **BBSR Compliance (Automation)** : This option will run the SCT and FWTS tests required for BBSR compliance, perform a Linux secure boot, and, if a TPM is present, evaluate the measured boot log. For the verification steps of BBSR ACS, refer to the [BBSR ACS Verification](../docs/BBSR_ACS_Verification.md).
189196
- **Linux Boot with SetVirtualAddressMap enabled** : This option is for debug purpose, to boot ACS Linux with SetVAMap on.
190197

191198
### ACS configs file
192199
- **acs_config.txt**: The file specifies the ARM specification version that the ACS tool suite complies with, and this information is included in the **System_Information** table of the **ACS_Summary.html** report.
193200

194201
- **acs_run_config.ini**: This file is used to manage the execution of various ACS test suites and supports passing parameters to them. <br />
195-
The current options supported are: <br />
196-
- SbsaRunEnabled - The value supported is 0 and 1.
197-
- 0: Don't run SBSA complaince in automation run
198-
- 1: Run SBSA complaince in automation run
199-
200-
Please refer to [acs run configuration guide](https://github.com/chetan-rathore/arm-systemready/blob/main/common/docs/acs_run_configuration_guide.md) on details of modifying the config file.
202+
203+
Please refer to [SystemReady_Execution_Enviroment_and_Config_Guide](../docs/SystemReady_Execution_Enviroment_and_Config_Guide.md) on details of modifying the config file.
201204

202-
- **system_config.txt**: The file is used to collect below system information which is required for **ACS_Summary.html** report, this needs to be manually filled by user.
205+
- **system_config.txt**: The file is used to collect below system information which is required for **ACS_Summary.html** report, It is recommned to fill this information before running the ACS image for complaince.
203206
- FW source code: Unknown
204207
- Flashing instructions: Unknown
205208
- product website: Unknown
@@ -214,8 +217,8 @@ This image comprise of single FAT file system partition recognized by UEFI: <br
214217
- The JSON and HTML formatted results are present in /acs_results/**acs_summary** folder.
215218

216219
#### Waiver application process
217-
- Please follow the [waiver application guide](https://github.com/ARM-software/arm-systemready/blob/main/common/docs/waiver_guide.md) on details of waiver application to acs results
218-
- Template of waiver.json can be found [here](https://github.com/ARM-software/arm-systemready/blob/main/common/docs/example_waiver.json)
220+
- Please follow the [waiver application guide](https://github.com/ARM-software/arm-systemready/blob/main/docs/waiver_guide.md) on details of waiver application to acs results
221+
- Template of waiver.json can be found [here](https://github.com/ARM-software/arm-systemready/blob/main/docs/example_waiver.json)
219222

220223
## Verification on Arm Neoverse N2 reference design
221224

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
The SystemReady band v3.0.1 release pre-built image is available at https://github.com/ARM-software/arm-systemready/releases/download/v25.04_SR_3.0.1/systemready_acs_live_image.img.xz.zip
3+
4+
Run below steps to decompress the file
5+
6+
- unzip systemready_acs_live_image.img.xz.zip
7+
- xz -d systemready_acs_live_image.img.xz

0 commit comments

Comments
 (0)