X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;ds=sidebyside;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmIchnDispatch.h;h=56e9e3844e7f1b5366f42001ee248cb6b2a616bd;hb=c5b900bed8bab2f16149c48f11c525690611b33d;hp=0b7b5dc4675f236fed155b0ce9564d451ae7253f;hpb=700a786952c4573a6dd7c7b0c74ea772969f777a;p=mirror_edk2.git
diff --git a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
index 0b7b5dc467..56e9e3844e 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
@@ -3,16 +3,14 @@
The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for
the given event types.
- Copyright (c) 2008, 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.
-
- Module Name: SmmIchnDispatch.h
+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.
@par Revision Reference:
This Protocol is defined in Framework of EFI SMM Core Interface Spec
@@ -23,7 +21,6 @@
#ifndef _EFI_SMM_ICHN_DISPATCH_H_
#define _EFI_SMM_ICHN_DISPATCH_H_
-#include
//
// Global ID for the ICH SMI Protocol
@@ -109,8 +106,8 @@ typedef struct {
/**
Dispatch function for a ICHN specific SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
+ @param DispatchHandle The handle of this dispatch function.
+ @param 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.
@@ -126,21 +123,21 @@ VOID
);
/**
- Register a child SMI source dispatch function with a parent SMM driver
+ Register a child SMI source dispatch function with a parent SMM driver.
- @param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
- @param DispatchFunction Function to install.
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
+ @param This The pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
+ @param DispatchFunction The function to install.
+ @param 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.
- @param DispatchHandle Handle generated by the dispatcher to track the function
+ @param DispatchHandle The handle generated by the dispatcher to track the function
instance.
@retval EFI_SUCCESS The dispatch function has been successfully
registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_DEVICE_ERROR The driver could not enable the SMI source.
@retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
child.
@retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value
@@ -159,14 +156,14 @@ EFI_STATUS
/**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
- @param DispatchHandle Handle of the service to remove.
+ @param This The pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
+ @param DispatchHandle The handle of the service to remove.
@retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
+ unregistered, and the SMI source has been disabled,
if there are no other registered child dispatch
functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval EFI_INVALID_PARAMETER The handle is invalid.
**/
typedef
@@ -180,19 +177,11 @@ EFI_STATUS
// Interface structure for the SMM ICHN specific SMI Dispatch Protocol
//
/**
- @par Protocol Description:
Provides the parent dispatch service for a given SMI source generator.
-
- @param Register
- Installs a child service to be dispatched by this protocol.
-
- @param UnRegister
- Removes a child service dispatched by this protocol.
-
**/
struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL {
- EFI_SMM_ICHN_REGISTER Register;
- EFI_SMM_ICHN_UNREGISTER UnRegister;
+ EFI_SMM_ICHN_REGISTER Register; ///< Installs a child service to be dispatched by this protocol.
+ EFI_SMM_ICHN_UNREGISTER UnRegister; ///< Removes a child service dispatched by this protocol.
};
extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid;