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()
.................................