Re: [PATCH v2 1/2] dt-bindings: serial: lantiq: Convert to YAML schema
From: Rob Herring
Date: Tue Aug 20 2019 - 12:08:04 EST
On Tue, Aug 20, 2019 at 3:29 AM Rahul Tanwar
<rahul.tanwar@xxxxxxxxxxxxxxx> wrote:
>
> Convert the existing DT binding document for Lantiq SoC ASC serial controller
> from txt format to YAML format.
>
> Signed-off-by: Rahul Tanwar <rahul.tanwar@xxxxxxxxxxxxxxx>
> ---
> .../devicetree/bindings/serial/lantiq_asc.txt | 31 ----------
> .../devicetree/bindings/serial/lantiq_asc.yaml | 70 ++++++++++++++++++++++
Use the compatible name: lantiq,asc.yaml
Don't forget the $id value too.
> 2 files changed, 70 insertions(+), 31 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/serial/lantiq_asc.txt
> create mode 100644 Documentation/devicetree/bindings/serial/lantiq_asc.yaml
> diff --git a/Documentation/devicetree/bindings/serial/lantiq_asc.yaml b/Documentation/devicetree/bindings/serial/lantiq_asc.yaml
> new file mode 100644
> index 000000000000..54b90490f4fb
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/serial/lantiq_asc.yaml
> @@ -0,0 +1,70 @@
> +# SPDX-License-Identifier: GPL-2.0-only
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/serial/lantiq_asc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Lantiq SoC ASC serial controller
> +
> +maintainers:
> + - Rahul Tanwar <rahul.tanwar@xxxxxxxxx>
> +
> +allOf:
> + - $ref: /schemas/serial.yaml#
> +
> +properties:
> + compatible:
> + oneOf:
> + items:
> + - const: lantiq,asc
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + minItems: 1
Technically, 1 item is not allowed until patch 2 (or the old doc was wrong).
> + maxItems: 3
> + items:
> + - description: tx or combined interrupt
> + - description: rx interrupt
> + - description: err interrupt
> +
> + clocks:
> + description:
> + When present, first entry listed should contain phandle
> + to the frequency clock and second entry should contain
> + phandle to the gate clock.
Schema needs to define how many entries:
items:
- description: ...
- description: ...
> +
> + clock-names:
> + items:
> + - const: freq
> + - const: asc
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> +
> +
> +examples:
> + - |
> + asc0: serial@16600000 {
> + compatible = "lantiq,asc";
> + reg = <0x16600000 0x100000>;
> + interrupt-parent = <&gic>;
> + interrupts = <GIC_SHARED 103 IRQ_TYPE_LEVEL_HIGH>,
> + <GIC_SHARED 105 IRQ_TYPE_LEVEL_HIGH>,
> + <GIC_SHARED 106 IRQ_TYPE_LEVEL_HIGH>;
> + clocks = <&cgu CLK_SSX4>, <&cgu GCLK_UART>;
> + clock-names = "freq", "asc";
> + };
> +
> + - |
> + asc1: serial@e100c00 {
I don't think this 2nd example adds anything.
> + compatible = "lantiq,asc";
> + reg = <0xE100C00 0x400>;
> + interrupt-parent = <&icu0>;
> + interrupts = <112 113 114>;
> + };
> +
> +...
> --
> 2.11.0
>