summaryrefslogtreecommitdiff
path: root/MdePkg
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-04-22 06:12:08 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-04-22 06:12:08 +0000
commit01aef47bbe11b3961da5136b064d947540a38060 (patch)
tree7955cd56359ba1a460f1bb2c7f856486d6228897 /MdePkg
parent7459094d5f6904a0c8445d97519f4a99b654ef43 (diff)
downloadedk2-01aef47bbe11b3961da5136b064d947540a38060.zip
edk2-01aef47bbe11b3961da5136b064d947540a38060.tar.gz
edk2-01aef47bbe11b3961da5136b064d947540a38060.tar.bz2
Fix missing include header file and fix typo in comment.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5110 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg')
-rw-r--r--MdePkg/Include/Library/BaseLib.h12
-rw-r--r--MdePkg/Include/Library/HiiLib.h25
-rw-r--r--MdePkg/Include/Library/PeiServicesLib.h13
-rw-r--r--MdePkg/Include/Library/PeiServicesTablePointerLib.h2
-rw-r--r--MdePkg/Include/Library/UefiLib.h13
-rw-r--r--MdePkg/Include/Ppi/Smbus2.h3
-rw-r--r--MdePkg/Include/Protocol/ComponentName.h2
-rw-r--r--MdePkg/Include/Protocol/ComponentName2.h2
-rw-r--r--MdePkg/Include/Protocol/DriverBinding.h1
-rw-r--r--MdePkg/Include/Protocol/DriverConfiguration.h1
-rw-r--r--MdePkg/Include/Protocol/DriverConfiguration2.h2
-rw-r--r--MdePkg/Include/Protocol/DriverDiagnostics.h2
-rw-r--r--MdePkg/Include/Protocol/PciRootBridgeIo.h2
13 files changed, 43 insertions, 37 deletions
diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index ae14cc7..cf337b7 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 38e1e50..199a5ec 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 bed1105..23eeb6b 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 8c133dd..a5b32a5 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 bbc4aca..7daa23b 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.
diff --git a/MdePkg/Include/Ppi/Smbus2.h b/MdePkg/Include/Ppi/Smbus2.h
index 29cec31..7c4bd70 100644
--- a/MdePkg/Include/Ppi/Smbus2.h
+++ b/MdePkg/Include/Ppi/Smbus2.h
@@ -18,7 +18,7 @@
#ifndef _PEI_SMBUS2_PPI_H
#define _PEI_SMBUS2_PPI_H
-
+#include <PiPei.h>
#include <IndustryStandard/SmBus.h>
#define EFI_PEI_SMBUS2_PPI_GUID \
@@ -172,7 +172,6 @@ EFI_STATUS
The Notify() function registers all the callback functions to allow the
bus driver to call these functions when the SlaveAddress/Data pair happens.
- @param PeiServices A pointer to the system PEI Services Table.
@param This A pointer to the EFI_PEI_SMBUS_PPI instance.
@param SlaveAddress Address that the host controller detects as
sending a message and calls all the registered functions.
diff --git a/MdePkg/Include/Protocol/ComponentName.h b/MdePkg/Include/Protocol/ComponentName.h
index 79a714a..34dd5bd 100644
--- a/MdePkg/Include/Protocol/ComponentName.h
+++ b/MdePkg/Include/Protocol/ComponentName.h
@@ -15,6 +15,8 @@
#ifndef __EFI_COMPONENT_NAME_H__
#define __EFI_COMPONENT_NAME_H__
+#include <PiDxe.h>
+
//
// Global ID for the Component Name Protocol
//
diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h
index 2a907f5..d9fc6e1 100644
--- a/MdePkg/Include/Protocol/ComponentName2.h
+++ b/MdePkg/Include/Protocol/ComponentName2.h
@@ -15,6 +15,8 @@
#ifndef __EFI_COMPONENT_NAME2_H__
#define __EFI_COMPONENT_NAME2_H__
+#include <PiDxe.h>
+
//
// Global ID for the Component Name Protocol
//
diff --git a/MdePkg/Include/Protocol/DriverBinding.h b/MdePkg/Include/Protocol/DriverBinding.h
index 96b0b1b..9499e11 100644
--- a/MdePkg/Include/Protocol/DriverBinding.h
+++ b/MdePkg/Include/Protocol/DriverBinding.h
@@ -15,6 +15,7 @@
#ifndef __EFI_DRIVER_BINDING_H__
#define __EFI_DRIVER_BINDING_H__
+#include <PiDxe.h>
#include <Protocol/DevicePath.h>
//
// Global ID for the ControllerHandle Driver Protocol
diff --git a/MdePkg/Include/Protocol/DriverConfiguration.h b/MdePkg/Include/Protocol/DriverConfiguration.h
index 7f10318..c9d025a 100644
--- a/MdePkg/Include/Protocol/DriverConfiguration.h
+++ b/MdePkg/Include/Protocol/DriverConfiguration.h
@@ -15,6 +15,7 @@
#ifndef __EFI_DRIVER_CONFIGURATION_H__
#define __EFI_DRIVER_CONFIGURATION_H__
+#include <PiDxe.h>
#include <Protocol/DriverConfiguration2.h>
//
diff --git a/MdePkg/Include/Protocol/DriverConfiguration2.h b/MdePkg/Include/Protocol/DriverConfiguration2.h
index c1011ba..e4417e1 100644
--- a/MdePkg/Include/Protocol/DriverConfiguration2.h
+++ b/MdePkg/Include/Protocol/DriverConfiguration2.h
@@ -15,6 +15,8 @@
#ifndef __EFI_DRIVER_CONFIGURATION2_H__
#define __EFI_DRIVER_CONFIGURATION2_H__
+#include <PiDxe.h>
+
//
// Global ID for the Driver Configuration Protocol defined in UEFI 2.0
//
diff --git a/MdePkg/Include/Protocol/DriverDiagnostics.h b/MdePkg/Include/Protocol/DriverDiagnostics.h
index d04bf49..13670ae 100644
--- a/MdePkg/Include/Protocol/DriverDiagnostics.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics.h
@@ -15,6 +15,8 @@
#ifndef __EFI_DRIVER_DIAGNOSTICS_H__
#define __EFI_DRIVER_DIAGNOSTICS_H__
+#include <PiDxe.h>
+
//
// Global ID for the Driver Diagnostics Protocol as defined in UEFI 2.0.
//
diff --git a/MdePkg/Include/Protocol/PciRootBridgeIo.h b/MdePkg/Include/Protocol/PciRootBridgeIo.h
index 8b39f66..c55fb15 100644
--- a/MdePkg/Include/Protocol/PciRootBridgeIo.h
+++ b/MdePkg/Include/Protocol/PciRootBridgeIo.h
@@ -19,6 +19,8 @@
#ifndef __PCI_ROOT_BRIDGE_IO_H__
#define __PCI_ROOT_BRIDGE_IO_H__
+#include <PiDxe.h>
+
#define EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GUID \
{ \
0x2f707ebb, 0x4a1a, 0x11d4, {0x9a, 0x38, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \