On Tue, Jan 26, 2021 at 1:35 AM Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> wrote: > > Convert the file into a JSON description at the yaml format. json-schema, not JSON really. I prefer just 'DT schema' which implies json-schema in yaml file format. This one is a bit tricky and suspect it needs a few others converted to get right. Not asking for that yet, just keep that in mind. > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> > --- > .../bindings/pci/amlogic,meson-pcie.txt | 4 +- > .../bindings/pci/axis,artpec6-pcie.txt | 2 +- > .../bindings/pci/designware,pcie.yaml | 194 ++++++++++++++++++ snps,dw-pcie.yaml > .../bindings/pci/designware-pcie.txt | 77 ------- > .../bindings/pci/fsl,imx6q-pcie.txt | 2 +- > .../bindings/pci/hisilicon-histb-pcie.txt | 2 +- > .../bindings/pci/hisilicon-pcie.txt | 2 +- > .../devicetree/bindings/pci/kirin-pcie.txt | 2 +- > .../bindings/pci/layerscape-pci.txt | 2 +- > .../bindings/pci/nvidia,tegra194-pcie.txt | 4 +- > .../devicetree/bindings/pci/pci-armada8k.txt | 2 +- > .../devicetree/bindings/pci/pci-keystone.txt | 10 +- > .../devicetree/bindings/pci/pcie-al.txt | 2 +- > .../devicetree/bindings/pci/qcom,pcie.txt | 14 +- > .../bindings/pci/samsung,exynos5440-pcie.txt | 4 +- > .../pci/socionext,uniphier-pcie-ep.yaml | 2 +- > .../devicetree/bindings/pci/ti-pci.txt | 4 +- > .../devicetree/bindings/pci/uniphier-pcie.txt | 2 +- > MAINTAINERS | 2 +- > 19 files changed, 225 insertions(+), 108 deletions(-) > create mode 100644 Documentation/devicetree/bindings/pci/designware,pcie.yaml > delete mode 100644 Documentation/devicetree/bindings/pci/designware-pcie.txt > diff --git a/Documentation/devicetree/bindings/pci/designware,pcie.yaml b/Documentation/devicetree/bindings/pci/designware,pcie.yaml > new file mode 100644 > index 000000000000..e610ed073789 > --- /dev/null > +++ b/Documentation/devicetree/bindings/pci/designware,pcie.yaml > @@ -0,0 +1,194 @@ > +# SPDX-License-Identifier: GPL-2.0 > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/pci/designware,pcie.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Synopsys DesignWare PCIe interface > + > +maintainers: > + - Jingoo Han <jingoohan1@xxxxxxxxx> > + - Gustavo Pimentel <gustavo.pimentel@xxxxxxxxxxxx> > + > +description: | > + Synopsys DesignWare PCIe host controller > + > +properties: > + compatible: > + description: | > + The compatible can be either: > + - snps,dw-pcie # for RC mode > + - snps,dw-pcie-ep # For EP mode > + or some other value, when there's a host-specific driver Needs to be a schema. This is complicated because sometimes it's used and sometimes not. So we need something like this: anyOf: - {} - items: contains: enum: - snps,dw-pcie - snps,dw-pcie-ep This will always be true, but at least documents the strings in a parseable form. > + > + reg: > + description: | > + For designware cores version < 4.80 contains the configuration > + address space. For designware core version >= 4.80, contains > + the configuration and ATU address space And DBI for all versions. > + maxItems: 4 minItems: 2 (dbi and config must always be there) > + > + reg-names: > + description: | > + Must be "config" for the PCIe configuration space and "atu" for > + the ATU address space. > + (The old way of getting the configuration address space from > + "ranges" is deprecated and should be avoided.) This is getting dropped from the driver and can be dropped here. This only existed for a few months back in 2013. > + maxItems: 4 minItems: 2 items: contains: enum: [ dbi, dbi2, config, atu ] > + > + num-lanes: > + description: | > + number of lanes to use (this property should be specified unless > + the link is brought already up in BIOS) > + maxItems: 1 Not an array. IIRC, pci-bus.yaml covers this. If not, needs a type ref and min/max (1-16). > + > + reset-gpio: > + description: GPIO pin number of power good signal Isn't this the PERST# signal? > + maxItems: 1 > + > + clocks: > + description: | > + Must contain an entry for each entry in clock-names. > + See Documentation/devicetree/bindings/clock/clock-bindings.txt for > + details. This is every 'clocks', drop. > + minItems: 2 > + maxItems: 8 > + > + clock-names: > + description: | > + Must include the following entries: > + - "pcie" > + - "pcie_bus" Need to be in a schema. > + minItems: 2 > + maxItems: 8 > + > + "snps,enable-cdm-check": > + $ref: /schemas/types.yaml#definitions/flag > + description: | > + This is a boolean property and if present enables > + automatic checking of CDM (Configuration Dependent Module) registers > + for data corruption. CDM registers include standard PCIe configuration > + space registers, Port Logic registers, DMA and iATU (internal Address > + Translation Unit) registers. > + > + # The following are mandatory properties for RC Mode > + > + "#address-cells": > + const: 3 > + > + "#size-cells": > + const: 2 > + > + device_type: > + const: pci > + > + ranges: > + $ref: /schemas/types.yaml#/definitions/uint32-array > + description: | > + ranges for the PCI memory and I/O regions > + minItems: 1 > + maxItems: 8 > + > + "#interrupt-cells": > + $ref: /schemas/types.yaml#/definitions/uint32 > + const: 1 > + > + interrupt-map-mask: > + description: | > + Standard PCI properties to define the mapping of the PCIe > + interface to interrupt numbers. > + > + interrupt-map: > + description: | > + Standard PCI properties to define the mapping of the PCIe > + interface to interrupt numbers. pci-bus.yaml already covers these. Drop and reference pci-bus.yaml > + > + # The following are optional properties for RC mode > + > + num-viewport: > + description: | > + number of view ports configured in hardware. If a platform > + does not specify it, the driver assumes 2. This is detected now and can be marked 'deprecated'. > + > + bus-range: > + description: | > + PCI bus numbers covered (it is recommended for new devicetrees > + to specify this property, to keep backwards compatibility a range of > + 0x00-0xff is assumed if not present) Covered by pci-bus.yaml. > + > + # The following are mandatory properties for EP Mode > + > + num-ib-windows: > + description: number of inbound address translation windows > + maxItems: 1 > + > + num-ob-windows: > + description: number of outbound address translation windows > + maxItems: 1 These 2 are detected now and can be marked 'deprecated'. > + > + # The following are optional properties for EP mode > + > + max-functions: > + description: maximum number of functions that can be configured > + maxItems: 1 Not an array. > + > +required: > + - reg > + - reg-names > + - compatible > + > +allOf: > + - if: > + properties: > + compatible: > + contains: > + const: snps,dw-pcie > + then: > + required: > + - compatible > + - "#address-cells" > + - "#size-cells" > + - device_type > + - ranges > + - "#interrupt-cells" > + - interrupt-map-mask > + - interrupt-map All these are required for all pci hosts. > + - if: > + properties: > + compatible: > + contains: > + const: snps,dw-pcie-ep > + then: > + required: > + - compatible > + - num-ib-windows > + - num-ob-windows > + > +additionalProperties: false > + > +examples: > + - | > + pcie: pcie@dfc00000 { > + compatible = "snps,dw-pcie"; > + reg = <0xdfc00000 0x0001000>, /* IP registers */ > + <0xd0000000 0x0002000>; /* Configuration space */ > + reg-names = "dbi", "config"; > + #address-cells = <3>; > + #size-cells = <2>; > + device_type = "pci"; > + ranges = <0x81000000 0 0x00000000 0xde000000 0 0x00010000 > + 0x82000000 0 0xd0400000 0xd0400000 0 0x0d000000>; > + interrupts = <25>, <24>; > + #interrupt-cells = <1>; > + num-lanes = <1>; > + }; > + pcie_ep: pcie_ep@dfd00000 { > + compatible = "snps,dw-pcie-ep"; > + reg = <0xdfc00000 0x0001000>, /* IP registers 1 */ > + <0xdfc01000 0x0001000>, /* IP registers 2 */ > + <0xd0000000 0x2000000>; /* Configuration space */ > + reg-names = "dbi", "dbi2", "addr_space"; > + num-ib-windows = <6>; > + num-ob-windows = <2>; > + num-lanes = <1>; > + };
