diff options
| author | jchen20 <jchen20@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-07-06 03:33:08 +0000 |
|---|---|---|
| committer | jchen20 <jchen20@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-07-06 03:33:08 +0000 |
| commit | 18998e40a5b313fd677db8c357a7d653800d5307 (patch) | |
| tree | 5fa540959ee94fe781f49e6ca0aec3e59eb47e47 /IntelFrameworkPkg/Include/Ppi | |
| parent | c7d5f35f1feec67680a221e72d65d8a7024da419 (diff) | |
| download | edk2-platforms-18998e40a5b313fd677db8c357a7d653800d5307.tar.xz | |
Fixed bug 202575. mainly follow Doxygen rule
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8755 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Ppi')
| -rw-r--r-- | IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h | 74 |
1 files changed, 68 insertions, 6 deletions
diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h index bb6120b59d..7e40eecd52 100644 --- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h +++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h @@ -36,30 +36,88 @@ // Boot Script Opcode Definitions
//
+///
+/// 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
+// Extensions to boot script definitions
//
+
+///
+/// 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
-//
+///
+/// EFI Boot Script Width
+///
typedef enum {
EfiBootScriptWidthUint8,
EfiBootScriptWidthUint16,
@@ -111,10 +169,14 @@ EFI_STATUS );
///
-/// This PPI produces functions to interpret and execute the Framework boot script table.
+/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and
+/// executes the Framework boot script table
///
struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {
- EFI_PEI_BOOT_SCRIPT_EXECUTE Execute; ///< Executes a boot script table.
+ ///
+ /// Executes a boot script table
+ ///
+ EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;
};
extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;
|