Include file matches things in PI. More...

#include <ipxe/efi/Uefi/UefiMultiPhase.h>
#include <ipxe/efi/Pi/PiMultiPhase.h>

Data Structures
struct	EFI_GCD_MEMORY_SPACE_DESCRIPTOR
	EFI_GCD_MEMORY_SPACE_DESCRIPTOR. More...

struct	EFI_GCD_IO_SPACE_DESCRIPTOR
	EFI_GCD_IO_SPACE_DESCRIPTOR. More...

struct	DXE_SERVICES

Macros
#define	DXE_SERVICES_SIGNATURE 0x565245535f455844ULL

#define	DXE_SPECIFICATION_MAJOR_REVISION 1

#define	DXE_SPECIFICATION_MINOR_REVISION 70

#define	DXE_SERVICES_REVISION ((DXE_SPECIFICATION_MAJOR_REVISION<<16) \| (DXE_SPECIFICATION_MINOR_REVISION))

Typedefs
typedef EFI_STATUS(EFIAPI *	EFI_ADD_MEMORY_SPACE) (IN EFI_GCD_MEMORY_TYPE GcdMemoryType, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Capabilities)
	Adds reserved memory, system memory, or memory-mapped I/O resources to the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_ALLOCATE_MEMORY_SPACE) (IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType, IN EFI_GCD_MEMORY_TYPE GcdMemoryType, IN UINTN Alignment, IN UINT64 Length, IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress, IN EFI_HANDLE ImageHandle, IN EFI_HANDLE DeviceHandle OPTIONAL)
	Allocates nonexistent memory, reserved memory, system memory, or memorymapped I/O resources from the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_FREE_MEMORY_SPACE) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
	Frees nonexistent memory, reserved memory, system memory, or memory-mapped I/O resources from the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_REMOVE_MEMORY_SPACE) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
	Removes reserved memory, system memory, or memory-mapped I/O resources from the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_GET_MEMORY_SPACE_DESCRIPTOR) (IN EFI_PHYSICAL_ADDRESS BaseAddress, OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Descriptor)
	Retrieves the descriptor for a memory region containing a specified address. More...

typedef EFI_STATUS(EFIAPI *	EFI_SET_MEMORY_SPACE_ATTRIBUTES) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Attributes)
	Modifies the attributes for a memory region in the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_SET_MEMORY_SPACE_CAPABILITIES) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Capabilities)
	Modifies the capabilities for a memory region in the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_GET_MEMORY_SPACE_MAP) (OUT UINTN NumberOfDescriptors, OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *MemorySpaceMap)
	Returns a map of the memory resources in the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_ADD_IO_SPACE) (IN EFI_GCD_IO_TYPE GcdIoType, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
	Adds reserved I/O or I/O resources to the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_ALLOCATE_IO_SPACE) (IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType, IN EFI_GCD_IO_TYPE GcdIoType, IN UINTN Alignment, IN UINT64 Length, IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress, IN EFI_HANDLE ImageHandle, IN EFI_HANDLE DeviceHandle OPTIONAL)
	Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_FREE_IO_SPACE) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
	Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_REMOVE_IO_SPACE) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
	Removes reserved I/O or I/O resources from the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_GET_IO_SPACE_DESCRIPTOR) (IN EFI_PHYSICAL_ADDRESS BaseAddress, OUT EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor)
	Retrieves the descriptor for an I/O region containing a specified address. More...

typedef EFI_STATUS(EFIAPI *	EFI_GET_IO_SPACE_MAP) (OUT UINTN NumberOfDescriptors, OUT EFI_GCD_IO_SPACE_DESCRIPTOR *IoSpaceMap)
	Returns a map of the I/O resources in the global coherency domain of the processor. More...

typedef EFI_STATUS(EFIAPI *	EFI_DISPATCH) (VOID)
	Loads and executed DXE drivers from firmware volumes. More...

typedef EFI_STATUS(EFIAPI *	EFI_SCHEDULE) (IN EFI_HANDLE FirmwareVolumeHandle, IN CONST EFI_GUID *FileName)
	Clears the Schedule on Request (SOR) flag for a component that is stored in a firmware volume. More...

typedef EFI_STATUS(EFIAPI *	EFI_TRUST) (IN EFI_HANDLE FirmwareVolumeHandle, IN CONST EFI_GUID *FileName)
	Promotes a file stored in a firmware volume from the untrusted to the trusted state. More...

