Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

rtos/MemoryPool.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /* mbed Microcontroller Library
kenjiArai 0:5b88d5760320 2 * Copyright (c) 2006-2012 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 0:5b88d5760320 28 #include "cmsis_os2.h"
kenjiArai 0:5b88d5760320 29 #include "mbed_rtos1_types.h"
kenjiArai 0:5b88d5760320 30 #include "mbed_rtos_storage.h"
kenjiArai 0:5b88d5760320 31 #include "platform/NonCopyable.h"
kenjiArai 0:5b88d5760320 32
kenjiArai 0:5b88d5760320 33 namespace rtos {
kenjiArai 0:5b88d5760320 34 /** \addtogroup rtos */
kenjiArai 0:5b88d5760320 35 /** @{*/
kenjiArai 0:5b88d5760320 36 /**
kenjiArai 0:5b88d5760320 37 * \defgroup rtos_MemoryPool MemoryPool class
kenjiArai 0:5b88d5760320 38 * @{
kenjiArai 0:5b88d5760320 39 */
kenjiArai 0:5b88d5760320 40
kenjiArai 0:5b88d5760320 41 /** Define and manage fixed-size memory pools of objects of a given type.
kenjiArai 0:5b88d5760320 42 @tparam T data type of a single object (element).
kenjiArai 0:5b88d5760320 43 @tparam queue_sz maximum number of objects (elements) in the memory pool.
kenjiArai 0:5b88d5760320 44
kenjiArai 0:5b88d5760320 45 @note
kenjiArai 0:5b88d5760320 46 Memory considerations: The memory pool data store and control structures will be created on current thread's stack,
kenjiArai 0:5b88d5760320 47 both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
kenjiArai 0:5b88d5760320 48 */
kenjiArai 0:5b88d5760320 49 template<typename T, uint32_t pool_sz>
kenjiArai 0:5b88d5760320 50 class MemoryPool : private mbed::NonCopyable<MemoryPool<T, pool_sz> > {
kenjiArai 0:5b88d5760320 51 MBED_STATIC_ASSERT(pool_sz > 0, "Invalid memory pool size. Must be greater than 0.");
kenjiArai 0:5b88d5760320 52 public:
kenjiArai 0:5b88d5760320 53 /** Create and Initialize a memory pool.
kenjiArai 0:5b88d5760320 54 *
kenjiArai 0:5b88d5760320 55 * @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 56 */
kenjiArai 0:5b88d5760320 57 MemoryPool()
kenjiArai 0:5b88d5760320 58 {
kenjiArai 0:5b88d5760320 59 memset(_pool_mem, 0, sizeof(_pool_mem));
kenjiArai 0:5b88d5760320 60 osMemoryPoolAttr_t attr = { 0 };
kenjiArai 0:5b88d5760320 61 attr.mp_mem = _pool_mem;
kenjiArai 0:5b88d5760320 62 attr.mp_size = sizeof(_pool_mem);
kenjiArai 0:5b88d5760320 63 attr.cb_mem = &_obj_mem;
kenjiArai 0:5b88d5760320 64 attr.cb_size = sizeof(_obj_mem);
kenjiArai 0:5b88d5760320 65 _id = osMemoryPoolNew(pool_sz, sizeof(T), &attr);
kenjiArai 0:5b88d5760320 66 MBED_ASSERT(_id);
kenjiArai 0:5b88d5760320 67 }
kenjiArai 0:5b88d5760320 68
kenjiArai 0:5b88d5760320 69 /** Destroy a memory pool
kenjiArai 0:5b88d5760320 70 *
kenjiArai 0:5b88d5760320 71 * @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 72 */
kenjiArai 0:5b88d5760320 73 ~MemoryPool()
kenjiArai 0:5b88d5760320 74 {
kenjiArai 0:5b88d5760320 75 osMemoryPoolDelete(_id);
kenjiArai 0:5b88d5760320 76 }
kenjiArai 0:5b88d5760320 77
kenjiArai 0:5b88d5760320 78 /** Allocate a memory block from a memory pool, without blocking.
kenjiArai 0:5b88d5760320 79 @return address of the allocated memory block or NULL in case of no memory available.
kenjiArai 0:5b88d5760320 80
kenjiArai 0:5b88d5760320 81 @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 82 */
kenjiArai 0:5b88d5760320 83 T *alloc(void)
kenjiArai 0:5b88d5760320 84 {
kenjiArai 0:5b88d5760320 85 return (T *)osMemoryPoolAlloc(_id, 0);
kenjiArai 0:5b88d5760320 86 }
kenjiArai 0:5b88d5760320 87
kenjiArai 0:5b88d5760320 88 /** Allocate a memory block from a memory pool, optionally blocking.
kenjiArai 0:5b88d5760320 89 @param millisec timeout value (osWaitForever to wait forever)
kenjiArai 0:5b88d5760320 90 @return address of the allocated memory block or NULL in case of no memory available.
kenjiArai 0:5b88d5760320 91
kenjiArai 0:5b88d5760320 92 @note You may call this function from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 93 */
kenjiArai 0:5b88d5760320 94 T *alloc_for(uint32_t millisec)
kenjiArai 0:5b88d5760320 95 {
kenjiArai 0:5b88d5760320 96 return (T *)osMemoryPoolAlloc(_id, millisec);
kenjiArai 0:5b88d5760320 97 }
kenjiArai 0:5b88d5760320 98
kenjiArai 0:5b88d5760320 99 /** Allocate a memory block from a memory pool, blocking.
kenjiArai 0:5b88d5760320 100 @param millisec absolute timeout time, referenced to Kernel::get_ms_count().
kenjiArai 0:5b88d5760320 101 @return address of the allocated memory block or NULL in case of no memory available.
kenjiArai 0:5b88d5760320 102
kenjiArai 0:5b88d5760320 103 @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 104 @note the underlying RTOS may have a limit to the maximum wait time
kenjiArai 0:5b88d5760320 105 due to internal 32-bit computations, but this is guaranteed to work if the
kenjiArai 0:5b88d5760320 106 wait is <= 0x7fffffff milliseconds (~24 days). If the limit is exceeded,
kenjiArai 0:5b88d5760320 107 the wait will time out earlier than specified.
kenjiArai 0:5b88d5760320 108 */
kenjiArai 0:5b88d5760320 109 T *alloc_until(uint64_t millisec)
kenjiArai 0:5b88d5760320 110 {
kenjiArai 0:5b88d5760320 111 uint64_t now = Kernel::get_ms_count();
kenjiArai 0:5b88d5760320 112 uint32_t delay;
kenjiArai 0:5b88d5760320 113 if (now >= millisec) {
kenjiArai 0:5b88d5760320 114 delay = 0;
kenjiArai 0:5b88d5760320 115 } else if (millisec - now >= osWaitForever) {
kenjiArai 0:5b88d5760320 116 delay = osWaitForever - 1;
kenjiArai 0:5b88d5760320 117 } else {
kenjiArai 0:5b88d5760320 118 delay = millisec - now;
kenjiArai 0:5b88d5760320 119 }
kenjiArai 0:5b88d5760320 120 return alloc_for(delay);
kenjiArai 0:5b88d5760320 121 }
kenjiArai 0:5b88d5760320 122
kenjiArai 0:5b88d5760320 123 /** Allocate a memory block from a memory pool, without blocking, and set memory block to zero.
kenjiArai 0:5b88d5760320 124 @return address of the allocated memory block or NULL in case of no memory available.
kenjiArai 0:5b88d5760320 125
kenjiArai 0:5b88d5760320 126 @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 127 */
kenjiArai 0:5b88d5760320 128 T *calloc(void)
kenjiArai 0:5b88d5760320 129 {
kenjiArai 0:5b88d5760320 130 T *item = alloc();
kenjiArai 0:5b88d5760320 131 if (item != NULL) {
kenjiArai 0:5b88d5760320 132 memset(item, 0, sizeof(T));
kenjiArai 0:5b88d5760320 133 }
kenjiArai 0:5b88d5760320 134 return item;
kenjiArai 0:5b88d5760320 135 }
kenjiArai 0:5b88d5760320 136
kenjiArai 0:5b88d5760320 137 /** Allocate a memory block from a memory pool, optionally blocking, and set memory block to zero.
kenjiArai 0:5b88d5760320 138 @param millisec timeout value (osWaitForever to wait forever)
kenjiArai 0:5b88d5760320 139 @return address of the allocated memory block or NULL in case of no memory available.
kenjiArai 0:5b88d5760320 140
kenjiArai 0:5b88d5760320 141 @note You may call this function from ISR context if the millisec parameter is set to 0.
kenjiArai 0:5b88d5760320 142 */
kenjiArai 0:5b88d5760320 143 T *calloc_for(uint32_t millisec)
kenjiArai 0:5b88d5760320 144 {
kenjiArai 0:5b88d5760320 145 T *item = alloc_for(millisec);
kenjiArai 0:5b88d5760320 146 if (item != NULL) {
kenjiArai 0:5b88d5760320 147 memset(item, 0, sizeof(T));
kenjiArai 0:5b88d5760320 148 }
kenjiArai 0:5b88d5760320 149 return item;
kenjiArai 0:5b88d5760320 150 }
kenjiArai 0:5b88d5760320 151
kenjiArai 0:5b88d5760320 152 /** Allocate a memory block from a memory pool, blocking, and set memory block to zero.
kenjiArai 0:5b88d5760320 153 @param millisec absolute timeout time, referenced to Kernel::get_ms_count().
kenjiArai 0:5b88d5760320 154 @return address of the allocated memory block or NULL in case of no memory available.
kenjiArai 0:5b88d5760320 155
kenjiArai 0:5b88d5760320 156 @note You cannot call this function from ISR context.
kenjiArai 0:5b88d5760320 157 @note the underlying RTOS may have a limit to the maximum wait time
kenjiArai 0:5b88d5760320 158 due to internal 32-bit computations, but this is guaranteed to work if the
kenjiArai 0:5b88d5760320 159 wait is <= 0x7fffffff milliseconds (~24 days). If the limit is exceeded,
kenjiArai 0:5b88d5760320 160 the wait will time out earlier than specified.
kenjiArai 0:5b88d5760320 161 */
kenjiArai 0:5b88d5760320 162 T *calloc_until(uint64_t millisec)
kenjiArai 0:5b88d5760320 163 {
kenjiArai 0:5b88d5760320 164 T *item = alloc_until(millisec);
kenjiArai 0:5b88d5760320 165 if (item != NULL) {
kenjiArai 0:5b88d5760320 166 memset(item, 0, sizeof(T));
kenjiArai 0:5b88d5760320 167 }
kenjiArai 0:5b88d5760320 168 return item;
kenjiArai 0:5b88d5760320 169 }
kenjiArai 0:5b88d5760320 170
kenjiArai 0:5b88d5760320 171 /** Free a memory block.
kenjiArai 0:5b88d5760320 172 @param block address of the allocated memory block to be freed.
kenjiArai 0:5b88d5760320 173 @return osOK on successful deallocation, osErrorParameter if given memory block id
kenjiArai 0:5b88d5760320 174 is NULL or invalid, or osErrorResource if given memory block is in an
kenjiArai 0:5b88d5760320 175 invalid memory pool state.
kenjiArai 0:5b88d5760320 176
kenjiArai 0:5b88d5760320 177 @note You may call this function from ISR context.
kenjiArai 0:5b88d5760320 178 */
kenjiArai 0:5b88d5760320 179 osStatus free(T *block)
kenjiArai 0:5b88d5760320 180 {
kenjiArai 0:5b88d5760320 181 return osMemoryPoolFree(_id, block);
kenjiArai 0:5b88d5760320 182 }
kenjiArai 0:5b88d5760320 183
kenjiArai 0:5b88d5760320 184 private:
kenjiArai 0:5b88d5760320 185 osMemoryPoolId_t _id;
kenjiArai 0:5b88d5760320 186 char _pool_mem[MBED_RTOS_STORAGE_MEM_POOL_MEM_SIZE(pool_sz, sizeof(T))];
kenjiArai 0:5b88d5760320 187 mbed_rtos_storage_mem_pool_t _obj_mem;
kenjiArai 0:5b88d5760320 188 };
kenjiArai 0:5b88d5760320 189 /** @}*/
kenjiArai 0:5b88d5760320 190 /** @}*/
kenjiArai 0:5b88d5760320 191
kenjiArai 0:5b88d5760320 192 }
kenjiArai 0:5b88d5760320 193 #endif