cmd: efidebug: fix -Werror=type-limits warning
[oweals/u-boot.git] / cmd / efidebug.c
index 961e8fad22be51b320bcfbf886937302db402142..5cc0a41af3b441f072e7432e596dcbf079fbc357 100644 (file)
@@ -9,15 +9,14 @@
 #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>
 
 #define BS systab.boottime
-#define RT systab.runtime
 
 /**
  * efi_get_device_handle_info() - get information of UEFI device
@@ -69,7 +68,7 @@ static int do_efi_show_devices(cmd_tbl_t *cmdtp, int flag,
        u16 *dev_path_text;
        efi_status_t ret;
 
-       ret = EFI_CALL(BS->locate_handle_buffer(ALL_HANDLES, NULL, NULL,
+       ret = EFI_CALL(efi_locate_handle_buffer(ALL_HANDLES, NULL, NULL,
                                                &num, &handles));
        if (ret != EFI_SUCCESS)
                return CMD_RET_FAILURE;
@@ -86,7 +85,7 @@ static int do_efi_show_devices(cmd_tbl_t *cmdtp, int flag,
                }
        }
 
-       EFI_CALL(BS->free_pool(handles));
+       efi_free_pool(handles);
 
        return CMD_RET_SUCCESS;
 }
@@ -148,7 +147,7 @@ static int do_efi_show_drivers(cmd_tbl_t *cmdtp, int flag,
        u16 *driver_name, *image_path_text;
        efi_status_t ret;
 
-       ret = EFI_CALL(BS->locate_handle_buffer(
+       ret = EFI_CALL(efi_locate_handle_buffer(
                                BY_PROTOCOL, &efi_guid_driver_binding_protocol,
                                NULL, &num, &handles));
        if (ret != EFI_SUCCESS)
@@ -170,12 +169,12 @@ static int do_efi_show_drivers(cmd_tbl_t *cmdtp, int flag,
                        else
                                printf("%p %-20ls <built-in>\n",
                                       handles[i], driver_name);
-                       EFI_CALL(BS->free_pool(driver_name));
-                       EFI_CALL(BS->free_pool(image_path_text));
+                       efi_free_pool(driver_name);
+                       efi_free_pool(image_path_text);
                }
        }
 
-       EFI_CALL(BS->free_pool(handles));
+       efi_free_pool(handles);
 
        return CMD_RET_SUCCESS;
 }
@@ -244,6 +243,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 +255,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 description of GUID.
  *
- * Return string for display to represent the protocol.
+ * @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;
 }
 
 /**
@@ -297,7 +320,7 @@ static int do_efi_show_handles(cmd_tbl_t *cmdtp, int flag,
        const char *guid_text;
        efi_status_t ret;
 
-       ret = EFI_CALL(BS->locate_handle_buffer(ALL_HANDLES, NULL, NULL,
+       ret = EFI_CALL(efi_locate_handle_buffer(ALL_HANDLES, NULL, NULL,
                                                &num, &handles));
        if (ret != EFI_SUCCESS)
                return CMD_RET_FAILURE;
@@ -331,7 +354,7 @@ static int do_efi_show_handles(cmd_tbl_t *cmdtp, int flag,
                putc('\n');
        }
 
-       EFI_CALL(BS->free_pool(handles));
+       efi_free_pool(handles);
 
        return CMD_RET_SUCCESS;
 }
@@ -371,6 +394,7 @@ static const char * const efi_mem_type_string[] = {
        [EFI_MMAP_IO] = "IO",
        [EFI_MMAP_IO_PORT] = "IO PORT",
        [EFI_PAL_CODE] = "PAL",
+       [EFI_PERSISTENT_MEMORY_TYPE] = "PERSISTENT",
 };
 
 static const struct efi_mem_attrs {
@@ -438,18 +462,17 @@ static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
        int i;
        efi_status_t ret;
 
-       ret = EFI_CALL(BS->get_memory_map(&map_size, memmap, NULL, NULL, NULL));
+       ret = efi_get_memory_map(&map_size, memmap, NULL, NULL, NULL);
        if (ret == EFI_BUFFER_TOO_SMALL) {
                map_size += sizeof(struct efi_mem_desc); /* for my own */
-               ret = EFI_CALL(BS->allocate_pool(EFI_LOADER_DATA,
-                                                map_size, (void *)&memmap));
+               ret = efi_allocate_pool(EFI_LOADER_DATA, map_size,
+                                       (void *)&memmap);
                if (ret != EFI_SUCCESS)
                        return CMD_RET_FAILURE;
-               ret = EFI_CALL(BS->get_memory_map(&map_size, memmap,
-                                                 NULL, NULL, NULL));
+               ret = efi_get_memory_map(&map_size, memmap, NULL, NULL, NULL);
        }
        if (ret != EFI_SUCCESS) {
-               EFI_CALL(BS->free_pool(memmap));
+               efi_free_pool(memmap);
                return CMD_RET_FAILURE;
        }
 
@@ -457,23 +480,59 @@ static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
               EFI_PHYS_ADDR_WIDTH - 5, spc, EFI_PHYS_ADDR_WIDTH - 3, spc);
        printf("================ %.*s %.*s ==========\n",
               EFI_PHYS_ADDR_WIDTH, sep, EFI_PHYS_ADDR_WIDTH, sep);
+       /*
+        * Coverity check: dereferencing null pointer "map."
+        * This is a false positive as memmap will always be
+        * populated by allocate_pool() above.
+        */
        for (i = 0, map = memmap; i < map_size / sizeof(*map); map++, i++) {
-               if (map->type < EFI_MAX_MEMORY_TYPE)
+               if (map->type < ARRAY_SIZE(efi_mem_type_string))
                        type = efi_mem_type_string[map->type];
                else
                        type = "(unknown)";
 
                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');
        }
 
-       EFI_CALL(BS->free_pool(memmap));
+       efi_free_pool(memmap);
+
+       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;
 }
