From 28cf853468a6c0df32e02bed948640cbaec8bb1a Mon Sep 17 00:00:00 2001
From: Vipin Deep Kaur <vkaur@qti.qualcomm.com>
Date: Mon, 28 Sep 2020 15:46:14 +0530
Subject: [PATCH] dt-bindings: qcom-sps-dma: Add snapshot of SPS DMA driver

This change adds a snapshot of SPS DMA driver from the 4.19
branch. kernel-4.19 baseline: 'commit b159d5da02b7
("dt-bindings: Add documentation for SDM660")'.

Change-Id: I1997961ee887e0657602e3456cee7f1ff88ae368
---
 bindings/dma/qcom-sps-dma.txt | 42 +++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 bindings/dma/qcom-sps-dma.txt

diff --git a/bindings/dma/qcom-sps-dma.txt b/bindings/dma/qcom-sps-dma.txt
new file mode 100644
index 000000000000..c6c8726dac26
--- /dev/null
+++ b/bindings/dma/qcom-sps-dma.txt
@@ -0,0 +1,42 @@
+* Qualcomm technologies inc, DMA engine driver for BAM (Bus Access Manager).
+
+Required properties:
+- compatible: Should be "qcom,sps-dma".
+- reg: Should contain DMA registers location and length. This should include
+  all of the per-channel registers.
+- interrupts: Should contain the BAM interrupt number.
+- qcom,summing-threshold:  Should contain the BAM event threshold of
+  the sum of descriptors' sizes in bytes.
+
+Optional properties:
+- qcom,managed-locally : Use when BAM global device control is managed locally
+  by the application processor.
+
+Example:
+
+	dma_blsp1: qcom,sps-dma@f9904000 { /* BLSP1 */
+		#dma-cells = <4>;
+		compatible = "qcom,sps-dma";
+		reg = <0xf9904000 0x19000>;
+		interrupts = <0 238 0>;
+		qcom,summing-threshold = <10>;
+	};
+
+DMA clients connected to the qcom-sps-dma DMA controller must use the format
+described in the dma.txt file, using a five-cell specifier for each channel,
+a phandle plus four integer cells, as shown below:
+
+dmas = <[phandle of the dma controller] [pipe index] [number of descriptors]
+				[sps_connect flags] [sps_register_event flags]>;
+
+Example:
+
+i2c_2: i2c@f9924000 { /* BLSP1 QUP2 */
+	.
+	.
+	.
+	/*     <&phandle pipe-idx n-descs connect-flags event-flags> */
+	dmas = <&dma_blsp1 14 32 0x20000020 0x20>,
+	       <&dma_blsp1 15 64 0x20000020 0x20>;
+	dma-names = "tx", "rx";
+};