task.h File Reference

#include "FreeRTOS.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
class	StaticTask_t

Macros
#define	__VSF_FREERTOS_TASK_THREAD_CB_FIELD   vsf_thread_cb_t thread_cb;
#define	__VSF_FREERTOS_TASK_NOTIFY_FIELDS
#define	taskYIELD()   vTaskYield()

Typedefs
typedef StaticTask_t *	TaskHandle_t
typedef void(*	TaskFunction_t) (void *)

Enumerations
enum	eNotifyAction {   eNoAction = 0 ,   eSetBits ,   eIncrement ,   eSetValueWithOverwrite ,   eSetValueWithoutOverwrite }

Functions
void	vTaskDelay (const TickType_t xTicksToDelay)
void	vTaskDelayUntil (TickType_t *const pxPreviousWakeTime, const TickType_t xTimeIncrement)
TickType_t	xTaskGetTickCount (void)
TickType_t	xTaskGetTickCountFromISR (void)
void	vTaskYield (void)
BaseType_t	xTaskCreate (TaskFunction_t pxTaskCode, const char *const pcName, const uint32_t usStackDepth, void *const pvParameters, UBaseType_t uxPriority, TaskHandle_t *const pxCreatedTask)
void	vTaskDelete (TaskHandle_t xTaskToDelete)
TaskHandle_t	xTaskCreateStatic (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)
TaskHandle_t	xTaskGetCurrentTaskHandle (void)
void	vTaskSuspendAll (void)
BaseType_t	xTaskResumeAll (void)
void	vTaskEnterCritical (void)
void	vTaskExitCritical (void)
UBaseType_t	vTaskEnterCriticalFromISR (void)
void	vTaskExitCriticalFromISR (UBaseType_t uxSavedInterruptState)
BaseType_t	xTaskNotify (TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction)
BaseType_t	xTaskNotifyFromISR (TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xTaskNotifyGive (TaskHandle_t xTaskToNotify)
void	vTaskNotifyGiveFromISR (TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken)
uint32_t	ulTaskNotifyTake (BaseType_t xClearCountOnExit, TickType_t xTicksToWait)
BaseType_t	xTaskNotifyWait (uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait)

Macro Definition Documentation

__VSF_FREERTOS_TASK_THREAD_CB_FIELD

#define __VSF_FREERTOS_TASK_THREAD_CB_FIELD   vsf_thread_cb_t thread_cb;

__VSF_FREERTOS_TASK_NOTIFY_FIELDS

#define __VSF_FREERTOS_TASK_NOTIFY_FIELDS

Value:

        vsf_sem_t           notify_sem;                                        \
        uint32_t            notify_value;                                      \
        bool                notify_pending;

taskYIELD

#define taskYIELD

(

)

vTaskYield()

Typedef Documentation

TaskHandle_t

typedef StaticTask_t* TaskHandle_t

TaskFunction_t

typedef void(* TaskFunction_t) (void *)

Enumeration Type Documentation

eNotifyAction

enum eNotifyAction

Enumerator
eNoAction
eSetBits
eIncrement
eSetValueWithOverwrite
eSetValueWithoutOverwrite

Function Documentation

vTaskDelay()

void vTaskDelay ( const TickType_t  xTicksToDelay )

extern

vTaskDelayUntil()

void vTaskDelayUntil ( TickType_t *const  pxPreviousWakeTime, const TickType_t  xTimeIncrement  )

extern

xTaskGetTickCount()

TickType_t xTaskGetTickCount ( void  )

extern

xTaskGetTickCountFromISR()

TickType_t xTaskGetTickCountFromISR ( void  )

extern

vTaskYield()

void vTaskYield ( void  )

extern

xTaskCreate()

BaseType_t xTaskCreate ( TaskFunction_t  pxTaskCode, const char *const  pcName, const uint32_t  usStackDepth, void *const  pvParameters, UBaseType_t  uxPriority, TaskHandle_t *const  pxCreatedTask  )

extern

vTaskDelete()

void vTaskDelete ( TaskHandle_t  xTaskToDelete )

extern

xTaskCreateStatic()

TaskHandle_t xTaskCreateStatic ( 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  )

extern

xTaskGetCurrentTaskHandle()

TaskHandle_t xTaskGetCurrentTaskHandle ( void  )

extern

vTaskSuspendAll()

void vTaskSuspendAll ( void  )

extern

xTaskResumeAll()

BaseType_t xTaskResumeAll ( void  )

extern

vTaskEnterCritical()

void vTaskEnterCritical ( void  )

extern

vTaskExitCritical()

void vTaskExitCritical ( void  )

extern

vTaskEnterCriticalFromISR()

UBaseType_t vTaskEnterCriticalFromISR ( void  )

extern

vTaskExitCriticalFromISR()

void vTaskExitCriticalFromISR ( UBaseType_t  uxSavedInterruptState )

extern

xTaskNotify()

BaseType_t xTaskNotify ( TaskHandle_t  xTaskToNotify, uint32_t  ulValue, eNotifyAction  eAction  )

extern

xTaskNotifyFromISR()

BaseType_t xTaskNotifyFromISR ( TaskHandle_t  xTaskToNotify, uint32_t  ulValue, eNotifyAction  eAction, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

xTaskNotifyGive()

BaseType_t xTaskNotifyGive ( TaskHandle_t  xTaskToNotify )

extern

vTaskNotifyGiveFromISR()

void vTaskNotifyGiveFromISR ( TaskHandle_t  xTaskToNotify, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

ulTaskNotifyTake()

uint32_t ulTaskNotifyTake ( BaseType_t  xClearCountOnExit, TickType_t  xTicksToWait  )

extern

xTaskNotifyWait()

BaseType_t xTaskNotifyWait ( uint32_t  ulBitsToClearOnEntry, uint32_t  ulBitsToClearOnExit, uint32_t *  pulNotificationValue, TickType_t  xTicksToWait  )

extern