Dylan Saada / Mbed 2 deprecated telemetre2

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

USBHost/mbed-rtos/rtos/MemoryPool.h@0:6ce9c65992e5, 2015-04-15 (annotated)

Committer:
dylancachan
Date:
Wed Apr 15 06:23:18 2015 +0000
Revision:
0:6ce9c65992e5
telemetre

Who changed what in which revision?

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