mirror of
https://github.com/espressif/esp-idf.git
synced 2025-11-04 14:14:11 +00:00
f50d83413e
Some files that should have their copyrights checked are still placed on the copyright ignore list. - These entries have been tidied up - Copyrights of those files have been updated.
126 lines
4.3 KiB
C
126 lines
4.3 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef __ESP_FREERTOS_HOOKS_H__
|
|
#define __ESP_FREERTOS_HOOKS_H__
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include "freertos/portmacro.h"
|
|
|
|
#include "esp_err.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
/*
|
|
Definitions for the tickhook and idlehook callbacks
|
|
*/
|
|
typedef bool (*esp_freertos_idle_cb_t)(void);
|
|
typedef void (*esp_freertos_tick_cb_t)(void);
|
|
|
|
/**
|
|
* @brief Register a callback to be called from the specified core's idle hook.
|
|
* The callback should return true if it should be called by the idle hook
|
|
* once per interrupt (or FreeRTOS tick), and return false if it should
|
|
* be called repeatedly as fast as possible by the idle hook.
|
|
*
|
|
* @warning Idle callbacks MUST NOT, UNDER ANY CIRCUMSTANCES, CALL
|
|
* A FUNCTION THAT MIGHT BLOCK.
|
|
*
|
|
* @param[in] new_idle_cb Callback to be called
|
|
* @param[in] cpuid id of the core
|
|
*
|
|
* @return
|
|
* - ESP_OK: Callback registered to the specified core's idle hook
|
|
* - ESP_ERR_NO_MEM: No more space on the specified core's idle hook to register callback
|
|
* - ESP_ERR_INVALID_ARG: cpuid is invalid
|
|
*/
|
|
esp_err_t esp_register_freertos_idle_hook_for_cpu(esp_freertos_idle_cb_t new_idle_cb, UBaseType_t cpuid);
|
|
|
|
/**
|
|
* @brief Register a callback to the idle hook of the core that calls this function.
|
|
* The callback should return true if it should be called by the idle hook
|
|
* once per interrupt (or FreeRTOS tick), and return false if it should
|
|
* be called repeatedly as fast as possible by the idle hook.
|
|
*
|
|
* @warning Idle callbacks MUST NOT, UNDER ANY CIRCUMSTANCES, CALL
|
|
* A FUNCTION THAT MIGHT BLOCK.
|
|
*
|
|
* @param[in] new_idle_cb Callback to be called
|
|
*
|
|
* @return
|
|
* - ESP_OK: Callback registered to the calling core's idle hook
|
|
* - ESP_ERR_NO_MEM: No more space on the calling core's idle hook to register callback
|
|
*/
|
|
esp_err_t esp_register_freertos_idle_hook(esp_freertos_idle_cb_t new_idle_cb);
|
|
|
|
/**
|
|
* @brief Register a callback to be called from the specified core's tick hook.
|
|
*
|
|
* @param[in] new_tick_cb Callback to be called
|
|
* @param[in] cpuid id of the core
|
|
*
|
|
* @return
|
|
* - ESP_OK: Callback registered to specified core's tick hook
|
|
* - ESP_ERR_NO_MEM: No more space on the specified core's tick hook to register the callback
|
|
* - ESP_ERR_INVALID_ARG: cpuid is invalid
|
|
*/
|
|
esp_err_t esp_register_freertos_tick_hook_for_cpu(esp_freertos_tick_cb_t new_tick_cb, UBaseType_t cpuid);
|
|
|
|
/**
|
|
* @brief Register a callback to be called from the calling core's tick hook.
|
|
*
|
|
* @param[in] new_tick_cb Callback to be called
|
|
*
|
|
* @return
|
|
* - ESP_OK: Callback registered to the calling core's tick hook
|
|
* - ESP_ERR_NO_MEM: No more space on the calling core's tick hook to register the callback
|
|
*/
|
|
esp_err_t esp_register_freertos_tick_hook(esp_freertos_tick_cb_t new_tick_cb);
|
|
|
|
/**
|
|
* @brief Unregister an idle callback from the idle hook of the specified core
|
|
*
|
|
* @param[in] old_idle_cb Callback to be unregistered
|
|
* @param[in] cpuid id of the core
|
|
*/
|
|
void esp_deregister_freertos_idle_hook_for_cpu(esp_freertos_idle_cb_t old_idle_cb, UBaseType_t cpuid);
|
|
|
|
/**
|
|
* @brief Unregister an idle callback. If the idle callback is registered to
|
|
* the idle hooks of both cores, the idle hook will be unregistered from
|
|
* both cores
|
|
*
|
|
* @param[in] old_idle_cb Callback to be unregistered
|
|
*/
|
|
void esp_deregister_freertos_idle_hook(esp_freertos_idle_cb_t old_idle_cb);
|
|
|
|
/**
|
|
* @brief Unregister a tick callback from the tick hook of the specified core
|
|
*
|
|
* @param[in] old_tick_cb Callback to be unregistered
|
|
* @param[in] cpuid id of the core
|
|
*/
|
|
void esp_deregister_freertos_tick_hook_for_cpu(esp_freertos_tick_cb_t old_tick_cb, UBaseType_t cpuid);
|
|
|
|
/**
|
|
* @brief Unregister a tick callback. If the tick callback is registered to the
|
|
* tick hooks of both cores, the tick hook will be unregistered from
|
|
* both cores
|
|
*
|
|
* @param[in] old_tick_cb Callback to be unregistered
|
|
*/
|
|
void esp_deregister_freertos_tick_hook(esp_freertos_tick_cb_t old_tick_cb);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // __ESP_FREERTOS_HOOKS_H__
|