#include <stdlib.h>
#include <string.h>
#include "FreeRTOS.h"
#include "task.h"
#include "timers.h"
#include "stack_macros.h"

Include dependency graph for tasks.c:

Go to the source code of this file.

Classes
struct	tskTaskControlBlock

Macros
#define	MPU_WRAPPERS_INCLUDED_FROM_API_FILE
#define	taskYIELD_IF_USING_PREEMPTION()
#define	taskNOT_WAITING_NOTIFICATION ( ( uint8_t ) 0 ) /* Must be zero as it is the initialised value. */
#define	taskWAITING_NOTIFICATION ( ( uint8_t ) 1 )
#define	taskNOTIFICATION_RECEIVED ( ( uint8_t ) 2 )
#define	tskSTACK_FILL_BYTE ( 0xa5U )
#define	tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 0 )
#define	tskSTATICALLY_ALLOCATED_STACK_ONLY ( ( uint8_t ) 1 )
#define	tskSTATICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 2 )
#define	tskSET_NEW_STACKS_TO_KNOWN_VALUE 0
#define	tskRUNNING_CHAR ( 'X' )
#define	tskBLOCKED_CHAR ( 'B' )
#define	tskREADY_CHAR ( 'R' )
#define	tskDELETED_CHAR ( 'D' )
#define	tskSUSPENDED_CHAR ( 'S' )
#define	configIDLE_TASK_NAME "IDLE"
#define	taskRECORD_READY_PRIORITY(uxPriority)
#define	taskSELECT_HIGHEST_PRIORITY_TASK()
#define	taskRESET_READY_PRIORITY(uxPriority)
#define	portRESET_READY_PRIORITY(uxPriority, uxTopReadyPriority)
#define	taskSWITCH_DELAYED_LISTS()
#define	prvAddTaskToReadyList(pxTCB)
#define	prvGetTCBFromHandle(pxHandle)
#define	taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000U

Typedefs
typedef struct tskTaskControlBlock	tskTCB
typedef tskTCB	TCB_t

Functions
static void	prvInitialiseTaskLists (static void prvCheckTasksWaitingTermination void)
	Utility task that simply returns pdTRUE if the task referenced by xTask is currently in the Suspended state, or pdFALSE if the task referenced by xTask is in any other state.
static void	prvAddNewTaskToReadyList (TCB_t *pxNewTCB)
void	vTaskStartScheduler (void)
void	vTaskEndScheduler (void)
void	vTaskSuspendAll (void)
BaseType_t	xTaskResumeAll (void)
TickType_t	xTaskGetTickCount (void)
TickType_t	xTaskGetTickCountFromISR (void)
UBaseType_t	uxTaskGetNumberOfTasks (void)
char *	pcTaskGetName (TaskHandle_t xTaskToQuery)
BaseType_t	xTaskCatchUpTicks (TickType_t xTicksToCatchUp)
BaseType_t	xTaskIncrementTick (void)
void	vTaskSwitchContext (void)
void	vTaskPlaceOnEventList (List_t *const pxEventList, const TickType_t xTicksToWait)
void	vTaskPlaceOnUnorderedEventList (List_t *pxEventList, const TickType_t xItemValue, const TickType_t xTicksToWait)
BaseType_t	xTaskRemoveFromEventList (const List_t *const pxEventList)
void	vTaskRemoveFromUnorderedEventList (ListItem_t *pxEventListItem, const TickType_t xItemValue)
void	vTaskSetTimeOutState (TimeOut_t *const pxTimeOut)
void	vTaskInternalSetTimeOutState (TimeOut_t *const pxTimeOut)
BaseType_t	xTaskCheckForTimeOut (TimeOut_t const pxTimeOut, TickType_t const pxTicksToWait)
void	vTaskMissedYield (void)
static	portTASK_FUNCTION (prvIdleTask, pvParameters)
static void	prvInitialiseTaskLists (void)
static void	prvCheckTasksWaitingTermination (void)
static void	prvResetNextTaskUnblockTime (void)
TickType_t	uxTaskResetEventItemValue (void)
static void	prvAddCurrentTaskToDelayedList (TickType_t xTicksToWait, const BaseType_t xCanBlockIndefinitely)

Variables
portDONT_DISCARD PRIVILEGED_DATA TCB_t *volatile	pxCurrentTCB = NULL
static PRIVILEGED_DATA List_t	pxReadyTasksLists [configMAX_PRIORITIES]
	Prioritised ready tasks.
