You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ja...@apache.org on 2024/07/05 09:34:14 UTC
(mynewt-core) branch master updated (869218ffd -> 7adb4ad6e)
This is an automated email from the ASF dual-hosted git repository.
janc pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git
from 869218ffd flash_test: Add flash area access support
new fa2b45d76 kernel/os_mempool: Add parameter names
new 7adb4ad6e kernel/os_mempool: Update doxygen comments in the header file
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
kernel/os/include/os/os_mempool.h | 92 +++++++++++++++++++++++----------------
1 file changed, 55 insertions(+), 37 deletions(-)
(mynewt-core) 02/02: kernel/os_mempool: Update doxygen comments in the header file
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git
commit 7adb4ad6e6fbfdebd7a0543497363ce5e79e4fa3
Author: Wojciech Pietraszewski <wo...@codecoup.pl>
AuthorDate: Fri Jun 28 16:07:11 2024 +0200
kernel/os_mempool: Update doxygen comments in the header file
Amends the documentation for functions and structures.
Adjusts the formatting for better readability.
---
kernel/os/include/os/os_mempool.h | 90 +++++++++++++++++++++++----------------
1 file changed, 54 insertions(+), 36 deletions(-)
diff --git a/kernel/os/include/os/os_mempool.h b/kernel/os/include/os/os_mempool.h
index 71aa41877..d4c3313a3 100644
--- a/kernel/os/include/os/os_mempool.h
+++ b/kernel/os/include/os/os_mempool.h
@@ -43,6 +43,7 @@ extern "C" {
* caller.
*/
struct os_memblock {
+ /** Next memory block in the list. */
SLIST_ENTRY(os_memblock) mb_next;
};
@@ -67,7 +68,9 @@ struct os_mempool {
uint8_t mp_flags;
/** Address of memory buffer used by pool */
uintptr_t mp_membuf_addr;
+ /** Next memory pool in the list. */
STAILQ_ENTRY(os_mempool) mp_list;
+ /** Head of the list of memory blocks. */
SLIST_HEAD(,os_memblock);
/** Name for memory block */
char *name;
@@ -102,14 +105,19 @@ struct os_mempool_ext;
typedef os_error_t os_mempool_put_fn(struct os_mempool_ext *ome, void *data,
void *arg);
+/** Extended memory pool. */
struct os_mempool_ext {
+ /** Standard memory pool. */
struct os_mempool mpe_mp;
- /* Callback that is executed immediately when a block is freed. */
+ /** Callback that is executed immediately when a block is freed. */
os_mempool_put_fn *mpe_put_cb;
+
+ /** Optional argument passed to the callback function. */
void *mpe_put_arg;
};
+/** Length of the name of memory pool */
#define OS_MEMPOOL_INFO_NAME_LEN (32)
/**
@@ -132,24 +140,27 @@ struct os_mempool_info {
/**
* Get information about the next system memory pool.
*
- * @param mempool The current memory pool, or NULL if starting iteration.
- * @param info A pointer to the structure to return memory pool information
- * into.
+ * @param mp The current memory pool, or NULL if starting
+ * iteration.
+ * @param omi A pointer to the structure to return memory pool
+ * information into.
*
- * @return The next memory pool in the list to get information about, or NULL
- * when at the last memory pool.
+ * @return The next memory pool in the list to get
+ * information about;
+ * NULL when at the last memory pool.
*/
struct os_mempool *os_mempool_info_get_next(struct os_mempool *mp,
- struct os_mempool_info *omi);
+ struct os_mempool_info *omi);
/**
* Get information system memory pool by name.
*
- * @param mempool_name The name of mempool.
- * @param info A pointer to the structure to return memory pool information
- * into, can be NULL.
+ * @param mempool_name The name of mempool.
+ * @param info A pointer to the structure to return memory pool
+ * information into, can be NULL.
*
- * @return The memory pool found, or NULL when there is no such memory pool.
+ * @return The memory pool found;
+ * NULL when there is no such memory pool.
*/
struct os_mempool *os_mempool_get(const char *mempool_name,
struct os_mempool_info *info);
@@ -160,11 +171,10 @@ struct os_mempool *os_mempool_get(const char *mempool_name,
* the memory pool.
*/
#if MYNEWT_VAL(OS_MEMPOOL_GUARD)
-/*
- * Leave extra 4 bytes of guard area at the end.
- */
+/** Leave extra 4 bytes of guard area at the end. */
#define OS_MEMPOOL_BLOCK_SZ(sz) ((sz) + sizeof(os_membuf_t))
#else
+/** Size of a memory pool block. */
#define OS_MEMPOOL_BLOCK_SZ(sz) (sz)
#endif
#if (OS_ALIGNMENT == 4)
@@ -176,6 +186,8 @@ typedef __uint128_t os_membuf_t;
#else
#error "Unhandled `OS_ALIGNMENT` for `os_membuf_t`"
#endif /* OS_ALIGNMENT == * */
+
+/** The total size of a memory pool, including alignment. */
#define OS_MEMPOOL_SIZE(n,blksize) (((OS_MEMPOOL_BLOCK_SZ(blksize) + ((OS_ALIGNMENT)-1)) / (OS_ALIGNMENT)) * (n))
/** Calculates the number of bytes required to initialize a memory pool. */
@@ -185,13 +197,14 @@ typedef __uint128_t os_membuf_t;
/**
* Initialize a memory pool.
*
- * @param mp Pointer to a pointer to a mempool
- * @param blocks The number of blocks in the pool
- * @param blocks_size The size of the block, in bytes.
- * @param membuf Pointer to memory to contain blocks.
- * @param name Name of the pool.
+ * @param mp Pointer to a pointer to a mempool
+ * @param blocks The number of blocks in the pool
+ * @param block_size The size of the block, in bytes.
+ * @param membuf Pointer to memory to contain blocks.
+ * @param name Name of the pool.
*
- * @return os_error_t
+ * @return 0 on success;
+ * Non-zero error code on failure.
*/
os_error_t os_mempool_init(struct os_mempool *mp, uint16_t blocks,
uint32_t block_size, void *membuf, char *name);
@@ -201,13 +214,14 @@ os_error_t os_mempool_init(struct os_mempool *mp, uint16_t blocks,
* are not specified when this function is called; they are assigned manually
* after initialization.
*
- * @param mpe The extended memory pool to initialize.
- * @param blocks The number of blocks in the pool.
- * @param block_size The size of each block, in bytes.
- * @param membuf Pointer to memory to contain blocks.
- * @param name Name of the pool.
+ * @param mpe The extended memory pool to initialize.
+ * @param blocks The number of blocks in the pool.
+ * @param block_size The size of each block, in bytes.
+ * @param membuf Pointer to memory to contain blocks.
+ * @param name Name of the pool.
*
- * @return os_error_t
+ * @return 0 on success;
+ * Non-zero error code on failure.
*/
os_error_t os_mempool_ext_init(struct os_mempool_ext *mpe, uint16_t blocks,
uint32_t block_size, void *membuf, char *name);
@@ -226,9 +240,10 @@ os_error_t os_mempool_unregister(struct os_mempool *mp);
/**
* Clears a memory pool.
*
- * @param mp The mempool to clear.
+ * @param mp The mempool to clear.
*
- * @return os_error_t
+ * @return 0 on success;
+ * Non-zero error code on failure.
*/
os_error_t os_mempool_clear(struct os_mempool *mp);
@@ -258,9 +273,10 @@ int os_memblock_from(const struct os_mempool *mp, const void *block_addr);
/**
* Get a memory block from a memory pool
*
- * @param mp Pointer to the memory pool
+ * @param mp Pointer to the memory pool
*
- * @return void* Pointer to block if available; NULL otherwise
+ * @return Pointer to block if available;
+ * NULL otherwise
*/
void *os_memblock_get(struct os_mempool *mp);
@@ -269,20 +285,22 @@ void *os_memblock_get(struct os_mempool *mp);
* This function should only be called from a put callback to free a block
* without causing infinite recursion.
*
- * @param mp Pointer to memory pool
- * @param block_addr Pointer to memory block
+ * @param mp Pointer to memory pool
+ * @param block_addr Pointer to memory block
*
- * @return os_error_t
+ * @return 0 on success;
+ * Non-zero error code on failure.
*/
os_error_t os_memblock_put_from_cb(struct os_mempool *mp, void *block_addr);
/**
* Puts the memory block back into the pool
*
- * @param mp Pointer to memory pool
- * @param block_addr Pointer to memory block
+ * @param mp Pointer to memory pool
+ * @param block_addr Pointer to memory block
*
- * @return os_error_t
+ * @return 0 on success;
+ * Non-zero error code on failure.
*/
os_error_t os_memblock_put(struct os_mempool *mp, void *block_addr);
(mynewt-core) 01/02: kernel/os_mempool: Add parameter names
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git
commit fa2b45d76acd1a6d129aaece8eac1aa134e73efa
Author: Wojciech Pietraszewski <wo...@codecoup.pl>
AuthorDate: Fri Jun 28 13:57:00 2024 +0200
kernel/os_mempool: Add parameter names
Adds missing parameter names to function declarations
---
kernel/os/include/os/os_mempool.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/kernel/os/include/os/os_mempool.h b/kernel/os/include/os/os_mempool.h
index d5cf018de..71aa41877 100644
--- a/kernel/os/include/os/os_mempool.h
+++ b/kernel/os/include/os/os_mempool.h
@@ -139,8 +139,8 @@ struct os_mempool_info {
* @return The next memory pool in the list to get information about, or NULL
* when at the last memory pool.
*/
-struct os_mempool *os_mempool_info_get_next(struct os_mempool *,
- struct os_mempool_info *);
+struct os_mempool *os_mempool_info_get_next(struct os_mempool *mp,
+ struct os_mempool_info *omi);
/**
* Get information system memory pool by name.