efi_loader: round the memory area in efi_add_memory_map()
[oweals/u-boot.git] / cmd / bootefi.c
index f1d7d8bc6634f4b1624959667457bcd0bbb21372..9849eb4f9950da0d0c008d3ec1b14760cfcc71bf 100644 (file)
@@ -6,20 +6,19 @@
  */
 
 #include <common.h>
-#include <bootm.h>
 #include <charset.h>
 #include <command.h>
 #include <dm.h>
 #include <efi_loader.h>
 #include <efi_selftest.h>
+#include <env.h>
 #include <errno.h>
+#include <malloc.h>
 #include <linux/libfdt.h>
 #include <linux/libfdt_env.h>
 #include <mapmem.h>
 #include <memalign.h>
-#include <asm/global_data.h>
 #include <asm-generic/sections.h>
-#include <asm-generic/unaligned.h>
 #include <linux/linkage.h>
 
 DECLARE_GLOBAL_DATA_PTR;
@@ -27,23 +26,16 @@ DECLARE_GLOBAL_DATA_PTR;
 static struct efi_device_path *bootefi_image_path;
 static struct efi_device_path *bootefi_device_path;
 
-/*
- * Allow unaligned memory access.
- *
- * This routine is overridden by architectures providing this feature.
- */
-void __weak allow_unaligned(void)
-{
-}
-
-/*
+/**
  * Set the load options of an image from an environment variable.
  *
- * @handle:    the image handle
- * @env_var:   name of the environment variable
- * Return:     status code
+ * @handle:            the image handle
+ * @env_var:           name of the environment variable
+ * @load_options:      pointer to load options (output)
+ * Return:             status code
  */
-static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
+static efi_status_t set_load_options(efi_handle_t handle, const char *env_var,
+                                    u16 **load_options)
 {
        struct efi_loaded_image *loaded_image_info;
        size_t size;
@@ -51,6 +43,7 @@ static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
        u16 *pos;
        efi_status_t ret;
 
+       *load_options = NULL;
        ret = EFI_CALL(systab.boottime->open_protocol(
                                        handle,
                                        &efi_guid_loaded_image,
@@ -75,6 +68,7 @@ static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
                return EFI_OUT_OF_RESOURCES;
        }
        pos = loaded_image_info->load_options;
+       *load_options = pos;
        utf8_utf16_strcpy(&pos, env);
        loaded_image_info->load_options_size = size * 2;
 
@@ -133,13 +127,13 @@ static efi_status_t copy_fdt(void **fdtp)
        new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
                                             fdt_size, 0);
        ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
-                                EFI_BOOT_SERVICES_DATA, fdt_pages,
+                                EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
                                 &new_fdt_addr);
        if (ret != EFI_SUCCESS) {
                /* If we can't put it there, put it somewhere */
                new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
                ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
-                                        EFI_BOOT_SERVICES_DATA, fdt_pages,
+                                        EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
                                         &new_fdt_addr);
                if (ret != EFI_SUCCESS) {
                        printf("ERROR: Failed to reserve space for FDT\n");
@@ -155,7 +149,17 @@ done:
        return ret;
 }
 
