cmd/pxe.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright 2010-2011 Calxeda, Inc.
   4  * Copyright (c) 2014, NVIDIA CORPORATION.  All rights reserved.
   5  */
   6
   7 #include <common.h>
   8 #include <command.h>
   9 #include <fs.h>
  10 #include <net.h>
  11
  12 #include "pxe_utils.h"
  13
  14 #ifdef CONFIG_CMD_NET
  15 const char *pxe_default_paths[] = {
  16 #ifdef CONFIG_SYS_SOC
  17 #ifdef CONFIG_SYS_BOARD
  18         "default-" CONFIG_SYS_ARCH "-" CONFIG_SYS_SOC "-" CONFIG_SYS_BOARD,
  19 #endif
  20         "default-" CONFIG_SYS_ARCH "-" CONFIG_SYS_SOC,
  21 #endif
  22         "default-" CONFIG_SYS_ARCH,
  23         "default",
  24         NULL
  25 };
  26
  27 static int do_get_tftp(struct pxe_context *ctx, const char *file_path,
  28                        char *file_addr)
  29 {
  30         char *tftp_argv[] = {"tftp", NULL, NULL, NULL};
  31
  32         tftp_argv[1] = file_addr;
  33         tftp_argv[2] = (void *)file_path;
  34
  35         if (do_tftpb(ctx->cmdtp, 0, 3, tftp_argv))
  36                 return -ENOENT;
  37
  38         return 1;
  39 }
  40
  41 /*
  42  * Looks for a pxe file with a name based on the pxeuuid environment variable.
  43  *
  44  * Returns 1 on success or < 0 on error.
  45  */
  46 static int pxe_uuid_path(struct pxe_context *ctx, unsigned long pxefile_addr_r)
  47 {
  48         char *uuid_str;
  49
  50         uuid_str = from_env("pxeuuid");
  51
  52         if (!uuid_str)
  53                 return -ENOENT;
  54
  55         return get_pxelinux_path(ctx, uuid_str, pxefile_addr_r);
  56 }
  57
  58 /*
  59  * Looks for a pxe file with a name based on the 'ethaddr' environment
  60  * variable.
  61  *
  62  * Returns 1 on success or < 0 on error.
  63  */
  64 static int pxe_mac_path(struct pxe_context *ctx, unsigned long pxefile_addr_r)
  65 {
  66         char mac_str[21];
  67         int err;
  68
  69         err = format_mac_pxe(mac_str, sizeof(mac_str));
  70
  71         if (err < 0)
  72                 return err;
  73
  74         return get_pxelinux_path(ctx, mac_str, pxefile_addr_r);
  75 }
  76
  77 /*
  78  * Looks for pxe files with names based on our IP address. See pxelinux
  79  * documentation for details on what these file names look like.  We match
  80  * that exactly.
  81  *
  82  * Returns 1 on success or < 0 on error.
  83  */
  84 static int pxe_ipaddr_paths(struct pxe_context *ctx, unsigned long pxefile_addr_r)
  85 {
  86         char ip_addr[9];
  87         int mask_pos, err;
  88
  89         sprintf(ip_addr, "%08X", ntohl(net_ip.s_addr));
  90
  91         for (mask_pos = 7; mask_pos >= 0;  mask_pos--) {
  92                 err = get_pxelinux_path(ctx, ip_addr, pxefile_addr_r);
  93
  94                 if (err > 0)
  95                         return err;
  96
  97                 ip_addr[mask_pos] = '\0';
  98         }
  99
 100         return -ENOENT;
 101 }
 102 /*
 103  * Entry point for the 'pxe get' command.
 104  * This Follows pxelinux's rules to download a config file from a tftp server.
 105  * The file is stored at the location given by the pxefile_addr_r environment
 106  * variable, which must be set.
 107  *
 108  * UUID comes from pxeuuid env variable, if defined
 109  * MAC addr comes from ethaddr env variable, if defined
 110  * IP
 111  *
 112  * see http://syslinux.zytor.com/wiki/index.php/PXELINUX
 113  *
 114  * Returns 0 on success or 1 on error.
 115  */
 116 static int
 117 do_pxe_get(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 118 {
 119         char *pxefile_addr_str;
 120         unsigned long pxefile_addr_r;
 121         struct pxe_context ctx;
 122         int err, i = 0;
 123
 124         if (argc != 1)
 125                 return CMD_RET_USAGE;
 126
 127         pxefile_addr_str = from_env("pxefile_addr_r");
 128
 129         if (!pxefile_addr_str)
 130                 return 1;
 131
 132         err = strict_strtoul(pxefile_addr_str, 16,
 133                              (unsigned long *)&pxefile_addr_r);
 134         if (err < 0)
 135                 return 1;
 136
 137         if (pxe_setup_ctx(&ctx, cmdtp, do_get_tftp, NULL, false,
 138                           env_get("bootfile"))) {
 139                 printf("Out of memory\n");
 140                 return CMD_RET_FAILURE;
 141         }
 142         /*
 143          * Keep trying paths until we successfully get a file we're looking
 144          * for.
 145          */
 146         if (pxe_uuid_path(&ctx, pxefile_addr_r) > 0 ||
 147             pxe_mac_path(&ctx, pxefile_addr_r) > 0 ||
 148             pxe_ipaddr_paths(&ctx, pxefile_addr_r) > 0) {
 149                 printf("Config file found\n");
 150                 pxe_destroy_ctx(&ctx);
 151
 152                 return 0;
 153         }
 154
 155         while (pxe_default_paths[i]) {
 156                 if (get_pxelinux_path(&ctx, pxe_default_paths[i],
 157                                       pxefile_addr_r) > 0) {
 158                         printf("Config file found\n");
 159                         pxe_destroy_ctx(&ctx);
 160                         return 0;
 161                 }
 162                 i++;
 163         }
 164
 165         printf("Config file not found\n");
 166         pxe_destroy_ctx(&ctx);
 167
 168         return 1;
 169 }
 170
 171 /*
 172  * Boots a system using a pxe file
 173  *
 174  * Returns 0 on success, 1 on error.
 175  */
 176 static int
 177 do_pxe_boot(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 178 {
 179         unsigned long pxefile_addr_r;
 180         char *pxefile_addr_str;
 181         struct pxe_context ctx;
 182         int ret;
 183
 184         if (argc == 1) {
 185                 pxefile_addr_str = from_env("pxefile_addr_r");
 186                 if (!pxefile_addr_str)
 187                         return 1;
 188
 189         } else if (argc == 2) {
 190                 pxefile_addr_str = argv[1];
 191         } else {
 192                 return CMD_RET_USAGE;
 193         }
 194
 195         if (strict_strtoul(pxefile_addr_str, 16, &pxefile_addr_r) < 0) {
 196                 printf("Invalid pxefile address: %s\n", pxefile_addr_str);
 197                 return 1;
 198         }
 199
 200         if (pxe_setup_ctx(&ctx, cmdtp, do_get_tftp, NULL, false,
 201                           env_get("bootfile"))) {
 202                 printf("Out of memory\n");
 203                 return CMD_RET_FAILURE;
 204         }
 205         ret = pxe_process(&ctx, pxefile_addr_r, false);
 206         pxe_destroy_ctx(&ctx);
 207         if (ret)
 208                 return CMD_RET_FAILURE;
 209
 210         copy_filename(net_boot_file_name, "", sizeof(net_boot_file_name));
 211
 212         return 0;
 213 }
 214
 215 static struct cmd_tbl cmd_pxe_sub[] = {
 216         U_BOOT_CMD_MKENT(get, 1, 1, do_pxe_get, "", ""),
 217         U_BOOT_CMD_MKENT(boot, 2, 1, do_pxe_boot, "", "")
 218 };
 219
 220 static void __maybe_unused pxe_reloc(void)
 221 {
 222         static int relocated_pxe;
 223
 224         if (!relocated_pxe) {
 225                 fixup_cmdtable(cmd_pxe_sub, ARRAY_SIZE(cmd_pxe_sub));
 226                 relocated_pxe = 1;
 227         }
 228 }
 229
 230 static int do_pxe(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 231 {
 232         struct cmd_tbl *cp;
 233
 234 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 235         pxe_reloc();
 236 #endif
 237
 238         if (argc < 2)
 239                 return CMD_RET_USAGE;
 240
 241         /* drop initial "pxe" arg */
 242         argc--;
 243         argv++;
 244
 245         cp = find_cmd_tbl(argv[0], cmd_pxe_sub, ARRAY_SIZE(cmd_pxe_sub));
 246
 247         if (cp)
 248                 return cp->cmd(cmdtp, flag, argc, argv);
 249
 250         return CMD_RET_USAGE;
 251 }
 252
 253 U_BOOT_CMD(pxe, 3, 1, do_pxe,
 254            "commands to get and boot from pxe files",
 255            "get - try to retrieve a pxe file using tftp\n"
 256            "pxe boot [pxefile_addr_r] - boot from the pxe file at pxefile_addr_r\n"
 257 );
 258 #endif