sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update comments to allign with spec

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7436 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
tding1
2009-02-05 08:42:01 +00:00
parent 19f1707078
commit 700a786952
12 changed files with 135 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
IntelFrameworkPkg/Include/Ppi/Smbus.h
View File

@ -69,7 +69,7 @@ typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION)( (EFIAPI *EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION)(
IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SERVICES **PeiServices,
IN EFI_PEI_SMBUS_PPI *This, IN EFI_PEI_SMBUS_PPI *This,
IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress, IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
IN EFI_SMBUS_DEVICE_COMMAND Command, IN EFI_SMBUS_DEVICE_COMMAND Command,
IN EFI_SMBUS_OPERATION Operation, IN EFI_SMBUS_OPERATION Operation,
@ -95,7 +95,7 @@ typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_PEI_SMBUS_NOTIFY_FUNCTION)( (EFIAPI *EFI_PEI_SMBUS_NOTIFY_FUNCTION)(
IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SERVICES **PeiServices,
IN EFI_PEI_SMBUS_PPI *SmbusPpi, IN EFI_PEI_SMBUS_PPI *SmbusPpi,
IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress, IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
IN UINTN Data IN UINTN Data
); );
@ -128,7 +128,7 @@ typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_PEI_SMBUS_PPI_ARP_DEVICE)( (EFIAPI *EFI_PEI_SMBUS_PPI_ARP_DEVICE)(
IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SERVICES **PeiServices,
IN EFI_PEI_SMBUS_PPI *This, IN EFI_PEI_SMBUS_PPI *This,
IN BOOLEAN ArpAll, IN BOOLEAN ArpAll,
IN EFI_SMBUS_UDID *SmbusUdid, OPTIONAL IN EFI_SMBUS_UDID *SmbusUdid, OPTIONAL
IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress OPTIONAL IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress OPTIONAL
@ -144,14 +144,14 @@ EFI_STATUS
@param SmbusDeviceMap The pointer to the device map as enumerated @param SmbusDeviceMap The pointer to the device map as enumerated
by the SMBus controller driver. by the SMBus controller driver.
@retval EFI_SUCCESS The device map was returned correctly in the buffer. @retval EFI_SUCCESS The device map was returned correctly in the buffer.
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_PEI_SMBUS_PPI_GET_ARP_MAP)( (EFIAPI *EFI_PEI_SMBUS_PPI_GET_ARP_MAP)(
IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SERVICES **PeiServices,
IN EFI_PEI_SMBUS_PPI *This, IN EFI_PEI_SMBUS_PPI *This,
IN OUT UINTN *Length, IN OUT UINTN *Length,
IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap
); );
@ -169,17 +169,17 @@ EFI_STATUS
@param NotifyFunction The function to call when the bus driver @param NotifyFunction The function to call when the bus driver
detects the SlaveAddress and Data pair. detects the SlaveAddress and Data pair.
@retval EFI_SUCCESS NotifyFunction has been registered. @retval EFI_SUCCESS NotifyFunction has been registered.
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_PEI_SMBUS_PPI_NOTIFY)( (EFIAPI *EFI_PEI_SMBUS_PPI_NOTIFY)(
IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_SERVICES **PeiServices,
IN EFI_PEI_SMBUS_PPI *This, IN EFI_PEI_SMBUS_PPI *This,
IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress, IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
IN UINTN Data, IN UINTN Data,
IN EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction IN EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction
); );
/** /**

4
IntelFrameworkPkg/Include/Protocol/SmmAccess.h
View File

@ -143,10 +143,10 @@ EFI_STATUS
Gets information on possible SMRAM regions. Gets information on possible SMRAM regions.
@param LockState @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 @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 { struct _EFI_SMM_ACCESS_PROTOCOL {

39
IntelFrameworkPkg/Include/Protocol/SmmBase.h
View File

@ -87,9 +87,11 @@ EFI_STATUS
@param SourceBuffer Optional source buffer in case of the image file @param SourceBuffer Optional source buffer in case of the image file
being in memory. being in memory.
@param SourceSize Size of the source image file, if in memory. @param SourceSize Size of the source image file, if in memory.
@param ImageHandle Pointer to the handle that reflects the driver @param ImageHandle The handle that the base driver uses to decode
loaded into SMM. the handler. Unique among SMM handlers only,
@param LegacyIA32Binary The binary image to load is legacy 16 bit code. 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_SUCCESS The operation was successful.
@retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler @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 Removes a handler from execution within SMRAM. This is the equivalent of performing
the UnloadImage System Management Mode. the UnloadImage in System Management Mode.
@param This Protocol instance pointer. @param This Protocol instance pointer.
@param ImageHandle Pointer to the handle that reflects the driver @param ImageHandle The handler to be removed.
loaded into SMM.
@retval EFI_SUCCESS The operation was successful @retval EFI_SUCCESS The operation was successful
@retval EFI_INVALID_PARAMETER The handler did not exist @retval EFI_INVALID_PARAMETER The handler did not exist
@ -133,13 +134,12 @@ EFI_STATUS
The SMM Inter-module Communicate Service Communicate() function The SMM Inter-module Communicate Service Communicate() function
provides a services to send/received messages from a registered provides a services to send/received messages from a registered
EFI service. The BASE protocol driver is responsible for doing 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 This Protocol instance pointer.
@param ImageHandle Pointer to the handle that reflects the driver @param ImageHandle The handle of the registered driver.
loaded into SMM.
@param CommunicationBuffer Pointer to the buffer to convey into SMRAM. @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_SUCCESS The message was successfully posted
@retval EFI_INVALID_PARAMETER The buffer was NULL @retval EFI_INVALID_PARAMETER The buffer was NULL
@ -156,14 +156,13 @@ EFI_STATUS
/** /**
Register a callback to execute within SMM. 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 This Protocol instance pointer.
@param CallbackAddress Address of the callback service @param SmmImageHandle Handle of the callback service.
@param MakeFirst If present, will stipulate that the handler is posted @param CallbackAddress Address of the callback service.
to be the first module executed in the dispatch table. @param MakeLast If present, will stipulate that the handler is posted to
@param MakeLast If present, will stipulate that the handler is posted be executed last in the dispatch table.
to be last executed in the dispatch table.
@param FloatingPointSave This is an optional parameter which informs the @param FloatingPointSave This is an optional parameter which informs the
EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save
the floating point register state. If any of the handlers 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_SUCCESS The operation was successful
@retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue @retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue
@retval EFI_UNSUPPORTED In runtime. @retval EFI_UNSUPPORTED In runtime.
@retval EFI_UNSUPPORTED Not in SMM. @retval EFI_UNSUPPORTED The caller is not in SMM.
**/ **/
typedef typedef
@ -194,7 +193,9 @@ EFI_STATUS
@param This Protocol instance pointer. @param This Protocol instance pointer.
@param PoolType The type of pool to allocate. @param PoolType The type of pool to allocate.
The only supported type is EfiRuntimeServicesData; 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 Size The number of bytes to allocate from the pool.
@param Buffer A pointer to a pointer to the allocated buffer if the call @param Buffer A pointer to a pointer to the allocated buffer if the call
succeeds; undefined otherwise. succeeds; undefined otherwise.

