Table of Contents
Advertisement
Chapter 2. API Reference
TaskHookFunction_t xTaskGetApplicationTaskTagFromISR(TaskHandle_t
Returns the pxHookFunction value assigned to the task xTask. Can be called from an interrupt service routine.
void
vTaskSetThreadLocalStoragePointer(TaskHandle_t
Set local storage pointer specific to the given task.
Each
task
contains
figNUM_THREAD_LOCAL_STORAGE_POINTERS setting in FreeRTOSConfig.h.
not use the pointers itself, so the application writer can use the pointers for any purpose they wish.
Parameters
• xTaskToSet: Task to set thread local storage pointer for
• xIndex:
figNUM_THREAD_LOCAL_STORAGE_POINTERS - 1.
• pvValue: Pointer value to set.
void
*pvTaskGetThreadLocalStoragePointer(TaskHandle_t
Get local storage pointer specific to the given task.
Each
task
contains
figNUM_THREAD_LOCAL_STORAGE_POINTERS setting in FreeRTOSConfig.h.
not use the pointers itself, so the application writer can use the pointers for any purpose they wish.
Return Pointer value
Parameters
• xTaskToQuery: Task to get thread local storage pointer for
• xIndex:
figNUM_THREAD_LOCAL_STORAGE_POINTERS - 1.
void
vTaskSetThreadLocalStoragePointerAndDelCallback(TaskHandle_t
Set local storage pointer and deletion callback.
Each
task
contains
figNUM_THREAD_LOCAL_STORAGE_POINTERS setting in FreeRTOSConfig.h.
not use the pointers itself, so the application writer can use the pointers for any purpose they wish.
Local storage pointers set for a task can reference dynamically allocated resources. This function is similar to
vTaskSetThreadLocalStoragePointer, but provides a way to release these resources when the task gets deleted.
For each pointer, a callback function can be set. This function will be called when task is deleted, with the
local storage pointer index and value as arguments.
Parameters
• xTaskToSet: Task to set thread local storage pointer for
• xIndex:
figNUM_THREAD_LOCAL_STORAGE_POINTERS - 1.
• pvValue: Pointer value to set.
• pvDelCallback: Function to call to dispose of the local storage pointer when the task is deleted.
void vApplicationGetIdleTaskMemory(StaticTask_t
This function is used to provide a statically allocated block of memory to FreeRTOS to hold the Idle Task TCB.
This function is required when configSUPPORT_STATIC_ALLOCATION is set. For more information see
this URI:
https://www.FreeRTOS.org/a00110.html#configSUPPORT_STATIC_ALLOCATION
Parameters
• ppxIdleTaskTCBBuffer: A handle to a statically allocated TCB buffer
• ppxIdleTaskStackBuffer: A handle to a statically allocated Stack buffer for thie idle task
• pulIdleTaskStackSize: A pointer to the number of elements that will fit in the allocated
stack buffer
Espressif Systems
*pvValue)
an
array
of
pointers
The
index
of
the
dex)
an
array
of
pointers
The
index
of
the
an
array
of
pointers
The
index
of
the
Type_t
*pulIdleTaskStackSize)
868
Submit Document Feedback
xTask)
xTaskToSet, BaseType_t xIndex, void
that
is
dimensioned
pointer
to
set,
from
xTaskToQuery, BaseType_t xIn-
that
is
dimensioned
pointer
to
get,
from
BaseType_t
*pvValue,
TlsDeleteCallback-
Function_t
pvDelCallback)
that
is
dimensioned
pointer
to
set,
from
**ppxIdleTaskTCBBuffer,
**ppxIdleTaskStackBuffer,
by
the
con-
The kernel does
0
to
con-
by
the
con-
The kernel does
0
to
con-
xTaskToSet,
xIndex,
void
by
the
con-
The kernel does
0
to
con-
Stack-
uint32_t
Release v4.4
Advertisement
Table of Contents
Need help?
Do you have a question about the ESP32-S2 and is the answer not in the manual?