Merge tag 'pull-24apr19' of git://git.denx.de/u-boot-dm
[oweals/u-boot.git] / cmd / bootefi.c
index d8ca4ed703efd2854fad714cde2d623180a93325..efaa548be4d84dd41bf7f4ee3ef78baf03e66ca3 100644 (file)
@@ -84,6 +84,8 @@ out:
                                                        efi_root, NULL));
 }
 
+#if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
+
 /**
  * copy_fdt() - Copy the device tree to a new location available to EFI
  *
@@ -185,154 +187,327 @@ static void efi_carve_out_dt_rsv(void *fdt)
        }
 }
 
-static efi_status_t efi_install_fdt(ulong fdt_addr)
+/**
+ * get_config_table() - get configuration table
+ *
+ * @guid:      GUID of the configuration table
+ * Return:     pointer to configuration table or NULL
+ */
+static void *get_config_table(const efi_guid_t *guid)
 {
+       size_t i;
+
+       for (i = 0; i < systab.nr_tables; i++) {
+               if (!guidcmp(guid, &systab.tables[i].guid))
+                       return systab.tables[i].table;
+       }
+       return NULL;
+}
+
+#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
+ *
+ * If specified, fdt will be installed as configuration table,
+ * otherwise no fdt will be passed.
+ */
+static efi_status_t efi_install_fdt(const char *fdt_opt)
+{
+       /*
+        * 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) {
+               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;
-       void *fdt;
 
+       if (fdt_opt) {
+               fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
+               if (!fdt_addr)
+                       return EFI_INVALID_PARAMETER;
+       } else {
+               /* 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");
+               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");
+                       return EFI_LOAD_ERROR;
+               }
+       }
+
+       /* Install device tree */
        fdt = map_sysmem(fdt_addr, 0);
        if (fdt_check_header(fdt)) {
                printf("ERROR: invalid device tree\n");
-               return EFI_INVALID_PARAMETER;
+               return EFI_LOAD_ERROR;
        }
 
-       /* Create memory reservation as indicated by the device tree */
+       /* Create memory reservations as indicated by the device tree */
        efi_carve_out_dt_rsv(fdt);
 
-       /* Prepare fdt for payload */
+       /* Prepare device tree for payload */
        ret = copy_fdt(&fdt);
-       if (ret)
-               return ret;
+       if (ret) {
+               printf("ERROR: out of memory\n");
+               return EFI_OUT_OF_RESOURCES;
+       }
 
        if (image_setup_libfdt(&img, fdt, 0, NULL)) {
                printf("ERROR: failed to process device tree\n");
                return EFI_LOAD_ERROR;
        }
 
-       /* Link to it in the efi tables */
+       /* Install device tree as UEFI table */
        ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
-       if (ret != EFI_SUCCESS)
-               return EFI_OUT_OF_RESOURCES;
+       if (ret != EFI_SUCCESS) {
+               printf("ERROR: failed to install device tree\n");
+               return ret;
+       }
+#endif /* GENERATE_ACPI_TABLE */
 
-       return ret;
+       return EFI_SUCCESS;
 }
 
-static efi_status_t bootefi_run_prepare(const char *load_options_path,
-               struct efi_device_path *device_path,
-               struct efi_device_path *image_path,
-               struct efi_loaded_image_obj **image_objp,
-               struct efi_loaded_image **loaded_image_infop)
+/**
+ * do_bootefi_exec() - execute EFI binary
+ *
+ * @handle:            handle of loaded image
+ * Return:             status code
+ *
+ * Load the EFI binary into a newly assigned memory unwinding the relocation
+ * information, install the loaded image protocol, and call the binary.
+ */
+static efi_status_t do_bootefi_exec(efi_handle_t handle)
 {
        efi_status_t ret;
 
-       ret = efi_setup_loaded_image(device_path, image_path, image_objp,
-                                    loaded_image_infop);
+       /* Transfer environment variable as load options */
+       ret = set_load_options(handle, "bootargs");
        if (ret != EFI_SUCCESS)
                return ret;
 
-       /* Transfer environment variable as load options */
-       return set_load_options((efi_handle_t)*image_objp, load_options_path);
+       /* we don't support much: */
+       env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
+               "{ro,boot}(blob)0000000000000000");
+
+       /* Call our payload! */
+       ret = EFI_CALL(efi_start_image(handle, NULL, NULL));
+
+       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.
+        */
+
+       return ret;
 }
 
 /**
- * bootefi_run_finish() - finish up after running an EFI test
+ * do_efibootmgr() - execute EFI Boot Manager
  *
- * @loaded_image_info: Pointer to a struct which holds the loaded image info
- * @image_objj: Pointer to a struct which holds the loaded image object
+ * @fdt_opt:   string of fdt start address
+ * Return:     status code
+ *
+ * Execute EFI Boot Manager
  */
