Skip to content

Improve documentation for memory stat ops #4790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 27, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions platform/mbed_stats.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,22 @@ typedef struct {
void mbed_stats_heap_get(mbed_stats_heap_t *stats);

typedef struct {
uint32_t thread_id; /**< Identifier for thread that owns the stack. */
uint32_t max_size; /**< Sum of the maximum number of bytes used in each stack. */
uint32_t reserved_size; /**< Current number of bytes allocated for all stacks. */
uint32_t stack_cnt; /**< Number of stacks currently allocated. */
uint32_t thread_id; /**< Identifier for thread that owns the stack or 0 if multiple threads. */
uint32_t max_size; /**< Maximum number of bytes used on the stack. */
uint32_t reserved_size; /**< Current number of bytes allocated for the stack. */
uint32_t stack_cnt; /**< Number of stacks stats accumulated in the structure. */
} mbed_stats_stack_t;

/**
* Fill the passed in structure with stack stats.
* Fill the passed in structure with stack stats accumulated for all threads. The thread_id will be 0
* and stack_cnt will represent number of threads.
*
* @param stats A pointer to the mbed_stats_stack_t structure to fill
*/
void mbed_stats_stack_get(mbed_stats_stack_t *stats);

/**
* Fill the passed array of stat structures with the stack stats
* for each available stack.
* Fill the passed array of stat structures with the stack stats for each available thread.
*
* @param stats A pointer to an array of mbed_stats_stack_t structures to fill
* @param count The number of mbed_stats_stack_t structures in the provided array
Expand Down