Documentation: add DT bindings for ARM SCPI power domains
authorSudeep Holla <sudeep.holla@arm.com>
Sun, 5 Jun 2016 17:50:50 +0000 (18:50 +0100)
committerSudeep Holla <sudeep.holla@arm.com>
Tue, 21 Jun 2016 09:16:00 +0000 (10:16 +0100)
The System Control Processor (SCP) provides peripheral devices with
power domains that can be enabled and disabled viathe System Control
and Power Interface (SCPI) Message Protocol. Add bindings to allow
probing of these device power domians.

Cc: Rob Herring <robh+dt@kernel.org>
Tested-by: Mathieu Poirier <mathieu.poirier@linaro.org>
Tested-by: Jon Medhurst <tixy@linaro.org>
Acked-by: Mark Rutland <mark.rutland@arm.com>
Reviewed-by: Jon Medhurst <tixy@linaro.org>
Reviewed-by: Kevin Hilman <khilman@baylibre.com>
Reviewed-by: Ulf Hansson <ulf.hansson@linaro.org>
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
Documentation/devicetree/bindings/arm/arm,scpi.txt

index 313dabdc14f9874273e4ed87b32b27c75c3c4bdb..faa4b44572e36e4bbe6342dd0dd2d0372e4da614 100644 (file)
@@ -87,10 +87,33 @@ Required properties:
                         implementation for the IDs to use. For Juno
                         R0 and Juno R1 refer to [3].
 
+Power domain bindings for the power domains based on SCPI Message Protocol
+------------------------------------------------------------
+
+This binding uses the generic power domain binding[4].
+
+PM domain providers
+===================
+
+Required properties:
+ - #power-domain-cells : Should be 1. Contains the device or the power
+                        domain ID value used by SCPI commands.
+ - num-domains: Total number of power domains provided by SCPI. This is
+               needed as the SCPI message protocol lacks a mechanism to
+               query this information at runtime.
+
+PM domain consumers
+===================
+
+Required properties:
+ - power-domains : A phandle and PM domain specifier as defined by bindings of
+                   the power controller specified by phandle.
+
 [0] http://infocenter.arm.com/help/topic/com.arm.doc.dui0922b/index.html
 [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
 [2] Documentation/devicetree/bindings/thermal/thermal.txt
 [3] http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0922b/apas03s22.html
+[4] Documentation/devicetree/bindings/power/power_domain.txt
 
 Example:
 
@@ -144,6 +167,12 @@ scpi_protocol: scpi@2e000000 {
                compatible = "arm,scpi-sensors";
                #thermal-sensor-cells = <1>;
        };
+
+       scpi_devpd: scpi-power-domains {
+               compatible = "arm,scpi-power-domains";
+               num-domains = <2>;
+               #power-domain-cells = <1>;
+       };
 };
 
 cpu@0 {
@@ -156,6 +185,7 @@ hdlcd@7ff60000 {
        ...
        reg = <0 0x7ff60000 0 0x1000>;
        clocks = <&scpi_clk 4>;
+       power-domains = <&scpi_devpd 1>;
 };
 
 thermal-zones {
@@ -186,3 +216,7 @@ The thermal-sensors property in the soc_thermal node uses the
 temperature sensor provided by SCP firmware to setup a thermal
 zone. The ID "3" is the sensor identifier for the temperature sensor
 as used by the firmware.
+
+The num-domains property in scpi-power-domains domain specifies that
+SCPI provides 2 power domains. The hdlcd node uses the power domain with
+domain ID 1.