mbed-os/TESTS/mbed_hal/lp_ticker/main.cpp

/* mbed Microcontroller Library
 * Copyright (c) 2016 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_LOWPOWERTIMER
    #error [NOT_SUPPORTED] Low power timer not supported for this target
#endif

#include "utest/utest.h"
#include "unity/unity.h"
#include "greentea-client/test_env.h"

#include "mbed.h"
#include "lp_ticker_api.h"

using namespace utest::v1;

static volatile bool complete;
static volatile timestamp_t complete_time;
static ticker_event_t delay_event;
static const ticker_data_t *lp_ticker_data = get_lp_ticker_data();
static Timer timer;
static LowPowerTimer lp_timer;

/* Timeouts are quite arbitrary due to large number of boards with varying level of accuracy */
#define LONG_TIMEOUT (100000)
#define SHORT_TIMEOUT (600)

void cb_done(uint32_t id) {
    if ((uint32_t)&delay_event == id) {
        complete_time = timer.read_us();
        complete = true;
    } else {
        // Normal ticker handling
        TimerEvent::irq(id);
    }
}

void cb_done_deepsleep(uint32_t id) {
    if ((uint32_t)&delay_event == id) {
        complete_time = lp_timer.read_us();
        complete = true;
    } else {
        // Normal ticker handling
        TimerEvent::irq(id);
    }
}

void lp_ticker_delay_us(uint32_t delay_us, uint32_t tolerance)
{
    complete = false;
    uint32_t delay_ts;

    ticker_set_handler(lp_ticker_data, cb_done);
    ticker_remove_event(lp_ticker_data, &delay_event);
    delay_ts = ticker_read(lp_ticker_data) + delay_us;

    timer.reset();
    timer.start();
    ticker_insert_event(lp_ticker_data, &delay_event, delay_ts, (uint32_t)&delay_event);
    while (!complete);
    timer.stop();

    TEST_ASSERT_UINT32_WITHIN(tolerance, delay_us, complete_time);
    TEST_ASSERT_TRUE(complete);
}

#if DEVICE_SLEEP
void lp_ticker_1s_deepsleep()
{
    complete = false;
    uint32_t delay_ts;

    /*
     * Since deepsleep() may shut down the UART peripheral, we wait for 10ms
     * to allow for hardware serial buffers to completely flush.

     * This should be replaced with a better function that checks if the
     * hardware buffers are empty. However, such an API does not exist now,
     * so we'll use the wait_ms() function for now.
     */
    wait_ms(10);

    ticker_set_handler(lp_ticker_data, cb_done_deepsleep);
    ticker_remove_event(lp_ticker_data, &delay_event);
    delay_ts = ticker_read(lp_ticker_data) + 1000000;

    /*
     * We use here the low power timer instead of microsecond timer for start and
     * end because the microseconds timer might be disable during deepsleep.
     */
    lp_timer.reset();
    lp_timer.start();
    ticker_insert_event(lp_ticker_data, &delay_event, delay_ts, (uint32_t)&delay_event);
    /* Make sure deepsleep is allowed, to go to deepsleep */
    bool deep_sleep_allowed = sleep_manager_can_deep_sleep();
    TEST_ASSERT_TRUE_MESSAGE(deep_sleep_allowed, "Deep sleep should be allowed");
    sleep();
    while (!complete);
    lp_timer.stop();

    TEST_ASSERT_UINT32_WITHIN(LONG_TIMEOUT, 1000000, complete_time);
    TEST_ASSERT_TRUE(complete);
}

void lp_ticker_1s_sleep()
{
    complete = false;
    uint32_t delay_ts;

    ticker_set_handler(lp_ticker_data, cb_done);
    ticker_remove_event(lp_ticker_data, &delay_event);
    delay_ts = ticker_read(lp_ticker_data) + 1000000;

    sleep_manager_lock_deep_sleep();
    timer.reset();
    timer.start();
    bool deep_sleep_allowed = sleep_manager_can_deep_sleep();
    TEST_ASSERT_FALSE_MESSAGE(deep_sleep_allowed, "Deep sleep should be disallowed");
    ticker_insert_event(lp_ticker_data, &delay_event, delay_ts, (uint32_t)&delay_event);
    sleep();
    while (!complete);
    timer.stop();
    sleep_manager_unlock_deep_sleep();

    TEST_ASSERT_UINT32_WITHIN(LONG_TIMEOUT, 1000000, complete_time);
    TEST_ASSERT_TRUE(complete);
}
#endif /* DEVICE_SLEEP */

void lp_ticker_500us(void)
{
    lp_ticker_delay_us(500, SHORT_TIMEOUT);
}

void lp_ticker_1ms(void)
{
    lp_ticker_delay_us(1000, SHORT_TIMEOUT);
}

void lp_ticker_1s(void)
{
    lp_ticker_delay_us(1000000, LONG_TIMEOUT);
}

void lp_ticker_5s(void)
{
    lp_ticker_delay_us(5000000, LONG_TIMEOUT);
}

utest::v1::status_t greentea_failure_handler(const Case *const source, const failure_t reason) {
    greentea_case_failure_abort_handler(source, reason);
    return STATUS_CONTINUE;
}

Case cases[] = {
    Case("500us lp_ticker", lp_ticker_500us, greentea_failure_handler),
    Case("1ms lp_ticker", lp_ticker_1ms, greentea_failure_handler),
    Case("1s lp_ticker", lp_ticker_1s, greentea_failure_handler),
    Case("5s lp_ticker", lp_ticker_5s, greentea_failure_handler),
#if DEVICE_SLEEP
    Case("1s lp_ticker sleep", lp_ticker_1s_sleep, greentea_failure_handler),
    Case("1s lp_ticker deepsleep", lp_ticker_1s_deepsleep, greentea_failure_handler),
#endif /* DEVICE_SLEEP */
};

utest::v1::status_t greentea_test_setup(const size_t number_of_cases) {
    GREENTEA_SETUP(20, "default_auto");
    lp_ticker_data->interface->init();
    return greentea_test_setup_handler(number_of_cases);
}

Specification specification(greentea_test_setup, cases, greentea_test_teardown_handler);

int main() {
    Harness::run(specification);
}