Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
From:   Baolin Wang <baolin.wang@linaro.org>
To:     rui.zhang@intel.com, edubezval@gmail.com,
        daniel.lezcano@linaro.org, amit.kucheria@verdurent.com,
        robh+dt@kernel.org, mark.rutland@arm.com
Cc:     orsonzhai@gmail.com, baolin.wang@linaro.org,
        baolin.wang7@gmail.com, freeman.liu@unisoc.com,
        zhang.lyra@gmail.com, linux-pm@vger.kernel.org,
        devicetree@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 1/2] dt-bindings: thermal: sprd: Add the Spreadtrum thermal documentation
Date:   Fri,  8 Nov 2019 17:54:30 +0800
Message-Id: <0a6b113010ad772a633b9cfeeb280dc41f17b951.1573206815.git.baolin.wang@linaro.org>
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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

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{
+			reg = <0>;
+			nvmem-cells = <&thm0_sen0>;
+			nvmem-cell-names = "sen_delta_cal";
+		};
+
+		ank1-sensor@1{
+			reg = <1>;
+			nvmem-cells = <&thm0_sen1>;
+			nvmem-cell-names = "sen_delta_cal";
+		};
+
+		......
+	};
-- 
1.7.9.5