Skip to content

Commit 30c9646

Browse files
sjg20xypron
sjg20
authored and
xypron
committed
doc: Add help for the efi command
This command currently has no help. Add some. Signed-off-by: Simon Glass <[email protected]>
1 parent 4e5e49a commit 30c9646

File tree

2 files changed

+198
-0
lines changed

2 files changed

+198
-0
lines changed

‎doc/usage/cmd/efi.rst

+197
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
.. SPDX-License-Identifier: GPL-2.0+
2+
.. Copyright 2020, Heinrich Schuchardt <[email protected]>
3+
4+
efi command
5+
===========
6+
7+
Synopsis
8+
--------
9+
10+
::
11+
12+
efi mem [all]
13+
14+
Description
15+
-----------
16+
17+
The *efi* command provides information about the EFI environment U-Boot is
18+
running in, when it is started from EFI.
19+
20+
When running as an EFI app, this command queries EFI boot services for the
21+
information. When running as an EFI payload, EFI boot services have been
22+
stopped, so it uses the information collected by the boot stub before that
23+
happened.
24+
25+
efi mem
26+
~~~~~~~
27+
28+
This shows the EFI memory map, sorted in order of physical address.
29+
30+
This is normally a very large table. To help reduce the amount of detritus,
31+
boot-time memory is normally merged with conventional memory. Use the 'all'
32+
argument to show everything.
33+
34+
The fields are as follows:
35+
36+
#
37+
Entry number (sequentially from 0)
38+
39+
Type
40+
Memory type. EFI has a large number of memory types. The type is shown in
41+
the format <n>:<name> where in is the format number in hex and <name> is the
42+
name.
43+
44+
Physical
45+
Physical address
46+
47+
Virtual
48+
Virtual address
49+
50+
Size
51+
Size of memory area in bytes
52+
53+
Attributes
54+
Shows a code for memory attributes. The key for this is shown below the
55+
table.
56+
57+
Example
58+
-------
59+
60+
::
61+
62+
=> efi mem
63+
EFI table at 0, memory map 000000001ad38b60, size 1260, key a79, version 1, descr. size 0x30
64+
# Type Physical Virtual Size Attributes
65+
0 7:conv 0000000000 0000000000 00000a0000 f
66+
<gap> 00000a0000 0000060000
67+
1 7:conv 0000100000 0000000000 0000700000 f
68+
2 a:acpi_nvs 0000800000 0000000000 0000008000 f
69+
3 7:conv 0000808000 0000000000 0000008000 f
70+
4 a:acpi_nvs 0000810000 0000000000 00000f0000 f
71+
5 7:conv 0000900000 0000000000 001efef000 f
72+
6 6:rt_data 001f8ef000 0000000000 0000100000 rf
73+
7 5:rt_code 001f9ef000 0000000000 0000100000 rf
74+
8 0:reserved 001faef000 0000000000 0000080000 f
75+
9 9:acpi_reclaim 001fb6f000 0000000000 0000010000 f
76+
10 a:acpi_nvs 001fb7f000 0000000000 0000080000 f
77+
11 7:conv 001fbff000 0000000000 0000359000 f
78+
12 6:rt_data 001ff58000 0000000000 0000020000 rf
79+
13 a:acpi_nvs 001ff78000 0000000000 0000088000 f
80+
<gap> 0020000000 0090000000
81+
14 0:reserved 00b0000000 0000000000 0010000000 1
82+
83+
Attributes key:
84+
f: uncached, write-coalescing, write-through, write-back
85+
rf: uncached, write-coalescing, write-through, write-back, needs runtime mapping
86+
1: uncached
87+
*Some areas are merged (use 'all' to see)
88+
89+
90+
=> efi mem all
91+
EFI table at 0, memory map 000000001ad38bb0, size 1260, key a79, version 1, descr. size 0x30
92+
# Type Physical Virtual Size Attributes
93+
0 3:bs_code 0000000000 0000000000 0000001000 f
94+
1 7:conv 0000001000 0000000000 000009f000 f
95+
<gap> 00000a0000 0000060000
96+
2 7:conv 0000100000 0000000000 0000700000 f
97+
3 a:acpi_nvs 0000800000 0000000000 0000008000 f
98+
4 7:conv 0000808000 0000000000 0000008000 f
99+
5 a:acpi_nvs 0000810000 0000000000 00000f0000 f
100+
6 4:bs_data 0000900000 0000000000 0000c00000 f
101+
7 7:conv 0001500000 0000000000 000aa36000 f
102+
8 2:loader_data 000bf36000 0000000000 0010000000 f
103+
9 4:bs_data 001bf36000 0000000000 0000020000 f
104+
10 7:conv 001bf56000 0000000000 00021e1000 f
105+
11 1:loader_code 001e137000 0000000000 00000c4000 f
106+
12 7:conv 001e1fb000 0000000000 000009b000 f
107+
13 1:loader_code 001e296000 0000000000 00000e2000 f
108+
14 7:conv 001e378000 0000000000 000005b000 f
109+
15 4:bs_data 001e3d3000 0000000000 000001e000 f
110+
16 7:conv 001e3f1000 0000000000 0000016000 f
111+
17 4:bs_data 001e407000 0000000000 0000016000 f
112+
18 2:loader_data 001e41d000 0000000000 0000002000 f
113+
19 4:bs_data 001e41f000 0000000000 0000828000 f
114+
20 3:bs_code 001ec47000 0000000000 0000045000 f
115+
21 4:bs_data 001ec8c000 0000000000 0000001000 f
116+
22 3:bs_code 001ec8d000 0000000000 000000e000 f
117+
23 4:bs_data 001ec9b000 0000000000 0000001000 f
118+
24 3:bs_code 001ec9c000 0000000000 000002c000 f
119+
25 4:bs_data 001ecc8000 0000000000 0000001000 f
120+
26 3:bs_code 001ecc9000 0000000000 000000c000 f
121+
27 4:bs_data 001ecd5000 0000000000 0000006000 f
122+
28 3:bs_code 001ecdb000 0000000000 0000014000 f
123+
29 4:bs_data 001ecef000 0000000000 0000001000 f
124+
30 3:bs_code 001ecf0000 0000000000 000005b000 f
125+
31 4:bs_data 001ed4b000 0000000000 000000b000 f
126+
32 3:bs_code 001ed56000 0000000000 0000024000 f
127+
33 4:bs_data 001ed7a000 0000000000 0000006000 f
128+
34 3:bs_code 001ed80000 0000000000 0000010000 f
129+
35 4:bs_data 001ed90000 0000000000 0000002000 f
130+
36 3:bs_code 001ed92000 0000000000 0000025000 f
131+
37 4:bs_data 001edb7000 0000000000 0000003000 f
132+
38 3:bs_code 001edba000 0000000000 0000011000 f
133+
39 4:bs_data 001edcb000 0000000000 0000008000 f
134+
40 3:bs_code 001edd3000 0000000000 000002d000 f
135+
41 4:bs_data 001ee00000 0000000000 0000201000 f
136+
42 3:bs_code 001f001000 0000000000 0000024000 f
137+
43 4:bs_data 001f025000 0000000000 0000002000 f
138+
44 3:bs_code 001f027000 0000000000 0000009000 f
139+
45 4:bs_data 001f030000 0000000000 0000005000 f
140+
46 3:bs_code 001f035000 0000000000 000002f000 f
141+
47 4:bs_data 001f064000 0000000000 0000001000 f
142+
48 3:bs_code 001f065000 0000000000 0000005000 f
143+
49 4:bs_data 001f06a000 0000000000 0000005000 f
144+
50 3:bs_code 001f06f000 0000000000 0000007000 f
145+
51 4:bs_data 001f076000 0000000000 0000007000 f
146+
52 3:bs_code 001f07d000 0000000000 000000d000 f
147+
53 4:bs_data 001f08a000 0000000000 0000001000 f
148+
54 3:bs_code 001f08b000 0000000000 0000006000 f
149+
55 4:bs_data 001f091000 0000000000 0000004000 f
150+
56 3:bs_code 001f095000 0000000000 000000d000 f
151+
57 4:bs_data 001f0a2000 0000000000 0000003000 f
152+
58 3:bs_code 001f0a5000 0000000000 0000026000 f
153+
59 4:bs_data 001f0cb000 0000000000 0000005000 f
154+
60 3:bs_code 001f0d0000 0000000000 0000019000 f
155+
61 4:bs_data 001f0e9000 0000000000 0000004000 f
156+
62 3:bs_code 001f0ed000 0000000000 0000024000 f
157+
63 4:bs_data 001f111000 0000000000 0000008000 f
158+
64 3:bs_code 001f119000 0000000000 000000b000 f
159+
65 4:bs_data 001f124000 0000000000 0000001000 f
160+
66 3:bs_code 001f125000 0000000000 0000002000 f
161+
67 4:bs_data 001f127000 0000000000 0000002000 f
162+
68 3:bs_code 001f129000 0000000000 0000009000 f
163+
69 4:bs_data 001f132000 0000000000 0000003000 f
164+
70 3:bs_code 001f135000 0000000000 0000005000 f
165+
71 4:bs_data 001f13a000 0000000000 0000003000 f
166+
72 3:bs_code 001f13d000 0000000000 0000005000 f
167+
73 4:bs_data 001f142000 0000000000 0000003000 f
168+
74 3:bs_code 001f145000 0000000000 0000011000 f
169+
75 4:bs_data 001f156000 0000000000 000000b000 f
170+
76 3:bs_code 001f161000 0000000000 0000009000 f
171+
77 4:bs_data 001f16a000 0000000000 0000400000 f
172+
78 3:bs_code 001f56a000 0000000000 0000006000 f
173+
79 4:bs_data 001f570000 0000000000 0000001000 f
174+
80 3:bs_code 001f571000 0000000000 0000001000 f
175+
81 4:bs_data 001f572000 0000000000 0000002000 f
176+
82 3:bs_code 001f574000 0000000000 0000017000 f
177+
83 4:bs_data 001f58b000 0000000000 0000364000 f
178+
84 6:rt_data 001f8ef000 0000000000 0000100000 rf
179+
85 5:rt_code 001f9ef000 0000000000 0000100000 rf
180+
86 0:reserved 001faef000 0000000000 0000080000 f
181+
87 9:acpi_reclaim 001fb6f000 0000000000 0000010000 f
182+
88 a:acpi_nvs 001fb7f000 0000000000 0000080000 f
183+
89 4:bs_data 001fbff000 0000000000 0000201000 f
184+
90 7:conv 001fe00000 0000000000 00000e8000 f
185+
91 4:bs_data 001fee8000 0000000000 0000020000 f
186+
92 3:bs_code 001ff08000 0000000000 0000026000 f
187+
93 4:bs_data 001ff2e000 0000000000 0000009000 f
188+
94 3:bs_code 001ff37000 0000000000 0000021000 f
189+
95 6:rt_data 001ff58000 0000000000 0000020000 rf
190+
96 a:acpi_nvs 001ff78000 0000000000 0000088000 f
191+
<gap> 0020000000 0090000000
192+
97 0:reserved 00b0000000 0000000000 0010000000 1
193+
194+
Attributes key:
195+
f: uncached, write-coalescing, write-through, write-back
196+
rf: uncached, write-coalescing, write-through, write-back, needs runtime mapping
197+
1: uncached

‎doc/usage/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Shell commands
4343
cmd/dm
4444
cmd/ebtupdate
4545
cmd/echo
46+
cmd/efi
4647
cmd/eficonfig
4748
cmd/env
4849
cmd/event

0 commit comments

Comments
 (0)