RE: [PATCH net-next V1 2/3] dt-bindings: net: imx-dwmac: convert imx-dwmac bindings to yaml

From: Joakim Zhang
Date: Thu Jul 22 2021 - 06:36:30 EST

Next message: Andy Shevchenko: "Re: [PATCH] mmc: mmc_spi: add spi:mmc-spi-slot alias"
Previous message: Daniel Vetter: "Re: [PATCH 2/3] drm: clarify lifetime/locking for drm_master's lease fields"
In reply to: Rob Herring: "Re: [PATCH net-next V1 2/3] dt-bindings: net: imx-dwmac: convert imx-dwmac bindings to yaml"
Next in thread: Joakim Zhang: "[PATCH net-next V1 3/3] arm64: dts: imx8mp: change interrupt order per dt-binding"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

> -----Original Message-----
> From: Rob Herring <robh@xxxxxxxxxx>
> Sent: 2021年7月22日 0:53
> To: Joakim Zhang <qiangqing.zhang@xxxxxxx>
> Cc: davem@xxxxxxxxxxxxx; kuba@xxxxxxxxxx; shawnguo@xxxxxxxxxx;
> s.hauer@xxxxxxxxxxxxxx; festevam@xxxxxxxxx; kernel@xxxxxxxxxxxxxx;
> dl-linux-imx <linux-imx@xxxxxxx>; peppe.cavallaro@xxxxxx;
> joabreu@xxxxxxxxxxxx; netdev@xxxxxxxxxxxxxxx; devicetree@xxxxxxxxxxxxxxx;
> linux-arm-kernel@xxxxxxxxxxxxxxxxxxx; linux-kernel@xxxxxxxxxxxxxxx
> Subject: Re: [PATCH net-next V1 2/3] dt-bindings: net: imx-dwmac: convert
> imx-dwmac bindings to yaml
>
> On Mon, Jul 19, 2021 at 03:18:20PM +0800, Joakim Zhang wrote:
> > In order to automate the verification of DT nodes covert imx-dwmac to
> > nxp,dwmac-imx.yaml, and pass below checking.
> >
> > $ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- dt_binding_check
> >
> DT_SCHEMA_FILES=Documentation/devicetree/bindings/net/nxp,dwmac-imx.y
> a
> > ml $ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- dtbs_check
> >
> DT_SCHEMA_FILES=Documentation/devicetree/bindings/net/nxp,dwmac-imx.y
> a
> > ml
> >
> > Signed-off-by: Joakim Zhang <qiangqing.zhang@xxxxxxx>
> > ---
> > .../devicetree/bindings/net/imx-dwmac.txt | 56 -----------
> > .../bindings/net/nxp,dwmac-imx.yaml | 93
> +++++++++++++++++++
> > 2 files changed, 93 insertions(+), 56 deletions(-) delete mode
> > 100644 Documentation/devicetree/bindings/net/imx-dwmac.txt
> > create mode 100644
> > Documentation/devicetree/bindings/net/nxp,dwmac-imx.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/net/imx-dwmac.txt
> > b/Documentation/devicetree/bindings/net/imx-dwmac.txt
> > deleted file mode 100644
> > index 921d522fe8d7..000000000000
> > --- a/Documentation/devicetree/bindings/net/imx-dwmac.txt
> > +++ /dev/null
> > @@ -1,56 +0,0 @@
> > -IMX8 glue layer controller, NXP imx8 families support Synopsys MAC 5.10a
> IP.
> > -
> > -This file documents platform glue layer for IMX.
> > -Please see stmmac.txt for the other unchanged properties.
> > -
> > -The device node has following properties.
> > -
> > -Required properties:
> > -- compatible: Should be "nxp,imx8mp-dwmac-eqos" to select glue layer
> > - and "snps,dwmac-5.10a" to select IP version.
> > -- clocks: Must contain a phandle for each entry in clock-names.
> > -- clock-names: Should be "stmmaceth" for the host clock.
> > - Should be "pclk" for the MAC apb clock.
> > - Should be "ptp_ref" for the MAC timer clock.
> > - Should be "tx" for the MAC RGMII TX clock:
> > - Should be "mem" for EQOS MEM clock.
> > - - "mem" clock is required for imx8dxl platform.
> > - - "mem" clock is not required for imx8mp platform.
> > -- interrupt-names: Should contain a list of interrupt names corresponding to
> > - the interrupts in the interrupts property, if available.
> > - Should be "macirq" for the main MAC IRQ
> > - Should be "eth_wake_irq" for the IT which wake up system
> > -- intf_mode: Should be phandle/offset pair. The phandle to the syscon node
> which
> > - encompases the GPR register, and the offset of the GPR register.
> > - - required for imx8mp platform.
> > - - is optional for imx8dxl platform.
> > -
> > -Optional properties:
> > -- intf_mode: is optional for imx8dxl platform.
> > -- snps,rmii_refclk_ext: to select RMII reference clock from external.
> > -
> > -Example:
> > - eqos: ethernet@30bf0000 {
> > - compatible = "nxp,imx8mp-dwmac-eqos", "snps,dwmac-5.10a";
> > - reg = <0x30bf0000 0x10000>;
> > - interrupts = <GIC_SPI 134 IRQ_TYPE_LEVEL_HIGH>,
> > - <GIC_SPI 135 IRQ_TYPE_LEVEL_HIGH>;
> > - interrupt-names = "eth_wake_irq", "macirq";
> > - clocks = <&clk IMX8MP_CLK_ENET_QOS_ROOT>,
> > - <&clk IMX8MP_CLK_QOS_ENET_ROOT>,
> > - <&clk IMX8MP_CLK_ENET_QOS_TIMER>,
> > - <&clk IMX8MP_CLK_ENET_QOS>;
> > - clock-names = "stmmaceth", "pclk", "ptp_ref", "tx";
> > - assigned-clocks = <&clk IMX8MP_CLK_ENET_AXI>,
> > - <&clk IMX8MP_CLK_ENET_QOS_TIMER>,
> > - <&clk IMX8MP_CLK_ENET_QOS>;
> > - assigned-clock-parents = <&clk IMX8MP_SYS_PLL1_266M>,
> > - <&clk IMX8MP_SYS_PLL2_100M>,
> > - <&clk IMX8MP_SYS_PLL2_125M>;
> > - assigned-clock-rates = <0>, <100000000>, <125000000>;
> > - nvmem-cells = <&eth_mac0>;
> > - nvmem-cell-names = "mac-address";
> > - nvmem_macaddr_swap;
> > - intf_mode = <&gpr 0x4>;
> > - status = "disabled";
> > - };
> > diff --git a/Documentation/devicetree/bindings/net/nxp,dwmac-imx.yaml
> > b/Documentation/devicetree/bindings/net/nxp,dwmac-imx.yaml
> > new file mode 100644
> > index 000000000000..5629b2e4ccf8
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/net/nxp,dwmac-imx.yaml
> > @@ -0,0 +1,93 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> > +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi
> >
> +cetree.org%2Fschemas%2Fnet%2Fnxp%2Cdwmac-imx.yaml%23&data=0
> 4%7C01
> >
> +%7Cqiangqing.zhang%40nxp.com%7Ce67c2543a57a49a20fa708d94c6802bc
> %7C686
> >
> +ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637624831874124189%7C
> Unknown%
> >
> +7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haW
> wiLCJ
> >
> +XVCI6Mn0%3D%7C1000&sdata=c0oEjThQAMvIOJYp4epHkPJr2rYMJQUb
> D1mccQvs
> > +mCo%3D&reserved=0
> > +$schema:
> > +https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevi
> >
> +cetree.org%2Fmeta-schemas%2Fcore.yaml%23&data=04%7C01%7Cqia
> ngqing
> >
> +.zhang%40nxp.com%7Ce67c2543a57a49a20fa708d94c6802bc%7C686ea1d3b
> c2b4c6
> >
> +fa92cd99c5c301635%7C0%7C0%7C637624831874134148%7CUnknown%7CT
> WFpbGZsb3
> >
> +d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0
> %3D%
> >
> +7C1000&sdata=1%2BNhcSiOujYzvNsGnYLwo6PGFHGb3gacVOntovlmGes
> %3D&amp
> > +;reserved=0
> > +
> > +title: NXP i.MX8 DWMAC glue layer Device Tree Bindings
> > +
> > +maintainers:
> > + - Joakim Zhang <qiangqing.zhang@xxxxxxx>
> > +
> > +# We need a select here so we don't match all nodes with 'snps,dwmac'
> > +select:
> > + properties:
> > + compatible:
> > + contains:
> > + enum:
> > + - nxp,imx8mp-dwmac-eqos
> > + - nxp,imx8dxl-dwmac-eqos
> > + required:
> > + - compatible
> > +
> > +allOf:
> > + - $ref: "snps,dwmac.yaml#"
> > +
> > +properties:
> > + compatible:
> > + oneOf:
> > + - items:
>
> Don't need 'oneOf' as there is only one entry.
OK

