1 // SPDX-License-Identifier: GPL-2.0+
3 * UEFI Shell-like command
5 * Copyright (c) 2018 AKASHI Takahiro, Linaro Limited
11 #include <efi_loader.h>
17 #include <linux/ctype.h>
19 #define BS systab.boottime
20 #define RT systab.runtime
23 * efi_get_device_handle_info() - get information of UEFI device
25 * @handle: Handle of UEFI device
26 * @dev_path_text: Pointer to text of device path
27 * Return: 0 on success, -1 on failure
29 * Currently return a formatted text of device path.
31 static int efi_get_device_handle_info(efi_handle_t handle, u16 **dev_path_text)
33 struct efi_device_path *dp;
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);
47 #define EFI_HANDLE_WIDTH ((int)sizeof(efi_handle_t) * 2)
49 static const char spc[] = " ";
50 static const char sep[] = "================";
53 * do_efi_show_devices() - show UEFI devices
55 * @cmdtp: Command table
57 * @argc: Number of arguments
58 * @argv: Argument array
59 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
61 * Implement efidebug "devices" sub-command.
62 * Show all UEFI devices and their information.
64 static int do_efi_show_devices(cmd_tbl_t *cmdtp, int flag,
65 int argc, char * const argv[])
67 efi_handle_t *handles;
72 ret = EFI_CALL(BS->locate_handle_buffer(ALL_HANDLES, NULL, NULL,
74 if (ret != EFI_SUCCESS)
75 return CMD_RET_FAILURE;
78 return CMD_RET_SUCCESS;
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);
89 EFI_CALL(BS->free_pool(handles));
91 return CMD_RET_SUCCESS;
95 * efi_get_driver_handle_info() - get information of UEFI driver
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
102 * Currently return no useful information as all UEFI drivers are
105 static int efi_get_driver_handle_info(efi_handle_t handle, u16 **driver_name,
108 struct efi_handler *handler;
109 struct efi_loaded_image *image;
114 * TODO: support EFI_COMPONENT_NAME2_PROTOCOL
119 ret = efi_search_protocol(handle, &efi_guid_loaded_image, &handler);
120 if (ret != EFI_SUCCESS) {
125 image = handler->protocol_interface;
126 *image_path = efi_dp_str(image->file_path);
132 * do_efi_show_drivers() - show UEFI drivers
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
140 * Implement efidebug "drivers" sub-command.
141 * Show all UEFI drivers and their information.
143 static int do_efi_show_drivers(cmd_tbl_t *cmdtp, int flag,
144 int argc, char * const argv[])
146 efi_handle_t *handles;
148 u16 *driver_name, *image_path_text;
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;
158 return CMD_RET_SUCCESS;
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,
168 printf("%p %-20ls %ls\n", handles[i],
169 driver_name, image_path_text);
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));
178 EFI_CALL(BS->free_pool(handles));
180 return CMD_RET_SUCCESS;
183 static const struct {
185 const efi_guid_t guid;
189 EFI_DEVICE_PATH_PROTOCOL_GUID,
192 "Device Path To Text",
193 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID,
196 "Device Path Utilities",
197 EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID,
200 "Unicode Collation 2",
201 EFI_UNICODE_COLLATION_PROTOCOL2_GUID,
205 EFI_DRIVER_BINDING_PROTOCOL_GUID,
209 EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID,
212 "Simple Text Input Ex",
213 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID,
216 "Simple Text Output",
217 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID,
221 EFI_BLOCK_IO_PROTOCOL_GUID,
224 "Simple File System",
225 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID,
229 EFI_LOADED_IMAGE_PROTOCOL_GUID,
233 EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID,
237 EFI_HII_STRING_PROTOCOL_GUID,
241 EFI_HII_DATABASE_PROTOCOL_GUID,
244 "HII Config Routing",
245 EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID,
249 EFI_LOAD_FILE2_PROTOCOL_GUID,
253 EFI_SIMPLE_NETWORK_PROTOCOL_GUID,
257 EFI_PXE_BASE_CODE_PROTOCOL_GUID,
259 /* Configuration table GUIDs */
273 "Runtime properties",
274 EFI_RT_PROPERTIES_TABLE_GUID,
279 * get_guid_text - get string of GUID
281 * Return description of GUID.
284 * Return: description of GUID or NULL
286 static const char *get_guid_text(const void *guid)
290 for (i = 0; i < ARRAY_SIZE(guid_list); i++) {
292 * As guidcmp uses memcmp() we can safely accept unaligned
295 if (!guidcmp(&guid_list[i].guid, guid))
296 return guid_list[i].text;
303 * do_efi_show_handles() - show UEFI handles
305 * @cmdtp: Command table
306 * @flag: Command flag
307 * @argc: Number of arguments
308 * @argv: Argument array
309 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
311 * Implement efidebug "dh" sub-command.
312 * Show all UEFI handles and their information, currently all protocols
315 static int do_efi_show_handles(cmd_tbl_t *cmdtp, int flag,
316 int argc, char * const argv[])
318 efi_handle_t *handles;
320 efi_uintn_t num, count, i, j;
321 const char *guid_text;
324 ret = EFI_CALL(BS->locate_handle_buffer(ALL_HANDLES, NULL, NULL,
326 if (ret != EFI_SUCCESS)
327 return CMD_RET_FAILURE;
330 return CMD_RET_SUCCESS;
332 printf("Handle%.*s Protocols\n", EFI_HANDLE_WIDTH - 6, spc);
333 printf("%.*s ====================\n", EFI_HANDLE_WIDTH, sep);
334 for (i = 0; i < num; i++) {
335 printf("%p", handles[i]);
336 ret = EFI_CALL(BS->protocols_per_handle(handles[i], &guid,
343 for (j = 0; j < count; j++) {
349 guid_text = get_guid_text(guid[j]);
353 printf("%pUl", guid[j]);
358 EFI_CALL(BS->free_pool(handles));
360 return CMD_RET_SUCCESS;
364 * do_efi_show_images() - show UEFI images
366 * @cmdtp: Command table
367 * @flag: Command flag
368 * @argc: Number of arguments
369 * @argv: Argument array
370 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
372 * Implement efidebug "images" sub-command.
373 * Show all UEFI loaded images and their information.
375 static int do_efi_show_images(cmd_tbl_t *cmdtp, int flag,
376 int argc, char * const argv[])
378 efi_print_image_infos(NULL);
380 return CMD_RET_SUCCESS;
383 static const char * const efi_mem_type_string[] = {
384 [EFI_RESERVED_MEMORY_TYPE] = "RESERVED",
385 [EFI_LOADER_CODE] = "LOADER CODE",
386 [EFI_LOADER_DATA] = "LOADER DATA",
387 [EFI_BOOT_SERVICES_CODE] = "BOOT CODE",
388 [EFI_BOOT_SERVICES_DATA] = "BOOT DATA",
389 [EFI_RUNTIME_SERVICES_CODE] = "RUNTIME CODE",
390 [EFI_RUNTIME_SERVICES_DATA] = "RUNTIME DATA",
391 [EFI_CONVENTIONAL_MEMORY] = "CONVENTIONAL",
392 [EFI_UNUSABLE_MEMORY] = "UNUSABLE MEM",
393 [EFI_ACPI_RECLAIM_MEMORY] = "ACPI RECLAIM MEM",
394 [EFI_ACPI_MEMORY_NVS] = "ACPI NVS",
395 [EFI_MMAP_IO] = "IO",
396 [EFI_MMAP_IO_PORT] = "IO PORT",
397 [EFI_PAL_CODE] = "PAL",
398 [EFI_PERSISTENT_MEMORY_TYPE] = "PERSISTENT",
401 static const struct efi_mem_attrs {
404 } efi_mem_attrs[] = {
405 {EFI_MEMORY_UC, "UC"},
406 {EFI_MEMORY_UC, "UC"},
407 {EFI_MEMORY_WC, "WC"},
408 {EFI_MEMORY_WT, "WT"},
409 {EFI_MEMORY_WB, "WB"},
410 {EFI_MEMORY_UCE, "UCE"},
411 {EFI_MEMORY_WP, "WP"},
412 {EFI_MEMORY_RP, "RP"},
413 {EFI_MEMORY_XP, "WP"},
414 {EFI_MEMORY_NV, "NV"},
415 {EFI_MEMORY_MORE_RELIABLE, "REL"},
416 {EFI_MEMORY_RO, "RO"},
417 {EFI_MEMORY_RUNTIME, "RT"},
421 * print_memory_attributes() - print memory map attributes
423 * @attributes: Attribute value
425 * Print memory map attributes
427 static void print_memory_attributes(u64 attributes)
431 for (sep = 0, i = 0; i < ARRAY_SIZE(efi_mem_attrs); i++)
432 if (attributes & efi_mem_attrs[i].bit) {
439 puts(efi_mem_attrs[i].text);
443 #define EFI_PHYS_ADDR_WIDTH (int)(sizeof(efi_physical_addr_t) * 2)
446 * do_efi_show_memmap() - show UEFI memory map
448 * @cmdtp: Command table
449 * @flag: Command flag
450 * @argc: Number of arguments
451 * @argv: Argument array
452 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
454 * Implement efidebug "memmap" sub-command.
455 * Show UEFI memory map.
457 static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
458 int argc, char * const argv[])
460 struct efi_mem_desc *memmap = NULL, *map;
461 efi_uintn_t map_size = 0;
466 ret = EFI_CALL(BS->get_memory_map(&map_size, memmap, NULL, NULL, NULL));
467 if (ret == EFI_BUFFER_TOO_SMALL) {
468 map_size += sizeof(struct efi_mem_desc); /* for my own */
469 ret = EFI_CALL(BS->allocate_pool(EFI_LOADER_DATA,
470 map_size, (void *)&memmap));
471 if (ret != EFI_SUCCESS)
472 return CMD_RET_FAILURE;
473 ret = EFI_CALL(BS->get_memory_map(&map_size, memmap,
476 if (ret != EFI_SUCCESS) {
477 EFI_CALL(BS->free_pool(memmap));
478 return CMD_RET_FAILURE;
481 printf("Type Start%.*s End%.*s Attributes\n",
482 EFI_PHYS_ADDR_WIDTH - 5, spc, EFI_PHYS_ADDR_WIDTH - 3, spc);
483 printf("================ %.*s %.*s ==========\n",
484 EFI_PHYS_ADDR_WIDTH, sep, EFI_PHYS_ADDR_WIDTH, sep);
485 for (i = 0, map = memmap; i < map_size / sizeof(*map); map++, i++) {
486 if (map->type < ARRAY_SIZE(efi_mem_type_string))
487 type = efi_mem_type_string[map->type];
491 printf("%-16s %.*llx-%.*llx", type,
493 (u64)map_to_sysmem((void *)(uintptr_t)
494 map->physical_start),
496 (u64)map_to_sysmem((void *)(uintptr_t)
497 (map->physical_start +
498 map->num_pages * EFI_PAGE_SIZE)));
500 print_memory_attributes(map->attribute);
504 EFI_CALL(BS->free_pool(memmap));
506 return CMD_RET_SUCCESS;
510 * do_efi_show_tables() - show UEFI configuration tables
512 * @cmdtp: Command table
513 * @flag: Command flag
514 * @argc: Number of arguments
515 * @argv: Argument array
516 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
518 * Implement efidebug "tables" sub-command.
519 * Show UEFI configuration tables.
521 static int do_efi_show_tables(cmd_tbl_t *cmdtp, int flag,
522 int argc, char * const argv[])
525 const char *guid_str;
527 for (i = 0; i < systab.nr_tables; ++i) {
528 guid_str = get_guid_text(&systab.tables[i].guid);
531 printf("%pUl %s\n", &systab.tables[i].guid, guid_str);
534 return CMD_RET_SUCCESS;
538 * do_efi_boot_add() - set UEFI load option
540 * @cmdtp: Command table
541 * @flag: Command flag
542 * @argc: Number of arguments
543 * @argv: Argument array
544 * Return: CMD_RET_SUCCESS on success,
545 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
547 * Implement efidebug "boot add" sub-command. Create or change UEFI load option.
549 * efidebug boot add <id> <label> <interface> <devnum>[:<part>] <file> <options>
551 static int do_efi_boot_add(cmd_tbl_t *cmdtp, int flag,
552 int argc, char * const argv[])
557 u16 var_name16[9], *p;
559 size_t label_len, label_len16;
561 struct efi_device_path *device_path = NULL, *file_path = NULL;
562 struct efi_load_option lo;
566 int r = CMD_RET_SUCCESS;
568 if (argc < 6 || argc > 7)
569 return CMD_RET_USAGE;
571 id = (int)simple_strtoul(argv[1], &endp, 16);
572 if (*endp != '\0' || id > 0xffff)
573 return CMD_RET_USAGE;
575 sprintf(var_name, "Boot%04X", id);
577 utf8_utf16_strncpy(&p, var_name, 9);
579 guid = efi_global_variable_guid;
582 lo.attributes = LOAD_OPTION_ACTIVE; /* always ACTIVE */
585 label_len = strlen(argv[2]);
586 label_len16 = utf8_utf16_strnlen(argv[2], label_len);
587 label = malloc((label_len16 + 1) * sizeof(u16));
589 return CMD_RET_FAILURE;
590 lo.label = label; /* label will be changed below */
591 utf8_utf16_strncpy(&label, argv[2], label_len);
594 ret = efi_dp_from_name(argv[3], argv[4], argv[5], &device_path,
596 if (ret != EFI_SUCCESS) {
597 printf("Cannot create device path for \"%s %s\"\n",
602 lo.file_path = file_path;
603 lo.file_path_length = efi_dp_size(file_path)
604 + sizeof(struct efi_device_path); /* for END */
608 lo.optional_data = NULL;
610 lo.optional_data = (const u8 *)argv[6];
612 size = efi_serialize_load_option(&lo, (u8 **)&data);
618 ret = EFI_CALL(RT->set_variable(var_name16, &guid,
619 EFI_VARIABLE_NON_VOLATILE |
620 EFI_VARIABLE_BOOTSERVICE_ACCESS |
621 EFI_VARIABLE_RUNTIME_ACCESS,
623 if (ret != EFI_SUCCESS) {
624 printf("Cannot set %ls\n", var_name16);
629 efi_free_pool(device_path);
630 efi_free_pool(file_path);
637 * do_efi_boot_rm() - delete UEFI load options
639 * @cmdtp: Command table
640 * @flag: Command flag
641 * @argc: Number of arguments
642 * @argv: Argument array
643 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
645 * Implement efidebug "boot rm" sub-command.
646 * Delete UEFI load options.
648 * efidebug boot rm <id> ...
650 static int do_efi_boot_rm(cmd_tbl_t *cmdtp, int flag,
651 int argc, char * const argv[])
657 u16 var_name16[9], *p;
661 return CMD_RET_USAGE;
663 guid = efi_global_variable_guid;
664 for (i = 1; i < argc; i++, argv++) {
665 id = (int)simple_strtoul(argv[1], &endp, 16);
666 if (*endp != '\0' || id > 0xffff)
667 return CMD_RET_FAILURE;
669 sprintf(var_name, "Boot%04X", id);
671 utf8_utf16_strncpy(&p, var_name, 9);
673 ret = EFI_CALL(RT->set_variable(var_name16, &guid, 0, 0, NULL));
675 printf("Cannot remove %ls\n", var_name16);
676 return CMD_RET_FAILURE;
680 return CMD_RET_SUCCESS;
684 * show_efi_boot_opt_data() - dump UEFI load option
686 * @varname16: variable name
687 * @data: value of UEFI load option variable
688 * @size: size of the boot option
690 * Decode the value of UEFI load option variable and print information.
692 static void show_efi_boot_opt_data(u16 *varname16, void *data, size_t size)
694 struct efi_load_option lo;
696 size_t label_len16, label_len;
699 efi_deserialize_load_option(&lo, data);
701 label_len16 = u16_strlen(lo.label);
702 label_len = utf16_utf8_strnlen(lo.label, label_len16);
703 label = malloc(label_len + 1);
707 utf16_utf8_strncpy(&p, lo.label, label_len16);
709 printf("%ls:\nattributes: %c%c%c (0x%08x)\n",
712 lo.attributes & LOAD_OPTION_ACTIVE ? 'A' : '-',
713 /* FORCE RECONNECT */
714 lo.attributes & LOAD_OPTION_FORCE_RECONNECT ? 'R' : '-',
716 lo.attributes & LOAD_OPTION_HIDDEN ? 'H' : '-',
718 printf(" label: %s\n", label);
720 dp_str = efi_dp_str(lo.file_path);
721 printf(" file_path: %ls\n", dp_str);
722 efi_free_pool(dp_str);
725 print_hex_dump(" ", DUMP_PREFIX_OFFSET, 16, 1,
726 lo.optional_data, size + (u8 *)data -
727 (u8 *)lo.optional_data, true);
732 * show_efi_boot_opt() - dump UEFI load option
734 * @varname16: variable name
736 * Dump information defined by UEFI load option.
738 static void show_efi_boot_opt(u16 *varname16)
745 ret = EFI_CALL(efi_get_variable(varname16, &efi_global_variable_guid,
747 if (ret == EFI_BUFFER_TOO_SMALL) {
750 printf("ERROR: Out of memory\n");
753 ret = EFI_CALL(efi_get_variable(varname16,
754 &efi_global_variable_guid,
756 if (ret == EFI_SUCCESS)
757 show_efi_boot_opt_data(varname16, data, size);
762 static int u16_tohex(u16 c)
764 if (c >= '0' && c <= '9')
766 if (c >= 'A' && c <= 'F')
769 /* not hexadecimal */
774 * show_efi_boot_dump() - dump all UEFI load options
776 * @cmdtp: Command table
777 * @flag: Command flag
778 * @argc: Number of arguments
779 * @argv: Argument array
780 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
782 * Implement efidebug "boot dump" sub-command.
783 * Dump information of all UEFI load options defined.
787 static int do_efi_boot_dump(cmd_tbl_t *cmdtp, int flag,
788 int argc, char * const argv[])
791 efi_uintn_t buf_size, size;
797 return CMD_RET_USAGE;
800 var_name16 = malloc(buf_size);
802 return CMD_RET_FAILURE;
807 ret = EFI_CALL(efi_get_next_variable_name(&size, var_name16,
809 if (ret == EFI_NOT_FOUND)
811 if (ret == EFI_BUFFER_TOO_SMALL) {
813 p = realloc(var_name16, buf_size);
816 return CMD_RET_FAILURE;
819 ret = EFI_CALL(efi_get_next_variable_name(&size,
823 if (ret != EFI_SUCCESS) {
825 return CMD_RET_FAILURE;
828 if (memcmp(var_name16, L"Boot", 8))
831 for (id = 0, i = 0; i < 4; i++) {
832 digit = u16_tohex(var_name16[4 + i]);
835 id = (id << 4) + digit;
837 if (i == 4 && !var_name16[8])
838 show_efi_boot_opt(var_name16);
843 return CMD_RET_SUCCESS;
847 * show_efi_boot_order() - show order of UEFI load options
849 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
851 * Show order of UEFI load options defined by BootOrder variable.
853 static int show_efi_boot_order(void)
859 u16 var_name16[9], *p16;
861 struct efi_load_option lo;
863 size_t label_len16, label_len;
867 ret = EFI_CALL(RT->get_variable(L"BootOrder", &efi_global_variable_guid,
869 if (ret != EFI_BUFFER_TOO_SMALL) {
870 if (ret == EFI_NOT_FOUND) {
871 printf("BootOrder not defined\n");
872 return CMD_RET_SUCCESS;
874 return CMD_RET_FAILURE;
877 bootorder = malloc(size);
879 printf("ERROR: Out of memory\n");
880 return CMD_RET_FAILURE;
882 ret = EFI_CALL(efi_get_variable(L"BootOrder", &efi_global_variable_guid,
883 NULL, &size, bootorder));
884 if (ret != EFI_SUCCESS) {
885 ret = CMD_RET_FAILURE;
889 num = size / sizeof(u16);
890 for (i = 0; i < num; i++) {
891 sprintf(var_name, "Boot%04X", bootorder[i]);
893 utf8_utf16_strncpy(&p16, var_name, 9);
896 ret = EFI_CALL(efi_get_variable(var_name16,
897 &efi_global_variable_guid, NULL,
899 if (ret != EFI_BUFFER_TOO_SMALL) {
900 printf("%2d: %s: (not defined)\n", i + 1, var_name);
906 ret = CMD_RET_FAILURE;
909 ret = EFI_CALL(efi_get_variable(var_name16,
910 &efi_global_variable_guid, NULL,
912 if (ret != EFI_SUCCESS) {
914 ret = CMD_RET_FAILURE;
918 efi_deserialize_load_option(&lo, data);
920 label_len16 = u16_strlen(lo.label);
921 label_len = utf16_utf8_strnlen(lo.label, label_len16);
922 label = malloc(label_len + 1);
925 ret = CMD_RET_FAILURE;
929 utf16_utf8_strncpy(&p, lo.label, label_len16);
930 printf("%2d: %s: %s\n", i + 1, var_name, label);
942 * do_efi_boot_next() - manage UEFI BootNext variable
944 * @cmdtp: Command table
945 * @flag: Command flag
946 * @argc: Number of arguments
947 * @argv: Argument array
948 * Return: CMD_RET_SUCCESS on success,
949 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
951 * Implement efidebug "boot next" sub-command.
952 * Set BootNext variable.
954 * efidebug boot next <id>
956 static int do_efi_boot_next(cmd_tbl_t *cmdtp, int flag,
957 int argc, char * const argv[])
964 int r = CMD_RET_SUCCESS;
967 return CMD_RET_USAGE;
969 bootnext = (u16)simple_strtoul(argv[1], &endp, 16);
970 if (*endp != '\0' || bootnext > 0xffff) {
971 printf("invalid value: %s\n", argv[1]);
976 guid = efi_global_variable_guid;
978 ret = EFI_CALL(RT->set_variable(L"BootNext", &guid,
979 EFI_VARIABLE_NON_VOLATILE |
980 EFI_VARIABLE_BOOTSERVICE_ACCESS |
981 EFI_VARIABLE_RUNTIME_ACCESS,
983 if (ret != EFI_SUCCESS) {
984 printf("Cannot set BootNext\n");
992 * do_efi_boot_order() - manage UEFI BootOrder variable
994 * @cmdtp: Command table
995 * @flag: Command flag
996 * @argc: Number of arguments
997 * @argv: Argument array
998 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
1000 * Implement efidebug "boot order" sub-command.
1001 * Show order of UEFI load options, or change it in BootOrder variable.
1003 * efidebug boot order [<id> ...]
1005 static int do_efi_boot_order(cmd_tbl_t *cmdtp, int flag,
1006 int argc, char * const argv[])
1008 u16 *bootorder = NULL;
1014 int r = CMD_RET_SUCCESS;
1017 return show_efi_boot_order();
1022 size = argc * sizeof(u16);
1023 bootorder = malloc(size);
1025 return CMD_RET_FAILURE;
1027 for (i = 0; i < argc; i++) {
1028 id = (int)simple_strtoul(argv[i], &endp, 16);
1029 if (*endp != '\0' || id > 0xffff) {
1030 printf("invalid value: %s\n", argv[i]);
1031 r = CMD_RET_FAILURE;
1035 bootorder[i] = (u16)id;
1038 guid = efi_global_variable_guid;
1039 ret = EFI_CALL(RT->set_variable(L"BootOrder", &guid,
1040 EFI_VARIABLE_NON_VOLATILE |
1041 EFI_VARIABLE_BOOTSERVICE_ACCESS |
1042 EFI_VARIABLE_RUNTIME_ACCESS,
1044 if (ret != EFI_SUCCESS) {
1045 printf("Cannot set BootOrder\n");
1046 r = CMD_RET_FAILURE;
1054 static cmd_tbl_t cmd_efidebug_boot_sub[] = {
1055 U_BOOT_CMD_MKENT(add, CONFIG_SYS_MAXARGS, 1, do_efi_boot_add, "", ""),
1056 U_BOOT_CMD_MKENT(rm, CONFIG_SYS_MAXARGS, 1, do_efi_boot_rm, "", ""),
1057 U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_efi_boot_dump, "", ""),
1058 U_BOOT_CMD_MKENT(next, CONFIG_SYS_MAXARGS, 1, do_efi_boot_next, "", ""),
1059 U_BOOT_CMD_MKENT(order, CONFIG_SYS_MAXARGS, 1, do_efi_boot_order,
1064 * do_efi_boot_opt() - manage UEFI load options
1066 * @cmdtp: Command table
1067 * @flag: Command flag
1068 * @argc: Number of arguments
1069 * @argv: Argument array
1070 * Return: CMD_RET_SUCCESS on success,
1071 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1073 * Implement efidebug "boot" sub-command.
1075 static int do_efi_boot_opt(cmd_tbl_t *cmdtp, int flag,
1076 int argc, char * const argv[])
1081 return CMD_RET_USAGE;
1085 cp = find_cmd_tbl(argv[0], cmd_efidebug_boot_sub,
1086 ARRAY_SIZE(cmd_efidebug_boot_sub));
1088 return CMD_RET_USAGE;
1090 return cp->cmd(cmdtp, flag, argc, argv);
1094 * do_efi_test_bootmgr() - run simple bootmgr for test
1096 * @cmdtp: Command table
1097 * @flag: Command flag
1098 * @argc: Number of arguments
1099 * @argv: Argument array
1100 * Return: CMD_RET_SUCCESS on success,
1101 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1103 * Implement efidebug "test bootmgr" sub-command.
1104 * Run simple bootmgr for test.
1106 * efidebug test bootmgr
1108 static int do_efi_test_bootmgr(cmd_tbl_t *cmdtp, int flag,
1109 int argc, char * const argv[])
1112 efi_uintn_t exit_data_size = 0;
1113 u16 *exit_data = NULL;
1116 ret = efi_bootmgr_load(&image);
1117 printf("efi_bootmgr_load() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1119 /* We call efi_start_image() even if error for test purpose. */
1120 ret = EFI_CALL(efi_start_image(image, &exit_data_size, &exit_data));
1121 printf("efi_start_image() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1122 if (ret && exit_data)
1123 efi_free_pool(exit_data);
1127 return CMD_RET_SUCCESS;
1130 static cmd_tbl_t cmd_efidebug_test_sub[] = {
1131 U_BOOT_CMD_MKENT(bootmgr, CONFIG_SYS_MAXARGS, 1, do_efi_test_bootmgr,
1136 * do_efi_test() - manage UEFI load options
1138 * @cmdtp: Command table
1139 * @flag: Command flag
1140 * @argc: Number of arguments
1141 * @argv: Argument array
1142 * Return: CMD_RET_SUCCESS on success,
1143 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1145 * Implement efidebug "test" sub-command.
1147 static int do_efi_test(cmd_tbl_t *cmdtp, int flag,
1148 int argc, char * const argv[])
1153 return CMD_RET_USAGE;
1157 cp = find_cmd_tbl(argv[0], cmd_efidebug_test_sub,
1158 ARRAY_SIZE(cmd_efidebug_test_sub));
1160 return CMD_RET_USAGE;
1162 return cp->cmd(cmdtp, flag, argc, argv);
1165 static cmd_tbl_t cmd_efidebug_sub[] = {
1166 U_BOOT_CMD_MKENT(boot, CONFIG_SYS_MAXARGS, 1, do_efi_boot_opt, "", ""),
1167 U_BOOT_CMD_MKENT(devices, CONFIG_SYS_MAXARGS, 1, do_efi_show_devices,
1169 U_BOOT_CMD_MKENT(drivers, CONFIG_SYS_MAXARGS, 1, do_efi_show_drivers,
1171 U_BOOT_CMD_MKENT(dh, CONFIG_SYS_MAXARGS, 1, do_efi_show_handles,
1173 U_BOOT_CMD_MKENT(images, CONFIG_SYS_MAXARGS, 1, do_efi_show_images,
1175 U_BOOT_CMD_MKENT(memmap, CONFIG_SYS_MAXARGS, 1, do_efi_show_memmap,
1177 U_BOOT_CMD_MKENT(tables, CONFIG_SYS_MAXARGS, 1, do_efi_show_tables,
1179 U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_efi_test,
1184 * do_efidebug() - display and configure UEFI environment
1186 * @cmdtp: Command table
1187 * @flag: Command flag
1188 * @argc: Number of arguments
1189 * @argv: Argument array
1190 * Return: CMD_RET_SUCCESS on success,
1191 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1193 * Implement efidebug command which allows us to display and
1194 * configure UEFI environment.
1196 static int do_efidebug(cmd_tbl_t *cmdtp, int flag,
1197 int argc, char * const argv[])
1203 return CMD_RET_USAGE;
1207 /* Initialize UEFI drivers */
1208 r = efi_init_obj_list();
1209 if (r != EFI_SUCCESS) {
1210 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
1211 r & ~EFI_ERROR_MASK);
1212 return CMD_RET_FAILURE;
1215 cp = find_cmd_tbl(argv[0], cmd_efidebug_sub,
1216 ARRAY_SIZE(cmd_efidebug_sub));
1218 return CMD_RET_USAGE;
1220 return cp->cmd(cmdtp, flag, argc, argv);
1223 #ifdef CONFIG_SYS_LONGHELP
1224 static char efidebug_help_text[] =
1225 " - UEFI Shell-like interface to configure UEFI environment\n"
1227 "efidebug boot add <bootid> <label> <interface> <devnum>[:<part>] <file path> [<load options>]\n"
1228 " - set UEFI BootXXXX variable\n"
1229 " <load options> will be passed to UEFI application\n"
1230 "efidebug boot rm <bootid#1> [<bootid#2> [<bootid#3> [...]]]\n"
1231 " - delete UEFI BootXXXX variables\n"
1232 "efidebug boot dump\n"
1233 " - dump all UEFI BootXXXX variables\n"
1234 "efidebug boot next <bootid>\n"
1235 " - set UEFI BootNext variable\n"
1236 "efidebug boot order [<bootid#1> [<bootid#2> [<bootid#3> [...]]]]\n"
1237 " - set/show UEFI boot order\n"
1239 "efidebug devices\n"
1240 " - show UEFI devices\n"
1241 "efidebug drivers\n"
1242 " - show UEFI drivers\n"
1244 " - show UEFI handles\n"
1246 " - show loaded images\n"
1248 " - show UEFI memory map\n"
1250 " - show UEFI configuration tables\n"
1251 "efidebug test bootmgr\n"
1252 " - run simple bootmgr for test\n";
1256 efidebug, 10, 0, do_efidebug,
1257 "Configure UEFI environment",