xTaskCreateStaticPinnedToCore() function

Create a new static task that is pinned to a particular core This function is similar to xTaskCreateStatic(), but allows the creation of a pinned task. The task's pinned core is specified by the xCoreID argument. If xCoreID is set to tskNO_AFFINITY, then the task is unpinned and can run on any core.

Syntax

Show:

Summary

Declaration

Definition

from idf_additions.h:101

TaskHandle_t xTaskCreateStaticPinnedToCore( TaskFunction_t pxTaskCode, const char * const pcName, const uint32_t ulStackDepth, void * const pvParameters, UBaseType_t uxPriority, StackType_t * const puxStackBuffer, StaticTask_t * const pxTaskBuffer, const BaseType_t xCoreID );

Implemented in freertos_tasks_c_additions.h:288

Arguments

Argument

Description

pxTaskCode

Pointer to the task entry function.

pcName

A descriptive name for the task.

ulStackDepth

The size of the task stack specified as the NUMBER OF BYTES. Note that this differs from vanilla FreeRTOS.

pvParameters

Pointer that will be used as the parameter for the task being created.

uxPriority

The priority at which the task should run.

pxStackBuffer

pxTaskBuffer

Must point to a variable of type StaticTask_t, which will then be used to hold the task's data structures,

xCoreID

The core to which the task is pinned to, or tskNO_AFFINITY if the task has no core affinity.

Return value

The task handle if the task was created, NULL otherwise.

Notes

If ( configNUMBER_OF_CORES == 1 ), setting xCoreID to tskNO_AFFINITY will be be treated as 0.

Examples

xTaskCreateStaticPinnedToCore() is referenced by 6 libraries and example projects:

References

from examples

xTaskCreateStaticPinnedToCore() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle