diff options
| author | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-08-08 03:05:03 +0000 |
|---|---|---|
| committer | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-08-08 03:05:03 +0000 |
| commit | 731bd38eacd731a46fc876d4f6fa5832778aba66 (patch) | |
| tree | 32a858ef15a8ce19d4a5229c57850219859e2d5b /MdeModulePkg/Core/Pei/FwVol/FwVol.c | |
| parent | 15273993817c9996395e08768f7a8b37e45fe1cc (diff) | |
| download | edk2-731bd38eacd731a46fc876d4f6fa5832778aba66.zip edk2-731bd38eacd731a46fc876d4f6fa5832778aba66.tar.gz edk2-731bd38eacd731a46fc876d4f6fa5832778aba66.tar.bz2 | |
Add more comments for PeiCore.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5618 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Core/Pei/FwVol/FwVol.c')
| -rw-r--r-- | MdeModulePkg/Core/Pei/FwVol/FwVol.c | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/MdeModulePkg/Core/Pei/FwVol/FwVol.c b/MdeModulePkg/Core/Pei/FwVol/FwVol.c index 73216c6..c507c0b 100644 --- a/MdeModulePkg/Core/Pei/FwVol/FwVol.c +++ b/MdeModulePkg/Core/Pei/FwVol/FwVol.c @@ -108,7 +108,9 @@ CalculateHeaderChecksum ( @param FileHandle Handle of file image
@param VolumeHandle Handle of FV
- @return EDES_TODO: Add description for return value
+ @retval TRUE Success to find FV and return FV handle that contains file by given
+ file name.
+ @retval FALSE Can not find the FV that contains file by given file name.
**/
BOOLEAN
@@ -315,10 +317,9 @@ PeiInitializeFv ( /**
Process Firmware Volum Information once FvInfoPPI install.
-
- @param PeiServices - General purpose services available to every PEIM.
- @param NotifyDescriptor EDES_TODO: Add parameter description
- @param Ppi EDES_TODO: Add parameter description
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param NotifyDescriptor Address of the notification descriptor data structure.
+ @param Ppi Address of the PPI that was installed.
@retval EFI_SUCCESS if the interface could be successfully installed
@@ -407,14 +408,14 @@ FirmwareVolmeInfoPpiNotifyCallback ( when meeting an encapsuled section.
- @param PeiServices - General purpose services available to every PEIM.
- SearchType - Filter to find only section of this type.
- @param SectionType EDES_TODO: Add parameter description
- @param Section - From where to search.
- @param SectionSize - The file size to search.
- @param OutputBuffer - Pointer to the section to search.
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
+ @param SectionType Filter to find only section of this type.
+ @param Section From where to search.
+ @param SectionSize The file size to search.
+ @param OutputBuffer Pointer to the section to search.
- @return EFI_STATUS
+ @retval EFI_NOT_FOUND Can not find the section by given section type.
+ @retval EFI_SUCCESS Success to find the section and process section correctly.
**/
EFI_STATUS
|