@@ -548,7 +607,7 @@ static int do_efi_boot_add(cmd_tbl_t *cmdtp, int flag,
                                + sizeof(struct efi_device_path); /* for END */
 
        /* optional data */
-       if (argc < 6)
+       if (argc == 6)
                lo.optional_data = NULL;
        else
                lo.optional_data = (const u8 *)argv[6];
@@ -559,7 +618,7 @@ static int do_efi_boot_add(cmd_tbl_t *cmdtp, int flag,
                goto out;
        }
 
-       ret = EFI_CALL(RT->set_variable(var_name16, &guid,
+       ret = EFI_CALL(efi_set_variable(var_name16, &guid,
                                        EFI_VARIABLE_NON_VOLATILE |
                                        EFI_VARIABLE_BOOTSERVICE_ACCESS |
                                        EFI_VARIABLE_RUNTIME_ACCESS,
@@ -598,7 +657,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 +670,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));
+               ret = EFI_CALL(efi_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 +686,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 +709,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 +734,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)
@@ -783,7 +838,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);
@@ -800,8 +855,7 @@ static int do_efi_boot_dump(cmd_tbl_t *cmdtp, int flag,
  */
 static int show_efi_boot_order(void)
 {
-       efi_guid_t guid;
-       u16 *bootorder = NULL;
+       u16 *bootorder;
        efi_uintn_t size;
        int num, i;
        char var_name[9];
@@ -812,20 +866,25 @@ static int show_efi_boot_order(void)
        size_t label_len16, label_len;
        efi_status_t ret;
 
-       guid = efi_global_variable_guid;
        size = 0;
-       ret = EFI_CALL(RT->get_variable(L"BootOrder", &guid, NULL, &size,
-                                       NULL));
-       if (ret == EFI_BUFFER_TOO_SMALL) {
-               bootorder = malloc(size);
-               ret = EFI_CALL(RT->get_variable(L"BootOrder", &guid, NULL,
-                                               &size, bootorder));
+       ret = EFI_CALL(efi_get_variable(L"BootOrder", &efi_global_variable_guid,
+                                       NULL, &size, NULL));
+       if (ret != EFI_BUFFER_TOO_SMALL) {
+               if (ret == EFI_NOT_FOUND) {
+                       printf("BootOrder not defined\n");
+                       return CMD_RET_SUCCESS;
+               } else {
+                       return CMD_RET_FAILURE;
+               }
        }
-       if (ret == EFI_NOT_FOUND) {
-               printf("BootOrder not defined\n");
-               ret = CMD_RET_SUCCESS;
-               goto out;
-       } else if (ret != EFI_SUCCESS) {
+       bootorder = malloc(size);
+       if (!bootorder) {
+               printf("ERROR: Out of memory\n");
+               return CMD_RET_FAILURE;
+       }
+       ret = EFI_CALL(efi_get_variable(L"BootOrder", &efi_global_variable_guid,
+                                       NULL, &size, bootorder));
+       if (ret != EFI_SUCCESS) {
                ret = CMD_RET_FAILURE;
                goto out;
        }
@@ -837,11 +896,11 @@ static int show_efi_boot_order(void)
                utf8_utf16_strncpy(&p16, var_name, 9);
 
                size = 0;
-               ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size,
-                                               NULL));
+               ret = EFI_CALL(efi_get_variable(var_name16,
+                                               &efi_global_variable_guid, NULL,
+                                               &size, NULL));
                if (ret != EFI_BUFFER_TOO_SMALL) {
-                       printf("%2d: Boot%04X: (not defined)\n",
-                              i + 1, bootorder[i]);
+                       printf("%2d: %s: (not defined)\n", i + 1, var_name);
                        continue;
                }
 
@@ -850,8 +909,9 @@ static int show_efi_boot_order(void)
                        ret = CMD_RET_FAILURE;
                        goto out;
                }
-               ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size,
-                                               data));
+               ret = EFI_CALL(efi_get_variable(var_name16,
+                                               &efi_global_variable_guid, NULL,
+                                               &size, data));
                if (ret != EFI_SUCCESS) {
                        free(data);
                        ret = CMD_RET_FAILURE;
@@ -870,7 +930,7 @@ static int show_efi_boot_order(void)
                }
                p = label;
                utf16_utf8_strncpy(&p, lo.label, label_len16);
-               printf("%2d: Boot%04X: %s\n", i + 1, bootorder[i], label);
+               printf("%2d: %s: %s\n", i + 1, var_name, label);
                free(label);
 
                free(data);
@@ -910,7 +970,7 @@ static int do_efi_boot_next(cmd_tbl_t *cmdtp, int flag,
                return CMD_RET_USAGE;
 
        bootnext = (u16)simple_strtoul(argv[1], &endp, 16);
-       if (*endp != '\0' || bootnext > 0xffff) {
+       if (*endp) {
                printf("invalid value: %s\n", argv[1]);
                r = CMD_RET_FAILURE;
                goto out;
@@ -918,7 +978,7 @@ static int do_efi_boot_next(cmd_tbl_t *cmdtp, int flag,
 
        guid = efi_global_variable_guid;
        size = sizeof(u16);
-       ret = EFI_CALL(RT->set_variable(L"BootNext", &guid,
+       ret = EFI_CALL(efi_set_variable(L"BootNext", &guid,
                                        EFI_VARIABLE_NON_VOLATILE |
                                        EFI_VARIABLE_BOOTSERVICE_ACCESS |
                                        EFI_VARIABLE_RUNTIME_ACCESS,
@@ -979,7 +1039,7 @@ static int do_efi_boot_order(cmd_tbl_t *cmdtp, int flag,
        }
 
        guid = efi_global_variable_guid;
-       ret = EFI_CALL(RT->set_variable(L"BootOrder", &guid,
+       ret = EFI_CALL(efi_set_variable(L"BootOrder", &guid,
                                        EFI_VARIABLE_NON_VOLATILE |
                                        EFI_VARIABLE_BOOTSERVICE_ACCESS |
                                        EFI_VARIABLE_RUNTIME_ACCESS,
@@ -1033,6 +1093,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 +1177,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,
+                        "", ""),
 };
 
 /**
@@ -1104,15 +1240,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(