summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
diff options
context:
space:
mode:
Diffstat (limited to 'IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h')
-rw-r--r--IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h45
1 files changed, 23 insertions, 22 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
index dd3ced5..7d98fcd 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
@@ -5,14 +5,14 @@
the Intel Platform Innovation Framework for EFI SMM Core Interface Specification
(SMM CIS) Version 0.9.
- Copyright (c) 2007, 2009 Intel Corporation
- All rights reserved. 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
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2007 - 2010, 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 that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@par Revision Reference:
This Protocol is defined in Framework of EFI SMM Core Interface Spec
@@ -56,8 +56,8 @@ typedef struct {
/**
Dispatch function for a Standby Button SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
+ @param DispatchHandle The handle of this dispatch function.
+ @param DispatchContext The pointer to the dispatch function's context.
The DispatchContext fields are filled in
by the dispatching driver prior to
invoking this dispatch function.
@@ -73,16 +73,17 @@ VOID
/**
Provides the parent dispatch service for a given SMI source generator
- @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.
- Indicates to the register
- function the Standby Button SMI phase for which to invoke the dispatch
+ @param This The pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
+ @param DispatchFunction The function to install.
+ @param DispatchContext The pointer to the dispatch function's context.
+ Indicates to the register function the Standby
+ Button SMI phase for which to invoke the dispatch
function.
- @param DispatchHandle Handle generated by the dispatcher to track the function instance.
+ @param DispatchHandle The 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.
+ registered, and the SMI source has been enabled.
@retval EFI_DEVICE_ERROR The driver could not enable the SMI source.
@retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
child.
@@ -100,16 +101,16 @@ EFI_STATUS
);
/**
- 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 Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
- @param DispatchHandle Handle of the service to remove.
+ @param This The pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.
+ @param DispatchHandle The handle of the service to remove.
@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
functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval EFI_INVALID_PARAMETER The handle is invalid.
**/
typedef