typedef EFI_STATUS(EFIAPI *	EFI_PROCESS_FIRMWARE_VOLUME) (IN CONST VOID FirmwareVolumeHeader, IN UINTN Size, OUT EFI_HANDLE FirmwareVolumeHandle)
	Creates a firmware volume handle for a firmware volume that is present in system memory. More...

typedef DXE_SERVICES	EFI_DXE_SERVICES

Enumerations
enum	EFI_GCD_MEMORY_TYPE { EfiGcdMemoryTypeNonExistent, EfiGcdMemoryTypeReserved, EfiGcdMemoryTypeSystemMemory, EfiGcdMemoryTypeMemoryMappedIo, EfiGcdMemoryTypePersistent, EfiGcdMemoryTypePersistentMemory = EfiGcdMemoryTypePersistent, EfiGcdMemoryTypeMoreReliable, EfiGcdMemoryTypeMaximum = 7 }
	Global Coherencey Domain types - Memory type. More...

enum	EFI_GCD_IO_TYPE { EfiGcdIoTypeNonExistent, EfiGcdIoTypeReserved, EfiGcdIoTypeIo, EfiGcdIoTypeMaximum }
	Global Coherencey Domain types - IO type. More...

enum	EFI_GCD_ALLOCATE_TYPE { EfiGcdAllocateAnySearchBottomUp, EfiGcdAllocateMaxAddressSearchBottomUp, EfiGcdAllocateAddress, EfiGcdAllocateAnySearchTopDown, EfiGcdAllocateMaxAddressSearchTopDown, EfiGcdMaxAllocateType }
	The type of allocation to perform. More...

Functions
	FILE_LICENCE (BSD2_PATENT)

Detailed Description

Include file matches things in PI.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:: PI Version 1.7

Definition in file PiDxeCis.h.

Macro Definition Documentation

◆ DXE_SERVICES_SIGNATURE

#define DXE_SERVICES_SIGNATURE 0x565245535f455844ULL

Definition at line 698 of file PiDxeCis.h.

◆ DXE_SPECIFICATION_MAJOR_REVISION

#define DXE_SPECIFICATION_MAJOR_REVISION 1

Definition at line 699 of file PiDxeCis.h.

◆ DXE_SPECIFICATION_MINOR_REVISION

#define DXE_SPECIFICATION_MINOR_REVISION 70

Definition at line 700 of file PiDxeCis.h.

◆ DXE_SERVICES_REVISION

#define DXE_SERVICES_REVISION ((DXE_SPECIFICATION_MAJOR_REVISION<<16) | (DXE_SPECIFICATION_MINOR_REVISION))

Definition at line 701 of file PiDxeCis.h.

Typedef Documentation

◆ EFI_ADD_MEMORY_SPACE

typedef EFI_STATUS(EFIAPI * EFI_ADD_MEMORY_SPACE) (IN EFI_GCD_MEMORY_TYPE GcdMemoryType, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Capabilities)

Adds reserved memory, system memory, or memory-mapped I/O resources to the global coherency domain of the processor.

Parameters

GcdMemoryType	The type of memory resource being added.
BaseAddress	The physical address that is the start address of the memory resource being added.
Length	The size, in bytes, of the memory resource that is being added.
Capabilities	The bit mask of attributes that the memory resource region supports.

Return values

EFI_SUCCESS	The memory resource was added to the global coherency domain of the processor.
EFI_INVALID_PARAMETER	GcdMemoryType is invalid.
EFI_INVALID_PARAMETER	Length is zero.
EFI_OUT_OF_RESOURCES	There are not enough system resources to add the memory resource to the global coherency domain of the processor.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length.
EFI_ACCESS_DENIED	One or more bytes of the memory resource range specified by BaseAddress and Length conflicts with a memory resource range that was previously added to the global coherency domain of the processor.
EFI_ACCESS_DENIED	One or more bytes of the memory resource range specified by BaseAddress and Length was allocated in a prior call to AllocateMemorySpace().

Definition at line 250 of file PiDxeCis.h.

◆ EFI_ALLOCATE_MEMORY_SPACE

typedef EFI_STATUS(EFIAPI * EFI_ALLOCATE_MEMORY_SPACE) (IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType, IN EFI_GCD_MEMORY_TYPE GcdMemoryType, IN UINTN Alignment, IN UINT64 Length, IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress, IN EFI_HANDLE ImageHandle, IN EFI_HANDLE DeviceHandle OPTIONAL)

