Data Structures | |
struct | EFI_SMM_SX_REGISTER_CONTEXT |
struct | _EFI_SMM_SX_DISPATCH2_PROTOCOL |
Defines | |
#define | EFI_SMM_SX_DISPATCH2_PROTOCOL_GUID |
Typedefs | |
typedef struct _EFI_SMM_SX_DISPATCH2_PROTOCOL | EFI_SMM_SX_DISPATCH2_PROTOCOL |
typedef EFI_STATUS(EFIAPI * | EFI_SMM_SX_REGISTER2 )(IN CONST EFI_SMM_SX_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN CONST EFI_SMM_SX_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle) |
typedef EFI_STATUS(EFIAPI * | EFI_SMM_SX_UNREGISTER2 )(IN CONST EFI_SMM_SX_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle) |
Enumerations | |
enum | EFI_SLEEP_TYPE { SxS0, SxS1, SxS2, SxS3, SxS4, SxS5, EfiMaximumSleepType } |
enum | EFI_SLEEP_PHASE { SxEntry, SxExit, EfiMaximumPhase } |
Variables | |
EFI_GUID | gEfiSmmSxDispatch2ProtocolGuid |
Provides the parent dispatch service for a given Sx-state source generator.
Copyright (c) 2009 - 2010, 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.
#define EFI_SMM_SX_DISPATCH2_PROTOCOL_GUID |
Value:
{ \ 0x456d2859, 0xa84b, 0x4e47, {0xa2, 0xee, 0x32, 0x76, 0xd8, 0x86, 0x99, 0x7d } \ }
typedef struct _EFI_SMM_SX_DISPATCH2_PROTOCOL EFI_SMM_SX_DISPATCH2_PROTOCOL |
typedef EFI_STATUS(EFIAPI * EFI_SMM_SX_REGISTER2)(IN CONST EFI_SMM_SX_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN CONST EFI_SMM_SX_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle) |
Provides the parent dispatch service for a given Sx source generator.
This service registers a function (DispatchFunction) which will be called when the sleep state event specified by RegisterContext is detected. On return, DispatchHandle contains a unique handle which may be used later to unregister the function using UnRegister(). The DispatchFunction will be called with Context set to the same value as was passed into this function in RegisterContext and with CommBuffer and CommBufferSize set to NULL and 0 respectively.
[in] | This | Pointer to the EFI_SMM_SX_DISPATCH2_PROTOCOL instance. |
[in] | DispatchFunction | Function to register for handler when the specified sleep state event occurs. |
[in] | RegisterContext | Pointer to the dispatch function's context. The caller fills this context in before calling the register function to indicate to the register function which Sx state type and phase the caller wishes to be called back on. For this intertace, the Sx driver will call the registered handlers for all Sx type and phases, so the Sx state handler(s) must check the Type and Phase field of the Dispatch context and act accordingly. |
[out] | DispatchHandle | Handle of dispatch function, for when interfacing with the parent Sx state SMM driver. |
EFI_SUCCESS | The dispatch function has been successfully registered and the SMI source has been enabled. | |
EFI_UNSUPPORTED | The Sx driver or hardware does not support that Sx Type/Phase. | |
EFI_DEVICE_ERROR | The Sx driver was unable to enable the SMI source. | |
EFI_INVALID_PARAMETER | RegisterContext is invalid. Type & Phase are not within valid range. | |
EFI_OUT_OF_RESOURCES | There is not enough memory (system or SMM) to manage this child. |
typedef EFI_STATUS(EFIAPI * EFI_SMM_SX_UNREGISTER2)(IN CONST EFI_SMM_SX_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle) |
Unregisters an Sx-state service.
This service removes the handler associated with DispatchHandle so that it will no longer be called in response to sleep event.
[in] | This | Pointer to the EFI_SMM_SX_DISPATCH2_PROTOCOL instance. |
[in] | DispatchHandle | Handle of the service to remove. |
EFI_SUCCESS | The service has been successfully removed. | |
EFI_INVALID_PARAMETER | The DispatchHandle was not valid. |
enum EFI_SLEEP_PHASE |
enum EFI_SLEEP_TYPE |