efi_loader: fix 'efidebug boot dump'
[oweals/u-boot.git] / cmd / efidebug.c
index 02dc491a68b6df91956ffed820adfef17ac63add..7ff2ce4ce1c27d29a7949487a3971c4b7b2b9be2 100644 (file)
@@ -9,10 +9,10 @@
 #include <common.h>
 #include <command.h>
 #include <efi_loader.h>
-#include <environment.h>
 #include <exports.h>
 #include <hexdump.h>
 #include <malloc.h>
+#include <mapmem.h>
 #include <search.h>
 #include <linux/ctype.h>
 
@@ -244,6 +244,10 @@ static const struct {
                "HII Config Routing",
                EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID,
        },
+       {
+               "Load File2",
+               EFI_LOAD_FILE2_PROTOCOL_GUID,
+       },
        {
                "Simple Network",
                EFI_SIMPLE_NETWORK_PROTOCOL_GUID,
@@ -252,27 +256,47 @@ static const struct {
                "PXE Base Code",
                EFI_PXE_BASE_CODE_PROTOCOL_GUID,
        },
+       /* Configuration table GUIDs */
+       {
+               "ACPI table",
+               EFI_ACPI_TABLE_GUID,
+       },
+       {
+               "device tree",
+               EFI_FDT_GUID,
+       },
+       {
+               "SMBIOS table",
+               SMBIOS_TABLE_GUID,
+       },
+       {
+               "Runtime properties",
+               EFI_RT_PROPERTIES_TABLE_GUID,
+       },
 };
 
 /**
- * get_guid_text - get string of protocol guid
- * @guid:      Protocol guid
- * Return:     String
+ * get_guid_text - get string of GUID
  *
- * Return string for display to represent the protocol.
+ * Return description of GUID.
+ *
+ * @guid:      GUID
+ * Return:     description of GUID or NULL
  */
-static const char *get_guid_text(const efi_guid_t *guid)
+static const char *get_guid_text(const void *guid)
 {
        int i;
 
-       for (i = 0; i < ARRAY_SIZE(guid_list); i++)
+       for (i = 0; i < ARRAY_SIZE(guid_list); i++) {
+               /*
+                * As guidcmp uses memcmp() we can safely accept unaligned
+                * GUIDs.
+                */
                if (!guidcmp(&guid_list[i].guid, guid))
-                       break;
+                       return guid_list[i].text;
+       }
 
-       if (i != ARRAY_SIZE(guid_list))
-               return guid_list[i].text;
-       else
-               return NULL;
+       return NULL;
 }
 
 /**
@@ -465,9 +489,12 @@ static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
 
                printf("%-16s %.*llx-%.*llx", type,
                       EFI_PHYS_ADDR_WIDTH,
-                      map->physical_start,
+                      (u64)map_to_sysmem((void *)(uintptr_t)
+                                         map->physical_start),
                       EFI_PHYS_ADDR_WIDTH,
-                      map->physical_start + map->num_pages * EFI_PAGE_SIZE);
+                      (u64)map_to_sysmem((void *)(uintptr_t)
+                                         (map->physical_start +
+                                          map->num_pages * EFI_PAGE_SIZE)));
 
                print_memory_attributes(map->attribute);
                putc('\n');
@@ -478,6 +505,34 @@ static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
        return CMD_RET_SUCCESS;
 }
 
+/**
+ * do_efi_show_tables() - show UEFI configuration tables
+ *
+ * @cmdtp:     Command table
+ * @flag:      Command flag
+ * @argc:      Number of arguments
+ * @argv:      Argument array
+ * Return:     CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
+ *
+ * Implement efidebug "tables" sub-command.
+ * Show UEFI configuration tables.
+ */
+static int do_efi_show_tables(cmd_tbl_t *cmdtp, int flag,
+                             int argc, char * const argv[])
+{
+       efi_uintn_t i;
+       const char *guid_str;
+
+       for (i = 0; i < systab.nr_tables; ++i) {
+               guid_str = get_guid_text(&systab.tables[i].guid);
+               if (!guid_str)
+                       guid_str = "";
+               printf("%pUl %s\n", &systab.tables[i].guid, guid_str);
+       }
+
+       return CMD_RET_SUCCESS;
+}
+
 /**
  * do_efi_boot_add() - set UEFI load option
  *
@@ -598,7 +653,7 @@ static int do_efi_boot_rm(cmd_tbl_t *cmdtp, int flag,
        int id, i;
        char *endp;
        char var_name[9];
-       u16 var_name16[9];
+       u16 var_name16[9], *p;
        efi_status_t ret;
 
        if (argc == 1)
@@ -611,11 +666,12 @@ static int do_efi_boot_rm(cmd_tbl_t *cmdtp, int flag,
                        return CMD_RET_FAILURE;
 
                sprintf(var_name, "Boot%04X", id);
-               utf8_utf16_strncpy((u16 **)&var_name16, var_name, 9);
+               p = var_name16;
+               utf8_utf16_strncpy(&p, var_name, 9);
 
                ret = EFI_CALL(RT->set_variable(var_name16, &guid, 0, 0, NULL));
                if (ret) {
-                       printf("Cannot remove Boot%04X", id);
+                       printf("Cannot remove %ls\n", var_name16);
                        return CMD_RET_FAILURE;
                }
        }
@@ -626,13 +682,13 @@ static int do_efi_boot_rm(cmd_tbl_t *cmdtp, int flag,
 /**
  * show_efi_boot_opt_data() - dump UEFI load option
  *
- * @id:                load option number
+ * @varname16: variable name
  * @data:      value of UEFI load option variable
  * @size:      size of the boot option
  *
  * Decode the value of UEFI load option variable and print information.
  */
