Quite a lot of the code in common/relates to booting and images. Before adding more it seems like a good time to move the code into its own directory.

Most files with 'boot' or 'image' in them are moved, except:

- autoboot.c which relates to U-Boot automatically running a script - bootstage.c which relates to U-Boot timing

Drop the removal of boot* files from the output directory, since this interfers with the symlinks created by tools and there does not appear to be any such file from my brief testing.

Signed-off-by: Simon Glass sjg@chromium.org ---

Kconfig | 2 ++ Makefile | 3 ++- README | 1 + common/Kconfig.boot => boot/Kconfig | 0 boot/Makefile | 34 +++++++++++++++++++++++++++++ {common => boot}/android_ab.c | 0 {common => boot}/boot_fit.c | 0 {common => boot}/bootm.c | 0 {common => boot}/bootm_os.c | 0 {common => boot}/bootretry.c | 0 {common => boot}/common_fit.c | 0 {common => boot}/fdt_region.c | 0 {common => boot}/image-android-dt.c | 0 {common => boot}/image-android.c | 0 {common => boot}/image-cipher.c | 0 {common => boot}/image-fdt.c | 0 {common => boot}/image-fit-sig.c | 0 {common => boot}/image-fit.c | 0 {common => boot}/image-sig.c | 0 {common => boot}/image.c | 0 common/Kconfig | 2 -- common/Makefile | 22 ------------------- doc/android/boot-image.rst | 2 +- scripts/Makefile.spl | 4 ++-- tools/Makefile | 16 +++++++------- 25 files changed, 50 insertions(+), 36 deletions(-) rename common/Kconfig.boot => boot/Kconfig (100%) create mode 100644 boot/Makefile rename {common => boot}/android_ab.c (100%) rename {common => boot}/boot_fit.c (100%) rename {common => boot}/bootm.c (100%) rename {common => boot}/bootm_os.c (100%) rename {common => boot}/bootretry.c (100%) rename {common => boot}/common_fit.c (100%) rename {common => boot}/fdt_region.c (100%) rename {common => boot}/image-android-dt.c (100%) rename {common => boot}/image-android.c (100%) rename {common => boot}/image-cipher.c (100%) rename {common => boot}/image-fdt.c (100%) rename {common => boot}/image-fit-sig.c (100%) rename {common => boot}/image-fit.c (100%) rename {common => boot}/image-sig.c (100%) rename {common => boot}/image.c (100%)

diff --git a/Kconfig b/Kconfig index a6c42b902f7..56ae57930f3 100644 --- a/Kconfig +++ b/Kconfig @@ -455,6 +455,8 @@ endmenu # General setup

source "api/Kconfig"

+source "boot/Kconfig" + source "common/Kconfig"

source "cmd/Kconfig" diff --git a/Makefile b/Makefile index 3c8437d21af..3a50ad2188e 100644 --- a/Makefile +++ b/Makefile @@ -804,6 +804,7 @@ HAVE_VENDOR_COMMON_LIB = $(if $(wildcard $(srctree)/board/$(VENDOR)/common/Makef

libs-$(CONFIG_API) += api/ libs-$(HAVE_VENDOR_COMMON_LIB) += board/$(VENDOR)/common/ +libs-y += boot/ libs-y += cmd/ libs-y += common/ libs-$(CONFIG_OF_EMBED) += dts/ @@ -2092,7 +2093,7 @@ CLEAN_DIRS += $(MODVERDIR) \ $(filter-out include, $(shell ls -1 $d 2>/dev/null))))

CLEAN_FILES += include/bmp_logo.h include/bmp_logo_data.h tools/version.h \ - boot* u-boot* MLO* SPL System.map fit-dtb.blob* \ + u-boot* MLO* SPL System.map fit-dtb.blob* \ u-boot-ivt.img.log u-boot-dtb.imx.log SPL.log u-boot.imx.log \ lpc32xx-* bl31.c bl31.elf bl31_*.bin image.map tispl.bin* \ idbloader.img flash.bin flash.log defconfig keep-syms-lto.c diff --git a/README b/README index 1c1db980987..1a74616d60e 100644 --- a/README +++ b/README @@ -144,6 +144,7 @@ Directory Hierarchy: /xtensa Files generic to Xtensa architecture /api Machine/arch-independent API for external apps /board Board-dependent files +/boot Support for images and booting /cmd U-Boot commands functions /common Misc architecture-independent functions /configs Board default configuration files diff --git a/common/Kconfig.boot b/boot/Kconfig similarity index 100% rename from common/Kconfig.boot rename to boot/Kconfig diff --git a/boot/Makefile b/boot/Makefile new file mode 100644 index 00000000000..57d26346afb --- /dev/null +++ b/boot/Makefile @@ -0,0 +1,34 @@ +# SPDX-License-Identifier: GPL-2.0+ +# +# (C) Copyright 2004-2006 +# Wolfgang Denk, DENX Software Engineering, wd@denx.de. + +ifndef CONFIG_SPL_BUILD + +# This option is not just y/n - it can have a numeric value +ifdef CONFIG_BOOT_RETRY_TIME +obj-y += bootretry.o +endif + +obj-$(CONFIG_CMD_BOOTM) += bootm.o bootm_os.o +obj-$(CONFIG_CMD_BOOTZ) += bootm.o bootm_os.o +obj-$(CONFIG_CMD_BOOTI) += bootm.o bootm_os.o + +endif + +obj-y += image.o +obj-$(CONFIG_ANDROID_AB) += android_ab.o +obj-$(CONFIG_ANDROID_BOOT_IMAGE) += image-android.o image-android-dt.o +obj-$(CONFIG_$(SPL_TPL_)OF_LIBFDT) += image-fdt.o +obj-$(CONFIG_$(SPL_TPL_)FIT_SIGNATURE) += fdt_region.o +obj-$(CONFIG_$(SPL_TPL_)FIT) += image-fit.o +obj-$(CONFIG_$(SPL_)MULTI_DTB_FIT) += boot_fit.o common_fit.o +obj-$(CONFIG_$(SPL_TPL_)IMAGE_SIGN_INFO) += image-sig.o +obj-$(CONFIG_$(SPL_TPL_)FIT_SIGNATURE) += image-fit-sig.o +obj-$(CONFIG_$(SPL_TPL_)FIT_CIPHER) += image-cipher.o + +obj-$(CONFIG_CMD_ADTIMG) += image-android-dt.o + +ifdef CONFIG_SPL_BUILD +obj-$(CONFIG_SPL_LOAD_FIT) += common_fit.o +endif diff --git a/common/android_ab.c b/boot/android_ab.c similarity index 100% rename from common/android_ab.c rename to boot/android_ab.c diff --git a/common/boot_fit.c b/boot/boot_fit.c similarity index 100% rename from common/boot_fit.c rename to boot/boot_fit.c diff --git a/common/bootm.c b/boot/bootm.c similarity index 100% rename from common/bootm.c rename to boot/bootm.c diff --git a/common/bootm_os.c b/boot/bootm_os.c similarity index 100% rename from common/bootm_os.c rename to boot/bootm_os.c diff --git a/common/bootretry.c b/boot/bootretry.c similarity index 100% rename from common/bootretry.c rename to boot/bootretry.c diff --git a/common/common_fit.c b/boot/common_fit.c similarity index 100% rename from common/common_fit.c rename to boot/common_fit.c diff --git a/common/fdt_region.c b/boot/fdt_region.c similarity index 100% rename from common/fdt_region.c rename to boot/fdt_region.c diff --git a/common/image-android-dt.c b/boot/image-android-dt.c similarity index 100% rename from common/image-android-dt.c rename to boot/image-android-dt.c diff --git a/common/image-android.c b/boot/image-android.c similarity index 100% rename from common/image-android.c rename to boot/image-android.c diff --git a/common/image-cipher.c b/boot/image-cipher.c similarity index 100% rename from common/image-cipher.c rename to boot/image-cipher.c diff --git a/common/image-fdt.c b/boot/image-fdt.c similarity index 100% rename from common/image-fdt.c rename to boot/image-fdt.c diff --git a/common/image-fit-sig.c b/boot/image-fit-sig.c similarity index 100% rename from common/image-fit-sig.c rename to boot/image-fit-sig.c diff --git a/common/image-fit.c b/boot/image-fit.c similarity index 100% rename from common/image-fit.c rename to boot/image-fit.c diff --git a/common/image-sig.c b/boot/image-sig.c similarity index 100% rename from common/image-sig.c rename to boot/image-sig.c diff --git a/common/image.c b/boot/image.c similarity index 100% rename from common/image.c rename to boot/image.c diff --git a/common/Kconfig b/common/Kconfig index 2ab20a6c85b..f8afa2ceff1 100644 --- a/common/Kconfig +++ b/common/Kconfig @@ -1,5 +1,3 @@ -source "common/Kconfig.boot" - menu "Console"

config MENU diff --git a/common/Makefile b/common/Makefile index 9063ed93910..de993700dd5 100644 --- a/common/Makefile +++ b/common/Makefile @@ -12,21 +12,12 @@ obj-$(CONFIG_HASH) += hash.o obj-$(CONFIG_HUSH_PARSER) += cli_hush.o obj-$(CONFIG_AUTOBOOT) += autoboot.o

-# This option is not just y/n - it can have a numeric value -ifdef CONFIG_BOOT_RETRY_TIME -obj-y += bootretry.o -endif - # # boards obj-y += board_f.o obj-y += board_r.o obj-$(CONFIG_DISPLAY_BOARDINFO) += board_info.o obj-$(CONFIG_DISPLAY_BOARDINFO_LATE) += board_info.o

-obj-$(CONFIG_CMD_BOOTM) += bootm.o bootm_os.o -obj-$(CONFIG_CMD_BOOTZ) += bootm.o bootm_os.o -obj-$(CONFIG_CMD_BOOTI) += bootm.o bootm_os.o - obj-$(CONFIG_CMD_BEDBUG) += bedbug.o obj-$(CONFIG_$(SPL_TPL_)OF_LIBFDT) += fdt_support.o obj-$(CONFIG_MII) += miiphyutil.o @@ -68,7 +59,6 @@ obj-$(CONFIG_DFU_OVER_USB) += dfu.o endif obj-$(CONFIG_SPL_HASH_SUPPORT) += hash.o obj-$(CONFIG_TPL_HASH_SUPPORT) += hash.o -obj-$(CONFIG_SPL_LOAD_FIT) += common_fit.o obj-$(CONFIG_SPL_NET_SUPPORT) += miiphyutil.o obj-$(CONFIG_$(SPL_TPL_)OF_LIBFDT) += fdt_support.o

@@ -104,22 +94,10 @@ obj-y += malloc_simple.o endif endif

-obj-y += image.o -obj-$(CONFIG_ANDROID_AB) += android_ab.o -obj-$(CONFIG_ANDROID_BOOT_IMAGE) += image-android.o image-android-dt.o -obj-$(CONFIG_$(SPL_TPL_)OF_LIBFDT) += image-fdt.o -obj-$(CONFIG_$(SPL_TPL_)FIT_SIGNATURE) += fdt_region.o -obj-$(CONFIG_$(SPL_TPL_)FIT) += image-fit.o -obj-$(CONFIG_$(SPL_)MULTI_DTB_FIT) += boot_fit.o common_fit.o -obj-$(CONFIG_$(SPL_TPL_)IMAGE_SIGN_INFO) += image-sig.o -obj-$(CONFIG_$(SPL_TPL_)FIT_SIGNATURE) += image-fit-sig.o -obj-$(CONFIG_$(SPL_TPL_)FIT_CIPHER) += image-cipher.o obj-$(CONFIG_IO_TRACE) += iotrace.o obj-y += memsize.o obj-y += stdio.o

-obj-$(CONFIG_CMD_ADTIMG) += image-android-dt.o - ifdef CONFIG_CMD_EEPROM_LAYOUT obj-y += eeprom/eeprom_field.o eeprom/eeprom_layout.o endif diff --git a/doc/android/boot-image.rst b/doc/android/boot-image.rst index fa8f2a47ee3..71db02521b0 100644 --- a/doc/android/boot-image.rst +++ b/doc/android/boot-image.rst @@ -139,7 +139,7 @@ overview on the whole Android 10 boot process can be found at [8]_. C API for working with Android Boot Image format ------------------------------------------------

-.. kernel-doc:: common/image-android.c +.. kernel-doc:: boot/image-android.c :internal:

References diff --git a/scripts/Makefile.spl b/scripts/Makefile.spl index 25a3e7fa52e..f2a619e28a7 100644 --- a/scripts/Makefile.spl +++ b/scripts/Makefile.spl @@ -92,10 +92,10 @@ libs-y += common/init/

# Special handling for a few options which support SPL/TPL ifeq ($(CONFIG_TPL_BUILD),y) -libs-$(CONFIG_TPL_LIBCOMMON_SUPPORT) += common/ cmd/ env/ +libs-$(CONFIG_TPL_LIBCOMMON_SUPPORT) += boot/ common/ cmd/ env/ libs-$(CONFIG_TPL_LIBGENERIC_SUPPORT) += lib/ else -libs-$(CONFIG_SPL_LIBCOMMON_SUPPORT) += common/ cmd/ env/ +libs-$(CONFIG_SPL_LIBCOMMON_SUPPORT) += boot/ common/ cmd/ env/ libs-$(CONFIG_SPL_LIBGENERIC_SUPPORT) += lib/ ifdef CONFIG_SPL_FRAMEWORK libs-$(CONFIG_PARTITIONS) += disk/ diff --git a/tools/Makefile b/tools/Makefile index 4a86321f646..2cda7cdd75f 100644 --- a/tools/Makefile +++ b/tools/Makefile @@ -76,9 +76,9 @@ hostprogs-$(CONFIG_TOOLS_LIBCRYPTO) += fit_info fit_check_sign

hostprogs-$(CONFIG_CMD_BOOTEFI_SELFTEST) += file2include

-FIT_OBJS-y := fit_common.o fit_image.o image-host.o common/image-fit.o -FIT_SIG_OBJS-$(CONFIG_TOOLS_LIBCRYPTO) := image-sig-host.o common/image-fit-sig.o -FIT_CIPHER_OBJS-$(CONFIG_TOOLS_LIBCRYPTO) := common/image-cipher.o +FIT_OBJS-y := fit_common.o fit_image.o image-host.o boot/image-fit.o +FIT_SIG_OBJS-$(CONFIG_TOOLS_LIBCRYPTO) := image-sig-host.o boot/image-fit-sig.o +FIT_CIPHER_OBJS-$(CONFIG_TOOLS_LIBCRYPTO) := boot/image-cipher.o

# The following files are synced with upstream DTC. # Use synced versions from scripts/dtc/libfdt/. @@ -106,13 +106,13 @@ dumpimage-mkimage-objs := aisimage.o \ $(FIT_OBJS-y) \ $(FIT_SIG_OBJS-y) \ $(FIT_CIPHER_OBJS-y) \ - common/fdt_region.o \ - common/bootm.o \ + boot/fdt_region.o \ + boot/bootm.o \ lib/crc32.o \ default_image.o \ lib/fdtdec_common.o \ lib/fdtdec.o \ - common/image.o \ + boot/image.o \ imagetool.o \ imximage.o \ imx8image.o \ @@ -226,7 +226,7 @@ hostprogs-$(CONFIG_ARCH_OCTEON) += update_octeon_header update_octeon_header-objs := update_octeon_header.o lib/crc32.o

hostprogs-y += fdtgrep -fdtgrep-objs += $(LIBFDT_OBJS) common/fdt_region.o fdtgrep.o +fdtgrep-objs += $(LIBFDT_OBJS) boot/fdt_region.o fdtgrep.o

ifneq ($(TOOLS_ONLY),y) hostprogs-y += spl_size_limit @@ -253,7 +253,7 @@ HOSTCFLAGS_sha512.o := -pedantic -DCONFIG_SHA512 -DCONFIG_SHA384 quiet_cmd_wrap = WRAP $@ cmd_wrap = echo "#include <../$(patsubst $(obj)/%,%,$@)>" >$@

-$(obj)/lib/%.c $(obj)/common/%.c $(obj)/env/%.c: +$(obj)/boot/%.c $(obj)/common/%.c $(obj)/env/%.c $(obj)/lib/%.c: $(call cmd,wrap)

clean-dirs := lib common

At present the PXE functions pass around a pointer to command-table entry which is very strange. It is only needed in a few places and it is odd to pass around a data structure from another module in this way.

For bootmethod we will need to provide some context information when reading files.

Create a PXE context struct to hold the command-table-entry pointer and pass that around instead. We can then add more things to the context as needed.

Signed-off-by: Simon Glass sjg@chromium.org ---

cmd/pxe.c | 28 +++++++++-------- cmd/pxe_utils.c | 80 ++++++++++++++++++++++++++----------------------- cmd/pxe_utils.h | 43 +++++++++++++++++++------- cmd/sysboot.c | 8 +++-- 4 files changed, 97 insertions(+), 62 deletions(-)

