]>
Commit | Line | Data |
---|---|---|
79964ac8 | 1 | /** @file\r |
f22f941e | 2 | This file declares the Boot Script Executer PPI.\r |
79964ac8 | 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 | |
1c2f052d | 11 | Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r |
22a69a5e | 12 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
79964ac8 | 13 | \r |
79964ac8 | 14 | @par Revision Reference:\r |
15 | This PPI is defined in Framework of EFI BootScript spec.\r | |
16 | Version 0.91.\r | |
17 | \r | |
18 | **/\r | |
19 | \r | |
694b922c | 20 | #ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r |
21 | #define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r | |
22 | \r | |
79964ac8 | 23 | #define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \\r |
24 | { \\r | |
25 | 0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \\r | |
26 | }\r | |
27 | \r | |
28 | typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI;\r | |
29 | \r | |
30 | /**\r | |
31 | Executes the Framework boot script table.\r | |
32 | \r | |
33 | @param PeiServices A pointer to the system PEI Services Table.\r | |
34 | @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.\r | |
35 | @param Address The physical memory address where the table is stored.\r | |
1c2f052d | 36 | It must be zero if the table to be executed is stored in\r |
f22f941e | 37 | a firmware volume file.\r |
79964ac8 | 38 | @param FvFile The firmware volume file name that contains the table to\r |
1c2f052d | 39 | be executed. It must be NULL if the table to be executed\r |
f22f941e | 40 | is stored in physical memory.\r |
79964ac8 | 41 | \r |
42 | @retval EFI_SUCCESS The boot script table was executed successfully.\r | |
43 | @retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.\r | |
44 | @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.\r | |
45 | @retval EFI_UNSUPPORTED The format of the boot script table is invalid.\r | |
f22f941e | 46 | Or, an unsupported opcode occurred in the table.\r |
1c2f052d | 47 | Or there were opcode execution errors, such as an\r |
f22f941e | 48 | insufficient dependency.\r |
79964ac8 | 49 | \r |
50 | **/\r | |
51 | typedef\r | |
52 | EFI_STATUS\r | |
69686d56 | 53 | (EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(\r |
79964ac8 | 54 | IN EFI_PEI_SERVICES **PeiServices,\r |
55 | IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI *This,\r | |
56 | IN EFI_PHYSICAL_ADDRESS Address,\r | |
57 | IN EFI_GUID *FvFile OPTIONAL\r | |
58 | );\r | |
59 | \r | |
2bbaeb0d | 60 | ///\r |
1c2f052d | 61 | /// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and\r |
f22f941e | 62 | /// executes the Framework boot script table.\r |
2bbaeb0d | 63 | ///\r |
79964ac8 | 64 | struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r |
1c2f052d LG |
65 | ///\r |
66 | /// Executes a boot script table.\r | |
67 | ///\r | |
68 | EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;\r | |
79964ac8 | 69 | };\r |
70 | \r | |
71 | extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r | |
72 | \r | |
73 | #endif\r |