Merge pull request #6230 from bulislaw/system_reset

Add system_reset call

Author: cmonr

TESTS/host_tests/system_reset.py

@@ -0,0 +1,76 @@
+"""
+Copyright (c) 2018 ARM Limited
+
+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.
+"""
+import time
+from mbed_host_tests import BaseHostTest
+from mbed_host_tests.host_tests_runner.host_test_default import DefaultTestSelector
+
+DEFAULT_CYCLE_PERIOD = 1.0
+
+MSG_VALUE_DUMMY = '0'
+
+MSG_KEY_DEVICE_READY = 'ready'
+MSG_KEY_DEVICE_RESET = 'reset'
+MSG_KEY_SYNC = '__sync'
+
+class SystemResetTest(BaseHostTest):
+    """Test for the system_reset API.
+
+    Given a device running code
+    When the device is restarted using @a system_reset()
+    Then the device is restarted
+    """
+
+    def __init__(self):
+        super(SystemResetTest, self).__init__()
+        self.reset = False
+        cycle_s = self.get_config_item('program_cycle_s')
+        self.program_cycle_s = cycle_s if cycle_s is not None else DEFAULT_CYCLE_PERIOD
+
+        self.test_steps_sequence = self.test_steps()
+        # Advance the coroutine to it's first yield statement.
+        self.test_steps_sequence.send(None)
+
+    def setup(self):
+        self.register_callback(MSG_KEY_DEVICE_READY, self.cb_device_ready)
+
+    def cb_device_ready(self, key, value, timestamp):
+        """Acknowledge device rebooted correctly and feed the test execution
+        """
+        self.reset = True
+
+        try:
+            if self.test_steps_sequence.send(value):
+                self.notify_complete(True)
+        except (StopIteration, RuntimeError) as exc:
+            self.notify_complete(False)
+
+    def test_steps(self):
+        """Reset the device and check the status
+        """
+        system_reset = yield
+
+        self.reset = False
+        self.send_kv(MSG_KEY_DEVICE_RESET, MSG_VALUE_DUMMY)
+        time.sleep(self.program_cycle_s)
+        self.send_kv(MSG_KEY_SYNC, MSG_VALUE_DUMMY)
+
+        system_reset = yield
+
+        if self.reset == False:
+            raise RuntimeError('Platform did not reset as expected.')
+
+        # The sequence is correct -- test passed.
+        yield True

TESTS/mbed_platform/system_reset/main.cpp

@@ -0,0 +1,51 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2018 ARM Limited
+ *
+ * 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 "mbed.h"
+#include "greentea-client/test_env.h"
+#include "unity/unity.h"
+
+#define MSG_VALUE_DUMMY "0"
+#define MSG_VALUE_LEN 16
+#define MSG_KEY_LEN 16
+
+#define MSG_KEY_DEVICE_READY "ready"
+#define MSG_KEY_DEVICE_RESET "reset"
+
+void test_system_reset()
+{
+    // Report readiness
+    greentea_send_kv(MSG_KEY_DEVICE_READY, MSG_VALUE_DUMMY);
+
+    static char _key[MSG_KEY_LEN + 1] = { };
+    static char _value[MSG_VALUE_LEN + 1] = { };
+
+    greentea_parse_kv(_key, _value, MSG_KEY_LEN, MSG_VALUE_LEN);
+    if (strcmp(_key, MSG_KEY_DEVICE_RESET) == 0) {
+        system_reset();
+        TEST_ASSERT_MESSAGE(0, "system_reset() did not reset the device as expected.");
+    }
+
+    TEST_ASSERT_MESSAGE(0, "Unexpected message key.");
+}
+
+int main(void)
+{
+    GREENTEA_SETUP(2, "system_reset");
+    test_system_reset();
+    GREENTEA_TESTSUITE_RESULT(0); // Fail on any error.
+
+    return 0;
+}

drivers/CAN.cpp

@@ -18,7 +18,7 @@
 #if DEVICE_CAN
 
 #include "cmsis.h"
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 
 namespace mbed {
 

drivers/I2C.cpp

@@ -18,7 +18,7 @@
 #if DEVICE_I2C
 
 #if DEVICE_I2C_ASYNCH
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 #endif
 
 namespace mbed {

drivers/PwmOut.h

@@ -21,7 +21,7 @@
 #if defined (DEVICE_PWMOUT) || defined(DOXYGEN_ONLY)
 #include "hal/pwmout_api.h"
 #include "platform/mbed_critical.h"
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 
 namespace mbed {
 /** \addtogroup drivers */

drivers/SPI.cpp

@@ -17,7 +17,7 @@
 #include "platform/mbed_critical.h"
 
 #if DEVICE_SPI_ASYNCH
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 #endif
 
 #if DEVICE_SPI

drivers/SerialBase.cpp

@@ -16,7 +16,7 @@
 #include "drivers/SerialBase.h"
 #include "platform/mbed_wait_api.h"
 #include "platform/mbed_critical.h"
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 
 #if DEVICE_SERIAL
 

drivers/Ticker.h

@@ -20,7 +20,7 @@
 #include "platform/Callback.h"
 #include "platform/mbed_toolchain.h"
 #include "platform/NonCopyable.h"
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 #include "hal/lp_ticker_api.h"
 #include "platform/mbed_critical.h"
 

drivers/Timeout.h

@@ -18,7 +18,7 @@
 
 #include "drivers/Ticker.h"
 #include "platform/NonCopyable.h"
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 
 namespace mbed {
 /** \addtogroup drivers */

drivers/Timer.h

@@ -19,7 +19,7 @@
 #include "platform/platform.h"
 #include "hal/ticker_api.h"
 #include "platform/NonCopyable.h"
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 
 namespace mbed {
 /** \addtogroup drivers */

features/nanostack/FEATURE_NANOSTACK/targets/TARGET_SL_RAIL/NanostackRfPhyEfr32.cpp

@@ -18,7 +18,7 @@
 #include <string.h>
 
 #include "mbed.h"
-#include "mbed_sleep.h"
+#include "mbed_power_mgmt.h"
 #include "ns_types.h"
 #include "platform/arm_hal_interrupt.h"
 #include "nanostack/platform/arm_hal_phy.h"

hal/mbed_sleep_manager.c

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-#include "mbed_sleep.h"
+#include "mbed_power_mgmt.h"
 #include "mbed_critical.h"
 #include "sleep_api.h"
 #include "mbed_error.h"

mbed.h

@@ -83,7 +83,7 @@
 #include "drivers/InterruptIn.h"
 #include "platform/mbed_wait_api.h"
 #include "hal/sleep_api.h"
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 #include "platform/mbed_rtc_time.h"
 #include "platform/mbed_poll.h"
 #include "platform/ATCmdParser.h"

platform/DeepSleepLock.h

@@ -17,7 +17,7 @@
 #define MBED_DEEPSLEEPLOCK_H
 
 #include <limits.h>
-#include "platform/mbed_sleep.h"
+#include "platform/mbed_power_mgmt.h"
 #include "platform/mbed_critical.h"
 
 namespace mbed {

platform/mbed_interface.c

@@ -71,7 +71,8 @@ int mbed_interface_powerdown(void) {
     }
 }
 
-// for backward compatibility
+MBED_DEPRECATED_SINCE("mbed-os-5.9", "This function shouldn't be used in new code."
+    "For system reset funcionality use system_reset()")
 void mbed_reset(void) {
     mbed_interface_reset();
 }