Dependents:   sensomed

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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