diff mbox series

[net-next,2/7] macb: bindings doc: use an MDIO node as a container for PHY nodes

Message ID 20200721100234.1302910-3-codrin.ciubotariu@microchip.com
State Changes Requested
Delegated to: David Miller
Headers show
Series Add an MDIO sub-node under MACB | expand

Commit Message

Codrin Ciubotariu July 21, 2020, 10:02 a.m. UTC
The MACB driver embeds an MDIO bus controller and for this reason there
was no need for an MDIO sub-node present to contain the PHY nodes. Adding
MDIO devies directly under an Ethernet node is deprecated, so an MDIO node
is included to contain of the PHY nodes (and other MDIO devices' nodes).

Signed-off-by: Codrin Ciubotariu <codrin.ciubotariu@microchip.com>
---
 Documentation/devicetree/bindings/net/macb.txt | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

Comments

Alexandre Belloni July 21, 2020, 1:29 p.m. UTC | #1
Hi,

The proper subject prefix is dt-bindings: net: macb:

On 21/07/2020 13:02:29+0300, Codrin Ciubotariu wrote:
> The MACB driver embeds an MDIO bus controller and for this reason there
> was no need for an MDIO sub-node present to contain the PHY nodes. Adding
> MDIO devies directly under an Ethernet node is deprecated, so an MDIO node
> is included to contain of the PHY nodes (and other MDIO devices' nodes).
> 
> Signed-off-by: Codrin Ciubotariu <codrin.ciubotariu@microchip.com>
> ---
>  Documentation/devicetree/bindings/net/macb.txt | 15 ++++++++++++---
>  1 file changed, 12 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/macb.txt b/Documentation/devicetree/bindings/net/macb.txt
> index 0b61a90f1592..88d5199c2279 100644
> --- a/Documentation/devicetree/bindings/net/macb.txt
> +++ b/Documentation/devicetree/bindings/net/macb.txt
> @@ -32,6 +32,11 @@ Required properties:
>  The MAC address will be determined using the optional properties
>  defined in ethernet.txt.
>  
> +Optional subnodes:
> +- mdio : specifies the MDIO bus in the MACB, used as a container for PHY nodes or other
> +  nodes of devices present on the MDIO bus. Please see ethernet-phy.yaml in the same
> +  directory for more details.
> +
>  Optional properties for PHY child node:
>  - reset-gpios : Should specify the gpio for phy reset
>  - magic-packet : If present, indicates that the hardware supports waking
> @@ -48,8 +53,12 @@ Examples:
>  		local-mac-address = [3a 0e 03 04 05 06];
>  		clock-names = "pclk", "hclk", "tx_clk";
>  		clocks = <&clkc 30>, <&clkc 30>, <&clkc 13>;
> -		ethernet-phy@1 {
> -			reg = <0x1>;
> -			reset-gpios = <&pioE 6 1>;
> +		mdio {
> +			#address-cells = <1>;
> +			#size-cells = <0>;
> +			ethernet-phy@1 {
> +				reg = <0x1>;
> +				reset-gpios = <&pioE 6 1>;
> +			};
>  		};
>  	};
> -- 
> 2.25.1
>
Codrin Ciubotariu July 21, 2020, 1:44 p.m. UTC | #2
On 21.07.2020 16:29, Alexandre Belloni wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> Hi,
> 
> The proper subject prefix is dt-bindings: net: macb:

Will fix in v2. Thanks!

> 
> On 21/07/2020 13:02:29+0300, Codrin Ciubotariu wrote:
>> The MACB driver embeds an MDIO bus controller and for this reason there
>> was no need for an MDIO sub-node present to contain the PHY nodes. Adding
>> MDIO devies directly under an Ethernet node is deprecated, so an MDIO node
>> is included to contain of the PHY nodes (and other MDIO devices' nodes).
>>
>> Signed-off-by: Codrin Ciubotariu <codrin.ciubotariu@microchip.com>
>> ---
>>   Documentation/devicetree/bindings/net/macb.txt | 15 ++++++++++++---
>>   1 file changed, 12 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/net/macb.txt b/Documentation/devicetree/bindings/net/macb.txt
>> index 0b61a90f1592..88d5199c2279 100644
>> --- a/Documentation/devicetree/bindings/net/macb.txt
>> +++ b/Documentation/devicetree/bindings/net/macb.txt
>> @@ -32,6 +32,11 @@ Required properties:
>>   The MAC address will be determined using the optional properties
>>   defined in ethernet.txt.
>>
>> +Optional subnodes:
>> +- mdio : specifies the MDIO bus in the MACB, used as a container for PHY nodes or other
>> +  nodes of devices present on the MDIO bus. Please see ethernet-phy.yaml in the same
>> +  directory for more details.
>> +
>>   Optional properties for PHY child node:
>>   - reset-gpios : Should specify the gpio for phy reset
>>   - magic-packet : If present, indicates that the hardware supports waking
>> @@ -48,8 +53,12 @@ Examples:
>>                local-mac-address = [3a 0e 03 04 05 06];
>>                clock-names = "pclk", "hclk", "tx_clk";
>>                clocks = <&clkc 30>, <&clkc 30>, <&clkc 13>;
>> -             ethernet-phy@1 {
>> -                     reg = <0x1>;
>> -                     reset-gpios = <&pioE 6 1>;
>> +             mdio {
>> +                     #address-cells = <1>;
>> +                     #size-cells = <0>;
>> +                     ethernet-phy@1 {
>> +                             reg = <0x1>;
>> +                             reset-gpios = <&pioE 6 1>;
>> +                     };
>>                };
>>        };
>> --
>> 2.25.1
>>
> 
> --
> Alexandre Belloni, Bootlin
> Embedded Linux and Kernel engineering
> https://bootlin.com
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/macb.txt b/Documentation/devicetree/bindings/net/macb.txt
index 0b61a90f1592..88d5199c2279 100644
--- a/Documentation/devicetree/bindings/net/macb.txt
+++ b/Documentation/devicetree/bindings/net/macb.txt
@@ -32,6 +32,11 @@  Required properties:
 The MAC address will be determined using the optional properties
 defined in ethernet.txt.
 
+Optional subnodes:
+- mdio : specifies the MDIO bus in the MACB, used as a container for PHY nodes or other
+  nodes of devices present on the MDIO bus. Please see ethernet-phy.yaml in the same
+  directory for more details.
+
 Optional properties for PHY child node:
 - reset-gpios : Should specify the gpio for phy reset
 - magic-packet : If present, indicates that the hardware supports waking
@@ -48,8 +53,12 @@  Examples:
 		local-mac-address = [3a 0e 03 04 05 06];
 		clock-names = "pclk", "hclk", "tx_clk";
 		clocks = <&clkc 30>, <&clkc 30>, <&clkc 13>;
-		ethernet-phy@1 {
-			reg = <0x1>;
-			reset-gpios = <&pioE 6 1>;
+		mdio {
+			#address-cells = <1>;
+			#size-cells = <0>;
+			ethernet-phy@1 {
+				reg = <0x1>;
+				reset-gpios = <&pioE 6 1>;
+			};
 		};
 	};