#include <PiPei.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DebugLib.h>
#include <Library/PeCoffLib.h>
#include <Library/HobLib.h>
#include <Library/PcdLib.h>
#include <Guid/MemoryAllocationHob.h>
#include <Library/IoLib.h>
#include <Library/BlParseLib.h>
#include <Library/PlatformSupportLib.h>
#include <Library/CpuLib.h>
#include <IndustryStandard/Acpi.h>
#include <IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h>
#include <Guid/SerialPortInfoGuid.h>
#include <Guid/MemoryMapInfoGuid.h>
#include <Guid/AcpiBoardInfoGuid.h>
#include <Guid/GraphicsInfoHob.h>
#include <UniversalPayload/SmbiosTable.h>
#include <UniversalPayload/AcpiTable.h>
#include <UniversalPayload/UniversalPayload.h>
#include <UniversalPayload/ExtraData.h>
#include <UniversalPayload/SerialPortInfo.h>
#include <UniversalPayload/DeviceTree.h>
#include <Guid/PcdDataBaseSignatureGuid.h>

Macros
#define	LEGACY_8259_MASK_REGISTER_MASTER 0x21

#define	LEGACY_8259_MASK_REGISTER_SLAVE 0xA1

#define	GET_OCCUPIED_SIZE(ActualSize, Alignment) ((ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1)))

#define	E820_RAM 1

#define	E820_RESERVED 2

#define	E820_ACPI 3

#define	E820_NVS 4

#define	E820_UNUSABLE 5

#define	E820_DISABLED 6

#define	E820_PMEM 7

#define	E820_UNDEFINED 8

Functions
VOID *EFIAPI	CreateHob (IN UINT16 HobType, IN UINT16 HobLength)

VOID EFIAPI	UpdateStackHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)

EFI_HOB_HANDOFF_INFO_TABLE *EFIAPI	HobConstructor (IN VOID EfiMemoryBottom, IN VOID EfiMemoryTop, IN VOID EfiFreeMemoryBottom, IN VOID EfiFreeMemoryTop)

EFI_STATUS	LoadDxeCore (OUT PHYSICAL_ADDRESS *DxeCoreEntryPoint)

EFI_STATUS	UniversalLoadDxeCore (IN EFI_FIRMWARE_VOLUME_HEADER DxeFv, OUT PHYSICAL_ADDRESS DxeCoreEntryPoint)

UINT64 EFIAPI	FdtNodeParser (IN VOID *FdtBase)

UINTN EFIAPI	CustomFdtNodeParser (IN VOID FdtBase, IN VOID HostList)

VOID	HandOffToDxeCore (IN EFI_PHYSICAL_ADDRESS DxeCoreEntryPoint, IN EFI_PEI_HOB_POINTERS HobList)

EFI_STATUS	FixUpPcdDatabase (IN EFI_FIRMWARE_VOLUME_HEADER *DxeFv)

EFI_STATUS	FileFindSection (IN EFI_FFS_FILE_HEADER FileHeader, IN EFI_SECTION_TYPE SectionType, OUT VOID *SectionData)

EFI_STATUS	FvFindFileByTypeGuid (IN EFI_FIRMWARE_VOLUME_HEADER FvHeader, IN EFI_FV_FILETYPE FileType, IN EFI_GUID Guid OPTIONAL, OUT EFI_FFS_FILE_HEADER **FileHeader)

ACPI_BOARD_INFO *	BuildHobFromAcpi (IN UINT64 AcpiTableBase)

VOID *EFIAPI	PayloadAllocatePages (IN UINTN Pages, IN EFI_MEMORY_TYPE MemoryType)

EFI_STATUS EFIAPI	FitUplEntryPoint (IN UINTN BootloaderParameter)

EFI_STATUS EFIAPI	UplEntryPoint (IN UINTN BootloaderParameter)

Detailed Description

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

Definition in file UefiPayloadEntry.h.

Macro Definition Documentation

◆ E820_ACPI

#define E820_ACPI 3

Definition at line 48 of file UefiPayloadEntry.h.

◆ E820_DISABLED

#define E820_DISABLED 6

Definition at line 51 of file UefiPayloadEntry.h.

