/** @file\r
Provides the parent dispatch service for a given Sx-state 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: SmmSxDispatch.h\r
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
#ifndef _EFI_SMM_SX_DISPATCH_H_\r
#define _EFI_SMM_SX_DISPATCH_H_\r
\r
-#include <PiDxe.h>\r
+//\r
+// Share some common definitions with PI SMM\r
+//\r
+#include <Protocol/SmmSxDispatch2.h>\r
\r
//\r
// Global ID for the Sx SMI Protocol\r
}\r
\r
typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL EFI_SMM_SX_DISPATCH_PROTOCOL;\r
-//\r
-// Related Definitions\r
-//\r
-typedef enum {\r
- SxS0,\r
- SxS1,\r
- SxS2,\r
- SxS3,\r
- SxS4,\r
- SxS5,\r
- EfiMaximumSleepType\r
-} EFI_SLEEP_TYPE;\r
-\r
-typedef enum {\r
- SxEntry,\r
- SxExit,\r
- EfiMaximumPhase\r
-} EFI_SLEEP_PHASE;\r
\r
typedef struct {\r
EFI_SLEEP_TYPE Type;\r
/**\r
Dispatch function for a Sx state SMI handler.\r
\r
- @param DispatchHandle Handle of this dispatch function.\r
- @param DispatchContext Pointer to the dispatch function's context.\r
+ @param DispatchHandle The handle of this dispatch function.\r
+ @param DispatchContext The pointer to the dispatch function's context.\r
The Type and Phase fields are filled in by the Sx dispatch driver\r
prior to invoking this dispatch function. For this interface,\r
the Sx driver will call the dispatch function for all Sx type\r
and phases, so the Sx state handler(s) must check the Type and\r
- Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.\r
+ Phase field of EFI_SMM_SX_DISPATCH_CONTEXT, and act accordingly.\r
\r
- Nothing\r
+ @return None\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_SMM_SX_DISPATCH) (\r
+(EFIAPI *EFI_SMM_SX_DISPATCH)(\r
IN EFI_HANDLE DispatchHandle,\r
IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext\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
+ Register a child SMI source dispatch function with a parent SMM driver.\r
+\r
+ @param This The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
+ @param DispatchFunction The function to install.\r
+ @param DispatchContext The pointer to the dispatch function's context.\r
+ The caller fills in this context before calling\r
+ the register function to indicates to the register\r
function which Sx state type and phase the caller\r
- wishes to be called back on. For this intertace,\r
+ wishes to be called back on. For this interface,\r
the Sx driver will call the registered handlers for\r
all Sx type and phases, so the Sx state handler(s)\r
must check the Type and Phase field of the Dispatch\r
- context and act accordingly.\r
- @param DispatchHandle Handle of dispatch function, for when interfacing\r
+ context, and act accordingly.\r
+ @param DispatchHandle The handle of dispatch function, for interfacing\r
with the parent Sx state SMM driver.\r
\r
@retval EFI_SUCCESS The dispatch function has been successfully\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. Type & Phase are not\r
- within valid range.\r
+ within a valid range.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_SX_REGISTER) (\r
- IN EFI_SMM_SX_DISPATCH_PROTOCOL *This,\r
- IN EFI_SMM_SX_DISPATCH DispatchFunction,\r
- IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext,\r
- OUT EFI_HANDLE *DispatchHandle\r
+(EFIAPI *EFI_SMM_SX_REGISTER)(\r
+ IN EFI_SMM_SX_DISPATCH_PROTOCOL *This,\r
+ IN EFI_SMM_SX_DISPATCH DispatchFunction,\r
+ IN EFI_SMM_SX_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 an Sx-state service\r
\r
- @param This Protocol instance pointer.\r
- @param DispatchHandle Handle of dispatch function to deregister.\r
+ @param This The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
+ @param DispatchHandle The handle of the service to remove.\r
\r
- @retval EFI_SUCCESS The dispatch function has been successfully unregistered and the\r
- SMI source has been disabled if there are no other registered child\r
+ @retval EFI_SUCCESS The dispatch function has been successfully unregistered, and the\r
+ SMI source has been disabled, if there are no other registered child\r
dispatch functions for this SMI source.\r
@retval EFI_INVALID_PARAMETER Handle is invalid.\r
- @retval other TBD\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_SX_UNREGISTER) (\r
- IN EFI_SMM_SX_DISPATCH_PROTOCOL *This,\r
- IN EFI_HANDLE DispatchHandle\r
+(EFIAPI *EFI_SMM_SX_UNREGISTER)(\r
+ IN EFI_SMM_SX_DISPATCH_PROTOCOL *This,\r
+ IN EFI_HANDLE DispatchHandle\r
);\r
\r
//\r
// Interface structure for the SMM Child Dispatch Protocol\r
//\r
/**\r
- @par Protocol Description:\r
Provides the parent dispatch service for a given Sx-state 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_SX_DISPATCH_PROTOCOL {\r
- EFI_SMM_SX_REGISTER Register;\r
- EFI_SMM_SX_UNREGISTER UnRegister;\r
+ EFI_SMM_SX_REGISTER Register; ///< Installs a child service to be dispatched by this protocol.\r
+ EFI_SMM_SX_UNREGISTER UnRegister; ///< Removes a child service dispatched by this protocol.\r
};\r
\r
extern EFI_GUID gEfiSmmSxDispatchProtocolGuid;\r
projects / mirror_edk2.git / blobdiff