Received-SPF: pass (google.com: domain of linux-kernel+bounces-56845-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Date: Wed, 7 Feb 2024 12:49:19 -0500
From: Frank Li <Frank.li@nxp.com>
To: Conor Dooley <conor@kernel.org>
Cc: Bjorn Helgaas <bhelgaas@google.com>,
	Lorenzo Pieralisi <lpieralisi@kernel.org>,
	Krzysztof =?utf-8?Q?Wilczy=C5=84ski?= <kw@linux.com>,
	Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Conor Dooley <conor+dt@kernel.org>,
	"open list:PCI SUBSYSTEM" <linux-pci@vger.kernel.org>,
	"open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS" <devicetree@vger.kernel.org>,
	open list <linux-kernel@vger.kernel.org>, imx@lists.linux.dev
Subject: Re: [PATCH 1/1] dt-bindings: pci: layerscape-pci: Convert to yaml
 file
Message-ID: <ZcPCn8q7viB/qcOH@lizhi-Precision-Tower-5810>
References: <20240207062403.304367-1-Frank.Li@nxp.com>
 <20240207-yoga-mobility-90a728f6342c@spud>
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20240207-yoga-mobility-90a728f6342c@spud>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?OWlGA7gJImtzVh5CVaYUxBHL/IxMsNwynSUgBZpsa9Xu567NCYyio5MR+qFu?=
 =?us-ascii?Q?L33viyuKUz3gbpSrqwPegf033WyKMEr1PYajXcDHShCq14zvqXGXKSXxvRsI?=
 =?us-ascii?Q?E+v4EqSm1ghPh1n7IHZd6mdCquRJ73afRvoY6ty1IN6RTDj2WxyBxTFyAmrV?=
 =?us-ascii?Q?d6u55lrNj4ZF1VAX/UfUPdCgn4ApphLgvEQXef5oesrUKJgbb0XcTL5o4Fo7?=
 =?us-ascii?Q?tV/nt6zeJ+MCnWO8oeV/Sc72CJwf4tJiJ4M3b3NJVqv7Xr0v8Lq5sBUbZWac?=
 =?us-ascii?Q?euFH+GrTa3L4N95gdIo/V92k3CPCNlAZDrSybmTBl+9KplE2dXgS8xEShwwL?=
 =?us-ascii?Q?MsTcG0zrJDF11LZUEDItz9OodOp9jguvtUTGfFRnGw8CpCsAQJ7HLDJpIBDH?=
 =?us-ascii?Q?bBiOsxTAwRKTpvA2JhtxPjFZPZGxHq35/lU8sucV0FEnUOUkVkgu2+wcEc/X?=
 =?us-ascii?Q?/G4RrMJ77x99l/u1NbaHYr7eFwpYYdzL2Pf7TmcnX4xllPZ26xtPsjOz4e+t?=
 =?us-ascii?Q?gTrFehREvfZO0B//2sofVqnkb+SQ1vIS+V+QThRfcpKpJAdK77tvsQEj+m8t?=
 =?us-ascii?Q?YT1tug8NLtGBy+hYbLhVaBhJTIIzob9oyBpD57umiKw82BUP1IOx3IQIrh2h?=
 =?us-ascii?Q?DZ5gahsxOnRnDRH2KcKp0Jhssfvgnf9TNAUeBQR+enwBogDP3p4mhNGLXpVI?=
 =?us-ascii?Q?CYY5qh8IcXHpWTwxehAzztPaht7njh9GMG2CRJXl02LjKIPyQ0Y29GzUSZEv?=
 =?us-ascii?Q?/cdZ5uRL79gnV5LmctLJeNSRUussia+hpKsJI60bZKzh4/on1I42v/aGqB0D?=
 =?us-ascii?Q?qaYXZ0yWKdEY2onpXYd6NM85nxA0WVBi64z+P0hUT4b/eKVD7Z24sUfC77Su?=
 =?us-ascii?Q?cq98o0+azHJIsIBH1GW2xP/b6umLAdKhgwNAfo0d+DGpaR7WXQmMTy/4Gs/T?=
 =?us-ascii?Q?3egyOjgCEgMpyq+s0YbHsUj553bMYyQo3Tu5q7zqBDO5ZwU4J7rNDD6eZK/J?=
 =?us-ascii?Q?7wHogI/KTeI60iopJDbT0wsqqY4fxs8tKRTvJjEW+IPwrxykqN/M5r3qy7ed?=
 =?us-ascii?Q?QGOVsOOYDLx87qUmBEpNcyCyel1u5pFVgP+GdGEU2w2wEoC3oaFBN8i9pCN4?=
 =?us-ascii?Q?ln/MGkduzV9+7zEaw4oye+yKjdY5Ju+8/ICByckVxD8OAujihPLHPMF+wRaT?=
 =?us-ascii?Q?95FMfTBzIistCUilm7tOTs/jNTYUdE7yShSNpmooQMJ6E6L/IMGkH8Sm1+Ci?=
 =?us-ascii?Q?ZQcixKHxrjJb/Z7Nw5p6lcHFVvslLX1DPXCMrP/0Al2QdZ0DMarXPOd205aE?=
 =?us-ascii?Q?LLqNmt99d57fJelI5SfJ3BucZL+PxHjmEI8b+JgG749zk+ahBqs2ZH5G35nn?=
 =?us-ascii?Q?jfmCu/jHRNFy1ecxEu5lnCgf5XTorQhHWM4wyicTupJe1Y+A3GWg1ET9Jjef?=
 =?us-ascii?Q?vyK45APNqEvZntYSGHrDmTSFussg/os9YQbw+3ZirOFDS5/I2V9KG6Pxz4hi?=
 =?us-ascii?Q?V8kxzUDRmI8TA9PkQy1CG1BDjxZjyP3IFQbXQfKwoK2V9YGFsXWkOlMUTIi1?=
 =?us-ascii?Q?jWZ0MCcWP9WIoxuTbC4=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 540d6676-ea95-44c5-33ca-08dc280520c1
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Feb 2024 17:49:27.4318
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 6IrjX+AgWbloWVSKP8TDyuQYmeRULLmFgLZwWs8Ng1aJhg1DBxdtxukB2OUV1RhsAYvoBlWJQpJL+kJSxT4OOA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB10027

On Wed, Feb 07, 2024 at 05:17:55PM +0000, Conor Dooley wrote:
> Hey Frank,
> 
> On Wed, Feb 07, 2024 at 01:24:02AM -0500, Frank Li wrote:
> > Convert layerscape pcie bind document to yaml file.
> > 
> > Signed-off-by: Frank Li <Frank.Li@nxp.com>
> > ---
> >  .../bindings/pci/fsl,layerscape-pcie-ep.yaml  |  84 +++++++++
> >  .../bindings/pci/fsl,layerscape-pcie.yaml     | 163 ++++++++++++++++++
> >  .../bindings/pci/layerscape-pci.txt           |  79 ---------
> >  3 files changed, 247 insertions(+), 79 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/pci/fsl,layerscape-pcie-ep.yaml
> >  create mode 100644 Documentation/devicetree/bindings/pci/fsl,layerscape-pcie.yaml
> >  delete mode 100644 Documentation/devicetree/bindings/pci/layerscape-pci.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/pci/fsl,layerscape-pcie-ep.yaml b/Documentation/devicetree/bindings/pci/fsl,layerscape-pcie-ep.yaml
> > new file mode 100644
> > index 0000000000000..3b592c820eb4c
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/pci/fsl,layerscape-pcie-ep.yaml
> > @@ -0,0 +1,84 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/pci/fsl,layerscape-pcie-ep.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Freescale Layerscape PCIe controller
> > +
> > +maintainers:
> > +  - Frank Li <Frank.Li@nxp.com>
> > +
> > +description: |+
> 
> Are you sure that you need this chomping operator?
> 
> > +  This PCIe endpoint controller is based on the Synopsys DesignWare PCIe IP
> 
> > +  and thus inherits all the common properties defined in snps,dw-pcie-ep.yaml.
> 
> You shouldn't need this statement given you have the ref: below.
> 
> > +
> > +  This controller derives its clocks from the Reset Configuration Word (RCW)
> > +  which is used to describe the PLL settings at the time of chip-reset.
> > +
> > +  Also as per the available Reference Manuals, there is no specific 'version'
> > +  register available in the Freescale PCIe controller register set,
> > +  which can allow determining the underlying DesignWare PCIe controller version
> > +  information.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - fsl,ls2088a-pcie-ep
> > +      - fsl,ls1088a-pcie-ep
> > +      - fsl,ls1046a-pcie-ep
> > +      - fsl,ls1028a-pcie-ep
> > +      - fsl,lx2160ar2-pcie-ep
> 
> Where did the fallback compatible go?

So far, no fallback compatible needed now. each devices already have its
compatible string.

> 
> > +
> > +  reg:
> > +    maxItems: 2
> > +
> > +  reg-names:
> > +    items:
> > +      - const: regs
> > +      - const: addr_space
> 
> The example uses "regs" and "config". Where did addr_space come from?

Example just show pcie-host part. Not show pcie-ep part.
pcie-ep part need 'addr_space'.

> 
> > +  fsl,pcie-scfg:
> > +    $ref: /schemas/types.yaml#/definitions/phandle
> > +    description: A phandle to the SCFG device node. The second entry is the
> > +      physical PCIe controller index starting from '0'. This is used to get
> > +      SCFG PEXN registers.
> > +
> > +  dma-coherent:
> 
> dma-coherent: true
> 
> > +    $ref: /schemas/types.yaml#/definitions/flag
> > +    description: Indicates that the hardware IP block can ensure the coherency
> > +      of the data transferred from/to the IP block. This can avoid the software
> > +      cache flush/invalid actions, and improve the performance significantly.
> > +
> > +  big-endian:
> > +    $ref: /schemas/types.yaml#/definitions/flag
> > +    description: If the PEX_LUT and PF register block is in big-endian, specify
> > +      this property.
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - reg-names
> 
> This was not previously required, why is it required now?

Actually its needed. 

> 
> > +  - "#address-cells"
> > +  - "#size-cells"
> > +  - device_type
> > +  - bus-range
> > +  - ranges
> > +
> > +allOf:
> > +  - $ref: /schemas/pci/snps,dw-pcie-ep.yaml#
> > +
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          enum:
> > +            - fsl,ls1028a-pcie-ep
> > +            - fsl,ls1046a-pcie-ep
> > +            - fsl,ls1088a-pcie-ep
> > +    then:
> > +      properties:
> > +        interrupt-names:
> > +          items:
> > +            - const: pme
> 
> Please define the interrupt properties at the top-level and constrain
> them on a per-device basis.
> 
> > +
> > +unevaluatedProperties: false
> > diff --git a/Documentation/devicetree/bindings/pci/fsl,layerscape-pcie.yaml b/Documentation/devicetree/bindings/pci/fsl,layerscape-pcie.yaml
> > new file mode 100644
> > index 0000000000000..e3719da306f25
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/pci/fsl,layerscape-pcie.yaml
> > @@ -0,0 +1,163 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/pci/fsl,layerscape-pcie.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> 
> Only brief comments here, as it most is the same comments as for the 
> > +
> > +title: Freescale Layerscape PCIe controller
> > +
> > +maintainers:
> > +  - Frank Li <Frank.Li@nxp.com>
> > +
> > +description: |+
> > +  This PCIe host controller is based on the Synopsys DesignWare PCIe IP
> > +  and thus inherits all the common properties defined in snps,dw-pcie.yaml.
> 
> Same two comments here as above.
> 
> > +
> > +  This controller derives its clocks from the Reset Configuration Word (RCW)
> > +  which is used to describe the PLL settings at the time of chip-reset.
> > +
> > +  Also as per the available Reference Manuals, there is no specific 'version'
> > +  register available in the Freescale PCIe controller register set,
> > +  which can allow determining the underlying DesignWare PCIe controller version
> > +  information.
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - fsl,ls1021a-pcie
> > +      - fsl,ls2080a-pcie
> > +      - fsl,ls2085a-pcie
> > +      - fsl,ls2088a-pcie
> > +      - fsl,ls1088a-pcie
> > +      - fsl,ls1046a-pcie
> > +      - fsl,ls1043a-pcie
> > +      - fsl,ls1012a-pcie
> > +      - fsl,ls1028a-pcie
> > +
> > +  reg:
> > +    maxItems: 2
> > +
> > +  reg-names:
> > +    items:
> > +      - const: regs
> > +      - const: config
> > +
> > +  fsl,pcie-scfg:
> > +    $ref: /schemas/types.yaml#/definitions/phandle
> > +    description: A phandle to the SCFG device node. The second entry is the
> > +      physical PCIe controller index starting from '0'. This is used to get
> > +      SCFG PEXN registers.
> > +
> > +  dma-coherent:
> > +    $ref: /schemas/types.yaml#/definitions/flag
> > +    description: Indicates that the hardware IP block can ensure the coherency
> > +      of the data transferred from/to the IP block. This can avoid the software
> > +      cache flush/invalid actions, and improve the performance significantly.
> 
> Same here.
> 
> > +
> > +  big-endian:
> > +    $ref: /schemas/types.yaml#/definitions/flag
> > +    description: If the PEX_LUT and PF register block is in big-endian, specify
> > +      this property.
> > +
> > +  msi-parent: true
> > +
> > +  iommu-map: true
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - reg-names
> 
> Same here.
> 
> > +  - "#address-cells"
> > +  - "#size-cells"
> > +  - device_type
> > +  - bus-range
> > +  - ranges
> > +  - interrupts
> > +  - interrupt-names
> > +  - "#interrupt-cells"
> > +  - interrupt-map-mask
> > +  - interrupt-map
> > +
> > +allOf:
> > +  - $ref: /schemas/pci/pci-bus.yaml#
> > +
> 
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          enum:
> > +            - fsl,ls1028a-pcie
> > +            - fsl,ls1046a-pcie
> > +            - fsl,ls1043a-pcie
> > +            - fsl,ls1012a-pcie
> > +    then:
> > +      properties:
> > +        interrupts:
> > +          maxItems: 2
> > +        interrupt-names:
> > +          items:
> > +            - const: pme
> > +            - const: aer
> > +
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          enum:
> > +            - fsl,ls2080a-pcie
> > +            - fsl,ls2085a-pcie
> > +            - fsl,ls2088a-pcie
> > +    then:
> > +      properties:
> > +        interrupts:
> > +          maxItems: 1
> > +        interrupt-names:
> > +          items:
> > +            - const: intr
> > +
> > +  - if:
> > +      properties:
> > +        compatible:
> > +          enum:
> > +            - fsl,ls1088a-pcie
> > +    then:
> > +      properties:
> > +        interrupts:
> > +          maxItems: 1
> > +        interrupt-names:
> > +          items:
> > +            - const: aer
> 
> And same here.
> 
> Thanks,
> Conor.