From cc24cf19990b27723d94eae10df9dd4f88c4818b Mon Sep 17 00:00:00 2001
From: Manaf Meethalavalappu Pallikunhi <manafm@qti.qualcomm.com>
Date: Mon, 24 May 2021 23:48:52 +0530
Subject: [PATCH] dt-bindings: Add snapshot of CX Ipeak cooling device
 devicetree binding

Add snapshot of CX Ipeak devicetree binding to the devicetree project.
This snapshot is taken as of 'commit <829fee7bd3d86> ("driver:
thermal: Update CX Ipeak driver to support CX Ipeak v1.1 hardware")'
of the msm-4.14 kernel project.

Change-Id: Ib661ebdfe21207f8e119819a870cbb0f459e290c
---
 bindings/thermal/qcom,cx-ipeak-cdev.txt | 53 +++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 bindings/thermal/qcom,cx-ipeak-cdev.txt

diff --git a/bindings/thermal/qcom,cx-ipeak-cdev.txt b/bindings/thermal/qcom,cx-ipeak-cdev.txt
new file mode 100644
index 000000000000..562cc6e5f5d3
--- /dev/null
+++ b/bindings/thermal/qcom,cx-ipeak-cdev.txt
@@ -0,0 +1,53 @@
+Qualcomm Technologies, Inc. CX Peak current cooling device
+
+The CX IPEAK cooling device, will be used to set thermal client vote to
+CX IPEAK  LM hardware. When all pre-defined clients on CX rail including
+thermal client set their vote, CXIP LM hardware throttles pre-defined
+client on the same rail.
+
+Required Parameters:
+- compatible:
+	Usage: required
+	Value type: <string>
+	Definition: should be "qcom,cxip-lm-cooling-device"
+
+- reg:
+	Usage: required
+	Value type: <values in hex>
+	Definition: Must contain 2 variables <a b> where 'a' is the starting
+		register address of the CX IPEAK LM hardware and 'b' is the
+		size of the peripheral address space.
+
+- qcom,thermal-client-offset:
+	Usage: Optional
+	Value type: <value in hex>
+	Definition: This property is required for CX IP LM v1.1 and above
+		hardware. Must contain offset from CX IPEAK LM reg
+		base for thermal client voting. If this property is not defined,
+		then CX IPEAK cooling device will use legacy CXIP LM hardware
+		offset registers.
+
+- qcom,bypass-client-list:
+	Usage: Optional
+	Value type: <value in hex>
+	Definition: This property is required for CX IP LM v1.1 and above
+		hardware. Must contain array of offsets from CX IPEAK LM reg
+		base for clients those are not participating voting to CXIP LM
+		hardware. This property makes sense only when thermal-client
+		is defined.
+
+- #cooling-cells:
+	Usage: required
+	Value type: <integer>
+	Definition: Must be 2. This is required by of-thermal and refer the doc
+		<devicetree/bindings/thermal/thermal.txt> for more details.
+
+Example:
+
+	cxip_cdev: cxip-cdev@1fed000 {
+		compatible = "qcom,cxip-lm-cooling-device";
+		reg = <0x1fed000 0x24>;
+		qcom,thermal-client-offset = <0x8000>;
+		qcom,bypass-client-list = <0x2004 0x3004>;
+		#cooling-cells = <2>;
+	};