-static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
-                              struct efi_loaded_image *loaded_image_info)
+static int do_efibootmgr(const char *fdt_opt)
 {
-       efi_restore_gd();
-       free(loaded_image_info->load_options);
-       efi_delete_handle(&image_obj->header);
+       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");
+               return CMD_RET_FAILURE;
+       }
+
+       ret = do_bootefi_exec(handle);
+       printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
+
+       if (ret != EFI_SUCCESS)
+               return CMD_RET_FAILURE;
+
+       return CMD_RET_SUCCESS;
 }
 
-/**
- * do_bootefi_exec() - execute EFI binary
+/*
+ * do_bootefi_image() - execute EFI binary from command line
  *
- * @efi:               address of the binary
- * @device_path:       path of the device from which the binary was loaded
- * @image_path:                device path of the binary
- * Return:             status code
+ * @image_opt: string of image start address
+ * @fdt_opt:   string of fdt start address
+ * Return:     status code
  *
- * Load the EFI binary into a newly assigned memory unwinding the relocation
- * information, install the loaded image protocol, and call the binary.
+ * Set up memory image for the binary to be loaded, prepare
+ * device path and then call do_bootefi_exec() to execute it.
  */
-static efi_status_t do_bootefi_exec(void *efi,
-                                   struct efi_device_path *device_path,
-                                   struct efi_device_path *image_path)
+static int do_bootefi_image(const char *image_opt, const char *fdt_opt)
 {
-       efi_handle_t mem_handle = NULL;
-       struct efi_device_path *memdp = NULL;
+       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;
-       struct efi_loaded_image_obj *image_obj = NULL;
-       struct efi_loaded_image *loaded_image_info = NULL;
 
-       /*
-        * Special case for efi payload not loaded from disk, such as
-        * 'bootefi hello' or for example payload loaded directly into
-        * memory via JTAG, etc:
-        */
+       /* 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;
+
+               saddr = env_get("loadaddr");
+               size = __efi_helloworld_end - __efi_helloworld_begin;
+
+               if (saddr)
+                       addr = simple_strtoul(saddr, NULL, 16);
+               else
+                       addr = CONFIG_SYS_LOAD_ADDR;
+
+               image_buf = map_sysmem(addr, size);
+               memcpy(image_buf, __efi_helloworld_begin, size);
+
+               device_path = NULL;
+               image_path = NULL;
+       } else
+#endif
+       {
+               size_str = env_get("filesize");
+               if (size_str)
+                       size = simple_strtoul(size_str, NULL, 16);
+               else
+                       size = 0;
+
+               addr = simple_strtoul(image_opt, NULL, 16);
+               /* Check that a numeric value was passed */
+               if (!addr && *image_opt != '0')
+                       return CMD_RET_USAGE;
+
+               image_buf = map_sysmem(addr, size);
+
+               device_path = bootefi_device_path;
+               image_path = bootefi_image_path;
+       }
+
        if (!device_path && !image_path) {
-               printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
-               /* actual addresses filled in after efi_load_pe() */
-               memdp = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
-               device_path = image_path = memdp;
                /*
-                * Grub expects that the device path of the loaded image is
-                * installed on a handle.
+                * 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);
+               /*
+                * Make sure that device for device_path exist
+                * in load_image(). Otherwise, shell and grub will fail.
                 */
                ret = efi_create_handle(&mem_handle);
                if (ret != EFI_SUCCESS)
-                       return ret; /* TODO: leaks device_path */
+                       goto out;
+
                ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
-                                      device_path);
+                                      file_path);
                if (ret != EFI_SUCCESS)
-                       goto err_add_protocol;
+                       goto out;
        } else {
                assert(device_path && image_path);
+               file_path = efi_dp_append(device_path, image_path);
        }
 