diff --git a/cmd/pxe.c b/cmd/pxe.c index 46ac08fa3a0..17ce54fc049 100644 --- a/cmd/pxe.c +++ b/cmd/pxe.c @@ -43,7 +43,7 @@ static int do_get_tftp(struct cmd_tbl *cmdtp, const char *file_path, * * Returns 1 on success or < 0 on error. */ -static int pxe_uuid_path(struct cmd_tbl *cmdtp, unsigned long pxefile_addr_r) +static int pxe_uuid_path(struct pxe_context *ctx, unsigned long pxefile_addr_r) { char *uuid_str;

@@ -52,7 +52,7 @@ static int pxe_uuid_path(struct cmd_tbl *cmdtp, unsigned long pxefile_addr_r) if (!uuid_str) return -ENOENT;

- return get_pxelinux_path(cmdtp, uuid_str, pxefile_addr_r); + return get_pxelinux_path(ctx, uuid_str, pxefile_addr_r); }

/* @@ -61,7 +61,7 @@ static int pxe_uuid_path(struct cmd_tbl *cmdtp, unsigned long pxefile_addr_r) * * Returns 1 on success or < 0 on error. */ -static int pxe_mac_path(struct cmd_tbl *cmdtp, unsigned long pxefile_addr_r) +static int pxe_mac_path(struct pxe_context *ctx, unsigned long pxefile_addr_r) { char mac_str[21]; int err; @@ -71,7 +71,7 @@ static int pxe_mac_path(struct cmd_tbl *cmdtp, unsigned long pxefile_addr_r) if (err < 0) return err;

- return get_pxelinux_path(cmdtp, mac_str, pxefile_addr_r); + return get_pxelinux_path(ctx, mac_str, pxefile_addr_r); }

/* @@ -81,7 +81,7 @@ static int pxe_mac_path(struct cmd_tbl *cmdtp, unsigned long pxefile_addr_r) * * Returns 1 on success or < 0 on error. */ -static int pxe_ipaddr_paths(struct cmd_tbl *cmdtp, unsigned long pxefile_addr_r) +static int pxe_ipaddr_paths(struct pxe_context *ctx, unsigned long pxefile_addr_r) { char ip_addr[9]; int mask_pos, err; @@ -89,7 +89,7 @@ static int pxe_ipaddr_paths(struct cmd_tbl *cmdtp, unsigned long pxefile_addr_r) sprintf(ip_addr, "%08X", ntohl(net_ip.s_addr));

for (mask_pos = 7; mask_pos >= 0; mask_pos--) { - err = get_pxelinux_path(cmdtp, ip_addr, pxefile_addr_r); + err = get_pxelinux_path(ctx, ip_addr, pxefile_addr_r);

if (err > 0) return err; @@ -118,8 +118,10 @@ do_pxe_get(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) { char *pxefile_addr_str; unsigned long pxefile_addr_r; + struct pxe_context ctx; int err, i = 0;

+ pxe_setup_ctx(&ctx, cmdtp); do_getfile = do_get_tftp;

if (argc != 1) @@ -139,16 +141,16 @@ do_pxe_get(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) * Keep trying paths until we successfully get a file we're looking * for. */ - if (pxe_uuid_path(cmdtp, pxefile_addr_r) > 0 || - pxe_mac_path(cmdtp, pxefile_addr_r) > 0 || - pxe_ipaddr_paths(cmdtp, pxefile_addr_r) > 0) { + if (pxe_uuid_path(&ctx, pxefile_addr_r) > 0 || + pxe_mac_path(&ctx, pxefile_addr_r) > 0 || + pxe_ipaddr_paths(&ctx, pxefile_addr_r) > 0) { printf("Config file found\n");

return 0; }

while (pxe_default_paths[i]) { - if (get_pxelinux_path(cmdtp, pxe_default_paths[i], + if (get_pxelinux_path(&ctx, pxe_default_paths[i], pxefile_addr_r) > 0) { printf("Config file found\n"); return 0; @@ -172,7 +174,9 @@ do_pxe_boot(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) unsigned long pxefile_addr_r; struct pxe_menu *cfg; char *pxefile_addr_str; + struct pxe_context ctx;

+ pxe_setup_ctx(&ctx, cmdtp); do_getfile = do_get_tftp;

if (argc == 1) { @@ -191,14 +195,14 @@ do_pxe_boot(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) return 1; }

- cfg = parse_pxefile(cmdtp, pxefile_addr_r); + cfg = parse_pxefile(&ctx, pxefile_addr_r);

if (!cfg) { printf("Error parsing config file\n"); return 1; }

- handle_pxe_menu(cmdtp, cfg); + handle_pxe_menu(&ctx, cfg);

destroy_pxe_menu(cfg);

diff --git a/cmd/pxe_utils.c b/cmd/pxe_utils.c index d7f4017efeb..280be55d9b3 100644 --- a/cmd/pxe_utils.c +++ b/cmd/pxe_utils.c @@ -105,7 +105,7 @@ int (*do_getfile)(struct cmd_tbl *cmdtp, const char *file_path, * * Returns 1 for success, or < 0 on error. */ -static int get_relfile(struct cmd_tbl *cmdtp, const char *file_path, +static int get_relfile(struct pxe_context *ctx, const char *file_path, unsigned long file_addr) { size_t path_len; @@ -133,10 +133,10 @@ static int get_relfile(struct cmd_tbl *cmdtp, const char *file_path,

sprintf(addr_buf, "%lx", file_addr);

- return do_getfile(cmdtp, relfile, addr_buf); + return do_getfile(ctx->cmdtp, relfile, addr_buf); }

-int get_pxe_file(struct cmd_tbl *cmdtp, const char *file_path, +int get_pxe_file(struct pxe_context *ctx, const char *file_path, unsigned long file_addr) { unsigned long config_file_size; @@ -144,7 +144,7 @@ int get_pxe_file(struct cmd_tbl *cmdtp, const char *file_path, int err; char *buf;

- err = get_relfile(cmdtp, file_path, file_addr); + err = get_relfile(ctx, file_path, file_addr);

if (err < 0) return err; @@ -170,7 +170,7 @@ int get_pxe_file(struct cmd_tbl *cmdtp, const char *file_path,

#define PXELINUX_DIR "pxelinux.cfg/"

-int get_pxelinux_path(struct cmd_tbl *cmdtp, const char *file, +int get_pxelinux_path(struct pxe_context *ctx, const char *file, unsigned long pxefile_addr_r) { size_t base_len = strlen(PXELINUX_DIR); @@ -184,7 +184,7 @@ int get_pxelinux_path(struct cmd_tbl *cmdtp, const char *file,

sprintf(path, PXELINUX_DIR "%s", file);

- return get_pxe_file(cmdtp, path, pxefile_addr_r); + return get_pxe_file(ctx, path, pxefile_addr_r); }

/* @@ -194,7 +194,7 @@ int get_pxelinux_path(struct cmd_tbl *cmdtp, const char *file, * * Returns 1 on success or < 0 on error. */ -static int get_relfile_envaddr(struct cmd_tbl *cmdtp, const char *file_path, +static int get_relfile_envaddr(struct pxe_context *ctx, const char *file_path, const char *envaddr_name) { unsigned long file_addr; @@ -208,7 +208,7 @@ static int get_relfile_envaddr(struct cmd_tbl *cmdtp, const char *file_path, if (strict_strtoul(envaddr, 16, &file_addr) < 0) return -EINVAL;

- return get_relfile(cmdtp, file_path, file_addr); + return get_relfile(ctx, file_path, file_addr); }

/* @@ -317,7 +317,8 @@ static int label_localboot(struct pxe_label *label) * Loads fdt overlays specified in 'fdtoverlays'. */ #ifdef CONFIG_OF_LIBFDT_OVERLAY -static void label_boot_fdtoverlay(struct cmd_tbl *cmdtp, struct pxe_label *label) +static void label_boot_fdtoverlay(struct pxe_context *ctx, + struct pxe_label *label) { char *fdtoverlay = label->fdtoverlays; struct fdt_header *working_fdt; @@ -367,7 +368,7 @@ static void label_boot_fdtoverlay(struct cmd_tbl *cmdtp, struct pxe_label *label goto skip_overlay;

/* Load overlay file */ - err = get_relfile_envaddr(cmdtp, overlayfile, + err = get_relfile_envaddr(ctx, overlayfile, "fdtoverlay_addr_r"); if (err < 0) { printf("Failed loading overlay %s\n", overlayfile); @@ -414,7 +415,7 @@ skip_overlay: * If the label specifies an 'append' line, its contents will overwrite that * of the 'bootargs' environment variable. */ -static int label_boot(struct cmd_tbl *cmdtp, struct pxe_label *label) +static int label_boot(struct pxe_context *ctx, struct pxe_label *label) { char *bootm_argv[] = { "bootm", NULL, NULL, NULL, NULL }; char initrd_str[28]; @@ -443,7 +444,7 @@ static int label_boot(struct cmd_tbl *cmdtp, struct pxe_label *label) }

if (label->initrd) { - if (get_relfile_envaddr(cmdtp, label->initrd, "ramdisk_addr_r") < 0) { + if (get_relfile_envaddr(ctx, label->initrd, "ramdisk_addr_r") < 0) { printf("Skipping %s for failure retrieving initrd\n", label->name); return 1; @@ -456,7 +457,7 @@ static int label_boot(struct cmd_tbl *cmdtp, struct pxe_label *label) bootm_argc = 3; }

- if (get_relfile_envaddr(cmdtp, label->kernel, "kernel_addr_r") < 0) { + if (get_relfile_envaddr(ctx, label->kernel, "kernel_addr_r") < 0) { printf("Skipping %s for failure retrieving kernel\n", label->name); return 1; @@ -596,7 +597,7 @@ static int label_boot(struct cmd_tbl *cmdtp, struct pxe_label *label) }

if (fdtfile) { - int err = get_relfile_envaddr(cmdtp, fdtfile, + int err = get_relfile_envaddr(ctx, fdtfile, "fdt_addr_r");

free(fdtfilefree); @@ -612,7 +613,7 @@ static int label_boot(struct cmd_tbl *cmdtp, struct pxe_label *label)

#ifdef CONFIG_OF_LIBFDT_OVERLAY if (label->fdtoverlays) - label_boot_fdtoverlay(cmdtp, label); + label_boot_fdtoverlay(ctx, label); #endif } else { bootm_argv[3] = NULL; @@ -632,16 +633,16 @@ static int label_boot(struct cmd_tbl *cmdtp, struct pxe_label *label) buf = map_sysmem(kernel_addr, 0); /* Try bootm for legacy and FIT format image */ if (genimg_get_format(buf) != IMAGE_FORMAT_INVALID) - do_bootm(cmdtp, 0, bootm_argc, bootm_argv); + do_bootm(ctx->cmdtp, 0, bootm_argc, bootm_argv); /* Try booting an AArch64 Linux kernel image */ else if (IS_ENABLED(CONFIG_CMD_BOOTI)) - do_booti(cmdtp, 0, bootm_argc, bootm_argv); + do_booti(ctx->cmdtp, 0, bootm_argc, bootm_argv); /* Try booting a Image */ else if (IS_ENABLED(CONFIG_CMD_BOOTZ)) - do_bootz(cmdtp, 0, bootm_argc, bootm_argv); + do_bootz(ctx->cmdtp, 0, bootm_argc, bootm_argv); /* Try booting an x86_64 Linux kernel image */ else if (IS_ENABLED(CONFIG_CMD_ZBOOT)) - do_zboot_parent(cmdtp, 0, bootm_argc, bootm_argv, NULL); + do_zboot_parent(ctx->cmdtp, 0, bootm_argc, bootm_argv, NULL);

unmap_sysmem(buf);

@@ -917,7 +918,7 @@ static int parse_integer(char **c, int *dst) return 1; }

-static int parse_pxefile_top(struct cmd_tbl *cmdtp, char *p, unsigned long base, +static int parse_pxefile_top(struct pxe_context *ctx, char *p, ulong base, struct pxe_menu *cfg, int nest_level);

/* @@ -928,7 +929,7 @@ static int parse_pxefile_top(struct cmd_tbl *cmdtp, char *p, unsigned long base, * include, nest_level has already been incremented and doesn't need to be * incremented here. */ -static int handle_include(struct cmd_tbl *cmdtp, char **c, unsigned long base, +static int handle_include(struct pxe_context *ctx, char **c, unsigned long base, struct pxe_menu *cfg, int nest_level) { char *include_path; @@ -944,7 +945,7 @@ static int handle_include(struct cmd_tbl *cmdtp, char **c, unsigned long base, return err; }

- err = get_pxe_file(cmdtp, include_path, base); + err = get_pxe_file(ctx, include_path, base);

if (err < 0) { printf("Couldn't retrieve %s\n", include_path); @@ -952,7 +953,7 @@ static int handle_include(struct cmd_tbl *cmdtp, char **c, unsigned long base, }

buf = map_sysmem(base, 0); - ret = parse_pxefile_top(cmdtp, buf, base, cfg, nest_level); + ret = parse_pxefile_top(ctx, buf, base, cfg, nest_level); unmap_sysmem(buf);

return ret; @@ -968,7 +969,7 @@ static int handle_include(struct cmd_tbl *cmdtp, char **c, unsigned long base, * nest_level should be 1 when parsing the top level pxe file, 2 when parsing * a file it includes, 3 when parsing a file included by that file, and so on. */ -static int parse_menu(struct cmd_tbl *cmdtp, char **c, struct pxe_menu *cfg, +static int parse_menu(struct pxe_context *ctx, char **c, struct pxe_menu *cfg, unsigned long base, int nest_level) { struct token t; @@ -984,7 +985,7 @@ static int parse_menu(struct cmd_tbl *cmdtp, char **c, struct pxe_menu *cfg, break;

case T_INCLUDE: - err = handle_include(cmdtp, c, base, cfg, nest_level + 1); + err = handle_include(ctx, c, base, cfg, nest_level + 1); break;

case T_BACKGROUND: @@ -1186,7 +1187,7 @@ static int parse_label(char **c, struct pxe_menu *cfg) * * Returns 1 on success, < 0 on error. */ -static int parse_pxefile_top(struct cmd_tbl *cmdtp, char *p, unsigned long base, +static int parse_pxefile_top(struct pxe_context *ctx, char *p, unsigned long base, struct pxe_menu *cfg, int nest_level) { struct token t; @@ -1209,7 +1210,7 @@ static int parse_pxefile_top(struct cmd_tbl *cmdtp, char *p, unsigned long base, switch (t.type) { case T_MENU: cfg->prompt = 1; - err = parse_menu(cmdtp, &p, cfg, + err = parse_menu(ctx, &p, cfg, base + ALIGN(strlen(b) + 1, 4), nest_level); break; @@ -1236,7 +1237,7 @@ static int parse_pxefile_top(struct cmd_tbl *cmdtp, char *p, unsigned long base, break;

case T_INCLUDE: - err = handle_include(cmdtp, &p, + err = handle_include(ctx, &p, base + ALIGN(strlen(b), 4), cfg, nest_level + 1); break; @@ -1263,7 +1264,6 @@ static int parse_pxefile_top(struct cmd_tbl *cmdtp, char *p, unsigned long base, }

/* - * Free the memory used by a pxe_menu and its labels. */ void destroy_pxe_menu(struct pxe_menu *cfg) { @@ -1285,7 +1285,7 @@ void destroy_pxe_menu(struct pxe_menu *cfg) free(cfg); }

-struct pxe_menu *parse_pxefile(struct cmd_tbl *cmdtp, unsigned long menucfg) +struct pxe_menu *parse_pxefile(struct pxe_context *ctx, unsigned long menucfg) { struct pxe_menu *cfg; char *buf; @@ -1301,7 +1301,7 @@ struct pxe_menu *parse_pxefile(struct cmd_tbl *cmdtp, unsigned long menucfg) INIT_LIST_HEAD(&cfg->labels);

buf = map_sysmem(menucfg, 0); - r = parse_pxefile_top(cmdtp, buf, menucfg, cfg, 1); + r = parse_pxefile_top(ctx, buf, menucfg, cfg, 1); unmap_sysmem(buf);

if (r < 0) { @@ -1369,7 +1369,8 @@ static struct menu *pxe_menu_to_menu(struct pxe_menu *cfg) /* * Try to boot any labels we have yet to attempt to boot. */ -static void boot_unattempted_labels(struct cmd_tbl *cmdtp, struct pxe_menu *cfg) +static void boot_unattempted_labels(struct pxe_context *ctx, + struct pxe_menu *cfg) { struct list_head *pos; struct pxe_label *label; @@ -1378,11 +1379,11 @@ static void boot_unattempted_labels(struct cmd_tbl *cmdtp, struct pxe_menu *cfg) label = list_entry(pos, struct pxe_label, list);

if (!label->attempted) - label_boot(cmdtp, label); + label_boot(ctx, label); } }

-void handle_pxe_menu(struct cmd_tbl *cmdtp, struct pxe_menu *cfg) +void handle_pxe_menu(struct pxe_context *ctx, struct pxe_menu *cfg) { void *choice; struct menu *m; @@ -1391,7 +1392,7 @@ void handle_pxe_menu(struct cmd_tbl *cmdtp, struct pxe_menu *cfg) if (IS_ENABLED(CONFIG_CMD_BMP)) { /* display BMP if available */ if (cfg->bmp) { - if (get_relfile(cmdtp, cfg->bmp, image_load_addr)) { + if (get_relfile(ctx, cfg->bmp, image_load_addr)) { if (CONFIG_IS_ENABLED(CMD_CLS)) run_command("cls", 0); bmp_display(image_load_addr, @@ -1423,12 +1424,17 @@ void handle_pxe_menu(struct cmd_tbl *cmdtp, struct pxe_menu *cfg) */

if (err == 1) { - err = label_boot(cmdtp, choice); + err = label_boot(ctx, choice); if (!err) return; } else if (err != -ENOENT) { return; }

- boot_unattempted_labels(cmdtp, cfg); + boot_unattempted_labels(ctx, cfg); +} + +void pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp) +{ + ctx->cmdtp = cmdtp; } diff --git a/cmd/pxe_utils.h b/cmd/pxe_utils.h index 441beefa2bc..cd0d3371765 100644 --- a/cmd/pxe_utils.h +++ b/cmd/pxe_utils.h @@ -79,6 +79,23 @@ extern bool is_pxe;

extern int (*do_getfile)(struct cmd_tbl *cmdtp, const char *file_path, char *file_addr); + +/** + * struct pxe_context - context information for PXE parsing + * + * @cmdtp: Pointer to command table to use when calling other commands + */ +struct pxe_context { + struct cmd_tbl *cmdtp; +}; + +/** + * destroy_pxe_menu() - Destroy an allocated pxe structure + * + * Free the memory used by a pxe_menu and its labels + * + * @cfg: Config to destroy, previous returned from parse_pxefile() + */ void destroy_pxe_menu(struct pxe_menu *cfg);

/** @@ -88,12 +105,12 @@ void destroy_pxe_menu(struct pxe_menu *cfg); * 'bootfile' was specified in the environment, the path to bootfile will be * prepended to 'file_path' and the resulting path will be used. * - * @cmdtp: Pointer to command-table entry for the initiating command + * @ctx: PXE context * @file_path: Path to file * @file_addr: Address to place file * Returns 1 on success, or < 0 for error */ -int get_pxe_file(struct cmd_tbl *cmdtp, const char *file_path, +int get_pxe_file(struct pxe_context *ctx, const char *file_path, ulong file_addr);

/** @@ -103,12 +120,12 @@ int get_pxe_file(struct cmd_tbl *cmdtp, const char *file_path, * to do the hard work, the location of the 'pxelinux.cfg' folder is generated * from the bootfile path, as described in get_pxe_file(). * - * @cmdtp: Pointer to command-table entry for the initiating command + * @ctx: PXE context * @file: Relative path to file * @pxefile_addr_r: Address to load file * Returns 1 on success or < 0 on error. */ -int get_pxelinux_path(struct cmd_tbl *cmdtp, const char *file, +int get_pxelinux_path(struct pxe_context *ctx, const char *file, ulong pxefile_addr_r);

/** @@ -123,25 +140,23 @@ int get_pxelinux_path(struct cmd_tbl *cmdtp, const char *file, * If this function returns, there weren't any labels that successfully * booted, or the user interrupted the menu selection via ctrl+c. * - * @cmdtp: Pointer to command-table entry for the initiating command + * @ctx: PXE context * @cfg: PXE menu */ -void handle_pxe_menu(struct cmd_tbl *cmdtp, struct pxe_menu *cfg); +void handle_pxe_menu(struct pxe_context *ctx, struct pxe_menu *cfg);

/** * parse_pxefile() - Parsing a pxe file * * This is only used for the top-level file. * - * @cmdtp: Pointer to command-table entry for the initiating command - * @menucfg: Address of PXE file - * + * @ctx: PXE context (provided by the caller) * Returns NULL if there is an error, otherwise, returns a pointer to a * pxe_menu struct populated with the results of parsing the pxe file (and any * files it includes). The resulting pxe_menu struct can be free()'d by using * the destroy_pxe_menu() function. */ -struct pxe_menu *parse_pxefile(struct cmd_tbl *cmdtp, ulong menucfg); +struct pxe_menu *parse_pxefile(struct pxe_context *ctx, ulong menucfg);

/** * format_mac_pxe() - Convert a MAC address to PXE format @@ -159,4 +174,12 @@ struct pxe_menu *parse_pxefile(struct cmd_tbl *cmdtp, ulong menucfg); */ int format_mac_pxe(char *outbuf, size_t outbuf_len);

+/** + * pxe_setup_ctx() - Setup a new PXE context + * + * @ctx: Context to set up + * @cmdtp: Command table entry which started this action + */ +void pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp); + #endif /* __PXE_UTILS_H */ diff --git a/cmd/sysboot.c b/cmd/sysboot.c index af6a2f1b7f1..9ba713c8aae 100644 --- a/cmd/sysboot.c +++ b/cmd/sysboot.c @@ -59,6 +59,7 @@ static int do_sysboot(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) { unsigned long pxefile_addr_r; + struct pxe_context ctx; struct pxe_menu *cfg; char *pxefile_addr_str; char *filename; @@ -90,6 +91,7 @@ static int do_sysboot(struct cmd_tbl *cmdtp, int flag, int argc, env_set("bootfile", filename); }

+ pxe_setup_ctx(&ctx, cmdtp); if (strstr(argv[3], "ext2")) { do_getfile = do_get_ext2; } else if (strstr(argv[3], "fat")) { @@ -108,12 +110,12 @@ static int do_sysboot(struct cmd_tbl *cmdtp, int flag, int argc, return 1; }

- if (get_pxe_file(cmdtp, filename, pxefile_addr_r) < 0) { + if (get_pxe_file(&ctx, filename, pxefile_addr_r) < 0) { printf("Error reading config file\n"); return 1; }

- cfg = parse_pxefile(cmdtp, pxefile_addr_r); + cfg = parse_pxefile(&ctx, pxefile_addr_r);

if (!cfg) { printf("Error parsing config file\n"); @@ -123,7 +125,7 @@ static int do_sysboot(struct cmd_tbl *cmdtp, int flag, int argc, if (prompt) cfg->prompt = 1;

- handle_pxe_menu(cmdtp, cfg); + handle_pxe_menu(&ctx, cfg);

destroy_pxe_menu(cfg);

Allow the caller to provide some info which is passed back to the readfile() method.

Signed-off-by: Simon Glass sjg@chromium.org ---

cmd/pxe.c | 4 ++-- cmd/pxe_utils.c | 3 ++- cmd/pxe_utils.h | 6 +++++- cmd/sysboot.c | 2 +- 4 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/cmd/pxe.c b/cmd/pxe.c index 70dbde3a636..d79b9b733d7 100644 --- a/cmd/pxe.c +++ b/cmd/pxe.c @@ -121,7 +121,7 @@ do_pxe_get(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) struct pxe_context ctx; int err, i = 0;

- pxe_setup_ctx(&ctx, cmdtp, do_get_tftp); + pxe_setup_ctx(&ctx, cmdtp, do_get_tftp, NULL);

if (argc != 1) return CMD_RET_USAGE; @@ -175,7 +175,7 @@ do_pxe_boot(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) char *pxefile_addr_str; struct pxe_context ctx;

- pxe_setup_ctx(&ctx, cmdtp, do_get_tftp); + pxe_setup_ctx(&ctx, cmdtp, do_get_tftp, NULL);

if (argc == 1) { pxefile_addr_str = from_env("pxefile_addr_r"); diff --git a/cmd/pxe_utils.c b/cmd/pxe_utils.c index 2caae6d1555..5ad6d3e3d44 100644 --- a/cmd/pxe_utils.c +++ b/cmd/pxe_utils.c @@ -1432,8 +1432,9 @@ void handle_pxe_menu(struct pxe_context *ctx, struct pxe_menu *cfg) }

void pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp, - pxe_getfile_func getfile) + pxe_getfile_func getfile, void *userdata) { ctx->cmdtp = cmdtp; ctx->getfile = getfile; + ctx->userdata = userdata; } diff --git a/cmd/pxe_utils.h b/cmd/pxe_utils.h index ca2696f48b0..921455f694e 100644 --- a/cmd/pxe_utils.h +++ b/cmd/pxe_utils.h @@ -86,6 +86,7 @@ typedef int (*pxe_getfile_func)(struct pxe_context *ctx, const char *file_path, * * @cmdtp: Pointer to command table to use when calling other commands * @getfile: Function called by PXE to read a file + * @userdata: Data the caller requires for @getfile */ struct pxe_context { struct cmd_tbl *cmdtp; @@ -99,6 +100,8 @@ struct pxe_context { * Return 0 if OK, -ve on error */ pxe_getfile_func getfile; + + void *userdata; };

/** @@ -192,8 +195,9 @@ int format_mac_pxe(char *outbuf, size_t outbuf_len); * @ctx: Context to set up * @cmdtp: Command table entry which started this action * @getfile: Function to call to read a file + * @userdata: Data the caller requires for @getfile - stored in ctx->userdata */ void pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp, - pxe_getfile_func getfile); + pxe_getfile_func getfile, void *userdata);

#endif /* __PXE_UTILS_H */ diff --git a/cmd/sysboot.c b/cmd/sysboot.c index 082f23543d1..5615e81e9ca 100644 --- a/cmd/sysboot.c +++ b/cmd/sysboot.c @@ -91,7 +91,7 @@ static int do_sysboot(struct cmd_tbl *cmdtp, int flag, int argc, env_set("bootfile", filename); }

- pxe_setup_ctx(&ctx, cmdtp, NULL); + pxe_setup_ctx(&ctx, cmdtp, NULL, NULL); if (strstr(argv[3], "ext2")) { ctx.getfile = do_get_ext2; } else if (strstr(argv[3], "fat")) {

Move the header file into the main include/ directory so we can use it from the bootmethod code. Move the C file into boot/ since it relates to booting.

Signed-off-by: Simon Glass sjg@chromium.org ---

boot/Makefile | 3 +++ {cmd => boot}/pxe_utils.c | 0 cmd/Makefile | 4 ++-- cmd/sysboot.c | 2 +- {cmd => include}/pxe_utils.h | 0 5 files changed, 6 insertions(+), 3 deletions(-) rename {cmd => boot}/pxe_utils.c (100%) rename {cmd => include}/pxe_utils.h (100%)

diff --git a/boot/Makefile b/boot/Makefile index 57d26346afb..e8f984248e6 100644 --- a/boot/Makefile +++ b/boot/Makefile @@ -14,6 +14,9 @@ obj-$(CONFIG_CMD_BOOTM) += bootm.o bootm_os.o obj-$(CONFIG_CMD_BOOTZ) += bootm.o bootm_os.o obj-$(CONFIG_CMD_BOOTI) += bootm.o bootm_os.o

+obj-$(CONFIG_CMD_PXE) += pxe_utils.o +obj-$(CONFIG_CMD_SYSBOOT) += pxe_utils.o + endif

obj-y += image.o diff --git a/cmd/pxe_utils.c b/boot/pxe_utils.c similarity index 100% rename from cmd/pxe_utils.c rename to boot/pxe_utils.c diff --git a/cmd/Makefile b/cmd/Makefile index ed3669411e6..891819ae0f6 100644 --- a/cmd/Makefile +++ b/cmd/Makefile @@ -123,7 +123,7 @@ obj-$(CONFIG_CMD_PINMUX) += pinmux.o obj-$(CONFIG_CMD_PMC) += pmc.o obj-$(CONFIG_CMD_PSTORE) += pstore.o obj-$(CONFIG_CMD_PWM) += pwm.o -obj-$(CONFIG_CMD_PXE) += pxe.o pxe_utils.o +obj-$(CONFIG_CMD_PXE) += pxe.o obj-$(CONFIG_CMD_WOL) += wol.o obj-$(CONFIG_CMD_QFW) += qfw.o obj-$(CONFIG_CMD_READ) += read.o @@ -145,7 +145,7 @@ obj-$(CONFIG_CMD_SETEXPR_FMT) += printf.o obj-$(CONFIG_CMD_SPI) += spi.o obj-$(CONFIG_CMD_STRINGS) += strings.o obj-$(CONFIG_CMD_SMC) += smccc.o -obj-$(CONFIG_CMD_SYSBOOT) += sysboot.o pxe_utils.o +obj-$(CONFIG_CMD_SYSBOOT) += sysboot.o obj-$(CONFIG_CMD_STACKPROTECTOR_TEST) += stackprot_test.o obj-$(CONFIG_CMD_TERMINAL) += terminal.o obj-$(CONFIG_CMD_TIME) += time.o diff --git a/cmd/sysboot.c b/cmd/sysboot.c index 85fa5d8aa01..b81255e155a 100644 --- a/cmd/sysboot.c +++ b/cmd/sysboot.c @@ -4,7 +4,7 @@ #include <command.h> #include <env.h> #include <fs.h> -#include "pxe_utils.h" +#include <pxe_utils.h>

static char *fs_argv[5];

diff --git a/cmd/pxe_utils.h b/include/pxe_utils.h similarity index 100% rename from cmd/pxe_utils.h rename to include/pxe_utils.h

There are a few more blank lines than makes sense for readability. Also free() handles a NULL pointer so drop the pointless checks.

Signed-off-by: Simon Glass sjg@chromium.org ---

boot/pxe_utils.c | 66 ++++++++++-------------------------------------- 1 file changed, 13 insertions(+), 53 deletions(-)

diff --git a/boot/pxe_utils.c b/boot/pxe_utils.c index 7a2213a5925..9f3edeab06a 100644 --- a/boot/pxe_utils.c +++ b/boot/pxe_utils.c @@ -51,7 +51,6 @@ int format_mac_pxe(char *outbuf, size_t outbuf_len)

if (outbuf_len < 21) { printf("outbuf is too small (%zd < 21)\n", outbuf_len); - return -ENOSPC; }

@@ -91,12 +90,10 @@ static int get_bootfile_path(const char *file_path, char *bootfile_path, goto ret;

bootfile = from_env("bootfile"); - if (!bootfile) goto ret;

last_slash = strrchr(bootfile, '/'); - if (!last_slash) goto ret;

@@ -140,7 +137,6 @@ static int get_relfile(struct pxe_context *ctx, const char *file_path,

err = get_bootfile_path(file_path, relfile, sizeof(relfile), ctx->allow_abs_path); - if (err < 0) return err;

@@ -181,7 +177,6 @@ int get_pxe_file(struct pxe_context *ctx, const char *file_path, char *buf;

err = get_relfile(ctx, file_path, file_addr); - if (err < 0) return err;

@@ -190,7 +185,6 @@ int get_pxe_file(struct pxe_context *ctx, const char *file_path, * and add the NUL byte. */ tftp_filesize = from_env("filesize"); - if (!tftp_filesize) return -ENOENT;

@@ -253,7 +247,6 @@ static int get_relfile_envaddr(struct pxe_context *ctx, const char *file_path, char *envaddr;

envaddr = from_env(envaddr_name); - if (!envaddr) return -ENOENT;

@@ -276,7 +269,6 @@ static struct pxe_label *label_create(void) struct pxe_label *label;

label = malloc(sizeof(struct pxe_label)); - if (!label) return NULL;

@@ -300,30 +292,14 @@ static struct pxe_label *label_create(void) */ static void label_destroy(struct pxe_label *label) { - if (label->name) - free(label->name); - - if (label->kernel) - free(label->kernel); - - if (label->config) - free(label->config); - - if (label->append) - free(label->append); - - if (label->initrd) - free(label->initrd); - - if (label->fdt) - free(label->fdt); - - if (label->fdtdir) - free(label->fdtdir); - - if (label->fdtoverlays) - free(label->fdtoverlays); - + free(label->name); + free(label->kernel); + free(label->config); + free(label->append); + free(label->initrd); + free(label->fdt); + free(label->fdtdir); + free(label->fdtoverlays); free(label); }

@@ -359,7 +335,6 @@ static int label_localboot(struct pxe_label *label) char *localcmd;

localcmd = from_env("localcmd"); - if (!localcmd) return -ENOENT;

@@ -718,8 +693,8 @@ static int label_boot(struct pxe_context *ctx, struct pxe_label *label) unmap_sysmem(buf);

cleanup: - if (fit_addr) - free(fit_addr); + free(fit_addr); + return 1; }

@@ -832,7 +807,6 @@ static char *get_string(char **p, struct token *t, char delim, int lower) */ b = *p; e = *p; - while (*e) { if ((delim == ' ' && isspace(*e)) || delim == *e) break; @@ -858,11 +832,8 @@ static char *get_string(char **p, struct token *t, char delim, int lower)

t->val[len] = '\0';

- /* - * Update *p so the caller knows where to continue scanning. - */ + /* Update *p so the caller knows where to continue scanning */ *p = e; - t->type = T_STRING;

return t->val; @@ -988,7 +959,6 @@ static int parse_integer(char **c, int *dst) char *s = *c;

get_token(c, &t, L_SLITERAL); - if (t.type != T_STRING) { printf("Expected string: %.*s\n", (int)(*c - s), s); return -EINVAL; @@ -1022,14 +992,12 @@ static int handle_include(struct pxe_context *ctx, char **c, unsigned long base, int ret;

err = parse_sliteral(c, &include_path); - if (err < 0) { printf("Expected include path: %.*s\n", (int)(*c - s), s); return err; }

err = get_pxe_file(ctx, include_path, base); - if (err < 0) { printf("Couldn't retrieve %s\n", include_path); return err; @@ -1079,7 +1047,6 @@ static int parse_menu(struct pxe_context *ctx, char **c, struct pxe_menu *cfg, printf("Ignoring malformed menu command: %.*s\n", (int)(*c - s), s); } - if (err < 0) return err;

@@ -1353,11 +1320,8 @@ void destroy_pxe_menu(struct pxe_menu *cfg) struct list_head *pos, *n; struct pxe_label *label;

- if (cfg->title) - free(cfg->title); - - if (cfg->default_label) - free(cfg->default_label); + free(cfg->title); + free(cfg->default_label);

list_for_each_safe(pos, n, &cfg->labels) { label = list_entry(pos, struct pxe_label, list); @@ -1375,7 +1339,6 @@ struct pxe_menu *parse_pxefile(struct pxe_context *ctx, unsigned long menucfg) int r;

cfg = malloc(sizeof(struct pxe_menu)); - if (!cfg) return NULL;

@@ -1386,7 +1349,6 @@ struct pxe_menu *parse_pxefile(struct pxe_context *ctx, unsigned long menucfg) buf = map_sysmem(menucfg, 0); r = parse_pxefile_top(ctx, buf, menucfg, cfg, 1); unmap_sysmem(buf); - if (r < 0) { destroy_pxe_menu(cfg); return NULL; @@ -1413,7 +1375,6 @@ static struct menu *pxe_menu_to_menu(struct pxe_menu *cfg) */ m = menu_create(cfg->title, DIV_ROUND_UP(cfg->timeout, 10), cfg->prompt, NULL, label_print, NULL, NULL); - if (!m) return NULL;

@@ -1492,7 +1453,6 @@ void handle_pxe_menu(struct pxe_context *ctx, struct pxe_menu *cfg) return;

err = menu_get_choice(m, &choice); - menu_destroy(m);

/*

The 'bootfile' environment variable is read in the bowels of pxe_util to provide a directory to which all loaded files are relative.

This is not obvious from the API to PXE and it is strange to make the caller set an environment variable rather than pass this as a parameter.

The code is also convoluted, which this feature implemented by get_bootfile_path().

Update the API to improve this. Unfortunately this means that pxe_setup_ctx() can fail, so add error checking.

Signed-off-by: Simon Glass sjg@chromium.org ---

boot/pxe_utils.c | 60 ++++++++++++++++++++++++++++----------------- cmd/pxe.c | 18 +++++++++++--- cmd/sysboot.c | 15 +++++++++--- include/pxe_utils.h | 19 +++++++++++--- 4 files changed, 79 insertions(+), 33 deletions(-)

diff --git a/boot/pxe_utils.c b/boot/pxe_utils.c index 225729ce57f..c04be110ea4 100644 --- a/boot/pxe_utils.c +++ b/boot/pxe_utils.c @@ -67,10 +67,10 @@ int format_mac_pxe(char *outbuf, size_t outbuf_len) /** * get_bootfile_path() - Figure out the path of a file to read * - * Returns the directory the file specified in the 'bootfile' env variable is - * in. If bootfile isn't defined in the environment, return NULL, which should - * be interpreted as "don't prepend anything to paths". + * Copies the boot directory into the supplied buffer. If there is no boot + * directory, set it to "" * + * @ctx: PXE context * @file_path: File path to read (relative to the PXE file) * @bootfile_path: Place to put the bootfile path * @bootfile_path_size: Size of @bootfile_path in bytes @@ -79,34 +79,25 @@ int format_mac_pxe(char *outbuf, size_t outbuf_len) * Returns 1 for success, -ENOSPC if bootfile_path_size is to small to hold the * resulting path */ -static int get_bootfile_path(const char *file_path, char *bootfile_path, - size_t bootfile_path_size, bool allow_abs_path) +static int get_bootfile_path(struct pxe_context *ctx, const char *file_path, + char *bootfile_path, size_t bootfile_path_size, + bool allow_abs_path) { - char *bootfile, *last_slash; size_t path_len = 0;

/* Only syslinux allows absolute paths */ if (file_path[0] == '/' && allow_abs_path) goto ret;

- bootfile = from_env("bootfile"); - if (!bootfile) - goto ret; - - last_slash = strrchr(bootfile, '/'); - if (!last_slash) - goto ret; - - path_len = (last_slash - bootfile) + 1; - - if (bootfile_path_size < path_len) { + path_len = strlen(ctx->bootdir); + if (bootfile_path_size < path_len + 1) { printf("bootfile_path too small. (%zd < %zd)\n", bootfile_path_size, path_len);

return -ENOSPC; }

- strncpy(bootfile_path, bootfile, path_len); + strncpy(bootfile_path, ctx->bootdir, path_len);

ret: bootfile_path[path_len] = '\0'; @@ -135,7 +126,7 @@ static int get_relfile(struct pxe_context *ctx, const char *file_path, char addr_buf[18]; int err;

- err = get_bootfile_path(file_path, relfile, sizeof(relfile), + err = get_bootfile_path(ctx, file_path, relfile, sizeof(relfile), ctx->allow_abs_path); if (err < 0) return err; @@ -1477,14 +1468,39 @@ void handle_pxe_menu(struct pxe_context *ctx, struct pxe_menu *cfg) boot_unattempted_labels(ctx, cfg); }

-void pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp, - pxe_getfile_func getfile, void *userdata, - bool allow_abs_path) +int pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp, + pxe_getfile_func getfile, void *userdata, + bool allow_abs_path, const char *bootfile) { + const char *last_slash; + size_t path_len = 0; + + memset(ctx, '\0', sizeof(*ctx)); ctx->cmdtp = cmdtp; ctx->getfile = getfile; ctx->userdata = userdata; ctx->allow_abs_path = allow_abs_path; + + /* figure out the boot directory, if there is one */ + if (bootfile && strlen(bootfile) >= MAX_TFTP_PATH_LEN) + return -ENOSPC; + ctx->bootdir = strdup(bootfile ? bootfile : ""); + if (!ctx->bootdir) + return -ENOMEM; + + if (bootfile) { + last_slash = strrchr(bootfile, '/'); + if (last_slash) + path_len = (last_slash - bootfile) + 1; + } + ctx->bootdir[path_len] = '\0'; + + return 0; +} + +void pxe_destroy_ctx(struct pxe_context *ctx) +{ + free(ctx->bootdir); }

int pxe_process(struct pxe_context *ctx, ulong pxefile_addr_r, bool prompt) diff --git a/cmd/pxe.c b/cmd/pxe.c index 4fa51d2e053..e319db51ef5 100644 --- a/cmd/pxe.c +++ b/cmd/pxe.c @@ -121,8 +121,6 @@ do_pxe_get(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) struct pxe_context ctx; int err, i = 0;

- pxe_setup_ctx(&ctx, cmdtp, do_get_tftp, NULL, false); - if (argc != 1) return CMD_RET_USAGE;

@@ -136,6 +134,11 @@ do_pxe_get(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) if (err < 0) return 1;

+ if (pxe_setup_ctx(&ctx, cmdtp, do_get_tftp, NULL, false, + env_get("bootfile"))) { + printf("Out of memory\n"); + return CMD_RET_FAILURE; + } /* * Keep trying paths until we successfully get a file we're looking * for. @@ -144,6 +147,7 @@ do_pxe_get(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) pxe_mac_path(&ctx, pxefile_addr_r) > 0 || pxe_ipaddr_paths(&ctx, pxefile_addr_r) > 0) { printf("Config file found\n"); + pxe_destroy_ctx(&ctx);

return 0; } @@ -152,12 +156,14 @@ do_pxe_get(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) if (get_pxelinux_path(&ctx, pxe_default_paths[i], pxefile_addr_r) > 0) { printf("Config file found\n"); + pxe_destroy_ctx(&ctx); return 0; } i++; }

printf("Config file not found\n"); + pxe_destroy_ctx(&ctx);

return 1; } @@ -175,8 +181,6 @@ do_pxe_boot(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) struct pxe_context ctx; int ret;

- pxe_setup_ctx(&ctx, cmdtp, do_get_tftp, NULL, false); - if (argc == 1) { pxefile_addr_str = from_env("pxefile_addr_r"); if (!pxefile_addr_str) @@ -193,7 +197,13 @@ do_pxe_boot(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) return 1; }

+ if (pxe_setup_ctx(&ctx, cmdtp, do_get_tftp, NULL, false, + env_get("bootfile"))) { + printf("Out of memory\n"); + return CMD_RET_FAILURE; + } ret = pxe_process(&ctx, pxefile_addr_r, false); + pxe_destroy_ctx(&ctx); if (ret) return CMD_RET_FAILURE;

diff --git a/cmd/sysboot.c b/cmd/sysboot.c index 7ee14df79e5..c45fed774d6 100644 --- a/cmd/sysboot.c +++ b/cmd/sysboot.c @@ -59,6 +59,7 @@ static int do_sysboot(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) { unsigned long pxefile_addr_r; + pxe_getfile_func getfile; struct pxe_context ctx; char *pxefile_addr_str; char *filename; @@ -89,13 +90,12 @@ static int do_sysboot(struct cmd_tbl *cmdtp, int flag, int argc, env_set("bootfile", filename); }

- pxe_setup_ctx(&ctx, cmdtp, NULL, NULL, true); if (strstr(argv[3], "ext2")) { - ctx.getfile = do_get_ext2; + getfile = do_get_ext2; } else if (strstr(argv[3], "fat")) { - ctx.getfile = do_get_fat; + getfile = do_get_fat; } else if (strstr(argv[3], "any")) { - ctx.getfile = do_get_any; + getfile = do_get_any; } else { printf("Invalid filesystem: %s\n", argv[3]); return 1; @@ -108,12 +108,19 @@ static int do_sysboot(struct cmd_tbl *cmdtp, int flag, int argc, return 1; }

+ if (pxe_setup_ctx(&ctx, cmdtp, getfile, NULL, true, filename)) { + printf("Out of memory\n"); + return CMD_RET_FAILURE; + } + if (get_pxe_file(&ctx, filename, pxefile_addr_r) < 0) { printf("Error reading config file\n"); + pxe_destroy_ctx(&ctx); return 1; }

ret = pxe_process(&ctx, pxefile_addr_r, prompt); + pxe_destroy_ctx(&ctx); if (ret) return CMD_RET_FAILURE;

diff --git a/include/pxe_utils.h b/include/pxe_utils.h index 0cae0dabec3..543d0245c8a 100644 --- a/include/pxe_utils.h +++ b/include/pxe_utils.h @@ -86,6 +86,8 @@ typedef int (*pxe_getfile_func)(struct pxe_context *ctx, const char *file_path, * @getfile: Function called by PXE to read a file * @userdata: Data the caller requires for @getfile * @allow_abs_path: true to allow absolute paths + * @bootdir: Directory that files are loaded from ("" if no directory). This is + * allocated */ struct pxe_context { struct cmd_tbl *cmdtp; @@ -102,6 +104,7 @@ struct pxe_context {

void *userdata; bool allow_abs_path; + char *bootdir; };

/** @@ -197,10 +200,20 @@ int format_mac_pxe(char *outbuf, size_t outbuf_len); * @getfile: Function to call to read a file * @userdata: Data the caller requires for @getfile - stored in ctx->userdata * @allow_abs_path: true to allow absolute paths + * @bootfile: Bootfile whose directory loaded files are relative to, NULL if + * none + * @return 0 if OK, -ENOMEM if out of memory */ -void pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp, - pxe_getfile_func getfile, void *userdata, - bool allow_abs_path); +int pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp, + pxe_getfile_func getfile, void *userdata, + bool allow_abs_path, const char *bootfile); + +/** + * pxe_destroy_ctx() - Destroy a PXE context + * + * @ctx: Context to destroy + */ +void pxe_destroy_ctx(struct pxe_context *ctx);

/** * pxe_process() - Process a PXE file through to boot

Add test and a comment for this function.

Signed-off-by: Simon Glass sjg@chromium.org ---

include/vsprintf.h | 13 ++++++++++++- test/print_ut.c | 17 +++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/include/vsprintf.h b/include/vsprintf.h index 83d187e53d4..4479df0af3f 100644 --- a/include/vsprintf.h +++ b/include/vsprintf.h @@ -172,7 +172,18 @@ int sprintf(char *buf, const char *fmt, ...) * See the vsprintf() documentation for format string extensions over C99. */ int vsprintf(char *buf, const char *fmt, va_list args); -char *simple_itoa(ulong i); + +/** + * simple_itoa() - convert an unsigned integer to a string + * + * This returns a static string containing the decimal representation of the + * given value. The returned value may be overwritten by other calls to the + * same function, so should be used immediately + * + * @val: Value to convert + * @return string containing the decimal representation of @val + */ +char *simple_itoa(ulong val);

/** * Format a string and place it in a buffer diff --git a/test/print_ut.c b/test/print_ut.c index e2bcfbef007..737845afd33 100644 --- a/test/print_ut.c +++ b/test/print_ut.c @@ -10,6 +10,7 @@ #include <log.h> #include <mapmem.h> #include <version.h> +#include <vsprintf.h> #include <test/suites.h> #include <test/test.h> #include <test/ut.h> @@ -328,6 +329,22 @@ static int print_do_hex_dump(struct unit_test_state *uts) } PRINT_TEST(print_do_hex_dump, UT_TESTF_CONSOLE_REC);

+static int print_itoa(struct unit_test_state *uts) +{ + ut_asserteq_str("123", simple_itoa(123)); + ut_asserteq_str("0", simple_itoa(0)); + ut_asserteq_str("2147483647", simple_itoa(0x7fffffff)); + ut_asserteq_str("4294967295", simple_itoa(0xffffffff)); + if (sizeof(ulong) == 8) { + ut_asserteq_str("9223372036854775807", + simple_itoa((1UL << 63) - 1)); + ut_asserteq_str("18446744073709551615", simple_itoa(-1)); + } + + return 0; +} +PRINT_TEST(print_itoa, 0); + int do_ut_print(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]) { struct unit_test *tests = UNIT_TEST_SUITE_START(print_test);

It is pretty strange that the pxe code uses the 'filesize' environment variable find the size of a file it has just read.

Partly this is because it uses the command-line interpreter to parse its request to load the file.

As a first step towards unwinding this, return it directly from the getfile() function. This makes the code a bit longer, for now, but will be cleaned up in future patches.

Signed-off-by: Simon Glass sjg@chromium.org ---

boot/pxe_utils.c | 70 ++++++++++++++++++++++++++++----------------- cmd/pxe.c | 7 ++++- cmd/sysboot.c | 21 ++++++++++++-- include/pxe_utils.h | 13 ++++++++- 4 files changed, 79 insertions(+), 32 deletions(-)

diff --git a/boot/pxe_utils.c b/boot/pxe_utils.c index f36f1f8a60c..e377e16be56 100644 --- a/boot/pxe_utils.c +++ b/boot/pxe_utils.c @@ -30,6 +30,20 @@

#define MAX_TFTP_PATH_LEN 512

+int pxe_get_file_size(ulong *sizep) +{ + const char *val; + + val = from_env("filesize"); + if (!val) + return -ENOENT; + + if (strict_strtoul(val, 16, sizep) < 0) + return -EINVAL; + + return 0; +} + /** * format_mac_pxe() - obtain a MAC address in the PXE format * @@ -75,14 +89,17 @@ int format_mac_pxe(char *outbuf, size_t outbuf_len) * @ctx: PXE context * @file_path: File path to read (relative to the PXE file) * @file_addr: Address to load file to + * @filesizep: If not NULL, returns the file size in bytes * Returns 1 for success, or < 0 on error */ static int get_relfile(struct pxe_context *ctx, const char *file_path, - unsigned long file_addr) + unsigned long file_addr, ulong *filesizep) { size_t path_len; char relfile[MAX_TFTP_PATH_LEN + 1]; char addr_buf[18]; + ulong size; + int ret;

if (file_path[0] == '/' && ctx->allow_abs_path) *relfile = '\0'; @@ -103,7 +120,13 @@ static int get_relfile(struct pxe_context *ctx, const char *file_path,

sprintf(addr_buf, "%lx", file_addr);

- return ctx->getfile(ctx, relfile, addr_buf); + ret = ctx->getfile(ctx, relfile, addr_buf, &size); + if (ret < 0) + return log_msg_ret("get", ret); + if (filesizep) + *filesizep = size; + + return 1; }

/** @@ -117,29 +140,17 @@ static int get_relfile(struct pxe_context *ctx, const char *file_path, * Returns 1 for success, or < 0 on error */ int get_pxe_file(struct pxe_context *ctx, const char *file_path, - unsigned long file_addr) + ulong file_addr) { - unsigned long config_file_size; - char *tftp_filesize; + ulong size; int err; char *buf;

- err = get_relfile(ctx, file_path, file_addr); + err = get_relfile(ctx, file_path, file_addr, &size); if (err < 0) return err;

- /* - * the file comes without a NUL byte at the end, so find out its size - * and add the NUL byte. - */ - tftp_filesize = from_env("filesize"); - if (!tftp_filesize) - return -ENOENT; - - if (strict_strtoul(tftp_filesize, 16, &config_file_size) < 0) - return -EINVAL; - - buf = map_sysmem(file_addr + config_file_size, 1); + buf = map_sysmem(file_addr + size, 1); *buf = '\0'; unmap_sysmem(buf);

@@ -184,12 +195,13 @@ int get_pxelinux_path(struct pxe_context *ctx, const char *file, * @file_path: File path to read (relative to the PXE file) * @envaddr_name: Name of environment variable which contains the address to * load to + * @filesizep: Returns the file size in bytes * Returns 1 on success, -ENOENT if @envaddr_name does not exist as an * environment variable, -EINVAL if its format is not valid hex, or other * value < 0 on other error */ static int get_relfile_envaddr(struct pxe_context *ctx, const char *file_path, - const char *envaddr_name) + const char *envaddr_name, ulong *filesizep) { unsigned long file_addr; char *envaddr; @@ -201,7 +213,7 @@ static int get_relfile_envaddr(struct pxe_context *ctx, const char *file_path, if (strict_strtoul(envaddr, 16, &file_addr) < 0) return -EINVAL;

- return get_relfile(ctx, file_path, file_addr); + return get_relfile(ctx, file_path, file_addr, filesizep); }

/** @@ -357,8 +369,8 @@ static void label_boot_fdtoverlay(struct pxe_context *ctx, goto skip_overlay;

/* Load overlay file */ - err = get_relfile_envaddr(ctx, overlayfile, - "fdtoverlay_addr_r"); + err = get_relfile_envaddr(ctx, overlayfile, "fdtoverlay_addr_r", + NULL); if (err < 0) { printf("Failed loading overlay %s\n", overlayfile); goto skip_overlay; @@ -438,7 +450,10 @@ static int label_boot(struct pxe_context *ctx, struct pxe_label *label) }

if (label->initrd) { - if (get_relfile_envaddr(ctx, label->initrd, "ramdisk_addr_r") < 0) { + ulong size; + + if (get_relfile_envaddr(ctx, label->initrd, "ramdisk_addr_r", + &size) < 0) { printf("Skipping %s for failure retrieving initrd\n", label->name); return 1; @@ -447,11 +462,12 @@ static int label_boot(struct pxe_context *ctx, struct pxe_label *label) bootm_argv[2] = initrd_str; strncpy(bootm_argv[2], env_get("ramdisk_addr_r"), 18); strcat(bootm_argv[2], ":"); - strncat(bootm_argv[2], env_get("filesize"), 9); + strcat(bootm_argv[2], simple_xtoa(size)); bootm_argc = 3; }

- if (get_relfile_envaddr(ctx, label->kernel, "kernel_addr_r") < 0) { + if (get_relfile_envaddr(ctx, label->kernel, "kernel_addr_r", + NULL) < 0) { printf("Skipping %s for failure retrieving kernel\n", label->name); return 1; @@ -592,7 +608,7 @@ static int label_boot(struct pxe_context *ctx, struct pxe_label *label)

if (fdtfile) { int err = get_relfile_envaddr(ctx, fdtfile, - "fdt_addr_r"); + "fdt_addr_r", NULL);

free(fdtfilefree); if (err < 0) { @@ -1384,7 +1400,7 @@ void handle_pxe_menu(struct pxe_context *ctx, struct pxe_menu *cfg) if (IS_ENABLED(CONFIG_CMD_BMP)) { /* display BMP if available */ if (cfg->bmp) { - if (get_relfile(ctx, cfg->bmp, image_load_addr)) { + if (get_relfile(ctx, cfg->bmp, image_load_addr, NULL)) { if (CONFIG_IS_ENABLED(CMD_CLS)) run_command("cls", 0); bmp_display(image_load_addr, diff --git a/cmd/pxe.c b/cmd/pxe.c index e319db51ef5..81703386c42 100644 --- a/cmd/pxe.c +++ b/cmd/pxe.c @@ -25,15 +25,20 @@ const char *pxe_default_paths[] = { };

static int do_get_tftp(struct pxe_context *ctx, const char *file_path, - char *file_addr) + char *file_addr, ulong *sizep) { char *tftp_argv[] = {"tftp", NULL, NULL, NULL}; + int ret;

tftp_argv[1] = file_addr; tftp_argv[2] = (void *)file_path;

if (do_tftpb(ctx->cmdtp, 0, 3, tftp_argv)) return -ENOENT; + ret = pxe_get_file_size(sizep); + if (ret) + return log_msg_ret("tftp", ret); + ctx->pxe_file_size = *sizep;

return 1; } diff --git a/cmd/sysboot.c b/cmd/sysboot.c index c45fed774d6..6344ecd357b 100644 --- a/cmd/sysboot.c +++ b/cmd/sysboot.c @@ -9,43 +9,58 @@ static char *fs_argv[5];

static int do_get_ext2(struct pxe_context *ctx, const char *file_path, - char *file_addr) + char *file_addr, ulong *sizep) { #ifdef CONFIG_CMD_EXT2 + int ret; + fs_argv[0] = "ext2load"; fs_argv[3] = file_addr; fs_argv[4] = (void *)file_path;

if (!do_ext2load(ctx->cmdtp, 0, 5, fs_argv)) return 1; + ret = pxe_get_file_size(sizep); + if (ret) + return log_msg_ret("tftp", ret); #endif return -ENOENT; }

static int do_get_fat(struct pxe_context *ctx, const char *file_path, - char *file_addr) + char *file_addr, ulong *sizep) { #ifdef CONFIG_CMD_FAT + int ret; + fs_argv[0] = "fatload"; fs_argv[3] = file_addr; fs_argv[4] = (void *)file_path;

if (!do_fat_fsload(ctx->cmdtp, 0, 5, fs_argv)) return 1; + ret = pxe_get_file_size(sizep); + if (ret) + return log_msg_ret("tftp", ret); #endif return -ENOENT; }

static int do_get_any(struct pxe_context *ctx, const char *file_path, - char *file_addr) + char *file_addr, ulong *sizep) { #ifdef CONFIG_CMD_FS_GENERIC + int ret; + fs_argv[0] = "load"; fs_argv[3] = file_addr; fs_argv[4] = (void *)file_path;

if (!do_load(ctx->cmdtp, 0, 5, fs_argv, FS_TYPE_ANY)) return 1; + ret = pxe_get_file_size(sizep); + if (ret) + return log_msg_ret("tftp", ret); #endif return -ENOENT; } diff --git a/include/pxe_utils.h b/include/pxe_utils.h index 8b50f2e6861..194a5ed8cc7 100644 --- a/include/pxe_utils.h +++ b/include/pxe_utils.h @@ -77,7 +77,7 @@ struct pxe_menu {

struct pxe_context; typedef int (*pxe_getfile_func)(struct pxe_context *ctx, const char *file_path, - char *file_addr); + char *file_addr, ulong *filesizep);

/** * struct pxe_context - context information for PXE parsing @@ -88,6 +88,7 @@ typedef int (*pxe_getfile_func)(struct pxe_context *ctx, const char *file_path, * @allow_abs_path: true to allow absolute paths * @bootdir: Directory that files are loaded from ("" if no directory). This is * allocated + * @pxe_file_size: Size of the PXE file */ struct pxe_context { struct cmd_tbl *cmdtp; @@ -98,6 +99,7 @@ struct pxe_context { * @file_path: Path to the file * @file_addr: String containing the hex address to put the file in * memory + * @filesizep: Returns the file size in bytes * Return 0 if OK, -ve on error */ pxe_getfile_func getfile; @@ -105,6 +107,7 @@ struct pxe_context { void *userdata; bool allow_abs_path; char *bootdir; + ulong pxe_file_size; };

/** @@ -225,4 +228,12 @@ void pxe_destroy_ctx(struct pxe_context *ctx); */ int pxe_process(struct pxe_context *ctx, ulong pxefile_addr_r, bool prompt);

+/** + * pxe_get_file_size() - Read the value of the 'filesize' environment variable + * + * @sizep: Place to put the value + * @return 0 if OK, -ENOENT if no such variable, -EINVAL if format is invalid + */ +int pxe_get_file_size(ulong *sizep); + #endif /* __PXE_UTILS_H */

Move this over to the new rST format.

Signed-off-by: Simon Glass sjg@chromium.org ---

doc/{README.distro => develop/distro.rst} | 177 ++++++++++------------ doc/develop/index.rst | 1 + 2 files changed, 80 insertions(+), 98 deletions(-) rename doc/{README.distro => develop/distro.rst} (76%)

diff --git a/doc/README.distro b/doc/develop/distro.rst similarity index 76% rename from doc/README.distro rename to doc/develop/distro.rst index c4f041ca712..105dcf28190 100644 --- a/doc/README.distro +++ b/doc/develop/distro.rst @@ -1,9 +1,4 @@ -SPDX-License-Identifier: GPL-2.0+ -/* - * (C) Copyright 2014 Red Hat Inc. - * Copyright (c) 2014-2015, NVIDIA CORPORATION. All rights reserved. - * Copyright (C) 2015 K. Merker merker@debian.org - */ +.. SPDX-License-Identifier: GPL-2.0+

Generic Distro Configuration Concept ==================================== @@ -73,9 +68,8 @@ Boot Configuration Files

The standard format for boot configuration files is that of extlinux.conf, as handled by U-Boot's "syslinux" (disk) or "pxe boot" (network). This is roughly -as specified at: +as specified at BootLoaderSpec_:

-http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/

... with the exceptions that the BootLoaderSpec document:

@@ -87,73 +81,70 @@ http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/ * Does not document the fdtdir option, which automatically selects the DTB to pass to the kernel.

-One example extlinux.conf generated by the Fedora installer is: +One example extlinux.conf generated by the Fedora installer is::

------------------------------------------------------------- -# extlinux.conf generated by anaconda + # extlinux.conf generated by anaconda

-ui menu.c32 + ui menu.c32

-menu autoboot Welcome to Fedora. Automatic boot in # second{,s}. Press a key for options. -menu title Fedora Boot Options. -menu hidden + menu autoboot Welcome to Fedora. Automatic boot in # second{,s}. Press a key for options. + menu title Fedora Boot Options. + menu hidden

-timeout 50 -#totaltimeout 9000 + timeout 50 + #totaltimeout 9000

-default Fedora (3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae) 22 (Rawhide) + default Fedora (3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae) 22 (Rawhide)

-label Fedora (3.17.0-0.rc4.git2.1.fc22.armv7hl) 22 (Rawhide) - kernel /boot/vmlinuz-3.17.0-0.rc4.git2.1.fc22.armv7hl - append ro root=UUID=8eac677f-8ea8-4270-8479-d5ddbb797450 console=ttyS0,115200n8 LANG=en_US.UTF-8 drm.debug=0xf - fdtdir /boot/dtb-3.17.0-0.rc4.git2.1.fc22.armv7hl - initrd /boot/initramfs-3.17.0-0.rc4.git2.1.fc22.armv7hl.img + label Fedora (3.17.0-0.rc4.git2.1.fc22.armv7hl) 22 (Rawhide) + kernel /boot/vmlinuz-3.17.0-0.rc4.git2.1.fc22.armv7hl + append ro root=UUID=8eac677f-8ea8-4270-8479-d5ddbb797450 console=ttyS0,115200n8 LANG=en_US.UTF-8 drm.debug=0xf + fdtdir /boot/dtb-3.17.0-0.rc4.git2.1.fc22.armv7hl + initrd /boot/initramfs-3.17.0-0.rc4.git2.1.fc22.armv7hl.img

-label Fedora (3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae) 22 (Rawhide) - kernel /boot/vmlinuz-3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae - append ro root=UUID=8eac677f-8ea8-4270-8479-d5ddbb797450 console=ttyS0,115200n8 LANG=en_US.UTF-8 drm.debug=0xf - fdtdir /boot/dtb-3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae - initrd /boot/initramfs-3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae.img + label Fedora (3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae) 22 (Rawhide) + kernel /boot/vmlinuz-3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae + append ro root=UUID=8eac677f-8ea8-4270-8479-d5ddbb797450 console=ttyS0,115200n8 LANG=en_US.UTF-8 drm.debug=0xf + fdtdir /boot/dtb-3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae + initrd /boot/initramfs-3.17.0-0.rc4.git2.1.fc22.armv7hl+lpae.img

-label Fedora-0-rescue-8f6ba7b039524e0eb957d2c9203f04bc (0-rescue-8f6ba7b039524e0eb957d2c9203f04bc) - kernel /boot/vmlinuz-0-rescue-8f6ba7b039524e0eb957d2c9203f04bc - initrd /boot/initramfs-0-rescue-8f6ba7b039524e0eb957d2c9203f04bc.img - append ro root=UUID=8eac677f-8ea8-4270-8479-d5ddbb797450 console=ttyS0,115200n8 - fdtdir /boot/dtb-3.16.0-0.rc6.git1.1.fc22.armv7hl+lpae ------------------------------------------------------------- + label Fedora-0-rescue-8f6ba7b039524e0eb957d2c9203f04bc (0-rescue-8f6ba7b039524e0eb957d2c9203f04bc) + kernel /boot/vmlinuz-0-rescue-8f6ba7b039524e0eb957d2c9203f04bc + initrd /boot/initramfs-0-rescue-8f6ba7b039524e0eb957d2c9203f04bc.img + append ro root=UUID=8eac677f-8ea8-4270-8479-d5ddbb797450 console=ttyS0,115200n8 + fdtdir /boot/dtb-3.16.0-0.rc6.git1.1.fc22.armv7hl+lpae

-Another hand-crafted network boot configuration file is:

------------------------------------------------------------- -TIMEOUT 100 +Another hand-crafted network boot configuration file is::

-MENU TITLE TFTP boot options + TIMEOUT 100

-LABEL jetson-tk1-emmc - MENU LABEL ../zImage root on Jetson TK1 eMMC - LINUX ../zImage - FDTDIR ../ - APPEND console=ttyS0,115200n8 console=tty1 loglevel=8 rootwait rw earlyprintk root=PARTUUID=80a5a8e9-c744-491a-93c1-4f4194fd690b + MENU TITLE TFTP boot options

-LABEL venice2-emmc - MENU LABEL ../zImage root on Venice2 eMMC - LINUX ../zImage - FDTDIR ../ - APPEND console=ttyS0,115200n8 console=tty1 loglevel=8 rootwait rw earlyprintk root=PARTUUID=5f71e06f-be08-48ed-b1ef-ee4800cc860f + LABEL jetson-tk1-emmc + MENU LABEL ../zImage root on Jetson TK1 eMMC + LINUX ../zImage + FDTDIR ../ + APPEND console=ttyS0,115200n8 console=tty1 loglevel=8 rootwait rw earlyprintk root=PARTUUID=80a5a8e9-c744-491a-93c1-4f4194fd690b

-LABEL sdcard - MENU LABEL ../zImage, root on 2GB sdcard - LINUX ../zImage - FDTDIR ../ - APPEND console=ttyS0,115200n8 console=tty1 loglevel=8 rootwait rw earlyprintk root=PARTUUID=b2f82cda-2535-4779-b467-094a210fbae7 + LABEL venice2-emmc + MENU LABEL ../zImage root on Venice2 eMMC + LINUX ../zImage + FDTDIR ../ + APPEND console=ttyS0,115200n8 console=tty1 loglevel=8 rootwait rw earlyprintk root=PARTUUID=5f71e06f-be08-48ed-b1ef-ee4800cc860f

-LABEL fedora-installer-fk - MENU LABEL Fedora installer w/ Fedora kernel - LINUX fedora-installer/vmlinuz - INITRD fedora-installer/initrd.img.orig - FDTDIR fedora-installer/dtb - APPEND loglevel=8 ip=dhcp inst.repo=http://10.0.0.2/mirrors/fedora/linux/development/rawhide/armhfp/os/ rd.shell cma=64M ------------------------------------------------------------- + LABEL sdcard + MENU LABEL ../zImage, root on 2GB sdcard + LINUX ../zImage + FDTDIR ../ + APPEND console=ttyS0,115200n8 console=tty1 loglevel=8 rootwait rw earlyprintk root=PARTUUID=b2f82cda-2535-4779-b467-094a210fbae7 + + LABEL fedora-installer-fk + MENU LABEL Fedora installer w/ Fedora kernel + LINUX fedora-installer/vmlinuz + INITRD fedora-installer/initrd.img.orig + FDTDIR fedora-installer/dtb + APPEND loglevel=8 ip=dhcp inst.repo=http://10.0.0.2/mirrors/fedora/linux/development/rawhide/armhfp/os/ rd.shell cma=64M

U-Boot Implementation ===================== @@ -166,13 +157,11 @@ a line with "CONFIG_DISTRO_DEFAULTS=y". If you want to enable this from Kconfig itself, for e.g. all boards using a specific SoC then add a "imply DISTRO_DEFAULTS" to your SoC CONFIG option.

-In your board configuration file, include the following: +In your board configuration file, include the following::

------------------------------------------------------------- -#ifndef CONFIG_SPL_BUILD -#include <config_distro_bootcmd.h> -#endif ------------------------------------------------------------- + #ifndef CONFIG_SPL_BUILD + #include <config_distro_bootcmd.h> + #endif

The first of those headers primarily enables a core set of U-Boot features, such as support for MBR and GPT partitions, ext* and FAT filesystems, booting @@ -205,7 +194,6 @@ CONFIG_EXTRA_ENV_SETTINGS in the board's U-Boot configuration file, so that the user doesn't have to configure them.

fdt_addr: - Mandatory for any system that provides the DTB in HW (e.g. ROM) and wishes to pass that DTB to Linux, rather than loading a DTB from the boot filesystem. Prohibited for any other system. @@ -214,7 +202,6 @@ fdt_addr: address.

fdt_addr_r: - Mandatory. The location in RAM where the DTB will be loaded or copied to when processing the fdtdir/devicetreedir or fdt/devicetree options in extlinux.conf. @@ -225,7 +212,6 @@ fdt_addr_r: A size of 1MB for the FDT/DTB seems reasonable.

fdtfile: - Mandatory. the name of the DTB file for the specific board for instance the espressobin v5 board the value is "marvell/armada-3720-espressobin.dtb" while on a clearfog pro it is "armada-388-clearfog-pro.dtb" in the case of @@ -236,16 +222,14 @@ fdtfile: SoC vendor directories.

ramdisk_addr_r: - Mandatory. The location in RAM where the initial ramdisk will be loaded to when processing the initrd option in extlinux.conf.

- It is recommended that this location be highest in RAM out of fdt_addr_, + It is recommended that this location be highest in RAM out of fdt_addr_r, kernel_addr_r, and ramdisk_addr_r, so that the RAM disk can vary in size and use any available RAM.

kernel_addr_r: - Mandatory. The location in RAM where the kernel will be loaded to when processing the kernel option in the extlinux.conf.

@@ -270,14 +254,12 @@ kernel_comp_size: size has to at least the size of loaded image for decompression to succeed.

pxefile_addr_r: - Mandatory. The location in RAM where extlinux.conf will be loaded to prior to processing.

A size of 1MB for extlinux.conf is more than adequate.

scriptaddr: - Mandatory, if the boot script is boot.scr rather than extlinux.conf. The location in RAM where boot.scr will be loaded to prior to execution.

@@ -292,24 +274,22 @@ MEM_LAYOUT_ENV_SETTINGS in include/configs/tegra124-common.h. Boot Target Configuration -------------------------

-<config_distro_bootcmd.h> defines $bootcmd and many helper command variables -that automatically search attached disks for boot configuration files and -execute them. Boards must provide configure <config_distro_bootcmd.h> so that -it supports the correct set of possible boot device types. To provide this +The `config_distro_bootcmd.h` file defines $bootcmd and many helper command +variables that automatically search attached disks for boot configuration files +and execute them. Boards must provide configure <config_distro_bootcmd.h> so +that it supports the correct set of possible boot device types. To provide this configuration, simply define macro BOOT_TARGET_DEVICES prior to including -<config_distro_bootcmd.h>. For example: - ------------------------------------------------------------- -#ifndef CONFIG_SPL_BUILD -#define BOOT_TARGET_DEVICES(func) \ - func(MMC, mmc, 1) \ - func(MMC, mmc, 0) \ - func(USB, usb, 0) \ - func(PXE, pxe, na) \ - func(DHCP, dhcp, na) -#include <config_distro_bootcmd.h> -#endif ------------------------------------------------------------- +<config_distro_bootcmd.h>. For example:: + + #ifndef CONFIG_SPL_BUILD + #define BOOT_TARGET_DEVICES(func) \ + func(MMC, mmc, 1) \ + func(MMC, mmc, 0) \ + func(USB, usb, 0) \ + func(PXE, pxe, na) \ + func(DHCP, dhcp, na) + #include <config_distro_bootcmd.h> + #endif

Each entry in the macro defines a single boot device (e.g. a specific eMMC device or SD card) or type of boot device (e.g. USB disk). The parameters to @@ -328,7 +308,6 @@ up by <config_distro_bootcmd.h>. After this, various environment variables may be altered to influence the boot process:

boot_targets: - The list of boot locations searched.

Example: mmc0, mmc1, usb, pxe @@ -336,7 +315,6 @@ boot_targets: Entries may be removed or re-ordered in this list to affect the boot order.

boot_prefixes: - For disk-based booting, the list of directories within a partition that are searched for boot configuration files (extlinux.conf, boot.scr).

@@ -346,7 +324,6 @@ boot_prefixes: directories which are searched.

boot_scripts: - The name of U-Boot style boot.scr files that $bootcmd searches for.

Example: boot.scr.uimg boot.scr @@ -358,17 +335,14 @@ boot_scripts: filenames which are supported.

scan_dev_for_extlinux: - If you want to disable extlinux.conf on all disks, set the value to something innocuous, e.g. setenv scan_dev_for_extlinux true.

scan_dev_for_scripts: - If you want to disable boot.scr on all disks, set the value to something innocuous, e.g. setenv scan_dev_for_scripts true.

boot_net_usb_start: - If you want to prevent USB enumeration by distro boot commands which execute network operations, set the value to something innocuous, e.g. setenv boot_net_usb_start true. This would be useful if you know your Ethernet @@ -376,7 +350,6 @@ boot_net_usb_start: avoiding unnecessary actions.

boot_net_pci_enum: - If you want to prevent PCI enumeration by distro boot commands which execute network operations, set the value to something innocuous, e.g. setenv boot_net_pci_enum true. This would be useful if you know your Ethernet @@ -412,10 +385,12 @@ Examples: The list of possible targets consists of:

- network targets + * dhcp * pxe

- storage targets (to which a device number must be appended) + * mmc * sata * scsi @@ -428,3 +403,9 @@ of the boot environment and are not guaranteed to exist or work in the same way in future u-boot versions. In particular the <device type>_boot variables (e.g. mmc_boot, usb_boot) are a strictly internal implementation detail and must not be used as a public interface. + +.. _BootLoaderSpec: http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/ + +.. sectionauthor:: (C) Copyright 2014 Red Hat Inc. +.. sectionauthor:: Copyright (c) 2014-2015, NVIDIA CORPORATION. All rights reserved. +.. sectionauthor:: Copyright (C) 2015 K. Merker merker@debian.org diff --git a/doc/develop/index.rst b/doc/develop/index.rst index 83c929babda..1fb0f06f6e8 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -12,6 +12,7 @@ Implementation ci_testing commands devicetree/index + distro driver-model/index global_data logging

Add a uclass for bootmethod and the various helpers needed to make it work.

Signed-off-by: Simon Glass sjg@chromium.org ---

MAINTAINERS | 6 + boot/Kconfig | 9 + boot/Makefile | 1 + boot/bootmethod.c | 445 +++++++++++++++++++++++++++++++++++++++++ include/bootmethod.h | 355 ++++++++++++++++++++++++++++++++ include/dm/uclass-id.h | 1 + 6 files changed, 817 insertions(+) create mode 100644 boot/bootmethod.c create mode 100644 include/bootmethod.h

diff --git a/MAINTAINERS b/MAINTAINERS index 776ff703b9b..d977cee562b 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -630,6 +630,12 @@ M: Simon Glass sjg@chromium.org S: Maintained F: tools/binman/

+BOOTMETHOD +M: Simon Glass sjg@chromium.org +S: Maintained +F: boot/bootmethod.c +F: include/bootmethod.h + BTRFS M: Marek Behun marek.behun@nic.cz R: Qu Wenruo wqu@suse.com diff --git a/boot/Kconfig b/boot/Kconfig index 0d4c38402c1..90f716c3ef1 100644 --- a/boot/Kconfig +++ b/boot/Kconfig @@ -290,6 +290,15 @@ endif # SPL

endif # FIT

+config BOOTMETHOD + bool "Bootmethod support" + default y + help + A bootmethod is a standard way of locating something to boot, + typically an Operating System such as Linux. Enable this to support + iterating through available bootmethods to find a bootflow suitable + for booting. + config LEGACY_IMAGE_FORMAT bool "Enable support for the legacy image format" default y if !FIT_SIGNATURE diff --git a/boot/Makefile b/boot/Makefile index e8f984248e6..10d427e115c 100644 --- a/boot/Makefile +++ b/boot/Makefile @@ -22,6 +22,7 @@ endif obj-y += image.o obj-$(CONFIG_ANDROID_AB) += android_ab.o obj-$(CONFIG_ANDROID_BOOT_IMAGE) += image-android.o image-android-dt.o +obj-$(CONFIG_$(SPL_TPL_)BOOTMETHOD) += bootmethod.o obj-$(CONFIG_$(SPL_TPL_)OF_LIBFDT) += image-fdt.o obj-$(CONFIG_$(SPL_TPL_)FIT_SIGNATURE) += fdt_region.o obj-$(CONFIG_$(SPL_TPL_)FIT) += image-fit.o diff --git a/boot/bootmethod.c b/boot/bootmethod.c new file mode 100644 index 00000000000..8e4157c6a47 --- /dev/null +++ b/boot/bootmethod.c @@ -0,0 +1,445 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Copyright 2021 Google LLC + * Written by Simon Glass sjg@chromium.org + */ + +#include <common.h> +#include <blk.h> +#include <bootmethod.h> +#include <dm.h> +#include <fs.h> +#include <log.h> +#include <malloc.h> +#include <part.h> +#include <dm/lists.h> +#include <dm/uclass-internal.h> + +enum { + /* + * Set some sort of limit on the number of bootflows a bootmethod can + * return. Note that for disks this limits the partitions numbers that + * are scanned to 1..MAX_BOOTFLOWS_PER_BOOTMETHOD + */ + MAX_BOOTFLOWS_PER_BOOTMETHOD = 20, +}; + +static const char *const bootmethod_state[BOOTFLOWST_COUNT] = { + "base", + "media", + "part", + "fs", + "file", + "loaded", +}; + +static const char *const bootmethod_type[BOOTFLOWT_COUNT] = { +}; + +int bootmethod_get_state(struct bootflow_state **statep) +{ + struct uclass *uc; + int ret; + + ret = uclass_get(UCLASS_BOOTMETHOD, &uc); + if (ret) + return ret; + *statep = uclass_get_priv(uc); + + return 0; +} + +const char *bootmethod_state_get_name(enum bootflow_state_t state) +{ + if (state < 0 || state >= BOOTFLOWST_COUNT) + return "?"; + + return bootmethod_state[state]; +} + +const char *bootmethod_type_get_name(enum bootflow_type_t type) +{ + if (type < 0 || type >= BOOTFLOWT_COUNT) + return "?"; + + return bootmethod_type[type]; +} + +void bootflow_free(struct bootflow *bflow) +{ + free(bflow->name); + free(bflow->subdir); + free(bflow->fname); + free(bflow->buf); +} + +void bootflow_remove(struct bootflow *bflow) +{ + list_del(&bflow->bm_node); + list_del(&bflow->glob_node); + + bootflow_free(bflow); + free(bflow); +} + +void bootmethod_clear_bootflows(struct udevice *dev) +{ + struct bootmethod_uc_plat *ucp = dev_get_uclass_plat(dev); + + while (!list_empty(&ucp->bootflow_head)) { + struct bootflow *bflow; + + bflow = list_first_entry(&ucp->bootflow_head, struct bootflow, + bm_node); + bootflow_remove(bflow); + } +} + +void bootmethod_clear_glob(void) +{ + struct bootflow_state *state; + + if (bootmethod_get_state(&state)) + return; + + while (!list_empty(&state->glob_head)) { + struct bootflow *bflow; + + bflow = list_first_entry(&state->glob_head, struct bootflow, + glob_node); + bootflow_remove(bflow); + } +} + +int bootmethod_add_bootflow(struct bootflow *bflow) +{ + struct bootmethod_uc_plat *ucp = dev_get_uclass_plat(bflow->dev); + struct bootflow_state *state; + struct bootflow *new; + int ret; + + assert(bflow->dev); + ret = bootmethod_get_state(&state); + if (ret) + return ret; + + new = malloc(sizeof(*bflow)); + if (!new) + return log_msg_ret("bflow", -ENOMEM); + memcpy(new, bflow, sizeof(*bflow)); + + list_add_tail(&new->glob_node, &state->glob_head); + list_add_tail(&new->bm_node, &ucp->bootflow_head); + + return 0; +} + +int bootmethod_first_bootflow(struct udevice *dev, struct bootflow **bflowp) +{ + struct bootmethod_uc_plat *ucp = dev_get_uclass_plat(dev); + + if (list_empty(&ucp->bootflow_head)) + return -ENOENT; + + *bflowp = list_first_entry(&ucp->bootflow_head, struct bootflow, + bm_node); + + return 0; +} + +int bootmethod_next_bootflow(struct bootflow **bflowp) +{ + struct bootflow *bflow = *bflowp; + struct bootmethod_uc_plat *ucp = dev_get_uclass_plat(bflow->dev); + + *bflowp = NULL; + + if (list_is_last(&bflow->bm_node, &ucp->bootflow_head)) + return -ENOENT; + + *bflowp = list_entry(bflow->bm_node.next, struct bootflow, bm_node); + + return 0; +} + +int bootflow_first_glob(struct bootflow **bflowp) +{ + struct bootflow_state *state; + int ret; + + ret = bootmethod_get_state(&state); + if (ret) + return ret; + + if (list_empty(&state->glob_head)) + return -ENOENT; + + *bflowp = list_first_entry(&state->glob_head, struct bootflow, + glob_node); + + return 0; +} + +int bootflow_next_glob(struct bootflow **bflowp) +{ + struct bootflow_state *state; + struct bootflow *bflow = *bflowp; + int ret; + + ret = bootmethod_get_state(&state); + if (ret) + return ret; + + *bflowp = NULL; + + if (list_is_last(&bflow->glob_node, &state->glob_head)) + return -ENOENT; + + *bflowp = list_entry(bflow->glob_node.next, struct bootflow, glob_node); + + return 0; +} + +int bootmethod_get_bootflow(struct udevice *dev, int seq, + struct bootflow *bflow) +{ + const struct bootmethod_ops *ops = bootmethod_get_ops(dev); + + if (!ops->get_bootflow) + return -ENOSYS; + memset(bflow, '\0', sizeof(*bflow)); + bflow->dev = dev; + bflow->seq = seq; + + return ops->get_bootflow(dev, seq, bflow); +} + +static int next_bootflow(struct udevice *dev, int seq, struct bootflow *bflow) +{ + int ret; + + ret = bootmethod_get_bootflow(dev, seq, bflow); + if (ret) + return ret; + + return 0; +} + +static void bootmethod_iter_set_dev(struct bootmethod_iter *iter, + struct udevice *dev) +{ + iter->dev = dev; + if (iter->flags & BOOTFLOWF_SHOW) { + if (dev) + printf("Scanning bootmethod '%s':\n", dev->name); + else + printf("No more bootmethods\n"); + } +} + +int bootmethod_scan_first_bootflow(struct bootmethod_iter *iter, int flags, + struct bootflow *bflow) +{ + struct udevice *dev; + int ret; + + iter->flags = flags; + iter->seq = 0; + ret = uclass_first_device_err(UCLASS_BOOTMETHOD, &dev); + if (ret) + return ret; + bootmethod_iter_set_dev(iter, dev); + + ret = bootmethod_scan_next_bootflow(iter, bflow); + if (ret) + return ret; + + return 0; +} + +int bootmethod_scan_next_bootflow(struct bootmethod_iter *iter, + struct bootflow *bflow) +{ + struct udevice *dev; + int ret; + + do { + dev = iter->dev; + ret = next_bootflow(dev, iter->seq, bflow); + + /* If we got a valid bootflow, return it */ + if (!ret) { + log_debug("Bootmethod '%s' seq %d: Found bootflow\n", + dev->name, iter->seq); + iter->seq++; + return 0; + } + + /* + * Unless there are no more partitions or no bootflow support, + * try the next partition + */ + else if (ret != -ESHUTDOWN && ret != -ENOSYS) { + log_debug("Bootmethod '%s' seq %d: Error %d\n", + dev->name, iter->seq, ret); + if ((iter->seq++ != MAX_BOOTFLOWS_PER_BOOTMETHOD) && + (iter->flags & BOOTFLOWF_ALL)) + return log_msg_ret("all", ret); + } + + /* we got to the end of that bootmethod, try the next */ + ret = uclass_next_device_err(&dev); + bootmethod_iter_set_dev(iter, dev); + + /* if there are no more bootmethods, give up */ + if (ret) + return ret; + + /* start at the beginning of this bootmethod */ + iter->seq = 0; + } while (1); +} + +int bootmethod_bind(struct udevice *parent, const char *drv_name, + const char *name, struct udevice **devp) +{ + struct udevice *dev; + char dev_name[30]; + char *str; + int ret; + + snprintf(dev_name, sizeof(dev_name), "%s.%s", parent->name, name); + str = strdup(dev_name); + if (!str) + return -ENOMEM; + ret = device_bind_driver(parent, drv_name, str, &dev); + if (ret) + return ret; + *devp = dev; + + return 0; +} + +int bootmethod_find_in_blk(struct udevice *dev, struct udevice *blk, int seq, + struct bootflow *bflow) +{ + struct blk_desc *desc = dev_get_uclass_plat(blk); + struct disk_partition info; + char name[60]; + int partnum = seq + 1; + int ret; + + if (seq >= MAX_BOOTFLOWS_PER_BOOTMETHOD) + return -ESHUTDOWN; + + bflow->blk = blk; + bflow->seq = seq; + snprintf(name, sizeof(name), "%s.part_%x", dev->name, partnum); + bflow->name = strdup(name); + if (!bflow->name) + return log_msg_ret("name", -ENOMEM); + + bflow->state = BOOTFLOWST_BASE; + ret = part_get_info(desc, partnum, &info); + + /* This error indicates the media is not present */ + if (ret != -EOPNOTSUPP) + bflow->state = BOOTFLOWST_MEDIA; + if (ret) + return log_msg_ret("part", ret); + + bflow->state = BOOTFLOWST_PART; + bflow->part = partnum; + ret = fs_set_blk_dev_with_part(desc, partnum); +#ifdef CONFIG_DOS_PARTITION + log_debug("%s: Found partition %x type %x fstype %d\n", blk->name, + partnum, info.sys_ind, ret ? -1 : fs_get_type()); +#endif + if (ret) + return log_msg_ret("fs", ret); + + bflow->state = BOOTFLOWST_FS; + + return 0; +} + +int bootflow_boot(struct bootflow *bflow) +{ + bool done = false; + int ret; + + if (bflow->state != BOOTFLOWST_LOADED) + return log_msg_ret("load", -EPROTO); + + switch (bflow->type) { + case BOOTFLOWT_COUNT: + break; + } + + if (!done) + return log_msg_ret("type", -ENOSYS); + + if (ret) + return log_msg_ret("boot", ret); + + /* + * internal error, should not get here since we should have booted + * something or returned an error + */ + + return log_msg_ret("end", -EFAULT); +} + +int bootmethod_setup_for_dev(struct udevice *parent, const char *drv_name) +{ + struct udevice *bm; + int ret; + + if (!CONFIG_IS_ENABLED(BOOTMETHOD)) + return 0; + + ret = device_find_first_child_by_uclass(parent, UCLASS_BOOTMETHOD, + &bm); + if (ret) { + if (ret != -ENODEV) { + log_debug("Cannot access bootmethod device\n"); + return ret; + } + + ret = bootmethod_bind(parent, drv_name, "bootmethod", &bm); + if (ret) { + log_debug("Cannot create bootmethod device\n"); + return ret; + } + } + + return 0; +} + +static int bootmethod_init(struct uclass *uc) +{ + struct bootflow_state *state = uclass_get_priv(uc); + + INIT_LIST_HEAD(&state->glob_head); + + return 0; +} + +static int bootmethod_post_bind(struct udevice *dev) +{ + struct bootmethod_uc_plat *ucp = dev_get_uclass_plat(dev); + + INIT_LIST_HEAD(&ucp->bootflow_head); + + return 0; +} + +UCLASS_DRIVER(bootmethod) = { + .id = UCLASS_BOOTMETHOD, + .name = "bootmethod", + .flags = DM_UC_FLAG_SEQ_ALIAS, + .priv_auto = sizeof(struct bootflow_state), + .per_device_plat_auto = sizeof(struct bootmethod_uc_plat), + .init = bootmethod_init, + .post_bind = bootmethod_post_bind, +}; diff --git a/include/bootmethod.h b/include/bootmethod.h new file mode 100644 index 00000000000..a45897b0c0c --- /dev/null +++ b/include/bootmethod.h @@ -0,0 +1,355 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ +/* + * Copyright 2021 Google LLC + * Written by Simon Glass sjg@chromium.org + */ + +#ifndef __bootmethod_h +#define __bootmethod_h + +#include <linux/list.h> + +/** + * enum bootflow_state_t - states that a particular bootflow can be in + */ +enum bootflow_state_t { + BOOTFLOWST_BASE, /**< Nothing known yet */ + BOOTFLOWST_MEDIA, /**< Media exists */ + BOOTFLOWST_PART, /**< Partition exists */ + BOOTFLOWST_FS, /**< Filesystem exists */ + BOOTFLOWST_FILE, /**< Bootflow file exists */ + BOOTFLOWST_LOADED, /**< Bootflow file loaded */ + + BOOTFLOWST_COUNT +}; + +enum bootflow_type_t { + BOOTFLOWT_COUNT, +}; + +/** + * struct bootflow_state - information about available bootflows, etc. + * + * This is attached to the bootmethod uclass so there is only one of them. It + * provides overall information about bootmethods and bootflows. + * + * @cur_bootmethod: Currently selected bootmethod (for commands) + * @cur_bootflow: Currently selected bootflow (for commands) + * @glob_head: Head for the global list of all bootmethods across all bootflows + */ +struct bootflow_state { + struct udevice *cur_bootmethod; + struct bootflow *cur_bootflow; + struct list_head glob_head; +}; + +/** + * struct bootmethod_uc_plat - uclass information about a bootmethod + * + * This is attached to each device in the bootmethod uclass and accessible via + * dev_get_uclass_plat(dev) + * + * @bootflows: List of available bootflows for this bootmethod + */ +struct bootmethod_uc_plat { + struct list_head bootflow_head; +}; + +extern struct bootflow_cmds g_bootflow_cmds; + +/** + * struct bootflow - information about a bootflow + * + * This is connected into two separate linked lists: + * + * bm_sibling - links all bootflows in the same bootmethod + * glob_sibling - links all bootflows in all bootmethods + * + * @bm_node: Points to siblings in the same bootmethod + * @glob_node: Points to siblings in the global list (all bootmethod) + * @dev: Bootmethod device which produced this bootflow + * @blk: Block device which contains this bootflow, NULL if this is a network + * device + * @seq: Sequence number of bootflow within its bootmethod, typically the + * partition number (0...) + * @name: Name of bootflow (allocated) + * @type: Bootflow type (enum bootflow_type_t) + * @state: Current state (enum bootflow_state_t) + * @part: Partition number + * @subdir: Subdirectory to fetch files from (with trailing /), or NULL if none + * @fname: Filename of bootflow file (allocated) + * @buf: Bootflow file contents (allocated) + * @size: Size of bootflow file in bytes + * @err: Error number received (0 if OK) + */ +struct bootflow { + struct list_head bm_node; + struct list_head glob_node; + struct udevice *dev; + struct udevice *blk; + int seq; + char *name; + enum bootflow_type_t type; + enum bootflow_state_t state; + int part; + char *subdir; + char *fname; + char *buf; + int size; + int err; +}; + +/** + * enum bootflow_flags_t - flags for the bootflow + * + * @BOOTFLOWF_FIXED: Only used fixed/internal media + * @BOOTFLOWF_SHOW: Show each bootmethod before scanning it + * @BOOTFLOWF_ALL: Return bootflows with errors as well + */ +enum bootflow_flags_t { + BOOTFLOWF_FIXED = 1 << 0, + BOOTFLOWF_SHOW = 1 << 1, + BOOTFLOWF_ALL = 1 << 2, +}; + +/** + * struct bootmethod_iter - state for iterating through bootflows + * + * @flags: Flags to use (see enum bootflow_flags_t) + * @dev: Current bootmethod + * @seq: Current sequence number within that bootmethod (determines partition + * number, for example) + */ +struct bootmethod_iter { + int flags; + struct udevice *dev; + int seq; +}; + +/** + * struct bootmethod_ops - Operations for the Platform Controller Hub + * + * Consider using ioctl() to add rarely used or driver-specific operations. + */ +struct bootmethod_ops { + /** + * get_bootflow() - get a bootflow + * + * @dev: Bootflow device to check + * @seq: Sequence number of bootflow to read (0 for first) + * @bflow: Returns bootflow if found + * @return 0 if OK, -ESHUTDOWN if there are no more bootflows on this + * device, -ENOSYS if this device doesn't support bootflows, + * other -ve value on other error + */ + int (*get_bootflow)(struct udevice *dev, int seq, + struct bootflow *bflow); +}; + +#define bootmethod_get_ops(dev) ((struct bootmethod_ops *)(dev)->driver->ops) + +/** + * bootmethod_get_bootflow() - get a bootflow + * + * @dev: Bootflow device to check + * @seq: Sequence number of bootflow to read (0 for first) + * @bflow: Returns bootflow if found + * @return 0 if OK, -ESHUTDOWN if there are no more bootflows on this device, + * -ENOSYS if this device doesn't support bootflows, other -ve value on + * other error + */ +int bootmethod_get_bootflow(struct udevice *dev, int seq, + struct bootflow *bflow); + +/** + * bootmethod_scan_first_bootflow() - find the first bootflow + * + * This works through the available bootmethod devices until it finds one that + * can supply a bootflow. It then returns that + * + * If @flags includes BOOTFLOWF_ALL then bootflows with errors are returned too + * + * @iter: Place to store private info (inited by this call) + * @flags: Flags for bootmethod (enum bootflow_flags_t) + * @bflow: Place to put the bootflow if found + * @return 0 if found, -ESHUTDOWN if no more bootflows, other -ve on error + */ +int bootmethod_scan_first_bootflow(struct bootmethod_iter *iter, int flags, + struct bootflow *bflow); + +/** + * bootmethod_scan_next_bootflow() - find the next bootflow + * + * This works through the available bootmethod devices until it finds one that + * can supply a bootflow. It then returns that bootflow + * + * @iter: Private info (as set up by bootmethod_scan_first_bootflow()) + * @bflow: Place to put the bootflow if found + * @return 0 if found, -ESHUTDOWN if no more bootflows, -ve on error + */ +int bootmethod_scan_next_bootflow(struct bootmethod_iter *iter, + struct bootflow *bflow); + +/** + * bootmethod_bind() - Bind a new named bootmethod device + * + * @parent: Parent of the new device + * @drv_name: Driver name to use for the bootmethod device + * @name: Name for the device (parent name is prepended) + * @devp: the new device (which has not been probed) + */ +int bootmethod_bind(struct udevice *parent, const char *drv_name, + const char *name, struct udevice **devp); + +/** + * bootmethod_find_in_blk() - Find a bootmethod in a block device + * + * @dev: Bootflow device associated with this block device + * @blk: Block device to search + * @seq: Sequence number within block device, used as the partition number, + * after adding 1 + * @bflow: Returns bootflow if found + * @return 0 if found, -ESHUTDOWN if no more bootflows, other -ve on error + */ +int bootmethod_find_in_blk(struct udevice *dev, struct udevice *blk, int seq, + struct bootflow *bflow); + +/** + * bootmethod_list() - List all available bootmethods + * + * @probe: true to probe devices, false to leave them as is + */ +void bootmethod_list(bool probe); + +/** + * bootmethod_state_get_name() - Get the name of a bootflow state + * + * @state: State to check + * @return name, or "?" if invalid + */ +const char *bootmethod_state_get_name(enum bootflow_state_t state); + +/** + * bootmethod_type_get_name() - Get the name of a bootflow state + * + * @type: Type to check + * @return name, or "?" if invalid + */ +const char *bootmethod_type_get_name(enum bootflow_type_t type); + +/** + * bootmethod_get_state() - Get the (single) state for the bootmethod system + * + * The state holds a global list of all bootflows that have been found. + * + * @return 0 if OK, -ve if the uclass does not exist + */ +int bootmethod_get_state(struct bootflow_state **statep); + +/** + * bootmethod_clear_bootflows() - Clear bootflows from a bootmethod + * + * Each bootmethod maintains a list of discovered bootflows. This provides a + * way to clear it. These bootflows are removed from the global list too. + * + * @dev: bootmethod device to update + */ +void bootmethod_clear_bootflows(struct udevice *dev); + +/** + * bootmethod_clear_glob() - Clear the global list of bootflows + * + * This removes all bootflows globally and across all bootmethods. + */ +void bootmethod_clear_glob(void); + +/** + * bootmethod_add_bootflow() - Add a bootflow to the bootmethod's list + * + * All fields in @bflow must be set up. Note that @bflow->dev is used to add the + * bootflow to that device. + * + * @dev: Bootmethod device to add to + * @bflow: Bootflow to add. Note that fields within bflow must be allocated + * since this function takes over ownership of these. This functions makes + * a copy of @bflow itself (without allocating its fields again), so the + * caller must dispose of the memory used by the @bflow pointer itself + * @return 0 if OK, -ENOMEM if out of memory + */ +int bootmethod_add_bootflow(struct bootflow *bflow); + +/** + * bootmethod_first_bootflow() - Get the first bootflow from a bootmethod + * + * Returns the first bootflow attached to a bootmethod + * + * @dev: bootmethod device + * @bflowp: Returns a pointer to the bootflow + * @return 0 if found, -ENOENT if there are no bootflows + */ +int bootmethod_first_bootflow(struct udevice *dev, struct bootflow **bflowp); + +/** + * bootmethod_next_bootflow() - Get the next bootflow from a bootmethod + * + * Returns the next bootflow attached to a bootmethod + * + * @bflowp: On entry, the last bootflow returned , e.g. from + * bootmethod_first_bootflow() + * @return 0 if found, -ENOENT if there are no more bootflows + */ +int bootmethod_next_bootflow(struct bootflow **bflowp); + +/** + * bootflow_first_glob() - Get the first bootflow from the global list + * + * Returns the first bootflow in the global list, no matter what bootflow it is + * attached to + * + * @bflowp: Returns a pointer to the bootflow + * @return 0 if found, -ENOENT if there are no bootflows + */ +int bootflow_first_glob(struct bootflow **bflowp); + +/** + * bootflow_next_glob() - Get the next bootflow from the global list + * + * Returns the next bootflow in the global list, no matter what bootflow it is + * attached to + * + * @bflowp: On entry, the last bootflow returned , e.g. from + * bootflow_first_glob() + * @return 0 if found, -ENOENT if there are no more bootflows + */ +int bootflow_next_glob(struct bootflow **bflowp); + +/** + * bootflow_free() - Free memory used by a bootflow + * + * This frees fields within @bflow, but not the @bflow pointer itself + */ +void bootflow_free(struct bootflow *bflow); + +/** + * bootflow_boot() - boot a bootflow + * + * @bflow: Bootflow to boot + * @return -EPROTO if bootflow has not been loaded, -ENOSYS if the bootflow + * type is not supported, -EFAULT if the boot returned without an error + * when we are expecting it to boot + */ +int bootflow_boot(struct bootflow *bflow); + +/** + * bootmethod_setup_for_dev() - Bind a new bootmethod device + * + * Creates a bootmethod device as a child of @parent. This should be called from + * the driver's bind() method or its uclass' post_bind() method. + * + * @parent: Parent device (e.g. MMC or Ethernet) + * @drv_name: Name of bootmethod driver to bind + * @return 0 if OK, -ve on error + */ +int bootmethod_setup_for_dev(struct udevice *parent, const char *drv_name); + +#endif diff --git a/include/dm/uclass-id.h b/include/dm/uclass-id.h index e7edd409f30..116d2f02f26 100644 --- a/include/dm/uclass-id.h +++ b/include/dm/uclass-id.h @@ -38,6 +38,7 @@ enum uclass_id { UCLASS_AXI, /* AXI bus */ UCLASS_BLK, /* Block device */ UCLASS_BOOTCOUNT, /* Bootcount backing store */ + UCLASS_BOOTMETHOD, /* Bootmethod for locating an OS to boot*/ UCLASS_BUTTON, /* Button */ UCLASS_CACHE, /* Cache controller */ UCLASS_CLK, /* Clock source, e.g. used by peripherals */

Add a 'bootmethod' command to handle listing and selection of bootmethods.

Signed-off-by: Simon Glass sjg@chromium.org ---

MAINTAINERS | 1 + cmd/Kconfig | 8 +++ cmd/bootmethod.c | 130 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 139 insertions(+) create mode 100644 cmd/bootmethod.c

diff --git a/MAINTAINERS b/MAINTAINERS index f78141c138b..655746265f8 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -635,6 +635,7 @@ M: Simon Glass sjg@chromium.org S: Maintained F: boot/bootmethod.c F: boot/distro.c +F: cmd/bootmethod.c F: include/bootmethod.h F: include/distro.h

diff --git a/cmd/Kconfig b/cmd/Kconfig index ffef3cc76ca..eec0dee8773 100644 --- a/cmd/Kconfig +++ b/cmd/Kconfig @@ -194,6 +194,14 @@ config CMD_BOOTM help Boot an application image from the memory.

+config CMD_BOOTMETHOD + bool "bootmethod" + default y if BOOTMETHOD + help + Support working with bootmethods, including listing available ones + and showing information about a particular one. It also allows + looking at bootflows available with the bootmethod. + config BOOTM_EFI bool "Support booting UEFI FIT images" depends on CMD_BOOTEFI && CMD_BOOTM && FIT diff --git a/cmd/bootmethod.c b/cmd/bootmethod.c new file mode 100644 index 00000000000..2620ff61eb2 --- /dev/null +++ b/cmd/bootmethod.c @@ -0,0 +1,130 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * 'bootmethod' command + * + * Copyright 2021 Google LLC + * Written by Simon Glass sjg@chromium.org + */ + +#include <common.h> +#include <bootmethod.h> +#include <command.h> +#include <dm.h> +#include <dm/device-internal.h> +#include <dm/uclass-internal.h> + +static int bootmethod_check_state(struct bootflow_state **statep) +{ + struct bootflow_state *state; + int ret; + + ret = bootmethod_get_state(&state); + if (ret) + return ret; + if (!state->cur_bootmethod) { + printf("Please use 'bootmethod select' first\n"); + return -ENOENT; + } + *statep = state; + + return 0; +} + +static int do_bootmethod_list(struct cmd_tbl *cmdtp, int flag, int argc, + char *const argv[]) +{ + bool probe; + + probe = argc >= 2 && !strcmp(argv[1], "-p"); + bootmethod_list(probe); + + return 0; +} + +static int do_bootmethod_select(struct cmd_tbl *cmdtp, int flag, int argc, + char *const argv[]) +{ + struct bootflow_state *state; + struct udevice *dev; + const char *name; + char *endp; + int seq; + int ret; + + ret = bootmethod_get_state(&state); + if (ret) + return CMD_RET_FAILURE; + if (argc < 2) { + state->cur_bootmethod = NULL; + return 0; + } + name = argv[1]; + seq = simple_strtol(name, &endp, 16); + + /* Select by name or number */ + if (*endp) + ret = uclass_get_device_by_name(UCLASS_BOOTMETHOD, name, &dev); + else + ret = uclass_get_device_by_seq(UCLASS_BOOTMETHOD, seq, &dev); + if (ret) { + printf("Cannot find '%s' (err=%d)\n", name, ret); + return CMD_RET_FAILURE; + } + state->cur_bootmethod = dev; + + return 0; +} + +static int do_bootmethod_info(struct cmd_tbl *cmdtp, int flag, int argc, + char *const argv[]) +{ + struct bootflow_state *state; + struct bootflow *bflow; + int ret, i, num_valid; + struct udevice *dev; + bool probe; + + probe = argc >= 2 && !strcmp(argv[1], "-p"); + + ret = bootmethod_check_state(&state); + if (ret) + return CMD_RET_FAILURE; + + dev = state->cur_bootmethod; + + /* Count the number of bootflows, including how many are valid*/ + num_valid = 0; + for (ret = bootmethod_first_bootflow(dev, &bflow), i = 0; + !ret; + ret = bootmethod_next_bootflow(&bflow), i++) + num_valid += bflow->state == BOOTFLOWST_LOADED; + + /* + * Prove the device, if requested, otherwise assume that there is no + * error + */ + ret = 0; + if (probe) + ret = device_probe(dev); + + printf("Name: %s\n", dev->name); + printf("Sequence: %d\n", dev_seq(dev)); + printf("Status: %s\n", ret ? simple_itoa(ret) : device_active(dev) ? + "Probed" : "OK"); + printf("Uclass: %s\n", dev_get_uclass_name(dev_get_parent(dev))); + printf("Bootflows: %d (%d valid)\n", i, num_valid); + + return 0; +} + +#ifdef CONFIG_SYS_LONGHELP +static char bootmethod_help_text[] = + "list [-p] - list all available bootmethods (-p to probe)\n" + "bootmethod select <bm> - select a bootmethod by name\n" + "bootmethod info [-p] - show information about a bootmethod (-p to probe)"; +#endif + +U_BOOT_CMD_WITH_SUBCMDS(bootmethod, "Bootmethods", bootmethod_help_text, + U_BOOT_SUBCMD_MKENT(list, 2, 1, do_bootmethod_list), + U_BOOT_SUBCMD_MKENT(select, 2, 1, do_bootmethod_select), + U_BOOT_SUBCMD_MKENT(info, 2, 1, do_bootmethod_info));

Add a set of combined tests for these two commands.

Expand the sandbox console-recording limit so that these can work.

These tests rely on a filesystem script which is not yet added to the Python tests. It is included here as a shell script.

Signed-off-by: Simon Glass sjg@chromium.org ---

MAINTAINERS | 1 + configs/sandbox_defconfig | 2 +- include/test/suites.h | 2 + test/Makefile | 1 + test/boot/Makefile | 5 + test/boot/bootmethod.c | 271 ++++++++++++++++++++++++++++++++++++++ test/cmd_ut.c | 4 + try.sh | 131 ++++++++++++++++++ 8 files changed, 416 insertions(+), 1 deletion(-) create mode 100644 test/boot/Makefile create mode 100644 test/boot/bootmethod.c create mode 100755 try.sh

diff --git a/MAINTAINERS b/MAINTAINERS index 367193358b7..2f74f7dbb19 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -639,6 +639,7 @@ F: cmd/bootflow.c F: cmd/bootmethod.c F: include/bootmethod.h F: include/distro.h +F: test/boot/bootmethod.c

BTRFS M: Marek Behun marek.behun@nic.cz diff --git a/configs/sandbox_defconfig b/configs/sandbox_defconfig index 952d430304c..31a8d6a1d90 100644 --- a/configs/sandbox_defconfig +++ b/configs/sandbox_defconfig @@ -26,7 +26,7 @@ CONFIG_AUTOBOOT_NEVER_TIMEOUT=y CONFIG_AUTOBOOT_STOP_STR_ENABLE=y CONFIG_AUTOBOOT_STOP_STR_CRYPT="$5$rounds=640000$HrpE65IkB8CM5nCL$BKT3QdF98Bo8fJpTr9tjZLZQyzqPASBY20xuK5Rent9" CONFIG_CONSOLE_RECORD=y -CONFIG_CONSOLE_RECORD_OUT_SIZE=0x1000 +CONFIG_CONSOLE_RECORD_OUT_SIZE=0x2000 CONFIG_PRE_CONSOLE_BUFFER=y CONFIG_LOG=y CONFIG_DISPLAY_BOARDINFO_LATE=y diff --git a/include/test/suites.h b/include/test/suites.h index d35cd83a4eb..c36aa568e78 100644 --- a/include/test/suites.h +++ b/include/test/suites.h @@ -29,6 +29,8 @@ int cmd_ut_category(const char *name, const char *prefix, int do_ut_addrmap(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); int do_ut_bootm(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); +int do_ut_bootmethod(struct cmd_tbl *cmdtp, int flag, int argc, + char *const argv[]); int do_ut_bloblist(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); int do_ut_common(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); diff --git a/test/Makefile b/test/Makefile index b3b2902e2e7..abd605a4351 100644 --- a/test/Makefile +++ b/test/Makefile @@ -22,6 +22,7 @@ obj-$(CONFIG_UT_TIME) += time_ut.o obj-y += ut.o

ifeq ($(CONFIG_SPL_BUILD),) +obj-$(CONFIG_UNIT_TEST) += boot/ obj-$(CONFIG_UNIT_TEST) += common/ obj-$(CONFIG_UNIT_TEST) += lib/ obj-y += log/ diff --git a/test/boot/Makefile b/test/boot/Makefile new file mode 100644 index 00000000000..bb1599b9c0d --- /dev/null +++ b/test/boot/Makefile @@ -0,0 +1,5 @@ +# SPDX-License-Identifier: GPL-2.0+ +# +# Copyright 2021 Google LLC + +obj-$(CONFIG_BOOTMETHOD) += bootmethod.o diff --git a/test/boot/bootmethod.c b/test/boot/bootmethod.c new file mode 100644 index 00000000000..4467625c0fd --- /dev/null +++ b/test/boot/bootmethod.c @@ -0,0 +1,271 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Copyright 2021 Google LLC + * Written by Simon Glass sjg@chromium.org + */ + +#include <common.h> +#include <dm.h> +#include <bootmethod.h> +#include <test/suites.h> +#include <test/ut.h> + +/* Declare a new bootmethod test */ +#define BOOTMETHOD_TEST(_name, _flags) \ + UNIT_TEST(_name, _flags, bootmethod_test) + +/* Check 'bootmethod list' command */ +static int bootmethod_test_cmd_list(struct unit_test_state *uts) +{ + int probed; + + console_record_reset_enable(); + for (probed = 0; probed < 2; probed++) { + int probe_ch = probed ? '+' : ' '; + + ut_assertok(run_command(probed ? "bootmethod list -p" : + "bootmethod list", 0)); + ut_assert_nextline("Seq Probed Status Uclass Name"); + ut_assert_nextlinen("---"); + ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 0, probe_ch, "OK", + "mmc", "mmc2.bootmethod"); + ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 1, probe_ch, "OK", + "mmc", "mmc1.bootmethod"); + ut_assert_nextline("%3x [ %c ] %6s %-8s %s", 2, probe_ch, "OK", + "mmc", "mmc0.bootmethod"); + ut_assert_nextlinen("---"); + ut_assert_nextline("(3 devices)"); + ut_assert_console_end(); + } + + return 0; +} +BOOTMETHOD_TEST(bootmethod_test_cmd_list, UT_TESTF_DM | UT_TESTF_SCAN_FDT); + +/* Check 'bootmethod select' and 'info' commands */ +static int bootmethod_test_cmd_select(struct unit_test_state *uts) +{ + console_record_reset_enable(); + ut_asserteq(1, run_command("bootmethod info", 0)); + ut_assert_nextlinen("Please use"); + ut_assert_console_end(); + + ut_assertok(run_command("bootmethod select 0", 0)); + ut_assert_console_end(); + + ut_assertok(run_command("bootmethod info", 0)); + ut_assert_nextline("Name: mmc2.bootmethod"); + ut_assert_nextline("Uclass: mmc"); + ut_assert_console_end(); + + return 0; +} +BOOTMETHOD_TEST(bootmethod_test_cmd_select, UT_TESTF_DM | UT_TESTF_SCAN_FDT); + +/* Check 'bootflow scan/list' commands */ +static int bootmethod_test_cmd_bootflow(struct unit_test_state *uts) +{ + console_record_reset_enable(); + ut_assertok(run_command("bootmethod select 2", 0)); + ut_assert_console_end(); + ut_assertok(run_command("bootflow scan -l", 0)); + ut_assert_nextline("Scanning for bootflows in bootmethod 'mmc0.bootmethod'"); + ut_assert_nextline("Seq Type State Uclass Part Name Filename"); + ut_assert_nextlinen("---"); + ut_assert_nextline(" 0 distro-boot loaded mmc 1 mmc0.bootmethod.part_1 extlinux/extlinux.conf"); + ut_assert_nextlinen("---"); + ut_assert_nextline("(21 bootflows, 1 valid)"); + ut_assert_console_end(); + + ut_assertok(run_command("bootflow list", 0)); + ut_assert_nextline("Showing bootflows for bootmethod 'mmc0.bootmethod'"); + ut_assert_nextline("Seq Type State Uclass Part Name Filename"); + ut_assert_nextlinen("---"); + ut_assert_nextline(" 0 distro-boot loaded mmc 1 mmc0.bootmethod.part_1 extlinux/extlinux.conf"); + ut_assert_nextlinen("---"); + ut_assert_nextline("(1 bootflow, 1 valid)"); + ut_assert_console_end(); + + return 0; +} +BOOTMETHOD_TEST(bootmethod_test_cmd_bootflow, UT_TESTF_DM | UT_TESTF_SCAN_FDT); + +/* Check 'bootflow scan/list' commands using all bootmethods */ +static int bootmethod_test_cmd_bootflow_glob(struct unit_test_state *uts) +{ + console_record_reset_enable(); + ut_assertok(run_command("bootflow scan -l", 0)); + ut_assert_nextline("Scanning for bootflows in all bootmethods"); + ut_assert_nextline("Seq Type State Uclass Part Name Filename"); + ut_assert_nextlinen("---"); + ut_assert_nextline("Scanning bootmethod 'mmc2.bootmethod':"); + ut_assert_nextline("Scanning bootmethod 'mmc1.bootmethod':"); + ut_assert_nextline("Scanning bootmethod 'mmc0.bootmethod':"); + ut_assert_nextline(" 0 distro-boot loaded mmc 1 mmc0.bootmethod.part_1 extlinux/extlinux.conf"); + ut_assert_nextline("No more bootmethods"); + ut_assert_nextlinen("---"); + ut_assert_nextline("(1 bootflow, 1 valid)"); + ut_assert_console_end(); + + ut_assertok(run_command("bootflow list", 0)); + ut_assert_nextline("Showing all bootflows"); + ut_assert_nextline("Seq Type State Uclass Part Name Filename"); + ut_assert_nextlinen("---"); + ut_assert_nextline(" 0 distro-boot loaded mmc 1 mmc0.bootmethod.part_1 extlinux/extlinux.conf"); + ut_assert_nextlinen("---"); + ut_assert_nextline("(1 bootflow, 1 valid)"); + ut_assert_console_end(); + + return 0; +} +BOOTMETHOD_TEST(bootmethod_test_cmd_bootflow_glob, + UT_TESTF_DM | UT_TESTF_SCAN_FDT); + +/* Check 'bootflow scan -e' */ +static int bootmethod_test_cmd_bootflow_scan_e(struct unit_test_state *uts) +{ + console_record_reset_enable(); + ut_assertok(run_command("bootflow scan -ale", 0)); + ut_assert_nextline("Scanning for bootflows in all bootmethods"); + ut_assert_nextline("Seq Type State Uclass Part Name Filename"); + ut_assert_nextlinen("---"); + ut_assert_nextline("Scanning bootmethod 'mmc2.bootmethod':"); + ut_assert_nextline(" 0 distro-boot media mmc 0 mmc2.bootmethod.part_1 <NULL>"); + ut_assert_nextline(" ** No partition found, err=-93"); + ut_assert_nextline(" 1 distro-boot media mmc 0 mmc2.bootmethod.part_2 <NULL>"); + + ut_assert_skip_to_line("Scanning bootmethod 'mmc1.bootmethod':"); + ut_assert_skip_to_line("Scanning bootmethod 'mmc0.bootmethod':"); + ut_assert_nextline(" 28 distro-boot loaded mmc 1 mmc0.bootmethod.part_1 extlinux/extlinux.conf"); + ut_assert_nextline(" 29 distro-boot media mmc 0 mmc0.bootmethod.part_2 <NULL>"); + ut_assert_skip_to_line(" 3b distro-boot media mmc 0 mmc0.bootmethod.part_14 <NULL>"); + ut_assert_nextline(" ** No partition found, err=-2"); + ut_assert_nextline("No more bootmethods"); + ut_assert_nextlinen("---"); + ut_assert_nextline("(60 bootflows, 1 valid)"); + ut_assert_console_end(); + + ut_assertok(run_command("bootflow list", 0)); + ut_assert_nextline("Showing all bootflows"); + ut_assert_nextline("Seq Type State Uclass Part Name Filename"); + ut_assert_nextlinen("---"); + ut_assert_nextline(" 0 distro-boot media mmc 0 mmc2.bootmethod.part_1 <NULL>"); + ut_assert_skip_to_line(" 28 distro-boot loaded mmc 1 mmc0.bootmethod.part_1 extlinux/extlinux.conf"); + ut_assert_skip_to_line(" 3b distro-boot media mmc 0 mmc0.bootmethod.part_14 <NULL>"); + ut_assert_nextlinen("---"); + ut_assert_nextline("(60 bootflows, 1 valid)"); + ut_assert_console_end(); + + return 0; +} +BOOTMETHOD_TEST(bootmethod_test_cmd_bootflow_scan_e, + UT_TESTF_DM | UT_TESTF_SCAN_FDT); + +/* Check 'bootflow info' */ +static int bootmethod_test_cmd_bootflow_info(struct unit_test_state *uts) +{ + console_record_reset_enable(); + ut_assertok(run_command("bootmethod select 2", 0)); + ut_assert_console_end(); + ut_assertok(run_command("bootflow scan", 0)); + ut_assert_console_end(); + ut_assertok(run_command("bootflow select 0", 0)); + ut_assert_console_end(); + ut_assertok(run_command("bootflow info", 0)); + ut_assert_nextline("Name: mmc0.bootmethod.part_1"); + ut_assert_nextline("Device: mmc0.bootmethod"); + ut_assert_nextline("Block dev: mmc0.blk"); + ut_assert_nextline("Sequence: 0"); + ut_assert_nextline("Type: distro-boot"); + ut_assert_nextline("State: loaded"); + ut_assert_nextline("Partition: 1"); + ut_assert_nextline("Subdir: (none)"); + ut_assert_nextline("Filename: extlinux/extlinux.conf"); + ut_assert_nextlinen("Buffer: "); + ut_assert_nextline("Size: 237 (567 bytes)"); + ut_assert_nextline("Error: 0"); + ut_assert_console_end(); + + ut_assertok(run_command("bootflow info -d", 0)); + ut_assert_nextline("Name: mmc0.bootmethod.part_1"); + ut_assert_skip_to_line("Error: 0"); + ut_assert_nextline("Contents:"); + ut_assert_nextline("%s", ""); + ut_assert_nextline("# extlinux.conf generated by appliance-creator"); + ut_assert_skip_to_line("initrd /initramfs-5.3.7-301.fc31.armv7hl.img"); + ut_assert_console_end(); + + return 0; +} +BOOTMETHOD_TEST(bootmethod_test_cmd_bootflow_info, + UT_TESTF_DM | UT_TESTF_SCAN_FDT); + +/* Check 'bootflow scan -b' to boot the first available bootmethod */ +static int bootmethod_test_cmd_bootflow_scan_boot(struct unit_test_state *uts) +{ + console_record_reset_enable(); + ut_assertok(run_command("bootflow scan -b", 0)); + ut_assert_nextline("** Booting bootflow 'mmc0.bootmethod.part_1'"); + ut_assert_nextline("Ignoring unknown command: ui"); + + /* + * We expect it to get through to boot although sandbox always returns + * -EFAULT as it cannot actually boot the kernel + */ + ut_assert_skip_to_line("sandbox: continuing, as we cannot run Linux"); + ut_assert_nextline("Boot failed (err=-14)"); + ut_assert_console_end(); + + return 0; +} +BOOTMETHOD_TEST(bootmethod_test_cmd_bootflow_scan_boot, + UT_TESTF_DM | UT_TESTF_SCAN_FDT); + +/* Check 'bootflow boot' to boot a selected bootflow */ +static int bootmethod_test_cmd_bootflow_boot(struct unit_test_state *uts) +{ + console_record_reset_enable(); + ut_assertok(run_command("bootmethod select 2", 0)); + ut_assert_console_end(); + ut_assertok(run_command("bootflow scan", 0)); + ut_assert_console_end(); + ut_assertok(run_command("bootflow select 0", 0)); + ut_assert_console_end(); + ut_assertok(run_command("bootflow boot", 0)); + ut_assert_nextline("** Booting bootflow 'mmc0.bootmethod.part_1'"); + ut_assert_nextline("Ignoring unknown command: ui"); + + /* + * We expect it to get through to boot although sandbox always returns + * -EFAULT as it cannot actually boot the kernel + */ + ut_assert_skip_to_line("sandbox: continuing, as we cannot run Linux"); + ut_assert_nextline("Boot failed (err=-14)"); + ut_assert_console_end(); + + return 0; +} +BOOTMETHOD_TEST(bootmethod_test_cmd_bootflow_boot, + UT_TESTF_DM | UT_TESTF_SCAN_FDT); + +/* Check we can get a bootmethod */ +static int bootmethod_test_get(struct unit_test_state *uts) +{ + struct bootmethod_iter iter; + struct bootflow bflow; + + ut_assertok(bootmethod_scan_first_bootflow(&iter, 0, &bflow)); + + return 0; +} +BOOTMETHOD_TEST(bootmethod_test_get, UT_TESTF_DM | UT_TESTF_SCAN_FDT); + +int do_ut_bootmethod(struct cmd_tbl *cmdtp, int flag, int argc, + char *const argv[]) +{ + struct unit_test *tests = UNIT_TEST_SUITE_START(bootmethod_test); + const int n_ents = UNIT_TEST_SUITE_COUNT(bootmethod_test); + + return cmd_ut_category("bootmethod", "bootmethod_test_", + tests, n_ents, argc, argv); +} diff --git a/test/cmd_ut.c b/test/cmd_ut.c index 90b260f72d6..c71f5575a04 100644 --- a/test/cmd_ut.c +++ b/test/cmd_ut.c @@ -28,6 +28,10 @@ int cmd_ut_category(const char *name, const char *prefix,

static struct cmd_tbl cmd_ut_sub[] = { U_BOOT_CMD_MKENT(all, CONFIG_SYS_MAXARGS, 1, do_ut_all, "", ""), +#ifdef CONFIG_BOOTMETHOD + U_BOOT_CMD_MKENT(bootmethod, CONFIG_SYS_MAXARGS, 1, do_ut_bootmethod, + "", ""), +#endif U_BOOT_CMD_MKENT(common, CONFIG_SYS_MAXARGS, 1, do_ut_common, "", ""), #if defined(CONFIG_UT_DM) U_BOOT_CMD_MKENT(dm, CONFIG_SYS_MAXARGS, 1, do_ut_dm, "", ""), diff --git a/try.sh b/try.sh new file mode 100755 index 00000000000..14519c3144c --- /dev/null +++ b/try.sh @@ -0,0 +1,131 @@ +#!/bin/bash + +set -e + +file=mmc.img +mnt=/mnt/x +fat=/mnt/y +dstdir=$fat/extlinux + +vmlinux=vmlinuz-5.3.7-301.fc31.armv7hl +initrd=initramfs-5.3.7-301.fc31.armv7hl.img +dtb=dtb-5.3.7-301.fc31.armv7hl/sandbox.dtb + +old() { + mkfs.vfat $file + sudo mount -o loop $file $mnt + #sudo cp /tmp/b/efi-x86_payload64/u-boot-payload.efi /mnt/x + #sudo cp /tmp/efi64/startup.nsh $mnt + #sudo cp /tmp/efi64/vmlinuz $mnt + echo >>/tmp/extlinux.conf <<EOF +ui menu.c32 + +menu autoboot Arch Boot. Automatic boot in # second{,s}. Press a key for options. +menu title Arch Boot Options. +menu hidden + +timeout 50 + +default Arch + +label Arch + kernel /zImage + append root=/dev/mmcblk0p2 rw rootfstype=ext4 rootwait consoleblank=0 no_console_suspend=1 console=ttymxc0,115200n8 + fdtdir /dtbs + initrd /initramfs-linux.img +EOF + sudo cp /tmp/extlinux.conf $mnt + ls $mnt + sudo umount $mnt +} + + +fat_setup() { + echo 'type=c' | sudo sfdisk $file + #sudo kpartx -a $file + loop=$(sudo losetup --show -f -P $file) + echo "Mounted to $loop" + fatpart="${loop}p1" + sudo mkfs.vfat $fatpart + sudo mount -o loop ${fatpart} $fat +} + + +fat_finish() { + sudo mkdir -p $dstdir + sudo cp /tmp/extlinux.conf $dstdir + + echo "vmlinux" | gzip >/tmp/inf + mkimage -f auto -d /tmp/inf /tmp/$vmlinux + + sudo cp /tmp/$vmlinux $fat + + echo "initd" >/tmp/$initrd + sudo cp /tmp/$initrd $fat + + dtb_dir="$(dirname /tmp/$dtb)" + mkdir -p $dtb_dir + echo "/dts-v1/; / {};" | dtc >/tmp/$dtb + sudo cp -r $dtb_dir $fat + + ls $dstdir + + sudo umount $fat + + losetup -d $loop +} + + +new() { + fat_setup + cat >/tmp/extlinux.conf << EOF +ui menu.c32 + +menu autoboot Arch Boot. Automatic boot in # second{,s}. Press a key for options. +menu title Arch Boot Options. +menu hidden + +timeout 50 + +default Arch + +label Arch + kernel /zImage + append root=/dev/mmcblk0p2 rw rootfstype=ext4 rootwait consoleblank=0 no_console_suspend=1 console=ttymxc0,115200n8 + fdtdir /dtbs + initrd /initramfs-linux.img +EOF + fat_finish +} + + +fedora31() { + fat_setup + cat >/tmp/extlinux.conf << EOF +# extlinux.conf generated by appliance-creator +ui menu.c32 +menu autoboot Welcome to Fedora-Workstation-armhfp-31-1.9. Automatic boot in # second{,s}. Press a key for options. +menu title Fedora-Workstation-armhfp-31-1.9 Boot Options. +menu hidden +timeout 20 +totaltimeout 600 + +label Fedora-Workstation-armhfp-31-1.9 (5.3.7-301.fc31.armv7hl) + kernel /$vmlinux + append ro root=UUID=9732b35b-4cd5-458b-9b91-80f7047e0b8a rhgb quiet LANG=en_US.UTF-8 cma=192MB cma=256MB + fdtdir /dtb-5.3.7-301.fc31.armv7hl/ + initrd /$initrd +EOF + fat_finish +} + +# Remove old devices +for dev in $(losetup |grep $file | awk '{print $1}'); do + echo "Remove $dev" + losetup -d $dev +done + +qemu-img create $file 20M +#old +#new +fedora31

At present the MMC uclass assumes that the only child it can have is a block device. Update this so we can add a bootmethod too.

Signed-off-by: Simon Glass sjg@chromium.org ---

drivers/mmc/mmc-uclass.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/mmc/mmc-uclass.c b/drivers/mmc/mmc-uclass.c index 0e13238c7e7..9e39fdd6c44 100644 --- a/drivers/mmc/mmc-uclass.c +++ b/drivers/mmc/mmc-uclass.c @@ -320,7 +320,7 @@ struct blk_desc *mmc_get_blk_desc(struct mmc *mmc) struct blk_desc *desc; struct udevice *dev;

- device_find_first_child(mmc->dev, &dev); + device_find_first_child_by_uclass(mmc->dev, UCLASS_BLK, &dev); if (!dev) return NULL; desc = dev_get_uclass_plat(dev); @@ -422,7 +422,7 @@ int mmc_unbind(struct udevice *dev) { struct udevice *bdev;

- device_find_first_child(dev, &bdev); + device_find_first_child_by_uclass(dev, UCLASS_BLK, &bdev); if (bdev) { device_remove(bdev, DM_REMOVE_NORMAL); device_unbind(bdev);

Add a bootmethod for Ethernet. It uses the distro boot mechanism to locate a file.

Signed-off-by: Simon Glass sjg@chromium.org ---

MAINTAINERS | 1 + configs/sandbox_defconfig | 1 + net/Kconfig | 9 +++++ net/Makefile | 1 + net/eth-uclass.c | 8 +++++ net/eth_bootmethod.c | 76 +++++++++++++++++++++++++++++++++++++++ 6 files changed, 96 insertions(+) create mode 100644 net/eth_bootmethod.c

diff --git a/MAINTAINERS b/MAINTAINERS index 246c5e60270..74e8eaafb10 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -643,6 +643,7 @@ F: doc/usage/bootmethod.rst F: drivers/mmc/mmc_bootmethod.c F: include/bootmethod.h F: include/distro.h +F: net/eth_bootmethod.c F: test/boot/bootmethod.c

BTRFS diff --git a/configs/sandbox_defconfig b/configs/sandbox_defconfig index 31a8d6a1d90..321d32be73e 100644 --- a/configs/sandbox_defconfig +++ b/configs/sandbox_defconfig @@ -116,6 +116,7 @@ CONFIG_ENV_IS_IN_EXT4=y CONFIG_ENV_EXT4_INTERFACE="host" CONFIG_ENV_EXT4_DEVICE_AND_PART="0:0" CONFIG_ENV_IMPORT_FDT=y +# CONFIG_BOOTMETHOD_ETH is not set CONFIG_BOOTP_SEND_HOSTNAME=y CONFIG_NETCONSOLE=y CONFIG_IP_DEFRAG=y diff --git a/net/Kconfig b/net/Kconfig index ba0ca813ce5..6f92fe44a8c 100644 --- a/net/Kconfig +++ b/net/Kconfig @@ -14,6 +14,15 @@ config PROT_UDP Enable a generic udp framework that allows defining a custom handler for udp protocol.

+config BOOTMETHOD_ETH + bool "Enable bootmethod for ethernet" + depends on BOOTMETHOD + default y + help + Provide a bootmethod for ethernet so that is it possible to boot + an operationg system over the network, using the PXE (Preboot + Execution Environment) protocol. + config BOOTP_SEND_HOSTNAME bool "Send hostname to DNS server" help diff --git a/net/Makefile b/net/Makefile index fb3eba840ff..c86bbd90349 100644 --- a/net/Makefile +++ b/net/Makefile @@ -12,6 +12,7 @@ obj-$(CONFIG_CMD_DNS) += dns.o obj-$(CONFIG_DM_DSA) += dsa-uclass.o ifdef CONFIG_DM_ETH obj-$(CONFIG_NET) += eth-uclass.o +obj-$(CONFIG_$(SPL_TPL_)BOOTMETHOD_ETH) += eth_bootmethod.o else obj-$(CONFIG_NET) += eth_legacy.o endif diff --git a/net/eth-uclass.c b/net/eth-uclass.c index 0da0e85be03..0284215b113 100644 --- a/net/eth-uclass.c +++ b/net/eth-uclass.c @@ -8,6 +8,7 @@ #define LOG_CATEGORY UCLASS_ETH

#include <common.h> +#include <bootmethod.h> #include <bootstage.h> #include <dm.h> #include <env.h> @@ -473,6 +474,8 @@ int eth_initialize(void)

static int eth_post_bind(struct udevice *dev) { + int ret; + if (strchr(dev->name, ' ')) { printf("\nError: eth device name "%s" has a space!\n", dev->name); @@ -482,6 +485,11 @@ static int eth_post_bind(struct udevice *dev) #ifdef CONFIG_DM_ETH_PHY eth_phy_binds_nodes(dev); #endif + if (CONFIG_IS_ENABLED(BOOTMETHOD_ETH)) { + ret = bootmethod_setup_for_dev(dev, "eth_bootmethod"); + if (ret) + return log_msg_ret("bootmethod", ret); + }

return 0; } diff --git a/net/eth_bootmethod.c b/net/eth_bootmethod.c new file mode 100644 index 00000000000..bc8843add80 --- /dev/null +++ b/net/eth_bootmethod.c @@ -0,0 +1,76 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Bootmethod for ethernet + * + * Copyright 2021 Google LLC + * Written by Simon Glass sjg@chromium.org + */ + +#include <common.h> +#include <bootmethod.h> +#include <command.h> +#include <distro.h> +#include <dm.h> +#include <net.h> + +static int eth_get_bootflow(struct udevice *dev, int seq, + struct bootflow *bflow) +{ + char name[60]; + int ret; + + /* + * Like distro boot, this assumes there is only one Ethernet device. + * In this case, that means that @eth is ignored + */ + if (seq) + return log_msg_ret("dhcp", -ESHUTDOWN); + + bflow->seq = seq; + snprintf(name, sizeof(name), "%s.%d", dev->name, seq); + bflow->name = strdup(name); + if (!bflow->name) + return log_msg_ret("name", -ENOMEM); + if (!bflow->name) + return log_msg_ret("name", -ENOMEM); + bflow->state = BOOTFLOWST_BASE; + + /* + * There is not a direct interface to the network stack so run + * everything through the command-line interpreter for now. + * + * Don't bother checking the result of dhcp. It can fail with: + * + * DHCP client bound to address 192.168.4.50 (4 ms) + * *** Warning: no boot file name; using 'C0A80432.img' + * Using smsc95xx_eth device + * TFTP from server 192.168.4.1; our IP address is 192.168.4.50 + * Filename 'C0A80432.img'. + * Load address: 0x200000 + * Loading: * + * TFTP error: 'File not found' (1) + * + * This is not a real failure, since we don't actually care if the + * boot file exists. + */ + run_command("dhcp", 0); + bflow->state = BOOTFLOWST_MEDIA; + + if (CONFIG_IS_ENABLED(BOOTMETHOD_DISTRO)) { + ret = distro_net_setup(bflow); + if (ret) + return log_msg_ret("distro", ret); + } + + return 0; +} + +struct bootmethod_ops eth_bootmethod_ops = { + .get_bootflow = eth_get_bootflow, +}; + +U_BOOT_DRIVER(eth_bootmethod) = { + .name = "eth_bootmethod", + .id = UCLASS_BOOTMETHOD, + .ops = &eth_bootmethod_ops, +};