]>
Commit | Line | Data |
---|---|---|
fe69ac84 | 1 | /** @file\r |
9095d37b | 2 | Null function implementation for EFI S3 boot script.\r |
fe69ac84 | 3 | \r |
9095d37b | 4 | Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r |
fe69ac84 | 5 | \r |
9344f092 | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
fe69ac84 | 7 | \r |
8 | **/\r | |
9 | \r | |
fe69ac84 | 10 | #include <Base.h>\r |
11 | #include <Library/S3BootScriptLib.h>\r | |
12 | \r | |
13 | /**\r | |
9095d37b | 14 | Save I/O write to boot script\r |
fe69ac84 | 15 | \r |
16 | @param Width the width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r | |
17 | @param Address The base address of the I/O operations.\r | |
18 | @param Count The number of I/O operations to perform.\r | |
19 | @param Buffer The source buffer from which to write data.\r | |
20 | \r | |
21 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
22 | @retval RETURN_SUCCESS Opcode is added.\r | |
23 | **/\r | |
24 | RETURN_STATUS\r | |
25 | EFIAPI\r | |
26 | S3BootScriptSaveIoWrite (\r | |
2f88bd3a MK |
27 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
28 | IN UINT64 Address,\r | |
29 | IN UINTN Count,\r | |
30 | IN VOID *Buffer\r | |
fe69ac84 | 31 | )\r |
32 | {\r | |
9095d37b | 33 | return RETURN_SUCCESS;\r |
fe69ac84 | 34 | }\r |
35 | \r | |
36 | /**\r | |
37 | Adds a record for an I/O modify operation into a S3 boot script table\r | |
38 | \r | |
39 | @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r | |
40 | @param Address The base address of the I/O operations.\r | |
41 | @param Data A pointer to the data to be OR-ed.\r | |
42 | @param DataMask A pointer to the data mask to be AND-ed with the data read from the register\r | |
43 | \r | |
44 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
45 | @retval RETURN_SUCCESS Opcode is added.\r | |
46 | **/\r | |
47 | RETURN_STATUS\r | |
48 | EFIAPI\r | |
49 | S3BootScriptSaveIoReadWrite (\r | |
2f88bd3a MK |
50 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
51 | IN UINT64 Address,\r | |
52 | IN VOID *Data,\r | |
53 | IN VOID *DataMask\r | |
fe69ac84 | 54 | )\r |
55 | {\r | |
9095d37b | 56 | return RETURN_SUCCESS;\r |
fe69ac84 | 57 | }\r |
58 | \r | |
59 | /**\r | |
60 | Adds a record for a memory write operation into a specified boot script table.\r | |
61 | \r | |
62 | @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r | |
63 | @param Address The base address of the memory operations\r | |
64 | @param Count The number of memory operations to perform.\r | |
65 | @param Buffer The source buffer from which to write the data.\r | |
66 | \r | |
67 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
68 | @retval RETURN_SUCCESS Opcode is added.\r | |
69 | **/\r | |
70 | RETURN_STATUS\r | |
71 | EFIAPI\r | |
72 | S3BootScriptSaveMemWrite (\r | |
2f88bd3a MK |
73 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
74 | IN UINT64 Address,\r | |
75 | IN UINTN Count,\r | |
76 | IN VOID *Buffer\r | |
fe69ac84 | 77 | )\r |
78 | {\r | |
9095d37b | 79 | return RETURN_SUCCESS;\r |
fe69ac84 | 80 | }\r |
2f88bd3a | 81 | \r |
fe69ac84 | 82 | /**\r |
83 | Adds a record for a memory modify operation into a specified boot script table.\r | |
84 | \r | |
85 | @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r | |
86 | @param Address The base address of the memory operations. Address needs alignment if required\r | |
87 | @param Data A pointer to the data to be OR-ed.\r | |
88 | @param DataMask A pointer to the data mask to be AND-ed with the data read from the register.\r | |
89 | \r | |
90 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
91 | @retval RETURN_SUCCESS Opcode is added.\r | |
92 | **/\r | |
93 | RETURN_STATUS\r | |
94 | EFIAPI\r | |
95 | S3BootScriptSaveMemReadWrite (\r | |
2f88bd3a MK |
96 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
97 | IN UINT64 Address,\r | |
98 | IN VOID *Data,\r | |
99 | IN VOID *DataMask\r | |
fe69ac84 | 100 | )\r |
101 | {\r | |
9095d37b | 102 | return RETURN_SUCCESS;\r |
fe69ac84 | 103 | }\r |
2f88bd3a | 104 | \r |
fe69ac84 | 105 | /**\r |
106 | Adds a record for a PCI configuration space write operation into a specified boot script table.\r | |
107 | \r | |
108 | @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r | |
109 | @param Address The address within the PCI configuration space.\r | |
110 | @param Count The number of PCI operations to perform.\r | |
111 | @param Buffer The source buffer from which to write the data.\r | |
112 | \r | |
113 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
114 | @retval RETURN_SUCCESS Opcode is added.\r | |
115 | **/\r | |
116 | RETURN_STATUS\r | |
117 | EFIAPI\r | |
118 | S3BootScriptSavePciCfgWrite (\r | |
2f88bd3a MK |
119 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
120 | IN UINT64 Address,\r | |
121 | IN UINTN Count,\r | |
122 | IN VOID *Buffer\r | |
fe69ac84 | 123 | )\r |
124 | {\r | |
9095d37b | 125 | return RETURN_SUCCESS;\r |
fe69ac84 | 126 | }\r |
127 | \r | |
128 | /**\r | |
129 | Adds a record for a PCI configuration space modify operation into a specified boot script table.\r | |
130 | \r | |
131 | @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r | |
132 | @param Address The address within the PCI configuration space.\r | |
133 | @param Data A pointer to the data to be OR-ed.The size depends on Width.\r | |
134 | @param DataMask A pointer to the data mask to be AND-ed.\r | |
135 | \r | |
136 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
137 | @retval RETURN__SUCCESS Opcode is added.\r | |
138 | **/\r | |
139 | RETURN_STATUS\r | |
140 | EFIAPI\r | |
141 | S3BootScriptSavePciCfgReadWrite (\r | |
2f88bd3a MK |
142 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
143 | IN UINT64 Address,\r | |
144 | IN VOID *Data,\r | |
145 | IN VOID *DataMask\r | |
fe69ac84 | 146 | )\r |
147 | {\r | |
9095d37b | 148 | return RETURN_SUCCESS;\r |
fe69ac84 | 149 | }\r |
2f88bd3a | 150 | \r |
fe69ac84 | 151 | /**\r |
152 | Adds a record for a PCI configuration space modify operation into a specified boot script table.\r | |
153 | \r | |
154 | @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r | |
155 | @param Segment The PCI segment number for Address.\r | |
156 | @param Address The address within the PCI configuration space.\r | |
157 | @param Count The number of PCI operations to perform.\r | |
158 | @param Buffer The source buffer from which to write the data.\r | |
159 | \r | |
160 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
161 | @retval RETURN_SUCCESS Opcode is added.\r | |
162 | **/\r | |
163 | RETURN_STATUS\r | |
164 | EFIAPI\r | |
165 | S3BootScriptSavePciCfg2Write (\r | |
2f88bd3a MK |
166 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
167 | IN UINT16 Segment,\r | |
168 | IN UINT64 Address,\r | |
169 | IN UINTN Count,\r | |
170 | IN VOID *Buffer\r | |
fe69ac84 | 171 | )\r |
172 | {\r | |
9095d37b | 173 | return RETURN_SUCCESS;\r |
fe69ac84 | 174 | }\r |
2f88bd3a | 175 | \r |
fe69ac84 | 176 | /**\r |
177 | Adds a record for a PCI configuration space modify operation into a specified boot script table.\r | |
178 | \r | |
179 | @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.\r | |
180 | @param Segment The PCI segment number for Address.\r | |
181 | @param Address The address within the PCI configuration space.\r | |
182 | @param Data A pointer to the data to be OR-ed. The size depends on Width.\r | |
183 | @param DataMask A pointer to the data mask to be AND-ed.\r | |
184 | \r | |
185 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
186 | @retval RETURN_SUCCESS Opcode is added.\r | |
187 | **/\r | |
188 | RETURN_STATUS\r | |
189 | EFIAPI\r | |
190 | S3BootScriptSavePciCfg2ReadWrite (\r | |
2f88bd3a MK |
191 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
192 | IN UINT16 Segment,\r | |
193 | IN UINT64 Address,\r | |
194 | IN VOID *Data,\r | |
195 | IN VOID *DataMask\r | |
fe69ac84 | 196 | )\r |
9095d37b LG |
197 | {\r |
198 | return RETURN_SUCCESS;\r | |
fe69ac84 | 199 | }\r |
2f88bd3a | 200 | \r |
fe69ac84 | 201 | /**\r |
202 | Adds a record for an SMBus command execution into a specified boot script table.\r | |
203 | \r | |
204 | @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.\r | |
205 | @param Operation Indicates which particular SMBus protocol it will use to execute the SMBus\r | |
206 | transactions.\r | |
207 | @param Length A pointer to signify the number of bytes that this operation will do.\r | |
208 | @param Buffer Contains the value of data to execute to the SMBUS slave device.\r | |
9095d37b | 209 | \r |
fe69ac84 | 210 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r |
211 | @retval RETURN_SUCCESS Opcode is added.\r | |
212 | **/\r | |
213 | RETURN_STATUS\r | |
214 | EFIAPI\r | |
215 | S3BootScriptSaveSmbusExecute (\r | |
2f88bd3a MK |
216 | IN UINTN SmBusAddress,\r |
217 | IN EFI_SMBUS_OPERATION Operation,\r | |
218 | IN UINTN *Length,\r | |
219 | IN VOID *Buffer\r | |
fe69ac84 | 220 | )\r |
221 | {\r | |
9095d37b | 222 | return RETURN_SUCCESS;\r |
fe69ac84 | 223 | }\r |
2f88bd3a | 224 | \r |
fe69ac84 | 225 | /**\r |
226 | Adds a record for an execution stall on the processor into a specified boot script table.\r | |
227 | \r | |
228 | @param Duration Duration in microseconds of the stall\r | |
9095d37b | 229 | \r |
fe69ac84 | 230 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r |
231 | @retval RETURN_SUCCESS Opcode is added.\r | |
232 | **/\r | |
233 | RETURN_STATUS\r | |
234 | EFIAPI\r | |
235 | S3BootScriptSaveStall (\r | |
2f88bd3a | 236 | IN UINTN Duration\r |
fe69ac84 | 237 | )\r |
238 | {\r | |
9095d37b | 239 | return RETURN_SUCCESS;\r |
fe69ac84 | 240 | }\r |
2f88bd3a | 241 | \r |
fe69ac84 | 242 | /**\r |
243 | Adds a record for dispatching specified arbitrary code into a specified boot script table.\r | |
244 | \r | |
245 | @param EntryPoint Entry point of the code to be dispatched.\r | |
9095d37b | 246 | \r |
fe69ac84 | 247 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r |
248 | @retval RETURN_SUCCESS Opcode is added.\r | |
249 | **/\r | |
250 | RETURN_STATUS\r | |
251 | EFIAPI\r | |
252 | S3BootScriptSaveDispatch (\r | |
2f88bd3a | 253 | IN VOID *EntryPoint\r |
fe69ac84 | 254 | )\r |
255 | {\r | |
256 | return RETURN_SUCCESS;\r | |
257 | }\r | |
2f88bd3a | 258 | \r |
fe69ac84 | 259 | /**\r |
300f2c6a | 260 | Adds a record for dispatching specified arbitrary code into a specified boot script table.\r |
fe69ac84 | 261 | \r |
262 | @param EntryPoint Entry point of the code to be dispatched.\r | |
263 | @param Context Argument to be passed into the EntryPoint of the code to be dispatched.\r | |
9095d37b | 264 | \r |
fe69ac84 | 265 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r |
266 | @retval RETURN_SUCCESS Opcode is added.\r | |
267 | **/\r | |
268 | RETURN_STATUS\r | |
269 | EFIAPI\r | |
270 | S3BootScriptSaveDispatch2 (\r | |
2f88bd3a MK |
271 | IN VOID *EntryPoint,\r |
272 | IN VOID *Context\r | |
fe69ac84 | 273 | )\r |
274 | {\r | |
9095d37b | 275 | return RETURN_SUCCESS;\r |
fe69ac84 | 276 | }\r |
277 | \r | |
278 | /**\r | |
279 | Adds a record for memory reads of the memory location and continues when the exit criteria is\r | |
280 | satisfied or after a defined duration.\r | |
9095d37b | 281 | \r |
57a1b9c4 JY |
282 | Please aware, below interface is different with PI specification, Vol 5:\r |
283 | EFI_S3_SAVE_STATE_PROTOCOL.Write() for EFI_BOOT_SCRIPT_MEM_POLL_OPCODE.\r | |
284 | "Duration" below is microseconds, while "Delay" in PI specification means\r | |
285 | the number of 100ns units to poll.\r | |
286 | \r | |
fe69ac84 | 287 | @param Width The width of the memory operations.\r |
288 | @param Address The base address of the memory operations.\r | |
289 | @param BitMask A pointer to the bit mask to be AND-ed with the data read from the register.\r | |
290 | @param BitValue A pointer to the data value after to be Masked.\r | |
291 | @param Duration Duration in microseconds of the stall.\r | |
292 | @param LoopTimes The times of the register polling.\r | |
293 | \r | |
294 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
295 | @retval RETURN_SUCCESS Opcode is added.\r | |
296 | \r | |
297 | **/\r | |
298 | RETURN_STATUS\r | |
299 | EFIAPI\r | |
300 | S3BootScriptSaveMemPoll (\r | |
2f88bd3a MK |
301 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
302 | IN UINT64 Address,\r | |
303 | IN VOID *BitMask,\r | |
304 | IN VOID *BitValue,\r | |
305 | IN UINTN Duration,\r | |
306 | IN UINT64 LoopTimes\r | |
fe69ac84 | 307 | )\r |
308 | {\r | |
9095d37b | 309 | return RETURN_SUCCESS;\r |
fe69ac84 | 310 | }\r |
311 | \r | |
312 | /**\r | |
313 | Store arbitrary information in the boot script table. This opcode is a no-op on dispatch and is only\r | |
314 | used for debugging script issues.\r | |
9095d37b | 315 | \r |
fe69ac84 | 316 | @param InformationLength Length of the data in bytes\r |
317 | @param Information Information to be logged in the boot scrpit\r | |
9095d37b | 318 | \r |
fe69ac84 | 319 | @retval RETURN_UNSUPPORTED If entering runtime, this method will not support.\r |
320 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
321 | @retval RETURN_SUCCESS Opcode is added.\r | |
322 | \r | |
323 | **/\r | |
324 | RETURN_STATUS\r | |
325 | EFIAPI\r | |
326 | S3BootScriptSaveInformation (\r | |
2f88bd3a MK |
327 | IN UINT32 InformationLength,\r |
328 | IN VOID *Information\r | |
fe69ac84 | 329 | )\r |
330 | {\r | |
9095d37b | 331 | return RETURN_SUCCESS;\r |
fe69ac84 | 332 | }\r |
2f88bd3a | 333 | \r |
fe69ac84 | 334 | /**\r |
335 | Adds a record for I/O reads the I/O location and continues when the exit criteria is satisfied or after a\r | |
336 | defined duration.\r | |
9095d37b LG |
337 | \r |
338 | @param Width The width of the I/O operations.\r | |
fe69ac84 | 339 | @param Address The base address of the I/O operations.\r |
340 | @param Data The comparison value used for the polling exit criteria.\r | |
341 | @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero\r | |
342 | in Data are ignored when polling the memory address.\r | |
343 | @param Delay The number of 100ns units to poll. Note that timer available may be of poorer\r | |
344 | granularity so the delay may be longer.\r | |
345 | \r | |
346 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
347 | @retval RETURN_SUCCESS Opcode is added.\r | |
348 | \r | |
349 | **/\r | |
350 | RETURN_STATUS\r | |
351 | EFIAPI\r | |
352 | S3BootScriptSaveIoPoll (\r | |
2f88bd3a MK |
353 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
354 | IN UINT64 Address,\r | |
fe69ac84 | 355 | IN VOID *Data,\r |
9095d37b | 356 | IN VOID *DataMask,\r |
2f88bd3a | 357 | IN UINT64 Delay\r |
fe69ac84 | 358 | )\r |
359 | {\r | |
9095d37b | 360 | return RETURN_SUCCESS;\r |
fe69ac84 | 361 | }\r |
362 | \r | |
363 | /**\r | |
364 | Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or\r | |
365 | after a defined duration.\r | |
366 | \r | |
9095d37b | 367 | @param Width The width of the I/O operations.\r |
fe69ac84 | 368 | @param Address The address within the PCI configuration space.\r |
369 | @param Data The comparison value used for the polling exit criteria.\r | |
370 | @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero\r | |
371 | in Data are ignored when polling the memory address\r | |
372 | @param Delay The number of 100ns units to poll. Note that timer available may be of poorer\r | |
373 | granularity so the delay may be longer.\r | |
374 | \r | |
375 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
376 | @retval RETURN_SUCCESS Opcode is added.\r | |
377 | \r | |
378 | **/\r | |
379 | RETURN_STATUS\r | |
380 | EFIAPI\r | |
381 | S3BootScriptSavePciPoll (\r | |
2f88bd3a MK |
382 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
383 | IN UINT64 Address,\r | |
384 | IN VOID *Data,\r | |
385 | IN VOID *DataMask,\r | |
386 | IN UINT64 Delay\r | |
387 | )\r | |
fe69ac84 | 388 | {\r |
9095d37b | 389 | return RETURN_SUCCESS;\r |
fe69ac84 | 390 | }\r |
2f88bd3a | 391 | \r |
fe69ac84 | 392 | /**\r |
393 | Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or\r | |
394 | after a defined duration.\r | |
395 | \r | |
9095d37b | 396 | @param Width The width of the I/O operations.\r |
fe69ac84 | 397 | @param Segment The PCI segment number for Address.\r |
398 | @param Address The address within the PCI configuration space.\r | |
399 | @param Data The comparison value used for the polling exit criteria.\r | |
400 | @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero\r | |
401 | in Data are ignored when polling the memory address\r | |
402 | @param Delay The number of 100ns units to poll. Note that timer available may be of poorer\r | |
403 | granularity so the delay may be longer.\r | |
404 | \r | |
405 | @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.\r | |
406 | @retval RETURN_SUCCESS Opcode is added.\r | |
407 | @note A known Limitations in the implementation: When interpreting the opcode EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE\r | |
9095d37b | 408 | EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE and EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE, the 'Segment' parameter is assumed as\r |
fe69ac84 | 409 | Zero, or else, assert.\r |
410 | \r | |
411 | **/\r | |
412 | RETURN_STATUS\r | |
413 | EFIAPI\r | |
414 | S3BootScriptSavePci2Poll (\r | |
2f88bd3a MK |
415 | IN S3_BOOT_SCRIPT_LIB_WIDTH Width,\r |
416 | IN UINT16 Segment,\r | |
417 | IN UINT64 Address,\r | |
418 | IN VOID *Data,\r | |
419 | IN VOID *DataMask,\r | |
420 | IN UINT64 Delay\r | |
fe69ac84 | 421 | )\r |
422 | {\r | |
9095d37b | 423 | return RETURN_SUCCESS;\r |
fe69ac84 | 424 | }\r |
2f88bd3a | 425 | \r |
fe69ac84 | 426 | /**\r |
427 | Save ASCII string information specified by Buffer to\r | |
428 | boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE\r | |
429 | \r | |
430 | @param String the ascii string to store into the S3 boot script table\r | |
431 | \r | |
432 | @retval RETURN_NOT_FOUND BootScriptSave Protocol not exist.\r | |
433 | @retval RETURN_SUCCESS BootScriptSave Protocol exist, always returns RETURN_SUCCESS\r | |
434 | \r | |
435 | **/\r | |
436 | RETURN_STATUS\r | |
437 | EFIAPI\r | |
438 | S3BootScriptSaveInformationAsciiString (\r | |
2f88bd3a | 439 | IN CONST CHAR8 *String\r |
fe69ac84 | 440 | )\r |
441 | {\r | |
9095d37b | 442 | return RETURN_SUCCESS;\r |
fe69ac84 | 443 | }\r |
2f88bd3a | 444 | \r |
fe69ac84 | 445 | /**\r |
9095d37b LG |
446 | This is an function to close the S3 boot script table. The function could only be called in\r |
447 | BOOT time phase. To comply with the Framework spec definition on\r | |
fe69ac84 | 448 | EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable(), this function will fulfill following things:\r |
449 | 1. Closes the specified boot script table\r | |
9095d37b LG |
450 | 2. It allocates a new memory pool to duplicate all the boot scripts in the specified table.\r |
451 | Once this function is called, the table maintained by the library will be destroyed\r | |
fe69ac84 | 452 | after it is copied into the allocated pool.\r |
9095d37b | 453 | 3. Any attempts to add a script record after calling this function will cause a new table\r |
fe69ac84 | 454 | to be created by the library.\r |
9095d37b | 455 | 4. The base address of the allocated pool will be returned in Address. Note that after\r |
fe69ac84 | 456 | using the boot script table, the CALLER is responsible for freeing the pool that is allocated\r |
9095d37b | 457 | by this function.\r |
fe69ac84 | 458 | \r |
459 | In Spec PI1.1, this EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable() is retired. By then it is not\r | |
460 | necessary to provide this API in BootScriptLib. To provides this API for now is only to meet\r | |
461 | the requirement from Framework Spec.\r | |
9095d37b LG |
462 | \r |
463 | If anyone does call CloseTable() on a real platform, then the caller is responsible for figuring out\r | |
464 | how to get the script to run on an S3 resume because the boot script maintained by the lib will be\r | |
fe69ac84 | 465 | destroyed.\r |
9095d37b LG |
466 | \r |
467 | @return the base address of the new copy of the boot script table.\r | |
fe69ac84 | 468 | \r |
469 | **/\r | |
2f88bd3a | 470 | UINT8 *\r |
fe69ac84 | 471 | EFIAPI\r |
472 | S3BootScriptCloseTable (\r | |
473 | VOID\r | |
474 | )\r | |
475 | {\r | |
9095d37b | 476 | return 0;\r |
fe69ac84 | 477 | }\r |
2f88bd3a | 478 | \r |
fe69ac84 | 479 | /**\r |
480 | Executes the S3 boot script table.\r | |
481 | \r | |
482 | @param RETURN_SUCCESS The boot script table was executed successfully.\r | |
9095d37b | 483 | @param RETURN_UNSUPPORTED Invalid script table or opcode.\r |
fe69ac84 | 484 | **/\r |
485 | RETURN_STATUS\r | |
486 | EFIAPI\r | |
487 | S3BootScriptExecute (\r | |
2f88bd3a | 488 | VOID\r |
fe69ac84 | 489 | )\r |
490 | {\r | |
9095d37b | 491 | return RETURN_SUCCESS;\r |
fe69ac84 | 492 | }\r |
2f88bd3a | 493 | \r |
fe69ac84 | 494 | /**\r |
9095d37b | 495 | Move the last boot script entry to the position\r |
fe69ac84 | 496 | \r |
497 | @param BeforeOrAfter Specifies whether the opcode is stored before (TRUE) or after (FALSE) the position\r | |
498 | in the boot script table specified by Position. If Position is NULL or points to\r | |
499 | NULL then the new opcode is inserted at the beginning of the table (if TRUE) or end\r | |
500 | of the table (if FALSE).\r | |
501 | @param Position On entry, specifies the position in the boot script table where the opcode will be\r | |
502 | inserted, either before or after, depending on BeforeOrAfter. On exit, specifies\r | |
503 | the position of the inserted opcode in the boot script table.\r | |
504 | \r | |
505 | @retval RETURN_OUT_OF_RESOURCES The table is not available.\r | |
506 | @retval RETURN_INVALID_PARAMETER The Position is not a valid position in the boot script table.\r | |
507 | @retval RETURN_SUCCESS Opcode is inserted.\r | |
508 | **/\r | |
509 | RETURN_STATUS\r | |
510 | EFIAPI\r | |
511 | S3BootScriptMoveLastOpcode (\r | |
2f88bd3a MK |
512 | IN BOOLEAN BeforeOrAfter,\r |
513 | IN OUT VOID **Position OPTIONAL\r | |
514 | )\r | |
fe69ac84 | 515 | {\r |
9095d37b | 516 | return RETURN_SUCCESS;\r |
fe69ac84 | 517 | }\r |
2f88bd3a | 518 | \r |
fe69ac84 | 519 | /**\r |
520 | Find a label within the boot script table and, if not present, optionally create it.\r | |
521 | \r | |
522 | @param BeforeOrAfter Specifies whether the opcode is stored before (TRUE)\r | |
9095d37b | 523 | or after (FALSE) the position in the boot script table\r |
fe69ac84 | 524 | specified by Position.\r |
9095d37b | 525 | @param CreateIfNotFound Specifies whether the label will be created if the label\r |
fe69ac84 | 526 | does not exists (TRUE) or not (FALSE).\r |
527 | @param Position On entry, specifies the position in the boot script table\r | |
528 | where the opcode will be inserted, either before or after,\r | |
529 | depending on BeforeOrAfter. On exit, specifies the position\r | |
530 | of the inserted opcode in the boot script table.\r | |
531 | @param Label Points to the label which will be inserted in the boot script table.\r | |
532 | \r | |
533 | @retval EFI_SUCCESS The operation succeeded. A record was added into the\r | |
534 | specified script table.\r | |
535 | @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r | |
9095d37b | 536 | If the opcode is unknow or not supported because of the PCD\r |
fe69ac84 | 537 | Feature Flags.\r |
538 | @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.\r | |
539 | \r | |
540 | **/\r | |
541 | RETURN_STATUS\r | |
9095d37b | 542 | EFIAPI\r |
fe69ac84 | 543 | S3BootScriptLabel (\r |
2f88bd3a MK |
544 | IN BOOLEAN BeforeOrAfter,\r |
545 | IN BOOLEAN CreateIfNotFound,\r | |
546 | IN OUT VOID **Position OPTIONAL,\r | |
547 | IN CONST CHAR8 *Label\r | |
fe69ac84 | 548 | )\r |
549 | {\r | |
9095d37b | 550 | return RETURN_SUCCESS;\r |
fe69ac84 | 551 | }\r |
2f88bd3a | 552 | \r |
fe69ac84 | 553 | /**\r |
554 | Compare two positions in the boot script table and return their relative position.\r | |
555 | @param Position1 The positions in the boot script table to compare\r | |
556 | @param Position2 The positions in the boot script table to compare\r | |
557 | @param RelativePosition On return, points to the result of the comparison\r | |
558 | \r | |
559 | @retval EFI_SUCCESS The operation succeeded. A record was added into the\r | |
560 | specified script table.\r | |
561 | @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r | |
9095d37b | 562 | If the opcode is unknow or not supported because of the PCD\r |
fe69ac84 | 563 | Feature Flags.\r |
564 | @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.\r | |
565 | \r | |
566 | **/\r | |
567 | RETURN_STATUS\r | |
9095d37b | 568 | EFIAPI\r |
fe69ac84 | 569 | S3BootScriptCompare (\r |
2f88bd3a MK |
570 | IN UINT8 *Position1,\r |
571 | IN UINT8 *Position2,\r | |
572 | OUT UINTN *RelativePosition\r | |
fe69ac84 | 573 | )\r |
574 | {\r | |
9095d37b | 575 | return RETURN_SUCCESS;\r |
fe69ac84 | 576 | }\r |