diff options
| author | Michael Kubacki <michael.kubacki@microsoft.com> | 2020-04-07 11:19:49 -0700 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2022-04-05 00:42:38 +0000 |
| commit | e189e01af26d63d7cc376b0b8ff1fa3fc3ad8dae (patch) | |
| tree | 21c51b85f1f27b9235852bcb27d8bce6256cba9a /PrmPkg/Include | |
| parent | 5f76c3e471aee1fc3e38af3de0c7a48b34df23ff (diff) | |
| download | edk2-e189e01af26d63d7cc376b0b8ff1fa3fc3ad8dae.zip edk2-e189e01af26d63d7cc376b0b8ff1fa3fc3ad8dae.tar.gz edk2-e189e01af26d63d7cc376b0b8ff1fa3fc3ad8dae.tar.bz2 | |
PrmPkg/PrmContextBufferLib: Add initial library instance
REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3812
This library is introduced to add a general abstraction for PRM context
buffer management.
Cc: Andrew Fish <afish@apple.com>
Cc: Kang Gao <kang.gao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Michael Kubacki <michael.kubacki@microsoft.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Benjamin You <benjamin.you@intel.com>
Cc: Liu Yun <yun.y.liu@intel.com>
Cc: Ankit Sinha <ankit.sinha@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Acked-by: Michael D Kinney <michael.d.kinney@intel.com>
Acked-by: Liming Gao <gaoliming@byosoft.com.cn>
Acked-by: Leif Lindholm <quic_llindhol@quicinc.com>
Reviewed-by: Ankit Sinha <ankit.sinha@intel.com>
Diffstat (limited to 'PrmPkg/Include')
| -rw-r--r-- | PrmPkg/Include/Library/PrmContextBufferLib.h | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/PrmPkg/Include/Library/PrmContextBufferLib.h b/PrmPkg/Include/Library/PrmContextBufferLib.h new file mode 100644 index 0000000..93dcd1e --- /dev/null +++ b/PrmPkg/Include/Library/PrmContextBufferLib.h @@ -0,0 +1,99 @@ +/** @file
+
+ The PRM Buffer Context library provides a general abstraction for context buffer management.
+
+ Copyright (c) Microsoft Corporation
+ SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef PRM_CONTEXT_BUFFER_LIB_H_
+#define PRM_CONTEXT_BUFFER_LIB_H_
+
+#include <Base.h>
+#include <PrmContextBuffer.h>
+#include <Uefi.h>
+
+typedef enum {
+ ///
+ /// Search by the PRM module GUID
+ ///
+ ByModuleGuid,
+ ///
+ /// Search by the PRM handler GUID
+ ///
+ ByHandlerGuid
+} PRM_GUID_SEARCH_TYPE;
+
+/**
+ Finds a PRM context buffer for the given PRM handler GUID.
+
+ Note: PRM_MODULE_CONTEXT_BUFFERS is at the PRM module level while PRM_CONTEXT_BUFFER is at the PRM handler level.
+
+ @param[in] HandlerGuid A pointer to the PRM handler GUID.
+ @param[in] ModuleContextBuffers A pointer to the PRM context buffers structure for the PRM module.
+ @param[out] PrmModuleContextBuffer A pointer to a pointer that will be set to the PRM context buffer
+ if successfully found.
+
+ @retval EFI_SUCCESS The PRM context buffer was found.
+ @retval EFI_INVALID_PARAMETER A required parameter pointer is NULL.
+ @retval EFI_NOT_FOUND The context buffer for the given PRM handler GUID could not be found.
+
+**/
+EFI_STATUS
+FindContextBufferInModuleBuffers (
+ IN CONST EFI_GUID *HandlerGuid,
+ IN CONST PRM_MODULE_CONTEXT_BUFFERS *ModuleContextBuffers,
+ OUT CONST PRM_CONTEXT_BUFFER **ContextBuffer
+ );
+
+/**
+ Returns a PRM context buffers structure for the given PRM search type.
+
+ This function allows a caller to get the context buffers structure for a PRM module with either the PRM module
+ GUID or the GUID for a PRM handler in the module.
+
+ Note: PRM_MODULE_CONTEXT_BUFFERS is at the PRM module level while PRM_CONTEXT_BUFFER is at the PRM handler level.
+
+ @param[in] GuidSearchType The type of GUID passed in the Guid argument.
+ @param[in] Guid A pointer to the GUID of a PRM module or PRM handler. The actual GUID type
+ will be interpreted based on the value passed in GuidSearchType.
+ @param[out] PrmModuleContextBuffers A pointer to a pointer that will be set to the PRM context buffers
+ structure if successfully found.
+
+ @retval EFI_SUCCESS The PRM context buffers structure was found.
+ @retval EFI_INVALID_PARAMETER A required parameter pointer is NULL.
+ @retval EFI_NOT_FOUND The context buffers for the given GUID could not be found.
+
+**/
+EFI_STATUS
+GetModuleContextBuffers (
+ IN PRM_GUID_SEARCH_TYPE GuidSearchType,
+ IN CONST EFI_GUID *Guid,
+ OUT CONST PRM_MODULE_CONTEXT_BUFFERS **PrmModuleContextBuffers
+ );
+
+/**
+ Returns a PRM context buffer for the given PRM handler.
+
+ @param[in] PrmHandlerGuid A pointer to the GUID for the PRM handler.
+ @param[in] PrmModuleContextBuffers A pointer to a PRM_MODULE_CONTEXT_BUFFERS structure. If this optional
+ parameter is provided, the handler context buffer will be searched for in this
+ buffer structure which saves time by not performing a global search for the
+ module buffer structure.
+ @param[out] PrmContextBuffer A pointer to a pointer that will be set to the PRM context buffer
+ if successfully found.
+
+ @retval EFI_SUCCESS The PRM context buffer was found.
+ @retval EFI_INVALID_PARAMETER A required parameter pointer is NULL.
+ @retval EFI_NOT_FOUND The context buffer for the PRM handler could not be found.
+
+**/
+EFI_STATUS
+GetContextBuffer (
+ IN CONST EFI_GUID *PrmHandlerGuid,
+ IN CONST PRM_MODULE_CONTEXT_BUFFERS *PrmModuleContextBuffers OPTIONAL,
+ OUT CONST PRM_CONTEXT_BUFFER **PrmContextBuffer
+ );
+
+#endif
|