#include "InternalBootScriptLib.h"

Functions
UINT8 *	S3BootScriptInternalCloseTable (VOID)

VOID	SaveBootScriptDataToLockBox (VOID)

VOID EFIAPI	S3BootScriptEventCallBack (IN EFI_EVENT Event, IN VOID *Context)

EFI_STATUS EFIAPI	S3BootScriptSmmEventCallBack (IN CONST EFI_GUID Protocol, IN VOID Interface, IN EFI_HANDLE Handle)

VOID	SaveBootTimeDataToLockBox (VOID)

VOID	SaveSmmPriviateDataToLockBoxAtRuntime (VOID)

EFI_STATUS EFIAPI	S3BootScriptSmmAtRuntimeCallBack (IN CONST EFI_GUID Protocol, IN VOID Interface, IN EFI_HANDLE Handle)

RETURN_STATUS EFIAPI	S3BootScriptLibInitialize (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

RETURN_STATUS EFIAPI	S3BootScriptLibDeinitialize (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

UINT8 *	S3BootScriptGetBootTimeEntryAddAddress (UINT8 EntryLength)

UINT8 *	S3BootScriptGetRuntimeEntryAddAddress (UINT8 EntryLength)

VOID	RestoreBootTimeDataFromLockBox (VOID)

UINT8 *	S3BootScriptGetEntryAddAddress (UINT8 EntryLength)

VOID	SyncBootScript (IN UINT8 *Script)

UINT8 *EFIAPI	S3BootScriptCloseTable (VOID)

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)

EFI_STATUS	CheckParameters (IN UINTN SmBusAddress, IN EFI_SMBUS_OPERATION Operation, IN OUT UINTN Length, IN VOID Buffer)

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	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	S3BootScriptSaveInformationAsciiString (IN CONST CHAR8 *String)

RETURN_STATUS EFIAPI	S3BootScriptSaveDispatch (IN VOID *EntryPoint)

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)

VOID	S3BootScriptCalculateInsertAddress (IN UINT8 EntryLength, IN VOID Position OPTIONAL, IN BOOLEAN BeforeOrAfter OPTIONAL, OUT UINT8 *Script)

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

RETURN_STATUS EFIAPI	S3BootScriptLabelInternal (IN BOOLEAN BeforeOrAfter, IN OUT VOID *Position OPTIONAL, IN UINT32 InformationLength, IN CONST CHAR8 Information)

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

Save the S3 data to S3 boot script.

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

Definition in file BootScriptSave.c.

Function Documentation

◆ CheckParameters()

EFI_STATUS CheckParameters	(	IN UINTN	SmBusAddress,
		IN EFI_SMBUS_OPERATION	Operation,
		IN OUT UINTN *	Length,
		IN VOID *	Buffer
	)

Checks the parameter of S3BootScriptSaveSmbusExecute().

This function checks the input parameters of SmbusExecute(). If the input parameters are valid for certain SMBus bus protocol, it will return EFI_SUCCESS; otherwise, it will return certain error code based on the input SMBus bus protocol.

Parameters

SmBusAddress	Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Operation	Signifies which particular SMBus hardware protocol instance that it will use to execute the SMBus transactions. This SMBus hardware protocol is defined by the SMBus Specification and is not related to EFI.
Length	Signifies the number of bytes that this operation will do. The maximum number of bytes can be revision specific and operation specific. This field will contain the actual number of bytes that are executed for this operation. Not all operations require this argument.
Buffer	Contains the value of data to execute to the SMBus slave device. Not all operations require this argument. The length of this buffer is identified by Length.

Return values

EFI_SUCCESS	All the parameters are valid for the corresponding SMBus bus protocol.
EFI_INVALID_PARAMETER	Operation is not defined in EFI_SMBUS_OPERATION.
EFI_INVALID_PARAMETER	Length/Buffer is NULL for operations except for EfiSmbusQuickRead and EfiSmbusQuickWrite. Length is outside the range of valid values.
EFI_UNSUPPORTED	The SMBus operation or PEC is not supported.
EFI_BUFFER_TOO_SMALL	Buffer is not sufficient for this operation.

