d2998af211
REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3812 Adds a new package to maintain Platform Runtime Mechanism (PRM) support. This package is intended to include generic code that provides a common infrastructure to support PRM in firmware and a collection of sample PRM modules that demonstrate how to use the interfaces and other package resources to author a PRM module. The following initial headers are included in this commit: * Prm.h - Includes common content for PRM with no dependencies on other PRM header files. * PrmContextBuffer.h - Includes definitions for PRM context buffers. Context buffers are standardized structures that point to various resources available to a PRM handler during its execution. * PrmDataBuffer.h - Includes definitions for PRM data buffers. Within the context of PRM, these data buffers are composed of a generic header followed by a variable length blob of arbitrary data. * PrmExportDescriptor.h - Includes definitions for creating PRM export descriptors. A PRM export descriptor is a structure referenced in the export table of PRM module that contains PRM-specific metadata about the module. * PrmMmio.h - Includes definitions for describing MMIO ranges uses by PRM modules. * PrmModule.h - Includes definitions commonly used by PRM module authors. This file is provided to serve as a convenient include for PRM module authors. * PrmOsServices.h - Includes content specific to PRM OS services. OS Services will not planned to be present in the final version of PRM. The OS Services have been reduced to a simple debug print function. So this is currently planned to be a temporary file to support debugging during PRM development. Note: Modules built for the UEFI environment can be built by Visual Studio and non-Visual Studio toolchains. However, PRM modules are currently only supported on Visual Studio toolchain due to usage of export tables. 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>
69 lines
3.0 KiB
C
69 lines
3.0 KiB
C
/** @file
|
|
|
|
Common definitions needed for Platform Runtime Mechanism (PRM) modules.
|
|
|
|
Copyright (c) Microsoft Corporation
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef PRM_MODULE_H_
|
|
#define PRM_MODULE_H_
|
|
|
|
#include <Prm.h>
|
|
#include <PrmContextBuffer.h>
|
|
#include <PrmDataBuffer.h>
|
|
#include <PrmExportDescriptor.h>
|
|
#include <PrmMmio.h>
|
|
#include <PrmModuleUpdate.h>
|
|
#include <PrmOsServices.h>
|
|
|
|
/**
|
|
Macro that provides a condensed form of a PRM Handler.
|
|
|
|
This macro can be used to define a PRM Handler that uses the standard PRM Handle
|
|
signature. It is simply provided for convenience.
|
|
|
|
**/
|
|
#define PRM_HANDLER_EXPORT(Name) \
|
|
STATIC_ASSERT (sizeof (PRM_STRING_(Name)) <= PRM_HANDLER_NAME_MAXIMUM_LENGTH, "The PRM handler exceeds the maximum allowed size of 128."); \
|
|
\
|
|
/** \
|
|
A Platform Runtime Mechanism (PRM) handler. \
|
|
\
|
|
@param[in] ParameterBuffer A pointer to the PRM handler parameter buffer \
|
|
@param[in] ContextBUffer A pointer to the PRM handler context buffer \
|
|
\
|
|
@retval EFI_STATUS The PRM handler executed successfully. \
|
|
@retval Others An error occurred in the PRM handler. \
|
|
\
|
|
**/ \
|
|
EFI_STATUS \
|
|
PRM_EXPORT_API \
|
|
EFIAPI \
|
|
Name ( \
|
|
IN VOID *ParameterBuffer, \
|
|
IN PRM_CONTEXT_BUFFER *ContextBuffer \
|
|
) \
|
|
|
|
/**
|
|
A macro that declares the PRM Module Update Lock Descriptor for a PRM Module.
|
|
|
|
This macro is intended to be used once in a PRM Module so the module update lock descriptor is
|
|
exported for the module.
|
|
|
|
**/
|
|
#define PRM_MODULE_UPDATE_LOCK_EXPORT \
|
|
PRM_EXPORT_API PRM_MODULE_UPDATE_LOCK_DESCRIPTOR PRM_MODULE_UPDATE_LOCK_DESCRIPTOR_NAME = { \
|
|
PRM_MODULE_UPDATE_LOCK_DESCRIPTOR_SIGNATURE, \
|
|
PRM_MODULE_UPDATE_LOCK_REVISION, \
|
|
{ 0 } \
|
|
} \
|
|
|
|
//
|
|
// A PRM module is required to export the PRM Module Update Lock
|
|
//
|
|
PRM_MODULE_UPDATE_LOCK_EXPORT;
|
|
|
|
#endif
|