Commit ecbfc6ff authored by Frank Li's avatar Frank Li Committed by Rob Herring (Arm)
Browse files

dt-bindings: soc: fsl: cpm_qe: convert to yaml format 



Convert binding doc qe.txt to yaml format. Split it to
fsl,qe-firmware.yaml, fsl,qe-ic.yaml, fsl,qe-muram.yaml, fsl,qe-si.yaml
fsl,qe-siram.yaml, fsl,qe.yaml.

Additional Changes:
- Fix error in example.
- Change to low case for hex value.
- Remove fsl,qe-num-riscs and fsl,qe-snums from required list.
- Add #address-cell and #size-cell.
- Add interrupts description for qe-ic.
- Add compatible string fsl,ls1043-qe-si for fsl,qe-si.yaml
- Add compatible string fsl,ls1043-qe-siram for fsl,qe-siram.yaml
- Add child node for fsl,qe.yaml

Fix below warning:
arch/arm64/boot/dts/freescale/fsl-ls1043a-rdb.dtb: /soc/uqe@2400000/muram@10000: failed to match any schema with compatible: ['fsl,qe-muram', 'fsl,cpm-muram']
arch/arm64/boot/dts/freescale/fsl-ls1043a-rdb.dtb: /soc/uqe@2400000/muram@10000: failed to match any schema with compatible: ['fsl,qe-muram', 'fsl,cpm-muram']
arch/arm64/boot/dts/freescale/fsl-ls1043a-rdb.dtb: /soc/uqe@2400000/muram@10000/data-only@0: failed to match any schema with compatible: ['fsl,qe-muram-data', 'fsl,cpm-muram-data']
arch/arm64/boot/dts/freescale/fsl-ls1043a-qds.dtb: /soc/uqe@2400000: failed to match any schema with compatible: ['fsl,qe', 'simple-bus']
arch/arm64/boot/dts/freescale/fsl-ls1043a-rdb.dtb: /soc/uqe@2400000/muram@10000/data-only@0: failed to match any schema with compatible: ['fsl,qe-muram-data', 'fsl,cpm-muram-data']
arch/arm64/boot/dts/freescale/fsl-ls1043a-qds.dtb: /soc/uqe@2400000/qeic@80: failed to match any schema with compatible: ['fsl,qe-ic']

Signed-off-by: default avatarFrank Li <Frank.Li@nxp.com>
Link: https://lore.kernel.org/r/20240703-ls_qe_warning-v1-1-7fe4af5b0bb0@nxp.com


Signed-off-by: default avatarRob Herring (Arm) <robh@kernel.org>
parent 1a73912f

Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,qe-firmware.yaml

0 → 100644
+48 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/soc/fsl/cpm_qe/fsl,qe-firmware.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Freescale QUICC Engine module Firmware Node



maintainers:

  - Frank Li <Frank.Li@nxp.com>



description: |

  This node defines a firmware binary that is embedded in the device tree, for

  the purpose of passing the firmware from bootloader to the kernel, or from

  the hypervisor to the guest.



  The firmware node itself contains the firmware binary contents, a compatible

  property, and any firmware-specific properties.  The node should be placed

  inside a QE node that needs it.  Doing so eliminates the need for a

  fsl,firmware-phandle property.  Other QE nodes that need the same firmware

  should define an fsl,firmware-phandle property that points to the firmware node

  in the first QE node.



  The fsl,firmware property can be specified in the DTS (possibly using incbin)

  or can be inserted by the boot loader at boot time.



properties:

  compatible:

    enum:

      - fsl,qe-firmware



  fsl,firmware:

    $ref: /schemas/types.yaml#/definitions/uint8-array

    description:

      A standard property.  This property contains the firmware binary "blob".



required:

  - compatible

  - fsl,firmware



additionalProperties: false



examples:

  - |

    qe-firmware {

        compatible = "fsl,qe-firmware";

        fsl,firmware = <0x70 0xcd 0x00 0x00 0x01 0x46 0x45>;

    };

Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,qe-ic.yaml

