Minor code enhancement.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / BootScriptExecuter.h

diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
index 1d249f01a58c2f4f1e6f3587ab017b452bba500f..9f5ca5054d91f326f562556ee9d6b5666470da80 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
+++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
@@ -1,7 +1,14 @@
 /** @file\r
   This file declares Boot Script Executer PPI.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  This PPI is published by a PEIM upon dispatch and provides an execution engine for the\r
+  Framework boot script. This PEIM should be platform neutral and have no specific knowledge of\r
+  platform instructions or other information. The ability to interpret the boot script depends on the\r
+  abundance of other PPIs that are available. For example, if the script requests an SMBus command\r
+  execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it\r
+  by issuing the native IA-32 instruction.\r
+\r
+  Copyright (c) 2007 - 2009, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -10,16 +17,14 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  BootScriptExecuter.h\r
-\r
   @par Revision Reference:\r
   This PPI is defined in Framework of EFI BootScript spec.\r
   Version 0.91.\r
 \r
 **/\r
 \r
-#ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H\r
-#define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H\r
+#ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
+#define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
 \r
 #define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \\r
   { \\r
@@ -48,23 +53,22 @@ typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PP
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE) (\r
+(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(\r
   IN     EFI_PEI_SERVICES                        **PeiServices,\r
   IN     EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI        *This,\r
   IN     EFI_PHYSICAL_ADDRESS                    Address,\r
   IN     EFI_GUID                                *FvFile OPTIONAL\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This PPI produces functions to interpret and execute the Framework boot script table.\r
-\r
-  @param Execute\r
-  Executes a boot script table.\r
-\r
-**/\r
+///\r
+/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and \r
+/// executes the Framework boot script table\r
+///\r
 struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r
-  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;\r
+       ///\r
+       /// Executes a boot script table\r
+       ///\r
+  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;  \r
 };\r
 \r
 extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r