Skip to content

Commit 39c1436

Browse files
committed
Updates to README and documentations
Signed-off-by: Sujana M <sujana.murali@arm.com>
1 parent 112bdb3 commit 39c1436

17 files changed

Lines changed: 367 additions & 136 deletions

README.md

Lines changed: 151 additions & 108 deletions
Large diffs are not rendered by default.
-15.9 KB
Binary file not shown.
2.72 KB
Binary file not shown.
497 Bytes
Binary file not shown.
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,21 @@ For more information, download the [DRTM Architecture for Arm](https://developer
88

99
## Release details
1010
- Code Quality: Alpha
11-
- The tests are written for version 1.0 of the DRTM Architecture for Arm.
11+
- The tests are written for version 1.1 of the DRTM Architecture for Arm.
1212
- For more details on tests implemented in this release, Please refer [DRTM Test Scenario Document](docs/arm_drtm_architecture_compliance_test_scenario.pdf).
1313

1414
## Downloading DRTM ACS
1515

16-
DRTM ACS code is present in a sub-directory in bsa-acs repository.
16+
DRTM ACS code is present in the sysarch-acs repository.
1717

18-
$ git clone ssh://ap-gerrit-1.ap01.arm.com:29418/avk/syscomp_bsa <br/>
19-
$ cd syscomp_bsa <br/>
18+
$ git clone https://github.com/ARM-software/sysarch-acs.git <br/>
19+
$ cd sysarch-acs <br/>
2020

2121
## Building DRTM ACS
2222
### UEFI application
2323
#### Prerequisites
2424

25-
ACS build requires that the following requirements are met, Please skip this if you are using [DRTM Application Build Script](scripts/build_drtm_uefi.sh).
25+
ACS build requires that the following requirements are met, Please skip this if you are using [DRTM Application Build Script](../tools/scripts/build_drtm_uefi.sh).
2626

2727
- Any mainstream Linux based OS distribution.
2828
- git clone EDK2 tree.
@@ -32,12 +32,12 @@ ACS build requires that the following requirements are met, Please skip this if
3232

3333
#### Build Steps
3434

35-
$ cd /path/to/syscomp_bsa/<br/>
36-
$ source drtm/scripts/build_drtm_uefi.sh
35+
$ cd /path/to/sysarch-acs/<br/>
36+
$ source tools/scripts/build_drtm_uefi.sh
3737

3838
#### Build Output
3939

40-
The following output file is created in /path/to/syscomp_bsa/workspace/output/:
40+
The following output file is created in /path/to/sysarch-acs/workspace/output/:
4141

4242
- Drtm.efi
4343

@@ -64,9 +64,9 @@ On a system where a USB port is available and functional, perform the following
6464
On an emulation environment with secondary storage, perform the following steps:
6565

6666
1. Create an image file which contains the 'Drtm.efi' file. For Example: <br/>
67-
$ mkfs.vfat -C -n HD0 hda.img 31457280 <br/>
67+
$ mkfs.vfat -C -n HD0 hda.img 2097152 <br/>
6868
$ sudo mount hda.img /mnt/drtm <br/>
69-
$ cd /path/to/syscomp_bsa/workspace/output/ <br/>
69+
$ cd /path/to/sysarch-acs/workspace/output/ <br/>
7070
$ sudo cp Drtm.efi /mnt/drtm/ <br/>
7171
$ sudo umount /mnt/drtm
7272
2. Load the image file to the secondary storage using a backdoor. The steps followed to load the image file are Emulation environment specific and beyond the scope of this document.
@@ -121,4 +121,4 @@ DRTM ACS is distributed under Apache v2.0 License.
121121

122122
--------------
123123

124-
*Copyright (c) 2024, Arm Limited and Contributors. All rights reserved.*
124+
*Copyright (c) 2024-2025, Arm Limited and Contributors. All rights reserved.*

docs/mpam/README.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
2+
# MPAM System Component Specification - Architecture Compliance Suite
3+
4+
## Memory System Resource Partitioning and Monitoring
5+
**Memory System Resource Partitioning and Monitoring** (MPAM) System Component specification describes propagation of a Partition ID (PARTID) and Performance Monitoring Group (PMG) through the memory system, a framework for memory-system component (MSC) controls that partition one or more of the performance resources of the component.
6+
7+
For more information, download the [MPAM System Component Specification](https://developer.arm.com/documentation/ihi0099/latest/).
8+
9+
## Release details
10+
- Code Quality: Alpha
11+
- The tests are written for version A.a of the MPAM Memory System Component Specification.
12+
- For more details on tests implemented in this release, Please refer [MPAM Test Scenario Document](docs/mpam/arm_mpam_architecture_compliance_test_scenario.pdf).
13+
14+
## Downloading MPAM ACS
15+
16+
MPAM ACS code is present in the sysarch-acs repository.
17+
18+
- git clone https://github.com/ARM-software/sysarch-acs.git <br/>
19+
- cd sysarch-acs <br/>
20+
21+
## Building MPAM ACS
22+
### UEFI application
23+
#### Prerequisites
24+
25+
ACS build requires that the following requirements are met, Please skip this if you are using [MPAM Application Build Script](../tools/scripts/build_mpam_uefi.sh).
26+
27+
- Any mainstream Linux based OS distribution.
28+
- git clone EDK2 tree.
29+
- git clone EDK2-libc tree.
30+
- Install GCC-ARM 13.2 [toolchain](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads).
31+
- Install the build prerequisite packages to build EDK2. The details of the packages are beyond the scope of this document.
32+
33+
#### Build Steps
34+
35+
- cd /path/to/bsa-acs/<br/>
36+
- source mpam/scripts/build_mpam_uefi.sh
37+
38+
#### Build Output
39+
40+
The following output file is created in /path/to/bsa-acs/workspace/output/:
41+
42+
- Mpam.efi
43+
44+
#### Note : Steps to get toolchain
45+
- wget https://developer.arm.com/-/media/Files/downloads/gnu/13.2.rel1/binrel/arm-gnu-toolchain-13.2.rel1-x86_64-aarch64-none-linux-gnu.tar.xz
46+
- tar -xf arm-gnu-toolchain-13.2.rel1-x86_64-aarch64-none-linux-gnu.tar.xz
47+
- export GCC49_AARCH64_PREFIX= GCC 13.2 toolchain path pointing to arm-gnu-toolchain-13.2.rel1-x86_64-aarch64-none-linux-gnu/bin/aarch64-none-linux-gnu-
48+
49+
## Test suite execution in UEFI
50+
51+
### Post-Silicon
52+
53+
On a system where a USB port is available and functional, perform the following steps:
54+
55+
1. Copy 'Mpam.efi' to a USB Flash drive.
56+
2. Plug in the USB Flash drive to one of the functional USB ports on the system.
57+
3. Boot the system to UEFI shell.
58+
4. To determine the file system number of the plugged in USB drive, execute 'map -r' command.
59+
5. Type 'fsx' where 'x' is replaced by the number determined in step 4.
60+
6. To start the compliance tests, run the executable Mpam.efi with the appropriate arguments.
61+
62+
### Emulation environment with secondary storage
63+
64+
On an emulation environment with secondary storage, perform the following steps:
65+
66+
1. Create an image file which contains the 'Mpam.efi' file. For Example: <br/>
67+
- mkfs.vfat -C -n HD0 hda.img 31457280 <br/>
68+
- sudo mount hda.img /mnt/mpam <br/>
69+
- cd /path/to/bsa-acs/workspace/output/ <br/>
70+
- sudo cp Mpam.efi /mnt/mpam/ <br/>
71+
- sudo umount /mnt/mpam
72+
2. Load the image file to the secondary storage using a backdoor. The steps followed to load the image file are Emulation environment specific and beyond the scope of this document.
73+
3. Boot the system to UEFI shell.
74+
4. To determine the file system number of the secondary storage, execute 'map -r' command.
75+
5. Type 'fsx' where 'x' is replaced by the number determined in step 4.
76+
6. To start the compliance tests, run the executable Mpam.efi with the appropriate arguments.
77+
78+
## Application arguments
79+
80+
Command line arguments are similar for uefi application, with some exceptions.
81+
82+
### UEFI
83+
84+
Shell> Mpam.efi [-v &lt;verbosity&gt;] [-skip &lt;test_id&gt;] [-f &lt;filename&gt;]
85+
86+
#### -v
87+
Choose the verbosity level.
88+
89+
- 1 - INFO and above
90+
- 2 - DEBUG and above
91+
- 3 - TEST and above
92+
- 4 - WARN and ERROR
93+
- 5 - ERROR
94+
95+
#### -skip
96+
Overrides the suite to skip the execution of a particular
97+
test. For example, <i>-skip 10</i> skips test 10.
98+
99+
#### -t
100+
If Test ID(s) set, will only run the specified test(s), all others will be skipped
101+
For example, <i>-t 10</i> Run test 10.
102+
103+
#### -m
104+
If Module ID(s) set, will only run the specified module(s), all others will be skipped
105+
For example, <i>-m 100</i> Run Cache Module.
106+
107+
#### -f (Only for UEFI application)
108+
Save the test output into a file in secondary storage. For example <i>-f mpam.log</i> creates a file mpam.log with test output.
109+
110+
### UEFI example
111+
112+
Shell> Mpam.efi -v 1 -skip 15,20,30 -f mpam_uefi.log
113+
114+
Runs MPAM ACS with verbosity INFO, skips test 15, 20 and 30 and saves the test results in <i>mpam_uefi.log</i>.
115+
116+
## Limitations
117+
118+
- Since this is a Alpha quality release, contains limited number of tests based on MPAM MSC Specification.
119+
- Few of the tests related to Errors in MSC have been verified on limited platforms. Please reach out to us in case of any help.
120+
- Memory Bandwidth Partitioning tests have been implemented but have not yet been verified on any platform. If you encounter any failures or errors during the ACS run, Please raise an issue.
121+
122+
## License
123+
MPAM ACS is distributed under Apache v2.0 License.
124+
125+
## Feedback, contributions, and support
126+
127+
- For feedback, use the GitHub Issue Tracker that is associated with this repository.
128+
- For support, send an email to "support-systemready-acs@arm.com" with details.
129+
- Arm licensees may contact Arm directly through their partner managers.
130+
- Arm welcomes code contributions through GitHub pull requests. See the GitHub documentation on how to raise pull requests.
131+
132+
--------------
133+
134+
*Copyright (c) 2025, Arm Limited and Contributors. All rights reserved.*
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)