File tree 1 file changed +10
-3
lines changed
1 file changed +10
-3
lines changed Original file line number Diff line number Diff line change @@ -1793,15 +1793,22 @@ impl MemoryMapMeta {
1793
1793
}
1794
1794
}
1795
1795
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.
1798
1798
///
1799
1799
/// A [`MemoryMap`] is always associated with the unique [`MemoryMapKey`]
1800
- /// bundled with the ma .
1800
+ /// bundled with the map .
1801
1801
///
1802
1802
/// To iterate over the entries, call [`MemoryMap::entries`].
1803
1803
///
1804
1804
/// ## 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
+ ///
1805
1812
/// **Please note** that when working with memory maps, the `entry_size` is
1806
1813
/// usually larger than `size_of::<MemoryDescriptor` [[0]]. So to be safe,
1807
1814
/// always use `entry_size` as step-size when interfacing with the memory map on
You can’t perform that action at this time.
0 commit comments