diff mbox series

dt-bindings: display: anx7814.txt: convert to yaml

Message ID 20200424065354.23781-1-ricardo.canuelo@collabora.com (mailing list archive)
State New, archived
Headers show
Series dt-bindings: display: anx7814.txt: convert to yaml | expand

Commit Message

Ricardo Cañuelo April 24, 2020, 6:53 a.m. UTC
This converts the Analogix ANX7814 bridge DT binding to yaml. Port
definitions and descriptions were expanded, apart from that it's a
direct translation from the original binding.

Signed-off-by: Ricardo Cañuelo <ricardo.canuelo@collabora.com>
---
Tested with:
make dt_binding_check ARCH=arm64 DT_SCHEMA_FILES=<.../anx7814.yaml>
make dtbs_check ARCH=arm64 DT_SCHEMA_FILES=<.../anx7814.yaml>

 .../bindings/display/bridge/anx7814.txt       |  42 ------
 .../bindings/display/bridge/anx7814.yaml      | 133 ++++++++++++++++++
 2 files changed, 133 insertions(+), 42 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/display/bridge/anx7814.txt
 create mode 100644 Documentation/devicetree/bindings/display/bridge/anx7814.yaml

Comments

Enric Balletbo i Serra April 24, 2020, 2:08 p.m. UTC | #1
Hi Ricardo,

Thank you for your patch.

On 24/4/20 8:53, Ricardo Cañuelo wrote:
> This converts the Analogix ANX7814 bridge DT binding to yaml. Port
> definitions and descriptions were expanded, apart from that it's a
> direct translation from the original binding.
> 
> Signed-off-by: Ricardo Cañuelo <ricardo.canuelo@collabora.com>
> ---
> Tested with:
> make dt_binding_check ARCH=arm64 DT_SCHEMA_FILES=<.../anx7814.yaml>
> make dtbs_check ARCH=arm64 DT_SCHEMA_FILES=<.../anx7814.yaml>
> 
>  .../bindings/display/bridge/anx7814.txt       |  42 ------
>  .../bindings/display/bridge/anx7814.yaml      | 133 ++++++++++++++++++
>  2 files changed, 133 insertions(+), 42 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/display/bridge/anx7814.txt
>  create mode 100644 Documentation/devicetree/bindings/display/bridge/anx7814.yaml

Use the full compatible string: analogix,anx7814.yaml

> 
> diff --git a/Documentation/devicetree/bindings/display/bridge/anx7814.txt b/Documentation/devicetree/bindings/display/bridge/anx7814.txt
> deleted file mode 100644
> index 17258747fff6..000000000000
> --- a/Documentation/devicetree/bindings/display/bridge/anx7814.txt
> +++ /dev/null
> @@ -1,42 +0,0 @@
> -Analogix ANX7814 SlimPort (Full-HD Transmitter)
> ------------------------------------------------
> -
> -The ANX7814 is an ultra-low power Full-HD (1080p60) SlimPort transmitter
> -designed for portable devices.
> -
> -Required properties:
> -
> - - compatible		: Must be one of:
> -			  "analogix,anx7808"
> -			  "analogix,anx7812"
> -			  "analogix,anx7814"
> -			  "analogix,anx7818"
> - - reg			: I2C address of the device
> - - interrupts		: Should contain the INTP interrupt
> - - hpd-gpios		: Which GPIO to use for hpd
> - - pd-gpios		: Which GPIO to use for power down
> - - reset-gpios		: Which GPIO to use for reset
> -
> -Optional properties:
> -
> - - dvdd10-supply	: Regulator for 1.0V digital core power.
> - - Video port for HDMI input, using the DT bindings defined in [1].
> -
> -[1]: Documentation/devicetree/bindings/media/video-interfaces.txt
> -
> -Example:
> -
> -	anx7814: anx7814@38 {
> -		compatible = "analogix,anx7814";
> -		reg = <0x38>;
> -		interrupt-parent = <&gpio0>;
> -		interrupts = <99 IRQ_TYPE_LEVEL_LOW>;   /* INTP */
> -		hpd-gpios = <&pio 36 GPIO_ACTIVE_HIGH>;
> -		pd-gpios = <&pio 33 GPIO_ACTIVE_HIGH>;
> -		reset-gpios = <&pio 98 GPIO_ACTIVE_HIGH>;
> -		port {
> -			anx7814_in: endpoint {
> -				remote-endpoint = <&hdmi0_out>;
> -			};
> -		};
> -	};
> diff --git a/Documentation/devicetree/bindings/display/bridge/anx7814.yaml b/Documentation/devicetree/bindings/display/bridge/anx7814.yaml
> new file mode 100644
> index 000000000000..53d3c778c893
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/bridge/anx7814.yaml
> @@ -0,0 +1,133 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/display/bridge/anx7814.yaml#

