The Pedigree Project  0.1
Macros
Memory pools

Macros

#define LWIP_MEMPOOL_PROTOTYPE(name)   extern const struct memp_desc memp_ ## name
 
#define LWIP_MEMPOOL_DECLARE(name, num, size, desc)
 
#define LWIP_MEMPOOL_INIT(name)   memp_init_pool(&memp_ ## name)
 
#define LWIP_MEMPOOL_ALLOC(name)   memp_malloc_pool(&memp_ ## name)
 
#define LWIP_MEMPOOL_FREE(name, x)   memp_free_pool(&memp_ ## name, (x))
 

Detailed Description

Custom memory pools

Macro Definition Documentation

#define LWIP_MEMPOOL_ALLOC (   name)    memp_malloc_pool(&memp_ ## name)

Allocate from a private memory pool

Definition at line 139 of file memp.h.

#define LWIP_MEMPOOL_DECLARE (   name,
  num,
  size,
  desc 
)
Value:
LWIP_DECLARE_MEMORY_ALIGNED(memp_memory_ ## name ## _base, ((num) * (MEMP_SIZE + MEMP_ALIGN_SIZE(size)))); \
\
LWIP_MEMPOOL_DECLARE_STATS_INSTANCE(memp_stats_ ## name) \
\
static struct memp *memp_tab_ ## name; \
\
const struct memp_desc memp_ ## name = { \
DECLARE_LWIP_MEMPOOL_DESC(desc) \
LWIP_MEMPOOL_DECLARE_STATS_REFERENCE(memp_stats_ ## name) \
(num), \
memp_memory_ ## name ## _base, \
&memp_tab_ ## name \
};
u16_t size
Definition: memp_priv.h:160
u16_t num
Definition: memp_priv.h:164
#define LWIP_MEM_ALIGN_SIZE(size)
Definition: arch.h:233
LWIP_DECLARE_MEMORY_ALIGNED(ram_heap, MEM_SIZE_ALIGNED+(2U *SIZEOF_STRUCT_MEM))

Declare a private memory pool Private mempools example: .h: only when pool is used in multiple .c files: LWIP_MEMPOOL_PROTOTYPE(my_private_pool); .c:

To relocate a pool, declare it as extern in cc.h. Example for GCC: extern u8_t attribute((section(".onchip_mem"))) memp_memory_my_private_pool[];

Definition at line 112 of file memp.h.

#define LWIP_MEMPOOL_FREE (   name,
 
)    memp_free_pool(&memp_ ## name, (x))

Free element from a private memory pool

Definition at line 144 of file memp.h.

#define LWIP_MEMPOOL_INIT (   name)    memp_init_pool(&memp_ ## name)

Initialize a private memory pool

Definition at line 134 of file memp.h.

#define LWIP_MEMPOOL_PROTOTYPE (   name)    extern const struct memp_desc memp_ ## name

Declare prototype for private memory pool if it is used in multiple files

Definition at line 84 of file memp.h.