Definition at line 1553 of file BootScriptSave.c.

◆ RestoreBootTimeDataFromLockBox()

VOID RestoreBootTimeDataFromLockBox ( VOID )

This function is to restore boot time boot script data from LockBox.

Definition at line 788 of file BootScriptSave.c.

◆ S3BootScriptCalculateInsertAddress()

VOID S3BootScriptCalculateInsertAddress	(	IN UINT8	EntryLength,
		IN VOID *Position	OPTIONAL,
		IN BOOLEAN BeforeOrAfter	OPTIONAL,
		OUT UINT8 **	Script
	)

Do the calculation of start address from which a new s3 boot script entry will write into.

Parameters

EntryLength	The new entry length.
Position	specifies the position in the boot script table where the opcode will be inserted, either before or after, depending on BeforeOrAfter.
BeforeOrAfter	The flag to indicate to insert the nod before or after the position. This parameter is effective when InsertFlag is TRUE
Script	return out the position from which the a new s3 boot script entry will write into

Definition at line 2194 of file BootScriptSave.c.

◆ 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:

Closes the specified boot script table
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.
Any attempts to add a script record after calling this function will cause a new table to be created by the library.
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. To provides this API for now is for Framework Spec compatibility.

If anyone does call CloseTable() on a real platform, then the caller is responsible for figuring out how to get the script to run at 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.

Note: this function could only called in boot time phase

Definition at line 950 of file BootScriptSave.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

Position1	The positions in the boot script table to compare
Position2	The positions in the boot script table to compare
RelativePosition	On return, points to the result of the comparison

Return values

EFI_SUCCESS	The operation succeeded or no action is required. A record was added into the specified script table if ACPI S3 was enabled.
EFI_INVALID_PARAMETER	The 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_RESOURCES	There is insufficient memory to store the boot script.

Definition at line 2536 of file BootScriptSave.c.

◆ S3BootScriptEventCallBack()

VOID EFIAPI S3BootScriptEventCallBack	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

This is the Event call back function to notify the Library the system is entering SmmLocked phase.

Parameters

Event	Pointer to this event
Context	Event handler private data

Definition at line 223 of file BootScriptSave.c.

◆ S3BootScriptGetBootTimeEntryAddAddress()

UINT8 * S3BootScriptGetBootTimeEntryAddAddress ( UINT8 EntryLength )

To get the start address from which a new boot time s3 boot script entry will write into. If the table is not exist, the functio will first allocate a buffer for the table If the table buffer is not enough for the new entry, in non-smm mode, the funtion will invoke reallocate to enlarge buffer.

Parameters

EntryLength the new entry length.

Return values

the	address from which the a new s3 boot script entry will write into

Definition at line 661 of file BootScriptSave.c.

◆ S3BootScriptGetEntryAddAddress()

UINT8 * S3BootScriptGetEntryAddAddress ( UINT8 EntryLength )

To get the start address from which a new s3 boot script entry will write into.

Parameters

EntryLength the new entry length.

Return values

the	address from which the a new s3 boot script entry will write into

Definition at line 831 of file BootScriptSave.c.

◆ S3BootScriptGetRuntimeEntryAddAddress()

UINT8 * S3BootScriptGetRuntimeEntryAddAddress ( UINT8 EntryLength )

To get the start address from which a new runtime(after SmmReadyToLock) s3 boot script entry will write into. In this case, it should be ensured that there is enough buffer to hold the entry.

Parameters

EntryLength the new entry length.

Return values

the	address from which the a new s3 runtime(after SmmReadyToLock) script entry will write into

Definition at line 761 of file BootScriptSave.c.

◆ S3BootScriptInternalCloseTable()

UINT8 * S3BootScriptInternalCloseTable ( VOID )

This is an internal function to add a terminate node the entry, recalculate the table length and fill into the table.

Returns: the base address of the boot script table.

Definition at line 136 of file BootScriptSave.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

BeforeOrAfter	Specifies whether the opcode is stored before (TRUE) or after (FALSE) the position in the boot script table specified by Position.
CreateIfNotFound	Specifies whether the label will be created if the label does not exists (TRUE) or not (FALSE).
Position	On 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.
Label	Points to the label which will be inserted in the boot script table.

Return values

EFI_SUCCESS	The operation succeeded or no action is required. A record was added into the specified script table if ACPI S3 was enabled.
EFI_INVALID_PARAMETER	The 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_RESOURCES	There is insufficient memory to store the boot script.

Definition at line 2446 of file BootScriptSave.c.

◆ S3BootScriptLabelInternal()

RETURN_STATUS EFIAPI S3BootScriptLabelInternal	(	IN BOOLEAN	BeforeOrAfter,
		IN OUT VOID **Position	OPTIONAL,
		IN UINT32	InformationLength,
		IN CONST CHAR8 *	Information
	)

Create a Label node in the boot script table.

Parameters

BeforeOrAfter	Specifies 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).
Position	On 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.
InformationLength	Length of the label in bytes
Information	Label to be logged in the boot scrpit

Return values

RETURN_INVALID_PARAMETER	The Position is not a valid position in the boot script table.
RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 2377 of file BootScriptSave.c.

◆ S3BootScriptLibDeinitialize()

RETURN_STATUS EFIAPI S3BootScriptLibDeinitialize	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Library Destructor to free the resources allocated by S3BootScriptLibInitialize() and unregister callbacks.

NOTICE: The destructor doesn't support unloading as a separate action, and it only supports unloading if the containing driver's entry point function fails.

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

RETURN_SUCCESS The destructor always returns RETURN_SUCCESS.

Definition at line 571 of file BootScriptSave.c.

◆ S3BootScriptLibInitialize()

RETURN_STATUS EFIAPI S3BootScriptLibInitialize	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Library Constructor. this function just identify it is a smm driver or non-smm driver linked against with the library

Parameters

ImageHandle	The firmware allocated handle for the EFI image.
SystemTable	A pointer to the EFI System Table.

Return values

RETURN_SUCCESS The constructor always returns RETURN_SUCCESS.

Definition at line 428 of file BootScriptSave.c.

◆ S3BootScriptMoveLastOpcode()

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

Move the last boot script entry to the position

Parameters

BeforeOrAfter	Specifies 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).
Position	On 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_RESOURCES	The table is not available.
RETURN_INVALID_PARAMETER	The Position is not a valid position in the boot script table.
RETURN_SUCCESS	Opcode is inserted no action is required as ACPI S3 was disabled.

Definition at line 2267 of file BootScriptSave.c.

◆ S3BootScriptSaveDispatch()

RETURN_STATUS EFIAPI S3BootScriptSaveDispatch ( IN VOID * EntryPoint )

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

Parameters

EntryPoint Entry point of the code to be dispatched.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1948 of file BootScriptSave.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

EntryPoint	Entry point of the code to be dispatched.
Context	Argument to be passed into the EntryPoint of the code to be dispatched.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1757 of file BootScriptSave.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

InformationLength	Length of the data in bytes
Information	Information to be logged in the boot scrpit

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1873 of file BootScriptSave.c.

◆ S3BootScriptSaveInformationAsciiString()

RETURN_STATUS EFIAPI S3BootScriptSaveInformationAsciiString ( IN CONST CHAR8 * String )

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

Parameters

String The string to save to boot script table

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1928 of file BootScriptSave.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

Width	The width of the I/O operations.
Address	The base address of the I/O operations.
Data	The comparison value used for the polling exit criteria.
DataMask	Mask used for the polling criteria. The bits in the bytes below Width which are zero in Data are ignored when polling the memory address.
Delay	The 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_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1999 of file BootScriptSave.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

Width	The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
Address	The base address of the I/O operations.
Data	A pointer to the data to be OR-ed.
DataMask	A pointer to the data mask to be AND-ed with the data read from the register

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1075 of file BootScriptSave.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

Width	The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
Address	The base address of the I/O operations.
Count	The number of I/O operations to perform.
Buffer	The source buffer from which to write data.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1011 of file BootScriptSave.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

Width	The width of the memory operations.
Address	The base address of the memory operations.
BitMask	A pointer to the bit mask to be AND-ed with the data read from the register.
BitValue	A pointer to the data value after to be Masked.
Duration	Duration in microseconds of the stall.
LoopTimes	The times of the register polling.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1814 of file BootScriptSave.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

Width	The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
Address	The base address of the memory operations. Address needs alignment if required
Data	A pointer to the data to be OR-ed.
DataMask	A pointer to the data mask to be AND-ed with the data read from the register.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1193 of file BootScriptSave.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

Width	The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
Address	The base address of the memory operations
Count	The number of memory operations to perform.
Buffer	The source buffer from which to write the data.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1129 of file BootScriptSave.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

Width	The width of the I/O operations.
Segment	The PCI segment number for Address.
Address	The address within the PCI configuration space.
Data	The comparison value used for the polling exit criteria.
DataMask	Mask used for the polling criteria. The bits in the bytes below Width which are zero in Data are ignored when polling the memory address
Delay	The 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_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Note: A known Limitations in the implementation which is 64bits operations are not supported.

Definition at line 2131 of file BootScriptSave.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 2 space modify operation into a specified boot script table.

Parameters

Width	The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
Segment	The PCI segment number for Address.
Address	The address within the PCI configuration space.
Data	A pointer to the data to be OR-ed. The size depends on Width.
DataMask	A pointer to the data mask to be AND-ed.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Note: A known Limitations in the implementation which is 64bits operations are not supported.

Definition at line 1466 of file BootScriptSave.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 2 space write operation into a specified boot script table.

Parameters

Width	The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
Segment	The PCI segment number for Address.
Address	The address within the PCI configuration space.
Count	The number of PCI operations to perform.
Buffer	The source buffer from which to write the data.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Note: A known Limitations in the implementation which is 64bits operations are not supported.

Definition at line 1390 of file BootScriptSave.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

Width	The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
Address	The address within the PCI configuration space.
Data	A pointer to the data to be OR-ed.The size depends on Width.
DataMask	A pointer to the data mask to be AND-ed.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN__SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Note: A known Limitations in the implementation which is 64bits operations are not supported.

Definition at line 1322 of file BootScriptSave.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

Width	The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
Address	The address within the PCI configuration space.
Count	The number of PCI operations to perform.
Buffer	The source buffer from which to write the data.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Note: A known Limitations in the implementation which is 64bits operations are not supported.

Definition at line 1249 of file BootScriptSave.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

Width	The width of the I/O operations.
Address	The address within the PCI configuration space.
Data	The comparison value used for the polling exit criteria.
DataMask	Mask used for the polling criteria. The bits in the bytes below Width which are zero in Data are ignored when polling the memory address
Delay	The 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_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Note: A known Limitations in the implementation which is 64bits operations are not supported.

Definition at line 2061 of file BootScriptSave.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

SmBusAddress	Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Operation	Indicates which particular SMBus protocol it will use to execute the SMBus transactions.
Length	A pointer to signify the number of bytes that this operation will do.
Buffer	Contains the value of data to execute to the SMBUS slave device.

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1640 of file BootScriptSave.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

Duration Duration in microseconds of the stall

Return values

RETURN_OUT_OF_RESOURCES	Not enough memory for the table do operation.
RETURN_SUCCESS	Opcode is added or no action is required as ACPI S3 was disabled.

