From a2f273100851c10f1a906d7215744b6d8ebbbaa4 Mon Sep 17 00:00:00 2001 From: Randolph Sapp Date: Wed, 22 Apr 2026 12:09:41 -0500 Subject: lmb: allocation flags macro documentation Update the allocation flags inline documentation to follow the kernel object like macro documentation specification. Use active voice for the short descriptions. Signed-off-by: Randolph Sapp Reviewed-by: Ilias Apalodimas Reviewed-by: Simon Glass --- include/lmb.h | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) (limited to 'include') diff --git a/include/lmb.h b/include/lmb.h index 5d5f037ccb9..ed472e9ef2e 100644 --- a/include/lmb.h +++ b/include/lmb.h @@ -19,16 +19,36 @@ #define LMB_ALIST_INITIAL_SIZE 4 /** - * DOC: Memory region attribute flags. + * define LMB_NONE - no special request * - * %LMB_NONE: No special request - * %LMB_NOMAP: Don't add to MMU configuration - * %LMB_NOOVERWRITE: The memory region cannot be overwritten/re-reserved - * %LMB_NONOTIFY: Do not notify other modules of changes to this memory region + * LMB Memory region attribute flag to indicate that there are no special + * requests for this region. Normally used as a placeholder value. */ #define LMB_NONE 0 + +/** + * define LMB_NOMAP - do not add to MMU configuration + * + * LMB Memory region attribute flag to indicate that the region will not be + * mapped by LMB. Normally used for reserved regions. + */ #define LMB_NOMAP BIT(1) + +/** + * define LMB_NOOVERWRITE - do not overwrite/re-reserve + * + * LMB Memory region attribute flag to indicate that the region will not be + * overwritten or re-reserved. Normally used for reserved regions. + */ #define LMB_NOOVERWRITE BIT(2) + +/** + * define LMB_NONOTIFY - do not notify other modules of changes + * + * LMB Memory region attribute flag to indicate that the region will not notify + * downstream allocators (currently just the EFI allocator) of changes to this + * region through lmb_map_update_notify(). + */ #define LMB_NONOTIFY BIT(3) /** -- cgit v1.2.3