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>
18 #include <linux/ctype.h>
20 #define BS systab.boottime
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(struct cmd_tbl *cmdtp, int flag,
65 int argc, char *const argv[])
67 efi_handle_t *handles;
72 ret = EFI_CALL(efi_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_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(struct cmd_tbl *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(efi_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_free_pool(driver_name);
174 efi_free_pool(image_path_text);
178 efi_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(struct cmd_tbl *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(efi_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_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(struct cmd_tbl *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_SP, "SP"},
418 {EFI_MEMORY_RUNTIME, "RT"},
422 * print_memory_attributes() - print memory map attributes
424 * @attributes: Attribute value
426 * Print memory map attributes
428 static void print_memory_attributes(u64 attributes)
432 for (sep = 0, i = 0; i < ARRAY_SIZE(efi_mem_attrs); i++)
433 if (attributes & efi_mem_attrs[i].bit) {
440 puts(efi_mem_attrs[i].text);
444 #define EFI_PHYS_ADDR_WIDTH (int)(sizeof(efi_physical_addr_t) * 2)
447 * do_efi_show_memmap() - show UEFI memory map
449 * @cmdtp: Command table
450 * @flag: Command flag
451 * @argc: Number of arguments
452 * @argv: Argument array
453 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
455 * Implement efidebug "memmap" sub-command.
456 * Show UEFI memory map.
458 static int do_efi_show_memmap(struct cmd_tbl *cmdtp, int flag,
459 int argc, char *const argv[])
461 struct efi_mem_desc *memmap = NULL, *map;
462 efi_uintn_t map_size = 0;
467 ret = efi_get_memory_map(&map_size, memmap, NULL, NULL, NULL);
468 if (ret == EFI_BUFFER_TOO_SMALL) {
469 map_size += sizeof(struct efi_mem_desc); /* for my own */
470 ret = efi_allocate_pool(EFI_LOADER_DATA, map_size,
472 if (ret != EFI_SUCCESS)
473 return CMD_RET_FAILURE;
474 ret = efi_get_memory_map(&map_size, memmap, NULL, NULL, NULL);
476 if (ret != EFI_SUCCESS) {
477 efi_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);
486 * Coverity check: dereferencing null pointer "map."
487 * This is a false positive as memmap will always be
488 * populated by allocate_pool() above.
490 for (i = 0, map = memmap; i < map_size / sizeof(*map); map++, i++) {
491 if (map->type < ARRAY_SIZE(efi_mem_type_string))
492 type = efi_mem_type_string[map->type];
496 printf("%-16s %.*llx-%.*llx", type,
498 (u64)map_to_sysmem((void *)(uintptr_t)
499 map->physical_start),
501 (u64)map_to_sysmem((void *)(uintptr_t)
502 (map->physical_start +
503 map->num_pages * EFI_PAGE_SIZE)));
505 print_memory_attributes(map->attribute);
509 efi_free_pool(memmap);
511 return CMD_RET_SUCCESS;
515 * do_efi_show_tables() - show UEFI configuration tables
517 * @cmdtp: Command table
518 * @flag: Command flag
519 * @argc: Number of arguments
520 * @argv: Argument array
521 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
523 * Implement efidebug "tables" sub-command.
524 * Show UEFI configuration tables.
526 static int do_efi_show_tables(struct cmd_tbl *cmdtp, int flag,
527 int argc, char *const argv[])
530 const char *guid_str;
532 for (i = 0; i < systab.nr_tables; ++i) {
533 guid_str = get_guid_text(&systab.tables[i].guid);
536 printf("%pUl %s\n", &systab.tables[i].guid, guid_str);
539 return CMD_RET_SUCCESS;
543 * do_efi_boot_add() - set UEFI load option
545 * @cmdtp: Command table
546 * @flag: Command flag
547 * @argc: Number of arguments
548 * @argv: Argument array
549 * Return: CMD_RET_SUCCESS on success,
550 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
552 * Implement efidebug "boot add" sub-command. Create or change UEFI load option.
554 * efidebug boot add <id> <label> <interface> <devnum>[:<part>] <file> <options>
556 static int do_efi_boot_add(struct cmd_tbl *cmdtp, int flag,
557 int argc, char *const argv[])
562 u16 var_name16[9], *p;
564 size_t label_len, label_len16;
566 struct efi_device_path *device_path = NULL, *file_path = NULL;
567 struct efi_load_option lo;
571 int r = CMD_RET_SUCCESS;
573 if (argc < 6 || argc > 7)
574 return CMD_RET_USAGE;
576 id = (int)simple_strtoul(argv[1], &endp, 16);
577 if (*endp != '\0' || id > 0xffff)
578 return CMD_RET_USAGE;
580 sprintf(var_name, "Boot%04X", id);
582 utf8_utf16_strncpy(&p, var_name, 9);
584 guid = efi_global_variable_guid;
587 lo.attributes = LOAD_OPTION_ACTIVE; /* always ACTIVE */
590 label_len = strlen(argv[2]);
591 label_len16 = utf8_utf16_strnlen(argv[2], label_len);
592 label = malloc((label_len16 + 1) * sizeof(u16));
594 return CMD_RET_FAILURE;
595 lo.label = label; /* label will be changed below */
596 utf8_utf16_strncpy(&label, argv[2], label_len);
599 ret = efi_dp_from_name(argv[3], argv[4], argv[5], &device_path,
601 if (ret != EFI_SUCCESS) {
602 printf("Cannot create device path for \"%s %s\"\n",
607 lo.file_path = file_path;
608 lo.file_path_length = efi_dp_size(file_path)
609 + sizeof(struct efi_device_path); /* for END */
613 lo.optional_data = NULL;
615 lo.optional_data = (const u8 *)argv[6];
617 size = efi_serialize_load_option(&lo, (u8 **)&data);
623 ret = EFI_CALL(efi_set_variable(var_name16, &guid,
624 EFI_VARIABLE_NON_VOLATILE |
625 EFI_VARIABLE_BOOTSERVICE_ACCESS |
626 EFI_VARIABLE_RUNTIME_ACCESS,
628 if (ret != EFI_SUCCESS) {
629 printf("Cannot set %ls\n", var_name16);
634 efi_free_pool(device_path);
635 efi_free_pool(file_path);
642 * do_efi_boot_rm() - delete UEFI load options
644 * @cmdtp: Command table
645 * @flag: Command flag
646 * @argc: Number of arguments
647 * @argv: Argument array
648 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
650 * Implement efidebug "boot rm" sub-command.
651 * Delete UEFI load options.
653 * efidebug boot rm <id> ...
655 static int do_efi_boot_rm(struct cmd_tbl *cmdtp, int flag,
656 int argc, char *const argv[])
662 u16 var_name16[9], *p;
666 return CMD_RET_USAGE;
668 guid = efi_global_variable_guid;
669 for (i = 1; i < argc; i++, argv++) {
670 id = (int)simple_strtoul(argv[1], &endp, 16);
671 if (*endp != '\0' || id > 0xffff)
672 return CMD_RET_FAILURE;
674 sprintf(var_name, "Boot%04X", id);
676 utf8_utf16_strncpy(&p, var_name, 9);
678 ret = EFI_CALL(efi_set_variable(var_name16, &guid, 0, 0, NULL));
680 printf("Cannot remove %ls\n", var_name16);
681 return CMD_RET_FAILURE;
685 return CMD_RET_SUCCESS;
689 * show_efi_boot_opt_data() - dump UEFI load option
691 * @varname16: variable name
692 * @data: value of UEFI load option variable
693 * @size: size of the boot option
695 * Decode the value of UEFI load option variable and print information.
697 static void show_efi_boot_opt_data(u16 *varname16, void *data, size_t size)
699 struct efi_load_option lo;
701 size_t label_len16, label_len;
704 efi_deserialize_load_option(&lo, data);
706 label_len16 = u16_strlen(lo.label);
707 label_len = utf16_utf8_strnlen(lo.label, label_len16);
708 label = malloc(label_len + 1);
712 utf16_utf8_strncpy(&p, lo.label, label_len16);
714 printf("%ls:\nattributes: %c%c%c (0x%08x)\n",
717 lo.attributes & LOAD_OPTION_ACTIVE ? 'A' : '-',
718 /* FORCE RECONNECT */
719 lo.attributes & LOAD_OPTION_FORCE_RECONNECT ? 'R' : '-',
721 lo.attributes & LOAD_OPTION_HIDDEN ? 'H' : '-',
723 printf(" label: %s\n", label);
725 dp_str = efi_dp_str(lo.file_path);
726 printf(" file_path: %ls\n", dp_str);
727 efi_free_pool(dp_str);
730 print_hex_dump(" ", DUMP_PREFIX_OFFSET, 16, 1,
731 lo.optional_data, size + (u8 *)data -
732 (u8 *)lo.optional_data, true);
737 * show_efi_boot_opt() - dump UEFI load option
739 * @varname16: variable name
741 * Dump information defined by UEFI load option.
743 static void show_efi_boot_opt(u16 *varname16)
750 ret = EFI_CALL(efi_get_variable(varname16, &efi_global_variable_guid,
752 if (ret == EFI_BUFFER_TOO_SMALL) {
755 printf("ERROR: Out of memory\n");
758 ret = EFI_CALL(efi_get_variable(varname16,
759 &efi_global_variable_guid,
761 if (ret == EFI_SUCCESS)
762 show_efi_boot_opt_data(varname16, data, size);
767 static int u16_tohex(u16 c)
769 if (c >= '0' && c <= '9')
771 if (c >= 'A' && c <= 'F')
774 /* not hexadecimal */
779 * show_efi_boot_dump() - dump all UEFI load options
781 * @cmdtp: Command table
782 * @flag: Command flag
783 * @argc: Number of arguments
784 * @argv: Argument array
785 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
787 * Implement efidebug "boot dump" sub-command.
788 * Dump information of all UEFI load options defined.
792 static int do_efi_boot_dump(struct cmd_tbl *cmdtp, int flag,
793 int argc, char *const argv[])
796 efi_uintn_t buf_size, size;
802 return CMD_RET_USAGE;
805 var_name16 = malloc(buf_size);
807 return CMD_RET_FAILURE;
812 ret = EFI_CALL(efi_get_next_variable_name(&size, var_name16,
814 if (ret == EFI_NOT_FOUND)
816 if (ret == EFI_BUFFER_TOO_SMALL) {
818 p = realloc(var_name16, buf_size);
821 return CMD_RET_FAILURE;
824 ret = EFI_CALL(efi_get_next_variable_name(&size,
828 if (ret != EFI_SUCCESS) {
830 return CMD_RET_FAILURE;
833 if (memcmp(var_name16, L"Boot", 8))
836 for (id = 0, i = 0; i < 4; i++) {
837 digit = u16_tohex(var_name16[4 + i]);
840 id = (id << 4) + digit;
842 if (i == 4 && !var_name16[8])
843 show_efi_boot_opt(var_name16);
848 return CMD_RET_SUCCESS;
852 * show_efi_boot_order() - show order of UEFI load options
854 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
856 * Show order of UEFI load options defined by BootOrder variable.
858 static int show_efi_boot_order(void)
864 u16 var_name16[9], *p16;
866 struct efi_load_option lo;
868 size_t label_len16, label_len;
872 ret = EFI_CALL(efi_get_variable(L"BootOrder", &efi_global_variable_guid,
874 if (ret != EFI_BUFFER_TOO_SMALL) {
875 if (ret == EFI_NOT_FOUND) {
876 printf("BootOrder not defined\n");
877 return CMD_RET_SUCCESS;
879 return CMD_RET_FAILURE;
882 bootorder = malloc(size);
884 printf("ERROR: Out of memory\n");
885 return CMD_RET_FAILURE;
887 ret = EFI_CALL(efi_get_variable(L"BootOrder", &efi_global_variable_guid,
888 NULL, &size, bootorder));
889 if (ret != EFI_SUCCESS) {
890 ret = CMD_RET_FAILURE;
894 num = size / sizeof(u16);
895 for (i = 0; i < num; i++) {
896 sprintf(var_name, "Boot%04X", bootorder[i]);
898 utf8_utf16_strncpy(&p16, var_name, 9);
901 ret = EFI_CALL(efi_get_variable(var_name16,
902 &efi_global_variable_guid, NULL,
904 if (ret != EFI_BUFFER_TOO_SMALL) {
905 printf("%2d: %s: (not defined)\n", i + 1, var_name);
911 ret = CMD_RET_FAILURE;
914 ret = EFI_CALL(efi_get_variable(var_name16,
915 &efi_global_variable_guid, NULL,
917 if (ret != EFI_SUCCESS) {
919 ret = CMD_RET_FAILURE;
923 efi_deserialize_load_option(&lo, data);
925 label_len16 = u16_strlen(lo.label);
926 label_len = utf16_utf8_strnlen(lo.label, label_len16);
927 label = malloc(label_len + 1);
930 ret = CMD_RET_FAILURE;
934 utf16_utf8_strncpy(&p, lo.label, label_len16);
935 printf("%2d: %s: %s\n", i + 1, var_name, label);
947 * do_efi_boot_next() - manage UEFI BootNext variable
949 * @cmdtp: Command table
950 * @flag: Command flag
951 * @argc: Number of arguments
952 * @argv: Argument array
953 * Return: CMD_RET_SUCCESS on success,
954 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
956 * Implement efidebug "boot next" sub-command.
957 * Set BootNext variable.
959 * efidebug boot next <id>
961 static int do_efi_boot_next(struct cmd_tbl *cmdtp, int flag,
962 int argc, char *const argv[])
969 int r = CMD_RET_SUCCESS;
972 return CMD_RET_USAGE;
974 bootnext = (u16)simple_strtoul(argv[1], &endp, 16);
976 printf("invalid value: %s\n", argv[1]);
981 guid = efi_global_variable_guid;
983 ret = EFI_CALL(efi_set_variable(L"BootNext", &guid,
984 EFI_VARIABLE_NON_VOLATILE |
985 EFI_VARIABLE_BOOTSERVICE_ACCESS |
986 EFI_VARIABLE_RUNTIME_ACCESS,
988 if (ret != EFI_SUCCESS) {
989 printf("Cannot set BootNext\n");
997 * do_efi_boot_order() - manage UEFI BootOrder variable
999 * @cmdtp: Command table
1000 * @flag: Command flag
1001 * @argc: Number of arguments
1002 * @argv: Argument array
1003 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
1005 * Implement efidebug "boot order" sub-command.
1006 * Show order of UEFI load options, or change it in BootOrder variable.
1008 * efidebug boot order [<id> ...]
1010 static int do_efi_boot_order(struct cmd_tbl *cmdtp, int flag,
1011 int argc, char *const argv[])
1013 u16 *bootorder = NULL;
1019 int r = CMD_RET_SUCCESS;
1022 return show_efi_boot_order();
1027 size = argc * sizeof(u16);
1028 bootorder = malloc(size);
1030 return CMD_RET_FAILURE;
1032 for (i = 0; i < argc; i++) {
1033 id = (int)simple_strtoul(argv[i], &endp, 16);
1034 if (*endp != '\0' || id > 0xffff) {
1035 printf("invalid value: %s\n", argv[i]);
1036 r = CMD_RET_FAILURE;
1040 bootorder[i] = (u16)id;
1043 guid = efi_global_variable_guid;
1044 ret = EFI_CALL(efi_set_variable(L"BootOrder", &guid,
1045 EFI_VARIABLE_NON_VOLATILE |
1046 EFI_VARIABLE_BOOTSERVICE_ACCESS |
1047 EFI_VARIABLE_RUNTIME_ACCESS,
1049 if (ret != EFI_SUCCESS) {
1050 printf("Cannot set BootOrder\n");
1051 r = CMD_RET_FAILURE;
1059 static struct cmd_tbl cmd_efidebug_boot_sub[] = {
1060 U_BOOT_CMD_MKENT(add, CONFIG_SYS_MAXARGS, 1, do_efi_boot_add, "", ""),
1061 U_BOOT_CMD_MKENT(rm, CONFIG_SYS_MAXARGS, 1, do_efi_boot_rm, "", ""),
1062 U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_efi_boot_dump, "", ""),
1063 U_BOOT_CMD_MKENT(next, CONFIG_SYS_MAXARGS, 1, do_efi_boot_next, "", ""),
1064 U_BOOT_CMD_MKENT(order, CONFIG_SYS_MAXARGS, 1, do_efi_boot_order,
1069 * do_efi_boot_opt() - manage UEFI load options
1071 * @cmdtp: Command table
1072 * @flag: Command flag
1073 * @argc: Number of arguments
1074 * @argv: Argument array
1075 * Return: CMD_RET_SUCCESS on success,
1076 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1078 * Implement efidebug "boot" sub-command.
1080 static int do_efi_boot_opt(struct cmd_tbl *cmdtp, int flag,
1081 int argc, char *const argv[])
1086 return CMD_RET_USAGE;
1090 cp = find_cmd_tbl(argv[0], cmd_efidebug_boot_sub,
1091 ARRAY_SIZE(cmd_efidebug_boot_sub));
1093 return CMD_RET_USAGE;
1095 return cp->cmd(cmdtp, flag, argc, argv);
1099 * do_efi_test_bootmgr() - run simple bootmgr for test
1101 * @cmdtp: Command table
1102 * @flag: Command flag
1103 * @argc: Number of arguments
1104 * @argv: Argument array
1105 * Return: CMD_RET_SUCCESS on success,
1106 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1108 * Implement efidebug "test bootmgr" sub-command.
1109 * Run simple bootmgr for test.
1111 * efidebug test bootmgr
1113 static int do_efi_test_bootmgr(struct cmd_tbl *cmdtp, int flag,
1114 int argc, char * const argv[])
1117 efi_uintn_t exit_data_size = 0;
1118 u16 *exit_data = NULL;
1121 ret = efi_bootmgr_load(&image);
1122 printf("efi_bootmgr_load() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1124 /* We call efi_start_image() even if error for test purpose. */
1125 ret = EFI_CALL(efi_start_image(image, &exit_data_size, &exit_data));
1126 printf("efi_start_image() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1127 if (ret && exit_data)
1128 efi_free_pool(exit_data);
1132 return CMD_RET_SUCCESS;
1135 static struct cmd_tbl cmd_efidebug_test_sub[] = {
1136 U_BOOT_CMD_MKENT(bootmgr, CONFIG_SYS_MAXARGS, 1, do_efi_test_bootmgr,
1141 * do_efi_test() - manage UEFI load options
1143 * @cmdtp: Command table
1144 * @flag: Command flag
1145 * @argc: Number of arguments
1146 * @argv: Argument array
1147 * Return: CMD_RET_SUCCESS on success,
1148 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1150 * Implement efidebug "test" sub-command.
1152 static int do_efi_test(struct cmd_tbl *cmdtp, int flag,
1153 int argc, char * const argv[])
1158 return CMD_RET_USAGE;
1162 cp = find_cmd_tbl(argv[0], cmd_efidebug_test_sub,
1163 ARRAY_SIZE(cmd_efidebug_test_sub));
1165 return CMD_RET_USAGE;
1167 return cp->cmd(cmdtp, flag, argc, argv);
1171 * do_efi_query_info() - QueryVariableInfo EFI service
1173 * @cmdtp: Command table
1174 * @flag: Command flag
1175 * @argc: Number of arguments
1176 * @argv: Argument array
1177 * Return: CMD_RET_SUCCESS on success,
1178 * CMD_RET_USAGE or CMD_RET_FAILURE on failure
1180 * Implement efidebug "test" sub-command.
1183 static int do_efi_query_info(struct cmd_tbl *cmdtp, int flag,
1184 int argc, char * const argv[])
1188 u64 max_variable_storage_size;
1189 u64 remain_variable_storage_size;
1190 u64 max_variable_size;
1193 for (i = 1; i < argc; i++) {
1194 if (!strcmp(argv[i], "-bs"))
1195 attr |= EFI_VARIABLE_BOOTSERVICE_ACCESS;
1196 else if (!strcmp(argv[i], "-rt"))
1197 attr |= EFI_VARIABLE_RUNTIME_ACCESS;
1198 else if (!strcmp(argv[i], "-nv"))
1199 attr |= EFI_VARIABLE_NON_VOLATILE;
1200 else if (!strcmp(argv[i], "-at"))
1202 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
1205 ret = EFI_CALL(efi_query_variable_info(attr,
1206 &max_variable_storage_size,
1207 &remain_variable_storage_size,
1208 &max_variable_size));
1209 if (ret != EFI_SUCCESS) {
1210 printf("Error: Cannot query UEFI variables, r = %lu\n",
1211 ret & ~EFI_ERROR_MASK);
1212 return CMD_RET_FAILURE;
1215 printf("Max storage size %llu\n", max_variable_storage_size);
1216 printf("Remaining storage size %llu\n", remain_variable_storage_size);
1217 printf("Max variable size %llu\n", max_variable_size);
1219 return CMD_RET_SUCCESS;
1222 static struct cmd_tbl cmd_efidebug_sub[] = {
1223 U_BOOT_CMD_MKENT(boot, CONFIG_SYS_MAXARGS, 1, do_efi_boot_opt, "", ""),
1224 U_BOOT_CMD_MKENT(devices, CONFIG_SYS_MAXARGS, 1, do_efi_show_devices,
1226 U_BOOT_CMD_MKENT(drivers, CONFIG_SYS_MAXARGS, 1, do_efi_show_drivers,
1228 U_BOOT_CMD_MKENT(dh, CONFIG_SYS_MAXARGS, 1, do_efi_show_handles,
1230 U_BOOT_CMD_MKENT(images, CONFIG_SYS_MAXARGS, 1, do_efi_show_images,
1232 U_BOOT_CMD_MKENT(memmap, CONFIG_SYS_MAXARGS, 1, do_efi_show_memmap,
1234 U_BOOT_CMD_MKENT(tables, CONFIG_SYS_MAXARGS, 1, do_efi_show_tables,
1236 U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_efi_test,
1238 U_BOOT_CMD_MKENT(query, CONFIG_SYS_MAXARGS, 1, do_efi_query_info,
1243 * do_efidebug() - display and configure UEFI environment
1245 * @cmdtp: Command table
1246 * @flag: Command flag
1247 * @argc: Number of arguments
1248 * @argv: Argument array
1249 * Return: CMD_RET_SUCCESS on success,
1250 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1252 * Implement efidebug command which allows us to display and
1253 * configure UEFI environment.
1255 static int do_efidebug(struct cmd_tbl *cmdtp, int flag,
1256 int argc, char *const argv[])
1262 return CMD_RET_USAGE;
1266 /* Initialize UEFI drivers */
1267 r = efi_init_obj_list();
1268 if (r != EFI_SUCCESS) {
1269 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
1270 r & ~EFI_ERROR_MASK);
1271 return CMD_RET_FAILURE;
1274 cp = find_cmd_tbl(argv[0], cmd_efidebug_sub,
1275 ARRAY_SIZE(cmd_efidebug_sub));
1277 return CMD_RET_USAGE;
1279 return cp->cmd(cmdtp, flag, argc, argv);
1282 #ifdef CONFIG_SYS_LONGHELP
1283 static char efidebug_help_text[] =
1284 " - UEFI Shell-like interface to configure UEFI environment\n"
1286 "efidebug boot add <bootid> <label> <interface> <devnum>[:<part>] <file path> [<load options>]\n"
1287 " - set UEFI BootXXXX variable\n"
1288 " <load options> will be passed to UEFI application\n"
1289 "efidebug boot rm <bootid#1> [<bootid#2> [<bootid#3> [...]]]\n"
1290 " - delete UEFI BootXXXX variables\n"
1291 "efidebug boot dump\n"
1292 " - dump all UEFI BootXXXX variables\n"
1293 "efidebug boot next <bootid>\n"
1294 " - set UEFI BootNext variable\n"
1295 "efidebug boot order [<bootid#1> [<bootid#2> [<bootid#3> [...]]]]\n"
1296 " - set/show UEFI boot order\n"
1298 "efidebug devices\n"
1299 " - show UEFI devices\n"
1300 "efidebug drivers\n"
1301 " - show UEFI drivers\n"
1303 " - show UEFI handles\n"
1305 " - show loaded images\n"
1307 " - show UEFI memory map\n"
1309 " - show UEFI configuration tables\n"
1310 "efidebug test bootmgr\n"
1311 " - run simple bootmgr for test\n"
1312 "efidebug query [-nv][-bs][-rt][-at]\n"
1313 " - show size of UEFI variables store\n";
1317 efidebug, 10, 0, do_efidebug,
1318 "Configure UEFI environment",