0 → 100644
+47 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/soc/fsl/cpm_qe/fsl,qe-ic.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Freescale QUICC Engine module Interrupt Controller (IC)



maintainers:

  - Frank Li <Frank.Li@nxp.com>



properties:

  compatible:

    const: fsl,qe-ic



  reg:

    maxItems: 1



  interrupts:

    items:

      - description: QE interrupt

      - description: QE critical

      - description: QE error

    minItems: 1



  interrupt-controller: true



  "#interrupt-cells":

    const: 1



required:

  - compatible

  - reg

  - interrupt-controller

  - "#interrupt-cells"



additionalProperties: false



examples:

  - |

    interrupt-controller@80 {

        compatible = "fsl,qe-ic";

        reg = <0x80 0x80>;

        #interrupt-cells = <1>;

        interrupt-controller;

        interrupts = <95 2 0 0  94 2 0 0>;

    };

Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,qe-muram.yaml

0 → 100644
+71 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/soc/fsl/cpm_qe/fsl,qe-muram.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Freescale QUICC Engine Multi-User RAM (MURAM)



maintainers:

  - Frank Li <Frank.Li@nxp.com>



description: Multi-User RAM (MURAM)



properties:

  compatible:

    items:

      - const: fsl,qe-muram

      - const: fsl,cpm-muram



  ranges:

    maxItems: 1



  "#address-cells":

    const: 1



  "#size-cells":

    const: 1



  mode:

    $ref: /schemas/types.yaml#/definitions/string

    enum: [host, slave]





patternProperties:

  '^data\-only@[a-f0-9]+$':

    type: object

    properties:

      compatible:

        items:

          - const: fsl,qe-muram-data

          - const: fsl,cpm-muram-data



      reg:

        maxItems: 1



    required:

      - compatible

      - reg



    additionalProperties: false



required:

  - compatible

  - ranges



additionalProperties: false



examples:

  - |

    muram@10000 {

        compatible = "fsl,qe-muram", "fsl,cpm-muram";

        ranges = <0 0x00010000 0x0000c000>;

        #address-cells = <1>;

        #size-cells = <1>;



        data-only@0{

            compatible = "fsl,qe-muram-data",

                         "fsl,cpm-muram-data";

            reg = <0 0xc000>;

        };

     };

Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,qe-si.yaml

0 → 100644
+40 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/soc/fsl/cpm_qe/fsl,qe-si.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Freescale QUICC Engine module Serial Interface Block (SI)



maintainers:

  - Frank Li <Frank.Li@nxp.com>



description:

  The SI manages the routing of eight TDM lines to the QE block serial drivers,

  the MCC and the UCCs, for receive and transmit.



properties:

  compatible:

    oneOf:

      - items:

          - enum:

              - fsl,ls1043-qe-si

          - const: fsl,t1040-qe-si

      - enum:

          - fsl,t1040-qe-si



  reg:

    maxItems: 1



required:

  - compatible

  - reg



additionalProperties: false



examples:

  - |

    si@700 {

        compatible = "fsl,t1040-qe-si";

        reg = <0x700 0x80>;

    };

Documentation/devicetree/bindings/soc/fsl/cpm_qe/fsl,qe-siram.yaml

0 → 100644
+39 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/soc/fsl/cpm_qe/fsl,qe-siram.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Freescale QUICC Engine module Serial Interface Block RAM(SIRAM)



maintainers:

  - Frank Li <Frank.Li@nxp.com>



description:

  store the routing entries of SI



properties:

  compatible:

    oneOf:

      - items:

          - enum:

              - fsl,ls1043-qe-siram

          - const: fsl,t1040-qe-siram

      - const: fsl,t1040-qe-siram



  reg:

    maxItems: 1



required:

  - compatible

  - reg



additionalProperties: false



examples:

  - |

    siram@1000 {

        compatible = "fsl,t1040-qe-siram";

        reg = <0x1000 0x800>;

    };