Functions
EFI_STATUS EFIAPI	GetSectionFromAnyFvByFileType (IN EFI_FV_FILETYPE FileType, IN UINTN FileInstance, IN EFI_SECTION_TYPE SectionType, IN UINTN SectionInstance, OUT VOID *Buffer, OUT UINTN Size)

EFI_STATUS EFIAPI	GetSectionFromAnyFv (IN CONST EFI_GUID NameGuid, IN EFI_SECTION_TYPE SectionType, IN UINTN SectionInstance, OUT VOID Buffer, OUT UINTN Size)

EFI_STATUS EFIAPI	GetSectionFromFv (IN CONST EFI_GUID NameGuid, IN EFI_SECTION_TYPE SectionType, IN UINTN SectionInstance, OUT VOID Buffer, OUT UINTN Size)

EFI_STATUS EFIAPI	GetSectionFromFfs (IN EFI_SECTION_TYPE SectionType, IN UINTN SectionInstance, OUT VOID *Buffer, OUT UINTN Size)

VOID *EFIAPI	GetFileBufferByFilePath (IN BOOLEAN BootPolicy, IN CONST EFI_DEVICE_PATH_PROTOCOL FilePath, OUT UINTN FileSize, OUT UINT32 *AuthenticationStatus)

EFI_STATUS EFIAPI	GetFileDevicePathFromAnyFv (IN CONST EFI_GUID NameGuid, IN EFI_SECTION_TYPE SectionType, IN UINTN SectionInstance, OUT EFI_DEVICE_PATH_PROTOCOL *FvFileDevicePath)

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

Detailed Description

MDE DXE Services Library provides functions that simplify the development of DXE Drivers. These functions help access data from sections of FFS files or from file path.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2015 Hewlett Packard Enterprise Development LP
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DxeServicesLib.h.

Function Documentation

◆ AllocatePeiAccessiblePages()

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

Allocates one or more 4KB pages of a given type from a memory region that is accessible to PEI.

Allocates the number of 4KB pages of type '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 remaining to satisfy the request, then NULL is returned.

Parameters

[in]	MemoryType	The memory type to allocate
[in]	Pages	The number of 4 KB pages to allocate.

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

Definition at line 31 of file Allocate.c.

◆ GetFileBufferByFilePath()

VOID *EFIAPI GetFileBufferByFilePath	(	IN BOOLEAN	BootPolicy,
		IN CONST EFI_DEVICE_PATH_PROTOCOL *	FilePath,
		OUT UINTN *	FileSize,
		OUT UINT32 *	AuthenticationStatus
	)

Get the image file buffer data and buffer size by its device path.

Access the file either from a firmware volume, from a file system interface, or from the load file interface.

Allocate memory to store the found image. The caller is responsible to free memory.

If FilePath is NULL, then NULL is returned. If FileSize is NULL, then NULL is returned. If AuthenticationStatus is NULL, then NULL is returned.

Parameters

[in]	BootPolicy	The policy for Open Image File.If TRUE, indicates that the request originates from the boot manager, and that the boot manager is attempting to load FilePath as a boot selection. If FALSE, then FilePath must match an exact file to be loaded.
[in]	FilePath	Pointer to the device path of the file that is abstracted to the file buffer.
[out]	FileSize	Pointer to the size of the abstracted file buffer.
[out]	AuthenticationStatus	Pointer to the authentication status.

Return values

NULL	FilePath is NULL, or FileSize is NULL, or AuthenticationStatus is NULL, or the file can't be found.
other	The abstracted file buffer. The caller is responsible to free memory.

Get the image file buffer data and buffer size by its device path.

Access the file either from a firmware volume, from a file system interface, or from the load file interface.

Allocate memory to store the found image. The caller is responsible to free memory.

If FilePath is NULL, then NULL is returned. If FileSize is NULL, then NULL is returned. If AuthenticationStatus is NULL, then NULL is returned.

Parameters

[in]	BootPolicy	Policy for Open Image File.If TRUE, indicates that the request originates from the boot manager, and that the boot manager is attempting to load FilePath as a boot selection. If FALSE, then FilePath must match an exact file to be loaded.
[in]	FilePath	The pointer to the device path of the file that is abstracted to the file buffer.
[out]	FileSize	The pointer to the size of the abstracted file buffer.
[out]	AuthenticationStatus	Pointer to the authentication status.

Return values

NULL	FilePath is NULL, or FileSize is NULL, or AuthenticationStatus is NULL, or the file can't be found.
other	The abstracted file buffer. The caller is responsible to free memory.

