summaryrefslogtreecommitdiffstats
path: root/PrmPkg/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'PrmPkg/Readme.md')
-rw-r--r--PrmPkg/Readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/PrmPkg/Readme.md b/PrmPkg/Readme.md
index b67b3a391e..00ef41bc5f 100644
--- a/PrmPkg/Readme.md
+++ b/PrmPkg/Readme.md
@@ -68,6 +68,18 @@ record (POR) configuration.
The following list are the currently defined build flags (if any) that may be passed to the `build` command
(e.g. -D FLAG=VALUE).
+* `ALLOCATE_CONTEXT_BUFFER_IN_FW` - Allocates the context buffer for each PRM handler in the firmware instead of
+ the operating system (OS).
+
+ Additional detail: The context buffer structure is defined in [PrmContextBuffer.h](PrmPkg/Include/PrmContextBuffer.h).
+ This structure can be instantiated by either firmware with a physical pointer to the buffer placed in the
+ `PRM_HANDLER_INFORMATION_STRUCT` for each handler wherein the OS would convert that physical pointer and pass it
+ as a virtual address pointer to each PRM handler. Alternatively, the context buffer can be allocated and populated
+ by the OS where it would get all the information to populate the context buffer from other structures.
+
+ The default is for the OS to allocate and populate the buffer. The alternative option of the firmware doing this
+ work is kept in the source code until broader OS testing is completed.
+
## Overview
At a high-level, PRM can be viewed from three levels of granularity: