Symbols

loading...

Files

loading...

Summary Syntax Arguments Examples References Call Tree Data Use Lifecycle

SourceVuESP-IDF Framework and ExamplesFreeRTOSxTaskCreatePinnedToCoreWithCaps()

xTaskCreatePinnedToCoreWithCaps() function

Creates a pinned task where its stack has specific memory capabilities This function is similar to xTaskCreatePinnedToCore(), except that it allows the memory allocated for the task's stack to have specific capabilities (e.g., MALLOC_CAP_SPIRAM). However, the specified capabilities will NOT apply to the task's TCB as a TCB must always be in internal RAM.

Syntax

Show:

Summary

Declaration

Definition

from idf_additions.h:284

BaseType_t xTaskCreatePinnedToCoreWithCaps( TaskFunction_t pvTaskCode, const char * const pcName, const configSTACK_DEPTH_TYPE usStackDepth, void * const pvParameters, UBaseType_t uxPriority, TaskHandle_t * const pvCreatedTask, const BaseType_t xCoreID, UBaseType_t uxMemoryCaps );

Implemented in idf_additions.c:31

Arguments

Argument

Declared as

Description

pvTaskCode

Pointer to the task entry function

pcName

const char * const

A descriptive name for the task

usStackDepth

const configSTACK_DEPTH_TYPE

The size of the task stack specified as the number of bytes

pvParameters

void * const

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

uxPriority

The priority at which the task should run.

pvCreatedTask

TaskHandle_t * const

Used to pass back a handle by which the created task can be referenced.

xCoreID

const BaseType_t

Core to which the task is pinned to, or tskNO_AFFINITY if unpinned.

uxMemoryCaps

Memory capabilities of the task stack's memory (see esp_heap_caps.h)

Return value

pdPASS if the task was successfully created and added to a ready list, otherwise an error code defined in the file projdefs.h

Examples

xTaskCreatePinnedToCoreWithCaps() is referenced by 1 libraries and example projects:

References

from 0/1 examples

Code

Location

Referrer

BaseType_t xTaskCreatePinnedToCoreWithCaps( TaskFunction_t pvTaskCode,

idf_additions.c:31

BaseType_t xTaskCreatePinnedToCoreWithCaps( TaskFunction_t pvTaskCode,

idf_additions.h:284

return xTaskCreatePinnedToCoreWithCaps( pvTaskCode, pcName, usStackDepth, pvParameters, uxPriority, pvCreatedTask, tskNO_AFFINITY, uxMemoryCaps );

idf_additions.h:331

xTaskCreateWithCaps()

Call Tree

from 0/1 examples

xTaskCreatePinnedToCoreWithCaps() is called by 1 function and calls 5 functions:

xTaskCreateWithCaps()

xTaskCreatePinnedToCoreWithCaps()

heap_caps_malloc()

heap_caps_free()

xTaskCreateStaticPinnedToCore()

Data Use

from 0/1 examples

xTaskCreatePinnedToCoreWithCaps():

xTaskCreatePinnedToCoreWithCaps()

Class Tree

from 0/1 examples

All items filtered out

All items filtered out

Override Tree

from 0/1 examples

All items filtered out

All items filtered out

Implementations

from 0/1 examples

All items filtered out

All items filtered out

Instances

from 0/1 examples

Lifecycle

from 0/1 examples

xTaskCreatePinnedToCoreWithCaps() allocates 1 types and frees 1 types:

xTaskCreatePinnedToCoreWithCaps()