summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
diff options
context:
space:
mode:
Diffstat (limited to 'IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h')
-rw-r--r--IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h33
1 files changed, 18 insertions, 15 deletions
diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
index 9f5ca50..3abf739 100644
--- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
+++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
@@ -1,5 +1,5 @@
/** @file
- This file declares Boot Script Executer PPI.
+ This file declares the Boot Script Executer PPI.
This PPI is published by a PEIM upon dispatch and provides an execution engine for the
Framework boot script. This PEIM should be platform neutral and have no specific knowledge of
@@ -8,14 +8,14 @@
execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it
by issuing the native IA-32 instruction.
- Copyright (c) 2007 - 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.
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that 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.
@par Revision Reference:
This PPI is defined in Framework of EFI BootScript spec.
@@ -39,16 +39,19 @@ typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PP
@param PeiServices A pointer to the system PEI Services Table.
@param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.
@param Address The physical memory address where the table is stored.
- It must be zero if the table to be executed is stored in a firmware volume file.
+ It must be zero if the table to be executed is stored in
+ a firmware volume file.
@param FvFile The firmware volume file name that contains the table to
- be executed. It must be NULL if the table to be executed is stored in physical memory.
+ be executed. It must be NULL if the table to be executed
+ is stored in physical memory.
@retval EFI_SUCCESS The boot script table was executed successfully.
@retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.
@retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.
@retval EFI_UNSUPPORTED The format of the boot script table is invalid.
- Or An unsupported opcode occurred in the table.
- Or There were opcode execution errors, such as an insufficient dependency.
+ Or, an unsupported opcode occurred in the table.
+ Or there were opcode execution errors, such as an
+ insufficient dependency.
**/
typedef
@@ -62,11 +65,11 @@ EFI_STATUS
///
/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and
-/// executes the Framework boot script table
+/// executes the Framework boot script table.
///
struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {
///
- /// Executes a boot script table
+ /// Executes a boot script table.
///
EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;
};