diff mbox series

[v3,3/8] dt-bindings: marvell: a38x: add solidrun armada 388 clearfog boards

Message ID 20231226-support-clearfog-gtr-l8-sfp-v3-3-fd1ac2d6bf2e@solid-run.com
State New
Headers
Series dt-bindings: marvell: a38x: add solidrun armada 388 clearfog boards |

Commit Message

Josua Mayer Dec. 26, 2023, 6:11 p.m. UTC 
  Add DT compatible for SolidRun Armada-388 based Clearfog Base and Pro
boards, which are already in place in-tree.

There are already 3 distinct dts in tree for these *two* boards,
declaring particular compatible strings:
- armada-388-clearfog.dts:
  compatible = "solidrun,clearfog-a1", "marvell,armada388",
               "marvell,armada385, "marvell,armada380";
- armada-388-clearfog-base.dts:
  compatible = "solidrun,clearfog-base-a1", "solidrun,clearfog-a1",
               "marvell,armada388", "marvell,armada385,
               "marvell,armada380";
- armada-388-clearfog-pro.dts:
  compatible = "solidrun,clearfog-base-a1", "solidrun,clearfog-a1",
               "marvell,armada388", "marvell,armada385,
               "marvell,armada380";

This has historic reasons, the first entry is a legacy name for the
"pro" version, old versions of u-boot built when only one variant
existed explicitly boot by this name.

Note that both compatibles and model field include the string "A1".
At least up to revision 2.0 of the board, this had been printed
on the pcb. However in marketing material and conversations it is
usually omitted. "Clearfog Pro" and "Clearfog Pro A1" always mean
exactly the same product.

Technically Base and Pro variants are similar enough that they can
successfully boot with each other's dts. Hence it makes (some)
sense for them to share the "clearfog-a1" compatible.

Add bindings for the explicit variants including base / pro suffix.
The legacy "armada-388-clearfog.dts" is not supported by these
bindings" as it does not make sense having two bindings for one board.

Signed-off-by: Josua Mayer <josua@solid-run.com>
---
 .../devicetree/bindings/arm/marvell/armada-38x.yaml          | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Rob Herring Dec. 26, 2023, 7:40 p.m. UTC | #1 
On Tue, 26 Dec 2023 19:11:34 +0100, Josua Mayer wrote:
> Add DT compatible for SolidRun Armada-388 based Clearfog Base and Pro
> boards, which are already in place in-tree.
> 
> There are already 3 distinct dts in tree for these *two* boards,
> declaring particular compatible strings:
> - armada-388-clearfog.dts:
>   compatible = "solidrun,clearfog-a1", "marvell,armada388",
>                "marvell,armada385, "marvell,armada380";
> - armada-388-clearfog-base.dts:
>   compatible = "solidrun,clearfog-base-a1", "solidrun,clearfog-a1",
>                "marvell,armada388", "marvell,armada385,
>                "marvell,armada380";
> - armada-388-clearfog-pro.dts:
>   compatible = "solidrun,clearfog-base-a1", "solidrun,clearfog-a1",
>                "marvell,armada388", "marvell,armada385,
>                "marvell,armada380";
> 
> This has historic reasons, the first entry is a legacy name for the
> "pro" version, old versions of u-boot built when only one variant
> existed explicitly boot by this name.
> 
> Note that both compatibles and model field include the string "A1".
> At least up to revision 2.0 of the board, this had been printed
> on the pcb. However in marketing material and conversations it is
> usually omitted. "Clearfog Pro" and "Clearfog Pro A1" always mean
> exactly the same product.
> 
> Technically Base and Pro variants are similar enough that they can
> successfully boot with each other's dts. Hence it makes (some)
> sense for them to share the "clearfog-a1" compatible.
> 
> Add bindings for the explicit variants including base / pro suffix.
> The legacy "armada-388-clearfog.dts" is not supported by these
> bindings" as it does not make sense having two bindings for one board.
> 
> Signed-off-by: Josua Mayer <josua@solid-run.com>
> ---
>  .../devicetree/bindings/arm/marvell/armada-38x.yaml          | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:
./Documentation/devicetree/bindings/arm/marvell/armada-38x.yaml:46:14: [warning] wrong indentation: expected 14 but found 13 (indentation)

dtschema/dtc warnings/errors:

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20231226-support-clearfog-gtr-l8-sfp-v3-3-fd1ac2d6bf2e@solid-run.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/arm/marvell/armada-38x.yaml b/Documentation/devicetree/bindings/arm/marvell/armada-38x.yaml
index 5bc69c4fe34d..f77976138bb3 100644
--- a/Documentation/devicetree/bindings/arm/marvell/armada-38x.yaml
+++ b/Documentation/devicetree/bindings/arm/marvell/armada-38x.yaml
@@ -38,4 +38,16 @@  properties:
           - const: marvell,armada385
           - const: marvell,armada380
 
+      - description:
+          SolidRun Armada 388 based single-board computers
+
+        items:
+          - enum:
+             - solidrun,clearfog-base-a1
+             - solidrun,clearfog-pro-a1
+          - const: solidrun,clearfog-a1
+          - const: marvell,armada388
+          - const: marvell,armada385
+          - const: marvell,armada380
+
 additionalProperties: true