pm: state: PM_STATE_DT_ITEMS_LIST->PM_STATE_LIST_FROM_DT_CPU

Rename the PM_STATE_DT_ITEMS_LIST macro to PM_STATE_LIST_FROM_DT_CPU to
make its purpose more clear. Similar naming scheme is found e.g. in the
GPIO API.

Associated internal macros and docstrings have been adjusted, too.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-12-01 19:37:40 +01:00 committed by Anas Nashif
commit 5ab7d35e7c
3 changed files with 12 additions and 14 deletions

View file

@ -304,7 +304,7 @@ static inline uint8_t reg_interval(const struct device *dev)
#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_PM) #if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_PM)
static const enum pm_state pm_states[] = static const enum pm_state pm_states[] =
PM_STATE_DT_ITEMS_LIST(DT_NODELABEL(cpu0)); PM_STATE_LIST_FROM_DT_CPU(DT_NODELABEL(cpu0));
#endif #endif
static const struct uart_driver_api uart_ns16550_driver_api; static const struct uart_driver_api uart_ns16550_driver_api;

View file

@ -169,15 +169,14 @@ struct pm_state_info {
PM_STATE_INFO_DT_INIT(DT_PHANDLE_BY_IDX(node_id, cpu_power_states, i)), PM_STATE_INFO_DT_INIT(DT_PHANDLE_BY_IDX(node_id, cpu_power_states, i)),
/** /**
* @brief Macro function to construct enum pm_state item in UTIL_LISTIFY * @brief Helper macro to initialize an entry of a struct pm_state array when
* extension. * using UTIL_LISTIFY in PM_STATE_LIST_FROM_DT_CPU.
* *
* @param child child index in UTIL_LISTIFY extension. * @param i UTIL_LISTIFY entry index.
* @param node_id A node identifier with compatible zephyr,power-state * @param node_id A node identifier with compatible zephyr,power-state
* @return macro function to construct a pm_state enum
*/ */
#define Z_PM_STATE_DT_ITEMS_LISTIFY_FUNC(child, node_id) \ #define Z_PM_STATE_FROM_DT_CPU(i, node_id) \
PM_STATE_DT_INIT(DT_PHANDLE_BY_IDX(node_id, cpu_power_states, child)), PM_STATE_DT_INIT(DT_PHANDLE_BY_IDX(node_id, cpu_power_states, i)),
/** @endcond */ /** @endcond */
@ -263,8 +262,8 @@ struct pm_state_info {
} }
/** /**
* @brief Macro function to construct a list of enum pm_state items by * @brief Initialize an array of struct pm_state with information from all the
* UTIL_LISTIFY func * states present in the given CPU node identifier.
* *
* Example devicetree fragment: * Example devicetree fragment:
* *
@ -299,16 +298,15 @@ struct pm_state_info {
* Example usage: * Example usage:
* *
* @code{.c} * @code{.c}
* const enum pm_state states[] = PM_STATE_DT_ITEMS_LIST(DT_NODELABEL(cpu0)); * const enum pm_state states[] = PM_STATE_LIST_FROM_DT_CPU(DT_NODELABEL(cpu0));
* @endcode * @endcode
* *
* @param node_id A CPU node identifier. * @param node_id A CPU node identifier.
* @return an array of enum pm_state items.
*/ */
#define PM_STATE_DT_ITEMS_LIST(node_id) \ #define PM_STATE_LIST_FROM_DT_CPU(node_id) \
{ \ { \
UTIL_LISTIFY(PM_STATE_DT_ITEMS_LEN(node_id), \ UTIL_LISTIFY(PM_STATE_DT_ITEMS_LEN(node_id), \
Z_PM_STATE_DT_ITEMS_LISTIFY_FUNC,node_id) \ Z_PM_STATE_FROM_DT_CPU, node_id) \
} }
/** /**

View file

@ -21,7 +21,7 @@ static enum pm_state wrong_states[] = {PM_STATE_SUSPEND_TO_DISK,
void test_power_states(void) void test_power_states(void)
{ {
enum pm_state dts_states[] = enum pm_state dts_states[] =
PM_STATE_DT_ITEMS_LIST(DT_NODELABEL(power_states)); PM_STATE_LIST_FROM_DT_CPU(DT_NODELABEL(power_states));
struct pm_state_info dts_infos[] = struct pm_state_info dts_infos[] =
PM_STATE_INFO_LIST_FROM_DT_CPU(DT_NODELABEL(power_states)); PM_STATE_INFO_LIST_FROM_DT_CPU(DT_NODELABEL(power_states));
uint32_t dts_states_len = uint32_t dts_states_len =