cmd/efi.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2015 Google, Inc
   4  * Written by Simon Glass <sjg@chromium.org>
   5  */
   6
   7 #include <common.h>
   8 #include <command.h>
   9 #include <efi.h>
  10 #include <errno.h>
  11 #include <malloc.h>
  12 #include <sort.h>
  13
  14 static const char *const type_name[] = {
  15         "reserved",
  16         "loader_code",
  17         "loader_data",
  18         "bs_code",
  19         "bs_data",
  20         "rt_code",
  21         "rt_data",
  22         "conv",
  23         "unusable",
  24         "acpi_reclaim",
  25         "acpi_nvs",
  26         "io",
  27         "io_port",
  28         "pal_code",
  29 };
  30
  31 static struct attr_info {
  32         u64 val;
  33         const char *name;
  34 } mem_attr[] = {
  35         { EFI_MEMORY_UC, "uncached" },
  36         { EFI_MEMORY_WC, "write-coalescing" },
  37         { EFI_MEMORY_WT, "write-through" },
  38         { EFI_MEMORY_WB, "write-back" },
  39         { EFI_MEMORY_UCE, "uncached & exported" },
  40         { EFI_MEMORY_WP, "write-protect" },
  41         { EFI_MEMORY_RP, "read-protect" },
  42         { EFI_MEMORY_XP, "execute-protect" },
  43         { EFI_MEMORY_NV, "non-volatile" },
  44         { EFI_MEMORY_MORE_RELIABLE, "higher reliability" },
  45         { EFI_MEMORY_RO, "read-only" },
  46         { EFI_MEMORY_RUNTIME, "needs runtime mapping" }
  47 };
  48
  49 /* Maximum different attribute values we can track */
  50 #define ATTR_SEEN_MAX   30
  51
  52 static inline bool is_boot_services(int type)
  53 {
  54         return type == EFI_LOADER_CODE || type == EFI_LOADER_DATA ||
  55                 type == EFI_BOOT_SERVICES_CODE ||
  56                 type == EFI_BOOT_SERVICES_DATA;
  57 }
  58
  59 static int h_cmp_entry(const void *v1, const void *v2)
  60 {
  61         const struct efi_mem_desc *desc1 = v1;
  62         const struct efi_mem_desc *desc2 = v2;
  63         int64_t diff = desc1->physical_start - desc2->physical_start;
  64
  65         /*
  66          * Manually calculate the difference to avoid sign loss in the 64-bit
  67          * to 32-bit conversion
  68          */
  69         return diff < 0 ? -1 : diff > 0 ? 1 : 0;
  70 }
  71
  72 void *efi_build_mem_table(struct efi_entry_memmap *map, int size, bool skip_bs)
  73 {
  74         struct efi_mem_desc *desc, *end, *base, *dest, *prev;
  75         int count;
  76         u64 addr;
  77
  78         base = malloc(size + sizeof(*desc));
  79         if (!base) {
  80                 debug("%s: Cannot allocate %#x bytes\n", __func__, size);
  81                 return NULL;
  82         }
  83         end = (struct efi_mem_desc *)((ulong)map + size);
  84         count = ((ulong)end - (ulong)map->desc) / map->desc_size;
  85         memcpy(base, map->desc, (ulong)end - (ulong)map->desc);
  86         qsort(base, count, map->desc_size, h_cmp_entry);
  87         prev = NULL;
  88         addr = 0;
  89         dest = base;
  90         end = (struct efi_mem_desc *)((ulong)base + count * map->desc_size);
  91         for (desc = base; desc < end; desc = efi_get_next_mem_desc(map, desc)) {
  92                 bool merge = true;
  93                 int type = desc->type;
  94
  95                 if (skip_bs && is_boot_services(desc->type))
  96                         type = EFI_CONVENTIONAL_MEMORY;
  97
  98                 memcpy(dest, desc, map->desc_size);
  99                 dest->type = type;
 100                 if (!skip_bs || !prev)
 101                         merge = false;
 102                 else if (desc->physical_start != addr)
 103                         merge = false;
 104                 else if (type != EFI_CONVENTIONAL_MEMORY)
 105                         merge = false;
 106                 else if (prev->type != EFI_CONVENTIONAL_MEMORY)
 107                         merge = false;
 108
 109                 if (merge) {
 110                         prev->num_pages += desc->num_pages;
 111                 } else {
 112                         prev = dest;
 113                         dest = efi_get_next_mem_desc(map, dest);
 114                 }
 115                 addr = desc->physical_start + (desc->num_pages <<
 116                                 EFI_PAGE_SHIFT);
 117         }
 118
 119         /* Mark the end */
 120         dest->type = EFI_TABLE_END;
 121
 122         return base;
 123 }
 124
 125 static void efi_print_mem_table(struct efi_entry_memmap *map,
 126                                 struct efi_mem_desc *desc, bool skip_bs)
 127 {
 128         u64 attr_seen[ATTR_SEEN_MAX];
 129         int attr_seen_count;
 130         int upto, i;
 131         u64 addr;
 132
 133         printf(" #  %-14s  %10s  %10s  %10s  %s\n", "Type", "Physical",
 134                "Virtual", "Size", "Attributes");
 135
 136         /* Keep track of all the different attributes we have seen */
 137         attr_seen_count = 0;
 138         addr = 0;
 139         for (upto = 0; desc->type != EFI_TABLE_END;
 140              upto++, desc = efi_get_next_mem_desc(map, desc)) {
 141                 const char *name;
 142                 u64 size;
 143
 144                 if (skip_bs && is_boot_services(desc->type))
 145                         continue;
 146                 if (desc->physical_start != addr) {
 147                         printf("    %-14s  %010llx  %10s  %010llx\n", "<gap>",
 148                                addr, "", desc->physical_start - addr);
 149                 }
 150                 size = desc->num_pages << EFI_PAGE_SHIFT;
 151
 152                 name = desc->type < ARRAY_SIZE(type_name) ?
 153                                 type_name[desc->type] : "<invalid>";
 154                 printf("%2d  %x:%-12s  %010llx  %010llx  %010llx  ", upto,
 155                        desc->type, name, desc->physical_start,
 156                        desc->virtual_start, size);
 157                 if (desc->attribute & EFI_MEMORY_RUNTIME)
 158                         putc('r');
 159                 printf("%llx", desc->attribute & ~EFI_MEMORY_RUNTIME);
 160                 putc('\n');
 161
 162                 for (i = 0; i < attr_seen_count; i++) {
 163                         if (attr_seen[i] == desc->attribute)
 164                                 break;
 165                 }
 166                 if (i == attr_seen_count && i < ATTR_SEEN_MAX)
 167                         attr_seen[attr_seen_count++] = desc->attribute;
 168                 addr = desc->physical_start + size;
 169         }
 170
 171         printf("\nAttributes key:\n");
 172         for (i = 0; i < attr_seen_count; i++) {
 173                 u64 attr = attr_seen[i];
 174                 bool first;
 175                 int j;
 176
 177                 printf("%c%llx: ", (attr & EFI_MEMORY_RUNTIME) ? 'r' : ' ',
 178                        attr & ~EFI_MEMORY_RUNTIME);
 179                 for (j = 0, first = true; j < ARRAY_SIZE(mem_attr); j++) {
 180                         if (attr & mem_attr[j].val) {
 181                                 if (first)
 182                                         first = false;
 183                                 else
 184                                         printf(", ");
 185                                 printf("%s", mem_attr[j].name);
 186                         }
 187                 }
 188                 putc('\n');
 189         }
 190         if (skip_bs)
 191                 printf("*Some areas are merged (use 'all' to see)\n");
 192 }
 193
 194 static int do_efi_mem(struct cmd_tbl *cmdtp, int flag, int argc,
 195                       char *const argv[])
 196 {
 197         struct efi_mem_desc *desc;
 198         struct efi_entry_memmap *map;
 199         int size, ret;
 200         bool skip_bs;
 201
 202         skip_bs = !argc || *argv[0] != 'a';
 203         ret = efi_info_get(EFIET_MEMORY_MAP, (void **)&map, &size);
 204         switch (ret) {
 205         case -ENOENT:
 206                 printf("No EFI table available\n");
 207                 goto done;
 208         case -EPROTONOSUPPORT:
 209                 printf("Incorrect EFI table version\n");
 210                 goto done;
 211         }
 212         printf("EFI table at %lx, memory map %p, size %x, version %x, descr. size %#x\n",
 213                gd->arch.table, map, size, map->version, map->desc_size);
 214         if (map->version != EFI_MEM_DESC_VERSION) {
 215                 printf("Incorrect memory map version\n");
 216                 ret = -EPROTONOSUPPORT;
 217                 goto done;
 218         }
 219
 220         desc = efi_build_mem_table(map, size, skip_bs);
 221         if (!desc) {
 222                 ret = -ENOMEM;
 223                 goto done;
 224         }
 225
 226         efi_print_mem_table(map, desc, skip_bs);
 227         free(desc);
 228 done:
 229         if (ret)
 230                 printf("Error: %d\n", ret);
 231
 232         return ret ? CMD_RET_FAILURE : 0;
 233 }
 234
 235 static struct cmd_tbl efi_commands[] = {
 236         U_BOOT_CMD_MKENT(mem, 1, 1, do_efi_mem, "", ""),
 237 };
 238
 239 static int do_efi(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 240 {
 241         struct cmd_tbl *efi_cmd;
 242         int ret;
 243
 244         if (argc < 2)
 245                 return CMD_RET_USAGE;
 246         efi_cmd = find_cmd_tbl(argv[1], efi_commands, ARRAY_SIZE(efi_commands));
 247         argc -= 2;
 248         argv += 2;
 249         if (!efi_cmd || argc > efi_cmd->maxargs)
 250                 return CMD_RET_USAGE;
 251
 252         ret = efi_cmd->cmd(efi_cmd, flag, argc, argv);
 253
 254         return cmd_process_error(efi_cmd, ret);
 255 }
 256
 257 U_BOOT_CMD(
 258         efi,     3,      1,      do_efi,
 259         "EFI access",
 260         "mem [all]        Dump memory information [include boot services]"
 261 );