Allocates nonexistent memory, reserved memory, system memory, or memorymapped I/O resources from the global coherency domain of the processor.

Parameters

GcdAllocateType	The type of allocation to perform.
GcdMemoryType	The type of memory resource being allocated.
Alignment	The log base 2 of the boundary that BaseAddress must be aligned on output. Align with 2^Alignment.
Length	The size in bytes of the memory resource range that is being allocated.
BaseAddress	A pointer to a physical address to allocate.
Imagehandle	The image handle of the agent that is allocating the memory resource.
DeviceHandle	The device handle for which the memory resource is being allocated.

Return values

EFI_INVALID_PARAMETER	GcdAllocateType is invalid.
EFI_INVALID_PARAMETER	GcdMemoryType is invalid.
EFI_INVALID_PARAMETER	Length is zero.
EFI_INVALID_PARAMETER	BaseAddress is NULL.
EFI_INVALID_PARAMETER	ImageHandle is NULL.
EFI_NOT_FOUND	The memory resource request could not be satisfied. No descriptor contains the desired space.
EFI_OUT_OF_RESOURCES	There are not enough system resources to allocate the memory resource from the global coherency domain of the processor.
EFI_SUCCESS	The memory resource was allocated from the global coherency domain of the processor.

Definition at line 289 of file PiDxeCis.h.

◆ EFI_FREE_MEMORY_SPACE

typedef EFI_STATUS(EFIAPI * EFI_FREE_MEMORY_SPACE) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)

Frees nonexistent memory, reserved memory, system memory, or memory-mapped I/O resources from the global coherency domain of the processor.

Parameters

BaseAddress	The physical address that is the start address of the memory resource being freed.
Length	The size in bytes of the memory resource range that is being freed.

Return values

EFI_SUCCESS	The memory resource was freed from the global coherency domain of the processor.
EFI_INVALID_PARAMETER	Length is zero.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length.
EFI_NOT_FOUND	The memory resource range specified by BaseAddress and Length was not allocated with previous calls to AllocateMemorySpace().
EFI_OUT_OF_RESOURCES	There are not enough system resources to free the memory resource from the global coherency domain of the processor.

Definition at line 319 of file PiDxeCis.h.

◆ EFI_REMOVE_MEMORY_SPACE

typedef EFI_STATUS(EFIAPI * EFI_REMOVE_MEMORY_SPACE) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)

Removes reserved memory, system memory, or memory-mapped I/O resources from the global coherency domain of the processor.

Parameters

BaseAddress	The physical address that is the start address of the memory resource being removed.
Length	The size in bytes of the memory resource that is being removed.

Return values

EFI_SUCCESS	The memory resource was removed from the global coherency domain of the processor.
EFI_INVALID_PARAMETER	Length is zero.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length.
EFI_NOT_FOUND	One or more bytes of the memory resource range specified by BaseAddress and Length was not added with previous calls to AddMemorySpace().
EFI_ACCESS_DEFINED	One or more bytes of the memory resource range specified by BaseAddress and Length has been allocated with AllocateMemorySpace().
EFI_OUT_OF_RESOURCES	There are not enough system resources to remove the memory resource from the global coherency domain of the processor.

Definition at line 347 of file PiDxeCis.h.

◆ EFI_GET_MEMORY_SPACE_DESCRIPTOR

typedef EFI_STATUS(EFIAPI * EFI_GET_MEMORY_SPACE_DESCRIPTOR) (IN EFI_PHYSICAL_ADDRESS BaseAddress, OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Descriptor)

Retrieves the descriptor for a memory region containing a specified address.

Parameters

BaseAddress	The physical address that is the start address of a memory region.
Descriptor	A pointer to a caller allocated descriptor.

Return values

EFI_SUCCESS	The descriptor for the memory resource region containing BaseAddress was returned in Descriptor.
EFI_INVALID_PARAMETER	Descriptor is NULL.
EFI_NOT_FOUND	A memory resource range containing BaseAddress was not found.

Definition at line 366 of file PiDxeCis.h.

◆ EFI_SET_MEMORY_SPACE_ATTRIBUTES

typedef EFI_STATUS(EFIAPI * EFI_SET_MEMORY_SPACE_ATTRIBUTES) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Attributes)

