according to DataHubSubclass spec, all fields of data record should be naturally...

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / BootScriptExecuter.h

diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
index c98f3821ebd61bc78d6d3c09ade0447b2ed90b75..bb1058ed78109962097ee2bbac6dcd221edd844a 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
+++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
@@ -8,7 +8,7 @@
   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
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -36,30 +36,93 @@
 // Boot Script Opcode Definitions\r
 //\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
+///\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
+// 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
+///\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
+///\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
+///\r
+/// The opcode indicate the start of the boot script table.\r
+///\r
 #define 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
 \r
-//\r
-// EFI Boot Script Width\r
-//\r
+///\r
+/// EFI Boot Script Width\r
+///\r
 typedef enum {\r
   EfiBootScriptWidthUint8,\r
   EfiBootScriptWidthUint16,\r
@@ -103,23 +166,22 @@ typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PP
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE) (\r
+(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(\r
   IN     EFI_PEI_SERVICES                        **PeiServices,\r
   IN     EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI        *This,\r
   IN     EFI_PHYSICAL_ADDRESS                    Address,\r
   IN     EFI_GUID                                *FvFile OPTIONAL\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This PPI produces functions to interpret and execute the Framework boot script table.\r
-\r
-  @param Execute\r
-  Executes a boot script table.\r
-\r
-**/\r
+///\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;\r
+       ///\r
+       /// Executes a boot script table\r
+       ///\r
+  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;  \r
 };\r
 \r
 extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r