4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MDE DXE Services Library provides functions that simplify the development of DXE Drivers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync These functions help access data from sections of FFS files or from file path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Identify the device handle from which the Image is loaded from. As this device handle is passed to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GetSectionFromFv as the identifier for a Firmware Volume, an EFI_FIRMWARE_VOLUME2_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync protocol instance should be located succesfully by calling gBS->HandleProtocol ().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function locates the EFI_LOADED_IMAGE_PROTOCOL instance installed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on ImageHandle. It then returns EFI_LOADED_IMAGE_PROTOCOL.DeviceHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ImageHandle is NULL, then ASSERT ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If failed to locate a EFI_LOADED_IMAGE_PROTOCOL on ImageHandle, then ASSERT ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle The firmware allocated handle for UEFI image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_HANDLE The device handle from which the Image is loaded from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate and fill a buffer from a Firmware Section identified by a Firmware File GUID name, a Firmware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Section type and instance number from the specified Firmware Volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This functions first locate the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance on FvHandle in order to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync carry out the Firmware Volume read operation. The function then reads the Firmware Section found sepcifed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by NameGuid, SectionType and SectionInstance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection ()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync found in PI Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SectionType is EFI_SECTION_TE, EFI_SECTION_TE is used as section type to start the search. If EFI_SECTION_TE section
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not found, EFI_SECTION_PE32 will be used to try the search again. If no EFI_SECTION_PE32 section is found, EFI_NOT_FOUND
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The data and size is returned by Buffer and Size. The caller is responsible to free the Buffer allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by this function. This function can be only called at TPL_NOTIFY and below.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FvHandle is NULL, then ASSERT ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If NameGuid is NULL, then ASSERT();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Size is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FvHandle The device handle that contains a instance of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NameGuid The GUID name of a Firmware File.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionType The Firmware Section type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionInstance The instance number of Firmware Section to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync read from starting from 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer On output, Buffer contains the the data read
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the section in the Firmware File found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size On output, the size of Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The image is found and data and size is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can't be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync output data buffer or complete the operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Firmware Volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The firmware volume containing the searched
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Firmware File is configured to disallow reads.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Read desired section content in NameGuid file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status) && (SectionType == EFI_SECTION_TE)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Try reading PE32 section, if the required section is TE type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Searches all the available firmware volumes and returns the first matching FFS section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function searches all the firmware volumes for FFS files with FV file type specified by FileType
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The order that the firmware volumes is searched is not deterministic. For each available FV a search
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is made for FFS file of type FileType. If the FV contains more than one FFS file with the same FileType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the FileInstance instance will be the matched FFS file. For each FFS file found a search
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It is the caller's responsibility to use FreePool() to free the allocated buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are retrieved from an FFS file based on SectionType and SectionInstance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the search will be retried with a section type of EFI_SECTION_PE32.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function must be called with a TPL <= TPL_NOTIFY.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Size is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileType Indicates the FV file type to search for within all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync available FVs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param FileInstance Indicates which file instance within all available
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FVs specified by FileType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileInstance starts from zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionType Indicates the FFS section type to search for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync within the FFS file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by FileType with FileInstance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionInstance Indicates which section instance within the FFS file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by FileType with FileInstance to retrieve.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SectionInstance starts from zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer On output, a pointer to a callee allocated buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing the FFS file section that was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Is it the caller's responsibility to free this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer using FreePool().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size On output, a pointer to the size, in bytes, of Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The specified FFS section was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified FFS section could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the matching FFS section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the firmware volume that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the matching FFS section does not allow reads.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Locate all available FVs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Go through FVs one by one to find the required section data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (IndexFv = 0; IndexFv < HandleCount; IndexFv++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Use Firmware Volume 2 Protocol to search for a file of type FileType in all FVs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = Fv->GetNextFile (Fv, &Key, &FileType, &NameGuid, &Attributes, Size);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } while (IndexFile > 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fv File with the required FV file type is found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Search the section file in the found FV file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The required FFS section file is not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Searches all the availables firmware volumes and returns the first matching FFS section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The order that the firmware volumes is searched is not deterministic. For each FFS file found a search
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It is the caller's responsibility to use FreePool() to free the allocated buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are retrieved from an FFS file based on SectionType and SectionInstance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the search will be retried with a section type of EFI_SECTION_PE32.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function must be called with a TPL <= TPL_NOTIFY.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If NameGuid is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Size is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NameGuid A pointer to to the FFS filename GUID to search for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync within any of the firmware volumes in the platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionType Indicates the FFS section type to search for within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the FFS file specified by NameGuid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionInstance Indicates which section instance within the FFS file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by NameGuid to retrieve.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer On output, a pointer to a callee allocated buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing the FFS file section that was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Is it the caller's responsibility to free this buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync using FreePool().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size On output, a pointer to the size, in bytes, of Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The specified FFS section was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified FFS section could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources available to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync retrieve the matching FFS section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync firmware volume that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the matching FFS section does not allow reads.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Search the FV that contain the caller's FFS first.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // FV builder can choose to build FFS into the this FV
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // so that this implementation of GetSectionFromAnyFv
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // will locate the FFS faster.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FvHandle = InternalImageHandleToFvHandle (gImageHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Skip the FV that contain the caller's FFS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Searches the firmware volume that the currently executing module was loaded from and returns the first matching FFS section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function searches the firmware volume that the currently executing module was loaded
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found a search
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It is the caller's responsibility to use FreePool() to free the allocated buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for details on how sections are retrieved from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync an FFS file based on SectionType and SectionInstance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the currently executing module was not loaded from a firmware volume, then EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the search will be retried with a section type of EFI_SECTION_PE32.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function must be called with a TPL <= TPL_NOTIFY.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If NameGuid is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Size is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NameGuid A pointer to to the FFS filename GUID to search for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync within the firmware volumes that the currently
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync executing module was loaded from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionType Indicates the FFS section type to search for within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the FFS file specified by NameGuid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionInstance Indicates which section instance within the FFS file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by NameGuid to retrieve.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer On output, a pointer to a callee allocated buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing the FFS file section that was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Is it the caller's responsibility to free this buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync using FreePool().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size On output, a pointer to the size, in bytes, of Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The specified FFS section was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified FFS section could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the matching FFS section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync firmware volume that contains the matching FFS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync section does not allow reads.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Searches the FFS file the the currently executing module was loaded from and returns the first matching FFS section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the SectionInstance instance is returned in Buffer. Buffer is allocated using AllocatePool(),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the size of the allocated buffer is returned in Size. It is the caller's responsibility
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to use FreePool() to free the allocated buffer. See EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection() for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync details on how sections are retrieved from an FFS file based on SectionType and SectionInstance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the currently executing module was not loaded from an FFS file, then EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SectionType is EFI_SECTION_TE, and the search with an FFS file fails,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the search will be retried with a section type of EFI_SECTION_PE32.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function must be called with a TPL <= TPL_NOTIFY.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Size is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionType Indicates the FFS section type to search for within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the FFS file that the currently executing module
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was loaded from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SectionInstance Indicates which section instance to retrieve within
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the FFS file that the currently executing module
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was loaded from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer On output, a pointer to a callee allocated buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync containing the FFS file section that was found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Is it the caller's responsibility to free this buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync using FreePool().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size On output, a pointer to the size, in bytes, of Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The specified FFS section was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The specified FFS section could not be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the matching FFS section.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync firmware volume that contains the matching FFS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync section does not allow reads.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the image file buffer data and buffer size by its device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Access the file either from a firmware volume, from a file system interface,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or from the load file interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Allocate memory to store the found image. The caller is responsible to free memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If File is NULL, then NULL is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileSize is NULL, then NULL is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If AuthenticationStatus is NULL, then NULL is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BootPolicy Policy for Open Image File.If TRUE, indicates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that the request originates from the boot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync manager, and that the boot manager is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync attempting to load FilePath as a boot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync selection. If FALSE, then FilePath must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync match an exact file to be loaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FilePath The pointer to the device path of the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that is absracted to the file buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FileSize The pointer to the size of the abstracted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] AuthenticationStatus The pointer to a caller-allocated UINT32
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in which the authentication status is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL File is NULL, or FileSize is NULL. Or, the file can't be found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval other The abstracted file buffer. The caller is responsible to free memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check input File device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FilePath == NULL || FileSize == NULL || AuthenticationStatus == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Init local variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy File Device Path
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OrigDevicePathNode = DuplicateDevicePath (FilePath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check whether this device path support FV2 protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Is so, this device path may contain a Image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath (&gEfiFirmwareVolume2ProtocolGuid, &DevicePathNode, &Handle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // For FwVol File system there is only a single file name that is a GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FvNameGuid = EfiGetNameGuidFromFwVolDevicePathNode ((CONST MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) DevicePathNode);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Read image from the firmware file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->HandleProtocol (Handle, &gEfiFirmwareVolume2ProtocolGuid, (VOID**)&FwVol);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Try a raw file, since a PE32 SECTION does not exist
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Attempt to access the file via a file system interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid, &DevicePathNode, &Handle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->HandleProtocol (Handle, &gEfiSimpleFileSystemProtocolGuid, (VOID**)&Volume);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Open the Volume to get the File System handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Duplicate the device path to avoid the access to unaligned device path node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Because the device path consists of one or more FILE PATH MEDIA DEVICE PATH
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // nodes, It assures the fields in device path nodes are 2 byte aligned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TempDevicePathNode = DuplicateDevicePath (DevicePathNode);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Setting Status to an EFI_ERROR value will cause the rest of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // the file system support below to be skipped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Parse each MEDIA_FILEPATH_DP node. There may be more than one, since the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // directory information and filename can be seperate. The goal is to inch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // our way down each device path node and close the previous node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while (!EFI_ERROR (Status) && !IsDevicePathEnd (DevicePathNode)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (DevicePathType (DevicePathNode) != MEDIA_DEVICE_PATH ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathSubType (DevicePathNode) != MEDIA_FILEPATH_DP) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((FILEPATH_DEVICE_PATH *) DevicePathNode)->PathName,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Close the previous node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevicePathNode = NextDevicePathNode (DevicePathNode);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We have found the file. Now we need to read it. Before we can read the file we need to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // figure out how big the file is.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate space for the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ImageBuffer = AllocatePool ((UINTN)FileInfo->FileSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Read the file into the buffer we allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = FileHandle->Read (FileHandle, &ImageBufferSize, ImageBuffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Close the file and Free FileInfo and TempDevicePathNode since we are done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Attempt to access the file via LoadFile2 interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath (&gEfiLoadFile2ProtocolGuid, &DevicePathNode, &Handle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->HandleProtocol (Handle, &gEfiLoadFile2ProtocolGuid, (VOID**)&LoadFile2);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Call LoadFile2 with the correct buffer size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Attempt to access the file via LoadFile interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateDevicePath (&gEfiLoadFileProtocolGuid, &DevicePathNode, &Handle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->HandleProtocol (Handle, &gEfiLoadFileProtocolGuid, (VOID**)&LoadFile);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Call LoadFile with the correct buffer size