Modifies the attributes for a memory region in the global coherency domain of the processor.

Parameters

BaseAddress	The physical address that is the start address of a memory region.
Length	The size in bytes of the memory region.
Attributes	The bit mask of attributes to set for the memory region.

Return values

EFI_SUCCESS	The attributes were set for the memory region.
EFI_INVALID_PARAMETER	Length is zero.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the memory resource range specified by BaseAddress and Length.
EFI_UNSUPPORTED	The bit mask of attributes is not support for the memory resource range specified by BaseAddress and Length.
EFI_ACCESS_DENIED	The attributes for the memory resource range specified by BaseAddress and Length cannot be modified.
EFI_OUT_OF_RESOURCES	There are not enough system resources to modify the attributes of the memory resource range.
EFI_NOT_AVAILABLE_YET	The attributes cannot be set because CPU architectural protocol is not available yet.

Definition at line 394 of file PiDxeCis.h.

◆ EFI_SET_MEMORY_SPACE_CAPABILITIES

typedef EFI_STATUS(EFIAPI * EFI_SET_MEMORY_SPACE_CAPABILITIES) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN UINT64 Capabilities)

Modifies the capabilities for a memory region in the global coherency domain of the processor.

Parameters

BaseAddress	The physical address that is the start address of a memory region.
Length	The size in bytes of the memory region.
Capabilities	The bit mask of capabilities that the memory region supports.

Return values

EFI_SUCCESS	The capabilities were set for the memory region.
EFI_INVALID_PARAMETER	Length is zero.
EFI_UNSUPPORTED	The capabilities specified by Capabilities do not include the memory region attributes currently in use.
EFI_ACCESS_DENIED	The capabilities for the memory resource range specified by BaseAddress and Length cannot be modified.
EFI_OUT_OF_RESOURCES	There are not enough system resources to modify the capabilities of the memory resource range.

Definition at line 419 of file PiDxeCis.h.

◆ EFI_GET_MEMORY_SPACE_MAP

typedef EFI_STATUS(EFIAPI * EFI_GET_MEMORY_SPACE_MAP) (OUT UINTN *NumberOfDescriptors, OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR **MemorySpaceMap)

Returns a map of the memory resources in the global coherency domain of the processor.

Parameters

NumberOfDescriptors	A pointer to number of descriptors returned in the MemorySpaceMap buffer.
MemorySpaceMap	A pointer to the array of EFI_GCD_MEMORY_SPACE_DESCRIPTORs.

Return values

EFI_SUCCESS	The memory space map was returned in the MemorySpaceMap buffer, and the number of descriptors in MemorySpaceMap was returned in NumberOfDescriptors.
EFI_INVALID_PARAMETER	NumberOfDescriptors is NULL.
EFI_INVALID_PARAMETER	MemorySpaceMap is NULL.
EFI_OUT_OF_RESOURCES	There are not enough resources to allocate MemorySpaceMap.

Definition at line 442 of file PiDxeCis.h.

◆ EFI_ADD_IO_SPACE

typedef EFI_STATUS(EFIAPI * EFI_ADD_IO_SPACE) (IN EFI_GCD_IO_TYPE GcdIoType, IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)

Adds reserved I/O or I/O resources to the global coherency domain of the processor.

Parameters

GcdIoType	The type of I/O resource being added.
BaseAddress	The physical address that is the start address of the I/O resource being added.
Length	The size in bytes of the I/O resource that is being added.

Return values

EFI_SUCCESS	The I/O resource was added to the global coherency domain of the processor.
EFI_INVALID_PARAMETER	GcdIoType is invalid.
EFI_INVALID_PARAMETER	Length is zero.
EFI_OUT_OF_RESOURCES	There are not enough system resources to add the I/O resource to the global coherency domain of the processor.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the I/O resource range specified by BaseAddress and Length.
EFI_ACCESS_DENIED	One or more bytes of the I/O resource range specified by BaseAddress and Length conflicts with an I/O resource range that was previously added to the global coherency domain of the processor.
EFI_ACCESS_DENIED	One or more bytes of the I/O resource range specified by BaseAddress and Length was allocated in a prior call to AllocateIoSpace().

Definition at line 473 of file PiDxeCis.h.

◆ EFI_ALLOCATE_IO_SPACE

