epagris/FreeRTOS-Kernel
1
0
Fork 1
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-11-04 02:59:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add an example of human readable table generated by vTaskListTasks() to tash.h (#1215)

Browse Source 
* Add an example of human readable table generated by vTaskListTasks() to task.h
This commit is contained in:
wwhheerree 2024-12-24 19:11:44 +08:00 committed by GitHub
parent f31787d35d
commit f63bc2b5cc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
include/task.h
View File

@ -2199,8 +2199,8 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
* Lists all the current tasks, along with their current state and stack * Lists all the current tasks, along with their current state and stack
* usage high water mark. * usage high water mark.
* *
* Tasks are reported as blocked ('B'), ready ('R'), deleted ('D') or * Tasks are reported as running ('X'), blocked ('B'), ready ('R'), deleted ('D')
* suspended ('S'). * or suspended ('S').
* *
* PLEASE NOTE: * PLEASE NOTE:
* *
@ -2208,8 +2208,16 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
* demo applications. Do not consider it to be part of the scheduler. * demo applications. Do not consider it to be part of the scheduler.
* *
* vTaskListTasks() calls uxTaskGetSystemState(), then formats part of the * vTaskListTasks() calls uxTaskGetSystemState(), then formats part of the
* uxTaskGetSystemState() output into a human readable table that displays task: * uxTaskGetSystemState() output into a human readable table that displays task
* names, states, priority, stack usage and task number. * information in the following format:
* Task Name, Task State, Task Priority, Task Stack High Watermak, Task Number.
*
* The following is a sample output:
* Task A X 2 67 2
* Task B R 1 67 3
* IDLE R 0 67 5
* Tmr Svc B 6 137 6
*
* Stack usage specified as the number of unused StackType_t words stack can hold * Stack usage specified as the number of unused StackType_t words stack can hold
* on top of stack - not the number of bytes. * on top of stack - not the number of bytes.
* *
@ -2260,8 +2268,8 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
* Lists all the current tasks, along with their current state and stack * Lists all the current tasks, along with their current state and stack
* usage high water mark. * usage high water mark.
* *
* Tasks are reported as blocked ('B'), ready ('R'), deleted ('D') or * Tasks are reported as running ('X'), blocked ('B'), ready ('R'), deleted ('D')
* suspended ('S'). * or suspended ('S').
* *
* PLEASE NOTE: * PLEASE NOTE:
* *
@ -2269,8 +2277,16 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
* demo applications. Do not consider it to be part of the scheduler. * demo applications. Do not consider it to be part of the scheduler.
* *
* vTaskList() calls uxTaskGetSystemState(), then formats part of the * vTaskList() calls uxTaskGetSystemState(), then formats part of the
* uxTaskGetSystemState() output into a human readable table that displays task: * uxTaskGetSystemState() output into a human readable table that displays task
* names, states, priority, stack usage and task number. * information in the following format:
* Task Name, Task State, Task Priority, Task Stack High Watermak, Task Number.
*
* The following is a sample output:
* Task A X 2 67 2
* Task B R 1 67 3
* IDLE R 0 67 5
* Tmr Svc B 6 137 6
*
* Stack usage specified as the number of unused StackType_t words stack can hold * Stack usage specified as the number of unused StackType_t words stack can hold
* on top of stack - not the number of bytes. * on top of stack - not the number of bytes.
* *