This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
+ http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@param ImageHandle The firmware allocated handle for UEFI image.\r
\r
- @retval EFI_HANDLE The device handle from which the Image is loaded from.\r
+ @retval EFI_HANDLE The device handle from which the Image is loaded from.\r
\r
**/\r
EFI_HANDLE\r
If Buffer is NULL, then ASSERT();\r
If Size is NULL, then ASSERT().\r
\r
- @param FvHandle The device handle that contains a instance of EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
+ @param FvHandle The device handle that contains a instance of \r
+ EFI_FIRMWARE_VOLUME2_PROTOCOL instance.\r
@param NameGuid The GUID name of a Firmware File.\r
@param SectionType The Firmware Section type.\r
- @param SectionInstance The instance number of Firmware Section to read from starting from 0.\r
- @param Buffer On output, Buffer contains the the data read from the section in the Firmware File found.\r
+ @param SectionInstance The instance number of Firmware Section to \r
+ read from starting from 0.\r
+ @param Buffer On output, Buffer contains the the data read \r
+ from the section in the Firmware File found.\r
@param Size On output, the size of Buffer.\r
\r
@retval EFI_SUCCESS The image is found and data and size is returned.\r
- @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r
- @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r
- @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r
- @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r
+ @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType \r
+ can't be found.\r
+ @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
+ output data buffer or complete the operations.\r
+ @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the \r
+ Firmware Volume.\r
+ @retval EFI_ACCESS_DENIED The firmware volume containing the searched \r
+ Firmware File is configured to disallow reads.\r
\r
**/\r
EFI_STATUS\r
If Buffer is NULL, then ASSERT().\r
If Size is NULL, then ASSERT().\r
\r
- @param FileType Indicates the FV file type to search for within all available FVs.\r
- @param FileInstance Indicates which file instance within all available FVs specified by FileType.\r
+ @param FileType Indicates the FV file type to search for within all \r
+ available FVs.\r
+ @param FileInstance Indicates which file instance within all available \r
+ FVs specified by FileType.\r
FileInstance starts from zero.\r
- @param SectionType Indicates the FFS section type to search for within the FFS file \r
+ @param SectionType Indicates the FFS section type to search for \r
+ within the FFS file \r
specified by FileType with FileInstance.\r
@param SectionInstance Indicates which section instance within the FFS file \r
- specified by FileType with FileInstance to retrieve. SectionInstance starts from zero.\r
- @param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found.\r
- Is it the caller's responsibility to free this buffer using FreePool().\r
+ specified by FileType with FileInstance to retrieve. \r
+ SectionInstance starts from zero.\r
+ @param Buffer On output, a pointer to a callee allocated buffer \r
+ containing the FFS file section that was found.\r
+ Is it the caller's responsibility to free this \r
+ buffer using FreePool().\r
@param Size On output, a pointer to the size, in bytes, of Buffer.\r
\r
@retval EFI_SUCCESS The specified FFS section was returned.\r
@retval EFI_NOT_FOUND The specified FFS section could not be found.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
- @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.\r
- @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that \r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve \r
+ the matching FFS section.\r
+ @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a \r
+ device error.\r
+ @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because \r
+ the firmware volume that \r
contains the matching FFS section does not allow reads.\r
**/\r
EFI_STATUS\r
If Size is NULL, then ASSERT().\r
\r
\r
- @param NameGuid A pointer to to the FFS filename GUID to search for within \r
- any of the firmware volumes in the platform. \r
- @param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid.\r
- @param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve.\r
- @param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found. \r
- Is it the caller's responsibility to free this buffer using FreePool().\r
+ @param NameGuid A pointer to to the FFS filename GUID to search for \r
+ within any of the firmware volumes in the platform. \r
+ @param SectionType Indicates the FFS section type to search for within \r
+ the FFS file specified by NameGuid.\r
+ @param SectionInstance Indicates which section instance within the FFS file \r
+ specified by NameGuid to retrieve.\r
+ @param Buffer On output, a pointer to a callee allocated buffer \r
+ containing the FFS file section that was found. \r
+ Is it the caller's responsibility to free this buffer \r
+ using FreePool().\r
@param Size On output, a pointer to the size, in bytes, of Buffer.\r
\r
@retval EFI_SUCCESS The specified FFS section was returned.\r
@retval EFI_NOT_FOUND The specified FFS section could not be found.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
- @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.\r
- @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that \r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to \r
+ retrieve the matching FFS section.\r
+ @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a \r
+ device error.\r
+ @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the \r
+ firmware volume that \r
contains the matching FFS section does not allow reads.\r
**/\r
EFI_STATUS\r
If Buffer is NULL, then ASSERT().\r
If Size is NULL, then ASSERT().\r
\r
- @param NameGuid A pointer to to the FFS filename GUID to search for within \r
- the firmware volumes that the currently executing module was loaded from.\r
- @param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid.\r
- @param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve.\r
- @param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found. \r
- Is it the caller's responsibility to free this buffer using FreePool().\r
+ @param NameGuid A pointer to to the FFS filename GUID to search for \r
+ within the firmware volumes that the currently \r
+ executing module was loaded from.\r
+ @param SectionType Indicates the FFS section type to search for within \r
+ the FFS file specified by NameGuid.\r
+ @param SectionInstance Indicates which section instance within the FFS file \r
+ specified by NameGuid to retrieve.\r
+ @param Buffer On output, a pointer to a callee allocated buffer \r
+ containing the FFS file section that was found. \r
+ Is it the caller's responsibility to free this buffer \r
+ using FreePool().\r
@param Size On output, a pointer to the size, in bytes, of Buffer.\r
\r
\r
@retval EFI_SUCCESS The specified FFS section was returned.\r
@retval EFI_NOT_FOUND The specified FFS section could not be found.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
- @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.\r
- @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that \r
- contains the matching FFS section does not allow reads. \r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve \r
+ the matching FFS section.\r
+ @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a \r
+ device error.\r
+ @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the \r
+ firmware volume that contains the matching FFS \r
+ section does not allow reads. \r
**/\r
EFI_STATUS\r
EFIAPI\r
If Size is NULL, then ASSERT().\r
\r
\r
- @param SectionType Indicates the FFS section type to search for within the FFS file \r
- that the currently executing module was loaded from.\r
- @param SectionInstance Indicates which section instance to retrieve within the FFS file \r
- that the currently executing module was loaded from.\r
- @param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found. \r
- Is it the caller's responsibility to free this buffer using FreePool().\r
+ @param SectionType Indicates the FFS section type to search for within \r
+ the FFS file that the currently executing module \r
+ was loaded from.\r
+ @param SectionInstance Indicates which section instance to retrieve within \r
+ the FFS file that the currently executing module \r
+ was loaded from.\r
+ @param Buffer On output, a pointer to a callee allocated buffer \r
+ containing the FFS file section that was found. \r
+ Is it the caller's responsibility to free this buffer \r
+ using FreePool().\r
@param Size On output, a pointer to the size, in bytes, of Buffer.\r
\r
@retval EFI_SUCCESS The specified FFS section was returned.\r
@retval EFI_NOT_FOUND The specified FFS section could not be found.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
- @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.\r
- @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that \r
- contains the matching FFS section does not allow reads. \r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve \r
+ the matching FFS section.\r
+ @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a \r
+ device error.\r
+ @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the \r
+ firmware volume that contains the matching FFS \r
+ section does not allow reads. \r
\r
**/\r
EFI_STATUS\r
If FileSize is NULL, then NULL is returned.\r
If AuthenticationStatus is NULL, then NULL is returned.\r
\r
- @param[in] BootPolicy Policy for Open Image File.If TRUE, indicates that the request \r
- originates from the boot manager, and that the boot manager is\r
- attempting to load FilePath as a boot selection. If FALSE, \r
- then FilePath must match an exact file to be loaded.\r
- @param[in] FilePath Pointer to the device path of the file that is absracted to\r
- the file buffer.\r
- @param[out] FileSize Pointer to the size of the abstracted file buffer.\r
- @param[out] AuthenticationStatus Pointer to a caller-allocated UINT32 in which the authentication\r
- status is returned.\r
-\r
- @retval NULL File is NULL, or FileSize is NULL. Or the file can't be found.\r
+ @param[in] BootPolicy Policy for Open Image File.If TRUE, indicates \r
+ that the request originates from the boot \r
+ manager, and that the boot manager is\r
+ attempting to load FilePath as a boot\r
+ selection. If FALSE, then FilePath must \r
+ match an exact file to be loaded.\r
+ @param[in] FilePath The pointer to the device path of the file\r
+ that is absracted to the file buffer.\r
+ @param[out] FileSize The pointer to the size of the abstracted \r
+ file buffer.\r
+ @param[out] AuthenticationStatus The pointer to a caller-allocated UINT32 \r
+ in which the authentication status is returned.\r
+\r
+ @retval NULL File is NULL, or FileSize is NULL. Or, the file can't be found.\r
@retval other The abstracted file buffer. The caller is responsible to free memory.\r
**/\r
VOID *\r
projects / mirror_edk2.git / blobdiff