Shoaib Ahmed / Mbed 2 deprecated uzairkhan

Final 350 project

Dependencies:   uzair Camera_LS_Y201 F7_Ethernet LCD_DISCO_F746NG NetworkAPI SDFileSystem mbed

mbed-rtos/rtos/MemoryPool.h@0:791a779d6220, 2017-07-31 (annotated)

Committer:
shoaib_ahmed
Date:
Mon Jul 31 09:16:35 2017 +0000
Revision:
0:791a779d6220
final project;

Who changed what in which revision?

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