dt-bindings: media: meson-ao-cec: convert to yaml

Commit Message

Neil Armstrong Oct. 21, 2019, 12:11 p.m. UTC

Now that we have the DT validation in place, let's convert the device tree
bindings for the Amlogic AO-CEC controller over to a YAML schemas.

Signed-off-by: Neil Armstrong <[e-mail]>
---
 .../media/amlogic,meson-gx-ao-cec.yaml        | 91 +++++++++++++++++++
 .../bindings/media/meson-ao-cec.txt           | 37 --------
 2 files changed, 91 insertions(+), 37 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/media/amlogic,meson-gx-ao-cec.yaml
 delete mode 100644 Documentation/devicetree/bindings/media/meson-ao-cec.txt

Comments

Rob Herring Oct. 29, 2019, 3:51 p.m. UTC | #1

On Mon, 21 Oct 2019 14:11:31 +0200, Neil Armstrong wrote:
> Now that we have the DT validation in place, let's convert the device tree
> bindings for the Amlogic AO-CEC controller over to a YAML schemas.
> 
> Signed-off-by: Neil Armstrong <[e-mail]>
> ---
>  .../media/amlogic,meson-gx-ao-cec.yaml        | 91 +++++++++++++++++++
>  .../bindings/media/meson-ao-cec.txt           | 37 --------
>  2 files changed, 91 insertions(+), 37 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/media/amlogic,meson-gx-ao-cec.yaml
>  delete mode 100644 Documentation/devicetree/bindings/media/meson-ao-cec.txt
> 

Applied, thanks.

Rob

Hans Verkuil Oct. 30, 2019, 10:38 a.m. UTC | #2

Hi Neil,

Can you post a new patch that updates the MAINTAINERS file?

Thanks!

	Hans

On 10/21/19 2:11 PM, Neil Armstrong wrote:
> Now that we have the DT validation in place, let's convert the device tree
> bindings for the Amlogic AO-CEC controller over to a YAML schemas.
> 
> Signed-off-by: Neil Armstrong <[e-mail]>
> ---
>   .../media/amlogic,meson-gx-ao-cec.yaml        | 91 +++++++++++++++++++
>   .../bindings/media/meson-ao-cec.txt           | 37 --------
>   2 files changed, 91 insertions(+), 37 deletions(-)
>   create mode 100644 Documentation/devicetree/bindings/media/amlogic,meson-gx-ao-cec.yaml
>   delete mode 100644 Documentation/devicetree/bindings/media/meson-ao-cec.txt
> 
> diff --git a/Documentation/devicetree/bindings/media/amlogic,meson-gx-ao-cec.yaml b/Documentation/devicetree/bindings/media/amlogic,meson-gx-ao-cec.yaml
> new file mode 100644
> index 000000000000..41197578f19a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/amlogic,meson-gx-ao-cec.yaml
> @@ -0,0 +1,91 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright 2019 BayLibre, SAS
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/media/amlogic,meson-gx-ao-cec.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Amlogic Meson AO-CEC Controller
> +
> +maintainers:
> +  - Neil Armstrong <[e-mail]>
> +
> +description: |
> +  The Amlogic Meson AO-CEC module is present is Amlogic SoCs and its purpose is
> +  to handle communication between HDMI connected devices over the CEC bus.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - amlogic,meson-gx-ao-cec # GXBB, GXL, GXM, G12A and SM1 AO_CEC_A module
> +      - amlogic,meson-g12a-ao-cec # G12A AO_CEC_B module
> +      - amlogic,meson-sm1-ao-cec # SM1 AO_CEC_B module
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  hdmi-phandle:
> +    description: phandle to the HDMI controller
> +    allOf:
> +      - $ref: /schemas/types.yaml#/definitions/phandle
> +
> +allOf:
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - amlogic,meson-gx-ao-cec
> +
> +    then:
> +      properties:
> +        clocks:
> +          items:
> +            - description: AO-CEC clock
> +
> +        clock-names:
> +          maxItems: 1
> +          items:
> +            - const: core
> +
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - amlogic,meson-g12a-ao-cec
> +              - amlogic,meson-sm1-ao-cec
> +
> +    then:
> +      properties:
> +        clocks:
> +          items:
> +            - description: AO-CEC clock generator source
> +
> +        clock-names:
> +          maxItems: 1
> +          items:
> +            - const: oscin
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - hdmi-phandle
> +  - clocks
> +  - clock-names
> +
> +examples:
> +  - |
> +    cec_AO: cec@100 {
> +        compatible = "amlogic,meson-gx-ao-cec";
> +        reg = <0x0 0x00100 0x0 0x14>;
> +        interrupts = <199>;
> +        clocks = <&clkc_cec>;
> +        clock-names = "core";
> +        hdmi-phandle = <&hdmi_tx>;
> +    };
> +
> diff --git a/Documentation/devicetree/bindings/media/meson-ao-cec.txt b/Documentation/devicetree/bindings/media/meson-ao-cec.txt
> deleted file mode 100644
> index ad92ee41c0dd..000000000000
> --- a/Documentation/devicetree/bindings/media/meson-ao-cec.txt
> +++ /dev/null
> @@ -1,37 +0,0 @@
> -* Amlogic Meson AO-CEC driver
> -
> -The Amlogic Meson AO-CEC module is present is Amlogic SoCs and its purpose is
> -to handle communication between HDMI connected devices over the CEC bus.
> -
> -Required properties:
> -  - compatible : value should be following depending on the SoC :
> -	For GXBB, GXL, GXM, G12A and SM1 (AO_CEC_A module) :
> -	"amlogic,meson-gx-ao-cec"
> -	For G12A (AO_CEC_B module) :
> -	"amlogic,meson-g12a-ao-cec"
> -	For SM1 (AO_CEC_B module) :
> -	"amlogic,meson-sm1-ao-cec"
> -
> -  - reg : Physical base address of the IP registers and length of memory
> -	  mapped region.
> -
> -  - interrupts : AO-CEC interrupt number to the CPU.
> -  - clocks : from common clock binding: handle to AO-CEC clock.
> -  - clock-names : from common clock binding, must contain :
> -		For GXBB, GXL, GXM, G12A and SM1 (AO_CEC_A module) :
> -		- "core"
> -		For G12A, SM1 (AO_CEC_B module) :
> -		- "oscin"
> -		corresponding to entry in the clocks property.
> -  - hdmi-phandle: phandle to the HDMI controller
> -
> -Example:
> -
> -cec_AO: cec@100 {
> -	compatible = "amlogic,meson-gx-ao-cec";
> -	reg = <0x0 0x00100 0x0 0x14>;
> -	interrupts = <GIC_SPI 199 IRQ_TYPE_EDGE_RISING>;
> -	clocks = <&clkc_AO CLKID_AO_CEC_32K>;
> -	clock-names = "core";
> -	hdmi-phandle = <&hdmi_tx>;
> -};
>

