mirror of https://github.com/ARMmbed/mbed-os.git
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.pull/5419/head
parent
99dc805e79
commit
3bb2c445ca
|
@ -120,7 +120,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
|
||||||
public:
|
public:
|
||||||
/** Create and Initialize a ConditionVariable object
|
/** Create and Initialize a ConditionVariable object
|
||||||
*
|
*
|
||||||
* @note You may call this function from ISR context.
|
* @note You cannot call this function from ISR context.
|
||||||
*/
|
*/
|
||||||
ConditionVariable(Mutex &mutex);
|
ConditionVariable(Mutex &mutex);
|
||||||
|
|
||||||
|
@ -190,7 +190,7 @@ public:
|
||||||
*
|
*
|
||||||
* @note - The thread calling this function must be the owner of the ConditionVariable's mutex
|
* @note - The thread calling this function must be the owner of the ConditionVariable's mutex
|
||||||
*
|
*
|
||||||
* @note This function may be called from ISR context.
|
* @note You cannot call this function from ISR context.
|
||||||
*/
|
*/
|
||||||
void notify_one();
|
void notify_one();
|
||||||
|
|
||||||
|
@ -198,13 +198,13 @@ public:
|
||||||
*
|
*
|
||||||
* @note - The thread calling this function must be the owner of the ConditionVariable's mutex
|
* @note - The thread calling this function must be the owner of the ConditionVariable's mutex
|
||||||
*
|
*
|
||||||
* @note This function may be called from ISR context.
|
* @note You cannot call this function from ISR context.
|
||||||
*/
|
*/
|
||||||
void notify_all();
|
void notify_all();
|
||||||
|
|
||||||
/** ConditionVariable destructor
|
/** ConditionVariable destructor
|
||||||
*
|
*
|
||||||
* @note You may call this function from ISR context.
|
* @note You cannot call this function from ISR context.
|
||||||
*/
|
*/
|
||||||
~ConditionVariable();
|
~ConditionVariable();
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue