TianoCore EDK2 master
Loading...
Searching...
No Matches
BootScriptLib.c File Reference
#include <Base.h>
#include <Library/S3BootScriptLib.h>

Go to the source code of this file.

Functions

RETURN_STATUS EFIAPI S3BootScriptSaveIoWrite (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN VOID *Buffer)
 
RETURN_STATUS EFIAPI S3BootScriptSaveIoReadWrite (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN VOID *Data, IN VOID *DataMask)
 
RETURN_STATUS EFIAPI S3BootScriptSaveMemWrite (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN VOID *Buffer)
 
RETURN_STATUS EFIAPI S3BootScriptSaveMemReadWrite (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN VOID *Data, IN VOID *DataMask)
 
RETURN_STATUS EFIAPI S3BootScriptSavePciCfgWrite (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN UINTN Count, IN VOID *Buffer)
 
RETURN_STATUS EFIAPI S3BootScriptSavePciCfgReadWrite (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN VOID *Data, IN VOID *DataMask)
 
RETURN_STATUS EFIAPI S3BootScriptSavePciCfg2Write (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT16 Segment, IN UINT64 Address, IN UINTN Count, IN VOID *Buffer)
 
RETURN_STATUS EFIAPI S3BootScriptSavePciCfg2ReadWrite (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT16 Segment, IN UINT64 Address, IN VOID *Data, IN VOID *DataMask)
 
RETURN_STATUS EFIAPI S3BootScriptSaveSmbusExecute (IN UINTN SmBusAddress, IN EFI_SMBUS_OPERATION Operation, IN UINTN *Length, IN VOID *Buffer)
 
RETURN_STATUS EFIAPI S3BootScriptSaveStall (IN UINTN Duration)
 
RETURN_STATUS EFIAPI S3BootScriptSaveDispatch (IN VOID *EntryPoint)
 
RETURN_STATUS EFIAPI S3BootScriptSaveDispatch2 (IN VOID *EntryPoint, IN VOID *Context)
 
RETURN_STATUS EFIAPI S3BootScriptSaveMemPoll (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN VOID *BitMask, IN VOID *BitValue, IN UINTN Duration, IN UINT64 LoopTimes)
 
RETURN_STATUS EFIAPI S3BootScriptSaveInformation (IN UINT32 InformationLength, IN VOID *Information)
 
RETURN_STATUS EFIAPI S3BootScriptSaveIoPoll (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN VOID *Data, IN VOID *DataMask, IN UINT64 Delay)
 
RETURN_STATUS EFIAPI S3BootScriptSavePciPoll (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT64 Address, IN VOID *Data, IN VOID *DataMask, IN UINT64 Delay)
 
RETURN_STATUS EFIAPI S3BootScriptSavePci2Poll (IN S3_BOOT_SCRIPT_LIB_WIDTH Width, IN UINT16 Segment, IN UINT64 Address, IN VOID *Data, IN VOID *DataMask, IN UINT64 Delay)
 
RETURN_STATUS EFIAPI S3BootScriptSaveInformationAsciiString (IN CONST CHAR8 *String)
 
UINT8 *EFIAPI S3BootScriptCloseTable (VOID)
 
RETURN_STATUS EFIAPI S3BootScriptExecute (VOID)
 
RETURN_STATUS EFIAPI S3BootScriptMoveLastOpcode (IN BOOLEAN BeforeOrAfter, IN OUT VOID **Position OPTIONAL)
 
RETURN_STATUS EFIAPI S3BootScriptLabel (IN BOOLEAN BeforeOrAfter, IN BOOLEAN CreateIfNotFound, IN OUT VOID **Position OPTIONAL, IN CONST CHAR8 *Label)
 
RETURN_STATUS EFIAPI S3BootScriptCompare (IN UINT8 *Position1, IN UINT8 *Position2, OUT UINTN *RelativePosition)
 

Detailed Description

Null function implementation for EFI S3 boot script.

Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file BootScriptLib.c.

Function Documentation

◆ S3BootScriptCloseTable()

UINT8 *EFIAPI S3BootScriptCloseTable ( VOID  )

This is an function to close the S3 boot script table. The function could only be called in BOOT time phase. To comply with the Framework spec definition on EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable(), this function will fulfill following things:

  1. Closes the specified boot script table
  2. It allocates a new memory pool to duplicate all the boot scripts in the specified table. Once this function is called, the table maintained by the library will be destroyed after it is copied into the allocated pool.
  3. Any attempts to add a script record after calling this function will cause a new table to be created by the library.
  4. The base address of the allocated pool will be returned in Address. Note that after using the boot script table, the CALLER is responsible for freeing the pool that is allocated by this function.

