cmd/efidebug.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  UEFI Shell-like command
   4  *
   5  *  Copyright (c) 2018 AKASHI Takahiro, Linaro Limited
   6  */
   7
   8 #include <charset.h>
   9 #include <common.h>
  10 #include <command.h>
  11 #include <efi_loader.h>
  12 #include <environment.h>
  13 #include <exports.h>
  14 #include <hexdump.h>
  15 #include <malloc.h>
  16 #include <search.h>
  17 #include <linux/ctype.h>
  18
  19 #define BS systab.boottime
  20 #define RT systab.runtime
  21
  22 /**
  23  * efi_get_device_handle_info() - get information of UEFI device
  24  *
  25  * @handle:             Handle of UEFI device
  26  * @dev_path_text:      Pointer to text of device path
  27  * Return:              0 on success, -1 on failure
  28  *
  29  * Currently return a formatted text of device path.
  30  */
  31 static int efi_get_device_handle_info(efi_handle_t handle, u16 **dev_path_text)
  32 {
  33         struct efi_device_path *dp;
  34         efi_status_t ret;
  35
  36         ret = EFI_CALL(BS->open_protocol(handle, &efi_guid_device_path,
  37                                          (void **)&dp, NULL /* FIXME */, NULL,
  38                                          EFI_OPEN_PROTOCOL_GET_PROTOCOL));
  39         if (ret == EFI_SUCCESS) {
  40                 *dev_path_text = efi_dp_str(dp);
  41                 return 0;
  42         } else {
  43                 return -1;
  44         }
  45 }
  46
  47 #define EFI_HANDLE_WIDTH ((int)sizeof(efi_handle_t) * 2)
  48
  49 static const char spc[] = "                ";
  50 static const char sep[] = "================";
  51
  52 /**
  53  * do_efi_show_devices() - show UEFI devices
  54  *
  55  * @cmdtp:      Command table
  56  * @flag:       Command flag
  57  * @argc:       Number of arguments
  58  * @argv:       Argument array
  59  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
  60  *
  61  * Implement efidebug "devices" sub-command.
  62  * Show all UEFI devices and their information.
  63  */
  64 static int do_efi_show_devices(cmd_tbl_t *cmdtp, int flag,
  65                                int argc, char * const argv[])
  66 {
  67         efi_handle_t *handles;
  68         efi_uintn_t num, i;
  69         u16 *dev_path_text;
  70         efi_status_t ret;
  71
  72         ret = EFI_CALL(BS->locate_handle_buffer(ALL_HANDLES, NULL, NULL,
  73                                                 &num, &handles));
  74         if (ret != EFI_SUCCESS)
  75                 return CMD_RET_FAILURE;
  76
  77         if (!num)
  78                 return CMD_RET_SUCCESS;
  79
  80         printf("Device%.*s Device Path\n", EFI_HANDLE_WIDTH - 6, spc);
  81         printf("%.*s ====================\n", EFI_HANDLE_WIDTH, sep);
  82         for (i = 0; i < num; i++) {
  83                 if (!efi_get_device_handle_info(handles[i], &dev_path_text)) {
  84                         printf("%p %ls\n", handles[i], dev_path_text);
  85                         efi_free_pool(dev_path_text);
  86                 }
  87         }
  88
  89         EFI_CALL(BS->free_pool(handles));
  90
  91         return CMD_RET_SUCCESS;
  92 }
  93
  94 /**
  95  * efi_get_driver_handle_info() - get information of UEFI driver
  96  *
  97  * @handle:             Handle of UEFI device
  98  * @driver_name:        Driver name
  99  * @image_path:         Pointer to text of device path
 100  * Return:              0 on success, -1 on failure
 101  *
 102  * Currently return no useful information as all UEFI drivers are
 103  * built-in..
 104  */
 105 static int efi_get_driver_handle_info(efi_handle_t handle, u16 **driver_name,
 106                                       u16 **image_path)
 107 {
 108         struct efi_handler *handler;
 109         struct efi_loaded_image *image;
 110         efi_status_t ret;
 111
 112         /*
 113          * driver name
 114          * TODO: support EFI_COMPONENT_NAME2_PROTOCOL
 115          */
 116         *driver_name = NULL;
 117
 118         /* image name */
 119         ret = efi_search_protocol(handle, &efi_guid_loaded_image, &handler);
 120         if (ret != EFI_SUCCESS) {
 121                 *image_path = NULL;
 122                 return 0;
 123         }
 124
 125         image = handler->protocol_interface;
 126         *image_path = efi_dp_str(image->file_path);
 127
 128         return 0;
 129 }
 130
 131 /**
 132  * do_efi_show_drivers() - show UEFI drivers
 133  *
 134  * @cmdtp:      Command table
 135  * @flag:       Command flag
 136  * @argc:       Number of arguments
 137  * @argv:       Argument array
 138  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
 139  *
 140  * Implement efidebug "drivers" sub-command.
 141  * Show all UEFI drivers and their information.
 142  */
 143 static int do_efi_show_drivers(cmd_tbl_t *cmdtp, int flag,
 144                                int argc, char * const argv[])
 145 {
 146         efi_handle_t *handles;
 147         efi_uintn_t num, i;
 148         u16 *driver_name, *image_path_text;
 149         efi_status_t ret;
 150
 151         ret = EFI_CALL(BS->locate_handle_buffer(
 152                                 BY_PROTOCOL, &efi_guid_driver_binding_protocol,
 153                                 NULL, &num, &handles));
 154         if (ret != EFI_SUCCESS)
 155                 return CMD_RET_FAILURE;
 156
 157         if (!num)
 158                 return CMD_RET_SUCCESS;
 159
 160         printf("Driver%.*s Name                 Image Path\n",
 161                EFI_HANDLE_WIDTH - 6, spc);
 162         printf("%.*s ==================== ====================\n",
 163                EFI_HANDLE_WIDTH, sep);
 164         for (i = 0; i < num; i++) {
 165                 if (!efi_get_driver_handle_info(handles[i], &driver_name,
 166                                                 &image_path_text)) {
 167                         if (image_path_text)
 168                                 printf("%p %-20ls %ls\n", handles[i],
 169                                        driver_name, image_path_text);
 170                         else
 171                                 printf("%p %-20ls <built-in>\n",
 172                                        handles[i], driver_name);
 173                         EFI_CALL(BS->free_pool(driver_name));
 174                         EFI_CALL(BS->free_pool(image_path_text));
 175                 }
 176         }
 177
 178         EFI_CALL(BS->free_pool(handles));
 179
 180         return CMD_RET_SUCCESS;
 181 }
 182
 183 static const struct {
 184         const char *text;
 185         const efi_guid_t guid;
 186 } guid_list[] = {
 187         {
 188                 "Device Path",
 189                 EFI_DEVICE_PATH_PROTOCOL_GUID,
 190         },
 191         {
 192                 "Device Path To Text",
 193                 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID,
 194         },
 195         {
 196                 "Device Path Utilities",
 197                 EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID,
 198         },
 199         {
 200                 "Unicode Collation 2",
 201                 EFI_UNICODE_COLLATION_PROTOCOL2_GUID,
 202         },
 203         {
 204                 "Driver Binding",
 205                 EFI_DRIVER_BINDING_PROTOCOL_GUID,
 206         },
 207         {
 208                 "Simple Text Input",
 209                 EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID,
 210         },
 211         {
 212                 "Simple Text Input Ex",
 213                 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID,
 214         },
 215         {
 216                 "Simple Text Output",
 217                 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID,
 218         },
 219         {
 220                 "Block IO",
 221                 EFI_BLOCK_IO_PROTOCOL_GUID,
 222         },
 223         {
 224                 "Simple File System",
 225                 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID,
 226         },
 227         {
 228                 "Loaded Image",
 229                 EFI_LOADED_IMAGE_PROTOCOL_GUID,
 230         },
 231         {
 232                 "Graphics Output",
 233                 EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID,
 234         },
 235         {
 236                 "HII String",
 237                 EFI_HII_STRING_PROTOCOL_GUID,
 238         },
 239         {
 240                 "HII Database",
 241                 EFI_HII_DATABASE_PROTOCOL_GUID,
 242         },
 243         {
 244                 "HII Config Routing",
 245                 EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID,
 246         },
 247         {
 248                 "Simple Network",
 249                 EFI_SIMPLE_NETWORK_PROTOCOL_GUID,
 250         },
 251         {
 252                 "PXE Base Code",
 253                 EFI_PXE_BASE_CODE_PROTOCOL_GUID,
 254         },
 255 };
 256
 257 /**
 258  * get_guid_text - get string of protocol guid
 259  * @guid:       Protocol guid
 260  * Return:      String
 261  *
 262  * Return string for display to represent the protocol.
 263  */
 264 static const char *get_guid_text(const efi_guid_t *guid)
 265 {
 266         int i;
 267
 268         for (i = 0; i < ARRAY_SIZE(guid_list); i++)
 269                 if (!guidcmp(&guid_list[i].guid, guid))
 270                         break;
 271
 272         if (i != ARRAY_SIZE(guid_list))
 273                 return guid_list[i].text;
 274         else
 275                 return NULL;
 276 }
 277
 278 /**
 279  * do_efi_show_handles() - show UEFI handles
 280  *
 281  * @cmdtp:      Command table
 282  * @flag:       Command flag
 283  * @argc:       Number of arguments
 284  * @argv:       Argument array
 285  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
 286  *
 287  * Implement efidebug "dh" sub-command.
 288  * Show all UEFI handles and their information, currently all protocols
 289  * added to handle.
 290  */
 291 static int do_efi_show_handles(cmd_tbl_t *cmdtp, int flag,
 292                                int argc, char * const argv[])
 293 {
 294         efi_handle_t *handles;
 295         efi_guid_t **guid;
 296         efi_uintn_t num, count, i, j;
 297         const char *guid_text;
 298         efi_status_t ret;
 299
 300         ret = EFI_CALL(BS->locate_handle_buffer(ALL_HANDLES, NULL, NULL,
 301                                                 &num, &handles));
 302         if (ret != EFI_SUCCESS)
 303                 return CMD_RET_FAILURE;
 304
 305         if (!num)
 306                 return CMD_RET_SUCCESS;
 307
 308         printf("Handle%.*s Protocols\n", EFI_HANDLE_WIDTH - 6, spc);
 309         printf("%.*s ====================\n", EFI_HANDLE_WIDTH, sep);
 310         for (i = 0; i < num; i++) {
 311                 printf("%p", handles[i]);
 312                 ret = EFI_CALL(BS->protocols_per_handle(handles[i], &guid,
 313                                                         &count));
 314                 if (ret || !count) {
 315                         putc('\n');
 316                         continue;
 317                 }
 318
 319                 for (j = 0; j < count; j++) {
 320                         if (j)
 321                                 printf(", ");
 322                         else
 323                                 putc(' ');
 324
 325                         guid_text = get_guid_text(guid[j]);
 326                         if (guid_text)
 327                                 puts(guid_text);
 328                         else
 329                                 printf("%pUl", guid[j]);
 330                 }
 331                 putc('\n');
 332         }
 333
 334         EFI_CALL(BS->free_pool(handles));
 335
 336         return CMD_RET_SUCCESS;
 337 }
 338
 339 /**
 340  * do_efi_show_images() - show UEFI images
 341  *
 342  * @cmdtp:      Command table
 343  * @flag:       Command flag
 344  * @argc:       Number of arguments
 345  * @argv:       Argument array
 346  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
 347  *
 348  * Implement efidebug "images" sub-command.
 349  * Show all UEFI loaded images and their information.
 350  */
 351 static int do_efi_show_images(cmd_tbl_t *cmdtp, int flag,
 352                               int argc, char * const argv[])
 353 {
 354         efi_print_image_infos(NULL);
 355
 356         return CMD_RET_SUCCESS;
 357 }
 358
 359 static const char * const efi_mem_type_string[] = {
 360         [EFI_RESERVED_MEMORY_TYPE] = "RESERVED",
 361         [EFI_LOADER_CODE] = "LOADER CODE",
 362         [EFI_LOADER_DATA] = "LOADER DATA",
 363         [EFI_BOOT_SERVICES_CODE] = "BOOT CODE",
 364         [EFI_BOOT_SERVICES_DATA] = "BOOT DATA",
 365         [EFI_RUNTIME_SERVICES_CODE] = "RUNTIME CODE",
 366         [EFI_RUNTIME_SERVICES_DATA] = "RUNTIME DATA",
 367         [EFI_CONVENTIONAL_MEMORY] = "CONVENTIONAL",
 368         [EFI_UNUSABLE_MEMORY] = "UNUSABLE MEM",
 369         [EFI_ACPI_RECLAIM_MEMORY] = "ACPI RECLAIM MEM",
 370         [EFI_ACPI_MEMORY_NVS] = "ACPI NVS",
 371         [EFI_MMAP_IO] = "IO",
 372         [EFI_MMAP_IO_PORT] = "IO PORT",
 373         [EFI_PAL_CODE] = "PAL",
 374 };
 375
 376 static const struct efi_mem_attrs {
 377         const u64 bit;
 378         const char *text;
 379 } efi_mem_attrs[] = {
 380         {EFI_MEMORY_UC, "UC"},
 381         {EFI_MEMORY_UC, "UC"},
 382         {EFI_MEMORY_WC, "WC"},
 383         {EFI_MEMORY_WT, "WT"},
 384         {EFI_MEMORY_WB, "WB"},
 385         {EFI_MEMORY_UCE, "UCE"},
 386         {EFI_MEMORY_WP, "WP"},
 387         {EFI_MEMORY_RP, "RP"},
 388         {EFI_MEMORY_XP, "WP"},
 389         {EFI_MEMORY_NV, "NV"},
 390         {EFI_MEMORY_MORE_RELIABLE, "REL"},
 391         {EFI_MEMORY_RO, "RO"},
 392         {EFI_MEMORY_RUNTIME, "RT"},
 393 };
 394
 395 /**
 396  * print_memory_attributes() - print memory map attributes
 397  * @attributes: Attribute value
 398  *
 399  * Print memory map attributes
 400  */
 401 static void print_memory_attributes(u64 attributes)
 402 {
 403         int sep, i;
 404
 405         for (sep = 0, i = 0; i < ARRAY_SIZE(efi_mem_attrs); i++)
 406                 if (attributes & efi_mem_attrs[i].bit) {
 407                         if (sep) {
 408                                 putc('|');
 409                         } else {
 410                                 putc(' ');
 411                                 sep = 1;
 412                         }
 413                         puts(efi_mem_attrs[i].text);
 414                 }
 415 }
 416
 417 #define EFI_PHYS_ADDR_WIDTH (int)(sizeof(efi_physical_addr_t) * 2)
 418
 419 /**
 420  * do_efi_show_memmap() - show UEFI memory map
 421  *
 422  * @cmdtp:      Command table
 423  * @flag:       Command flag
 424  * @argc:       Number of arguments
 425  * @argv:       Argument array
 426  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
 427  *
 428  * Implement efidebug "memmap" sub-command.
 429  * Show UEFI memory map.
 430  */
 431 static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
 432                               int argc, char * const argv[])
 433 {
 434         struct efi_mem_desc *memmap = NULL, *map;
 435         efi_uintn_t map_size = 0;
 436         const char *type;
 437         int i;
 438         efi_status_t ret;
 439
 440         ret = EFI_CALL(BS->get_memory_map(&map_size, memmap, NULL, NULL, NULL));
 441         if (ret == EFI_BUFFER_TOO_SMALL) {
 442                 map_size += sizeof(struct efi_mem_desc); /* for my own */
 443                 ret = EFI_CALL(BS->allocate_pool(EFI_LOADER_DATA,
 444                                                  map_size, (void *)&memmap));
 445                 if (ret != EFI_SUCCESS)
 446                         return CMD_RET_FAILURE;
 447                 ret = EFI_CALL(BS->get_memory_map(&map_size, memmap,
 448                                                   NULL, NULL, NULL));
 449         }
 450         if (ret != EFI_SUCCESS) {
 451                 EFI_CALL(BS->free_pool(memmap));
 452                 return CMD_RET_FAILURE;
 453         }
 454
 455         printf("Type             Start%.*s End%.*s Attributes\n",
 456                EFI_PHYS_ADDR_WIDTH - 5, spc, EFI_PHYS_ADDR_WIDTH - 3, spc);
 457         printf("================ %.*s %.*s ==========\n",
 458                EFI_PHYS_ADDR_WIDTH, sep, EFI_PHYS_ADDR_WIDTH, sep);
 459         for (i = 0, map = memmap; i < map_size / sizeof(*map); map++, i++) {
 460                 if (map->type < EFI_MAX_MEMORY_TYPE)
 461                         type = efi_mem_type_string[map->type];
 462                 else
 463                         type = "(unknown)";
 464
 465                 printf("%-16s %.*llx-%.*llx", type,
 466                        EFI_PHYS_ADDR_WIDTH,
 467                        map->physical_start,
 468                        EFI_PHYS_ADDR_WIDTH,
 469                        map->physical_start + map->num_pages * EFI_PAGE_SIZE);
 470
 471                 print_memory_attributes(map->attribute);
 472                 putc('\n');
 473         }
 474
 475         EFI_CALL(BS->free_pool(memmap));
 476
 477         return CMD_RET_SUCCESS;
 478 }
 479
 480 /**
 481  * do_efi_boot_add() - set UEFI load option
 482  *
 483  * @cmdtp:      Command table
 484  * @flag:       Command flag
 485  * @argc:       Number of arguments
 486  * @argv:       Argument array
 487  * Return:      CMD_RET_SUCCESS on success,
 488  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
 489  *
 490  * Implement efidebug "boot add" sub-command.
 491  * Create or change UEFI load option.
 492  *   - boot add <id> <label> <interface> <devnum>[:<part>] <file> <options>
 493  */
 494 static int do_efi_boot_add(cmd_tbl_t *cmdtp, int flag,
 495                            int argc, char * const argv[])
 496 {
 497         int id;
 498         char *endp;
 499         char var_name[9];
 500         u16 var_name16[9], *p;
 501         efi_guid_t guid;
 502         size_t label_len, label_len16;
 503         u16 *label;
 504         struct efi_device_path *device_path = NULL, *file_path = NULL;
 505         struct efi_load_option lo;
 506         void *data = NULL;
 507         efi_uintn_t size;
 508         efi_status_t ret;
 509         int r;
 510
 511         if (argc < 6 || argc > 7)
 512                 return CMD_RET_USAGE;
 513
 514         id = (int)simple_strtoul(argv[1], &endp, 16);
 515         if (*endp != '\0' || id > 0xffff)
 516                 return CMD_RET_USAGE;
 517
 518         sprintf(var_name, "Boot%04X", id);
 519         p = var_name16;
 520         utf8_utf16_strncpy(&p, var_name, 9);
 521
 522         guid = efi_global_variable_guid;
 523
 524         /* attributes */
 525         lo.attributes = LOAD_OPTION_ACTIVE; /* always ACTIVE */
 526
 527         /* label */
 528         label_len = strlen(argv[2]);
 529         label_len16 = utf8_utf16_strnlen(argv[2], label_len);
 530         label = malloc((label_len16 + 1) * sizeof(u16));
 531         if (!label)
 532                 return CMD_RET_FAILURE;
 533         lo.label = label; /* label will be changed below */
 534         utf8_utf16_strncpy(&label, argv[2], label_len);
 535
 536         /* file path */
 537         ret = efi_dp_from_name(argv[3], argv[4], argv[5], &device_path,
 538                                &file_path);
 539         if (ret != EFI_SUCCESS) {
 540                 printf("Cannot create device path for \"%s %s\"\n",
 541                        argv[3], argv[4]);
 542                 r = CMD_RET_FAILURE;
 543                 goto out;
 544         }
 545         lo.file_path = file_path;
 546         lo.file_path_length = efi_dp_size(file_path)
 547                                 + sizeof(struct efi_device_path); /* for END */
 548
 549         /* optional data */
 550         if (argc < 6)
 551                 lo.optional_data = NULL;
 552         else
 553                 lo.optional_data = (const u8 *)argv[6];
 554
 555         size = efi_serialize_load_option(&lo, (u8 **)&data);
 556         if (!size) {
 557                 r = CMD_RET_FAILURE;
 558                 goto out;
 559         }
 560
 561         ret = EFI_CALL(RT->set_variable(var_name16, &guid,
 562                                         EFI_VARIABLE_NON_VOLATILE |
 563                                         EFI_VARIABLE_BOOTSERVICE_ACCESS |
 564                                         EFI_VARIABLE_RUNTIME_ACCESS,
 565                                         size, data));
 566         r = (ret == EFI_SUCCESS ? CMD_RET_SUCCESS : CMD_RET_FAILURE);
 567 out:
 568         free(data);
 569         efi_free_pool(device_path);
 570         efi_free_pool(file_path);
 571         free(lo.label);
 572
 573         return r;
 574 }
 575
 576 /**
 577  * do_efi_boot_rm() - delete UEFI load options
 578  *
 579  * @cmdtp:      Command table
 580  * @flag:       Command flag
 581  * @argc:       Number of arguments
 582  * @argv:       Argument array
 583  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
 584  *
 585  * Implement efidebug "boot rm" sub-command.
 586  * Delete UEFI load options.
 587  *   - boot rm <id> ...
 588  */
 589 static int do_efi_boot_rm(cmd_tbl_t *cmdtp, int flag,
 590                           int argc, char * const argv[])
 591 {
 592         efi_guid_t guid;
 593         int id, i;
 594         char *endp;
 595         char var_name[9];
 596         u16 var_name16[9];
 597         efi_status_t ret;
 598
 599         if (argc == 1)
 600                 return CMD_RET_USAGE;
 601
 602         guid = efi_global_variable_guid;
 603         for (i = 1; i < argc; i++, argv++) {
 604                 id = (int)simple_strtoul(argv[1], &endp, 16);
 605                 if (*endp != '\0' || id > 0xffff)
 606                         return CMD_RET_FAILURE;
 607
 608                 sprintf(var_name, "Boot%04X", id);
 609                 utf8_utf16_strncpy((u16 **)&var_name16, var_name, 9);
 610
 611                 ret = EFI_CALL(RT->set_variable(var_name16, &guid, 0, 0, NULL));
 612                 if (ret) {
 613                         printf("cannot remove Boot%04X", id);
 614                         return CMD_RET_FAILURE;
 615                 }
 616         }
 617
 618         return CMD_RET_SUCCESS;
 619 }
 620
 621 /**
 622  * show_efi_boot_opt_data() - dump UEFI load option
 623  *
 624  * @id:         load option number
 625  * @data:       value of UEFI load option variable
 626  * @size:       size of the boot option
 627  *
 628  * Decode the value of UEFI load option variable and print information.
 629  */
 630 static void show_efi_boot_opt_data(int id, void *data, size_t size)
 631 {
 632         struct efi_load_option lo;
 633         char *label, *p;
 634         size_t label_len16, label_len;
 635         u16 *dp_str;
 636
 637         efi_deserialize_load_option(&lo, data);
 638
 639         label_len16 = u16_strlen(lo.label);
 640         label_len = utf16_utf8_strnlen(lo.label, label_len16);
 641         label = malloc(label_len + 1);
 642         if (!label)
 643                 return;
 644         p = label;
 645         utf16_utf8_strncpy(&p, lo.label, label_len16);
 646
 647         printf("Boot%04X:\n", id);
 648         printf("  attributes: %c%c%c (0x%08x)\n",
 649                /* ACTIVE */
 650                lo.attributes & LOAD_OPTION_ACTIVE ? 'A' : '-',
 651                /* FORCE RECONNECT */
 652                lo.attributes & LOAD_OPTION_FORCE_RECONNECT ? 'R' : '-',
 653                /* HIDDEN */
 654                lo.attributes & LOAD_OPTION_HIDDEN ? 'H' : '-',
 655                lo.attributes);
 656         printf("  label: %s\n", label);
 657
 658         dp_str = efi_dp_str(lo.file_path);
 659         printf("  file_path: %ls\n", dp_str);
 660         efi_free_pool(dp_str);
 661
 662         printf("  data:\n");
 663         print_hex_dump("    ", DUMP_PREFIX_OFFSET, 16, 1,
 664                        lo.optional_data, size + (u8 *)data -
 665                        (u8 *)lo.optional_data, true);
 666         free(label);
 667 }
 668
 669 /**
 670  * show_efi_boot_opt() - dump UEFI load option
 671  *
 672  * @id:         Load option number
 673  *
 674  * Dump information defined by UEFI load option.
 675  */
 676 static void show_efi_boot_opt(int id)
 677 {
 678         char var_name[9];
 679         u16 var_name16[9], *p;
 680         efi_guid_t guid;
 681         void *data = NULL;
 682         efi_uintn_t size;
 683         int ret;
 684
 685         sprintf(var_name, "Boot%04X", id);
 686         p = var_name16;
 687         utf8_utf16_strncpy(&p, var_name, 9);
 688         guid = efi_global_variable_guid;
 689
 690         size = 0;
 691         ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size, NULL));
 692         if (ret == (int)EFI_BUFFER_TOO_SMALL) {
 693                 data = malloc(size);
 694                 ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size,
 695                                                 data));
 696         }
 697         if (ret == EFI_SUCCESS)
 698                 show_efi_boot_opt_data(id, data, size);
 699         else if (ret == EFI_NOT_FOUND)
 700                 printf("Boot%04X: not found\n", id);
 701
 702         free(data);
 703 }
 704
 705 static int u16_tohex(u16 c)
 706 {
 707         if (c >= '0' && c <= '9')
 708                 return c - '0';
 709         if (c >= 'A' && c <= 'F')
 710                 return c - 'A' + 10;
 711
 712         /* not hexadecimal */
 713         return -1;
 714 }
 715
 716 /**
 717  * show_efi_boot_dump() - dump all UEFI load options
 718  *
 719  * @cmdtp:      Command table
 720  * @flag:       Command flag
 721  * @argc:       Number of arguments
 722  * @argv:       Argument array
 723  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
 724  *
 725  * Implement efidebug "boot dump" sub-command.
 726  * Dump information of all UEFI load options defined.
 727  *   - boot dump
 728  */
 729 static int do_efi_boot_dump(cmd_tbl_t *cmdtp, int flag,
 730                             int argc, char * const argv[])
 731 {
 732         u16 *var_name16, *p;
 733         efi_uintn_t buf_size, size;
 734         efi_guid_t guid;
 735         int id, i, digit;
 736         efi_status_t ret;
 737
 738         if (argc > 1)
 739                 return CMD_RET_USAGE;
 740
 741         buf_size = 128;
 742         var_name16 = malloc(buf_size);
 743         if (!var_name16)
 744                 return CMD_RET_FAILURE;
 745
 746         var_name16[0] = 0;
 747         for (;;) {
 748                 size = buf_size;
 749                 ret = EFI_CALL(efi_get_next_variable_name(&size, var_name16,
 750                                                           &guid));
 751                 if (ret == EFI_NOT_FOUND)
 752                         break;
 753                 if (ret == EFI_BUFFER_TOO_SMALL) {
 754                         buf_size = size;
 755                         p = realloc(var_name16, buf_size);
 756                         if (!p) {
 757                                 free(var_name16);
 758                                 return CMD_RET_FAILURE;
 759                         }
 760                         var_name16 = p;
 761                         ret = EFI_CALL(efi_get_next_variable_name(&size,
 762                                                                   var_name16,
 763                                                                   &guid));
 764                 }
 765                 if (ret != EFI_SUCCESS) {
 766                         free(var_name16);
 767                         return CMD_RET_FAILURE;
 768                 }
 769
 770                 if (memcmp(var_name16, L"Boot", 8))
 771                         continue;
 772
 773                 for (id = 0, i = 0; i < 4; i++) {
 774                         digit = u16_tohex(var_name16[4 + i]);
 775                         if (digit < 0)
 776                                 break;
 777                         id = (id << 4) + digit;
 778                 }
 779                 if (i == 4 && !var_name16[8])
 780                         show_efi_boot_opt(id);
 781         }
 782
 783         free(var_name16);
 784
 785         return CMD_RET_SUCCESS;
 786 }
 787
 788 /**
 789  * show_efi_boot_order() - show order of UEFI load options
 790  *
 791  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
 792  *
 793  * Show order of UEFI load options defined by BootOrder variable.
 794  */
 795 static int show_efi_boot_order(void)
 796 {
 797         efi_guid_t guid;
 798         u16 *bootorder = NULL;
 799         efi_uintn_t size;
 800         int num, i;
 801         char var_name[9];
 802         u16 var_name16[9], *p16;
 803         void *data;
 804         struct efi_load_option lo;
 805         char *label, *p;
 806         size_t label_len16, label_len;
 807         efi_status_t ret;
 808
 809         guid = efi_global_variable_guid;
 810         size = 0;
 811         ret = EFI_CALL(RT->get_variable(L"BootOrder", &guid, NULL, &size,
 812                                         NULL));
 813         if (ret == EFI_BUFFER_TOO_SMALL) {
 814                 bootorder = malloc(size);
 815                 ret = EFI_CALL(RT->get_variable(L"BootOrder", &guid, NULL,
 816                                                 &size, bootorder));
 817         }
 818         if (ret == EFI_NOT_FOUND) {
 819                 printf("BootOrder not defined\n");
 820                 ret = CMD_RET_SUCCESS;
 821                 goto out;
 822         } else if (ret != EFI_SUCCESS) {
 823                 ret = CMD_RET_FAILURE;
 824                 goto out;
 825         }
 826
 827         num = size / sizeof(u16);
 828         for (i = 0; i < num; i++) {
 829                 sprintf(var_name, "Boot%04X", bootorder[i]);
 830                 p16 = var_name16;
 831                 utf8_utf16_strncpy(&p16, var_name, 9);
 832
 833                 size = 0;
 834                 ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size,
 835                                                 NULL));
 836                 if (ret != EFI_BUFFER_TOO_SMALL) {
 837                         printf("%2d: Boot%04X: (not defined)\n",
 838                                i + 1, bootorder[i]);
 839                         continue;
 840                 }
 841
 842                 data = malloc(size);
 843                 if (!data) {
 844                         ret = CMD_RET_FAILURE;
 845                         goto out;
 846                 }
 847                 ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size,
 848                                                 data));
 849                 if (ret != EFI_SUCCESS) {
 850                         free(data);
 851                         ret = CMD_RET_FAILURE;
 852                         goto out;
 853                 }
 854
 855                 efi_deserialize_load_option(&lo, data);
 856
 857                 label_len16 = u16_strlen(lo.label);
 858                 label_len = utf16_utf8_strnlen(lo.label, label_len16);
 859                 label = malloc(label_len + 1);
 860                 if (!label) {
 861                         free(data);
 862                         ret = CMD_RET_FAILURE;
 863                         goto out;
 864                 }
 865                 p = label;
 866                 utf16_utf8_strncpy(&p, lo.label, label_len16);
 867                 printf("%2d: Boot%04X: %s\n", i + 1, bootorder[i], label);
 868                 free(label);
 869
 870                 free(data);
 871         }
 872 out:
 873         free(bootorder);
 874
 875         return ret;
 876 }
 877
 878 /**
 879  * do_efi_boot_next() - manage UEFI BootNext variable
 880  *
 881  * @cmdtp:      Command table
 882  * @flag:       Command flag
 883  * @argc:       Number of arguments
 884  * @argv:       Argument array
 885  * Return:      CMD_RET_SUCCESS on success,
 886  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
 887  *
 888  * Implement efidebug "boot next" sub-command.
 889  * Set BootNext variable.
 890  *   - boot next <id>
 891  */
 892 static int do_efi_boot_next(cmd_tbl_t *cmdtp, int flag,
 893                             int argc, char * const argv[])
 894 {
 895         u16 bootnext;
 896         efi_uintn_t size;
 897         char *endp;
 898         efi_guid_t guid;
 899         efi_status_t ret;
 900         int r;
 901
 902         if (argc != 2)
 903                 return CMD_RET_USAGE;
 904
 905         bootnext = (u16)simple_strtoul(argv[1], &endp, 16);
 906         if (*endp != '\0' || bootnext > 0xffff) {
 907                 printf("invalid value: %s\n", argv[1]);
 908                 r = CMD_RET_FAILURE;
 909                 goto out;
 910         }
 911
 912         guid = efi_global_variable_guid;
 913         size = sizeof(u16);
 914         ret = EFI_CALL(RT->set_variable(L"BootNext", &guid,
 915                                         EFI_VARIABLE_NON_VOLATILE |
 916                                         EFI_VARIABLE_BOOTSERVICE_ACCESS |
 917                                         EFI_VARIABLE_RUNTIME_ACCESS,
 918                                         size, &bootnext));
 919         r = (ret == EFI_SUCCESS ? CMD_RET_SUCCESS : CMD_RET_FAILURE);
 920 out:
 921         return r;
 922 }
 923
 924 /**
 925  * do_efi_boot_order() - manage UEFI BootOrder variable
 926  *
 927  * @cmdtp:      Command table
 928  * @flag:       Command flag
 929  * @argc:       Number of arguments
 930  * @argv:       Argument array
 931  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
 932  *
 933  * Implement efidebug "boot order" sub-command.
 934  * Show order of UEFI load options, or change it in BootOrder variable.
 935  *   - boot order [<id> ...]
 936  */
 937 static int do_efi_boot_order(cmd_tbl_t *cmdtp, int flag,
 938                              int argc, char * const argv[])
 939 {
 940         u16 *bootorder = NULL;
 941         efi_uintn_t size;
 942         int id, i;
 943         char *endp;
 944         efi_guid_t guid;
 945         efi_status_t ret;
 946         int r;
 947
 948         if (argc == 1)
 949                 return show_efi_boot_order();
 950
 951         argc--;
 952         argv++;
 953
 954         size = argc * sizeof(u16);
 955         bootorder = malloc(size);
 956         if (!bootorder)
 957                 return CMD_RET_FAILURE;
 958
 959         for (i = 0; i < argc; i++) {
 960                 id = (int)simple_strtoul(argv[i], &endp, 16);
 961                 if (*endp != '\0' || id > 0xffff) {
 962                         printf("invalid value: %s\n", argv[i]);
 963                         r = CMD_RET_FAILURE;
 964                         goto out;
 965                 }
 966
 967                 bootorder[i] = (u16)id;
 968         }
 969
 970         guid = efi_global_variable_guid;
 971         ret = EFI_CALL(RT->set_variable(L"BootOrder", &guid,
 972                                         EFI_VARIABLE_NON_VOLATILE |
 973                                         EFI_VARIABLE_BOOTSERVICE_ACCESS |
 974                                         EFI_VARIABLE_RUNTIME_ACCESS,
 975                                         size, bootorder));
 976         r = (ret == EFI_SUCCESS ? CMD_RET_SUCCESS : CMD_RET_FAILURE);
 977 out:
 978         free(bootorder);
 979
 980         return r;
 981 }
 982
 983 static cmd_tbl_t cmd_efidebug_boot_sub[] = {
 984         U_BOOT_CMD_MKENT(add, CONFIG_SYS_MAXARGS, 1, do_efi_boot_add, "", ""),
 985         U_BOOT_CMD_MKENT(rm, CONFIG_SYS_MAXARGS, 1, do_efi_boot_rm, "", ""),
 986         U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_efi_boot_dump, "", ""),
 987         U_BOOT_CMD_MKENT(next, CONFIG_SYS_MAXARGS, 1, do_efi_boot_next, "", ""),
 988         U_BOOT_CMD_MKENT(order, CONFIG_SYS_MAXARGS, 1, do_efi_boot_order,
 989                          "", ""),
 990 };
 991
 992 /**
 993  * do_efi_boot_opt() - manage UEFI load options
 994  *
 995  * @cmdtp:      Command table
 996  * @flag:       Command flag
 997  * @argc:       Number of arguments
 998  * @argv:       Argument array
 999  * Return:      CMD_RET_SUCCESS on success,
1000  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1001  *
1002  * Implement efidebug "boot" sub-command.
1003  * See above for details of sub-commands.
1004  */
1005 static int do_efi_boot_opt(cmd_tbl_t *cmdtp, int flag,
1006                            int argc, char * const argv[])
1007 {
1008         cmd_tbl_t *cp;
1009
1010         if (argc < 2)
1011                 return CMD_RET_USAGE;
1012
1013         argc--; argv++;
1014
1015         cp = find_cmd_tbl(argv[0], cmd_efidebug_boot_sub,
1016                           ARRAY_SIZE(cmd_efidebug_boot_sub));
1017         if (!cp)
1018                 return CMD_RET_USAGE;
1019
1020         return cp->cmd(cmdtp, flag, argc, argv);
1021 }
1022
1023 static cmd_tbl_t cmd_efidebug_sub[] = {
1024         U_BOOT_CMD_MKENT(boot, CONFIG_SYS_MAXARGS, 1, do_efi_boot_opt, "", ""),
1025         U_BOOT_CMD_MKENT(devices, CONFIG_SYS_MAXARGS, 1, do_efi_show_devices,
1026                          "", ""),
1027         U_BOOT_CMD_MKENT(drivers, CONFIG_SYS_MAXARGS, 1, do_efi_show_drivers,
1028                          "", ""),
1029         U_BOOT_CMD_MKENT(dh, CONFIG_SYS_MAXARGS, 1, do_efi_show_handles,
1030                          "", ""),
1031         U_BOOT_CMD_MKENT(images, CONFIG_SYS_MAXARGS, 1, do_efi_show_images,
1032                          "", ""),
1033         U_BOOT_CMD_MKENT(memmap, CONFIG_SYS_MAXARGS, 1, do_efi_show_memmap,
1034                          "", ""),
1035 };
1036
1037 /**
1038  * do_efidebug() - display and configure UEFI environment
1039  *
1040  * @cmdtp:      Command table
1041  * @flag:       Command flag
1042  * @argc:       Number of arguments
1043  * @argv:       Argument array
1044  * Return:      CMD_RET_SUCCESS on success,
1045  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1046  *
1047  * Implement efidebug command which allows us to display and
1048  * configure UEFI environment.
1049  * See above for details of sub-commands.
1050  */
1051 static int do_efidebug(cmd_tbl_t *cmdtp, int flag,
1052                        int argc, char * const argv[])
1053 {
1054         cmd_tbl_t *cp;
1055         efi_status_t r;
1056
1057         if (argc < 2)
1058                 return CMD_RET_USAGE;
1059
1060         argc--; argv++;
1061
1062         /* Initialize UEFI drivers */
1063         r = efi_init_obj_list();
1064         if (r != EFI_SUCCESS) {
1065                 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
1066                        r & ~EFI_ERROR_MASK);
1067                 return CMD_RET_FAILURE;
1068         }
1069
1070         cp = find_cmd_tbl(argv[0], cmd_efidebug_sub,
1071                           ARRAY_SIZE(cmd_efidebug_sub));
1072         if (!cp)
1073                 return CMD_RET_USAGE;
1074
1075         return cp->cmd(cmdtp, flag, argc, argv);
1076 }
1077
1078 #ifdef CONFIG_SYS_LONGHELP
1079 static char efidebug_help_text[] =
1080         "  - UEFI Shell-like interface to configure UEFI environment\n"
1081         "\n"
1082         "efidebug boot add <bootid> <label> <interface> <devnum>[:<part>] <file path> [<load options>]\n"
1083         "  - set UEFI BootXXXX variable\n"
1084         "    <load options> will be passed to UEFI application\n"
1085         "efidebug boot rm <bootid#1> [<bootid#2> [<bootid#3> [...]]]\n"
1086         "  - delete UEFI BootXXXX variables\n"
1087         "efidebug boot dump\n"
1088         "  - dump all UEFI BootXXXX variables\n"
1089         "efidebug boot next <bootid>\n"
1090         "  - set UEFI BootNext variable\n"
1091         "efidebug boot order [<bootid#1> [<bootid#2> [<bootid#3> [...]]]]\n"
1092         "  - set/show UEFI boot order\n"
1093         "\n"
1094         "efidebug devices\n"
1095         "  - show uefi devices\n"
1096         "efidebug drivers\n"
1097         "  - show uefi drivers\n"
1098         "efidebug dh\n"
1099         "  - show uefi handles\n"
1100         "efidebug images\n"
1101         "  - show loaded images\n"
1102         "efidebug memmap\n"
1103         "  - show uefi memory map\n";
1104 #endif
1105
1106 U_BOOT_CMD(
1107         efidebug, 10, 0, do_efidebug,
1108         "Configure UEFI environment",
1109         efidebug_help_text
1110 );