Merge pull request #166 from DavidLin1577/patch-6

Fixed some wrong notes in tos_mmblk.h
This commit is contained in:
Arthur
2020-06-08 19:57:25 +08:00
committed by GitHub

View File

@@ -68,15 +68,13 @@ __API__ k_err_t tos_mmblk_pool_create(k_mmblk_pool_t *mbp, void *pool_start, siz
__API__ k_err_t tos_mmblk_pool_destroy(k_mmblk_pool_t *mbp); __API__ k_err_t tos_mmblk_pool_destroy(k_mmblk_pool_t *mbp);
/** /**
* @brief Create a memory manage block pool. * @brief Allocate a memory manage block.
* Create a memory manage block pool. * Allocate a memory manage block.
* *
* @attention None * @attention None
* *
* @param[in] mbp pointer to the memory block pool handler. * @param[in] mbp pointer to the memory block pool handler.
* @param[in] pool_start start address of the pool. * @param[in] blk start address of the memory manage block.
* @param[in] blk_num number of the blocks in the pool.
* @param[in] blk_size size of each block in the pool.
* *
* @return errcode * @return errcode
* @retval #K_ERR_MMBLK_POOL_EMPTY the pool is empty. * @retval #K_ERR_MMBLK_POOL_EMPTY the pool is empty.
@@ -85,15 +83,13 @@ __API__ k_err_t tos_mmblk_pool_destroy(k_mmblk_pool_t *mbp);
__API__ k_err_t tos_mmblk_alloc(k_mmblk_pool_t *mbp, void **blk); __API__ k_err_t tos_mmblk_alloc(k_mmblk_pool_t *mbp, void **blk);
/** /**
* @brief Create a memory manage block pool. * @brief Free a memory manage block.
* Create a memory manage block pool. * Free a memory manage block.
* *
* @attention None * @attention None
* *
* @param[in] mbp pointer to the memory block pool handler. * @param[in] mbp pointer to the memory block pool handler.
* @param[in] pool_start start address of the pool. * @param[in] blk start address of the memory manage block.
* @param[in] blk_num number of the blocks in the pool.
* @param[in] blk_size size of each block in the pool.
* *
* @return errcode * @return errcode
* @retval #K_ERR_MMBLK_POOL_FULL the pool is full. * @retval #K_ERR_MMBLK_POOL_FULL the pool is full.