X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmSxDispatch.h;h=b29fbb3bfd080860b0aac6390379153009f4aaf8;hp=e7621cdfe6787130cd279d6cc24f2b9a4b8b6a86;hb=0e0eeecad42a9aaf17e304fdffabbeed0e8d3a44;hpb=79964ac84ea0ca6c68d0dea38245fa83ff1945d1

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
index e7621cdfe6..b29fbb3bfd 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
@@ -1,7 +1,7 @@
 /** @file
-  This file declares EFI Smm Sx Smi Child Protocol
+  Provides the parent dispatch service for a given Sx-state source generator.
 
-  Copyright (c) 2007, Intel Corporation
+  Copyright (c) 2007 - 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
@@ -21,6 +21,7 @@
 #ifndef _EFI_SMM_SX_DISPATCH_H_
 #define _EFI_SMM_SX_DISPATCH_H_
 
+
 //
 // Global ID for the Sx SMI Protocol
 //
@@ -68,12 +69,12 @@ typedef struct {
                                 and phases, so the Sx state handler(s) must check the Type and
                                 Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.
 
-  Nothing
+  @return None
 
 **/
 typedef
 VOID
-(EFIAPI *EFI_SMM_SX_DISPATCH) (
+(EFIAPI *EFI_SMM_SX_DISPATCH)(
   IN  EFI_HANDLE                    DispatchHandle,
   IN  EFI_SMM_SX_DISPATCH_CONTEXT   *DispatchContext
   );
@@ -81,9 +82,8 @@ 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_SX_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
@@ -109,50 +109,41 @@ VOID
 **/
 typedef
 EFI_STATUS
-(EFIAPI *EFI_SMM_SX_REGISTER) (
-  IN EFI_SMM_SX_DISPATCH_PROTOCOL           *This,
-  IN  EFI_SMM_SX_DISPATCH                   DispatchFunction,
-  IN  EFI_SMM_SX_DISPATCH_CONTEXT           *DispatchContext,
-  OUT EFI_HANDLE                            *DispatchHandle
+(EFIAPI *EFI_SMM_SX_REGISTER)(
+  IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,
+  IN EFI_SMM_SX_DISPATCH                   DispatchFunction,
+  IN EFI_SMM_SX_DISPATCH_CONTEXT           *DispatchContext,
+  OUT EFI_HANDLE                           *DispatchHandle
   );
 
 /**
-  Unregister a child SMI source dispatch function with a parent SMM driver
+  Unregisters an Sx-state service
 
-  @param  This                  Protocol instance pointer.
-  @param  DispatchHandle        Handle of dispatch function to deregister.
+  @param  This                  Pointer to the EFI_SMM_SX_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_SX_UNREGISTER) (
-  IN EFI_SMM_SX_DISPATCH_PROTOCOL           *This,
-  IN  EFI_HANDLE                            DispatchHandle
+(EFIAPI *EFI_SMM_SX_UNREGISTER)(
+  IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,
+  IN EFI_HANDLE                            DispatchHandle
   );
 
 //
 // Interface structure for the SMM Child Dispatch Protocol
 //
 /**
-  @par Protocol Description:
   Provides the parent dispatch service for a given Sx-state 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_SX_DISPATCH_PROTOCOL {
-  EFI_SMM_SX_REGISTER   Register;
-  EFI_SMM_SX_UNREGISTER UnRegister;
+  EFI_SMM_SX_REGISTER   Register;     ///< Installs a child service to be dispatched by this protocol.
+  EFI_SMM_SX_UNREGISTER UnRegister;   ///< Removes a child service dispatched by this protocol.
 };
 
 extern EFI_GUID gEfiSmmSxDispatchProtocolGuid;