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>
12 #include <environment.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_SIMPLE_NETWORK_PROTOCOL_GUID,
253 EFI_PXE_BASE_CODE_PROTOCOL_GUID,
258 * get_guid_text - get string of protocol guid
259 * @guid: Protocol guid
262 * Return string for display to represent the protocol.
264 static const char *get_guid_text(const efi_guid_t *guid)
268 for (i = 0; i < ARRAY_SIZE(guid_list); i++)
269 if (!guidcmp(&guid_list[i].guid, guid))
272 if (i != ARRAY_SIZE(guid_list))
273 return guid_list[i].text;
279 * do_efi_show_handles() - show UEFI handles
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
287 * Implement efidebug "dh" sub-command.
288 * Show all UEFI handles and their information, currently all protocols
291 static int do_efi_show_handles(cmd_tbl_t *cmdtp, int flag,
292 int argc, char * const argv[])
294 efi_handle_t *handles;
296 efi_uintn_t num, count, i, j;
297 const char *guid_text;
300 ret = EFI_CALL(BS->locate_handle_buffer(ALL_HANDLES, NULL, NULL,
302 if (ret != EFI_SUCCESS)
303 return CMD_RET_FAILURE;
306 return CMD_RET_SUCCESS;
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,
319 for (j = 0; j < count; j++) {
325 guid_text = get_guid_text(guid[j]);
329 printf("%pUl", guid[j]);
334 EFI_CALL(BS->free_pool(handles));
336 return CMD_RET_SUCCESS;
340 * do_efi_show_images() - show UEFI images
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
348 * Implement efidebug "images" sub-command.
349 * Show all UEFI loaded images and their information.
351 static int do_efi_show_images(cmd_tbl_t *cmdtp, int flag,
352 int argc, char * const argv[])
354 efi_print_image_infos(NULL);
356 return CMD_RET_SUCCESS;
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",
376 static const struct efi_mem_attrs {
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"},
396 * print_memory_attributes() - print memory map attributes
397 * @attributes: Attribute value
399 * Print memory map attributes
401 static void print_memory_attributes(u64 attributes)
405 for (sep = 0, i = 0; i < ARRAY_SIZE(efi_mem_attrs); i++)
406 if (attributes & efi_mem_attrs[i].bit) {
413 puts(efi_mem_attrs[i].text);
417 #define EFI_PHYS_ADDR_WIDTH (int)(sizeof(efi_physical_addr_t) * 2)
420 * do_efi_show_memmap() - show UEFI memory map
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
428 * Implement efidebug "memmap" sub-command.
429 * Show UEFI memory map.
431 static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
432 int argc, char * const argv[])
434 struct efi_mem_desc *memmap = NULL, *map;
435 efi_uintn_t map_size = 0;
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,
450 if (ret != EFI_SUCCESS) {
451 EFI_CALL(BS->free_pool(memmap));
452 return CMD_RET_FAILURE;
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];
465 printf("%-16s %.*llx-%.*llx", type,
469 map->physical_start + map->num_pages * EFI_PAGE_SIZE);
471 print_memory_attributes(map->attribute);
475 EFI_CALL(BS->free_pool(memmap));
477 return CMD_RET_SUCCESS;
481 * do_efi_boot_add() - set UEFI load option
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
490 * Implement efidebug "boot add" sub-command.
491 * Create or change UEFI load option.
492 * - boot add <id> <label> <interface> <devnum>[:<part>] <file> <options>
494 static int do_efi_boot_add(cmd_tbl_t *cmdtp, int flag,
495 int argc, char * const argv[])
500 u16 var_name16[9], *p;
502 size_t label_len, label_len16;
504 struct efi_device_path *device_path = NULL, *file_path = NULL;
505 struct efi_load_option lo;
510 if (argc < 6 || argc > 7)
511 return CMD_RET_USAGE;
513 id = (int)simple_strtoul(argv[1], &endp, 16);
514 if (*endp != '\0' || id > 0xffff)
515 return CMD_RET_USAGE;
517 sprintf(var_name, "Boot%04X", id);
519 utf8_utf16_strncpy(&p, var_name, 9);
521 guid = efi_global_variable_guid;
524 lo.attributes = LOAD_OPTION_ACTIVE; /* always ACTIVE */
527 label_len = strlen(argv[2]);
528 label_len16 = utf8_utf16_strnlen(argv[2], label_len);
529 label = malloc((label_len16 + 1) * sizeof(u16));
531 return CMD_RET_FAILURE;
532 lo.label = label; /* label will be changed below */
533 utf8_utf16_strncpy(&label, argv[2], label_len);
536 ret = efi_dp_from_name(argv[3], argv[4], argv[5], &device_path,
538 if (ret != EFI_SUCCESS) {
539 printf("Cannot create device path for \"%s %s\"\n",
541 ret = CMD_RET_FAILURE;
544 lo.file_path = file_path;
545 lo.file_path_length = efi_dp_size(file_path)
546 + sizeof(struct efi_device_path); /* for END */
550 lo.optional_data = NULL;
552 lo.optional_data = (const u8 *)argv[6];
554 size = efi_serialize_load_option(&lo, (u8 **)&data);
556 ret = CMD_RET_FAILURE;
560 ret = EFI_CALL(RT->set_variable(var_name16, &guid,
561 EFI_VARIABLE_NON_VOLATILE |
562 EFI_VARIABLE_BOOTSERVICE_ACCESS |
563 EFI_VARIABLE_RUNTIME_ACCESS,
565 ret = (ret == EFI_SUCCESS ? CMD_RET_SUCCESS : CMD_RET_FAILURE);
568 efi_free_pool(device_path);
569 efi_free_pool(file_path);
576 * do_efi_boot_rm() - delete UEFI load options
578 * @cmdtp: Command table
579 * @flag: Command flag
580 * @argc: Number of arguments
581 * @argv: Argument array
582 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
584 * Implement efidebug "boot rm" sub-command.
585 * Delete UEFI load options.
588 static int do_efi_boot_rm(cmd_tbl_t *cmdtp, int flag,
589 int argc, char * const argv[])
599 return CMD_RET_USAGE;
601 guid = efi_global_variable_guid;
602 for (i = 1; i < argc; i++, argv++) {
603 id = (int)simple_strtoul(argv[1], &endp, 16);
604 if (*endp != '\0' || id > 0xffff)
605 return CMD_RET_FAILURE;
607 sprintf(var_name, "Boot%04X", id);
608 utf8_utf16_strncpy((u16 **)&var_name16, var_name, 9);
610 ret = EFI_CALL(RT->set_variable(var_name16, &guid, 0, 0, NULL));
612 printf("cannot remove Boot%04X", id);
613 return CMD_RET_FAILURE;
617 return CMD_RET_SUCCESS;
621 * show_efi_boot_opt_data() - dump UEFI load option
623 * @id: load option number
624 * @data: value of UEFI load option variable
625 * @size: size of the boot option
627 * Decode the value of UEFI load option variable and print information.
629 static void show_efi_boot_opt_data(int id, void *data, size_t size)
631 struct efi_load_option lo;
633 size_t label_len16, label_len;
636 efi_deserialize_load_option(&lo, data);
638 label_len16 = u16_strlen(lo.label);
639 label_len = utf16_utf8_strnlen(lo.label, label_len16);
640 label = malloc(label_len + 1);
644 utf16_utf8_strncpy(&p, lo.label, label_len16);
646 printf("Boot%04X:\n", id);
647 printf(" attributes: %c%c%c (0x%08x)\n",
649 lo.attributes & LOAD_OPTION_ACTIVE ? 'A' : '-',
650 /* FORCE RECONNECT */
651 lo.attributes & LOAD_OPTION_FORCE_RECONNECT ? 'R' : '-',
653 lo.attributes & LOAD_OPTION_HIDDEN ? 'H' : '-',
655 printf(" label: %s\n", label);
657 dp_str = efi_dp_str(lo.file_path);
658 printf(" file_path: %ls\n", dp_str);
659 efi_free_pool(dp_str);
662 print_hex_dump(" ", DUMP_PREFIX_OFFSET, 16, 1,
663 lo.optional_data, size + (u8 *)data -
664 (u8 *)lo.optional_data, true);
669 * show_efi_boot_opt() - dump UEFI load option
671 * @id: Load option number
673 * Dump information defined by UEFI load option.
675 static void show_efi_boot_opt(int id)
678 u16 var_name16[9], *p;
684 sprintf(var_name, "Boot%04X", id);
686 utf8_utf16_strncpy(&p, var_name, 9);
687 guid = efi_global_variable_guid;
690 ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size, NULL));
691 if (ret == (int)EFI_BUFFER_TOO_SMALL) {
693 ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size,
696 if (ret == EFI_SUCCESS)
697 show_efi_boot_opt_data(id, data, size);
698 else if (ret == EFI_NOT_FOUND)
699 printf("Boot%04X: not found\n", id);
704 static int u16_tohex(u16 c)
706 if (c >= '0' && c <= '9')
708 if (c >= 'A' && c <= 'F')
711 /* not hexadecimal */
716 * show_efi_boot_dump() - dump all UEFI load options
718 * @cmdtp: Command table
719 * @flag: Command flag
720 * @argc: Number of arguments
721 * @argv: Argument array
722 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
724 * Implement efidebug "boot dump" sub-command.
725 * Dump information of all UEFI load options defined.
728 static int do_efi_boot_dump(cmd_tbl_t *cmdtp, int flag,
729 int argc, char * const argv[])
732 efi_uintn_t buf_size, size;
738 return CMD_RET_USAGE;
741 var_name16 = malloc(buf_size);
743 return CMD_RET_FAILURE;
748 ret = EFI_CALL(efi_get_next_variable_name(&size, var_name16,
750 if (ret == EFI_NOT_FOUND)
752 if (ret == EFI_BUFFER_TOO_SMALL) {
754 p = realloc(var_name16, buf_size);
757 return CMD_RET_FAILURE;
760 ret = EFI_CALL(efi_get_next_variable_name(&size,
764 if (ret != EFI_SUCCESS) {
766 return CMD_RET_FAILURE;
769 if (memcmp(var_name16, L"Boot", 8))
772 for (id = 0, i = 0; i < 4; i++) {
773 digit = u16_tohex(var_name16[4 + i]);
776 id = (id << 4) + digit;
778 if (i == 4 && !var_name16[8])
779 show_efi_boot_opt(id);
784 return CMD_RET_SUCCESS;
788 * show_efi_boot_order() - show order of UEFI load options
790 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
792 * Show order of UEFI load options defined by BootOrder variable.
794 static int show_efi_boot_order(void)
797 u16 *bootorder = NULL;
801 u16 var_name16[9], *p16;
803 struct efi_load_option lo;
805 size_t label_len16, label_len;
808 guid = efi_global_variable_guid;
810 ret = EFI_CALL(RT->get_variable(L"BootOrder", &guid, NULL, &size,
812 if (ret == EFI_BUFFER_TOO_SMALL) {
813 bootorder = malloc(size);
814 ret = EFI_CALL(RT->get_variable(L"BootOrder", &guid, NULL,
817 if (ret == EFI_NOT_FOUND) {
818 printf("BootOrder not defined\n");
819 ret = CMD_RET_SUCCESS;
821 } else if (ret != EFI_SUCCESS) {
822 ret = CMD_RET_FAILURE;
826 num = size / sizeof(u16);
827 for (i = 0; i < num; i++) {
828 sprintf(var_name, "Boot%04X", bootorder[i]);
830 utf8_utf16_strncpy(&p16, var_name, 9);
833 ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size,
835 if (ret != EFI_BUFFER_TOO_SMALL) {
836 printf("%2d: Boot%04X: (not defined)\n",
837 i + 1, bootorder[i]);
843 ret = CMD_RET_FAILURE;
846 ret = EFI_CALL(RT->get_variable(var_name16, &guid, NULL, &size,
848 if (ret != EFI_SUCCESS) {
850 ret = CMD_RET_FAILURE;
854 efi_deserialize_load_option(&lo, data);
856 label_len16 = u16_strlen(lo.label);
857 label_len = utf16_utf8_strnlen(lo.label, label_len16);
858 label = malloc(label_len + 1);
861 ret = CMD_RET_FAILURE;
865 utf16_utf8_strncpy(&p, lo.label, label_len16);
866 printf("%2d: Boot%04X: %s\n", i + 1, bootorder[i], label);
878 * do_efi_boot_next() - manage UEFI BootNext variable
880 * @cmdtp: Command table
881 * @flag: Command flag
882 * @argc: Number of arguments
883 * @argv: Argument array
884 * Return: CMD_RET_SUCCESS on success,
885 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
887 * Implement efidebug "boot next" sub-command.
888 * Set BootNext variable.
891 static int do_efi_boot_next(cmd_tbl_t *cmdtp, int flag,
892 int argc, char * const argv[])
901 return CMD_RET_USAGE;
903 bootnext = (u16)simple_strtoul(argv[1], &endp, 16);
904 if (*endp != '\0' || bootnext > 0xffff) {
905 printf("invalid value: %s\n", argv[1]);
906 ret = CMD_RET_FAILURE;
910 guid = efi_global_variable_guid;
912 ret = EFI_CALL(RT->set_variable(L"BootNext", &guid,
913 EFI_VARIABLE_NON_VOLATILE |
914 EFI_VARIABLE_BOOTSERVICE_ACCESS |
915 EFI_VARIABLE_RUNTIME_ACCESS,
917 ret = (ret == EFI_SUCCESS ? CMD_RET_SUCCESS : CMD_RET_FAILURE);
923 * do_efi_boot_order() - manage UEFI BootOrder variable
925 * @cmdtp: Command table
926 * @flag: Command flag
927 * @argc: Number of arguments
928 * @argv: Argument array
929 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
931 * Implement efidebug "boot order" sub-command.
932 * Show order of UEFI load options, or change it in BootOrder variable.
933 * - boot order [<id> ...]
935 static int do_efi_boot_order(cmd_tbl_t *cmdtp, int flag,
936 int argc, char * const argv[])
938 u16 *bootorder = NULL;
946 return show_efi_boot_order();
951 size = argc * sizeof(u16);
952 bootorder = malloc(size);
954 return CMD_RET_FAILURE;
956 for (i = 0; i < argc; i++) {
957 id = (int)simple_strtoul(argv[i], &endp, 16);
958 if (*endp != '\0' || id > 0xffff) {
959 printf("invalid value: %s\n", argv[i]);
960 ret = CMD_RET_FAILURE;
964 bootorder[i] = (u16)id;
967 guid = efi_global_variable_guid;
968 ret = EFI_CALL(RT->set_variable(L"BootOrder", &guid,
969 EFI_VARIABLE_NON_VOLATILE |
970 EFI_VARIABLE_BOOTSERVICE_ACCESS |
971 EFI_VARIABLE_RUNTIME_ACCESS,
973 ret = (ret == EFI_SUCCESS ? CMD_RET_SUCCESS : CMD_RET_FAILURE);
980 static cmd_tbl_t cmd_efidebug_boot_sub[] = {
981 U_BOOT_CMD_MKENT(add, CONFIG_SYS_MAXARGS, 1, do_efi_boot_add, "", ""),
982 U_BOOT_CMD_MKENT(rm, CONFIG_SYS_MAXARGS, 1, do_efi_boot_rm, "", ""),
983 U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_efi_boot_dump, "", ""),
984 U_BOOT_CMD_MKENT(next, CONFIG_SYS_MAXARGS, 1, do_efi_boot_next, "", ""),
985 U_BOOT_CMD_MKENT(order, CONFIG_SYS_MAXARGS, 1, do_efi_boot_order,
990 * do_efi_boot_opt() - manage UEFI load options
992 * @cmdtp: Command table
993 * @flag: Command flag
994 * @argc: Number of arguments
995 * @argv: Argument array
996 * Return: CMD_RET_SUCCESS on success,
997 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
999 * Implement efidebug "boot" sub-command.
1000 * See above for details of sub-commands.
1002 static int do_efi_boot_opt(cmd_tbl_t *cmdtp, int flag,
1003 int argc, char * const argv[])
1008 return CMD_RET_USAGE;
1012 cp = find_cmd_tbl(argv[0], cmd_efidebug_boot_sub,
1013 ARRAY_SIZE(cmd_efidebug_boot_sub));
1015 return CMD_RET_USAGE;
1017 return cp->cmd(cmdtp, flag, argc, argv);
1020 static cmd_tbl_t cmd_efidebug_sub[] = {
1021 U_BOOT_CMD_MKENT(boot, CONFIG_SYS_MAXARGS, 1, do_efi_boot_opt, "", ""),
1022 U_BOOT_CMD_MKENT(devices, CONFIG_SYS_MAXARGS, 1, do_efi_show_devices,
1024 U_BOOT_CMD_MKENT(drivers, CONFIG_SYS_MAXARGS, 1, do_efi_show_drivers,
1026 U_BOOT_CMD_MKENT(dh, CONFIG_SYS_MAXARGS, 1, do_efi_show_handles,
1028 U_BOOT_CMD_MKENT(images, CONFIG_SYS_MAXARGS, 1, do_efi_show_images,
1030 U_BOOT_CMD_MKENT(memmap, CONFIG_SYS_MAXARGS, 1, do_efi_show_memmap,
1035 * do_efidebug() - display and configure UEFI environment
1037 * @cmdtp: Command table
1038 * @flag: Command flag
1039 * @argc: Number of arguments
1040 * @argv: Argument array
1041 * Return: CMD_RET_SUCCESS on success,
1042 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1044 * Implement efidebug command which allows us to display and
1045 * configure UEFI environment.
1046 * See above for details of sub-commands.
1048 static int do_efidebug(cmd_tbl_t *cmdtp, int flag,
1049 int argc, char * const argv[])
1055 return CMD_RET_USAGE;
1059 /* Initialize UEFI drivers */
1060 r = efi_init_obj_list();
1061 if (r != EFI_SUCCESS) {
1062 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
1063 r & ~EFI_ERROR_MASK);
1064 return CMD_RET_FAILURE;
1067 cp = find_cmd_tbl(argv[0], cmd_efidebug_sub,
1068 ARRAY_SIZE(cmd_efidebug_sub));
1070 return CMD_RET_USAGE;
1072 return cp->cmd(cmdtp, flag, argc, argv);
1075 #ifdef CONFIG_SYS_LONGHELP
1076 static char efidebug_help_text[] =
1077 " - UEFI Shell-like interface to configure UEFI environment\n"
1079 "efidebug boot add <bootid> <label> <interface> <devnum>[:<part>] <file path> [<load options>]\n"
1080 " - set UEFI BootXXXX variable\n"
1081 " <load options> will be passed to UEFI application\n"
1082 "efidebug boot rm <bootid#1> [<bootid#2> [<bootid#3> [...]]]\n"
1083 " - delete UEFI BootXXXX variables\n"
1084 "efidebug boot dump\n"
1085 " - dump all UEFI BootXXXX variables\n"
1086 "efidebug boot next <bootid>\n"
1087 " - set UEFI BootNext variable\n"
1088 "efidebug boot order [<bootid#1> [<bootid#2> [<bootid#3> [...]]]]\n"
1089 " - set/show UEFI boot order\n"
1091 "efidebug devices\n"
1092 " - show uefi devices\n"
1093 "efidebug drivers\n"
1094 " - show uefi drivers\n"
1096 " - show uefi handles\n"
1098 " - show loaded images\n"
1100 " - show uefi memory map\n";
1104 efidebug, 10, 0, do_efidebug,
1105 "Configure UEFI environment",