Skip to contentSkip to conversation

cmd: net: add a 'net list' command to list network devs

PATCH Superseded Tim Harvey 2 participants 5 messages Jun 11, 2021 – Jun 14, 2021

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Tim Harvey

author
#0 lore raw

PATCH v2 1/1 cmd: net: add a 'net list' command to list network devs

In a system with multiple network controllers it can be difficult to know the names of the various devices available. This is especially true for USB ether devices as they do not display device names upon detection.

This is being added as a net sub-system in case other commands may want to be added or moved here.

Example:
U-Boot > net
net - NET sub-system

Usage:
net list - list available devices

U-Boot > net list
eth0 : ethernet@2188000 00:d0:12:98:f5:47 active
eth1 : e1000#0 00:d0:12:98:f5:48
eth2 : asix_eth 8c:ae:4c:f5:84:9d
eth3 : asix_eth 8c:ae:4c:f9:41:e3

---
v2: added Reviewed-by tags

---
 cmd/net.c | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
cmd/net.c +44 -0
index beb2877dfd..e51bc443f7 100644
@@ -10,6 +10,7 @@
 #include <common.h>
 #include <bootstage.h>
 #include <command.h>
+#include <dm.h>
 #include <env.h>
 #include <image.h>
 #include <net.h>
@@ -480,3 +481,46 @@ U_BOOT_CMD(
 );
 
 #endif  /* CONFIG_CMD_LINK_LOCAL */
