GNU Linux-libre 4.19.264-gnu1
[releases.git] / Documentation / devicetree / bindings / hwlock / qcom-hwspinlock.txt
1 Qualcomm Hardware Mutex Block:
2
3 The hardware block provides mutexes utilized between different processors on
4 the SoC as part of the communication protocol used by these processors.
5
6 - compatible:
7         Usage: required
8         Value type: <string>
9         Definition: must be one of:
10                     "qcom,sfpb-mutex",
11                     "qcom,tcsr-mutex"
12
13 - syscon:
14         Usage: required
15         Value type: <prop-encoded-array>
16         Definition: one cell containing:
17                     syscon phandle
18                     offset of the hwmutex block within the syscon
19                     stride of the hwmutex registers
20
21 - #hwlock-cells:
22         Usage: required
23         Value type: <u32>
24         Definition: must be 1, the specified cell represent the lock id
25                     (hwlock standard property, see hwlock.txt)
26
27 Example:
28
29         tcsr_mutex_block: syscon@fd484000 {
30                 compatible = "syscon";
31                 reg = <0xfd484000 0x2000>;
32         };
33
34         hwlock@fd484000 {
35                 compatible = "qcom,tcsr-mutex";
36                 syscon = <&tcsr_mutex_block 0 0x80>;
37
38                 #hwlock-cells = <1>;
39         };