Skip to content

Commit f6840f9

Browse files
committed
doc: improve description of MemoryMap
1 parent 66c42bc commit f6840f9

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

uefi/src/table/boot.rs

+10-3
Original file line numberDiff line numberDiff line change
@@ -1793,15 +1793,22 @@ impl MemoryMapMeta {
17931793
}
17941794
}
17951795

1796-
/// An accessory to the UEFI memory map that can be either iterated or indexed
1797-
/// like an array.
1796+
/// An accessory to the UEFI memory map and associated metadata that can be
1797+
/// either iterated or indexed like an array.
17981798
///
17991799
/// A [`MemoryMap`] is always associated with the unique [`MemoryMapKey`]
1800-
/// bundled with the ma.
1800+
/// bundled with the map.
18011801
///
18021802
/// To iterate over the entries, call [`MemoryMap::entries`].
18031803
///
18041804
/// ## UEFI pitfalls
1805+
/// Note that a MemoryMap can quickly become outdated, as soon as any explicit
1806+
/// or hidden allocation happens.
1807+
///
1808+
/// As soon as boot services are excited, all previous obtained memory maps must
1809+
/// be considered as outdated, except if the [`MemoryMapKey`] equals the one
1810+
/// returned by `exit_boot_services()`.
1811+
///
18051812
/// **Please note** that when working with memory maps, the `entry_size` is
18061813
/// usually larger than `size_of::<MemoryDescriptor` [[0]]. So to be safe,
18071814
/// always use `entry_size` as step-size when interfacing with the memory map on

0 commit comments

Comments
 (0)