update comments to allign with spec
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7436 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
tding1
@ -143,10 +143,10 @@ EFI_STATUS
|
||||
Gets information on possible SMRAM regions.
|
||||
|
||||
@param LockState
|
||||
Indicates the current state of the SMRAM. Set to TRUE if any region is locked.
|
||||
Indicates the current state of the SMRAM. Set to TRUE if any region is locked.
|
||||
|
||||
@param OpenState
|
||||
Indicates the current state of the SMRAM. Set to TRUE if any region is open.
|
||||
Indicates the current state of the SMRAM. Set to TRUE if any region is open.
|
||||
|
||||
**/
|
||||
struct _EFI_SMM_ACCESS_PROTOCOL {
|
||||
|
||||
@ -87,9 +87,11 @@ EFI_STATUS
|
||||
@param SourceBuffer Optional source buffer in case of the image file
|
||||
being in memory.
|
||||
@param SourceSize Size of the source image file, if in memory.
|
||||
@param ImageHandle Pointer to the handle that reflects the driver
|
||||
loaded into SMM.
|
||||
@param LegacyIA32Binary The binary image to load is legacy 16 bit code.
|
||||
@param ImageHandle The handle that the base driver uses to decode
|
||||
the handler. Unique among SMM handlers only,
|
||||
not unique across DXE/EFI.
|
||||
@param LegacyIA32Binary An optional parameter that details that the associated
|
||||
file is a real-mode IA-32 binary.
|
||||
|
||||
@retval EFI_SUCCESS The operation was successful.
|
||||
@retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler
|
||||
@ -110,12 +112,11 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
/**
|
||||
Remove a given driver SMRAM. This is the equivalent of performing
|
||||
the UnloadImage System Management Mode.
|
||||
Removes a handler from execution within SMRAM. This is the equivalent of performing
|
||||
the UnloadImage in System Management Mode.
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param ImageHandle Pointer to the handle that reflects the driver
|
||||
loaded into SMM.
|
||||
@param ImageHandle The handler to be removed.
|
||||
|
||||
@retval EFI_SUCCESS The operation was successful
|
||||
@retval EFI_INVALID_PARAMETER The handler did not exist
|
||||
@ -133,13 +134,12 @@ EFI_STATUS
|
||||
The SMM Inter-module Communicate Service Communicate() function
|
||||
provides a services to send/received messages from a registered
|
||||
EFI service. The BASE protocol driver is responsible for doing
|
||||
any of the copies such that the data lives in boot-service accessible RAM.
|
||||
any of the copies such that the data lives in boot-service-accessible RAM.
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param ImageHandle Pointer to the handle that reflects the driver
|
||||
loaded into SMM.
|
||||
@param ImageHandle The handle of the registered driver.
|
||||
@param CommunicationBuffer Pointer to the buffer to convey into SMRAM.
|
||||
@param SourceSize Size of the contents of buffer..
|
||||
@param SourceSize The size of the data buffer being passed in.
|
||||
|
||||
@retval EFI_SUCCESS The message was successfully posted
|
||||
@retval EFI_INVALID_PARAMETER The buffer was NULL
|
||||
@ -156,14 +156,13 @@ EFI_STATUS
|
||||
|
||||
/**
|
||||
Register a callback to execute within SMM.
|
||||
This allows receipt of messages created with the Boot Service COMMUNICATE.
|
||||
This allows receipt of messages created with EFI_SMM_BASE_PROTOCOL.Communicate().
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param CallbackAddress Address of the callback service
|
||||
@param MakeFirst If present, will stipulate that the handler is posted
|
||||
to be the first module executed in the dispatch table.
|
||||
@param MakeLast If present, will stipulate that the handler is posted
|
||||
to be last executed in the dispatch table.
|
||||
@param SmmImageHandle Handle of the callback service.
|
||||
@param CallbackAddress Address of the callback service.
|
||||
@param MakeLast If present, will stipulate that the handler is posted to
|
||||
be executed last in the dispatch table.
|
||||
@param FloatingPointSave This is an optional parameter which informs the
|
||||
EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save
|
||||
the floating point register state. If any of the handlers
|
||||
@ -172,7 +171,7 @@ EFI_STATUS
|
||||
@retval EFI_SUCCESS The operation was successful
|
||||
@retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue
|
||||
@retval EFI_UNSUPPORTED In runtime.
|
||||
@retval EFI_UNSUPPORTED Not in SMM.
|
||||
@retval EFI_UNSUPPORTED The caller is not in SMM.
|
||||
|
||||
**/
|
||||
typedef
|
||||
@ -194,7 +193,9 @@ EFI_STATUS
|
||||
@param This Protocol instance pointer.
|
||||
@param PoolType The type of pool to allocate.
|
||||
The only supported type is EfiRuntimeServicesData;
|
||||
the interface will internally map this runtime request to SMRAM.
|
||||
the interface will internally map this runtime request to
|
||||
SMRAM for IA-32 and leave as this type for the Itanium
|
||||
processor family. Other types can be ignored.
|
||||
@param Size The number of bytes to allocate from the pool.
|
||||
@param Buffer A pointer to a pointer to the allocated buffer if the call
|
||||
succeeds; undefined otherwise.
|
||||
|
||||
@ -37,7 +37,7 @@ typedef struct _EFI_SMM_CONTROL_PROTOCOL EFI_SMM_CONTROL_PROTOCOL;
|
||||
{ \
|
||||
0x8d12e231, 0xc667, 0x4fd1, {0x98, 0xf2, 0x24, 0x49, 0xa7, 0xe7, 0xb2, 0xe5 } \
|
||||
}
|
||||
|
||||
//
|
||||
// SMM Access specification Data Structures
|
||||
//
|
||||
typedef struct {
|
||||
@ -78,7 +78,8 @@ EFI_STATUS
|
||||
Clears any system state that was created in response to the Active call.
|
||||
|
||||
@param This The EFI_SMM_CONTROL_PROTOCOL instance.
|
||||
@param Periodic Optional parameter to repeat at this period one time
|
||||
@param Periodic Optional parameter to repeat at this period one
|
||||
time or, if the Periodic Boolean is set, periodically.
|
||||
|
||||
@retval EFI_SUCCESS The SMI/PMI has been engendered.
|
||||
@retval EFI_DEVICE_ERROR The source could not be cleared.
|
||||
|
||||
@ -75,16 +75,15 @@ VOID
|
||||
/**
|
||||
Register a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchFunction Pointer to dispatch function to be invoked for
|
||||
this SMI source
|
||||
@param This Pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchFunction Function to install.
|
||||
@param DispatchContext 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 DispatchHandle Handle of dispatch function, for when interfacing
|
||||
with the parent Sx state SMM driver.
|
||||
@param 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.
|
||||
@ -105,17 +104,16 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
/**
|
||||
Unregister a child SMI source dispatch function with a parent SMM driver
|
||||
Unregisters a General Purpose Input (GPI) service.
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchHandle Handle of dispatch function to deregister.
|
||||
@param This Pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchHandle Handle of the service to remove.
|
||||
|
||||
@retval EFI_SUCCESS The dispatch function has been successfully
|
||||
unregistered and the SMI source has been disabled
|
||||
if there are no other registered child dispatch
|
||||
functions for this SMI source.
|
||||
@retval EFI_INVALID_PARAMETER Handle is invalid.
|
||||
@retval other TBD
|
||||
|
||||
**/
|
||||
typedef
|
||||
|
||||
@ -107,7 +107,7 @@ typedef struct {
|
||||
// Member functions
|
||||
//
|
||||
/**
|
||||
Dispatch function for a ICH n specific SMI handler.
|
||||
Dispatch function for a ICHN specific SMI handler.
|
||||
|
||||
@param DispatchHandle Handle of this dispatch function.
|
||||
@param DispatchContext Pointer to the dispatch function's context.
|
||||
@ -115,7 +115,7 @@ typedef struct {
|
||||
by the dispatching driver prior to
|
||||
invoking this dispatch function.
|
||||
|
||||
Nothing
|
||||
@return None
|
||||
|
||||
**/
|
||||
typedef
|
||||
@ -128,16 +128,15 @@ VOID
|
||||
/**
|
||||
Register a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchFunction Pointer to dispatch function to be invoked for
|
||||
this SMI source
|
||||
@param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchFunction Function to install.
|
||||
@param DispatchContext 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 ICHN SMI source for which the dispatch
|
||||
function should be invoked.
|
||||
@param DispatchHandle Handle of dispatch function, for when interfacing
|
||||
with the parent Sx state SMM driver.
|
||||
@param 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.
|
||||
@ -160,15 +159,14 @@ EFI_STATUS
|
||||
/**
|
||||
Unregister a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchHandle Handle of dispatch function to deregister.
|
||||
@param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchHandle Handle of the service to remove.
|
||||
|
||||
@retval EFI_SUCCESS The dispatch function has been successfully
|
||||
unregistered and the SMI source has been disabled
|
||||
if there are no other registered child dispatch
|
||||
functions for this SMI source.
|
||||
@retval EFI_INVALID_PARAMETER Handle is invalid.
|
||||
@retval other TBD
|
||||
|
||||
**/
|
||||
typedef
|
||||
@ -179,7 +177,7 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
//
|
||||
// Interface structure for the SMM Ich n specific SMI Dispatch Protocol
|
||||
// Interface structure for the SMM ICHN specific SMI Dispatch Protocol
|
||||
//
|
||||
/**
|
||||
@par Protocol Description:
|
||||
|
||||
@ -84,7 +84,7 @@ typedef struct {
|
||||
by the dispatching driver prior to
|
||||
invoking this dispatch function.
|
||||
|
||||
Nothing
|
||||
@return None
|
||||
|
||||
**/
|
||||
typedef
|
||||
@ -119,16 +119,14 @@ EFI_STATUS
|
||||
/**
|
||||
Register a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchFunction Pointer to dispatch function to be invoked for
|
||||
this SMI source
|
||||
@param This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchFunction Function to install.
|
||||
@param DispatchContext 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 period at which the dispatch function
|
||||
should be invoked.
|
||||
@param DispatchHandle Handle of dispatch function, for when interfacing
|
||||
with the parent Sx state SMM driver.
|
||||
@param 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.
|
||||
@ -149,10 +147,10 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
/**
|
||||
Unregister a child SMI source dispatch function with a parent SMM driver
|
||||
Unregisters a periodic timer service.
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchHandle Handle of dispatch function to deregister.
|
||||
@param This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchHandle Handle of the service to remove.
|
||||
|
||||
@retval EFI_SUCCESS The dispatch function has been successfully
|
||||
unregistered and the SMI source has been disabled
|
||||
|
||||
@ -62,7 +62,7 @@ typedef struct {
|
||||
by the dispatching driver prior to
|
||||
invoking this dispatch function.
|
||||
|
||||
Nothing
|
||||
@return None
|
||||
|
||||
**/
|
||||
typedef
|
||||
@ -73,18 +73,16 @@ VOID
|
||||
);
|
||||
|
||||
/**
|
||||
Register a child SMI source dispatch function with a parent SMM driver
|
||||
Provides the parent dispatch service for a given SMI source generator
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchFunction Pointer to dispatch function to be invoked for
|
||||
this SMI source
|
||||
@param This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchFunction Function to install.
|
||||
@param DispatchContext 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 Power Button SMI phase for which the dispatch
|
||||
function should be invoked.
|
||||
@param DispatchHandle Handle of dispatch function, for when interfacing
|
||||
with the parent Sx state SMM driver.
|
||||
@param 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.
|
||||
@ -105,17 +103,16 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
/**
|
||||
Unregister a child SMI source dispatch function with a parent SMM driver
|
||||
Unregisters a power-button service.
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchHandle Handle of dispatch function to deregister.
|
||||
@param This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchHandle Handle of the service to remove.
|
||||
|
||||
@retval EFI_SUCCESS The dispatch function has been successfully
|
||||
unregistered and the SMI source has been disabled
|
||||
if there are no other registered child dispatch
|
||||
functions for this SMI source.
|
||||
@retval EFI_INVALID_PARAMETER Handle is invalid.
|
||||
@retval other TBD
|
||||
|
||||
**/
|
||||
typedef
|
||||
|
||||
@ -63,7 +63,7 @@ typedef struct {
|
||||
by the dispatching driver prior to
|
||||
invoking this dispatch function.
|
||||
|
||||
@return Nothing
|
||||
@return None
|
||||
|
||||
**/
|
||||
typedef
|
||||
@ -74,18 +74,16 @@ VOID
|
||||
);
|
||||
|
||||
/**
|
||||
Register a child SMI source dispatch function with a parent SMM driver
|
||||
Provides the parent dispatch service for a given SMI source generator
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchFunction Pointer to dispatch function to be invoked for
|
||||
this SMI source
|
||||
@param This Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchFunction Function to install.
|
||||
@param DispatchContext 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 Standby Button SMI phase for which the dispatch
|
||||
function should be invoked.
|
||||
@param DispatchHandle Handle of dispatch function, for when interfacing
|
||||
with the parent Sx state SMM driver.
|
||||
@param 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.
|
||||
@ -108,15 +106,14 @@ EFI_STATUS
|
||||
/**
|
||||
Unregister a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchHandle Handle of dispatch function to deregister.
|
||||
@param This Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchHandle Handle of the service to remove.
|
||||
|
||||
@retval EFI_SUCCESS The dispatch function has been successfully
|
||||
unregistered and the SMI source has been disabled
|
||||
if there are no other registered child dispatch
|
||||
functions for this SMI source.
|
||||
@retval EFI_INVALID_PARAMETER Handle is invalid.
|
||||
@retval other TBD
|
||||
|
||||
**/
|
||||
typedef
|
||||
|
||||
@ -59,7 +59,7 @@ typedef struct {
|
||||
The dispatch function will only be called
|
||||
for input values for which it is registered.
|
||||
|
||||
Nothing
|
||||
@return None
|
||||
|
||||
**/
|
||||
typedef
|
||||
@ -72,16 +72,14 @@ VOID
|
||||
/**
|
||||
Register a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchFunction Pointer to dispatch function to be invoked for
|
||||
this SMI source
|
||||
@param This Pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchFunction Function to install.
|
||||
@param DispatchContext Pointer to the dispatch function's context.
|
||||
The caller fills this context in before calling
|
||||
the register function to indicate to the register
|
||||
function which Software SMI input value the
|
||||
dispatch function should be invoked for.
|
||||
@param DispatchHandle Handle of dispatch function, for when interfacing
|
||||
with the parent Sx state SMM driver.
|
||||
@param 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.
|
||||
@ -104,15 +102,14 @@ EFI_STATUS
|
||||
/**
|
||||
Unregister a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchHandle Handle of dispatch function to deregister.
|
||||
@param This Pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchHandle Handle of the service to remove.
|
||||
|
||||
@retval EFI_SUCCESS The dispatch function has been successfully
|
||||
unregistered and the SMI source has been disabled
|
||||
if there are no other registered child dispatch
|
||||
functions for this SMI source.
|
||||
@retval EFI_INVALID_PARAMETER Handle is invalid.
|
||||
@retval other TBD
|
||||
|
||||
**/
|
||||
typedef
|
||||
|
||||
@ -70,7 +70,7 @@ typedef struct {
|
||||
and phases, so the Sx state handler(s) must check the Type and
|
||||
Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.
|
||||
|
||||
Nothing
|
||||
@return None
|
||||
|
||||
**/
|
||||
typedef
|
||||
@ -83,9 +83,8 @@ VOID
|
||||
/**
|
||||
Register a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchFunction Pointer to dispatch function to be invoked for
|
||||
this SMI source
|
||||
@param This Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchFunction Function to install.
|
||||
@param DispatchContext Pointer to the dispatch function's context.
|
||||
The caller fills this context in before calling
|
||||
the register function to indicate to the register
|
||||
@ -119,16 +118,15 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
/**
|
||||
Unregister a child SMI source dispatch function with a parent SMM driver
|
||||
Unregisters an Sx-state service
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchHandle Handle of dispatch function to deregister.
|
||||
@param This Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchHandle Handle of the service to remove.
|
||||
|
||||
@retval EFI_SUCCESS The dispatch function has been successfully unregistered and the
|
||||
SMI source has been disabled if there are no other registered child
|
||||
dispatch functions for this SMI source.
|
||||
@retval EFI_INVALID_PARAMETER Handle is invalid.
|
||||
@retval other TBD
|
||||
|
||||
**/
|
||||
typedef
|
||||
|
||||
@ -57,7 +57,7 @@ typedef struct {
|
||||
by the dispatching driver prior to
|
||||
invoking this dispatch function.
|
||||
|
||||
Nothing
|
||||
@return None
|
||||
|
||||
**/
|
||||
typedef
|
||||
@ -70,16 +70,16 @@ VOID
|
||||
/**
|
||||
Register a child SMI source dispatch function with a parent SMM driver
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchFunction Pointer to dispatch function to be invoked for
|
||||
this SMI source
|
||||
@param This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchFunction Pointer to dispatch function to be invoked
|
||||
for this SMI source.
|
||||
@param DispatchContext 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 USB SMI types for which the dispatch
|
||||
function should be invoked.
|
||||
@param DispatchHandle Handle of dispatch function, for when interfacing
|
||||
with the parent Sx state SMM driver.
|
||||
@param 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.
|
||||
@ -100,10 +100,10 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
/**
|
||||
Unregister a child SMI source dispatch function with a parent SMM driver
|
||||
Unregisters a USB service
|
||||
|
||||
@param This Protocol instance pointer.
|
||||
@param DispatchHandle Handle of dispatch function to deregister.
|
||||
@param This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.
|
||||
@param DispatchHandle Handle of the service to remove.
|
||||
|
||||
@retval EFI_SUCCESS The dispatch function has been successfully
|
||||
unregistered and the SMI source has been disabled
|
||||
|
||||
Reference in New Issue
Block a user