[linux-2.6-block.git] / Documentation / devicetree / bindings / thermal / tegra-soctherm.txt

Tegra124 SOCTHERM thermal management system

The SOCTHERM IP block contains thermal sensors, support for polled
or interrupt-based thermal monitoring, CPU and GPU throttling based
on temperature trip points, and handling external overcurrent
notifications. It is also used to manage emergency shutdown in an
overheating situation.

Required properties :
- compatible : For Tegra124, must contain "nvidia,tegra124-soctherm".
  For Tegra132, must contain "nvidia,tegra132-soctherm".
  For Tegra210, must contain "nvidia,tegra210-soctherm".
- reg : Should contain 1 entry:
  - SOCTHERM register set
- interrupts : Defines the interrupt used by SOCTHERM
- clocks : Must contain an entry for each entry in clock-names.
  See ../clocks/clock-bindings.txt for details.
- clock-names : Must include the following entries:
  - tsensor
  - soctherm
- resets : Must contain an entry for each entry in reset-names.
  See ../reset/reset.txt for details.
- reset-names : Must include the following entries:
  - soctherm
- #thermal-sensor-cells : Should be 1. See ./thermal.txt for a description
    of this property. See <dt-bindings/thermal/tegra124-soctherm.h> for a
    list of valid values when referring to thermal sensors.


Example :

	soctherm@0,700e2000 {
		compatible = "nvidia,tegra124-soctherm";
		reg = <0x0 0x700e2000 0x0 0x1000>;
		interrupts = <GIC_SPI 48 IRQ_TYPE_LEVEL_HIGH>;
		clocks = <&tegra_car TEGRA124_CLK_TSENSOR>,
			<&tegra_car TEGRA124_CLK_SOC_THERM>;
		clock-names = "tsensor", "soctherm";
		resets = <&tegra_car 78>;
		reset-names = "soctherm";

		#thermal-sensor-cells = <1>;
	};

Example: referring to thermal sensors :

       thermal-zones {
                cpu {
                        polling-delay-passive = <1000>;
                        polling-delay = <1000>;

                        thermal-sensors =
                                <&soctherm TEGRA124_SOCTHERM_SENSOR_CPU>;
                };
	};
Commit	Line	Data
0199e993 MP	1	Tegra124 SOCTHERM thermal management system
	2
	3	The SOCTHERM IP block contains thermal sensors, support for polled
	4	or interrupt-based thermal monitoring, CPU and GPU throttling based
	5	on temperature trip points, and handling external overcurrent
	6	notifications. It is also used to manage emergency shutdown in an
	7	overheating situation.
	8
	9	Required properties :
193c9d23 PW	10	- compatible : For Tegra124, must contain "nvidia,tegra124-soctherm".
	11	For Tegra132, must contain "nvidia,tegra132-soctherm".
	12	For Tegra210, must contain "nvidia,tegra210-soctherm".
0199e993 MP	13	- reg : Should contain 1 entry:
	14	- SOCTHERM register set
	15	- interrupts : Defines the interrupt used by SOCTHERM
	16	- clocks : Must contain an entry for each entry in clock-names.
	17	See ../clocks/clock-bindings.txt for details.
	18	- clock-names : Must include the following entries:
	19	- tsensor
	20	- soctherm
	21	- resets : Must contain an entry for each entry in reset-names.
	22	See ../reset/reset.txt for details.
	23	- reset-names : Must include the following entries:
	24	- soctherm
	25	- #thermal-sensor-cells : Should be 1. See ./thermal.txt for a description
	26	of this property. See <dt-bindings/thermal/tegra124-soctherm.h> for a
	27	list of valid values when referring to thermal sensors.
	28
	29
	30	Example :
	31
	32	soctherm@0,700e2000 {
	33	compatible = "nvidia,tegra124-soctherm";
	34	reg = <0x0 0x700e2000 0x0 0x1000>;
	35	interrupts = <GIC_SPI 48 IRQ_TYPE_LEVEL_HIGH>;
	36	clocks = <&tegra_car TEGRA124_CLK_TSENSOR>,
	37	<&tegra_car TEGRA124_CLK_SOC_THERM>;
	38	clock-names = "tsensor", "soctherm";
	39	resets = <&tegra_car 78>;
	40	reset-names = "soctherm";
	41
	42	#thermal-sensor-cells = <1>;
	43	};
	44
	45	Example: referring to thermal sensors :
	46
	47	thermal-zones {
	48	cpu {
	49	polling-delay-passive = <1000>;
	50	polling-delay = <1000>;
	51
	52	thermal-sensors =
	53	<&soctherm TEGRA124_SOCTHERM_SENSOR_CPU>;
	54	};
	55	};