In Spec PI1.1, this EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable() is retired. By then it is not necessary to provide this API in BootScriptLib. To provides this API for now is only to meet the requirement from Framework Spec.

If anyone does call CloseTable() on a real platform, then the caller is responsible for figuring out how to get the script to run on an S3 resume because the boot script maintained by the lib will be destroyed.

Returns
the base address of the new copy of the boot script table.

Definition at line 472 of file BootScriptLib.c.

◆ S3BootScriptCompare()

RETURN_STATUS EFIAPI S3BootScriptCompare ( IN UINT8 *  Position1,
IN UINT8 *  Position2,
OUT UINTN RelativePosition 
)

Compare two positions in the boot script table and return their relative position.

Parameters
Position1The positions in the boot script table to compare
Position2The positions in the boot script table to compare
RelativePositionOn return, points to the result of the comparison
Return values
EFI_SUCCESSThe operation succeeded. A record was added into the specified script table.
EFI_INVALID_PARAMETERThe parameter is illegal or the given boot script is not supported. If the opcode is unknow or not supported because of the PCD Feature Flags.
EFI_OUT_OF_RESOURCESThere is insufficient memory to store the boot script.

Definition at line 569 of file BootScriptLib.c.

◆ S3BootScriptExecute()

RETURN_STATUS EFIAPI S3BootScriptExecute ( VOID  )

Executes the S3 boot script table.

Parameters
RETURN_SUCCESSThe boot script table was executed successfully.
RETURN_UNSUPPORTEDInvalid script table or opcode.

Definition at line 487 of file BootScriptLib.c.

◆ S3BootScriptLabel()

RETURN_STATUS EFIAPI S3BootScriptLabel ( IN BOOLEAN  BeforeOrAfter,
IN BOOLEAN  CreateIfNotFound,
IN OUT VOID **Position  OPTIONAL,
IN CONST CHAR8 *  Label 
)

Find a label within the boot script table and, if not present, optionally create it.

Parameters
BeforeOrAfterSpecifies whether the opcode is stored before (TRUE) or after (FALSE) the position in the boot script table specified by Position.
CreateIfNotFoundSpecifies whether the label will be created if the label does not exists (TRUE) or not (FALSE).
PositionOn entry, specifies the position in the boot script table where the opcode will be inserted, either before or after, depending on BeforeOrAfter. On exit, specifies the position of the inserted opcode in the boot script table.
LabelPoints to the label which will be inserted in the boot script table.
Return values
EFI_SUCCESSThe operation succeeded. A record was added into the specified script table.
EFI_INVALID_PARAMETERThe parameter is illegal or the given boot script is not supported. If the opcode is unknow or not supported because of the PCD Feature Flags.
EFI_OUT_OF_RESOURCESThere is insufficient memory to store the boot script.

Definition at line 543 of file BootScriptLib.c.

◆ S3BootScriptMoveLastOpcode()

RETURN_STATUS EFIAPI S3BootScriptMoveLastOpcode ( IN BOOLEAN  BeforeOrAfter,
IN OUT VOID **Position  OPTIONAL 
)

Move the last boot script entry to the position

Parameters
BeforeOrAfterSpecifies whether the opcode is stored before (TRUE) or after (FALSE) the position in the boot script table specified by Position. If Position is NULL or points to NULL then the new opcode is inserted at the beginning of the table (if TRUE) or end of the table (if FALSE).
PositionOn entry, specifies the position in the boot script table where the opcode will be inserted, either before or after, depending on BeforeOrAfter. On exit, specifies the position of the inserted opcode in the boot script table.
Return values
RETURN_OUT_OF_RESOURCESThe table is not available.
RETURN_INVALID_PARAMETERThe Position is not a valid position in the boot script table.
RETURN_SUCCESSOpcode is inserted.

Definition at line 511 of file BootScriptLib.c.

◆ S3BootScriptSaveDispatch()

RETURN_STATUS EFIAPI S3BootScriptSaveDispatch ( IN VOID *  EntryPoint)

Adds a record for dispatching specified arbitrary code into a specified boot script table.

Parameters
EntryPointEntry point of the code to be dispatched.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 252 of file BootScriptLib.c.

◆ S3BootScriptSaveDispatch2()

RETURN_STATUS EFIAPI S3BootScriptSaveDispatch2 ( IN VOID *  EntryPoint,
IN VOID *  Context 
)

Adds a record for dispatching specified arbitrary code into a specified boot script table.

Parameters
EntryPointEntry point of the code to be dispatched.
ContextArgument to be passed into the EntryPoint of the code to be dispatched.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 270 of file BootScriptLib.c.

◆ S3BootScriptSaveInformation()

RETURN_STATUS EFIAPI S3BootScriptSaveInformation ( IN UINT32  InformationLength,
IN VOID *  Information 
)

Store arbitrary information in the boot script table. This opcode is a no-op on dispatch and is only used for debugging script issues.

Parameters
InformationLengthLength of the data in bytes
InformationInformation to be logged in the boot scrpit
Return values
RETURN_UNSUPPORTEDIf entering runtime, this method will not support.
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 326 of file BootScriptLib.c.

◆ S3BootScriptSaveInformationAsciiString()

RETURN_STATUS EFIAPI S3BootScriptSaveInformationAsciiString ( IN CONST CHAR8 *  String)

Save ASCII string information specified by Buffer to boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE

Parameters
Stringthe ascii string to store into the S3 boot script table
Return values
RETURN_NOT_FOUNDBootScriptSave Protocol not exist.
RETURN_SUCCESSBootScriptSave Protocol exist, always returns RETURN_SUCCESS

Definition at line 438 of file BootScriptLib.c.

◆ S3BootScriptSaveIoPoll()

RETURN_STATUS EFIAPI S3BootScriptSaveIoPoll ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT64  Address,
IN VOID *  Data,
IN VOID *  DataMask,
IN UINT64  Delay 
)

Adds a record for I/O reads the I/O location and continues when the exit criteria is satisfied or after a defined duration.

Parameters
WidthThe width of the I/O operations.
AddressThe base address of the I/O operations.
DataThe comparison value used for the polling exit criteria.
DataMaskMask used for the polling criteria. The bits in the bytes below Width which are zero in Data are ignored when polling the memory address.
DelayThe number of 100ns units to poll. Note that timer available may be of poorer granularity so the delay may be longer.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 352 of file BootScriptLib.c.

◆ S3BootScriptSaveIoReadWrite()

RETURN_STATUS EFIAPI S3BootScriptSaveIoReadWrite ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT64  Address,
IN VOID *  Data,
IN VOID *  DataMask 
)

Adds a record for an I/O modify operation into a S3 boot script table

Parameters
WidthThe width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
AddressThe base address of the I/O operations.
DataA pointer to the data to be OR-ed.
DataMaskA pointer to the data mask to be AND-ed with the data read from the register
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 49 of file BootScriptLib.c.

◆ S3BootScriptSaveIoWrite()

RETURN_STATUS EFIAPI S3BootScriptSaveIoWrite ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT64  Address,
IN UINTN  Count,
IN VOID *  Buffer 
)

Save I/O write to boot script

Parameters
Widththe width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
AddressThe base address of the I/O operations.
CountThe number of I/O operations to perform.
BufferThe source buffer from which to write data.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 26 of file BootScriptLib.c.

◆ S3BootScriptSaveMemPoll()

RETURN_STATUS EFIAPI S3BootScriptSaveMemPoll ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT64  Address,
IN VOID *  BitMask,
IN VOID *  BitValue,
IN UINTN  Duration,
IN UINT64  LoopTimes 
)

Adds a record for memory reads of the memory location and continues when the exit criteria is satisfied or after a defined duration.

Please aware, below interface is different with PI specification, Vol 5: EFI_S3_SAVE_STATE_PROTOCOL.Write() for EFI_BOOT_SCRIPT_MEM_POLL_OPCODE. "Duration" below is microseconds, while "Delay" in PI specification means the number of 100ns units to poll.

Parameters
WidthThe width of the memory operations.
AddressThe base address of the memory operations.
BitMaskA pointer to the bit mask to be AND-ed with the data read from the register.
BitValueA pointer to the data value after to be Masked.
DurationDuration in microseconds of the stall.
LoopTimesThe times of the register polling.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 300 of file BootScriptLib.c.

◆ S3BootScriptSaveMemReadWrite()

RETURN_STATUS EFIAPI S3BootScriptSaveMemReadWrite ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT64  Address,
IN VOID *  Data,
IN VOID *  DataMask 
)

Adds a record for a memory modify operation into a specified boot script table.

Parameters
WidthThe width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
AddressThe base address of the memory operations. Address needs alignment if required
DataA pointer to the data to be OR-ed.
DataMaskA pointer to the data mask to be AND-ed with the data read from the register.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 95 of file BootScriptLib.c.

◆ S3BootScriptSaveMemWrite()

RETURN_STATUS EFIAPI S3BootScriptSaveMemWrite ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT64  Address,
IN UINTN  Count,
IN VOID *  Buffer 
)

Adds a record for a memory write operation into a specified boot script table.

Parameters
WidthThe width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
AddressThe base address of the memory operations
CountThe number of memory operations to perform.
BufferThe source buffer from which to write the data.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 72 of file BootScriptLib.c.

◆ S3BootScriptSavePci2Poll()

