Merge pull request #19 from chetan-rathore/master

SCMI 2.0 EAC release

Author: chetan-rathore

Makefile

@@ -21,34 +21,50 @@ export TOP=$(shell pwd)
 # Library and executable names
 LIB=scmi_test
 PROGRAM=scmi_test_agent
+BAREMETAL=baremetal
+MOCKER=mocker
+LINUX=linux
 
-# Default version and verbose setting
-VERBOSE := 3
-VERSION := 1
-
-# Obtain PLAT command line argument and set platform directory
-# However PLAT is an optional variable hence conditionally set these
+#Set PLATFORM
 ifneq ($(PLAT),)
-	PLAT_DIR=platform/$(PLAT)
-	EXE=$(PROGRAM)
+PLAT_DIR=platform/$(PLAT)
+APP_DIR=$(PLAT)_app
+EXE=$(PROGRAM)
 endif
 
-APP_DIR=linux_app
+ifeq ($(PLAT),$(BAREMETAL))
+LIB_BM=$(LIB)
+undefine EXE
+else
+LIB_ALL=$(LIB)
+endif
+
+ifeq ($(PLAT),$(LINUX))
+PLAT_DIR=platform/sgm776
+endif
+
+# Set VERBOSE to default(TEST) if not set
+ifndef VERBOSE
+    VERBOSE=3
+endif
 
 # Obtain PROTOCOLS command line argument
 comma := ,
-ALL_PROTOCOLS=base common $(subst $(comma), ,$(PROTOCOLS))
+ALL_PROTOCOLS=base $(subst $(comma), ,$(PROTOCOLS))
 ALL_PROTOCOLS_UPPER=$(shell echo $(ALL_PROTOCOLS) | tr a-z A-Z)
 
 # List of subdirs to be built
 DIRS=val $(PLAT_DIR) $(ALL_PROTOCOLS:%=test_pool/%) $(APP_DIR)
+ifeq ($(PLAT),$(MOCKER))
+DIRS+=$(PLAT_DIR)/$(PLAT)
+endif
 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)/test_pool/${HEADER_DIR} -I$(TOP)/platform/${HEADER_DIR}
+export I_DIRS=$(DIRS:%=-I$(TOP)/%/${HEADER_DIR}) -I$(TOP)/val/${HEADER_DIR} -I$(TOP)/platform/$(PLAT)/${HEADER_DIR}
 
 # Output objects directory
 export APP_OBJ_DIR=$(TOP)/app_output
@@ -64,15 +80,14 @@ 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)
+export CFLAGS+=-DVERBOSE_LEVEL=$(VERBOSE)  -Wall -Werror
 
 # Location of external library directories
 LIB_DIR=$(TOP)
 
 all: all_makefiles # to avoid overriding all target
 
-all_makefiles: check_requirements $(BUILD_ALL) $(LIB) $(EXE)
+all_makefiles: check_requirements $(BUILD_ALL) $(LIB_ALL) $(LIB_BM) $(EXE)
 	@echo "### Built project successfully!!!###"
 
 check_requirements:
@@ -88,15 +103,18 @@ $(BUILD_ALL):
 $(PROGRAM):
 	echo "Building executable '$@' at `pwd`"
 	echo "$(CC) $(D_NAMES) $(CFLAGS) $(PLATFORM_OBJ_DIR)/*.o $(LDFLAGS) -L$(LIB_DIR) -l$(LIB) -o $@"
