Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 376bf52d authored by Neil Armstrong's avatar Neil Armstrong
Browse files

dt-bindings: display: amlogic, meson-dw-hdmi: convert to yaml 



Now that we have the DT validation in place, let's convert the device tree
bindings for the Amlogic Synopsys DW-HDMI specifics over to YAML schemas.

The original example and usage of clock-names uses a reversed "isfr"
and "iahb" clock-names, the rewritten YAML bindings uses the reversed
instead of fixing the device trees order.

The #sound-dai-cells optional property has been added to match this node
as a sound dai.

The port connection table has been dropped in favor of a description
of each port.

Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarNeil Armstrong <narmstrong@baylibre.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20190808085522.21950-2-narmstrong@baylibre.com
parent 52791eee

Documentation/devicetree/bindings/display/amlogic,meson-dw-hdmi.txt

deleted100644 → 0
+0 −119
Original line number Diff line number Diff line 
Amlogic specific extensions to the Synopsys Designware HDMI Controller

======================================================================



The Amlogic Meson Synopsys Designware Integration is composed of :

- A Synopsys DesignWare HDMI Controller IP

- A TOP control block controlling the Clocks and PHY

- A custom HDMI PHY in order to convert video to TMDS signal

 ___________________________________

|            HDMI TOP               |<= HPD

|___________________________________|

|                  |                |

|  Synopsys HDMI   |   HDMI PHY     |=> TMDS

|    Controller    |________________|

|___________________________________|<=> DDC



The HDMI TOP block only supports HPD sensing.

The Synopsys HDMI Controller interrupt is routed through the

TOP Block interrupt.

Communication to the TOP Block and the Synopsys HDMI Controller is done

via a pair of dedicated addr+read/write registers.

The HDMI PHY is configured by registers in the HHI register block.



Pixel data arrives in 4:4:4 format from the VENC block and the VPU HDMI mux

selects either the ENCI encoder for the 576i or 480i formats or the ENCP

encoder for all the other formats including interlaced HD formats.



The VENC uses a DVI encoder on top of the ENCI or ENCP encoders to generate

DVI timings for the HDMI controller.



Amlogic Meson GXBB, GXL and GXM SoCs families embeds the Synopsys DesignWare

HDMI TX IP version 2.01a with HDCP and I2C & S/PDIF

audio source interfaces.



Required properties:

- compatible: value should be different for each SoC family as :

	- GXBB (S905) : "amlogic,meson-gxbb-dw-hdmi"

	- GXL (S905X, S905D) : "amlogic,meson-gxl-dw-hdmi"

	- GXM (S912) : "amlogic,meson-gxm-dw-hdmi"

	followed by the common "amlogic,meson-gx-dw-hdmi"

	- G12A (S905X2, S905Y2, S905D2) : "amlogic,meson-g12a-dw-hdmi"

- reg: Physical base address and length of the controller's registers.

- interrupts: The HDMI interrupt number

- clocks, clock-names : must have the phandles to the HDMI iahb and isfr clocks,

  and the Amlogic Meson venci clocks as described in

  Documentation/devicetree/bindings/clock/clock-bindings.txt,

  the clocks are soc specific, the clock-names should be "iahb", "isfr", "venci"

- resets, resets-names: must have the phandles to the HDMI apb, glue and phy

  resets as described in :

  Documentation/devicetree/bindings/reset/reset.txt,

  the reset-names should be "hdmitx_apb", "hdmitx", "hdmitx_phy"



Optional properties:

- hdmi-supply: Optional phandle to an external 5V regulator to power the HDMI

  logic, as described in the file ../regulator/regulator.txt



Required nodes:



The connections to the HDMI ports are modeled using the OF graph

bindings specified in Documentation/devicetree/bindings/graph.txt.



The following table lists for each supported model the port number

corresponding to each HDMI output and input.



		Port 0		Port 1

-----------------------------------------

 S905 (GXBB)	VENC Input	TMDS Output

 S905X (GXL)	VENC Input	TMDS Output

 S905D (GXL)	VENC Input	TMDS Output

 S912 (GXM)	VENC Input	TMDS Output

 S905X2 (G12A)	VENC Input	TMDS Output

 S905Y2 (G12A)	VENC Input	TMDS Output

 S905D2 (G12A)	VENC Input	TMDS Output



Example:



hdmi-connector {

	compatible = "hdmi-connector";

	type = "a";



	port {

		hdmi_connector_in: endpoint {

			remote-endpoint = <&hdmi_tx_tmds_out>;

		};

	};

};



