ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Copy edit MemoryPool.h 

Copy edit file for active voice.
pull/5954/head
Amanda Butler 2018-01-08 17:43:45 -06:00 committed by Cruz Monrreal II‰
parent bdc21ed978
commit 9dfa3bda4b
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
rtos/MemoryPool.h
View File

@ -52,7 +52,7 @@ class MemoryPool : private mbed::NonCopyable<MemoryPool<T, pool_sz> > {
public: public:
/** Create and Initialize a memory pool. /** Create and Initialize a memory pool.
* *
* @note This function cannot be called from ISR context. * @note You cannot call this function from ISR context.
*/ */
MemoryPool() { MemoryPool() {
memset(_pool_mem, 0, sizeof(_pool_mem)); memset(_pool_mem, 0, sizeof(_pool_mem));
@ -68,7 +68,7 @@ public:
/** Destroy a memory pool /** Destroy a memory pool
* *
* @note This function cannot be called from ISR context. * @note You cannot call this function from ISR context.
*/ */
~MemoryPool() { ~MemoryPool() {
osMemoryPoolDelete(_id); osMemoryPoolDelete(_id);
@ -77,7 +77,7 @@ public:
/** Allocate a memory block of type T from a memory pool. /** Allocate a memory block of type T from a memory pool.
@return address of the allocated memory block or NULL in case of no memory available. @return address of the allocated memory block or NULL in case of no memory available.
@note This function may be called from ISR context. @note You may call this function from ISR context.
*/ */
T* alloc(void) { T* alloc(void) {
return (T*)osMemoryPoolAlloc(_id, 0); return (T*)osMemoryPoolAlloc(_id, 0);
@ -86,7 +86,7 @@ public:
/** Allocate a memory block of type T from a memory pool and set memory block to zero. /** Allocate a memory block of type T from a memory pool and set memory block to zero.
@return address of the allocated memory block or NULL in case of no memory available. @return address of the allocated memory block or NULL in case of no memory available.
@note This function may be called from ISR context. @note You may call this function from ISR context.
*/ */
T* calloc(void) { T* calloc(void) {
T *item = (T*)osMemoryPoolAlloc(_id, 0); T *item = (T*)osMemoryPoolAlloc(_id, 0);
@ -102,7 +102,7 @@ public:
is NULL or invalid, or osErrorResource if given memory block is in an is NULL or invalid, or osErrorResource if given memory block is in an
invalid memory pool state. invalid memory pool state.
@note This function may be called from ISR context. @note You may call this function from ISR context.
*/ */
osStatus free(T *block) { osStatus free(T *block) {
return osMemoryPoolFree(_id, (void*)block); return osMemoryPoolFree(_id, (void*)block);