Patch

diff --git a/Documentation/devicetree/bindings/media/amlogic,meson-gx-ao-cec.yaml b/Documentation/devicetree/bindings/media/amlogic,meson-gx-ao-cec.yaml
new file mode 100644
index 000000000000..41197578f19a
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/amlogic,meson-gx-ao-cec.yaml
@@ -0,0 +1,91 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2019 BayLibre, SAS
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/media/amlogic,meson-gx-ao-cec.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Amlogic Meson AO-CEC Controller
+
+maintainers:
+  - Neil Armstrong <[e-mail]>
+
+description: |
+  The Amlogic Meson AO-CEC module is present is Amlogic SoCs and its purpose is
+  to handle communication between HDMI connected devices over the CEC bus.
+
+properties:
+  compatible:
+    enum:
+      - amlogic,meson-gx-ao-cec # GXBB, GXL, GXM, G12A and SM1 AO_CEC_A module
+      - amlogic,meson-g12a-ao-cec # G12A AO_CEC_B module
+      - amlogic,meson-sm1-ao-cec # SM1 AO_CEC_B module
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  hdmi-phandle:
+    description: phandle to the HDMI controller
+    allOf:
+      - $ref: /schemas/types.yaml#/definitions/phandle
+
+allOf:
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - amlogic,meson-gx-ao-cec
+
+    then:
+      properties:
+        clocks:
+          items:
+            - description: AO-CEC clock
+
+        clock-names:
+          maxItems: 1
+          items:
+            - const: core
+
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - amlogic,meson-g12a-ao-cec
+              - amlogic,meson-sm1-ao-cec
+
+    then:
+      properties:
+        clocks:
+          items:
+            - description: AO-CEC clock generator source
+
+        clock-names:
+          maxItems: 1
+          items:
+            - const: oscin
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - hdmi-phandle
+  - clocks
+  - clock-names
+
+examples:
+  - |
+    cec_AO: cec@100 {
+        compatible = "amlogic,meson-gx-ao-cec";
+        reg = <0x0 0x00100 0x0 0x14>;
+        interrupts = <199>;
+        clocks = <&clkc_cec>;
+        clock-names = "core";
+        hdmi-phandle = <&hdmi_tx>;
+    };
+
diff --git a/Documentation/devicetree/bindings/media/meson-ao-cec.txt b/Documentation/devicetree/bindings/media/meson-ao-cec.txt
deleted file mode 100644
index ad92ee41c0dd..000000000000
--- a/Documentation/devicetree/bindings/media/meson-ao-cec.txt
+++ /dev/null
@@ -1,37 +0,0 @@ 
-* Amlogic Meson AO-CEC driver
-
-The Amlogic Meson AO-CEC module is present is Amlogic SoCs and its purpose is
-to handle communication between HDMI connected devices over the CEC bus.
-
-Required properties:
-  - compatible : value should be following depending on the SoC :
-	For GXBB, GXL, GXM, G12A and SM1 (AO_CEC_A module) :
-	"amlogic,meson-gx-ao-cec"
-	For G12A (AO_CEC_B module) :
-	"amlogic,meson-g12a-ao-cec"
-	For SM1 (AO_CEC_B module) :
-	"amlogic,meson-sm1-ao-cec"
-
-  - reg : Physical base address of the IP registers and length of memory
-	  mapped region.
-
-  - interrupts : AO-CEC interrupt number to the CPU.
-  - clocks : from common clock binding: handle to AO-CEC clock.
-  - clock-names : from common clock binding, must contain :
-		For GXBB, GXL, GXM, G12A and SM1 (AO_CEC_A module) :
-		- "core"
-		For G12A, SM1 (AO_CEC_B module) :
-		- "oscin"
-		corresponding to entry in the clocks property.
-  - hdmi-phandle: phandle to the HDMI controller
-
-Example:
-
-cec_AO: cec@100 {
-	compatible = "amlogic,meson-gx-ao-cec";
-	reg = <0x0 0x00100 0x0 0x14>;
-	interrupts = <GIC_SPI 199 IRQ_TYPE_EDGE_RISING>;
-	clocks = <&clkc_AO CLKID_AO_CEC_32K>;
-	clock-names = "core";
-	hdmi-phandle = <&hdmi_tx>;
-};