Definition at line 607 of file DxeServicesLib.c.

◆ GetFileDevicePathFromAnyFv()

EFI_STATUS EFIAPI GetFileDevicePathFromAnyFv	(	IN CONST EFI_GUID *	NameGuid,
		IN EFI_SECTION_TYPE	SectionType,
		IN UINTN	SectionInstance,
		OUT EFI_DEVICE_PATH_PROTOCOL **	FvFileDevicePath
	)

Searches all the available firmware volumes and returns the file device path of first matching FFS section.

This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid. The order that the firmware volumes is searched is not deterministic. For each FFS file found a search is made for FFS sections of type SectionType.

If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. This function must be called with a TPL <= TPL_NOTIFY.

If NameGuid is NULL, then ASSERT().

Parameters

NameGuid	A pointer to to the FFS filename GUID to search for within any of the firmware volumes in the platform.
SectionType	Indicates the FFS section type to search for within the FFS file specified by NameGuid.
SectionInstance	Indicates which section instance within the FFS file specified by NameGuid to retrieve.
FvFileDevicePath	Device path for the target FFS file.

Return values

EFI_SUCCESS	The specified file device path of FFS section was returned.
EFI_NOT_FOUND	The specified file device path of FFS section could not be found.
EFI_DEVICE_ERROR	The FFS section could not be retrieves due to a device error.
EFI_ACCESS_DENIED	The FFS section could not be retrieves because the firmware volume that contains the matching FFS section does not allow reads.
EFI_INVALID_PARAMETER	FvFileDevicePath is NULL.

Definition at line 981 of file DxeServicesLib.c.

◆ GetSectionFromAnyFv()

EFI_STATUS EFIAPI GetSectionFromAnyFv	(	IN CONST EFI_GUID *	NameGuid,
		IN EFI_SECTION_TYPE	SectionType,
		IN UINTN	SectionInstance,
		OUT VOID **	Buffer,
		OUT UINTN *	Size
	)

Searches all the available firmware volumes and returns the first matching FFS section.

This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid. The order in which the firmware volumes are searched is not deterministic. For each FFS file found, a search is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. It is the caller's responsibility to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance.

If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. This function must be called with a TPL <= TPL_NOTIFY.

If NameGuid is NULL, then ASSERT(). If Buffer is NULL, then ASSERT(). If Size is NULL, then ASSERT().

Parameters

NameGuid	A pointer to to the FFS filename GUID to search for within any of the firmware volumes in the platform.
SectionType	Indicates the FFS section type to search for within the FFS file specified by NameGuid.
SectionInstance	Indicates which section instance within the FFS file specified by NameGuid to retrieve.
Buffer	On output, a pointer to a callee-allocated buffer containing the FFS file section that was found. It is the caller's responsibility to free this buffer using FreePool().
Size	On output, a pointer to the size, in bytes, of Buffer.

Return values

EFI_SUCCESS	The specified FFS section was returned.
EFI_NOT_FOUND	The specified FFS section could not be found.
EFI_OUT_OF_RESOURCES	There are not enough resources available to retrieve the matching FFS section.
EFI_DEVICE_ERROR	The FFS section could not be retrieves due to a device error.
EFI_ACCESS_DENIED	The FFS section could not be retrieves because the firmware volume that contains the matching FFS section does not allow reads.

Searches all the availables firmware volumes and returns the first matching FFS section.

This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid. The order that the firmware volumes is searched is not deterministic. For each FFS file found a search is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. It is the caller's responsibility to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance.

If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. This function must be called with a TPL <= TPL_NOTIFY.

If NameGuid is NULL, then ASSERT(). If Buffer is NULL, then ASSERT(). If Size is NULL, then ASSERT().

Parameters

NameGuid	A pointer to to the FFS filename GUID to search for within any of the firmware volumes in the platform.
SectionType	Indicates the FFS section type to search for within the FFS file specified by NameGuid.
SectionInstance	Indicates which section instance within the FFS file specified by NameGuid to retrieve.
Buffer	On output, a pointer to a callee allocated buffer containing the FFS file section that was found. Is it the caller's responsibility to free this buffer using FreePool().
Size	On output, a pointer to the size, in bytes, of Buffer.

Return values

EFI_SUCCESS	The specified FFS section was returned.
EFI_NOT_FOUND	The specified FFS section could not be found.
EFI_OUT_OF_RESOURCES	There are not enough resources available to retrieve the matching FFS section.
EFI_DEVICE_ERROR	The FFS section could not be retrieves due to a device error.
EFI_ACCESS_DENIED	The FFS section could not be retrieves because the firmware volume that contains the matching FFS section does not allow reads.

