From 38cc48d575a6232cfd440d97711f89f5f531422d Mon Sep 17 00:00:00 2001 From: gdisirio Date: Thu, 7 Oct 2010 13:32:58 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2237 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/kernel/include/chmboxes.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'os') diff --git a/os/kernel/include/chmboxes.h b/os/kernel/include/chmboxes.h index ed4bec8ff..964952c23 100644 --- a/os/kernel/include/chmboxes.h +++ b/os/kernel/include/chmboxes.h @@ -79,7 +79,7 @@ extern "C" { ((mbp)->mb_top - (mbp)->mb_buffer) /** - * @brief Returns the free space into the mailbox. + * @brief Returns the number of free message slots into a mailbox. * @note Can be invoked in any system state but if invoked out of a locked * state then the returned value may change after reading. * @note The returned value can be less than zero when there are waiting @@ -90,10 +90,10 @@ extern "C" { * * @iclass */ -#define chMBGetEmptyI(mbp) chSemGetCounterI(&(mbp)->mb_emptysem) +#define chMBGetFreeCountI(mbp) chSemGetCounterI(&(mbp)->mb_emptysem) /** - * @brief Returns the number of messages into the mailbox. + * @brief Returns the number of queued messages into a mailbox. * @note Can be invoked in any system state but if invoked out of a locked * state then the returned value may change after reading. * @note The returned value can be less than zero when there are waiting @@ -104,14 +104,14 @@ extern "C" { * * @iclass */ -#define chMBGetFullI(mbp) chSemGetCounterI(&(mbp)->mb_fullsem) +#define chMBGetFullCountI(mbp) chSemGetCounterI(&(mbp)->mb_fullsem) /** * @brief Returns the next message in the queue without removing it. * @pre A message must be waiting in the queue for this function to work * or it would return garbage. The correct way to use this macro is - * to use @p chMBGetFull() and then use this macro, all within a - * lock state. + * to use @p chMBGetFullCountI() and then use this macro, all within + * a lock state. * * @iclass */ -- cgit v1.2.3