takashi kadono / Mbed OS Nucleo_446

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:   ssd1331

mbed-os/rtos/MemoryPool.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /* mbed Microcontroller Library
kadonotakashi 0:8fdf9a60065b 2 * Copyright (c) 2006-2012 ARM Limited
kadonotakashi 0:8fdf9a60065b 3 *
kadonotakashi 0:8fdf9a60065b 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
kadonotakashi 0:8fdf9a60065b 5 * of this software and associated documentation files (the "Software"), to deal
kadonotakashi 0:8fdf9a60065b 6 * in the Software without restriction, including without limitation the rights
kadonotakashi 0:8fdf9a60065b 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
kadonotakashi 0:8fdf9a60065b 8 * copies of the Software, and to permit persons to whom the Software is
kadonotakashi 0:8fdf9a60065b 9 * furnished to do so, subject to the following conditions:
kadonotakashi 0:8fdf9a60065b 10 *
kadonotakashi 0:8fdf9a60065b 11 * The above copyright notice and this permission notice shall be included in
kadonotakashi 0:8fdf9a60065b 12 * all copies or substantial portions of the Software.
kadonotakashi 0:8fdf9a60065b 13 *
kadonotakashi 0:8fdf9a60065b 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
kadonotakashi 0:8fdf9a60065b 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
kadonotakashi 0:8fdf9a60065b 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
kadonotakashi 0:8fdf9a60065b 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
kadonotakashi 0:8fdf9a60065b 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
kadonotakashi 0:8fdf9a60065b 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
kadonotakashi 0:8fdf9a60065b 20 * SOFTWARE.
kadonotakashi 0:8fdf9a60065b 21 */
kadonotakashi 0:8fdf9a60065b 22 #ifndef MEMORYPOOL_H
kadonotakashi 0:8fdf9a60065b 23 #define MEMORYPOOL_H
kadonotakashi 0:8fdf9a60065b 24
kadonotakashi 0:8fdf9a60065b 25 #include <stdint.h>
kadonotakashi 0:8fdf9a60065b 26 #include <string.h>
kadonotakashi 0:8fdf9a60065b 27
kadonotakashi 0:8fdf9a60065b 28 #include "cmsis_os2.h"
kadonotakashi 0:8fdf9a60065b 29 #include "mbed_rtos1_types.h"
kadonotakashi 0:8fdf9a60065b 30 #include "mbed_rtos_storage.h"
kadonotakashi 0:8fdf9a60065b 31 #include "platform/NonCopyable.h"
kadonotakashi 0:8fdf9a60065b 32
kadonotakashi 0:8fdf9a60065b 33 namespace rtos {
kadonotakashi 0:8fdf9a60065b 34 /** \addtogroup rtos */
kadonotakashi 0:8fdf9a60065b 35 /** @{*/
kadonotakashi 0:8fdf9a60065b 36 /**
kadonotakashi 0:8fdf9a60065b 37 * \defgroup rtos_MemoryPool MemoryPool class
kadonotakashi 0:8fdf9a60065b 38 * @{
kadonotakashi 0:8fdf9a60065b 39 */
kadonotakashi 0:8fdf9a60065b 40
kadonotakashi 0:8fdf9a60065b 41 /** Define and manage fixed-size memory pools of objects of a given type.
kadonotakashi 0:8fdf9a60065b 42 @tparam T data type of a single object (element).
kadonotakashi 0:8fdf9a60065b 43 @tparam queue_sz maximum number of objects (elements) in the memory pool.
kadonotakashi 0:8fdf9a60065b 44
kadonotakashi 0:8fdf9a60065b 45 @note
kadonotakashi 0:8fdf9a60065b 46 Memory considerations: The memory pool data store and control structures will be created on current thread's stack,
kadonotakashi 0:8fdf9a60065b 47 both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
kadonotakashi 0:8fdf9a60065b 48 */
kadonotakashi 0:8fdf9a60065b 49 template<typename T, uint32_t pool_sz>
kadonotakashi 0:8fdf9a60065b 50 class MemoryPool : private mbed::NonCopyable<MemoryPool<T, pool_sz> > {
kadonotakashi 0:8fdf9a60065b 51 MBED_STATIC_ASSERT(pool_sz > 0, "Invalid memory pool size. Must be greater than 0.");
kadonotakashi 0:8fdf9a60065b 52 public:
kadonotakashi 0:8fdf9a60065b 53 /** Create and Initialize a memory pool.
kadonotakashi 0:8fdf9a60065b 54 *
kadonotakashi 0:8fdf9a60065b 55 * @note You cannot call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 56 */
kadonotakashi 0:8fdf9a60065b 57 MemoryPool() {
kadonotakashi 0:8fdf9a60065b 58 memset(_pool_mem, 0, sizeof(_pool_mem));
kadonotakashi 0:8fdf9a60065b 59 memset(&_obj_mem, 0, sizeof(_obj_mem));
kadonotakashi 0:8fdf9a60065b 60 osMemoryPoolAttr_t attr = { 0 };
kadonotakashi 0:8fdf9a60065b 61 attr.mp_mem = _pool_mem;
kadonotakashi 0:8fdf9a60065b 62 attr.mp_size = sizeof(_pool_mem);
kadonotakashi 0:8fdf9a60065b 63 attr.cb_mem = &_obj_mem;
kadonotakashi 0:8fdf9a60065b 64 attr.cb_size = sizeof(_obj_mem);
kadonotakashi 0:8fdf9a60065b 65 _id = osMemoryPoolNew(pool_sz, sizeof(T), &attr);
kadonotakashi 0:8fdf9a60065b 66 MBED_ASSERT(_id);
kadonotakashi 0:8fdf9a60065b 67 }
kadonotakashi 0:8fdf9a60065b 68
kadonotakashi 0:8fdf9a60065b 69 /** Destroy a memory pool
kadonotakashi 0:8fdf9a60065b 70 *
kadonotakashi 0:8fdf9a60065b 71 * @note You cannot call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 72 */
kadonotakashi 0:8fdf9a60065b 73 ~MemoryPool() {
kadonotakashi 0:8fdf9a60065b 74 osMemoryPoolDelete(_id);
kadonotakashi 0:8fdf9a60065b 75 }
kadonotakashi 0:8fdf9a60065b 76
kadonotakashi 0:8fdf9a60065b 77 /** Allocate a memory block of type T from a memory pool.
kadonotakashi 0:8fdf9a60065b 78 @return address of the allocated memory block or NULL in case of no memory available.
kadonotakashi 0:8fdf9a60065b 79
kadonotakashi 0:8fdf9a60065b 80 @note You may call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 81 */
kadonotakashi 0:8fdf9a60065b 82 T* alloc(void) {
kadonotakashi 0:8fdf9a60065b 83 return (T*)osMemoryPoolAlloc(_id, 0);
kadonotakashi 0:8fdf9a60065b 84 }
kadonotakashi 0:8fdf9a60065b 85
kadonotakashi 0:8fdf9a60065b 86 /** Allocate a memory block of type T from a memory pool and set memory block to zero.
kadonotakashi 0:8fdf9a60065b 87 @return address of the allocated memory block or NULL in case of no memory available.
kadonotakashi 0:8fdf9a60065b 88
kadonotakashi 0:8fdf9a60065b 89 @note You may call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 90 */
kadonotakashi 0:8fdf9a60065b 91 T* calloc(void) {
kadonotakashi 0:8fdf9a60065b 92 T *item = (T*)osMemoryPoolAlloc(_id, 0);
kadonotakashi 0:8fdf9a60065b 93 if (item != NULL) {
kadonotakashi 0:8fdf9a60065b 94 memset(item, 0, sizeof(T));
kadonotakashi 0:8fdf9a60065b 95 }
kadonotakashi 0:8fdf9a60065b 96 return item;
kadonotakashi 0:8fdf9a60065b 97 }
kadonotakashi 0:8fdf9a60065b 98
kadonotakashi 0:8fdf9a60065b 99 /** Free a memory block.
kadonotakashi 0:8fdf9a60065b 100 @param block address of the allocated memory block to be freed.
kadonotakashi 0:8fdf9a60065b 101 @return osOK on successful deallocation, osErrorParameter if given memory block id
kadonotakashi 0:8fdf9a60065b 102 is NULL or invalid, or osErrorResource if given memory block is in an
kadonotakashi 0:8fdf9a60065b 103 invalid memory pool state.
kadonotakashi 0:8fdf9a60065b 104
kadonotakashi 0:8fdf9a60065b 105 @note You may call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 106 */
kadonotakashi 0:8fdf9a60065b 107 osStatus free(T *block) {
kadonotakashi 0:8fdf9a60065b 108 return osMemoryPoolFree(_id, (void*)block);
kadonotakashi 0:8fdf9a60065b 109 }
kadonotakashi 0:8fdf9a60065b 110
kadonotakashi 0:8fdf9a60065b 111 private:
kadonotakashi 0:8fdf9a60065b 112 osMemoryPoolId_t _id;
kadonotakashi 0:8fdf9a60065b 113 /* osMemoryPoolNew requires that pool block size is a multiple of 4 bytes. */
kadonotakashi 0:8fdf9a60065b 114 char _pool_mem[((sizeof(T) + 3) & ~3) * pool_sz];
kadonotakashi 0:8fdf9a60065b 115 mbed_rtos_storage_mem_pool_t _obj_mem;
kadonotakashi 0:8fdf9a60065b 116 };
kadonotakashi 0:8fdf9a60065b 117 /** @}*/
kadonotakashi 0:8fdf9a60065b 118 /** @}*/
kadonotakashi 0:8fdf9a60065b 119
kadonotakashi 0:8fdf9a60065b 120 }
kadonotakashi 0:8fdf9a60065b 121 #endif
kadonotakashi 0:8fdf9a60065b 122
kadonotakashi 0:8fdf9a60065b 123