4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Include file matches things in PI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PI Version 1.2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Global Coherencey Domain types - Memory type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A memory region that is visible to the boot processor. However, there are no system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// components that are currently decoding this memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A memory region that is visible to the boot processor. This memory region is being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// decoded by a system component, but the memory region is not considered to be either
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// system memory or memory-mapped I/O.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A memory region that is visible to the boot processor. A memory controller is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// currently decoding this memory region and the memory controller is producing a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// tested system memory region that is available to the memory services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A memory region that is visible to the boot processor. This memory region is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// currently being decoded by a component as memory-mapped I/O that can be used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// access I/O devices in the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Global Coherencey Domain types - IO type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An I/O region that is visible to the boot processor. However, there are no system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// components that are currently decoding this I/O region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An I/O region that is visible to the boot processor. This I/O region is currently being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// decoded by a system component, but the I/O region cannot be used to access I/O devices.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An I/O region that is visible to the boot processor. This I/O region is currently being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// decoded by a system component that is producing I/O ports that can be used to access I/O devices.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The type of allocation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The GCD memory space map is searched from the lowest address up to the highest address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// looking for unallocated memory ranges.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The GCD memory space map is searched from the lowest address up
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to the specified MaxAddress looking for unallocated memory ranges.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The GCD memory space map is checked to see if the memory range starting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// at the specified Address is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The GCD memory space map is searched from the highest address down to the lowest address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// looking for unallocated memory ranges.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The GCD memory space map is searched from the specified MaxAddress
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// down to the lowest address looking for unallocated memory ranges.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_GCD_MEMORY_SPACE_DESCRIPTOR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The physical address of the first byte in the memory region. Type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// description in the UEFI 2.0 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of bytes in the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The bit mask of attributes that the memory region is capable of supporting. The bit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// mask of available attributes is defined in the GetMemoryMap() function description
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// in the UEFI 2.0 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The bit mask of attributes that the memory region is currently using. The bit mask of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// available attributes is defined in GetMemoryMap().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Type of the memory region. Type EFI_GCD_MEMORY_TYPE is defined in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AddMemorySpace() function description.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The image handle of the agent that allocated the memory resource described by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PhysicalStart and NumberOfBytes. If this field is NULL, then the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// resource is not currently allocated. Type EFI_HANDLE is defined in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// InstallProtocolInterface() in the UEFI 2.0 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The device handle for which the memory resource has been allocated. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ImageHandle is NULL, then the memory resource is not currently allocated. If this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// field is NULL, then the memory resource is not associated with a device that is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// described by a device handle. Type EFI_HANDLE is defined in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// InstallProtocolInterface() in the UEFI 2.0 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_GCD_IO_SPACE_DESCRIPTOR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Physical address of the first byte in the I/O region. Type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// description in the UEFI 2.0 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of bytes in the I/O region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Type of the I/O region. Type EFI_GCD_IO_TYPE is defined in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AddIoSpace() function description.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The image handle of the agent that allocated the I/O resource described by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PhysicalStart and NumberOfBytes. If this field is NULL, then the I/O
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// resource is not currently allocated. Type EFI_HANDLE is defined in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// InstallProtocolInterface() in the UEFI 2.0 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The device handle for which the I/O resource has been allocated. If ImageHandle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is NULL, then the I/O resource is not currently allocated. If this field is NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the I/O resource is not associated with a device that is described by a device handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// 2.0 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds reserved memory, system memory, or memory-mapped I/O resources to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GcdMemoryType The type of memory resource being added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the memory resource being added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size, in bytes, of the memory resource that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is being added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Capabilities The bit mask of attributes that the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource region supports.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The memory resource was added to the global
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER GcdMemoryType is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to add
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the memory resource to the global coherency
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor does not support one or more bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the memory resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more bytes of the memory resource range
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by BaseAddress and Length conflicts
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with a memory resource range that was previously
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync added to the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more bytes of the memory resource range
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by BaseAddress and Length was allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in a prior call to AllocateMemorySpace().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates nonexistent memory, reserved memory, system memory, or memorymapped
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync I/O resources from the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GcdAllocateType The type of allocation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GcdMemoryType The type of memory resource being allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Alignment The log base 2 of the boundary that BaseAddress must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be aligned on output. Align with 2^Alignment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the memory resource range that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is being allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress A pointer to a physical address to allocate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Imagehandle The image handle of the agent that is allocating
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the memory resource.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceHandle The device handle for which the memory resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is being allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER GcdAllocateType is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER GcdMemoryType is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER BaseAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ImageHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The memory resource request could not be satisfied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync No descriptor contains the desired space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to allocate the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource from the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The memory resource was allocated from the global coherency
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Frees nonexistent memory, reserved memory, system memory, or memory-mapped
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync I/O resources from the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address of the memory resource being freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the memory resource range that is being freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The memory resource was freed from the global coherency domain of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The memory resource range specified by BaseAddress and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length was not allocated with previous calls to AllocateMemorySpace().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to free the memory resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Removes reserved memory, system memory, or memory-mapped I/O resources from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address of the memory resource being removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the memory resource that is being removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The memory resource was removed from the global coherency
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND One or more bytes of the memory resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length was not added with previous calls to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AddMemorySpace().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DEFINED One or more bytes of the memory resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length has been allocated with AllocateMemorySpace().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to remove the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource from the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the descriptor for a memory region containing a specified address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address of a memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Descriptor A pointer to a caller allocated descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The descriptor for the memory resource region containing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress was returned in Descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Descriptor is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND A memory resource range containing BaseAddress was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Modifies the attributes for a memory region in the global coherency domain of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address of a memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Attributes The bit mask of attributes to set for the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The attributes were set for the memory region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The bit mask of attributes is not support for the memory resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DEFINED The attributes for the memory resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length cannot be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the memory resource range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_AVAILABLE_YET The attributes cannot be set because CPU architectural protocol is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not available yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns a map of the memory resources in the global coherency domain of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumberOfDescriptors A pointer to number of descriptors returned in the MemorySpaceMap buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemorySpaceMap A pointer to the array of EFI_GCD_MEMORY_SPACE_DESCRIPTORs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The memory space map was returned in the MemorySpaceMap
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer, and the number of descriptors in MemorySpaceMap was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned in NumberOfDescriptors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER NumberOfDescriptors is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER MemorySpaceMap is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate MemorySpaceMap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR **MemorySpaceMap
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds reserved I/O or I/O resources to the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GcdIoType The type of I/O resource being added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address of the I/O resource being added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the I/O resource that is being added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The I/O resource was added to the global coherency domain of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER GcdIoType is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to add the I/O resource to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the I/O
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more bytes of the I/O resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length conflicts with an I/O resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync range that was previously added to the global coherency domain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more bytes of the I/O resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length was allocated in a prior call to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AllocateIoSpace().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocates nonexistent I/O, reserved I/O, or I/O resources from the global coherency
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GcdAllocateType The type of allocation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GcdIoType The type of I/O resource being allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Alignment The log base 2 of the boundary that BaseAddress must be aligned on output.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the I/O resource range that is being allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress A pointer to a physical address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Imagehandle The image handle of the agent that is allocating the I/O resource.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceHandle The device handle for which the I/O resource is being allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The I/O resource was allocated from the global coherency domain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER GcdAllocateType is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER GcdIoType is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER BaseAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER ImageHandle is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to allocate the I/O
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource from the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The I/O resource request could not be satisfied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Frees nonexistent I/O, reserved I/O, or I/O resources from the global coherency
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address of the I/O resource being freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the I/O resource range that is being freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The I/O resource was freed from the global coherency domain of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the I/O resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The I/O resource range specified by BaseAddress and Length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was not allocated with previous calls to AllocateIoSpace().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to free the I/O resource from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Removes reserved I/O or I/O resources from the global coherency domain of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress A pointer to a physical address that is the start address of the I/O resource being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length The size in bytes of the I/O resource that is being removed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The I/O resource was removed from the global coherency domain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Length is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the I/O
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource range specified by BaseAddress and Length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND One or more bytes of the I/O resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length was not added with previous
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync calls to AddIoSpace().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED One or more bytes of the I/O resource range specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress and Length has been allocated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AllocateIoSpace().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources to remove the I/O
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resource from the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves the descriptor for an I/O region containing a specified address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BaseAddress The physical address that is the start address of an I/O region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Descriptor A pointer to a caller allocated descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The descriptor for the I/O resource region containing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseAddress was returned in Descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Descriptor is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND An I/O resource range containing BaseAddress was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns a map of the I/O resources in the global coherency domain of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumberOfDescriptors A pointer to number of descriptors returned in the IoSpaceMap buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemorySpaceMap A pointer to the array of EFI_GCD_IO_SPACE_DESCRIPTORs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The I/O space map was returned in the IoSpaceMap buffer, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the number of descriptors in IoSpaceMap was returned in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NumberOfDescriptors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER NumberOfDescriptors is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER IoSpaceMap is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate IoSpaceMap.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Loads and executed DXE drivers from firmware volumes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Dispatch() function searches for DXE drivers in firmware volumes that have been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync installed since the last time the Dispatch() service was called. It then evaluates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the dependency expressions of all the DXE drivers and loads and executes those DXE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync drivers whose dependency expression evaluate to TRUE. This service must interact with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Security Architectural Protocol to authenticate DXE drivers before they are executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This process is continued until no more DXE drivers can be executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS One or more DXE driver were dispatched.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No DXE drivers were dispatched.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED An attempt is being made to start the DXE Dispatcher recursively.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Thus, no action was taken.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Clears the Schedule on Request (SOR) flag for a component that is stored in a firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileName A pointer to the name of the file in a firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The DXE driver was found and its SOR bit was cleared.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The DXE driver does not exist, or the DXE driver exists and its SOR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bit is not set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Promotes a file stored in a firmware volume from the untrusted to the trusted state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FirmwareVolumeHandle The handle of the firmware volume that contains the file specified by FileName.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DriverName A pointer to the name of the file in a firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Status of promoting FFS from untrusted to trusted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The file was not found in the untrusted state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Creates a firmware volume handle for a firmware volume that is present in system memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FirmwareVolumeHeader A pointer to the header of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size The size, in bytes, of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FirmwareVolumeHandle On output, a pointer to the created handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The EFI_FIRMWARE_VOLUME_PROTOCOL and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_PATH_PROTOCOL were installed onto
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FirmwareVolumeHandle for the firmware volume described
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by FirmwareVolumeHeader and Size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The firmware volume described by FirmwareVolumeHeader
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and Size is corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough system resources available to produce the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FIRMWARE_VOLUME_PROTOCOL and EFI_DEVICE_PATH_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the firmware volume described by FirmwareVolumeHeader and Size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// DXE Services Table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DXE_SERVICES_SIGNATURE 0x565245535f455844ULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DXE_SERVICES_REVISION ((DXE_SPECIFICATION_MAJOR_REVISION<<16) | (DXE_SPECIFICATION_MINOR_REVISION))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The table header for the DXE Services Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This header contains the DXE_SERVICES_SIGNATURE and DXE_SERVICES_REVISION values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Global Coherency Domain Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_GET_MEMORY_SPACE_DESCRIPTOR GetMemorySpaceDescriptor;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SET_MEMORY_SPACE_ATTRIBUTES SetMemorySpaceAttributes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Dispatcher Services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Service to process a single firmware volume found in a capsule
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The function prototype for invoking a function on an Application Processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This definition is used by the UEFI MP Serices Protocol, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PI SMM System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in,out] Buffer The pointer to private data buffer.