Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

rtos/MemoryPool.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /* mbed Microcontroller Library
elessair 0:f269e3021894 2 * Copyright (c) 2006-2012 ARM Limited
elessair 0:f269e3021894 3 *
elessair 0:f269e3021894 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
elessair 0:f269e3021894 5 * of this software and associated documentation files (the "Software"), to deal
elessair 0:f269e3021894 6 * in the Software without restriction, including without limitation the rights
elessair 0:f269e3021894 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
elessair 0:f269e3021894 8 * copies of the Software, and to permit persons to whom the Software is
elessair 0:f269e3021894 9 * furnished to do so, subject to the following conditions:
elessair 0:f269e3021894 10 *
elessair 0:f269e3021894 11 * The above copyright notice and this permission notice shall be included in
elessair 0:f269e3021894 12 * all copies or substantial portions of the Software.
elessair 0:f269e3021894 13 *
elessair 0:f269e3021894 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
elessair 0:f269e3021894 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
elessair 0:f269e3021894 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
elessair 0:f269e3021894 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
elessair 0:f269e3021894 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
elessair 0:f269e3021894 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
elessair 0:f269e3021894 20 * SOFTWARE.
elessair 0:f269e3021894 21 */
elessair 0:f269e3021894 22 #ifndef MEMORYPOOL_H
elessair 0:f269e3021894 23 #define MEMORYPOOL_H
elessair 0:f269e3021894 24
elessair 0:f269e3021894 25 #include <stdint.h>
elessair 0:f269e3021894 26 #include <string.h>
elessair 0:f269e3021894 27
elessair 0:f269e3021894 28 #include "cmsis_os.h"
elessair 0:f269e3021894 29
elessair 0:f269e3021894 30 namespace rtos {
elessair 0:f269e3021894 31 /** \addtogroup rtos */
elessair 0:f269e3021894 32 /** @{*/
elessair 0:f269e3021894 33
elessair 0:f269e3021894 34 /** Define and manage fixed-size memory pools of objects of a given type.
elessair 0:f269e3021894 35 @tparam T data type of a single object (element).
elessair 0:f269e3021894 36 @tparam queue_sz maximum number of objects (elements) in the memory pool.
elessair 0:f269e3021894 37 */
elessair 0:f269e3021894 38 template<typename T, uint32_t pool_sz>
elessair 0:f269e3021894 39 class MemoryPool {
elessair 0:f269e3021894 40 public:
elessair 0:f269e3021894 41 /** Create and Initialize a memory pool. */
elessair 0:f269e3021894 42 MemoryPool() {
elessair 0:f269e3021894 43 #ifdef CMSIS_OS_RTX
elessair 0:f269e3021894 44 memset(_pool_m, 0, sizeof(_pool_m));
elessair 0:f269e3021894 45 _pool_def.pool = _pool_m;
elessair 0:f269e3021894 46
elessair 0:f269e3021894 47 _pool_def.pool_sz = pool_sz;
elessair 0:f269e3021894 48 _pool_def.item_sz = sizeof(T);
elessair 0:f269e3021894 49 #endif
elessair 0:f269e3021894 50 _pool_id = osPoolCreate(&_pool_def);
elessair 0:f269e3021894 51 }
elessair 0:f269e3021894 52
elessair 0:f269e3021894 53 /** Allocate a memory block of type T from a memory pool.
elessair 0:f269e3021894 54 @return address of the allocated memory block or NULL in case of no memory available.
elessair 0:f269e3021894 55 */
elessair 0:f269e3021894 56 T* alloc(void) {
elessair 0:f269e3021894 57 return (T*)osPoolAlloc(_pool_id);
elessair 0:f269e3021894 58 }
elessair 0:f269e3021894 59
elessair 0:f269e3021894 60 /** Allocate a memory block of type T from a memory pool and set memory block to zero.
elessair 0:f269e3021894 61 @return address of the allocated memory block or NULL in case of no memory available.
elessair 0:f269e3021894 62 */
elessair 0:f269e3021894 63 T* calloc(void) {
elessair 0:f269e3021894 64 return (T*)osPoolCAlloc(_pool_id);
elessair 0:f269e3021894 65 }
elessair 0:f269e3021894 66
elessair 0:f269e3021894 67 /** Return an allocated memory block back to a specific memory pool.
elessair 0:f269e3021894 68 @param address of the allocated memory block that is returned to the memory pool.
elessair 0:f269e3021894 69 @return status code that indicates the execution status of the function.
elessair 0:f269e3021894 70 */
elessair 0:f269e3021894 71 osStatus free(T *block) {
elessair 0:f269e3021894 72 return osPoolFree(_pool_id, (void*)block);
elessair 0:f269e3021894 73 }
elessair 0:f269e3021894 74
elessair 0:f269e3021894 75 private:
elessair 0:f269e3021894 76 osPoolId _pool_id;
elessair 0:f269e3021894 77 osPoolDef_t _pool_def;
elessair 0:f269e3021894 78 #ifdef CMSIS_OS_RTX
elessair 0:f269e3021894 79 uint32_t _pool_m[3+((sizeof(T)+3)/4)*(pool_sz)];
elessair 0:f269e3021894 80 #endif
elessair 0:f269e3021894 81 };
elessair 0:f269e3021894 82
elessair 0:f269e3021894 83 }
elessair 0:f269e3021894 84 #endif
elessair 0:f269e3021894 85
elessair 0:f269e3021894 86 /** @}*/