Merge pull request #15 from chetansinghrathore/master

SCMI ACK v2.0 Alpha Release code

Author: prasanth-pulla

license.md LICENSE.mdlicense.md renamed to LICENSE.md

@@ -1,4 +1,4 @@
-                                  Apache License
+                                 Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
@@ -177,15 +177,26 @@
 
    APPENDIX: How to apply the Apache License to your work.
 
-      Individual files to contain the following tag instead of full license text.
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
 
-----------
+   Copyright [yyyy] [name of copyright owner]
 
->     Copyright (c) YYYY, ARM Limited and Contributors. All rights reserved.
->
->     SPDX-License-Identifier: Apache-2.0
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
 
-----------
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
 
-      This enables machine processing of license information based on the SPDX
-      License Identifiers that are avialable at: [http://spdx.org/licenses/](http://spdx.org/licenses/)

Makefile

@@ -1,49 +1,85 @@
-#
-# Copyright (c) 2017, ARM Limited and Contributors. All rights reserved.
-#
-# SPDX-License-Identifier: Apache-2.0
-#
+#/** @file
+# * Copyright (c) 2019, Arm Limited or its affiliates. All rights reserved.
+# * SPDX-License-Identifier : Apache-2.0
+# *
+# * Licensed under the Apache License, Version 2.0 (the "License");
+# * you may not use this file except in compliance with the License.
+# * You may obtain a copy of the License at
+# *
+# *  http://www.apache.org/licenses/LICENSE-2.0
+# *
+# * Unless required by applicable law or agreed to in writing, software
+# * distributed under the License is distributed on an "AS IS" BASIS,
+# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# * See the License for the specific language governing permissions and
+# * limitations under the License.
+#**/
 
 include Makefile.inc
 export TOP=$(shell pwd)
+
 # Library and executable names
 LIB=scmi_test
 PROGRAM=scmi_test_agent
+
+# Default version and verbose setting
+VERBOSE := 3
+VERSION := 1
+
 # Obtain PLAT command line argument and set platform directory
-# However PLAT is an optional varible hence conditionally set these
+# However PLAT is an optional variable hence conditionally set these
 ifneq ($(PLAT),)
-	PLAT_DIR=platform/$(PLAT) platform/$(PLAT)/transport
+	PLAT_DIR=platform/$(PLAT)
 	EXE=$(PROGRAM)
 endif
 
+APP_DIR=linux_app
+
 # Obtain PROTOCOLS command line argument
 comma := ,
-ALL_PROTOCOLS=base $(subst $(comma), ,$(PROTOCOLS))
+ALL_PROTOCOLS=base common $(subst $(comma), ,$(PROTOCOLS))
 ALL_PROTOCOLS_UPPER=$(shell echo $(ALL_PROTOCOLS) | tr a-z A-Z)
+
 # List of subdirs to be built
-DIRS=test_agent $(PLAT_DIR) $(ALL_PROTOCOLS:%=protocols/%)
+DIRS=val $(PLAT_DIR) $(ALL_PROTOCOLS:%=test_pool/%) $(APP_DIR)
 BUILD_ALL=$(DIRS)
+
 # Name for directory within each subdir that contains its header files
 export HEADER_DIR=include
+
 # List of directories to be searched for header files
-export I_DIRS=$(DIRS:%=-I$(TOP)/%/${HEADER_DIR}) -I$(TOP)/protocols/${HEADER_DIR} -I$(TOP)/platform/${HEADER_DIR}
+export I_DIRS=$(DIRS:%=-I$(TOP)/%/${HEADER_DIR}) -I$(TOP)/test_pool/${HEADER_DIR} -I$(TOP)/platform/${HEADER_DIR}
+
 # Output objects directory
-export OBJ_DIR=$(TOP)/output
+export APP_OBJ_DIR=$(TOP)/app_output
+
+# Test output objects directory
+export TEST_OBJ_DIR=$(TOP)/test_output
+
 # Platform output objects directory
 export PLATFORM_OBJ_DIR=$(TOP)/platform_output
+
+# Val output objects directory
+export VAL_OBJ_DIR=$(TOP)/val_output
+
 # list of names to be converted as macros
 export D_NAMES=$(ALL_PROTOCOLS_UPPER:%=-D%_PROTOCOL)
+export CFLAGS=-DVERBOSE_LEVEL=$(VERBOSE) -Wall -Werror
+export CFLAGS+=-DSCMI_VERSION_$(VERSION)
+
 # Location of external library directories
 LIB_DIR=$(TOP)
 
 all: all_makefiles # to avoid overriding all target
 
 all_makefiles: check_requirements $(BUILD_ALL) $(LIB) $(EXE)
-	@echo "### Built project succesfully!!!###"
+	@echo "### Built project successfully!!!###"
 
 check_requirements:
-	mkdir -p ${OBJ_DIR}
+	mkdir -p ${APP_OBJ_DIR}
+	mkdir -p ${TEST_OBJ_DIR}
 	mkdir -p ${PLATFORM_OBJ_DIR}
+	mkdir -p ${VAL_OBJ_DIR}
 
 $(BUILD_ALL):
 	@echo "Building sub-component at $(@)"
@@ -56,15 +92,22 @@ $(PROGRAM):
 
 $(LIB):
 	echo "Building library at `pwd`"
-	$(AR) -cvq lib$@.a $(OBJ_DIR)/*.o
+	$(AR) -cvq lib$@.a $(VAL_OBJ_DIR)/*.o $(TEST_OBJ_DIR)/*.o  $(APP_OBJ_DIR)/*.o
+
+help:
+	@echo "### SUPPORTED PROTOCOLS : base power_domain system_domain performance clock sensor  ###"
+	@echo "### SUPPORTED VERSION : 1 (SCMI v1.0 test) , 2 (SCMI v2.0 test)  ###"
+	@echo "### SUPPORTED VERBOSE : 1 (ERR) 2 (WARN) 3 (TEST) 4 (DEBUG) 5 (INFO)   ###"
 
 clean: clean_all # to avoid overriding clean target
 
 clean_all:
 	echo "Cleaning at $(TOP)"
 	rm -f lib*.a
 	rm -f $(PROGRAM)
-	rm -rf $(OBJ_DIR)
+	rm -rf $(APP_OBJ_DIR)
+	rm -rf $(TEST_OBJ_DIR)
+	rm -rf $(VAL_OBJ_DIR)
 	rm -rf $(PLATFORM_OBJ_DIR)
 
 .PHONY: check_requirements

README.md

@@ -0,0 +1,57 @@
+# 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"

acknowledgements.md

@@ -1,9 +1,9 @@
-**Guide for testing on Juno ADP**
+**Guide for testing on SGM platforms**
 =================================
 
 Table of Contents:
 - [Introduction](#introduction)
-- [Juno ADP software stack](#juno-adp-software-stack)
+- [Software stack](#software-stack)
 - [Linux kernel](#linux-kernel)
   * [Mailbox test driver](#mailbox-test-driver)
   * [Doorbell support patches for mailbox](#doorbell-support-patches-for-mailbox)
@@ -12,54 +12,27 @@ Table of Contents:
 
 Introduction
 -------
-This document lists the instructions that must be followed to enable the Juno Linux image to run SCMI Linux application using the mailbox test driver interface.
+This document lists the instructions that must be followed to run SCMI ACS as Linux application using the mailbox test driver interface on SGM platforms.
+For an introduction to the System Guidance for Mobile (SGM) platforms, please refer to the [Arm Developer documentation].
 
-Juno ADP software stack
+Software Stack
 -------
-The [Arm connected community] maintains the information about the software stack support for Juno Arm Development Platform (ADP). 
+Arm provides a [super-project] with guides for building and running a full software stack on Arm platforms. This project provides a convenient wrapper around the various build systems involved in the software stack. Please contact Arm for support on software stack for SGM platform.
 
-Linux kernel 
+Linux kernel
 -------
-The following changes must be made in the Linux kernel source code.
+The following changes must be made in the Linux kernel source code after downloading software stack for SGM.
 
 ### Mailbox test driver
-To use SCMI test agent on Juno platform, the Linux kernel must be rebuilt to include the mailbox test driver with mailbox doorbell support and additional changes. Doorbell support patches for mailbox and additional changes to enable mailbox test driver are tested against Linux kernel version 4.13. 
+To use SCMI test agent on SGM platform, the Linux kernel must be rebuilt to include the mailbox test driver with mailbox doorbell support and additional changes. Doorbell support patches for mailbox and additional changes to enable mailbox test driver are tested against Linux kernel version 4.13.
 
 ### Doorbell support patches for mailbox
-The doorbell support for mailbox driver is enabled by applying a patch series that is currently discussed in LKML. For more information, see [Mailbox doorbell support patches]. Pick up the relevant mailbox patches from [Mailbox doorbell support repo]. These patches must be applied to the Juno mainline tracker kernel. The kernel can be downloaded using the steps that are mentioned on [Arm connected community].
+The doorbell support for mailbox driver is enabled by applying a patch series that is currently discussed in LKML. For more information, see [Mailbox doorbell support patches]. Pick up the relevant mailbox patches from [Mailbox doorbell support repo]. These patches must be applied to the linux kernel.
 
 ### Additional changes to enable mailbox test driver
 In addition to applying the patches, follow these steps before starting the kernel build.
 
-`Enable mailbox test driver`: By default, Juno ADP kernels do not have the mailbox test driver enabled. Set CONFIG_MAILBOX_TEST=y in kernel config to include mailbox test driver in the kernel.
-
-`Update device tree`: The Juno device trees currently have a node describing mailbox prior to the doorbell mode support. Also, the current device trees do not have a node describing the mailbox test. <br>
-You must do the following in arch/arm64/boot/dts/arm/juno-base.dtsi. Replace existing node describing mailbox with the following:
-
-```
-	mailbox: mhu@2b1f0000 {
-			compatible = "arm,mhu-doorbell", "arm,primecell";
-			reg = <0x0 0x2b1f0000 0x0 0x1000>;
-			interrupts = <GIC_SPI 36 IRQ_TYPE_LEVEL_HIGH>,
-				     <GIC_SPI 35 IRQ_TYPE_LEVEL_HIGH>;
-			interrupt-names = "mhu_lpri_rx",
-					  "mhu_hpri_rx";
-			#mbox-cells = <2>;
-			mbox-name = "ARM-MHU";
-			clocks = <&soc_refclk100mhz>;
-			clock-names = "apb_pclk";
-	};
-```
-Then, add a new node describing the mailbox test as shown below:
-
-```
-	mailbox-test@2e000000 {
-		compatible = "mailbox-test";
-		mbox-names = "tx";
-		mboxes = <&mailbox 0 0>;
-		reg = <0x0 0x2e000000 0x0 0x80>, <0x0 0x2e000000 0x0 0x80>;
-	};
-```
+`Enable mailbox test driver`: Set CONFIG_MAILBOX_TEST=y in kernel config to include mailbox test driver in the kernel.
 
 `Modify mailbox driver to prevent format conversion`: The current version of mailbox driver always converts raw binary data to hex format. For SCMI test agent, we expect raw data unmodified for processing. The change that is shown below prevents the format change. 
 <br> The driver support to add this as a configurable option is planned for the future.
@@ -85,15 +58,16 @@ waitq_err:
 The current change in mailbox test driver is not an ideal solution. A better solution is to use sysfs entry for configurability. This enhancement will be upstreamed in the future, thereby making this change redundant.
 
 ## Kernel build
-Build the kernel and device tree after making the changes for Juno ADP, and flash the images in target.
+Build the kernel and device tree after making the changes and use the run-scripts for running the SGM
 
-For instructions to build the test suite for arm/juno platform and running it, see relevant sections in [User Guide].
+For instructions to build the test suite for sgm platform and running it, see relevant sections in [User Guide].
 
 - - - - - - - - - - - - - - - -
 
-_Copyright (c) 2017, Arm Limited and Contributors. All rights reserved._
+_Copyright (c) 2019, Arm Limited and Contributors. All rights reserved._
 
-[ARM connected community]:		https://community.arm.com/dev-platforms
+[ARM Developer documentation]:		https://developer.arm.com/tools-and-software/simulation-models/fixed-virtual-platforms
 [Mailbox doorbell support patches]:	https://lkml.org/lkml/2017/5/24/339
 [Mailbox doorbell support repo]:	https://git.kernel.org/pub/scm/linux/kernel/git/sudeep.holla/linux.git/log/?h=scmi_mhu_dt_changes
 [User Guide]:				./user_guide.md
+[super-project]:  https://git.linaro.org/landing-teams/working/arm/arm-reference-platforms.git/about/docs/user-guide.rst