-	$(CC) $(D_NAMES) $(CFLAGS) $(PLATFORM_OBJ_DIR)/*.o $(LDFLAGS) -L$(LIB_DIR) -l$(LIB) -o $@
+	$(CC) $(D_NAMES) $(CFLAGS)  $(APP_OBJ_DIR)/*.o $(PLATFORM_OBJ_DIR)/*.o $(LDFLAGS) -L$(LIB_DIR) -l$(LIB) -o $@
+
+$(LIB_BM):
+	echo "Building library at `pwd`"
+	$(AR) -cvq lib$@.a $(VAL_OBJ_DIR)/*.o $(TEST_OBJ_DIR)/*.o  $(APP_OBJ_DIR)/*.o $(PLATFORM_OBJ_DIR)/*.o
 
-$(LIB):
+$(LIB_ALL):
 	echo "Building library at `pwd`"
-	$(AR) -cvq lib$@.a $(VAL_OBJ_DIR)/*.o $(TEST_OBJ_DIR)/*.o  $(APP_OBJ_DIR)/*.o
+	$(AR) -cvq lib$@.a $(VAL_OBJ_DIR)/*.o $(TEST_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 PROTOCOLS : base power_domain system_domain performance clock sensor reset  ###"
 	@echo "### SUPPORTED VERBOSE : 1 (ERR) 2 (WARN) 3 (TEST) 4 (DEBUG) 5 (INFO)   ###"
 
 clean: clean_all # to avoid overriding clean target

README.md

@@ -1,42 +1,37 @@
-# System Control and Management Interface Compliance Suite
+
+# 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.
+**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).
+For more information, download the [SCMI Platform Design Document](https://developer.arm.com/documentation/den0056/b/?lang=en).
 
-## 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.
+## SCMI Compliance suite
+SCMI compliance suite is a collection of self-checking, portable C tests. SCMI compliance suite enables adopters of SCMI Platform Design Document \(PDD\) 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.
+ - Code quality: REL v2.0.
  - 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.
+ - The compliance suite is verified against [SCP-firmware](https://github.com/ARM-software/SCP-firmware).
+ - To know about the gaps in the test coverage, see the [Test checklist].
 
 ## GitHub branch
-
-To get the latest version of the code with bug fixes and new features, use the master branch.
+  Use the master branch to get the latest version of the code with bug fixes and new features.
 
 ## 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.
+The mapping of the rules in the specification to the test cases and the steps followed in the tests are mentioned in the [Test checklist].
 
 ## Getting started
-See the [User Guide] for instructions to adapt, build, and run the test suite.
+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].
+For details on the design of the SCMI test suite, see [Validation Methodology Document].
 
 ## License
-The software is provided under Apache 2.0 [License]. Contributions to this project are accepted under the same 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.
@@ -49,9 +44,8 @@ Arm values and welcomes any feedback and contributions to this project.
 
 - - - - - - - - - - - - - - - - - - - -
 
-_Copyright (c) 2019, Arm Limited and Contributors. All rights reserved._
+_Copyright (c) 2019-2020, 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"
+[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"

baremetal_app/Makefile

@@ -0,0 +1,35 @@
+#/** @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.
+#**/
+
+C_FILES := $(wildcard *.c)
+H_FILES := $(wildcard $(HEADER_DIR)/*.h)
+OBJS := $(patsubst %.c,$(APP_OBJ_DIR)/%.o,$(C_FILES))
+
+all: all_baremetal_app
+
+all_baremetal_app: $(OBJS)
+	@echo "### Finished building with makefile at `pwd` ###"
+
+$(APP_OBJ_DIR)/%.o: %.c $(H_FILES)
+	echo "$(CC) $(D_NAMES) $(CFLAGS) $(I_DIRS) -c $< -o $@"
+	$(CC) $(D_NAMES) $(CFLAGS) $(I_DIRS) -g -c $< -o $@
+
+clean: clean_baremetal_app
+
+clean_baremetal_app:
+
+.PHONY: clean

baremetal_app/app.c

@@ -0,0 +1,86 @@
+/** @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 "val_interface.h"
+
+/**
+  @brief   Entry point to SCMI suite
+           1. Caller       -  Platform layer.
+           2. Prerequisite -  Power domain protocol info table.
+  @param   none
+  @return  none
+**/
+
+void arm_scmi_agent_execute(void *agent_info)
+{
+    uint32_t num_pass;
+    uint32_t num_fail;
+    uint32_t num_skip;
+
+    val_print(VAL_PRINT_ERR, "\n\n        **** SCMI Compliance Suite **** ");
+
+    if (val_initialize_system(agent_info)) {
+        val_print(VAL_PRINT_ERR, "\n **** INIT FAILED ***");
+        return;
+    }
+
+    val_print(VAL_PRINT_ERR, "\n\n          *** Starting BASE tests ***");
+    val_base_execute_tests();
+
+#ifdef POWER_DOMAIN_PROTOCOL
+    val_print(VAL_PRINT_ERR, "\n\n          *** Starting POWER tests *** ");
+    val_power_domain_execute_tests();
+#endif
+
+#ifdef SYSTEM_POWER_PROTOCOL
+    val_print(VAL_PRINT_ERR, "\n\n          *** Starting SYSTEM POWER tests ***  ");
+    val_system_power_execute_tests();
+#endif
+
+#ifdef PERFORMANCE_PROTOCOL
+    val_print(VAL_PRINT_ERR, "\n\n          *** Starting PERFORMANCE tests ***  ");
+    val_performance_execute_tests();
+#endif
+
+ #ifdef CLOCK_PROTOCOL
+    val_print(VAL_PRINT_ERR, "\n\n          *** Starting CLOCK tests ***");
+    val_clock_execute_tests();
+#endif
+
+#ifdef SENSOR_PROTOCOL
+    val_print(VAL_PRINT_ERR, "\n\n          *** Starting SENSOR tests ***  ");
+    val_sensor_execute_tests();
+#endif
+
+#ifdef RESET_PROTOCOL
+    val_print(VAL_PRINT_ERR, "\n\n          *** Starting RESET tests ***  ");
+    val_reset_execute_tests();
+#endif
+
+    num_pass = val_get_test_passed();
+    num_fail = val_get_test_failed();
+    num_skip = val_get_test_skipped();
+
+    val_print(VAL_PRINT_ERR, "\n****************************************************", 0);
+    val_print(VAL_PRINT_ERR, "\n  TOTAL TESTS: %d", num_pass + num_fail + num_skip);
+    val_print(VAL_PRINT_ERR, "    PASSED: %d", num_pass);
+    val_print(VAL_PRINT_ERR, "    FAILED: %d", num_fail);
+    val_print(VAL_PRINT_ERR, "    SKIPPED: %d", num_skip);
+    val_print(VAL_PRINT_ERR, "\n****************************************************", 0);
+
+    val_print(VAL_PRINT_ERR, "\n\n        **** SCMI tests complete **** \n ");
+}

docs/ARM_SCMI_Validation_Methodology.pdf

@@ -1,3 +1,4 @@
+
 **Guide for testing on SGM platforms**
 =================================
 
@@ -17,43 +18,43 @@ For an introduction to the System Guidance for Mobile (SGM) platforms, please re
 
 Software Stack
 -------
-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.
+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 at  support-connect@arm.com  for support on software stack of SGM platform.
 
 Linux kernel
 -------
-The following changes must be made in the Linux kernel source code after downloading software stack for SGM.
+The following changes must be made in the Linux kernel source code after downloading the software stack for SGM.
 
 ### Mailbox test driver
-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.
+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 linux kernel.
+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]. 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`: 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. 
+`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.
 <br> Until that change is added, the change that is shown below is required in the mbox_test_message_read function in drivers/mailbox/mailbox-test.c:
 
 ```
-	}
-	*(touser + l) = '\0';
+    }
+    *(touser + l) = '\0';
 
-+	ret = simple_read_from_buffer(userbuf, count, ppos, tdev->rx_buffer,
-+					MBOX_HEXDUMP_MAX_LEN);
++   ret = simple_read_from_buffer(userbuf, count, ppos, tdev->rx_buffer,
++                   MBOX_HEXDUMP_MAX_LEN);
 +
-	memset(tdev->rx_buffer, 0, MBOX_MAX_MSG_LEN);
-	mbox_data_ready = false;
+    memset(tdev->rx_buffer, 0, MBOX_MAX_MSG_LEN);
+    mbox_data_ready = false;
 
-	spin_unlock_irqrestore(&tdev->lock, flags);
+    spin_unlock_irqrestore(&tdev->lock, flags);
 
--	ret = simple_read_from_buffer(userbuf, count, ppos, touser, MBOX_HEXDUMP_MAX_LEN);
+-   ret = simple_read_from_buffer(userbuf, count, ppos, touser, MBOX_HEXDUMP_MAX_LEN);
 waitq_err:
-	__set_current_state(TASK_RUNNING);
-	remove_wait_queue(&tdev->waitq, &wait);
+    __set_current_state(TASK_RUNNING);
+    remove_wait_queue(&tdev->waitq, &wait);
 ```
 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.
 
@@ -64,10 +65,9 @@ For instructions to build the test suite for sgm platform and running it, see re
 
 - - - - - - - - - - - - - - - -
 
-_Copyright (c) 2019, Arm Limited and Contributors. All rights reserved._
+_Copyright (c) 2019-2020, Arm Limited and Contributors. All rights reserved._
 
-[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
+[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
+[User Guide]:                ./user_guide.md
 [super-project]:  https://git.linaro.org/landing-teams/working/arm/arm-reference-platforms.git/about/docs/user-guide.rst