[v14,2/5] dt-bindings: document Rockchip thermal
diff mbox

Message ID 1414377588-2237-3-git-send-email-caesar.wang@rock-chips.com
State New, archived
Headers show

Commit Message

Wang Caesar Oct. 27, 2014, 2:39 a.m. UTC
This add the necessary binding documentation for the thermal
found on Rockchip SoCs

Signed-off-by: zhaoyifeng <zyf@rock-chips.com>
Signed-off-by: Caesar Wang <caesar.wang@rock-chips.com>
---
 .../bindings/thermal/rockchip-thermal.txt          | 53 ++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/rockchip-thermal.txt

Comments

Dmitry Torokhov Oct. 28, 2014, 12:29 a.m. UTC | #1
On Mon, Oct 27, 2014 at 10:39:45AM +0800, Caesar Wang wrote:
> This add the necessary binding documentation for the thermal
> found on Rockchip SoCs
> 
> Signed-off-by: zhaoyifeng <zyf@rock-chips.com>
> Signed-off-by: Caesar Wang <caesar.wang@rock-chips.com>
> ---
>  .../bindings/thermal/rockchip-thermal.txt          | 53 ++++++++++++++++++++++
>  1 file changed, 53 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> 
> diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> new file mode 100644
> index 0000000..d5b1401
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> @@ -0,0 +1,53 @@
> +* Temperature Sensor ADC (TSADC) on rockchip SoCs
> +
> +Required properties:
> +- compatible : "rockchip,rk3288-tsadc"
> +- reg : physical base address of the controller and length of memory mapped
> +	region.
> +- interrupts : The interrupt number to the cpu. The interrupt specifier format
> +	       depends on the interrupt controller.
> +- clocks : Must contain an entry for each entry in clock-names.
> +- clock-names : Shall be "tsadc" for the converter-clock, and "apb_pclk" for
> +		the peripheral clock.
> +- #thermal-sensor-cells : Should be 1. See ./thermal.txt for a description.

I think you are missing description of hw-shut-temp, tsadc-tshut-mode
and tsadc-tshut-polarity and optional pinctrl settings.

> +
> +Exiample:
> +tsadc: tsadc@ff280000 {
> +	compatible = "rockchip,rk3288-tsadc";
> +	reg = <0xff280000 0x100>;
> +	interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
> +	clocks = <&cru SCLK_TSADC>, <&cru PCLK_TSADC>;
> +	clock-names = "tsadc", "apb_pclk";
> +};
> +
> +Example: referring to thermal sensors:
> +thermal-zones {
> +	cpu_thermal: cpu_thermal {
> +		polling-delay-passive = <1000>; /* milliseconds */
> +		polling-delay = <5000>; /* milliseconds */
> +
> +		/* sensor	ID */
> +		thermal-sensors = <&tsadc	1>;
> +
> +		trips {
> +			cpu_alert0: cpu_alert {
> +				temperature = <80000>; /* millicelsius */
> +				hysteresis = <2000>; /* millicelsius */
> +				type = "passive";
> +			};
> +			cpu_crit: cpu_crit {
> +				temperature = <120000>; /* millicelsius */
> +				hysteresis = <2000>; /* millicelsius */
> +				type = "critical";
> +			};
> +		};
> +
> +		cooling-maps {
> +			map0 {
> +				trip = <&cpu_alert0>;
> +				cooling-device =
> +					<&cpu0 THERMAL_NO_LIMIT THERMAL_NO_LIMIT>;
> +			};
> +		};
> +	};
> +};
> -- 
> 1.9.1
> 
>
Wang Caesar Oct. 28, 2014, 12:32 a.m. UTC | #2
Dmitry,

? 2014?10?28? 08:29, Dmitry Torokhov ??:
> On Mon, Oct 27, 2014 at 10:39:45AM +0800, Caesar Wang wrote:
>> This add the necessary binding documentation for the thermal
>> found on Rockchip SoCs
>>
>> Signed-off-by: zhaoyifeng <zyf@rock-chips.com>
>> Signed-off-by: Caesar Wang <caesar.wang@rock-chips.com>
>> ---
>>   .../bindings/thermal/rockchip-thermal.txt          | 53 ++++++++++++++++++++++
>>   1 file changed, 53 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>
>> diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>> new file mode 100644
>> index 0000000..d5b1401
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>> @@ -0,0 +1,53 @@
>> +* Temperature Sensor ADC (TSADC) on rockchip SoCs
>> +
>> +Required properties:
>> +- compatible : "rockchip,rk3288-tsadc"
>> +- reg : physical base address of the controller and length of memory mapped
>> +	region.
>> +- interrupts : The interrupt number to the cpu. The interrupt specifier format
>> +	       depends on the interrupt controller.
>> +- clocks : Must contain an entry for each entry in clock-names.
>> +- clock-names : Shall be "tsadc" for the converter-clock, and "apb_pclk" for
>> +		the peripheral clock.
>> +- #thermal-sensor-cells : Should be 1. See ./thermal.txt for a description.
> I think you are missing description of hw-shut-temp, tsadc-tshut-mode
> and tsadc-tshut-mode
>   and optional pinctrl settings.

If it's really need,we just have hw-shut-temp,tsadc-tshut-mode
and tsadc-tshut-mode,no need  pinctrl setting,I think.

