X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmIchnDispatch.h;h=2254cd42bf9c02719760201d84efa1c200eb914b;hp=3e906888148676d7aef7b7e8a21c009b9061369e;hb=0e0eeecad42a9aaf17e304fdffabbeed0e8d3a44;hpb=8411f1c002faf9a16c28a643a1c8a32de904a7d7

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
index 3e90688814..2254cd42bf 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
@@ -3,7 +3,7 @@
   The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for
   the given event types.
 
-  Copyright (c) 2008, Intel Corporation
+  Copyright (c) 2008 - 2009, 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
@@ -23,7 +23,6 @@
 #ifndef _EFI_SMM_ICHN_DISPATCH_H_
 #define _EFI_SMM_ICHN_DISPATCH_H_
 
-#include <PiDxe.h>
 
 //
 // Global ID for the ICH SMI Protocol
@@ -107,7 +106,7 @@ typedef struct {
 // Member functions
 //
 /**
-  Dispatch function for a ICH n specific SMI handler.
+  Dispatch function for a ICHN specific SMI handler.
 
   @param  DispatchHandle        Handle of this dispatch function.
   @param  DispatchContext       Pointer to the dispatch function's context.
@@ -115,12 +114,12 @@ typedef struct {
                                 by the dispatching driver prior to
                                 invoking this dispatch function.
 
-  Nothing
+  @return None
 
 **/
 typedef
 VOID
-(EFIAPI *EFI_SMM_ICHN_DISPATCH) (
+(EFIAPI *EFI_SMM_ICHN_DISPATCH)(
   IN  EFI_HANDLE                      DispatchHandle,
   IN  EFI_SMM_ICHN_DISPATCH_CONTEXT   *DispatchContext
   );
@@ -128,16 +127,15 @@ VOID
 /**
   Register a child SMI source dispatch function with a parent SMM driver
 
-  @param  This                  Protocol instance pointer.
-  @param  DispatchFunction      Pointer to dispatch function to be invoked for
-                                this SMI source
+  @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
                                 the register function to indicate to the register
                                 function the ICHN SMI source for which the dispatch
                                 function should be invoked.
-  @param  DispatchHandle        Handle of dispatch function, for when interfacing
-                                with the parent Sx state SMM driver.
+  @param  DispatchHandle        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.
@@ -150,51 +148,42 @@ VOID
 **/
 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
+(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
   );
 
 /**
   Unregister a child SMI source dispatch function with a parent SMM driver
 
-  @param  This                  Protocol instance pointer.
-  @param  DispatchHandle        Handle of dispatch function to deregister.
+  @param  This                  Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
+  @param  DispatchHandle        Handle of the service to remove.
 
   @retval 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.
   @retval EFI_INVALID_PARAMETER Handle is invalid.
-  @retval other                 TBD
 
 **/
 typedef
 EFI_STATUS
-(EFIAPI *EFI_SMM_ICHN_UNREGISTER) (
-  IN EFI_SMM_ICHN_DISPATCH_PROTOCOL             *This,
-  IN  EFI_HANDLE                                DispatchHandle
+(EFIAPI *EFI_SMM_ICHN_UNREGISTER)(
+  IN EFI_SMM_ICHN_DISPATCH_PROTOCOL            *This,
+  IN EFI_HANDLE                                DispatchHandle
   );
 
 //
-// Interface structure for the SMM Ich n specific SMI Dispatch Protocol
+// 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;