From f38fdc749879ff6b9339fded2062e3dac46fa72d Mon Sep 17 00:00:00 2001 From: klu2 Date: Wed, 10 Dec 2008 03:10:07 +0000 Subject: [PATCH] Synchronize interface function comment from declaration in library class header file to implementation in library instance. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6951 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Library/PeiServicesLib/PeiServicesLib.c | 7 ++--- .../PeiServicesTablePointer.c | 7 +++-- .../PeiServicesTablePointer.c | 29 ++++++------------- .../PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c | 4 +-- .../Library/PeimEntryPoint/PeimEntryPoint.c | 13 +++++---- 5 files changed, 25 insertions(+), 35 deletions(-) diff --git a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c index 93495f04b8..1f5e20d32b 100644 --- a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c +++ b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c @@ -192,7 +192,7 @@ PeiServicesSetBootMode ( EFI_STATUS EFIAPI PeiServicesGetHobList ( - OUT VOID **HobList + OUT VOID **HobList ) { CONST EFI_PEI_SERVICES **PeiServices; @@ -445,7 +445,7 @@ PeiServicesRegisterForShadow ( **/ EFI_STATUS -EFIAPI +EFIAPI PeiServicesFfsGetFileInfo ( IN CONST EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo @@ -466,8 +466,7 @@ PeiServicesFfsGetFileInfo ( @param VolumeHandle The firmware volume to search FileHandle Upon exit, points to the found file's handle or NULL if it could not be found. - - @param FileHandle The filehandle found in volume. + @param FileHandle Pointer to found file handle @retval EFI_SUCCESS File was found. diff --git a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c index 564e50626a..c45a55829d 100644 --- a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c +++ b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c @@ -22,14 +22,15 @@ CONST EFI_PEI_SERVICES **gPeiServices; /** - The function cache the pointer of PEI services to global variable. + The function set the pointer of PEI services immediately preceding the IDT table + according to PI specification. - @param PeiServices The address of PeiServices pointer. + @param PeiServicesTablePointer The address of PeiServices pointer. **/ VOID EFIAPI SetPeiServicesTablePointer ( - IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer + IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer ) { gPeiServices = PeiServicesTablePointer; diff --git a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c index 599e8f25aa..f2c29bdaa4 100644 --- a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c +++ b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c @@ -22,16 +22,12 @@ #include /** - - The function returns the pointer to PeiServicee following - PI1.0. - - For IA32, the four-bytes field immediately prior to new IDT - base addres is used to save the EFI_PEI_SERVICES**. - For x64, the eight-bytes field immediately prior to new IDT - base addres is used to save the EFI_PEI_SERVICES** - - @return The pointer to PeiServices. + The function returns the pointer to PEI services. + + The function returns the pointer to PEI services. + It will ASSERT() if the pointer to PEI services is NULL. + + @retval The pointer to PeiServices. **/ CONST EFI_PEI_SERVICES ** @@ -50,17 +46,10 @@ GetPeiServicesTablePointer ( } /** + The function set the pointer of PEI services immediately preceding the IDT table + according to PI specification. - The function sets the pointer to PeiServicee following - PI1.0. - - For IA32, the four-bytes field immediately prior to new IDT - base addres is used to save the EFI_PEI_SERVICES**. - For x64, the eight-bytes field immediately prior to new IDT - base addres is used to save the EFI_PEI_SERVICES** - - @param PeiServicesTablePointer The pointer to PeiServices. - + @param PeiServicesTablePointer The address of PeiServices pointer. **/ VOID EFIAPI diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c index d78682a694..bf111fa718 100644 --- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c +++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. This internal function retrieves Smbus PPI from PPI database. - @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation. + @param VOID @return The pointer to Smbus PPI. @@ -57,7 +57,7 @@ InternalGetSmbusPpi ( @param Status Return status for the executed command. This is an optional parameter and may be NULL. - @return The actual number of bytes that are executed for this operation.. + @return The actual number of bytes that are executed for this operation. **/ UINTN diff --git a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c index 286c2df9e8..a03c377059 100644 --- a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c +++ b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c @@ -26,8 +26,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile(). @param PeiServices Describes the list of possible PEI Services. - @return Status returned by entry points of Peims. - + @retval EFI_SUCCESS The PEIM executed normally. + @retval !EFI_SUCCESS The PEIM failed to execute normally. **/ EFI_STATUS EFIAPI @@ -56,20 +56,21 @@ _ModuleEntryPoint ( /** - Wrapper of Peim image entry point. + Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). @param FileHandle Handle of the file being invoked. Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile(). @param PeiServices Describes the list of possible PEI Services. - @return Status returned by entry points of Peims. + @retval EFI_SUCCESS The PEIM executed normally. + @retval !EFI_SUCCESS The PEIM failed to execute normally. **/ EFI_STATUS EFIAPI EfiMain ( - IN EFI_PEI_FILE_HANDLE FileHandle, - IN CONST EFI_PEI_SERVICES **PeiServices + IN EFI_PEI_FILE_HANDLE FileHandle, + IN CONST EFI_PEI_SERVICES **PeiServices ) { return _ModuleEntryPoint (FileHandle, PeiServices); -- 2.39.2