typedef EFI_STATUS(EFIAPI * EFI_ALLOCATE_IO_SPACE) (IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType, IN EFI_GCD_IO_TYPE GcdIoType, IN UINTN Alignment, IN UINT64 Length, IN OUT EFI_PHYSICAL_ADDRESS *BaseAddress, IN EFI_HANDLE ImageHandle, IN EFI_HANDLE DeviceHandle OPTIONAL)

Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency domain of the processor.

Parameters

GcdAllocateType	The type of allocation to perform.
GcdIoType	The type of I/O resource being allocated.
Alignment	The log base 2 of the boundary that BaseAddress must be aligned on output.
Length	The size in bytes of the I/O resource range that is being allocated.
BaseAddress	A pointer to a physical address.
Imagehandle	The image handle of the agent that is allocating the I/O resource.
DeviceHandle	The device handle for which the I/O resource is being allocated.

Return values

EFI_SUCCESS	The I/O resource was allocated from the global coherency domain of the processor.
EFI_INVALID_PARAMETER	GcdAllocateType is invalid.
EFI_INVALID_PARAMETER	GcdIoType is invalid.
EFI_INVALID_PARAMETER	Length is zero.
EFI_INVALID_PARAMETER	BaseAddress is NULL.
EFI_INVALID_PARAMETER	ImageHandle is NULL.
EFI_OUT_OF_RESOURCES	There are not enough system resources to allocate the I/O resource from the global coherency domain of the processor.
EFI_NOT_FOUND	The I/O resource request could not be satisfied.

Definition at line 505 of file PiDxeCis.h.

◆ EFI_FREE_IO_SPACE

typedef EFI_STATUS(EFIAPI * EFI_FREE_IO_SPACE) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)

Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency domain of the processor.

Parameters

BaseAddress	The physical address that is the start address of the I/O resource being freed.
Length	The size in bytes of the I/O resource range that is being freed.

Return values

EFI_SUCCESS	The I/O resource was freed from the global coherency domain of the processor.
EFI_INVALID_PARAMETER	Length is zero.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the I/O resource range specified by BaseAddress and Length.
EFI_NOT_FOUND	The I/O resource range specified by BaseAddress and Length was not allocated with previous calls to AllocateIoSpace().
EFI_OUT_OF_RESOURCES	There are not enough system resources to free the I/O resource from the global coherency domain of the processor.

Definition at line 535 of file PiDxeCis.h.

◆ EFI_REMOVE_IO_SPACE

typedef EFI_STATUS(EFIAPI * EFI_REMOVE_IO_SPACE) (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)

Removes reserved I/O or I/O resources from the global coherency domain of the processor.

Parameters

BaseAddress	A pointer to a physical address that is the start address of the I/O resource being removed.
Length	The size in bytes of the I/O resource that is being removed.

Return values

EFI_SUCCESS	The I/O resource was removed from the global coherency domain of the processor.
EFI_INVALID_PARAMETER	Length is zero.
EFI_UNSUPPORTED	The processor does not support one or more bytes of the I/O resource range specified by BaseAddress and Length.
EFI_NOT_FOUND	One or more bytes of the I/O resource range specified by BaseAddress and Length was not added with previous calls to AddIoSpace().
EFI_ACCESS_DENIED	One or more bytes of the I/O resource range specified by BaseAddress and Length has been allocated with AllocateIoSpace().
EFI_OUT_OF_RESOURCES	There are not enough system resources to remove the I/O resource from the global coherency domain of the processor.

Definition at line 565 of file PiDxeCis.h.

◆ EFI_GET_IO_SPACE_DESCRIPTOR

typedef EFI_STATUS(EFIAPI * EFI_GET_IO_SPACE_DESCRIPTOR) (IN EFI_PHYSICAL_ADDRESS BaseAddress, OUT EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor)

Retrieves the descriptor for an I/O region containing a specified address.

Parameters

BaseAddress	The physical address that is the start address of an I/O region.
Descriptor	A pointer to a caller allocated descriptor.

Return values

EFI_SUCCESS	The descriptor for the I/O resource region containing BaseAddress was returned in Descriptor.
EFI_INVALID_PARAMETER	Descriptor is NULL.
EFI_NOT_FOUND	An I/O resource range containing BaseAddress was not found.

Definition at line 584 of file PiDxeCis.h.

◆ EFI_GET_IO_SPACE_MAP