-static void show_efi_boot_opt_data(int id, void *data, size_t size)
+static void show_efi_boot_opt_data(u16 *varname16, void *data, size_t size)
 {
        struct efi_load_option lo;
        char *label, *p;
@@ -649,8 +705,8 @@ static void show_efi_boot_opt_data(int id, void *data, size_t size)
        p = label;
        utf16_utf8_strncpy(&p, lo.label, label_len16);
 
-       printf("Boot%04X:\n", id);
-       printf("  attributes: %c%c%c (0x%08x)\n",
+       printf("%ls:\nattributes: %c%c%c (0x%08x)\n",
+              varname16,
               /* ACTIVE */
               lo.attributes & LOAD_OPTION_ACTIVE ? 'A' : '-',
               /* FORCE RECONNECT */
@@ -674,37 +730,32 @@ static void show_efi_boot_opt_data(int id, void *data, size_t size)
 /**
  * show_efi_boot_opt() - dump UEFI load option
  *
- * @id:                Load option number
+ * @varname16: variable name
  *
  * Dump information defined by UEFI load option.
  */
-static void show_efi_boot_opt(int id)
+static void show_efi_boot_opt(u16 *varname16)
 {
-       char var_name[9];
-       u16 var_name16[9], *p;
-       efi_guid_t guid;
-       void *data = NULL;
+       void *data;
        efi_uintn_t size;
-       int ret;
-
-       sprintf(var_name, "Boot%04X", id);
-       p = var_name16;
-       utf8_utf16_strncpy(&p, var_name, 9);
-       guid = efi_global_variable_guid;
+       efi_status_t ret;
 
        size = 0;
-       ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size, NULL));
-       if (ret == (int)EFI_BUFFER_TOO_SMALL) {
+       ret = EFI_CALL(efi_get_variable(varname16, &efi_global_variable_guid,
+                                       NULL, &size, NULL));
+       if (ret == EFI_BUFFER_TOO_SMALL) {
                data = malloc(size);
-               ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size,
-                                               data));
+               if (!data) {
+                       printf("ERROR: Out of memory\n");
+                       return;
+               }
+               ret = EFI_CALL(efi_get_variable(varname16,
+                                               &efi_global_variable_guid,
+                                               NULL, &size, data));
+               if (ret == EFI_SUCCESS)
+                       show_efi_boot_opt_data(varname16, data, size);
+               free(data);
        }
-       if (ret == EFI_SUCCESS)
-               show_efi_boot_opt_data(id, data, size);
-       else if (ret == EFI_NOT_FOUND)
-               printf("Boot%04X: not found\n", id);
-
-       free(data);
 }
 
 static int u16_tohex(u16 c)
@@ -729,7 +780,8 @@ static int u16_tohex(u16 c)
  *
  * Implement efidebug "boot dump" sub-command.
  * Dump information of all UEFI load options defined.
- *   - boot dump
+ *
+ *     efidebug boot dump
  */
 static int do_efi_boot_dump(cmd_tbl_t *cmdtp, int flag,
                            int argc, char * const argv[])
@@ -782,7 +834,7 @@ static int do_efi_boot_dump(cmd_tbl_t *cmdtp, int flag,
                        id = (id << 4) + digit;
                }
                if (i == 4 && !var_name16[8])
-                       show_efi_boot_opt(id);
+                       show_efi_boot_opt(var_name16);
        }
 
        free(var_name16);
