2011-08-29 22:17:27 +00:00
|
|
|
/** @file
|
2016-08-17 16:51:55 +08:00
|
|
|
Support for S3 boot script lib. This file defined some internal macro and internal
|
2011-08-29 22:17:27 +00:00
|
|
|
data structure
|
2016-08-17 16:51:55 +08:00
|
|
|
|
2016-08-08 18:20:58 +08:00
|
|
|
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
|
2011-08-29 22:17:27 +00:00
|
|
|
|
2019-04-03 16:05:13 -07:00
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
2011-08-29 22:17:27 +00:00
|
|
|
|
|
|
|
|
**/
|
2021-12-05 14:54:02 -08:00
|
|
|
|
MdeModulePkg: Replace include guards with #pragma once
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
2026-02-03 13:48:28 -05:00
|
|
|
#pragma once
|
2011-08-29 22:17:27 +00:00
|
|
|
|
|
|
|
|
#include <PiDxe.h>
|
|
|
|
|
|
|
|
|
|
#include <Guid/EventGroup.h>
|
|
|
|
|
#include <Protocol/SmmBase2.h>
|
|
|
|
|
#include <Protocol/DxeSmmReadyToLock.h>
|
|
|
|
|
#include <Protocol/SmmReadyToLock.h>
|
2015-09-15 07:49:12 +00:00
|
|
|
#include <Protocol/SmmExitBootServices.h>
|
|
|
|
|
#include <Protocol/SmmLegacyBoot.h>
|
2011-08-29 22:17:27 +00:00
|
|
|
|
|
|
|
|
#include <Library/S3BootScriptLib.h>
|
|
|
|
|
|
|
|
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
|
|
|
#include <Library/BaseLib.h>
|
|
|
|
|
#include <Library/PcdLib.h>
|
|
|
|
|
#include <Library/SmbusLib.h>
|
|
|
|
|
#include <Library/IoLib.h>
|
2016-08-08 18:20:58 +08:00
|
|
|
#include <Library/PciSegmentLib.h>
|
2011-08-29 22:17:27 +00:00
|
|
|
#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
|
|
|
|
|
|
2011-11-28 06:19:36 +00:00
|
|
|
//
|
2016-08-08 18:20:58 +08:00
|
|
|
// Macro to convert a UEFI PCI address + segment to a PCI Segment Library PCI address
|
2011-11-28 06:19:36 +00:00
|
|
|
//
|
2016-08-08 18:20:58 +08:00
|
|
|
#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)) \
|
|
|
|
|
)
|
2011-08-29 22:17:27 +00:00
|
|
|
|
|
|
|
|
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 {
|
2015-09-15 07:49:12 +00:00
|
|
|
UINT8 *TableBase;
|
2016-08-17 16:51:55 +08:00
|
|
|
UINT32 TableLength; // Record the actual memory length
|
|
|
|
|
UINT16 TableMemoryPageNumber; // Record the page number Allocated for the table
|
2015-09-15 07:49:12 +00:00
|
|
|
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.
|
2011-08-29 22:17:27 +00:00
|
|
|
} 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
|
