4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides the parent dispatch service for a given Sx-state source generator.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is defined in Framework of EFI SMM Core Interface Spec
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Version 0.9.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Share some common definitions with PI SMM
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Global ID for the Sx SMI Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x14fc52be, 0x1dc, 0x426c, {0x91, 0xae, 0xa2, 0x3c, 0x3e, 0x22, 0xa, 0xe8 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL EFI_SMM_SX_DISPATCH_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Member functions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dispatch function for a Sx state SMI handler.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DispatchHandle The handle of this dispatch function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DispatchContext The pointer to the dispatch function's context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Type and Phase fields are filled in by the Sx dispatch driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prior to invoking this dispatch function. For this interface,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Sx driver will call the dispatch function for all Sx type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and phases, so the Sx state handler(s) must check the Type and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Phase field of EFI_SMM_SX_DISPATCH_CONTEXT, and act accordingly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return None
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Register a child SMI source dispatch function with a parent SMM driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DispatchFunction The function to install.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DispatchContext The pointer to the dispatch function's context.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The caller fills in this context before calling
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the register function to indicates to the register
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function which Sx state type and phase the caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync wishes to be called back on. For this interface,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Sx driver will call the registered handlers for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all Sx type and phases, so the Sx state handler(s)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must check the Type and Phase field of the Dispatch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync context, and act accordingly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DispatchHandle The handle of dispatch function, for interfacing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the parent Sx state SMM driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The dispatch function has been successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registered and the SMI source has been enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The Sx driver or hardware does not support that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The Sx driver was unable to enable the SMI source.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DispatchContext is invalid. Type & Phase are not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync within a valid range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Unregisters an Sx-state service
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DispatchHandle The handle of the service to remove.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The dispatch function has been successfully unregistered, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMI source has been disabled, if there are no other registered child
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync dispatch functions for this SMI source.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Interface structure for the SMM Child Dispatch Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides the parent dispatch service for a given Sx-state source generator.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SMM_SX_REGISTER Register; ///< Installs a child service to be dispatched by this protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SMM_SX_UNREGISTER UnRegister; ///< Removes a child service dispatched by this protocol.