# System Control and Management Interface Compliance Suite

## Introduction
**System Control and Management Interface** (SCMI)  is a set of operating system-independent software interfaces that are used in system management.

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).

## SCMI compliance suite
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.

## Release details
 - Code quality: REL v2.0 Alpha.
 - The tests are written for version 2.0 of the SCMI PDD.
 - The compliance suite maintains backward compatibility with version 1.0 of the SCMI PDD.
 - The compliance suite is not a substitute for design verification.
 - Refer to the [Test checklist] for the scenarios covered by the tests.

## GitHub branch

To get the latest version of the code with bug fixes and new features, use the master branch.

## Test scenarios

The mapping of the SCMI commands to the test cases are mentioned in the [Test checklist].

## Future enhancements

The following features or capability additions are planned as part of future releases:
-   Testing notifications and delayed responses for relevant commands.
-   Test library extension with new test cases for additional protocols as defined in the newer version of the PDD.

## Getting started
See the [User Guide] for instructions to adapt, build, and run the test suite.

### Additional reading
For details on the design of the SCMI test suite, see the [Validation Methodology Document].

## License
The software is provided under Apache 2.0 [License]. Contributions to this project are accepted under the same license.

## Feedback and support
Arm values and welcomes any feedback and contributions to this project.

*   For feedback, use the issue tracker that is associated with this project [Issue Tracker](https://github.com/ARM-software/scmi-tests/issues).
*   For support, send your queries to [support-scmi-acs@arm.com](mailto:support-scmi-acs@arm.com).
*   Arm licensees can contact Arm directly through their partner managers.
*   Arm welcomes code contributions through GitHub pull requests.


- - - - - - - - - - - - - - - - - - - -

_Copyright (c) 2019, Arm Limited and Contributors. All rights reserved._

[User Guide]:			./docs/user_guide.md "SCMI Test Suite User Guide"
[Validation Methodology Document]:		./docs/Arm_SCMI_Validation_Methodology.pdf "SCMI Test Suite Design"
[Test checklist]:		./docs/scmi_testlist.md "SCMI Test Specification"
[License]:		./LICENSE.md "License"