Unverified Commit f5a98bfe authored by Maxime Ripard's avatar Maxime Ripard
Browse files

dt-bindings: display: Convert Allwinner display pipeline to schemas 



The Allwinner SoCs have a display engine composed of several controllers
assembled differently depending on the SoC, the number and type of output
they have, and the additional features they provide. A number of those are
supported in Linux, with the matching bindings.

Now that we have the DT validation in place, let's split into separate file
and convert the device tree bindings for those controllers to schemas.

Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarMaxime Ripard <maxime@cerno.tech>
Link: https://patchwork.freedesktop.org/patch/msgid/20200103152801.47254-1-maxime@cerno.tech
parent 9d10fc26

Documentation/devicetree/bindings/display/allwinner,sun4i-a10-display-backend.yaml

0 → 100644
+291 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

%YAML 1.2

---

$id: http://devicetree.org/schemas/display/allwinner,sun4i-a10-display-backend.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Allwinner A10 Display Engine Backend Device Tree Bindings



maintainers:

  - Chen-Yu Tsai <wens@csie.org>

  - Maxime Ripard <mripard@kernel.org>



description: |

  The display engine backend exposes layers and sprites to the system.



properties:

  compatible:

    enum:

      - allwinner,sun4i-a10-display-backend

      - allwinner,sun5i-a13-display-backend

      - allwinner,sun6i-a31-display-backend

      - allwinner,sun7i-a20-display-backend

      - allwinner,sun8i-a23-display-backend

      - allwinner,sun8i-a33-display-backend

      - allwinner,sun9i-a80-display-backend



  reg:

    minItems: 1

    maxItems: 2

    items:

      - description: Display Backend registers

      - description: SAT registers



  reg-names:

    minItems: 1

    maxItems: 2

    items:

      - const: be

      - const: sat



  interrupts:

    maxItems: 1



  clocks:

    minItems: 3

    maxItems: 4

    items:

      - description: The backend interface clock

      - description: The backend module clock

      - description: The backend DRAM clock

      - description: The SAT clock



  clock-names:

    minItems: 3

    maxItems: 4

    items:

      - const: ahb

      - const: mod

      - const: ram

      - const: sat



  resets:

    minItems: 1

    maxItems: 2

    items:

      - description: The Backend reset line

      - description: The SAT reset line



  reset-names:

    minItems: 1

    maxItems: 2

    items:

      - const: be

      - const: sat



  # FIXME: This should be made required eventually once every SoC will

  # have the MBUS declared.

  interconnects:

    maxItems: 1



  # FIXME: This should be made required eventually once every SoC will

  # have the MBUS declared.

  interconnect-names:

    const: dma-mem



  ports:

    type: object

    description: |

      A ports node with endpoint definitions as defined in

      Documentation/devicetree/bindings/media/video-interfaces.txt.



    properties:

      "#address-cells":

        const: 1



      "#size-cells":

        const: 0



      port@0:

        type: object

        description: |

          Input endpoints of the controller.



      port@1:

        type: object

        description: |

          Output endpoints of the controller.



    required:

      - "#address-cells"

      - "#size-cells"

      - port@0

      - port@1



    additionalProperties: false



required:

  - compatible

  - reg

  - interrupts

  - clocks

  - clock-names

  - resets

  - ports



additionalProperties: false



if:

  properties:

    compatible:

      contains:

        const: allwinner,sun8i-a33-display-backend



then:

  properties:

    reg:

      minItems: 2



    reg-names:

      minItems: 2



    clocks:

      minItems: 4



    clock-names:

      minItems: 4



    resets:

      minItems: 2



    reset-names:

      minItems: 2



  required:

    - reg-names

    - reset-names



else:

  properties:

    reg:

      maxItems: 1



    reg-names:

      maxItems: 1



    clocks:

      maxItems: 3



    clock-names:

      maxItems: 3



    resets:

      maxItems: 1



    reset-names:

      maxItems: 1



