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 <dm/device.h>
12 #include <efi_dt_fixup.h>
13 #include <efi_load_initrd.h>
14 #include <efi_loader.h>
15 #include <efi_rng.h>
16 #include <efi_variable.h>
17 #include <exports.h>
18 #include <hexdump.h>
19 #include <log.h>
20 #include <malloc.h>
21 #include <mapmem.h>
22 #include <part.h>
23 #include <search.h>
24 #include <linux/ctype.h>
25 #include <linux/err.h>
26
27 #define BS systab.boottime
28
29 #ifdef CONFIG_EFI_HAVE_CAPSULE_SUPPORT
30 /**
31 * do_efi_capsule_update() - process a capsule update
32 *
33 * @cmdtp: Command table
34 * @flag: Command flag
35 * @argc: Number of arguments
36 * @argv: Argument array
37 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
38 *
39 * Implement efidebug "capsule update" sub-command.
40 * process a capsule update.
41 *
42 * efidebug capsule update [-v] <capsule address>
43 */
do_efi_capsule_update(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])44 static int do_efi_capsule_update(struct cmd_tbl *cmdtp, int flag,
45 int argc, char * const argv[])
46 {
47 struct efi_capsule_header *capsule;
48 int verbose = 0;
49 char *endp;
50 efi_status_t ret;
51
52 if (argc != 2 && argc != 3)
53 return CMD_RET_USAGE;
54
55 if (argc == 3) {
56 if (strcmp(argv[1], "-v"))
57 return CMD_RET_USAGE;
58
59 verbose = 1;
60 argc--;
61 argv++;
62 }
63
64 capsule = (typeof(capsule))hextoul(argv[1], &endp);
65 if (endp == argv[1]) {
66 printf("Invalid address: %s", argv[1]);
67 return CMD_RET_FAILURE;
68 }
69
70 if (verbose) {
71 printf("Capsule guid: %pUl\n", &capsule->capsule_guid);
72 printf("Capsule flags: 0x%x\n", capsule->flags);
73 printf("Capsule header size: 0x%x\n", capsule->header_size);
74 printf("Capsule image size: 0x%x\n",
75 capsule->capsule_image_size);
76 }
77
78 ret = EFI_CALL(efi_update_capsule(&capsule, 1, 0));
79 if (ret) {
80 printf("Cannot handle a capsule at %p\n", capsule);
81 return CMD_RET_FAILURE;
82 }
83
84 return CMD_RET_SUCCESS;
85 }
86
87 #ifdef CONFIG_EFI_CAPSULE_ON_DISK
do_efi_capsule_on_disk_update(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])88 static int do_efi_capsule_on_disk_update(struct cmd_tbl *cmdtp, int flag,
89 int argc, char * const argv[])
90 {
91 efi_status_t ret;
92
93 ret = efi_launch_capsules();
94
95 return ret == EFI_SUCCESS ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
96 }
97 #endif
98
99 /**
100 * do_efi_capsule_show() - show capsule information
101 *
102 * @cmdtp: Command table
103 * @flag: Command flag
104 * @argc: Number of arguments
105 * @argv: Argument array
106 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
107 *
108 * Implement efidebug "capsule show" sub-command.
109 * show capsule information.
110 *
111 * efidebug capsule show <capsule address>
112 */
do_efi_capsule_show(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])113 static int do_efi_capsule_show(struct cmd_tbl *cmdtp, int flag,
114 int argc, char * const argv[])
115 {
116 struct efi_capsule_header *capsule;
117 char *endp;
118
119 if (argc != 2)
120 return CMD_RET_USAGE;
121
122 capsule = (typeof(capsule))hextoul(argv[1], &endp);
123 if (endp == argv[1]) {
124 printf("Invalid address: %s", argv[1]);
125 return CMD_RET_FAILURE;
126 }
127
128 printf("Capsule guid: %pUl\n", &capsule->capsule_guid);
129 printf("Capsule flags: 0x%x\n", capsule->flags);
130 printf("Capsule header size: 0x%x\n", capsule->header_size);
131 printf("Capsule image size: 0x%x\n",
132 capsule->capsule_image_size);
133
134 return CMD_RET_SUCCESS;
135 }
136
137 #ifdef CONFIG_EFI_ESRT
138
139 #define EFI_ESRT_FW_TYPE_NUM 4
140 char *efi_fw_type_str[EFI_ESRT_FW_TYPE_NUM] = {"unknown", "system FW", "device FW",
141 "UEFI driver"};
142
143 #define EFI_ESRT_UPDATE_STATUS_NUM 9
144 char *efi_update_status_str[EFI_ESRT_UPDATE_STATUS_NUM] = {"success", "unsuccessful",
145 "insufficient resources", "incorrect version", "invalid format",
146 "auth error", "power event (AC)", "power event (batt)",
147 "unsatisfied dependencies"};
148
149 #define EFI_FW_TYPE_STR_GET(idx) (\
150 EFI_ESRT_FW_TYPE_NUM > (idx) ? efi_fw_type_str[(idx)] : "error"\
151 )
152
153 #define EFI_FW_STATUS_STR_GET(idx) (\
154 EFI_ESRT_UPDATE_STATUS_NUM > (idx) ? efi_update_status_str[(idx)] : "error"\
155 )
156
157 /**
158 * do_efi_capsule_esrt() - manage UEFI capsules
159 *
160 * @cmdtp: Command table
161 * @flag: Command flag
162 * @argc: Number of arguments
163 * @argv: Argument array
164 * Return: CMD_RET_SUCCESS on success,
165 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
166 *
167 * Implement efidebug "capsule esrt" sub-command.
168 * The prints the current ESRT table.
169 *
170 * efidebug capsule esrt
171 */
do_efi_capsule_esrt(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])172 static int do_efi_capsule_esrt(struct cmd_tbl *cmdtp, int flag,
173 int argc, char * const argv[])
174 {
175 struct efi_system_resource_table *esrt = NULL;
176
177 if (argc != 1)
178 return CMD_RET_USAGE;
179
180 for (int idx = 0; idx < systab.nr_tables; idx++)
181 if (!guidcmp(&efi_esrt_guid, &systab.tables[idx].guid))
182 esrt = (struct efi_system_resource_table *)systab.tables[idx].table;
183
184 if (!esrt) {
185 log_info("ESRT: table not present\n");
186 return CMD_RET_SUCCESS;
187 }
188
189 printf("========================================\n");
190 printf("ESRT: fw_resource_count=%d\n", esrt->fw_resource_count);
191 printf("ESRT: fw_resource_count_max=%d\n", esrt->fw_resource_count_max);
192 printf("ESRT: fw_resource_version=%lld\n", esrt->fw_resource_version);
193
194 for (int idx = 0; idx < esrt->fw_resource_count; idx++) {
195 printf("[entry %d]==============================\n", idx);
196 printf("ESRT: fw_class=%pUL\n", &esrt->entries[idx].fw_class);
197 printf("ESRT: fw_type=%s\n", EFI_FW_TYPE_STR_GET(esrt->entries[idx].fw_type));
198 printf("ESRT: fw_version=%d\n", esrt->entries[idx].fw_version);
199 printf("ESRT: lowest_supported_fw_version=%d\n",
200 esrt->entries[idx].lowest_supported_fw_version);
201 printf("ESRT: capsule_flags=%d\n",
202 esrt->entries[idx].capsule_flags);
203 printf("ESRT: last_attempt_version=%d\n",
204 esrt->entries[idx].last_attempt_version);
205 printf("ESRT: last_attempt_status=%s\n",
206 EFI_FW_STATUS_STR_GET(esrt->entries[idx].last_attempt_status));
207 }
208 printf("========================================\n");
209
210 return CMD_RET_SUCCESS;
211 }
212 #endif /* CONFIG_EFI_ESRT */
213 /**
214 * do_efi_capsule_res() - show a capsule update result
215 *
216 * @cmdtp: Command table
217 * @flag: Command flag
218 * @argc: Number of arguments
219 * @argv: Argument array
220 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
221 *
222 * Implement efidebug "capsule result" sub-command.
223 * show a capsule update result.
224 * If result number is not specified, CapsuleLast will be shown.
225 *
226 * efidebug capsule result [<capsule result number>]
227 */
do_efi_capsule_res(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])228 static int do_efi_capsule_res(struct cmd_tbl *cmdtp, int flag,
229 int argc, char * const argv[])
230 {
231 int capsule_id;
232 char *endp;
233 u16 var_name16[12];
234 efi_guid_t guid;
235 struct efi_capsule_result_variable_header *result = NULL;
236 efi_uintn_t size;
237 efi_status_t ret;
238
239 if (argc != 1 && argc != 2)
240 return CMD_RET_USAGE;
241
242 guid = efi_guid_capsule_report;
243 if (argc == 1) {
244 size = sizeof(var_name16);
245 ret = efi_get_variable_int(u"CapsuleLast", &guid, NULL,
246 &size, var_name16, NULL);
247
248 if (ret != EFI_SUCCESS) {
249 if (ret == EFI_NOT_FOUND)
250 printf("CapsuleLast doesn't exist\n");
251 else
252 printf("Failed to get CapsuleLast\n");
253
254 return CMD_RET_FAILURE;
255 }
256 printf("CapsuleLast is %ls\n", var_name16);
257 } else {
258 argc--;
259 argv++;
260
261 capsule_id = hextoul(argv[0], &endp);
262 if (capsule_id < 0 || capsule_id > 0xffff)
263 return CMD_RET_USAGE;
264
265 efi_create_indexed_name(var_name16, sizeof(var_name16),
266 "Capsule", capsule_id);
267 }
268
269 size = 0;
270 ret = efi_get_variable_int(var_name16, &guid, NULL, &size, NULL, NULL);
271 if (ret == EFI_BUFFER_TOO_SMALL) {
272 result = malloc(size);
273 if (!result)
274 return CMD_RET_FAILURE;
275 ret = efi_get_variable_int(var_name16, &guid, NULL, &size,
276 result, NULL);
277 }
278 if (ret != EFI_SUCCESS) {
279 free(result);
280 printf("Failed to get %ls\n", var_name16);
281
282 return CMD_RET_FAILURE;
283 }
284
285 printf("Result total size: 0x%x\n", result->variable_total_size);
286 printf("Capsule guid: %pUl\n", &result->capsule_guid);
287 printf("Time processed: %04d-%02d-%02d %02d:%02d:%02d\n",
288 result->capsule_processed.year, result->capsule_processed.month,
289 result->capsule_processed.day, result->capsule_processed.hour,
290 result->capsule_processed.minute,
291 result->capsule_processed.second);
292 printf("Capsule status: 0x%lx\n", result->capsule_status);
293
294 free(result);
295
296 return CMD_RET_SUCCESS;
297 }
298
299 static struct cmd_tbl cmd_efidebug_capsule_sub[] = {
300 U_BOOT_CMD_MKENT(update, CONFIG_SYS_MAXARGS, 1, do_efi_capsule_update,
301 "", ""),
302 U_BOOT_CMD_MKENT(show, CONFIG_SYS_MAXARGS, 1, do_efi_capsule_show,
303 "", ""),
304 #ifdef CONFIG_EFI_ESRT
305 U_BOOT_CMD_MKENT(esrt, CONFIG_SYS_MAXARGS, 1, do_efi_capsule_esrt,
306 "", ""),
307 #endif
308 #ifdef CONFIG_EFI_CAPSULE_ON_DISK
309 U_BOOT_CMD_MKENT(disk-update, 0, 0, do_efi_capsule_on_disk_update,
310 "", ""),
311 #endif
312 U_BOOT_CMD_MKENT(result, CONFIG_SYS_MAXARGS, 1, do_efi_capsule_res,
313 "", ""),
314 };
315
316 /**
317 * do_efi_capsule() - manage UEFI capsules
318 *
319 * @cmdtp: Command table
320 * @flag: Command flag
321 * @argc: Number of arguments
322 * @argv: Argument array
323 * Return: CMD_RET_SUCCESS on success,
324 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
325 *
326 * Implement efidebug "capsule" sub-command.
327 */
do_efi_capsule(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])328 static int do_efi_capsule(struct cmd_tbl *cmdtp, int flag,
329 int argc, char * const argv[])
330 {
331 struct cmd_tbl *cp;
332
333 if (argc < 2)
334 return CMD_RET_USAGE;
335
336 argc--; argv++;
337
338 cp = find_cmd_tbl(argv[0], cmd_efidebug_capsule_sub,
339 ARRAY_SIZE(cmd_efidebug_capsule_sub));
340 if (!cp)
341 return CMD_RET_USAGE;
342
343 return cp->cmd(cmdtp, flag, argc, argv);
344 }
345 #endif /* CONFIG_EFI_HAVE_CAPSULE_SUPPORT */
346
347 #define EFI_HANDLE_WIDTH ((int)sizeof(efi_handle_t) * 2)
348
349 static const char spc[] = " ";
350 static const char sep[] = "================";
351
352 /**
353 * efi_get_driver_handle_info() - get information of UEFI driver
354 *
355 * @handle: Handle of UEFI device
356 * @driver_name: Driver name
357 * @image_path: Pointer to text of device path
358 * Return: 0 on success, -1 on failure
359 *
360 * Currently return no useful information as all UEFI drivers are
361 * built-in..
362 */
efi_get_driver_handle_info(efi_handle_t handle,u16 ** driver_name,u16 ** image_path)363 static int efi_get_driver_handle_info(efi_handle_t handle, u16 **driver_name,
364 u16 **image_path)
365 {
366 struct efi_handler *handler;
367 struct efi_loaded_image *image;
368 efi_status_t ret;
369
370 /*
371 * driver name
372 * TODO: support EFI_COMPONENT_NAME2_PROTOCOL
373 */
374 *driver_name = NULL;
375
376 /* image name */
377 ret = efi_search_protocol(handle, &efi_guid_loaded_image, &handler);
378 if (ret != EFI_SUCCESS) {
379 *image_path = NULL;
380 return 0;
381 }
382
383 image = handler->protocol_interface;
384 *image_path = efi_dp_str(image->file_path);
385
386 return 0;
387 }
388
389 /**
390 * do_efi_show_drivers() - show UEFI drivers
391 *
392 * @cmdtp: Command table
393 * @flag: Command flag
394 * @argc: Number of arguments
395 * @argv: Argument array
396 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
397 *
398 * Implement efidebug "drivers" sub-command.
399 * Show all UEFI drivers and their information.
400 */
do_efi_show_drivers(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])401 static int do_efi_show_drivers(struct cmd_tbl *cmdtp, int flag,
402 int argc, char *const argv[])
403 {
404 efi_handle_t *handles;
405 efi_uintn_t num, i;
406 u16 *driver_name, *image_path_text;
407 efi_status_t ret;
408
409 ret = EFI_CALL(efi_locate_handle_buffer(
410 BY_PROTOCOL, &efi_guid_driver_binding_protocol,
411 NULL, &num, &handles));
412 if (ret != EFI_SUCCESS)
413 return CMD_RET_FAILURE;
414
415 if (!num)
416 return CMD_RET_SUCCESS;
417
418 printf("Driver%.*s Name Image Path\n",
419 EFI_HANDLE_WIDTH - 6, spc);
420 printf("%.*s ==================== ====================\n",
421 EFI_HANDLE_WIDTH, sep);
422 for (i = 0; i < num; i++) {
423 if (!efi_get_driver_handle_info(handles[i], &driver_name,
424 &image_path_text)) {
425 if (image_path_text)
426 printf("%p %-20ls %ls\n", handles[i],
427 driver_name, image_path_text);
428 else
429 printf("%p %-20ls <built-in>\n",
430 handles[i], driver_name);
431 efi_free_pool(driver_name);
432 efi_free_pool(image_path_text);
433 }
434 }
435
436 efi_free_pool(handles);
437
438 return CMD_RET_SUCCESS;
439 }
440
441 /**
442 * do_efi_show_handles() - show UEFI handles
443 *
444 * @cmdtp: Command table
445 * @flag: Command flag
446 * @argc: Number of arguments
447 * @argv: Argument array
448 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
449 *
450 * Implement efidebug "dh" sub-command.
451 * Show all UEFI handles and their information, currently all protocols
452 * added to handle.
453 */
do_efi_show_handles(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])454 static int do_efi_show_handles(struct cmd_tbl *cmdtp, int flag,
455 int argc, char *const argv[])
456 {
457 efi_handle_t *handles;
458 efi_guid_t **guid;
459 efi_uintn_t num, count, i, j;
460 efi_status_t ret;
461
462 ret = EFI_CALL(efi_locate_handle_buffer(ALL_HANDLES, NULL, NULL,
463 &num, &handles));
464 if (ret != EFI_SUCCESS)
465 return CMD_RET_FAILURE;
466
467 if (!num)
468 return CMD_RET_SUCCESS;
469
470 for (i = 0; i < num; i++) {
471 struct efi_handler *handler;
472
473 printf("\n%p", handles[i]);
474 if (handles[i]->dev)
475 printf(" (%s)", handles[i]->dev->name);
476 printf("\n");
477 /* Print device path */
478 ret = efi_search_protocol(handles[i], &efi_guid_device_path,
479 &handler);
480 if (ret == EFI_SUCCESS)
481 printf(" %pD\n", handler->protocol_interface);
482 ret = EFI_CALL(BS->protocols_per_handle(handles[i], &guid,
483 &count));
484 /* Print other protocols */
485 for (j = 0; j < count; j++) {
486 if (guidcmp(guid[j], &efi_guid_device_path))
487 printf(" %pUs\n", guid[j]);
488 }
489 }
490
491 efi_free_pool(handles);
492
493 return CMD_RET_SUCCESS;
494 }
495
496 /**
497 * do_efi_show_images() - show UEFI images
498 *
499 * @cmdtp: Command table
500 * @flag: Command flag
501 * @argc: Number of arguments
502 * @argv: Argument array
503 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
504 *
505 * Implement efidebug "images" sub-command.
506 * Show all UEFI loaded images and their information.
507 */
do_efi_show_images(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])508 static int do_efi_show_images(struct cmd_tbl *cmdtp, int flag,
509 int argc, char *const argv[])
510 {
511 efi_print_image_infos(NULL);
512
513 return CMD_RET_SUCCESS;
514 }
515
516 static const char * const efi_mem_type_string[] = {
517 [EFI_RESERVED_MEMORY_TYPE] = "RESERVED",
518 [EFI_LOADER_CODE] = "LOADER CODE",
519 [EFI_LOADER_DATA] = "LOADER DATA",
520 [EFI_BOOT_SERVICES_CODE] = "BOOT CODE",
521 [EFI_BOOT_SERVICES_DATA] = "BOOT DATA",
522 [EFI_RUNTIME_SERVICES_CODE] = "RUNTIME CODE",
523 [EFI_RUNTIME_SERVICES_DATA] = "RUNTIME DATA",
524 [EFI_CONVENTIONAL_MEMORY] = "CONVENTIONAL",
525 [EFI_UNUSABLE_MEMORY] = "UNUSABLE MEM",
526 [EFI_ACPI_RECLAIM_MEMORY] = "ACPI RECLAIM MEM",
527 [EFI_ACPI_MEMORY_NVS] = "ACPI NVS",
528 [EFI_MMAP_IO] = "IO",
529 [EFI_MMAP_IO_PORT] = "IO PORT",
530 [EFI_PAL_CODE] = "PAL",
531 [EFI_PERSISTENT_MEMORY_TYPE] = "PERSISTENT",
532 };
533
534 static const struct efi_mem_attrs {
535 const u64 bit;
536 const char *text;
537 } efi_mem_attrs[] = {
538 {EFI_MEMORY_UC, "UC"},
539 {EFI_MEMORY_UC, "UC"},
540 {EFI_MEMORY_WC, "WC"},
541 {EFI_MEMORY_WT, "WT"},
542 {EFI_MEMORY_WB, "WB"},
543 {EFI_MEMORY_UCE, "UCE"},
544 {EFI_MEMORY_WP, "WP"},
545 {EFI_MEMORY_RP, "RP"},
546 {EFI_MEMORY_XP, "WP"},
547 {EFI_MEMORY_NV, "NV"},
548 {EFI_MEMORY_MORE_RELIABLE, "REL"},
549 {EFI_MEMORY_RO, "RO"},
550 {EFI_MEMORY_SP, "SP"},
551 {EFI_MEMORY_RUNTIME, "RT"},
552 };
553
554 /**
555 * print_memory_attributes() - print memory map attributes
556 *
557 * @attributes: Attribute value
558 *
559 * Print memory map attributes
560 */
print_memory_attributes(u64 attributes)561 static void print_memory_attributes(u64 attributes)
562 {
563 int sep, i;
564
565 for (sep = 0, i = 0; i < ARRAY_SIZE(efi_mem_attrs); i++)
566 if (attributes & efi_mem_attrs[i].bit) {
567 if (sep) {
568 putc('|');
569 } else {
570 putc(' ');
571 sep = 1;
572 }
573 puts(efi_mem_attrs[i].text);
574 }
575 }
576
577 #define EFI_PHYS_ADDR_WIDTH (int)(sizeof(efi_physical_addr_t) * 2)
578
579 /**
580 * do_efi_show_memmap() - show UEFI memory map
581 *
582 * @cmdtp: Command table
583 * @flag: Command flag
584 * @argc: Number of arguments
585 * @argv: Argument array
586 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
587 *
588 * Implement efidebug "memmap" sub-command.
589 * Show UEFI memory map.
590 */
do_efi_show_memmap(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])591 static int do_efi_show_memmap(struct cmd_tbl *cmdtp, int flag,
592 int argc, char *const argv[])
593 {
594 struct efi_mem_desc *memmap, *map;
595 efi_uintn_t map_size;
596 const char *type;
597 int i;
598 efi_status_t ret;
599
600 ret = efi_get_memory_map_alloc(&map_size, &memmap);
601 if (ret != EFI_SUCCESS)
602 return CMD_RET_FAILURE;
603
604 printf("Type Start%.*s End%.*s Attributes\n",
605 EFI_PHYS_ADDR_WIDTH - 5, spc, EFI_PHYS_ADDR_WIDTH - 3, spc);
606 printf("================ %.*s %.*s ==========\n",
607 EFI_PHYS_ADDR_WIDTH, sep, EFI_PHYS_ADDR_WIDTH, sep);
608 /*
609 * Coverity check: dereferencing null pointer "map."
610 * This is a false positive as memmap will always be
611 * populated by allocate_pool() above.
612 */
613 for (i = 0, map = memmap; i < map_size / sizeof(*map); map++, i++) {
614 if (map->type < ARRAY_SIZE(efi_mem_type_string))
615 type = efi_mem_type_string[map->type];
616 else
617 type = "(unknown)";
618
619 printf("%-16s %.*llx-%.*llx", type,
620 EFI_PHYS_ADDR_WIDTH,
621 (u64)map_to_sysmem((void *)(uintptr_t)
622 map->physical_start),
623 EFI_PHYS_ADDR_WIDTH,
624 (u64)map_to_sysmem((void *)(uintptr_t)
625 (map->physical_start +
626 map->num_pages * EFI_PAGE_SIZE)));
627
628 print_memory_attributes(map->attribute);
629 putc('\n');
630 }
631
632 efi_free_pool(memmap);
633
634 return CMD_RET_SUCCESS;
635 }
636
637 /**
638 * do_efi_show_tables() - show UEFI configuration tables
639 *
640 * @cmdtp: Command table
641 * @flag: Command flag
642 * @argc: Number of arguments
643 * @argv: Argument array
644 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
645 *
646 * Implement efidebug "tables" sub-command.
647 * Show UEFI configuration tables.
648 */
do_efi_show_tables(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])649 static int do_efi_show_tables(struct cmd_tbl *cmdtp, int flag,
650 int argc, char *const argv[])
651 {
652 efi_show_tables(&systab);
653
654 return CMD_RET_SUCCESS;
655 }
656
657 /**
658 * create_initrd_dp() - create a special device for our Boot### option
659 *
660 * @dev: device
661 * @part: disk partition
662 * @file: filename
663 * @shortform: create short form device path
664 * Return: pointer to the device path or ERR_PTR
665 */
666 static
create_initrd_dp(const char * dev,const char * part,const char * file,int shortform)667 struct efi_device_path *create_initrd_dp(const char *dev, const char *part,
668 const char *file, int shortform)
669
670 {
671 struct efi_device_path *tmp_dp = NULL, *tmp_fp = NULL, *short_fp = NULL;
672 struct efi_device_path *initrd_dp = NULL;
673 efi_status_t ret;
674 const struct efi_initrd_dp id_dp = {
675 .vendor = {
676 {
677 DEVICE_PATH_TYPE_MEDIA_DEVICE,
678 DEVICE_PATH_SUB_TYPE_VENDOR_PATH,
679 sizeof(id_dp.vendor),
680 },
681 EFI_INITRD_MEDIA_GUID,
682 },
683 .end = {
684 DEVICE_PATH_TYPE_END,
685 DEVICE_PATH_SUB_TYPE_END,
686 sizeof(id_dp.end),
687 }
688 };
689
690 ret = efi_dp_from_name(dev, part, file, &tmp_dp, &tmp_fp);
691 if (ret != EFI_SUCCESS) {
692 printf("Cannot create device path for \"%s %s\"\n", part, file);
693 goto out;
694 }
695 if (shortform)
696 short_fp = efi_dp_shorten(tmp_fp);
697 if (!short_fp)
698 short_fp = tmp_fp;
699
700 initrd_dp = efi_dp_append((const struct efi_device_path *)&id_dp,
701 short_fp);
702
703 out:
704 efi_free_pool(tmp_dp);
705 efi_free_pool(tmp_fp);
706 return initrd_dp;
707 }
708
709 /**
710 * do_efi_boot_add() - set UEFI load option
711 *
712 * @cmdtp: Command table
713 * @flag: Command flag
714 * @argc: Number of arguments
715 * @argv: Argument array
716 * Return: CMD_RET_SUCCESS on success,
717 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
718 *
719 * Implement efidebug "boot add" sub-command. Create or change UEFI load option.
720 *
721 * efidebug boot add -b <id> <label> <interface> <devnum>[:<part>] <file>
722 * -i <file> <interface2> <devnum2>[:<part>] <initrd>
723 * -s '<options>'
724 */
do_efi_boot_add(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])725 static int do_efi_boot_add(struct cmd_tbl *cmdtp, int flag,
726 int argc, char *const argv[])
727 {
728 int id;
729 char *endp;
730 u16 var_name16[9];
731 efi_guid_t guid;
732 u16 *label;
733 struct efi_device_path *file_path = NULL;
734 struct efi_device_path *fp_free = NULL;
735 struct efi_device_path *final_fp = NULL;
736 struct efi_device_path *initrd_dp = NULL;
737 struct efi_load_option lo;
738 void *data = NULL;
739 efi_uintn_t size;
740 efi_uintn_t fp_size = 0;
741 efi_status_t ret;
742 int r = CMD_RET_SUCCESS;
743
744 guid = efi_global_variable_guid;
745
746 /* attributes */
747 lo.attributes = LOAD_OPTION_ACTIVE; /* always ACTIVE */
748 lo.optional_data = NULL;
749 lo.label = NULL;
750
751 argc--;
752 argv++; /* 'add' */
753 for (; argc > 0; argc--, argv++) {
754 int shortform;
755
756 if (*argv[0] != '-' || strlen(argv[0]) != 2) {
757 r = CMD_RET_USAGE;
758 goto out;
759 }
760 shortform = 0;
761 switch (argv[0][1]) {
762 case 'b':
763 shortform = 1;
764 /* fallthrough */
765 case 'B':
766 if (argc < 5 || lo.label) {
767 r = CMD_RET_USAGE;
768 goto out;
769 }
770 id = (int)hextoul(argv[1], &endp);
771 if (*endp != '\0' || id > 0xffff)
772 return CMD_RET_USAGE;
773
774 efi_create_indexed_name(var_name16, sizeof(var_name16),
775 "Boot", id);
776
777 /* label */
778 label = efi_convert_string(argv[2]);
779 if (!label)
780 return CMD_RET_FAILURE;
781 lo.label = label; /* label will be changed below */
782
783 /* file path */
784 ret = efi_dp_from_name(argv[3], argv[4], argv[5],
785 NULL, &fp_free);
786 if (ret != EFI_SUCCESS) {
787 printf("Cannot create device path for \"%s %s\"\n",
788 argv[3], argv[4]);
789 r = CMD_RET_FAILURE;
790 goto out;
791 }
792 if (shortform)
793 file_path = efi_dp_shorten(fp_free);
794 if (!file_path)
795 file_path = fp_free;
796 fp_size += efi_dp_size(file_path) +
797 sizeof(struct efi_device_path);
798 argc -= 5;
799 argv += 5;
800 break;
801 case 'i':
802 shortform = 1;
803 /* fallthrough */
804 case 'I':
805 if (argc < 3 || initrd_dp) {
806 r = CMD_RET_USAGE;
807 goto out;
808 }
809
810 initrd_dp = create_initrd_dp(argv[1], argv[2], argv[3],
811 shortform);
812 if (!initrd_dp) {
813 printf("Cannot add an initrd\n");
814 r = CMD_RET_FAILURE;
815 goto out;
816 }
817 argc -= 3;
818 argv += 3;
819 fp_size += efi_dp_size(initrd_dp) +
820 sizeof(struct efi_device_path);
821 break;
822 case 's':
823 if (argc < 1 || lo.optional_data) {
824 r = CMD_RET_USAGE;
825 goto out;
826 }
827 lo.optional_data = (const u8 *)argv[1];
828 argc -= 1;
829 argv += 1;
830 break;
831 default:
832 r = CMD_RET_USAGE;
833 goto out;
834 }
835 }
836
837 if (!file_path) {
838 printf("Missing binary\n");
839 r = CMD_RET_USAGE;
840 goto out;
841 }
842
843 final_fp = efi_dp_concat(file_path, initrd_dp);
844 if (!final_fp) {
845 printf("Cannot create final device path\n");
846 r = CMD_RET_FAILURE;
847 goto out;
848 }
849
850 lo.file_path = final_fp;
851 lo.file_path_length = fp_size;
852
853 size = efi_serialize_load_option(&lo, (u8 **)&data);
854 if (!size) {
855 r = CMD_RET_FAILURE;
856 goto out;
857 }
858
859 ret = efi_set_variable_int(var_name16, &guid,
860 EFI_VARIABLE_NON_VOLATILE |
861 EFI_VARIABLE_BOOTSERVICE_ACCESS |
862 EFI_VARIABLE_RUNTIME_ACCESS,
863 size, data, false);
864 if (ret != EFI_SUCCESS) {
865 printf("Cannot set %ls\n", var_name16);
866 r = CMD_RET_FAILURE;
867 }
868
869 out:
870 free(data);
871 efi_free_pool(final_fp);
872 efi_free_pool(initrd_dp);
873 efi_free_pool(fp_free);
874 free(lo.label);
875
876 return r;
877 }
878
879 /**
880 * do_efi_boot_rm() - delete UEFI load options
881 *
882 * @cmdtp: Command table
883 * @flag: Command flag
884 * @argc: Number of arguments
885 * @argv: Argument array
886 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
887 *
888 * Implement efidebug "boot rm" sub-command.
889 * Delete UEFI load options.
890 *
891 * efidebug boot rm <id> ...
892 */
do_efi_boot_rm(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])893 static int do_efi_boot_rm(struct cmd_tbl *cmdtp, int flag,
894 int argc, char *const argv[])
895 {
896 efi_guid_t guid;
897 int id, i;
898 char *endp;
899 u16 var_name16[9];
900 efi_status_t ret;
901
902 if (argc == 1)
903 return CMD_RET_USAGE;
904
905 guid = efi_global_variable_guid;
906 for (i = 1; i < argc; i++, argv++) {
907 id = (int)hextoul(argv[1], &endp);
908 if (*endp != '\0' || id > 0xffff)
909 return CMD_RET_FAILURE;
910
911 efi_create_indexed_name(var_name16, sizeof(var_name16),
912 "Boot", id);
913 ret = efi_set_variable_int(var_name16, &guid, 0, 0, NULL,
914 false);
915 if (ret) {
916 printf("Cannot remove %ls\n", var_name16);
917 return CMD_RET_FAILURE;
918 }
919 }
920
921 return CMD_RET_SUCCESS;
922 }
923
924 /**
925 * show_efi_boot_opt_data() - dump UEFI load option
926 *
927 * @varname16: variable name
928 * @data: value of UEFI load option variable
929 * @size: size of the boot option
930 *
931 * Decode the value of UEFI load option variable and print information.
932 */
show_efi_boot_opt_data(u16 * varname16,void * data,size_t * size)933 static void show_efi_boot_opt_data(u16 *varname16, void *data, size_t *size)
934 {
935 struct efi_device_path *initrd_path = NULL;
936 struct efi_load_option lo;
937 efi_status_t ret;
938
939 ret = efi_deserialize_load_option(&lo, data, size);
940 if (ret != EFI_SUCCESS) {
941 printf("%ls: invalid load option\n", varname16);
942 return;
943 }
944
945 printf("%ls:\nattributes: %c%c%c (0x%08x)\n",
946 varname16,
947 /* ACTIVE */
948 lo.attributes & LOAD_OPTION_ACTIVE ? 'A' : '-',
949 /* FORCE RECONNECT */
950 lo.attributes & LOAD_OPTION_FORCE_RECONNECT ? 'R' : '-',
951 /* HIDDEN */
952 lo.attributes & LOAD_OPTION_HIDDEN ? 'H' : '-',
953 lo.attributes);
954 printf(" label: %ls\n", lo.label);
955
956 printf(" file_path: %pD\n", lo.file_path);
957
958 initrd_path = efi_dp_from_lo(&lo, &efi_lf2_initrd_guid);
959 if (initrd_path) {
960 printf(" initrd_path: %pD\n", initrd_path);
961 efi_free_pool(initrd_path);
962 }
963
964 printf(" data:\n");
965 print_hex_dump(" ", DUMP_PREFIX_OFFSET, 16, 1,
966 lo.optional_data, *size, true);
967 }
968
969 /**
970 * show_efi_boot_opt() - dump UEFI load option
971 *
972 * @varname16: variable name
973 *
974 * Dump information defined by UEFI load option.
975 */
show_efi_boot_opt(u16 * varname16)976 static void show_efi_boot_opt(u16 *varname16)
977 {
978 void *data;
979 efi_uintn_t size;
980 efi_status_t ret;
981
982 size = 0;
983 ret = efi_get_variable_int(varname16, &efi_global_variable_guid,
984 NULL, &size, NULL, NULL);
985 if (ret == EFI_BUFFER_TOO_SMALL) {
986 data = malloc(size);
987 if (!data) {
988 printf("ERROR: Out of memory\n");
989 return;
990 }
991 ret = efi_get_variable_int(varname16, &efi_global_variable_guid,
992 NULL, &size, data, NULL);
993 if (ret == EFI_SUCCESS)
994 show_efi_boot_opt_data(varname16, data, &size);
995 free(data);
996 }
997 }
998
999 /**
1000 * show_efi_boot_dump() - dump all UEFI load options
1001 *
1002 * @cmdtp: Command table
1003 * @flag: Command flag
1004 * @argc: Number of arguments
1005 * @argv: Argument array
1006 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
1007 *
1008 * Implement efidebug "boot dump" sub-command.
1009 * Dump information of all UEFI load options defined.
1010 *
1011 * efidebug boot dump
1012 */
do_efi_boot_dump(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1013 static int do_efi_boot_dump(struct cmd_tbl *cmdtp, int flag,
1014 int argc, char *const argv[])
1015 {
1016 u16 *var_name16, *p;
1017 efi_uintn_t buf_size, size;
1018 efi_guid_t guid;
1019 efi_status_t ret;
1020
1021 if (argc > 1)
1022 return CMD_RET_USAGE;
1023
1024 buf_size = 128;
1025 var_name16 = malloc(buf_size);
1026 if (!var_name16)
1027 return CMD_RET_FAILURE;
1028
1029 var_name16[0] = 0;
1030 for (;;) {
1031 size = buf_size;
1032 ret = efi_get_next_variable_name_int(&size, var_name16, &guid);
1033 if (ret == EFI_NOT_FOUND)
1034 break;
1035 if (ret == EFI_BUFFER_TOO_SMALL) {
1036 buf_size = size;
1037 p = realloc(var_name16, buf_size);
1038 if (!p) {
1039 free(var_name16);
1040 return CMD_RET_FAILURE;
1041 }
1042 var_name16 = p;
1043 ret = efi_get_next_variable_name_int(&size, var_name16,
1044 &guid);
1045 }
1046 if (ret != EFI_SUCCESS) {
1047 free(var_name16);
1048 return CMD_RET_FAILURE;
1049 }
1050
1051 if (efi_varname_is_load_option(var_name16, NULL))
1052 show_efi_boot_opt(var_name16);
1053 }
1054
1055 free(var_name16);
1056
1057 return CMD_RET_SUCCESS;
1058 }
1059
1060 /**
1061 * show_efi_boot_order() - show order of UEFI load options
1062 *
1063 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
1064 *
1065 * Show order of UEFI load options defined by BootOrder variable.
1066 */
show_efi_boot_order(void)1067 static int show_efi_boot_order(void)
1068 {
1069 u16 *bootorder;
1070 efi_uintn_t size;
1071 int num, i;
1072 u16 var_name16[9];
1073 void *data;
1074 struct efi_load_option lo;
1075 efi_status_t ret;
1076
1077 size = 0;
1078 ret = efi_get_variable_int(u"BootOrder", &efi_global_variable_guid,
1079 NULL, &size, NULL, NULL);
1080 if (ret != EFI_BUFFER_TOO_SMALL) {
1081 if (ret == EFI_NOT_FOUND) {
1082 printf("BootOrder not defined\n");
1083 return CMD_RET_SUCCESS;
1084 } else {
1085 return CMD_RET_FAILURE;
1086 }
1087 }
1088 bootorder = malloc(size);
1089 if (!bootorder) {
1090 printf("ERROR: Out of memory\n");
1091 return CMD_RET_FAILURE;
1092 }
1093 ret = efi_get_variable_int(u"BootOrder", &efi_global_variable_guid,
1094 NULL, &size, bootorder, NULL);
1095 if (ret != EFI_SUCCESS) {
1096 ret = CMD_RET_FAILURE;
1097 goto out;
1098 }
1099
1100 num = size / sizeof(u16);
1101 for (i = 0; i < num; i++) {
1102 efi_create_indexed_name(var_name16, sizeof(var_name16),
1103 "Boot", bootorder[i]);
1104
1105 size = 0;
1106 ret = efi_get_variable_int(var_name16,
1107 &efi_global_variable_guid, NULL,
1108 &size, NULL, NULL);
1109 if (ret != EFI_BUFFER_TOO_SMALL) {
1110 printf("%2d: %ls: (not defined)\n", i + 1, var_name16);
1111 continue;
1112 }
1113
1114 data = malloc(size);
1115 if (!data) {
1116 ret = CMD_RET_FAILURE;
1117 goto out;
1118 }
1119 ret = efi_get_variable_int(var_name16,
1120 &efi_global_variable_guid, NULL,
1121 &size, data, NULL);
1122 if (ret != EFI_SUCCESS) {
1123 free(data);
1124 ret = CMD_RET_FAILURE;
1125 goto out;
1126 }
1127
1128 ret = efi_deserialize_load_option(&lo, data, &size);
1129 if (ret != EFI_SUCCESS) {
1130 printf("%ls: invalid load option\n", var_name16);
1131 ret = CMD_RET_FAILURE;
1132 goto out;
1133 }
1134
1135 printf("%2d: %ls: %ls\n", i + 1, var_name16, lo.label);
1136
1137 free(data);
1138 }
1139 out:
1140 free(bootorder);
1141
1142 return ret;
1143 }
1144
1145 /**
1146 * do_efi_boot_next() - manage UEFI BootNext variable
1147 *
1148 * @cmdtp: Command table
1149 * @flag: Command flag
1150 * @argc: Number of arguments
1151 * @argv: Argument array
1152 * Return: CMD_RET_SUCCESS on success,
1153 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1154 *
1155 * Implement efidebug "boot next" sub-command.
1156 * Set BootNext variable.
1157 *
1158 * efidebug boot next <id>
1159 */
do_efi_boot_next(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1160 static int do_efi_boot_next(struct cmd_tbl *cmdtp, int flag,
1161 int argc, char *const argv[])
1162 {
1163 u16 bootnext;
1164 efi_uintn_t size;
1165 char *endp;
1166 efi_guid_t guid;
1167 efi_status_t ret;
1168 int r = CMD_RET_SUCCESS;
1169
1170 if (argc != 2)
1171 return CMD_RET_USAGE;
1172
1173 bootnext = (u16)hextoul(argv[1], &endp);
1174 if (*endp) {
1175 printf("invalid value: %s\n", argv[1]);
1176 r = CMD_RET_FAILURE;
1177 goto out;
1178 }
1179
1180 guid = efi_global_variable_guid;
1181 size = sizeof(u16);
1182 ret = efi_set_variable_int(u"BootNext", &guid,
1183 EFI_VARIABLE_NON_VOLATILE |
1184 EFI_VARIABLE_BOOTSERVICE_ACCESS |
1185 EFI_VARIABLE_RUNTIME_ACCESS,
1186 size, &bootnext, false);
1187 if (ret != EFI_SUCCESS) {
1188 printf("Cannot set BootNext\n");
1189 r = CMD_RET_FAILURE;
1190 }
1191 out:
1192 return r;
1193 }
1194
1195 /**
1196 * do_efi_boot_order() - manage UEFI BootOrder variable
1197 *
1198 * @cmdtp: Command table
1199 * @flag: Command flag
1200 * @argc: Number of arguments
1201 * @argv: Argument array
1202 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
1203 *
1204 * Implement efidebug "boot order" sub-command.
1205 * Show order of UEFI load options, or change it in BootOrder variable.
1206 *
1207 * efidebug boot order [<id> ...]
1208 */
do_efi_boot_order(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1209 static int do_efi_boot_order(struct cmd_tbl *cmdtp, int flag,
1210 int argc, char *const argv[])
1211 {
1212 u16 *bootorder = NULL;
1213 efi_uintn_t size;
1214 int id, i;
1215 char *endp;
1216 efi_guid_t guid;
1217 efi_status_t ret;
1218 int r = CMD_RET_SUCCESS;
1219
1220 if (argc == 1)
1221 return show_efi_boot_order();
1222
1223 argc--;
1224 argv++;
1225
1226 size = argc * sizeof(u16);
1227 bootorder = malloc(size);
1228 if (!bootorder)
1229 return CMD_RET_FAILURE;
1230
1231 for (i = 0; i < argc; i++) {
1232 id = (int)hextoul(argv[i], &endp);
1233 if (*endp != '\0' || id > 0xffff) {
1234 printf("invalid value: %s\n", argv[i]);
1235 r = CMD_RET_FAILURE;
1236 goto out;
1237 }
1238
1239 bootorder[i] = (u16)id;
1240 }
1241
1242 guid = efi_global_variable_guid;
1243 ret = efi_set_variable_int(u"BootOrder", &guid,
1244 EFI_VARIABLE_NON_VOLATILE |
1245 EFI_VARIABLE_BOOTSERVICE_ACCESS |
1246 EFI_VARIABLE_RUNTIME_ACCESS,
1247 size, bootorder, true);
1248 if (ret != EFI_SUCCESS) {
1249 printf("Cannot set BootOrder\n");
1250 r = CMD_RET_FAILURE;
1251 }
1252 out:
1253 free(bootorder);
1254
1255 return r;
1256 }
1257
1258 static struct cmd_tbl cmd_efidebug_boot_sub[] = {
1259 U_BOOT_CMD_MKENT(add, CONFIG_SYS_MAXARGS, 1, do_efi_boot_add, "", ""),
1260 U_BOOT_CMD_MKENT(rm, CONFIG_SYS_MAXARGS, 1, do_efi_boot_rm, "", ""),
1261 U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_efi_boot_dump, "", ""),
1262 U_BOOT_CMD_MKENT(next, CONFIG_SYS_MAXARGS, 1, do_efi_boot_next, "", ""),
1263 U_BOOT_CMD_MKENT(order, CONFIG_SYS_MAXARGS, 1, do_efi_boot_order,
1264 "", ""),
1265 };
1266
1267 /**
1268 * do_efi_boot_opt() - manage UEFI load options
1269 *
1270 * @cmdtp: Command table
1271 * @flag: Command flag
1272 * @argc: Number of arguments
1273 * @argv: Argument array
1274 * Return: CMD_RET_SUCCESS on success,
1275 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1276 *
1277 * Implement efidebug "boot" sub-command.
1278 */
do_efi_boot_opt(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1279 static int do_efi_boot_opt(struct cmd_tbl *cmdtp, int flag,
1280 int argc, char *const argv[])
1281 {
1282 struct cmd_tbl *cp;
1283
1284 if (argc < 2)
1285 return CMD_RET_USAGE;
1286
1287 argc--; argv++;
1288
1289 cp = find_cmd_tbl(argv[0], cmd_efidebug_boot_sub,
1290 ARRAY_SIZE(cmd_efidebug_boot_sub));
1291 if (!cp)
1292 return CMD_RET_USAGE;
1293
1294 return cp->cmd(cmdtp, flag, argc, argv);
1295 }
1296
1297 /**
1298 * do_efi_test_bootmgr() - run simple bootmgr for test
1299 *
1300 * @cmdtp: Command table
1301 * @flag: Command flag
1302 * @argc: Number of arguments
1303 * @argv: Argument array
1304 * Return: CMD_RET_SUCCESS on success,
1305 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1306 *
1307 * Implement efidebug "test bootmgr" sub-command.
1308 * Run simple bootmgr for test.
1309 *
1310 * efidebug test bootmgr
1311 */
do_efi_test_bootmgr(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1312 static __maybe_unused int do_efi_test_bootmgr(struct cmd_tbl *cmdtp, int flag,
1313 int argc, char * const argv[])
1314 {
1315 efi_handle_t image;
1316 efi_uintn_t exit_data_size = 0;
1317 u16 *exit_data = NULL;
1318 efi_status_t ret;
1319 void *load_options = NULL;
1320
1321 ret = efi_bootmgr_load(&image, &load_options);
1322 printf("efi_bootmgr_load() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1323
1324 /* We call efi_start_image() even if error for test purpose. */
1325 ret = EFI_CALL(efi_start_image(image, &exit_data_size, &exit_data));
1326 printf("efi_start_image() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1327 if (ret && exit_data)
1328 efi_free_pool(exit_data);
1329
1330 efi_restore_gd();
1331
1332 free(load_options);
1333 return CMD_RET_SUCCESS;
1334 }
1335
1336 static struct cmd_tbl cmd_efidebug_test_sub[] = {
1337 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
1338 U_BOOT_CMD_MKENT(bootmgr, CONFIG_SYS_MAXARGS, 1, do_efi_test_bootmgr,
1339 "", ""),
1340 #endif
1341 };
1342
1343 /**
1344 * do_efi_test() - manage UEFI load options
1345 *
1346 * @cmdtp: Command table
1347 * @flag: Command flag
1348 * @argc: Number of arguments
1349 * @argv: Argument array
1350 * Return: CMD_RET_SUCCESS on success,
1351 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1352 *
1353 * Implement efidebug "test" sub-command.
1354 */
do_efi_test(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1355 static int do_efi_test(struct cmd_tbl *cmdtp, int flag,
1356 int argc, char * const argv[])
1357 {
1358 struct cmd_tbl *cp;
1359
1360 if (argc < 2)
1361 return CMD_RET_USAGE;
1362
1363 argc--; argv++;
1364
1365 cp = find_cmd_tbl(argv[0], cmd_efidebug_test_sub,
1366 ARRAY_SIZE(cmd_efidebug_test_sub));
1367 if (!cp)
1368 return CMD_RET_USAGE;
1369
1370 return cp->cmd(cmdtp, flag, argc, argv);
1371 }
1372
1373 /**
1374 * do_efi_query_info() - QueryVariableInfo EFI service
1375 *
1376 * @cmdtp: Command table
1377 * @flag: Command flag
1378 * @argc: Number of arguments
1379 * @argv: Argument array
1380 * Return: CMD_RET_SUCCESS on success,
1381 * CMD_RET_USAGE or CMD_RET_FAILURE on failure
1382 *
1383 * Implement efidebug "test" sub-command.
1384 */
1385
do_efi_query_info(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1386 static int do_efi_query_info(struct cmd_tbl *cmdtp, int flag,
1387 int argc, char * const argv[])
1388 {
1389 efi_status_t ret;
1390 u32 attr = 0;
1391 u64 max_variable_storage_size;
1392 u64 remain_variable_storage_size;
1393 u64 max_variable_size;
1394 int i;
1395
1396 for (i = 1; i < argc; i++) {
1397 if (!strcmp(argv[i], "-bs"))
1398 attr |= EFI_VARIABLE_BOOTSERVICE_ACCESS;
1399 else if (!strcmp(argv[i], "-rt"))
1400 attr |= EFI_VARIABLE_RUNTIME_ACCESS;
1401 else if (!strcmp(argv[i], "-nv"))
1402 attr |= EFI_VARIABLE_NON_VOLATILE;
1403 else if (!strcmp(argv[i], "-at"))
1404 attr |=
1405 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
1406 }
1407
1408 ret = efi_query_variable_info_int(attr, &max_variable_storage_size,
1409 &remain_variable_storage_size,
1410 &max_variable_size);
1411 if (ret != EFI_SUCCESS) {
1412 printf("Error: Cannot query UEFI variables, r = %lu\n",
1413 ret & ~EFI_ERROR_MASK);
1414 return CMD_RET_FAILURE;
1415 }
1416
1417 printf("Max storage size %llu\n", max_variable_storage_size);
1418 printf("Remaining storage size %llu\n", remain_variable_storage_size);
1419 printf("Max variable size %llu\n", max_variable_size);
1420
1421 return CMD_RET_SUCCESS;
1422 }
1423
1424 static struct cmd_tbl cmd_efidebug_sub[] = {
1425 U_BOOT_CMD_MKENT(boot, CONFIG_SYS_MAXARGS, 1, do_efi_boot_opt, "", ""),
1426 #ifdef CONFIG_EFI_HAVE_CAPSULE_SUPPORT
1427 U_BOOT_CMD_MKENT(capsule, CONFIG_SYS_MAXARGS, 1, do_efi_capsule,
1428 "", ""),
1429 #endif
1430 U_BOOT_CMD_MKENT(drivers, CONFIG_SYS_MAXARGS, 1, do_efi_show_drivers,
1431 "", ""),
1432 U_BOOT_CMD_MKENT(dh, CONFIG_SYS_MAXARGS, 1, do_efi_show_handles,
1433 "", ""),
1434 U_BOOT_CMD_MKENT(images, CONFIG_SYS_MAXARGS, 1, do_efi_show_images,
1435 "", ""),
1436 U_BOOT_CMD_MKENT(memmap, CONFIG_SYS_MAXARGS, 1, do_efi_show_memmap,
1437 "", ""),
1438 U_BOOT_CMD_MKENT(tables, CONFIG_SYS_MAXARGS, 1, do_efi_show_tables,
1439 "", ""),
1440 U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_efi_test,
1441 "", ""),
1442 U_BOOT_CMD_MKENT(query, CONFIG_SYS_MAXARGS, 1, do_efi_query_info,
1443 "", ""),
1444 };
1445
1446 /**
1447 * do_efidebug() - display and configure UEFI environment
1448 *
1449 * @cmdtp: Command table
1450 * @flag: Command flag
1451 * @argc: Number of arguments
1452 * @argv: Argument array
1453 * Return: CMD_RET_SUCCESS on success,
1454 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1455 *
1456 * Implement efidebug command which allows us to display and
1457 * configure UEFI environment.
1458 */
do_efidebug(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])1459 static int do_efidebug(struct cmd_tbl *cmdtp, int flag,
1460 int argc, char *const argv[])
1461 {
1462 struct cmd_tbl *cp;
1463 efi_status_t r;
1464
1465 if (argc < 2)
1466 return CMD_RET_USAGE;
1467
1468 argc--; argv++;
1469
1470 /* Initialize UEFI drivers */
1471 r = efi_init_obj_list();
1472 if (r != EFI_SUCCESS) {
1473 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
1474 r & ~EFI_ERROR_MASK);
1475 return CMD_RET_FAILURE;
1476 }
1477
1478 cp = find_cmd_tbl(argv[0], cmd_efidebug_sub,
1479 ARRAY_SIZE(cmd_efidebug_sub));
1480 if (!cp)
1481 return CMD_RET_USAGE;
1482
1483 return cp->cmd(cmdtp, flag, argc, argv);
1484 }
1485
1486 #ifdef CONFIG_SYS_LONGHELP
1487 static char efidebug_help_text[] =
1488 " - UEFI Shell-like interface to configure UEFI environment\n"
1489 "\n"
1490 "efidebug boot add - set UEFI BootXXXX variable\n"
1491 " -b|-B <bootid> <label> <interface> <devnum>[:<part>] <file path>\n"
1492 " -i|-I <interface> <devnum>[:<part>] <initrd file path>\n"
1493 " (-b, -i for short form device path)\n"
1494 " -s '<optional data>'\n"
1495 "efidebug boot rm <bootid#1> [<bootid#2> [<bootid#3> [...]]]\n"
1496 " - delete UEFI BootXXXX variables\n"
1497 "efidebug boot dump\n"
1498 " - dump all UEFI BootXXXX variables\n"
1499 "efidebug boot next <bootid>\n"
1500 " - set UEFI BootNext variable\n"
1501 "efidebug boot order [<bootid#1> [<bootid#2> [<bootid#3> [...]]]]\n"
1502 " - set/show UEFI boot order\n"
1503 "\n"
1504 #ifdef CONFIG_EFI_HAVE_CAPSULE_SUPPORT
1505 "efidebug capsule update [-v] <capsule address>\n"
1506 " - process a capsule\n"
1507 "efidebug capsule disk-update\n"
1508 " - update a capsule from disk\n"
1509 "efidebug capsule show <capsule address>\n"
1510 " - show capsule information\n"
1511 "efidebug capsule result [<capsule result var>]\n"
1512 " - show a capsule update result\n"
1513 #ifdef CONFIG_EFI_ESRT
1514 "efidebug capsule esrt\n"
1515 " - print the ESRT\n"
1516 #endif
1517 "\n"
1518 #endif
1519 "efidebug drivers\n"
1520 " - show UEFI drivers\n"
1521 "efidebug dh\n"
1522 " - show UEFI handles\n"
1523 "efidebug images\n"
1524 " - show loaded images\n"
1525 "efidebug memmap\n"
1526 " - show UEFI memory map\n"
1527 "efidebug tables\n"
1528 " - show UEFI configuration tables\n"
1529 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
1530 "efidebug test bootmgr\n"
1531 " - run simple bootmgr for test\n"
1532 #endif
1533 "efidebug query [-nv][-bs][-rt][-at]\n"
1534 " - show size of UEFI variables store\n";
1535 #endif
1536
1537 U_BOOT_CMD(
1538 efidebug, CONFIG_SYS_MAXARGS, 0, do_efidebug,
1539 "Configure UEFI environment",
1540 efidebug_help_text
1541 );
1542