| Masahisa Kojima | dfcf0e5 | 2022-09-12 17:33:58 +0900 | [diff] [blame] | 1 | .. SPDX-License-Identifier: GPL-2.0+ |
| 2 | .. (C) Copyright 2022, Masahisa Kojima <masahisa.kojima@linaro.org> |
| 3 | |
| 4 | eficonfig command |
| 5 | ================= |
| 6 | |
| 7 | Synopsis |
| 8 | -------- |
| 9 | :: |
| 10 | |
| 11 | eficonfig |
| 12 | |
| 13 | Description |
| 14 | ----------- |
| 15 | |
| 16 | The "eficonfig" command uses U-Boot menu interface and provides |
| 17 | a menu-driven UEFI variable maintenance feature. |
| 18 | The "eficonfig" has the following menu entries. |
| 19 | |
| 20 | Add Boot Option |
| 21 | Add new UEFI Boot Option. |
| 22 | User can edit description, file path, and optional_data. |
| 23 | |
| 24 | Edit Boot Option |
| 25 | Edit the existing UEFI Boot Option |
| 26 | User can edit description, file path, and optional_data. |
| 27 | |
| 28 | Change Boot Order |
| 29 | Change the order of UEFI BootOrder variable. |
| 30 | |
| 31 | Delete Boot Option |
| 32 | Delete the UEFI Boot Option |
| 33 | |
| 34 | Configuration |
| 35 | ------------- |
| 36 | |
| 37 | The "eficonfig" command is enabled by:: |
| 38 | |
| 39 | CONFIG_CMD_EFICONFIG=y |
| 40 | |
| 41 | If CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE is enabled, user can not enter |
| 42 | U-Boot console. In this case, bootmenu can be used to invoke "eficonfig":: |
| 43 | |
| 44 | CONFIG_USE_PREBOOT=y |
| 45 | CONFIG_PREBOOT="setenv bootmenu_0 UEFI Maintenance Menu=eficonfig" |
| 46 | |
| 47 | How to boot the system with newly added UEFI Boot Option |
| 48 | '''''''''''''''''''''''''''''''''''''''''''''''''''''''' |
| 49 | |
| 50 | "eficonfig" command is responsible for configuring the UEFI variables, |
| 51 | not directly handle the system boot. |
| 52 | The new Boot Option added by "eficonfig" is appended at the last entry |
| 53 | of UEFI BootOrder variable, user may want to change the boot order |
| 54 | through "Change Boot Order". |
| 55 | If the bootmenu is enabled, CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE is enabled, |
| 56 | and "eficonfig" is configured as preboot command, the newly added Boot Options |
| 57 | are enumerated in the bootmenu when user exits from the eficonfig menu. |
| 58 | User may select the entry in the bootmenu to boot the system, or follow |
| 59 | the U-Boot configuration the system already has. |
| 60 | |
| 61 | Auto boot with the UEFI Boot Option |
| 62 | ''''''''''''''''''''''''''''''''''' |
| 63 | |
| 64 | To do auto boot according to the UEFI BootOrder variable, |
| 65 | add "bootefi bootmgr" entry as a default or first bootmenu entry:: |
| 66 | |
| 67 | CONFIG_PREBOOT="setenv bootmenu_0 UEFI Boot Manager=bootefi bootmgr; setenv bootmenu_1 UEFI Maintenance Menu=eficonfig" |
| 68 | |
| 69 | See also |
| 70 | -------- |
| 71 | * :doc:`bootmenu<bootmenu>` provides a simple mechanism for creating menus with different boot items |