typedef EFI_STATUS(EFIAPI * EFI_GET_IO_SPACE_MAP) (OUT UINTN *NumberOfDescriptors, OUT EFI_GCD_IO_SPACE_DESCRIPTOR **IoSpaceMap)

Returns a map of the I/O resources in the global coherency domain of the processor.

Parameters

NumberOfDescriptors	A pointer to number of descriptors returned in the IoSpaceMap buffer.
MemorySpaceMap	A pointer to the array of EFI_GCD_IO_SPACE_DESCRIPTORs.

Return values

EFI_SUCCESS	The I/O space map was returned in the IoSpaceMap buffer, and the number of descriptors in IoSpaceMap was returned in NumberOfDescriptors.
EFI_INVALID_PARAMETER	NumberOfDescriptors is NULL.
EFI_INVALID_PARAMETER	IoSpaceMap is NULL.
EFI_OUT_OF_RESOURCES	There are not enough resources to allocate IoSpaceMap.

Definition at line 606 of file PiDxeCis.h.

◆ EFI_DISPATCH

typedef EFI_STATUS(EFIAPI * EFI_DISPATCH) (VOID)

Loads and executed DXE drivers from firmware volumes.

The Dispatch() function searches for DXE drivers in firmware volumes that have been installed since the last time the Dispatch() service was called. It then evaluates the dependency expressions of all the DXE drivers and loads and executes those DXE drivers whose dependency expression evaluate to TRUE. This service must interact with the Security Architectural Protocol to authenticate DXE drivers before they are executed. This process is continued until no more DXE drivers can be executed.

Return values

EFI_SUCCESS	One or more DXE driver were dispatched.
EFI_NOT_FOUND	No DXE drivers were dispatched.
EFI_ALREADY_STARTED	An attempt is being made to start the DXE Dispatcher recursively. Thus, no action was taken.

Definition at line 629 of file PiDxeCis.h.

◆ EFI_SCHEDULE

typedef EFI_STATUS(EFIAPI * EFI_SCHEDULE) (IN EFI_HANDLE FirmwareVolumeHandle, IN CONST EFI_GUID *FileName)

Clears the Schedule on Request (SOR) flag for a component that is stored in a firmware volume.

Parameters

FirmwareVolumeHandle	The handle of the firmware volume that contains the file specified by FileName.
FileName	A pointer to the name of the file in a firmware volume.

Return values

EFI_SUCCESS	The DXE driver was found and its SOR bit was cleared.
EFI_NOT_FOUND	The DXE driver does not exist, or the DXE driver exists and its SOR bit is not set.

Definition at line 646 of file PiDxeCis.h.

◆ EFI_TRUST

typedef EFI_STATUS(EFIAPI * EFI_TRUST) (IN EFI_HANDLE FirmwareVolumeHandle, IN CONST EFI_GUID *FileName)

Promotes a file stored in a firmware volume from the untrusted to the trusted state.

Parameters

FirmwareVolumeHandle	The handle of the firmware volume that contains the file specified by FileName.
DriverName	A pointer to the name of the file in a firmware volume.

Returns: Status of promoting FFS from untrusted to trusted state.

Return values

EFI_NOT_FOUND The file was not found in the untrusted state.

Definition at line 664 of file PiDxeCis.h.

◆ EFI_PROCESS_FIRMWARE_VOLUME

typedef EFI_STATUS(EFIAPI * EFI_PROCESS_FIRMWARE_VOLUME) (IN CONST VOID *FirmwareVolumeHeader, IN UINTN Size, OUT EFI_HANDLE *FirmwareVolumeHandle)

Creates a firmware volume handle for a firmware volume that is present in system memory.

Parameters

FirmwareVolumeHeader	A pointer to the header of the firmware volume.
Size	The size, in bytes, of the firmware volume.
FirmwareVolumeHandle	On output, a pointer to the created handle.

Return values

EFI_SUCCESS	The EFI_FIRMWARE_VOLUME_PROTOCOL and EFI_DEVICE_PATH_PROTOCOL were installed onto FirmwareVolumeHandle for the firmware volume described by FirmwareVolumeHeader and Size.
EFI_VOLUME_CORRUPTED	The firmware volume described by FirmwareVolumeHeader and Size is corrupted.
EFI_OUT_OF_RESOURCES	There are not enough system resources available to produce the EFI_FIRMWARE_VOLUME_PROTOCOL and EFI_DEVICE_PATH_PROTOCOL for the firmware volume described by FirmwareVolumeHeader and Size.