-       ret = bootefi_run_prepare("bootargs", device_path, image_path,
-                                 &image_obj, &loaded_image_info);
-       if (ret)
-               goto err_prepare;
-
-       /* Load the EFI payload */
-       ret = efi_load_pe(image_obj, efi, loaded_image_info);
+       ret = EFI_CALL(efi_load_image(false, efi_root,
+                                     file_path, image_buf, size, &handle));
        if (ret != EFI_SUCCESS)
-               goto err_prepare;
-
-       if (memdp) {
-               struct efi_device_path_memory *mdp = (void *)memdp;
-               mdp->memory_type = loaded_image_info->image_code_type;
-               mdp->start_address = (uintptr_t)loaded_image_info->image_base;
-               mdp->end_address = mdp->start_address +
-                               loaded_image_info->image_size;
-       }
-
-       /* we don't support much: */
-       env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
-               "{ro,boot}(blob)0000000000000000");
-
-       /* Call our payload! */
-       debug("%s: Jumping to 0x%p\n", __func__, image_obj->entry);
-       ret = EFI_CALL(efi_start_image(&image_obj->header, NULL, NULL));
+               goto out;
 
-err_prepare:
-       /* image has returned, loaded-image obj goes *poof*: */
-       bootefi_run_finish(image_obj, loaded_image_info);
+       ret = do_bootefi_exec(handle);
+       printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
 
-err_add_protocol:
+out:
        if (mem_handle)
                efi_delete_handle(mem_handle);
+       if (file_path)
+               efi_free_pool(file_path);
 
-       return ret;
+       if (ret != EFI_SUCCESS)
+               return CMD_RET_FAILURE;
+
+       return CMD_RET_SUCCESS;
 }
 
 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
+static efi_status_t bootefi_run_prepare(const char *load_options_path,
+               struct efi_device_path *device_path,
+               struct efi_device_path *image_path,
+               struct efi_loaded_image_obj **image_objp,
+               struct efi_loaded_image **loaded_image_infop)
+{
+       efi_status_t ret;
+
+       ret = efi_setup_loaded_image(device_path, image_path, image_objp,
+                                    loaded_image_infop);
+       if (ret != EFI_SUCCESS)
+               return ret;
+
+       /* Transfer environment variable as load options */
+       return set_load_options((efi_handle_t)*image_objp, load_options_path);
+}
+
 /**
  * bootefi_test_prepare() - prepare to run an EFI test
  *
@@ -378,36 +553,33 @@ failure:
        return ret;
 }
 
-#endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
-
-static int do_bootefi_bootmgr_exec(void)
+/**
+ * bootefi_run_finish() - finish up after running an EFI test
+ *
+ * @loaded_image_info: Pointer to a struct which holds the loaded image info
+ * @image_obj: Pointer to a struct which holds the loaded image object
+ */
+static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
+                              struct efi_loaded_image *loaded_image_info)
 {
-       struct efi_device_path *device_path, *file_path;
-       void *addr;
-       efi_status_t r;
-
-       addr = efi_bootmgr_load(&device_path, &file_path);
-       if (!addr)
-               return 1;
-
-       printf("## Starting EFI application at %p ...\n", addr);
-       r = do_bootefi_exec(addr, device_path, file_path);
-       printf("## Application terminated, r = %lu\n",
-              r & ~EFI_ERROR_MASK);
-
-       if (r != EFI_SUCCESS)
-               return 1;
-
-       return 0;
+       efi_restore_gd();
+       free(loaded_image_info->load_options);
+       efi_delete_handle(&image_obj->header);
 }
 
-/* Interpreter command to boot an arbitrary EFI image from memory */
-static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
+/**
+ * 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)
 {
-       unsigned long addr;
-       char *saddr;
-       efi_status_t r;
-       unsigned long fdt_addr;
+       struct efi_loaded_image_obj *image_obj;
+       struct efi_loaded_image *loaded_image_info;
+       efi_status_t ret;
 
        /* Allow unaligned memory access */
        allow_unaligned();
@@ -415,81 +587,46 @@ static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
        switch_to_non_secure_mode();
 
        /* Initialize EFI drivers */
-       r = efi_init_obj_list();
-       if (r != EFI_SUCCESS) {
-               printf("Error: Cannot set up EFI drivers, r = %lu\n",
-                      r & ~EFI_ERROR_MASK);
+       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)
+       ret = efi_install_fdt(fdt_opt);
+       if (ret == EFI_INVALID_PARAMETER)
                return CMD_RET_USAGE;
+       else if (ret != EFI_SUCCESS)
+               return CMD_RET_FAILURE;
 
