Merge tag 'efi-2020-07-rc6' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi
[oweals/u-boot.git] / cmd / efidebug.c
index d8a76d78a38896727f70fb7947b417303654c0f7..58018f700cd401a36e25d188f9722aa75e7c8535 100644 (file)
@@ -11,6 +11,7 @@
 #include <efi_loader.h>
 #include <exports.h>
 #include <hexdump.h>
+#include <log.h>
 #include <malloc.h>
 #include <mapmem.h>
 #include <search.h>
@@ -60,8 +61,8 @@ static const char sep[] = "================";
  * Implement efidebug "devices" sub-command.
  * Show all UEFI devices and their information.
  */
-static int do_efi_show_devices(cmd_tbl_t *cmdtp, int flag,
-                              int argc, char * const argv[])
+static int do_efi_show_devices(struct cmd_tbl *cmdtp, int flag,
+                              int argc, char *const argv[])
 {
        efi_handle_t *handles;
        efi_uintn_t num, i;
@@ -139,8 +140,8 @@ static int efi_get_driver_handle_info(efi_handle_t handle, u16 **driver_name,
  * Implement efidebug "drivers" sub-command.
  * Show all UEFI drivers and their information.
  */
-static int do_efi_show_drivers(cmd_tbl_t *cmdtp, int flag,
-                              int argc, char * const argv[])
+static int do_efi_show_drivers(struct cmd_tbl *cmdtp, int flag,
+                              int argc, char *const argv[])
 {
        efi_handle_t *handles;
        efi_uintn_t num, i;
@@ -311,8 +312,8 @@ static const char *get_guid_text(const void *guid)
  * Show all UEFI handles and their information, currently all protocols
  * added to handle.
  */
-static int do_efi_show_handles(cmd_tbl_t *cmdtp, int flag,
-                              int argc, char * const argv[])
+static int do_efi_show_handles(struct cmd_tbl *cmdtp, int flag,
+                              int argc, char *const argv[])
 {
        efi_handle_t *handles;
        efi_guid_t **guid;
@@ -371,8 +372,8 @@ static int do_efi_show_handles(cmd_tbl_t *cmdtp, int flag,
  * Implement efidebug "images" sub-command.
  * Show all UEFI loaded images and their information.
  */
-static int do_efi_show_images(cmd_tbl_t *cmdtp, int flag,
-                             int argc, char * const argv[])
+static int do_efi_show_images(struct cmd_tbl *cmdtp, int flag,
+                             int argc, char *const argv[])
 {
        efi_print_image_infos(NULL);
 
@@ -413,6 +414,7 @@ static const struct efi_mem_attrs {
        {EFI_MEMORY_NV, "NV"},
        {EFI_MEMORY_MORE_RELIABLE, "REL"},
        {EFI_MEMORY_RO, "RO"},
+       {EFI_MEMORY_SP, "SP"},
        {EFI_MEMORY_RUNTIME, "RT"},
 };
 
@@ -453,8 +455,8 @@ static void print_memory_attributes(u64 attributes)
  * Implement efidebug "memmap" sub-command.
  * Show UEFI memory map.
  */
-static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
-                             int argc, char * const argv[])
+static int do_efi_show_memmap(struct cmd_tbl *cmdtp, int flag,
+                             int argc, char *const argv[])
 {
        struct efi_mem_desc *memmap = NULL, *map;
        efi_uintn_t map_size = 0;
@@ -480,6 +482,11 @@ 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 < ARRAY_SIZE(efi_mem_type_string))
                        type = efi_mem_type_string[map->type];
@@ -516,8 +523,8 @@ static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
  * 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[])
+static int do_efi_show_tables(struct cmd_tbl *cmdtp, int flag,
+                             int argc, char *const argv[])
 {
        efi_uintn_t i;
        const char *guid_str;
@@ -546,8 +553,8 @@ static int do_efi_show_tables(cmd_tbl_t *cmdtp, int flag,
  *
  *     efidebug boot add <id> <label> <interface> <devnum>[:<part>] <file> <options>
  */
-static int do_efi_boot_add(cmd_tbl_t *cmdtp, int flag,
-                          int argc, char * const argv[])
+static int do_efi_boot_add(struct cmd_tbl *cmdtp, int flag,
+                          int argc, char *const argv[])
 {
        int id;
        char *endp;
@@ -602,7 +609,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];
@@ -645,8 +652,8 @@ out:
  *
  *     efidebug boot rm <id> ...
  */
-static int do_efi_boot_rm(cmd_tbl_t *cmdtp, int flag,
-                         int argc, char * const argv[])
+static int do_efi_boot_rm(struct cmd_tbl *cmdtp, int flag,
+                         int argc, char *const argv[])
 {
        efi_guid_t guid;
        int id, i;
@@ -687,14 +694,19 @@ static int do_efi_boot_rm(cmd_tbl_t *cmdtp, int flag,
  *
  * Decode the value of UEFI load option variable and print information.
  */
-static void show_efi_boot_opt_data(u16 *varname16, 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;
        size_t label_len16, label_len;
        u16 *dp_str;
+       efi_status_t ret;
 
-       efi_deserialize_load_option(&lo, data);
+       ret = efi_deserialize_load_option(&lo, data, size);
+       if (ret != EFI_SUCCESS) {
+               printf("%ls: invalid load option\n", varname16);
+               return;
+       }
 
        label_len16 = u16_strlen(lo.label);
        label_len = utf16_utf8_strnlen(lo.label, label_len16);
@@ -721,8 +733,7 @@ static void show_efi_boot_opt_data(u16 *varname16, void *data, size_t size)
 
        printf("  data:\n");
        print_hex_dump("    ", DUMP_PREFIX_OFFSET, 16, 1,
-                      lo.optional_data, size + (u8 *)data -
-                      (u8 *)lo.optional_data, true);
+                      lo.optional_data, *size, true);
        free(label);
 }
 
@@ -752,7 +763,7 @@ static void show_efi_boot_opt(u16 *varname16)
                                                &efi_global_variable_guid,
                                                NULL, &size, data));
                if (ret == EFI_SUCCESS)
-                       show_efi_boot_opt_data(varname16, data, size);
+                       show_efi_boot_opt_data(varname16, data, &size);
                free(data);
        }
 }
@@ -782,8 +793,8 @@ static int u16_tohex(u16 c)
  *
  *     efidebug boot dump
  */
-static int do_efi_boot_dump(cmd_tbl_t *cmdtp, int flag,
-                           int argc, char * const argv[])
+static int do_efi_boot_dump(struct cmd_tbl *cmdtp, int flag,
+                           int argc, char *const argv[])
 {
        u16 *var_name16, *p;
        efi_uintn_t buf_size, size;
@@ -913,7 +924,12 @@ static int show_efi_boot_order(void)
                        goto out;
                }
 
-               efi_deserialize_load_option(&lo, data);
+               ret = efi_deserialize_load_option(&lo, data, &size);
+               if (ret != EFI_SUCCESS) {
+                       printf("%ls: invalid load option\n", var_name16);
+                       ret = CMD_RET_FAILURE;
+                       goto out;
+               }
 
                label_len16 = u16_strlen(lo.label);
                label_len = utf16_utf8_strnlen(lo.label, label_len16);
@@ -951,8 +967,8 @@ out:
  *
  *     efidebug boot next <id>
  */
-static int do_efi_boot_next(cmd_tbl_t *cmdtp, int flag,
-                           int argc, char * const argv[])
+static int do_efi_boot_next(struct cmd_tbl *cmdtp, int flag,
+                           int argc, char *const argv[])
 {
        u16 bootnext;
        efi_uintn_t size;
@@ -965,7 +981,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;
@@ -1000,8 +1016,8 @@ out:
  *
  *     efidebug boot order [<id> ...]
  */
-static int do_efi_boot_order(cmd_tbl_t *cmdtp, int flag,
-                            int argc, char * const argv[])
+static int do_efi_boot_order(struct cmd_tbl *cmdtp, int flag,
+                            int argc, char *const argv[])
 {
        u16 *bootorder = NULL;
        efi_uintn_t size;
@@ -1049,7 +1065,7 @@ out:
        return r;
 }
 
-static cmd_tbl_t cmd_efidebug_boot_sub[] = {
+static struct cmd_tbl cmd_efidebug_boot_sub[] = {
        U_BOOT_CMD_MKENT(add, CONFIG_SYS_MAXARGS, 1, do_efi_boot_add, "", ""),
        U_BOOT_CMD_MKENT(rm, CONFIG_SYS_MAXARGS, 1, do_efi_boot_rm, "", ""),
        U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_efi_boot_dump, "", ""),
@@ -1070,10 +1086,10 @@ static cmd_tbl_t cmd_efidebug_boot_sub[] = {
  *
  * Implement efidebug "boot" sub-command.
  */
-static int do_efi_boot_opt(cmd_tbl_t *cmdtp, int flag,
-                          int argc, char * const argv[])
+static int do_efi_boot_opt(struct cmd_tbl *cmdtp, int flag,
+                          int argc, char *const argv[])
 {
-       cmd_tbl_t *cp;
+       struct cmd_tbl *cp;
 
        if (argc < 2)
                return CMD_RET_USAGE;
@@ -1103,7 +1119,7 @@ static int do_efi_boot_opt(cmd_tbl_t *cmdtp, int flag,
  *
  *     efidebug test bootmgr
  */
-static int do_efi_test_bootmgr(cmd_tbl_t *cmdtp, int flag,
+static int do_efi_test_bootmgr(struct cmd_tbl *cmdtp, int flag,
                               int argc, char * const argv[])
 {
        efi_handle_t image;
@@ -1125,7 +1141,7 @@ static int do_efi_test_bootmgr(cmd_tbl_t *cmdtp, int flag,
        return CMD_RET_SUCCESS;
 }
 
-static cmd_tbl_t cmd_efidebug_test_sub[] = {
+static struct cmd_tbl cmd_efidebug_test_sub[] = {
        U_BOOT_CMD_MKENT(bootmgr, CONFIG_SYS_MAXARGS, 1, do_efi_test_bootmgr,
                         "", ""),
 };
@@ -1142,10 +1158,10 @@ static cmd_tbl_t cmd_efidebug_test_sub[] = {
  *
  * Implement efidebug "test" sub-command.
  */
-static int do_efi_test(cmd_tbl_t *cmdtp, int flag,
+static int do_efi_test(struct cmd_tbl *cmdtp, int flag,
                       int argc, char * const argv[])
 {
-       cmd_tbl_t *cp;
+       struct cmd_tbl *cp;
 
        if (argc < 2)
                return CMD_RET_USAGE;
@@ -1160,7 +1176,59 @@ static int do_efi_test(cmd_tbl_t *cmdtp, int flag,
        return cp->cmd(cmdtp, flag, argc, argv);
 }
 
-static cmd_tbl_t cmd_efidebug_sub[] = {
+/**
+ * do_efi_query_info() - QueryVariableInfo EFI service
+ *
+ * @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_FAILURE on failure
+ *
+ * Implement efidebug "test" sub-command.
+ */
+
+static int do_efi_query_info(struct cmd_tbl *cmdtp, int flag,
+                            int argc, char * const argv[])
+{
+       efi_status_t ret;
+       u32 attr = 0;
+       u64 max_variable_storage_size;
+       u64 remain_variable_storage_size;
+       u64 max_variable_size;
+       int i;
+
+       for (i = 1; i < argc; i++) {
+               if (!strcmp(argv[i], "-bs"))
+                       attr |= EFI_VARIABLE_BOOTSERVICE_ACCESS;
+               else if (!strcmp(argv[i], "-rt"))
+                       attr |= EFI_VARIABLE_RUNTIME_ACCESS;
+               else if (!strcmp(argv[i], "-nv"))
+                       attr |= EFI_VARIABLE_NON_VOLATILE;
+               else if (!strcmp(argv[i], "-at"))
+                       attr |=
+                               EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
+       }
+
+       ret = EFI_CALL(efi_query_variable_info(attr,
+                                              &max_variable_storage_size,
+                                              &remain_variable_storage_size,
+                                              &max_variable_size));
+       if (ret != EFI_SUCCESS) {
+               printf("Error: Cannot query UEFI variables, r = %lu\n",
+                      ret & ~EFI_ERROR_MASK);
+               return CMD_RET_FAILURE;
+       }
+
+       printf("Max storage size %llu\n", max_variable_storage_size);
+       printf("Remaining storage size %llu\n", remain_variable_storage_size);
+       printf("Max variable size %llu\n", max_variable_size);
+
+       return CMD_RET_SUCCESS;
+}
+
+static struct cmd_tbl 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,
                         "", ""),
@@ -1176,6 +1244,8 @@ static cmd_tbl_t cmd_efidebug_sub[] = {
                         "", ""),
        U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_efi_test,
                         "", ""),
+       U_BOOT_CMD_MKENT(query, CONFIG_SYS_MAXARGS, 1, do_efi_query_info,
+                        "", ""),
 };
 
 /**
@@ -1191,10 +1261,10 @@ static cmd_tbl_t cmd_efidebug_sub[] = {
  * Implement efidebug command which allows us to display and
  * configure UEFI environment.
  */
-static int do_efidebug(cmd_tbl_t *cmdtp, int flag,
-                      int argc, char * const argv[])
+static int do_efidebug(struct cmd_tbl *cmdtp, int flag,
+                      int argc, char *const argv[])
 {
-       cmd_tbl_t *cp;
+       struct cmd_tbl *cp;
        efi_status_t r;
 
        if (argc < 2)
@@ -1247,7 +1317,9 @@ static char efidebug_help_text[] =
        "efidebug tables\n"
        "  - show UEFI configuration tables\n"
        "efidebug test bootmgr\n"
-       "  - run simple bootmgr for test\n";
+       "  - run simple bootmgr for test\n"
+       "efidebug query [-nv][-bs][-rt][-at]\n"
+       "  - show size of UEFI variables store\n";
 #endif
 
 U_BOOT_CMD(