目錄
xTaskGetApplicationTaskTagTagxTaskGetApplicationTaskTagFromISR
uxTaskGetStackHighWaterMarkuxTaskGetStackHighWaterMark2
vTaskSetThreadLocalStoragePointer
pvTaskGetThreadLocalStoragePointer
uxTaskGetSystemState（）
UBaseType_t uxTaskGetSystemState（
TaskStatus_t * const pxTaskStatusArray，
const UBaseType_t uxArraySize，
unsigned long * const pulTotalRunTime）;
必須在FreeRTOSConfig.h中將configUSE_TRACE_FACILITY定義爲1，才能使uxTaskGetSystemState（）可用。
uxTaskGetSystemState（）爲系統中的每個任務填充TaskStatus_t結構。TaskStatus_t結構除其他外包含任務句柄的成員，任務名稱，任務優先級，任務狀態以及任務消耗的運行時間總量。
有關爲單個任務而不是每個任務填充TaskStatus_t結構的版本，請參見vTaskGetInfo（）。
注意：此功能僅用於調試用途，因爲其使用會導致調度程序長時間處於掛起狀態。
參數：
| pxTaskStatusArray | 指向TaskStatus_t結構數組的指針。對於受RTOS控制的每個任務，該數組必須至少包含一個TaskStatus_t結構。可以使用uxTaskGetNumberOfTasks（） API函數來確定RTOS控制下的任務數。 |
| uxArraySize | pxTaskStatusArray參數指向的數組的大小。該大小指定爲數組中索引的數量（數組中包含的TaskStatus_t結構的數量），而不是數組中的字節數。 |
| pulTotalRunTime | 如果在FreeRTOSConfig.h中將configGENERATE_RUN_TIME_STATS設置爲1，則* pulTotalRunTime將由uxTaskGetSystemState（）設置爲自目標啓動以來的總運行時間（由運行時間統計時鐘定義）。可以將pulTotalRunTime設置爲NULL以忽略總運行時間值。 |
返回值：
uxTaskGetSystemState（）填充的TaskStatus_t結構的數量。該值應等於uxTaskGetNumberOfTasks（）API函數返回的數字，但如果uxArraySize參數中傳遞的值太小，則該數字將爲零。
用法示例：
/* This example demonstrates how a human readable table of run time stats
information is generated from raw data provided by uxTaskGetSystemState().
The human readable table is written to pcWriteBuffer. (see the vTaskList()
API function which actually does just this). */
void vTaskGetRunTimeStats( signed char *pcWriteBuffer )
{
TaskStatus_t *pxTaskStatusArray;
volatile UBaseType_t uxArraySize, x;
unsigned long ulTotalRunTime, ulStatsAsPercentage;
/* Make sure the write buffer does not contain a string. */
*pcWriteBuffer = 0x00;
/* Take a snapshot of the number of tasks in case it changes while this
function is executing. */
uxArraySize = uxTaskGetNumberOfTasks();
/* Allocate a TaskStatus_t structure for each task. An array could be
allocated statically at compile time. */
pxTaskStatusArray = pvPortMalloc( uxArraySize * sizeof( TaskStatus_t ) );
if( pxTaskStatusArray != NULL )
{
/* Generate raw status information about each task. */
uxArraySize = uxTaskGetSystemState( pxTaskStatusArray,
uxArraySize,
&ulTotalRunTime );
/* For percentage calculations. */
ulTotalRunTime /= 100UL;
/* Avoid divide by zero errors. */
if( ulTotalRunTime > 0 )
{
/* For each populated position in the pxTaskStatusArray array,
format the raw data as human readable ASCII data. */
for( x = 0; x < uxArraySize; x++ )
{
/* What percentage of the total run time has the task used?
This will always be rounded down to the nearest integer.
ulTotalRunTimeDiv100 has already been divided by 100. */
ulStatsAsPercentage =
pxTaskStatusArray[ x ].ulRunTimeCounter / ulTotalRunTime;
if( ulStatsAsPercentage > 0UL )
{
sprintf( pcWriteBuffer, "%stt%lutt%lu%%rn",
pxTaskStatusArray[ x ].pcTaskName,
pxTaskStatusArray[ x ].ulRunTimeCounter,
ulStatsAsPercentage );
}
else
{
/* If the percentage is zero here then the task has
consumed less than 1% of the total run time. */
sprintf( pcWriteBuffer, "%stt%lutt<1%%rn",
pxTaskStatusArray[ x ].pcTaskName,
pxTaskStatusArray[ x ].ulRunTimeCounter );
}
pcWriteBuffer += strlen( ( char * ) pcWriteBuffer );
}
}
/* The array is no longer needed, free the memory it consumes. */
vPortFree( pxTaskStatusArray );
}
}
The TaskStatus_t definition
typedef struct xTASK_STATUS
{
/* The handle of the task to which the rest of the information in the
structure relates. */
TaskHandle_t xHandle;
/* A pointer to the task's name. This value will be invalid if the task was
deleted since the structure was populated! */
const signed char *pcTaskName;
/* A number unique to the task. */
UBaseType_t xTaskNumber;
/* The state in which the task existed when the structure was populated. */
eTaskState eCurrentState;
/* The priority at which the task was running (may be inherited) when the
structure was populated. */
UBaseType_t uxCurrentPriority;
/* The priority to which the task will return if the task's current priority
has been inherited to avoid unbounded priority inversion when obtaining a
mutex. Only valid if configUSE_MUTEXES is defined as 1 in
FreeRTOSConfig.h. */
UBaseType_t uxBasePriority;
/* The total run time allocated to the task so far, as defined by the run
time stats clock. Only valid when configGENERATE_RUN_TIME_STATS is
defined as 1 in FreeRTOSConfig.h. */
unsigned long ulRunTimeCounter;
/* Points to the lowest address of the task's stack area. */
StackType_t *pxStackBase;
/* The minimum amount of stack space that has remained for the task since
the task was created. The closer this value is to zero the closer the task
has come to overflowing its stack. */
configSTACK_DEPTH_TYPE usStackHighWaterMark;
} TaskStatus_t;
vTaskGetInfo()
task.h
void vTaskGetInfo( TaskHandle_t xTask,
TaskStatus_t *pxTaskStatus,
BaseType_t xGetFreeStackSpace,
eTaskState eState );
必須在FreeRTOSConfig.h中將configUSE_TRACE_FACILITY定義爲1，vTaskGetInfo（）纔可用。
uxTaskGetSystemState（） 爲系統中的每個任務填充TaskStatus_t結構， 而vTaskGetInfo（）爲單個任務填充TaskStatus_t結構。TaskStatus_t結構除其他外包含任務句柄的成員，任務名稱，任務優先級，任務狀態以及任務消耗的運行時間總量。
注意：此功能僅用於調試用途，因爲其使用會導致調度程序長時間處於掛起狀態。
參數：
| 任務 | 正在查詢任務的句柄。將xTask設置爲NULL將返回有關調用任務的信息。 |
| pxTaskStatus | pxTaskStatus指向的TaskStatus_t結構將填充有關xTask參數中傳遞的句柄引用的任務的信息。 |
| xGetFreeStackSpace | TaskStatus_t結構包含一個成員，用於報告要查詢的任務的堆棧高水位線。堆棧高水位標記是已存在的最小堆棧空間量，因此數字越接近零，任務就越接近其堆棧溢出。計算堆棧高水位標記需要相對較長的時間，並且可以使系統暫時無響應–因此提供了xGetFreeStackSpace參數，以跳過高水位檢查。如果xGetFreeStackSpace未設置爲pdFALSE，則僅將高水印值寫入TaskStatus_t結構。 |
| 房地產 | TaskStatus_t結構包含一個成員，用於報告要查詢的任務的狀態。獲取任務狀態並不像簡單分配那樣快-因此提供eState參數可以從TaskStatus_t結構中省略狀態信息。要獲取狀態信息，然後將eState設置爲eInvalid-否則，在eState中傳遞的值將在TaskStatus_t結構中報告爲任務狀態。 |
用法示例：
void vAFunction( void )
{
TaskHandle_t xHandle;
TaskStatus_t xTaskDetails;
/* Obtain the handle of a task from its name. */
xHandle = xTaskGetHandle( "Task_Name" );
/* Check the handle is not NULL. */
configASSERT( xHandle );
/* Use the handle to obtain further information about the task. */
vTaskGetInfo( /* The handle of the task being queried. */
xHandle,
/* The TaskStatus_t structure to complete with information
on xTask. */
&xTaskDetails,
/* Include the stack high water mark value in the
TaskStatus_t structure. */
pdTRUE,
/* Include the task state in the TaskStatus_t structure. */
eInvalid );
}
typedef struct xTASK_STATUS
{
/* The handle of the task to which the rest of the information in the
structure relates. */
TaskHandle_t xHandle;
/* A pointer to the task's name. This value will be invalid if the task was
deleted since the structure was populated! */
const signed char *pcTaskName;
/* A number unique to the task. */
UBaseType_t xTaskNumber;
/* The state in which the task existed when the structure was populated. */
eTaskState eCurrentState;
/* The priority at which the task was running (may be inherited) when the
structure was populated. */
UBaseType_t uxCurrentPriority;
/* The priority to which the task will return if the task's current priority
has been inherited to avoid unbounded priority inversion when obtaining a
mutex. Only valid if configUSE_MUTEXES is defined as 1 in
FreeRTOSConfig.h. */
UBaseType_t uxBasePriority;
/* The total run time allocated to the task so far, as defined by the run
time stats clock. Only valid when configGENERATE_RUN_TIME_STATS is
defined as 1 in FreeRTOSConfig.h. */
unsigned long ulRunTimeCounter;
/* Points to the lowest address of the task's stack area. */
StackType_t *pxStackBase;
/* The minimum amount of stack space that has remained for the task since
the task was created. The closer this value is to zero the closer the task
has come to overflowing its stack. */
configSTACK_DEPTH_TYPE usStackHighWaterMark;
} TaskStatus_t;
xTaskGetApplicationTaskTagTag
xTaskGetApplicationTaskTagFromISR
爲了使這些功能可用，必須將configUSE_APPLICATION_TASK_TAG定義爲1。有關更多信息，請參見RTOS配置文檔。
xTaskGetApplicationTaskTagTagFromISR（）是xTaskGetApplicationTaskTagTag（）的一個版本，可以從中斷服務例程（ISR）進行調用。
返回與任務關聯的“標籤”值。標籤值的含義和使用由應用程序編寫者定義。RTOS內核本身通常不會訪問標籤值。
此功能僅適用於高級用戶。
參數：
| 任務 | 正在查詢任務的句柄。任務可以使用NULL作爲參數值來查詢自己的標記值。 |
返回值：
被查詢任務的“標籤”值。
用法示例：
/* In this example, an integer is set as the task tag value. */
void vATask( void *pvParameters )
{
/* Assign a tag value of 1 to the currently executing task.
The (void *) cast is used to prevent compiler warnings. */
vTaskSetApplicationTaskTag( NULL, ( void * ) 1 );
for( ;; )
{
/* Rest of task code goes here. */
}
}
void vAFunction( void )
{
TaskHandle_t xHandle;
int iReturnedTaskHandle;
/* Create a task from the vATask() function, storing the handle to the
created task in the xTask variable. */
/* Create the task. */
if( xTaskCreate(
vATask, /* Pointer to the function that implements
the task. */
"Demo task", /* Text name given to the task. */
STACK_SIZE, /* The size of the stack that should be created
for the task. This is defined in words, not
bytes. */
NULL, /* The task does not use the
parameter. */
TASK_PRIORITY, /* The priority to assign to the newly created
task. */
&xHandle /* The handle to the task being created will be
placed in xHandle. */
) == pdPASS )
{
/* The task was created successfully. Delay for a short period to allow
the task to run. */
vTaskDelay( 100 );
/* What tag value is assigned to the task? The returned tag value is
stored in an integer, so cast to an integer to prevent compiler
warnings. */
iReturnedTaskHandle = ( int ) xTaskGetApplicationTaskTag( xHandle );
}
}
xTaskGetCurrentTaskHandle
必須將INCLUDE_xTaskGetCurrentTaskHandle設置爲1才能使用此功能。
返回值：
當前正在運行（正在調用）的任務的句柄。
xTaskGetHandle
TaskHandle_t xTaskGetHandle（const char * pcNameToQuery）;
從任務名稱中查找任務的句柄。
注意：此功能需要相對較長的時間才能完成，並且每個任務只能調用一次。一旦獲得任務的句柄，就可以將其存儲在本地以供重複使用。
必須將FreeRTOSConfig.h中的INCLUDE_xTaskGetHandle設置爲1，才能使xTaskGetHandle（）可用。
參數：
| pcNameToQuery | 將爲其返回句柄的任務的文本名稱（作爲標準的C NULL終止字符串）。
有關 設置任務文本名稱的信息，請參見xTaskCreate（） 和xTaskCreateStatic（） API函數的pcName參數。 |
返回值：
如果可以找到具有在pcNameToQuery中傳遞的名稱的任務，則返回任務的句柄，否則返回NULL。
xTaskGetIdleTaskHandle
必須將INCLUDE_xTaskGetIdleTaskHandle設置爲1才能使用此功能。
返回值：
與空閒任務關聯的任務句柄。啓動RTOS計劃程序時，將自動創建空閒任務。
uxTaskGetStackHighWaterMark
uxTaskGetStackHighWaterMark2
要使這些功能可用，必須將INCLUDE_uxTaskGetStackHighWaterMark定義爲1。有關更多信息，請參見RTOS配置文檔。
uxTaskGetStackHighWaterMark2（）是uxTaskGetStackHighWaterMark（）的版本，該版本返回用戶可定義的類型以消除8位架構上UBaseType_t類型的數據類型寬度限制。
任務使用的堆棧將隨着任務執行和中斷處理而增長和收縮。uxTaskGetStackHighWaterMark（）返回自任務開始執行以來任務可用的最小剩餘堆棧空間量，即當任務堆棧處於最大（最深）值時仍未使用的堆棧量。這就是所謂的堆棧“高水位標記”。
參數：
| 任務 | 正在查詢任務的句柄。任務可以通過傳遞NULL作爲xTask參數來查詢自己的高水位線。 |
返回值：
| 返回的值是以字爲單位的高水位標記（例如，在32位計算機上，返回值爲1表示未使用4個字節的堆棧）。如果返回值爲零，則任務可能已溢出其堆棧。如果返回值接近於零，則任務已接近溢出其堆棧。 |
用法示例：
void vTask1( void * pvParameters )
{
UBaseType_t uxHighWaterMark;
/* Inspect our own high water mark on entering the task. */
uxHighWaterMark = uxTaskGetStackHighWaterMark( NULL );
for( ;; )
{
/* Call any function. */
vTaskDelay( 1000 );
/* Calling the function will have used some stack space, we would
therefore now expect uxTaskGetStackHighWaterMark() to return a
value lower than when it was called on entering the task. */
uxHighWaterMark = uxTaskGetStackHighWaterMark( NULL );
}
}
eTaskGetState
以枚舉類型返回執行eTaskGetState（）時任務存在的狀態。
必須在FreeRTOSConfig.h中將INCLUDE_eTaskGetState設置爲1，eTaskGetState（）纔可用。
另請參見vTaskGetInfo（）。
參數：
| 任務 | 主題任務（正在查詢的任務）的句柄。 |
返回值：
下表列出了eTaskGetState（）將針對xTask參數引用的任務可能存在的每個可能狀態返回的值。
| 狀態 |
返回值
|
| 就緒態 | eReady |
| 運行態 | eRunning（調用任務正在查詢自己的優先級） |
| 阻塞態 | eBlocked |
| 掛起態 | eSuspended |
| 刪除態 | eDeleted（任務TCB正在等待清理） |
pcTaskGetName
從任務的句柄中查找任務的名稱。
參數：
| xTaskToQuery | 正在查詢任務的句柄。可以將xTaskToQuery設置爲NULL來查詢調用任務的名稱。 |
返回值：
指向主題任務名稱的指針，該名稱是標準的以NULL結尾的C字符串。
xTaskGetTickCount
volatile TickType_t xTaskGetTickCount（void）;
無法從ISR調用此函數。改用xTaskGetTickCountFromISR（）。
返回值：
自調用vTaskStartScheduler以來的滴答計數。
xTaskGetTickCountFromISR
volatile TickType_t xTaskGetTickCountFromFromISR（void）;
可以從ISR調用的xTaskGetTickCount（）版本。
返回值：
自調用vTaskStartScheduler以來的滴答計數。
xTaskGetSchedulerState
返回值：
以下常量之一（在task.h中定義）：taskSCHEDULER_NOT_STARTED，taskSCHEDULER_RUNNING，taskSCHEDULER_SUSPENDED。
要使此功能可用，必須在FreeRTOSConfig.h中將INCLUDE_xTaskGetSchedulerState或configUSE_TIMERS設置爲1。
uxTaskGetNumberOfTasks
返回值：
RTOS內核當前正在管理的任務數。這包括所有準備就緒，已阻止和已暫停的任務。空閒任務已刪除但尚未釋放的任務也將包括在計數中。
vTaskList
void vTaskList（char * pcWriteBuffer）;
要使此功能可用，必須在FreeRTOSConfig.h中將configUSE_TRACE_FACILITY和configUSE_STATS_FORMATTING_FUNCTIONS定義爲1。有關更多信息，請參見配置部分。
注意：此功能將在其持續時間內禁用中斷。它不適合正常的應用程序運行時使用，而是作爲調試輔助。
vTaskList（）調用uxTaskGetSystemState（），然後將uxTaskGetSystemState（）生成的原始數據格式化爲人類可讀（ASCII）表，該表顯示每個任務的狀態，包括任務堆棧的高水位標記（高水位標記越小，任務越接近其堆棧溢出）。 單擊此處查看生成的輸出示例。
在ASCII表中，以下字母用於表示任務的狀態：
- 'B' –已屏蔽
- 'R' –準備就緒
- 'D' –刪除（等待清理）
- 'S' –暫停或被阻止，沒有超時
vTaskList（）是僅出於方便目的而提供的實用程序函數。它不被視爲內核的一部分。有關 實用程序函數的信息，請參見vTaskGetRunTimeStats（），該實用程序函數會生成類似的運行時任務利用率信息表。
參數：
| pcWriteBuffer | 將上述詳細信息寫入ASCII格式的緩衝區。假定此緩衝區足夠大以包含生成的報告。每個任務大約40個字節就足夠了。 |
vTaskStartTrace
[此功能與FreeRTOS V7.1.0中已刪除的舊版跟蹤實用程序有關，用戶可能會發現更易於使用且功能更強大的更新的 跟蹤掛鉤宏。
啓動RTOS內核活動跟蹤。跟蹤記錄何時運行哪個任務的標識。
跟蹤文件以二進制格式存儲。單獨的DOS實用程序convtrce.exe可用於將其轉換爲製表符分隔的文本文件，該文件可在電子表格中查看和繪製。
參數：
| pcBuffer | 跟蹤將寫入其中的緩衝區。 |
| ulBufferSize | pcBuffer的大小（以字節爲單位）。跟蹤將一直持續到緩衝區已滿或調用ulTaskEndTrace（）爲止。 |
ulTaskEndTrace
[此功能與FreeRTOS V7.1.0中已刪除的舊版跟蹤實用程序有關，用戶可能會發現更易於使用且功能更強大的更新的跟蹤掛鉤宏。
停止RTOS內核活動跟蹤。請參見vTaskStartTrace（）。
返回值：
已寫入跟蹤緩衝區的字節數。
vTaskGetRunTimeStats
void vTaskGetRunTimeStats（char * pcWriteBuffer）;
有關此功能的完整說明，請參見“ 運行時統計”頁面。
configGENERATE_RUN_TIME_STATS，configUSE_STATS_FORMATTING_FUNCTIONS和configSUPPORT_DYNAMIC_ALLOCATION必須都定義爲1，此功能纔可用。然後，應用程序還必須提供portCONFIGURE_TIMER_FOR_RUN_TIME_STATS（）和portGET_RUN_TIME_COUNTER_VALUE的定義，以配置外設定時器/計數器並分別返回定時器的當前計數值。計數器應至少是滴答計數頻率的10倍。
注意：此功能將在其持續時間內禁用中斷。它不適合正常的應用程序運行時使用，而是作爲調試輔助。vTaskGetRunTimeStats（）
調用uxTaskGetSystemState（），然後將uxTaskGetSystemState（）生成的原始數據格式化爲人類可讀（ASCII）表，該表顯示每個任務在運行狀態下所花費的時間（每個任務所消耗的CPU時間） 。數據以絕對值和百分比值形式提供。絕對值的分辨率取決於應用程序提供的運行時統計時鐘的頻率。
vTaskGetRunTimeStats（）是僅出於方便目的而提供的實用程序函數。它不被視爲內核的一部分。有關 生成每個任務狀態信息的實用程序功能，請參見vTaskList（）。
參數：
| pcWriteBuffer | 執行時間將以ASCII形式寫入的緩衝區。假定此緩衝區足夠大以包含生成的報告。每個任務大約40個字節就足夠了。 |
vTaskSetApplicationTaskTag
必須將configUSE_APPLICATION_TASK_TAG定義爲1，此功能才能使用。有關更多信息，請參見RTOS配置文檔。
可以爲每個任務分配一個“標籤”值。該值僅用於應用程序– RTOS內核本身不以任何方式使用它。該RTOS跟蹤宏文檔頁面提供了一個應用程序可能如何利用此功能的一個很好的例子。
參數：
| 任務 | 爲其分配了標籤值的任務的句柄。將xTask傳遞爲NULL會將標記分配給調用任務。 |
| pxTagValue | 分配給任務標籤的值。這是TaskHookFunction_t類型，允許將功能指針分配爲標籤，儘管實際上可以分配任何值。請參見下面的示例。 |
用法示例：
/* In this example an integer is set as the task tag value.
See the RTOS trace hook macros documentation page for an
example how such an assignment can be used. */
void vATask( void *pvParameters )
{
/* Assign a tag value of 1 to myself. */
vTaskSetApplicationTaskTag( NULL, ( void * ) 1 );
for( ;; )
{
/* Rest of task code goes here. */
}
}
/***********************************************/
/* In this example a callback function is being assigned as the task tag.
First define the callback function - this must have type TaskHookFunction_t
as per this example. */
static BaseType_t prvExampleTaskHook( void * pvParameter )
{
/* Perform some action - this could be anything from logging a value,
updating the task state, outputting a value, etc. */
return 0;
}
/* Now define the task that sets prvExampleTaskHook as its hook/tag value.
This is in fact registering the task callback, as described on the
xTaskCallApplicationTaskHook() documentation page. */
void vAnotherTask( void *pvParameters )
{
/* Register our callback function. */
vTaskSetApplicationTaskTag( NULL, prvExampleTaskHook );
for( ;; )
{
/* Rest of task code goes here. */
}
}
/* As an example use of the hook (callback) we can get the RTOS kernel to call the
hook function of each task that is being switched out during a reschedule. */
#define traceTASK_SWITCHED_OUT() xTaskCallApplicationTaskHook( pxCurrentTCB,
0 )
xTaskCallApplicationTaskHook
必須將configUSE_APPLICATION_TASK_TAG定義爲1，此功能才能使用。有關更多信息，請參見RTOS配置文檔。
可以爲每個任務分配一個“標籤”值。通常，此值僅供應用程序使用，RTOS內核不會訪問它。但是，可以使用標記將鉤子（或回調）函數分配給任務-通過調用xTaskCallApplicationTaskHook（）執行鉤子函數。每個任務可以定義自己的回調，也可以根本不定義回調。
儘管可以使用第一個函數參數來調用任何任務的鉤子函數，但是任務鉤子函數最常見的用法是使用跟蹤鉤子宏，如以下示例所示。
任務掛鉤函數必須具有TaskHookFunction_t類型，即帶有void *參數，並返回BaseType_t類型的值。void *參數可用於將任何信息傳遞給hook函數。
參數：
| 任務 | 正在調用其掛鉤函數的任務的句柄。將NULL作爲xTask傳遞時，將調用與當前正在執行的任務相關聯的hook函數。 |
| pvParameter | 傳遞給掛鉤函數的值。這可以是指向結構的指針，也可以只是數字值。 |
用法示例：
/* In this example a callback function is being assigned as the task tag.
First define the callback function - this must have type TaskHookFunction_t
as per this example. */
static BaseType_t prvExampleTaskHook( void * pvParameter )
{
/* Perform some action - this could be anything from logging a value,
updating the task state, outputting a value, etc. */
return 0;
}
/* Now define the task that sets prvExampleTaskHook as its hook/tag value.
This is in fact registering the task callback, as described on the
xTaskCallApplicationTaskHook() documentation page. */
void vAnotherTask( void *pvParameters )
{
/* Register our callback function. */
vTaskSetApplicationTaskTag( NULL, prvExampleTaskHook );
for( ;; )
{
/* Rest of task code goes here. */
}
}
/* As an example use of the hook (callback) we can get the RTOS kernel to
call the hook function of each task that is being switched out during a
reschedule. */
#define traceTASK_SWITCHED_OUT() xTaskCallApplicationTaskHook( pxCurrentTCB, 0 )
vTaskSetThreadLocalStoragePointer
無效vTaskSetThreadLocalStoragePointer（TaskHandle_t xTaskToSet，
BaseType_t xIndex，
無效* pvValue）
在任務的線程本地存儲數組中設置一個值 。
此功能僅適用於高級用戶。
參數：
| xTaskToSet | 線程本地數據正在寫入的任務的句柄。通過使用NULL作爲參數值，任務可以寫入其自己的線程本地數據。 |
| 索引 | 線程本地存儲陣列中要寫入數據的索引。
可用數組索引的數量由FreeRTOSConfig.h中的configNUM_THREAD_LOCAL_STORAGE_POINTERS 編譯時配置常量 設置 。 |
| pv值 | 要寫入由xIndex參數指定的索引的值。 |
用法示例：
請參閱線程本地存儲陣列 文檔頁面上提供的示例。
pvTaskGetThreadLocalStoragePointer
無效* pvTaskGetThreadLocalStoragePointer（
TaskHandle_t xTaskToQuery，
BaseType_t xIndex）;
從任務的線程本地存儲數組中檢索一個值 。
此功能僅適用於高級用戶。
參數：
| xTaskToQuery | 從中讀取線程本地數據的任務的句柄。通過使用NULL作爲參數值，任務可以讀取自己的線程本地數據。 |
| 索引 | 到線程本地存儲陣列中的索引，將從中讀取數據。
可用數組索引的數量由FreeRTOSConfig.h中的configNUM_THREAD_LOCAL_STORAGE_POINTERS 編譯時配置常量 設置 。 |
返回值：
存儲在任務xTaskToQuery的線程本地存儲數組的索引位置xIndex中的值。
用法示例：
請參閱線程本地存儲陣列 文檔頁面上提供的示例。
vTaskSetTimeOutState（）
void vTaskSetTimeOutState（TimeOut_t * const pxTimeOut）;
此功能僅適用於高級用戶。
任務可以進入阻止狀態以等待事件。通常，任務不會無限期地處於“阻塞”狀態，而是將指定超時期限。如果超時時間在任務等待事件發生之前到期，則該任務將從“阻塞”狀態中刪除。
如果任務在等待事件發生時多次進入和退出“阻止”狀態，則必須調整每次任務進入“阻止”狀態所用的超時時間，以確保在“阻止”狀態下花費的所有時間總計不超過最初指定的超時期限。xTaskCheckForTimeOut（）執行調整時要考慮偶發計數溢出之類的偶發事件，否則這會使手動調整容易出錯。
vTaskSetTimeOutState（）與xTaskCheckForTimeOut（）一起使用。調用vTaskSetTimeOutState（）設置初始條件，然後可以調用xTaskCheckForTimeOut（）來檢查超時條件，並在未發生超時的情況下調整剩餘的塊時間。
參數：
| pxTimeOut | 指向結構的指針，該結構將被初始化以保存確定是否發生超時所必需的信息。 |
用法示例：
xTaskCheckForTimeOut（） 文檔頁面 上提供了一個示例。
xTaskCheckForTimeOut（）
BaseType_t xTaskCheckForTimeOut（TimeOut_t * const pxTimeOut，
TickType_t * const pxTicksToWait）;
此功能僅適用於高級用戶。
任務可以進入阻止狀態以等待事件。通常，任務不會無限期地處於“阻塞”狀態，而是將指定超時期限。如果超時時間在任務等待事件發生之前到期，則該任務將從“阻塞”狀態中刪除。
如果任務在等待事件發生時多次進入和退出“阻止”狀態，則必須調整每次任務進入“阻止”狀態所用的超時時間，以確保在“阻止”狀態下花費的所有時間總計不超過最初指定的超時期限。xTaskCheckForTimeOut（）執行調整時要考慮偶發計數溢出之類的偶發事件，否則這會使手動調整容易出錯。
xTaskCheckForTimeOut（）與vTaskSetTimeOutState（）一起使用。調用vTaskSetTimeOutState（）設置初始條件，然後可以調用xTaskCheckForTimeOut（）來檢查超時條件，並在未發生超時的情況下調整剩餘的塊時間。
參數：
| pxTimeOut | 指向結構的指針，該結構保存確定是否發生超時所需的信息。使用vTaskSetTimeOutState（）初始化pxTimeOut。 |
| pxTicksToWait | 用於傳遞調整後的阻止時間，這是考慮到已經處於“阻止”狀態的時間之後剩餘的阻止時間。 |
返回值：
如果返回pdTRUE，則沒有塊時間剩餘，並且發生了超時。
如果返回pdFALSE，則剩餘一些塊時間，因此不會發生超時。
用法示例：
/* Driver library function used to receive uxWantedBytes from an Rx buffer that
is filled by a UART interrupt. If there are not enough bytes in the Rx buffer
then the task enters the Blocked state until it is notified that more data has
been placed into the buffer. If there is still not enough data then the task
re-enters the Blocked state, and xTaskCheckForTimeOut() is used to re-calculate
the Block time to ensure the total amount of time spent in the Blocked state does
not exceed MAX_TIME_TO_WAIT. This continues until either the buffer contains at
least uxWantedBytes bytes, or the total amount of time spent in the Blocked state
reaches MAX_TIME_TO_WAIT – at which point the task reads however many bytes are
available up to a maximum of uxWantedBytes. */
size_t xUART_Receive( uint8_t *pucBuffer, size_t uxWantedBytes )
{
size_t uxReceived = 0;
TickType_t xTicksToWait = MAX_TIME_TO_WAIT;
TimeOut_t xTimeOut;
/* Initialize xTimeOut. This records the time at which this function was
entered. */
vTaskSetTimeOutState( &xTimeOut );
/* Loop until the buffer contains the wanted number of bytes, or a timeout
occurs. */
while( UART_bytes_in_rx_buffer( pxUARTInstance ) < uxWantedBytes )
{
/* The buffer didn't contain enough data so this task is going to
enter the Blocked state. Adjusting xTicksToWait to account for any time
that has been spent in the Blocked state within this function so far to
ensure the total amount of time spent in the Blocked state does not exceed
MAX_TIME_TO_WAIT. */
if( xTaskCheckForTimeOut( &xTimeOut, &xTicksToWait ) != pdFALSE )
{
/* Timed out before the wanted number of bytes were available, exit the
loop. */
break;
}
/* Wait for a maximum of xTicksToWait ticks to be notified that the receive
interrupt has placed more data into the buffer. */
ulTaskNotifyTake( pdTRUE, xTicksToWait );
}
/* Attempt to read uxWantedBytes from the receive buffer into pucBuffer. The
actual number of bytes read (which might be less than uxWantedBytes) is
returned. */
uxReceived = UART_read_from_receive_buffer( pxUARTInstance,
pucBuffer,
uxWantedBytes );
return uxReceived;
}