/* * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include #include #include #include #include #include "unity.h" #include "freertos/FreeRTOS.h" #include "freertos/task.h" #include "freertos/semphr.h" #include "spi_flash_mmap.h" #include "esp_rom_sys.h" #include "esp_private/spi_flash_os.h" #if CONFIG_IDF_TARGET_ESP32 #include "esp32/rom/ets_sys.h" // for ETSTimer type #elif CONFIG_IDF_TARGET_ESP32S2 #include "esp32s2/rom/ets_sys.h" #elif CONFIG_IDF_TARGET_ESP32S3 #include "esp32s3/rom/ets_sys.h" #elif CONFIG_IDF_TARGET_ESP32C3 #include "esp32c3/rom/ets_sys.h" #elif CONFIG_IDF_TARGET_ESP32C2 #include "esp32c2/rom/ets_sys.h" #elif CONFIG_IDF_TARGET_ESP32C6 #include "esp32c6/rom/ets_sys.h" #endif static void test_correct_delay_timer_func(void* arg) { struct timeval* ptv = (struct timeval*) arg; gettimeofday(ptv, NULL); } TEST_CASE("ets_timer produces correct delay", "[ets_timer]") { ETSTimer timer1 = {0}; const int delays_ms[] = {20, 100, 200, 250}; const size_t delays_count = sizeof(delays_ms) / sizeof(delays_ms[0]); for (size_t i = 0; i < delays_count; ++i) { struct timeval tv_end = {0}; ets_timer_setfn(&timer1, &test_correct_delay_timer_func, &tv_end); struct timeval tv_start; gettimeofday(&tv_start, NULL); ets_timer_arm(&timer1, delays_ms[i], false); vTaskDelay(delays_ms[i] * 2 / portTICK_PERIOD_MS); int32_t ms_diff = (tv_end.tv_sec - tv_start.tv_sec) * 1000 + (tv_end.tv_usec - tv_start.tv_usec) / 1000; printf("%d %"PRIi32"\n", delays_ms[i], ms_diff); TEST_ASSERT_INT32_WITHIN(portTICK_PERIOD_MS, delays_ms[i], ms_diff); } ets_timer_disarm(&timer1); ets_timer_done(&timer1); } // no, we can't make this a const size_t (ยง6.7.5.2) #define NUM_INTERVALS 16 typedef struct { ETSTimer *timer; size_t cur_interval; int intervals[NUM_INTERVALS]; struct timeval tv_start; } test_periodic_correct_delays_args_t; static void test_periodic_correct_delays_timer_func(void* arg) { test_periodic_correct_delays_args_t *p_args = (test_periodic_correct_delays_args_t *) arg; struct timeval tv_now; gettimeofday(&tv_now, NULL); int32_t ms_diff = (tv_now.tv_sec - p_args->tv_start.tv_sec) * 1000 + (tv_now.tv_usec - p_args->tv_start.tv_usec) / 1000; printf("timer #%d %"PRIi32"ms\n", p_args->cur_interval, ms_diff); p_args->intervals[p_args->cur_interval++] = ms_diff; // Deliberately make timer handler run longer. // We check that this doesn't affect the result. esp_rom_delay_us(10 * 1000); if (p_args->cur_interval == NUM_INTERVALS) { printf("done\n"); ets_timer_disarm(p_args->timer); } } TEST_CASE("periodic ets_timer produces correct delays", "[ets_timer]") { const int delay_ms = 100; ETSTimer timer1 = {0}; test_periodic_correct_delays_args_t args = {0}; args.timer = &timer1; gettimeofday(&args.tv_start, NULL); ets_timer_setfn(&timer1, &test_periodic_correct_delays_timer_func, &args); ets_timer_arm(&timer1, delay_ms, true); vTaskDelay(delay_ms * (NUM_INTERVALS + 1)); TEST_ASSERT_EQUAL_UINT32(NUM_INTERVALS, args.cur_interval); for (size_t i = 0; i < NUM_INTERVALS; ++i) { TEST_ASSERT_INT32_WITHIN(portTICK_PERIOD_MS, (i + 1) * delay_ms, args.intervals[i]); } ets_timer_done(&timer1); } #undef NUM_INTERVALS #define N 5 typedef struct { const int order[N * 3]; size_t count; } test_timers_ordered_correctly_common_t; typedef struct { int timer_index; const int intervals[N]; size_t intervals_count; ETSTimer* timer; test_timers_ordered_correctly_common_t* common; bool pass; SemaphoreHandle_t done; } test_timers_ordered_correctly_args_t; static void test_timers_ordered_correctly_timer_func(void* arg) { test_timers_ordered_correctly_args_t* p_args = (test_timers_ordered_correctly_args_t*) arg; // check order size_t count = p_args->common->count; int expected_index = p_args->common->order[count]; printf("At count %d, expected timer %d, got timer %d\n", count, expected_index, p_args->timer_index); if (expected_index != p_args->timer_index) { p_args->pass = false; ets_timer_disarm(p_args->timer); xSemaphoreGive(p_args->done); return; } p_args->common->count++; if (++p_args->intervals_count == N) { ets_timer_disarm(p_args->timer); xSemaphoreGive(p_args->done); return; } int next_interval = p_args->intervals[p_args->intervals_count]; printf("timer %d interval #%d, %d ms\n", p_args->timer_index, p_args->intervals_count, next_interval); ets_timer_arm(p_args->timer, next_interval, false); } TEST_CASE("multiple ETSTimers are ordered correctly", "[ets_timer]") { ETSTimer timer1; ETSTimer timer2; ETSTimer timer3; test_timers_ordered_correctly_common_t common = { .order = {1, 2, 3, 2, 1, 3, 1, 2, 1, 3, 2, 1, 3, 3, 2}, .count = 0 }; SemaphoreHandle_t done = xSemaphoreCreateCounting(3, 0); test_timers_ordered_correctly_args_t args1 = { .timer_index = 1, .intervals = {10, 40, 20, 40, 30}, .timer = &timer1, .common = &common, .pass = true, .done = done }; test_timers_ordered_correctly_args_t args2 = { .timer_index = 2, .intervals = {20, 20, 60, 30, 40}, .timer = &timer2, .common = &common, .pass = true, .done = done }; test_timers_ordered_correctly_args_t args3 = { .timer_index = 3, .intervals = {30, 30, 60, 30, 10}, .timer = &timer3, .common = &common, .pass = true, .done = done }; ets_timer_setfn(&timer1, &test_timers_ordered_correctly_timer_func, &args1); ets_timer_setfn(&timer2, &test_timers_ordered_correctly_timer_func, &args2); ets_timer_setfn(&timer3, &test_timers_ordered_correctly_timer_func, &args3); ets_timer_arm(&timer1, args1.intervals[0], false); ets_timer_arm(&timer2, args2.intervals[0], false); ets_timer_arm(&timer3, args3.intervals[0], false); for (int i = 0; i < 3; ++i) { int result = xSemaphoreTake(done, 180 / portTICK_PERIOD_MS); TEST_ASSERT_TRUE(result == pdPASS); } TEST_ASSERT_TRUE(args1.pass); TEST_ASSERT_TRUE(args2.pass); TEST_ASSERT_TRUE(args3.pass); ets_timer_done(&timer1); ets_timer_done(&timer2); ets_timer_done(&timer3); } #undef N static void IRAM_ATTR test_iram_timer_func(void* arg) { volatile bool *b = (volatile bool *)arg; *b = true; } /* WiFi/BT coexistence will sometimes arm/disarm timers from an ISR where flash may be disabled. */ IRAM_ATTR TEST_CASE("ETSTimers arm & disarm run from IRAM", "[ets_timer]") { volatile bool flag = false; ETSTimer timer1; const int INTERVAL = 5; ets_timer_setfn(&timer1, &test_iram_timer_func, (void *)&flag); /* arm a disabled timer, then disarm a live timer */ spi_flash_guard_get()->start(); // Disables flash cache ets_timer_arm(&timer1, INTERVAL, false); // redundant call is deliberate (test code path if already armed) ets_timer_arm(&timer1, INTERVAL, false); ets_timer_disarm(&timer1); spi_flash_guard_get()->end(); // Re-enables flash cache TEST_ASSERT_FALSE(flag); // didn't expire yet /* do the same thing but wait for the timer to expire */ spi_flash_guard_get()->start(); ets_timer_arm(&timer1, INTERVAL, false); spi_flash_guard_get()->end(); vTaskDelay(2 * INTERVAL / portTICK_PERIOD_MS); TEST_ASSERT_TRUE(flag); spi_flash_guard_get()->start(); ets_timer_disarm(&timer1); spi_flash_guard_get()->end(); ets_timer_done(&timer1); }