1/*
2 * SETUP: Make sure we define everything we will need.
3 *
4 * We have create three types of pools:
5 *   1) MEMPOOL - standard pools
6 *   2) MALLOC_MEMPOOL - to be used by mem_malloc in mem.c
7 *   3) PBUF_MEMPOOL - a mempool of pbuf's, so include space for the pbuf struct
8 *
9 * If the include'r doesn't require any special treatment of each of the types
10 * above, then will declare #2 & #3 to be just standard mempools.
11 */
12#ifndef LWIP_MALLOC_MEMPOOL
13/* This treats "malloc pools" just like any other pool.
14   The pools are a little bigger to provide 'size' as the amount of user data. */
15#define LWIP_MALLOC_MEMPOOL(num, size) LWIP_MEMPOOL(POOL_##size, num, (size + sizeof(struct memp_malloc_helper)), "MALLOC_"#size)
16#define LWIP_MALLOC_MEMPOOL_START
17#define LWIP_MALLOC_MEMPOOL_END
18#endif                          /* LWIP_MALLOC_MEMPOOL */
19
20#ifndef LWIP_PBUF_MEMPOOL
21/* This treats "pbuf pools" just like any other pool.
22 * Allocates buffers for a pbuf struct AND a payload size */
23#define LWIP_PBUF_MEMPOOL(name, num, payload, desc) LWIP_MEMPOOL(name, num, (MEMP_ALIGN_SIZE(sizeof(struct pbuf)) + MEMP_ALIGN_SIZE(payload)), desc)
24#endif                          /* LWIP_PBUF_MEMPOOL */
25
26
27/*
28 * A list of internal pools used by LWIP.
29 *
30 * LWIP_MEMPOOL(pool_name, number_elements, element_size, pool_description)
31 *     creates a pool name MEMP_pool_name. description is used in stats.c
32 */
33#if LWIP_RAW
34LWIP_MEMPOOL(RAW_PCB, MEMP_NUM_RAW_PCB, sizeof(struct raw_pcb), "RAW_PCB")
35#endif                          /* LWIP_RAW */
36#if LWIP_UDP
37  LWIP_MEMPOOL(UDP_PCB, MEMP_NUM_UDP_PCB, sizeof(struct udp_pcb), "UDP_PCB")
38#endif                          /* LWIP_UDP */
39#if LWIP_TCP
40  LWIP_MEMPOOL(TCP_PCB, MEMP_NUM_TCP_PCB, sizeof(struct tcp_pcb), "TCP_PCB")
41  LWIP_MEMPOOL(TCP_PCB_LISTEN, MEMP_NUM_TCP_PCB_LISTEN,
42             sizeof(struct tcp_pcb_listen), "TCP_PCB_LISTEN")
43  LWIP_MEMPOOL(TCP_SEG, MEMP_NUM_TCP_SEG, sizeof(struct tcp_seg), "TCP_SEG")
44#endif                          /* LWIP_TCP */
45#if IP_REASSEMBLY
46  LWIP_MEMPOOL(REASSDATA, MEMP_NUM_REASSDATA, sizeof(struct ip_reassdata),
47             "REASSDATA")
48#endif                          /* IP_REASSEMBLY */
49#if LWIP_NETCONN
50  LWIP_MEMPOOL(NETBUF, MEMP_NUM_NETBUF, sizeof(struct netbuf), "NETBUF")
51  LWIP_MEMPOOL(NETCONN, MEMP_NUM_NETCONN, sizeof(struct netconn), "NETCONN")
52#endif                          /* LWIP_NETCONN */
53#if NO_SYS==0
54  LWIP_MEMPOOL(TCPIP_MSG_API, MEMP_NUM_TCPIP_MSG_API, sizeof(struct tcpip_msg),
55             "TCPIP_MSG_API")
56  LWIP_MEMPOOL(TCPIP_MSG_INPKT, MEMP_NUM_TCPIP_MSG_INPKT,
57             sizeof(struct tcpip_msg), "TCPIP_MSG_INPKT")
58#endif                          /* NO_SYS==0 */
59#if ARP_QUEUEING
60  LWIP_MEMPOOL(ARP_QUEUE, MEMP_NUM_ARP_QUEUE, sizeof(struct etharp_q_entry),
61             "ARP_QUEUE")
62#endif                          /* ARP_QUEUEING */
63#if LWIP_IGMP
64  LWIP_MEMPOOL(IGMP_GROUP, MEMP_NUM_IGMP_GROUP, sizeof(struct igmp_group),
65             "IGMP_GROUP")
66#endif                          /* LWIP_IGMP */
67#if NO_SYS==0
68  LWIP_MEMPOOL(SYS_TIMEOUT, MEMP_NUM_SYS_TIMEOUT, sizeof(struct sys_timeo),
69             "SYS_TIMEOUT")
70#endif                          /* NO_SYS==0 */
71/*
72 * A list of pools of pbuf's used by LWIP.
73 *
74 * LWIP_PBUF_MEMPOOL(pool_name, number_elements, pbuf_payload_size, pool_description)
75 *     creates a pool name MEMP_pool_name. description is used in stats.c
76 *     This allocates enough space for the pbuf struct and a payload.
77 *     (Example: pbuf_payload_size=0 allocates only size for the struct)
78 */
79  LWIP_PBUF_MEMPOOL(PBUF, MEMP_NUM_PBUF + PBUF_POOL_SIZE, 0, "PBUF_REF/ROM")
80  LWIP_MEMPOOL(PBUF_POOL, PBUF_POOL_SIZE, PBUF_POOL_BUFSIZE, "PBUF_POOL")
81
82
83/*
84 * Allow for user-defined pools; this must be explicitly set in lwipopts.h
85 * since the default is to NOT look for lwippools.h
86 */
87#if MEMP_USE_CUSTOM_POOLS
88#include "lwippools.h"
89#endif                          /* MEMP_USE_CUSTOM_POOLS */
90/*
91 * REQUIRED CLEANUP: Clear up so we don't get "multiply defined" error later
92 * (#undef is ignored for something that is not defined)
93 */
94#undef LWIP_MEMPOOL
95#undef LWIP_MALLOC_MEMPOOL
96#undef LWIP_MALLOC_MEMPOOL_START
97#undef LWIP_MALLOC_MEMPOOL_END
98#undef LWIP_PBUF_MEMPOOL
99