+
+static int do_net_list(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
+{
+	const struct udevice *current = eth_get_dev();
+	unsigned char env_enetaddr[ARP_HLEN];
+	const struct udevice *dev;
+	struct uclass *uc;
+
+	uclass_id_foreach_dev(UCLASS_ETH, dev, uc) {
+		eth_env_get_enetaddr_by_index("eth", dev_seq(dev), env_enetaddr);
+		printf("eth%d : %s %pM %s\n", dev_seq(dev), dev->name, env_enetaddr,
+		       current == dev ? "active" : "");
+	}
+	return CMD_RET_SUCCESS;
+}
+
+static struct cmd_tbl cmd_net[] = {
+	U_BOOT_CMD_MKENT(list, 1, 0, do_net_list, "", ""),
+};
+
+static int do_net(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
+{
+	struct cmd_tbl *cp;
+
+	cp = find_cmd_tbl(argv[1], cmd_net, ARRAY_SIZE(cmd_net));
+
+	/* Drop the net command */
+	argc--;
+	argv++;
+
+	if (!cp || argc > cp->maxargs)
+		return CMD_RET_USAGE;
+	if (flag == CMD_FLAG_REPEAT && !cmd_is_repeatable(cp))
+		return CMD_RET_SUCCESS;
+
+	return cp->cmd(cmdtp, flag, argc, argv);
+}
+
+U_BOOT_CMD(
+	net, 2, 1, do_net,
+	"NET sub-system",
+	"list - list available devices\n"
+);
Signature · 1 line
2.17.1
#1 lore raw
Quoted 93 lines · Tim Harvey

In a system with multiple network controllers it can be difficult to know the names of the various devices available. This is especially true for USB ether devices as they do not display device names upon detection.

This is being added as a net sub-system in case other commands may want to be added or moved here.

Example:
U-Boot > net
net - NET sub-system

Usage:
net list - list available devices

U-Boot > net list
eth0 : ethernet@2188000 00:d0:12:98:f5:47 active
eth1 : e1000#0 00:d0:12:98:f5:48
eth2 : asix_eth 8c:ae:4c:f5:84:9d
eth3 : asix_eth 8c:ae:4c:f9:41:e3

---
v2: added Reviewed-by tags
---
cmd/net.c | 44 ++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 44 insertions(+)
cmd/net.c +3 -0
index beb2877dfd..e51bc443f7 100644
@@ -10,6 +10,7 @@
 #include <common.h>
 #include <bootstage.h>
 #include <command.h>
+#include <dm.h>
 #include <env.h>
 #include <image.h>
 #include <net.h>
@@ -480,3 +481,46 @@ U_BOOT_CMD(
 );
 
 #endif /* CONFIG_CMD_LINK_LOCAL */
+
+static int do_net_list(struct cmd_tbl *cmdtp, int flag, int argc, char

*const argv[])

cmd/net.c +19 -0
+{
+ const struct udevice *current = eth_get_dev();
+ unsigned char env_enetaddr[ARP_HLEN];
+ const struct udevice *dev;
+ struct uclass *uc;
+
+ uclass_id_foreach_dev(UCLASS_ETH, dev, uc) {
+ eth_env_get_enetaddr_by_index("eth", dev_seq(dev), env_enetaddr);
+ printf("eth%d : %s %pM %s\n", dev_seq(dev), dev->name, env_enetaddr,
+ current == dev ? "active" : "");
+ }
+ return CMD_RET_SUCCESS;
+}
+
+static struct cmd_tbl cmd_net[] = {
+ U_BOOT_CMD_MKENT(list, 1, 0, do_net_list, "", ""),
+};
+
+static int do_net(struct cmd_tbl *cmdtp, int flag, int argc, char

*const argv[])

cmd/net.c +22 -1
+{
+ struct cmd_tbl *cp;
+
+ cp = find_cmd_tbl(argv[1], cmd_net, ARRAY_SIZE(cmd_net));
+
+ /* Drop the net command */
+ argc--;
+ argv++;
+
+ if (!cp || argc > cp->maxargs)
+ return CMD_RET_USAGE;
+ if (flag == CMD_FLAG_REPEAT && !cmd_is_repeatable(cp))
+ return CMD_RET_SUCCESS;
+
+ return cp->cmd(cmdtp, flag, argc, argv);
+}
+
+U_BOOT_CMD(
+ net, 2, 1, do_net,
+ "NET sub-system",
+ "list - list available devices\n"
+);
--
Quoted 1 line

2.17.1

Applied to u-boot-net/master, thanks!

Best regards,
Ramon Fried

#2 lore raw

Hi Tim.
The patch fails build in several boards (Malta variants):

+cmd/net.c: In function 'do_net_list':
42+cmd/net.c:487:34: error: initialization of 'const struct udevice *' from incompatible pointer type 'struct eth_device *' [-Werror=incompatible-pointer-types]
43+ 487 | const struct udevice *current = eth_get_dev(); 44+ | ^~~~~~~~~~~

Thanks,
Ramon.

author
#3 lore raw
Quoted 11 lines · Ramon Fried

Hi Tim.
The patch fails build in several boards (Malta variants):

+cmd/net.c: In function 'do_net_list':
42+cmd/net.c:487:34: error: initialization of 'const struct udevice *' from incompatible pointer type 'struct eth_device *' [-Werror=incompatible-pointer-types]
43+ 487 | const struct udevice *current = eth_get_dev(); 44+ | ^~~~~~~~~~~

Ramon,

Looks like my patch only works for DM_ETH. If I were to implement this for legacy eth it would probably be a mess as the device list is a static struct in net/eth_legacy.c. I'm not sure how to tell how many boards are out there that are not yet converted to DM_ETH and am not sure when legacy eth goes away. How about if I just add #ifdef CONFIG_DM_ETH around the whole thing and it isn't supported for legacy eth?

Best Regards,

Tim

#4 lore raw
Quoted 24 lines · Tim Harvey
Quoted 11 lines · Ramon Fried

Hi Tim.
The patch fails build in several boards (Malta variants):

+cmd/net.c: In function 'do_net_list':
42+cmd/net.c:487:34: error: initialization of 'const struct udevice *' from incompatible pointer type 'struct eth_device *' [-Werror=incompatible-pointer-types]
43+ 487 | const struct udevice *current = eth_get_dev(); 44+ | ^~~~~~~~~~~

Ramon,

Looks like my patch only works for DM_ETH. If I were to implement this for legacy eth it would probably be a mess as the device list is a static struct in net/eth_legacy.c. I'm not sure how to tell how many boards are out there that are not yet converted to DM_ETH and am not sure when legacy eth goes away. How about if I just add #ifdef CONFIG_DM_ETH around the whole thing and it isn't supported for legacy eth?

Quoted 3 lines

Best Regards,

Tim

Sounds good to me.