>> +
>> +Exiample:
>> +tsadc: tsadc@ff280000 {
>> +	compatible = "rockchip,rk3288-tsadc";
>> +	reg = <0xff280000 0x100>;
>> +	interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
>> +	clocks = <&cru SCLK_TSADC>, <&cru PCLK_TSADC>;
>> +	clock-names = "tsadc", "apb_pclk";
>> +};
>> +
>> +Example: referring to thermal sensors:
>> +thermal-zones {
>> +	cpu_thermal: cpu_thermal {
>> +		polling-delay-passive = <1000>; /* milliseconds */
>> +		polling-delay = <5000>; /* milliseconds */
>> +
>> +		/* sensor	ID */
>> +		thermal-sensors = <&tsadc	1>;
>> +
>> +		trips {
>> +			cpu_alert0: cpu_alert {
>> +				temperature = <80000>; /* millicelsius */
>> +				hysteresis = <2000>; /* millicelsius */
>> +				type = "passive";
>> +			};
>> +			cpu_crit: cpu_crit {
>> +				temperature = <120000>; /* millicelsius */
>> +				hysteresis = <2000>; /* millicelsius */
>> +				type = "critical";
>> +			};
>> +		};
>> +
>> +		cooling-maps {
>> +			map0 {
>> +				trip = <&cpu_alert0>;
>> +				cooling-device =
>> +					<&cpu0 THERMAL_NO_LIMIT THERMAL_NO_LIMIT>;
>> +			};
>> +		};
>> +	};
>> +};
>> -- 
>> 1.9.1
>>
>>
Dmitry Torokhov Oct. 28, 2014, 12:37 a.m. UTC | #3
On Tuesday, October 28, 2014 08:32:45 AM Caesar Wang wrote:
> Dmitry,
> 
> ? 2014?10?28? 08:29, Dmitry Torokhov ??:
> > On Mon, Oct 27, 2014 at 10:39:45AM +0800, Caesar Wang wrote:
> >> This add the necessary binding documentation for the thermal
> >> found on Rockchip SoCs
> >> 
> >> Signed-off-by: zhaoyifeng <zyf@rock-chips.com>
> >> Signed-off-by: Caesar Wang <caesar.wang@rock-chips.com>
> >> ---
> >> 
> >>   .../bindings/thermal/rockchip-thermal.txt          | 53
> >>   ++++++++++++++++++++++ 1 file changed, 53 insertions(+)
> >>   create mode 100644
> >>   Documentation/devicetree/bindings/thermal/rockchip-thermal.txt>> 
> >> diff --git
> >> a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> >> b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt new
> >> file mode 100644
> >> index 0000000..d5b1401
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> >> @@ -0,0 +1,53 @@
> >> +* Temperature Sensor ADC (TSADC) on rockchip SoCs
> >> +
> >> +Required properties:
> >> +- compatible : "rockchip,rk3288-tsadc"
> >> +- reg : physical base address of the controller and length of memory
> >> mapped +	region.
> >> +- interrupts : The interrupt number to the cpu. The interrupt specifier
> >> format +	       depends on the interrupt controller.
> >> +- clocks : Must contain an entry for each entry in clock-names.
> >> +- clock-names : Shall be "tsadc" for the converter-clock, and "apb_pclk"
> >> for +		the peripheral clock.
> >> +- #thermal-sensor-cells : Should be 1. See ./thermal.txt for a
> >> description.> 
> > I think you are missing description of hw-shut-temp, tsadc-tshut-mode
> > and tsadc-tshut-mode
> > 
> >   and optional pinctrl settings.
> 
> If it's really need,we just have hw-shut-temp,tsadc-tshut-mode
> and tsadc-tshut-mode,no need  pinctrl setting,I think.

This is more question to DeviceTree guys, but I can see us not documenting
pinctrl since it is generic property used by every driver out there. We should
definitely document driver-specific properties.

Thanks.

Patch
diff mbox

diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
new file mode 100644
index 0000000..d5b1401
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
@@ -0,0 +1,53 @@ 
+* Temperature Sensor ADC (TSADC) on rockchip SoCs
+
+Required properties:
+- compatible : "rockchip,rk3288-tsadc"
+- reg : physical base address of the controller and length of memory mapped
+	region.
+- interrupts : The interrupt number to the cpu. The interrupt specifier format
+	       depends on the interrupt controller.
+- clocks : Must contain an entry for each entry in clock-names.
+- clock-names : Shall be "tsadc" for the converter-clock, and "apb_pclk" for
+		the peripheral clock.
+- #thermal-sensor-cells : Should be 1. See ./thermal.txt for a description.
+
+Exiample:
+tsadc: tsadc@ff280000 {
+	compatible = "rockchip,rk3288-tsadc";
+	reg = <0xff280000 0x100>;
+	interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
+	clocks = <&cru SCLK_TSADC>, <&cru PCLK_TSADC>;
+	clock-names = "tsadc", "apb_pclk";
+};
+
+Example: referring to thermal sensors:
+thermal-zones {
+	cpu_thermal: cpu_thermal {
+		polling-delay-passive = <1000>; /* milliseconds */
+		polling-delay = <5000>; /* milliseconds */
+
+		/* sensor	ID */
+		thermal-sensors = <&tsadc	1>;
+
+		trips {
+			cpu_alert0: cpu_alert {
+				temperature = <80000>; /* millicelsius */
+				hysteresis = <2000>; /* millicelsius */
+				type = "passive";
+			};
+			cpu_crit: cpu_crit {
+				temperature = <120000>; /* millicelsius */
+				hysteresis = <2000>; /* millicelsius */
+				type = "critical";
+			};
+		};
+
+		cooling-maps {
+			map0 {
+				trip = <&cpu_alert0>;
+				cooling-device =
+					<&cpu0 THERMAL_NO_LIMIT THERMAL_NO_LIMIT>;
+			};
+		};
+	};
+};