Definition at line 1713 of file BootScriptSave.c.

◆ S3BootScriptSmmAtRuntimeCallBack()

EFI_STATUS EFIAPI S3BootScriptSmmAtRuntimeCallBack	(	IN CONST EFI_GUID *	Protocol,
		IN VOID *	Interface,
		IN EFI_HANDLE	Handle
	)

This is the Event call back function is triggered in SMM to notify the Library the system is entering runtime phase.

Parameters

[in]	Protocol	Points to the protocol's unique identifier
[in]	Interface	Points to the interface instance
[in]	Handle	The handle on which the interface was installed

Return values

EFI_SUCCESS SmmAtRuntimeCallBack runs successfully

Definition at line 398 of file BootScriptSave.c.

◆ S3BootScriptSmmEventCallBack()

EFI_STATUS EFIAPI S3BootScriptSmmEventCallBack	(	IN CONST EFI_GUID *	Protocol,
		IN VOID *	Interface,
		IN EFI_HANDLE	Handle
	)

This is the Event call back function is triggered in SMM to notify the Library the system is entering SmmLocked phase and set InSmm flag.

Parameters

Protocol	Points to the protocol's unique identifier
Interface	Points to the interface instance
Handle	The handle on which the interface was installed

Return values

EFI_SUCCESS SmmEventCallback runs successfully

Definition at line 276 of file BootScriptSave.c.

◆ SaveBootScriptDataToLockBox()

VOID SaveBootScriptDataToLockBox ( VOID )

This function save boot script data to LockBox.

Definition at line 179 of file BootScriptSave.c.

◆ SaveBootTimeDataToLockBox()

VOID SaveBootTimeDataToLockBox ( VOID )

This function is to save boot time boot script data to LockBox.

Because there may be INSERT boot script at runtime in SMM. The boot time copy will be used to restore data after back from S3. Otherwise the data inserted may cause some boot time boot script data lost if only BootScriptData used.

Definition at line 325 of file BootScriptSave.c.

◆ SaveSmmPriviateDataToLockBoxAtRuntime()

VOID SaveSmmPriviateDataToLockBoxAtRuntime ( VOID )

This function save boot script SMM private data to LockBox with BackFromS3 = TRUE at runtime. S3 resume will help restore it to tell the Library the system is back from S3.

Definition at line 360 of file BootScriptSave.c.

◆ SyncBootScript()

VOID SyncBootScript ( IN UINT8 * Script )

Sync BootScript LockBox data.

Parameters

Script The address from where the boot script has been added or updated.

Definition at line 878 of file BootScriptSave.c.

Variable Documentation

◆ mBootScriptDataBootTimeGuid

EFI_GUID mBootScriptDataBootTimeGuid

Initial value:

= {
  0xb5af1d7a, 0xb8cf, 0x4eb3, { 0x89, 0x25, 0xa8, 0x20, 0xe1, 0x6b, 0x68, 0x7d }
}

Definition at line 108 of file BootScriptSave.c.

◆ mBootScriptDataGuid

EFI_GUID mBootScriptDataGuid

Initial value:

= {
  0xaea6b965, 0xdcf5, 0x4311, { 0xb4, 0xb8, 0xf, 0x12, 0x46, 0x44, 0x94, 0xd2 }
}

Definition at line 104 of file BootScriptSave.c.

◆ mBootScriptSmmPrivateDataGuid

EFI_GUID mBootScriptSmmPrivateDataGuid

Initial value:

= {
  0x627ee2da, 0x3bf9, 0x439b, { 0x92, 0x9f, 0x2e, 0xe, 0x6e, 0x9d, 0xba, 0x62 }
}

Definition at line 116 of file BootScriptSave.c.

◆ mBootScriptSmst

EFI_SMM_SYSTEM_TABLE2* mBootScriptSmst = NULL

Definition at line 126 of file BootScriptSave.c.

◆ mBootScriptTableBaseGuid

