Skip to content

Commit e45b4f3

Browse files
Sujana-Mchetan-rathore
authored andcommitted
rel(bsa,sbsa and mpam): Readme updates
- Updated the Readme.md file to reflect the level changes - Updated the mpam Readme.md file Signed-off-by: Sujana M <sujana.murali@arm.com>
1 parent e1efad7 commit e45b4f3

2 files changed

Lines changed: 5 additions & 7 deletions

File tree

docs/common/cli_args.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ semantics so individual READMEs can simply reference it.
1717
| `-f <path>` | All | Copy UART output to the specified file on the active filesystem (for example, `-f fs0:\logs\run.txt`). |
1818
| `-fr` | All | Include future-requirement (FR) rules for the selected specification. |
1919
| `-help`, `-h` | All | Display the full usage banner inside the UEFI shell. |
20-
| `-l <level>` | All | Execute all rules up to the chosen level (for example, SBSA levels 1-7). |
21-
| `-m <modules>` | All | Run only the listed modules (comma-separated). Valid names include `PE`, `GIC`, `PERIPHERAL`, `MEM_MAP`, `MEMORY`, `PMU`, `RAS`, `SMMU`, `TIMER`, `WATCHDOG`, `NIST`, `PCIE`, `MPAM`, `ETE`, `TPM`, and `POWER_WAKEUP`; unsupported modules in the active binary are ignored. |
20+
| `-l <level>` | All | Execute all rules up to the chosen level (for example, SBSA levels 1-8). |
21+
| `-m <modules>` | All | Run only the listed modules (comma-separated). Valid names include `PE`, `GIC`, `PERIPHERAL`, `MEM_MAP`, `MEMORY`, `PMU`, `RAS`, `SMMU`, `TIMER`, `WATCHDOG`, `NIST`, `PCIE`, `MPAM`, `ETE`, `TPM`, `CXL`, and `POWER_WAKEUP`; unsupported modules in the active binary are ignored. |
2222
| `-mmio` | All | Log every `pal_mmio_read` / `pal_mmio_write` invocation; combine with `-v 1` to focus on MMIO tracing. |
2323
| `-no_crypto_ext` | All | Report that architectural crypto extensions are absent or disabled (for export control or platform reasons). |
2424
| `-only <level>` | All | Run only the rules that match the provided level. |
@@ -29,7 +29,7 @@ semantics so individual READMEs can simply reference it.
2929
| `-skip-dp-nic-ms` | All | Skip PCIe exerciser coverage for DisplayPort, network, and mass-storage devices when those endpoints are unavailable. |
3030
| `-skipmodule <modules>` | All | Exclude the listed modules from the run (for example, `-skipmodule PE,GIC`). |
3131
| `-slc <type>` | SBSA | Provide the system last-level cache implementation (`1` for PPTT PE-side cache, `2` for HMAT memory-side cache). |
32-
| `-timeout <1-5>` | All | Scale watchdog and wakeup waits (1 = default/minimum, 5 = maximum delay). |
32+
| `-timeout <500-2000>` | All | Set pass timeout (in microseconds) for wakeup and watchdog tests (1ms = default, 500us = minimum, 2sec = maximum delay). |
3333
| `-v <level>` | All | Set verbosity: 5=ERROR, 4=WARN, 3=TEST, 2=DEBUG, 1=INFO. |
3434

3535
Refer to each specification README for other variant-level constraints, rule

docs/mpam/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ been implemented and interpreted correctly.
4949

5050
## Documentation and Guides
5151
- [SYS-MPAM Test Scenario Document](arm_mpam_architecture_compliance_test_scenario.md)
52-
- [Common CLI arguments](../common/cli_args.md)
5352
- [Common UEFI build guide](../common/uefi_build.md)
5453

5554
## SYS-MPAM build steps
@@ -100,9 +99,8 @@ Runs at INFO level, skips tests 15/20/30, and saves the UART log to
10099

101100
## Application arguments
102101

103-
SYS-MPAM ACS currently supports numeric test and module selectors. See the
104-
[Common CLI arguments](../common/cli_args.md) for shared options.
105-
102+
SYS-MPAM ACS currently supports numeric test and module selectors. See example below:
103+
106104
Shell> Mpam.efi [-v <verbosity>] [-skip <test_id>] [-t <test_id>] [-m <module_id>] [-f <filename>]
107105

108106
#### -v

0 commit comments

Comments
 (0)