diff mbox series

[net-next,4/5] net: dt-bindings: Introduce the Qualcomm IPQESS Ethernet controller

Message ID 20220422180305.301882-5-maxime.chevallier@bootlin.com (mailing list archive)
State New, archived
Headers show
Series net: ipqess: introduce Qualcomm IPQESS driver | expand

Commit Message

Maxime Chevallier April 22, 2022, 6:03 p.m. UTC 
Add the DT binding for the IPQESS Ethernet Controller. This is a simple
controller, only requiring the phy-mode, interrupts, clocks, and
possibly a MAC address setting.

Signed-off-by: Maxime Chevallier <maxime.chevallier@bootlin.com>
---
 .../devicetree/bindings/net/qcom,ipqess.yaml  | 94 +++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/qcom,ipqess.yaml

Comments

Rob Herring (Arm) April 22, 2022, 9:10 p.m. UTC | #1 
On Fri, 22 Apr 2022 20:03:04 +0200, Maxime Chevallier wrote:
> Add the DT binding for the IPQESS Ethernet Controller. This is a simple
> controller, only requiring the phy-mode, interrupts, clocks, and
> possibly a MAC address setting.
> 
> Signed-off-by: Maxime Chevallier <maxime.chevallier@bootlin.com>
> ---
>  .../devicetree/bindings/net/qcom,ipqess.yaml  | 94 +++++++++++++++++++
>  1 file changed, 94 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/qcom,ipqess.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Error: Documentation/devicetree/bindings/net/qcom,ipqess.example.dts:26.27-28 syntax error
FATAL ERROR: Unable to parse input tree
make[1]: *** [scripts/Makefile.lib:364: Documentation/devicetree/bindings/net/qcom,ipqess.example.dtb] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1401: dt_binding_check] Error 2

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Krzysztof Kozlowski April 23, 2022, 5:49 p.m. UTC | #2 
On 22/04/2022 20:03, Maxime Chevallier wrote:
> Add the DT binding for the IPQESS Ethernet Controller. This is a simple
> controller, only requiring the phy-mode, interrupts, clocks, and
> possibly a MAC address setting.
> 
> Signed-off-by: Maxime Chevallier <maxime.chevallier@bootlin.com>
> ---
>  .../devicetree/bindings/net/qcom,ipqess.yaml  | 94 +++++++++++++++++++
>  1 file changed, 94 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/qcom,ipqess.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/qcom,ipqess.yaml b/Documentation/devicetree/bindings/net/qcom,ipqess.yaml
> new file mode 100644
> index 000000000000..8fec5633692f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/qcom,ipqess.yaml
> @@ -0,0 +1,94 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/qcom,ipqess.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Qualcomm IPQ ESS EDMA Ethernet Controller Device Tree Bindings

s/Device Tree Bindings//

> +
> +allOf:
> +  - $ref: "ethernet-controller.yaml#"

allOf goes after maintainers.

> +
> +maintainers:
> +  - Maxime Chevallier <maxime.chevallier@bootlin.com>
> +
> +properties:
> +  compatible:
> +    const: qcom,ipq4019e-ess-edma
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    minItems: 2
> +    maxItems: 32
> +    description: One interrupt per tx and rx queue, with up to 16 queues.
> +
> +  clocks:
> +    maxItems: 1
> +
> +  phy-mode: true
> +
> +  fixed-link: true
> +
> +  mac-address: true

You don't need all these three. They come from ethernet-controller and
you use unevaluatedProperties.

> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - phy-mode
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    gmac: ethernet@c080000 {
> +        compatible = "qcom,ipq4019-ess-edma";
> +        reg = <0xc080000 0x8000>;
> +        interrupts = <GIC_SPI  65 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  66 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  67 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  68 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  69 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  70 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  71 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  72 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  73 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  74 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  75 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  76 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  77 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  78 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  79 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI  80 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 240 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 241 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 242 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 243 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 244 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 245 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 246 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 247 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 248 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 249 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 250 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 251 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 252 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 253 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 254 IRQ_TYPE_EDGE_RISING>,
> +                     <GIC_SPI 255 IRQ_TYPE_EDGE_RISING>;
> +
> +        status = "okay";

No status in the example.

> +
> +        phy-mode = "internal";
> +        fixed-link {
> +            speed = <1000>;
> +            full-duplex;
> +            pause;
> +            asym-pause;
> +        };
> +    };
> +
> +...


Best regards,
Krzysztof
Maxime Chevallier April 26, 2022, 2:02 p.m. UTC | #3 
Hi Krzysztof

On Sat, 23 Apr 2022 19:49:30 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:

Thanks a lot for the review, I'll address all your comments in a V2.

