xref: /freebsd/sys/contrib/device-tree/Bindings/display/mediatek/mediatek,aal.yaml (revision 535af610a4fdace6d50960c0ad9be0597eea7a1b) 
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,aal.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Mediatek display adaptive ambient light processor
8
9maintainers:
10  - Chun-Kuang Hu <chunkuang.hu@kernel.org>
11  - Philipp Zabel <p.zabel@pengutronix.de>
12
13description: |
14  Mediatek display adaptive ambient light processor, namely AAL,
15  is responsible for backlight power saving and sunlight visibility improving.
16  AAL device node must be siblings to the central MMSYS_CONFIG node.
17  For a description of the MMSYS_CONFIG binding, see
18  Documentation/devicetree/bindings/arm/mediatek/mediatek,mmsys.yaml
19  for details.
20
21properties:
22  compatible:
23    oneOf:
24      - enum:
25          - mediatek,mt8173-disp-aal
26          - mediatek,mt8183-disp-aal
27      - items:
28          - enum:
29              - mediatek,mt2712-disp-aal
30          - const: mediatek,mt8173-disp-aal
31      - items:
32          - enum:
33              - mediatek,mt8186-disp-aal
34              - mediatek,mt8188-disp-aal
35              - mediatek,mt8192-disp-aal
36              - mediatek,mt8195-disp-aal
37          - const: mediatek,mt8183-disp-aal
38
39  reg:
40    maxItems: 1
41
42  interrupts:
43    maxItems: 1
44
45  power-domains:
46    description: A phandle and PM domain specifier as defined by bindings of
47      the power controller specified by phandle. See
48      Documentation/devicetree/bindings/power/power-domain.yaml for details.
49
50  clocks:
51    items:
52      - description: AAL Clock
53
54  mediatek,gce-client-reg:
55    description: The register of client driver can be configured by gce with
56      4 arguments defined in this property, such as phandle of gce, subsys id,
57      register offset and size. Each GCE subsys id is mapping to a client
58      defined in the header include/dt-bindings/gce/<chip>-gce.h.
59    $ref: /schemas/types.yaml#/definitions/phandle-array
60    maxItems: 1
61
62required:
63  - compatible
64  - reg
65  - interrupts
66  - power-domains
67  - clocks
68
69additionalProperties: false
70
71examples:
72  - |
73    #include <dt-bindings/interrupt-controller/arm-gic.h>
74    #include <dt-bindings/clock/mt8173-clk.h>
75    #include <dt-bindings/power/mt8173-power.h>
76    #include <dt-bindings/gce/mt8173-gce.h>
77
78    soc {
79        #address-cells = <2>;
80        #size-cells = <2>;
81
82        aal@14015000 {
83           compatible = "mediatek,mt8173-disp-aal";
84           reg = <0 0x14015000 0 0x1000>;
85           interrupts = <GIC_SPI 189 IRQ_TYPE_LEVEL_LOW>;
86           power-domains = <&scpsys MT8173_POWER_DOMAIN_MM>;
87           clocks = <&mmsys CLK_MM_DISP_AAL>;
88           mediatek,gce-client-reg = <&gce SUBSYS_1401XXXX 0x5000 0x1000>;
89       };
90    };
91