Definition at line 374 of file DxeServicesLib.c.

◆ GetSectionFromAnyFvByFileType()

EFI_STATUS EFIAPI GetSectionFromAnyFvByFileType	(	IN EFI_FV_FILETYPE	FileType,
		IN UINTN	FileInstance,
		IN EFI_SECTION_TYPE	SectionType,
		IN UINTN	SectionInstance,
		OUT VOID **	Buffer,
		OUT UINTN *	Size
	)

Searches all the available firmware volumes and returns the first matching FFS section.

This function searches all the firmware volumes for FFS files with FV file type specified by FileType The order that the firmware volumes is searched is not deterministic. For each available FV a search is made for FFS file of type FileType. If the FV contains more than one FFS file with the same FileType, the FileInstance instance will be the matched FFS file. For each FFS file found a search is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. It is the caller's responsibility to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance.

If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. This function must be called with a TPL <= TPL_NOTIFY.

If Buffer is NULL, then ASSERT(). If Size is NULL, then ASSERT().

Parameters

FileType	Indicates the FV file type to search for within all available FVs.
FileInstance	Indicates which file instance within all available FVs specified by FileType. FileInstance starts from zero.
SectionType	Indicates the FFS section type to search for within the FFS file specified by FileType with FileInstance.
SectionInstance	Indicates which section instance within the FFS file specified by FileType with FileInstance to retrieve. SectionInstance starts from zero.
Buffer	On output, a pointer to a callee allocated buffer containing the FFS file section that was found. Is it the caller's responsibility to free this buffer using FreePool().
Size	On output, a pointer to the size, in bytes, of Buffer.

Return values

EFI_SUCCESS	The specified FFS section was returned.
EFI_NOT_FOUND	The specified FFS section could not be found.
EFI_OUT_OF_RESOURCES	There are not enough resources available to retrieve the matching FFS section.
EFI_DEVICE_ERROR	The FFS section could not be retrieves due to a device error.
EFI_ACCESS_DENIED	The FFS section could not be retrieves because the firmware volume that contains the matching FFS section does not allow reads.

Definition at line 230 of file DxeServicesLib.c.

◆ GetSectionFromFfs()

EFI_STATUS EFIAPI GetSectionFromFfs	(	IN EFI_SECTION_TYPE	SectionType,
		IN UINTN	SectionInstance,
		OUT VOID **	Buffer,
		OUT UINTN *	Size
	)

Searches the FFS file the currently executing module was loaded from and returns the first matching FFS section.

This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. It is the caller's responsibility to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance.

If the currently executing module was not loaded from an FFS file, then EFI_NOT_FOUND is returned. If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. This function must be called with a TPL <= TPL_NOTIFY.

If Buffer is NULL, then ASSERT(). If Size is NULL, then ASSERT().

Parameters

SectionType	Indicates the FFS section type to search for within the FFS file that the currently executing module was loaded from.
SectionInstance	Indicates which section instance to retrieve within the FFS file that the currently executing module was loaded from.
Buffer	On output, a pointer to a callee allocated buffer containing the FFS file section that was found. It is the caller's responsibility to free this buffer using FreePool().
Size	On output, a pointer to the size, in bytes, of Buffer.

Return values

EFI_SUCCESS	The specified FFS section was returned.
EFI_NOT_FOUND	The specified FFS section could not be found.
EFI_OUT_OF_RESOURCES	There are not enough resources available to retrieve the matching FFS section.
EFI_DEVICE_ERROR	The FFS section could not be retrieves due to a device error.
EFI_ACCESS_DENIED	The FFS section could not be retrieves because the firmware volume that contains the matching FFS section does not allow reads.

Searches the FFS file the currently executing module was loaded from and returns the first matching FFS section.

This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. It is the caller's responsibility to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance.

If the currently executing module was not loaded from an FFS file, then EFI_NOT_FOUND is returned. If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32. This function must be called with a TPL <= TPL_NOTIFY.

If Buffer is NULL, then ASSERT(). If Size is NULL, then ASSERT().

Parameters

SectionType	Indicates the FFS section type to search for within the FFS file that the currently executing module was loaded from.
SectionInstance	Indicates which section instance to retrieve within the FFS file that the currently executing module was loaded from.
Buffer	On output, a pointer to a callee allocated buffer containing the FFS file section that was found. Is it the caller's responsibility to free this buffer using FreePool().
Size	On output, a pointer to the size, in bytes, of Buffer.

