summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Framework/BootScript.h
diff options
context:
space:
mode:
authormdkinney <mdkinney@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-11 23:25:44 +0000
committermdkinney <mdkinney@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-11 23:25:44 +0000
commit87d6344732796c9570488593977377bb0e693de7 (patch)
tree8f3f0c0e352696391c3c0ae5083bf337f070c7c8 /IntelFrameworkPkg/Include/Framework/BootScript.h
parent17c62eb63ece0f18315a4bf542c0b5f223c5efae (diff)
downloadedk2-platforms-87d6344732796c9570488593977377bb0e693de7.tar.xz
1) Add Include/Framework/BootScript.h that contains defines shared between Boot Script Executer PPI and Boot Script Save Protocol. Remove those safe defines from Include/Ppi/BootScriptExecuter.h
2) Remove Include/Framework/DataHubRecords.h and merge its content into Include/Guid/DataHubRecords.h 3) Remove Include/Framework/Legacy16.h and merge its contents into Include/Protocol/LegacyBios.h 4) Update FrameworkDxe.h to no longer include all the Legacy16.h and DataHubRecords.h contents. This reduces the number of include file and definitions pulled in when a module include FrameworkDxe.h. The Legacy16.h contents can now be included by a module through Protocol/LegacyBios.h and the DataHubRecords.h contents can be included by a module through Guid/DataHubRecords.h 5) Update Include/Guid/StatusCodeDataTypeId.h so it can be safely included by both PEIMs and DXE Modules since both the PEI and DXE phases support status codes 6) Remove extra #includes where possible to reduce number of files included during a build. 7) Update Include/Protocol/LegacyBiosPlatform.h to #include Include/Protocol/LegacyBios.h since it depends on HDD_INFO and COMPATIBILITY16 strictures carried by LegacyBios.h git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8899 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Framework/BootScript.h')
-rw-r--r--IntelFrameworkPkg/Include/Framework/BootScript.h127
1 files changed, 127 insertions, 0 deletions
diff --git a/IntelFrameworkPkg/Include/Framework/BootScript.h b/IntelFrameworkPkg/Include/Framework/BootScript.h
new file mode 100644
index 0000000000..939c1f5078
--- /dev/null
+++ b/IntelFrameworkPkg/Include/Framework/BootScript.h
@@ -0,0 +1,127 @@
+/** @file
+ This file contains the boot script defintions that are shared between the
+ Boot Script Executor PPI and the Boot Script Save Protocol.
+
+ Copyright (c) 2009, Intel Corporation
+ All rights reserved. This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef _FRAMEWORK_BOOT_SCRIPT_H_
+#define _FRAMEWORK_BOOT_SCRIPT_H_
+
+///
+/// S3 Boot Script Table identifier
+///
+#define EFI_ACPI_S3_RESUME_SCRIPT_TABLE 0x00
+
+///
+/// The opcode is to add a record for an I/O write operation into a specified boot script table.
+///
+#define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE 0x00
+///
+/// The opcode is to add a record for an I/O modify operation into a specified boot script table.
+///
+#define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE 0x01
+///
+/// The opcode is to add a record for a memory write operation into a specified boot script table.
+///
+#define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE 0x02
+///
+/// The opcode is to add a record for a memory modify operation into a specified boot script table.
+///
+#define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE 0x03
+///
+/// The opcode is to adds a record for a PCI configuration space write operation into a specified boot
+/// script table.
+///
+#define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE 0x04
+///
+/// The opcode is to add a record for a PCI configuration space modify operation into a specified
+/// boot script table.
+///
+#define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE 0x05
+///
+/// The opcode is to add a record for an SMBus command execution into a specified boot script table.
+///
+#define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE 0x06
+///
+/// The opcode is to adds a record for an execution stall on the processor into a specified
+/// boot script table.
+///
+#define EFI_BOOT_SCRIPT_STALL_OPCODE 0x07
+///
+/// The opcode is to add a record for dispatching specified arbitrary code into a specified
+/// boot script table.
+///
+#define EFI_BOOT_SCRIPT_DISPATCH_OPCODE 0x08
+
+//
+// Extensions to boot script definitions
+//
+///
+/// Inconsistent with specification here:
+/// Follow OPCODEs are not defined in Framework Spec BootScript_0.91, but in
+/// PI1.0 Spec. And OPCODEs which are needed in the implementation
+///
+///
+/// The opcode is to add a record for memory reads of the memory location and continues when the
+/// exit criteria is satisfied or after a defined duration.
+///
+#define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE 0x09
+///
+/// The opcode is to store arbitrary information in the boot script table which is a no-op on dispatch
+/// and is only used for debugging script issues.
+///
+#define EFI_BOOT_SCRIPT_INFORMATION_OPCODE 0x0A
+///
+/// The opcode is to add a record for a PCI configuration space write operation into a
+/// specified boot script table.
+///
+#define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE 0x0B
+///
+/// The opcode is to add a record for a PCI configuration space modify operation into a specified
+/// boot script table.
+///
+#define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C
+///
+/// The opcode is to add a record for dispatching specified arbitrary code into a specified
+/// boot script table.
+///
+#define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE 0x0D
+
+///
+/// The opcode indicate the start of the boot script table.
+///
+#define EFI_BOOT_SCRIPT_TABLE_OPCODE 0xAA
+///
+/// The opcode indicate the end of the boot script table.
+///
+#define EFI_BOOT_SCRIPT_TERMINATE_OPCODE 0xFF
+
+///
+/// EFI Boot Script Width
+///
+typedef enum {
+ EfiBootScriptWidthUint8,
+ EfiBootScriptWidthUint16,
+ EfiBootScriptWidthUint32,
+ EfiBootScriptWidthUint64,
+ EfiBootScriptWidthFifoUint8,
+ EfiBootScriptWidthFifoUint16,
+ EfiBootScriptWidthFifoUint32,
+ EfiBootScriptWidthFifoUint64,
+ EfiBootScriptWidthFillUint8,
+ EfiBootScriptWidthFillUint16,
+ EfiBootScriptWidthFillUint32,
+ EfiBootScriptWidthFillUint64,
+ EfiBootScriptWidthMaximum
+} EFI_BOOT_SCRIPT_WIDTH;
+
+#endif