modm API documentation
Public Member Functions | Static Public Member Functions | List of all members
modm::platform::HeapTable Class Reference
Platform HAL » ARM Cortex-M Core

#include <modm/platform/core/heap_table.hpp>

Public Member Functions

Iterator begin ()
 
Iterator end ()
 

Static Public Member Functions

static bool find_largest (const uint8_t **start, const uint8_t **end, MemoryTraits trait_mask=MemoryDefault)
 

Detailed Description

Provides information about the unused memory sections in RAM listed by size and memory traits.

The iterator returns a tuple of values for each memory section:

    >
  1. MemoryTraits traits,
  2. const uint32_t *start_addr,
  3. const uint32_t *end_addr,
  4. size_t size in Bytes.

Member Function Documentation

bool modm::platform::HeapTable::find_largest ( const uint8_t **  start,
const uint8_t **  end,
MemoryTraits  trait_mask = MemoryDefault 
)
static

Find the largest continuous memory section which satisfies at least the selected memory traits.

The documentation for this class was generated from the following files: