Re: [PATCH 1/2] dt-bindings: thermal: sprd: Add the Spreadtrum thermal documentation

[Rob Herring <robh@kernel.org>]

On Fri, Nov 08, 2019 at 05:54:30PM +0800, Baolin Wang wrote:
> From: Freeman Liu <freeman.liu@unisoc.com>
> 
> Add the Spreadtrum thermal documentation.
> 
> Signed-off-by: Freeman Liu <freeman.liu@unisoc.com>
> Signed-off-by: Baolin Wang <baolin.wang@linaro.org>
> ---
>  .../devicetree/bindings/thermal/sprd-thermal.txt   |   41 ++++++++++++++++++++
>  1 file changed, 41 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/sprd-thermal.txt

Please make this a schema. See Documentation/devicetree/writing-schema.rst

> 
> diff --git a/Documentation/devicetree/bindings/thermal/sprd-thermal.txt b/Documentation/devicetree/bindings/thermal/sprd-thermal.txt
> new file mode 100644
> index 0000000..a9da7f4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/sprd-thermal.txt
> @@ -0,0 +1,41 @@
> +* Spreadtrum thermal sensor controller bindings
> +
> +Required properties:
> +- compatible : Should be "sprd,ums512-thermal"
> +- reg: Address range of the thermal registers
> +- clock-names: "enable" for thermal module enable clock.
> +- clocks: Should contain a clock specifier for each entry in clock-names.
> +- nvmem-cells: A phandle to the calibration data provided by a nvmem device.
> +- nvmem-cell-names: Should be "thm_sign_cal" and "thm_ratio_cal".
> +- #thermal-sensor-cells: Should be 1. See ./thermal.txt for a description.
> +
> +Child nodes properties:
> +- reg: Specify the sensor id.
> +- nvmem-cells: A phandle to the calibration data provided by a nvmem device.
> +- nvmem-cell-names: Should be "sen_delta_cal".
> +
> +Example:
> +
> +	ap_thm0: thermal@32200000 {
> +		compatible = "sprd,ums512-thermal";
> +		reg = <0 0x32200000 0 0x10000>;
> +		clock-names = "enable";
> +		clocks = <&aonapb_gate CLK_THM0_EB>;
> +		#thermal-sensor-cells = <1>;
> +		nvmem-cells = <&thm0_sign>, <&thm0_ratio>;
> +		nvmem-cell-names = "thm_sign_cal", "thm_ratio_cal";
> +
> +		prometheus0-sensor@0{

space                               ^

> +			reg = <0>;
> +			nvmem-cells = <&thm0_sen0>;
> +			nvmem-cell-names = "sen_delta_cal";
> +		};
> +
> +		ank1-sensor@1{

space                        ^

> +			reg = <1>;
> +			nvmem-cells = <&thm0_sen1>;
> +			nvmem-cell-names = "sen_delta_cal";
> +		};
> +
> +		......
> +	};
> -- 
> 1.7.9.5
>