Skip to content

Commit 3bb2c44

Browse files
committed
Correct ConditionVariable ISR comments
No ConditionVariable methods are useable from ISR, due to the built-in mutex and the requirement that the caller of notify holds the mutex.
1 parent 99dc805 commit 3bb2c44

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

rtos/ConditionVariable.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
120120
public:
121121
/** Create and Initialize a ConditionVariable object
122122
*
123-
* @note You may call this function from ISR context.
123+
* @note You cannot call this function from ISR context.
124124
*/
125125
ConditionVariable(Mutex &mutex);
126126

@@ -190,21 +190,21 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
190190
*
191191
* @note - The thread calling this function must be the owner of the ConditionVariable's mutex
192192
*
193-
* @note This function may be called from ISR context.
193+
* @note You cannot call this function from ISR context.
194194
*/
195195
void notify_one();
196196

197197
/** Notify all waiters on this condition variable that a condition changed.
198198
*
199199
* @note - The thread calling this function must be the owner of the ConditionVariable's mutex
200200
*
201-
* @note This function may be called from ISR context.
201+
* @note You cannot call this function from ISR context.
202202
*/
203203
void notify_all();
204204

205205
/** ConditionVariable destructor
206206
*
207-
* @note You may call this function from ISR context.
207+
* @note You cannot call this function from ISR context.
208208
*/
209209
~ConditionVariable();
210210

0 commit comments

Comments
 (0)