xref: /linux/Documentation/devicetree/bindings/display/mediatek/mediatek,padding.yaml (revision df9c299371054cb725eef730fd0f1d0fe2ed6bb0) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/display/mediatek/mediatek,padding.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: MediaTek Display Padding
8
9maintainers:
10  - Chun-Kuang Hu <chunkuang.hu@kernel.org>
11  - Philipp Zabel <p.zabel@pengutronix.de>
12
13description:
14  Padding provides ability to add pixels to width and height of a layer with
15  specified colors. Due to hardware design, Mixer in VDOSYS1 requires
16  width of a layer to be 2-pixel-align, or 4-pixel-align when ETHDR is enabled,
17  we need Padding to deal with odd width.
18  Please notice that even if the Padding is in bypass mode, settings in
19  register must be cleared to 0, or undefined behaviors could happen.
20
21properties:
22  compatible:
23    oneOf:
24      - enum:
25          - mediatek,mt8188-disp-padding
26          - mediatek,mt8195-mdp3-padding
27      - items:
28          - const: mediatek,mt8188-mdp3-padding
29          - const: mediatek,mt8195-mdp3-padding
30
31  reg:
32    maxItems: 1
33
34  power-domains:
35    maxItems: 1
36
37  clocks:
38    items:
39      - description: Padding's clocks
40
41  mediatek,gce-client-reg:
42    description:
43      GCE (Global Command Engine) is a multi-core micro processor that helps
44      its clients to execute commands without interrupting CPU. This property
45      describes GCE client's information that is composed by 4 fields.
46      1. Phandle of the GCE (there may be several GCE processors)
47      2. Sub-system ID defined in the dt-binding like a user ID
48         (Please refer to include/dt-bindings/gce/<chip>-gce.h)
49      3. Offset from base address of the subsys you are at
50      4. Size of the register the client needs
51    $ref: /schemas/types.yaml#/definitions/phandle-array
52    items:
53      items:
54        - description: Phandle of the GCE
55        - description: Subsys ID defined in the dt-binding
56        - description: Offset from base address of the subsys
57        - description: Size of register
58    maxItems: 1
59
60required:
61  - compatible
62  - reg
63  - power-domains
64  - clocks
65  - mediatek,gce-client-reg
66
67additionalProperties: false
68
69examples:
70  - |
71    #include <dt-bindings/interrupt-controller/arm-gic.h>
72    #include <dt-bindings/clock/mediatek,mt8188-clk.h>
73    #include <dt-bindings/power/mediatek,mt8188-power.h>
74    #include <dt-bindings/gce/mt8195-gce.h>
75
76    soc {
77        #address-cells = <2>;
78        #size-cells = <2>;
79
80        padding0: padding@1c11d000 {
81            compatible = "mediatek,mt8188-disp-padding";
82            reg = <0 0x1c11d000 0 0x1000>;
83            clocks = <&vdosys1 CLK_VDO1_PADDING0>;
84            power-domains = <&spm MT8188_POWER_DOMAIN_VDOSYS1>;
85            mediatek,gce-client-reg = <&gce0 SUBSYS_1c11XXXX 0xd000 0x1000>;
86        };
87    };
88