X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FPpi%2FBootScriptExecuter.h;h=7e40eecd52f4c73e8974e979f50d5560263bb258;hp=bb6120b59d9d4dcb877ac8d3bd398d01e2d352d4;hb=18998e40a5b313fd677db8c357a7d653800d5307;hpb=c7d5f35f1feec67680a221e72d65d8a7024da419

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;