diff mbox

[1/6] thermal: sti: Supply Device Tree documentation

Message ID 1401442715-6350-2-git-send-email-lee.jones@linaro.org
State New
Headers show

Commit Message

Lee Jones May 30, 2014, 9:38 a.m. UTC
Signed-off-by: Ajit Pal Singh <ajitpal.singh@st.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 .../devicetree/bindings/thermal/st-thermal.txt     | 42 ++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/st-thermal.txt

Comments

Peter Griffin June 5, 2014, 12:01 p.m. UTC | #1
Hi Lee,

> +Example:
> +
> +	temp1@fdfe8000 {
> +		compatible	= "st,stih416-mpe-thermal";
> +		reg		= <0xfdfe8000 0x10>;
> +		clock-names	= "thermal";
> +		clocks		= <&CLK_M_MPETHSENS>;
> +		interrupts	= <GIC_SPI 23 IRQ_TYPE_NONE>;
> +	};

With the renaming of the STI device tree from upper to lower
case. The clock name in this example also needs updating.

Once fixed: -
 Acked-by: Peter Griffin <peter.griffin@linaro.org>

Regards,

Peter
--
To unsubscribe from this list: send the line "unsubscribe linux-pm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Lee Jones June 5, 2014, 12:25 p.m. UTC | #2
On Thu, 05 Jun 2014, Peter Griffin wrote:

> Hi Lee,
> 
> > +Example:
> > +
> > +	temp1@fdfe8000 {
> > +		compatible	= "st,stih416-mpe-thermal";
> > +		reg		= <0xfdfe8000 0x10>;
> > +		clock-names	= "thermal";
> > +		clocks		= <&CLK_M_MPETHSENS>;
> > +		interrupts	= <GIC_SPI 23 IRQ_TYPE_NONE>;
> > +	};
> 
> With the renaming of the STI device tree from upper to lower
> case. The clock name in this example also needs updating.

You're right.  Will rebase and fix.

> Once fixed: -
>  Acked-by: Peter Griffin <peter.griffin@linaro.org>
> 
> Regards,
> 
> Peter
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/thermal/st-thermal.txt b/Documentation/devicetree/bindings/thermal/st-thermal.txt
new file mode 100644
index 0000000..8537fdc
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/st-thermal.txt
@@ -0,0 +1,42 @@ 
+Binding for Thermal Sensor driver for STMicroelectronics STi series of SoCs.
+
+Required parameters:
+-------------------
+
+compatible : 	st,<SoC>-<module>-thermal; should be one of:
+		  "st,stih415-sas-thermal",
+		  "st,stih415-mpe-thermal",
+		  "st,stih416-sas-thermal"
+		  "st,stih416-mpe-thermal"
+		  "st,stid127-thermal" or
+		  "st,stih407-thermal"
+		according to the SoC type (stih415, stih416, stid127, stih407)
+		and module type (sas or mpe). On stid127 & stih407 there is only
+		one die/module, so there is no module type in the compatible
+		string.
+clock-names : 	Should be "thermal".
+		  See: Documentation/devicetree/bindings/resource-names.txt
+clocks : 	Phandle of the clock used by the thermal sensor.
+		  See: Documentation/devicetree/bindings/clock/clock-bindings.txt
+
+Optional parameters:
+-------------------
+
+reg : 		For non-sysconf based sensors, this should be the physical base
+		address and length of the sensor's registers.
+interrupts :	Standard way to define interrupt number.
+		Interrupt is mandatory to be defined when compatible is
+		"stih416-mpe-thermal".
+		  NB: For thermal sensor's for which no interrupt has been
+		  defined, a polling delay of 1000ms will be used to read the
+		  temperature from device.
+
+Example:
+
+	temp1@fdfe8000 {
+		compatible	= "st,stih416-mpe-thermal";
+		reg		= <0xfdfe8000 0x10>;
+		clock-names	= "thermal";
+		clocks		= <&CLK_M_MPETHSENS>;
+		interrupts	= <GIC_SPI 23 IRQ_TYPE_NONE>;
+	};