examples:

  - |

    /*

     * This comes from the clock/sun4i-a10-ccu.h and

     * reset/sun4i-a10-ccu.h headers, but we can't include them since

     * it would trigger a bunch of warnings for redefinitions of

     * symbols with the other example.

     */



    #define CLK_AHB_DE_BE0	42

    #define CLK_DRAM_DE_BE0	140

    #define CLK_DE_BE0		144

    #define RST_DE_BE0		5



    display-backend@1e60000 {

        compatible = "allwinner,sun4i-a10-display-backend";

        reg = <0x01e60000 0x10000>;

        interrupts = <47>;

        clocks = <&ccu CLK_AHB_DE_BE0>, <&ccu CLK_DE_BE0>,

                 <&ccu CLK_DRAM_DE_BE0>;

        clock-names = "ahb", "mod",

                      "ram";

        resets = <&ccu RST_DE_BE0>;



        ports {

            #address-cells = <1>;

            #size-cells = <0>;



            port@0 {

                #address-cells = <1>;

                #size-cells = <0>;

                reg = <0>;



                endpoint@0 {

                    reg = <0>;

                    remote-endpoint = <&fe0_out_be0>;

                };



                endpoint@1 {

                    reg = <1>;

                    remote-endpoint = <&fe1_out_be0>;

                };

            };



            port@1 {

                #address-cells = <1>;

                #size-cells = <0>;

                reg = <1>;



                endpoint@0 {

                    reg = <0>;

                    remote-endpoint = <&tcon0_in_be0>;

                };



                endpoint@1 {

                    reg = <1>;

                    remote-endpoint = <&tcon1_in_be0>;

                };

            };

        };

    };



  - |

    #include <dt-bindings/interrupt-controller/arm-gic.h>



    /*

     * This comes from the clock/sun8i-a23-a33-ccu.h and

     * reset/sun8i-a23-a33-ccu.h headers, but we can't include them

     * since it would trigger a bunch of warnings for redefinitions of

     * symbols with the other example.

     */



    #define CLK_BUS_DE_BE	40

    #define CLK_BUS_SAT		46

    #define CLK_DRAM_DE_BE	84

    #define CLK_DE_BE		85

    #define RST_BUS_DE_BE	21

    #define RST_BUS_SAT		27



    display-backend@1e60000 {

        compatible = "allwinner,sun8i-a33-display-backend";

        reg = <0x01e60000 0x10000>, <0x01e80000 0x1000>;

        reg-names = "be", "sat";

        interrupts = <GIC_SPI 95 IRQ_TYPE_LEVEL_HIGH>;

        clocks = <&ccu CLK_BUS_DE_BE>, <&ccu CLK_DE_BE>,

                 <&ccu CLK_DRAM_DE_BE>, <&ccu CLK_BUS_SAT>;

        clock-names = "ahb", "mod",

                      "ram", "sat";

        resets = <&ccu RST_BUS_DE_BE>, <&ccu RST_BUS_SAT>;

        reset-names = "be", "sat";



        ports {

            #address-cells = <1>;

            #size-cells = <0>;



            port@0 {

                reg = <0>;



                endpoint {

                    remote-endpoint = <&fe0_out_be0>;

                };

            };



            port@1 {

                reg = <1>;



                endpoint {

                    remote-endpoint = <&drc0_in_be0>;

                };

            };

        };

    };



...

Documentation/devicetree/bindings/display/allwinner,sun4i-a10-display-engine.yaml

0 → 100644
+114 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

%YAML 1.2

---

$id: http://devicetree.org/schemas/display/allwinner,sun4i-a10-display-engine.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Allwinner A10 Display Engine Pipeline Device Tree Bindings



maintainers:

  - Chen-Yu Tsai <wens@csie.org>

  - Maxime Ripard <mripard@kernel.org>



description: |

  The display engine pipeline (and its entry point, since it can be

  either directly the backend or the frontend) is represented as an

  extra node.



  The Allwinner A10 Display pipeline is composed of several components

  that are going to be documented below:



  For all connections between components up to the TCONs in the

  display pipeline, when there are multiple components of the same

  type at the same depth, the local endpoint ID must be the same as

  the remote component's index. For example, if the remote endpoint is

  Frontend 1, then the local endpoint ID must be 1.



  Frontend 0  [0] ------- [0]  Backend 0  [0] ------- [0]  TCON 0

              [1] --   -- [1]             [1] --   -- [1]

                    \ /                         \ /

                     X                           X

                    / \                         / \

              [0] --   -- [0]             [0] --   -- [0]

  Frontend 1  [1] ------- [1]  Backend 1  [1] ------- [1]  TCON 1



  For a two pipeline system such as the one depicted above, the lines

  represent the connections between the components, while the numbers

  within the square brackets corresponds to the ID of the local endpoint.



  The same rule also applies to DE 2.0 mixer-TCON connections:



  Mixer 0  [0] ----------- [0]  TCON 0

           [1] ----   ---- [1]

                   \ /

                    X

                   / \

           [0] ----   ---- [0]

  Mixer 1  [1] ----------- [1]  TCON 1



