[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <b387a2ed-af47-45a9-871e-d43a66e41f21@kernel.org>
Date: Fri, 13 Jun 2025 11:50:28 +0200
From: Krzysztof Kozlowski <krzk@...nel.org>
To: Jacky Chou <jacky_chou@...eedtech.com>, bhelgaas@...gle.com,
lpieralisi@...nel.org, kwilczynski@...nel.org, mani@...nel.org,
robh@...nel.org, krzk+dt@...nel.org, conor+dt@...nel.org, joel@....id.au,
andrew@...econstruct.com.au, vkoul@...nel.org, kishon@...nel.org,
linus.walleij@...aro.org, p.zabel@...gutronix.de,
linux-aspeed@...ts.ozlabs.org, linux-pci@...r.kernel.org,
devicetree@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
linux-kernel@...r.kernel.org, linux-phy@...ts.infradead.org,
openbmc@...ts.ozlabs.org, linux-gpio@...r.kernel.org
Cc: elbadrym@...gle.com, romlem@...gle.com, anhphan@...gle.com,
wak@...gle.com, yuxiaozhang@...gle.com, BMC-SW@...eedtech.com
Subject: Re: [PATCH 3/7] dt-bindings: pci: Add document for ASPEED PCIe RC
On 13/06/2025 05:29, Jacky Chou wrote:
> Add device tree binding documentation for the ASPEED PCIe Root Complex
> controller. This binding describes the required and optional properties
> for configuring the PCIe RC node, including support for syscon phandles,
> MSI, clocks, resets, and interrupt mapping. The schema enforces strict
> property validation and provides a comprehensive example for reference.
>
> Signed-off-by: Jacky Chou <jacky_chou@...eedtech.com>
> ---
> .../devicetree/bindings/pci/aspeed-pcie.yaml | 159 ++++++++++++++++++
> 1 file changed, 159 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/pci/aspeed-pcie.yaml
>
> diff --git a/Documentation/devicetree/bindings/pci/aspeed-pcie.yaml b/Documentation/devicetree/bindings/pci/aspeed-pcie.yaml
> new file mode 100644
> index 000000000000..5b50a9e2d472
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/pci/aspeed-pcie.yaml
Same comments.
> @@ -0,0 +1,159 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/pci/aspeed-pcie.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ASPEED PCIe Root Complex Controller
> +
> +maintainers:
> + - Jacky Chou <jacky_chou@...eedtech.com>
> +
> +description: |
Do not need '|' unless you need to preserve formatting.
> + Device tree binding for the ASPEED PCIe Root Complex controller.
No, describe the hardware. Your current description is 100% redundant.
It is never useful to say in DT binding description that it is a DT
binding. It cannot be anything else, can it?
> +
> +properties:
> + compatible:
> + enum:
> + - aspeed,ast2600-pcie
> + - aspeed,ast2700-pcie
> +
> + device_type:
> + const: pci
You need to include proper pci schema and drop all redundant properties.
Look at other schemas.
> +
> + reg:
> + maxItems: 1
> +
> + ranges:
> + minItems: 2
> + maxItems: 2
> +
> + interrupts:
> + description: IntX and MSI interrupt
Need to list the items. Look at other schemas.
> +
> + resets:
> + items:
> + - description: Module reset
> + - description: PCIe PERST
> +
> + reset-names:
> + items:
> + - const: h2x
> + - const: perst
> +
> + msi-parent: true
> +
> + msi_address:
Where is this property defined? I do not see in kernel nor in dtschema.
Drop and use existing properties. I am not even talking about coding
style...
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: MSI address
> +
> + aspeed,ahbc:
> + $ref: /schemas/types.yaml#/definitions/phandle
> + description: Phandle to ASPEED AHBC syscon.
For what purpose?
> +
> + aspeed,pciecfg:
> + $ref: /schemas/types.yaml#/definitions/phandle
> + description: Phandle to ASPEED PCIe configuration syscon.
For what purpose?
> +
> + aspeed,pciephy:
> + $ref: /schemas/types.yaml#/definitions/phandle
> + description: Phandle to ASPEED PCIe PHY syscon.
For what purpose?
> +
> + clocks:
> + description: PCIe BUS clock
Missing constraints.
Just open any other binding and do not implement things diferently.
> +
> + interrupt-controller:
> + description: Interrupt controller node for handling legacy PCI interrupts.
> + type: object
> + properties:
> + '#address-cells':
> + const: 0
> + '#interrupt-cells':
> + const: 1
> + interrupt-controller: true
> +
> + required:
> + - '#address-cells'
> + - '#interrupt-cells'
> + - interrupt-controller
> +
> + additionalProperties: false
> +
> +allOf:
> + - $ref: /schemas/pci/pci-bus.yaml#
> + - $ref: /schemas/interrupt-controller/msi-controller.yaml#
> + - if:
> + properties:
> + compatible:
> + contains:
> + const: aspeed,ast2600-pcie
> + then:
> + required:
> + - aspeed,ahbc
else: make it false
> +
> +required:
> + - interrupts
> + - bus-range
> + - ranges
> + - resets
> + - reset-names
> + - msi-parent
> + - msi-controller
> + - aspeed,pciephy
> + - aspeed,pciecfg
> + - interrupt-map-mask
> + - interrupt-map
> + - interrupt-controller
Messed order, missing properties. Open other bindings...
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + #include <dt-bindings/clock/ast2600-clock.h>
> +
> + apb {
> + #address-cells = <1>;
> + #size-cells = <1>;
> +
> + pcie0: pcie@...700C0 {
> + compatible = "aspeed,ast2600-pcie";
> + device_type = "pci";
> + reg = <0x1e7700C0 0x40>;
Lower case hex. Please follow carefully DTS coding style.
Best regards,
Krzysztof
Powered by blists - more mailing lists