◆ E820_NVS

#define E820_NVS 4

Definition at line 49 of file UefiPayloadEntry.h.

◆ E820_PMEM

#define E820_PMEM 7

Definition at line 52 of file UefiPayloadEntry.h.

◆ E820_RAM

#define E820_RAM 1

Definition at line 46 of file UefiPayloadEntry.h.

◆ E820_RESERVED

#define E820_RESERVED 2

Definition at line 47 of file UefiPayloadEntry.h.

◆ E820_UNDEFINED

#define E820_UNDEFINED 8

Definition at line 53 of file UefiPayloadEntry.h.

◆ E820_UNUSABLE

#define E820_UNUSABLE 5

Definition at line 50 of file UefiPayloadEntry.h.

◆ GET_OCCUPIED_SIZE

#define GET_OCCUPIED_SIZE	(	ActualSize,
		Alignment
	)	((ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1)))

Definition at line 43 of file UefiPayloadEntry.h.

◆ LEGACY_8259_MASK_REGISTER_MASTER

#define LEGACY_8259_MASK_REGISTER_MASTER 0x21

Definition at line 41 of file UefiPayloadEntry.h.

◆ LEGACY_8259_MASK_REGISTER_SLAVE

#define LEGACY_8259_MASK_REGISTER_SLAVE 0xA1

Definition at line 42 of file UefiPayloadEntry.h.

Function Documentation

◆ BuildHobFromAcpi()

ACPI_BOARD_INFO * BuildHobFromAcpi ( IN UINT64 AcpiTableBase )

Build ACPI board info HOB using infomation from ACPI table

Parameters

AcpiTableBase ACPI table start address in memory

Return values

A	pointer to ACPI board HOB ACPI_BOARD_INFO. Null if build HOB failure.

Definition at line 139 of file AcpiTable.c.

◆ CreateHob()

VOID *EFIAPI CreateHob	(	IN UINT16	HobType,
		IN UINT16	HobLength
	)

Add a new HOB to the HOB List.

Parameters

HobType	Type of the new HOB.
HobLength	Length of the new HOB to allocate.

Returns: NULL if there is no space to create a hob.; The address point to the new created hob.

This service enables PEIMs to create various types of HOBs.

Parameters

Type	The type of HOB to be installed.
Length	The length of the HOB to be added.

Return values

!NULL	The HOB was successfully created.
NULL	There is no additional space for HOB creation.

Definition at line 101 of file Hob.c.

◆ CustomFdtNodeParser()

UINTN EFIAPI CustomFdtNodeParser	(	IN VOID *	Fdt,
		IN VOID *	HobList
	)

It will Parse FDT -custom node based on information.

Parameters

[in]	FdtBase	The starting memory address of FdtBase
[in]	HostList	The starting memory address of New Hob list.

It will Parse FDT -custom node based on information from bootloaders.

Parameters

[in]	FdtBase	The starting memory address of FdtBase
[in]	HobList	The starting memory address of New Hob list.

It will Parse FDT -custom node based on information from bootloaders.

Parameters

[in]	FdtBase	The starting memory address of FdtBase.
[in]	HobList	The starting memory address of New Hob list.

Return values

HobList The base address of Hoblist.

Definition at line 120 of file CustomFdtNodeParserLib.c.

◆ FdtNodeParser()

UINT64 EFIAPI FdtNodeParser ( IN VOID * FdtBase )

It will Parse FDT -node based on information.

Parameters

[in] FdtBase The starting memory address of FdtBase

Return values

HobList The base address of Hoblist.

It will Parse FDT -node based on information from bootloaders.

Parameters

[in] FdtBase The starting memory address of FdtBase

Return values

HobList The base address of Hoblist.

Definition at line 1002 of file FdtParserLib.c.

◆ FileFindSection()

EFI_STATUS FileFindSection	(	IN EFI_FFS_FILE_HEADER *	FileHeader,
		IN EFI_SECTION_TYPE	SectionType,
		OUT VOID **	SectionData
	)

This function searchs a given section type within a valid FFS file.

Parameters

