Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

rtos/MemoryPool.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /* mbed Microcontroller Library
kenjiArai 1:9db0e321a9f4 2 * Copyright (c) 2006-2019 ARM Limited
kenjiArai 0:5b88d5760320 3 *
kenjiArai 0:5b88d5760320 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
kenjiArai 0:5b88d5760320 5 * of this software and associated documentation files (the "Software"), to deal
kenjiArai 0:5b88d5760320 6 * in the Software without restriction, including without limitation the rights
kenjiArai 0:5b88d5760320 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
kenjiArai 0:5b88d5760320 8 * copies of the Software, and to permit persons to whom the Software is
kenjiArai 0:5b88d5760320 9 * furnished to do so, subject to the following conditions:
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * The above copyright notice and this permission notice shall be included in
kenjiArai 0:5b88d5760320 12 * all copies or substantial portions of the Software.
kenjiArai 0:5b88d5760320 13 *
kenjiArai 0:5b88d5760320 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
kenjiArai 0:5b88d5760320 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
kenjiArai 0:5b88d5760320 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
kenjiArai 0:5b88d5760320 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
kenjiArai 0:5b88d5760320 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
kenjiArai 0:5b88d5760320 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
kenjiArai 0:5b88d5760320 20 * SOFTWARE.
kenjiArai 0:5b88d5760320 21 */
kenjiArai 0:5b88d5760320 22 #ifndef MEMORYPOOL_H
kenjiArai 0:5b88d5760320 23 #define MEMORYPOOL_H
kenjiArai 0:5b88d5760320 24
kenjiArai 0:5b88d5760320 25 #include <stdint.h>
kenjiArai 0:5b88d5760320 26 #include <string.h>
kenjiArai 0:5b88d5760320 27
kenjiArai 1:9db0e321a9f4 28 #include "rtos/mbed_rtos_types.h"
kenjiArai 1:9db0e321a9f4 29 #include "rtos/mbed_rtos1_types.h"
kenjiArai 1:9db0e321a9f4 30 #include "rtos/mbed_rtos_storage.h"
kenjiArai 0:5b88d5760320 31 #include "platform/NonCopyable.h"
kenjiArai 1:9db0e321a9f4 32 #include "platform/mbed_assert.h"
kenjiArai 1:9db0e321a9f4 33 #include "Kernel.h"
kenjiArai 0:5b88d5760320 34
kenjiArai 1:9db0e321a9f4 35
kenjiArai 1:9db0e321a9f4 36 #if MBED_CONF_RTOS_PRESENT || defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 37 namespace rtos {
kenjiArai 1:9db0e321a9f4 38 /** \addtogroup rtos-public-api */
kenjiArai 0:5b88d5760320 39 /** @{*/
kenjiArai 1:9db0e321a9f4 40
kenjiArai 0:5b88d5760320 41 /**
kenjiArai 0:5b88d5760320 42 * \defgroup rtos_MemoryPool MemoryPool class
kenjiArai 0:5b88d5760320 43 * @{
kenjiArai 0:5b88d5760320 44 */
kenjiArai 0:5b88d5760320 45
kenjiArai 0:5b88d5760320 46 /** Define and manage fixed-size memory pools of objects of a given type.
kenjiArai 0:5b88d5760320 47 @tparam T data type of a single object (element).
kenjiArai 0:5b88d5760320 48 @tparam queue_sz maximum number of objects (elements) in the memory pool.
kenjiArai 0:5b88d5760320 49
kenjiArai 0:5b88d5760320 50 @note
kenjiArai 0:5b88d5760320 51 Memory considerations: The memory pool data store and control structures will be created on current thread's stack,
kenjiArai 0:5b88d5760320 52 both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
kenjiArai 0:5b88d5760320 53 */
kenjiArai 0:5b88d5760320 54 template<typename T, uint32_t pool_sz>
kenjiArai 0:5b88d5760320 55 class MemoryPool : private mbed::NonCopyable<MemoryPool<T, pool_sz> > {
kenjiArai 0:5b88d5760320 56 MBED_STATIC_ASSERT(pool_sz > 0, "Invalid memory pool size. Must be greater than 0.");
kenjiArai 0:5b88d5760320 57 public:
kenjiArai 0:5b88d5760320 58 /** Create and Initialize a memory pool.
kenjiArai 0:5b88d5760320 59 *
kenjiArai 0:5b88d5760320 60 * @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 61 */
kenjiArai 0:5b88d5760320 62 MemoryPool()
kenjiArai 0:5b88d5760320 63 {
kenjiArai 0:5b88d5760320 64 memset(_pool_mem, 0, sizeof(_pool_mem));
kenjiArai 0:5b88d5760320 65 osMemoryPoolAttr_t attr = { 0 };
kenjiArai 0:5b88d5760320 66 attr.mp_mem = _pool_mem;
kenjiArai 0:5b88d5760320 67 attr.mp_size = sizeof(_pool_mem);
kenjiArai 0:5b88d5760320 68 attr.cb_mem = &_obj_mem;
kenjiArai 0:5b88d5760320 69 attr.cb_size = sizeof(_obj_mem);
kenjiArai 0:5b88d5760320 70 _id = osMemoryPoolNew(pool_sz, sizeof(T), &attr);
kenjiArai 0:5b88d5760320 71 MBED_ASSERT(_id);
kenjiArai 0:5b88d5760320 72 }
kenjiArai 0:5b88d5760320 73
kenjiArai 0:5b88d5760320 74 /** Destroy a memory pool
kenjiArai 0:5b88d5760320 75 *
kenjiArai 0:5b88d5760320 76 * @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 77 */
kenjiArai 0:5b88d5760320 78 ~MemoryPool()
kenjiArai 0:5b88d5760320 79 {
kenjiArai 0:5b88d5760320 80 osMemoryPoolDelete(_id);
kenjiArai 0:5b88d5760320 81 }
kenjiArai 0:5b88d5760320 82
kenjiArai 0:5b88d5760320 83 /** Allocate a memory block from a memory pool, without blocking.
kenjiArai 1:9db0e321a9f4 84 @return address of the allocated memory block or nullptr in case of no memory available.
kenjiArai 0:5b88d5760320 85
kenjiArai 0:5b88d5760320 86 @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 87 */
kenjiArai 0:5b88d5760320 88 T *alloc(void)
kenjiArai 0:5b88d5760320 89 {
kenjiArai 0:5b88d5760320 90 return (T *)osMemoryPoolAlloc(_id, 0);
kenjiArai 0:5b88d5760320 91 }
kenjiArai 0:5b88d5760320 92
kenjiArai 0:5b88d5760320 93 /** Allocate a memory block from a memory pool, optionally blocking.
kenjiArai 0:5b88d5760320 94 @param millisec timeout value (osWaitForever to wait forever)
kenjiArai 1:9db0e321a9f4 95 @return address of the allocated memory block or nullptr in case of no memory available.
kenjiArai 0:5b88d5760320 96
kenjiArai 0:5b88d5760320 97 @note You may call this function from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 98 */
kenjiArai 0:5b88d5760320 99 T *alloc_for(uint32_t millisec)
kenjiArai 0:5b88d5760320 100 {
kenjiArai 0:5b88d5760320 101 return (T *)osMemoryPoolAlloc(_id, millisec);
kenjiArai 0:5b88d5760320 102 }
kenjiArai 0:5b88d5760320 103
kenjiArai 0:5b88d5760320 104 /** Allocate a memory block from a memory pool, blocking.
kenjiArai 0:5b88d5760320 105 @param millisec absolute timeout time, referenced to Kernel::get_ms_count().
kenjiArai 1:9db0e321a9f4 106 @return address of the allocated memory block or nullptr in case of no memory available.
kenjiArai 0:5b88d5760320 107
kenjiArai 0:5b88d5760320 108 @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 109 @note the underlying RTOS may have a limit to the maximum wait time
kenjiArai 0:5b88d5760320 110 due to internal 32-bit computations, but this is guaranteed to work if the
kenjiArai 0:5b88d5760320 111 wait is <= 0x7fffffff milliseconds (~24 days). If the limit is exceeded,
kenjiArai 0:5b88d5760320 112 the wait will time out earlier than specified.
kenjiArai 0:5b88d5760320 113 */
kenjiArai 0:5b88d5760320 114 T *alloc_until(uint64_t millisec)
kenjiArai 0:5b88d5760320 115 {
kenjiArai 0:5b88d5760320 116 uint64_t now = Kernel::get_ms_count();
kenjiArai 0:5b88d5760320 117 uint32_t delay;
kenjiArai 0:5b88d5760320 118 if (now >= millisec) {
kenjiArai 0:5b88d5760320 119 delay = 0;
kenjiArai 0:5b88d5760320 120 } else if (millisec - now >= osWaitForever) {
kenjiArai 0:5b88d5760320 121 delay = osWaitForever - 1;
kenjiArai 0:5b88d5760320 122 } else {
kenjiArai 0:5b88d5760320 123 delay = millisec - now;
kenjiArai 0:5b88d5760320 124 }
kenjiArai 0:5b88d5760320 125 return alloc_for(delay);
kenjiArai 0:5b88d5760320 126 }
kenjiArai 0:5b88d5760320 127
kenjiArai 0:5b88d5760320 128 /** Allocate a memory block from a memory pool, without blocking, and set memory block to zero.
kenjiArai 1:9db0e321a9f4 129 @return address of the allocated memory block or nullptr in case of no memory available.
kenjiArai 0:5b88d5760320 130
kenjiArai 0:5b88d5760320 131 @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 132 */
kenjiArai 0:5b88d5760320 133 T *calloc(void)
kenjiArai 0:5b88d5760320 134 {
kenjiArai 0:5b88d5760320 135 T *item = alloc();
kenjiArai 1:9db0e321a9f4 136 if (item != nullptr) {
kenjiArai 0:5b88d5760320 137 memset(item, 0, sizeof(T));
kenjiArai 0:5b88d5760320 138 }
kenjiArai 0:5b88d5760320 139 return item;
kenjiArai 0:5b88d5760320 140 }
kenjiArai 0:5b88d5760320 141
kenjiArai 0:5b88d5760320 142 /** Allocate a memory block from a memory pool, optionally blocking, and set memory block to zero.
kenjiArai 0:5b88d5760320 143 @param millisec timeout value (osWaitForever to wait forever)
kenjiArai 1:9db0e321a9f4 144 @return address of the allocated memory block or nullptr in case of no memory available.
kenjiArai 0:5b88d5760320 145
kenjiArai 0:5b88d5760320 146 @note You may call this function from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 147 */
kenjiArai 0:5b88d5760320 148 T *calloc_for(uint32_t millisec)
kenjiArai 0:5b88d5760320 149 {
kenjiArai 0:5b88d5760320 150 T *item = alloc_for(millisec);
kenjiArai 1:9db0e321a9f4 151 if (item != nullptr) {
kenjiArai 0:5b88d5760320 152 memset(item, 0, sizeof(T));
kenjiArai 0:5b88d5760320 153 }
kenjiArai 0:5b88d5760320 154 return item;
kenjiArai 0:5b88d5760320 155 }
kenjiArai 0:5b88d5760320 156
kenjiArai 0:5b88d5760320 157 /** Allocate a memory block from a memory pool, blocking, and set memory block to zero.
kenjiArai 0:5b88d5760320 158 @param millisec absolute timeout time, referenced to Kernel::get_ms_count().
kenjiArai 1:9db0e321a9f4 159 @return address of the allocated memory block or nullptr in case of no memory available.
kenjiArai 0:5b88d5760320 160
kenjiArai 0:5b88d5760320 161 @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 162 @note the underlying RTOS may have a limit to the maximum wait time
kenjiArai 0:5b88d5760320 163 due to internal 32-bit computations, but this is guaranteed to work if the
kenjiArai 0:5b88d5760320 164 wait is <= 0x7fffffff milliseconds (~24 days). If the limit is exceeded,
kenjiArai 0:5b88d5760320 165 the wait will time out earlier than specified.
kenjiArai 0:5b88d5760320 166 */
kenjiArai 0:5b88d5760320 167 T *calloc_until(uint64_t millisec)
kenjiArai 0:5b88d5760320 168 {
kenjiArai 0:5b88d5760320 169 T *item = alloc_until(millisec);
kenjiArai 1:9db0e321a9f4 170 if (item != nullptr) {
kenjiArai 0:5b88d5760320 171 memset(item, 0, sizeof(T));
kenjiArai 0:5b88d5760320 172 }
kenjiArai 0:5b88d5760320 173 return item;
kenjiArai 0:5b88d5760320 174 }
kenjiArai 0:5b88d5760320 175
kenjiArai 0:5b88d5760320 176 /** Free a memory block.
kenjiArai 0:5b88d5760320 177 @param block address of the allocated memory block to be freed.
kenjiArai 0:5b88d5760320 178 @return osOK on successful deallocation, osErrorParameter if given memory block id
kenjiArai 1:9db0e321a9f4 179 is nullptr or invalid, or osErrorResource if given memory block is in an
kenjiArai 0:5b88d5760320 180 invalid memory pool state.
kenjiArai 0:5b88d5760320 181
kenjiArai 0:5b88d5760320 182 @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 183 */
kenjiArai 0:5b88d5760320 184 osStatus free(T *block)
kenjiArai 0:5b88d5760320 185 {
kenjiArai 0:5b88d5760320 186 return osMemoryPoolFree(_id, block);
kenjiArai 0:5b88d5760320 187 }
kenjiArai 0:5b88d5760320 188
kenjiArai 0:5b88d5760320 189 private:
kenjiArai 0:5b88d5760320 190 osMemoryPoolId_t _id;
kenjiArai 0:5b88d5760320 191 char _pool_mem[MBED_RTOS_STORAGE_MEM_POOL_MEM_SIZE(pool_sz, sizeof(T))];
kenjiArai 0:5b88d5760320 192 mbed_rtos_storage_mem_pool_t _obj_mem;
kenjiArai 0:5b88d5760320 193 };
kenjiArai 0:5b88d5760320 194 /** @}*/
kenjiArai 0:5b88d5760320 195 /** @}*/
kenjiArai 0:5b88d5760320 196 }
kenjiArai 0:5b88d5760320 197 #endif
kenjiArai 1:9db0e321a9f4 198 #endif