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

diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h b/MdeModulePkg/Include/Library/CapsuleLib.h
index b8691bc4aba98a56d94f30289a343749cd2505c7..8f411458d139c9ec2eba24e7663542f92494cb3c 100644 (file)
--- a/MdeModulePkg/Include/Library/CapsuleLib.h
+++ b/MdeModulePkg/Include/Library/CapsuleLib.h
@@ -19,6 +19,8 @@
 /**\r
   Those capsules supported by the firmwares.\r
   \r
+  @param  CapsuleHeader    Point to the UEFI capsule image to be checked.\r
+  \r
   @retval EFI_SUCESS       Input capsule is supported by firmware.\r
   @retval EFI_UNSUPPORTED  Input capsule is not supported by the firmware.\r
 **/\r
@@ -32,6 +34,8 @@ SupportCapsuleImage (
 /**\r
   The firmware implements to process the capsule image.\r
   \r
+  @param  CapsuleHeader    Point to the UEFI capsule image to be processed. \r
+   \r
   @retval EFI_SUCESS       Process Capsule Image successfully. \r
   @retval EFI_UNSUPPORTED  Capsule image is not supported by the firmware.\r
 **/\r

diff --git a/MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.c b/MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.c
index a74bf75ced0804cdc1d50cb46d762e90997d5853..1b88b3a61283f8379f7ba4bfcf3936cde2665537 100644 (file)
--- 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.
 /**\r
   Those capsules supported by the firmwares.\r
   \r
+  @param  CapsuleHeader    Point to the UEFI capsule image to be checked.\r
+  \r
   @retval EFI_SUCESS       Input capsule is supported by firmware.\r
   @retval EFI_UNSUPPORTED  Input capsule is not supported by the firmware.\r
 **/\r
@@ -32,6 +34,8 @@ SupportCapsuleImage (
 /**\r
   The firmware implements to process the capsule image.\r
   \r
+  @param  CapsuleHeader    Point to the UEFI capsule image to be processed. \r
+   \r
   @retval EFI_SUCESS       Process Capsule Image successfully. \r
   @retval EFI_UNSUPPORTED  Capsule image is not supported by the firmware.\r
 **/\r

diff --git a/MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c b/MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c
index db415a11435f032604c52c71eb912b15e841453f..bf77d80d6f6d7ba4f5fd9c047d2f1c5b10c0feaa 100644 (file)
--- a/MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c
+++ b/MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c
@@ -355,9 +355,12 @@ EfiFvbReadBlock (
   IN EFI_LBA                                      Lba,\r
   IN UINTN                                        Offset,\r
   IN OUT UINTN                                    *NumBytes,\r
-  IN UINT8                                        *Buffer\r
+  OUT UINT8                                       *Buffer\r
   )\r
 {\r
+  ASSERT (NumBytes != NULL);\r
+  ASSERT (Buffer != NULL);\r
+  \r
   if (Instance >= mFvbCount) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
@@ -394,6 +397,8 @@ EfiFvbWriteBlock (
   IN UINT8                                        *Buffer\r
   )\r
 {\r
+  ASSERT (NumBytes != NULL);\r
+  \r
   if (Instance >= mFvbCount) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
@@ -449,6 +454,8 @@ EfiFvbGetVolumeAttributes (
   OUT EFI_FVB_ATTRIBUTES                  *Attributes\r
   )\r
 {\r
+  ASSERT (Attributes != NULL);\r
+  \r
   if (Instance >= mFvbCount) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
@@ -481,6 +488,8 @@ EfiFvbSetVolumeAttributes (
   IN OUT EFI_FVB_ATTRIBUTES                   *Attributes\r
   )\r
 {\r
+  ASSERT (Attributes != NULL);\r
+  \r
   if (Instance >= mFvbCount) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
@@ -511,6 +520,8 @@ EfiFvbGetPhysicalAddress (
   OUT EFI_PHYSICAL_ADDRESS                *BaseAddress\r
   )\r
 {\r
+  ASSERT (BaseAddress != NULL);\r
+  \r
   if (Instance >= mFvbCount) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
@@ -547,6 +558,9 @@ EfiFvbGetBlockSize (
   OUT UINTN                                       *NumOfBlocks\r
   )\r
 {\r
+  ASSERT (BlockSize != NULL);\r
+  ASSERT (NumOfBlocks != NULL);\r
+  \r
   if (Instance >= mFvbCount) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r