FileHeader	A pointer to the file header that contains the set of sections to be searched.
SearchType	The value of the section type to search.
SectionData	A pointer to the discovered section, if successful.

Return values

EFI_SUCCESS	The section was found.
EFI_NOT_FOUND	The section was not found.

This function searchs a given section type within a valid FFS file.

Parameters

FileHeader	A pointer to the file header that contains the set of sections to be searched.
SectionType	The value of the section type to search.
SectionData	A pointer to the discovered section, if successful.

Return values

EFI_SUCCESS	The section was found.
EFI_NOT_FOUND	The section was not found.

Definition at line 201 of file LoadDxeCore.c.

◆ FitUplEntryPoint()

EFI_STATUS EFIAPI FitUplEntryPoint ( IN UINTN BootloaderParameter )

Entry point to the C language phase of UEFI payload.

Parameters

[in] FdtPrt The starting address of FDT .

Return values

It	will not return if SUCCESS, and return error when passing bootloader parameter.

Entry point to the C language phase of UEFI payload.

Parameters

[in] BootloaderParameter The starting address of FDT .

Return values

It	will not return if SUCCESS, and return error when passing bootloader parameter.

Definition at line 495 of file FitUniversalPayloadEntry.c.

◆ FixUpPcdDatabase()

EFI_STATUS FixUpPcdDatabase ( IN EFI_FIRMWARE_VOLUME_HEADER * DxeFv )

Some bootloader may pass a pcd database, and UPL also contain a PCD database. Dxe PCD driver has the assumption that the two PCD database can be catenated and the local token number should be successive. This function will fix up the UPL PCD database to meet that assumption.

Parameters

[in] DxeFv The FV where to find the Universal PCD database.

Return values

EFI_SUCCESS	If it completed successfully.
other	Failed to fix up.

Definition at line 165 of file FitUniversalPayloadEntry.c.

◆ FvFindFileByTypeGuid()

EFI_STATUS FvFindFileByTypeGuid	(	IN EFI_FIRMWARE_VOLUME_HEADER *	FvHeader,
		IN EFI_FV_FILETYPE	FileType,
		IN EFI_GUID *Guid	OPTIONAL,
		OUT EFI_FFS_FILE_HEADER **	FileHeader
	)

This function searchs a given file type with a given Guid within a valid FV. If input Guid is NULL, will locate the first section having the given file type

Parameters

FvHeader	A pointer to firmware volume header that contains the set of files to be searched.
FileType	File type to be searched.
Guid	Will ignore if it is NULL.
FileHeader	A pointer to the discovered file, if successful.

Return values

EFI_SUCCESS	Successfully found FileType
EFI_NOT_FOUND	File type can't be found.

Definition at line 131 of file LoadDxeCore.c.

◆ HandOffToDxeCore()

VOID HandOffToDxeCore	(	IN EFI_PHYSICAL_ADDRESS	DxeCoreEntryPoint,
		IN EFI_PEI_HOB_POINTERS	HobList
	)

Transfers control to DxeCore.

This function performs a CPU architecture specific operations to execute the entry point of DxeCore with the parameters of HobList.

Parameters

DxeCoreEntryPoint	The entry point of DxeCore.
HobList	The start of HobList passed to DxeCore.

Transfers control to DxeCore.

This function performs a CPU architecture specific operations to execute the entry point of DxeCore with the parameters of HobList. It also installs EFI_END_OF_PEI_PPI to signal the end of PEI phase.

Parameters

DxeCoreEntryPoint	The entry point of DxeCore.
HobList	The start of HobList passed to DxeCore.

Definition at line 26 of file DxeHandoff.c.

◆ HobConstructor()

EFI_HOB_HANDOFF_INFO_TABLE *EFIAPI HobConstructor	(	IN VOID *	EfiMemoryBottom,
		IN VOID *	EfiMemoryTop,
		IN VOID *	EfiFreeMemoryBottom,
		IN VOID *	EfiFreeMemoryTop
	)

Build a Handoff Information Table HOB

This function initialize a HOB region from EfiMemoryBegin to EfiMemoryTop. And EfiFreeMemoryBottom and EfiFreeMemoryTop should be inside the HOB region.

Parameters

