Clarify @pram b in Base.h. Accepted and edited in Qing Huang changes for @retval...

[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / BootScript.h

diff --git a/IntelFrameworkPkg/Include/Framework/BootScript.h b/IntelFrameworkPkg/Include/Framework/BootScript.h
index 939c1f50787971baa81138e7fa9d9b6aa316938f..cf846ec86b2a0c971c65ca18f9ff048f737a424b 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/BootScript.h
+++ b/IntelFrameworkPkg/Include/Framework/BootScript.h
@@ -13,115 +13,35 @@
 \r
 **/\r
 \r
-#ifndef _FRAMEWORK_BOOT_SCRIPT_H_\r
-#define _FRAMEWORK_BOOT_SCRIPT_H_\r
+#ifndef _BOOT_SCRIPT_H_\r
+#define _BOOT_SCRIPT_H_\r
 \r
+#include <PiDxe.h>\r
 ///\r
-/// S3 Boot Script Table identifier\r
-///\r
-#define EFI_ACPI_S3_RESUME_SCRIPT_TABLE               0x00\r
-\r
-///\r
-/// The opcode is to add a record for an I/O write operation into a specified boot script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE               0x00\r
-///\r
-/// The opcode is to add a record for an I/O modify operation into a specified boot script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE          0x01\r
-///\r
-/// The opcode is to add a record for a memory write operation into a specified boot script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE              0x02\r
-///\r
-/// The opcode is to add a record for a memory modify operation into a specified boot script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE         0x03\r
-///\r
-/// The opcode is to adds a record for a PCI configuration space write operation into a specified boot \r
-/// script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE       0x04\r
-///\r
-/// The opcode is to add a record for a PCI configuration space modify operation into a specified \r
-/// boot script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE  0x05\r
-///\r
-/// The opcode is to add a record for an SMBus command execution into a specified boot script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE          0x06\r
+/// The framework implementation defines follow opcode which is different from PI specification: \r
+/// To add FRAMEWORK_ prefix to avoid naming conflict.\r
 ///\r
-/// The opcode is to adds a record for an execution stall on the processor into a specified\r
-/// boot script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_STALL_OPCODE                  0x07\r
-///\r
-/// The opcode is to add a record for dispatching specified arbitrary code into a specified \r
-/// boot script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_DISPATCH_OPCODE               0x08\r
-\r
-//\r
-// Extensions to boot script definitions \r
-//\r
-///\r
-/// Inconsistent with specification here: \r
-/// Follow OPCODEs are not defined in Framework Spec BootScript_0.91, but in\r
-/// PI1.0 Spec. And OPCODEs which are needed in the implementation\r
+/// S3 Boot Script Table identifier\r
 ///\r
+#define FRAMEWORK_EFI_ACPI_S3_RESUME_SCRIPT_TABLE               0x00\r
 ///\r
 /// The opcode is to add a record for memory reads of the memory location and continues when the \r
 /// exit criteria is satisfied or after a defined duration.\r
 ///\r
-#define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE               0x09\r
-///\r
-/// The opcode is to store arbitrary information in the boot script table which is a no-op on dispatch \r
-/// and is only used for debugging script issues.\r
-///\r
-#define EFI_BOOT_SCRIPT_INFORMATION_OPCODE            0x0A\r
-///\r
-/// The opcode is to add a record for a PCI configuration space write operation into a \r
-/// specified boot script table.\r
-/// \r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE      0x0B\r
-///\r
-/// The opcode is to add a record for a PCI configuration space modify operation into a specified\r
-/// boot script table.\r
-///\r
-#define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C\r
+#define FRAMEWORK_EFI_BOOT_SCRIPT_MEM_POLL_OPCODE               0x09\r
 ///\r
 /// The opcode is to add a record for dispatching specified arbitrary code into a specified\r
 /// boot script table.\r
 ///\r
-#define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE             0x0D\r
-\r
+#define FRAMEWORK_EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE             0x0D\r
 ///\r
 /// The opcode indicate the start of the boot script table.\r
 ///\r
-#define EFI_BOOT_SCRIPT_TABLE_OPCODE                  0xAA\r
+#define FRAMEWORK_EFI_BOOT_SCRIPT_TABLE_OPCODE                  0xAA\r
 ///\r
 /// The opcode indicate the end of the boot script table.\r
 ///\r
-#define EFI_BOOT_SCRIPT_TERMINATE_OPCODE              0xFF\r
+#define FRAMEWORK_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
 #endif\r