diff mbox series

net: use the same alias stem for ethernet as linux

Message ID 20210225155111.2812-1-michael@walle.cc
State New
Delegated to: Joe Hershberger
Headers show
Series net: use the same alias stem for ethernet as linux | expand

Commit Message

Michael Walle Feb. 25, 2021, 3:51 p.m. UTC
Linux uses the prefix "ethernet" whereas u-boot uses "eth". This is from
the linux tree:

$ grep "eth[0-9].*=.*&" arch/**/*dts{,i}|wc -l
0
$ grep "ethernet[0-9].*=.*&" arch/**/*dts{,i}|wc -l
633

In u-boot device trees both prefixes are used. Until recently the only
user of the ethernet alias was the sandbox test device tree. This
changed with commit fc054d563bfb ("net: Introduce DSA class for Ethernet
switches"). There, the MAC addresses are inherited based on the devices
sequence IDs which is in turn given by the device tree.

Before there are more users in u-boot and both worlds will differ even
more, rename the alias prefix to "ethernet" to match the linux ones.
Also adapt the test cases and rename any old aliases in the u-boot
device trees.

Cc: David Wu <david.wu@rock-chips.com>
Signed-off-by: Michael Walle <michael@walle.cc>
---
Vladimir, I didn't do another patch to rename any ethernet aliases to
"eth". Though kontron boards contain "ethernetN" aliases, all in tree
variants don't make use of it. So there is nothing to be fixed.

 arch/arm/dts/fsl-ls1028a-rdb.dts | 12 ++++++------
 arch/sandbox/dts/test.dts        | 10 +++++-----
 net/eth-uclass.c                 |  4 ++--
 test/dm/ofnode.c                 |  2 +-
 test/dm/test-fdt.c               |  2 +-
 5 files changed, 15 insertions(+), 15 deletions(-)

Comments

Fabio Estevam Feb. 25, 2021, 3:58 p.m. UTC | #1
Hi Michael,

On Thu, Feb 25, 2021 at 12:51 PM Michael Walle <michael@walle.cc> wrote:
>
> Linux uses the prefix "ethernet" whereas u-boot uses "eth". This is from
> the linux tree:
>
> $ grep "eth[0-9].*=.*&" arch/**/*dts{,i}|wc -l
> 0
> $ grep "ethernet[0-9].*=.*&" arch/**/*dts{,i}|wc -l
> 633
>
> In u-boot device trees both prefixes are used. Until recently the only
> user of the ethernet alias was the sandbox test device tree. This
> changed with commit fc054d563bfb ("net: Introduce DSA class for Ethernet
> switches"). There, the MAC addresses are inherited based on the devices
> sequence IDs which is in turn given by the device tree.
>
> Before there are more users in u-boot and both worlds will differ even
> more, rename the alias prefix to "ethernet" to match the linux ones.
> Also adapt the test cases and rename any old aliases in the u-boot
> device trees.
>
> Cc: David Wu <david.wu@rock-chips.com>
> Signed-off-by: Michael Walle <michael@walle.cc>

Yes, this is the preferred node naming as per the Devicetree Specification:

Reviewed-by: Fabio Estevam <festevam@gmail.com>
Ramon Fried Feb. 25, 2021, 7:32 p.m. UTC | #2
On Thu, Feb 25, 2021 at 5:58 PM Fabio Estevam <festevam@gmail.com> wrote:
>
> Hi Michael,
>
> On Thu, Feb 25, 2021 at 12:51 PM Michael Walle <michael@walle.cc> wrote:
> >
> > Linux uses the prefix "ethernet" whereas u-boot uses "eth". This is from
> > the linux tree:
> >
> > $ grep "eth[0-9].*=.*&" arch/**/*dts{,i}|wc -l
> > 0
> > $ grep "ethernet[0-9].*=.*&" arch/**/*dts{,i}|wc -l
> > 633
> >
> > In u-boot device trees both prefixes are used. Until recently the only
> > user of the ethernet alias was the sandbox test device tree. This
> > changed with commit fc054d563bfb ("net: Introduce DSA class for Ethernet
> > switches"). There, the MAC addresses are inherited based on the devices
> > sequence IDs which is in turn given by the device tree.
> >
> > Before there are more users in u-boot and both worlds will differ even
> > more, rename the alias prefix to "ethernet" to match the linux ones.
> > Also adapt the test cases and rename any old aliases in the u-boot
> > device trees.
> >
> > Cc: David Wu <david.wu@rock-chips.com>
> > Signed-off-by: Michael Walle <michael@walle.cc>
>
> Yes, this is the preferred node naming as per the Devicetree Specification:
>
> Reviewed-by: Fabio Estevam <festevam@gmail.com>
Ack-by: Ramon Fried <rfried.dev@gmail.com>
David Wu March 3, 2021, 10:26 a.m. UTC | #3
Hi Michael,

Thank you for your patch, good complement.

在 2021/2/25 下午11:51, Michael Walle 写道:
> Linux uses the prefix "ethernet" whereas u-boot uses "eth". This is from
> the linux tree:
> 
> $ grep "eth[0-9].*=.*&" arch/**/*dts{,i}|wc -l
> 0
> $ grep "ethernet[0-9].*=.*&" arch/**/*dts{,i}|wc -l
> 633
> 
> In u-boot device trees both prefixes are used. Until recently the only
> user of the ethernet alias was the sandbox test device tree. This
> changed with commit fc054d563bfb ("net: Introduce DSA class for Ethernet
> switches"). There, the MAC addresses are inherited based on the devices
> sequence IDs which is in turn given by the device tree.
> 
> Before there are more users in u-boot and both worlds will differ even
> more, rename the alias prefix to "ethernet" to match the linux ones.
> Also adapt the test cases and rename any old aliases in the u-boot
> device trees.
> 
> Cc: David Wu <david.wu@rock-chips.com>
> Signed-off-by: Michael Walle <michael@walle.cc>
> ---
> Vladimir, I didn't do another patch to rename any ethernet aliases to
> "eth". Though kontron boards contain "ethernetN" aliases, all in tree
> variants don't make use of it. So there is nothing to be fixed.
> 
>   arch/arm/dts/fsl-ls1028a-rdb.dts | 12 ++++++------
>   arch/sandbox/dts/test.dts        | 10 +++++-----
>   net/eth-uclass.c                 |  4 ++--
>   test/dm/ofnode.c                 |  2 +-
>   test/dm/test-fdt.c               |  2 +-
>   5 files changed, 15 insertions(+), 15 deletions(-)
> 
> diff --git a/arch/arm/dts/fsl-ls1028a-rdb.dts b/arch/arm/dts/fsl-ls1028a-rdb.dts
> index 3432fca352..82a8c0a0cd 100644
> --- a/arch/arm/dts/fsl-ls1028a-rdb.dts
> +++ b/arch/arm/dts/fsl-ls1028a-rdb.dts
> @@ -15,12 +15,12 @@
>   	compatible = "fsl,ls1028a-rdb", "fsl,ls1028a";
>   	aliases {
>   		spi0 = &fspi;
> -		eth0 = &enetc0;
> -		eth1 = &enetc2;
> -		eth2 = &mscc_felix_port0;
> -		eth3 = &mscc_felix_port1;
> -		eth4 = &mscc_felix_port2;
> -		eth5 = &mscc_felix_port3;
> +		ethernet0 = &enetc0;
> +		ethernet1 = &enetc2;
> +		ethernet2 = &mscc_felix_port0;
> +		ethernet3 = &mscc_felix_port1;
> +		ethernet4 = &mscc_felix_port2;
> +		ethernet5 = &mscc_felix_port3;
>   	};
>   };
>   
> diff --git a/arch/sandbox/dts/test.dts b/arch/sandbox/dts/test.dts
> index 3ef3ba0b17..7a5d4aa71d 100644
> --- a/arch/sandbox/dts/test.dts
> +++ b/arch/sandbox/dts/test.dts
> @@ -14,11 +14,11 @@
>   
>   	aliases {
>   		console = &uart0;
> -		eth0 = "/eth@10002000";
> -		eth2 = &swp_0;
> -		eth3 = &eth_3;
> -		eth4 = &dsa_eth0;
> -		eth5 = &eth_5;
> +		ethernet0 = "/eth@10002000";
> +		ethernet2 = &swp_0;
> +		ethernet3 = &eth_3;
> +		ethernet4 = &dsa_eth0;
> +		ethernet5 = &eth_5;
>   		gpio1 = &gpio_a;
>   		gpio2 = &gpio_b;
>   		gpio3 = &gpio_c;
> diff --git a/net/eth-uclass.c b/net/eth-uclass.c
> index 0b4260dc5b..5146bd6666 100644
> --- a/net/eth-uclass.c
> +++ b/net/eth-uclass.c
> @@ -605,8 +605,8 @@ static int eth_pre_remove(struct udevice *dev)
>   	return 0;
>   }
>   
> -UCLASS_DRIVER(eth) = {
> -	.name		= "eth",
> +UCLASS_DRIVER(ethernet) = {
> +	.name		= "ethernet",
>   	.id		= UCLASS_ETH,
>   	.post_bind	= eth_post_bind,
>   	.pre_unbind	= eth_pre_unbind,
> diff --git a/test/dm/ofnode.c b/test/dm/ofnode.c
> index c539134296..3b708b63eb 100644
> --- a/test/dm/ofnode.c
> +++ b/test/dm/ofnode.c
> @@ -213,7 +213,7 @@ static int dm_test_ofnode_read_aliases(struct unit_test_state *uts)
>   	ofnode node;
>   	int size;
>   
> -	node = ofnode_get_aliases_node("eth3");
> +	node = ofnode_get_aliases_node("ethernet3");
>   	ut_assert(ofnode_valid(node));
>   	ut_asserteq_str("sbe5", ofnode_get_name(node));
>   
> diff --git a/test/dm/test-fdt.c b/test/dm/test-fdt.c
> index 6e83aeecd9..98972665f2 100644
> --- a/test/dm/test-fdt.c
> +++ b/test/dm/test-fdt.c
> @@ -183,7 +183,7 @@ static int dm_test_alias_highest_id(struct unit_test_state *uts)
>   {
>   	int ret;
>   
> -	ret = dev_read_alias_highest_id("eth");
> +	ret = dev_read_alias_highest_id("ethernet");
>   	ut_asserteq(5, ret);
>   
>   	ret = dev_read_alias_highest_id("gpio");
>
diff mbox series

Patch

diff --git a/arch/arm/dts/fsl-ls1028a-rdb.dts b/arch/arm/dts/fsl-ls1028a-rdb.dts
index 3432fca352..82a8c0a0cd 100644
--- a/arch/arm/dts/fsl-ls1028a-rdb.dts
+++ b/arch/arm/dts/fsl-ls1028a-rdb.dts
@@ -15,12 +15,12 @@ 
 	compatible = "fsl,ls1028a-rdb", "fsl,ls1028a";
 	aliases {
 		spi0 = &fspi;
-		eth0 = &enetc0;
-		eth1 = &enetc2;
-		eth2 = &mscc_felix_port0;
-		eth3 = &mscc_felix_port1;
-		eth4 = &mscc_felix_port2;
-		eth5 = &mscc_felix_port3;
+		ethernet0 = &enetc0;
+		ethernet1 = &enetc2;
+		ethernet2 = &mscc_felix_port0;
+		ethernet3 = &mscc_felix_port1;
+		ethernet4 = &mscc_felix_port2;
+		ethernet5 = &mscc_felix_port3;
 	};
 };
 
diff --git a/arch/sandbox/dts/test.dts b/arch/sandbox/dts/test.dts
index 3ef3ba0b17..7a5d4aa71d 100644
--- a/arch/sandbox/dts/test.dts
+++ b/arch/sandbox/dts/test.dts
@@ -14,11 +14,11 @@ 
 
 	aliases {
 		console = &uart0;
-		eth0 = "/eth@10002000";
-		eth2 = &swp_0;
-		eth3 = &eth_3;
-		eth4 = &dsa_eth0;
-		eth5 = &eth_5;
+		ethernet0 = "/eth@10002000";
+		ethernet2 = &swp_0;
+		ethernet3 = &eth_3;
+		ethernet4 = &dsa_eth0;
+		ethernet5 = &eth_5;
 		gpio1 = &gpio_a;
 		gpio2 = &gpio_b;
 		gpio3 = &gpio_c;
diff --git a/net/eth-uclass.c b/net/eth-uclass.c
index 0b4260dc5b..5146bd6666 100644
--- a/net/eth-uclass.c
+++ b/net/eth-uclass.c
@@ -605,8 +605,8 @@  static int eth_pre_remove(struct udevice *dev)
 	return 0;
 }
 
-UCLASS_DRIVER(eth) = {
-	.name		= "eth",
+UCLASS_DRIVER(ethernet) = {
+	.name		= "ethernet",
 	.id		= UCLASS_ETH,
 	.post_bind	= eth_post_bind,
 	.pre_unbind	= eth_pre_unbind,
diff --git a/test/dm/ofnode.c b/test/dm/ofnode.c
index c539134296..3b708b63eb 100644
--- a/test/dm/ofnode.c
+++ b/test/dm/ofnode.c
@@ -213,7 +213,7 @@  static int dm_test_ofnode_read_aliases(struct unit_test_state *uts)
 	ofnode node;
 	int size;
 
-	node = ofnode_get_aliases_node("eth3");
+	node = ofnode_get_aliases_node("ethernet3");
 	ut_assert(ofnode_valid(node));
 	ut_asserteq_str("sbe5", ofnode_get_name(node));
 
diff --git a/test/dm/test-fdt.c b/test/dm/test-fdt.c
index 6e83aeecd9..98972665f2 100644
--- a/test/dm/test-fdt.c
+++ b/test/dm/test-fdt.c
@@ -183,7 +183,7 @@  static int dm_test_alias_highest_id(struct unit_test_state *uts)
 {
 	int ret;
 
-	ret = dev_read_alias_highest_id("eth");
+	ret = dev_read_alias_highest_id("ethernet");
 	ut_asserteq(5, ret);
 
 	ret = dev_read_alias_highest_id("gpio");