Re: [PATCH 3/3] dt-bindings: remoteproc: Add Arm remoteproc

Krzysztof Kozlowski
2024-03-01T19:31:00Z

On 01/03/2024 17:42, abdellatif.elkhlifi@arm.com wrote:
> From: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com>
>
> introduce the bindings for Arm remoteproc support.
>
> Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com>
> ---
> .../bindings/remoteproc/arm,rproc.yaml | 69 +++++++++++++++++++
> MAINTAINERS | 1 +

Fix order of patches - bindings are always before the user (see
submitting bindings doc).

> 2 files changed, 70 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/remoteproc/arm,rproc.yaml
>
> diff --git a/Documentation/devicetree/bindings/remoteproc/arm,rproc.yaml b/Documentation/devicetree/bindings/remoteproc/arm,rproc.yaml
> new file mode 100644
> index 000000000000..322197158059
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/remoteproc/arm,rproc.yaml
> @@ -0,0 +1,69 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/remoteproc/arm,rproc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Arm Remoteproc Devices

That's quite generic... does it applied to all ARM designs?

> +
> +maintainers:
> + - Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com>
> +
> +description: |
> + Some Arm heterogeneous System-On-Chips feature remote processors that can
> + be controlled with a reset control register and a reset status register to
> + start or stop the processor.
> +
> + This document defines the bindings for these remote processors.

Drop last sentence.

> +
> +properties:
> + compatible:
> + enum:
> + - arm,corstone1000-extsys
> +
> + reg:
> + minItems: 2
> + maxItems: 2
> + description: |
> + Address and size in bytes of the reset control register
> + and the reset status register.
> + Expects the registers to be in the order as above.
> + Should contain an entry for each value in 'reg-names'.

Entirely redundant sentences... instead this all just list items with
description.

> +
> + reg-names:Do not need '|' unless you need to preserve formatting.
> + description: |
> + Required names for each of the reset registers defined in
> + the 'reg' property. Expects the names from the following
> + list, in the specified order, each representing the corresponding
> + reset register.

Really, drop.

> + items:
> + - const: reset-control
> + - const: reset-status
> +
> + firmware-name:
> + description: |

Do not need '|' unless you need to preserve formatting.

> + Default name of the firmware to load to the remote processor.
> +
> +required:
> + - compatible
> + - reg
> + - reg-names
> + - firmware-name
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + extsys0: remoteproc@1a010310 {

Drop label, not used.

> + compatible = "arm,corstone1000-extsys";

Use 4 spaces for example indentation.

> + reg = <0x1a010310 0x4>, <0x1a010314 0x4>;
> + reg-names = "reset-control", "reset-status";
> + firmware-name = "es0_flashfw.elf";
> + };
> +
> + extsys1: remoteproc@1a010318 {
> + compatible = "arm,corstone1000-extsys";

These are the same examples, so keep only one.

> + reg = <0x1a010318 0x4>, <0x1a01031c 0x4>;
> + reg-names = "reset-control", "reset-status";
> + firmware-name = "es1_flashfw.elf";
> + };

Best regards,
Krzysztof