1 // SPDX-License-Identifier: GPL-2.0+
7 #define LOG_CATEGORY UCLASS_ETH
12 #include <bootstage.h>
15 #include <dm/devres.h>
25 static int netboot_common(enum proto_t, struct cmd_tbl *, int, char * const []);
27 #ifdef CONFIG_CMD_BOOTP
28 static int do_bootp(struct cmd_tbl *cmdtp, int flag, int argc,
31 return netboot_common(BOOTP, cmdtp, argc, argv);
35 bootp, 3, 1, do_bootp,
36 "boot image via network using BOOTP/TFTP protocol",
37 "[loadAddress] [[hostIPaddr:]bootfilename]"
41 #ifdef CONFIG_CMD_TFTPBOOT
42 int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
46 bootstage_mark_name(BOOTSTAGE_KERNELREAD_START, "tftp_start");
47 ret = netboot_common(TFTPGET, cmdtp, argc, argv);
48 bootstage_mark_name(BOOTSTAGE_KERNELREAD_STOP, "tftp_done");
52 #if IS_ENABLED(CONFIG_IPV6)
54 tftpboot, 4, 1, do_tftpb,
55 "boot image via network using TFTP protocol\n"
56 "To use IPv6 add -ipv6 parameter or use IPv6 hostIPaddr framed "
58 "[loadAddress] [[hostIPaddr:]bootfilename] [" USE_IP6_CMD_PARAM "]"
62 tftpboot, 3, 1, do_tftpb,
63 "load file via network using TFTP protocol",
64 "[loadAddress] [[hostIPaddr:]bootfilename]"
69 #ifdef CONFIG_CMD_TFTPPUT
70 static int do_tftpput(struct cmd_tbl *cmdtp, int flag, int argc,
73 return netboot_common(TFTPPUT, cmdtp, argc, argv);
77 tftpput, 4, 1, do_tftpput,
78 "TFTP put command, for uploading files to a server",
79 "Address Size [[hostIPaddr:]filename]"
83 #ifdef CONFIG_CMD_TFTPSRV
84 static int do_tftpsrv(struct cmd_tbl *cmdtp, int flag, int argc,
87 return netboot_common(TFTPSRV, cmdtp, argc, argv);
91 tftpsrv, 2, 1, do_tftpsrv,
92 "act as a TFTP server and boot the first received file",
94 "Listen for an incoming TFTP transfer, receive a file and boot it.\n"
95 "The transfer is aborted if a transfer has not been started after\n"
96 "about 50 seconds or if Ctrl-C is pressed."
101 #ifdef CONFIG_CMD_RARP
102 int do_rarpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
104 return netboot_common(RARP, cmdtp, argc, argv);
108 rarpboot, 3, 1, do_rarpb,
109 "boot image via network using RARP/TFTP protocol",
110 "[loadAddress] [[hostIPaddr:]bootfilename]"
114 #if defined(CONFIG_CMD_DHCP6)
115 static int do_dhcp6(struct cmd_tbl *cmdtp, int flag, int argc,
120 char *dhcp_argv[] = {NULL, NULL, NULL, NULL};
122 /* Add -ipv6 flag for autoload */
123 for (i = 0; i < argc; i++)
124 dhcp_argv[i] = argv[i];
125 dhcp_argc = argc + 1;
126 dhcp_argv[dhcp_argc - 1] = USE_IP6_CMD_PARAM;
128 return netboot_common(DHCP6, cmdtp, dhcp_argc, dhcp_argv);
131 U_BOOT_CMD(dhcp6, 3, 1, do_dhcp6,
132 "boot image via network using DHCPv6/TFTP protocol.\n"
133 "Use IPv6 hostIPaddr framed with [] brackets",
134 "[loadAddress] [[hostIPaddr:]bootfilename]");
137 #if defined(CONFIG_CMD_DHCP)
138 static int do_dhcp(struct cmd_tbl *cmdtp, int flag, int argc,
141 return netboot_common(DHCP, cmdtp, argc, argv);
146 "boot image via network using DHCP/TFTP protocol",
147 "[loadAddress] [[hostIPaddr:]bootfilename]"
150 int dhcp_run(ulong addr, const char *fname, bool autoload)
152 char *dhcp_argv[] = {"dhcp", NULL, (char *)fname, NULL};
153 struct cmd_tbl cmdtp = {}; /* dummy */
158 log_debug("addr=%lx, fname=%s, autoload=%d\n", addr, fname, autoload);
159 old_autoload = env_get_yesno("autoload");
160 ret = env_set("autoload", autoload ? "y" : "n");
162 return log_msg_ret("en1", -EINVAL);
165 sprintf(file_addr, "%lx", addr);
166 dhcp_argv[1] = file_addr;
169 result = do_dhcp(&cmdtp, 0, !autoload ? 1 : fname ? 3 : 2, dhcp_argv);
171 ret = env_set("autoload", old_autoload == -1 ? NULL :
172 old_autoload ? "y" : "n");
174 return log_msg_ret("en2", -EINVAL);
177 return log_msg_ret("res", -ENOENT);
183 #if defined(CONFIG_CMD_NFS)
184 static int do_nfs(struct cmd_tbl *cmdtp, int flag, int argc,
187 return netboot_common(NFS, cmdtp, argc, argv);
192 "boot image via network using NFS protocol",
193 "[loadAddress] [[hostIPaddr:]bootfilename]"
197 #if defined(CONFIG_CMD_WGET)
198 static int do_wget(struct cmd_tbl *cmdtp, int flag, int argc, char * const argv[])
200 return netboot_common(WGET, cmdtp, argc, argv);
205 "boot image via network using HTTP protocol",
206 "[loadAddress] [[hostIPaddr:]path and image name]"
210 static void netboot_update_env(void)
214 if (net_gateway.s_addr) {
215 ip_to_string(net_gateway, tmp);
216 env_set("gatewayip", tmp);
219 if (net_netmask.s_addr) {
220 ip_to_string(net_netmask, tmp);
221 env_set("netmask", tmp);
224 #ifdef CONFIG_CMD_BOOTP
226 env_set("hostname", net_hostname);
229 #ifdef CONFIG_CMD_BOOTP
230 if (net_root_path[0])
231 env_set("rootpath", net_root_path);
235 ip_to_string(net_ip, tmp);
236 env_set("ipaddr", tmp);
239 * Only attempt to change serverip if net/bootp.c:store_net_params()
242 if (!IS_ENABLED(CONFIG_BOOTP_SERVERIP) && net_server_ip.s_addr) {
243 ip_to_string(net_server_ip, tmp);
244 env_set("serverip", tmp);
246 if (net_dns_server.s_addr) {
247 ip_to_string(net_dns_server, tmp);
248 env_set("dnsip", tmp);
250 #if defined(CONFIG_BOOTP_DNS2)
251 if (net_dns_server2.s_addr) {
252 ip_to_string(net_dns_server2, tmp);
253 env_set("dnsip2", tmp);
256 #ifdef CONFIG_CMD_BOOTP
257 if (net_nis_domain[0])
258 env_set("domain", net_nis_domain);
261 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_TIMEOFFSET)
262 if (net_ntp_time_offset) {
263 sprintf(tmp, "%d", net_ntp_time_offset);
264 env_set("timeoffset", tmp);
267 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_NTPSERVER)
268 if (net_ntp_server.s_addr) {
269 ip_to_string(net_ntp_server, tmp);
270 env_set("ntpserverip", tmp);
274 if (IS_ENABLED(CONFIG_IPV6)) {
275 if (!ip6_is_unspecified_addr(&net_ip6) ||
276 net_prefix_length != 0) {
277 if (net_prefix_length != 0)
278 snprintf(tmp, sizeof(tmp), "%pI6c/%d", &net_ip6, net_prefix_length);
280 snprintf(tmp, sizeof(tmp), "%pI6c", &net_ip6);
281 env_set("ip6addr", tmp);
284 if (!ip6_is_unspecified_addr(&net_server_ip6)) {
285 snprintf(tmp, sizeof(tmp), "%pI6c", &net_server_ip6);
286 env_set("serverip6", tmp);
289 if (!ip6_is_unspecified_addr(&net_gateway6)) {
290 snprintf(tmp, sizeof(tmp), "%pI6c", &net_gateway6);
291 env_set("gatewayip6", tmp);
297 * parse_addr_size() - parse address and size arguments for tftpput
299 * @argv: command line arguments
300 * Return: 0 on success
302 static int parse_addr_size(char * const argv[])
304 if (strict_strtoul(argv[1], 16, &image_save_addr) < 0 ||
305 strict_strtoul(argv[2], 16, &image_save_size) < 0) {
306 printf("Invalid address/size\n");
307 return CMD_RET_USAGE;
313 * parse_args() - parse command line arguments
315 * @proto: command prototype
316 * @argc: number of arguments
317 * @argv: command line arguments
318 * Return: 0 on success
320 static int parse_args(enum proto_t proto, int argc, char *const argv[])
327 if (IS_ENABLED(CONFIG_CMD_TFTPPUT) && proto == TFTPPUT)
330 /* refresh bootfile name from env */
331 copy_filename(net_boot_file_name, env_get("bootfile"),
332 sizeof(net_boot_file_name));
336 if (IS_ENABLED(CONFIG_CMD_TFTPPUT) && proto == TFTPPUT)
339 * Only one arg - accept two forms:
340 * Just load address, or just boot file name. The latter
341 * form must be written in a format which can not be
342 * mis-interpreted as a valid number.
344 addr = hextoul(argv[1], &end);
345 if (end == (argv[1] + strlen(argv[1]))) {
346 image_load_addr = addr;
347 /* refresh bootfile name from env */
348 copy_filename(net_boot_file_name, env_get("bootfile"),
349 sizeof(net_boot_file_name));
351 net_boot_file_name_explicit = true;
352 copy_filename(net_boot_file_name, argv[1],
353 sizeof(net_boot_file_name));
358 if (IS_ENABLED(CONFIG_CMD_TFTPPUT) && proto == TFTPPUT) {
359 if (parse_addr_size(argv))
362 image_load_addr = hextoul(argv[1], NULL);
363 net_boot_file_name_explicit = true;
364 copy_filename(net_boot_file_name, argv[2],
365 sizeof(net_boot_file_name));
369 #ifdef CONFIG_CMD_TFTPPUT
371 if (parse_addr_size(argv))
373 net_boot_file_name_explicit = true;
374 copy_filename(net_boot_file_name, argv[3],
375 sizeof(net_boot_file_name));
384 static int netboot_common(enum proto_t proto, struct cmd_tbl *cmdtp, int argc,
391 net_boot_file_name_explicit = false;
392 *net_boot_file_name = '\0';
394 /* pre-set image_load_addr */
395 s = env_get("loadaddr");
397 image_load_addr = hextoul(s, NULL);
399 if (IS_ENABLED(CONFIG_IPV6)) {
402 /* IPv6 parameter has to be always *last* */
403 if (!strcmp(argv[argc - 1], USE_IP6_CMD_PARAM)) {
405 /* It is a hack not to break switch/case code */
410 if (parse_args(proto, argc, argv)) {
411 bootstage_error(BOOTSTAGE_ID_NET_START);
412 return CMD_RET_USAGE;
415 bootstage_mark(BOOTSTAGE_ID_NET_START);
417 if (IS_ENABLED(CONFIG_IPV6) && !use_ip6) {
421 s = strchr(net_boot_file_name, '[');
422 e = strchr(net_boot_file_name, ']');
425 if (!string_to_ip6(s + 1, len - 1, &net_server_ip6))
430 size = net_loop(proto);
432 bootstage_error(BOOTSTAGE_ID_NET_NETLOOP_OK);
433 return CMD_RET_FAILURE;
435 bootstage_mark(BOOTSTAGE_ID_NET_NETLOOP_OK);
437 /* net_loop ok, update environment */
438 netboot_update_env();
440 /* done if no file was loaded (no errors though) */
442 bootstage_error(BOOTSTAGE_ID_NET_LOADED);
443 return CMD_RET_SUCCESS;
446 bootstage_mark(BOOTSTAGE_ID_NET_LOADED);
448 rcode = bootm_maybe_autostart(cmdtp, argv[0]);
450 if (rcode == CMD_RET_SUCCESS)
451 bootstage_mark(BOOTSTAGE_ID_NET_DONE);
453 bootstage_error(BOOTSTAGE_ID_NET_DONE_ERR);
457 #if defined(CONFIG_CMD_PING)
458 static int do_ping(struct cmd_tbl *cmdtp, int flag, int argc,
462 return CMD_RET_USAGE;
464 net_ping_ip = string_to_ip(argv[1]);
465 if (net_ping_ip.s_addr == 0)
466 return CMD_RET_USAGE;
468 if (net_loop(PING) < 0) {
469 printf("ping failed; host %s is not alive\n", argv[1]);
470 return CMD_RET_FAILURE;
473 printf("host %s is alive\n", argv[1]);
475 return CMD_RET_SUCCESS;
480 "send ICMP ECHO_REQUEST to network host",
485 #if IS_ENABLED(CONFIG_CMD_PING6)
486 int do_ping6(struct cmd_tbl *cmdtp, int flag, int argc, char * const argv[])
488 if (string_to_ip6(argv[1], strlen(argv[1]), &net_ping_ip6))
489 return CMD_RET_USAGE;
492 if (net_loop(PING6) < 0) {
494 printf("ping6 failed; host %pI6c is not alive\n",
500 printf("host %pI6c is alive\n", &net_ping_ip6);
505 ping6, 2, 1, do_ping6,
506 "send ICMPv6 ECHO_REQUEST to network host",
509 #endif /* CONFIG_CMD_PING6 */
511 #if defined(CONFIG_CMD_CDP)
513 static void cdp_update_env(void)
517 if (cdp_appliance_vlan != htons(-1)) {
518 printf("CDP offered appliance VLAN %d\n",
519 ntohs(cdp_appliance_vlan));
520 vlan_to_string(cdp_appliance_vlan, tmp);
521 env_set("vlan", tmp);
522 net_our_vlan = cdp_appliance_vlan;
525 if (cdp_native_vlan != htons(-1)) {
526 printf("CDP offered native VLAN %d\n", ntohs(cdp_native_vlan));
527 vlan_to_string(cdp_native_vlan, tmp);
528 env_set("nvlan", tmp);
529 net_native_vlan = cdp_native_vlan;
533 int do_cdp(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
539 printf("cdp failed; perhaps not a CISCO switch?\n");
540 return CMD_RET_FAILURE;
545 return CMD_RET_SUCCESS;
550 "Perform CDP network configuration",
555 #if defined(CONFIG_CMD_SNTP)
556 static struct udp_ops sntp_ops = {
557 .prereq = sntp_prereq,
562 int do_sntp(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
567 net_ntp_server = env_get_ip("ntpserverip");
568 if (net_ntp_server.s_addr == 0) {
569 printf("ntpserverip not set\n");
570 return CMD_RET_FAILURE;
573 net_ntp_server = string_to_ip(argv[1]);
574 if (net_ntp_server.s_addr == 0) {
575 printf("Bad NTP server IP address\n");
576 return CMD_RET_FAILURE;
580 toff = env_get("timeoffset");
582 net_ntp_time_offset = 0;
584 net_ntp_time_offset = simple_strtol(toff, NULL, 10);
586 if (udp_loop(&sntp_ops) < 0) {
587 printf("SNTP failed: host %pI4 not responding\n",
589 return CMD_RET_FAILURE;
592 return CMD_RET_SUCCESS;
597 "synchronize RTC via network",
602 #if defined(CONFIG_CMD_DNS)
603 int do_dns(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
606 return CMD_RET_USAGE;
609 * We should check for a valid hostname:
610 * - Each label must be between 1 and 63 characters long
611 * - the entire hostname has a maximum of 255 characters
612 * - only the ASCII letters 'a' through 'z' (case-insensitive),
613 * the digits '0' through '9', and the hyphen
614 * - cannot begin or end with a hyphen
615 * - no other symbols, punctuation characters, or blank spaces are
617 * but hey - this is a minimalist implmentation, so only check length
618 * and let the name server deal with things.
620 if (strlen(argv[1]) >= 255) {
621 printf("dns error: hostname too long\n");
622 return CMD_RET_FAILURE;
625 net_dns_resolve = argv[1];
628 net_dns_env_var = argv[2];
630 net_dns_env_var = NULL;
632 if (net_loop(DNS) < 0) {
633 printf("dns lookup of %s failed, check setup\n", argv[1]);
634 return CMD_RET_FAILURE;
637 return CMD_RET_SUCCESS;
642 "lookup the IP of a hostname",
646 #endif /* CONFIG_CMD_DNS */
648 #if defined(CONFIG_CMD_LINK_LOCAL)
649 static int do_link_local(struct cmd_tbl *cmdtp, int flag, int argc,
654 if (net_loop(LINKLOCAL) < 0)
655 return CMD_RET_FAILURE;
657 net_gateway.s_addr = 0;
658 ip_to_string(net_gateway, tmp);
659 env_set("gatewayip", tmp);
661 ip_to_string(net_netmask, tmp);
662 env_set("netmask", tmp);
664 ip_to_string(net_ip, tmp);
665 env_set("ipaddr", tmp);
666 env_set("llipaddr", tmp); /* store this for next time */
668 return CMD_RET_SUCCESS;
672 linklocal, 1, 1, do_link_local,
673 "acquire a network IP address using the link-local protocol",
677 #endif /* CONFIG_CMD_LINK_LOCAL */
679 static int do_net_list(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
681 const struct udevice *current = eth_get_dev();
682 unsigned char env_enetaddr[ARP_HLEN];
683 const struct udevice *dev;
686 uclass_id_foreach_dev(UCLASS_ETH, dev, uc) {
687 eth_env_get_enetaddr_by_index("eth", dev_seq(dev), env_enetaddr);
688 printf("eth%d : %s %pM %s\n", dev_seq(dev), dev->name, env_enetaddr,
689 current == dev ? "active" : "");
691 return CMD_RET_SUCCESS;
694 static int do_net_stats(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
696 int nstats, err, i, off;
702 return CMD_RET_USAGE;
704 err = uclass_get_device_by_name(UCLASS_ETH, argv[1], &dev);
706 printf("Could not find device %s\n", argv[1]);
707 return CMD_RET_FAILURE;
710 if (!eth_get_ops(dev)->get_sset_count ||
711 !eth_get_ops(dev)->get_strings ||
712 !eth_get_ops(dev)->get_stats) {
713 printf("Driver does not implement stats dump!\n");
714 return CMD_RET_FAILURE;
717 nstats = eth_get_ops(dev)->get_sset_count(dev);
718 strings = kcalloc(nstats, ETH_GSTRING_LEN, GFP_KERNEL);
720 return CMD_RET_FAILURE;
722 values = kcalloc(nstats, sizeof(u64), GFP_KERNEL);
724 goto err_free_strings;
726 eth_get_ops(dev)->get_strings(dev, strings);
727 eth_get_ops(dev)->get_stats(dev, values);
730 for (i = 0; i < nstats; i++) {
731 printf(" %s: %llu\n", &strings[off], values[i]);
732 off += ETH_GSTRING_LEN;
735 return CMD_RET_SUCCESS;
740 return CMD_RET_FAILURE;
743 static struct cmd_tbl cmd_net[] = {
744 U_BOOT_CMD_MKENT(list, 1, 0, do_net_list, "", ""),
745 U_BOOT_CMD_MKENT(stats, 2, 0, do_net_stats, "", ""),
748 static int do_net(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
752 cp = find_cmd_tbl(argv[1], cmd_net, ARRAY_SIZE(cmd_net));
754 /* Drop the net command */
758 if (!cp || argc > cp->maxargs)
759 return CMD_RET_USAGE;
760 if (flag == CMD_FLAG_REPEAT && !cmd_is_repeatable(cp))
761 return CMD_RET_SUCCESS;
763 return cp->cmd(cmdtp, flag, argc, argv);
769 "list - list available devices\n"
770 "stats <device> - dump statistics for specified device\n"
773 #if defined(CONFIG_CMD_NCSI)
774 static int do_ncsi(struct cmd_tbl *cmdtp, int flag, int argc, char * const argv[])
776 if (!phy_interface_is_ncsi() || !ncsi_active()) {
777 printf("Device not configured for NC-SI\n");
778 return CMD_RET_FAILURE;
781 if (net_loop(NCSI) < 0)
782 return CMD_RET_FAILURE;
784 return CMD_RET_SUCCESS;
789 "Configure attached NIC via NC-SI",
792 #endif /* CONFIG_CMD_NCSI */