Definition at line 689 of file PiDxeCis.h.

◆ EFI_DXE_SERVICES

typedef DXE_SERVICES EFI_DXE_SERVICES

Definition at line 743 of file PiDxeCis.h.

Enumeration Type Documentation

◆ EFI_GCD_MEMORY_TYPE

enum EFI_GCD_MEMORY_TYPE

Global Coherencey Domain types - Memory type.

Enumerator
EfiGcdMemoryTypeNonExistent	A memory region that is visible to the boot processor. However, there are no system components that are currently decoding this memory region.
EfiGcdMemoryTypeReserved	A memory region that is visible to the boot processor. This memory region is being decoded by a system component, but the memory region is not considered to be either system memory or memory-mapped I/O.
EfiGcdMemoryTypeSystemMemory	A memory region that is visible to the boot processor. A memory controller is currently decoding this memory region and the memory controller is producing a tested system memory region that is available to the memory services.
EfiGcdMemoryTypeMemoryMappedIo	A memory region that is visible to the boot processor. This memory region is currently being decoded by a component as memory-mapped I/O that can be used to access I/O devices in the platform.
EfiGcdMemoryTypePersistent	A memory region that is visible to the boot processor. This memory supports byte-addressable non-volatility.
EfiGcdMemoryTypePersistentMemory
EfiGcdMemoryTypeMoreReliable	A memory region that provides higher reliability relative to other memory in the system. If all memory has the same reliability, then this bit is not used.
EfiGcdMemoryTypeMaximum

Definition at line 23 of file PiDxeCis.h.

              {
   ///
   /// A memory region that is visible to the boot processor. However, there are no system
   /// components that are currently decoding this memory region.
   ///
   EfiGcdMemoryTypeNonExistent,
   ///
   /// A memory region that is visible to the boot processor. This memory region is being
   /// decoded by a system component, but the memory region is not considered to be either
   /// system memory or memory-mapped I/O.
   ///
   EfiGcdMemoryTypeReserved,
   ///
   /// A memory region that is visible to the boot processor. A memory controller is
   /// currently decoding this memory region and the memory controller is producing a
   /// tested system memory region that is available to the memory services.
   ///
   EfiGcdMemoryTypeSystemMemory,
   ///
   /// A memory region that is visible to the boot processor. This memory region is
   /// currently being decoded by a component as memory-mapped I/O that can be used to
   /// access I/O devices in the platform.
   ///
   EfiGcdMemoryTypeMemoryMappedIo,
   ///
   /// A memory region that is visible to the boot processor.
   /// This memory supports byte-addressable non-volatility.
   ///
   EfiGcdMemoryTypePersistent,
   //
   // Keep original one for the compatibility.
   //
   EfiGcdMemoryTypePersistentMemory = EfiGcdMemoryTypePersistent,
   ///
   /// A memory region that provides higher reliability relative to other memory in the
   /// system. If all memory has the same reliability, then this bit is not used.
   ///
   EfiGcdMemoryTypeMoreReliable,
   // ///
   // /// A memory region that describes system memory that has not been accepted
   // /// by a corresponding call to the underlying isolation architecture.
   // ///
   // /// Please be noted:
   // /// EfiGcdMemoryTypeUnaccepted is defined in PrePiDxeCis.h because it has not been
   // /// defined in PI spec.
   // EfiGcdMemoryTypeUnaccepted,
   EfiGcdMemoryTypeMaximum = 7
 } EFI_GCD_MEMORY_TYPE;

◆ EFI_GCD_IO_TYPE

enum EFI_GCD_IO_TYPE

Global Coherencey Domain types - IO type.

Enumerator
EfiGcdIoTypeNonExistent	An I/O region that is visible to the boot processor. However, there are no system components that are currently decoding this I/O region.
EfiGcdIoTypeReserved	An I/O region that is visible to the boot processor. This I/O region is currently being decoded by a system component, but the I/O region cannot be used to access I/O devices.
EfiGcdIoTypeIo	An I/O region that is visible to the boot processor. This I/O region is currently being decoded by a system component that is producing I/O ports that can be used to access I/O devices.
EfiGcdIoTypeMaximum

