Architecture-specific power management APIs

Functions
FUNC_NORETURN void	arch_system_halt (unsigned int reason)
void	arch_cpu_idle (void)
	Power save idle routine. More...
void	arch_cpu_atomic_idle (unsigned int key)
	Atomically re-enable interrupts and enter low power mode. More...

Detailed Description

Function Documentation

arch_cpu_atomic_idle()

void arch_cpu_atomic_idle

(

unsigned int

key

)

#include <include/sys/arch_interface.h>

Atomically re-enable interrupts and enter low power mode.

The requirements for arch_cpu_atomic_idle() are as follows:

1. Enabling interrupts and entering a low-power mode needs to be atomic, i.e. there should be no period of time where interrupts are enabled before the processor enters a low-power mode. See the comments in k_lifo_get(), for example, of the race condition that occurs if this requirement is not met.
2. After waking up from the low-power mode, the interrupt lockout state must be restored as indicated in the 'key' input parameter.

See also

k_cpu_atomic_idle()

Parameters

key	Lockout key returned by previous invocation of arch_irq_lock()

arch_cpu_idle()

void arch_cpu_idle

(

void

)

#include <include/sys/arch_interface.h>

Power save idle routine.

This function will be called by the kernel idle loop or possibly within an implementation of z_pm_save_idle in the kernel when the '_pm_save_flag' variable is non-zero.

Architectures that do not implement power management instructions may immediately return, otherwise a power-saving instruction should be issued to wait for an interrupt.

Note

The function is expected to return after the interrupt that has caused the CPU to exit power-saving mode has been serviced, although this is not a firm requirement.

See also

k_cpu_idle()

arch_system_halt()

FUNC_NORETURN void arch_system_halt

(

unsigned int

reason

)

#include <kernel/include/kernel_arch_interface.h>

Halt the system, optionally propagating a reason code