Clarification for uxGetTaskHighWaterMark()

paulgcoleman wrote on Tuesday, June 26, 2012:

I’m using the API function uxGetTaskHighWaterMark() to gather some runtime stats for my project. What I don’t understand is what this function returns. The manual says it returns the amount of stack space remaining but is this in bytes or words? My confusion arises from the fact that when you create a task you specify the stack size in words and not in bytes but the manual isn’t clear about what the uxGetTaskHighWaterMark() function returns.
Thanks, Paul.

davedoors wrote on Tuesday, June 26, 2012:

Looking at http://www.freertos.org/uxTaskGetStackHighWaterMark.html (and the source code) the function returns the high water mark (not the current stack use) in words (not bytes).

Where are you looking?

paulgcoleman wrote on Tuesday, June 26, 2012:

I’m looking in the manual that we bought at the start of the project from the website. On page 50 is says that “uxTaskGetStackHighWaterMark() returns the minimum amount of remaining stack space that has been available since the task started executing” but it didn’t mention if it’s bytes or words.

tpham3783 wrote on Tuesday, June 26, 2012:

Good question,

I asked a similar question, please ref. this thread:

https://sourceforge.net/projects/freertos/forums/forum/382005/topic/5328009