state.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Intel corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_PM_STATE_H_
#define ZEPHYR_INCLUDE_PM_STATE_H_
 
#include <sys/util.h>
#include <devicetree.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum pm_state {
        PM_STATE_ACTIVE,
        PM_STATE_RUNTIME_IDLE,
        PM_STATE_SUSPEND_TO_IDLE,
        PM_STATE_STANDBY,
        PM_STATE_SUSPEND_TO_RAM,
        PM_STATE_SUSPEND_TO_DISK,
        PM_STATE_SOFT_OFF
};
 
struct pm_state_info {
        enum pm_state state;
 
        uint8_t substate_id;
 
        uint32_t min_residency_us;
 
        uint32_t exit_latency_us;
};
 
#define PM_STATE_INFO_DT_ITEM_BY_IDX(node_id, i)                    \
        {                                                           \
                .state = DT_ENUM_IDX(DT_PHANDLE_BY_IDX(node_id, \
                        cpu_power_states, i), power_state_name),    \
                .substate_id = DT_PROP_BY_PHANDLE_IDX_OR(node_id, \
                        cpu_power_states, i, substate_id, 0),   \
                .min_residency_us = DT_PROP_BY_PHANDLE_IDX_OR(node_id, \
                                cpu_power_states, i, min_residency_us, 0),\
                .exit_latency_us = DT_PROP_BY_PHANDLE_IDX_OR(node_id, \
                                cpu_power_states, i, exit_latency_us, 0),\
        },
 
#define PM_STATE_DT_ITEMS_LEN(node_id) \
        DT_PROP_LEN_OR(node_id, cpu_power_states, 0)
 
#define PM_STATE_INFO_DT_ITEMS_LISTIFY_FUNC(child, node_id) \
        PM_STATE_INFO_DT_ITEM_BY_IDX(node_id, child)
 
#define PM_STATE_INFO_DT_ITEMS_LIST(node_id) {         \
        UTIL_LISTIFY(PM_STATE_DT_ITEMS_LEN(node_id),   \
                     PM_STATE_INFO_DT_ITEMS_LISTIFY_FUNC,\
                     node_id)                          \
        }
 
#define PM_STATE_DT_ITEM_BY_IDX(node_id, i)                     \
        DT_ENUM_IDX(DT_PHANDLE_BY_IDX(node_id,                  \
                      cpu_power_states, i), power_state_name),
 
 
#define PM_STATE_DT_ITEMS_LISTIFY_FUNC(child, node_id) \
        PM_STATE_DT_ITEM_BY_IDX(node_id, child)
 
#define PM_STATE_DT_ITEMS_LIST(node_id) {           \
        UTIL_LISTIFY(PM_STATE_DT_ITEMS_LEN(node_id),\
                     PM_STATE_DT_ITEMS_LISTIFY_FUNC,\
                     node_id)                       \
        }
 
#ifdef __cplusplus
}
#endif
 
#endif