Re: [PATCH 1/1] dt-binding: board: convert fsl-board.txt to yaml

[Krzysztof Kozlowski <krzk@kernel.org>]

On 12/08/2024 22:01, Frank Li wrote:
> Convert binding doc fsl-board.txt to yaml format. split to 3 part
> fsl,bcsr.yaml, fsl,fpga-qixis.yaml, fsl,fpga-qixis-i2c.yaml
> 
> Additional change for fsl,fpga-qixis.yaml
> - Add childnode mdio-mux-emi*
> - Add compatible string fsl,ls1043aqds-fpga, fsl,ls1043ardb-fpga,
> fsl,ls1046aqds-fpga, fsl,ls1046ardb-fpga, fsl,ls208xaqds-fpga,
> fsl,ls1043ardb-cpld, fsl,ls1046ardb-cpld, fsl,ls1088aqds-fpga,
> fsl,ls1088ardb-fpga, fsl,ls2080aqds-fpga, fsl,ls2080ardb-fpga.
> - Change address to 32bit in example.
> 
> Additional change for fsl,fpga-qixis-i2c.yaml
> - Add mux-controller
> - Add compatible string fsl,ls1028aqds-fpga, fsl,lx2160aqds-fpga
> 
> Fix below warning:
> 
> arch/arm64/boot/dts/freescale/fsl-ls1028a-qds.dtb: /soc/i2c@2000000/fpga@66: failed to match any schema with compatible: ['fsl,ls1028aqds-fpga', 'fsl,fpga-qixis-i2c', 'simple-mfd']
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>

Please use subject prefixes matching the subsystem. You can get them for
example with `git log --oneline -- DIRECTORY_OR_FILE` on the directory
your patch is touching. For bindings, the preferred subjects are
explained here:
https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters

It is not "dt-binding" but dt-bindings.

> ---
>  .../devicetree/bindings/board/fsl,bcsr.yaml   | 38 +++++++++
>  .../bindings/board/fsl,fpga-qixis-i2c.yaml    | 50 ++++++++++++
>  .../bindings/board/fsl,fpga-qixis.yaml        | 81 +++++++++++++++++++
>  .../devicetree/bindings/board/fsl-board.txt   | 81 -------------------
>  4 files changed, 169 insertions(+), 81 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/board/fsl,bcsr.yaml
>  create mode 100644 Documentation/devicetree/bindings/board/fsl,fpga-qixis-i2c.yaml
>  create mode 100644 Documentation/devicetree/bindings/board/fsl,fpga-qixis.yaml
>  delete mode 100644 Documentation/devicetree/bindings/board/fsl-board.txt
> 
> diff --git a/Documentation/devicetree/bindings/board/fsl,bcsr.yaml b/Documentation/devicetree/bindings/board/fsl,bcsr.yaml
> new file mode 100644
> index 0000000000000..73e33483d20c9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/board/fsl,bcsr.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/board/fsl,bcsr.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Board Control and Status
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>
> +
> +description:
> +  Freescale Reference Board Bindings.

Drop

> +
> +  This document describes device tree bindings for various devices that
> +  exist on some Freescale reference boards.

Drop

> +
> +properties:
> +  compatible:
> +    enum:
> +      - fsl,mpc8360mds-bcsr
> +
> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    board@f8000000 {
> +        compatible = "fsl,mpc8360mds-bcsr";
> +        reg = <0xf8000000 0x8000>;
> +    };
> +
> diff --git a/Documentation/devicetree/bindings/board/fsl,fpga-qixis-i2c.yaml b/Documentation/devicetree/bindings/board/fsl,fpga-qixis-i2c.yaml
> new file mode 100644
> index 0000000000000..cab221a1fd466
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/board/fsl,fpga-qixis-i2c.yaml
> @@ -0,0 +1,50 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/board/fsl,fpga-qixis-i2c.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale on-board FPGA connected on I2C bus
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +          - enum:
> +              - fsl,bsc9132qds-fpga
> +              - fsl,ls1028aqds-fpga
> +              - fsl,lx2160aqds-fpga
> +          - const: fsl,fpga-qixis-i2c
> +          - const: simple-mfd
> +        minItems: 2

Why flexible? All are fixed - three compatibles.

> +
> +  interrupts:
> +    maxItems: 1
> +
> +  reg:
> +    maxItems: 1
> +
> +  mux-controller:
> +    $ref: /schemas/mux/reg-mux.yaml
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        board-control@66 {
> +            compatible = "fsl,bsc9132qds-fpga", "fsl,fpga-qixis-i2c";
> +            reg = <0x66>;

Make it complete.

> +        };
> +    };
> +
> diff --git a/Documentation/devicetree/bindings/board/fsl,fpga-qixis.yaml b/Documentation/devicetree/bindings/board/fsl,fpga-qixis.yaml
> new file mode 100644
> index 0000000000000..455620daa1fee
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/board/fsl,fpga-qixis.yaml
> @@ -0,0 +1,81 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/board/fsl,fpga-qixis.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale on-board FPGA/CPLD
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +          - const: fsl,p1022ds-fpga
> +          - const: fsl,fpga-ngpixis
> +      - items:
> +          - enum:
> +              - fsl,ls1088aqds-fpga
> +              - fsl,ls1088ardb-fpga
> +              - fsl,ls2080aqds-fpga
> +              - fsl,ls2080ardb-fpga
> +          - const: fsl,fpga-qixis
> +      - items:
> +          - enum:
> +              - fsl,ls1043aqds-fpga
> +              - fsl,ls1043ardb-fpga
> +              - fsl,ls1046aqds-fpga
> +              - fsl,ls1046ardb-fpga
> +              - fsl,ls208xaqds-fpga
> +          - const: fsl,fpga-qixis
> +          - const: simple-mfd
> +      - enum:
> +          - fsl,ls1043ardb-cpld
> +          - fsl,ls1046ardb-cpld
> +          - fsl,t1040rdb-cpld
> +          - fsl,t1042rdb-cpld
> +          - fsl,t1042rdb_pi-cpld
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  reg:
> +    maxItems: 1
> +
> +  "#address-cells":
> +    const: 1
> +
> +  "#size-cells":
> +    const: 1
> +
> +  ranges:
> +    maxItems: 1
> +
> +patternProperties:
> +  '^mdio-mux-emi[0-9]@[a-f0-9]+$':

Either suffix or unit address, not both. This does not match some of
your DTS, at least after quick look. Probably DTS needs to be fixed.


> +    $ref: /schemas/net/mdio-mux-mmioreg.yaml
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false

Best regards,
Krzysztof