PebbleOS v4.47.0-327-g7753e801d
Loading...
Searching...
No Matches
idle.h File Reference
#include <stddef.h>
#include <stdint.h>
#include <pbl/kernel/compiler.h>
#include <pbl/kernel/section.h>
#include <pbl/kernel/types.h>
#include <pbl_arch_idle.h>

Data Structures

struct  pbl_idle_state
 Idle state. More...
 
struct  pbl_idle_hook_times
 Times of an idle hook, see pbl_idle_hook_set_times(). More...
 
struct  pbl_idle_hook
 Idle hook, see PBL_IDLE_HOOK_DEFINE. More...
 
struct  pbl_idle_latency_request
 Request on the time the CPU takes to wake up, see pbl_idle_latency_request_add(). More...
 

Macros

#define PBL_IDLE_STATES_MAX   4
 Maximum number of idle states.
 
#define PBL_IDLE_HOOK_DEFINE(_name, _enter, _exit, _arg)
 Define a hook, for a driver to act before the CPU idles and after.
 
#define PBL_IDLE_HOOK_LATE_DEFINE(_name, _enter, _exit, _arg)
 Define a hook the SoC calls last before the CPU idles and first after.
 
#define PBL_IDLE_HOOK(_name)   (&pbl_idle_hook_##_name)
 Get a hook defined with PBL_IDLE_HOOK_DEFINE in the same file.
 

Typedefs

typedef uint8_t pbl_idle_state_id_t
 Index of an idle state in pbl_soc_idle_states.
 

Functions

static void pbl_cpu_idle (void)
 Wait for an interrupt.
 
static void pbl_cpu_idle_deep (void)
 Wait for an interrupt in the CPU's deep sleep.
 
void pbl_idle_hook_set_times (const struct pbl_idle_hook *hook, uint32_t min_us, uint32_t exit_us)
 Set the times of a hook, rounded up to ticks.
 
void pbl_idle_hooks_late_enter (pbl_idle_state_id_t state)
 Call the enter function of every late hook.
 
void pbl_idle_hooks_late_exit (pbl_idle_state_id_t state)
 Call the exit function of every late hook.
 
static void pbl_idle_state_block (pbl_idle_state_id_t state)
 Keep the CPU out of an idle state and of every deeper one.
 
static void pbl_idle_state_release (pbl_idle_state_id_t state)
 Release a block taken with pbl_idle_state_block().
 
static void pbl_idle_latency_request_add (struct pbl_idle_latency_request *req, uint32_t us)
 Keep the CPU out of the idle states, and off the hooks, that take longer to wake up from.
 
static void pbl_idle_latency_request_remove (struct pbl_idle_latency_request *req)
 Remove a request added with pbl_idle_latency_request_add().
 
void pbl_idle_set_enabled (bool enable)
 Allow the CPU to idle or keep it running, e.g.
 
uint64_t pbl_idle_residency_us (pbl_idle_state_id_t state)
 Get the time spent in an idle state since boot.
 

Variables

const struct pbl_idle_state pbl_soc_idle_states []
 Idle states, shallowest first.
 
const size_t pbl_soc_num_idle_states
 Number of entries in pbl_soc_idle_states.