[PATCHv1 2/8] Documentation: arm: Link idle-states binding to code

From: Amit Kucheria
Date: Fri May 10 2019 - 07:31:21 EST

The enable-method needs to be psci for the psci_cpuidle_ops to be
correctly registered.

Add a note to the binding documentation on where to find the declaration
of the enable-method since it is a macro and escapes any attempts to
grep for it.

Cc: Sudeep Holla <sudeep.holla@xxxxxxx>
Signed-off-by: Amit Kucheria <amit.kucheria@xxxxxxxxxx>
Documentation/devicetree/bindings/arm/idle-states.txt | 7 +++++++
1 file changed, 7 insertions(+)

diff --git a/Documentation/devicetree/bindings/arm/idle-states.txt b/Documentation/devicetree/bindings/arm/idle-states.txt
index 45730ba60af5..3a42335a6f3d 100644
--- a/Documentation/devicetree/bindings/arm/idle-states.txt
+++ b/Documentation/devicetree/bindings/arm/idle-states.txt
@@ -239,6 +239,10 @@ processor idle states, defined as device tree nodes, are listed.
# On ARM v8 64-bit this property is required and must
- "psci"
+ (This assumes that the enable-method is "psci"
+ in the cpu node[6] that then uses the
+ CPUIDLE_METHOD_OF_DECLARE macro to setup the
+ psci_cpuidle_ops callbacks)
# On ARM 32-bit systems this property is optional

The nodes describing the idle states (state) can only be defined within the
@@ -697,3 +701,6 @@ cpus {

[5] Devicetree Specification
+[6] ARM Linux Kernel documentation - Booting AArch64 Linux
+ Documentation/arm64/booting.txt