static PRIVILEGED_DATA List_t	xDelayedTaskList1
	Delayed tasks.
static PRIVILEGED_DATA List_t	xDelayedTaskList2
	Delayed tasks (two lists are used - one for delays that have overflowed the current tick count.
static PRIVILEGED_DATA List_t *volatile	pxDelayedTaskList
	Points to the delayed task list currently being used.
static PRIVILEGED_DATA List_t *volatile	pxOverflowDelayedTaskList
	Points to the delayed task list currently being used to hold tasks that have overflowed the current tick count.
static PRIVILEGED_DATA List_t	xPendingReadyList
	Tasks that have been readied while the scheduler was suspended.
static PRIVILEGED_DATA volatile UBaseType_t	uxCurrentNumberOfTasks = ( UBaseType_t ) 0U
static PRIVILEGED_DATA volatile TickType_t	xTickCount = ( TickType_t ) configINITIAL_TICK_COUNT
static PRIVILEGED_DATA volatile UBaseType_t	uxTopReadyPriority = tskIDLE_PRIORITY
static PRIVILEGED_DATA volatile BaseType_t	xSchedulerRunning = pdFALSE
static PRIVILEGED_DATA volatile TickType_t	xPendedTicks = ( TickType_t ) 0U
static PRIVILEGED_DATA volatile BaseType_t	xYieldPending = pdFALSE
static PRIVILEGED_DATA volatile BaseType_t	xNumOfOverflows = ( BaseType_t ) 0
static PRIVILEGED_DATA UBaseType_t	uxTaskNumber = ( UBaseType_t ) 0U
static PRIVILEGED_DATA volatile TickType_t	xNextTaskUnblockTime = ( TickType_t ) 0U
static PRIVILEGED_DATA TaskHandle_t	xIdleTaskHandle = NULL
	Holds the handle of the idle task.
const volatile UBaseType_t	uxTopUsedPriority = configMAX_PRIORITIES - 1U
static PRIVILEGED_DATA volatile UBaseType_t	uxSchedulerSuspended = ( UBaseType_t ) 0U

Macro Definition Documentation

◆ configIDLE_TASK_NAME

#define configIDLE_TASK_NAME "IDLE"

Definition at line 115 of file tasks.c.

Referenced by vTaskStartScheduler().

◆ MPU_WRAPPERS_INCLUDED_FROM_API_FILE

#define MPU_WRAPPERS_INCLUDED_FROM_API_FILE

Definition at line 36 of file tasks.c.

◆ portRESET_READY_PRIORITY

#define portRESET_READY_PRIORITY	(		uxPriority,
			uxTopReadyPriority )

Definition at line 158 of file tasks.c.

Referenced by prvAddCurrentTaskToDelayedList().

◆ prvAddTaskToReadyList

#define prvAddTaskToReadyList ( pxTCB )

Value:

    do {                                                                                                   \
        traceMOVED_TASK_TO_READY_STATE( pxTCB );                                                           \
        taskRECORD_READY_PRIORITY( ( pxTCB )->uxPriority );                                                \
        listINSERT_END( &( pxReadyTasksLists[ ( pxTCB )->uxPriority ] ), &( ( pxTCB )->xStateListItem ) ); \
        tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB );                                                      \
    } while( 0 )

Definition at line 220 of file tasks.c.

Referenced by prvAddNewTaskToReadyList(), vTaskRemoveFromUnorderedEventList(), xTaskIncrementTick(), xTaskRemoveFromEventList(), and xTaskResumeAll().

◆ prvGetTCBFromHandle

#define prvGetTCBFromHandle ( pxHandle )

Value:

( ( ( pxHandle ) == NULL ) ? pxCurrentTCB : ( pxHandle ) )

NULL

#define NULL

Definition usbd_def.h:44

pxCurrentTCB

portDONT_DISCARD PRIVILEGED_DATA TCB_t *volatile pxCurrentTCB

Definition tasks.c:332

Definition at line 235 of file tasks.c.

Referenced by pcTaskGetName().

◆ taskEVENT_LIST_ITEM_VALUE_IN_USE

#define taskEVENT_LIST_ITEM_VALUE_IN_USE 0x8000U

Definition at line 246 of file tasks.c.

Referenced by vTaskPlaceOnUnorderedEventList(), and vTaskRemoveFromUnorderedEventList().

◆ taskNOT_WAITING_NOTIFICATION

#define taskNOT_WAITING_NOTIFICATION ( ( uint8_t ) 0 ) /* Must be zero as it is the initialised value. */

