Memory pool API. More...

#include "lwip/opt.h"
#include "lwip/priv/memp_std.h"
#include "lwip/priv/memp_priv.h"
#include "lwip/stats.h"

Macros
#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. More...

#define	LWIP_MEMPOOL_DECLARE(name, num, size, desc)
	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: More...

#define	LWIP_MEMPOOL_INIT(name) memp_init_pool(&memp_ ## name)
	Initialize a private memory pool. More...

#define	LWIP_MEMPOOL_ALLOC(name) memp_malloc_pool(&memp_ ## name)
	Allocate from a private memory pool. More...

#define	LWIP_MEMPOOL_FREE(name, x) memp_free_pool(&memp_ ## name, (x))
	Free element from a private memory pool. More...

Enumerations

Detailed Description

Memory pool API.

Definition in file memp.h.

Macro Definition Documentation

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

Allocate from a private memory pool.

Definition at line 122 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) \
    LWIP_MEM_ALIGN_SIZE(size), \
    (num), \
    memp_memory_ ## name ## _base, \
    &memp_tab_ ## name \
  };

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:

in global variables section: LWIP_MEMPOOL_DECLARE(my_private_pool, 10, sizeof(foo), "Some description")
call ONCE before using pool (e.g. in some init() function): LWIP_MEMPOOL_INIT(my_private_pool);
allocate: void* my_new_mem = LWIP_MEMPOOL_ALLOC(my_private_pool);
free: LWIP_MEMPOOL_FREE(my_private_pool, my_new_mem);

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_base[];

Definition at line 95 of file memp.h.

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

Free element from a private memory pool.

Definition at line 127 of file memp.h.

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

Initialize a private memory pool.

Definition at line 117 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 67 of file memp.h.

Enumeration Type Documentation

enum memp_t

Create the list of all memory pools managed by memp.

MEMP_MAX represents a NULL pool at the end

Definition at line 52 of file memp.h.

Macros

Enumerations

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Important Information for this Arm website