michaelh/zephyr
1
0
Fork 0
Code Releases Activity

kernel: document interrupt behavior of k_cpu_atomic_idle

Browse source 
The generic kernel API did not specify the effect of the call on the
interrupt lockout state.  The implementation forwards to
arch_cpu_atomic_idle() which does document that the state is restored
to the state specified in the passed key, which makes it have the
effect of invoking irq_unlock(key).

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
This commit is contained in:
Peter Bigot 2020-09-29 10:43:10 -05:00 • committed by Ioannis Glaropoulos
commit 88e756e05e
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/kernel.h
View file

@ -5220,8 +5220,14 @@ static inline void k_cpu_idle(void)
/**
* @brief Make the CPU idle in an atomic fashion.
*
* Similar to k_cpu_idle(), but called with interrupts locked if operations
* must be done atomically before making the CPU idle.
* Similar to k_cpu_idle(), but must be called with interrupts locked.
*
* Enabling interrupts and entering a low-power mode will be atomic,
* i.e. there will be no period of time where interrupts are enabled before
* the processor enters a low-power mode.
*
* After waking up from the low-power mode, the interrupt lockout state will
* be restored as if by irq_unlock(key).
*
* @param key Interrupt locking key obtained from irq_lock().
*