[RTOS Support] Clarification for uxGetTaskHighWaterMark()

The FreeRTOS kernel is now an MIT licensed AWS open source project, and these pages are being updated accordingly.

Quality RTOS & Embedded Software

About Contact Support FAQ Download

Menu

Quick Start

Supported MCUs

PDF Books

Trace Tools

Ecosystem

Quick Start Guide

Support Forum

⇓ Download Source ⇓

FreeRTOS+ Ecosystem

FreeRTOS+TCP:
Thread safe TCP/IP stack

SafeRTOS:
TUV certified RTOS

OpenRTOS:
Commercial Licensed RTOS

Fail Safe File System:
Ensures data integrity

FreeRTOS BSPs:
3rd party driver packages

Trace & Visualisation:
Tracealyzer for FreeRTOS

CLI:
Command line interface

WolfSSL SSL / TLS:
Networking security protocols

RTOS Training:
Delivered online or on-site

IO:
read(), write(), ioctl() interface

FreeRTOS+ Lab Projects

FreeRTOS+POSIX:
POSIX threading API

FreeRTOS+FAT:
Thread aware file system

FreeRTOS Support Archive

The FreeRTOS support forum is used to obtain active support directly from Real Time Engineers Ltd. In return for using our top quality software and services for free, we request you play fair and do your bit to help others too! Sign up to receive notifications of new support topics then help where you can.

This is a read only archive of threads posted to the FreeRTOS support forum. The archive is updated every week, so will not always contain the very latest posts. Use these archive pages to search previous posts. Use the Live FreeRTOS Forum link to reply to a post, or start a new support thread.

[FreeRTOS Home] [Live FreeRTOS Forum] [FAQ] [Archive Top] [June 2012 Threads]

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.