IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h File Reference


Data Structures

struct  EFI_SMM_ICHN_DISPATCH_CONTEXT
struct  _EFI_SMM_ICHN_DISPATCH_PROTOCOL

Defines

#define EFI_SMM_ICHN_DISPATCH_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_SMM_ICHN_DISPATCH_PROTOCOL 
EFI_SMM_ICHN_DISPATCH_PROTOCOL
typedef VOID(EFIAPI * EFI_SMM_ICHN_DISPATCH )(IN EFI_HANDLE DispatchHandle, IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext)
typedef EFI_STATUS(EFIAPI * EFI_SMM_ICHN_REGISTER )(IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This, IN EFI_SMM_ICHN_DISPATCH DispatchFunction, IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI * EFI_SMM_ICHN_UNREGISTER )(IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Enumerations

enum  EFI_SMM_ICHN_SMI_TYPE {
  IchnMch, IchnPme, IchnRtcAlarm, IchnRingIndicate,
  IchnAc97Wake, IchnSerialIrq, IchnY2KRollover, IchnTcoTimeout,
  IchnOsTco, IchnNmi, IchnIntruderDetect, IchnBiosWp,
  IchnMcSmi, IchnPmeB0, IchnThrmSts, IchnSmBus,
  IchnIntelUsb2, IchnMonSmi7, IchnMonSmi6, IchnMonSmi5,
  IchnMonSmi4, IchnDevTrap13, IchnDevTrap12, IchnDevTrap11,
  IchnDevTrap10, IchnDevTrap9, IchnDevTrap8, IchnDevTrap7,
  IchnDevTrap6, IchnDevTrap5, IchnDevTrap3, IchnDevTrap2,
  IchnDevTrap1, IchnDevTrap0, IchnIoTrap3, IchnIoTrap2,
  IchnIoTrap1, IchnIoTrap0, IchnPciExpress, IchnMonitor,
  IchnSpi, IchnQRT, IchnGpioUnlock, NUM_ICHN_TYPES
}

Variables

EFI_GUID gEfiSmmIchnDispatchProtocolGuid

Detailed Description

Provides the parent dispatch service for a given SMI source generator. The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for the given event types.

Copyright (c) 2008 - 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.

Revision Reference:
This Protocol is defined in Framework of EFI SMM Core Interface Spec Version 0.9.

Define Documentation

#define EFI_SMM_ICHN_DISPATCH_PROTOCOL_GUID

Value:

{ \
    0xc50b323e, 0x9075, 0x4f2a, {0xac, 0x8e, 0xd2, 0x59, 0x6a, 0x10, 0x85, 0xcc } \
  }


Typedef Documentation

typedef VOID(EFIAPI * EFI_SMM_ICHN_DISPATCH)(IN EFI_HANDLE DispatchHandle, IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext)

Dispatch function for a ICHN specific SMI handler.

Parameters:
DispatchHandle The handle of this dispatch function.
DispatchContext The pointer to the dispatch function's context. The DispatchContext fields are filled in by the dispatching driver prior to invoking this dispatch function.
Returns:
None

typedef EFI_STATUS(EFIAPI * EFI_SMM_ICHN_REGISTER)(IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This, IN EFI_SMM_ICHN_DISPATCH DispatchFunction, IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext, OUT EFI_HANDLE *DispatchHandle)

Register a child SMI source dispatch function with a parent SMM driver.

Parameters:
This The pointer to the EFI_SMM_ICHN_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 indicate to the register function the ICHN SMI source for which the dispatch function should be invoked.
DispatchHandle The handle generated by the dispatcher to track the function instance.
Return values:
EFI_SUCCESS The dispatch function has been successfully registered and the SMI source has been enabled.
EFI_DEVICE_ERROR The driver could not enable the SMI source.
EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this child.
EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value is not within valid range.

typedef EFI_STATUS(EFIAPI * EFI_SMM_ICHN_UNREGISTER)(IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Unregister a child SMI source dispatch function with a parent SMM driver

Parameters:
This The pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
DispatchHandle The handle of the service to remove.
Return values:
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 The handle is invalid.


Enumeration Type Documentation

Enumerator:
IchnMch 
IchnPme 
IchnRtcAlarm 
IchnRingIndicate 
IchnAc97Wake 
IchnSerialIrq 
IchnY2KRollover 
IchnTcoTimeout 
IchnOsTco 
IchnNmi 
IchnIntruderDetect 
IchnBiosWp 
IchnMcSmi 
IchnPmeB0 
IchnThrmSts 
IchnSmBus 
IchnIntelUsb2 
IchnMonSmi7 
IchnMonSmi6 
IchnMonSmi5 
IchnMonSmi4 
IchnDevTrap13 
IchnDevTrap12 
IchnDevTrap11 
IchnDevTrap10 
IchnDevTrap9 
IchnDevTrap8 
IchnDevTrap7 
IchnDevTrap6 
IchnDevTrap5 
IchnDevTrap3 
IchnDevTrap2 
IchnDevTrap1 
IchnDevTrap0 
IchnIoTrap3 
IchnIoTrap2 
IchnIoTrap1 
IchnIoTrap0 
IchnPciExpress 
IchnMonitor 
IchnSpi 
IchnQRT 
IchnGpioUnlock 
NUM_ICHN_TYPES 


Variable Documentation


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1