79964ac8 |
1 | /** @file\r |
2 | This file declares Boot Script Executer PPI.\r |
3 | \r |
4 | Copyright (c) 2007, 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 |
694b922c |
21 | #ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r |
22 | #define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_\r |
23 | \r |
0106da0f |
24 | #include <PiPei.h>\r |
79964ac8 |
25 | \r |
c3902377 |
26 | #define EFI_ACPI_S3_RESUME_SCRIPT_TABLE 0x00\r |
27 | \r |
28 | //\r |
29 | // Boot Script Opcode Definitions\r |
30 | //\r |
31 | \r |
32 | #define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE 0x00\r |
33 | #define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE 0x01\r |
34 | #define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE 0x02\r |
35 | #define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE 0x03\r |
36 | #define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE 0x04\r |
37 | #define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE 0x05\r |
38 | #define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE 0x06\r |
39 | #define EFI_BOOT_SCRIPT_STALL_OPCODE 0x07\r |
40 | #define EFI_BOOT_SCRIPT_DISPATCH_OPCODE 0x08\r |
41 | \r |
42 | //\r |
43 | // Extensions to boot script definitions\r |
44 | //\r |
45 | #define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE 0x09\r |
46 | #define EFI_BOOT_SCRIPT_INFORMATION_OPCODE 0x0A\r |
47 | #define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE 0x0B\r |
48 | #define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C\r |
49 | #define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE 0x0D\r |
50 | #define EFI_BOOT_SCRIPT_TABLE_OPCODE 0xAA\r |
51 | #define EFI_BOOT_SCRIPT_TERMINATE_OPCODE 0xFF\r |
52 | \r |
53 | //\r |
54 | // EFI Boot Script Width\r |
55 | //\r |
56 | typedef enum {\r |
57 | EfiBootScriptWidthUint8,\r |
58 | EfiBootScriptWidthUint16,\r |
59 | EfiBootScriptWidthUint32,\r |
60 | EfiBootScriptWidthUint64,\r |
61 | EfiBootScriptWidthFifoUint8,\r |
62 | EfiBootScriptWidthFifoUint16,\r |
63 | EfiBootScriptWidthFifoUint32,\r |
64 | EfiBootScriptWidthFifoUint64,\r |
65 | EfiBootScriptWidthFillUint8,\r |
66 | EfiBootScriptWidthFillUint16,\r |
67 | EfiBootScriptWidthFillUint32,\r |
68 | EfiBootScriptWidthFillUint64,\r |
69 | EfiBootScriptWidthMaximum\r |
70 | } EFI_BOOT_SCRIPT_WIDTH;\r |
b80fbe85 |
71 | \r |
79964ac8 |
72 | #define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \\r |
73 | { \\r |
74 | 0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \\r |
75 | }\r |
76 | \r |
77 | typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI;\r |
78 | \r |
79 | /**\r |
80 | Executes the Framework boot script table.\r |
81 | \r |
82 | @param PeiServices A pointer to the system PEI Services Table.\r |
83 | @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.\r |
84 | @param Address The physical memory address where the table is stored.\r |
85 | It must be zero if the table to be executed is stored in a firmware volume file.\r |
86 | @param FvFile The firmware volume file name that contains the table to\r |
87 | be executed. It must be NULL if the table to be executed is stored in physical memory.\r |
88 | \r |
89 | @retval EFI_SUCCESS The boot script table was executed successfully.\r |
90 | @retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.\r |
91 | @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.\r |
92 | @retval EFI_UNSUPPORTED The format of the boot script table is invalid.\r |
93 | Or An unsupported opcode occurred in the table.\r |
94 | Or There were opcode execution errors, such as an insufficient dependency.\r |
95 | \r |
96 | **/\r |
97 | typedef\r |
98 | EFI_STATUS\r |
99 | (EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE) (\r |
100 | IN EFI_PEI_SERVICES **PeiServices,\r |
101 | IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI *This,\r |
102 | IN EFI_PHYSICAL_ADDRESS Address,\r |
103 | IN EFI_GUID *FvFile OPTIONAL\r |
104 | );\r |
105 | \r |
106 | /**\r |
107 | @par Ppi Description:\r |
108 | This PPI produces functions to interpret and execute the Framework boot script table.\r |
109 | \r |
110 | @param Execute\r |
111 | Executes a boot script table.\r |
112 | \r |
113 | **/\r |
114 | struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {\r |
115 | EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;\r |
116 | };\r |
117 | \r |
118 | extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;\r |
119 | \r |
120 | #endif\r |