platform: CriticalSectionLock class improvement

pull/5621/head
Maciej Bocianski 2017-11-30 14:23:48 +01:00
parent 9cce4d2b06
commit ad67904daa
1 changed files with 40 additions and 9 deletions

View File

@ -33,14 +33,25 @@ namespace mbed {
* Usage:
* @code
*
* void f() {
* // some code here
* {
* CriticalSectionLock lock;
* // Code in this block will run with interrupts disabled
* }
* // interrupts will be restored to their previous state
* // RAII style usage
* unsigned int atomic_counter_increment(unsigned int &counter) {
* CriticalSectionLock lock;
* // Code in this block will run with interrupts disabled
* // Interrupts will be restored to their previous state automatically
* // at the end of function scope
* return ++counter;
* }
*
* // free locking usage
* unsigned int atomic_counter_decrement(unsigned int &counter) {
* CriticalSectionLock::enable();
* // Code in this block will run with interrupts disabled
* counter--;
* CriticalSectionLock::disable(); // need explicitly to disable critical section lock
* // interrupts will be restored to their previous state here
* return counter;
* }
*
* @endcode
*/
class CriticalSectionLock {
@ -56,20 +67,40 @@ public:
}
/** Mark the start of a critical section
*
*
*/
MBED_DEPRECATED_SINCE("mbed-os-5.8",
"This function is inconsistent with RAII and is being removed in the future."
"Replaced by static function CriticalSectionLock::enable.")
void lock()
{
core_util_critical_section_enter();
}
/** Mark the end of a critical section
*
*
*/
MBED_DEPRECATED_SINCE("mbed-os-5.8",
"This function is inconsistent with RAII and is being removed in the future."
"Replaced by static function CriticalSectionLock::disable.")
void unlock()
{
core_util_critical_section_exit();
}
/** Mark the start of a critical section
*/
static void enable()
{
core_util_critical_section_enter();
}
/** Mark the end of a critical section
*/
static void disable()
{
core_util_critical_section_exit();
}
};
/**@}*/