Data Structures | |
struct | EFI_SMM_SW_REGISTER_CONTEXT |
struct | EFI_SMM_SW_CONTEXT |
struct | _EFI_SMM_SW_DISPATCH2_PROTOCOL |
Defines | |
#define | EFI_SMM_SW_DISPATCH2_PROTOCOL_GUID |
Typedefs | |
typedef struct _EFI_SMM_SW_DISPATCH2_PROTOCOL | EFI_SMM_SW_DISPATCH2_PROTOCOL |
typedef EFI_STATUS(EFIAPI * | EFI_SMM_SW_REGISTER2 )(IN CONST EFI_SMM_SW_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN OUT EFI_SMM_SW_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle) |
typedef EFI_STATUS(EFIAPI * | EFI_SMM_SW_UNREGISTER2 )(IN CONST EFI_SMM_SW_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle) |
Variables | |
EFI_GUID | gEfiSmmSwDispatch2ProtocolGuid |
This protocol provides the parent dispatch service for a given SMI source generator.
Copyright (c) 2009 - 2012, 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_SW_DISPATCH2_PROTOCOL_GUID |
Value:
{ \ 0x18a3c6dc, 0x5eea, 0x48c8, {0xa1, 0xc1, 0xb5, 0x33, 0x89, 0xf9, 0x89, 0x99 } \ }
typedef struct _EFI_SMM_SW_DISPATCH2_PROTOCOL EFI_SMM_SW_DISPATCH2_PROTOCOL |
typedef EFI_STATUS(EFIAPI * EFI_SMM_SW_REGISTER2)(IN CONST EFI_SMM_SW_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN OUT EFI_SMM_SW_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle) |
Register a child SMI source dispatch function for the specified software SMI.
This service registers a function (DispatchFunction) which will be called when the software SMI source specified by RegisterContext->SwSmiCpuIndex is detected. On return, DispatchHandle contains a unique handle which may be used later to unregister the function using UnRegister().
[in] | This | Pointer to the EFI_SMM_SW_DISPATCH2_PROTOCOL instance. |
[in] | DispatchFunction | Function to register for handler when the specified software SMI is generated. |
[in,out] | 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 Software SMI input value the dispatch function should be invoked for. |
[out] | DispatchHandle | Handle generated by the dispatcher to track the function instance. |
EFI_SUCCESS | The dispatch function has been successfully registered and the SMI source has been enabled. | |
EFI_DEVICE_ERROR | The SW driver was unable to enable the SMI source. | |
EFI_INVALID_PARAMETER | RegisterContext is invalid. The SW SMI input value is not within valid range. | |
EFI_OUT_OF_RESOURCES | There is not enough memory (system or SMM) to manage this child. | |
EFI_OUT_OF_RESOURCES | A unique software SMI value could not be assigned for this dispatch. |
typedef EFI_STATUS(EFIAPI * EFI_SMM_SW_UNREGISTER2)(IN CONST EFI_SMM_SW_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle) |
Unregister a child SMI source dispatch function for the specified software SMI.
This service removes the handler associated with DispatchHandle so that it will no longer be called in response to a software SMI.
[in] | This | Pointer to the EFI_SMM_SW_DISPATCH2_PROTOCOL instance. |
[in] | DispatchHandle | Handle of dispatch function to deregister. |
EFI_SUCCESS | The dispatch function has been successfully unregistered. | |
EFI_INVALID_PARAMETER | The DispatchHandle was not valid. |