len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-04-19 21:11:57 -04:00
Code Issues Packages Projects Releases Wiki Activity

Modified uxTaskGetStackHighWaterMark() to take a parameter for the task to be checked, rather than just checking the stack of the calling task.

Browse source
This commit is contained in:
Richard Barry 2008-03-05 10:13:18 +00:00
parent 47a7f0165b
commit 8e856177c9
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
Source/include/task.h
View file

@ -868,17 +868,23 @@ unsigned portLONG ulTaskEndTrace( void );
/** /**
* task.h * task.h
* <PRE>unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( void );</PRE> * <PRE>unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( xTaskHandle xTask );</PRE>
* *
* INCLUDE_uxTaskGetStackHighWaterMark must be set to 1 in FreeRTOSConfig.h for * INCLUDE_uxTaskGetStackHighWaterMark must be set to 1 in FreeRTOSConfig.h for
* this function to be available. * this function to be available.
* *
* Returns the high water mark for the stack of the calling task. That is, * Returns the high water mark of the stack associated with xTask. That is,
* the minimum free stack space there has been (in bytes) since the task * the minimum free stack space there has been (in bytes) since the task
* started. The small the returned number the closer the task has come * started. The smaller the returned number the closer the task has come
* to overflowing its stack. * to overflowing its stack.
*
* @param xTask Handle of the task associated with the stack to be checked.
* Set xTask to NULL to check the stack of the calling task.
*
* @return The smallest amount of free stack space there has been (in bytes)
* since the task referenced by xTask was created.
*/ */
unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( void ); unsigned portBASE_TYPE uxTaskGetStackHighWaterMark( xTaskHandle xTask );
/*----------------------------------------------------------- /*-----------------------------------------------------------
* SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES