Merge branch '2020-05-18-reduce-size-of-common.h'
[platform/kernel/u-boot.git] / 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 <exports.h>
13 #include <hexdump.h>
14 #include <log.h>
15 #include <malloc.h>
16 #include <mapmem.h>
17 #include <search.h>
18 #include <linux/ctype.h>
19
20 #define BS systab.boottime
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(struct cmd_tbl *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(efi_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_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(struct cmd_tbl *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(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;
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_free_pool(driver_name);
174                         efi_free_pool(image_path_text);
175                 }
176         }
177
178         efi_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                 "Load File2",
249                 EFI_LOAD_FILE2_PROTOCOL_GUID,
250         },
251         {
252                 "Simple Network",
253                 EFI_SIMPLE_NETWORK_PROTOCOL_GUID,
254         },
255         {
256                 "PXE Base Code",
257                 EFI_PXE_BASE_CODE_PROTOCOL_GUID,
258         },
259         /* Configuration table GUIDs */
260         {
261                 "ACPI table",
262                 EFI_ACPI_TABLE_GUID,
263         },
264         {
265                 "device tree",
266                 EFI_FDT_GUID,
267         },
268         {
269                 "SMBIOS table",
270                 SMBIOS_TABLE_GUID,
271         },
272         {
273                 "Runtime properties",
274                 EFI_RT_PROPERTIES_TABLE_GUID,
275         },
276 };
277
278 /**
279  * get_guid_text - get string of GUID
280  *
281  * Return description of GUID.
282  *
283  * @guid:       GUID
284  * Return:      description of GUID or NULL
285  */
286 static const char *get_guid_text(const void *guid)
287 {
288         int i;
289
290         for (i = 0; i < ARRAY_SIZE(guid_list); i++) {
291                 /*
292                  * As guidcmp uses memcmp() we can safely accept unaligned
293                  * GUIDs.
294                  */
295                 if (!guidcmp(&guid_list[i].guid, guid))
296                         return guid_list[i].text;
297         }
298
299         return NULL;
300 }
301
302 /**
303  * do_efi_show_handles() - show UEFI handles
304  *
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
310  *
311  * Implement efidebug "dh" sub-command.
312  * Show all UEFI handles and their information, currently all protocols
313  * added to handle.
314  */
315 static int do_efi_show_handles(struct cmd_tbl *cmdtp, int flag,
316                                int argc, char *const argv[])
317 {
318         efi_handle_t *handles;
319         efi_guid_t **guid;
320         efi_uintn_t num, count, i, j;
321         const char *guid_text;
322         efi_status_t ret;
323
324         ret = EFI_CALL(efi_locate_handle_buffer(ALL_HANDLES, NULL, NULL,
325                                                 &num, &handles));
326         if (ret != EFI_SUCCESS)
327                 return CMD_RET_FAILURE;
328
329         if (!num)
330                 return CMD_RET_SUCCESS;
331
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,
337                                                         &count));
338                 if (ret || !count) {
339                         putc('\n');
340                         continue;
341                 }
342
343                 for (j = 0; j < count; j++) {
344                         if (j)
345                                 printf(", ");
346                         else
347                                 putc(' ');
348
349                         guid_text = get_guid_text(guid[j]);
350                         if (guid_text)
351                                 puts(guid_text);
352                         else
353                                 printf("%pUl", guid[j]);
354                 }
355                 putc('\n');
356         }
357
358         efi_free_pool(handles);
359
360         return CMD_RET_SUCCESS;
361 }
362
363 /**
364  * do_efi_show_images() - show UEFI images
365  *
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
371  *
372  * Implement efidebug "images" sub-command.
373  * Show all UEFI loaded images and their information.
374  */
375 static int do_efi_show_images(struct cmd_tbl *cmdtp, int flag,
376                               int argc, char *const argv[])
377 {
378         efi_print_image_infos(NULL);
379
380         return CMD_RET_SUCCESS;
381 }
382
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",
399 };
400
401 static const struct efi_mem_attrs {
402         const u64 bit;
403         const char *text;
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"},
418 };
419
420 /**
421  * print_memory_attributes() - print memory map attributes
422  *
423  * @attributes: Attribute value
424  *
425  * Print memory map attributes
426  */
427 static void print_memory_attributes(u64 attributes)
428 {
429         int sep, i;
430
431         for (sep = 0, i = 0; i < ARRAY_SIZE(efi_mem_attrs); i++)
432                 if (attributes & efi_mem_attrs[i].bit) {
433                         if (sep) {
434                                 putc('|');
435                         } else {
436                                 putc(' ');
437                                 sep = 1;
438                         }
439                         puts(efi_mem_attrs[i].text);
440                 }
441 }
442
443 #define EFI_PHYS_ADDR_WIDTH (int)(sizeof(efi_physical_addr_t) * 2)
444
445 /**
446  * do_efi_show_memmap() - show UEFI memory map
447  *
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
453  *
454  * Implement efidebug "memmap" sub-command.
455  * Show UEFI memory map.
456  */
457 static int do_efi_show_memmap(struct cmd_tbl *cmdtp, int flag,
458                               int argc, char *const argv[])
459 {
460         struct efi_mem_desc *memmap = NULL, *map;
461         efi_uintn_t map_size = 0;
462         const char *type;
463         int i;
464         efi_status_t ret;
465
466         ret = efi_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_allocate_pool(EFI_LOADER_DATA, map_size,
470                                         (void *)&memmap);
471                 if (ret != EFI_SUCCESS)
472                         return CMD_RET_FAILURE;
473                 ret = efi_get_memory_map(&map_size, memmap, NULL, NULL, NULL);
474         }
475         if (ret != EFI_SUCCESS) {
476                 efi_free_pool(memmap);
477                 return CMD_RET_FAILURE;
478         }
479
480         printf("Type             Start%.*s End%.*s Attributes\n",
481                EFI_PHYS_ADDR_WIDTH - 5, spc, EFI_PHYS_ADDR_WIDTH - 3, spc);
482         printf("================ %.*s %.*s ==========\n",
483                EFI_PHYS_ADDR_WIDTH, sep, EFI_PHYS_ADDR_WIDTH, sep);
484         /*
485          * Coverity check: dereferencing null pointer "map."
486          * This is a false positive as memmap will always be
487          * populated by allocate_pool() above.
488          */
489         for (i = 0, map = memmap; i < map_size / sizeof(*map); map++, i++) {
490                 if (map->type < ARRAY_SIZE(efi_mem_type_string))
491                         type = efi_mem_type_string[map->type];
492                 else
493                         type = "(unknown)";
494
495                 printf("%-16s %.*llx-%.*llx", type,
496                        EFI_PHYS_ADDR_WIDTH,
497                        (u64)map_to_sysmem((void *)(uintptr_t)
498                                           map->physical_start),
499                        EFI_PHYS_ADDR_WIDTH,
500                        (u64)map_to_sysmem((void *)(uintptr_t)
501                                           (map->physical_start +
502                                            map->num_pages * EFI_PAGE_SIZE)));
503
504                 print_memory_attributes(map->attribute);
505                 putc('\n');
506         }
507
508         efi_free_pool(memmap);
509
510         return CMD_RET_SUCCESS;
511 }
512
513 /**
514  * do_efi_show_tables() - show UEFI configuration tables
515  *
516  * @cmdtp:      Command table
517  * @flag:       Command flag
518  * @argc:       Number of arguments
519  * @argv:       Argument array
520  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
521  *
522  * Implement efidebug "tables" sub-command.
523  * Show UEFI configuration tables.
524  */
525 static int do_efi_show_tables(struct cmd_tbl *cmdtp, int flag,
526                               int argc, char *const argv[])
527 {
528         efi_uintn_t i;
529         const char *guid_str;
530
531         for (i = 0; i < systab.nr_tables; ++i) {
532                 guid_str = get_guid_text(&systab.tables[i].guid);
533                 if (!guid_str)
534                         guid_str = "";
535                 printf("%pUl %s\n", &systab.tables[i].guid, guid_str);
536         }
537
538         return CMD_RET_SUCCESS;
539 }
540
541 /**
542  * do_efi_boot_add() - set UEFI load option
543  *
544  * @cmdtp:      Command table
545  * @flag:       Command flag
546  * @argc:       Number of arguments
547  * @argv:       Argument array
548  * Return:      CMD_RET_SUCCESS on success,
549  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
550  *
551  * Implement efidebug "boot add" sub-command. Create or change UEFI load option.
552  *
553  *     efidebug boot add <id> <label> <interface> <devnum>[:<part>] <file> <options>
554  */
555 static int do_efi_boot_add(struct cmd_tbl *cmdtp, int flag,
556                            int argc, char *const argv[])
557 {
558         int id;
559         char *endp;
560         char var_name[9];
561         u16 var_name16[9], *p;
562         efi_guid_t guid;
563         size_t label_len, label_len16;
564         u16 *label;
565         struct efi_device_path *device_path = NULL, *file_path = NULL;
566         struct efi_load_option lo;
567         void *data = NULL;
568         efi_uintn_t size;
569         efi_status_t ret;
570         int r = CMD_RET_SUCCESS;
571
572         if (argc < 6 || argc > 7)
573                 return CMD_RET_USAGE;
574
575         id = (int)simple_strtoul(argv[1], &endp, 16);
576         if (*endp != '\0' || id > 0xffff)
577                 return CMD_RET_USAGE;
578
579         sprintf(var_name, "Boot%04X", id);
580         p = var_name16;
581         utf8_utf16_strncpy(&p, var_name, 9);
582
583         guid = efi_global_variable_guid;
584
585         /* attributes */
586         lo.attributes = LOAD_OPTION_ACTIVE; /* always ACTIVE */
587
588         /* label */
589         label_len = strlen(argv[2]);
590         label_len16 = utf8_utf16_strnlen(argv[2], label_len);
591         label = malloc((label_len16 + 1) * sizeof(u16));
592         if (!label)
593                 return CMD_RET_FAILURE;
594         lo.label = label; /* label will be changed below */
595         utf8_utf16_strncpy(&label, argv[2], label_len);
596
597         /* file path */
598         ret = efi_dp_from_name(argv[3], argv[4], argv[5], &device_path,
599                                &file_path);
600         if (ret != EFI_SUCCESS) {
601                 printf("Cannot create device path for \"%s %s\"\n",
602                        argv[3], argv[4]);
603                 r = CMD_RET_FAILURE;
604                 goto out;
605         }
606         lo.file_path = file_path;
607         lo.file_path_length = efi_dp_size(file_path)
608                                 + sizeof(struct efi_device_path); /* for END */
609
610         /* optional data */
611         if (argc == 6)
612                 lo.optional_data = NULL;
613         else
614                 lo.optional_data = (const u8 *)argv[6];
615
616         size = efi_serialize_load_option(&lo, (u8 **)&data);
617         if (!size) {
618                 r = CMD_RET_FAILURE;
619                 goto out;
620         }
621
622         ret = EFI_CALL(efi_set_variable(var_name16, &guid,
623                                         EFI_VARIABLE_NON_VOLATILE |
624                                         EFI_VARIABLE_BOOTSERVICE_ACCESS |
625                                         EFI_VARIABLE_RUNTIME_ACCESS,
626                                         size, data));
627         if (ret != EFI_SUCCESS) {
628                 printf("Cannot set %ls\n", var_name16);
629                 r = CMD_RET_FAILURE;
630         }
631 out:
632         free(data);
633         efi_free_pool(device_path);
634         efi_free_pool(file_path);
635         free(lo.label);
636
637         return r;
638 }
639
640 /**
641  * do_efi_boot_rm() - delete UEFI load options
642  *
643  * @cmdtp:      Command table
644  * @flag:       Command flag
645  * @argc:       Number of arguments
646  * @argv:       Argument array
647  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
648  *
649  * Implement efidebug "boot rm" sub-command.
650  * Delete UEFI load options.
651  *
652  *     efidebug boot rm <id> ...
653  */
654 static int do_efi_boot_rm(struct cmd_tbl *cmdtp, int flag,
655                           int argc, char *const argv[])
656 {
657         efi_guid_t guid;
658         int id, i;
659         char *endp;
660         char var_name[9];
661         u16 var_name16[9], *p;
662         efi_status_t ret;
663
664         if (argc == 1)
665                 return CMD_RET_USAGE;
666
667         guid = efi_global_variable_guid;
668         for (i = 1; i < argc; i++, argv++) {
669                 id = (int)simple_strtoul(argv[1], &endp, 16);
670                 if (*endp != '\0' || id > 0xffff)
671                         return CMD_RET_FAILURE;
672
673                 sprintf(var_name, "Boot%04X", id);
674                 p = var_name16;
675                 utf8_utf16_strncpy(&p, var_name, 9);
676
677                 ret = EFI_CALL(efi_set_variable(var_name16, &guid, 0, 0, NULL));
678                 if (ret) {
679                         printf("Cannot remove %ls\n", var_name16);
680                         return CMD_RET_FAILURE;
681                 }
682         }
683
684         return CMD_RET_SUCCESS;
685 }
686
687 /**
688  * show_efi_boot_opt_data() - dump UEFI load option
689  *
690  * @varname16:  variable name
691  * @data:       value of UEFI load option variable
692  * @size:       size of the boot option
693  *
694  * Decode the value of UEFI load option variable and print information.
695  */
696 static void show_efi_boot_opt_data(u16 *varname16, void *data, size_t size)
697 {
698         struct efi_load_option lo;
699         char *label, *p;
700         size_t label_len16, label_len;
701         u16 *dp_str;
702
703         efi_deserialize_load_option(&lo, data);
704
705         label_len16 = u16_strlen(lo.label);
706         label_len = utf16_utf8_strnlen(lo.label, label_len16);
707         label = malloc(label_len + 1);
708         if (!label)
709                 return;
710         p = label;
711         utf16_utf8_strncpy(&p, lo.label, label_len16);
712
713         printf("%ls:\nattributes: %c%c%c (0x%08x)\n",
714                varname16,
715                /* ACTIVE */
716                lo.attributes & LOAD_OPTION_ACTIVE ? 'A' : '-',
717                /* FORCE RECONNECT */
718                lo.attributes & LOAD_OPTION_FORCE_RECONNECT ? 'R' : '-',
719                /* HIDDEN */
720                lo.attributes & LOAD_OPTION_HIDDEN ? 'H' : '-',
721                lo.attributes);
722         printf("  label: %s\n", label);
723
724         dp_str = efi_dp_str(lo.file_path);
725         printf("  file_path: %ls\n", dp_str);
726         efi_free_pool(dp_str);
727
728         printf("  data:\n");
729         print_hex_dump("    ", DUMP_PREFIX_OFFSET, 16, 1,
730                        lo.optional_data, size + (u8 *)data -
731                        (u8 *)lo.optional_data, true);
732         free(label);
733 }
734
735 /**
736  * show_efi_boot_opt() - dump UEFI load option
737  *
738  * @varname16:  variable name
739  *
740  * Dump information defined by UEFI load option.
741  */
742 static void show_efi_boot_opt(u16 *varname16)
743 {
744         void *data;
745         efi_uintn_t size;
746         efi_status_t ret;
747
748         size = 0;
749         ret = EFI_CALL(efi_get_variable(varname16, &efi_global_variable_guid,
750                                         NULL, &size, NULL));
751         if (ret == EFI_BUFFER_TOO_SMALL) {
752                 data = malloc(size);
753                 if (!data) {
754                         printf("ERROR: Out of memory\n");
755                         return;
756                 }
757                 ret = EFI_CALL(efi_get_variable(varname16,
758                                                 &efi_global_variable_guid,
759                                                 NULL, &size, data));
760                 if (ret == EFI_SUCCESS)
761                         show_efi_boot_opt_data(varname16, data, size);
762                 free(data);
763         }
764 }
765
766 static int u16_tohex(u16 c)
767 {
768         if (c >= '0' && c <= '9')
769                 return c - '0';
770         if (c >= 'A' && c <= 'F')
771                 return c - 'A' + 10;
772
773         /* not hexadecimal */
774         return -1;
775 }
776
777 /**
778  * show_efi_boot_dump() - dump all UEFI load options
779  *
780  * @cmdtp:      Command table
781  * @flag:       Command flag
782  * @argc:       Number of arguments
783  * @argv:       Argument array
784  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
785  *
786  * Implement efidebug "boot dump" sub-command.
787  * Dump information of all UEFI load options defined.
788  *
789  *     efidebug boot dump
790  */
791 static int do_efi_boot_dump(struct cmd_tbl *cmdtp, int flag,
792                             int argc, char *const argv[])
793 {
794         u16 *var_name16, *p;
795         efi_uintn_t buf_size, size;
796         efi_guid_t guid;
797         int id, i, digit;
798         efi_status_t ret;
799
800         if (argc > 1)
801                 return CMD_RET_USAGE;
802
803         buf_size = 128;
804         var_name16 = malloc(buf_size);
805         if (!var_name16)
806                 return CMD_RET_FAILURE;
807
808         var_name16[0] = 0;
809         for (;;) {
810                 size = buf_size;
811                 ret = EFI_CALL(efi_get_next_variable_name(&size, var_name16,
812                                                           &guid));
813                 if (ret == EFI_NOT_FOUND)
814                         break;
815                 if (ret == EFI_BUFFER_TOO_SMALL) {
816                         buf_size = size;
817                         p = realloc(var_name16, buf_size);
818                         if (!p) {
819                                 free(var_name16);
820                                 return CMD_RET_FAILURE;
821                         }
822                         var_name16 = p;
823                         ret = EFI_CALL(efi_get_next_variable_name(&size,
824                                                                   var_name16,
825                                                                   &guid));
826                 }
827                 if (ret != EFI_SUCCESS) {
828                         free(var_name16);
829                         return CMD_RET_FAILURE;
830                 }
831
832                 if (memcmp(var_name16, L"Boot", 8))
833                         continue;
834
835                 for (id = 0, i = 0; i < 4; i++) {
836                         digit = u16_tohex(var_name16[4 + i]);
837                         if (digit < 0)
838                                 break;
839                         id = (id << 4) + digit;
840                 }
841                 if (i == 4 && !var_name16[8])
842                         show_efi_boot_opt(var_name16);
843         }
844
845         free(var_name16);
846
847         return CMD_RET_SUCCESS;
848 }
849
850 /**
851  * show_efi_boot_order() - show order of UEFI load options
852  *
853  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
854  *
855  * Show order of UEFI load options defined by BootOrder variable.
856  */
857 static int show_efi_boot_order(void)
858 {
859         u16 *bootorder;
860         efi_uintn_t size;
861         int num, i;
862         char var_name[9];
863         u16 var_name16[9], *p16;
864         void *data;
865         struct efi_load_option lo;
866         char *label, *p;
867         size_t label_len16, label_len;
868         efi_status_t ret;
869
870         size = 0;
871         ret = EFI_CALL(efi_get_variable(L"BootOrder", &efi_global_variable_guid,
872                                         NULL, &size, NULL));
873         if (ret != EFI_BUFFER_TOO_SMALL) {
874                 if (ret == EFI_NOT_FOUND) {
875                         printf("BootOrder not defined\n");
876                         return CMD_RET_SUCCESS;
877                 } else {
878                         return CMD_RET_FAILURE;
879                 }
880         }
881         bootorder = malloc(size);
882         if (!bootorder) {
883                 printf("ERROR: Out of memory\n");
884                 return CMD_RET_FAILURE;
885         }
886         ret = EFI_CALL(efi_get_variable(L"BootOrder", &efi_global_variable_guid,
887                                         NULL, &size, bootorder));
888         if (ret != EFI_SUCCESS) {
889                 ret = CMD_RET_FAILURE;
890                 goto out;
891         }
892
893         num = size / sizeof(u16);
894         for (i = 0; i < num; i++) {
895                 sprintf(var_name, "Boot%04X", bootorder[i]);
896                 p16 = var_name16;
897                 utf8_utf16_strncpy(&p16, var_name, 9);
898
899                 size = 0;
900                 ret = EFI_CALL(efi_get_variable(var_name16,
901                                                 &efi_global_variable_guid, NULL,
902                                                 &size, NULL));
903                 if (ret != EFI_BUFFER_TOO_SMALL) {
904                         printf("%2d: %s: (not defined)\n", i + 1, var_name);
905                         continue;
906                 }
907
908                 data = malloc(size);
909                 if (!data) {
910                         ret = CMD_RET_FAILURE;
911                         goto out;
912                 }
913                 ret = EFI_CALL(efi_get_variable(var_name16,
914                                                 &efi_global_variable_guid, NULL,
915                                                 &size, data));
916                 if (ret != EFI_SUCCESS) {
917                         free(data);
918                         ret = CMD_RET_FAILURE;
919                         goto out;
920                 }
921
922                 efi_deserialize_load_option(&lo, data);
923
924                 label_len16 = u16_strlen(lo.label);
925                 label_len = utf16_utf8_strnlen(lo.label, label_len16);
926                 label = malloc(label_len + 1);
927                 if (!label) {
928                         free(data);
929                         ret = CMD_RET_FAILURE;
930                         goto out;
931                 }
932                 p = label;
933                 utf16_utf8_strncpy(&p, lo.label, label_len16);
934                 printf("%2d: %s: %s\n", i + 1, var_name, label);
935                 free(label);
936
937                 free(data);
938         }
939 out:
940         free(bootorder);
941
942         return ret;
943 }
944
945 /**
946  * do_efi_boot_next() - manage UEFI BootNext variable
947  *
948  * @cmdtp:      Command table
949  * @flag:       Command flag
950  * @argc:       Number of arguments
951  * @argv:       Argument array
952  * Return:      CMD_RET_SUCCESS on success,
953  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
954  *
955  * Implement efidebug "boot next" sub-command.
956  * Set BootNext variable.
957  *
958  *     efidebug boot next <id>
959  */
960 static int do_efi_boot_next(struct cmd_tbl *cmdtp, int flag,
961                             int argc, char *const argv[])
962 {
963         u16 bootnext;
964         efi_uintn_t size;
965         char *endp;
966         efi_guid_t guid;
967         efi_status_t ret;
968         int r = CMD_RET_SUCCESS;
969
970         if (argc != 2)
971                 return CMD_RET_USAGE;
972
973         bootnext = (u16)simple_strtoul(argv[1], &endp, 16);
974         if (*endp) {
975                 printf("invalid value: %s\n", argv[1]);
976                 r = CMD_RET_FAILURE;
977                 goto out;
978         }
979
980         guid = efi_global_variable_guid;
981         size = sizeof(u16);
982         ret = EFI_CALL(efi_set_variable(L"BootNext", &guid,
983                                         EFI_VARIABLE_NON_VOLATILE |
984                                         EFI_VARIABLE_BOOTSERVICE_ACCESS |
985                                         EFI_VARIABLE_RUNTIME_ACCESS,
986                                         size, &bootnext));
987         if (ret != EFI_SUCCESS) {
988                 printf("Cannot set BootNext\n");
989                 r = CMD_RET_FAILURE;
990         }
991 out:
992         return r;
993 }
994
995 /**
996  * do_efi_boot_order() - manage UEFI BootOrder variable
997  *
998  * @cmdtp:      Command table
999  * @flag:       Command flag
1000  * @argc:       Number of arguments
1001  * @argv:       Argument array
1002  * Return:      CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
1003  *
1004  * Implement efidebug "boot order" sub-command.
1005  * Show order of UEFI load options, or change it in BootOrder variable.
1006  *
1007  *     efidebug boot order [<id> ...]
1008  */
1009 static int do_efi_boot_order(struct cmd_tbl *cmdtp, int flag,
1010                              int argc, char *const argv[])
1011 {
1012         u16 *bootorder = NULL;
1013         efi_uintn_t size;
1014         int id, i;
1015         char *endp;
1016         efi_guid_t guid;
1017         efi_status_t ret;
1018         int r = CMD_RET_SUCCESS;
1019
1020         if (argc == 1)
1021                 return show_efi_boot_order();
1022
1023         argc--;
1024         argv++;
1025
1026         size = argc * sizeof(u16);
1027         bootorder = malloc(size);
1028         if (!bootorder)
1029                 return CMD_RET_FAILURE;
1030
1031         for (i = 0; i < argc; i++) {
1032                 id = (int)simple_strtoul(argv[i], &endp, 16);
1033                 if (*endp != '\0' || id > 0xffff) {
1034                         printf("invalid value: %s\n", argv[i]);
1035                         r = CMD_RET_FAILURE;
1036                         goto out;
1037                 }
1038
1039                 bootorder[i] = (u16)id;
1040         }
1041
1042         guid = efi_global_variable_guid;
1043         ret = EFI_CALL(efi_set_variable(L"BootOrder", &guid,
1044                                         EFI_VARIABLE_NON_VOLATILE |
1045                                         EFI_VARIABLE_BOOTSERVICE_ACCESS |
1046                                         EFI_VARIABLE_RUNTIME_ACCESS,
1047                                         size, bootorder));
1048         if (ret != EFI_SUCCESS) {
1049                 printf("Cannot set BootOrder\n");
1050                 r = CMD_RET_FAILURE;
1051         }
1052 out:
1053         free(bootorder);
1054
1055         return r;
1056 }
1057
1058 static struct cmd_tbl cmd_efidebug_boot_sub[] = {
1059         U_BOOT_CMD_MKENT(add, CONFIG_SYS_MAXARGS, 1, do_efi_boot_add, "", ""),
1060         U_BOOT_CMD_MKENT(rm, CONFIG_SYS_MAXARGS, 1, do_efi_boot_rm, "", ""),
1061         U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_efi_boot_dump, "", ""),
1062         U_BOOT_CMD_MKENT(next, CONFIG_SYS_MAXARGS, 1, do_efi_boot_next, "", ""),
1063         U_BOOT_CMD_MKENT(order, CONFIG_SYS_MAXARGS, 1, do_efi_boot_order,
1064                          "", ""),
1065 };
1066
1067 /**
1068  * do_efi_boot_opt() - manage UEFI load options
1069  *
1070  * @cmdtp:      Command table
1071  * @flag:       Command flag
1072  * @argc:       Number of arguments
1073  * @argv:       Argument array
1074  * Return:      CMD_RET_SUCCESS on success,
1075  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1076  *
1077  * Implement efidebug "boot" sub-command.
1078  */
1079 static int do_efi_boot_opt(struct cmd_tbl *cmdtp, int flag,
1080                            int argc, char *const argv[])
1081 {
1082         struct cmd_tbl *cp;
1083
1084         if (argc < 2)
1085                 return CMD_RET_USAGE;
1086
1087         argc--; argv++;
1088
1089         cp = find_cmd_tbl(argv[0], cmd_efidebug_boot_sub,
1090                           ARRAY_SIZE(cmd_efidebug_boot_sub));
1091         if (!cp)
1092                 return CMD_RET_USAGE;
1093
1094         return cp->cmd(cmdtp, flag, argc, argv);
1095 }
1096
1097 /**
1098  * do_efi_test_bootmgr() - run simple bootmgr for test
1099  *
1100  * @cmdtp:      Command table
1101  * @flag:       Command flag
1102  * @argc:       Number of arguments
1103  * @argv:       Argument array
1104  * Return:      CMD_RET_SUCCESS on success,
1105  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1106  *
1107  * Implement efidebug "test bootmgr" sub-command.
1108  * Run simple bootmgr for test.
1109  *
1110  *     efidebug test bootmgr
1111  */
1112 static int do_efi_test_bootmgr(struct cmd_tbl *cmdtp, int flag,
1113                                int argc, char * const argv[])
1114 {
1115         efi_handle_t image;
1116         efi_uintn_t exit_data_size = 0;
1117         u16 *exit_data = NULL;
1118         efi_status_t ret;
1119
1120         ret = efi_bootmgr_load(&image);
1121         printf("efi_bootmgr_load() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1122
1123         /* We call efi_start_image() even if error for test purpose. */
1124         ret = EFI_CALL(efi_start_image(image, &exit_data_size, &exit_data));
1125         printf("efi_start_image() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1126         if (ret && exit_data)
1127                 efi_free_pool(exit_data);
1128
1129         efi_restore_gd();
1130
1131         return CMD_RET_SUCCESS;
1132 }
1133
1134 static struct cmd_tbl cmd_efidebug_test_sub[] = {
1135         U_BOOT_CMD_MKENT(bootmgr, CONFIG_SYS_MAXARGS, 1, do_efi_test_bootmgr,
1136                          "", ""),
1137 };
1138
1139 /**
1140  * do_efi_test() - manage UEFI load options
1141  *
1142  * @cmdtp:      Command table
1143  * @flag:       Command flag
1144  * @argc:       Number of arguments
1145  * @argv:       Argument array
1146  * Return:      CMD_RET_SUCCESS on success,
1147  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1148  *
1149  * Implement efidebug "test" sub-command.
1150  */
1151 static int do_efi_test(struct cmd_tbl *cmdtp, int flag,
1152                        int argc, char * const argv[])
1153 {
1154         struct cmd_tbl *cp;
1155
1156         if (argc < 2)
1157                 return CMD_RET_USAGE;
1158
1159         argc--; argv++;
1160
1161         cp = find_cmd_tbl(argv[0], cmd_efidebug_test_sub,
1162                           ARRAY_SIZE(cmd_efidebug_test_sub));
1163         if (!cp)
1164                 return CMD_RET_USAGE;
1165
1166         return cp->cmd(cmdtp, flag, argc, argv);
1167 }
1168
1169 /**
1170  * do_efi_query_info() - QueryVariableInfo EFI service
1171  *
1172  * @cmdtp:      Command table
1173  * @flag:       Command flag
1174  * @argc:       Number of arguments
1175  * @argv:       Argument array
1176  * Return:      CMD_RET_SUCCESS on success,
1177  *              CMD_RET_USAGE or CMD_RET_FAILURE on failure
1178  *
1179  * Implement efidebug "test" sub-command.
1180  */
1181
1182 static int do_efi_query_info(struct cmd_tbl *cmdtp, int flag,
1183                              int argc, char * const argv[])
1184 {
1185         efi_status_t ret;
1186         u32 attr = 0;
1187         u64 max_variable_storage_size;
1188         u64 remain_variable_storage_size;
1189         u64 max_variable_size;
1190         int i;
1191
1192         for (i = 1; i < argc; i++) {
1193                 if (!strcmp(argv[i], "-bs"))
1194                         attr |= EFI_VARIABLE_BOOTSERVICE_ACCESS;
1195                 else if (!strcmp(argv[i], "-rt"))
1196                         attr |= EFI_VARIABLE_RUNTIME_ACCESS;
1197                 else if (!strcmp(argv[i], "-nv"))
1198                         attr |= EFI_VARIABLE_NON_VOLATILE;
1199                 else if (!strcmp(argv[i], "-at"))
1200                         attr |=
1201                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
1202         }
1203
1204         ret = EFI_CALL(efi_query_variable_info(attr,
1205                                                &max_variable_storage_size,
1206                                                &remain_variable_storage_size,
1207                                                &max_variable_size));
1208         if (ret != EFI_SUCCESS) {
1209                 printf("Error: Cannot query UEFI variables, r = %lu\n",
1210                        ret & ~EFI_ERROR_MASK);
1211                 return CMD_RET_FAILURE;
1212         }
1213
1214         printf("Max storage size %llu\n", max_variable_storage_size);
1215         printf("Remaining storage size %llu\n", remain_variable_storage_size);
1216         printf("Max variable size %llu\n", max_variable_size);
1217
1218         return CMD_RET_SUCCESS;
1219 }
1220
1221 static struct cmd_tbl cmd_efidebug_sub[] = {
1222         U_BOOT_CMD_MKENT(boot, CONFIG_SYS_MAXARGS, 1, do_efi_boot_opt, "", ""),
1223         U_BOOT_CMD_MKENT(devices, CONFIG_SYS_MAXARGS, 1, do_efi_show_devices,
1224                          "", ""),
1225         U_BOOT_CMD_MKENT(drivers, CONFIG_SYS_MAXARGS, 1, do_efi_show_drivers,
1226                          "", ""),
1227         U_BOOT_CMD_MKENT(dh, CONFIG_SYS_MAXARGS, 1, do_efi_show_handles,
1228                          "", ""),
1229         U_BOOT_CMD_MKENT(images, CONFIG_SYS_MAXARGS, 1, do_efi_show_images,
1230                          "", ""),
1231         U_BOOT_CMD_MKENT(memmap, CONFIG_SYS_MAXARGS, 1, do_efi_show_memmap,
1232                          "", ""),
1233         U_BOOT_CMD_MKENT(tables, CONFIG_SYS_MAXARGS, 1, do_efi_show_tables,
1234                          "", ""),
1235         U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_efi_test,
1236                          "", ""),
1237         U_BOOT_CMD_MKENT(query, CONFIG_SYS_MAXARGS, 1, do_efi_query_info,
1238                          "", ""),
1239 };
1240
1241 /**
1242  * do_efidebug() - display and configure UEFI environment
1243  *
1244  * @cmdtp:      Command table
1245  * @flag:       Command flag
1246  * @argc:       Number of arguments
1247  * @argv:       Argument array
1248  * Return:      CMD_RET_SUCCESS on success,
1249  *              CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1250  *
1251  * Implement efidebug command which allows us to display and
1252  * configure UEFI environment.
1253  */
1254 static int do_efidebug(struct cmd_tbl *cmdtp, int flag,
1255                        int argc, char *const argv[])
1256 {
1257         struct cmd_tbl *cp;
1258         efi_status_t r;
1259
1260         if (argc < 2)
1261                 return CMD_RET_USAGE;
1262
1263         argc--; argv++;
1264
1265         /* Initialize UEFI drivers */
1266         r = efi_init_obj_list();
1267         if (r != EFI_SUCCESS) {
1268                 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
1269                        r & ~EFI_ERROR_MASK);
1270                 return CMD_RET_FAILURE;
1271         }
1272
1273         cp = find_cmd_tbl(argv[0], cmd_efidebug_sub,
1274                           ARRAY_SIZE(cmd_efidebug_sub));
1275         if (!cp)
1276                 return CMD_RET_USAGE;
1277
1278         return cp->cmd(cmdtp, flag, argc, argv);
1279 }
1280
1281 #ifdef CONFIG_SYS_LONGHELP
1282 static char efidebug_help_text[] =
1283         "  - UEFI Shell-like interface to configure UEFI environment\n"
1284         "\n"
1285         "efidebug boot add <bootid> <label> <interface> <devnum>[:<part>] <file path> [<load options>]\n"
1286         "  - set UEFI BootXXXX variable\n"
1287         "    <load options> will be passed to UEFI application\n"
1288         "efidebug boot rm <bootid#1> [<bootid#2> [<bootid#3> [...]]]\n"
1289         "  - delete UEFI BootXXXX variables\n"
1290         "efidebug boot dump\n"
1291         "  - dump all UEFI BootXXXX variables\n"
1292         "efidebug boot next <bootid>\n"
1293         "  - set UEFI BootNext variable\n"
1294         "efidebug boot order [<bootid#1> [<bootid#2> [<bootid#3> [...]]]]\n"
1295         "  - set/show UEFI boot order\n"
1296         "\n"
1297         "efidebug devices\n"
1298         "  - show UEFI devices\n"
1299         "efidebug drivers\n"
1300         "  - show UEFI drivers\n"
1301         "efidebug dh\n"
1302         "  - show UEFI handles\n"
1303         "efidebug images\n"
1304         "  - show loaded images\n"
1305         "efidebug memmap\n"
1306         "  - show UEFI memory map\n"
1307         "efidebug tables\n"
1308         "  - show UEFI configuration tables\n"
1309         "efidebug test bootmgr\n"
1310         "  - run simple bootmgr for test\n"
1311         "efidebug query [-nv][-bs][-rt][-at]\n"
1312         "  - show size of UEFI variables store\n";
1313 #endif
1314
1315 U_BOOT_CMD(
1316         efidebug, 10, 0, do_efidebug,
1317         "Configure UEFI environment",
1318         efidebug_help_text
1319 );