[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <465dc390-a5ff-547a-2bd3-54b29e1b6c43@linaro.org>
Date: Thu, 14 Sep 2023 07:54:20 +0200
From: Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
To: Max Filippov <jcmvbkbc@...il.com>, linux-kernel@...r.kernel.org,
linux-serial@...r.kernel.org, devicetree@...r.kernel.org
Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
Jiri Slaby <jirislaby@...nel.org>,
Rob Herring <robh+dt@...nel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@...aro.org>,
Conor Dooley <conor+dt@...nel.org>
Subject: Re: [PATCH 1/4] dt-bindings: serial: document esp32-uart bindings
On 13/09/2023 23:14, Max Filippov wrote:
> Add documentation for the ESP32xx UART controllers.
>
> Signed-off-by: Max Filippov <jcmvbkbc@...il.com>
> ---
> .../bindings/serial/esp,esp32-uart.yaml | 48 +++++++++++++++++++
> 1 file changed, 48 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml
>
> diff --git a/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml
> new file mode 100644
> index 000000000000..8b45ef808107
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/serial/esp,esp32-uart.yaml
> @@ -0,0 +1,48 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/serial/esp,esp32-uart.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ESP32 UART controller
> +
> +maintainers:
> + - Max Filippov <jcmvbkbc@...il.com>
> +
> +description: |
Do not need '|' unless you need to preserve formatting.
> + ESP32 UART controller is a part of ESP32 SoC series.
> +
> +properties:
> + compatible:
> + oneOf:
That's just enum. Your descriptions are useless - tell nothing - so drop
them.
> + - description: UART controller for the ESP32 SoC
> + const: esp,esp32-uart
Looks quite generic, so just to be sure? This is not a family name,
right? Neither family names nor wildcards are allowed.
> + - description: UART controller for the ESP32S3 SoC
> + const: esp,esp32s3-uart
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - clocks
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + serial0: serial@...00000 {
Drop unused label.
> + compatible = "esp,esp32s3-uart";
Use 4 spaces for example indentation.
> + reg = <0x60000000 0x80>;
> + interrupts = <27 1 0>;
Use proper define for IRQ flags.
> + clocks = <&serial_clk>;
> + };
Best regards,
Krzysztof
Powered by blists - more mailing lists