Wayne Jay / EthernetInterface

Onenet

Dependents:   K64F_eCompass_OneNET_JW

lwip/include/lwip/memp_std.h@0:b2805b6888dc, 2016-06-20 (annotated)

Committer:
robert_jw
Date:
Mon Jun 20 01:40:20 2016 +0000
Revision:
0:b2805b6888dc
ADS

Who changed what in which revision?

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