Added new function chPoolLoadArray().

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4088 35acf78f-673a-0410-8e92-d51de3d6d3f4

2 files changed, 74 insertions, 4 deletions

diff --git a/os/kernel/include/chmempools.h b/os/kernel/include/chmempools.h
index 8a0d6f47d..a920e2579 100644
--- a/os/kernel/include/chmempools.h
+++ b/os/kernel/include/chmempools.h
@@ -75,10 +75,50 @@ typedef struct {
 #define MEMORYPOOL_DECL(name, size, provider)                               \

   MemoryPool name = _MEMORYPOOL_DATA(name, size, provider)

 

+/**

+ * @name    Macro Functions

+ * @{

+ */

+/**

+ * @brief   Adds an object to a memory pool.

+ * @pre     The memory pool must be already been initialized.

+ * @pre     The added object must be of the right size for the specified

+ *          memory pool.

+ * @pre     The added object must be memory aligned to the size of

+ *          @p stkalign_t type.

+ * @note    This function is just an alias for @p chPoolFree() and has been

+ *          added for clarity.

+ *

+ * @param[in] mp        pointer to a @p MemoryPool structure

+ * @param[in] objp      the pointer to the object to be added

+ *

+ * @api

+ */

+#define chPoolAdd(mp, objp) chPoolFree(mp, objp)

+

+/**

+ * @brief   Adds an object to a memory pool.

+ * @pre     The memory pool must be already been initialized.

+ * @pre     The added object must be of the right size for the specified

+ *          memory pool.

+ * @pre     The added object must be memory aligned to the size of

+ *          @p stkalign_t type.

+ * @note    This function is just an alias for @p chPoolFree() and has been

+ *          added for clarity.

+ *

+ * @param[in] mp        pointer to a @p MemoryPool structure

+ * @param[in] objp      the pointer to the object to be added

+ *

+ * @iclass

+ */

+#define chPoolAddI(mp, objp) chPoolFreeI(mp, objp)

+/** @} */

+

 #ifdef __cplusplus

 extern "C" {

 #endif

   void chPoolInit(MemoryPool *mp, size_t size, memgetfunc_t provider);

+  void chPoolLoadArray(MemoryPool *mp, void *p, size_t n);

   void *chPoolAllocI(MemoryPool *mp);

   void *chPoolAlloc(MemoryPool *mp);

   void chPoolFreeI(MemoryPool *mp, void *objp);

diff --git a/os/kernel/src/chmempools.c b/os/kernel/src/chmempools.c
index 6d1f7e866..8ef5cc403 100644
--- a/os/kernel/src/chmempools.c
+++ b/os/kernel/src/chmempools.c
@@ -61,7 +61,33 @@ void chPoolInit(MemoryPool *mp, size_t size, memgetfunc_t provider) {
 }

 

 /**

+ * @brief   Loads a memory pool with an array of static objects.

+ * @pre     The memory pool must be already been initialized.

+ * @pre     The array elements must be of the right size for the specified

+ *          memory pool.

+ * @post    The memory pool contains the elements of the input array.

+ *

+ * @param[in] mp        pointer to a @p MemoryPool structure

+ * @param[in] p         pointer to the array first element

+ * @param[in] n         number of elements in the array

+ *

+ * @api

+ */

+void chPoolLoadArray(MemoryPool *mp, void *p, size_t n) {

+

+  chDbgCheck((mp != NULL) && MEM_IS_ALIGNED(p) && (n != 0),

+             "chPoolLoadArray");

+

+  while (n) {

+    chPoolAdd(mp, p);

+    p = (void *)(((uint8_t *)p) + mp->mp_object_size);

+    n--;

+  }

+}

+

+/**

  * @brief   Allocates an object from a memory pool.

+ * @pre     The memory pool must be already been initialized.

  *

  * @param[in] mp        pointer to a @p MemoryPool structure

  * @return              The pointer to the allocated object.

@@ -84,6 +110,7 @@ void *chPoolAllocI(MemoryPool *mp) {
 

 /**

  * @brief   Allocates an object from a memory pool.

+ * @pre     The memory pool must be already been initialized.

  *

  * @param[in] mp        pointer to a @p MemoryPool structure

  * @return              The pointer to the allocated object.

@@ -101,14 +128,15 @@ void *chPoolAlloc(MemoryPool *mp) {
 }

 

 /**

- * @brief   Releases (or adds) an object into (to) a memory pool.

+ * @brief   Releases an object into a memory pool.

+ * @pre     The memory pool must be already been initialized.

  * @pre     The freed object must be of the right size for the specified

  *          memory pool.

  * @pre     The freed object must be memory aligned to the size of

  *          @p stkalign_t type.

  *

  * @param[in] mp        pointer to a @p MemoryPool structure

- * @param[in] objp      the pointer to the object to be released or added

+ * @param[in] objp      the pointer to the object to be released

  *

  * @iclass

  */

@@ -124,14 +152,15 @@ void chPoolFreeI(MemoryPool *mp, void *objp) {
 }

 

 /**

- * @brief   Releases (or adds) an object into (to) a memory pool.

+ * @brief   Releases an object into a memory pool.

+ * @pre     The memory pool must be already been initialized.

  * @pre     The freed object must be of the right size for the specified

  *          memory pool.

  * @pre     The freed object must be memory aligned to the size of

  *          @p stkalign_t type.

  *

  * @param[in] mp        pointer to a @p MemoryPool structure

- * @param[in] objp      the pointer to the object to be released or added

+ * @param[in] objp      the pointer to the object to be released

  *

  * @api

  */

@@ -141,6 +170,7 @@ void chPoolFree(MemoryPool *mp, void *objp) {
   chPoolFreeI(mp, objp);

   chSysUnlock();

 }

+

 #endif /* CH_USE_MEMPOOLS */

 

 /** @} */