chore(docs): drop the "wfi" from `pwr_domain_pwr_down_wfi`
To allow for generic handling of a wakeup, this hook is no longer
expected to call wfi itself. Update the name everywhere to reflect this
expectation so that future platform implementers don't get misled.
Change-Id: Ic33f0b6da74592ad6778fd802c2f0b85223af614
Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>
diff --git a/docs/porting-guide.rst b/docs/porting-guide.rst
index f0da2aa..84d029d 100644
--- a/docs/porting-guide.rst
+++ b/docs/porting-guide.rst
@@ -2897,7 +2897,7 @@
data, for example in DRAM. The Distributor can then be powered down using an
implementation-defined sequence.
-plat_psci_ops.pwr_domain_pwr_down_wfi()
+plat_psci_ops.pwr_domain_pwr_down()
.......................................
This is an optional function and, if implemented, is expected to perform
@@ -2968,7 +2968,7 @@
This function is called by PSCI implementation in response to a ``SYSTEM_OFF``
call. It performs the platform-specific system poweroff sequence after
notifying the Secure Payload Dispatcher. The caller will call ``wfi`` if this
-function returns, similar to `plat_psci_ops.pwr_domain_pwr_down_wfi()`_.
+function returns, similar to `plat_psci_ops.pwr_domain_pwr_down()`_.
plat_psci_ops.system_reset()
............................
@@ -2976,7 +2976,7 @@
This function is called by PSCI implementation in response to a ``SYSTEM_RESET``
call. It performs the platform-specific system reset sequence after
notifying the Secure Payload Dispatcher. The caller will call ``wfi`` if this
-function returns, similar to `plat_psci_ops.pwr_domain_pwr_down_wfi()`_.
+function returns, similar to `plat_psci_ops.pwr_domain_pwr_down()`_.
plat_psci_ops.validate_power_state()
....................................
@@ -3065,7 +3065,7 @@
resets, all failures must return ``PSCI_E_INVALID_PARAMETERS``
and vendor reset can return other PSCI error codes as defined
in `PSCI`_. If this function returns success, the caller will call
-``wfi`` similar to `plat_psci_ops.pwr_domain_pwr_down_wfi()`_.
+``wfi`` similar to `plat_psci_ops.pwr_domain_pwr_down()`_.
plat_psci_ops.write_mem_protect()
.................................
diff --git a/include/lib/psci/psci.h b/include/lib/psci/psci.h
index 3a5bdba..68e721a 100644
--- a/include/lib/psci/psci.h
+++ b/include/lib/psci/psci.h
@@ -331,7 +331,7 @@
const psci_power_state_t *target_state);
void (*pwr_domain_suspend_finish)(
const psci_power_state_t *target_state);
- void (*pwr_domain_pwr_down_wfi)(
+ void (*pwr_domain_pwr_down)(
const psci_power_state_t *target_state);
void (*system_off)(void);
void (*system_reset)(void);
diff --git a/lib/psci/psci_off.c b/lib/psci/psci_off.c
index dbc646c..577fdd7 100644
--- a/lib/psci/psci_off.c
+++ b/lib/psci/psci_off.c
@@ -163,9 +163,9 @@
RT_INSTR_ENTER_HW_LOW_PWR,
PMF_NO_CACHE_MAINT);
#endif
- if (psci_plat_pm_ops->pwr_domain_pwr_down_wfi != NULL) {
+ if (psci_plat_pm_ops->pwr_domain_pwr_down != NULL) {
/* This function may not return */
- psci_plat_pm_ops->pwr_domain_pwr_down_wfi(&state_info);
+ psci_plat_pm_ops->pwr_domain_pwr_down(&state_info);
}
psci_pwrdown_cpu_end_terminal();
diff --git a/lib/psci/psci_suspend.c b/lib/psci/psci_suspend.c
index baa3bd4..05bbe39 100644
--- a/lib/psci/psci_suspend.c
+++ b/lib/psci/psci_suspend.c
@@ -258,9 +258,9 @@
#endif
if (is_power_down_state != 0U) {
- if (psci_plat_pm_ops->pwr_domain_pwr_down_wfi != NULL) {
+ if (psci_plat_pm_ops->pwr_domain_pwr_down != NULL) {
/* This function may not return */
- psci_plat_pm_ops->pwr_domain_pwr_down_wfi(state_info);
+ psci_plat_pm_ops->pwr_domain_pwr_down(state_info);
}
psci_pwrdown_cpu_end_wakeup(max_off_lvl);
diff --git a/plat/amlogic/axg/axg_pm.c b/plat/amlogic/axg/axg_pm.c
index e67f263..8a1b5d2 100644
--- a/plat/amlogic/axg/axg_pm.c
+++ b/plat/amlogic/axg/axg_pm.c
@@ -152,7 +152,7 @@
.pwr_domain_on = axg_pwr_domain_on,
.pwr_domain_on_finish = axg_pwr_domain_on_finish,
.pwr_domain_off = axg_pwr_domain_off,
- .pwr_domain_pwr_down_wfi = axg_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = axg_pwr_domain_pwr_down_wfi,
.system_off = axg_system_off,
.system_reset = axg_system_reset
};
diff --git a/plat/amlogic/g12a/g12a_pm.c b/plat/amlogic/g12a/g12a_pm.c
index c9fe3e9..1203e3c 100644
--- a/plat/amlogic/g12a/g12a_pm.c
+++ b/plat/amlogic/g12a/g12a_pm.c
@@ -200,7 +200,7 @@
.pwr_domain_on = g12a_pwr_domain_on,
.pwr_domain_on_finish = g12a_pwr_domain_on_finish,
.pwr_domain_off = g12a_pwr_domain_off,
- .pwr_domain_pwr_down_wfi = g12a_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = g12a_pwr_domain_pwr_down_wfi,
.system_off = g12a_system_off,
.system_reset = g12a_system_reset
};
diff --git a/plat/amlogic/gxbb/gxbb_pm.c b/plat/amlogic/gxbb/gxbb_pm.c
index 48bff7b..eeebb41 100644
--- a/plat/amlogic/gxbb/gxbb_pm.c
+++ b/plat/amlogic/gxbb/gxbb_pm.c
@@ -176,7 +176,7 @@
.pwr_domain_on = gxbb_pwr_domain_on,
.pwr_domain_on_finish = gxbb_pwr_domain_on_finish,
.pwr_domain_off = gxbb_pwr_domain_off,
- .pwr_domain_pwr_down_wfi = gxbb_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = gxbb_pwr_domain_pwr_down_wfi,
.system_off = gxbb_system_off,
.system_reset = gxbb_system_reset,
};
diff --git a/plat/amlogic/gxl/gxl_pm.c b/plat/amlogic/gxl/gxl_pm.c
index 433140b..5af4932 100644
--- a/plat/amlogic/gxl/gxl_pm.c
+++ b/plat/amlogic/gxl/gxl_pm.c
@@ -199,7 +199,7 @@
.pwr_domain_on = gxl_pwr_domain_on,
.pwr_domain_on_finish = gxl_pwr_domain_on_finish,
.pwr_domain_off = gxl_pwr_domain_off,
- .pwr_domain_pwr_down_wfi = gxl_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = gxl_pwr_domain_pwr_down_wfi,
.system_off = gxl_system_off,
.system_reset = gxl_system_reset,
};
diff --git a/plat/imx/imx8m/imx8mm/imx8mm_psci.c b/plat/imx/imx8m/imx8mm/imx8mm_psci.c
index 815d3a2..766c7b3 100644
--- a/plat/imx/imx8m/imx8mm/imx8mm_psci.c
+++ b/plat/imx/imx8m/imx8mm/imx8mm_psci.c
@@ -25,7 +25,7 @@
.cpu_standby = imx_cpu_standby,
.pwr_domain_suspend = imx_domain_suspend,
.pwr_domain_suspend_finish = imx_domain_suspend_finish,
- .pwr_domain_pwr_down_wfi = imx_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = imx_pwr_domain_pwr_down_wfi,
.get_sys_suspend_power_state = imx_get_sys_suspend_power_state,
.system_reset = imx_system_reset,
.system_reset2 = imx_system_reset2,
diff --git a/plat/imx/imx8m/imx8mn/imx8mn_psci.c b/plat/imx/imx8m/imx8mn/imx8mn_psci.c
index f541fc1..4947d66 100644
--- a/plat/imx/imx8m/imx8mn/imx8mn_psci.c
+++ b/plat/imx/imx8m/imx8mn/imx8mn_psci.c
@@ -25,7 +25,7 @@
.cpu_standby = imx_cpu_standby,
.pwr_domain_suspend = imx_domain_suspend,
.pwr_domain_suspend_finish = imx_domain_suspend_finish,
- .pwr_domain_pwr_down_wfi = imx_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = imx_pwr_domain_pwr_down_wfi,
.get_sys_suspend_power_state = imx_get_sys_suspend_power_state,
.system_reset = imx_system_reset,
.system_off = imx_system_off,
diff --git a/plat/imx/imx8m/imx8mp/imx8mp_psci.c b/plat/imx/imx8m/imx8mp/imx8mp_psci.c
index bc7b246..0a8c351 100644
--- a/plat/imx/imx8m/imx8mp/imx8mp_psci.c
+++ b/plat/imx/imx8m/imx8mp/imx8mp_psci.c
@@ -25,7 +25,7 @@
.cpu_standby = imx_cpu_standby,
.pwr_domain_suspend = imx_domain_suspend,
.pwr_domain_suspend_finish = imx_domain_suspend_finish,
- .pwr_domain_pwr_down_wfi = imx_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = imx_pwr_domain_pwr_down_wfi,
.get_sys_suspend_power_state = imx_get_sys_suspend_power_state,
.system_reset = imx_system_reset,
.system_off = imx_system_off,
diff --git a/plat/imx/imx8m/imx8mq/imx8mq_psci.c b/plat/imx/imx8m/imx8mq/imx8mq_psci.c
index 3375ce7..c023b55 100644
--- a/plat/imx/imx8m/imx8mq/imx8mq_psci.c
+++ b/plat/imx/imx8m/imx8mq/imx8mq_psci.c
@@ -137,7 +137,7 @@
.cpu_standby = imx_cpu_standby,
.pwr_domain_suspend = imx_domain_suspend,
.pwr_domain_suspend_finish = imx_domain_suspend_finish,
- .pwr_domain_pwr_down_wfi = imx_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = imx_pwr_domain_pwr_down_wfi,
.get_sys_suspend_power_state = imx_get_sys_suspend_power_state,
.system_reset = imx_system_reset,
.system_reset2 = imx_system_reset2,
diff --git a/plat/imx/imx8ulp/imx8ulp_psci.c b/plat/imx/imx8ulp/imx8ulp_psci.c
index 628acea..59af8be 100644
--- a/plat/imx/imx8ulp/imx8ulp_psci.c
+++ b/plat/imx/imx8ulp/imx8ulp_psci.c
@@ -538,7 +538,7 @@
.pwr_domain_suspend_finish = imx_domain_suspend_finish,
.get_sys_suspend_power_state = imx_get_sys_suspend_power_state,
.validate_power_state = imx_validate_power_state,
- .pwr_domain_pwr_down_wfi = imx8ulp_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = imx8ulp_pwr_domain_pwr_down_wfi,
};
int plat_setup_psci_ops(uintptr_t sec_entrypoint,
diff --git a/plat/marvell/armada/a8k/common/plat_pm.c b/plat/marvell/armada/a8k/common/plat_pm.c
index f08f08a..ae3ee37 100644
--- a/plat/marvell/armada/a8k/common/plat_pm.c
+++ b/plat/marvell/armada/a8k/common/plat_pm.c
@@ -845,7 +845,7 @@
.pwr_domain_on_finish = a8k_pwr_domain_on_finish,
.get_sys_suspend_power_state = a8k_get_sys_suspend_power_state,
.pwr_domain_suspend_finish = a8k_pwr_domain_suspend_finish,
- .pwr_domain_pwr_down_wfi = a8k_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = a8k_pwr_domain_pwr_down_wfi,
.system_off = a8k_system_off,
.system_reset = a8k_system_reset,
.validate_power_state = a8k_validate_power_state,
diff --git a/plat/mediatek/lib/pm/mtk_pm.c b/plat/mediatek/lib/pm/mtk_pm.c
index 772c2d7..553fad2 100644
--- a/plat/mediatek/lib/pm/mtk_pm.c
+++ b/plat/mediatek/lib/pm/mtk_pm.c
@@ -45,8 +45,8 @@
mtk_pm_ops.get_sys_suspend_power_state = ops->get_sys_suspend_power_state;
}
- if (!mtk_pm_ops.pwr_domain_pwr_down_wfi)
- mtk_pm_ops.pwr_domain_pwr_down_wfi = ops->pwr_domain_pwr_down_wfi;
+ if (!mtk_pm_ops.pwr_domain_pwr_down)
+ mtk_pm_ops.pwr_domain_pwr_down = ops->pwr_domain_pwr_down_wfi;
mtk_pm_status |= MTK_PM_ST_PWR_READY;
#endif
diff --git a/plat/nuvoton/npcm845x/npcm845x_psci.c b/plat/nuvoton/npcm845x/npcm845x_psci.c
index a954265..6e9523e 100644
--- a/plat/nuvoton/npcm845x/npcm845x_psci.c
+++ b/plat/nuvoton/npcm845x/npcm845x_psci.c
@@ -384,7 +384,7 @@
/* For testing purposes only This PSCI states are not supported */
.pwr_domain_off = npcm845x_pwr_domain_off,
- .pwr_domain_pwr_down_wfi = npcm845x_pwr_down_wfi,
+ .pwr_domain_pwr_down = npcm845x_pwr_down_wfi,
};
/* For reference only
@@ -400,7 +400,7 @@
* const psci_power_state_t *target_state);
* void (*pwr_domain_suspend_finish)(
* const psci_power_state_t *target_state);
- * void __dead2 (*pwr_domain_pwr_down_wfi)(
+ * void __dead2 (*pwr_domain_pwr_down )(
* const psci_power_state_t *target_state);
* void __dead2 (*system_off)(void);
* void __dead2 (*system_reset)(void);
diff --git a/plat/nvidia/tegra/common/tegra_pm.c b/plat/nvidia/tegra/common/tegra_pm.c
index 8edb024..234cb6b 100644
--- a/plat/nvidia/tegra/common/tegra_pm.c
+++ b/plat/nvidia/tegra/common/tegra_pm.c
@@ -284,7 +284,7 @@
.pwr_domain_suspend = tegra_pwr_domain_suspend,
.pwr_domain_on_finish = tegra_pwr_domain_on_finish,
.pwr_domain_suspend_finish = tegra_pwr_domain_suspend_finish,
- .pwr_domain_pwr_down_wfi = tegra_pwr_domain_power_down_wfi,
+ .pwr_domain_pwr_down = tegra_pwr_domain_power_down_wfi,
.system_off = tegra_system_off,
.system_reset = tegra_system_reset,
.validate_power_state = tegra_validate_power_state,
diff --git a/plat/nxp/common/psci/plat_psci.c b/plat/nxp/common/psci/plat_psci.c
index f6dd7b3..c154a7f 100644
--- a/plat/nxp/common/psci/plat_psci.c
+++ b/plat/nxp/common/psci/plat_psci.c
@@ -433,7 +433,7 @@
.pwr_domain_off = _pwr_domain_off,
#endif
#if (SOC_CORE_OFF || SOC_CORE_PWR_DWN)
- .pwr_domain_pwr_down_wfi = _pwr_down_wfi,
+ .pwr_domain_pwr_down = _pwr_down_wfi,
#endif
#if (SOC_CORE_STANDBY || SOC_CORE_PWR_DWN)
/* cpu_suspend */
diff --git a/plat/qemu/common/qemu_pm.c b/plat/qemu/common/qemu_pm.c
index 5f64d70..7893c81 100644
--- a/plat/qemu/common/qemu_pm.c
+++ b/plat/qemu/common/qemu_pm.c
@@ -218,7 +218,7 @@
.cpu_standby = qemu_cpu_standby,
.pwr_domain_on = qemu_pwr_domain_on,
.pwr_domain_off = qemu_pwr_domain_off,
- .pwr_domain_pwr_down_wfi = qemu_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = qemu_pwr_domain_pwr_down_wfi,
.pwr_domain_suspend = qemu_pwr_domain_suspend,
.pwr_domain_on_finish = qemu_pwr_domain_on_finish,
.pwr_domain_suspend_finish = qemu_pwr_domain_suspend_finish,
diff --git a/plat/qemu/qemu_sbsa/sbsa_pm.c b/plat/qemu/qemu_sbsa/sbsa_pm.c
index 8d1e1d4..7ce7beb 100644
--- a/plat/qemu/qemu_sbsa/sbsa_pm.c
+++ b/plat/qemu/qemu_sbsa/sbsa_pm.c
@@ -215,7 +215,7 @@
.cpu_standby = qemu_cpu_standby,
.pwr_domain_on = qemu_pwr_domain_on,
.pwr_domain_off = qemu_pwr_domain_off,
- .pwr_domain_pwr_down_wfi = qemu_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = qemu_pwr_domain_pwr_down_wfi,
.pwr_domain_suspend = qemu_pwr_domain_suspend,
.pwr_domain_on_finish = qemu_pwr_domain_on_finish,
.pwr_domain_suspend_finish = qemu_pwr_domain_suspend_finish,
diff --git a/plat/qti/common/src/qti_pm.c b/plat/qti/common/src/qti_pm.c
index 4400e40..2428126 100644
--- a/plat/qti/common/src/qti_pm.c
+++ b/plat/qti/common/src/qti_pm.c
@@ -278,7 +278,7 @@
.pwr_domain_off = qti_node_power_off,
.pwr_domain_suspend = qti_node_suspend,
.pwr_domain_suspend_finish = qti_node_suspend_finish,
- .pwr_domain_pwr_down_wfi = qti_domain_power_down_wfi,
+ .pwr_domain_pwr_down = qti_domain_power_down_wfi,
.system_off = qti_system_off,
.system_reset = qti_system_reset,
.get_node_hw_state = NULL,
diff --git a/plat/renesas/common/plat_pm.c b/plat/renesas/common/plat_pm.c
index 9810596..871dddc 100644
--- a/plat/renesas/common/plat_pm.c
+++ b/plat/renesas/common/plat_pm.c
@@ -302,7 +302,7 @@
.system_off = rcar_system_off,
.system_reset = rcar_system_reset,
.validate_power_state = rcar_validate_power_state,
- .pwr_domain_pwr_down_wfi = rcar_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = rcar_pwr_domain_pwr_down_wfi,
#if RCAR_SYSTEM_SUSPEND
.get_sys_suspend_power_state = rcar_get_sys_suspend_power_state,
#endif
diff --git a/plat/rockchip/common/plat_pm.c b/plat/rockchip/common/plat_pm.c
index c3dc234..df74033 100644
--- a/plat/rockchip/common/plat_pm.c
+++ b/plat/rockchip/common/plat_pm.c
@@ -395,7 +395,7 @@
.pwr_domain_suspend = rockchip_pwr_domain_suspend,
.pwr_domain_on_finish = rockchip_pwr_domain_on_finish,
.pwr_domain_suspend_finish = rockchip_pwr_domain_suspend_finish,
- .pwr_domain_pwr_down_wfi = rockchip_pd_pwr_down_wfi,
+ .pwr_domain_pwr_down = rockchip_pd_pwr_down_wfi,
.system_reset = rockchip_system_reset,
.system_off = rockchip_system_poweroff,
.validate_power_state = rockchip_validate_power_state,
diff --git a/plat/rpi/common/rpi3_pm.c b/plat/rpi/common/rpi3_pm.c
index 456e160..4dfe8f0 100644
--- a/plat/rpi/common/rpi3_pm.c
+++ b/plat/rpi/common/rpi3_pm.c
@@ -272,7 +272,7 @@
.pwr_domain_off = rpi3_pwr_domain_off,
.pwr_domain_on = rpi3_pwr_domain_on,
.pwr_domain_on_finish = rpi3_pwr_domain_on_finish,
- .pwr_domain_pwr_down_wfi = rpi3_pwr_down_wfi,
+ .pwr_domain_pwr_down = rpi3_pwr_down_wfi,
.system_off = rpi3_system_off,
.system_reset = rpi3_system_reset,
.validate_power_state = rpi3_validate_power_state,
diff --git a/plat/socionext/uniphier/uniphier_psci.c b/plat/socionext/uniphier/uniphier_psci.c
index a371705..b009c5e 100644
--- a/plat/socionext/uniphier/uniphier_psci.c
+++ b/plat/socionext/uniphier/uniphier_psci.c
@@ -113,7 +113,7 @@
.pwr_domain_on = uniphier_psci_pwr_domain_on,
.pwr_domain_off = uniphier_psci_pwr_domain_off,
.pwr_domain_on_finish = uniphier_psci_pwr_domain_on_finish,
- .pwr_domain_pwr_down_wfi = uniphier_psci_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = uniphier_psci_pwr_domain_pwr_down_wfi,
.system_off = uniphier_psci_system_off,
.system_reset = uniphier_psci_system_reset,
};
diff --git a/plat/st/stm32mp1/stm32mp1_pm.c b/plat/st/stm32mp1/stm32mp1_pm.c
index 97e1ac6..7841022 100644
--- a/plat/st/stm32mp1/stm32mp1_pm.c
+++ b/plat/st/stm32mp1/stm32mp1_pm.c
@@ -215,7 +215,7 @@
.pwr_domain_suspend = stm32_pwr_domain_suspend,
.pwr_domain_on_finish = stm32_pwr_domain_on_finish,
.pwr_domain_suspend_finish = stm32_pwr_domain_suspend_finish,
- .pwr_domain_pwr_down_wfi = stm32_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = stm32_pwr_domain_pwr_down_wfi,
.system_off = stm32_system_off,
.system_reset = stm32_system_reset,
.validate_power_state = stm32_validate_power_state,
diff --git a/plat/st/stm32mp2/stm32mp2_pm.c b/plat/st/stm32mp2/stm32mp2_pm.c
index 5bb381d..9be42c5 100644
--- a/plat/st/stm32mp2/stm32mp2_pm.c
+++ b/plat/st/stm32mp2/stm32mp2_pm.c
@@ -103,7 +103,7 @@
.pwr_domain_suspend = stm32_pwr_domain_suspend,
.pwr_domain_on_finish = stm32_pwr_domain_on_finish,
.pwr_domain_suspend_finish = stm32_pwr_domain_suspend_finish,
- .pwr_domain_pwr_down_wfi = stm32_pwr_domain_pwr_down_wfi,
+ .pwr_domain_pwr_down = stm32_pwr_domain_pwr_down_wfi,
.system_off = stm32_system_off,
.system_reset = stm32_system_reset,
.validate_power_state = stm32_validate_power_state,