summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
diff options
context:
space:
mode:
authormyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-03-16 01:53:11 +0000
committermyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-03-16 01:53:11 +0000
commitf22f941ed273753a0426d1234869857f19c28664 (patch)
tree414dd4cc3fa518dca29739d001eac8378d880dd2 /IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
parenta89fa50ccf7a29405e3d24c49625dbd70cdba9fa (diff)
downloadedk2-platforms-f22f941ed273753a0426d1234869857f19c28664.tar.xz
Grammatical and disclaimer changes (does not follow internal C coding stds.)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10249 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h')
-rw-r--r--IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h44
1 files changed, 23 insertions, 21 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
index 64bba9fac4..eab8e8732b 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
@@ -1,14 +1,14 @@
/** @file
Provides the parent dispatch service for the power button SMI source generator.
- 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
@@ -53,8 +53,8 @@ typedef struct {
/**
Dispatch function for a Power Button SMI handler.
- @param[in] DispatchHandle Handle of this dispatch function.
- @param[in] DispatchContext Pointer to the dispatch function's context.
+ @param[in] DispatchHandle The handle of this dispatch function.
+ @param[in] 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.
@@ -70,13 +70,15 @@ VOID
/**
Provides the parent dispatch service for a given SMI source generator
- @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
- @param[in] DispatchFunction Function to install.
- @param[in] DispatchContext Pointer to the dispatch function's context.
+ @param[in] This The pointer to the
+ EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
+ @param[in] DispatchFunction The function to install.
+ @param[in] DispatchContext The pointer to the dispatch function's context.
Indicates to the register
- function the Power Button SMI phase for which to invoke the dispatch
- function.
- @param[out] DispatchHandle Handle generated by the dispatcher to track the function instance.
+ function the Power Button SMI phase for which
+ to invoke the dispatch function.
+ @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.
@@ -99,15 +101,15 @@ EFI_STATUS
/**
Unregisters a power-button service.
- @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
- @param[in] DispatchHandle Handle of the service to remove.
+ @param[in] This The pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.
+ @param[in] 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 if there are no other registered
+ 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