[v8,1/2] DT: hwspinlock: Add binding documentation for Qualcomm hwmutex

Commit Message

Bjorn Andersson March 24, 2015, 5:11 p.m. UTC

Add binding documentation for the Qualcomm Hardware Mutex.

Reviewed-by: Andy Gross <[e-mail]>
Reviewed-by: Jeffrey Hugo <[e-mail]>
Signed-off-by: Bjorn Andersson <[e-mail]>
---

Changes since v7:
- Corrected address, compatible and naming of the tcsr block

Changes since v6:
- Corrected indentation error in example

Changes since v5:
- Extracted the dt binding documentation into a separate patch
- Moved the driver to consume a syscon
- Dropped previously suggested generic hwlock dt bindings

 .../devicetree/bindings/hwlock/qcom-hwspinlock.txt | 39 ++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.txt

Comments

Ohad Ben Cohen May 2, 2015, 7:57 a.m. UTC | #1

On Tue, Mar 24, 2015 at 7:11 PM, Bjorn Andersson
<[e-mail]> wrote:
> Add binding documentation for the Qualcomm Hardware Mutex.
>
> Reviewed-by: Andy Gross <[e-mail]>
> Reviewed-by: Jeffrey Hugo <[e-mail]>
> Signed-off-by: Bjorn Andersson <[e-mail]>
> ---

Both patches have been applied, thanks!
--
To unsubscribe from this list: send the line "unsubscribe linux-arm-msm" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.txt b/Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.txt
new file mode 100644
index 0000000..4563f52
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.txt
@@ -0,0 +1,39 @@ 
+Qualcomm Hardware Mutex Block:
+
+The hardware block provides mutexes utilized between different processors on
+the SoC as part of the communication protocol used by these processors.
+
+- compatible:
+	Usage: required
+	Value type: <string>
+	Definition: must be one of:
+		    "qcom,sfpb-mutex",
+		    "qcom,tcsr-mutex"
+
+- syscon:
+	Usage: required
+	Value type: <prop-encoded-array>
+	Definition: one cell containing:
+		    syscon phandle
+		    offset of the hwmutex block within the syscon
+		    stride of the hwmutex registers
+
+- #hwlock-cells:
+	Usage: required
+	Value type: <u32>
+	Definition: must be 1, the specified cell represent the lock id
+		    (hwlock standard property, see hwlock.txt)
+
+Example:
+
+	tcsr_mutex_block: syscon@fd484000 {
+		compatible = "syscon";
+		reg = <0xfd484000 0x2000>;
+	};
+
+	hwlock@fd484000 {
+		compatible = "qcom,tcsr-mutex";
+		syscon = <&tcsr_mutex_block 0 0x80>;
+
+		#hwlock-cells = <1>;
+	};