Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.

Commit ef9bf65

Browse files
chetanarmchetanarm
committed
SCMI v2.0 Alpha release code
1 parent 6c6c9b4 commit ef9bf65

122 files changed

Lines changed: 10184 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎LICENSE.md‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+

‎Makefile‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
#/** @file
2+
# * Copyright (c) 2019, Arm Limited or its affiliates. All rights reserved.
3+
# * SPDX-License-Identifier : Apache-2.0
4+
# *
5+
# * Licensed under the Apache License, Version 2.0 (the "License");
6+
# * you may not use this file except in compliance with the License.
7+
# * You may obtain a copy of the License at
8+
# *
9+
# * http://www.apache.org/licenses/LICENSE-2.0
10+
# *
11+
# * Unless required by applicable law or agreed to in writing, software
12+
# * distributed under the License is distributed on an "AS IS" BASIS,
13+
# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# * See the License for the specific language governing permissions and
15+
# * limitations under the License.
16+
#**/
17+
18+
include Makefile.inc
19+
export TOP=$(shell pwd)
20+
21+
# Library and executable names
22+
LIB=scmi_test
23+
PROGRAM=scmi_test_agent
24+
25+
# Default version and verbose setting
26+
VERBOSE := 3
27+
VERSION := 1
28+
29+
# Obtain PLAT command line argument and set platform directory
30+
# However PLAT is an optional variable hence conditionally set these
31+
ifneq ($(PLAT),)
32+
PLAT_DIR=platform/$(PLAT)
33+
EXE=$(PROGRAM)
34+
endif
35+
36+
APP_DIR=linux_app
37+
38+
# Obtain PROTOCOLS command line argument
39+
comma := ,
40+
ALL_PROTOCOLS=base common $(subst $(comma), ,$(PROTOCOLS))
41+
ALL_PROTOCOLS_UPPER=$(shell echo $(ALL_PROTOCOLS) | tr a-z A-Z)
42+
43+
# List of subdirs to be built
44+
DIRS=val $(PLAT_DIR) $(ALL_PROTOCOLS:%=test_pool/%) $(APP_DIR)
45+
BUILD_ALL=$(DIRS)
46+
47+
# Name for directory within each subdir that contains its header files
48+
export HEADER_DIR=include
49+
50+
# List of directories to be searched for header files
51+
export I_DIRS=$(DIRS:%=-I$(TOP)/%/${HEADER_DIR}) -I$(TOP)/test_pool/${HEADER_DIR} -I$(TOP)/platform/${HEADER_DIR}
52+
53+
# Output objects directory
54+
export APP_OBJ_DIR=$(TOP)/app_output
55+
56+
# Test output objects directory
57+
export TEST_OBJ_DIR=$(TOP)/test_output
58+
59+
# Platform output objects directory
60+
export PLATFORM_OBJ_DIR=$(TOP)/platform_output
61+
62+
# Val output objects directory
63+
export VAL_OBJ_DIR=$(TOP)/val_output
64+
65+
# list of names to be converted as macros
66+
export D_NAMES=$(ALL_PROTOCOLS_UPPER:%=-D%_PROTOCOL)
67+
export CFLAGS=-DVERBOSE_LEVEL=$(VERBOSE) -Wall -Werror
68+
export CFLAGS+=-DSCMI_VERSION_$(VERSION)
69+
70+
# Location of external library directories
71+
LIB_DIR=$(TOP)
72+
73+
all: all_makefiles # to avoid overriding all target
74+
75+
all_makefiles: check_requirements $(BUILD_ALL) $(LIB) $(EXE)
76+
@echo "### Built project successfully!!!###"
77+
78+
check_requirements:
79+
mkdir -p ${APP_OBJ_DIR}
80+
mkdir -p ${TEST_OBJ_DIR}
81+
mkdir -p ${PLATFORM_OBJ_DIR}
82+
mkdir -p ${VAL_OBJ_DIR}
83+
84+
$(BUILD_ALL):
85+
@echo "Building sub-component at $(@)"
86+
$(MAKE) -C $(@)
87+
88+
$(PROGRAM):
89+
echo "Building executable '$@' at `pwd`"
90+
echo "$(CC) $(D_NAMES) $(CFLAGS) $(PLATFORM_OBJ_DIR)/*.o $(LDFLAGS) -L$(LIB_DIR) -l$(LIB) -o $@"
91+
$(CC) $(D_NAMES) $(CFLAGS) $(PLATFORM_OBJ_DIR)/*.o $(LDFLAGS) -L$(LIB_DIR) -l$(LIB) -o $@
92+
93+
$(LIB):
94+
echo "Building library at `pwd`"
95+
$(AR) -cvq lib$@.a $(VAL_OBJ_DIR)/*.o $(TEST_OBJ_DIR)/*.o $(APP_OBJ_DIR)/*.o
96+
97+
help:
98+
@echo "### SUPPORTED PROTOCOLS : base power_domain system_domain performance clock sensor ###"
99+
@echo "### SUPPORTED VERSION : 1 (SCMI v1.0 test) , 2 (SCMI v2.0 test) ###"
100+
@echo "### SUPPORTED VERBOSE : 1 (ERR) 2 (WARN) 3 (TEST) 4 (DEBUG) 5 (INFO) ###"
101+
102+
clean: clean_all # to avoid overriding clean target
103+
104+
clean_all:
105+
echo "Cleaning at $(TOP)"
106+
rm -f lib*.a
107+
rm -f $(PROGRAM)
108+
rm -rf $(APP_OBJ_DIR)
109+
rm -rf $(TEST_OBJ_DIR)
110+
rm -rf $(VAL_OBJ_DIR)
111+
rm -rf $(PLATFORM_OBJ_DIR)
112+
113+
.PHONY: check_requirements
114+
.PHONY: all
115+
.PHONY: $(DIRS)
116+
.PHONY: clean

‎Makefile.inc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
export CC := $(CROSS_COMPILE)gcc
2+
CFLAGS += -static
3+
4+
LD := $(CROSS_COMPILE)ld
5+
LDFLAGS +=
6+
7+
export AR := $(CROSS_COMPILE)ar
8+
ARFLAGS +=
9+
10+
.SILENT :

‎README.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# System Control and Management Interface Compliance Suite
2+
3+
## Introduction
4+
**System Control and Management Interface** (SCMI) is a set of operating system-independent software interfaces that are used in system management.
5+
6+
For more information, download the [SCMI Platform Design Document](http://infocenter.arm.com/help/topic/com.arm.doc.den0056b/DEN0056B_System_Control_and_Management_Interface_v2_0.pdf).
7+
8+
## SCMI compliance suite
9+
SCMI compliance suite is a collection of self-checking, portable C tests. It enables adopters of SCMI PDD \(Platform Design Document\) to test their own implementations. It provides a predefined library of tests and a test framework to execute these tests. The test suite can be adapted to different platforms. It also enables the extension of the current test library to include platform-specific custom commands and custom protocols.
10+
11+
## Release details
12+
- Code quality: REL v2.0 Alpha.
13+
- The tests are written for version 2.0 of the SCMI PDD.
14+
- The compliance suite maintains backward compatibility with version 1.0 of the SCMI PDD.
15+
- The compliance suite is not a substitute for design verification.
16+
- Refer to the [Test checklist] for the scenarios covered by the tests.
17+
18+
## GitHub branch
19+
20+
To get the latest version of the code with bug fixes and new features, use the master branch.
21+
22+
## Test scenarios
23+
24+
The mapping of the SCMI commands to the test cases are mentioned in the [Test checklist].
25+
26+
## Future enhancements
27+
28+
The following features or capability additions are planned as part of future releases:
29+
- Testing notifications and delayed responses for relevant commands.
30+
- Test library extension with new test cases for additional protocols as defined in the newer version of the PDD.
31+
32+
## Getting started
33+
See the [User Guide] for instructions to adapt, build, and run the test suite.
34+
35+
### Additional reading
36+
For details on the design of the SCMI test suite, see the [Validation Methodology Document].
37+
38+
## License
39+
The software is provided under Apache 2.0 [License]. Contributions to this project are accepted under the same license.
40+
41+
## Feedback and support
42+
Arm values and welcomes any feedback and contributions to this project.
43+
44+
* For feedback, use the issue tracker that is associated with this project [Issue Tracker](https://github.com/ARM-software/scmi-tests/issues).
45+
* For support, send your queries to [support-scmi-acs@arm.com](mailto:support-scmi-acs@arm.com).
46+
* Arm licensees can contact Arm directly through their partner managers.
47+
* Arm welcomes code contributions through GitHub pull requests.
48+
49+
50+
- - - - - - - - - - - - - - - - - - - -
51+
52+
_Copyright (c) 2019, Arm Limited and Contributors. All rights reserved._
53+
54+
[User Guide]: ./docs/user_guide.md "SCMI Test Suite User Guide"
55+
[Validation Methodology Document]: ./docs/Arm_SCMI_Validation_Methodology.pdf "SCMI Test Suite Design"
56+
[Test checklist]: ./docs/scmi_testlist.md "SCMI Test Specification"
57+
[License]: ./LICENSE.md "License"

‎docs/Arm_SCMI_Validation_Methodology.pdf‎

384 KB
Binary file not shown.

0 commit comments

Comments
 (0)