doc/api/efi.rst

   1 .. SPDX-License-Identifier: GPL-2.0+
   2
   3 UEFI subsystem
   4 ==============
   5
   6 Lauching UEFI images
   7 --------------------
   8
   9 Bootefi command
  10 ~~~~~~~~~~~~~~~
  11
  12 The bootefi command is used to start UEFI applications or to install UEFI
  13 drivers. It takes two parameters
  14
  15     bootefi <image address> [fdt address]
  16
  17 * image address - the memory address of the UEFI binary
  18 * fdt address - the memory address of the flattened device tree
  19
  20 The environment variable 'bootargs' is passed as load options in the UEFI system
  21 table. The Linux kernel EFI stub uses the load options as command line
  22 arguments.
  23
  24 .. kernel-doc:: cmd/bootefi.c
  25    :internal:
  26
  27 Boot manager
  28 ~~~~~~~~~~~~
  29
  30 The UEFI specification foresees to define boot entries and boot sequence via UEFI
  31 variables. Booting according to these variables is possible via
  32
  33     bootefi bootmgr [fdt address]
  34
  35 * fdt address - the memory address of the flattened device tree
  36
  37 The relevant variables are:
  38
  39 * Boot0000-BootFFFF define boot entries
  40 * BootNext specifies next boot option to be booted
  41 * BootOrder specifies in which sequence the boot options shall be tried if
  42   BootNext is not defined or booting via BootNext fails
  43
  44 .. kernel-doc:: lib/efi_loader/efi_bootmgr.c
  45    :internal:
  46
  47 Efidebug command
  48 ~~~~~~~~~~~~~~~~
  49
  50 The efidebug command is used to set and display boot options as well as to
  51 display information about internal data of the UEFI subsystem (devices,
  52 drivers, handles, loaded images, and the memory map).
  53
  54 .. kernel-doc:: cmd/efidebug.c
  55    :internal:
  56
  57 Initialization of the UEFI sub-system
  58 -------------------------------------
  59
  60 .. kernel-doc:: lib/efi_loader/efi_setup.c
  61    :internal:
  62
  63 Boot services
  64 -------------
  65
  66 .. kernel-doc:: lib/efi_loader/efi_boottime.c
  67    :internal:
  68
  69 Image relocation
  70 ~~~~~~~~~~~~~~~~
  71
  72 .. kernel-doc:: lib/efi_loader/efi_image_loader.c
  73    :internal:
  74
  75 Memory services
  76 ~~~~~~~~~~~~~~~
  77
  78 .. kernel-doc:: lib/efi_loader/efi_memory.c
  79    :internal:
  80
  81 SetWatchdogTimer service
  82 ~~~~~~~~~~~~~~~~~~~~~~~~
  83
  84 .. kernel-doc:: lib/efi_loader/efi_watchdog.c
  85    :internal:
  86
  87 Runtime services
  88 ----------------
  89
  90 .. kernel-doc:: lib/efi_loader/efi_runtime.c
  91    :internal:
  92
  93 Variable services
  94 ~~~~~~~~~~~~~~~~~
  95
  96 .. kernel-doc:: lib/efi_loader/efi_variable.c
  97    :internal:
  98
  99 UEFI drivers
 100 ------------
 101
 102 UEFI driver uclass
 103 ~~~~~~~~~~~~~~~~~~
 104 .. kernel-doc:: lib/efi_driver/efi_uclass.c
 105    :internal:
 106
 107 Block device driver
 108 ~~~~~~~~~~~~~~~~~~~
 109
 110 .. kernel-doc:: lib/efi_driver/efi_block_device.c
 111    :internal:
 112
 113 Protocols
 114 ---------
 115
 116 Block IO protocol
 117 ~~~~~~~~~~~~~~~~~
 118
 119 .. kernel-doc:: lib/efi_loader/efi_disk.c
 120    :internal:
 121
 122 File protocol
 123 ~~~~~~~~~~~~~
 124
 125 .. kernel-doc:: lib/efi_loader/efi_file.c
 126    :internal:
 127
 128 Graphical output protocol
 129 ~~~~~~~~~~~~~~~~~~~~~~~~~
 130
 131 .. kernel-doc:: lib/efi_loader/efi_gop.c
 132    :internal:
 133
 134 Load file 2 protocol
 135 ~~~~~~~~~~~~~~~~~~~~
 136
 137 The load file 2 protocol can be used by the Linux kernel to load the initial
 138 RAM disk. U-Boot can be configured to provide an implementation.
 139
 140 .. kernel-doc:: lib/efi_loader/efi_load_initrd.c
 141    :internal:
 142
 143 Network protocols
 144 ~~~~~~~~~~~~~~~~~
 145
 146 .. kernel-doc:: lib/efi_loader/efi_net.c
 147    :internal:
 148
 149 Random number generator protocol
 150 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 151
 152 .. kernel-doc:: lib/efi_loader/efi_rng.c
 153    :internal:
 154
 155 Text IO protocols
 156 ~~~~~~~~~~~~~~~~~
 157
 158 .. kernel-doc:: lib/efi_loader/efi_console.c
 159    :internal:
 160
 161 Unicode Collation protocol
 162 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 163
 164 .. kernel-doc:: lib/efi_loader/efi_unicode_collation.c
 165    :internal: