Kev Mann / mbed-dev-OS5_10_4

features/lwipstack/LWIPMemoryManager.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kevman 0:38ceb79fef03 1 /* Copyright (c) 2017 ARM Limited
kevman 0:38ceb79fef03 2 *
kevman 0:38ceb79fef03 3 * Licensed under the Apache License, Version 2.0 (the "License");
kevman 0:38ceb79fef03 4 * you may not use this file except in compliance with the License.
kevman 0:38ceb79fef03 5 * You may obtain a copy of the License at
kevman 0:38ceb79fef03 6 *
kevman 0:38ceb79fef03 7 * http://www.apache.org/licenses/LICENSE-2.0
kevman 0:38ceb79fef03 8 *
kevman 0:38ceb79fef03 9 * Unless required by applicable law or agreed to in writing, software
kevman 0:38ceb79fef03 10 * distributed under the License is distributed on an "AS IS" BASIS,
kevman 0:38ceb79fef03 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kevman 0:38ceb79fef03 12 * See the License for the specific language governing permissions and
kevman 0:38ceb79fef03 13 * limitations under the License.
kevman 0:38ceb79fef03 14 */
kevman 0:38ceb79fef03 15
kevman 0:38ceb79fef03 16 #ifndef LWIP_MEMORY_MANAGER_H
kevman 0:38ceb79fef03 17 #define LWIP_MEMORY_MANAGER_H
kevman 0:38ceb79fef03 18
kevman 0:38ceb79fef03 19 #include "EMACMemoryManager.h"
kevman 0:38ceb79fef03 20
kevman 0:38ceb79fef03 21 class LWIPMemoryManager : public EMACMemoryManager {
kevman 0:38ceb79fef03 22 public:
kevman 0:38ceb79fef03 23
kevman 0:38ceb79fef03 24 /**
kevman 0:38ceb79fef03 25 * Allocates memory buffer from the heap
kevman 0:38ceb79fef03 26 *
kevman 0:38ceb79fef03 27 * Memory buffer allocated from heap is always contiguous and can be arbitrary size.
kevman 0:38ceb79fef03 28 *
kevman 0:38ceb79fef03 29 * @param size Size of the memory to allocate in bytes
kevman 0:38ceb79fef03 30 * @param align Memory alignment requirement in bytes
kevman 0:38ceb79fef03 31 * @return Allocated memory buffer, or NULL in case of error
kevman 0:38ceb79fef03 32 */
kevman 0:38ceb79fef03 33 virtual emac_mem_buf_t *alloc_heap(uint32_t size, uint32_t align);
kevman 0:38ceb79fef03 34
kevman 0:38ceb79fef03 35 /**
kevman 0:38ceb79fef03 36 * Allocates memory buffer chain from a pool
kevman 0:38ceb79fef03 37 *
kevman 0:38ceb79fef03 38 * Memory allocated from pool is contiguous if size is equal or less than
kevman 0:38ceb79fef03 39 * (aligned) allocation unit, otherwise may be chained. Will typically come from
kevman 0:38ceb79fef03 40 * fixed-size packet pool memory.
kevman 0:38ceb79fef03 41 *
kevman 0:38ceb79fef03 42 * @param size Total size of the memory to allocate in bytes
kevman 0:38ceb79fef03 43 * @param align Memory alignment requirement for each buffer in bytes
kevman 0:38ceb79fef03 44 * @return Allocated memory buffer chain, or NULL in case of error
kevman 0:38ceb79fef03 45 */
kevman 0:38ceb79fef03 46 virtual emac_mem_buf_t *alloc_pool(uint32_t size, uint32_t align);
kevman 0:38ceb79fef03 47
kevman 0:38ceb79fef03 48 /**
kevman 0:38ceb79fef03 49 * Get memory buffer pool allocation unit
kevman 0:38ceb79fef03 50 *
kevman 0:38ceb79fef03 51 * Returns the maximum size of contiguous memory that can be allocated from a pool.
kevman 0:38ceb79fef03 52 *
kevman 0:38ceb79fef03 53 * @param align Memory alignment requirement in bytes
kevman 0:38ceb79fef03 54 * @return Contiguous memory size
kevman 0:38ceb79fef03 55 */
kevman 0:38ceb79fef03 56 virtual uint32_t get_pool_alloc_unit(uint32_t align) const;
kevman 0:38ceb79fef03 57
kevman 0:38ceb79fef03 58 /**
kevman 0:38ceb79fef03 59 * Free memory buffer chain
kevman 0:38ceb79fef03 60 *
kevman 0:38ceb79fef03 61 * If memory buffer is chained must point to the start of the chain. Frees all buffers
kevman 0:38ceb79fef03 62 * from the chained list.
kevman 0:38ceb79fef03 63 *
kevman 0:38ceb79fef03 64 * @param buf Memory buffer chain to be freed.
kevman 0:38ceb79fef03 65 */
kevman 0:38ceb79fef03 66 virtual void free(emac_mem_buf_t *buf);
kevman 0:38ceb79fef03 67
kevman 0:38ceb79fef03 68 /**
kevman 0:38ceb79fef03 69 * Return total length of a memory buffer chain
kevman 0:38ceb79fef03 70 *
kevman 0:38ceb79fef03 71 * Returns a total length of this buffer and any following buffers in the chain.
kevman 0:38ceb79fef03 72 *
kevman 0:38ceb79fef03 73 * @param buf Memory buffer chain
kevman 0:38ceb79fef03 74 * @return Total length in bytes
kevman 0:38ceb79fef03 75 */
kevman 0:38ceb79fef03 76 virtual uint32_t get_total_len(const emac_mem_buf_t *buf) const;
kevman 0:38ceb79fef03 77
kevman 0:38ceb79fef03 78 /**
kevman 0:38ceb79fef03 79 * Copy a memory buffer chain
kevman 0:38ceb79fef03 80 *
kevman 0:38ceb79fef03 81 * Copies data from one buffer chain to another. Copy operation does not adjust the lengths
kevman 0:38ceb79fef03 82 * of the copied-to memory buffer chain, so chain total lengths must be the same.
kevman 0:38ceb79fef03 83 *
kevman 0:38ceb79fef03 84 * @param to_buf Memory buffer chain to copy to
kevman 0:38ceb79fef03 85 * @param from_buf Memory buffer chain to copy from
kevman 0:38ceb79fef03 86 */
kevman 0:38ceb79fef03 87 virtual void copy(emac_mem_buf_t *to_buf, const emac_mem_buf_t *from_buf);
kevman 0:38ceb79fef03 88
kevman 0:38ceb79fef03 89 /**
kevman 0:38ceb79fef03 90 * Copy to a memory buffer chain
kevman 0:38ceb79fef03 91 *
kevman 0:38ceb79fef03 92 * Copies data to a buffer chain. Copy operation does not adjust the lengths
kevman 0:38ceb79fef03 93 * of the copied-to memory buffer chain, so chain total length must match the
kevman 0:38ceb79fef03 94 * copied length.
kevman 0:38ceb79fef03 95 *
kevman 0:38ceb79fef03 96 * @param to_buf Memory buffer chain to copy to
kevman 0:38ceb79fef03 97 * @param ptr Pointer to data
kevman 0:38ceb79fef03 98 * @param len Data length
kevman 0:38ceb79fef03 99 */
kevman 0:38ceb79fef03 100 virtual void copy_to_buf(emac_mem_buf_t *to_buf, const void *ptr, uint32_t len);
kevman 0:38ceb79fef03 101
kevman 0:38ceb79fef03 102 /**
kevman 0:38ceb79fef03 103 * Copy from a memory buffer chain
kevman 0:38ceb79fef03 104 *
kevman 0:38ceb79fef03 105 * Copies data from a memory buffer chain.
kevman 0:38ceb79fef03 106 *
kevman 0:38ceb79fef03 107 * @param len Data length
kevman 0:38ceb79fef03 108 * @param ptr Pointer to data
kevman 0:38ceb79fef03 109 * @param from_buf Memory buffer chain to copy from
kevman 0:38ceb79fef03 110 * @return Length of the data that was copied
kevman 0:38ceb79fef03 111 */
kevman 0:38ceb79fef03 112 virtual uint32_t copy_from_buf(void *ptr, uint32_t len, const emac_mem_buf_t *from_buf) const;
kevman 0:38ceb79fef03 113
kevman 0:38ceb79fef03 114 /**
kevman 0:38ceb79fef03 115 * Concatenate two memory buffer chains
kevman 0:38ceb79fef03 116 *
kevman 0:38ceb79fef03 117 * Concatenates buffer chain to end of the other buffer chain. Concatenated-to buffer total length
kevman 0:38ceb79fef03 118 * is adjusted accordingly. cat_buf must point to the start of a the chain. After concatenation
kevman 0:38ceb79fef03 119 * to_buf's chain now owns those buffers, and they will be freed when the to_buf chain is freed.
kevman 0:38ceb79fef03 120 *
kevman 0:38ceb79fef03 121 * @param to_buf Memory buffer chain to concatenate to
kevman 0:38ceb79fef03 122 * @param cat_buf Memory buffer chain to concatenate
kevman 0:38ceb79fef03 123 */
kevman 0:38ceb79fef03 124 virtual void cat(emac_mem_buf_t *to_buf, emac_mem_buf_t *cat_buf);
kevman 0:38ceb79fef03 125
kevman 0:38ceb79fef03 126 /**
kevman 0:38ceb79fef03 127 * Returns the next buffer
kevman 0:38ceb79fef03 128 *
kevman 0:38ceb79fef03 129 * Returns the next buffer from the memory buffer chain.
kevman 0:38ceb79fef03 130 *
kevman 0:38ceb79fef03 131 * @param buf Memory buffer
kevman 0:38ceb79fef03 132 * @return The next memory buffer, or NULL if last
kevman 0:38ceb79fef03 133 */
kevman 0:38ceb79fef03 134 virtual emac_mem_buf_t *get_next(const emac_mem_buf_t *buf) const;
kevman 0:38ceb79fef03 135
kevman 0:38ceb79fef03 136 /**
kevman 0:38ceb79fef03 137 * Return pointer to the payload of the buffer
kevman 0:38ceb79fef03 138 *
kevman 0:38ceb79fef03 139 * @param buf Memory buffer
kevman 0:38ceb79fef03 140 * @return Pointer to the payload
kevman 0:38ceb79fef03 141 */
kevman 0:38ceb79fef03 142 virtual void *get_ptr(const emac_mem_buf_t *buf) const;
kevman 0:38ceb79fef03 143
kevman 0:38ceb79fef03 144 /**
kevman 0:38ceb79fef03 145 * Return payload size of the buffer
kevman 0:38ceb79fef03 146 *
kevman 0:38ceb79fef03 147 * @param buf Memory buffer
kevman 0:38ceb79fef03 148 * @return Size in bytes
kevman 0:38ceb79fef03 149 */
kevman 0:38ceb79fef03 150 virtual uint32_t get_len(const emac_mem_buf_t *buf) const;
kevman 0:38ceb79fef03 151
kevman 0:38ceb79fef03 152 /**
kevman 0:38ceb79fef03 153 * Sets the payload size of the buffer
kevman 0:38ceb79fef03 154 *
kevman 0:38ceb79fef03 155 * The allocated payload size will not change. It is not permitted
kevman 0:38ceb79fef03 156 * to change the length of a buffer that is not the first (or only) in a chain.
kevman 0:38ceb79fef03 157 *
kevman 0:38ceb79fef03 158 * @param buf Memory buffer
kevman 0:38ceb79fef03 159 * @param len Payload size, must be less or equal allocated size
kevman 0:38ceb79fef03 160 */
kevman 0:38ceb79fef03 161 virtual void set_len(emac_mem_buf_t *buf, uint32_t len);
kevman 0:38ceb79fef03 162
kevman 0:38ceb79fef03 163 private:
kevman 0:38ceb79fef03 164
kevman 0:38ceb79fef03 165 /**
kevman 0:38ceb79fef03 166 * Returns a total memory alignment size
kevman 0:38ceb79fef03 167 *
kevman 0:38ceb79fef03 168 * Calculates the total memory alignment size for a memory buffer chain.
kevman 0:38ceb79fef03 169 * Used internally on pool allocation.
kevman 0:38ceb79fef03 170 *
kevman 0:38ceb79fef03 171 * @param size Size of the memory to allocate in bytes
kevman 0:38ceb79fef03 172 * @param align Memory alignment requirement for each buffer in bytes
kevman 0:38ceb79fef03 173 * @return Total alignment needed in bytes
kevman 0:38ceb79fef03 174 */
kevman 0:38ceb79fef03 175 uint32_t count_total_align(uint32_t size, uint32_t align);
kevman 0:38ceb79fef03 176
kevman 0:38ceb79fef03 177 /**
kevman 0:38ceb79fef03 178 * Aligns a memory buffer chain
kevman 0:38ceb79fef03 179 *
kevman 0:38ceb79fef03 180 * Aligns a memory buffer chain and updates lengths and total lengths
kevman 0:38ceb79fef03 181 * accordingly. There needs to be enough overhead to do the alignment
kevman 0:38ceb79fef03 182 * for all buffers.
kevman 0:38ceb79fef03 183 *
kevman 0:38ceb79fef03 184 * @param pbuf Memory buffer
kevman 0:38ceb79fef03 185 * @param align Memory alignment requirement for each buffer in bytes
kevman 0:38ceb79fef03 186 */
kevman 0:38ceb79fef03 187 void align_memory(struct pbuf *pbuf, uint32_t align);
kevman 0:38ceb79fef03 188
kevman 0:38ceb79fef03 189 /**
kevman 0:38ceb79fef03 190 * Sets total lengths of a memory buffer chain
kevman 0:38ceb79fef03 191 *
kevman 0:38ceb79fef03 192 * Sets total length fields for a memory buffer chain based on buffer
kevman 0:38ceb79fef03 193 * length fields. All total lengths are calculated again.
kevman 0:38ceb79fef03 194 *
kevman 0:38ceb79fef03 195 * @param pbuf Memory buffer
kevman 0:38ceb79fef03 196 */
kevman 0:38ceb79fef03 197 void set_total_len(struct pbuf *pbuf);
kevman 0:38ceb79fef03 198 };
kevman 0:38ceb79fef03 199
kevman 0:38ceb79fef03 200 #endif /* LWIP_MEMORY_MANAGER_H */