diff options
Diffstat (limited to 'src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h')
| -rw-r--r-- | src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h | 68 |
1 files changed, 34 insertions, 34 deletions
diff --git a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h index 37eaa2129e..2a110ce3ae 100644 --- a/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h +++ b/src/vendorcode/intel/edk2/UDK2017/MdePkg/Include/Ppi/FirmwareVolume.h @@ -2,13 +2,13 @@ This file provides functions for accessing a memory-mapped firmware volume of a specific format. Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR> - This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: This PPI is from PI Version 1.0 errata. @@ -22,7 +22,7 @@ /// The GUID for this PPI is the same as the firmware volume format GUID. /// The FV format can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for a user-defined /// format. The EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format. -/// +/// typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI; @@ -36,15 +36,15 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI; buffer which contains the necessary information for creating the firmware volume handle. Normally, these values are derived from the EFI_FIRMWARE_VOLUME_INFO_PPI. - - + + @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @param Buffer Points to the start of the buffer. @param BufferSize Size of the buffer. @param FvHandle Points to the returned firmware volume handle. The firmware volume handle must - be unique within the system. + be unique within the system. @retval EFI_SUCCESS Firmware volume handle created. @retval EFI_VOLUME_CORRUPTED Volume was corrupt. @@ -62,7 +62,7 @@ EFI_STATUS /** Finds the next file of the specified type. - This service enables PEI modules to discover additional firmware files. + This service enables PEI modules to discover additional firmware files. The FileHandle must be unique within the system. @param This Points to this instance of the @@ -80,20 +80,20 @@ EFI_STATUS @retval EFI_SUCCESS The file was found. @retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL. -**/ +**/ typedef EFI_STATUS -(EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( - IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, - IN EFI_FV_FILETYPE SearchType, +(EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( + IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, + IN EFI_FV_FILETYPE SearchType, IN EFI_PEI_FV_HANDLE FvHandle, - IN OUT EFI_PEI_FILE_HANDLE *FileHandle + IN OUT EFI_PEI_FILE_HANDLE *FileHandle ); /** - Find a file within a volume by its name. - + Find a file within a volume by its name. + This service searches for files with a specific name, within either the specified firmware volume or all firmware volumes. @@ -131,8 +131,8 @@ EFI_STATUS This function returns information about a specific file, including its file name, type, attributes, starting - address and size. - + address and size. + @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @param FileHandle Handle of the file. @@ -143,13 +143,13 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER If FileHandle does not represent a valid file. @retval EFI_INVALID_PARAMETER If FileInfo is NULL. - -**/ + +**/ typedef EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_FILE_INFO)( - IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, - IN EFI_PEI_FILE_HANDLE FileHandle, + IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, + IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo ); @@ -158,7 +158,7 @@ EFI_STATUS This function returns information about a specific file, including its file name, type, attributes, starting - address, size and authentication status. + address, size and authentication status. @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @@ -175,14 +175,14 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_FILE_INFO2)( - IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, + IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO2 *FileInfo ); /** This function returns information about the firmware volume. - + @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @param FvHandle Handle to the firmware handle. @@ -193,21 +193,21 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER FvHandle does not indicate a valid firmware volume or VolumeInfo is NULL. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_INFO)( - IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, - IN EFI_PEI_FV_HANDLE FvHandle, + IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, + IN EFI_PEI_FV_HANDLE FvHandle, OUT EFI_FV_INFO *VolumeInfo ); /** Find the next matching section in the firmware file. - + This service enables PEI modules to discover sections of a given type within a valid file. - + @param This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI. @param SearchType A filter to find only sections of this @@ -216,7 +216,7 @@ EFI_STATUS search. @param SectionData Updated upon return to point to the section found. - + @retval EFI_SUCCESS Section was found. @retval EFI_NOT_FOUND Section of the specified type was not found. SectionData contains NULL. @@ -291,4 +291,4 @@ struct _EFI_PEI_FIRMWARE_VOLUME_PPI { extern EFI_GUID gEfiPeiFirmwareVolumePpiGuid; -#endif +#endif |