Reviewed the description in the FatBinPkg .dec file.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmSxDispatch.h

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
index 66f059463ac16bebb11409bc2893bd85c59006d8..9c3c07743d6a9f4e26f9d426390dcac84dabbe64 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
@@ -1,5 +1,5 @@
 /** @file\r
 /** @file\r

-  This file declares EFI Smm Sx Smi Child Protocol\r
+  Provides the parent dispatch service for a given Sx-state source generator.\r

 \r
   Copyright (c) 2007, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
 \r
   Copyright (c) 2007, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r


@@ -70,12 +70,12 @@ typedef struct {
                                 and phases, so the Sx state handler(s) must check the Type and\r
                                 Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.\r
 \r
                                 and phases, so the Sx state handler(s) must check the Type and\r
                                 Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.\r
 \r

-  Nothing\r
+  @return None\r

 \r
 **/\r
 typedef\r
 VOID\r
 \r
 **/\r
 typedef\r
 VOID\r

-(EFIAPI *EFI_SMM_SX_DISPATCH) (\r
+(EFIAPI *EFI_SMM_SX_DISPATCH)(\r

   IN  EFI_HANDLE                    DispatchHandle,\r
   IN  EFI_SMM_SX_DISPATCH_CONTEXT   *DispatchContext\r
   );\r
   IN  EFI_HANDLE                    DispatchHandle,\r
   IN  EFI_SMM_SX_DISPATCH_CONTEXT   *DispatchContext\r
   );\r


@@ -83,9 +83,8 @@ VOID
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver\r
 \r
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver\r
 \r

-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchFunction      Pointer to dispatch function to be invoked for\r
-                                this SMI source\r
+  @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchFunction      Function to install.\r

   @param  DispatchContext       Pointer to the dispatch function's context.\r
                                 The caller fills this context in before calling\r
                                 the register function to indicate to the register\r
   @param  DispatchContext       Pointer to the dispatch function's context.\r
                                 The caller fills this context in before calling\r
                                 the register function to indicate to the register\r


@@ -111,31 +110,30 @@ VOID
 **/\r
 typedef\r
 EFI_STATUS\r
 **/\r
 typedef\r
 EFI_STATUS\r

-(EFIAPI *EFI_SMM_SX_REGISTER) (\r
-  IN EFI_SMM_SX_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_SMM_SX_DISPATCH                   DispatchFunction,\r
-  IN  EFI_SMM_SX_DISPATCH_CONTEXT           *DispatchContext,\r
-  OUT EFI_HANDLE                            *DispatchHandle\r
+(EFIAPI *EFI_SMM_SX_REGISTER)(\r
+  IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,\r
+  IN EFI_SMM_SX_DISPATCH                   DispatchFunction,\r
+  IN EFI_SMM_SX_DISPATCH_CONTEXT           *DispatchContext,\r
+  OUT EFI_HANDLE                           *DispatchHandle\r

   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Unregister a child SMI source dispatch function with a parent SMM driver\r
+  Unregisters an Sx-state service\r

 \r
 \r

-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchHandle        Handle of dispatch function to deregister.\r
+  @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchHandle        Handle of the service to remove.\r

 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully unregistered and the\r
                                 SMI source has been disabled if there are no other registered child\r
                                 dispatch functions for this SMI source.\r
   @retval EFI_INVALID_PARAMETER Handle is invalid.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully unregistered and the\r
                                 SMI source has been disabled if there are no other registered child\r
                                 dispatch functions for this SMI source.\r
   @retval EFI_INVALID_PARAMETER Handle is invalid.\r

-  @retval other                 TBD\r

 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r

-(EFIAPI *EFI_SMM_SX_UNREGISTER) (\r
-  IN EFI_SMM_SX_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_HANDLE                            DispatchHandle\r
+(EFIAPI *EFI_SMM_SX_UNREGISTER)(\r
+  IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,\r
+  IN EFI_HANDLE                            DispatchHandle\r

   );\r
 \r
 //\r
   );\r
 \r
 //\r