Quality RTOS & Embedded Software

 Real time embedded FreeRTOS RSS feed 
Quick Start Supported MCUs PDF Books Trace Tools Ecosystem


Clarification for uxGetTaskHighWaterMark()

Posted by Paul Coleman on 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.

RE: Clarification for uxGetTaskHighWaterMark()

Posted by Dave on 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?

RE: Clarification for uxGetTaskHighWaterMark()

Posted by Paul Coleman on 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.

RE: Clarification for uxGetTaskHighWaterMark()

Posted by Toan Pham on June 26, 2012
Good question,

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


[ Back to the top ]    [ About FreeRTOS ]    [ Privacy ]    [ Sitemap ]    [ ]

Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.

Latest News

FreeRTOS v10.2.0 is available for immediate download. MIT licensed, and including RISC-V and ARMv8-M (Cortex-M33) demos.

NXP tweet showing LPC5500 (ARMv8-M Cortex-M33) running FreeRTOS.

View a recording of the "OTA Update Security and Reliability" webinar, presented by TI and AWS.


FreeRTOS and other embedded software careers at AWS.

FreeRTOS Partners

ARM Connected RTOS partner for all ARM microcontroller cores

Cadence Tensilica Cortes

Espressif ESP32

IAR Partner

Microchip Premier RTOS Partner

RTOS partner of NXP for all NXP ARM microcontrollers





STMicro RTOS partner supporting ARM7, ARM Cortex-M3, ARM Cortex-M4 and ARM Cortex-M0

Texas Instruments MCU Developer Network RTOS partner for ARM and MSP430 microcontrollers

OpenRTOS and SafeRTOS

Xilinx Microblaze and Zynq partner