xref: /freebsd/sys/contrib/device-tree/Bindings/soc/mediatek/mediatek,mutex.yaml (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/soc/mediatek/mediatek,mutex.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Mediatek mutex
8
9maintainers:
10  - Chun-Kuang Hu <chunkuang.hu@kernel.org>
11  - Philipp Zabel <p.zabel@pengutronix.de>
12
13description: |
14  Mediatek mutex, namely MUTEX, is used to send the triggers signals called
15  Start Of Frame (SOF) / End Of Frame (EOF) to each sub-modules on the display
16  data path or MDP data path.
17  In some SoC, such as mt2701, MUTEX could be a hardware mutex which protects
18  the shadow register.
19  MUTEX device node must be siblings to the central MMSYS_CONFIG node.
20  For a description of the MMSYS_CONFIG binding, see
21  Documentation/devicetree/bindings/arm/mediatek/mediatek,mmsys.yaml
22  for details.
23
24properties:
25  compatible:
26    enum:
27      - mediatek,mt2701-disp-mutex
28      - mediatek,mt2712-disp-mutex
29      - mediatek,mt6795-disp-mutex
30      - mediatek,mt8167-disp-mutex
31      - mediatek,mt8173-disp-mutex
32      - mediatek,mt8183-disp-mutex
33      - mediatek,mt8186-disp-mutex
34      - mediatek,mt8186-mdp3-mutex
35      - mediatek,mt8188-disp-mutex
36      - mediatek,mt8192-disp-mutex
37      - mediatek,mt8195-disp-mutex
38      - mediatek,mt8195-vpp-mutex
39      - mediatek,mt8365-disp-mutex
40
41  reg:
42    maxItems: 1
43
44  interrupts:
45    maxItems: 1
46
47  power-domains:
48    description: A phandle and PM domain specifier as defined by bindings of
49      the power controller specified by phandle. See
50      Documentation/devicetree/bindings/power/power-domain.yaml for details.
51
52  clocks:
53    items:
54      - description: MUTEX Clock
55
56  mediatek,gce-events:
57    description:
58      The event id which is mapping to the specific hardware event signal
59      to gce. The event id is defined in the gce header
60      include/dt-bindings/gce/<chip>-gce.h of each chips.
61    $ref: /schemas/types.yaml#/definitions/uint32-array
62
63  mediatek,gce-client-reg:
64    $ref: /schemas/types.yaml#/definitions/phandle-array
65    items:
66      items:
67        - description: phandle of GCE
68        - description: GCE subsys id
69        - description: register offset
70        - description: register size
71    description: The register of client driver can be configured by gce with
72      4 arguments defined in this property. Each GCE subsys id is mapping to
73      a client defined in the header include/dt-bindings/gce/<chip>-gce.h.
74
75allOf:
76  - if:
77      properties:
78        compatible:
79          contains:
80            enum:
81              - mediatek,mt2701-disp-mutex
82              - mediatek,mt2712-disp-mutex
83              - mediatek,mt6795-disp-mutex
84              - mediatek,mt8173-disp-mutex
85              - mediatek,mt8186-disp-mutex
86              - mediatek,mt8186-mdp3-mutex
87              - mediatek,mt8192-disp-mutex
88              - mediatek,mt8195-disp-mutex
89    then:
90      required:
91        - clocks
92
93
94required:
95  - compatible
96  - reg
97  - interrupts
98  - power-domains
99
100additionalProperties: false
101
102examples:
103  - |
104    #include <dt-bindings/interrupt-controller/arm-gic.h>
105    #include <dt-bindings/clock/mt8173-clk.h>
106    #include <dt-bindings/power/mt8173-power.h>
107    #include <dt-bindings/gce/mt8173-gce.h>
108
109    soc {
110        #address-cells = <2>;
111        #size-cells = <2>;
112
113        mutex: mutex@14020000 {
114            compatible = "mediatek,mt8173-disp-mutex";
115            reg = <0 0x14020000 0 0x1000>;
116            interrupts = <GIC_SPI 169 IRQ_TYPE_LEVEL_LOW>;
117            power-domains = <&spm MT8173_POWER_DOMAIN_MM>;
118            clocks = <&mmsys CLK_MM_MUTEX_32K>;
119            mediatek,gce-events = <CMDQ_EVENT_MUTEX0_STREAM_EOF>,
120                                  <CMDQ_EVENT_MUTEX1_STREAM_EOF>;
121        };
122    };
123