blob: 569003ae2efcde79c5dd8f8f0909decc3376b29b [file] [log] [blame]
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001// 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>
Heinrich Schuchardtf3290be2022-10-04 15:31:17 +020011#include <dm/device.h>
Heinrich Schuchardt94686f62020-12-13 10:30:24 +010012#include <efi_dt_fixup.h>
Ilias Apalodimascbea2412021-03-17 21:55:01 +020013#include <efi_load_initrd.h>
AKASHI Takahiro59df7e72019-02-25 15:54:38 +090014#include <efi_loader.h>
Heinrich Schuchardt79693352020-09-27 14:50:25 +020015#include <efi_rng.h>
Heinrich Schuchardtacfe1de2021-05-24 11:10:59 +020016#include <efi_variable.h>
AKASHI Takahiro59df7e72019-02-25 15:54:38 +090017#include <exports.h>
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +020018#include <hexdump.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060019#include <log.h>
AKASHI Takahiro59df7e72019-02-25 15:54:38 +090020#include <malloc.h>
Heinrich Schuchardta415d612020-03-14 08:44:07 +010021#include <mapmem.h>
Heinrich Schuchardtb9b0ea32021-02-02 17:53:14 +010022#include <part.h>
AKASHI Takahiro59df7e72019-02-25 15:54:38 +090023#include <search.h>
24#include <linux/ctype.h>
Ilias Apalodimascbea2412021-03-17 21:55:01 +020025#include <linux/err.h>
AKASHI Takahiro59df7e72019-02-25 15:54:38 +090026
AKASHI Takahiro355cdb52019-02-25 15:54:39 +090027#define BS systab.boottime
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +090028
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 */
44static 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
Simon Glass7e5f4602021-07-24 09:03:29 -060064 capsule = (typeof(capsule))hextoul(argv[1], &endp);
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +090065 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
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +020078 ret = EFI_CALL(efi_update_capsule(&capsule, 1, 0));
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +090079 if (ret) {
Michal Simek046d7a02022-08-09 16:31:12 +020080 printf("Cannot handle a capsule at %p\n", capsule);
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +090081 return CMD_RET_FAILURE;
82 }
83
84 return CMD_RET_SUCCESS;
85}
86
Masami Hiramatsu4cd1fca2022-03-21 22:37:35 +090087#ifdef CONFIG_EFI_CAPSULE_ON_DISK
Sughosh Ganu74075952020-12-30 19:27:11 +053088static 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}
Masami Hiramatsu4cd1fca2022-03-21 22:37:35 +090097#endif
Sughosh Ganu74075952020-12-30 19:27:11 +053098
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +090099/**
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 */
113static 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
Simon Glass7e5f4602021-07-24 09:03:29 -0600122 capsule = (typeof(capsule))hextoul(argv[1], &endp);
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900123 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
Jose Marinhoaa31a872021-03-11 13:18:51 +0000137#ifdef CONFIG_EFI_ESRT
138
139#define EFI_ESRT_FW_TYPE_NUM 4
140char *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
144char *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) (\
150EFI_ESRT_FW_TYPE_NUM > (idx) ? efi_fw_type_str[(idx)] : "error"\
151)
152
153#define EFI_FW_STATUS_STR_GET(idx) (\
154EFI_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 */
172static 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 */
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900213/**
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 */
228static 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;
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +0200233 u16 var_name16[12];
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900234 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);
Simon Glass156ccbc2022-01-23 12:55:12 -0700245 ret = efi_get_variable_int(u"CapsuleLast", &guid, NULL,
Heinrich Schuchardtacfe1de2021-05-24 11:10:59 +0200246 &size, var_name16, NULL);
247
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900248 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
Simon Glass7e5f4602021-07-24 09:03:29 -0600261 capsule_id = hextoul(argv[0], &endp);
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900262 if (capsule_id < 0 || capsule_id > 0xffff)
263 return CMD_RET_USAGE;
264
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +0200265 efi_create_indexed_name(var_name16, sizeof(var_name16),
266 "Capsule", capsule_id);
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900267 }
268
269 size = 0;
Heinrich Schuchardtacfe1de2021-05-24 11:10:59 +0200270 ret = efi_get_variable_int(var_name16, &guid, NULL, &size, NULL, NULL);
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900271 if (ret == EFI_BUFFER_TOO_SMALL) {
272 result = malloc(size);
AKASHI Takahiro30f82222021-01-22 10:42:48 +0900273 if (!result)
274 return CMD_RET_FAILURE;
Heinrich Schuchardtacfe1de2021-05-24 11:10:59 +0200275 ret = efi_get_variable_int(var_name16, &guid, NULL, &size,
276 result, NULL);
AKASHI Takahiro30f82222021-01-22 10:42:48 +0900277 }
278 if (ret != EFI_SUCCESS) {
279 free(result);
280 printf("Failed to get %ls\n", var_name16);
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900281
AKASHI Takahiro30f82222021-01-22 10:42:48 +0900282 return CMD_RET_FAILURE;
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900283 }
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
299static 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 "", ""),
Jose Marinhoaa31a872021-03-11 13:18:51 +0000304#ifdef CONFIG_EFI_ESRT
305 U_BOOT_CMD_MKENT(esrt, CONFIG_SYS_MAXARGS, 1, do_efi_capsule_esrt,
306 "", ""),
307#endif
Masami Hiramatsu4cd1fca2022-03-21 22:37:35 +0900308#ifdef CONFIG_EFI_CAPSULE_ON_DISK
Sughosh Ganu74075952020-12-30 19:27:11 +0530309 U_BOOT_CMD_MKENT(disk-update, 0, 0, do_efi_capsule_on_disk_update,
310 "", ""),
Masami Hiramatsu4cd1fca2022-03-21 22:37:35 +0900311#endif
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +0900312 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 */
328static 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 */
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900346
AKASHI Takahiro355cdb52019-02-25 15:54:39 +0900347#define EFI_HANDLE_WIDTH ((int)sizeof(efi_handle_t) * 2)
348
349static const char spc[] = " ";
350static const char sep[] = "================";
351
352/**
AKASHI Takahiro66eaf562019-02-25 15:54:40 +0900353 * 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 */
363static 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 */
Simon Glass09140112020-05-10 11:40:03 -0600401static int do_efi_show_drivers(struct cmd_tbl *cmdtp, int flag,
402 int argc, char *const argv[])
AKASHI Takahiro66eaf562019-02-25 15:54:40 +0900403{
404 efi_handle_t *handles;
405 efi_uintn_t num, i;
406 u16 *driver_name, *image_path_text;
407 efi_status_t ret;
408
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200409 ret = EFI_CALL(efi_locate_handle_buffer(
AKASHI Takahiro66eaf562019-02-25 15:54:40 +0900410 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);
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200431 efi_free_pool(driver_name);
432 efi_free_pool(image_path_text);
AKASHI Takahiro66eaf562019-02-25 15:54:40 +0900433 }
434 }
435
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200436 efi_free_pool(handles);
AKASHI Takahiro66eaf562019-02-25 15:54:40 +0900437
438 return CMD_RET_SUCCESS;
439}
440
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900441/**
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 */
Simon Glass09140112020-05-10 11:40:03 -0600454static int do_efi_show_handles(struct cmd_tbl *cmdtp, int flag,
455 int argc, char *const argv[])
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900456{
457 efi_handle_t *handles;
458 efi_guid_t **guid;
459 efi_uintn_t num, count, i, j;
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900460 efi_status_t ret;
461
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200462 ret = EFI_CALL(efi_locate_handle_buffer(ALL_HANDLES, NULL, NULL,
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900463 &num, &handles));
464 if (ret != EFI_SUCCESS)
465 return CMD_RET_FAILURE;
466
467 if (!num)
468 return CMD_RET_SUCCESS;
469
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900470 for (i = 0; i < num; i++) {
Heinrich Schuchardtf3290be2022-10-04 15:31:17 +0200471 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);
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900482 ret = EFI_CALL(BS->protocols_per_handle(handles[i], &guid,
483 &count));
Heinrich Schuchardtf3290be2022-10-04 15:31:17 +0200484 /* Print other protocols */
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900485 for (j = 0; j < count; j++) {
Heinrich Schuchardtf3290be2022-10-04 15:31:17 +0200486 if (guidcmp(guid[j], &efi_guid_device_path))
487 printf(" %pUs\n", guid[j]);
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900488 }
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900489 }
490
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200491 efi_free_pool(handles);
AKASHI Takahiroa8014622019-02-25 15:54:41 +0900492
493 return CMD_RET_SUCCESS;
494}
495
AKASHI Takahiro66eaf562019-02-25 15:54:40 +0900496/**
AKASHI Takahirofa536732019-02-25 15:54:42 +0900497 * 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 */
Simon Glass09140112020-05-10 11:40:03 -0600508static int do_efi_show_images(struct cmd_tbl *cmdtp, int flag,
509 int argc, char *const argv[])
AKASHI Takahirofa536732019-02-25 15:54:42 +0900510{
511 efi_print_image_infos(NULL);
512
513 return CMD_RET_SUCCESS;
514}
515
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900516static 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",
Heinrich Schuchardtdd9056c2020-04-29 20:21:39 +0200531 [EFI_PERSISTENT_MEMORY_TYPE] = "PERSISTENT",
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900532};
533
534static 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"},
Heinrich Schuchardt255a4732020-05-19 07:20:46 +0200550 {EFI_MEMORY_SP, "SP"},
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900551 {EFI_MEMORY_RUNTIME, "RT"},
552};
553
554/**
555 * print_memory_attributes() - print memory map attributes
Heinrich Schuchardt0b016562019-07-14 14:00:41 +0200556 *
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900557 * @attributes: Attribute value
558 *
559 * Print memory map attributes
560 */
561static 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 */
Simon Glass09140112020-05-10 11:40:03 -0600591static int do_efi_show_memmap(struct cmd_tbl *cmdtp, int flag,
592 int argc, char *const argv[])
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900593{
594 struct efi_mem_desc *memmap = NULL, *map;
595 efi_uintn_t map_size = 0;
596 const char *type;
597 int i;
598 efi_status_t ret;
599
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200600 ret = efi_get_memory_map(&map_size, memmap, NULL, NULL, NULL);
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900601 if (ret == EFI_BUFFER_TOO_SMALL) {
602 map_size += sizeof(struct efi_mem_desc); /* for my own */
Heinrich Schuchardt1a127962022-11-29 16:00:41 +0100603 ret = efi_allocate_pool(EFI_BOOT_SERVICES_DATA, map_size,
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200604 (void *)&memmap);
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900605 if (ret != EFI_SUCCESS)
606 return CMD_RET_FAILURE;
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200607 ret = efi_get_memory_map(&map_size, memmap, NULL, NULL, NULL);
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900608 }
609 if (ret != EFI_SUCCESS) {
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200610 efi_free_pool(memmap);
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900611 return CMD_RET_FAILURE;
612 }
613
614 printf("Type Start%.*s End%.*s Attributes\n",
615 EFI_PHYS_ADDR_WIDTH - 5, spc, EFI_PHYS_ADDR_WIDTH - 3, spc);
616 printf("================ %.*s %.*s ==========\n",
617 EFI_PHYS_ADDR_WIDTH, sep, EFI_PHYS_ADDR_WIDTH, sep);
AKASHI Takahiroe2a5b862020-05-08 14:50:18 +0900618 /*
619 * Coverity check: dereferencing null pointer "map."
620 * This is a false positive as memmap will always be
621 * populated by allocate_pool() above.
622 */
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900623 for (i = 0, map = memmap; i < map_size / sizeof(*map); map++, i++) {
Heinrich Schuchardtdd9056c2020-04-29 20:21:39 +0200624 if (map->type < ARRAY_SIZE(efi_mem_type_string))
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900625 type = efi_mem_type_string[map->type];
626 else
627 type = "(unknown)";
628
629 printf("%-16s %.*llx-%.*llx", type,
630 EFI_PHYS_ADDR_WIDTH,
Heinrich Schuchardt6c0ef352020-03-27 04:33:17 +0000631 (u64)map_to_sysmem((void *)(uintptr_t)
632 map->physical_start),
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900633 EFI_PHYS_ADDR_WIDTH,
Heinrich Schuchardt6c0ef352020-03-27 04:33:17 +0000634 (u64)map_to_sysmem((void *)(uintptr_t)
635 (map->physical_start +
636 map->num_pages * EFI_PAGE_SIZE)));
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900637
638 print_memory_attributes(map->attribute);
639 putc('\n');
640 }
641
Heinrich Schuchardta30c7232020-05-02 16:08:37 +0200642 efi_free_pool(memmap);
AKASHI Takahiro00358bb2019-02-25 15:54:43 +0900643
644 return CMD_RET_SUCCESS;
645}
646
AKASHI Takahirofa536732019-02-25 15:54:42 +0900647/**
Heinrich Schuchardt986e0642020-01-07 05:57:47 +0100648 * do_efi_show_tables() - show UEFI configuration tables
649 *
650 * @cmdtp: Command table
651 * @flag: Command flag
652 * @argc: Number of arguments
653 * @argv: Argument array
654 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
655 *
656 * Implement efidebug "tables" sub-command.
657 * Show UEFI configuration tables.
658 */
Simon Glass09140112020-05-10 11:40:03 -0600659static int do_efi_show_tables(struct cmd_tbl *cmdtp, int flag,
660 int argc, char *const argv[])
Heinrich Schuchardt986e0642020-01-07 05:57:47 +0100661{
662 efi_uintn_t i;
Heinrich Schuchardt986e0642020-01-07 05:57:47 +0100663
Heinrich Schuchardt3adae642022-01-16 14:10:23 +0100664 for (i = 0; i < systab.nr_tables; ++i)
665 printf("%pUl (%pUs)\n",
666 &systab.tables[i].guid, &systab.tables[i].guid);
Heinrich Schuchardt986e0642020-01-07 05:57:47 +0100667
668 return CMD_RET_SUCCESS;
669}
670
671/**
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100672 * create_initrd_dp() - create a special device for our Boot### option
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200673 *
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100674 * @dev: device
675 * @part: disk partition
676 * @file: filename
677 * @shortform: create short form device path
678 * Return: pointer to the device path or ERR_PTR
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200679 */
680static
681struct efi_device_path *create_initrd_dp(const char *dev, const char *part,
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100682 const char *file, int shortform)
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200683
684{
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100685 struct efi_device_path *tmp_dp = NULL, *tmp_fp = NULL, *short_fp = NULL;
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200686 struct efi_device_path *initrd_dp = NULL;
687 efi_status_t ret;
688 const struct efi_initrd_dp id_dp = {
689 .vendor = {
690 {
691 DEVICE_PATH_TYPE_MEDIA_DEVICE,
692 DEVICE_PATH_SUB_TYPE_VENDOR_PATH,
693 sizeof(id_dp.vendor),
694 },
695 EFI_INITRD_MEDIA_GUID,
696 },
697 .end = {
698 DEVICE_PATH_TYPE_END,
699 DEVICE_PATH_SUB_TYPE_END,
700 sizeof(id_dp.end),
701 }
702 };
703
704 ret = efi_dp_from_name(dev, part, file, &tmp_dp, &tmp_fp);
705 if (ret != EFI_SUCCESS) {
706 printf("Cannot create device path for \"%s %s\"\n", part, file);
707 goto out;
708 }
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100709 if (shortform)
710 short_fp = efi_dp_shorten(tmp_fp);
711 if (!short_fp)
712 short_fp = tmp_fp;
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200713
714 initrd_dp = efi_dp_append((const struct efi_device_path *)&id_dp,
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100715 short_fp);
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200716
717out:
718 efi_free_pool(tmp_dp);
719 efi_free_pool(tmp_fp);
720 return initrd_dp;
721}
722
723/**
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900724 * do_efi_boot_add() - set UEFI load option
725 *
726 * @cmdtp: Command table
727 * @flag: Command flag
728 * @argc: Number of arguments
729 * @argv: Argument array
730 * Return: CMD_RET_SUCCESS on success,
731 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
732 *
Heinrich Schuchardt0b016562019-07-14 14:00:41 +0200733 * Implement efidebug "boot add" sub-command. Create or change UEFI load option.
734 *
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200735 * efidebug boot add -b <id> <label> <interface> <devnum>[:<part>] <file>
736 * -i <file> <interface2> <devnum2>[:<part>] <initrd>
737 * -s '<options>'
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900738 */
Simon Glass09140112020-05-10 11:40:03 -0600739static int do_efi_boot_add(struct cmd_tbl *cmdtp, int flag,
740 int argc, char *const argv[])
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900741{
742 int id;
743 char *endp;
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +0200744 u16 var_name16[9];
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900745 efi_guid_t guid;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900746 u16 *label;
Heinrich Schuchardtccc41fc2022-03-23 20:26:25 +0100747 struct efi_device_path *file_path = NULL;
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100748 struct efi_device_path *fp_free = NULL;
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200749 struct efi_device_path *final_fp = NULL;
750 struct efi_device_path *initrd_dp = NULL;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900751 struct efi_load_option lo;
752 void *data = NULL;
753 efi_uintn_t size;
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200754 efi_uintn_t fp_size = 0;
Heinrich Schuchardt428a4702019-06-20 12:48:04 +0200755 efi_status_t ret;
Heinrich Schuchardta332f252019-06-20 12:59:45 +0200756 int r = CMD_RET_SUCCESS;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900757
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900758 guid = efi_global_variable_guid;
759
760 /* attributes */
761 lo.attributes = LOAD_OPTION_ACTIVE; /* always ACTIVE */
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200762 lo.optional_data = NULL;
763 lo.label = NULL;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900764
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200765 argc--;
766 argv++; /* 'add' */
767 for (; argc > 0; argc--, argv++) {
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100768 int shortform;
769
770 if (*argv[0] != '-' || strlen(argv[0]) != 2) {
771 r = CMD_RET_USAGE;
772 goto out;
773 }
774 shortform = 0;
775 switch (argv[0][1]) {
776 case 'b':
777 shortform = 1;
778 /* fallthrough */
779 case 'B':
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200780 if (argc < 5 || lo.label) {
781 r = CMD_RET_USAGE;
782 goto out;
783 }
Simon Glass7e5f4602021-07-24 09:03:29 -0600784 id = (int)hextoul(argv[1], &endp);
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200785 if (*endp != '\0' || id > 0xffff)
786 return CMD_RET_USAGE;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900787
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +0200788 efi_create_indexed_name(var_name16, sizeof(var_name16),
789 "Boot", id);
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200790
791 /* label */
Heinrich Schuchardt80fadf42022-10-06 06:48:02 +0200792 label = efi_convert_string(argv[2]);
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200793 if (!label)
794 return CMD_RET_FAILURE;
795 lo.label = label; /* label will be changed below */
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200796
797 /* file path */
798 ret = efi_dp_from_name(argv[3], argv[4], argv[5],
Heinrich Schuchardtccc41fc2022-03-23 20:26:25 +0100799 NULL, &fp_free);
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200800 if (ret != EFI_SUCCESS) {
801 printf("Cannot create device path for \"%s %s\"\n",
802 argv[3], argv[4]);
803 r = CMD_RET_FAILURE;
804 goto out;
805 }
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100806 if (shortform)
807 file_path = efi_dp_shorten(fp_free);
808 if (!file_path)
809 file_path = fp_free;
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200810 fp_size += efi_dp_size(file_path) +
811 sizeof(struct efi_device_path);
812 argc -= 5;
813 argv += 5;
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100814 break;
815 case 'i':
816 shortform = 1;
817 /* fallthrough */
818 case 'I':
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200819 if (argc < 3 || initrd_dp) {
820 r = CMD_RET_USAGE;
821 goto out;
822 }
823
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100824 initrd_dp = create_initrd_dp(argv[1], argv[2], argv[3],
825 shortform);
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200826 if (!initrd_dp) {
827 printf("Cannot add an initrd\n");
828 r = CMD_RET_FAILURE;
829 goto out;
830 }
831 argc -= 3;
832 argv += 3;
833 fp_size += efi_dp_size(initrd_dp) +
834 sizeof(struct efi_device_path);
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100835 break;
836 case 's':
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200837 if (argc < 1 || lo.optional_data) {
838 r = CMD_RET_USAGE;
839 goto out;
840 }
841 lo.optional_data = (const u8 *)argv[1];
842 argc -= 1;
843 argv += 1;
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100844 break;
845 default:
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200846 r = CMD_RET_USAGE;
847 goto out;
848 }
849 }
850
851 if (!file_path) {
852 printf("Missing binary\n");
853 r = CMD_RET_USAGE;
854 goto out;
855 }
856
857 final_fp = efi_dp_concat(file_path, initrd_dp);
858 if (!final_fp) {
859 printf("Cannot create final device path\n");
Heinrich Schuchardt428a4702019-06-20 12:48:04 +0200860 r = CMD_RET_FAILURE;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900861 goto out;
862 }
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900863
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200864 lo.file_path = final_fp;
865 lo.file_path_length = fp_size;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900866
867 size = efi_serialize_load_option(&lo, (u8 **)&data);
868 if (!size) {
Heinrich Schuchardt428a4702019-06-20 12:48:04 +0200869 r = CMD_RET_FAILURE;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900870 goto out;
871 }
872
Heinrich Schuchardtacfe1de2021-05-24 11:10:59 +0200873 ret = efi_set_variable_int(var_name16, &guid,
874 EFI_VARIABLE_NON_VOLATILE |
875 EFI_VARIABLE_BOOTSERVICE_ACCESS |
876 EFI_VARIABLE_RUNTIME_ACCESS,
877 size, data, false);
Heinrich Schuchardta332f252019-06-20 12:59:45 +0200878 if (ret != EFI_SUCCESS) {
879 printf("Cannot set %ls\n", var_name16);
880 r = CMD_RET_FAILURE;
881 }
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200882
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900883out:
884 free(data);
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200885 efi_free_pool(final_fp);
886 efi_free_pool(initrd_dp);
Heinrich Schuchardt63276a52022-02-26 12:10:10 +0100887 efi_free_pool(fp_free);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900888 free(lo.label);
889
Heinrich Schuchardt428a4702019-06-20 12:48:04 +0200890 return r;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900891}
892
893/**
894 * do_efi_boot_rm() - delete UEFI load options
895 *
896 * @cmdtp: Command table
897 * @flag: Command flag
898 * @argc: Number of arguments
899 * @argv: Argument array
900 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
901 *
902 * Implement efidebug "boot rm" sub-command.
903 * Delete UEFI load options.
Heinrich Schuchardt0b016562019-07-14 14:00:41 +0200904 *
905 * efidebug boot rm <id> ...
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900906 */
Simon Glass09140112020-05-10 11:40:03 -0600907static int do_efi_boot_rm(struct cmd_tbl *cmdtp, int flag,
908 int argc, char *const argv[])
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900909{
910 efi_guid_t guid;
911 int id, i;
912 char *endp;
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +0200913 u16 var_name16[9];
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900914 efi_status_t ret;
915
916 if (argc == 1)
917 return CMD_RET_USAGE;
918
919 guid = efi_global_variable_guid;
920 for (i = 1; i < argc; i++, argv++) {
Simon Glass7e5f4602021-07-24 09:03:29 -0600921 id = (int)hextoul(argv[1], &endp);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900922 if (*endp != '\0' || id > 0xffff)
923 return CMD_RET_FAILURE;
924
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +0200925 efi_create_indexed_name(var_name16, sizeof(var_name16),
926 "Boot", id);
Heinrich Schuchardtacfe1de2021-05-24 11:10:59 +0200927 ret = efi_set_variable_int(var_name16, &guid, 0, 0, NULL,
928 false);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900929 if (ret) {
Heinrich Schuchardt30efb5d2020-03-02 20:13:10 +0100930 printf("Cannot remove %ls\n", var_name16);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900931 return CMD_RET_FAILURE;
932 }
933 }
934
935 return CMD_RET_SUCCESS;
936}
937
938/**
939 * show_efi_boot_opt_data() - dump UEFI load option
940 *
Heinrich Schuchardtb5f4e9e2020-04-29 19:20:35 +0200941 * @varname16: variable name
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200942 * @data: value of UEFI load option variable
943 * @size: size of the boot option
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900944 *
945 * Decode the value of UEFI load option variable and print information.
946 */
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200947static void show_efi_boot_opt_data(u16 *varname16, void *data, size_t *size)
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900948{
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200949 struct efi_device_path *initrd_path = NULL;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900950 struct efi_load_option lo;
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200951 efi_status_t ret;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900952
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200953 ret = efi_deserialize_load_option(&lo, data, size);
954 if (ret != EFI_SUCCESS) {
955 printf("%ls: invalid load option\n", varname16);
956 return;
957 }
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900958
Heinrich Schuchardtb5f4e9e2020-04-29 19:20:35 +0200959 printf("%ls:\nattributes: %c%c%c (0x%08x)\n",
960 varname16,
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900961 /* ACTIVE */
962 lo.attributes & LOAD_OPTION_ACTIVE ? 'A' : '-',
963 /* FORCE RECONNECT */
964 lo.attributes & LOAD_OPTION_FORCE_RECONNECT ? 'R' : '-',
965 /* HIDDEN */
966 lo.attributes & LOAD_OPTION_HIDDEN ? 'H' : '-',
967 lo.attributes);
Heinrich Schuchardtcd5a87e2021-05-24 10:35:25 +0200968 printf(" label: %ls\n", lo.label);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900969
Heinrich Schuchardtfc42b8b2021-10-15 01:47:40 +0200970 printf(" file_path: %pD\n", lo.file_path);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900971
Heinrich Schuchardt9ad37fe2021-10-15 02:33:33 +0200972 initrd_path = efi_dp_from_lo(&lo, &efi_lf2_initrd_guid);
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200973 if (initrd_path) {
Heinrich Schuchardtfc42b8b2021-10-15 01:47:40 +0200974 printf(" initrd_path: %pD\n", initrd_path);
Ilias Apalodimascbea2412021-03-17 21:55:01 +0200975 efi_free_pool(initrd_path);
976 }
977
Heinrich Schuchardt39a1ff82019-04-29 13:51:45 +0200978 printf(" data:\n");
979 print_hex_dump(" ", DUMP_PREFIX_OFFSET, 16, 1,
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +0200980 lo.optional_data, *size, true);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900981}
982
983/**
984 * show_efi_boot_opt() - dump UEFI load option
985 *
Heinrich Schuchardtb5f4e9e2020-04-29 19:20:35 +0200986 * @varname16: variable name
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900987 *
988 * Dump information defined by UEFI load option.
989 */
Heinrich Schuchardtb5f4e9e2020-04-29 19:20:35 +0200990static void show_efi_boot_opt(u16 *varname16)
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900991{
Heinrich Schuchardtb5f4e9e2020-04-29 19:20:35 +0200992 void *data;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900993 efi_uintn_t size;
AKASHI Takahiro0bffb8c2019-11-26 10:11:22 +0900994 efi_status_t ret;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900995
AKASHI Takahiro59df7e72019-02-25 15:54:38 +0900996 size = 0;
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +0200997 ret = efi_get_variable_int(varname16, &efi_global_variable_guid,
998 NULL, &size, NULL, NULL);
AKASHI Takahiro0bffb8c2019-11-26 10:11:22 +0900999 if (ret == EFI_BUFFER_TOO_SMALL) {
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001000 data = malloc(size);
Heinrich Schuchardtb5f4e9e2020-04-29 19:20:35 +02001001 if (!data) {
1002 printf("ERROR: Out of memory\n");
1003 return;
1004 }
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +02001005 ret = efi_get_variable_int(varname16, &efi_global_variable_guid,
1006 NULL, &size, data, NULL);
Heinrich Schuchardtb5f4e9e2020-04-29 19:20:35 +02001007 if (ret == EFI_SUCCESS)
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +02001008 show_efi_boot_opt_data(varname16, data, &size);
Heinrich Schuchardtb5f4e9e2020-04-29 19:20:35 +02001009 free(data);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001010 }
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001011}
1012
1013/**
1014 * show_efi_boot_dump() - dump all UEFI load options
1015 *
1016 * @cmdtp: Command table
1017 * @flag: Command flag
1018 * @argc: Number of arguments
1019 * @argv: Argument array
1020 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
1021 *
1022 * Implement efidebug "boot dump" sub-command.
1023 * Dump information of all UEFI load options defined.
Heinrich Schuchardta6ccba02019-07-25 20:52:23 +02001024 *
1025 * efidebug boot dump
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001026 */
Simon Glass09140112020-05-10 11:40:03 -06001027static int do_efi_boot_dump(struct cmd_tbl *cmdtp, int flag,
1028 int argc, char *const argv[])
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001029{
AKASHI Takahiroffe21572019-04-26 09:44:18 +09001030 u16 *var_name16, *p;
1031 efi_uintn_t buf_size, size;
1032 efi_guid_t guid;
AKASHI Takahiroffe21572019-04-26 09:44:18 +09001033 efi_status_t ret;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001034
1035 if (argc > 1)
1036 return CMD_RET_USAGE;
1037
AKASHI Takahiroffe21572019-04-26 09:44:18 +09001038 buf_size = 128;
1039 var_name16 = malloc(buf_size);
1040 if (!var_name16)
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001041 return CMD_RET_FAILURE;
1042
AKASHI Takahiroffe21572019-04-26 09:44:18 +09001043 var_name16[0] = 0;
1044 for (;;) {
1045 size = buf_size;
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +02001046 ret = efi_get_next_variable_name_int(&size, var_name16, &guid);
AKASHI Takahiroffe21572019-04-26 09:44:18 +09001047 if (ret == EFI_NOT_FOUND)
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001048 break;
AKASHI Takahiroffe21572019-04-26 09:44:18 +09001049 if (ret == EFI_BUFFER_TOO_SMALL) {
1050 buf_size = size;
1051 p = realloc(var_name16, buf_size);
1052 if (!p) {
1053 free(var_name16);
1054 return CMD_RET_FAILURE;
1055 }
1056 var_name16 = p;
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +02001057 ret = efi_get_next_variable_name_int(&size, var_name16,
1058 &guid);
AKASHI Takahiroffe21572019-04-26 09:44:18 +09001059 }
1060 if (ret != EFI_SUCCESS) {
1061 free(var_name16);
1062 return CMD_RET_FAILURE;
1063 }
1064
Masahisa Kojima3ac026a2022-12-02 13:59:35 +09001065 if (efi_varname_is_load_option(var_name16, NULL))
Heinrich Schuchardtb5f4e9e2020-04-29 19:20:35 +02001066 show_efi_boot_opt(var_name16);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001067 }
AKASHI Takahiroffe21572019-04-26 09:44:18 +09001068
1069 free(var_name16);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001070
1071 return CMD_RET_SUCCESS;
1072}
1073
1074/**
1075 * show_efi_boot_order() - show order of UEFI load options
1076 *
1077 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
1078 *
1079 * Show order of UEFI load options defined by BootOrder variable.
1080 */
1081static int show_efi_boot_order(void)
1082{
Heinrich Schuchardtf9f5f922020-04-29 21:15:08 +02001083 u16 *bootorder;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001084 efi_uintn_t size;
1085 int num, i;
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +02001086 u16 var_name16[9];
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001087 void *data;
1088 struct efi_load_option lo;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001089 efi_status_t ret;
1090
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001091 size = 0;
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +02001092 ret = efi_get_variable_int(u"BootOrder", &efi_global_variable_guid,
1093 NULL, &size, NULL, NULL);
Heinrich Schuchardtf9f5f922020-04-29 21:15:08 +02001094 if (ret != EFI_BUFFER_TOO_SMALL) {
1095 if (ret == EFI_NOT_FOUND) {
1096 printf("BootOrder not defined\n");
1097 return CMD_RET_SUCCESS;
1098 } else {
1099 return CMD_RET_FAILURE;
1100 }
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001101 }
Heinrich Schuchardtf9f5f922020-04-29 21:15:08 +02001102 bootorder = malloc(size);
1103 if (!bootorder) {
1104 printf("ERROR: Out of memory\n");
1105 return CMD_RET_FAILURE;
1106 }
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +02001107 ret = efi_get_variable_int(u"BootOrder", &efi_global_variable_guid,
1108 NULL, &size, bootorder, NULL);
Heinrich Schuchardtf9f5f922020-04-29 21:15:08 +02001109 if (ret != EFI_SUCCESS) {
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001110 ret = CMD_RET_FAILURE;
1111 goto out;
1112 }
1113
1114 num = size / sizeof(u16);
1115 for (i = 0; i < num; i++) {
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +02001116 efi_create_indexed_name(var_name16, sizeof(var_name16),
Heinrich Schuchardt2b8723c2021-06-12 00:01:44 +02001117 "Boot", bootorder[i]);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001118
1119 size = 0;
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +02001120 ret = efi_get_variable_int(var_name16,
1121 &efi_global_variable_guid, NULL,
1122 &size, NULL, NULL);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001123 if (ret != EFI_BUFFER_TOO_SMALL) {
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +02001124 printf("%2d: %ls: (not defined)\n", i + 1, var_name16);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001125 continue;
1126 }
1127
1128 data = malloc(size);
1129 if (!data) {
1130 ret = CMD_RET_FAILURE;
1131 goto out;
1132 }
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +02001133 ret = efi_get_variable_int(var_name16,
1134 &efi_global_variable_guid, NULL,
1135 &size, data, NULL);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001136 if (ret != EFI_SUCCESS) {
1137 free(data);
1138 ret = CMD_RET_FAILURE;
1139 goto out;
1140 }
1141
Heinrich Schuchardt0e69bcf2020-05-31 22:46:09 +02001142 ret = efi_deserialize_load_option(&lo, data, &size);
1143 if (ret != EFI_SUCCESS) {
1144 printf("%ls: invalid load option\n", var_name16);
1145 ret = CMD_RET_FAILURE;
1146 goto out;
1147 }
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001148
Heinrich Schuchardt2ecee312021-05-24 10:57:03 +02001149 printf("%2d: %ls: %ls\n", i + 1, var_name16, lo.label);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001150
1151 free(data);
1152 }
1153out:
1154 free(bootorder);
1155
1156 return ret;
1157}
1158
1159/**
1160 * do_efi_boot_next() - manage UEFI BootNext variable
1161 *
1162 * @cmdtp: Command table
1163 * @flag: Command flag
1164 * @argc: Number of arguments
1165 * @argv: Argument array
1166 * Return: CMD_RET_SUCCESS on success,
1167 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1168 *
1169 * Implement efidebug "boot next" sub-command.
1170 * Set BootNext variable.
Heinrich Schuchardt0b016562019-07-14 14:00:41 +02001171 *
1172 * efidebug boot next <id>
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001173 */
Simon Glass09140112020-05-10 11:40:03 -06001174static int do_efi_boot_next(struct cmd_tbl *cmdtp, int flag,
1175 int argc, char *const argv[])
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001176{
1177 u16 bootnext;
1178 efi_uintn_t size;
1179 char *endp;
1180 efi_guid_t guid;
1181 efi_status_t ret;
Heinrich Schuchardta332f252019-06-20 12:59:45 +02001182 int r = CMD_RET_SUCCESS;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001183
1184 if (argc != 2)
1185 return CMD_RET_USAGE;
1186
Simon Glass7e5f4602021-07-24 09:03:29 -06001187 bootnext = (u16)hextoul(argv[1], &endp);
Heinrich Schuchardtbdb15772020-05-09 17:59:19 +02001188 if (*endp) {
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001189 printf("invalid value: %s\n", argv[1]);
Heinrich Schuchardt428a4702019-06-20 12:48:04 +02001190 r = CMD_RET_FAILURE;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001191 goto out;
1192 }
1193
1194 guid = efi_global_variable_guid;
1195 size = sizeof(u16);
Simon Glass156ccbc2022-01-23 12:55:12 -07001196 ret = efi_set_variable_int(u"BootNext", &guid,
1197 EFI_VARIABLE_NON_VOLATILE |
1198 EFI_VARIABLE_BOOTSERVICE_ACCESS |
1199 EFI_VARIABLE_RUNTIME_ACCESS,
1200 size, &bootnext, false);
Heinrich Schuchardta332f252019-06-20 12:59:45 +02001201 if (ret != EFI_SUCCESS) {
1202 printf("Cannot set BootNext\n");
1203 r = CMD_RET_FAILURE;
1204 }
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001205out:
Heinrich Schuchardt428a4702019-06-20 12:48:04 +02001206 return r;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001207}
1208
1209/**
1210 * do_efi_boot_order() - manage UEFI BootOrder variable
1211 *
1212 * @cmdtp: Command table
1213 * @flag: Command flag
1214 * @argc: Number of arguments
1215 * @argv: Argument array
1216 * Return: CMD_RET_SUCCESS on success, CMD_RET_RET_FAILURE on failure
1217 *
1218 * Implement efidebug "boot order" sub-command.
1219 * Show order of UEFI load options, or change it in BootOrder variable.
Heinrich Schuchardt0b016562019-07-14 14:00:41 +02001220 *
1221 * efidebug boot order [<id> ...]
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001222 */
Simon Glass09140112020-05-10 11:40:03 -06001223static int do_efi_boot_order(struct cmd_tbl *cmdtp, int flag,
1224 int argc, char *const argv[])
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001225{
1226 u16 *bootorder = NULL;
1227 efi_uintn_t size;
1228 int id, i;
1229 char *endp;
1230 efi_guid_t guid;
1231 efi_status_t ret;
Heinrich Schuchardta332f252019-06-20 12:59:45 +02001232 int r = CMD_RET_SUCCESS;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001233
1234 if (argc == 1)
1235 return show_efi_boot_order();
1236
1237 argc--;
1238 argv++;
1239
1240 size = argc * sizeof(u16);
1241 bootorder = malloc(size);
1242 if (!bootorder)
1243 return CMD_RET_FAILURE;
1244
1245 for (i = 0; i < argc; i++) {
Simon Glass7e5f4602021-07-24 09:03:29 -06001246 id = (int)hextoul(argv[i], &endp);
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001247 if (*endp != '\0' || id > 0xffff) {
1248 printf("invalid value: %s\n", argv[i]);
Heinrich Schuchardt428a4702019-06-20 12:48:04 +02001249 r = CMD_RET_FAILURE;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001250 goto out;
1251 }
1252
1253 bootorder[i] = (u16)id;
1254 }
1255
1256 guid = efi_global_variable_guid;
Simon Glass156ccbc2022-01-23 12:55:12 -07001257 ret = efi_set_variable_int(u"BootOrder", &guid,
1258 EFI_VARIABLE_NON_VOLATILE |
1259 EFI_VARIABLE_BOOTSERVICE_ACCESS |
1260 EFI_VARIABLE_RUNTIME_ACCESS,
1261 size, bootorder, true);
Heinrich Schuchardta332f252019-06-20 12:59:45 +02001262 if (ret != EFI_SUCCESS) {
1263 printf("Cannot set BootOrder\n");
1264 r = CMD_RET_FAILURE;
1265 }
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001266out:
1267 free(bootorder);
1268
Heinrich Schuchardt428a4702019-06-20 12:48:04 +02001269 return r;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001270}
1271
Simon Glass09140112020-05-10 11:40:03 -06001272static struct cmd_tbl cmd_efidebug_boot_sub[] = {
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001273 U_BOOT_CMD_MKENT(add, CONFIG_SYS_MAXARGS, 1, do_efi_boot_add, "", ""),
1274 U_BOOT_CMD_MKENT(rm, CONFIG_SYS_MAXARGS, 1, do_efi_boot_rm, "", ""),
1275 U_BOOT_CMD_MKENT(dump, CONFIG_SYS_MAXARGS, 1, do_efi_boot_dump, "", ""),
1276 U_BOOT_CMD_MKENT(next, CONFIG_SYS_MAXARGS, 1, do_efi_boot_next, "", ""),
1277 U_BOOT_CMD_MKENT(order, CONFIG_SYS_MAXARGS, 1, do_efi_boot_order,
1278 "", ""),
1279};
1280
1281/**
1282 * do_efi_boot_opt() - manage UEFI load options
1283 *
1284 * @cmdtp: Command table
1285 * @flag: Command flag
1286 * @argc: Number of arguments
1287 * @argv: Argument array
1288 * Return: CMD_RET_SUCCESS on success,
1289 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1290 *
1291 * Implement efidebug "boot" sub-command.
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001292 */
Simon Glass09140112020-05-10 11:40:03 -06001293static int do_efi_boot_opt(struct cmd_tbl *cmdtp, int flag,
1294 int argc, char *const argv[])
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001295{
Simon Glass09140112020-05-10 11:40:03 -06001296 struct cmd_tbl *cp;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001297
1298 if (argc < 2)
1299 return CMD_RET_USAGE;
1300
1301 argc--; argv++;
1302
1303 cp = find_cmd_tbl(argv[0], cmd_efidebug_boot_sub,
1304 ARRAY_SIZE(cmd_efidebug_boot_sub));
1305 if (!cp)
1306 return CMD_RET_USAGE;
1307
1308 return cp->cmd(cmdtp, flag, argc, argv);
1309}
1310
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001311/**
1312 * do_efi_test_bootmgr() - run simple bootmgr for test
1313 *
1314 * @cmdtp: Command table
1315 * @flag: Command flag
1316 * @argc: Number of arguments
1317 * @argv: Argument array
1318 * Return: CMD_RET_SUCCESS on success,
1319 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1320 *
1321 * Implement efidebug "test bootmgr" sub-command.
1322 * Run simple bootmgr for test.
1323 *
1324 * efidebug test bootmgr
1325 */
Heinrich Schuchardtff2f5322021-01-15 19:02:50 +01001326static __maybe_unused int do_efi_test_bootmgr(struct cmd_tbl *cmdtp, int flag,
1327 int argc, char * const argv[])
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001328{
1329 efi_handle_t image;
1330 efi_uintn_t exit_data_size = 0;
1331 u16 *exit_data = NULL;
1332 efi_status_t ret;
Heinrich Schuchardtbc78d222020-08-11 18:20:50 +02001333 void *load_options = NULL;
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001334
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +02001335 ret = efi_bootmgr_load(&image, &load_options);
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001336 printf("efi_bootmgr_load() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1337
1338 /* We call efi_start_image() even if error for test purpose. */
1339 ret = EFI_CALL(efi_start_image(image, &exit_data_size, &exit_data));
1340 printf("efi_start_image() returned: %ld\n", ret & ~EFI_ERROR_MASK);
1341 if (ret && exit_data)
1342 efi_free_pool(exit_data);
1343
1344 efi_restore_gd();
1345
Heinrich Schuchardt0ad64002020-08-07 17:49:39 +02001346 free(load_options);
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001347 return CMD_RET_SUCCESS;
1348}
1349
Simon Glass09140112020-05-10 11:40:03 -06001350static struct cmd_tbl cmd_efidebug_test_sub[] = {
Heinrich Schuchardtff2f5322021-01-15 19:02:50 +01001351#ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001352 U_BOOT_CMD_MKENT(bootmgr, CONFIG_SYS_MAXARGS, 1, do_efi_test_bootmgr,
1353 "", ""),
Heinrich Schuchardtff2f5322021-01-15 19:02:50 +01001354#endif
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001355};
1356
1357/**
1358 * do_efi_test() - manage UEFI load options
1359 *
1360 * @cmdtp: Command table
1361 * @flag: Command flag
1362 * @argc: Number of arguments
1363 * @argv: Argument array
1364 * Return: CMD_RET_SUCCESS on success,
1365 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1366 *
1367 * Implement efidebug "test" sub-command.
1368 */
Simon Glass09140112020-05-10 11:40:03 -06001369static int do_efi_test(struct cmd_tbl *cmdtp, int flag,
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001370 int argc, char * const argv[])
1371{
Simon Glass09140112020-05-10 11:40:03 -06001372 struct cmd_tbl *cp;
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001373
1374 if (argc < 2)
1375 return CMD_RET_USAGE;
1376
1377 argc--; argv++;
1378
1379 cp = find_cmd_tbl(argv[0], cmd_efidebug_test_sub,
1380 ARRAY_SIZE(cmd_efidebug_test_sub));
1381 if (!cp)
1382 return CMD_RET_USAGE;
1383
1384 return cp->cmd(cmdtp, flag, argc, argv);
1385}
1386
Ilias Apalodimasb0e4f2c2020-05-17 22:25:45 +03001387/**
1388 * do_efi_query_info() - QueryVariableInfo EFI service
1389 *
1390 * @cmdtp: Command table
1391 * @flag: Command flag
1392 * @argc: Number of arguments
1393 * @argv: Argument array
1394 * Return: CMD_RET_SUCCESS on success,
1395 * CMD_RET_USAGE or CMD_RET_FAILURE on failure
1396 *
1397 * Implement efidebug "test" sub-command.
1398 */
1399
Simon Glass09140112020-05-10 11:40:03 -06001400static int do_efi_query_info(struct cmd_tbl *cmdtp, int flag,
Ilias Apalodimasb0e4f2c2020-05-17 22:25:45 +03001401 int argc, char * const argv[])
1402{
1403 efi_status_t ret;
1404 u32 attr = 0;
1405 u64 max_variable_storage_size;
1406 u64 remain_variable_storage_size;
1407 u64 max_variable_size;
1408 int i;
1409
1410 for (i = 1; i < argc; i++) {
1411 if (!strcmp(argv[i], "-bs"))
1412 attr |= EFI_VARIABLE_BOOTSERVICE_ACCESS;
1413 else if (!strcmp(argv[i], "-rt"))
1414 attr |= EFI_VARIABLE_RUNTIME_ACCESS;
1415 else if (!strcmp(argv[i], "-nv"))
1416 attr |= EFI_VARIABLE_NON_VOLATILE;
1417 else if (!strcmp(argv[i], "-at"))
1418 attr |=
1419 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
1420 }
1421
Heinrich Schuchardtf4d52c42022-10-15 13:21:01 +02001422 ret = efi_query_variable_info_int(attr, &max_variable_storage_size,
1423 &remain_variable_storage_size,
1424 &max_variable_size);
Ilias Apalodimasb0e4f2c2020-05-17 22:25:45 +03001425 if (ret != EFI_SUCCESS) {
1426 printf("Error: Cannot query UEFI variables, r = %lu\n",
1427 ret & ~EFI_ERROR_MASK);
1428 return CMD_RET_FAILURE;
1429 }
1430
1431 printf("Max storage size %llu\n", max_variable_storage_size);
1432 printf("Remaining storage size %llu\n", remain_variable_storage_size);
1433 printf("Max variable size %llu\n", max_variable_size);
1434
1435 return CMD_RET_SUCCESS;
1436}
1437
Simon Glass09140112020-05-10 11:40:03 -06001438static struct cmd_tbl cmd_efidebug_sub[] = {
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001439 U_BOOT_CMD_MKENT(boot, CONFIG_SYS_MAXARGS, 1, do_efi_boot_opt, "", ""),
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +09001440#ifdef CONFIG_EFI_HAVE_CAPSULE_SUPPORT
1441 U_BOOT_CMD_MKENT(capsule, CONFIG_SYS_MAXARGS, 1, do_efi_capsule,
1442 "", ""),
1443#endif
AKASHI Takahiro66eaf562019-02-25 15:54:40 +09001444 U_BOOT_CMD_MKENT(drivers, CONFIG_SYS_MAXARGS, 1, do_efi_show_drivers,
1445 "", ""),
AKASHI Takahiroa8014622019-02-25 15:54:41 +09001446 U_BOOT_CMD_MKENT(dh, CONFIG_SYS_MAXARGS, 1, do_efi_show_handles,
1447 "", ""),
AKASHI Takahirofa536732019-02-25 15:54:42 +09001448 U_BOOT_CMD_MKENT(images, CONFIG_SYS_MAXARGS, 1, do_efi_show_images,
1449 "", ""),
AKASHI Takahiro00358bb2019-02-25 15:54:43 +09001450 U_BOOT_CMD_MKENT(memmap, CONFIG_SYS_MAXARGS, 1, do_efi_show_memmap,
1451 "", ""),
Heinrich Schuchardt986e0642020-01-07 05:57:47 +01001452 U_BOOT_CMD_MKENT(tables, CONFIG_SYS_MAXARGS, 1, do_efi_show_tables,
1453 "", ""),
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001454 U_BOOT_CMD_MKENT(test, CONFIG_SYS_MAXARGS, 1, do_efi_test,
1455 "", ""),
Ilias Apalodimasb0e4f2c2020-05-17 22:25:45 +03001456 U_BOOT_CMD_MKENT(query, CONFIG_SYS_MAXARGS, 1, do_efi_query_info,
1457 "", ""),
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001458};
1459
1460/**
1461 * do_efidebug() - display and configure UEFI environment
1462 *
1463 * @cmdtp: Command table
1464 * @flag: Command flag
1465 * @argc: Number of arguments
1466 * @argv: Argument array
1467 * Return: CMD_RET_SUCCESS on success,
1468 * CMD_RET_USAGE or CMD_RET_RET_FAILURE on failure
1469 *
1470 * Implement efidebug command which allows us to display and
1471 * configure UEFI environment.
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001472 */
Simon Glass09140112020-05-10 11:40:03 -06001473static int do_efidebug(struct cmd_tbl *cmdtp, int flag,
1474 int argc, char *const argv[])
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001475{
Simon Glass09140112020-05-10 11:40:03 -06001476 struct cmd_tbl *cp;
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001477 efi_status_t r;
1478
1479 if (argc < 2)
1480 return CMD_RET_USAGE;
1481
1482 argc--; argv++;
1483
1484 /* Initialize UEFI drivers */
1485 r = efi_init_obj_list();
1486 if (r != EFI_SUCCESS) {
1487 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
1488 r & ~EFI_ERROR_MASK);
1489 return CMD_RET_FAILURE;
1490 }
1491
1492 cp = find_cmd_tbl(argv[0], cmd_efidebug_sub,
1493 ARRAY_SIZE(cmd_efidebug_sub));
1494 if (!cp)
1495 return CMD_RET_USAGE;
1496
1497 return cp->cmd(cmdtp, flag, argc, argv);
1498}
1499
1500#ifdef CONFIG_SYS_LONGHELP
1501static char efidebug_help_text[] =
1502 " - UEFI Shell-like interface to configure UEFI environment\n"
1503 "\n"
Heinrich Schuchardt63276a52022-02-26 12:10:10 +01001504 "efidebug boot add - set UEFI BootXXXX variable\n"
1505 " -b|-B <bootid> <label> <interface> <devnum>[:<part>] <file path>\n"
1506 " -i|-I <interface> <devnum>[:<part>] <initrd file path>\n"
1507 " (-b, -i for short form device path)\n"
1508 " -s '<optional data>'\n"
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001509 "efidebug boot rm <bootid#1> [<bootid#2> [<bootid#3> [...]]]\n"
1510 " - delete UEFI BootXXXX variables\n"
1511 "efidebug boot dump\n"
1512 " - dump all UEFI BootXXXX variables\n"
1513 "efidebug boot next <bootid>\n"
1514 " - set UEFI BootNext variable\n"
1515 "efidebug boot order [<bootid#1> [<bootid#2> [<bootid#3> [...]]]]\n"
1516 " - set/show UEFI boot order\n"
AKASHI Takahiro355cdb52019-02-25 15:54:39 +09001517 "\n"
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +09001518#ifdef CONFIG_EFI_HAVE_CAPSULE_SUPPORT
1519 "efidebug capsule update [-v] <capsule address>\n"
1520 " - process a capsule\n"
Sughosh Ganu74075952020-12-30 19:27:11 +05301521 "efidebug capsule disk-update\n"
1522 " - update a capsule from disk\n"
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +09001523 "efidebug capsule show <capsule address>\n"
1524 " - show capsule information\n"
1525 "efidebug capsule result [<capsule result var>]\n"
1526 " - show a capsule update result\n"
Jose Marinhoaa31a872021-03-11 13:18:51 +00001527#ifdef CONFIG_EFI_ESRT
1528 "efidebug capsule esrt\n"
1529 " - print the ESRT\n"
1530#endif
AKASHI Takahiro7f35ced2020-11-17 09:28:01 +09001531 "\n"
1532#endif
AKASHI Takahiro66eaf562019-02-25 15:54:40 +09001533 "efidebug drivers\n"
Heinrich Schuchardt07e2fe72020-01-07 07:48:15 +01001534 " - show UEFI drivers\n"
AKASHI Takahiroa8014622019-02-25 15:54:41 +09001535 "efidebug dh\n"
Heinrich Schuchardt07e2fe72020-01-07 07:48:15 +01001536 " - show UEFI handles\n"
AKASHI Takahirofa536732019-02-25 15:54:42 +09001537 "efidebug images\n"
AKASHI Takahiro00358bb2019-02-25 15:54:43 +09001538 " - show loaded images\n"
1539 "efidebug memmap\n"
Heinrich Schuchardt07e2fe72020-01-07 07:48:15 +01001540 " - show UEFI memory map\n"
Heinrich Schuchardt986e0642020-01-07 05:57:47 +01001541 "efidebug tables\n"
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001542 " - show UEFI configuration tables\n"
Heinrich Schuchardtff2f5322021-01-15 19:02:50 +01001543#ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
AKASHI Takahiro525fc062020-04-14 11:51:48 +09001544 "efidebug test bootmgr\n"
Ilias Apalodimasb0e4f2c2020-05-17 22:25:45 +03001545 " - run simple bootmgr for test\n"
Heinrich Schuchardtff2f5322021-01-15 19:02:50 +01001546#endif
Ilias Apalodimasb0e4f2c2020-05-17 22:25:45 +03001547 "efidebug query [-nv][-bs][-rt][-at]\n"
1548 " - show size of UEFI variables store\n";
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001549#endif
1550
1551U_BOOT_CMD(
Ilias Apalodimascbea2412021-03-17 21:55:01 +02001552 efidebug, CONFIG_SYS_MAXARGS, 0, do_efidebug,
AKASHI Takahiro59df7e72019-02-25 15:54:38 +09001553 "Configure UEFI environment",
1554 efidebug_help_text
1555);