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