Definition at line 75 of file PiDxeCis.h.

              {
   ///
   /// An I/O region that is visible to the boot processor. However, there are no system
   /// components that are currently decoding this I/O region.
   ///
   EfiGcdIoTypeNonExistent,
   ///
   /// An I/O region that is visible to the boot processor. This I/O region is currently being
   /// decoded by a system component, but the I/O region cannot be used to access I/O devices.
   ///
   EfiGcdIoTypeReserved,
   ///
   /// An I/O region that is visible to the boot processor. This I/O region is currently being
   /// decoded by a system component that is producing I/O ports that can be used to access I/O devices.
   ///
   EfiGcdIoTypeIo,
   EfiGcdIoTypeMaximum
 } EFI_GCD_IO_TYPE;

◆ EFI_GCD_ALLOCATE_TYPE

enum EFI_GCD_ALLOCATE_TYPE

The type of allocation to perform.

Enumerator
EfiGcdAllocateAnySearchBottomUp	The GCD memory space map is searched from the lowest address up to the highest address looking for unallocated memory ranges.
EfiGcdAllocateMaxAddressSearchBottomUp	The GCD memory space map is searched from the lowest address up to the specified MaxAddress looking for unallocated memory ranges.
EfiGcdAllocateAddress	The GCD memory space map is checked to see if the memory range starting at the specified Address is available.
EfiGcdAllocateAnySearchTopDown	The GCD memory space map is searched from the highest address down to the lowest address looking for unallocated memory ranges.
EfiGcdAllocateMaxAddressSearchTopDown	The GCD memory space map is searched from the specified MaxAddress down to the lowest address looking for unallocated memory ranges.
EfiGcdMaxAllocateType

Definition at line 97 of file PiDxeCis.h.

              {
   ///
   /// The GCD memory space map is searched from the lowest address up to the highest address
   /// looking for unallocated memory ranges.
   ///
   EfiGcdAllocateAnySearchBottomUp,
   ///
   /// The GCD memory space map is searched from the lowest address up
   /// to the specified MaxAddress looking for unallocated memory ranges.
   ///
   EfiGcdAllocateMaxAddressSearchBottomUp,
   ///
   /// The GCD memory space map is checked to see if the memory range starting
   /// at the specified Address is available.
   ///
   EfiGcdAllocateAddress,
   ///
   /// The GCD memory space map is searched from the highest address down to the lowest address
   /// looking for unallocated memory ranges.
   ///
   EfiGcdAllocateAnySearchTopDown,
   ///
   /// The GCD memory space map is searched from the specified MaxAddress
   /// down to the lowest address looking for unallocated memory ranges.
   ///
   EfiGcdAllocateMaxAddressSearchTopDown,
   EfiGcdMaxAllocateType
 } EFI_GCD_ALLOCATE_TYPE;

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT )

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ DXE_SERVICES_SIGNATURE

◆ DXE_SPECIFICATION_MAJOR_REVISION

◆ DXE_SPECIFICATION_MINOR_REVISION

◆ DXE_SERVICES_REVISION

Typedef Documentation

◆ EFI_ADD_MEMORY_SPACE

◆ EFI_ALLOCATE_MEMORY_SPACE

◆ EFI_FREE_MEMORY_SPACE

◆ EFI_REMOVE_MEMORY_SPACE

◆ EFI_GET_MEMORY_SPACE_DESCRIPTOR

◆ EFI_SET_MEMORY_SPACE_ATTRIBUTES

◆ EFI_SET_MEMORY_SPACE_CAPABILITIES

◆ EFI_GET_MEMORY_SPACE_MAP

◆ EFI_ADD_IO_SPACE

◆ EFI_ALLOCATE_IO_SPACE

◆ EFI_FREE_IO_SPACE

◆ EFI_REMOVE_IO_SPACE

◆ EFI_GET_IO_SPACE_DESCRIPTOR

◆ EFI_GET_IO_SPACE_MAP

◆ EFI_DISPATCH

◆ EFI_SCHEDULE

◆ EFI_TRUST

◆ EFI_PROCESS_FIRMWARE_VOLUME

◆ EFI_DXE_SERVICES

Enumeration Type Documentation

◆ EFI_GCD_MEMORY_TYPE

◆ EFI_GCD_IO_TYPE

◆ EFI_GCD_ALLOCATE_TYPE

Function Documentation

◆ FILE_LICENCE()