]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | This file declares Boot Script Executer PPI.\r | |
3 | \r | |
4 | Copyright (c) 2006, Intel Corporation \r | |
5 | All rights reserved. This program and the accompanying materials \r | |
6 | are licensed and made available under the terms and conditions of the BSD License \r | |
7 | which accompanies this distribution. The full text of the license may be found at \r | |
8 | http://opensource.org/licenses/bsd-license.php \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
12 | \r | |
13 | Module Name: BootScriptExecuter.h\r | |
14 | \r | |
15 | @par Revision Reference:\r | |
16 | This PPI is defined in Framework of EFI BootScript spec.\r | |
17 | Version 0.91.\r | |
18 | \r | |
19 | **/\r | |
20 | \r | |
21 | #ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H\r | |
22 | #define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H\r | |
23 | \r | |
24 | #define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \\r | |
25 | { \\r | |
26 | 0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \\r | |
27 | }\r | |
28 | \r | |
29 | typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI;\r | |
30 | \r | |
31 | /**\r | |
32 | Executes the Framework boot script table.\r | |
33 | \r | |
0647c9ad LG |
34 | @param PeiServices A pointer to the system PEI Services Table.\r |
35 | @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.\r | |
36 | @param Address The physical memory address where the table is stored.\r | |
37 | It must be zero if the table to be executed is stored in a firmware volume file.\r | |
38 | @param FvFile The firmware volume file name that contains the table to\r | |
39 | be executed. It must be NULL if the table to be executed is stored in physical memory.\r | |
40 | \r | |
41 | @retval EFI_SUCCESS The boot script table was executed successfully.\r | |
878ddf1f | 42 | @retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.\r |
0647c9ad LG |
43 | @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.\r |
44 | @retval EFI_UNSUPPORTED The format of the boot script table is invalid.\r | |
45 | Or An unsupported opcode occurred in the table.\r | |
46 | Or There were opcode execution errors, such as an insufficient dependency.\r | |
878ddf1f | 47 | \r |
48 | **/\r | |
49 | typedef\r | |
50 | EFI_STATUS\r | |
51 | (EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE) (\r | |
52 | IN EFI_PEI_SERVICES **PeiServices,\r | |
53 | IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI *This,\r | |
54 | IN EFI_PHYSICAL_ADDRESS Address,\r | |
55 | IN EFI_GUID *FvFile OPTIONAL\r | |
56 | );\r | |
57 | \r | |
58 | /**\r | |
59 | @par Ppi Description:\r | |
60 | This PPI produces functions to interpret and execute the Framework boot script table.\r | |
61 | \r | |
62 | @param Execute\r | |
63 | Executes a boot script table.\r | |
64 | \r | |
65 | **/\r | |
66 | struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r | |
67 | EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;\r | |
68 | };\r | |
69 | \r | |
70 | extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r | |
71 | \r | |
72 | #endif\r |