> > + - enum:
> > + - nxp,imx8mp-dwmac-eqos
> > + - nxp,imx8dxl-dwmac-eqos
> > + - const: snps,dwmac-5.10a
> > +
> > + clocks:
> > + minItems: 3
> > + maxItems: 5
> > + items:
> > + - description: MAC host clock
> > + - description: MAC apb clock
> > + - description: MAC timer clock
> > + - description: MAC RGMII TX clock
> > + - description: EQOS MEM clock
> > +
> > + clock-names:
> > + minItems: 3
> > + maxItems: 5
> > + contains:
>
> s/contains/items/
>
> But really, like the other one, can't you define the order?
OK

> > + enum:
> > + - stmmaceth
> > + - pclk
> > + - ptp_ref
> > + - tx
> > + - mem
> > +
> > + intf_mode:
> > + $ref: /schemas/types.yaml#/definitions/phandle-array
> > + description:
> > + Should be phandle/offset pair. The phandle to the syscon node which
> > + encompases the GPR register, and the offset of the GPR register.
>
> Sounds like 2 cells:
>
> maxItems: 2
Why? I think it's only one item like below:

intf_mode = <&gpr 0x4>;

> > +
> > + snps,rmii_refclk_ext:
> > + $ref: /schemas/types.yaml#/definitions/flag
> > + description:
> > + To select RMII reference clock from external.
> > +
> > +required:
> > + - compatible
> > + - clocks
> > + - clock-names
> > +
> > +unevaluatedProperties: false
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/interrupt-controller/arm-gic.h>
> > + #include <dt-bindings/interrupt-controller/irq.h>
> > + #include <dt-bindings/clock/imx8mp-clock.h>
> > +
> > + eqos: ethernet@30bf0000 {
> > + compatible =
> "nxp,imx8mp-dwmac-eqos","snps,dwmac-5.10a";
> > + reg = <0x30bf0000 0x10000>;
> > + interrupts = <GIC_SPI 135 IRQ_TYPE_LEVEL_HIGH>,
> > + <GIC_SPI 134 IRQ_TYPE_LEVEL_HIGH>;
> > + interrupt-names = "macirq", "eth_wake_irq";
> > + clocks = <&clk IMX8MP_CLK_ENET_QOS_ROOT>,
> > + <&clk IMX8MP_CLK_QOS_ENET_ROOT>,
> > + <&clk IMX8MP_CLK_ENET_QOS_TIMER>,
> > + <&clk IMX8MP_CLK_ENET_QOS>;
> > + clock-names = "stmmaceth", "pclk", "ptp_ref", "tx";
> > + phy-mode = "rgmii";
> > + status = "disabled";
>
> Why are you disabling your example? Drop.
OK

Will send a follow-up patch to improve this dt-binding later.

Best Regards,
Joakim Zhang
>
> > + };
> > --
> > 2.17.1
> >
> >

Next message: Andy Shevchenko: "Re: [PATCH] mmc: mmc_spi: add spi:mmc-spi-slot alias"
Previous message: Daniel Vetter: "Re: [PATCH 2/3] drm: clarify lifetime/locking for drm_master's lease fields"
In reply to: Rob Herring: "Re: [PATCH net-next V1 2/3] dt-bindings: net: imx-dwmac: convert imx-dwmac bindings to yaml"
Next in thread: Joakim Zhang: "[PATCH net-next V1 3/3] arm64: dts: imx8mp: change interrupt order per dt-binding"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]