Definition at line 71 of file tasks.c.

◆ taskNOTIFICATION_RECEIVED

#define taskNOTIFICATION_RECEIVED ( ( uint8_t ) 2 )

Definition at line 73 of file tasks.c.

◆ taskRECORD_READY_PRIORITY

#define taskRECORD_READY_PRIORITY ( uxPriority )

Value:

    do {                                            \
        if( ( uxPriority ) > uxTopReadyPriority )   \
        {                                           \
            uxTopReadyPriority = ( uxPriority );    \
        }                                           \
    } while( 0 ) /* taskRECORD_READY_PRIORITY */

Definition at line 126 of file tasks.c.

◆ taskRESET_READY_PRIORITY

#define taskRESET_READY_PRIORITY ( uxPriority )

Definition at line 157 of file tasks.c.

◆ taskSELECT_HIGHEST_PRIORITY_TASK

#define taskSELECT_HIGHEST_PRIORITY_TASK ( )

Value:

    do {                                                                      \
        UBaseType_t uxTopPriority = uxTopReadyPriority;                       \
                                                                              \
        /* Find the highest priority queue that contains ready tasks. */      \
        while( listLIST_IS_EMPTY( &( pxReadyTasksLists[ uxTopPriority ] ) ) ) \
        {                                                                     \
            configASSERT( uxTopPriority );                                    \
            --uxTopPriority;                                                  \
        }                                                                     \
                                                                              \
        /* listGET_OWNER_OF_NEXT_ENTRY indexes through the list, so the tasks of \
         * the  same priority get an equal share of the processor time. */                    \
        listGET_OWNER_OF_NEXT_ENTRY( pxCurrentTCB, &( pxReadyTasksLists[ uxTopPriority ] ) ); \
        uxTopReadyPriority = uxTopPriority;                                                   \
    } while( 0 ) /* taskSELECT_HIGHEST_PRIORITY_TASK */

Definition at line 136 of file tasks.c.

Referenced by vTaskSwitchContext().

◆ taskSWITCH_DELAYED_LISTS

#define taskSWITCH_DELAYED_LISTS ( )

Value:

    do {                                                                          \
        List_t * pxTemp;                                                          \
                                                                                  \
        /* The delayed tasks list should be empty when the lists are switched. */ \
        configASSERT( ( listLIST_IS_EMPTY( pxDelayedTaskList ) ) );               \
                                                                                  \
        pxTemp = pxDelayedTaskList;                                               \
        pxDelayedTaskList = pxOverflowDelayedTaskList;                            \
        pxOverflowDelayedTaskList = pxTemp;                                       \
        xNumOfOverflows++;                                                        \
        prvResetNextTaskUnblockTime();                                            \
    } while( 0 )

Definition at line 200 of file tasks.c.

Referenced by xTaskIncrementTick().

◆ taskWAITING_NOTIFICATION

#define taskWAITING_NOTIFICATION ( ( uint8_t ) 1 )

Definition at line 72 of file tasks.c.

◆ taskYIELD_IF_USING_PREEMPTION

#define taskYIELD_IF_USING_PREEMPTION ( )

Definition at line 65 of file tasks.c.

Referenced by prvAddNewTaskToReadyList(), and xTaskResumeAll().

◆ tskBLOCKED_CHAR

#define tskBLOCKED_CHAR ( 'B' )

Definition at line 99 of file tasks.c.

◆ tskDELETED_CHAR

#define tskDELETED_CHAR ( 'D' )

Definition at line 101 of file tasks.c.

◆ tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB

#define tskDYNAMICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 0 )

Definition at line 82 of file tasks.c.

◆ tskREADY_CHAR

#define tskREADY_CHAR ( 'R' )

Definition at line 100 of file tasks.c.

◆ tskRUNNING_CHAR

#define tskRUNNING_CHAR ( 'X' )

Definition at line 98 of file tasks.c.

◆ tskSET_NEW_STACKS_TO_KNOWN_VALUE

#define tskSET_NEW_STACKS_TO_KNOWN_VALUE 0

Definition at line 92 of file tasks.c.

◆ tskSTACK_FILL_BYTE

#define tskSTACK_FILL_BYTE ( 0xa5U )

Definition at line 79 of file tasks.c.

◆ tskSTATICALLY_ALLOCATED_STACK_AND_TCB

#define tskSTATICALLY_ALLOCATED_STACK_AND_TCB ( ( uint8_t ) 2 )

Definition at line 84 of file tasks.c.

