mirror of https://github.com/acidanthera/audk.git
562 lines
21 KiB
C
562 lines
21 KiB
C
/** @file
|
|
Null function implementation for EFI S3 boot script.
|
|
|
|
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
|
|
#include <Base.h>
|
|
#include <Library/S3BootScriptLib.h>
|
|
|
|
/**
|
|
Save I/O write to boot script
|
|
|
|
@param Width the width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
|
|
@param Address The base address of the I/O operations.
|
|
@param Count The number of I/O operations to perform.
|
|
@param Buffer The source buffer from which to write data.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveIoWrite (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT64 Address,
|
|
IN UINTN Count,
|
|
IN VOID *Buffer
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
Adds a record for an I/O modify operation into a S3 boot script table
|
|
|
|
@param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
|
|
@param Address The base address of the I/O operations.
|
|
@param Data A pointer to the data to be OR-ed.
|
|
@param DataMask A pointer to the data mask to be AND-ed with the data read from the register
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveIoReadWrite (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT64 Address,
|
|
IN VOID *Data,
|
|
IN VOID *DataMask
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
Adds a record for a memory write operation into a specified boot script table.
|
|
|
|
@param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
|
|
@param Address The base address of the memory operations
|
|
@param Count The number of memory operations to perform.
|
|
@param Buffer The source buffer from which to write the data.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveMemWrite (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT64 Address,
|
|
IN UINTN Count,
|
|
IN VOID *Buffer
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for a memory modify operation into a specified boot script table.
|
|
|
|
@param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
|
|
@param Address The base address of the memory operations. Address needs alignment if required
|
|
@param Data A pointer to the data to be OR-ed.
|
|
@param DataMask A pointer to the data mask to be AND-ed with the data read from the register.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveMemReadWrite (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT64 Address,
|
|
IN VOID *Data,
|
|
IN VOID *DataMask
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for a PCI configuration space write operation into a specified boot script table.
|
|
|
|
@param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
|
|
@param Address The address within the PCI configuration space.
|
|
@param Count The number of PCI operations to perform.
|
|
@param Buffer The source buffer from which to write the data.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSavePciCfgWrite (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT64 Address,
|
|
IN UINTN Count,
|
|
IN VOID *Buffer
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
Adds a record for a PCI configuration space modify operation into a specified boot script table.
|
|
|
|
@param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
|
|
@param Address The address within the PCI configuration space.
|
|
@param Data A pointer to the data to be OR-ed.The size depends on Width.
|
|
@param DataMask A pointer to the data mask to be AND-ed.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN__SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSavePciCfgReadWrite (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT64 Address,
|
|
IN VOID *Data,
|
|
IN VOID *DataMask
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for a PCI configuration space modify operation into a specified boot script table.
|
|
|
|
@param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
|
|
@param Segment The PCI segment number for Address.
|
|
@param Address The address within the PCI configuration space.
|
|
@param Count The number of PCI operations to perform.
|
|
@param Buffer The source buffer from which to write the data.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSavePciCfg2Write (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT16 Segment,
|
|
IN UINT64 Address,
|
|
IN UINTN Count,
|
|
IN VOID *Buffer
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for a PCI configuration space modify operation into a specified boot script table.
|
|
|
|
@param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
|
|
@param Segment The PCI segment number for Address.
|
|
@param Address The address within the PCI configuration space.
|
|
@param Data A pointer to the data to be OR-ed. The size depends on Width.
|
|
@param DataMask A pointer to the data mask to be AND-ed.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSavePciCfg2ReadWrite (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT16 Segment,
|
|
IN UINT64 Address,
|
|
IN VOID *Data,
|
|
IN VOID *DataMask
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for an SMBus command execution into a specified boot script table.
|
|
|
|
@param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
|
|
@param Operation Indicates which particular SMBus protocol it will use to execute the SMBus
|
|
transactions.
|
|
@param Length A pointer to signify the number of bytes that this operation will do.
|
|
@param Buffer Contains the value of data to execute to the SMBUS slave device.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveSmbusExecute (
|
|
IN UINTN SmBusAddress,
|
|
IN EFI_SMBUS_OPERATION Operation,
|
|
IN UINTN *Length,
|
|
IN VOID *Buffer
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for an execution stall on the processor into a specified boot script table.
|
|
|
|
@param Duration Duration in microseconds of the stall
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveStall (
|
|
IN UINTN Duration
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for dispatching specified arbitrary code into a specified boot script table.
|
|
|
|
@param EntryPoint Entry point of the code to be dispatched.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveDispatch (
|
|
IN VOID *EntryPoint
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for dispatching specified arbitrary code into a specified boot script table.
|
|
|
|
@param EntryPoint Entry point of the code to be dispatched.
|
|
@param Context Argument to be passed into the EntryPoint of the code to be dispatched.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveDispatch2 (
|
|
IN VOID *EntryPoint,
|
|
IN VOID *Context
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param Width The width of the memory operations.
|
|
@param Address The base address of the memory operations.
|
|
@param BitMask A pointer to the bit mask to be AND-ed with the data read from the register.
|
|
@param BitValue A pointer to the data value after to be Masked.
|
|
@param Duration Duration in microseconds of the stall.
|
|
@param LoopTimes The times of the register polling.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
|
|
**/
|
|
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 RETURN_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
Store arbitrary information in the boot script table. This opcode is a no-op on dispatch and is only
|
|
used for debugging script issues.
|
|
|
|
@param InformationLength Length of the data in bytes
|
|
@param Information Information to be logged in the boot scrpit
|
|
|
|
@retval RETURN_UNSUPPORTED If entering runtime, this method will not support.
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveInformation (
|
|
IN UINT32 InformationLength,
|
|
IN VOID *Information
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for I/O reads the I/O location and continues when the exit criteria is satisfied or after a
|
|
defined duration.
|
|
|
|
@param Width The width of the I/O operations.
|
|
@param Address The base address of the I/O operations.
|
|
@param Data The comparison value used for the polling exit criteria.
|
|
@param 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.
|
|
@param Delay The number of 100ns units to poll. Note that timer available may be of poorer
|
|
granularity so the delay may be longer.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveIoPoll (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT64 Address,
|
|
IN VOID *Data,
|
|
IN VOID *DataMask,
|
|
IN UINT64 Delay
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or
|
|
after a defined duration.
|
|
|
|
@param Width The width of the I/O operations.
|
|
@param Address The address within the PCI configuration space.
|
|
@param Data The comparison value used for the polling exit criteria.
|
|
@param 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
|
|
@param Delay The number of 100ns units to poll. Note that timer available may be of poorer
|
|
granularity so the delay may be longer.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode is added.
|
|
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSavePciPoll (
|
|
IN S3_BOOT_SCRIPT_LIB_WIDTH Width,
|
|
IN UINT64 Address,
|
|
IN VOID *Data,
|
|
IN VOID *DataMask,
|
|
IN UINT64 Delay
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or
|
|
after a defined duration.
|
|
|
|
@param Width The width of the I/O operations.
|
|
@param Segment The PCI segment number for Address.
|
|
@param Address The address within the PCI configuration space.
|
|
@param Data The comparison value used for the polling exit criteria.
|
|
@param 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
|
|
@param Delay The number of 100ns units to poll. Note that timer available may be of poorer
|
|
granularity so the delay may be longer.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
|
|
@retval RETURN_SUCCESS Opcode 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.
|
|
|
|
**/
|
|
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 RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Save ASCII string information specified by Buffer to
|
|
boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE
|
|
|
|
@param String the ascii string to store into the S3 boot script table
|
|
|
|
@retval RETURN_NOT_FOUND BootScriptSave Protocol not exist.
|
|
@retval RETURN_SUCCESS BootScriptSave Protocol exist, always returns RETURN_SUCCESS
|
|
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptSaveInformationAsciiString (
|
|
IN CONST CHAR8 *String
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
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.
|
|
|
|
@return the base address of the new copy of the boot script table.
|
|
|
|
**/
|
|
UINT8*
|
|
EFIAPI
|
|
S3BootScriptCloseTable (
|
|
VOID
|
|
)
|
|
{
|
|
return 0;
|
|
}
|
|
/**
|
|
Executes the S3 boot script table.
|
|
|
|
@param RETURN_SUCCESS The boot script table was executed successfully.
|
|
@param RETURN_UNSUPPORTED Invalid script table or opcode.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptExecute (
|
|
VOID
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Move the last boot script entry to the position
|
|
|
|
@param 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).
|
|
@param 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.
|
|
|
|
@retval RETURN_OUT_OF_RESOURCES The table is not available.
|
|
@retval RETURN_INVALID_PARAMETER The Position is not a valid position in the boot script table.
|
|
@retval RETURN_SUCCESS Opcode is inserted.
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptMoveLastOpcode (
|
|
IN BOOLEAN BeforeOrAfter,
|
|
IN OUT VOID **Position OPTIONAL
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Find a label within the boot script table and, if not present, optionally create it.
|
|
|
|
@param BeforeOrAfter Specifies whether the opcode is stored before (TRUE)
|
|
or after (FALSE) the position in the boot script table
|
|
specified by Position.
|
|
@param CreateIfNotFound Specifies whether the label will be created if the label
|
|
does not exists (TRUE) or not (FALSE).
|
|
@param 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.
|
|
@param Label Points to the label which will be inserted in the boot script table.
|
|
|
|
@retval EFI_SUCCESS The operation succeeded. A record was added into the
|
|
specified script table.
|
|
@retval 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.
|
|
@retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.
|
|
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptLabel (
|
|
IN BOOLEAN BeforeOrAfter,
|
|
IN BOOLEAN CreateIfNotFound,
|
|
IN OUT VOID **Position OPTIONAL,
|
|
IN CONST CHAR8 *Label
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|
|
/**
|
|
Compare two positions in the boot script table and return their relative position.
|
|
@param Position1 The positions in the boot script table to compare
|
|
@param Position2 The positions in the boot script table to compare
|
|
@param RelativePosition On return, points to the result of the comparison
|
|
|
|
@retval EFI_SUCCESS The operation succeeded. A record was added into the
|
|
specified script table.
|
|
@retval 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.
|
|
@retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.
|
|
|
|
**/
|
|
RETURN_STATUS
|
|
EFIAPI
|
|
S3BootScriptCompare (
|
|
IN UINT8 *Position1,
|
|
IN UINT8 *Position2,
|
|
OUT UINTN *RelativePosition
|
|
)
|
|
{
|
|
return RETURN_SUCCESS;
|
|
}
|