EFI_GUID mBootScriptTableBaseGuid

Initial value:

= {
  0x1810ab4a, 0x2314, 0x4df6, { 0x81, 0xeb, 0x67, 0xc6, 0xec, 0x5, 0x85, 0x91 }
}

Definition at line 112 of file BootScriptSave.c.

◆ mEventDxeSmmReadyToLock

EFI_EVENT mEventDxeSmmReadyToLock = NULL

Definition at line 120 of file BootScriptSave.c.

◆ mRegistrationSmmExitBootServices

VOID* mRegistrationSmmExitBootServices = NULL

Definition at line 121 of file BootScriptSave.c.

◆ mRegistrationSmmLegacyBoot

VOID* mRegistrationSmmLegacyBoot = NULL

Definition at line 122 of file BootScriptSave.c.

◆ mRegistrationSmmReadyToLock

VOID* mRegistrationSmmReadyToLock = NULL

Definition at line 123 of file BootScriptSave.c.

◆ mS3BootScriptAcpiS3Enable

BOOLEAN mS3BootScriptAcpiS3Enable = TRUE

Definition at line 127 of file BootScriptSave.c.

◆ mS3BootScriptTableAllocated

BOOLEAN mS3BootScriptTableAllocated = FALSE

Definition at line 124 of file BootScriptSave.c.

◆ mS3BootScriptTablePtr

SCRIPT_TABLE_PRIVATE_DATA* mS3BootScriptTablePtr

Data structure usage:

+---------------------------—+<----— PcdS3BootScriptTablePrivateDataPtr | SCRIPT_TABLE_PRIVATE_DATA | (mS3BootScriptTablePtr, Before SmmReadyToLock) | TableBase |— PcdS3BootScriptTablePrivateSmmDataPtr | TableLength |–|– (mS3BootScriptTablePtr = mS3BootScriptTableSmmPtr, After SmmReadyToLock InSmm) | TableMemoryPageNumber |–|-|-— | AtRuntime | | | | | InSmm | | | | | BootTimeScriptLength |–|-|—|— | SmmLocked | | | | | | BackFromS3 | | | | | +---------------------------—+ | | | | | | | | +---------------------------—+<– | | | | EFI_BOOT_SCRIPT_TABLE_HEADER | | | | | TableLength |-—|– | | +---------------------------—+ | | | | | ...... | | | | | +---------------------------—+<-— | | | | EFI_BOOT_SCRIPT_TERMINATE | | | | +---------------------------—+<---— | | | | | | mBootScriptDataBootTimeGuid LockBox: | | Used to restore data after back from S3| | to handle potential INSERT boot script | | at runtime. | | +---------------------------—+ | | | Boot Time Boot Script | | |

Before SmmReadyToLock

+---------------------------—+ | | | Boot Time Boot Script | | | | After SmmReadyToLock InSmm | | | | | | | +---------------------------—+<----—|–| | | | | mBootScriptDataGuid LockBox: (IN_PLACE) | | Used to restore data at S3 resume. | | +---------------------------—+ | | | Boot Time Boot Script | | |

Before SmmReadyToLock

+---------------------------—+ | | | Boot Time Boot Script | | | | After SmmReadyToLock InSmm | | | | | | | +---------------------------—+<----—|— | Runtime Boot Script | | | After SmmReadyToLock InSmm | | +---------------------------—+ | | ...... | | +---------------------------—+<-----—

mBootScriptTableBaseGuid LockBox: (IN_PLACE) +---------------------------—+ | mS3BootScriptTablePtr-> | | TableBase | +---------------------------—+

Definition at line 97 of file BootScriptSave.c.

◆ mS3BootScriptTableSmmAllocated

BOOLEAN mS3BootScriptTableSmmAllocated = FALSE

Definition at line 125 of file BootScriptSave.c.

◆ mS3BootScriptTableSmmPtr

