/** @file\r
Provides the parent dispatch service for the power button SMI source generator.\r
\r
- Copyright (c) 2007, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
- Module Name: SmmPowerButtonDispatch.h\r
-\r
@par Revision Reference:\r
This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
Version 0.9.\r
\r
+Copyright (c) 2007, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
**/\r
\r
#ifndef _EFI_SMM_POWER_BUTTON_DISPATCH_H_\r
/**\r
Dispatch function for a Power Button SMI handler.\r
\r
- @param DispatchHandle Handle of this dispatch function.\r
- @param DispatchContext Pointer to the dispatch function's context.\r
- The DispatchContext fields are filled in\r
- by the dispatching driver prior to\r
- invoking this dispatch function.\r
-\r
- Nothing\r
+ @param[in] DispatchHandle Handle of this dispatch function.\r
+ @param[in] DispatchContext Pointer to the dispatch function's context.\r
+ The DispatchContext fields are filled in\r
+ by the dispatching driver prior to\r
+ invoking this dispatch function.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
- Register a child SMI source dispatch function with a parent SMM driver\r
-\r
- @param This Protocol instance pointer.\r
- @param DispatchFunction Pointer to dispatch function to be invoked for\r
- this SMI source\r
- @param DispatchContext Pointer to the dispatch function's context.\r
- The caller fills this context in before calling\r
- the register function to indicate to the register\r
- function the Power Button SMI phase for which the dispatch\r
- function should be invoked.\r
- @param DispatchHandle Handle of dispatch function, for when interfacing\r
- with the parent Sx state SMM driver.\r
-\r
- @retval EFI_SUCCESS The dispatch function has been successfully\r
- registered and the SMI source has been enabled.\r
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.\r
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this\r
- child.\r
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI\r
- phase is not within valid range.\r
+ Provides the parent dispatch service for a given SMI source generator\r
+\r
+ @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.\r
+ @param[in] DispatchFunction Function to install.\r
+ @param[in] DispatchContext Pointer to the dispatch function's context.\r
+ The caller fills this context in before calling\r
+ the register function to indicate to the register\r
+ function the Power Button SMI phase for which the dispatch\r
+ function should be invoked.\r
+ @param[out] DispatchHandle Handle generated by the dispatcher to track the function instance.\r
+\r
+ @retval EFI_SUCCESS The dispatch function has been successfully\r
+ registered and the SMI source has been enabled.\r
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this\r
+ child.\r
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI\r
+ phase is not within valid range.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_POWER_BUTTON_REGISTER)(\r
- IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL *This,\r
- IN EFI_SMM_POWER_BUTTON_DISPATCH DispatchFunction,\r
- IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT *DispatchContext,\r
- OUT EFI_HANDLE *DispatchHandle\r
+ IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL *This,\r
+ IN EFI_SMM_POWER_BUTTON_DISPATCH DispatchFunction,\r
+ IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT *DispatchContext,\r
+ OUT EFI_HANDLE *DispatchHandle\r
);\r
\r
/**\r
- Unregister a child SMI source dispatch function with a parent SMM driver\r
+ Unregisters a power-button service.\r
\r
- @param This Protocol instance pointer.\r
- @param DispatchHandle Handle of dispatch function to deregister.\r
+ @param[in] This Pointer to the EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL instance.\r
+ @param[in] DispatchHandle Handle of the service to remove.\r
\r
- @retval EFI_SUCCESS The dispatch function has been successfully\r
- unregistered and the SMI source has been disabled\r
- if there are no other registered child dispatch\r
- functions for this SMI source.\r
- @retval EFI_INVALID_PARAMETER Handle is invalid.\r
- @retval other TBD\r
+ @retval EFI_SUCCESS The dispatch function has been successfully\r
+ unregistered and the SMI source has been\r
+ disabled if there are no other registered\r
+ child dispatch functions for this SMI\r
+ source.\r
+ @retval EFI_INVALID_PARAMETER Handle is invalid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_POWER_BUTTON_UNREGISTER)(\r
- IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL *This,\r
- IN EFI_HANDLE DispatchHandle\r
+ IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL *This,\r
+ IN EFI_HANDLE DispatchHandle\r
);\r
\r
-//\r
-// Interface structure for the SMM Power Button SMI Dispatch Protocol\r
-//\r
/**\r
@par Protocol Description:\r
Provides the parent dispatch service for the SMM power button SMI source generator.\r
\r
- @param Register\r
- Installs a child service to be dispatched by this protocol.\r
-\r
- @param UnRegister\r
- Removes a child service dispatched by this protocol.\r
-\r
**/\r
struct _EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL {\r
+ ///\r
+ /// Installs a child service to be dispatched by this protocol.\r
+ ///\r
EFI_SMM_POWER_BUTTON_REGISTER Register;\r
+\r
+ ///\r
+ /// Removes a child service dispatched by this protocol.\r
+ ///\r
EFI_SMM_POWER_BUTTON_UNREGISTER UnRegister;\r
};\r
\r
projects / mirror_edk2.git / blobdiff