[v3,1/3] dt-bindings: Document the hi3660 thermal sensor bindings

Message ID 1502353935-92924-2-git-send-email-kevin.wangtao@hisilicon.com
State Changes Requested
Headers show

Commit Message

Wangtao (Kevin, Kirin) Aug. 10, 2017, 8:32 a.m.
From: Tao Wang <kevin.wangtao@linaro.org>

This adds documentation of device tree bindings for the
thermal sensor controller of hi3660 SoC.

Signed-off-by: Tao Wang <kevin.wangtao@linaro.org>
---
 .../devicetree/bindings/thermal/hisi-tsensor.txt   | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/hisi-tsensor.txt

Comments

Rob Herring Aug. 17, 2017, 3:10 p.m. | #1
On Thu, Aug 10, 2017 at 04:32:13PM +0800, Tao Wang wrote:
> From: Tao Wang <kevin.wangtao@linaro.org>
> 
> This adds documentation of device tree bindings for the
> thermal sensor controller of hi3660 SoC.
> 
> Signed-off-by: Tao Wang <kevin.wangtao@linaro.org>
> ---
>  .../devicetree/bindings/thermal/hisi-tsensor.txt   | 23 ++++++++++++++++++++++
>  1 file changed, 23 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/hisi-tsensor.txt
> 
> diff --git a/Documentation/devicetree/bindings/thermal/hisi-tsensor.txt b/Documentation/devicetree/bindings/thermal/hisi-tsensor.txt
> new file mode 100644
> index 0000000..2ab0eb9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/hisi-tsensor.txt
> @@ -0,0 +1,23 @@
> +* Temperature Sensor on hisilicon SoC
> +
> +** Required properties :
> +
> +- compatible: "hisilicon,thermal-tsensor".

Needs an SoC specific compatible.

> +- reg: physical base address of thermal sensor and length of memory mapped
> +  region.
> +- offset: reg offset of each sensor.

Should be implied by the compatible.

> +- coefficients:	An array of integers (one signed cell) containing
> +		coefficients to turn adc value to temperture.

Needs a vendor prefix.

> +- hisi,adc-range: adc value range, minimum value is followed by maximum value.
> +- #thermal-sensor-cells: Should be 1. See ./thermal.txt for a description.
> +
> +Example :
> +
> +tsensor: tsensor@FFF3000 {
> +	compatible = "hisilicon,tsensor";
> +	reg = <0x0 0xfff30000 0x0 0x1000>;
> +	offset = <0x1c 0x5c 0x9c>;
> +	coefficients = <165000 (-40000)>;
> +	hisi,adc-range = <0x74 0x39A>;
> +	#thermal-sensor-cells = <1>;
> +};
> -- 
> 2.8.1
> 
> --
> 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
--
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
Wangtao (Kevin, Kirin) Aug. 21, 2017, 2:17 a.m. | #2
在 2017/8/17 23:10, Rob Herring 写道:
> On Thu, Aug 10, 2017 at 04:32:13PM +0800, Tao Wang wrote:
>> From: Tao Wang <kevin.wangtao@linaro.org>
>>
>> This adds documentation of device tree bindings for the
>> thermal sensor controller of hi3660 SoC.
>>
>> Signed-off-by: Tao Wang <kevin.wangtao@linaro.org>
>> ---
>>   .../devicetree/bindings/thermal/hisi-tsensor.txt   | 23 ++++++++++++++++++++++
>>   1 file changed, 23 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/thermal/hisi-tsensor.txt
>>
>> diff --git a/Documentation/devicetree/bindings/thermal/hisi-tsensor.txt b/Documentation/devicetree/bindings/thermal/hisi-tsensor.txt
>> new file mode 100644
>> index 0000000..2ab0eb9
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/thermal/hisi-tsensor.txt
>> @@ -0,0 +1,23 @@
>> +* Temperature Sensor on hisilicon SoC
>> +
>> +** Required properties :
>> +
>> +- compatible: "hisilicon,thermal-tsensor".
> 
> Needs an SoC specific compatible.
OK
> 
>> +- reg: physical base address of thermal sensor and length of memory mapped
>> +  region.
>> +- offset: reg offset of each sensor.
> 
> Should be implied by the compatible.
Do you mean that the reg offset should not in dts?
> 
>> +- coefficients:	An array of integers (one signed cell) containing
>> +		coefficients to turn adc value to temperture.
> 
> Needs a vendor prefix.
OK
> 
>> +- hisi,adc-range: adc value range, minimum value is followed by maximum value.
>> +- #thermal-sensor-cells: Should be 1. See ./thermal.txt for a description.
>> +
>> +Example :
>> +
>> +tsensor: tsensor@FFF3000 {
>> +	compatible = "hisilicon,tsensor";
>> +	reg = <0x0 0xfff30000 0x0 0x1000>;
>> +	offset = <0x1c 0x5c 0x9c>;
>> +	coefficients = <165000 (-40000)>;
>> +	hisi,adc-range = <0x74 0x39A>;
>> +	#thermal-sensor-cells = <1>;
>> +};
>> -- 
>> 2.8.1
>>
>> --
>> 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
> 
> .
> 

--
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

Patch

diff --git a/Documentation/devicetree/bindings/thermal/hisi-tsensor.txt b/Documentation/devicetree/bindings/thermal/hisi-tsensor.txt
new file mode 100644
index 0000000..2ab0eb9
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/hisi-tsensor.txt
@@ -0,0 +1,23 @@ 
+* Temperature Sensor on hisilicon SoC
+
+** Required properties :
+
+- compatible: "hisilicon,thermal-tsensor".
+- reg: physical base address of thermal sensor and length of memory mapped
+  region.
+- offset: reg offset of each sensor.
+- coefficients:	An array of integers (one signed cell) containing
+		coefficients to turn adc value to temperture.
+- hisi,adc-range: adc value range, minimum value is followed by maximum value.
+- #thermal-sensor-cells: Should be 1. See ./thermal.txt for a description.
+
+Example :
+
+tsensor: tsensor@FFF3000 {
+	compatible = "hisilicon,tsensor";
+	reg = <0x0 0xfff30000 0x0 0x1000>;
+	offset = <0x1c 0x5c 0x9c>;
+	coefficients = <165000 (-40000)>;
+	hisi,adc-range = <0x74 0x39A>;
+	#thermal-sensor-cells = <1>;
+};