hdmi_tx: hdmi-tx@c883a000 {

	compatible = "amlogic,meson-gxbb-dw-hdmi", "amlogic,meson-gx-dw-hdmi";

	reg = <0x0 0xc883a000 0x0 0x1c>;

	interrupts = <GIC_SPI 57 IRQ_TYPE_EDGE_RISING>;

	resets = <&reset RESET_HDMITX_CAPB3>,

		 <&reset RESET_HDMI_SYSTEM_RESET>,

		 <&reset RESET_HDMI_TX>;

	reset-names = "hdmitx_apb", "hdmitx", "hdmitx_phy";

	clocks = <&clkc CLKID_HDMI_PCLK>,

		 <&clkc CLKID_CLK81>,

		 <&clkc CLKID_GCLK_VENCI_INT0>;

	clock-names = "isfr", "iahb", "venci";

	#address-cells = <1>;

	#size-cells = <0>;



	/* VPU VENC Input */

	hdmi_tx_venc_port: port@0 {

		reg = <0>;



		hdmi_tx_in: endpoint {

			remote-endpoint = <&hdmi_tx_out>;

		};

	};



	/* TMDS Output */

	hdmi_tx_tmds_port: port@1 {

		reg = <1>;



		hdmi_tx_tmds_out: endpoint {

			remote-endpoint = <&hdmi_connector_in>;

		};

	};

};

Documentation/devicetree/bindings/display/amlogic,meson-dw-hdmi.yaml

0 → 100644
+150 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

# Copyright 2019 BayLibre, SAS

%YAML 1.2

---

$id: "http://devicetree.org/schemas/display/amlogic,meson-dw-hdmi.yaml#"

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



title: Amlogic specific extensions to the Synopsys Designware HDMI Controller



maintainers:

  - Neil Armstrong <narmstrong@baylibre.com>



description: |

  The Amlogic Meson Synopsys Designware Integration is composed of

  - A Synopsys DesignWare HDMI Controller IP

  - A TOP control block controlling the Clocks and PHY

  - A custom HDMI PHY in order to convert video to TMDS signal

   ___________________________________

  |            HDMI TOP               |<= HPD

  |___________________________________|

  |                  |                |

  |  Synopsys HDMI   |   HDMI PHY     |=> TMDS

  |    Controller    |________________|

  |___________________________________|<=> DDC



  The HDMI TOP block only supports HPD sensing.

  The Synopsys HDMI Controller interrupt is routed through the

  TOP Block interrupt.

  Communication to the TOP Block and the Synopsys HDMI Controller is done

  via a pair of dedicated addr+read/write registers.

  The HDMI PHY is configured by registers in the HHI register block.



  Pixel data arrives in "4:4:4" format from the VENC block and the VPU HDMI mux

  selects either the ENCI encoder for the 576i or 480i formats or the ENCP

  encoder for all the other formats including interlaced HD formats.



  The VENC uses a DVI encoder on top of the ENCI or ENCP encoders to generate

  DVI timings for the HDMI controller.



  Amlogic Meson GXBB, GXL and GXM SoCs families embeds the Synopsys DesignWare

  HDMI TX IP version 2.01a with HDCP and I2C & S/PDIF

  audio source interfaces.



properties:

  compatible:

    oneOf:

      - items:

          - enum:

              - amlogic,meson-gxbb-dw-hdmi # GXBB (S905)

              - amlogic,meson-gxl-dw-hdmi # GXL (S905X, S905D)

              - amlogic,meson-gxm-dw-hdmi # GXM (S912)

          - const: amlogic,meson-gx-dw-hdmi

      - enum:

          - amlogic,meson-g12a-dw-hdmi # G12A (S905X2, S905Y2, S905D2)



  reg:

    maxItems: 1



  interrupts:

    maxItems: 1



  clocks:

    minItems: 3



  clock-names:

    items:

      - const: isfr

      - const: iahb

      - const: venci



  resets:

    minItems: 3



  reset-names:

    items:

      - const: hdmitx_apb

      - const: hdmitx

      - const: hdmitx_phy



  hdmi-supply:

    description: phandle to an external 5V regulator to power the HDMI logic

    allOf:

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



  port@0:

    type: object

    description:

      A port node pointing to the VENC Input port node.



  port@1:

    type: object

    description:

      A port node pointing to the TMDS Output port node.



  "#address-cells":

    const: 1



  "#size-cells":

    const: 0



  "#sound-dai-cells":

    const: 0



required:

  - compatible

  - reg

  - interrupts

  - clocks

  - clock-names

  - resets

  - reset-names

  - port@0

  - port@1

  - "#address-cells"

  - "#size-cells"



additionalProperties: false



examples:

  - |

    hdmi_tx: hdmi-tx@c883a000 {

        compatible = "amlogic,meson-gxbb-dw-hdmi", "amlogic,meson-gx-dw-hdmi";

        reg = <0xc883a000 0x1c>;

        interrupts = <57>;

        resets = <&reset_apb>, <&reset_hdmitx>, <&reset_hdmitx_phy>;

        reset-names = "hdmitx_apb", "hdmitx", "hdmitx_phy";

        clocks = <&clk_isfr>, <&clk_iahb>, <&clk_venci>;

        clock-names = "isfr", "iahb", "venci";

        #address-cells = <1>;

        #size-cells = <0>;



        /* VPU VENC Input */

        hdmi_tx_venc_port: port@0 {

            reg = <0>;



            hdmi_tx_in: endpoint {

                remote-endpoint = <&hdmi_tx_out>;

            };

        };



        /* TMDS Output */

        hdmi_tx_tmds_port: port@1 {

             reg = <1>;



             hdmi_tx_tmds_out: endpoint {

                 remote-endpoint = <&hdmi_connector_in>;

             };

        };

    };