summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authordanh-arm <dan.handley@arm.com>2016-05-27 11:08:45 +0100
committerdanh-arm <dan.handley@arm.com>2016-05-27 11:08:45 +0100
commit2ff900f28df5f975e1c1746e59610df5ccabf7aa (patch)
treec55b402e1ffa2779efe3f2613275245a79a89c73 /docs
parent8c94f82c678312fcdfc3eee8b819ca1c0da723fb (diff)
parentac1cc8eb76c39bca445478c2dffa9cd18829cff4 (diff)
Merge pull request #633 from soby-mathew/sm/psci_wfi_hook
PSCI: Add pwr_domain_pwr_down_wfi() hook in plat_psci_ops
Diffstat (limited to 'docs')
-rw-r--r--docs/porting-guide.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/porting-guide.md b/docs/porting-guide.md
index 0cd36134..8947defb 100644
--- a/docs/porting-guide.md
+++ b/docs/porting-guide.md
@@ -1715,6 +1715,22 @@ latter case, the power domain is expected to save enough state so that it can
resume execution by restoring this state when its powered on (see
`pwr_domain_suspend_finish()`).
+#### plat_psci_ops.pwr_domain_pwr_down_wfi()
+
+This is an optional function and, if implemented, is expected to perform
+platform specific actions including the `wfi` invocation which allows the
+CPU to powerdown. Since this function is invoked outside the PSCI locks,
+the actions performed in this hook must be local to the CPU or the platform
+must ensure that races between multiple CPUs cannot occur.
+
+The `target_state` has a similar meaning as described in the `pwr_domain_off()`
+operation and it encodes the platform coordinated target local power states for
+the CPU power domain and its parent power domain levels. This function must
+not return back to the caller.
+
+If this function is not implemented by the platform, PSCI generic
+implementation invokes `psci_power_down_wfi()` for power down.
+
#### plat_psci_ops.pwr_domain_on_finish()
This function is called by the PSCI implementation after the calling CPU is