Scribd
Upload
3 views

Task Function in FreeRTOS

The document describes the function xTaskCreate in FreeRTOS, which is used to create a task and allocate the required RAM from the FreeRTOS heap. It outlines the parameters needed for the function, including the task function pointer, task name, stack depth, parameters, priority, and an optional task handle. Additionally, it mentions the difference between dynamic and static task creation using xTaskCreateStatic, where RAM is allocated by the application writer.

Uploaded by

letrutia1433
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
3 views

Task Function in FreeRTOS

The document describes the function xTaskCreate in FreeRTOS, which is used to create a task and allocate the required RAM from the FreeRTOS heap. It outlines the parameters needed for the function, including the task function pointer, task name, stack depth, parameters, priority, and an optional task handle. Additionally, it mentions the difference between dynamic and static task creation using xTaskCreateStatic, where RAM is allocated by the application writer.

Uploaded by

letrutia1433
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 2

BaseType_t xTaskCreate(TaskFunction_t pvTaskCode,

const char * const pcName,


const configSTACK_DEPTH_TYPE
uxStackDepth,
void *pvParameters,
UBaseType_t uxPriority,
TaskHandle_t *pxCreatedTask
);

xTaskCreate() then the required RAM is automatically allocated from the FreeRTOS
heap. If a task is created using xTaskCreateStatic() then the RAM is provided by the
application writer, so it can be statically allocated at compile time. See the Static Vs Dynamic
allocation page for more information.

pvTaskCode Pointer to the task entry function (just the name of the function
that implements the task, see the example below).

Tasks are normally implemented as an infinite loop; the function


which implements the task must never attempt to return or exit.
Tasks can, however, delete themselves.
pcName A descriptive name for the task. This is mainly used to facilitate
debugging, but can also be used to obtain a task handle.

The maximum length of a task's name is defined


by configMAX_TASK_NAME_LEN in FreeRTOSConfig.h.
uxStackDepth The number of words (not bytes!) to allocate for use as the task's
stack. For example, if the stack is 16-bits wide and uxStackDepth
is 100, then 200 bytes will be allocated for use as the task's stack.
As another example, if the stack is 32-bits wide and uxStackDepth
is 400 then 1600 bytes will be allocated for use as the task's
stack.

The stack depth multiplied by the stack width must not exceed the
maximum value that can be contained in a variable of
type size_t.

See the FAQ How big should the stack be?


pvParameters A value that is passed as the paramater to the created task.

If pvParameters is set to the address of a variable then the


variable must still exist when the created task executes - so it is
not valid to pass the address of a stack variable.
uxPriority The priority at which the created task will execute.

Systems that include MPU support can optionally create a task in


a privileged (system) mode by setting the
bit portPRIVILEGE_BIT in uxPriority. For example, to create a
privileged task at priority 2 set uxPriority to ( 2
| portPRIVILEGE_BIT ).

Priorities are asserted to be less than configMAX_PRIORITIES.


If configASSERT is undefined, priorities are silently capped at
(configMAX_PRIORITIES - 1).
pxCreatedTask Used to pass a handle to the created task out of
the xTaskCreate() function. pxCreatedTask is optional and can be
set to NULL.

You might also like