diff options
Diffstat (limited to 'MdePkg/Include/Library')
-rw-r--r-- | MdePkg/Include/Library/BaseLib.h | 12 | ||||
-rw-r--r-- | MdePkg/Include/Library/HiiLib.h | 25 | ||||
-rw-r--r-- | MdePkg/Include/Library/PeiServicesLib.h | 13 | ||||
-rw-r--r-- | MdePkg/Include/Library/PeiServicesTablePointerLib.h | 2 | ||||
-rw-r--r-- | MdePkg/Include/Library/UefiLib.h | 13 |
5 files changed, 30 insertions, 35 deletions
diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h index ae14cc72ea..cf337b7190 100644 --- a/MdePkg/Include/Library/BaseLib.h +++ b/MdePkg/Include/Library/BaseLib.h @@ -2064,7 +2064,7 @@ DivS64x64Remainder ( If the Buffer is NULL, then ASSERT(). - @param Buffer Pointer to a 16-bit value that may be unaligned. + @param Uint16 Pointer to a 16-bit value that may be unaligned. @return *Uint16 @@ -2085,7 +2085,7 @@ ReadUnaligned16 ( If the Buffer is NULL, then ASSERT(). - @param Buffer Pointer to a 16-bit value that may be unaligned. + @param Uint16 Pointer to a 16-bit value that may be unaligned. @param Value 16-bit value to write to Buffer. @return Value @@ -2150,7 +2150,7 @@ WriteUnaligned24 ( If the Buffer is NULL, then ASSERT(). - @param Buffer Pointer to a 32-bit value that may be unaligned. + @param Uint32 Pointer to a 32-bit value that may be unaligned. @return *Uint32 @@ -2171,7 +2171,7 @@ ReadUnaligned32 ( If the Buffer is NULL, then ASSERT(). - @param Buffer Pointer to a 32-bit value that may be unaligned. + @param Uint32 Pointer to a 32-bit value that may be unaligned. @param Value 32-bit value to write to Buffer. @return Value @@ -2193,7 +2193,7 @@ WriteUnaligned32 ( If the Buffer is NULL, then ASSERT(). - @param Buffer Pointer to a 64-bit value that may be unaligned. + @param Uint64 Pointer to a 64-bit value that may be unaligned. @return *Uint64 @@ -2214,7 +2214,7 @@ ReadUnaligned64 ( If the Buffer is NULL, then ASSERT(). - @param Buffer Pointer to a 64-bit value that may be unaligned. + @param Uint64 Pointer to a 64-bit value that may be unaligned. @param Value 64-bit value to write to Buffer. @return Value diff --git a/MdePkg/Include/Library/HiiLib.h b/MdePkg/Include/Library/HiiLib.h index 38e1e50f7e..199a5ec182 100644 --- a/MdePkg/Include/Library/HiiLib.h +++ b/MdePkg/Include/Library/HiiLib.h @@ -57,14 +57,14 @@ HiiLibPreparePackageList ( If HiiHandle is NULL, then ASSERT.
- @param NumberOfPackages The number of HII packages to register.
- @param GuidId Package List GUID ID.
- @param EFI_HANDLE Optional. If not NULL, the DriverHandle on which an instance of DEVICE_PATH_PROTOCOL is installed.
- This DriverHandle uniquely defines the device that the added packages are associated with.
- @param HiiHandle On output, the HiiHandle is update with the handle which can be used to retrieve the Package
- List later. If the functions failed to add the package to the default HII database, this value will
- be set to NULL.
- @param ... The variable argument list describing all HII Package.
+ @param NumberOfPackages The number of HII packages to register.
+ @param GuidId Package List GUID ID.
+ @param DriverHandle Optional. If not NULL, the DriverHandle on which an instance of DEVICE_PATH_PROTOCOL is installed.
+ This DriverHandle uniquely defines the device that the added packages are associated with.
+ @param HiiHandle On output, the HiiHandle is update with the handle which can be used to retrieve the Package
+ List later. If the functions failed to add the package to the default HII database, this value will
+ be set to NULL.
+ @param ... The variable argument list describing all HII Package.
@return EFI_SUCCESS If the packages are successfully added to the default HII database.
@return EFI_OUT_OF_RESOURCE Not enough resource to complete the operation.
@@ -248,8 +248,6 @@ HiiLibGetStringFromToken ( If HandleBufferLength is NULL, then ASSERT.
If HiiHandleBuffer is NULL, then ASSERT.
- @param HiiDatabase A pointer to the EFI_HII_DATABASE_PROTOCOL
- instance.
@param HandleBufferLength On input, a pointer to the length of the handle
buffer. On output, the length of the handle buffer
that is required for the handles found.
@@ -272,8 +270,8 @@ HiiLibGetHiiHandles ( If HiiHandle could not be found in the default HII database, then ASSERT.
If Guid is NULL, then ASSERT.
- @param HiiHandle Hii handle
- @param Guid Package list GUID
+ @param Handle Hii handle
+ @param Guid Package list GUID
@retval EFI_SUCCESS Successfully extract GUID from Hii database.
@@ -376,7 +374,8 @@ HiiLibGetSupportedLanguages ( If not enough resource to complete the operation, then ASSERT.
@param HiiHandle The HII package list handle.
-
+ @param FirstLanguage Pointer to language name buffer.
+
@return The supported languages.
**/
diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h index bed110584c..23eeb6be00 100644 --- a/MdePkg/Include/Library/PeiServicesLib.h +++ b/MdePkg/Include/Library/PeiServicesLib.h @@ -165,7 +165,7 @@ PeiServicesCreateHob ( @param Instance This instance of the firmware volume to find. The value 0 is the
Boot Firmware Volume (BFV).
- @param FwVolHeader Pointer to the firmware volume header of the volume to return.
+ @param VolumeHandle Pointer to the firmware volume header of the volume to return.
@retval EFI_SUCCESS The volume was found.
@retval EFI_NOT_FOUND The volume was not found.
@@ -183,9 +183,9 @@ PeiServicesFfsFindNextVolume ( This service enables PEIMs to discover additional firmware files.
@param SearchType A filter to find files only of this type.
- @param FwVolHeader Pointer to the firmware volume header of the volume to search.
+ @param VolumeHandle Pointer to the firmware volume header of the volume to search.
This parameter must point to a valid FFS volume.
- @param FileHeader Pointer to the current file from which to begin searching.
+ @param FileHandle Pointer to the current file from which to begin searching.
@retval EFI_SUCCESS The file was found.
@retval EFI_NOT_FOUND The file was not found.
@@ -203,8 +203,8 @@ PeiServicesFfsFindNextFile ( /**
This service enables PEIMs to discover sections of a given type within a valid FFS file.
- @param SearchType The value of the section type to find.
- @param FfsFileHeader A pointer to the file header that contains the set of sections to
+ @param SectionType The value of the section type to find.
+ @param FileHandle A pointer to the file header that contains the set of sections to
be searched.
@param SectionData A pointer to the discovered section, if successful.
@@ -282,8 +282,6 @@ PeiServicesAllocatePool ( /**
Resets the entire platform.
- @param VOID
-
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.
@@ -306,6 +304,7 @@ PeiServicesResetSystem ( @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 Pointer to found file handle
@retval EFI_SUCCESS File was found.
diff --git a/MdePkg/Include/Library/PeiServicesTablePointerLib.h b/MdePkg/Include/Library/PeiServicesTablePointerLib.h index 8c133dd108..a5b32a565b 100644 --- a/MdePkg/Include/Library/PeiServicesTablePointerLib.h +++ b/MdePkg/Include/Library/PeiServicesTablePointerLib.h @@ -34,7 +34,7 @@ GetPeiServicesTablePointer ( 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
diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h index bbc4acab33..7daa23be48 100644 --- a/MdePkg/Include/Library/UefiLib.h +++ b/MdePkg/Include/Library/UefiLib.h @@ -144,9 +144,7 @@ EfiNamedEventSignal ( can then immediately be restored back to the current TPL level with a call
to RestoreTPL().
- @param VOID
-
- @retvale EFI_TPL The current TPL.
+ @return The current TPL.
**/
EFI_TPL
@@ -180,7 +178,6 @@ EfiInitializeLock ( priority level. Since there is no preemption or multiprocessor support in EFI,
acquiring the lock only consists of raising to the locks TPL.
- @param Lock A pointer to the lock data structure to initialize.
@param Priority The task priority level of the lock.
@return The lock.
@@ -220,7 +217,7 @@ EfiInitializeLock ( priority level of the mutual exclusion lock. Then, it places the lock in the
acquired state.
- @param Priority The task priority level of the lock.
+ @param Lock A pointer to the lock to acquire.
**/
VOID
@@ -302,7 +299,7 @@ EfiTestManagedDevice ( @param ControllerHandle A handle for a (parent) controller to test.
@param ChildHandle A child handle to test.
- @param ConsumsedGuid Supplies the protocol that the child controller
+ @param ProtocolGuid Supplies the protocol that the child controller
opens on its parent controller.
@retval EFI_SUCCESS ChildHandle is a child of the ControllerHandle.
@@ -676,7 +673,7 @@ EfiCreateEventLegacyBootEx ( the EDK/EFI 1.10 form and EDKII/UEFI 2.0 form and allows common code to
work both ways.
- @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
+ @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@retval EFI_SUCCESS Event was created.
@retval Other Event was not created.
@@ -701,7 +698,7 @@ EfiCreateEventReadyToBoot ( @param NotifyTpl The task priority level of the event.
@param NotifyFunction The notification function to call when the event is signaled.
@param NotifyContext The content to pass to NotifyFunction when the event is signaled.
- @param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
+ @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@retval EFI_SUCCESS Event was created.
@retval Other Event was not created.
|