X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;ds=sidebyside;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmSxDispatch.h;h=9c3c07743d6a9f4e26f9d426390dcac84dabbe64;hb=3a0d56608f54c88f55986fbd1c729028f6aa7e16;hp=66f059463ac16bebb11409bc2893bd85c59006d8;hpb=b80fbe8543eb535e40172a263b6b5d633e5b282c;p=mirror_edk2.git

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
index 66f059463a..9c3c07743d 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
@@ -1,5 +1,5 @@
 /** @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
   All rights reserved. This program and the accompanying materials
@@ -70,12 +70,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
   );
@@ -83,9 +83,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
@@ -111,31 +110,30 @@ 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
   );
 
 //