Blame view

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