Dream team / mbed-rtos

Official mbed Real Time Operating System based on the RTX implementation of the CMSIS-RTOS API open standard.

Fork of mbed-rtos by mbed official

rtos/MemoryPool.h@111:de54bc598ef1, 2016-04-29 (annotated)

Committer:
acarter2
Date:
Fri Apr 29 14:04:02 2016 +0000
Revision:
111:de54bc598ef1
current code 2;

Who changed what in which revision?

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