RETURN_STATUS EFIAPI S3BootScriptSavePci2Poll ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT16  Segment,
IN UINT64  Address,
IN VOID *  Data,
IN VOID *  DataMask,
IN UINT64  Delay 
)

Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or after a defined duration.

Parameters
WidthThe width of the I/O operations.
SegmentThe PCI segment number for Address.
AddressThe address within the PCI configuration space.
DataThe comparison value used for the polling exit criteria.
DataMaskMask used for the polling criteria. The bits in the bytes below Width which are zero in Data are ignored when polling the memory address
DelayThe number of 100ns units to poll. Note that timer available may be of poorer granularity so the delay may be longer.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.
Note
A known Limitations in the implementation: When interpreting the opcode EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE and EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE, the 'Segment' parameter is assumed as Zero, or else, assert.

Definition at line 414 of file BootScriptLib.c.

◆ S3BootScriptSavePciCfg2ReadWrite()

RETURN_STATUS EFIAPI S3BootScriptSavePciCfg2ReadWrite ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT16  Segment,
IN UINT64  Address,
IN VOID *  Data,
IN VOID *  DataMask 
)

Adds a record for a PCI configuration space modify operation into a specified boot script table.

Parameters
WidthThe width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
SegmentThe PCI segment number for Address.
AddressThe address within the PCI configuration space.
DataA pointer to the data to be OR-ed. The size depends on Width.
DataMaskA pointer to the data mask to be AND-ed.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 190 of file BootScriptLib.c.

◆ S3BootScriptSavePciCfg2Write()

RETURN_STATUS EFIAPI S3BootScriptSavePciCfg2Write ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT16  Segment,
IN UINT64  Address,
IN UINTN  Count,
IN VOID *  Buffer 
)

Adds a record for a PCI configuration space modify operation into a specified boot script table.

Parameters
WidthThe width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
SegmentThe PCI segment number for Address.
AddressThe address within the PCI configuration space.
CountThe number of PCI operations to perform.
BufferThe source buffer from which to write the data.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 165 of file BootScriptLib.c.

◆ S3BootScriptSavePciCfgReadWrite()

RETURN_STATUS EFIAPI S3BootScriptSavePciCfgReadWrite ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT64  Address,
IN VOID *  Data,
IN VOID *  DataMask 
)

Adds a record for a PCI configuration space modify operation into a specified boot script table.

Parameters
WidthThe width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
AddressThe address within the PCI configuration space.
DataA pointer to the data to be OR-ed.The size depends on Width.
DataMaskA pointer to the data mask to be AND-ed.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN__SUCCESSOpcode is added.

Definition at line 141 of file BootScriptLib.c.

◆ S3BootScriptSavePciCfgWrite()

RETURN_STATUS EFIAPI S3BootScriptSavePciCfgWrite ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT64  Address,
IN UINTN  Count,
IN VOID *  Buffer 
)

Adds a record for a PCI configuration space write operation into a specified boot script table.

Parameters
WidthThe width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
AddressThe address within the PCI configuration space.
CountThe number of PCI operations to perform.
BufferThe source buffer from which to write the data.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 118 of file BootScriptLib.c.

◆ S3BootScriptSavePciPoll()

RETURN_STATUS EFIAPI S3BootScriptSavePciPoll ( IN S3_BOOT_SCRIPT_LIB_WIDTH  Width,
IN UINT64  Address,
IN VOID *  Data,
IN VOID *  DataMask,
IN UINT64  Delay 
)

Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or after a defined duration.

Parameters
WidthThe width of the I/O operations.
AddressThe address within the PCI configuration space.
DataThe comparison value used for the polling exit criteria.
DataMaskMask used for the polling criteria. The bits in the bytes below Width which are zero in Data are ignored when polling the memory address
DelayThe number of 100ns units to poll. Note that timer available may be of poorer granularity so the delay may be longer.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 381 of file BootScriptLib.c.

◆ S3BootScriptSaveSmbusExecute()

RETURN_STATUS EFIAPI S3BootScriptSaveSmbusExecute ( IN UINTN  SmBusAddress,
IN EFI_SMBUS_OPERATION  Operation,
IN UINTN Length,
IN VOID *  Buffer 
)

Adds a record for an SMBus command execution into a specified boot script table.

Parameters
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
OperationIndicates which particular SMBus protocol it will use to execute the SMBus transactions.
LengthA pointer to signify the number of bytes that this operation will do.
BufferContains the value of data to execute to the SMBUS slave device.
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 215 of file BootScriptLib.c.

◆ S3BootScriptSaveStall()

RETURN_STATUS EFIAPI S3BootScriptSaveStall ( IN UINTN  Duration)

Adds a record for an execution stall on the processor into a specified boot script table.

Parameters
DurationDuration in microseconds of the stall
Return values
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 235 of file BootScriptLib.c.