Don't forget to update this too.


> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analogix ANX7814 SlimPort (Full-HD Transmitter)
> +
> +maintainers:
> +  - Enric Balletbo i Serra <enric.balletbo@collabora.com>
> +
> +description: |
> +  The ANX7814 is an ultra-low power Full-HD (1080p60) SlimPort transmitter
> +  designed for portable devices.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - analogix,anx7808
> +      - analogix,anx7812
> +      - analogix,anx7814
> +      - analogix,anx7818
> +
> +  reg:
> +    maxItems: 1
> +    description: I2C address of the device.
> +

Can drop the description as there's nothing specific to this device.

> +  interrupts:
> +    maxItems: 1
> +    description: Should contain the INTP interrupt.
> +
> +  hpd-gpios:
> +    maxItems: 1
> +    description: Which GPIO to use for hpd.
> +
> +  pd-gpios:
> +    maxItems: 1
> +    description: Which GPIO to use for power down.
> +
> +  reset-gpios:
> +    maxItems: 1
> +    description: Which GPIO to use for reset.
> +
> +  dvdd10-supply:
> +    maxItems: 1
> +    description: Regulator for 1.0V digital core power.
> +
> +  ports:
> +    type: object
> +    description:
> +      A node containing input and output port nodes with endpoint
> +      definitions as documented in
> +      Documentation/devicetree/bindings/media/video-interfaces.txt
> +      Documentation/devicetree/bindings/graph.txt
> +
> +    properties:
> +      "#address-cells":
> +        const: 1
> +

I don't' think you need to specify this. You can drop it (better double check
with Rob, though)

> +      "#size-cells":
> +        const: 0
> +

I don't' think you need to specify this. You can drop it (better double check
with Rob, though)

> +      port@0:
> +        type: object
> +        description: Video port for HDMI input.
> +
> +        properties:
> +          reg:
> +            const: 0
> +
> +      port@1:
> +        type: object
> +        description:
> +          Video port for SlimPort, DisplayPort, eDP or MyDP output.
> +
> +        properties:
> +          reg:
> +            const: 1
> +
> +    required:
> +      - port@0
> +      - port@1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - hpd-gpios
> +  - pd-gpios
> +  - reset-gpios
> +  - ports
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    #include <dt-bindings/gpio/gpio.h>
> +
> +    i2c0 {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        anx7814: anx7814@38 {

This should be "bridge@38 {", since node names are supposed to
match the class of the device instead of the name of the device. I guess.

> +            compatible = "analogix,anx7814";
> +            reg = <0x38>;
> +            interrupt-parent = <&gpio0>;
> +            interrupts = <99 IRQ_TYPE_LEVEL_LOW>;   /* INTP */
> +            hpd-gpios = <&pio 36 GPIO_ACTIVE_HIGH>;
> +            pd-gpios = <&pio 33 GPIO_ACTIVE_HIGH>;
> +            reset-gpios = <&pio 98 GPIO_ACTIVE_HIGH>;
> +
> +            ports {
> +                #address-cells = <1>;
> +                #size-cells = <0>;
> +
> +                port@0 {
> +                    reg = <0>;
> +                    anx7814_in: endpoint {
> +                        remote-endpoint = <&hdmi0_out>;
> +                    };
> +                };
> +
> +                port@1 {
> +                    reg = <1>;
> +                    anx7814_out: endpoint {
> +                        remote-endpoint = <&edp_out>;
> +                    };
> +                };
> +            };
> +        };
> +    };
> +...
>
Ricardo Cañuelo April 27, 2020, 8:04 a.m. UTC | #2
On vie 24-04-2020 16:08:10, Enric Balletbo i Serra wrote:
> Hi Ricardo,
> 
> Thank you for your patch.

Hi Enric,

Thanks for reviewing it.

> > +      "#size-cells":
> > +        const: 0
> > +
> 
> I don't' think you need to specify this. You can drop it (better double check
> with Rob, though)

I think you're right. I put it just to be clear about it and because
some other yaml bindings specify them, but this is already well defined
in Documentation/devicetree/bindings/mediavideo-interfaces.txt, which is
referenced in the binding.

I agree with the rest of the comments.

