summaryrefslogtreecommitdiff
path: root/MdeModulePkg
diff options
context:
space:
mode:
authorlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>2008-02-25 06:29:00 +0000
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>2008-02-25 06:29:00 +0000
commit2ae8963ce89f711acd773b85ca4fe7458b9b0b84 (patch)
tree136aa3d74f68425f20ff25915de5eb9089cf5488 /MdeModulePkg
parentad42b17a754b63a1f556eac364e55f412eae509d (diff)
downloadedk2-platforms-2ae8963ce89f711acd773b85ca4fe7458b9b0b84.tar.xz
Add comments for parameter.
Add ASSERT for the input parameters. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4749 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg')
-rw-r--r--MdeModulePkg/Include/Library/CapsuleLib.h4
-rw-r--r--MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.c4
-rw-r--r--MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c16
3 files changed, 23 insertions, 1 deletions
diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h b/MdeModulePkg/Include/Library/CapsuleLib.h
index b8691bc4ab..8f411458d1 100644
--- a/MdeModulePkg/Include/Library/CapsuleLib.h
+++ b/MdeModulePkg/Include/Library/CapsuleLib.h
@@ -19,6 +19,8 @@
/**
Those capsules supported by the firmwares.
+ @param CapsuleHeader Point to the UEFI capsule image to be checked.
+
@retval EFI_SUCESS Input capsule is supported by firmware.
@retval EFI_UNSUPPORTED Input capsule is not supported by the firmware.
**/
@@ -32,6 +34,8 @@ SupportCapsuleImage (
/**
The firmware implements to process the capsule image.
+ @param CapsuleHeader Point to the UEFI capsule image to be processed.
+
@retval EFI_SUCESS Process Capsule Image successfully.
@retval EFI_UNSUPPORTED Capsule image is not supported by the firmware.
**/
diff --git a/MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.c b/MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.c
index a74bf75ced..1b88b3a612 100644
--- a/MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.c
+++ b/MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.c
@@ -17,6 +17,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Those capsules supported by the firmwares.
+ @param CapsuleHeader Point to the UEFI capsule image to be checked.
+
@retval EFI_SUCESS Input capsule is supported by firmware.
@retval EFI_UNSUPPORTED Input capsule is not supported by the firmware.
**/
@@ -32,6 +34,8 @@ SupportCapsuleImage (
/**
The firmware implements to process the capsule image.
+ @param CapsuleHeader Point to the UEFI capsule image to be processed.
+
@retval EFI_SUCESS Process Capsule Image successfully.
@retval EFI_UNSUPPORTED Capsule image is not supported by the firmware.
**/
diff --git a/MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c b/MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c
index db415a1143..bf77d80d6f 100644
--- a/MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c
+++ b/MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c
@@ -355,9 +355,12 @@ EfiFvbReadBlock (
IN EFI_LBA Lba,
IN UINTN Offset,
IN OUT UINTN *NumBytes,
- IN UINT8 *Buffer
+ OUT UINT8 *Buffer
)
{
+ ASSERT (NumBytes != NULL);
+ ASSERT (Buffer != NULL);
+
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
@@ -394,6 +397,8 @@ EfiFvbWriteBlock (
IN UINT8 *Buffer
)
{
+ ASSERT (NumBytes != NULL);
+
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
@@ -449,6 +454,8 @@ EfiFvbGetVolumeAttributes (
OUT EFI_FVB_ATTRIBUTES *Attributes
)
{
+ ASSERT (Attributes != NULL);
+
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
@@ -481,6 +488,8 @@ EfiFvbSetVolumeAttributes (
IN OUT EFI_FVB_ATTRIBUTES *Attributes
)
{
+ ASSERT (Attributes != NULL);
+
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
@@ -511,6 +520,8 @@ EfiFvbGetPhysicalAddress (
OUT EFI_PHYSICAL_ADDRESS *BaseAddress
)
{
+ ASSERT (BaseAddress != NULL);
+
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
@@ -547,6 +558,9 @@ EfiFvbGetBlockSize (
OUT UINTN *NumOfBlocks
)
{
+ ASSERT (BlockSize != NULL);
+ ASSERT (NumOfBlocks != NULL);
+
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}