diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-11 08:17:27 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-11 08:17:27 +0000 |
commit | f215e02bf85f68d3a6106c2a1f4f7f063f819064 (patch) | |
tree | 6bb5b92c046312c4e95ac2620b10ddf482d3fa8b /src/VBox/Devices/EFI/Firmware/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h | |
parent | Initial commit. (diff) | |
download | virtualbox-f215e02bf85f68d3a6106c2a1f4f7f063f819064.tar.xz virtualbox-f215e02bf85f68d3a6106c2a1f4f7f063f819064.zip |
Adding upstream version 7.0.14-dfsg.upstream/7.0.14-dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/VBox/Devices/EFI/Firmware/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h')
-rw-r--r-- | src/VBox/Devices/EFI/Firmware/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/src/VBox/Devices/EFI/Firmware/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h b/src/VBox/Devices/EFI/Firmware/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h new file mode 100644 index 00000000..8a6a6e39 --- /dev/null +++ b/src/VBox/Devices/EFI/Firmware/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h @@ -0,0 +1,105 @@ +/** @file + Support for S3 boot script lib. This file defined some internal macro and internal + data structure + + Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR> + + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#ifndef __INTERNAL_BOOT_SCRIPT_LIB__ +#define __INTERNAL_BOOT_SCRIPT_LIB__ + +#include <PiDxe.h> + +#include <Guid/EventGroup.h> +#include <Protocol/SmmBase2.h> +#include <Protocol/DxeSmmReadyToLock.h> +#include <Protocol/SmmReadyToLock.h> +#include <Protocol/SmmExitBootServices.h> +#include <Protocol/SmmLegacyBoot.h> + +#include <Library/S3BootScriptLib.h> + +#include <Library/UefiBootServicesTableLib.h> +#include <Library/BaseLib.h> +#include <Library/PcdLib.h> +#include <Library/SmbusLib.h> +#include <Library/IoLib.h> +#include <Library/PciSegmentLib.h> +#include <Library/DebugLib.h> +#include <Library/BaseMemoryLib.h> +#include <Library/TimerLib.h> +#include <Library/UefiLib.h> +#include <Library/LockBoxLib.h> + +#include "BootScriptInternalFormat.h" + +#define MAX_IO_ADDRESS 0xFFFF + +// +// Macro to convert a UEFI PCI address + segment to a PCI Segment Library PCI address +// +#define PCI_ADDRESS_ENCODE(S, A) PCI_SEGMENT_LIB_ADDRESS( \ + S, \ + ((((UINTN)(A)) & 0xff000000) >> 24), \ + ((((UINTN)(A)) & 0x00ff0000) >> 16), \ + ((((UINTN)(A)) & 0xff00) >> 8), \ + ((RShiftU64 ((A), 32) & 0xfff) | ((A) & 0xff)) \ + ) + +typedef union { + UINT8 volatile *Buf; + UINT8 volatile *Uint8; + UINT16 volatile *Uint16; + UINT32 volatile *Uint32; + UINT64 volatile *Uint64; + UINTN volatile Uint; +} PTR; + + +// Minimum and maximum length for SMBus bus block protocols defined in SMBus spec 2.0. +// +#define MIN_SMBUS_BLOCK_LEN 1 +#define MAX_SMBUS_BLOCK_LEN 32 + +// +// The boot script private data. +// +typedef struct { + UINT8 *TableBase; + UINT32 TableLength; // Record the actual memory length + UINT16 TableMemoryPageNumber; // Record the page number Allocated for the table + BOOLEAN InSmm; // Record if this library is in SMM. + BOOLEAN AtRuntime; // Record if current state is after SmmExitBootServices or SmmLegacyBoot. + UINT32 BootTimeScriptLength; // Maintain boot time script length in LockBox after SmmReadyToLock in SMM. + BOOLEAN SmmLocked; // Record if current state is after SmmReadyToLock + BOOLEAN BackFromS3; // Indicate that the system is back from S3. +} SCRIPT_TABLE_PRIVATE_DATA; + +typedef +EFI_STATUS +(EFIAPI *DISPATCH_ENTRYPOINT_FUNC) ( + IN EFI_HANDLE ImageHandle, + IN VOID *Context + ); + +extern SCRIPT_TABLE_PRIVATE_DATA *mS3BootScriptTablePtr; + +// +// Define Opcode for Label which is implementation specific and no standard spec define. +// +#define S3_BOOT_SCRIPT_LIB_LABEL_OPCODE 0xFE + +/// +/// The opcode indicate the start of the boot script table. +/// +#define S3_BOOT_SCRIPT_LIB_TABLE_OPCODE 0xAA +/// +/// The opcode indicate the end of the boot script table. +/// +#define S3_BOOT_SCRIPT_LIB_TERMINATE_OPCODE 0xFF + + +#endif //__INTERNAL_BOOT_SCRIPT_LIB__ + |