2 This file declares Boot Script Executer PPI.
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 and 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.
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
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.
20 Module Name: BootScriptExecuter.h
22 @par Revision Reference:
23 This PPI is defined in Framework of EFI BootScript spec.
28 #ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_
29 #define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_
33 #define EFI_ACPI_S3_RESUME_SCRIPT_TABLE 0x00
36 // Boot Script Opcode Definitions
40 /// The opcode is to add a record for an I/O write operation into a specified boot script table.
42 #define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE 0x00
44 /// The opcode is to add a record for an I/O modify operation into a specified boot script table.
46 #define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE 0x01
48 /// The opcode is to add a record for a memory write operation into a specified boot script table.
50 #define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE 0x02
52 /// The opcode is to add a record for a memory modify operation into a specified boot script table.
54 #define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE 0x03
56 /// The opcode is to adds a record for a PCI configuration space write operation into a specified boot
59 #define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE 0x04
61 /// The opcode is to add a record for a PCI configuration space modify operation into a specified
62 /// boot script table.
64 #define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE 0x05
66 /// The opcode is to add a record for an SMBus command execution into a specified boot script table.
68 #define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE 0x06
70 /// The opcode is to adds a record for an execution stall on the processor into a specified
71 /// boot script table.
73 #define EFI_BOOT_SCRIPT_STALL_OPCODE 0x07
75 /// The opcode is to add a record for dispatching specified arbitrary code into a specified
76 /// boot script table.
78 #define EFI_BOOT_SCRIPT_DISPATCH_OPCODE 0x08
81 // Extensions to boot script definitions
85 /// The opcode is to add a record for memory reads of the memory location and continues when the
86 /// exit criteria is satisfied or after a defined duration.
88 #define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE 0x09
90 /// The opcode is to store arbitrary information in the boot script table which is a no-op on dispatch
91 /// and is only used for debugging script issues.
93 #define EFI_BOOT_SCRIPT_INFORMATION_OPCODE 0x0A
95 /// The opcode is to add a record for a PCI configuration space write operation into a
96 /// specified boot script table.
98 #define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE 0x0B
100 /// The opcode is to add a record for a PCI configuration space modify operation into a specified
101 /// boot script table.
103 #define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C
105 /// The opcode is to add a record for dispatching specified arbitrary code into a specified
106 /// boot script table.
108 #define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE 0x0D
110 /// The opcode indicate the start of the boot script table.
112 #define EFI_BOOT_SCRIPT_TABLE_OPCODE 0xAA
114 /// The opcode indicate the end of the boot script table.
116 #define EFI_BOOT_SCRIPT_TERMINATE_OPCODE 0xFF
119 /// EFI Boot Script Width
122 EfiBootScriptWidthUint8
,
123 EfiBootScriptWidthUint16
,
124 EfiBootScriptWidthUint32
,
125 EfiBootScriptWidthUint64
,
126 EfiBootScriptWidthFifoUint8
,
127 EfiBootScriptWidthFifoUint16
,
128 EfiBootScriptWidthFifoUint32
,
129 EfiBootScriptWidthFifoUint64
,
130 EfiBootScriptWidthFillUint8
,
131 EfiBootScriptWidthFillUint16
,
132 EfiBootScriptWidthFillUint32
,
133 EfiBootScriptWidthFillUint64
,
134 EfiBootScriptWidthMaximum
135 } EFI_BOOT_SCRIPT_WIDTH
;
137 #define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \
139 0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \
142 typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI
;
145 Executes the Framework boot script table.
147 @param PeiServices A pointer to the system PEI Services Table.
148 @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.
149 @param Address The physical memory address where the table is stored.
150 It must be zero if the table to be executed is stored in a firmware volume file.
151 @param FvFile The firmware volume file name that contains the table to
152 be executed. It must be NULL if the table to be executed is stored in physical memory.
154 @retval EFI_SUCCESS The boot script table was executed successfully.
155 @retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.
156 @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.
157 @retval EFI_UNSUPPORTED The format of the boot script table is invalid.
158 Or An unsupported opcode occurred in the table.
159 Or There were opcode execution errors, such as an insufficient dependency.
164 (EFIAPI
*EFI_PEI_BOOT_SCRIPT_EXECUTE
)(
165 IN EFI_PEI_SERVICES
**PeiServices
,
166 IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI
*This
,
167 IN EFI_PHYSICAL_ADDRESS Address
,
168 IN EFI_GUID
*FvFile OPTIONAL
172 /// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and
173 /// executes the Framework boot script table
175 struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI
{
177 /// Executes a boot script table
179 EFI_PEI_BOOT_SCRIPT_EXECUTE Execute
;
182 extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid
;