properties:

  compatible:

    enum:

      - allwinner,sun4i-a10-display-engine

      - allwinner,sun5i-a10s-display-engine

      - allwinner,sun5i-a13-display-engine

      - allwinner,sun6i-a31-display-engine

      - allwinner,sun6i-a31s-display-engine

      - allwinner,sun7i-a20-display-engine

      - allwinner,sun8i-a23-display-engine

      - allwinner,sun8i-a33-display-engine

      - allwinner,sun8i-a83t-display-engine

      - allwinner,sun8i-h3-display-engine

      - allwinner,sun8i-r40-display-engine

      - allwinner,sun8i-v3s-display-engine

      - allwinner,sun9i-a80-display-engine

      - allwinner,sun50i-a64-display-engine

      - allwinner,sun50i-h6-display-engine



  allwinner,pipelines:

    allOf:

      - $ref: /schemas/types.yaml#/definitions/phandle-array

      - minItems: 1

        maxItems: 2

    description: |

      Available display engine frontends (DE 1.0) or mixers (DE

      2.0/3.0) available.



required:

  - compatible

  - allwinner,pipelines



additionalProperties: false



if:

  properties:

    compatible:

      contains:

        enum:

          - allwinner,sun4i-a10-display-engine

          - allwinner,sun6i-a31-display-engine

          - allwinner,sun6i-a31s-display-engine

          - allwinner,sun7i-a20-display-engine

          - allwinner,sun8i-a83t-display-engine

          - allwinner,sun8i-r40-display-engine

          - allwinner,sun9i-a80-display-engine

          - allwinner,sun50i-a64-display-engine



then:

  properties:

    allwinner,pipelines:

      minItems: 2



else:

  properties:

    allwinner,pipelines:

      maxItems: 1



examples:

  - |

      de: display-engine {

          compatible = "allwinner,sun4i-a10-display-engine";

          allwinner,pipelines = <&fe0>, <&fe1>;

      };



...

Documentation/devicetree/bindings/display/allwinner,sun4i-a10-display-frontend.yaml

0 → 100644
+138 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

%YAML 1.2

---

$id: http://devicetree.org/schemas/display/allwinner,sun4i-a10-display-frontend.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Allwinner A10 Display Engine Frontend Device Tree Bindings



maintainers:

  - Chen-Yu Tsai <wens@csie.org>

  - Maxime Ripard <mripard@kernel.org>



description: |

  The display engine frontend does formats conversion, scaling,

  deinterlacing and color space conversion.



properties:

  compatible:

    enum:

      - allwinner,sun4i-a10-display-frontend

      - allwinner,sun5i-a13-display-frontend

      - allwinner,sun6i-a31-display-frontend

      - allwinner,sun7i-a20-display-frontend

      - allwinner,sun8i-a23-display-frontend

      - allwinner,sun8i-a33-display-frontend

      - allwinner,sun9i-a80-display-frontend



  reg:

    maxItems: 1



  interrupts:

    maxItems: 1



  clocks:

    items:

      - description: The frontend interface clock

      - description: The frontend module clock

      - description: The frontend DRAM clock



  clock-names:

    items:

      - const: ahb

      - const: mod

      - const: ram



  # FIXME: This should be made required eventually once every SoC will

  # have the MBUS declared.

  interconnects:

    maxItems: 1



  # FIXME: This should be made required eventually once every SoC will

  # have the MBUS declared.

  interconnect-names:

    const: dma-mem



  resets:

    maxItems: 1



  ports:

    type: object

    description: |

      A ports node with endpoint definitions as defined in

      Documentation/devicetree/bindings/media/video-interfaces.txt.



    properties:

      "#address-cells":

        const: 1



      "#size-cells":

        const: 0



      port@0:

        type: object

        description: |

          Input endpoints of the controller.



      port@1:

        type: object

        description: |

          Output endpoints of the controller.



    required:

      - "#address-cells"

      - "#size-cells"

      - port@1



    additionalProperties: false



required:

  - compatible

  - reg

  - interrupts

  - clocks

  - clock-names

  - resets

  - ports



additionalProperties: false



examples:

  - |

    #include <dt-bindings/clock/sun4i-a10-ccu.h>

    #include <dt-bindings/reset/sun4i-a10-ccu.h>



    fe0: display-frontend@1e00000 {

        compatible = "allwinner,sun4i-a10-display-frontend";

        reg = <0x01e00000 0x20000>;

        interrupts = <47>;

        clocks = <&ccu CLK_AHB_DE_FE0>, <&ccu CLK_DE_FE0>,

                 <&ccu CLK_DRAM_DE_FE0>;

        clock-names = "ahb", "mod",

                      "ram";

        resets = <&ccu RST_DE_FE0>;



        ports {

            #address-cells = <1>;

            #size-cells = <0>;



            fe0_out: port@1 {

                #address-cells = <1>;

                #size-cells = <0>;

                reg = <1>;



                fe0_out_be0: endpoint@0 {

                    reg = <0>;

                    remote-endpoint = <&be0_in_fe0>;

                };



                fe0_out_be1: endpoint@1 {

                    reg = <1>;

                    remote-endpoint = <&be1_in_fe0>;

                };

            };

        };

    };





...

Documentation/devicetree/bindings/display/allwinner,sun4i-a10-hdmi.yaml

0 → 100644
+183 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

%YAML 1.2

---

$id: http://devicetree.org/schemas/display/allwinner,sun4i-a10-hdmi.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Allwinner A10 HDMI Controller Device Tree Bindings



description: |

  The HDMI Encoder supports the HDMI video and audio outputs, and does

  CEC. It is one end of the pipeline.



maintainers:

  - Chen-Yu Tsai <wens@csie.org>

  - Maxime Ripard <mripard@kernel.org>



properties:

  compatible:

    oneOf:

      - const: allwinner,sun4i-a10-hdmi

      - const: allwinner,sun5i-a10s-hdmi

      - const: allwinner,sun6i-a31-hdmi

      - items:

        - const: allwinner,sun7i-a20-hdmi

        - const: allwinner,sun5i-a10s-hdmi



  reg:

    maxItems: 1



  interrupts:

    maxItems: 1



  clocks:

    oneOf:

      - items:

        - description: The HDMI interface clock

        - description: The HDMI module clock

        - description: The first video PLL

        - description: The second video PLL



      - items:

        - description: The HDMI interface clock

        - description: The HDMI module clock

        - description: The HDMI DDC clock

        - description: The first video PLL

        - description: The second video PLL



  clock-names:

    oneOf:

      - items:

        - const: ahb

        - const: mod

        - const: pll-0

        - const: pll-1



      - items:

        - const: ahb

        - const: mod

        - const: ddc

        - const: pll-0

        - const: pll-1



  resets:

    maxItems: 1



  dmas:

    items:

      - description: DDC Transmission DMA Channel

      - description: DDC Reception DMA Channel

      - description: Audio Transmission DMA Channel



  dma-names:

    items:

      - const: ddc-tx

      - const: ddc-rx

      - const: audio-tx



  ports:

    type: object

    description: |

      A ports node with endpoint definitions as defined in

      Documentation/devicetree/bindings/media/video-interfaces.txt.



    properties:

      "#address-cells":

        const: 1



      "#size-cells":

        const: 0



      port@0:

        type: object

        description: |

          Input endpoints of the controller.



      port@1:

        type: object

        description: |

          Output endpoints of the controller. Usually an HDMI

          connector.



    required:

      - "#address-cells"

      - "#size-cells"

      - port@0

      - port@1



    additionalProperties: false



required:

  - compatible

  - reg

  - interrupts

  - clocks

  - clock-names

  - dmas

  - dma-names



if:

  properties:

    compatible:

      contains:

        const: allwinner,sun6i-a31-hdmi



then:

  properties:

    clocks:

      minItems: 5



    clock-names:

      minItems: 5



  required:

    - resets



additionalProperties: false



examples:

  - |

    #include <dt-bindings/clock/sun4i-a10-ccu.h>

    #include <dt-bindings/dma/sun4i-a10.h>

    #include <dt-bindings/reset/sun4i-a10-ccu.h>



    hdmi: hdmi@1c16000 {

        compatible = "allwinner,sun4i-a10-hdmi";

        reg = <0x01c16000 0x1000>;

        interrupts = <58>;

        clocks = <&ccu CLK_AHB_HDMI0>, <&ccu CLK_HDMI>,

                 <&ccu CLK_PLL_VIDEO0_2X>,

                 <&ccu CLK_PLL_VIDEO1_2X>;

        clock-names = "ahb", "mod", "pll-0", "pll-1";

        dmas = <&dma SUN4I_DMA_NORMAL 16>,

               <&dma SUN4I_DMA_NORMAL 16>,

               <&dma SUN4I_DMA_DEDICATED 24>;

        dma-names = "ddc-tx", "ddc-rx", "audio-tx";



        ports {

            #address-cells = <1>;

            #size-cells = <0>;



            hdmi_in: port@0 {

                #address-cells = <1>;

                #size-cells = <0>;

                reg = <0>;



                hdmi_in_tcon0: endpoint@0 {

                    reg = <0>;

                    remote-endpoint = <&tcon0_out_hdmi>;

                };



                hdmi_in_tcon1: endpoint@1 {

                    reg = <1>;

                    remote-endpoint = <&tcon1_out_hdmi>;

                };

            };



            hdmi_out: port@1 {

                reg = <1>;

            };

        };

    };



...

Documentation/devicetree/bindings/display/allwinner,sun4i-a10-tcon.yaml

0 → 100644
+676 −0

File added.

Preview size limit exceeded, changes collapsed.

CRA Git | Maintained and supported by SUSTech CRA and CCSE