aboutsummaryrefslogtreecommitdiffstats
path: root/docs/porting-guide.md
diff options
context:
space:
mode:
authorJeenu Viswambharan <jeenu.viswambharan@arm.com>2016-08-03 15:54:50 +0100
committerJeenu Viswambharan <jeenu.viswambharan@arm.com>2016-09-15 11:17:55 +0100
commit28d3d614b57730bdf364e49259d3c42599d26145 (patch)
tree5c86445a3cd7cdb46ccd2508264a7c41cc253b43 /docs/porting-guide.md
parent77b05323921c23e4261ddd8fee5c326a79b0af97 (diff)
downloadplatform_external_arm-trusted-firmware-28d3d614b57730bdf364e49259d3c42599d26145.tar.gz
platform_external_arm-trusted-firmware-28d3d614b57730bdf364e49259d3c42599d26145.tar.bz2
platform_external_arm-trusted-firmware-28d3d614b57730bdf364e49259d3c42599d26145.zip
PSCI: Add support for PSCI NODE_HW_STATE API
This patch adds support for NODE_HW_STATE PSCI API by introducing a new PSCI platform hook (get_node_hw_state). The implementation validates supplied arguments, and then invokes this platform-defined hook and returns its result to the caller. PSCI capabilities are updated accordingly. Also updates porting and firmware design guides. Change-Id: I808e55bdf0c157002a7c104b875779fe50a68a30
Diffstat (limited to 'docs/porting-guide.md')
-rw-r--r--docs/porting-guide.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/porting-guide.md b/docs/porting-guide.md
index 8dad4a051..195c9374d 100644
--- a/docs/porting-guide.md
+++ b/docs/porting-guide.md
@@ -1832,6 +1832,20 @@ This function can also be used in case the platform wants to support local
power state encoding for `power_state` parameter of PSCI_STAT_COUNT/RESIDENCY
APIs as described in Section 5.18 of [PSCI].
+#### plat_psci_ops.get_node_hw_state()
+
+This is an optional function. If implemented this function is intended to return
+the power state of a node (identified by the first parameter, the `MPIDR`) in
+the power domain topology (identified by the second parameter, `power_level`),
+as retrieved from a power controller or equivalent component on the platform.
+Upon successful completion, the implementation must map and return the final
+status among `HW_ON`, `HW_OFF` or `HW_STANDBY`. Upon encountering failures, it
+must return either `PSCI_E_INVALID_PARAMS` or `PSCI_E_NOT_SUPPORTED` as
+appropriate.
+
+Implementations are not expected to handle `power_levels` greater than
+`PLAT_MAX_PWR_LVL`.
+
3.6 Interrupt Management framework (in BL31)
----------------------------------------------
BL31 implements an Interrupt Management Framework (IMF) to manage interrupts