pm.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2014 Wind River Systems, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_PM_PM_H_
#define ZEPHYR_INCLUDE_PM_PM_H_
 
#include <zephyr/types.h>
#include <sys/slist.h>
#include <pm/state.h>
#include <toolchain.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct pm_notifier {
        sys_snode_t _node;
        void (*state_entry)(enum pm_state state);
        void (*state_exit)(enum pm_state state);
};
 
#if defined(CONFIG_PM) || defined(__DOXYGEN__)
bool pm_power_state_force(uint8_t cpu, struct pm_state_info info);
 
void pm_notifier_register(struct pm_notifier *notifier);
 
int pm_notifier_unregister(struct pm_notifier *notifier);
 
struct pm_state_info pm_power_state_next_get(uint8_t cpu);
 
void pm_constraint_set(enum pm_state state);
 
void pm_constraint_release(enum pm_state state);
 
bool pm_constraint_get(enum pm_state state);
 
void pm_power_state_set(struct pm_state_info info);
 
void pm_power_state_exit_post_ops(struct pm_state_info info);
 
#else  /* CONFIG_PM */
 
#define pm_notifier_register(notifier)
#define pm_notifier_unregister(notifier) (-ENOSYS)
 
#define pm_constraint_set(pm_state)
#define pm_constraint_release(pm_state)
#define pm_constraint_get(pm_state) (true)
 
#define pm_power_state_set(info)
#define pm_power_state_exit_post_ops(info)
#define pm_power_state_next_get(cpu) \
        ((struct pm_state_info){PM_STATE_ACTIVE, 0, 0})
 
#endif /* CONFIG_PM */
 
void z_pm_save_idle_exit(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_PM_PM_H_ */