diff mbox

[1/2] dt-bindings: document Rockchip thermal

Message ID 1408752934-18318-2-git-send-email-caesar.wang@rock-chips.com
State Superseded, archived
Headers show

Commit Message

caesar Aug. 23, 2014, 12:15 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          |   33 ++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/rockchip-thermal.txt

Comments

Heiko Stuebner Aug. 23, 2014, 11:03 p.m. UTC | #1
Hi Caesar,

Am Samstag, 23. August 2014, 08:15:33 schrieb Caesar Wang:
> 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          |   33
> ++++++++++++++++++++ 1 file changed, 33 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..b556eae
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> @@ -0,0 +1,33 @@
> +* 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_clk" for the transfer-clock, and
> "tsadc_pclk" for +    the peripheral clock.
> +Optional properties:
> +- clock-frequency : Thermal sensor's clock frequency.

see comment in patch2, this should probably use assigned-rate if at all 
necessary (and the assigned-rate is not necessary to document here)


> +- pinctrl-names : Should contain only one value - "default".
> +- pinctrl-0 : Should contain only one value - &tsadc_int.

in general pinctrl settings are just board-specific settings and do not
need to be part of the binding documentation.
And in this case, are you sure that the tsadc uses some pin as interrupt?
Because in the TRM the TS-ADC interrupt is number 69 of the GIC itself
and not some pin accessible via pinctrl.


> +- passive-temp : Temperature of trip 0.
> +- critical-temp : Temperature of trip 1.
> +- force-shut-temp : Temperature of force shut down.

please use the generic trip-points described in
Documentation/devicetree/bindings/thermal/thermal.txt
for this, instead of defining new properties


Heiko

> +Example:
> +
> +tsadc: tsadc@ff280000 {
> +	compatible = "rockchip,rk3288-tsadc";
> +	reg = <0xff280000 0x100>;
> +	interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
> +	clock-frequency = <10000>;
> +	clocks = <&cru SCLK_TSADC>, <&cru PCLK_TSADC>;
> +	clock-names = "tsadc_clk", "tsadc_pclk";
> +	pinctrl-names = "default";
> +	pinctrl-1 = <&tsadc_int>;
> +	passive-temp = <80>;
> +	critical-temp = <100>;
> +	force-shut-temp = <120>;
> +};

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
caesar Aug. 26, 2014, 12:50 a.m. UTC | #2
Hi Heiko,

在 2014年08月24日 07:03, Heiko Stübner 写道:
> Hi Caesar,
>
> Am Samstag, 23. August 2014, 08:15:33 schrieb Caesar Wang:
>> 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          |   33
>> ++++++++++++++++++++ 1 file changed, 33 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..b556eae
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>> @@ -0,0 +1,33 @@
>> +* 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_clk" for the transfer-clock, and
>> "tsadc_pclk" for +    the peripheral clock.
>> +Optional properties:
>> +- clock-frequency : Thermal sensor's clock frequency.
> see comment in patch2, this should probably use assigned-rate if at all
> necessary (and the assigned-rate is not necessary to document here)
>

yeah, it's necessary.