> On 22/04/2022 20:03, Maxime Chevallier wrote:
> > Add the DT binding for the IPQESS Ethernet Controller. This is a
> > simple controller, only requiring the phy-mode, interrupts, clocks,
> > and possibly a MAC address setting.
> > 
> > Signed-off-by: Maxime Chevallier <maxime.chevallier@bootlin.com>
> > ---
> >  .../devicetree/bindings/net/qcom,ipqess.yaml  | 94
> > +++++++++++++++++++ 1 file changed, 94 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/net/qcom,ipqess.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/net/qcom,ipqess.yaml
> > b/Documentation/devicetree/bindings/net/qcom,ipqess.yaml new file
> > mode 100644 index 000000000000..8fec5633692f
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/net/qcom,ipqess.yaml
> > @@ -0,0 +1,94 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/net/qcom,ipqess.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Qualcomm IPQ ESS EDMA Ethernet Controller Device Tree
> > Bindings  
> 
> s/Device Tree Bindings//
> 
> > +
> > +allOf:
> > +  - $ref: "ethernet-controller.yaml#"  
> 
> allOf goes after maintainers.
> 
> > +
> > +maintainers:
> > +  - Maxime Chevallier <maxime.chevallier@bootlin.com>
> > +
> > +properties:
> > +  compatible:
> > +    const: qcom,ipq4019e-ess-edma
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    minItems: 2
> > +    maxItems: 32
> > +    description: One interrupt per tx and rx queue, with up to 16
> > queues. +
> > +  clocks:
> > +    maxItems: 1
> > +
> > +  phy-mode: true
> > +
> > +  fixed-link: true
> > +
> > +  mac-address: true  
> 
> You don't need all these three. They come from ethernet-controller and
> you use unevaluatedProperties.
> 
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - clocks
> > +  - phy-mode
> > +
> > +unevaluatedProperties: false
> > +
> > +examples:
> > +  - |
> > +    gmac: ethernet@c080000 {
> > +        compatible = "qcom,ipq4019-ess-edma";
> > +        reg = <0xc080000 0x8000>;
> > +        interrupts = <GIC_SPI  65 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  66 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  67 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  68 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  69 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  70 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  71 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  72 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  73 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  74 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  75 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  76 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  77 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  78 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  79 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI  80 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 240 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 241 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 242 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 243 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 244 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 245 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 246 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 247 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 248 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 249 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 250 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 251 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 252 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 253 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 254 IRQ_TYPE_EDGE_RISING>,
> > +                     <GIC_SPI 255 IRQ_TYPE_EDGE_RISING>;
> > +
> > +        status = "okay";  
> 
> No status in the example.
> 
> > +
> > +        phy-mode = "internal";
> > +        fixed-link {
> > +            speed = <1000>;
> > +            full-duplex;
> > +            pause;
> > +            asym-pause;
> > +        };
> > +    };
> > +
> > +...  
> 
> 
> Best regards,
> Krzysztof

Best Regards,

Maxime
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/qcom,ipqess.yaml b/Documentation/devicetree/bindings/net/qcom,ipqess.yaml
new file mode 100644
index 000000000000..8fec5633692f
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/qcom,ipqess.yaml
@@ -0,0 +1,94 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/qcom,ipqess.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm IPQ ESS EDMA Ethernet Controller Device Tree Bindings
+
+allOf:
+  - $ref: "ethernet-controller.yaml#"
+
+maintainers:
+  - Maxime Chevallier <maxime.chevallier@bootlin.com>
+
+properties:
+  compatible:
+    const: qcom,ipq4019e-ess-edma
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    minItems: 2
+    maxItems: 32
+    description: One interrupt per tx and rx queue, with up to 16 queues.
+
+  clocks:
+    maxItems: 1
+
+  phy-mode: true
+
+  fixed-link: true
+
+  mac-address: true
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - phy-mode
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    gmac: ethernet@c080000 {
+        compatible = "qcom,ipq4019-ess-edma";
+        reg = <0xc080000 0x8000>;
+        interrupts = <GIC_SPI  65 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  66 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  67 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  68 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  69 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  70 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  71 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  72 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  73 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  74 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  75 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  76 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  77 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  78 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  79 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI  80 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 240 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 241 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 242 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 243 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 244 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 245 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 246 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 247 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 248 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 249 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 250 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 251 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 252 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 253 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 254 IRQ_TYPE_EDGE_RISING>,
+                     <GIC_SPI 255 IRQ_TYPE_EDGE_RISING>;
+
+        status = "okay";
+
+        phy-mode = "internal";
+        fixed-link {
+            speed = <1000>;
+            full-duplex;
+            pause;
+            asym-pause;
+        };
+    };
+
+...