Re: [PATCH v3 1/2] media: rc: meson-irblaster: document device tree bindings
From: Rob Herring
Date: Wed Jul 14 2021 - 19:23:09 EST
On Fri, Jul 09, 2021 at 07:57:52PM +0300, Viktor Prutyanov wrote:
> This patch adds binding documentation for the IR transmitter
> available in Amlogic Meson SoCs.
>
> Signed-off-by: Viktor Prutyanov <viktor.prutyanov@xxxxxxxxxxxx>
> ---
> changes in v2:
> - compatible = "amlogic,meson-g12a-irblaster" added
> - clocks, clock-names and mod-clock updated
> changes in v3:
> - mod-clock removed
> - max-fifo-level added
>
> .../media/amlogic,meson-irblaster.yaml | 65 +++++++++++++++++++
> 1 file changed, 65 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/media/amlogic,meson-irblaster.yaml
>
> diff --git a/Documentation/devicetree/bindings/media/amlogic,meson-irblaster.yaml b/Documentation/devicetree/bindings/media/amlogic,meson-irblaster.yaml
> new file mode 100644
> index 000000000000..1e10aa0d3a94
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/amlogic,meson-irblaster.yaml
> @@ -0,0 +1,65 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/media/amlogic,meson-irblaster.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Amlogic Meson IR blaster
> +
> +maintainers:
> + - Viktor Prutyanov <viktor.prutyanov@xxxxxxxxxxxx>
> +
> +description: |
> + Some Amlogic SoCs such as A311D and T950D4 have IR transmitter
> + (blaster) controller onboard. It is capable of sending IR signals
> + with arbitrary carrier frequency and duty cycle.
> +
> +properties:
> + compatible:
> + oneOf:
> + - const: amlogic,meson-irblaster
> + - items:
> + - const: amlogic,meson-g12a-irblaster
> + - const: amlogic,meson-irblaster
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 2
> +
> + clock-names:
> + items:
> + - const: sysclk
> + - const: xtal
> +
> + max-fifo-level:
> + maxItems: 1
An array?
Needs a vendor prefix, type reference and constraints on allowed values.
> + description:
> + Maximum IR blaster FIFO fill level
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - clocks
> + - clock-names
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> + #include <dt-bindings/clock/g12a-clkc.h>
> +
> + irblaster@ff80014c {
> + compatible = "amlogic,meson-g12a-irblaster", "amlogic,meson-irblaster";
> + reg = <0xff80014c 0x10>;
> + interrupts = <0 198 IRQ_TYPE_EDGE_RISING>;
> + clocks = <&clkc CLKID_CLK81>, <&xtal>;
> + clock-names = "sysclk", "xtal";
> + };
> --
> 2.21.0
>
>