EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Functions | Variables

MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c File Reference

#include "InternalBootScriptLib.h"

Go to the source code of this file.

Functions

UINT8S3BootScriptInternalCloseTable (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)
RETURN_STATUS EFIAPI S3BootScriptLibInitialize (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
UINT8S3BootScriptGetBootTimeEntryAddAddress (UINT8 EntryLength)
UINT8S3BootScriptGetRuntimeEntryAddAddress (UINT8 EntryLength)
UINT8S3BootScriptGetEntryAddAddress (UINT8 EntryLength)
VOID SyncBootScript (VOID)
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)
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 UINTN 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)

Variables

SCRIPT_TABLE_PRIVATE_DATAmS3BootScriptTablePtr
EFI_EVENT mEnterRuntimeEvent
SCRIPT_TABLE_PRIVATE_DATA mS3BootScriptTable
UINTN mLockBoxLength
EFI_GUID mBootScriptDataGuid
EFI_GUID mBootScriptHeaderDataGuid

Detailed Description

Save the S3 data to S3 boot script.

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file BootScriptSave.c.


Function Documentation

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:
EntryLengthThe new entry length.
Positionspecifies the position in the boot script table where the opcode will be inserted, either before or after, depending on BeforeOrAfter.
BeforeOrAfterThe flag to indicate to insert the nod before or after the position. This parameter is effective when InsertFlag is TRUE
Scriptreturn out the position from which the a new s3 boot script entry will write into

Definition at line 1521 of file BootScriptSave.c.

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. 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 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 tble.
Note:
this function could only called in boot time phase

Definition at line 589 of file BootScriptSave.c.

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 1819 of file BootScriptSave.c.

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 run time phase.

Parameters:
EventPointer to this event
ContextEvent hanlder private data

Definition at line 153 of file BootScriptSave.c.

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:
EntryLengththe new entry length.
Return values:
theaddress from which the a new s3 boot script entry will write into

Definition at line 351 of file BootScriptSave.c.

UINT8* S3BootScriptGetEntryAddAddress ( UINT8  EntryLength)

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

Parameters:
EntryLengththe new entry length.
Return values:
theaddress from which the a new s3 runtime script entry will write into

Definition at line 475 of file BootScriptSave.c.

UINT8* S3BootScriptGetRuntimeEntryAddAddress ( UINT8  EntryLength)

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

Parameters:
EntryLengththe new entry length.
Return values:
theaddress from which the a new s3 runtime script entry will write into

Definition at line 447 of file BootScriptSave.c.

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 tble.

Definition at line 64 of file BootScriptSave.c.

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 1743 of file BootScriptSave.c.

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:
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.
InformationLengthLength of the label in bytes
InformationLabel to be logged in the boot scrpit
Return values:
RETURN_INVALID_PARAMETERThe Position is not a valid position in the boot script table.
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 1683 of file BootScriptSave.c.

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:
ImageHandleThe firmware allocated handle for the EFI image.
SystemTableA pointer to the EFI System Table.
Return values:
RETURN_SUCCESSAllocate the global memory space to store S3 boot script table private data
RETURN_OUT_OF_RESOURCESNo enough memory to allocated.

Definition at line 259 of file BootScriptSave.c.

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 1592 of file BootScriptSave.c.

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 1310 of file BootScriptSave.c.

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

Adds a record for an execution stall on the processor 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 1132 of file BootScriptSave.c.

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 1232 of file BootScriptSave.c.

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:
StringThe string to save to boot script table
Return values:
RETURN_OUT_OF_RESOURCESNot enough memory for the table do operation.
RETURN_SUCCESSOpcode is added.

Definition at line 1291 of file BootScriptSave.c.

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 1356 of file BootScriptSave.c.

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 696 of file BootScriptSave.c.

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 647 of file BootScriptSave.c.

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

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

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 1178 of file BootScriptSave.c.

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 792 of file BootScriptSave.c.

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 744 of file BootScriptSave.c.

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 1471 of file BootScriptSave.c.

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 992 of file BootScriptSave.c.

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 941 of file BootScriptSave.c.

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 888 of file BootScriptSave.c.

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 840 of file BootScriptSave.c.

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 1413 of file BootScriptSave.c.

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 1047 of file BootScriptSave.c.

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 1094 of file BootScriptSave.c.

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 run time phase and set InSmm flag.

Parameters:
ProtocolPoints to the protocol's unique identifier
InterfacePoints to the interface instance
HandleThe handle on which the interface was installed
Return values:
EFI_SUCCESSSmmEventCallback runs successfully

Definition at line 205 of file BootScriptSave.c.

VOID SaveBootScriptDataToLockBox ( VOID  )

This function save boot script data to LockBox. 1. BootSriptPrivate data, BootScript data - Image and DispatchContext are handled by platform. 2. BootScriptExecutor, BootScriptExecutor context

  • ACPI variable - (PI version) sould be handled by SMM driver. S3 Page table is handled here.
  • ACPI variable - framework version is already handled by Framework CPU driver.

Definition at line 110 of file BootScriptSave.c.

VOID SyncBootScript ( VOID  )

Sync BootScript LockBox data.

Definition at line 540 of file BootScriptSave.c.


Variable Documentation

Initial value:
 {
  0xaea6b965, 0xdcf5, 0x4311, 0xb4, 0xb8, 0xf, 0x12, 0x46, 0x44, 0x94, 0xd2
}

Definition at line 49 of file BootScriptSave.c.

Initial value:
 {
  0x1810ab4a, 0x2314, 0x4df6, 0x81, 0xeb, 0x67, 0xc6, 0xec, 0x5, 0x85, 0x91
}

Definition at line 53 of file BootScriptSave.c.

Definition at line 42 of file BootScriptSave.c.

Definition at line 47 of file BootScriptSave.c.

Definition at line 46 of file BootScriptSave.c.

Data structure usage:

+------------------------------+<-- PcdS3BootScriptTablePrivateDataPtr | SCRIPT_TABLE_PRIVATE_DATA | | TableBase |--- | TableLength |--|-- | AtRuntime | | | | InSmm | | | +------------------------------+ | | | | +------------------------------+<-- | | EFI_BOOT_SCRIPT_TABLE_HEADER | | | TableLength |----|-- +------------------------------+ | | | ...... | | | +------------------------------+<---- | | EFI_BOOT_SCRIPT_TERMINATE | | +------------------------------+<------

Definition at line 41 of file BootScriptSave.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines