Re: [PATCH v1 09/14] dt-bindings: nvmem: add YAML schema for the sl28 vpd layout

[Krzysztof Kozlowski]

On 26/08/2022 00:44, Michael Walle wrote:
> Add a schema for the NVMEM layout on Kontron's sl28 boards.
> 
> Signed-off-by: Michael Walle <michael@xxxxxxxx>
> ---
>  .../nvmem/layouts/kontron,sl28-vpd.yaml       | 52 +++++++++++++++++++
>  1 file changed, 52 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/nvmem/layouts/kontron,sl28-vpd.yaml
> 
> diff --git a/Documentation/devicetree/bindings/nvmem/layouts/kontron,sl28-vpd.yaml b/Documentation/devicetree/bindings/nvmem/layouts/kontron,sl28-vpd.yaml
> new file mode 100644
> index 000000000000..e4bc2d9182db
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/nvmem/layouts/kontron,sl28-vpd.yaml
> @@ -0,0 +1,52 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/nvmem/layouts/kontron,sl28-vpd.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: NVMEM layout of the Kontron SMARC-sAL28 vital product data
> +
> +maintainers:
> +  - Michael Walle <michael@xxxxxxxx>
> +
> +description:
> +  The vital product data (VPD) of the sl28 boards contains a serial
> +  number and a base MAC address. The actual MAC addresses for the
> +  on-board ethernet devices are derived from this base MAC address by
> +  adding an offset.
> +
> +properties:
> +  compatible:
> +    items:
> +      - const: kontron,sl28-vpd
> +      - const: user-otp
> +
> +  serial-number:
> +    type: object

You should define the contents of this object. I would expect this to be
uint32 or string. I think you also need description, as this is not
really standard field.

> +
> +  base-mac-address:

Fields should be rather described here, not in top-level description.

> +    type: object

On this level:
    additionalProperties: false

> +
> +    properties:
> +      "#nvmem-cell-cells":
> +        const: 1
> +

I also wonder why you do not have unit addresses. What if you want to
have two base MAC addresses?

> +required:
> +  - compatible

Other fields are I guess required? At least serial-number should be always?

> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +      otp-1 {

Messed up indentation (use 4 spaces). Generic node name "otp".

> +          compatible = "kontron,sl28-vpd", "user-otp";
> +
> +          serial_number: serial-number {

What's the point of the empty node?

> +          };
> +
> +          base_mac_address: base-mac-address {
> +              #nvmem-cell-cells = <1>;
> +          };
> +      };
> +
> +...


Best regards,
Krzysztof