Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/rtos/MemoryPool.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

UserRevisionLine numberNew contents of line
valeyev 0:e056ac8fecf8 1 /* mbed Microcontroller Library
valeyev 0:e056ac8fecf8 2 * Copyright (c) 2006-2012 ARM Limited
valeyev 0:e056ac8fecf8 3 *
valeyev 0:e056ac8fecf8 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
valeyev 0:e056ac8fecf8 5 * of this software and associated documentation files (the "Software"), to deal
valeyev 0:e056ac8fecf8 6 * in the Software without restriction, including without limitation the rights
valeyev 0:e056ac8fecf8 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
valeyev 0:e056ac8fecf8 8 * copies of the Software, and to permit persons to whom the Software is
valeyev 0:e056ac8fecf8 9 * furnished to do so, subject to the following conditions:
valeyev 0:e056ac8fecf8 10 *
valeyev 0:e056ac8fecf8 11 * The above copyright notice and this permission notice shall be included in
valeyev 0:e056ac8fecf8 12 * all copies or substantial portions of the Software.
valeyev 0:e056ac8fecf8 13 *
valeyev 0:e056ac8fecf8 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
valeyev 0:e056ac8fecf8 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
valeyev 0:e056ac8fecf8 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
valeyev 0:e056ac8fecf8 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
valeyev 0:e056ac8fecf8 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
valeyev 0:e056ac8fecf8 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
valeyev 0:e056ac8fecf8 20 * SOFTWARE.
valeyev 0:e056ac8fecf8 21 */
valeyev 0:e056ac8fecf8 22 #ifndef MEMORYPOOL_H
valeyev 0:e056ac8fecf8 23 #define MEMORYPOOL_H
valeyev 0:e056ac8fecf8 24
valeyev 0:e056ac8fecf8 25 #include <stdint.h>
valeyev 0:e056ac8fecf8 26 #include <string.h>
valeyev 0:e056ac8fecf8 27
valeyev 0:e056ac8fecf8 28 #include "cmsis_os2.h"
valeyev 0:e056ac8fecf8 29 #include "mbed_rtos1_types.h"
valeyev 0:e056ac8fecf8 30 #include "mbed_rtos_storage.h"
valeyev 0:e056ac8fecf8 31 #include "platform/NonCopyable.h"
valeyev 0:e056ac8fecf8 32
valeyev 0:e056ac8fecf8 33 namespace rtos {
valeyev 0:e056ac8fecf8 34 /** \addtogroup rtos */
valeyev 0:e056ac8fecf8 35 /** @{*/
valeyev 0:e056ac8fecf8 36 /**
valeyev 0:e056ac8fecf8 37 * \defgroup rtos_MemoryPool MemoryPool class
valeyev 0:e056ac8fecf8 38 * @{
valeyev 0:e056ac8fecf8 39 */
valeyev 0:e056ac8fecf8 40
valeyev 0:e056ac8fecf8 41 /** Define and manage fixed-size memory pools of objects of a given type.
valeyev 0:e056ac8fecf8 42 @tparam T data type of a single object (element).
valeyev 0:e056ac8fecf8 43 @tparam queue_sz maximum number of objects (elements) in the memory pool.
valeyev 0:e056ac8fecf8 44
valeyev 0:e056ac8fecf8 45 @note
valeyev 0:e056ac8fecf8 46 Memory considerations: The memory pool data store and control structures will be created on current thread's stack,
valeyev 0:e056ac8fecf8 47 both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
valeyev 0:e056ac8fecf8 48 */
valeyev 0:e056ac8fecf8 49 template<typename T, uint32_t pool_sz>
valeyev 0:e056ac8fecf8 50 class MemoryPool : private mbed::NonCopyable<MemoryPool<T, pool_sz> > {
valeyev 0:e056ac8fecf8 51 MBED_STATIC_ASSERT(pool_sz > 0, "Invalid memory pool size. Must be greater than 0.");
valeyev 0:e056ac8fecf8 52 public:
valeyev 0:e056ac8fecf8 53 /** Create and Initialize a memory pool.
valeyev 0:e056ac8fecf8 54 *
valeyev 0:e056ac8fecf8 55 * @note You cannot call this function from ISR context.
valeyev 0:e056ac8fecf8 56 */
valeyev 0:e056ac8fecf8 57 MemoryPool() {
valeyev 0:e056ac8fecf8 58 memset(_pool_mem, 0, sizeof(_pool_mem));
valeyev 0:e056ac8fecf8 59 memset(&_obj_mem, 0, sizeof(_obj_mem));
valeyev 0:e056ac8fecf8 60 osMemoryPoolAttr_t attr = { 0 };
valeyev 0:e056ac8fecf8 61 attr.mp_mem = _pool_mem;
valeyev 0:e056ac8fecf8 62 attr.mp_size = sizeof(_pool_mem);
valeyev 0:e056ac8fecf8 63 attr.cb_mem = &_obj_mem;
valeyev 0:e056ac8fecf8 64 attr.cb_size = sizeof(_obj_mem);
valeyev 0:e056ac8fecf8 65 _id = osMemoryPoolNew(pool_sz, sizeof(T), &attr);
valeyev 0:e056ac8fecf8 66 MBED_ASSERT(_id);
valeyev 0:e056ac8fecf8 67 }
valeyev 0:e056ac8fecf8 68
valeyev 0:e056ac8fecf8 69 /** Destroy a memory pool
valeyev 0:e056ac8fecf8 70 *
valeyev 0:e056ac8fecf8 71 * @note You cannot call this function from ISR context.
valeyev 0:e056ac8fecf8 72 */
valeyev 0:e056ac8fecf8 73 ~MemoryPool() {
valeyev 0:e056ac8fecf8 74 osMemoryPoolDelete(_id);
valeyev 0:e056ac8fecf8 75 }
valeyev 0:e056ac8fecf8 76
valeyev 0:e056ac8fecf8 77 /** Allocate a memory block of type T from a memory pool.
valeyev 0:e056ac8fecf8 78 @return address of the allocated memory block or NULL in case of no memory available.
valeyev 0:e056ac8fecf8 79
valeyev 0:e056ac8fecf8 80 @note You may call this function from ISR context.
valeyev 0:e056ac8fecf8 81 */
valeyev 0:e056ac8fecf8 82 T* alloc(void) {
valeyev 0:e056ac8fecf8 83 return (T*)osMemoryPoolAlloc(_id, 0);
valeyev 0:e056ac8fecf8 84 }
valeyev 0:e056ac8fecf8 85
valeyev 0:e056ac8fecf8 86 /** Allocate a memory block of type T from a memory pool and set memory block to zero.
valeyev 0:e056ac8fecf8 87 @return address of the allocated memory block or NULL in case of no memory available.
valeyev 0:e056ac8fecf8 88
valeyev 0:e056ac8fecf8 89 @note You may call this function from ISR context.
valeyev 0:e056ac8fecf8 90 */
valeyev 0:e056ac8fecf8 91 T* calloc(void) {
valeyev 0:e056ac8fecf8 92 T *item = (T*)osMemoryPoolAlloc(_id, 0);
valeyev 0:e056ac8fecf8 93 if (item != NULL) {
valeyev 0:e056ac8fecf8 94 memset(item, 0, sizeof(T));
valeyev 0:e056ac8fecf8 95 }
valeyev 0:e056ac8fecf8 96 return item;
valeyev 0:e056ac8fecf8 97 }
valeyev 0:e056ac8fecf8 98
valeyev 0:e056ac8fecf8 99 /** Free a memory block.
valeyev 0:e056ac8fecf8 100 @param block address of the allocated memory block to be freed.
valeyev 0:e056ac8fecf8 101 @return osOK on successful deallocation, osErrorParameter if given memory block id
valeyev 0:e056ac8fecf8 102 is NULL or invalid, or osErrorResource if given memory block is in an
valeyev 0:e056ac8fecf8 103 invalid memory pool state.
valeyev 0:e056ac8fecf8 104
valeyev 0:e056ac8fecf8 105 @note You may call this function from ISR context.
valeyev 0:e056ac8fecf8 106 */
valeyev 0:e056ac8fecf8 107 osStatus free(T *block) {
valeyev 0:e056ac8fecf8 108 return osMemoryPoolFree(_id, (void*)block);
valeyev 0:e056ac8fecf8 109 }
valeyev 0:e056ac8fecf8 110
valeyev 0:e056ac8fecf8 111 private:
valeyev 0:e056ac8fecf8 112 osMemoryPoolId_t _id;
valeyev 0:e056ac8fecf8 113 /* osMemoryPoolNew requires that pool block size is a multiple of 4 bytes. */
valeyev 0:e056ac8fecf8 114 char _pool_mem[((sizeof(T) + 3) & ~3) * pool_sz];
valeyev 0:e056ac8fecf8 115 mbed_rtos_storage_mem_pool_t _obj_mem;
valeyev 0:e056ac8fecf8 116 };
valeyev 0:e056ac8fecf8 117 /** @}*/
valeyev 0:e056ac8fecf8 118 /** @}*/
valeyev 0:e056ac8fecf8 119
valeyev 0:e056ac8fecf8 120 }
valeyev 0:e056ac8fecf8 121 #endif
valeyev 0:e056ac8fecf8 122
valeyev 0:e056ac8fecf8 123