Re: [PATCH 10/10] dt-bindings: timer: convert bcm2835-system-timer bindings to YAML

[Rob Herring <robh@kernel.org>]

On Sun, Jun 04, 2023 at 02:12:23PM +0200, Stefan Wahren wrote:
> Convert the DT binding document for bcm2835-system-timer from .txt
> to YAML.
> 
> Signed-off-by: Stefan Wahren <stefan.wahren@i2se.com>
> ---
>  .../timer/brcm,bcm2835-system-timer.txt       | 22 ----------
>  .../timer/brcm,bcm2835-system-timer.yaml      | 44 +++++++++++++++++++
>  2 files changed, 44 insertions(+), 22 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/timer/brcm,bcm2835-system-timer.txt
>  create mode 100644 Documentation/devicetree/bindings/timer/brcm,bcm2835-system-timer.yaml
> 
> diff --git a/Documentation/devicetree/bindings/timer/brcm,bcm2835-system-timer.txt b/Documentation/devicetree/bindings/timer/brcm,bcm2835-system-timer.txt
> deleted file mode 100644
> index 844bd5fbd04c..000000000000
> --- a/Documentation/devicetree/bindings/timer/brcm,bcm2835-system-timer.txt
> +++ /dev/null
> @@ -1,22 +0,0 @@
> -BCM2835 System Timer
> -
> -The System Timer peripheral provides four 32-bit timer channels and a
> -single 64-bit free running counter. Each channel has an output compare
> -register, which is compared against the 32 least significant bits of the
> -free running counter values, and generates an interrupt.
> -
> -Required properties:
> -
> -- compatible : should be "brcm,bcm2835-system-timer"
> -- reg : Specifies base physical address and size of the registers.
> -- interrupts : A list of 4 interrupt sinks; one per timer channel.
> -- clock-frequency : The frequency of the clock that drives the counter, in Hz.
> -
> -Example:
> -
> -timer {
> -	compatible = "brcm,bcm2835-system-timer";
> -	reg = <0x7e003000 0x1000>;
> -	interrupts = <1 0>, <1 1>, <1 2>, <1 3>;
> -	clock-frequency = <1000000>;
> -};
> diff --git a/Documentation/devicetree/bindings/timer/brcm,bcm2835-system-timer.yaml b/Documentation/devicetree/bindings/timer/brcm,bcm2835-system-timer.yaml
> new file mode 100644
> index 000000000000..555fca4897e7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/timer/brcm,bcm2835-system-timer.yaml
> @@ -0,0 +1,44 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/timer/brcm,bcm2835-system-timer.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: BCM2835 System Timer
> +
> +maintainers:
> +  - Stefan Wahren <stefan.wahren@i2se.com>
> +
> +description:
> +  The System Timer peripheral provides four 32-bit timer channels and a
> +  single 64-bit free running counter. Each channel has an output compare
> +  register, which is compared against the 32 least significant bits of the
> +  free running counter values, and generates an interrupt.
> +
> +properties:
> +  compatible:
> +    const: brcm,bcm2835-system-timer
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 4

Should list what each entry is.

> +
> +  clock-frequency: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    timer@7e003000 {
> +      compatible = "brcm,bcm2835-system-timer";
> +      reg = <0x7e003000 0x1000>;
> +      interrupts = <1 0>, <1 1>, <1 2>, <1 3>;
> +      clock-frequency = <1000000>;
> +    };
> -- 
> 2.34.1
>