Minor code enhancement.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / BootScriptExecuter.h
CommitLineData
79964ac8 1/** @file\r
2 This file declares Boot Script Executer PPI.\r
3\r
4a71b21a 4 This PPI is published by a PEIM upon dispatch and provides an execution engine for the\r
5 Framework boot script. This PEIM should be platform neutral and have no specific knowledge of\r
5259c97d 6 platform instructions or other information. The ability to interpret the boot script depends on the\r
4a71b21a 7 abundance of other PPIs that are available. For example, if the script requests an SMBus command\r
8 execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it\r
9 by issuing the native IA-32 instruction.\r
10\r
2bbaeb0d 11 Copyright (c) 2007 - 2009, Intel Corporation\r
79964ac8 12 All rights reserved. This program and the accompanying materials\r
13 are licensed and made available under the terms and conditions of the BSD License\r
14 which accompanies this distribution. The full text of the license may be found at\r
15 http://opensource.org/licenses/bsd-license.php\r
16\r
17 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
18 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
19\r
79964ac8 20 @par Revision Reference:\r
21 This PPI is defined in Framework of EFI BootScript spec.\r
22 Version 0.91.\r
23\r
24**/\r
25\r
694b922c 26#ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
27#define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r
28\r
79964ac8 29#define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \\r
30 { \\r
31 0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \\r
32 }\r
33\r
34typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI;\r
35\r
36/**\r
37 Executes the Framework boot script table.\r
38\r
39 @param PeiServices A pointer to the system PEI Services Table.\r
40 @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.\r
41 @param Address The physical memory address where the table is stored.\r
42 It must be zero if the table to be executed is stored in a firmware volume file.\r
43 @param FvFile The firmware volume file name that contains the table to\r
44 be executed. It must be NULL if the table to be executed is stored in physical memory.\r
45\r
46 @retval EFI_SUCCESS The boot script table was executed successfully.\r
47 @retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.\r
48 @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.\r
49 @retval EFI_UNSUPPORTED The format of the boot script table is invalid.\r
50 Or An unsupported opcode occurred in the table.\r
51 Or There were opcode execution errors, such as an insufficient dependency.\r
52\r
53**/\r
54typedef\r
55EFI_STATUS\r
69686d56 56(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(\r
79964ac8 57 IN EFI_PEI_SERVICES **PeiServices,\r
58 IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI *This,\r
59 IN EFI_PHYSICAL_ADDRESS Address,\r
60 IN EFI_GUID *FvFile OPTIONAL\r
61 );\r
62\r
2bbaeb0d 63///\r
18998e40 64/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and \r
65/// executes the Framework boot script table\r
2bbaeb0d 66///\r
79964ac8 67struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r
18998e40 68 ///\r
69 /// Executes a boot script table\r
70 ///\r
71 EFI_PEI_BOOT_SCRIPT_EXECUTE Execute; \r
79964ac8 72};\r
73\r
74extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r
75\r
76#endif\r