MdePkg: Reference new definitions for Management Mode.
In PI 1.5 version, system management mode name(SMM) has been changed to Management Mode(MM). It impacts the current code which still use SMM/Smram/SMI keywords. This patch update the original files which related to old SMM modules, also keep the compatible with old SMM related drivers. Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <liming.gao@intel.com> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Eric Dong <eric.dong@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
@@ -9,7 +9,7 @@
|
||||
given event types. Several inputs can be enabled. This purpose of this interface is to generate an
|
||||
SMI in response to any of these inputs having a true value provided.
|
||||
|
||||
Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>
|
||||
This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
@@ -26,98 +26,22 @@
|
||||
#ifndef _SMM_GPI_DISPATCH2_H_
|
||||
#define _SMM_GPI_DISPATCH2_H_
|
||||
|
||||
#include <Protocol/MmGpiDispatch.h>
|
||||
#include <Pi/PiSmmCis.h>
|
||||
|
||||
#define EFI_SMM_GPI_DISPATCH2_PROTOCOL_GUID \
|
||||
{ \
|
||||
0x25566b03, 0xb577, 0x4cbf, {0x95, 0x8c, 0xed, 0x66, 0x3e, 0xa2, 0x43, 0x80 } \
|
||||
}
|
||||
|
||||
#define EFI_SMM_GPI_DISPATCH2_PROTOCOL_GUID EFI_MM_GPI_DISPATCH_PROTOCOL_GUID
|
||||
///
|
||||
/// The dispatch function's context.
|
||||
///
|
||||
typedef struct {
|
||||
///
|
||||
/// A number from one of 2^64 possible GPIs that can generate an SMI. A
|
||||
/// 0 corresponds to logical GPI[0]; 1 corresponds to logical GPI[1]; and
|
||||
/// GpiNum of N corresponds to GPI[N], where N can span from 0 to 2^64-1.
|
||||
///
|
||||
UINT64 GpiNum;
|
||||
} EFI_SMM_GPI_REGISTER_CONTEXT;
|
||||
typedef EFI_MM_GPI_REGISTER_CONTEXT EFI_SMM_GPI_REGISTER_CONTEXT;
|
||||
|
||||
typedef struct _EFI_SMM_GPI_DISPATCH2_PROTOCOL EFI_SMM_GPI_DISPATCH2_PROTOCOL;
|
||||
typedef EFI_MM_GPI_REGISTER EFI_SMM_GPI_REGISTER2;
|
||||
|
||||
/**
|
||||
Registers a child SMI source dispatch function with a parent SMM driver.
|
||||
typedef EFI_MM_GPI_UNREGISTER EFI_SMM_GPI_UNREGISTER2;
|
||||
|
||||
This service registers a function (DispatchFunction) which will be called when an SMI is
|
||||
generated because of one or more of the GPIs specified by RegisterContext. On return,
|
||||
DispatchHandle contains a unique handle which may be used later to unregister the function
|
||||
using UnRegister().
|
||||
The DispatchFunction will be called with Context set to the same value as was passed into
|
||||
this function in RegisterContext and with CommBuffer pointing to another instance of
|
||||
EFI_SMM_GPI_REGISTER_CONTEXT describing the GPIs which actually caused the SMI and
|
||||
CommBufferSize pointing to the size of the structure.
|
||||
typedef EFI_MM_GPI_DISPATCH_PROTOCOL EFI_SMM_GPI_DISPATCH2_PROTOCOL;
|
||||
|
||||
@param[in] This Pointer to the EFI_SMM_GPI_DISPATCH2_PROTOCOL instance.
|
||||
@param[in] DispatchFunction Function to register for handler when the specified GPI causes an SMI.
|
||||
@param[in] RegisterContext Pointer to the dispatch function's context.
|
||||
The caller fills this context in before calling
|
||||
the register function to indicate to the register
|
||||
function the GPI(s) for which the dispatch function
|
||||
should be invoked.
|
||||
@param[out] DispatchHandle Handle generated by the dispatcher to track the
|
||||
function instance.
|
||||
|
||||
@retval EFI_SUCCESS The dispatch function has been successfully
|
||||
registered and the SMI source has been enabled.
|
||||
@retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
|
||||
@retval EFI_INVALID_PARAMETER RegisterContext is invalid. The GPI input value
|
||||
is not within valid range.
|
||||
@retval EFI_OUT_OF_RESOURCES There is not enough memory (system or SMM) to manage this child.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_SMM_GPI_REGISTER2)(
|
||||
IN CONST EFI_SMM_GPI_DISPATCH2_PROTOCOL *This,
|
||||
IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction,
|
||||
IN CONST EFI_SMM_GPI_REGISTER_CONTEXT *RegisterContext,
|
||||
OUT EFI_HANDLE *DispatchHandle
|
||||
);
|
||||
|
||||
/**
|
||||
Unregisters a General Purpose Input (GPI) service.
|
||||
|
||||
This service removes the handler associated with DispatchHandle so that it will no longer be
|
||||
called when the GPI triggers an SMI.
|
||||
|
||||
@param[in] This Pointer to the EFI_SMM_GPI_DISPATCH2_PROTOCOL instance.
|
||||
@param[in] DispatchHandle Handle of the service to remove.
|
||||
|
||||
@retval EFI_SUCCESS Handle of the service to remove.
|
||||
@retval EFI_INVALID_PARAMETER The DispatchHandle was not valid.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_SMM_GPI_UNREGISTER2)(
|
||||
IN CONST EFI_SMM_GPI_DISPATCH2_PROTOCOL *This,
|
||||
IN EFI_HANDLE DispatchHandle
|
||||
);
|
||||
|
||||
///
|
||||
/// Interface structure for the SMM GPI SMI Dispatch Protocol
|
||||
///
|
||||
/// The SMM GPI SMI Dispatch Protocol provides the parent dispatch service
|
||||
/// for the General Purpose Input (GPI) SMI source generator.
|
||||
///
|
||||
struct _EFI_SMM_GPI_DISPATCH2_PROTOCOL {
|
||||
EFI_SMM_GPI_REGISTER2 Register;
|
||||
EFI_SMM_GPI_UNREGISTER2 UnRegister;
|
||||
///
|
||||
/// Denotes the maximum value of inputs that can have handlers attached.
|
||||
///
|
||||
UINTN NumSupportedGpis;
|
||||
};
|
||||
|
||||
extern EFI_GUID gEfiSmmGpiDispatch2ProtocolGuid;
|
||||
|
||||
|
Reference in New Issue
Block a user