RE: [PATCH v7 1/4] dt-bindings: soc: imx8m: add DT Binding doc for soc unique ID

[Alice Guo (OSS)]

> -----Original Message-----
> From: Krzysztof Kozlowski <krzk@xxxxxxxxxx>
> Sent: 2020年12月15日 17:11
> To: Alice Guo (OSS) <alice.guo@xxxxxxxxxxx>
> Cc: robh+dt@xxxxxxxxxx; shawnguo@xxxxxxxxxx; s.hauer@xxxxxxxxxxxxxx;
> kernel@xxxxxxxxxxxxxx; festevam@xxxxxxxxx; devicetree@xxxxxxxxxxxxxxx;
> linux-arm-kernel@xxxxxxxxxxxxxxxxxxx; linux-kernel@xxxxxxxxxxxxxxx; dl-linux-imx
> <linux-imx@xxxxxxx>
> Subject: Re: [PATCH v7 1/4] dt-bindings: soc: imx8m: add DT Binding doc for soc
> unique ID
> 
> On Tue, Dec 15, 2020 at 04:35:48PM +0800, Alice Guo (OSS) wrote:
> > From: Alice Guo <alice.guo@xxxxxxx>
> >
> > Add DT Binding doc for the Unique ID of i.MX 8M series.
> >
> > Signed-off-by: Alice Guo <alice.guo@xxxxxxx>
> > ---
> >
> > Changes for v7:
> >  - change to a separate schema file
> > Changes for v6:
> >  - none
> > Changes for v5:
> >  - correct the error of using allOf
> > Changes for v4:
> >  - use allOf to limit new version DTS files for i.MX8M to include
> >    "fsl,imx8m*-soc", nvmem-cells and nvmem-cells-names Changes for v3:
> >  - put it into Documentation/devicetree/bindings/arm/fsl.yaml
> >  - modify the description of nvmem-cells
> >  - use "make ARCH=arm64 dtbs_check" to make sure it is right Changes
> > for v2:
> >  - remove the subject prefix "LF-2571-1"
> >
> >  .../bindings/soc/imx/imx8m-soc.yaml           | 54
> +++++++++++++++++++
> >  1 file changed, 54 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/soc/imx/imx8m-soc.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/soc/imx/imx8m-soc.yaml
> > b/Documentation/devicetree/bindings/soc/imx/imx8m-soc.yaml
> > new file mode 100644
> > index 000000000000..a2f7dc0c9b35
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/soc/imx/imx8m-soc.yaml
> > @@ -0,0 +1,54 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/soc/imx/imx8m-soc.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: NXP i.MX8M Series SoC
> > +
> > +maintainers:
> > +  - Alice Guo <alice.guo@xxxxxxx>
> > +
> > +description: |
> > +  NXP i.MX8M series SoCs contain fuse entries from which SoC Unique
> > +ID can be
> > +  obtained.
> > +
> > +select:
> 
> Mhm, there are other compatibles here so indeed, select is needed.
> 
> > +  properties:
> > +    compatible:
> > +      contains:
> > +        enum:
> > +          - fsl,imx8mm
> > +          - fsl,imx8mn
> > +          - fsl,imx8mp
> > +          - fsl,imx8mq
> > +  required:
> > +    - compatible
> 
> This does not work - does not match anything. It seems you missed proper
> "required" for the matched node.
> 
> Provide also an example.
> 
> Best regards,
> Krzysztof
> 

Hi, Krzysztof
Thank you for your advice. My opinion is different from yours.

I did the fowllowing test:
--- a/Documentation/devicetree/bindings/soc/imx/imx8m-soc.yaml
+++ b/Documentation/devicetree/bindings/soc/imx/imx8m-soc.yaml
@@ -22,6 +22,7 @@ select:
           - fsl,imx8mn
           - fsl,imx8mp
           - fsl,imx8mq
+          - fsl,lx2160a
   required:
     - compatible

➜  linux-next git:(master) ✗ make ARCH=arm64 dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/soc/imx/imx8m-soc.yaml
...
/home/nxf55104/virtualization/upstream/linux-next/arch/arm64/boot/dts/freescale/fsl-lx2160a-clearfog-cx.dt.yaml: /: soc:compatible:0: 'simple-bus' is not one of ['fsl,imx8mm-soc', 'fsl,imx8mn-soc', 'fsl,imx8mp-soc', 'fsl,imx8mq-soc']
        From schema: /home/nxf55104/virtualization/upstream/linux-next/Documentation/devicetree/bindings/soc/imx/imx8m-soc.yaml
...

So, I think it works and can match stuff. I do not understand what proper " required" I missed. Please give me some tips. Thank you.

Best regards,
Alice

> 
> > +
> > +properties:
> > +  soc:
> > +    type: object
> > +    properties:
> > +      compatible:
> > +        items:
> > +          - enum:
> > +              - fsl,imx8mm-soc
> > +              - fsl,imx8mn-soc
> > +              - fsl,imx8mp-soc
> > +              - fsl,imx8mq-soc
> > +          - const: simple-bus
> > +
> > +      nvmem-cells:
> > +        maxItems: 1
> > +        description: Phandle to the SOC Unique ID provided by a nvmem
> > + node
> > +
> > +      nvmem-cells-names:
> > +        const: soc_unique_id
> > +
> > +    required:
> > +      - compatible
> > +      - nvmem-cells
> > +      - nvmem-cell-names
> > +
> > +additionalProperties: true
> > +...
> > --
> > 2.17.1
> >