Referenced by prvInitialiseTaskLists().

◆ tskSTATICALLY_ALLOCATED_STACK_ONLY

#define tskSTATICALLY_ALLOCATED_STACK_ONLY ( ( uint8_t ) 1 )

Definition at line 83 of file tasks.c.

◆ tskSUSPENDED_CHAR

#define tskSUSPENDED_CHAR ( 'S' )

Definition at line 102 of file tasks.c.

Typedef Documentation

◆ TCB_t

typedef tskTCB TCB_t

Definition at line 328 of file tasks.c.

◆ tskTCB

typedef struct tskTaskControlBlock tskTCB

Function Documentation

◆ pcTaskGetName()

char * pcTaskGetName ( TaskHandle_t xTaskToQuery )

Definition at line 2353 of file tasks.c.

References configASSERT, tskTaskControlBlock::pcTaskName, and prvGetTCBFromHandle.

Referenced by osThreadGetName().

◆ portTASK_FUNCTION()

portTASK_FUNCTION	(	prvIdleTask	,
		pvParameters	)

static

THIS IS THE RTOS IDLE TASK - WHICH IS CREATED AUTOMATICALLY WHEN THE SCHEDULER IS STARTED.

Definition at line 3488 of file tasks.c.

References configASSERT, configEXPECTED_IDLE_TIME_BEFORE_SLEEP, configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING, listCURRENT_LIST_LENGTH, mtCOVERAGE_TEST_MARKER, portALLOCATE_SECURE_CONTEXT, portSUPPRESS_TICKS_AND_SLEEP, prvCheckTasksWaitingTermination(), pxReadyTasksLists, taskYIELD, traceLOW_POWER_IDLE_BEGIN, traceLOW_POWER_IDLE_END, tskIDLE_PRIORITY, vApplicationIdleHook(), vTaskSuspendAll(), xNextTaskUnblockTime, xTaskResumeAll(), and xTickCount.

◆ prvAddCurrentTaskToDelayedList()

void prvAddCurrentTaskToDelayedList	(	TickType_t	xTicksToWait,
		const BaseType_t	xCanBlockIndefinitely )

static

Definition at line 5386 of file tasks.c.

References listINSERT_END, listSET_LIST_ITEM_VALUE, mtCOVERAGE_TEST_MARKER, pdFALSE, portMAX_DELAY, portRESET_READY_PRIORITY, pxCurrentTCB, pxDelayedTaskList, pxOverflowDelayedTaskList, uxListRemove(), uxTopReadyPriority, vListInsert(), xNextTaskUnblockTime, and xTickCount.

Referenced by vTaskPlaceOnEventList(), and vTaskPlaceOnUnorderedEventList().

◆ prvAddNewTaskToReadyList()

void prvAddNewTaskToReadyList ( TCB_t * pxNewTCB )

static

Definition at line 1029 of file tasks.c.

References mtCOVERAGE_TEST_MARKER, NULL, pdFALSE, portSETUP_TCB, prvAddTaskToReadyList, prvInitialiseTaskLists(), pxCurrentTCB, taskENTER_CRITICAL, taskEXIT_CRITICAL, taskYIELD_IF_USING_PREEMPTION, traceTASK_CREATE, uxCurrentNumberOfTasks, tskTaskControlBlock::uxPriority, uxTaskNumber, and xSchedulerRunning.

Referenced by prvInitialiseTaskLists().

◆ prvCheckTasksWaitingTermination()

void prvCheckTasksWaitingTermination ( void )

static

THIS FUNCTION IS CALLED FROM THE RTOS IDLE TASK

Definition at line 3744 of file tasks.c.

References listGET_OWNER_OF_HEAD_ENTRY, taskENTER_CRITICAL, taskEXIT_CRITICAL, uxCurrentNumberOfTasks, uxListRemove(), and tskTaskControlBlock::xStateListItem.

Referenced by portTASK_FUNCTION().

◆ prvInitialiseTaskLists() [1/2]

void prvInitialiseTaskLists ( static void prvCheckTasksWaitingTermination void )

static

Utility task that simply returns pdTRUE if the task referenced by xTask is currently in the Suspended state, or pdFALSE if the task referenced by xTask is in any other state.

Definition at line 421 of file tasks.c.

References configASSERT, configSTACK_DEPTH_TYPE, NULL, PRIVILEGED_FUNCTION, prvAddNewTaskToReadyList(), and tskSTATICALLY_ALLOCATED_STACK_AND_TCB.