michaelh/zephyr
1
0
Fork 0
Code Releases Activity

unified: Tweak mailbox API parameters

Browse source 
Tweak mailbox API parameters so that not only are their descriptions
correct, but their names match across header file and C file.

Change-Id: Ieeb3a40fb7c535a5eac2e06533d01d13aaf69181
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
This commit is contained in:
Peter Mitsis 2016-10-14 10:04:55 -04:00 • committed by Benjamin Walsh
commit 40680f6eb9
2 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/kernel.h
View file

@ -891,15 +891,15 @@ struct k_mbox {
extern void k_mbox_init(struct k_mbox *mbox); extern void k_mbox_init(struct k_mbox *mbox);
extern int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *msg, extern int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
int32_t timeout); int32_t timeout);
extern void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *msg, extern void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
struct k_sem *sem); struct k_sem *sem);
extern int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *msg, extern int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg,
void *buffer, int32_t timeout); void *buffer, int32_t timeout);
extern void k_mbox_data_get(struct k_mbox_msg *msg, void *buffer); extern void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer);
extern int k_mbox_data_block_get(struct k_mbox_msg *msg, extern int k_mbox_data_block_get(struct k_mbox_msg *rx_msg,
struct k_mem_pool *pool, struct k_mem_pool *pool,
struct k_mem_block *block, int32_t timeout); struct k_mem_block *block, int32_t timeout);

12
kernel/unified/mailbox.c
View file

@ -227,7 +227,7 @@ static void _mbox_message_dispose(struct k_mbox_msg *rx_msg)
* *
* @param mbox Pointer to the mailbox object. * @param mbox Pointer to the mailbox object.
* @param tx_msg Pointer to transmit message descriptor. * @param tx_msg Pointer to transmit message descriptor.
* @param timeout Maximum time (nanoseconds) to wait for the message to be * @param timeout Maximum time (milliseconds) to wait for the message to be
* received (although not necessarily completely processed). * received (although not necessarily completely processed).
* Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long * Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long
* as necessary. * as necessary.
@ -319,7 +319,7 @@ static int _mbox_message_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
* *
* @param mbox Pointer to the mailbox object. * @param mbox Pointer to the mailbox object.
* @param tx_msg Pointer to transmit message descriptor. * @param tx_msg Pointer to transmit message descriptor.
* @param timeout Maximum time (nanoseconds) to wait for the message to be * @param timeout Maximum time (milliseconds) to wait for the message to be
* received (although not necessarily completely processed). * received (although not necessarily completely processed).
* Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long * Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long
* as necessary. * as necessary.
@ -420,10 +420,10 @@ void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer)
* permits the caller to reattempt data retrieval at a later time or to dispose * permits the caller to reattempt data retrieval at a later time or to dispose
* of the received message without retrieving its data. * of the received message without retrieving its data.
* *
* @param msg Pointer to receive message descriptor. * @param rx_msg Pointer to receive message descriptor.
* @param pool Memory pool identifier. (Use NULL to discard data.) * @param pool Memory pool identifier. (Use NULL to discard data.)
* @param block Pointer to area to hold memory pool block info. * @param block Pointer to area to hold memory pool block info.
* @param timeout Maximum time (nanoseconds) to wait for a memory pool block. * @param timeout Maximum time (milliseconds) to wait for a memory pool block.
* Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long as * Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long as
* necessary. * necessary.
* *
@ -501,10 +501,10 @@ static int _mbox_message_data_check(struct k_mbox_msg *rx_msg, void *buffer)
* and disposes of the message. * and disposes of the message.
* *
* @param mbox Pointer to the mailbox object. * @param mbox Pointer to the mailbox object.
* @param msg Pointer to receive message descriptor. * @param rx_msg Pointer to receive message descriptor.
* @param buffer Pointer to buffer to receive data. * @param buffer Pointer to buffer to receive data.
* (Use NULL to defer data retrieval and message disposal until later.) * (Use NULL to defer data retrieval and message disposal until later.)
* @param timeout Maximum time (nanoseconds) to wait for a message. * @param timeout Maximum time (milliseconds) to wait for a message.
* Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long as * Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long as
* necessary. * necessary.
* *