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 bb6120b59d9d4dcb877ac8d3bd398d01e2d352d4..9f5ca5054d91f326f562556ee9d6b5666470da80 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
+++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
@@ -3,7 +3,7 @@
 \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 and other information. The ability to interpret the boot script depends on the\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
@@ -17,8 +17,6 @@
   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
@@ -28,54 +26,6 @@
 #ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
 #define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
 \r
-#include <PiPei.h>\r
-\r
-#define EFI_ACPI_S3_RESUME_SCRIPT_TABLE               0x00\r
-\r
-//\r
-// Boot Script Opcode Definitions\r
-//\r
-\r
-#define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE               0x00\r
-#define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE          0x01\r
-#define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE              0x02\r
-#define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE         0x03\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE       0x04\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE  0x05\r
-#define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE          0x06\r
-#define EFI_BOOT_SCRIPT_STALL_OPCODE                  0x07\r
-#define EFI_BOOT_SCRIPT_DISPATCH_OPCODE               0x08\r
-\r
-//\r
-// Extensions to boot script definitions\r
-//\r
-#define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE               0x09\r
-#define EFI_BOOT_SCRIPT_INFORMATION_OPCODE            0x0A\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE      0x0B\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C\r
-#define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE             0x0D\r
-#define EFI_BOOT_SCRIPT_TABLE_OPCODE                  0xAA\r
-#define EFI_BOOT_SCRIPT_TERMINATE_OPCODE              0xFF\r
-\r
-//\r
-// EFI Boot Script Width\r
-//\r
-typedef enum {\r
-  EfiBootScriptWidthUint8,\r
-  EfiBootScriptWidthUint16,\r
-  EfiBootScriptWidthUint32,\r
-  EfiBootScriptWidthUint64,\r
-  EfiBootScriptWidthFifoUint8,\r
-  EfiBootScriptWidthFifoUint16,\r
-  EfiBootScriptWidthFifoUint32,\r
-  EfiBootScriptWidthFifoUint64,\r
-  EfiBootScriptWidthFillUint8,\r
-  EfiBootScriptWidthFillUint16,\r
-  EfiBootScriptWidthFillUint32,\r
-  EfiBootScriptWidthFillUint64,\r
-  EfiBootScriptWidthMaximum\r
-} EFI_BOOT_SCRIPT_WIDTH;\r
-\r
 #define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \\r
   { \\r
     0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \\r
@@ -111,10 +61,14 @@ EFI_STATUS
   );\r
 \r
 ///\r
-/// This PPI produces functions to interpret and execute the Framework boot script table.\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;  ///< Executes a boot script table.\r
+       ///\r
+       /// Executes a boot script table\r
+       ///\r
+  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;  \r
 };\r
 \r
 extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r