@@ -1013,7 +1065,6 @@ static cmd_tbl_t cmd_efidebug_boot_sub[] = {
  *             CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
  *
  * Implement efidebug "boot" sub-command.
- * See above for details of sub-commands.
  */
 static int do_efi_boot_opt(cmd_tbl_t *cmdtp, int flag,
                           int argc, char * const argv[])
@@ -1033,6 +1084,78 @@ static int do_efi_boot_opt(cmd_tbl_t *cmdtp, int flag,
        return cp->cmd(cmdtp, flag, argc, argv);
 }
 
+/**
+ * do_efi_test_bootmgr() - run simple bootmgr for test
+ *
+ * @cmdtp:     Command table
+ * @flag:      Command flag
+ * @argc:      Number of arguments
+ * @argv:      Argument array
+ * Return:     CMD_RET_SUCCESS on success,
+ *             CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
+ *
+ * Implement efidebug "test bootmgr" sub-command.
+ * Run simple bootmgr for test.
+ *
+ *     efidebug test bootmgr
+ */
+static int do_efi_test_bootmgr(cmd_tbl_t *cmdtp, int flag,
+                              int argc, char * const argv[])
+{
+       efi_handle_t image;
+       efi_uintn_t exit_data_size = 0;
+       u16 *exit_data = NULL;
+       efi_status_t ret;
+
+       ret = efi_bootmgr_load(&image);
+       printf("efi_bootmgr_load() returned: %ld\n", ret & ~EFI_ERROR_MASK);
+
+       /* We call efi_start_image() even if error for test purpose. */
+       ret = EFI_CALL(efi_start_image(image, &exit_data_size, &exit_data));
+       printf("efi_start_image() returned: %ld\n", ret & ~EFI_ERROR_MASK);
+       if (ret && exit_data)
+               efi_free_pool(exit_data);
+
+       efi_restore_gd();
+
+       return CMD_RET_SUCCESS;
+}
+
+static cmd_tbl_t cmd_efidebug_test_sub[] = {
+       U_BOOT_CMD_MKENT(bootmgr, CONFIG_SYS_MAXARGS, 1, do_efi_test_bootmgr,
+                        "", ""),
+};
+
+/**
+ * do_efi_test() - manage UEFI load options
+ *
+ * @cmdtp:     Command table
+ * @flag:      Command flag
+ * @argc:      Number of arguments
+ * @argv:      Argument array
+ * Return:     CMD_RET_SUCCESS on success,
+ *             CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
+ *
+ * Implement efidebug "test" sub-command.
+ */
+static int do_efi_test(cmd_tbl_t *cmdtp, int flag,
+                      int argc, char * const argv[])
+{
+       cmd_tbl_t *cp;
+
+       if (argc < 2)
+               return CMD_RET_USAGE;
+
+       argc--; argv++;
+
+       cp = find_cmd_tbl(argv[0], cmd_efidebug_test_sub,
+                         ARRAY_SIZE(cmd_efidebug_test_sub));
+       if (!cp)
+               return CMD_RET_USAGE;
+
+       return cp->cmd(cmdtp, flag, argc, argv);
+}
+
 static cmd_tbl_t cmd_efidebug_sub[] = {
        U_BOOT_CMD_MKENT(boot, CONFIG_SYS_MAXARGS, 1, do_efi_boot_opt, "", ""),
        U_BOOT_CMD_MKENT(devices, CONFIG_SYS_MAXARGS, 1, do_efi_show_devices,
@@ -1045,6 +1168,10 @@ static cmd_tbl_t cmd_efidebug_sub[] = {
                         "", ""),
        U_BOOT_CMD_MKENT(memmap, CONFIG_SYS_MAXARGS, 1, do_efi_show_memmap,
                         "", ""),
+       U_BOOT_CMD_MKENT(tables, CONFIG_SYS_MAXARGS, 1, do_efi_show_tables,
+                        "", ""),
+       U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_efi_test,
+                        "", ""),
 };
 
 /**
@@ -1059,7 +1186,6 @@ static cmd_tbl_t cmd_efidebug_sub[] = {
  *
  * Implement efidebug command which allows us to display and
  * configure UEFI environment.
- * See above for details of sub-commands.
  */
 static int do_efidebug(cmd_tbl_t *cmdtp, int flag,
                       int argc, char * const argv[])
@@ -1105,15 +1231,19 @@ static char efidebug_help_text[] =
        "  - set/show UEFI boot order\n"
        "\n"
        "efidebug devices\n"
-       "  - show uefi devices\n"
+       "  - show UEFI devices\n"
        "efidebug drivers\n"
-       "  - show uefi drivers\n"
+       "  - show UEFI drivers\n"
        "efidebug dh\n"
-       "  - show uefi handles\n"
+       "  - show UEFI handles\n"
        "efidebug images\n"
        "  - show loaded images\n"
        "efidebug memmap\n"
-       "  - show uefi memory map\n";
+       "  - show UEFI memory map\n"
+       "efidebug tables\n"
+       "  - show UEFI configuration tables\n"
+       "efidebug test bootmgr\n"
+       "  - run simple bootmgr for test\n";
 #endif
 
 U_BOOT_CMD(