ok,I will fix it.
>> +- pinctrl-names : Should contain only one value - "default".
>> +- pinctrl-0 : Should contain only one value - &tsadc_int.
> in general pinctrl settings are just board-specific settings and do not
> need to be part of the binding documentation.
> And in this case, are you sure that the tsadc uses some pin as interrupt?
> Because in the TRM the TS-ADC interrupt is number 69 of the GIC itself
> and not some pin accessible via pinctrl.
>
>
>> +- passive-temp : Temperature of trip 0.
>> +- critical-temp : Temperature of trip 1.
>> +- force-shut-temp : Temperature of force shut down.
> please use the generic trip-points described in
> Documentation/devicetree/bindings/thermal/thermal.txt
> for this, instead of defining new properties
>
>
> Heiko
Ditto,
>
>> +Example:
>> +
>> +tsadc: tsadc@ff280000 {
>> +	compatible = "rockchip,rk3288-tsadc";
>> +	reg = <0xff280000 0x100>;
>> +	interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
>> +	clock-frequency = <10000>;
>> +	clocks = <&cru SCLK_TSADC>, <&cru PCLK_TSADC>;
>> +	clock-names = "tsadc_clk", "tsadc_pclk";
>> +	pinctrl-names = "default";
>> +	pinctrl-1 = <&tsadc_int>;
>> +	passive-temp = <80>;
>> +	critical-temp = <100>;
>> +	force-shut-temp = <120>;
>> +};
>
>
>
caesar Aug. 26, 2014, 4:47 p.m. UTC | #3
Heiko,
在 2014/8/24 7:03, Heiko Stübner 写道:
> Hi Caesar,
>
> Am Samstag, 23. August 2014, 08:15:33 schrieb Caesar Wang:
>> 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          |   33
>> ++++++++++++++++++++ 1 file changed, 33 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..b556eae
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>> @@ -0,0 +1,33 @@
>> +* 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_clk" for the transfer-clock, and
>> "tsadc_pclk" for +    the peripheral clock.
>> +Optional properties:
>> +- clock-frequency : Thermal sensor's clock frequency.
> see comment in patch2, this should probably use assigned-rate if at all
> necessary (and the assigned-rate is not necessary to document here)
>
>
>> +- pinctrl-names : Should contain only one value - "default".
>> +- pinctrl-0 : Should contain only one value - &tsadc_int.
> in general pinctrl settings are just board-specific settings and do not
> need to be part of the binding documentation.
> And in this case, are you sure that the tsadc uses some pin as interrupt?
> Because in the TRM the TS-ADC interrupt is number 69 of the GIC itself
> and not some pin accessible via pinctrl.
>
>
>> +- passive-temp : Temperature of trip 0.
>> +- critical-temp : Temperature of trip 1.
>> +- force-shut-temp : Temperature of force shut down.
> please use the generic trip-points described in
> Documentation/devicetree/bindings/thermal/thermal.txt
> for this, instead of defining new properties

There are have 4 trip-points mode in thermal.txt.
It's ACTIVE、PASSAIVE、 HOT and  CRITICAL.

Do you have some suggestion for fix it if I need add shut-temp mode ?

- Caesar
>
> Heiko
>
>> +Example:
>> +
>> +tsadc: tsadc@ff280000 {
>> +	compatible = "rockchip,rk3288-tsadc";
>> +	reg = <0xff280000 0x100>;
>> +	interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
>> +	clock-frequency = <10000>;
>> +	clocks = <&cru SCLK_TSADC>, <&cru PCLK_TSADC>;
>> +	clock-names = "tsadc_clk", "tsadc_pclk";
>> +	pinctrl-names = "default";
>> +	pinctrl-1 = <&tsadc_int>;
>> +	passive-temp = <80>;
>> +	critical-temp = <100>;
>> +	force-shut-temp = <120>;
>> +};
>
>
>
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
new file mode 100644
index 0000000..b556eae
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
@@ -0,0 +1,33 @@ 
+* 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_clk" for the transfer-clock, and "tsadc_pclk" for
+    the peripheral clock.
+Optional properties:
+- clock-frequency : Thermal sensor's clock frequency.
+- pinctrl-names : Should contain only one value - "default".
+- pinctrl-0 : Should contain only one value - &tsadc_int.
+- passive-temp : Temperature of trip 0.
+- critical-temp : Temperature of trip 1.
+- force-shut-temp : Temperature of force shut down.
+Example:
+
+tsadc: tsadc@ff280000 {
+	compatible = "rockchip,rk3288-tsadc";
+	reg = <0xff280000 0x100>;
+	interrupts = <GIC_SPI 37 IRQ_TYPE_LEVEL_HIGH>;
+	clock-frequency = <10000>;
+	clocks = <&cru SCLK_TSADC>, <&cru PCLK_TSADC>;
+	clock-names = "tsadc_clk", "tsadc_pclk";
+	pinctrl-names = "default";
+	pinctrl-1 = <&tsadc_int>;
+	passive-temp = <80>;
+	critical-temp = <100>;
+	force-shut-temp = <120>;
+};