/* * SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include #include #include #include "freertos/FreeRTOS.h" #include "esp_attr.h" #include "esp_freertos_hooks.h" #include "esp_cpu.h" #include "sdkconfig.h" #if CONFIG_PM_ENABLE #include "esp_pm.h" #include "esp_private/pm_impl.h" #endif //We use just a static array here because it's not expected many components will need //an idle or tick hook. #define MAX_HOOKS 8 static portMUX_TYPE hooks_spinlock = portMUX_INITIALIZER_UNLOCKED; static esp_freertos_idle_cb_t idle_cb[CONFIG_FREERTOS_NUMBER_OF_CORES][MAX_HOOKS] = {0}; static esp_freertos_tick_cb_t tick_cb[CONFIG_FREERTOS_NUMBER_OF_CORES][MAX_HOOKS] = {0}; void IRAM_ATTR esp_vApplicationTickHook(void) { int n; int core = xPortGetCoreID(); for (n = 0; n < MAX_HOOKS; n++) { if (tick_cb[core][n] != NULL) { tick_cb[core][n](); } } } void esp_vApplicationIdleHook(void) { bool can_go_idle = true; int core = xPortGetCoreID(); for (int n = 0; n < MAX_HOOKS; n++) { if (idle_cb[core][n] != NULL && !idle_cb[core][n]()) { can_go_idle = false; } } if (!can_go_idle) { return; } #ifdef CONFIG_PM_ENABLE esp_pm_impl_idle_hook(); esp_pm_impl_waiti(); #else esp_cpu_wait_for_intr(); #endif } esp_err_t esp_register_freertos_idle_hook_for_cpu(esp_freertos_idle_cb_t new_idle_cb, UBaseType_t cpuid) { if (cpuid >= CONFIG_FREERTOS_NUMBER_OF_CORES) { return ESP_ERR_INVALID_ARG; } portENTER_CRITICAL(&hooks_spinlock); for (int n = 0; n < MAX_HOOKS; n++) { if (idle_cb[cpuid][n] == NULL) { idle_cb[cpuid][n] = new_idle_cb; portEXIT_CRITICAL(&hooks_spinlock); return ESP_OK; } } portEXIT_CRITICAL(&hooks_spinlock); return ESP_ERR_NO_MEM; } esp_err_t esp_register_freertos_idle_hook(esp_freertos_idle_cb_t new_idle_cb) { return esp_register_freertos_idle_hook_for_cpu(new_idle_cb, xPortGetCoreID()); } esp_err_t esp_register_freertos_tick_hook_for_cpu(esp_freertos_tick_cb_t new_tick_cb, UBaseType_t cpuid) { if (cpuid >= CONFIG_FREERTOS_NUMBER_OF_CORES) { return ESP_ERR_INVALID_ARG; } portENTER_CRITICAL(&hooks_spinlock); for (int n = 0; n < MAX_HOOKS; n++) { if (tick_cb[cpuid][n] == NULL) { tick_cb[cpuid][n] = new_tick_cb; portEXIT_CRITICAL(&hooks_spinlock); return ESP_OK; } } portEXIT_CRITICAL(&hooks_spinlock); return ESP_ERR_NO_MEM; } esp_err_t esp_register_freertos_tick_hook(esp_freertos_tick_cb_t new_tick_cb) { return esp_register_freertos_tick_hook_for_cpu(new_tick_cb, xPortGetCoreID()); } void esp_deregister_freertos_idle_hook_for_cpu(esp_freertos_idle_cb_t old_idle_cb, UBaseType_t cpuid) { if (cpuid >= CONFIG_FREERTOS_NUMBER_OF_CORES) { return; } portENTER_CRITICAL(&hooks_spinlock); for (int n = 0; n < MAX_HOOKS; n++) { if (idle_cb[cpuid][n] == old_idle_cb) { idle_cb[cpuid][n] = NULL; } } portEXIT_CRITICAL(&hooks_spinlock); } void esp_deregister_freertos_idle_hook(esp_freertos_idle_cb_t old_idle_cb) { portENTER_CRITICAL(&hooks_spinlock); for (int m = 0; m < CONFIG_FREERTOS_NUMBER_OF_CORES; m++) { esp_deregister_freertos_idle_hook_for_cpu(old_idle_cb, m); } portEXIT_CRITICAL(&hooks_spinlock); } void esp_deregister_freertos_tick_hook_for_cpu(esp_freertos_tick_cb_t old_tick_cb, UBaseType_t cpuid) { if (cpuid >= CONFIG_FREERTOS_NUMBER_OF_CORES) { return; } portENTER_CRITICAL(&hooks_spinlock); for (int n = 0; n < MAX_HOOKS; n++) { if (tick_cb[cpuid][n] == old_tick_cb) { tick_cb[cpuid][n] = NULL; } } portEXIT_CRITICAL(&hooks_spinlock); } void esp_deregister_freertos_tick_hook(esp_freertos_tick_cb_t old_tick_cb) { portENTER_CRITICAL(&hooks_spinlock); for (int m = 0; m < CONFIG_FREERTOS_NUMBER_OF_CORES; m++) { esp_deregister_freertos_tick_hook_for_cpu(old_tick_cb, m); } portEXIT_CRITICAL(&hooks_spinlock); }