ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#define __ESP_FREERTOS_HOOKS_H__
#include <stdbool.h>
#include "freertos/portmacro.h"
#include "esp_err.h"
esp_freertos_idle_cb_t
esp_freertos_tick_cb_t
esp_register_freertos_idle_hook_for_cpu(esp_freertos_idle_cb_t, UBaseType_t);
esp_register_freertos_idle_hook(esp_freertos_idle_cb_t);
esp_register_freertos_tick_hook_for_cpu(esp_freertos_tick_cb_t, UBaseType_t);
esp_register_freertos_tick_hook(esp_freertos_tick_cb_t);
esp_deregister_freertos_idle_hook_for_cpu(esp_freertos_idle_cb_t, UBaseType_t);
esp_deregister_freertos_idle_hook(esp_freertos_idle_cb_t);
esp_deregister_freertos_tick_hook_for_cpu(esp_freertos_tick_cb_t, UBaseType_t);
esp_deregister_freertos_tick_hook(esp_freertos_tick_cb_t);
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/esp_system/include/esp_freertos_hooks.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * 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__
Details
Show:
from
Types: Columns: