Add comments for parameter.
authorlgao4 <lgao4@de2fecce-e211-0410-80a6-f3fac2684e05>
Mon, 25 Feb 2008 06:29:00 +0000 (06:29 +0000)
committerlgao4 <lgao4@de2fecce-e211-0410-80a6-f3fac2684e05>
Mon, 25 Feb 2008 06:29:00 +0000 (06:29 +0000)
Add ASSERT for the input parameters.

git-svn-id: https://edk2.tianocore.org/svn/edk2/trunk@4749 de2fecce-e211-0410-80a6-f3fac2684e05

edk2/MdeModulePkg/Include/Library/CapsuleLib.h
edk2/MdeModulePkg/Library/DxeCapsuleLibNull/DxeCapsuleLibNull.c
edk2/MdeModulePkg/Library/EdkFvbServiceLib/Fvb.c

index b8691bc..8f41145 100644 (file)
@@ -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
index a74bf75..1b88b3a 100644 (file)
@@ -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
index db415a1..bf77d80 100644 (file)
@@ -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