-       if (argc > 2) {
-               fdt_addr = simple_strtoul(argv[2], NULL, 16);
-               if (!fdt_addr && *argv[2] != '0')
-                       return CMD_RET_USAGE;
-               /* Install device tree */
-               r = efi_install_fdt(fdt_addr);
-               if (r != EFI_SUCCESS) {
-                       printf("ERROR: failed to install device tree\n");
-                       return CMD_RET_FAILURE;
-               }
-       } else {
-               /* Remove device tree. EFI_NOT_FOUND can be ignored here */
-               efi_install_configuration_table(&efi_guid_fdt, NULL);
-               printf("WARNING: booting without device tree\n");
-       }
-#ifdef CONFIG_CMD_BOOTEFI_HELLO
-       if (!strcmp(argv[1], "hello")) {
-               ulong size = __efi_helloworld_end - __efi_helloworld_begin;
+       ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
+                                  "\\selftest", "efi_selftest");
+       if (ret != EFI_SUCCESS)
+               return CMD_RET_FAILURE;
 
-               saddr = env_get("loadaddr");
-               if (saddr)
-                       addr = simple_strtoul(saddr, NULL, 16);
-               else
-                       addr = CONFIG_SYS_LOAD_ADDR;
-               memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size);
-       } else
-#endif
-#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
-       if (!strcmp(argv[1], "selftest")) {
-               struct efi_loaded_image_obj *image_obj;
-               struct efi_loaded_image *loaded_image_info;
-
-               r = bootefi_test_prepare(&image_obj, &loaded_image_info,
-                                        "\\selftest", "efi_selftest");
-               if (r != EFI_SUCCESS)
-                       return CMD_RET_FAILURE;
-
-               /* Execute the test */
-               r = EFI_CALL(efi_selftest(&image_obj->header, &systab));
-               bootefi_run_finish(image_obj, loaded_image_info);
-               return r != EFI_SUCCESS;
-       } else
-#endif
-       if (!strcmp(argv[1], "bootmgr")) {
-               return do_bootefi_bootmgr_exec();
-       } else {
-               saddr = argv[1];
+       /* Execute the test */
+       ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
+       bootefi_run_finish(image_obj, loaded_image_info);
 
-               addr = simple_strtoul(saddr, NULL, 16);
-               /* Check that a numeric value was passed */
-               if (!addr && *saddr != '0')
-                       return CMD_RET_USAGE;
+       return ret != EFI_SUCCESS;
+}
+#endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
 
-       }
+/* Interpreter command to boot an arbitrary EFI image from memory */
+static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
+{
+       if (argc < 2)
+               return CMD_RET_USAGE;
 
-       printf("## Starting EFI application at %08lx ...\n", addr);
-       r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path,
-                           bootefi_image_path);
-       printf("## Application terminated, r = %lu\n",
-              r & ~EFI_ERROR_MASK);
+       if (!strcmp(argv[1], "bootmgr"))
+               return do_efibootmgr(argc > 2 ? argv[2] : NULL);
+#ifdef CONFIG_CMD_BOOTEFI_SELFTEST
+       else if (!strcmp(argv[1], "selftest"))
+               return do_efi_selftest(argc > 2 ? argv[2] : NULL);
+#endif
 
-       if (r != EFI_SUCCESS)
-               return 1;
-       else
-               return 0;
+       return do_bootefi_image(argv[1], argc > 2 ? argv[2] : NULL);
 }
 
 #ifdef CONFIG_SYS_LONGHELP
@@ -508,7 +645,7 @@ static char bootefi_help_text[] =
        "    Use environment variable efi_selftest to select a single test.\n"
        "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
 #endif
-       "bootefi bootmgr [fdt addr]\n"
+       "bootefi bootmgr [fdt address]\n"
        "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
        "\n"
        "    If specified, the device tree located at <fdt address> gets\n"
@@ -533,6 +670,13 @@ void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
        ret = efi_dp_from_name(dev, devnr, path, &device, &image);
        if (ret == EFI_SUCCESS) {
                bootefi_device_path = device;
+               if (image) {
+                       /* FIXME: image should not contain device */
+                       struct efi_device_path *image_tmp = image;
+
+                       efi_dp_split_file_path(image, &device, &image);
+                       efi_free_pool(image_tmp);
+               }
                bootefi_image_path = image;
        } else {
                bootefi_device_path = NULL;