/** @file\r
The internal header file for firmware volume related definitions.\r
- \r
-Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
-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
- \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
+Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+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
+\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
**/\r
\r
buffer which contains the necessary information for creating\r
the firmware volume handle. Normally, these values are derived\r
from the EFI_FIRMWARE_VOLUME_INFO_PPI.\r
- \r
- \r
+\r
+\r
@param This Points to this instance of the\r
EFI_PEI_FIRMWARE_VOLUME_PPI.\r
@param Buffer Points to the start of the buffer.\r
@param BufferSize Size of the buffer.\r
@param FvHandle Points to the returned firmware volume\r
handle. The firmware volume handle must\r
- be unique within the system. \r
+ be unique within the system.\r
\r
@retval EFI_SUCCESS Firmware volume handle created.\r
@retval EFI_VOLUME_CORRUPTED Volume was corrupt.\r
IN UINTN BufferSize,\r
OUT EFI_PEI_FV_HANDLE *FvHandle\r
);\r
- \r
+\r
/**\r
Finds the next file of the specified type.\r
\r
- This service enables PEI modules to discover additional firmware files. \r
+ This service enables PEI modules to discover additional firmware files.\r
The FileHandle must be unique within the system.\r
\r
@param This Points to this instance of the\r
@retval EFI_SUCCESS The file was found.\r
@retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL.\r
\r
-**/ \r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFvPpiFindFileByType (\r
);\r
\r
/**\r
- Find a file within a volume by its name. \r
- \r
+ Find a file within a volume by its name.\r
+\r
This service searches for files with a specific name, within\r
either the specified firmware volume or all firmware volumes.\r
\r
FileName was NULL.\r
\r
\r
-**/ \r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFvPpiFindFileByName (\r
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
IN CONST EFI_GUID *FileName,\r
IN EFI_PEI_FV_HANDLE *FvHandle,\r
- OUT EFI_PEI_FILE_HANDLE *FileHandle \r
+ OUT EFI_PEI_FILE_HANDLE *FileHandle\r
);\r
\r
/**\r
Find the next matching section in the firmware file.\r
- \r
+\r
This service enables PEI modules to discover sections\r
of a given type within a valid file.\r
- \r
+\r
@param This Points to this instance of the\r
EFI_PEI_FIRMWARE_VOLUME_PPI.\r
@param SearchType A filter to find only sections of this\r
search.\r
@param SectionData Updated upon return to point to the\r
section found.\r
- \r
+\r
@retval EFI_SUCCESS Section was found.\r
@retval EFI_NOT_FOUND Section of the specified type was not\r
found. SectionData contains NULL.\r
-**/ \r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFvPpiFindSectionByType (\r
\r
This function returns information about a specific\r
file, including its file name, type, attributes, starting\r
- address and size. \r
- \r
+ address and size.\r
+\r
@param This Points to this instance of the\r
EFI_PEI_FIRMWARE_VOLUME_PPI.\r
@param FileHandle Handle of the file.\r
@retval EFI_INVALID_PARAMETER If FileHandle does not\r
represent a valid file.\r
@retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r
- \r
-**/ \r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFvPpiGetFileInfo (\r
- IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, \r
- IN EFI_PEI_FILE_HANDLE FileHandle, \r
+ IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
OUT EFI_FV_FILE_INFO *FileInfo\r
);\r
\r
\r
/**\r
This function returns information about the firmware volume.\r
- \r
+\r
@param This Points to this instance of the\r
EFI_PEI_FIRMWARE_VOLUME_PPI.\r
@param FvHandle Handle to the firmware handle.\r
@retval EFI_INVALID_PARAMETER FvHandle does not indicate a valid\r
firmware volume or VolumeInfo is NULL.\r
\r
-**/ \r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFvPpiGetVolumeInfo (\r
- IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, \r
- IN EFI_PEI_FV_HANDLE FvHandle, \r
+ IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,\r
+ IN EFI_PEI_FV_HANDLE FvHandle,\r
OUT EFI_FV_INFO *VolumeInfo\r
);\r
\r
/**\r
Convert the handle of FV to pointer of corresponding PEI_CORE_FV_HANDLE.\r
- \r
+\r
@param FvHandle The handle of a FV.\r
- \r
+\r
@retval NULL if can not find.\r
- @return Pointer of corresponding PEI_CORE_FV_HANDLE. \r
+ @return Pointer of corresponding PEI_CORE_FV_HANDLE.\r
**/\r
PEI_CORE_FV_HANDLE *\r
FvHandleToCoreHandle (\r
IN EFI_PEI_FV_HANDLE FvHandle\r
);\r
- \r
+\r
/**\r
Given the input file pointer, search for the next matching file in the\r
FFS volume as defined by SearchType. The search starts from FileHeader inside\r
\r
/**\r
Report the information for a new discoveried FV in unknown format.\r
- \r
+\r
If the EFI_PEI_FIRMWARE_VOLUME_PPI has not been installed for specifical FV format, but\r
the FV in this FV format has been discoveried, then the information of this FV\r
will be cached into PEI_CORE_INSTANCE's UnknownFvInfo array.\r
Also a notification would be installed for unknown FV format guid, if EFI_PEI_FIRMWARE_VOLUME_PPI\r
is installed later by platform's PEIM, the original unknown FV will be processed by\r
using new installed EFI_PEI_FIRMWARE_VOLUME_PPI.\r
- \r
+\r
@param PrivateData Point to instance of PEI_CORE_INSTANCE\r
@param FvInfo2Ppi Point to FvInfo2 PPI.\r
- \r
+\r
@retval EFI_OUT_OF_RESOURCES The FV info array in PEI_CORE_INSTANCE has no more spaces.\r
@retval EFI_SUCCESS Success to add the information for unknown FV.\r
**/\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI *FvInfo2Ppi\r
);\r
- \r
+\r
/**\r
Find the FV information according to FV format guid.\r
- \r
+\r
This routine also will remove the FV information found by given FV format guid from\r
PrivateData->UnknownFvInfo[].\r
- \r
+\r
@param PrivateData Point to instance of PEI_CORE_INSTANCE\r
@param Format Point to given FV format guid\r
@param FvInfo On return, the pointer of FV information buffer in given FV format guid\r
@param FvInfoSize On return, the size of FV information buffer.\r
@param AuthenticationStatus On return, the authentication status of FV information buffer.\r
- \r
+\r
@retval EFI_NOT_FOUND The FV is not found for new installed EFI_PEI_FIRMWARE_VOLUME_PPI\r
@retval EFI_SUCCESS Success to find a FV which could be processed by new installed EFI_PEI_FIRMWARE_VOLUME_PPI.\r
**/\r
OUT UINT32 *FvInfoSize,\r
OUT UINT32 *AuthenticationStatus\r
);\r
- \r
+\r
/**\r
Notification callback function for EFI_PEI_FIRMWARE_VOLUME_PPI.\r
- \r
- When a EFI_PEI_FIRMWARE_VOLUME_PPI is installed to support new FV format, this \r
+\r
+ When a EFI_PEI_FIRMWARE_VOLUME_PPI is installed to support new FV format, this\r
routine is called to process all discoveried FVs in this format.\r
- \r
+\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
@param NotifyDescriptor Address of the notification descriptor data structure.\r
@param Ppi Address of the PPI that was installed.\r
- \r
+\r
@retval EFI_SUCCESS The notification callback is processed correctly.\r
**/\r
EFI_STATUS\r
IN EFI_PEI_SERVICES **PeiServices,\r
IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
IN VOID *Ppi\r
- ); \r
- \r
-#endif \r
+ );\r
+\r
+#endif\r
projects / mirror_edk2.git / blobdiff