mirror of https://github.com/ARMmbed/mbed-os.git
Tests: HAL API: Watchdog: Add dev reset tests
Filip Jagodzinski
Filip Jagodzinski
parent
484b716c6e
commit
f1e744d4a0
|
|
@ -0,0 +1,96 @@
|
|||
"""
|
||||
mbed SDK
|
||||
Copyright (c) 2017 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 collections
|
||||
import threading
|
||||
from mbed_host_tests import BaseHostTest
|
||||
|
||||
TestCaseData = collections.namedtuple('TestCaseData', ['index', 'data_to_send'])
|
||||
|
||||
DEFAULT_CYCLE_PERIOD = 4.0
|
||||
|
||||
MSG_VALUE_DUMMY = '0'
|
||||
CASE_DATA_INVALID = 0xffffffff
|
||||
CASE_DATA_PHASE2_OK = 0xfffffffe
|
||||
|
||||
MSG_KEY_SYNC = '__sync'
|
||||
MSG_KEY_DEVICE_READY = 'ready'
|
||||
MSG_KEY_START_CASE = 'start_case'
|
||||
MSG_KEY_DEVICE_RESET = 'dev_reset'
|
||||
|
||||
|
||||
class WatchdogReset(BaseHostTest):
|
||||
"""Host side test that handles device reset.
|
||||
|
||||
Given a device with a watchdog timer started.
|
||||
When the device notifies the host about an incoming reset.
|
||||
Then the host:
|
||||
* keeps track of the test case index of the current test suite,
|
||||
* performs a dev-host handshake.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
super(WatchdogReset, self).__init__()
|
||||
self.current_case = TestCaseData(0, CASE_DATA_INVALID)
|
||||
self.__handshake_timer = None
|
||||
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
|
||||
|
||||
def handshake_timer_start(self, seconds=1.0):
|
||||
"""Start a new handshake timer.
|
||||
|
||||
Perform a dev-host handshake by sending a sync message.
|
||||
"""
|
||||
self.__handshake_timer = threading.Timer(seconds, self.send_kv,
|
||||
[MSG_KEY_SYNC, MSG_VALUE_DUMMY])
|
||||
self.__handshake_timer.start()
|
||||
|
||||
def handshake_timer_cancel(self):
|
||||
"""Cancel the current handshake timer."""
|
||||
try:
|
||||
self.__handshake_timer.cancel()
|
||||
except AttributeError:
|
||||
pass
|
||||
finally:
|
||||
self.__handshake_timer = None
|
||||
|
||||
def setup(self):
|
||||
self.register_callback(MSG_KEY_DEVICE_READY, self.cb_device_ready)
|
||||
self.register_callback(MSG_KEY_DEVICE_RESET, self.cb_device_reset)
|
||||
|
||||
def teardown(self):
|
||||
self.handshake_timer_cancel()
|
||||
|
||||
def cb_device_ready(self, key, value, timestamp):
|
||||
"""Advance the device test suite to a proper test case.
|
||||
|
||||
Additionally, send test case data to the device.
|
||||
"""
|
||||
self.handshake_timer_cancel()
|
||||
msg_value = '{0.index:02x},{0.data_to_send:08x}'.format(self.current_case)
|
||||
self.send_kv(MSG_KEY_START_CASE, msg_value)
|
||||
|
||||
def cb_device_reset(self, key, value, timestamp):
|
||||
"""Keep track of the test case number.
|
||||
|
||||
Also set a new handshake timeout, so when the device gets
|
||||
restarted by the watchdog, the communication will be restored
|
||||
by the __handshake_timer.
|
||||
"""
|
||||
self.handshake_timer_cancel()
|
||||
case_num, dev_reset_delay_ms = (int(i, base=16) for i in value.split(','))
|
||||
self.current_case = TestCaseData(case_num, CASE_DATA_PHASE2_OK)
|
||||
self.handshake_timer_start(self.program_cycle_s + dev_reset_delay_ms / 1000.0)
|
||||
|
|
@ -0,0 +1,286 @@
|
|||
/* mbed Microcontroller Library
|
||||
* Copyright (c) 2017 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.
|
||||
*/
|
||||
#if !DEVICE_WATCHDOG
|
||||
#error [NOT_SUPPORTED] Watchdog not supported for this target
|
||||
#endif
|
||||
|
||||
#include "greentea-client/test_env.h"
|
||||
#include "utest/utest.h"
|
||||
#include "unity/unity.h"
|
||||
#include "hal/watchdog_api.h"
|
||||
#include "watchdog_reset_tests.h"
|
||||
#include "mbed.h"
|
||||
|
||||
#define TIMEOUT_MS 500UL
|
||||
#define TIMEOUT_DELTA_MS 50UL
|
||||
|
||||
#define MSG_VALUE_DUMMY "0"
|
||||
#define CASE_DATA_INVALID 0xffffffffUL
|
||||
#define CASE_DATA_PHASE2_OK 0xfffffffeUL
|
||||
|
||||
#define MSG_VALUE_LEN 24
|
||||
#define MSG_KEY_LEN 24
|
||||
|
||||
#define MSG_KEY_DEVICE_READY "ready"
|
||||
#define MSG_KEY_START_CASE "start_case"
|
||||
#define MSG_KEY_DEVICE_RESET "dev_reset"
|
||||
|
||||
using utest::v1::Case;
|
||||
using utest::v1::Specification;
|
||||
using utest::v1::Harness;
|
||||
|
||||
struct testcase_data {
|
||||
int index;
|
||||
int start_index;
|
||||
uint32_t received_data;
|
||||
};
|
||||
|
||||
void release_sem(Semaphore *sem)
|
||||
{
|
||||
sem->release();
|
||||
}
|
||||
|
||||
testcase_data current_case;
|
||||
|
||||
bool send_reset_notification(testcase_data * tcdata, uint32_t delay_ms)
|
||||
{
|
||||
char msg_value[12];
|
||||
int str_len = snprintf(msg_value, sizeof msg_value, "%02x,%08lx", tcdata->start_index + tcdata->index, delay_ms);
|
||||
if (str_len != (sizeof msg_value) - 1) {
|
||||
utest_printf("Failed to compose a value string to be sent to host.");
|
||||
return false;
|
||||
}
|
||||
greentea_send_kv(MSG_KEY_DEVICE_RESET, msg_value);
|
||||
return true;
|
||||
}
|
||||
|
||||
void test_simple_reset()
|
||||
{
|
||||
// Phase 2. -- verify the test results.
|
||||
// Verify if this test case passed based on data received from host.
|
||||
if (current_case.received_data != CASE_DATA_INVALID) {
|
||||
TEST_ASSERT_EQUAL(CASE_DATA_PHASE2_OK, current_case.received_data);
|
||||
current_case.received_data = CASE_DATA_INVALID;
|
||||
return;
|
||||
}
|
||||
|
||||
// Phase 1. -- run the test code.
|
||||
// Init the watchdog and wait for a device reset.
|
||||
watchdog_config_t config = { TIMEOUT_MS };
|
||||
if (send_reset_notification(¤t_case, TIMEOUT_MS + TIMEOUT_DELTA_MS) == false) {
|
||||
TEST_ASSERT_MESSAGE(0, "Dev-host communication error.");
|
||||
return;
|
||||
}
|
||||
TEST_ASSERT_EQUAL(WATCHDOG_STATUS_OK, hal_watchdog_init(&config));
|
||||
wait_ms(TIMEOUT_MS + TIMEOUT_DELTA_MS); // Device reset expected.
|
||||
|
||||
// Watchdog reset should have occurred during wait_ms() above;
|
||||
|
||||
hal_watchdog_kick(); // Just to buy some time for testsuite failure handling.
|
||||
TEST_ASSERT_MESSAGE(0, "Watchdog did not reset the device as expected.");
|
||||
}
|
||||
|
||||
#if DEVICE_SLEEP
|
||||
void test_sleep_reset()
|
||||
{
|
||||
// Phase 2. -- verify the test results.
|
||||
if (current_case.received_data != CASE_DATA_INVALID) {
|
||||
TEST_ASSERT_EQUAL(CASE_DATA_PHASE2_OK, current_case.received_data);
|
||||
current_case.received_data = CASE_DATA_INVALID;
|
||||
return;
|
||||
}
|
||||
|
||||
// Phase 1. -- run the test code.
|
||||
watchdog_config_t config = { TIMEOUT_MS };
|
||||
Semaphore sem(0, 1);
|
||||
Timeout timeout;
|
||||
if (send_reset_notification(¤t_case, TIMEOUT_MS + TIMEOUT_DELTA_MS) == false) {
|
||||
TEST_ASSERT_MESSAGE(0, "Dev-host communication error.");
|
||||
return;
|
||||
}
|
||||
TEST_ASSERT_EQUAL(WATCHDOG_STATUS_OK, hal_watchdog_init(&config));
|
||||
sleep_manager_lock_deep_sleep();
|
||||
timeout.attach_us(mbed::callback(release_sem, &sem), 1000ULL * (TIMEOUT_MS + TIMEOUT_DELTA_MS));
|
||||
if (sleep_manager_can_deep_sleep()) {
|
||||
TEST_ASSERT_MESSAGE(0, "Deepsleep should be disallowed.");
|
||||
return;
|
||||
}
|
||||
while (sem.wait(0) != 1) {
|
||||
sleep(); // Device reset expected.
|
||||
}
|
||||
sleep_manager_unlock_deep_sleep();
|
||||
|
||||
// Watchdog reset should have occurred during sleep() above;
|
||||
|
||||
hal_watchdog_kick(); // Just to buy some time for testsuite failure handling.
|
||||
TEST_ASSERT_MESSAGE(0, "Watchdog did not reset the device as expected.");
|
||||
}
|
||||
|
||||
#if DEVICE_LOWPOWERTIMER
|
||||
void test_deepsleep_reset()
|
||||
{
|
||||
// Phase 2. -- verify the test results.
|
||||
if (current_case.received_data != CASE_DATA_INVALID) {
|
||||
TEST_ASSERT_EQUAL(CASE_DATA_PHASE2_OK, current_case.received_data);
|
||||
current_case.received_data = CASE_DATA_INVALID;
|
||||
return;
|
||||
}
|
||||
|
||||
// Phase 1. -- run the test code.
|
||||
watchdog_config_t config = { TIMEOUT_MS };
|
||||
Semaphore sem(0, 1);
|
||||
LowPowerTimeout lp_timeout;
|
||||
if (send_reset_notification(¤t_case, TIMEOUT_MS + TIMEOUT_DELTA_MS) == false) {
|
||||
TEST_ASSERT_MESSAGE(0, "Dev-host communication error.");
|
||||
return;
|
||||
}
|
||||
TEST_ASSERT_EQUAL(WATCHDOG_STATUS_OK, hal_watchdog_init(&config));
|
||||
lp_timeout.attach_us(mbed::callback(release_sem, &sem), 1000ULL * (TIMEOUT_MS + TIMEOUT_DELTA_MS));
|
||||
wait_ms(10); // Wait for the serial buffers to flush.
|
||||
if (!sleep_manager_can_deep_sleep()) {
|
||||
TEST_ASSERT_MESSAGE(0, "Deepsleep should be allowed.");
|
||||
}
|
||||
while (sem.wait(0) != 1) {
|
||||
sleep(); // Device reset expected.
|
||||
}
|
||||
|
||||
// Watchdog reset should have occurred during that sleep() above;
|
||||
|
||||
hal_watchdog_kick(); // Just to buy some time for testsuite failure handling.
|
||||
TEST_ASSERT_MESSAGE(0, "Watchdog did not reset the device as expected.");
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
void test_restart_reset()
|
||||
{
|
||||
watchdog_features_t features = hal_watchdog_get_platform_features();
|
||||
if (!features.disable_watchdog) {
|
||||
TEST_IGNORE_MESSAGE("Disabling watchdog not supported for this platform");
|
||||
return;
|
||||
}
|
||||
|
||||
// Phase 2. -- verify the test results.
|
||||
if (current_case.received_data != CASE_DATA_INVALID) {
|
||||
TEST_ASSERT_EQUAL(CASE_DATA_PHASE2_OK, current_case.received_data);
|
||||
current_case.received_data = CASE_DATA_INVALID;
|
||||
return;
|
||||
}
|
||||
|
||||
// Phase 1. -- run the test code.
|
||||
watchdog_config_t config = { TIMEOUT_MS };
|
||||
TEST_ASSERT_EQUAL(WATCHDOG_STATUS_OK, hal_watchdog_init(&config));
|
||||
wait_ms(TIMEOUT_MS / 2UL);
|
||||
TEST_ASSERT_EQUAL(WATCHDOG_STATUS_OK, hal_watchdog_stop());
|
||||
// Check that stopping the watchdog prevents a device reset.
|
||||
wait_ms(TIMEOUT_MS / 2UL + TIMEOUT_DELTA_MS);
|
||||
|
||||
if (send_reset_notification(¤t_case, TIMEOUT_MS + TIMEOUT_DELTA_MS) == false) {
|
||||
TEST_ASSERT_MESSAGE(0, "Dev-host communication error.");
|
||||
return;
|
||||
}
|
||||
TEST_ASSERT_EQUAL(WATCHDOG_STATUS_OK, hal_watchdog_init(&config));
|
||||
wait_ms(TIMEOUT_MS + TIMEOUT_DELTA_MS); // Device reset expected.
|
||||
|
||||
// Watchdog reset should have occurred during that wait() above;
|
||||
|
||||
hal_watchdog_kick(); // Just to buy some time for testsuite failure handling.
|
||||
TEST_ASSERT_MESSAGE(0, "Watchdog did not reset the device as expected.");
|
||||
}
|
||||
|
||||
void test_kick_reset()
|
||||
{
|
||||
// Phase 2. -- verify the test results.
|
||||
if (current_case.received_data != CASE_DATA_INVALID) {
|
||||
TEST_ASSERT_EQUAL(CASE_DATA_PHASE2_OK, current_case.received_data);
|
||||
current_case.received_data = CASE_DATA_INVALID;
|
||||
return;
|
||||
}
|
||||
|
||||
// Phase 1. -- run the test code.
|
||||
watchdog_config_t config = { TIMEOUT_MS };
|
||||
TEST_ASSERT_EQUAL(WATCHDOG_STATUS_OK, hal_watchdog_init(&config));
|
||||
for (int i = 3; i; i--) {
|
||||
wait_ms(TIMEOUT_MS / 2UL);
|
||||
hal_watchdog_kick();
|
||||
}
|
||||
if (send_reset_notification(¤t_case, TIMEOUT_MS + TIMEOUT_DELTA_MS) == false) {
|
||||
TEST_ASSERT_MESSAGE(0, "Dev-host communication error.");
|
||||
return;
|
||||
}
|
||||
wait_ms(TIMEOUT_MS + TIMEOUT_DELTA_MS); // Device reset expected.
|
||||
|
||||
// Watchdog reset should have occurred during that wait() above;
|
||||
|
||||
hal_watchdog_kick(); // Just to buy some time for testsuite failure handling.
|
||||
TEST_ASSERT_MESSAGE(0, "Watchdog did not reset the device as expected.");
|
||||
}
|
||||
|
||||
utest::v1::status_t case_setup(const Case * const source, const size_t index_of_case)
|
||||
{
|
||||
current_case.index = index_of_case;
|
||||
return utest::v1::greentea_case_setup_handler(source, index_of_case);
|
||||
}
|
||||
|
||||
int testsuite_setup(const size_t number_of_cases)
|
||||
{
|
||||
GREENTEA_SETUP(90, "watchdog_reset");
|
||||
utest::v1::status_t status = utest::v1::greentea_test_setup_handler(number_of_cases);
|
||||
if (status != utest::v1::STATUS_CONTINUE) {
|
||||
return status;
|
||||
}
|
||||
|
||||
char key[MSG_KEY_LEN + 1] = { };
|
||||
char value[MSG_VALUE_LEN + 1] = { };
|
||||
|
||||
greentea_send_kv(MSG_KEY_DEVICE_READY, MSG_VALUE_DUMMY);
|
||||
greentea_parse_kv(key, value, MSG_KEY_LEN, MSG_VALUE_LEN);
|
||||
|
||||
if (strcmp(key, MSG_KEY_START_CASE) != 0) {
|
||||
utest_printf("Invalid message key.\n");
|
||||
return utest::v1::STATUS_ABORT;
|
||||
}
|
||||
|
||||
int num_args = sscanf(value, "%02x,%08lx", &(current_case.start_index), &(current_case.received_data));
|
||||
if (num_args == 0 || num_args == EOF) {
|
||||
utest_printf("Invalid data received from host\n");
|
||||
return utest::v1::STATUS_ABORT;
|
||||
}
|
||||
|
||||
utest_printf("This test suite is composed of %i test cases. Starting at index %i.\n", number_of_cases,
|
||||
current_case.start_index);
|
||||
return current_case.start_index;
|
||||
}
|
||||
|
||||
Case cases[] = {
|
||||
Case("Watchdog reset", case_setup, test_simple_reset),
|
||||
#if DEVICE_SLEEP
|
||||
Case("Watchdog reset in sleep mode", case_setup, test_sleep_reset),
|
||||
#if DEVICE_LOWPOWERTIMER
|
||||
Case("Watchdog reset in deepsleep mode", case_setup, test_deepsleep_reset),
|
||||
#endif
|
||||
#endif
|
||||
Case("Watchdog started again", case_setup, test_restart_reset),
|
||||
Case("Kicking the watchdog prevents reset", case_setup, test_kick_reset),
|
||||
};
|
||||
|
||||
Specification specification((utest::v1::test_setup_handler_t) testsuite_setup, cases);
|
||||
|
||||
int main()
|
||||
{
|
||||
// Harness will start with a test case index provided by host script.
|
||||
return !Harness::run(specification);
|
||||
}
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
/* mbed Microcontroller Library
|
||||
* Copyright (c) 2017 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup hal_watchdog_tests
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef MBED_HAL_WATCHDOG_RESET_TESTS_H
|
||||
#define MBED_HAL_WATCHDOG_RESET_TESTS_H
|
||||
|
||||
#if DEVICE_WATCHDOG
|
||||
|
||||
/** Test watchdog reset
|
||||
*
|
||||
* Given a device with a watchdog started
|
||||
* When a watchdog timeout expires
|
||||
* Then the device is restarted
|
||||
*/
|
||||
void test_simple_reset();
|
||||
|
||||
/** Test watchdog reset in sleep mode
|
||||
*
|
||||
* Given a device supporting sleep mode, with a watchdog started
|
||||
* When the device is in sleep mode and watchdog timeout expires
|
||||
* Then the device is restarted
|
||||
*/
|
||||
void test_sleep_reset();
|
||||
|
||||
/** Test watchdog reset in deepsleep mode
|
||||
*
|
||||
* Given a device supporting deepsleep mode, with watchdog started
|
||||
* When the device is in deepsleep mode and watchdog timeout expires
|
||||
* Then the device is restarted
|
||||
*/
|
||||
void test_deepsleep_reset();
|
||||
|
||||
/** Test stopped watchdog can be started again and reset the device
|
||||
*
|
||||
* Given a device supporting 'disable_watchdog' feature, with watchdog started
|
||||
* When the watchdog is stopped before timeout expires
|
||||
* Then the device is not restarted
|
||||
* When the watchdog is started again and it's timeout expires
|
||||
* Then the device is restarted
|
||||
*/
|
||||
void test_restart_reset();
|
||||
|
||||
/** Test kicking the watchdog prevents reset
|
||||
*
|
||||
* Given a device with watchdog started
|
||||
* When the watchdog is kicked before timeout expires
|
||||
* Then the device restart is prevented
|
||||
* When the watchdog is *NOT* kicked again before next timeout expires
|
||||
* Then the device is restarted
|
||||
*
|
||||
*/
|
||||
void test_kick_reset();
|
||||
|
||||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
||||
Loading…
Reference in New Issue