-/*
+static void efi_reserve_memory(u64 addr, u64 size)
+{
+       /* Convert from sandbox address space. */
+       addr = (uintptr_t)map_sysmem(addr, 0);
+       if (efi_add_memory_map(addr, size,
+                              EFI_RESERVED_MEMORY_TYPE) != EFI_SUCCESS)
+               printf("Reserved memory mapping failed addr %llx size %llx\n",
+                      addr, size);
+}
+
+/**
  * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
  *
  * The mem_rsv entries of the FDT are added to the memory map. Any failures are
@@ -167,7 +171,8 @@ done:
 static void efi_carve_out_dt_rsv(void *fdt)
 {
        int nr_rsv, i;
-       uint64_t addr, size, pages;
+       u64 addr, size;
+       int nodeoffset, subnode;
 
        nr_rsv = fdt_num_mem_rsv(fdt);
 
@@ -175,15 +180,26 @@ static void efi_carve_out_dt_rsv(void *fdt)
        for (i = 0; i < nr_rsv; i++) {
                if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
                        continue;
+               efi_reserve_memory(addr, size);
+       }
 
-               /* Convert from sandbox address space. */
-               addr = (uintptr_t)map_sysmem(addr, 0);
-
-               pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
-               addr &= ~EFI_PAGE_MASK;
-               if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
-                                       false))
-                       printf("FDT memrsv map %d: Failed to add to map\n", i);
+       /* process reserved-memory */
+       nodeoffset = fdt_subnode_offset(fdt, 0, "reserved-memory");
+       if (nodeoffset >= 0) {
+               subnode = fdt_first_subnode(fdt, nodeoffset);
+               while (subnode >= 0) {
+                       /* check if this subnode has a reg property */
+                       addr = fdtdec_get_addr_size(fdt, subnode, "reg",
+                                                   (fdt_size_t *)&size);
+                       /*
+                        * The /reserved-memory node may have children with
+                        * a size instead of a reg property.
+                        */
+                       if (addr != FDT_ADDR_T_NONE &&
+                           fdtdec_get_is_enabled(fdt, subnode))
+                               efi_reserve_memory(addr, size);
+                       subnode = fdt_next_subnode(fdt, subnode);
+               }
        }
 }
 
@@ -207,61 +223,68 @@ static void *get_config_table(const efi_guid_t *guid)
 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
 
 /**
- * efi_install_fdt() - install fdt passed by a command argument
- * @fdt_opt:   pointer to argument
- * Return:     status code
+ * efi_install_fdt() - install device tree
+ *
+ * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
+ * address will will be installed as configuration table, otherwise the device
+ * tree located at the address indicated by environment variable fdt_addr or as
+ * fallback fdtcontroladdr will be used.
+ *
+ * On architectures using ACPI tables device trees shall not be installed as
+ * configuration table.
  *
- * If specified, fdt will be installed as configuration table,
- * otherwise no fdt will be passed.
+ * @fdt:       address of device tree or EFI_FDT_USE_INTERNAL to use the
+ *             the hardware device tree as indicated by environment variable
+ *             fdt_addr or as fallback the internal device tree as indicated by
+ *             the environment variable fdtcontroladdr
+ * Return:     status code
  */
