+++ /dev/null
-/** @file\r
- Provides the parent dispatch service for a given SMI source generator.\r
- The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for\r
- the given event types.\r
-\r
-Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
-SPDX-License-Identifier: BSD-2-Clause-Patent\r
-\r
- @par Revision Reference:\r
- This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
- Version 0.9.\r
-\r
-**/\r
-\r
-#ifndef _EFI_SMM_ICHN_DISPATCH_H_\r
-#define _EFI_SMM_ICHN_DISPATCH_H_\r
-\r
-\r
-//\r
-// Global ID for the ICH SMI Protocol\r
-//\r
-#define EFI_SMM_ICHN_DISPATCH_PROTOCOL_GUID \\r
- { \\r
- 0xc50b323e, 0x9075, 0x4f2a, {0xac, 0x8e, 0xd2, 0x59, 0x6a, 0x10, 0x85, 0xcc } \\r
- }\r
-\r
-typedef struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL EFI_SMM_ICHN_DISPATCH_PROTOCOL;\r
-\r
-//\r
-// Related Definitions\r
-//\r
-//\r
-// ICHN Specific SMIs. These are miscellaneous SMI sources that are supported by the\r
-// ICHN specific SMI implementation. These may change over time. TrapNumber is only\r
-// valid if the Type is Trap.\r
-//\r
-typedef enum {\r
- //\r
- // NOTE: NEVER delete items from this list/enumeration! Doing so will prevent other versions\r
- // of the code from compiling. If the ICH version your driver is written for doesn't support\r
- // some of these SMIs, then simply return EFI_UNSUPPORTED when a child/client tries to register\r
- // for them.\r
- //\r
- IchnMch,\r
- IchnPme,\r
- IchnRtcAlarm,\r
- IchnRingIndicate,\r
- IchnAc97Wake,\r
- IchnSerialIrq,\r
- IchnY2KRollover,\r
- IchnTcoTimeout,\r
- IchnOsTco,\r
- IchnNmi,\r
- IchnIntruderDetect,\r
- IchnBiosWp,\r
- IchnMcSmi,\r
- IchnPmeB0,\r
- IchnThrmSts,\r
- IchnSmBus,\r
- IchnIntelUsb2,\r
- IchnMonSmi7,\r
- IchnMonSmi6,\r
- IchnMonSmi5,\r
- IchnMonSmi4,\r
- IchnDevTrap13,\r
- IchnDevTrap12,\r
- IchnDevTrap11,\r
- IchnDevTrap10,\r
- IchnDevTrap9,\r
- IchnDevTrap8,\r
- IchnDevTrap7,\r
- IchnDevTrap6,\r
- IchnDevTrap5,\r
- IchnDevTrap3,\r
- IchnDevTrap2,\r
- IchnDevTrap1,\r
- IchnDevTrap0,\r
- IchnIoTrap3,\r
- IchnIoTrap2,\r
- IchnIoTrap1,\r
- IchnIoTrap0,\r
- IchnPciExpress,\r
- IchnMonitor,\r
- IchnSpi,\r
- IchnQRT,\r
- IchnGpioUnlock,\r
- //\r
- // INSERT NEW ITEMS JUST BEFORE THIS LINE\r
- //\r
- NUM_ICHN_TYPES // the number of items in this enumeration\r
-} EFI_SMM_ICHN_SMI_TYPE;\r
-\r
-typedef struct {\r
- EFI_SMM_ICHN_SMI_TYPE Type;\r
-} EFI_SMM_ICHN_DISPATCH_CONTEXT;\r
-\r
-//\r
-// Member functions\r
-//\r
-/**\r
- Dispatch function for a ICHN specific SMI handler.\r
-\r
- @param DispatchHandle The handle of this dispatch function.\r
- @param DispatchContext The pointer to the dispatch function's context.\r
- The DispatchContext fields are filled in\r
- by the dispatching driver prior to\r
- invoking this dispatch function.\r
-\r
- @return None\r
-\r
-**/\r
-typedef\r
-VOID\r
-(EFIAPI *EFI_SMM_ICHN_DISPATCH)(\r
- IN EFI_HANDLE DispatchHandle,\r
- IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext\r
- );\r
-\r
-/**\r
- Register a child SMI source dispatch function with a parent SMM driver.\r
-\r
- @param This The pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.\r
- @param DispatchFunction The function to install.\r
- @param DispatchContext The pointer to the dispatch function's context.\r
- The caller fills in this context before calling\r
- the register function to indicate to the register\r
- function the ICHN SMI source for which the dispatch\r
- function should be invoked.\r
- @param DispatchHandle The handle generated by the dispatcher to track the function\r
- instance.\r
-\r
- @retval EFI_SUCCESS The dispatch function has been successfully\r
- registered and the SMI source has been enabled.\r
- @retval EFI_DEVICE_ERROR The driver could not enable the SMI source.\r
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this\r
- child.\r
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value\r
- is not within valid range.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_ICHN_REGISTER)(\r
- IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,\r
- IN EFI_SMM_ICHN_DISPATCH DispatchFunction,\r
- IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext,\r
- OUT EFI_HANDLE *DispatchHandle\r
- );\r
-\r
-/**\r
- Unregister a child SMI source dispatch function with a parent SMM driver\r
-\r
- @param This The pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.\r
- @param DispatchHandle The handle of the service to remove.\r
-\r
- @retval EFI_SUCCESS The dispatch function has been successfully\r
- unregistered, and the SMI source has been disabled,\r
- if there are no other registered child dispatch\r
- functions for this SMI source.\r
- @retval EFI_INVALID_PARAMETER The handle is invalid.\r
-\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_SMM_ICHN_UNREGISTER)(\r
- IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,\r
- IN EFI_HANDLE DispatchHandle\r
- );\r
-\r
-//\r
-// Interface structure for the SMM ICHN specific SMI Dispatch Protocol\r
-//\r
-/**\r
- Provides the parent dispatch service for a given SMI source generator.\r
-**/\r
-struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL {\r
- EFI_SMM_ICHN_REGISTER Register; ///< Installs a child service to be dispatched by this protocol.\r
- EFI_SMM_ICHN_UNREGISTER UnRegister; ///< Removes a child service dispatched by this protocol.\r
-};\r
-\r
-extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid;\r
-\r
-#endif\r
projects / mirror_edk2.git / blobdiff