From 2f91e478843e29d83225d30130a61c158c3affbd Mon Sep 17 00:00:00 2001 From: Olivier Martin Date: Wed, 25 Nov 2015 18:12:18 +0000 Subject: [PATCH] RTOS/RTX: Clarify osSignalWait() clear the signal flags It was not clear in the osSignalWait() function description that the function clears the signal flags. --- CMSIS/RTOS/RTX/INC/cmsis_os.h | 2 +- CMSIS/RTOS/Template/cmsis_os.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CMSIS/RTOS/RTX/INC/cmsis_os.h b/CMSIS/RTOS/RTX/INC/cmsis_os.h index 1e00c50..8886096 100644 --- a/CMSIS/RTOS/RTX/INC/cmsis_os.h +++ b/CMSIS/RTOS/RTX/INC/cmsis_os.h @@ -385,7 +385,7 @@ int32_t osSignalSet (osThreadId thread_id, int32_t signals); /// \return previous signal flags of the specified thread or 0x80000000 in case of incorrect parameters or call from ISR. int32_t osSignalClear (osThreadId thread_id, int32_t signals); -/// Wait for one or more Signal Flags to become signaled for the current \b RUNNING thread. +/// Wait and clear one or more Signal Flags to become signaled for the current \b RUNNING thread. /// \param[in] signals wait until all specified signal flags set or 0 for any single signal flag. /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out. /// \return event flag information or error code. diff --git a/CMSIS/RTOS/Template/cmsis_os.h b/CMSIS/RTOS/Template/cmsis_os.h index 068ebca..d3594a7 100644 --- a/CMSIS/RTOS/Template/cmsis_os.h +++ b/CMSIS/RTOS/Template/cmsis_os.h @@ -417,7 +417,7 @@ int32_t osSignalSet (osThreadId thread_id, int32_t signals); /// \note MUST REMAIN UNCHANGED: \b osSignalClear shall be consistent in every CMSIS-RTOS. int32_t osSignalClear (osThreadId thread_id, int32_t signals); -/// Wait for one or more Signal Flags to become signaled for the current \b RUNNING thread. +/// Wait and clear one or more Signal Flags to become signaled for the current \b RUNNING thread. /// \param[in] signals wait until all specified signal flags set or 0 for any single signal flag. /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out. /// \return event flag information or error code.