Timothy Beight / Mbed 2 deprecated 6_songs-from-the-cloud

This is a fork due to permission issues

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of 6_songs-from-the-cloud by MakingMusicWorkshop

mbed-client/mbed-rtos/rtos/MemoryPool.h@1:0ddbe2d3319c, 2016-05-19 (annotated)

Committer:
timbeight
Date:
Thu May 19 16:02:10 2016 +0000
Revision:
1:0ddbe2d3319c
Parent:
0:f7c60d3e7b8a 
This is my first commit while in the class.

Who changed what in which revision?

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