5
IntelFrameworkPkg/Include/Protocol/SmmControl.h
View File

@ -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 } \ 0x8d12e231, 0xc667, 0x4fd1, {0x98, 0xf2, 0x24, 0x49, 0xa7, 0xe7, 0xb2, 0xe5 } \
} }
//
// SMM Access specification Data Structures // SMM Access specification Data Structures
// //
typedef struct { typedef struct {
@ -78,7 +78,8 @@ EFI_STATUS
Clears any system state that was created in response to the Active call. Clears any system state that was created in response to the Active call.
@param This The EFI_SMM_CONTROL_PROTOCOL instance. @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_SUCCESS The SMI/PMI has been engendered.
@retval EFI_DEVICE_ERROR The source could not be cleared. @retval EFI_DEVICE_ERROR The source could not be cleared.

28
IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h
View File

@ -75,16 +75,15 @@ VOID
/** /**
Register a child SMI source dispatch function with a parent SMM driver Register a child SMI source dispatch function with a parent SMM driver
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.
@param DispatchFunction Pointer to dispatch function to be invoked for @param DispatchFunction Function to install.
this SMI source
@param DispatchContext Pointer to the dispatch function's context. @param DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling The caller fills this context in before calling
the register function to indicate to the register the register function to indicate to the register
function the GPI(s) for which the dispatch function function the GPI(s) for which the dispatch function
should be invoked. should be invoked.
@param DispatchHandle Handle of dispatch function, for when interfacing @param DispatchHandle Handle generated by the dispatcher to track the
with the parent Sx state SMM driver. function instance.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
registered and the SMI source has been enabled. registered and the SMI source has been enabled.
@ -98,31 +97,30 @@ VOID
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_GPI_REGISTER)( (EFIAPI *EFI_SMM_GPI_REGISTER)(
IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This, IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This,
IN EFI_SMM_GPI_DISPATCH DispatchFunction, IN EFI_SMM_GPI_DISPATCH DispatchFunction,
IN EFI_SMM_GPI_DISPATCH_CONTEXT *DispatchContext, IN EFI_SMM_GPI_DISPATCH_CONTEXT *DispatchContext,
OUT EFI_HANDLE *DispatchHandle OUT EFI_HANDLE *DispatchHandle
); );
/** /**
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 This Pointer to the EFI_SMM_GPI_DISPATCH_PROTOCOL instance.
@param DispatchHandle Handle of dispatch function to deregister. @param DispatchHandle Handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
unregistered and the SMI source has been disabled unregistered and the SMI source has been disabled
if there are no other registered child dispatch if there are no other registered child dispatch
functions for this SMI source. functions for this SMI source.
@retval EFI_INVALID_PARAMETER Handle is invalid. @retval EFI_INVALID_PARAMETER Handle is invalid.
@retval other TBD
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_GPI_UNREGISTER)( (EFIAPI *EFI_SMM_GPI_UNREGISTER)(
IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This, IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This,
IN EFI_HANDLE DispatchHandle IN EFI_HANDLE DispatchHandle
); );
// //

32
IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
View File

@ -107,7 +107,7 @@ typedef struct {
// Member functions // 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 DispatchHandle Handle of this dispatch function.
@param DispatchContext Pointer to the dispatch function's context. @param DispatchContext Pointer to the dispatch function's context.
@ -115,7 +115,7 @@ typedef struct {
by the dispatching driver prior to by the dispatching driver prior to
invoking this dispatch function. invoking this dispatch function.
Nothing @return None
**/ **/
typedef typedef
@ -128,16 +128,15 @@ VOID
/** /**
Register a child SMI source dispatch function with a parent SMM driver Register a child SMI source dispatch function with a parent SMM driver
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
@param DispatchFunction Pointer to dispatch function to be invoked for @param DispatchFunction Function to install.
this SMI source
@param DispatchContext Pointer to the dispatch function's context. @param DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling The caller fills this context in before calling
the register function to indicate to the register the register function to indicate to the register
function the ICHN SMI source for which the dispatch function the ICHN SMI source for which the dispatch
function should be invoked. function should be invoked.
@param DispatchHandle Handle of dispatch function, for when interfacing @param DispatchHandle Handle generated by the dispatcher to track the function
with the parent Sx state SMM driver. instance.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
registered and the SMI source has been enabled. registered and the SMI source has been enabled.
@ -151,35 +150,34 @@ VOID
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_ICHN_REGISTER)( (EFIAPI *EFI_SMM_ICHN_REGISTER)(
IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This, IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,
IN EFI_SMM_ICHN_DISPATCH DispatchFunction, IN EFI_SMM_ICHN_DISPATCH DispatchFunction,
IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext, IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext,
OUT EFI_HANDLE *DispatchHandle OUT EFI_HANDLE *DispatchHandle
); );
/** /**
Unregister a child SMI source dispatch function with a parent SMM driver Unregister a child SMI source dispatch function with a parent SMM driver
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
@param DispatchHandle Handle of dispatch function to deregister. @param DispatchHandle Handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
unregistered and the SMI source has been disabled unregistered and the SMI source has been disabled
if there are no other registered child dispatch if there are no other registered child dispatch
functions for this SMI source. functions for this SMI source.
@retval EFI_INVALID_PARAMETER Handle is invalid. @retval EFI_INVALID_PARAMETER Handle is invalid.
@retval other TBD
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_ICHN_UNREGISTER)( (EFIAPI *EFI_SMM_ICHN_UNREGISTER)(
IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This, IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,
IN EFI_HANDLE DispatchHandle IN EFI_HANDLE DispatchHandle
); );
// //
// Interface structure for the SMM Ich n specific SMI Dispatch Protocol // Interface structure for the SMM ICHN specific SMI Dispatch Protocol
// //
/** /**
@par Protocol Description: @par Protocol Description:

32
IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
View File

@ -84,14 +84,14 @@ typedef struct {
by the dispatching driver prior to by the dispatching driver prior to
invoking this dispatch function. invoking this dispatch function.
Nothing @return None
**/ **/
typedef typedef
VOID VOID
(EFIAPI *EFI_SMM_PERIODIC_TIMER_DISPATCH)( (EFIAPI *EFI_SMM_PERIODIC_TIMER_DISPATCH)(
IN EFI_HANDLE DispatchHandle, IN EFI_HANDLE DispatchHandle,
IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext
); );
/** /**
@ -119,16 +119,14 @@ EFI_STATUS
/** /**
Register a child SMI source dispatch function with a parent SMM driver Register a child SMI source dispatch function with a parent SMM driver
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.
@param DispatchFunction Pointer to dispatch function to be invoked for @param DispatchFunction Function to install.
this SMI source
@param DispatchContext Pointer to the dispatch function's context. @param DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling The caller fills this context in before calling
the register function to indicate to the register the register function to indicate to the register
function the period at which the dispatch function function the period at which the dispatch function
should be invoked. should be invoked.
@param DispatchHandle Handle of dispatch function, for when interfacing @param DispatchHandle Handle generated by the dispatcher to track the function instance.
with the parent Sx state SMM driver.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
registered and the SMI source has been enabled. registered and the SMI source has been enabled.
@ -142,17 +140,17 @@ EFI_STATUS
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER)( (EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER)(
IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This, IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,
IN EFI_SMM_PERIODIC_TIMER_DISPATCH DispatchFunction, IN EFI_SMM_PERIODIC_TIMER_DISPATCH DispatchFunction,
IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext, IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext,
OUT EFI_HANDLE *DispatchHandle OUT EFI_HANDLE *DispatchHandle
); );
/** /**
Unregister a child SMI source dispatch function with a parent SMM driver Unregisters a periodic timer service.
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.
@param DispatchHandle Handle of dispatch function to deregister. @param DispatchHandle Handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
unregistered and the SMI source has been disabled unregistered and the SMI source has been disabled
@ -164,8 +162,8 @@ EFI_STATUS
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER)( (EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER)(
IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This, IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,
IN EFI_HANDLE DispatchHandle IN EFI_HANDLE DispatchHandle
); );
// //

31
IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
View File

@ -62,7 +62,7 @@ typedef struct {
by the dispatching driver prior to by the dispatching driver prior to
invoking this dispatch function. invoking this dispatch function.
Nothing @return None
**/ **/
typedef 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 This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
@param DispatchFunction Pointer to dispatch function to be invoked for @param DispatchFunction Function to install.
this SMI source
@param DispatchContext Pointer to the dispatch function's context. @param DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling The caller fills this context in before calling
the register function to indicate to the register the register function to indicate to the register
function the Power Button SMI phase for which the dispatch function the Power Button SMI phase for which the dispatch
function should be invoked. function should be invoked.
@param DispatchHandle Handle of dispatch function, for when interfacing @param DispatchHandle Handle generated by the dispatcher to track the function instance.
with the parent Sx state SMM driver.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
registered and the SMI source has been enabled. registered and the SMI source has been enabled.
@ -98,31 +96,30 @@ VOID
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_POWER_BUTTON_REGISTER)( (EFIAPI *EFI_SMM_POWER_BUTTON_REGISTER)(
IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL *This,
IN EFI_SMM_POWER_BUTTON_DISPATCH DispatchFunction, IN EFI_SMM_POWER_BUTTON_DISPATCH DispatchFunction,
IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT *DispatchContext, IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT *DispatchContext,
OUT EFI_HANDLE *DispatchHandle OUT EFI_HANDLE *DispatchHandle
); );
/** /**
Unregister a child SMI source dispatch function with a parent SMM driver Unregisters a power-button service.
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
@param DispatchHandle Handle of dispatch function to deregister. @param DispatchHandle Handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
unregistered and the SMI source has been disabled unregistered and the SMI source has been disabled
if there are no other registered child dispatch if there are no other registered child dispatch
functions for this SMI source. functions for this SMI source.
@retval EFI_INVALID_PARAMETER Handle is invalid. @retval EFI_INVALID_PARAMETER Handle is invalid.
@retval other TBD
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_POWER_BUTTON_UNREGISTER)( (EFIAPI *EFI_SMM_POWER_BUTTON_UNREGISTER)(
IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL *This,
IN EFI_HANDLE DispatchHandle IN EFI_HANDLE DispatchHandle
); );
// //

27
IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
View File

@ -63,7 +63,7 @@ typedef struct {
by the dispatching driver prior to by the dispatching driver prior to
invoking this dispatch function. invoking this dispatch function.
@return Nothing @return None
**/ **/
typedef 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 This Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
@param DispatchFunction Pointer to dispatch function to be invoked for @param DispatchFunction Function to install.
this SMI source
@param DispatchContext Pointer to the dispatch function's context. @param DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling The caller fills this context in before calling
the register function to indicate to the register the register function to indicate to the register
function the Standby Button SMI phase for which the dispatch function the Standby Button SMI phase for which the dispatch
function should be invoked. function should be invoked.
@param DispatchHandle Handle of dispatch function, for when interfacing @param DispatchHandle Handle generated by the dispatcher to track the function instance.
with the parent Sx state SMM driver.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
registered and the SMI source has been enabled. registered and the SMI source has been enabled.
@ -99,31 +97,30 @@ VOID
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_STANDBY_BUTTON_REGISTER)( (EFIAPI *EFI_SMM_STANDBY_BUTTON_REGISTER)(
IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL *This,
IN EFI_SMM_STANDBY_BUTTON_DISPATCH DispatchFunction, IN EFI_SMM_STANDBY_BUTTON_DISPATCH DispatchFunction,
IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT *DispatchContext, IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT *DispatchContext,
OUT EFI_HANDLE *DispatchHandle OUT EFI_HANDLE *DispatchHandle
); );
/** /**
Unregister a child SMI source dispatch function with a parent SMM driver Unregister a child SMI source dispatch function with a parent SMM driver
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
@param DispatchHandle Handle of dispatch function to deregister. @param DispatchHandle Handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
unregistered and the SMI source has been disabled unregistered and the SMI source has been disabled
if there are no other registered child dispatch if there are no other registered child dispatch
functions for this SMI source. functions for this SMI source.
@retval EFI_INVALID_PARAMETER Handle is invalid. @retval EFI_INVALID_PARAMETER Handle is invalid.
@retval other TBD
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_STANDBY_BUTTON_UNREGISTER)( (EFIAPI *EFI_SMM_STANDBY_BUTTON_UNREGISTER)(
IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL *This, IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL *This,
IN EFI_HANDLE DispatchHandle IN EFI_HANDLE DispatchHandle
); );
// //

27
IntelFrameworkPkg/Include/Protocol/SmmSwDispatch.h
View File

@ -59,7 +59,7 @@ typedef struct {
The dispatch function will only be called The dispatch function will only be called
for input values for which it is registered. for input values for which it is registered.
Nothing @return None
**/ **/
typedef typedef
@ -72,16 +72,14 @@ VOID
/** /**
Register a child SMI source dispatch function with a parent SMM driver Register a child SMI source dispatch function with a parent SMM driver
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.
@param DispatchFunction Pointer to dispatch function to be invoked for @param DispatchFunction Function to install.
this SMI source
@param DispatchContext Pointer to the dispatch function's context. @param DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling The caller fills this context in before calling
the register function to indicate to the register the register function to indicate to the register
function which Software SMI input value the function which Software SMI input value the
dispatch function should be invoked for. dispatch function should be invoked for.
@param DispatchHandle Handle of dispatch function, for when interfacing @param DispatchHandle Handle generated by the dispatcher to track the function instance.
with the parent Sx state SMM driver.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
registered and the SMI source has been enabled. registered and the SMI source has been enabled.
@ -95,31 +93,30 @@ VOID
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_SW_REGISTER)( (EFIAPI *EFI_SMM_SW_REGISTER)(
IN EFI_SMM_SW_DISPATCH_PROTOCOL *This, IN EFI_SMM_SW_DISPATCH_PROTOCOL *This,
IN EFI_SMM_SW_DISPATCH DispatchFunction, IN EFI_SMM_SW_DISPATCH DispatchFunction,
IN EFI_SMM_SW_DISPATCH_CONTEXT *DispatchContext, IN EFI_SMM_SW_DISPATCH_CONTEXT *DispatchContext,
OUT EFI_HANDLE *DispatchHandle OUT EFI_HANDLE *DispatchHandle
); );
/** /**
Unregister a child SMI source dispatch function with a parent SMM driver Unregister a child SMI source dispatch function with a parent SMM driver
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_SW_DISPATCH_PROTOCOL instance.
@param DispatchHandle Handle of dispatch function to deregister. @param DispatchHandle Handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
unregistered and the SMI source has been disabled unregistered and the SMI source has been disabled
if there are no other registered child dispatch if there are no other registered child dispatch
functions for this SMI source. functions for this SMI source.
@retval EFI_INVALID_PARAMETER Handle is invalid. @retval EFI_INVALID_PARAMETER Handle is invalid.
@retval other TBD
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_SW_UNREGISTER)( (EFIAPI *EFI_SMM_SW_UNREGISTER)(
IN EFI_SMM_SW_DISPATCH_PROTOCOL *This, IN EFI_SMM_SW_DISPATCH_PROTOCOL *This,
IN EFI_HANDLE DispatchHandle IN EFI_HANDLE DispatchHandle
); );
// //

26
IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
View File

@ -70,7 +70,7 @@ typedef struct {
and phases, so the Sx state handler(s) must check the Type and and phases, so the Sx state handler(s) must check the Type and
Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly. Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.
Nothing @return None
**/ **/
typedef typedef
@ -83,9 +83,8 @@ VOID
/** /**
Register a child SMI source dispatch function with a parent SMM driver Register a child SMI source dispatch function with a parent SMM driver
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
@param DispatchFunction Pointer to dispatch function to be invoked for @param DispatchFunction Function to install.
this SMI source
@param DispatchContext Pointer to the dispatch function's context. @param DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling The caller fills this context in before calling
the register function to indicate to the register the register function to indicate to the register
@ -112,30 +111,29 @@ VOID
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_SX_REGISTER)( (EFIAPI *EFI_SMM_SX_REGISTER)(
IN EFI_SMM_SX_DISPATCH_PROTOCOL *This, IN EFI_SMM_SX_DISPATCH_PROTOCOL *This,
IN EFI_SMM_SX_DISPATCH DispatchFunction, IN EFI_SMM_SX_DISPATCH DispatchFunction,
IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext, IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext,
OUT EFI_HANDLE *DispatchHandle OUT EFI_HANDLE *DispatchHandle
); );
/** /**
Unregister a child SMI source dispatch function with a parent SMM driver Unregisters an Sx-state service
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
@param DispatchHandle Handle of dispatch function to deregister. @param DispatchHandle Handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully unregistered and the @retval EFI_SUCCESS The dispatch function has been successfully unregistered and the
SMI source has been disabled if there are no other registered child SMI source has been disabled if there are no other registered child
dispatch functions for this SMI source. dispatch functions for this SMI source.
@retval EFI_INVALID_PARAMETER Handle is invalid. @retval EFI_INVALID_PARAMETER Handle is invalid.
@retval other TBD
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SMM_SX_UNREGISTER)( (EFIAPI *EFI_SMM_SX_UNREGISTER)(
IN EFI_SMM_SX_DISPATCH_PROTOCOL *This, IN EFI_SMM_SX_DISPATCH_PROTOCOL *This,
IN EFI_HANDLE DispatchHandle IN EFI_HANDLE DispatchHandle
); );
// //

18
IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
View File

@ -57,7 +57,7 @@ typedef struct {
by the dispatching driver prior to by the dispatching driver prior to
invoking this dispatch function. invoking this dispatch function.
Nothing @return None
**/ **/
typedef typedef
@ -70,16 +70,16 @@ VOID
/** /**
Register a child SMI source dispatch function with a parent SMM driver Register a child SMI source dispatch function with a parent SMM driver
@param This Protocol instance pointer. @param This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.
@param DispatchFunction Pointer to dispatch function to be invoked for @param DispatchFunction Pointer to dispatch function to be invoked
this SMI source for this SMI source.
@param DispatchContext Pointer to the dispatch function's context. @param DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling The caller fills this context in before calling
the register function to indicate to the register the register function to indicate to the register
function the USB SMI types for which the dispatch function the USB SMI types for which the dispatch
function should be invoked. function should be invoked.
@param DispatchHandle Handle of dispatch function, for when interfacing @param DispatchHandle Handle generated by the dispatcher to track the
with the parent Sx state SMM driver. function instance.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
registered and the SMI source has been enabled. 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 This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.
@param DispatchHandle Handle of dispatch function to deregister. @param DispatchHandle Handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully @retval EFI_SUCCESS The dispatch function has been successfully
unregistered and the SMI source has been disabled unregistered and the SMI source has been disabled