Return values

EFI_SUCCESS	The specified FFS section was returned.
EFI_NOT_FOUND	The specified FFS section could not be found.
EFI_OUT_OF_RESOURCES	There are not enough resources available to retrieve the matching FFS section.
EFI_DEVICE_ERROR	The FFS section could not be retrieves due to a device error.
EFI_ACCESS_DENIED	The FFS section could not be retrieves because the firmware volume that contains the matching FFS section does not allow reads.

Definition at line 561 of file DxeServicesLib.c.

◆ GetSectionFromFv()

EFI_STATUS EFIAPI GetSectionFromFv	(	IN CONST EFI_GUID *	NameGuid,
		IN EFI_SECTION_TYPE	SectionType,
		IN UINTN	SectionInstance,
		OUT VOID **	Buffer,
		OUT UINTN *	Size
	)

Searches the firmware volume that the currently executing module was loaded from and returns the first matching FFS section.

This function searches the firmware volume that the currently executing module was loaded from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found, a search is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. It is the caller's responsibility to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance.

If the currently executing module was not loaded from a firmware volume, then EFI_NOT_FOUND is returned. If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32.

This function must be called with a TPL <= TPL_NOTIFY. If NameGuid is NULL, then ASSERT(). If Buffer is NULL, then ASSERT(). If Size is NULL, then ASSERT().

Parameters

NameGuid	A pointer to to the FFS filename GUID to search for within the firmware volumes that the currently executing module was loaded from.
SectionType	Indicates the FFS section type to search for within the FFS file specified by NameGuid.
SectionInstance	Indicates which section instance within the FFS file specified by NameGuid to retrieve.
Buffer	On output, a pointer to a callee allocated buffer containing the FFS file section that was found. It is the caller's responsibility to free this buffer using FreePool().
Size	On output, a pointer to the size, in bytes, of Buffer.

Return values

EFI_SUCCESS	The specified FFS section was returned.
EFI_NOT_FOUND	The specified FFS section could not be found.
EFI_OUT_OF_RESOURCES	There are not enough resources available to retrieve the matching FFS section.
EFI_DEVICE_ERROR	The FFS section could not be retrieves due to a device error.
EFI_ACCESS_DENIED	The FFS section could not be retrieves because the firmware volume that contains the matching FFS section does not allow reads.

Searches the firmware volume that the currently executing module was loaded from and returns the first matching FFS section.

This function searches the firmware volume that the currently executing module was loaded from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found a search is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. It is the caller's responsibility to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from an FFS file based on SectionType and SectionInstance.

If the currently executing module was not loaded from a firmware volume, then EFI_NOT_FOUND is returned. If SectionType is EFI_SECTION_TE, and the search with an FFS file fails, the search will be retried with a section type of EFI_SECTION_PE32.

This function must be called with a TPL <= TPL_NOTIFY. If NameGuid is NULL, then ASSERT(). If Buffer is NULL, then ASSERT(). If Size is NULL, then ASSERT().

Parameters

NameGuid	A pointer to to the FFS filename GUID to search for within the firmware volumes that the currently executing module was loaded from.
SectionType	Indicates the FFS section type to search for within the FFS file specified by NameGuid.
SectionInstance	Indicates which section instance within the FFS file specified by NameGuid to retrieve.
Buffer	On output, a pointer to a callee allocated buffer containing the FFS file section that was found. Is it the caller's responsibility to free this buffer using FreePool().
Size	On output, a pointer to the size, in bytes, of Buffer.

Return values

EFI_SUCCESS	The specified FFS section was returned.
EFI_NOT_FOUND	The specified FFS section could not be found.
EFI_OUT_OF_RESOURCES	There are not enough resources available to retrieve the matching FFS section.
EFI_DEVICE_ERROR	The FFS section could not be retrieves due to a device error.
EFI_ACCESS_DENIED	The FFS section could not be retrieves because the firmware volume that contains the matching FFS section does not allow reads.

Definition at line 499 of file DxeServicesLib.c.

Functions

Detailed Description

Function Documentation

◆ AllocatePeiAccessiblePages()

◆ GetFileBufferByFilePath()

◆ GetFileDevicePathFromAnyFv()

◆ GetSectionFromAnyFv()

◆ GetSectionFromAnyFvByFileType()

◆ GetSectionFromFfs()

◆ GetSectionFromFv()