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 <zephyr/sys/slist.h>
#include <zephyr/pm/state.h>
#include <zephyr/toolchain.h>
#include <errno.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif



struct pm_notifier {
        sys_snode_t _node;
        union {
                struct {
                        void (*state_entry)(enum pm_state state);
                        void (*state_exit)(enum pm_state state);
                };
                struct {
                        void (*substate_entry)(enum pm_state state, uint8_t substate_id);
                        void (*substate_exit)(enum pm_state state, uint8_t substate_id);
                };
        };
        bool report_substate; /* 0 is for backwards compatibility that didn't report substates */
};
 
#if defined(CONFIG_PM) || defined(__DOXYGEN__)
bool pm_state_force(uint8_t cpu, const struct pm_state_info *info);

void pm_notifier_register(struct pm_notifier *notifier);

int pm_notifier_unregister(struct pm_notifier *notifier);

const struct pm_state_info *pm_state_next_get(uint8_t cpu);

void pm_system_resume(void);



void pm_state_set(enum pm_state state, uint8_t substate_id);

void pm_state_exit_post_ops(enum pm_state state, uint8_t substate_id);

 
#else  /* CONFIG_PM */
 
static inline void pm_notifier_register(struct pm_notifier *notifier)
{
        ARG_UNUSED(notifier);
}
 
static inline int pm_notifier_unregister(struct pm_notifier *notifier)
{
        ARG_UNUSED(notifier);
 
        return -ENOSYS;
}
 
static inline const struct pm_state_info *pm_state_next_get(uint8_t cpu)
{
        ARG_UNUSED(cpu);
 
        return NULL;
}
 
static inline void pm_system_resume(void)
{
}
 
#endif /* CONFIG_PM */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_PM_PM_H_ */