From 40680f6eb905d5140cc49ca0fe7b576764aaba7d Mon Sep 17 00:00:00 2001 From: Peter Mitsis Date: Fri, 14 Oct 2016 10:04:55 -0400 Subject: [PATCH] unified: Tweak mailbox API parameters 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 --- include/kernel.h | 10 +++++----- kernel/unified/mailbox.c | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/include/kernel.h b/include/kernel.h index 22bdce1b769..1fbec780396 100644 --- a/include/kernel.h +++ b/include/kernel.h @@ -891,15 +891,15 @@ struct k_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); -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); -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); -extern void k_mbox_data_get(struct k_mbox_msg *msg, void *buffer); -extern int k_mbox_data_block_get(struct k_mbox_msg *msg, +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 *rx_msg, struct k_mem_pool *pool, struct k_mem_block *block, int32_t timeout); diff --git a/kernel/unified/mailbox.c b/kernel/unified/mailbox.c index 15d9d659f54..3d7929b0ba8 100644 --- a/kernel/unified/mailbox.c +++ b/kernel/unified/mailbox.c @@ -227,7 +227,7 @@ static void _mbox_message_dispose(struct k_mbox_msg *rx_msg) * * @param mbox Pointer to the mailbox object. * @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). * Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long * 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 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). * Use K_NO_WAIT to return immediately, or K_FOREVER to wait as long * 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 * 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 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 * necessary. * @@ -501,10 +501,10 @@ static int _mbox_message_data_check(struct k_mbox_msg *rx_msg, void *buffer) * and disposes of the message. * * @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. * (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 * necessary. *