bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ipc: icmsg & icbmsg: Fix alloc_tx_buffer() doxygen description

Browse Source 
The return values were not correct, and the parameters descriptions
were not too easy to understand.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
This commit is contained in:
Alberto Escolar Piedras 2024-10-22 11:24:51 +02:00 committed by Fabio Baltieri
parent f840f660a4
commit a5e3a33b39
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
subsys/ipc/ipc_service/backends/ipc_icbmsg.c
View File

@ -320,15 +320,16 @@ static int buffer_to_index_validate(const struct channel_config *ch_conf,
/**
* Allocate buffer for transmission
*
* @param[in,out] size Required size of the buffer. If zero, first available block is
* allocated and all subsequent available blocks. Size actually
* allocated which is not less than requested.
* @param[out] buffer Allocated buffer data.
* @param[in,out] size Required size of the buffer. If set to zero, the first available block will
* be allocated, together with all contiguous free blocks that follow it.
* On success, size will contain the actually allocated size, which will be
* at least the requested size.
* @param[out] buffer Pointer to the newly allocated buffer.
* @param[in] timeout Timeout.
*
* @return Positive index of the first allocated block or negative error.
* @retval -EINVAL If requested size is bigger than entire allocable space.
* @retval -ENOSPC If timeout was K_NO_WAIT and there was not enough space.
* @retval -ENOMEM If requested size is bigger than entire allocable space, or
* the timeout was K_NO_WAIT and there was not enough space.
* @retval -EAGAIN If timeout occurred.
*/
static int alloc_tx_buffer(struct backend_data *dev_data, uint32_t *size,