Kind regards,
Ricardo
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/display/bridge/anx7814.txt b/Documentation/devicetree/bindings/display/bridge/anx7814.txt
deleted file mode 100644
index 17258747fff6..000000000000
--- a/Documentation/devicetree/bindings/display/bridge/anx7814.txt
+++ /dev/null
@@ -1,42 +0,0 @@ 
-Analogix ANX7814 SlimPort (Full-HD Transmitter)
------------------------------------------------
-
-The ANX7814 is an ultra-low power Full-HD (1080p60) SlimPort transmitter
-designed for portable devices.
-
-Required properties:
-
- - compatible		: Must be one of:
-			  "analogix,anx7808"
-			  "analogix,anx7812"
-			  "analogix,anx7814"
-			  "analogix,anx7818"
- - reg			: I2C address of the device
- - interrupts		: Should contain the INTP interrupt
- - hpd-gpios		: Which GPIO to use for hpd
- - pd-gpios		: Which GPIO to use for power down
- - reset-gpios		: Which GPIO to use for reset
-
-Optional properties:
-
- - dvdd10-supply	: Regulator for 1.0V digital core power.
- - Video port for HDMI input, using the DT bindings defined in [1].
-
-[1]: Documentation/devicetree/bindings/media/video-interfaces.txt
-
-Example:
-
-	anx7814: anx7814@38 {
-		compatible = "analogix,anx7814";
-		reg = <0x38>;
-		interrupt-parent = <&gpio0>;
-		interrupts = <99 IRQ_TYPE_LEVEL_LOW>;   /* INTP */
-		hpd-gpios = <&pio 36 GPIO_ACTIVE_HIGH>;
-		pd-gpios = <&pio 33 GPIO_ACTIVE_HIGH>;
-		reset-gpios = <&pio 98 GPIO_ACTIVE_HIGH>;
-		port {
-			anx7814_in: endpoint {
-				remote-endpoint = <&hdmi0_out>;
-			};
-		};
-	};
diff --git a/Documentation/devicetree/bindings/display/bridge/anx7814.yaml b/Documentation/devicetree/bindings/display/bridge/anx7814.yaml
new file mode 100644
index 000000000000..53d3c778c893
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/bridge/anx7814.yaml
@@ -0,0 +1,133 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/bridge/anx7814.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analogix ANX7814 SlimPort (Full-HD Transmitter)
+
+maintainers:
+  - Enric Balletbo i Serra <enric.balletbo@collabora.com>
+
+description: |
+  The ANX7814 is an ultra-low power Full-HD (1080p60) SlimPort transmitter
+  designed for portable devices.
+
+properties:
+  compatible:
+    enum:
+      - analogix,anx7808
+      - analogix,anx7812
+      - analogix,anx7814
+      - analogix,anx7818
+
+  reg:
+    maxItems: 1
+    description: I2C address of the device.
+
+  interrupts:
+    maxItems: 1
+    description: Should contain the INTP interrupt.
+
+  hpd-gpios:
+    maxItems: 1
+    description: Which GPIO to use for hpd.
+
+  pd-gpios:
+    maxItems: 1
+    description: Which GPIO to use for power down.
+
+  reset-gpios:
+    maxItems: 1
+    description: Which GPIO to use for reset.
+
+  dvdd10-supply:
+    maxItems: 1
+    description: Regulator for 1.0V digital core power.
+
+  ports:
+    type: object
+    description:
+      A node containing input and output port nodes with endpoint
+      definitions as documented in
+      Documentation/devicetree/bindings/media/video-interfaces.txt
+      Documentation/devicetree/bindings/graph.txt
+
+    properties:
+      "#address-cells":
+        const: 1
+
+      "#size-cells":
+        const: 0
+
+      port@0:
+        type: object
+        description: Video port for HDMI input.
+
+        properties:
+          reg:
+            const: 0
+
+      port@1:
+        type: object
+        description:
+          Video port for SlimPort, DisplayPort, eDP or MyDP output.
+
+        properties:
+          reg:
+            const: 1
+
+    required:
+      - port@0
+      - port@1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - hpd-gpios
+  - pd-gpios
+  - reset-gpios
+  - ports
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/gpio/gpio.h>
+
+    i2c0 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        anx7814: anx7814@38 {
+            compatible = "analogix,anx7814";
+            reg = <0x38>;
+            interrupt-parent = <&gpio0>;
+            interrupts = <99 IRQ_TYPE_LEVEL_LOW>;   /* INTP */
+            hpd-gpios = <&pio 36 GPIO_ACTIVE_HIGH>;
+            pd-gpios = <&pio 33 GPIO_ACTIVE_HIGH>;
+            reset-gpios = <&pio 98 GPIO_ACTIVE_HIGH>;
+
+            ports {
+                #address-cells = <1>;
+                #size-cells = <0>;
+
+                port@0 {
+                    reg = <0>;
+                    anx7814_in: endpoint {
+                        remote-endpoint = <&hdmi0_out>;
+                    };
+                };
+
+                port@1 {
+                    reg = <1>;
+                    anx7814_out: endpoint {
+                        remote-endpoint = <&edp_out>;
+                    };
+                };
+            };
+        };
+    };
+...