cmd/net.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  */
   6
   7 /*
   8  * Boot support
   9  */
  10 #include <common.h>
  11 #include <bootstage.h>
  12 #include <command.h>
  13 #include <dm.h>
  14 #include <env.h>
  15 #include <image.h>
  16 #include <net.h>
  17 #include <net/udp.h>
  18 #include <net/sntp.h>
  19
  20 static int netboot_common(enum proto_t, struct cmd_tbl *, int, char * const []);
  21
  22 #ifdef CONFIG_CMD_BOOTP
  23 static int do_bootp(struct cmd_tbl *cmdtp, int flag, int argc,
  24                     char *const argv[])
  25 {
  26         return netboot_common(BOOTP, cmdtp, argc, argv);
  27 }
  28
  29 U_BOOT_CMD(
  30         bootp,  3,      1,      do_bootp,
  31         "boot image via network using BOOTP/TFTP protocol",
  32         "[loadAddress] [[hostIPaddr:]bootfilename]"
  33 );
  34 #endif
  35
  36 #ifdef CONFIG_CMD_TFTPBOOT
  37 int do_tftpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
  38 {
  39         int ret;
  40
  41         bootstage_mark_name(BOOTSTAGE_KERNELREAD_START, "tftp_start");
  42         ret = netboot_common(TFTPGET, cmdtp, argc, argv);
  43         bootstage_mark_name(BOOTSTAGE_KERNELREAD_STOP, "tftp_done");
  44         return ret;
  45 }
  46
  47 U_BOOT_CMD(
  48         tftpboot,       3,      1,      do_tftpb,
  49         "boot image via network using TFTP protocol",
  50         "[loadAddress] [[hostIPaddr:]bootfilename]"
  51 );
  52 #endif
  53
  54 #ifdef CONFIG_CMD_TFTPPUT
  55 static int do_tftpput(struct cmd_tbl *cmdtp, int flag, int argc,
  56                       char *const argv[])
  57 {
  58         return netboot_common(TFTPPUT, cmdtp, argc, argv);
  59 }
  60
  61 U_BOOT_CMD(
  62         tftpput,        4,      1,      do_tftpput,
  63         "TFTP put command, for uploading files to a server",
  64         "Address Size [[hostIPaddr:]filename]"
  65 );
  66 #endif
  67
  68 #ifdef CONFIG_CMD_TFTPSRV
  69 static int do_tftpsrv(struct cmd_tbl *cmdtp, int flag, int argc,
  70                       char *const argv[])
  71 {
  72         return netboot_common(TFTPSRV, cmdtp, argc, argv);
  73 }
  74
  75 U_BOOT_CMD(
  76         tftpsrv,        2,      1,      do_tftpsrv,
  77         "act as a TFTP server and boot the first received file",
  78         "[loadAddress]\n"
  79         "Listen for an incoming TFTP transfer, receive a file and boot it.\n"
  80         "The transfer is aborted if a transfer has not been started after\n"
  81         "about 50 seconds or if Ctrl-C is pressed."
  82 );
  83 #endif
  84
  85
  86 #ifdef CONFIG_CMD_RARP
  87 int do_rarpb(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
  88 {
  89         return netboot_common(RARP, cmdtp, argc, argv);
  90 }
  91
  92 U_BOOT_CMD(
  93         rarpboot,       3,      1,      do_rarpb,
  94         "boot image via network using RARP/TFTP protocol",
  95         "[loadAddress] [[hostIPaddr:]bootfilename]"
  96 );
  97 #endif
  98
  99 #if defined(CONFIG_CMD_DHCP)
 100 static int do_dhcp(struct cmd_tbl *cmdtp, int flag, int argc,
 101                    char *const argv[])
 102 {
 103         return netboot_common(DHCP, cmdtp, argc, argv);
 104 }
 105
 106 U_BOOT_CMD(
 107         dhcp,   3,      1,      do_dhcp,
 108         "boot image via network using DHCP/TFTP protocol",
 109         "[loadAddress] [[hostIPaddr:]bootfilename]"
 110 );
 111 #endif
 112
 113 #if defined(CONFIG_CMD_NFS)
 114 static int do_nfs(struct cmd_tbl *cmdtp, int flag, int argc,
 115                   char *const argv[])
 116 {
 117         return netboot_common(NFS, cmdtp, argc, argv);
 118 }
 119
 120 U_BOOT_CMD(
 121         nfs,    3,      1,      do_nfs,
 122         "boot image via network using NFS protocol",
 123         "[loadAddress] [[hostIPaddr:]bootfilename]"
 124 );
 125 #endif
 126
 127 static void netboot_update_env(void)
 128 {
 129         char tmp[22];
 130
 131         if (net_gateway.s_addr) {
 132                 ip_to_string(net_gateway, tmp);
 133                 env_set("gatewayip", tmp);
 134         }
 135
 136         if (net_netmask.s_addr) {
 137                 ip_to_string(net_netmask, tmp);
 138                 env_set("netmask", tmp);
 139         }
 140
 141 #ifdef CONFIG_CMD_BOOTP
 142         if (net_hostname[0])
 143                 env_set("hostname", net_hostname);
 144 #endif
 145
 146 #ifdef CONFIG_CMD_BOOTP
 147         if (net_root_path[0])
 148                 env_set("rootpath", net_root_path);
 149 #endif
 150
 151         if (net_ip.s_addr) {
 152                 ip_to_string(net_ip, tmp);
 153                 env_set("ipaddr", tmp);
 154         }
 155         /*
 156          * Only attempt to change serverip if net/bootp.c:store_net_params()
 157          * could have set it
 158          */
 159         if (!IS_ENABLED(CONFIG_BOOTP_SERVERIP) && net_server_ip.s_addr) {
 160                 ip_to_string(net_server_ip, tmp);
 161                 env_set("serverip", tmp);
 162         }
 163         if (net_dns_server.s_addr) {
 164                 ip_to_string(net_dns_server, tmp);
 165                 env_set("dnsip", tmp);
 166         }
 167 #if defined(CONFIG_BOOTP_DNS2)
 168         if (net_dns_server2.s_addr) {
 169                 ip_to_string(net_dns_server2, tmp);
 170                 env_set("dnsip2", tmp);
 171         }
 172 #endif
 173 #ifdef CONFIG_CMD_BOOTP
 174         if (net_nis_domain[0])
 175                 env_set("domain", net_nis_domain);
 176 #endif
 177
 178 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_TIMEOFFSET)
 179         if (net_ntp_time_offset) {
 180                 sprintf(tmp, "%d", net_ntp_time_offset);
 181                 env_set("timeoffset", tmp);
 182         }
 183 #endif
 184 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_NTPSERVER)
 185         if (net_ntp_server.s_addr) {
 186                 ip_to_string(net_ntp_server, tmp);
 187                 env_set("ntpserverip", tmp);
 188         }
 189 #endif
 190 }
 191
 192 /**
 193  * parse_addr_size() - parse address and size arguments for tftpput
 194  *
 195  * @argv:       command line arguments
 196  * Return:      0 on success
 197  */
 198 static int parse_addr_size(char * const argv[])
 199 {
 200         if (strict_strtoul(argv[1], 16, &image_save_addr) < 0 ||
 201             strict_strtoul(argv[2], 16, &image_save_size) < 0) {
 202                 printf("Invalid address/size\n");
 203                 return CMD_RET_USAGE;
 204         }
 205         return 0;
 206 }
 207
 208 /**
 209  * parse_args() - parse command line arguments
 210  *
 211  * @proto:      command prototype
 212  * @argc:       number of arguments
 213  * @argv:       command line arguments
 214  * Return:      0 on success
 215  */
 216 static int parse_args(enum proto_t proto, int argc, char *const argv[])
 217 {
 218         ulong addr;
 219         char *end;
 220
 221         switch (argc) {
 222         case 1:
 223                 if (CONFIG_IS_ENABLED(CMD_TFTPPUT) && proto == TFTPPUT)
 224                         return 1;
 225
 226                 /* refresh bootfile name from env */
 227                 copy_filename(net_boot_file_name, env_get("bootfile"),
 228                               sizeof(net_boot_file_name));
 229                 break;
 230
 231         case 2:
 232                 if (CONFIG_IS_ENABLED(CMD_TFTPPUT) && proto == TFTPPUT)
 233                         return 1;
 234                 /*
 235                  * Only one arg - accept two forms:
 236                  * Just load address, or just boot file name. The latter
 237                  * form must be written in a format which can not be
 238                  * mis-interpreted as a valid number.
 239                  */
 240                 addr = hextoul(argv[1], &end);
 241                 if (end == (argv[1] + strlen(argv[1]))) {
 242                         image_load_addr = addr;
 243                         /* refresh bootfile name from env */
 244                         copy_filename(net_boot_file_name, env_get("bootfile"),
 245                                       sizeof(net_boot_file_name));
 246                 } else {
 247                         net_boot_file_name_explicit = true;
 248                         copy_filename(net_boot_file_name, argv[1],
 249                                       sizeof(net_boot_file_name));
 250                 }
 251                 break;
 252
 253         case 3:
 254                 if (CONFIG_IS_ENABLED(CMD_TFTPPUT) && proto == TFTPPUT) {
 255                         if (parse_addr_size(argv))
 256                                 return 1;
 257                 } else {
 258                         image_load_addr = hextoul(argv[1], NULL);
 259                         net_boot_file_name_explicit = true;
 260                         copy_filename(net_boot_file_name, argv[2],
 261                                       sizeof(net_boot_file_name));
 262                 }
 263                 break;
 264
 265 #ifdef CONFIG_CMD_TFTPPUT
 266         case 4:
 267                 if (parse_addr_size(argv))
 268                         return 1;
 269                 net_boot_file_name_explicit = true;
 270                 copy_filename(net_boot_file_name, argv[3],
 271                               sizeof(net_boot_file_name));
 272                 break;
 273 #endif
 274         default:
 275                 return 1;
 276         }
 277         return 0;
 278 }
 279
 280 static int netboot_common(enum proto_t proto, struct cmd_tbl *cmdtp, int argc,
 281                           char *const argv[])
 282 {
 283         char *s;
 284         int   rcode = 0;
 285         int   size;
 286
 287         net_boot_file_name_explicit = false;
 288         *net_boot_file_name = '\0';
 289
 290         /* pre-set image_load_addr */
 291         s = env_get("loadaddr");
 292         if (s != NULL)
 293                 image_load_addr = hextoul(s, NULL);
 294
 295         if (parse_args(proto, argc, argv)) {
 296                 bootstage_error(BOOTSTAGE_ID_NET_START);
 297                 return CMD_RET_USAGE;
 298         }
 299
 300         bootstage_mark(BOOTSTAGE_ID_NET_START);
 301
 302         size = net_loop(proto);
 303         if (size < 0) {
 304                 bootstage_error(BOOTSTAGE_ID_NET_NETLOOP_OK);
 305                 return CMD_RET_FAILURE;
 306         }
 307         bootstage_mark(BOOTSTAGE_ID_NET_NETLOOP_OK);
 308
 309         /* net_loop ok, update environment */
 310         netboot_update_env();
 311
 312         /* done if no file was loaded (no errors though) */
 313         if (size == 0) {
 314                 bootstage_error(BOOTSTAGE_ID_NET_LOADED);
 315                 return CMD_RET_SUCCESS;
 316         }
 317
 318         bootstage_mark(BOOTSTAGE_ID_NET_LOADED);
 319
 320         rcode = bootm_maybe_autostart(cmdtp, argv[0]);
 321
 322         if (rcode == CMD_RET_SUCCESS)
 323                 bootstage_mark(BOOTSTAGE_ID_NET_DONE);
 324         else
 325                 bootstage_error(BOOTSTAGE_ID_NET_DONE_ERR);
 326         return rcode;
 327 }
 328
 329 #if defined(CONFIG_CMD_PING)
 330 static int do_ping(struct cmd_tbl *cmdtp, int flag, int argc,
 331                    char *const argv[])
 332 {
 333         if (argc < 2)
 334                 return CMD_RET_USAGE;
 335
 336         net_ping_ip = string_to_ip(argv[1]);
 337         if (net_ping_ip.s_addr == 0)
 338                 return CMD_RET_USAGE;
 339
 340         if (net_loop(PING) < 0) {
 341                 printf("ping failed; host %s is not alive\n", argv[1]);
 342                 return CMD_RET_FAILURE;
 343         }
 344
 345         printf("host %s is alive\n", argv[1]);
 346
 347         return CMD_RET_SUCCESS;
 348 }
 349
 350 U_BOOT_CMD(
 351         ping,   2,      1,      do_ping,
 352         "send ICMP ECHO_REQUEST to network host",
 353         "pingAddress"
 354 );
 355 #endif
 356
 357 #if defined(CONFIG_CMD_CDP)
 358
 359 static void cdp_update_env(void)
 360 {
 361         char tmp[16];
 362
 363         if (cdp_appliance_vlan != htons(-1)) {
 364                 printf("CDP offered appliance VLAN %d\n",
 365                        ntohs(cdp_appliance_vlan));
 366                 vlan_to_string(cdp_appliance_vlan, tmp);
 367                 env_set("vlan", tmp);
 368                 net_our_vlan = cdp_appliance_vlan;
 369         }
 370
 371         if (cdp_native_vlan != htons(-1)) {
 372                 printf("CDP offered native VLAN %d\n", ntohs(cdp_native_vlan));
 373                 vlan_to_string(cdp_native_vlan, tmp);
 374                 env_set("nvlan", tmp);
 375                 net_native_vlan = cdp_native_vlan;
 376         }
 377 }
 378
 379 int do_cdp(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 380 {
 381         int r;
 382
 383         r = net_loop(CDP);
 384         if (r < 0) {
 385                 printf("cdp failed; perhaps not a CISCO switch?\n");
 386                 return CMD_RET_FAILURE;
 387         }
 388
 389         cdp_update_env();
 390
 391         return CMD_RET_SUCCESS;
 392 }
 393
 394 U_BOOT_CMD(
 395         cdp,    1,      1,      do_cdp,
 396         "Perform CDP network configuration",
 397         "\n"
 398 );
 399 #endif
 400
 401 #if defined(CONFIG_CMD_SNTP)
 402 static struct udp_ops sntp_ops = {
 403         .prereq = sntp_prereq,
 404         .start = sntp_start,
 405         .data = NULL,
 406 };
 407
 408 int do_sntp(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 409 {
 410         char *toff;
 411
 412         if (argc < 2) {
 413                 net_ntp_server = env_get_ip("ntpserverip");
 414                 if (net_ntp_server.s_addr == 0) {
 415                         printf("ntpserverip not set\n");
 416                         return CMD_RET_FAILURE;
 417                 }
 418         } else {
 419                 net_ntp_server = string_to_ip(argv[1]);
 420                 if (net_ntp_server.s_addr == 0) {
 421                         printf("Bad NTP server IP address\n");
 422                         return CMD_RET_FAILURE;
 423                 }
 424         }
 425
 426         toff = env_get("timeoffset");
 427         if (toff == NULL)
 428                 net_ntp_time_offset = 0;
 429         else
 430                 net_ntp_time_offset = simple_strtol(toff, NULL, 10);
 431
 432         if (udp_loop(&sntp_ops) < 0) {
 433                 printf("SNTP failed: host %pI4 not responding\n",
 434                        &net_ntp_server);
 435                 return CMD_RET_FAILURE;
 436         }
 437
 438         return CMD_RET_SUCCESS;
 439 }
 440
 441 U_BOOT_CMD(
 442         sntp,   2,      1,      do_sntp,
 443         "synchronize RTC via network",
 444         "[NTP server IP]\n"
 445 );
 446 #endif
 447
 448 #if defined(CONFIG_CMD_DNS)
 449 int do_dns(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 450 {
 451         if (argc == 1)
 452                 return CMD_RET_USAGE;
 453
 454         /*
 455          * We should check for a valid hostname:
 456          * - Each label must be between 1 and 63 characters long
 457          * - the entire hostname has a maximum of 255 characters
 458          * - only the ASCII letters 'a' through 'z' (case-insensitive),
 459          *   the digits '0' through '9', and the hyphen
 460          * - cannot begin or end with a hyphen
 461          * - no other symbols, punctuation characters, or blank spaces are
 462          *   permitted
 463          * but hey - this is a minimalist implmentation, so only check length
 464          * and let the name server deal with things.
 465          */
 466         if (strlen(argv[1]) >= 255) {
 467                 printf("dns error: hostname too long\n");
 468                 return CMD_RET_FAILURE;
 469         }
 470
 471         net_dns_resolve = argv[1];
 472
 473         if (argc == 3)
 474                 net_dns_env_var = argv[2];
 475         else
 476                 net_dns_env_var = NULL;
 477
 478         if (net_loop(DNS) < 0) {
 479                 printf("dns lookup of %s failed, check setup\n", argv[1]);
 480                 return CMD_RET_FAILURE;
 481         }
 482
 483         return CMD_RET_SUCCESS;
 484 }
 485
 486 U_BOOT_CMD(
 487         dns,    3,      1,      do_dns,
 488         "lookup the IP of a hostname",
 489         "hostname [envvar]"
 490 );
 491
 492 #endif  /* CONFIG_CMD_DNS */
 493
 494 #if defined(CONFIG_CMD_LINK_LOCAL)
 495 static int do_link_local(struct cmd_tbl *cmdtp, int flag, int argc,
 496                          char *const argv[])
 497 {
 498         char tmp[22];
 499
 500         if (net_loop(LINKLOCAL) < 0)
 501                 return CMD_RET_FAILURE;
 502
 503         net_gateway.s_addr = 0;
 504         ip_to_string(net_gateway, tmp);
 505         env_set("gatewayip", tmp);
 506
 507         ip_to_string(net_netmask, tmp);
 508         env_set("netmask", tmp);
 509
 510         ip_to_string(net_ip, tmp);
 511         env_set("ipaddr", tmp);
 512         env_set("llipaddr", tmp); /* store this for next time */
 513
 514         return CMD_RET_SUCCESS;
 515 }
 516
 517 U_BOOT_CMD(
 518         linklocal,      1,      1,      do_link_local,
 519         "acquire a network IP address using the link-local protocol",
 520         ""
 521 );
 522
 523 #endif  /* CONFIG_CMD_LINK_LOCAL */
 524
 525 #ifdef CONFIG_DM_ETH
 526 static int do_net_list(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 527 {
 528         const struct udevice *current = eth_get_dev();
 529         unsigned char env_enetaddr[ARP_HLEN];
 530         const struct udevice *dev;
 531         struct uclass *uc;
 532
 533         uclass_id_foreach_dev(UCLASS_ETH, dev, uc) {
 534                 eth_env_get_enetaddr_by_index("eth", dev_seq(dev), env_enetaddr);
 535                 printf("eth%d : %s %pM %s\n", dev_seq(dev), dev->name, env_enetaddr,
 536                        current == dev ? "active" : "");
 537         }
 538         return CMD_RET_SUCCESS;
 539 }
 540
 541 static struct cmd_tbl cmd_net[] = {
 542         U_BOOT_CMD_MKENT(list, 1, 0, do_net_list, "", ""),
 543 };
 544
 545 static int do_net(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 546 {
 547         struct cmd_tbl *cp;
 548
 549         cp = find_cmd_tbl(argv[1], cmd_net, ARRAY_SIZE(cmd_net));
 550
 551         /* Drop the net command */
 552         argc--;
 553         argv++;
 554
 555         if (!cp || argc > cp->maxargs)
 556                 return CMD_RET_USAGE;
 557         if (flag == CMD_FLAG_REPEAT && !cmd_is_repeatable(cp))
 558                 return CMD_RET_SUCCESS;
 559
 560         return cp->cmd(cmdtp, flag, argc, argv);
 561 }
 562
 563 U_BOOT_CMD(
 564         net, 2, 1, do_net,
 565         "NET sub-system",
 566         "list - list available devices\n"
 567 );
 568 #endif // CONFIG_DM_ETH