diff mbox series

[v4,1/3] dt-bindings: net: add reset property for aspeed, ast2600-mdio binding

Message ID 20220412065611.8930-2-dylan_hung@aspeedtech.com (mailing list archive)
State New, archived
Headers show
Series Add reset deassertion for Aspeed MDIO | expand

Commit Message

Dylan Hung April 12, 2022, 6:56 a.m. UTC
The AST2600 MDIO bus controller has a reset control bit and must be
deasserted before manipulating the MDIO controller. By default, the
hardware asserts the reset so the driver only need to deassert it.

Regarding to the old DT blobs which don't have reset property in them,
the reset deassertion is usually done by the bootloader so the reset
property is optional to work with them.

Signed-off-by: Dylan Hung <dylan_hung@aspeedtech.com>
Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
---
 .../devicetree/bindings/net/aspeed,ast2600-mdio.yaml         | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Rob Herring (Arm) April 12, 2022, 1:14 p.m. UTC | #1
On Tue, 12 Apr 2022 14:56:09 +0800, Dylan Hung wrote:
> The AST2600 MDIO bus controller has a reset control bit and must be
> deasserted before manipulating the MDIO controller. By default, the
> hardware asserts the reset so the driver only need to deassert it.
> 
> Regarding to the old DT blobs which don't have reset property in them,
> the reset deassertion is usually done by the bootloader so the reset
> property is optional to work with them.
> 
> Signed-off-by: Dylan Hung <dylan_hung@aspeedtech.com>
> Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
> ---
>  .../devicetree/bindings/net/aspeed,ast2600-mdio.yaml         | 5 +++++
>  1 file changed, 5 insertions(+)
> 

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/aspeed,ast2600-mdio.example.dts:25.35-36 syntax error
FATAL ERROR: Unable to parse input tree
make[1]: *** [scripts/Makefile.lib:364: Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.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.
Joel Stanley April 13, 2022, 2:34 a.m. UTC | #2
On Tue, 12 Apr 2022 at 06:55, Dylan Hung <dylan_hung@aspeedtech.com> wrote:
>
> The AST2600 MDIO bus controller has a reset control bit and must be
> deasserted before manipulating the MDIO controller. By default, the
> hardware asserts the reset so the driver only need to deassert it.
>
> Regarding to the old DT blobs which don't have reset property in them,
> the reset deassertion is usually done by the bootloader so the reset
> property is optional to work with them.
>
> Signed-off-by: Dylan Hung <dylan_hung@aspeedtech.com>
> Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
> ---
>  .../devicetree/bindings/net/aspeed,ast2600-mdio.yaml         | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml b/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
> index 1c88820cbcdf..1174c14898e1 100644
> --- a/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
> +++ b/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
> @@ -20,10 +20,14 @@ allOf:
>  properties:
>    compatible:
>      const: aspeed,ast2600-mdio
> +
>    reg:
>      maxItems: 1
>      description: The register range of the MDIO controller instance
>
> +  resets:
> +    maxItems: 1
> +
>  required:
>    - compatible
>    - reg
> @@ -39,6 +43,7 @@ examples:
>              reg = <0x1e650000 0x8>;
>              #address-cells = <1>;
>              #size-cells = <0>;
> +            resets = <&syscon ASPEED_RESET_MII>;

You will need to include the definition for ASPEED_RESET_MII at the
start of the example:

#include <dt-bindings/clock/ast2600-clock.h>

You can test the bindings example by doing this:

pip install dtschema

make dt_binding_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml

Cheers,

Joel

>
>              ethphy0: ethernet-phy@0 {
>                      compatible = "ethernet-phy-ieee802.3-c22";
> --
> 2.25.1
>
Dylan Hung April 13, 2022, 2:59 a.m. UTC | #3
> -----Original Message-----
> From: Joel Stanley [mailto:joel@jms.id.au]
> Sent: 2022年4月13日 10:34 AM
> To: Dylan Hung <dylan_hung@aspeedtech.com>
> Cc: Rob Herring <robh+dt@kernel.org>; Andrew Jeffery <andrew@aj.id.au>;
> Andrew Lunn <andrew@lunn.ch>; hkallweit1@gmail.com; Russell King
> <linux@armlinux.org.uk>; David S . Miller <davem@davemloft.net>; Jakub
> Kicinski <kuba@kernel.org>; pabeni@redhat.com; Philipp Zabel
> <p.zabel@pengutronix.de>; devicetree <devicetree@vger.kernel.org>; Linux
> ARM <linux-arm-kernel@lists.infradead.org>; linux-aspeed
> <linux-aspeed@lists.ozlabs.org>; Linux Kernel Mailing List
> <linux-kernel@vger.kernel.org>; Networking <netdev@vger.kernel.org>;
> Krzysztof Kozlowski <krzk+dt@kernel.org>; BMC-SW
> <BMC-SW@aspeedtech.com>; Krzysztof Kozlowski <krzk@kernel.org>
> Subject: Re: [PATCH v4 1/3] dt-bindings: net: add reset property for aspeed,
> ast2600-mdio binding
> 
> On Tue, 12 Apr 2022 at 06:55, Dylan Hung <dylan_hung@aspeedtech.com>
> wrote:
> >
> > The AST2600 MDIO bus controller has a reset control bit and must be
> > deasserted before manipulating the MDIO controller. By default, the
> > hardware asserts the reset so the driver only need to deassert it.
> >
> > Regarding to the old DT blobs which don't have reset property in them,
> > the reset deassertion is usually done by the bootloader so the reset
> > property is optional to work with them.
> >
> > Signed-off-by: Dylan Hung <dylan_hung@aspeedtech.com>
> > Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
> > ---
> >  .../devicetree/bindings/net/aspeed,ast2600-mdio.yaml         | 5 +++++
> >  1 file changed, 5 insertions(+)
> >
> > diff --git
> > a/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
> > b/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
> > index 1c88820cbcdf..1174c14898e1 100644
> > --- a/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
> > +++ b/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
> > @@ -20,10 +20,14 @@ allOf:
> >  properties:
> >    compatible:
> >      const: aspeed,ast2600-mdio
> > +
> >    reg:
> >      maxItems: 1
> >      description: The register range of the MDIO controller instance
> >
> > +  resets:
> > +    maxItems: 1
> > +
> >  required:
> >    - compatible
> >    - reg
> > @@ -39,6 +43,7 @@ examples:
> >              reg = <0x1e650000 0x8>;
> >              #address-cells = <1>;
> >              #size-cells = <0>;
> > +            resets = <&syscon ASPEED_RESET_MII>;
> 
> You will need to include the definition for ASPEED_RESET_MII at the start of
> the example:
> 
> #include <dt-bindings/clock/ast2600-clock.h>
> 
> You can test the bindings example by doing this:
> 
> pip install dtschema
> 
> make dt_binding_check
> DT_SCHEMA_FILES=Documentation/devicetree/bindings/net/aspeed,ast2600-
> mdio.yaml
> 

Thank you for your comment, I have reproduced this error and fixed it on my side.
The change will be included in V5.

> Cheers,
> 
> Joel
> 
> >
> >              ethphy0: ethernet-phy@0 {
> >                      compatible = "ethernet-phy-ieee802.3-c22";
> > --
> > 2.25.1
> >
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml b/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
index 1c88820cbcdf..1174c14898e1 100644
--- a/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
+++ b/Documentation/devicetree/bindings/net/aspeed,ast2600-mdio.yaml
@@ -20,10 +20,14 @@  allOf:
 properties:
   compatible:
     const: aspeed,ast2600-mdio
+
   reg:
     maxItems: 1
     description: The register range of the MDIO controller instance
 
+  resets:
+    maxItems: 1
+
 required:
   - compatible
   - reg
@@ -39,6 +43,7 @@  examples:
             reg = <0x1e650000 0x8>;
             #address-cells = <1>;
             #size-cells = <0>;
+            resets = <&syscon ASPEED_RESET_MII>;
 
             ethphy0: ethernet-phy@0 {
                     compatible = "ethernet-phy-ieee802.3-c22";