-static efi_status_t efi_install_fdt(const char *fdt_opt)
+efi_status_t efi_install_fdt(void *fdt)
 {
        /*
         * The EBBR spec requires that we have either an FDT or an ACPI table
         * but not both.
         */
 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
-       if (fdt_opt) {
+       if (fdt) {
                printf("ERROR: can't have ACPI table and device tree.\n");
                return EFI_LOAD_ERROR;
        }
 #else
-       unsigned long fdt_addr;
-       void *fdt;
        bootm_headers_t img = { 0 };
        efi_status_t ret;
 
-       if (fdt_opt) {
-               fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
-               if (!fdt_addr)
-                       return EFI_INVALID_PARAMETER;
-       } else {
+       if (fdt == EFI_FDT_USE_INTERNAL) {
+               const char *fdt_opt;
+               uintptr_t fdt_addr;
+
                /* Look for device tree that is already installed */
                if (get_config_table(&efi_guid_fdt))
                        return EFI_SUCCESS;
-               /* Use our own device tree as default */
-               fdt_opt = env_get("fdtcontroladdr");
+               /* Check if there is a hardware device tree */
+               fdt_opt = env_get("fdt_addr");
+               /* Use our own device tree as fallback */
                if (!fdt_opt) {
-                       printf("ERROR: need device tree\n");
-                       return EFI_NOT_FOUND;
+                       fdt_opt = env_get("fdtcontroladdr");
+                       if (!fdt_opt) {
+                               printf("ERROR: need device tree\n");
+                               return EFI_NOT_FOUND;
+                       }
                }
                fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
                if (!fdt_addr) {
-                       printf("ERROR: invalid $fdtcontroladdr\n");
+                       printf("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
                        return EFI_LOAD_ERROR;
                }
+               fdt = map_sysmem(fdt_addr, 0);
        }
 
        /* Install device tree */
-       fdt = map_sysmem(fdt_addr, 0);
        if (fdt_check_header(fdt)) {
                printf("ERROR: invalid device tree\n");
                return EFI_LOAD_ERROR;
        }
 
-       /* Create memory reservations as indicated by the device tree */
-       efi_carve_out_dt_rsv(fdt);
-
        /* Prepare device tree for payload */
        ret = copy_fdt(&fdt);
        if (ret) {
@@ -274,6 +297,9 @@ static efi_status_t efi_install_fdt(const char *fdt_opt)
                return EFI_LOAD_ERROR;
        }
 
+       /* Create memory reservations as indicated by the device tree */
+       efi_carve_out_dt_rsv(fdt);
+
        /* Install device tree as UEFI table */
        ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
        if (ret != EFI_SUCCESS) {
@@ -299,9 +325,10 @@ static efi_status_t do_bootefi_exec(efi_handle_t handle)
        efi_status_t ret;
        efi_uintn_t exit_data_size = 0;
        u16 *exit_data = NULL;
+       u16 *load_options;
 
        /* Transfer environment variable as load options */
-       ret = set_load_options(handle, "bootargs");
+       ret = set_load_options(handle, "bootargs", &load_options);
        if (ret != EFI_SUCCESS)
                return ret;
 
@@ -315,48 +342,21 @@ static efi_status_t do_bootefi_exec(efi_handle_t handle)
 
        efi_restore_gd();
 
-       /*
-        * FIXME: Who is responsible for
-        *      free(loaded_image_info->load_options);
-        * Once efi_exit() is implemented correctly,
-        * handle itself doesn't exist here.
-        */
+       free(load_options);
 
        return ret;
 }
 
 /**
- * do_efibootmgr() - execute EFI Boot Manager
+ * do_efibootmgr() - execute EFI boot manager
  *
- * @fdt_opt:   string of fdt start address
  * Return:     status code
- *
- * Execute EFI Boot Manager
  */
-static int do_efibootmgr(const char *fdt_opt)
+static int do_efibootmgr(void)
 {
        efi_handle_t handle;
        efi_status_t ret;
 
-       /* Allow unaligned memory access */
-       allow_unaligned();
-
-       switch_to_non_secure_mode();
-
-       /* Initialize EFI drivers */
-       ret = efi_init_obj_list();
-       if (ret != EFI_SUCCESS) {
-               printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
-                      ret & ~EFI_ERROR_MASK);
-               return CMD_RET_FAILURE;
-       }
-
-       ret = efi_install_fdt(fdt_opt);
-       if (ret == EFI_INVALID_PARAMETER)
-               return CMD_RET_USAGE;
-       else if (ret != EFI_SUCCESS)
-               return CMD_RET_FAILURE;
-
        ret = efi_bootmgr_load(&handle);
        if (ret != EFI_SUCCESS) {
                printf("EFI boot manager: Cannot load any image\n");
@@ -371,45 +371,22 @@ static int do_efibootmgr(const char *fdt_opt)
        return CMD_RET_SUCCESS;
 }
 
-/*
- * do_bootefi_image() - execute EFI binary from command line
+/**
+ * do_bootefi_image() - execute EFI binary
+ *
+ * Set up memory image for the binary to be loaded, prepare device path, and
+ * then call do_bootefi_exec() to execute it.
  *
  * @image_opt: string of image start address
- * @fdt_opt:   string of fdt start address
  * Return:     status code
- *
- * Set up memory image for the binary to be loaded, prepare
- * device path and then call do_bootefi_exec() to execute it.
  */
-static int do_bootefi_image(const char *image_opt, const char *fdt_opt)
+static int do_bootefi_image(const char *image_opt)
 {
        void *image_buf;
-       struct efi_device_path *device_path, *image_path;
-       struct efi_device_path *file_path = NULL;
        unsigned long addr, size;
        const char *size_str;
-       efi_handle_t mem_handle = NULL, handle;
        efi_status_t ret;
 
-       /* Allow unaligned memory access */
-       allow_unaligned();
-
-       switch_to_non_secure_mode();
-
-       /* Initialize EFI drivers */
-       ret = efi_init_obj_list();
-       if (ret != EFI_SUCCESS) {
-               printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
-                      ret & ~EFI_ERROR_MASK);
-               return CMD_RET_FAILURE;
-       }
-
-       ret = efi_install_fdt(fdt_opt);
-       if (ret == EFI_INVALID_PARAMETER)
-               return CMD_RET_USAGE;
-       else if (ret != EFI_SUCCESS)
-               return CMD_RET_FAILURE;
-
 #ifdef CONFIG_CMD_BOOTEFI_HELLO
        if (!strcmp(image_opt, "hello")) {
                char *saddr;
@@ -425,8 +402,10 @@ static int do_bootefi_image(const char *image_opt, const char *fdt_opt)
                image_buf = map_sysmem(addr, size);
                memcpy(image_buf, __efi_helloworld_begin, size);
 
-               device_path = NULL;
-               image_path = NULL;
+               efi_free_pool(bootefi_device_path);
+               efi_free_pool(bootefi_image_path);
+               bootefi_device_path = NULL;
+               bootefi_image_path = NULL;
        } else
 #endif
        {
@@ -442,19 +421,37 @@ static int do_bootefi_image(const char *image_opt, const char *fdt_opt)
                        return CMD_RET_USAGE;
 
                image_buf = map_sysmem(addr, size);
-
-               device_path = bootefi_device_path;
-               image_path = bootefi_image_path;
        }
+       ret = efi_run_image(image_buf, size);
+
+       if (ret != EFI_SUCCESS)
+               return CMD_RET_FAILURE;
+
+       return CMD_RET_SUCCESS;
+}
 
-       if (!device_path && !image_path) {
+/**
+ * efi_run_image() - run loaded UEFI image
+ *
+ * @source_buffer:     memory address of the UEFI image
+ * @source_size:       size of the UEFI image
+ * Return:             status code
+ */
+efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
+{
+       efi_handle_t mem_handle = NULL, handle;
+       struct efi_device_path *file_path = NULL;
+       efi_status_t ret;
+
+       if (!bootefi_device_path || !bootefi_image_path) {
                /*
                 * Special case for efi payload not loaded from disk,
                 * such as 'bootefi hello' or for example payload
                 * loaded directly into memory via JTAG, etc:
                 */
                file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
-                                           (uintptr_t)image_buf, size);
+                                           (uintptr_t)source_buffer,
+                                           source_size);
                /*
                 * Make sure that device for device_path exist
                 * in load_image(). Otherwise, shell and grub will fail.
@@ -468,27 +465,21 @@ static int do_bootefi_image(const char *image_opt, const char *fdt_opt)
                if (ret != EFI_SUCCESS)
                        goto out;
        } else {
-               assert(device_path && image_path);
-               file_path = efi_dp_append(device_path, image_path);
+               file_path = efi_dp_append(bootefi_device_path,
+                                         bootefi_image_path);
        }
 
-       ret = EFI_CALL(efi_load_image(false, efi_root,
-                                     file_path, image_buf, size, &handle));
+       ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
+                                     source_size, &handle));
        if (ret != EFI_SUCCESS)
                goto out;
 
        ret = do_bootefi_exec(handle);
 
 out:
-       if (mem_handle)
-               efi_delete_handle(mem_handle);
-       if (file_path)
-               efi_free_pool(file_path);
-
-       if (ret != EFI_SUCCESS)
-               return CMD_RET_FAILURE;
-
-       return CMD_RET_SUCCESS;
+       efi_delete_handle(mem_handle);
+       efi_free_pool(file_path);
+       return ret;
 }
 
 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
@@ -499,6 +490,7 @@ static efi_status_t bootefi_run_prepare(const char *load_options_path,
                struct efi_loaded_image **loaded_image_infop)
 {
        efi_status_t ret;
+       u16 *load_options;
 
        ret = efi_setup_loaded_image(device_path, image_path, image_objp,
                                     loaded_image_infop);
@@ -506,7 +498,8 @@ static efi_status_t bootefi_run_prepare(const char *load_options_path,
                return ret;
 
        /* Transfer environment variable as load options */
-       return set_load_options((efi_handle_t)*image_objp, load_options_path);
+       return set_load_options((efi_handle_t)*image_objp, load_options_path,
+                               &load_options);
 }
 
 /**
@@ -569,38 +562,16 @@ static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
 }
 
 /**
- * do_efi_selftest() - execute EFI Selftest
+ * do_efi_selftest() - execute EFI selftest
  *
- * @fdt_opt:   string of fdt start address
  * Return:     status code
- *
- * Execute EFI Selftest
  */
-static int do_efi_selftest(const char *fdt_opt)
+static int do_efi_selftest(void)
 {
        struct efi_loaded_image_obj *image_obj;
        struct efi_loaded_image *loaded_image_info;
        efi_status_t ret;
 
-       /* Allow unaligned memory access */
-       allow_unaligned();
-
-       switch_to_non_secure_mode();
-
-       /* Initialize EFI drivers */
-       ret = efi_init_obj_list();
-       if (ret != EFI_SUCCESS) {
-               printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
-                      ret & ~EFI_ERROR_MASK);
-               return CMD_RET_FAILURE;
-       }
-
-       ret = efi_install_fdt(fdt_opt);
-       if (ret == EFI_INVALID_PARAMETER)
-               return CMD_RET_USAGE;
-       else if (ret != EFI_SUCCESS)
-               return CMD_RET_FAILURE;
-
        ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
                                   "\\selftest", "efi_selftest");
        if (ret != EFI_SUCCESS)
@@ -614,20 +585,53 @@ static int do_efi_selftest(const char *fdt_opt)
 }
 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
 
-/* Interpreter command to boot an arbitrary EFI image from memory */
+/**
+ * do_bootefi() - execute `bootefi` command
+ *
+ * @cmdtp:     table entry describing command
+ * @flag:      bitmap indicating how the command was invoked
+ * @argc:      number of arguments
+ * @argv:      command line arguments
+ * Return:     status code
+ */
 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 {
+       efi_status_t ret;
+       void *fdt;
+
        if (argc < 2)
                return CMD_RET_USAGE;
 
+       /* Initialize EFI drivers */
+       ret = efi_init_obj_list();
+       if (ret != EFI_SUCCESS) {
+               printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
+                      ret & ~EFI_ERROR_MASK);
+               return CMD_RET_FAILURE;
+       }
+
+       if (argc > 2) {
+               uintptr_t fdt_addr;
+
+               fdt_addr = simple_strtoul(argv[2], NULL, 16);
+               fdt = map_sysmem(fdt_addr, 0);
+       } else {
+               fdt = EFI_FDT_USE_INTERNAL;
+       }
+       ret = efi_install_fdt(fdt);
+       if (ret == EFI_INVALID_PARAMETER)
+               return CMD_RET_USAGE;
+       else if (ret != EFI_SUCCESS)
+               return CMD_RET_FAILURE;
+
        if (!strcmp(argv[1], "bootmgr"))
-               return do_efibootmgr(argc > 2 ? argv[2] : NULL);
+               return do_efibootmgr();
 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
        else if (!strcmp(argv[1], "selftest"))
-               return do_efi_selftest(argc > 2 ? argv[2] : NULL);
+               return do_efi_selftest();
 #endif
 
-       return do_bootefi_image(argv[1], argc > 2 ? argv[2] : NULL);
+       return do_bootefi_image(argv[1]);
 }
 
 #ifdef CONFIG_SYS_LONGHELP
@@ -659,6 +663,16 @@ U_BOOT_CMD(
        bootefi_help_text
 );
 
+/**
+ * efi_set_bootdev() - set boot device
+ *
+ * This function is called when a file is loaded, e.g. via the 'load' command.
+ * We use the path to this file to inform the UEFI binary about the boot device.
+ *
+ * @dev:       device, e.g. "MMC"
+ * @devnr:     number of the device, e.g. "1:2"
+ * @path:      path to file loaded
+ */
 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
 {
        struct efi_device_path *device, *image;