tool/mbed/mbed-sdk/libraries/rtos/rtos/MemoryPool.h

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