On Thu, Nov 05, 2020 at 04:11:14PM +0200, Laurentiu Tudor wrote: > From: Ionut-robert Aron <ionut-robert.aron@xxxxxxx> > > Convert fsl,qoriq-mc to YAML in order to automate the verification > process of dts files. In addition, update MAINTAINERS accordingly > and, while at it, add some missing files. > > Signed-off-by: Ionut-robert Aron <ionut-robert.aron@xxxxxxx> > [laurentiu.tudor@xxxxxxx: update MINTAINERS, updates & fixes in schema] > Signed-off-by: Laurentiu Tudor <laurentiu.tudor@xxxxxxx> > --- > .../devicetree/bindings/misc/fsl,qoriq-mc.txt | 196 ---------------- > .../bindings/misc/fsl,qoriq-mc.yaml | 218 ++++++++++++++++++ > .../ethernet/freescale/dpaa2/overview.rst | 5 +- > MAINTAINERS | 4 +- > 4 files changed, 225 insertions(+), 198 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > create mode 100644 Documentation/devicetree/bindings/misc/fsl,qoriq-mc.yaml [...] > diff --git a/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.yaml b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.yaml > new file mode 100644 > index 000000000000..9e89fd8eb635 > --- /dev/null > +++ b/Documentation/devicetree/bindings/misc/fsl,qoriq-mc.yaml > @@ -0,0 +1,218 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +# Copyright 2020 NXP > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/misc/fsl,qoriq-mc.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +maintainers: > + - Laurentiu Tudor <laurentiu.tudor@xxxxxxx> > + > +title: Freescale Management Complex > + > +description: | > + The Freescale Management Complex (fsl-mc) is a hardware resource > + manager that manages specialized hardware objects used in > + network-oriented packet processing applications. After the fsl-mc > + block is enabled, pools of hardware resources are available, such as > + queues, buffer pools, I/O interfaces. These resources are building > + blocks that can be used to create functional hardware objects/devices > + such as network interfaces, crypto accelerator instances, L2 switches, > + etc. > + > + For an overview of the DPAA2 architecture and fsl-mc bus see: > + Documentation/networking/device_drivers/freescale/dpaa2/overview.rst > + > + As described in the above overview, all DPAA2 objects in a DPRC share the > + same hardware "isolation context" and a 10-bit value called an ICID > + (isolation context id) is expressed by the hardware to identify > + the requester. > + > + The generic 'iommus' property is insufficient to describe the relationship > + between ICIDs and IOMMUs, so an iommu-map property is used to define > + the set of possible ICIDs under a root DPRC and how they map to > + an IOMMU. > + > + For generic IOMMU bindings, see: > + Documentation/devicetree/bindings/iommu/iommu.txt. > + > + For arm-smmu binding, see: > + Documentation/devicetree/bindings/iommu/arm,smmu.yaml. > + > + MC firmware binary images can be found here: > + https://github.com/NXP/qoriq-mc-binary > + > +properties: > + compatible: > + const: "fsl,qoriq-mc" Don't need quotes. > + description: "Must be 'fsl,qoriq-mc'. A Freescale Management Complex Drop ^^^^^^^^^^^^^^^^^^^^^^^^ The schema says that. > + compatible with this binding must have Block Revision > + Registers BRR1 and BRR2 at offset 0x0BF8 and 0x0BFC in > + the MC control register region." > + > + reg: > + description: "A standard property. Specifies one or two regions defining Don't need quotes. You need '|' for a literal block to keep formatting. But all this should be expressed as schema... > + the MC's registers: > + > + - the first region is the command portal for the this machine > + and must always be present > + > + - the second region is the MC control registers. This region > + may not be present in some scenarios, such as in the device > + tree presented to a virtual machine." reg: minItems: 1 items: - description: the command portal for the this machine - description: MC control registers. This region may not be present in some scenarios, such as in the device tree presented to a virtual machine. > + > + ranges: > + description: "A standard property. Defines the mapping between the child > + MC address space and the parent system address space. > + > + The MC address space is defined by 3 components: > + <region type> <offset hi> <offset lo> > + > + Valid values for region type are: > + 0x0 - MC portals > + 0x1 - QBMAN portals" > + > + '#address-cells': > + const: 3 > + > + '#size-cells': > + const: 1 > + > + dpmacs: > + type: object > + description: "The fsl-mc node may optionally have dpmac sub-nodes that > + describe the relationship between the Ethernet MACs which belong > + to the MC and the Ethernet PHYs on the system board. > + > + The dpmac nodes must be under a node named 'dpmacs' which > + contains the following properties: > + > + - '#address-cells' > + const: 1 > + description: Must be present if dpmac sub-nodes are defined > + and must have a value of 1. > + > + - '#size-cells' > + const: 0 > + description: Must be present if dpmac sub-nodes are defined > + and must have a value of 0." Drop whatever description can be expressed in schemas. > + > + properties: > + '#address-cells': > + const: 1 > + > + '#size-cells': > + const: 0 > + > + patternProperties: > + "^dpmac@[0-9a-f]+$": > + type: object > + > + description: "dpmac sub-node that describes the relationship between the > + Ethernet MACs which belong to the MC and the Ethernet PHYs > + on the system board." > + > + properties: > + compatible: > + const: "fsl,qoriq-mc-dpmac" > + > + reg: > + description: Specifies the id of the dpmac Constraints on the value? > + > + phy-handle: > + $ref: /schemas/types.yaml#definitions/phandle > + description: "Specifies the phandle to the PHY device node > + associated with the this dpmac." > + > + required: > + - compatible > + - reg > + - phy-handle > + > + iommu-map: > + description: | > + Maps an ICID to an IOMMU and associated iommu-specifier data. > + > + The property is an arbitrary number of tuples of > + (icid-base, iommu, iommu-base, length). > + > + Any ICID i in the interval [icid-base, icid-base + length) is > + associated with the listed IOMMU, with the iommu-specifier > + (i - icid-base + iommu-base). > + > + msi-map: > + description: | > + Maps an ICID to a GIC ITS and associated msi-specifier data. > + > + The property is an arbitrary number of tuples of > + (icid-base, gic-its, msi-base, length). > + > + Any ICID in the interval [icid-base, icid-base + length) is > + associated with the listed GIC ITS, with the msi-specifier > + (i - icid-base + msi-base). > + > + msi-parent: > + deprecated: true > + description: "Points to the MSI controller node handling message interrupts > + for the MC." > + > +required: > + - compatible > + - reg > + - iommu-map > + - msi-map > + - ranges > + - '#address-cells' > + - '#size-cells' > + > +additionalProperties: false > + > +examples: > + - | > + soc { > + #address-cells = <2>; > + #size-cells = <2>; > + > + smmu: iommu@5000000 { > + compatible = "arm,mmu-500"; > + #global-interrupts = <1>; > + #iommu-cells = <1>; > + reg = <0 0x5000000 0 0x800000>; > + stream-match-mask = <0x7c00>; > + interrupts = <0 13 4>, > + <0 146 4>, <0 147 4>, > + <0 148 4>, <0 149 4>, > + <0 150 4>, <0 151 4>, > + <0 152 4>, <0 153 4>; > + }; > + > + fsl_mc: fsl-mc@80c000000 { > + compatible = "fsl,qoriq-mc"; > + reg = <0x00000008 0x0c000000 0 0x40>, /* MC portal base */ > + <0x00000000 0x08340000 0 0x40000>; /* MC control reg */ > + /* define map for ICIDs 23-64 */ > + iommu-map = <23 &smmu 23 41>; > + /* define msi map for ICIDs 23-64 */ > + msi-map = <23 &its 23 41>; > + #address-cells = <3>; > + #size-cells = <1>; > + > + /* > + * Region type 0x0 - MC portals > + * Region type 0x1 - QBMAN portals > + */ > + ranges = <0x0 0x0 0x0 0x8 0x0c000000 0x4000000 > + 0x1 0x0 0x0 0x8 0x18000000 0x8000000>; > + > + dpmacs { > + #address-cells = <1>; > + #size-cells = <0>; > + > + dpmac@1 { > + compatible = "fsl,qoriq-mc-dpmac"; > + reg = <1>; > + phy-handle = <&mdio0_phy0>; > + }; > + }; > + }; > + }; > diff --git a/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/overview.rst b/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/overview.rst > index d638b5a8aadd..b3261c5871cc 100644 > --- a/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/overview.rst > +++ b/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/overview.rst > @@ -28,6 +28,9 @@ interfaces, an L2 switch, or accelerator instances. > The MC provides memory-mapped I/O command interfaces (MC portals) > which DPAA2 software drivers use to operate on DPAA2 objects. > > +MC firmware binary images can be found here: > +https://github.com/NXP/qoriq-mc-binary > + > The diagram below shows an overview of the DPAA2 resource management > architecture:: > > @@ -338,7 +341,7 @@ Key functions include: > a bind of the root DPRC to the DPRC driver > > The binding for the MC-bus device-tree node can be consulted at > -*Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt*. > +*Documentation/devicetree/bindings/misc/fsl,qoriq-mc.yaml*. > The sysfs bind/unbind interfaces for the MC-bus can be consulted at > *Documentation/ABI/testing/sysfs-bus-fsl-mc*. > > diff --git a/MAINTAINERS b/MAINTAINERS > index b43b59542d15..400a17c90edb 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -14409,9 +14409,11 @@ M: Stuart Yoder <stuyoder@xxxxxxxxx> > M: Laurentiu Tudor <laurentiu.tudor@xxxxxxx> > L: linux-kernel@xxxxxxxxxxxxxxx > S: Maintained > -F: Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt > +F: Documentation/devicetree/bindings/misc/fsl,dpaa2-console.yaml > +F: Documentation/devicetree/bindings/misc/fsl,qoriq-mc.yaml > F: Documentation/networking/device_drivers/ethernet/freescale/dpaa2/overview.rst > F: drivers/bus/fsl-mc/ > +F: include/linux/fsl/mc.h > > QT1010 MEDIA DRIVER > M: Antti Palosaari <crope@xxxxxx> > -- > 2.17.1 >