SCRIPT_TABLE_PRIVATE_DATA* mS3BootScriptTableSmmPtr

Definition at line 102 of file BootScriptSave.c.

Variables
SCRIPT_TABLE_PRIVATE_DATA *	mS3BootScriptTablePtr

SCRIPT_TABLE_PRIVATE_DATA *	mS3BootScriptTableSmmPtr

EFI_GUID	mBootScriptDataGuid

EFI_GUID	mBootScriptDataBootTimeGuid

EFI_GUID	mBootScriptTableBaseGuid

EFI_GUID	mBootScriptSmmPrivateDataGuid

EFI_EVENT	mEventDxeSmmReadyToLock = NULL

VOID *	mRegistrationSmmExitBootServices = NULL

VOID *	mRegistrationSmmLegacyBoot = NULL

VOID *	mRegistrationSmmReadyToLock = NULL

BOOLEAN	mS3BootScriptTableAllocated = FALSE

BOOLEAN	mS3BootScriptTableSmmAllocated = FALSE

EFI_SMM_SYSTEM_TABLE2 *	mBootScriptSmst = NULL

BOOLEAN	mS3BootScriptAcpiS3Enable = TRUE

Functions

Variables

Detailed Description

Function Documentation

◆ CheckParameters()

◆ RestoreBootTimeDataFromLockBox()

◆ S3BootScriptCalculateInsertAddress()

◆ S3BootScriptCloseTable()

◆ S3BootScriptCompare()

◆ S3BootScriptEventCallBack()

◆ S3BootScriptGetBootTimeEntryAddAddress()

◆ S3BootScriptGetEntryAddAddress()

◆ S3BootScriptGetRuntimeEntryAddAddress()

◆ S3BootScriptInternalCloseTable()

◆ S3BootScriptLabel()

◆ S3BootScriptLabelInternal()

◆ S3BootScriptLibDeinitialize()

◆ S3BootScriptLibInitialize()

◆ S3BootScriptMoveLastOpcode()

◆ S3BootScriptSaveDispatch()

◆ S3BootScriptSaveDispatch2()

◆ S3BootScriptSaveInformation()

◆ S3BootScriptSaveInformationAsciiString()

◆ S3BootScriptSaveIoPoll()

◆ S3BootScriptSaveIoReadWrite()

◆ S3BootScriptSaveIoWrite()

◆ S3BootScriptSaveMemPoll()

◆ S3BootScriptSaveMemReadWrite()

◆ S3BootScriptSaveMemWrite()

◆ S3BootScriptSavePci2Poll()

◆ S3BootScriptSavePciCfg2ReadWrite()

◆ S3BootScriptSavePciCfg2Write()

◆ S3BootScriptSavePciCfgReadWrite()

◆ S3BootScriptSavePciCfgWrite()

◆ S3BootScriptSavePciPoll()

◆ S3BootScriptSaveSmbusExecute()

◆ S3BootScriptSaveStall()

◆ S3BootScriptSmmAtRuntimeCallBack()

◆ S3BootScriptSmmEventCallBack()

◆ SaveBootScriptDataToLockBox()

◆ SaveBootTimeDataToLockBox()

◆ SaveSmmPriviateDataToLockBoxAtRuntime()

◆ SyncBootScript()

Variable Documentation

◆ mBootScriptDataBootTimeGuid

◆ mBootScriptDataGuid

◆ mBootScriptSmmPrivateDataGuid

◆ mBootScriptSmst

◆ mBootScriptTableBaseGuid

◆ mEventDxeSmmReadyToLock

◆ mRegistrationSmmExitBootServices

◆ mRegistrationSmmLegacyBoot

◆ mRegistrationSmmReadyToLock

◆ mS3BootScriptAcpiS3Enable

◆ mS3BootScriptTableAllocated

◆ mS3BootScriptTablePtr

◆ mS3BootScriptTableSmmAllocated

◆ mS3BootScriptTableSmmPtr