Data Structures | |
struct | EFI_SMM_SX_DISPATCH_CONTEXT |
struct | _EFI_SMM_SX_DISPATCH_PROTOCOL |
Defines | |
#define | EFI_SMM_SX_DISPATCH_PROTOCOL_GUID |
Typedefs | |
typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL | EFI_SMM_SX_DISPATCH_PROTOCOL |
typedef VOID(EFIAPI * | EFI_SMM_SX_DISPATCH )(IN EFI_HANDLE DispatchHandle, IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext) |
typedef EFI_STATUS(EFIAPI * | EFI_SMM_SX_REGISTER )(IN EFI_SMM_SX_DISPATCH_PROTOCOL *This, IN EFI_SMM_SX_DISPATCH DispatchFunction, IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext, OUT EFI_HANDLE *DispatchHandle) |
typedef EFI_STATUS(EFIAPI * | EFI_SMM_SX_UNREGISTER )(IN EFI_SMM_SX_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle) |
Variables | |
EFI_GUID | gEfiSmmSxDispatchProtocolGuid |
Copyright (c) 2007 - 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 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.
#define EFI_SMM_SX_DISPATCH_PROTOCOL_GUID |
Value:
{ \ 0x14fc52be, 0x1dc, 0x426c, {0x91, 0xae, 0xa2, 0x3c, 0x3e, 0x22, 0xa, 0xe8 } \ }
typedef VOID(EFIAPI * EFI_SMM_SX_DISPATCH)(IN EFI_HANDLE DispatchHandle, IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext) |
Dispatch function for a Sx state SMI handler.
DispatchHandle | The handle of this dispatch function. | |
DispatchContext | The pointer to the dispatch function's context. The Type and Phase fields are filled in by the Sx dispatch driver prior to invoking this dispatch function. For this interface, the Sx driver will call the dispatch function for all Sx type and phases, so the Sx state handler(s) must check the Type and Phase field of EFI_SMM_SX_DISPATCH_CONTEXT, and act accordingly. |
typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL EFI_SMM_SX_DISPATCH_PROTOCOL |
typedef EFI_STATUS(EFIAPI * EFI_SMM_SX_REGISTER)(IN EFI_SMM_SX_DISPATCH_PROTOCOL *This, IN EFI_SMM_SX_DISPATCH DispatchFunction, IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext, OUT EFI_HANDLE *DispatchHandle) |
Register a child SMI source dispatch function with a parent SMM driver.
This | The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance. | |
DispatchFunction | The function to install. | |
DispatchContext | The pointer to the dispatch function's context. The caller fills in this context before calling the register function to indicates to the register function which Sx state type and phase the caller wishes to be called back on. For this interface, 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. | |
DispatchHandle | The handle of dispatch function, for 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_OUT_OF_RESOURCES | Not enough memory (system or SMM) to manage this child. | |
EFI_INVALID_PARAMETER | DispatchContext is invalid. Type & Phase are not within a valid range. |
typedef EFI_STATUS(EFIAPI * EFI_SMM_SX_UNREGISTER)(IN EFI_SMM_SX_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle) |
Unregisters an Sx-state service
This | The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance. | |
DispatchHandle | The handle of the service to remove. |
EFI_SUCCESS | The dispatch function has been successfully unregistered, and the SMI source has been disabled, if there are no other registered child dispatch functions for this SMI source. | |
EFI_INVALID_PARAMETER | Handle is invalid. |
EFI_GUID gEfiSmmSxDispatchProtocolGuid |