PrmPkg: Publish PRM operation region to support PRM ACPI _DSM invocation

[mirror_edk2.git] / PrmPkg / Include / PrmModule.h

/** @file\r
\r
  Common definitions needed for Platform Runtime Mechanism (PRM) modules.\r
\r
  Copyright (c) Microsoft Corporation\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef PRM_MODULE_H_\r
#define PRM_MODULE_H_\r
\r
#include <Prm.h>\r
#include <PrmContextBuffer.h>\r
#include <PrmDataBuffer.h>\r
#include <PrmExportDescriptor.h>\r
#include <PrmMmio.h>\r
#include <PrmModuleUpdate.h>\r
#include <PrmOsServices.h>\r
\r
/**\r
  Macro that provides a condensed form of a PRM Handler.\r
\r
  This macro can be used to define a PRM Handler that uses the standard PRM Handle\r
  signature. It is simply provided for convenience.\r
\r
**/\r
#define PRM_HANDLER_EXPORT(Name)                                                  \\r
  STATIC_ASSERT (sizeof (PRM_STRING_(Name)) <= PRM_HANDLER_NAME_MAXIMUM_LENGTH, "The PRM handler exceeds the maximum allowed size of 128.");  \\r
                                                                                  \\r
/**                                                                               \\r
  A Platform Runtime Mechanism (PRM) handler.                                     \\r
                                                                                  \\r
  @param[in]  ParameterBuffer     A pointer to the PRM handler parameter buffer   \\r
  @param[in]  ContextBUffer       A pointer to the PRM handler context buffer     \\r
                                                                                  \\r
  @retval EFI_STATUS              The PRM handler executed successfully.          \\r
  @retval Others                  An error occurred in the PRM handler.           \\r
                                                                                  \\r
**/                                                                               \\r
  EFI_STATUS                                    \\r
  PRM_EXPORT_API                                \\r
  EFIAPI                                        \\r
  Name (                                        \\r
    IN VOID                 *ParameterBuffer,   \\r
    IN PRM_CONTEXT_BUFFER   *ContextBuffer      \\r
    )                                           \\r
\r
/**\r
  A macro that declares the PRM Module Update Lock Descriptor for a PRM Module.\r
\r
  This macro is intended to be used once in a PRM Module so the module update lock descriptor is\r
  exported for the module.\r
\r
**/\r
#define PRM_MODULE_UPDATE_LOCK_EXPORT                                                           \\r
  PRM_EXPORT_API PRM_MODULE_UPDATE_LOCK_DESCRIPTOR PRM_MODULE_UPDATE_LOCK_DESCRIPTOR_NAME = {   \\r
    PRM_MODULE_UPDATE_LOCK_DESCRIPTOR_SIGNATURE,                                                \\r
    PRM_MODULE_UPDATE_LOCK_REVISION,                                                            \\r
    { 0 }                                                                                       \\r
  }                                                                                             \\r
\r
//\r
// A PRM module is required to export the PRM Module Update Lock\r
//\r
PRM_MODULE_UPDATE_LOCK_EXPORT;\r
\r
#endif\r