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