[in]	EfiMemoryBottom	Total memory start address
[in]	EfiMemoryTop	Total memory end address.
[in]	EfiFreeMemoryBottom	Free memory start address
[in]	EfiFreeMemoryTop	Free memory end address.

Returns: The pointer to the handoff HOB table.

Definition at line 54 of file Hob.c.

◆ LoadDxeCore()

EFI_STATUS LoadDxeCore ( OUT PHYSICAL_ADDRESS * DxeCoreEntryPoint )

Find DXE core from FV and build DXE core HOBs.

Parameters

[out] DxeCoreEntryPoint DXE core entry point

Return values

EFI_SUCCESS	If it completed successfully.
EFI_NOT_FOUND	If it failed to load DXE FV.

Definition at line 259 of file LoadDxeCore.c.

◆ PayloadAllocatePages()

VOID *EFIAPI PayloadAllocatePages	(	IN UINTN	Pages,
		IN EFI_MEMORY_TYPE	MemoryType
	)

Allocates one or more pages .

Allocates the number of pages of MemoryType and returns a pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned. If there is not enough memory availble to satisfy the request, then NULL is returned.

Parameters

Pages	The number of 4 KB pages to allocate.
MemoryType	The Memorytype

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Allocates one or more pages of type EfiBootServicesData.

Allocates the number of pages of MemoryType and returns a pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned. If there is not enough memory availble to satisfy the request, then NULL is returned.

Parameters

Pages	The number of 4 KB pages to allocate.
MemoryType	The MemoryType

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Definition at line 28 of file MemoryAllocation.c.

◆ UniversalLoadDxeCore()

EFI_STATUS UniversalLoadDxeCore	(	IN EFI_FIRMWARE_VOLUME_HEADER *	DxeFv,
		OUT PHYSICAL_ADDRESS *	DxeCoreEntryPoint
	)

Find DXE core from FV and build DXE core HOBs.

Parameters

[in]	DxeFv	The FV where to find the DXE core.
[out]	DxeCoreEntryPoint	DXE core entry point

Return values

EFI_SUCCESS	If it completed successfully.
EFI_NOT_FOUND	If it failed to load DXE FV.

Definition at line 327 of file LoadDxeCore.c.

◆ UpdateStackHob()

VOID EFIAPI UpdateStackHob	(	IN EFI_PHYSICAL_ADDRESS	BaseAddress,
		IN UINT64	Length
	)

Update the Stack Hob if the stack has been moved

Parameters

BaseAddress	The 64 bit physical address of the Stack.
Length	The length of the stack in bytes.

Updates the Stack HOB passed to DXE phase.

This function traverses the whole HOB list and update the stack HOB to reflect the real stack that is used by DXE core.

Parameters

BaseAddress	The lower address of stack used by DxeCore.
Length	The length of stack used by DxeCore.

Definition at line 731 of file Hob.c.

◆ UplEntryPoint()

EFI_STATUS EFIAPI UplEntryPoint ( IN UINTN BootloaderParameter )

Entry point to the C language phase of UEFI payload.

Parameters

[in] BootloaderParameter The starting address of bootloader parameter block.

Return values

It	will not return if SUCCESS, and return error when passing bootloader parameter.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ E820_ACPI

◆ E820_DISABLED

◆ E820_NVS

◆ E820_PMEM

◆ E820_RAM

◆ E820_RESERVED

◆ E820_UNDEFINED

◆ E820_UNUSABLE

◆ GET_OCCUPIED_SIZE

◆ LEGACY_8259_MASK_REGISTER_MASTER

◆ LEGACY_8259_MASK_REGISTER_SLAVE

Function Documentation

◆ BuildHobFromAcpi()

◆ CreateHob()

◆ CustomFdtNodeParser()

◆ FdtNodeParser()

◆ FileFindSection()

◆ FitUplEntryPoint()

◆ FixUpPcdDatabase()

◆ FvFindFileByTypeGuid()

◆ HandOffToDxeCore()

◆ HobConstructor()

◆ LoadDxeCore()

◆ PayloadAllocatePages()

◆ UniversalLoadDxeCore()

◆ UpdateStackHob()

◆ UplEntryPoint()