[deliverable/linux.git] / Documentation / devicetree / bindings / thermal / st-thermal.txt

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>;
	};
Commit	Line	Data
a5635912 LJ	1	Binding for Thermal Sensor driver for STMicroelectronics STi series of SoCs.
	2
	3	Required parameters:
	4	-------------------
	5
	6	compatible : st,<SoC>-<module>-thermal; should be one of:
	7	"st,stih415-sas-thermal",
	8	"st,stih415-mpe-thermal",
	9	"st,stih416-sas-thermal"
	10	"st,stih416-mpe-thermal"
	11	"st,stid127-thermal" or
	12	"st,stih407-thermal"
	13	according to the SoC type (stih415, stih416, stid127, stih407)
	14	and module type (sas or mpe). On stid127 & stih407 there is only
	15	one die/module, so there is no module type in the compatible
	16	string.
	17	clock-names : Should be "thermal".
	18	See: Documentation/devicetree/bindings/resource-names.txt
	19	clocks : Phandle of the clock used by the thermal sensor.
	20	See: Documentation/devicetree/bindings/clock/clock-bindings.txt
	21
	22	Optional parameters:
	23	-------------------
	24
	25	reg : For non-sysconf based sensors, this should be the physical base
	26	address and length of the sensor's registers.
	27	interrupts : Standard way to define interrupt number.
	28	Interrupt is mandatory to be defined when compatible is
	29	"stih416-mpe-thermal".
	30	NB: For thermal sensor's for which no interrupt has been
	31	defined, a polling delay of 1000ms will be used to read the
	32	temperature from device.
	33
	34	Example:
	35
	36	temp1@fdfe8000 {
	37	compatible = "st,stih416-mpe-thermal";
	38	reg = <0xfdfe8000 0x10>;
	39	clock-names = "thermal";
	40	clocks = <&clk_m_mpethsens>;
	41	interrupts = <GIC_SPI 23 IRQ_TYPE_NONE>;
	42	};