FreeRTOS
Select one of the symbols to view example projects that use it.
 
Outline
#include "sdkconfig.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
-------------------------------------------------- Task Snapshot
xTASK_SNAPSHOT
TaskIterator
xTaskGetNext(TaskIterator_t *);
vTaskGetSnapshot(TaskHandle_t, TaskSnapshot_t *);
uxTaskGetSnapshotAll(TaskSnapshot_t *const, const UBaseType_t, UBaseType_t *const);
pvTaskGetCurrentTCBForCore(BaseType_t);
Files
loading...
SourceVuESP-IDF Framework and ExamplesFreeRTOSesp_additions/include/esp_private/freertos_debug.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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #pragma once #include "sdkconfig.h" #include "freertos/FreeRTOS.h" #include "freertos/task.h" /* * This header contains private API used by various ESP-IDF debugging features (e.g., esp_gdbstub). *//* ... */ /* *INDENT-OFF* */ #ifdef __cplusplus extern "C" { #endif /* *INDENT-ON* */ /* -------------------------------------------------- Task Snapshot ------------------------------------------------- */ /** * @brief Task Snapshot structure * * - Used with the uxTaskGetSnapshotAll() function to save memory snapshot of each task in the system. * - We need this structure because TCB_t is defined (hidden) in tasks.c. *//* ... */ typedef struct xTASK_SNAPSHOT { void * pxTCB; /*!< Address of the task control block. */ StackType_t * pxTopOfStack; /*!< Points to the location of the last item placed on the tasks stack. */ StackType_t * pxEndOfStack; /*!< Points to the end of the stack. pxTopOfStack < pxEndOfStack, stack grows hi2lo * pxTopOfStack > pxEndOfStack, stack grows lo2hi*//* ... */ }{ ... } TaskSnapshot_t; /** * @brief Task Snapshot iterator * * Used in xTaskGetNext(). Must be zero/null initialized on the first call. *//* ... */ typedef struct TaskIterator { UBaseType_t uxCurrentListIndex; /**< Current task list index being traversed. */ ListItem_t * pxNextListItem; /**< Next task list item will being traversed. */ TaskHandle_t pxTaskHandle; /**< Current task handle being traversed. */ }{ ... } TaskIterator_t; /** * @brief Get the next task using the task iterator. * * This function retrieves the next task in the traversal sequence. * * @param xIterator Pointer to the task iterator structure. * * @return Index of the current task list. Returns -1 if all tasks have been traversed. * * @note The task iterator keeps track of the current state during task traversal, * including the index of the current task list and the pointer of the next task list item. * When all tasks have been traversed, this function returns -1. * If a broken or corrupted task is encountered, the task handle is set to NULL. * *//* ... */ int xTaskGetNext( TaskIterator_t * xIterator ); /** * @brief Fill a TaskSnapshot_t structure for specified task. * * - This function is used by the panic handler to get the snapshot of a particular task. * * @note This function should only be called when FreeRTOS is no longer running (e.g., during a panic) as this function * does not acquire any locks. * @param[in] pxTask Task's handle * @param[out] pxTaskSnapshot Snapshot of the task * @return pdTRUE if operation was successful else pdFALSE *//* ... */ BaseType_t vTaskGetSnapshot( TaskHandle_t pxTask, TaskSnapshot_t * pxTaskSnapshot ); /** * @brief Fill an array of TaskSnapshot_t structures for every task in the system * * - This function is used by the panic handler to get a snapshot of all tasks in the system * * @note This function should only be called when FreeRTOS is no longer running (e.g., during a panic) as this function * does not acquire any locks. * @param[out] pxTaskSnapshotArray Array of TaskSnapshot_t structures filled by this function * @param[in] uxArrayLength Length of the provided array * @param[out] pxTCBSize Size of the a task's TCB structure (can be set to NULL) * @return UBaseType_t *//* ... */ UBaseType_t uxTaskGetSnapshotAll( TaskSnapshot_t * const pxTaskSnapshotArray, const UBaseType_t uxArrayLength, UBaseType_t * const pxTCBSize ); -------------------------------------------------- Task Snapshot /* ----------------------------------------------------- Misc ----------------------------------------------------- */ /** * @brief Get a void pointer to the current TCB of a particular core * * @note This function provides no guarantee that the return TCB will still be the current task (or that the task still * exists) when it returns. It is the caller's responsibility to ensure that the task does not get scheduled or deleted. * @param xCoreID The core to query * @return Void pointer to current TCB *//* ... */ void * pvTaskGetCurrentTCBForCore( BaseType_t xCoreID ); /* *INDENT-OFF* */ #ifdef __cplusplus }{...} #endif /* *INDENT-ON* */
Details
Show:
from
Types: Columns: