MdeModulePkg/IpIoLib: Check the input parameters before use them.

[mirror_edk2.git] / MdeModulePkg / Include / Library / IpIoLib.h

diff --git a/MdeModulePkg/Include/Library/IpIoLib.h b/MdeModulePkg/Include/Library/IpIoLib.h
index bae7113407cb6abf074fed7e7c86f3cd13dd7d80..463bf95b499a51f310b25fe83103a3f6bb393285 100644 (file)
--- a/MdeModulePkg/Include/Library/IpIoLib.h
+++ b/MdeModulePkg/Include/Library/IpIoLib.h
@@ -359,8 +359,9 @@ IpIoDestroy (
 \r
   @param[in, out]  IpIo            The pointer to the IP_IO instance that needs to stop.\r
 \r
-  @retval          EFI_SUCCESS     The IP_IO instance stopped successfully.\r
-  @retval          Others          Anrror condition occurred.\r
+  @retval          EFI_SUCCESS            The IP_IO instance stopped successfully.\r
+  @retval          EFI_INVALID_PARAMETER  Invalid input parameter.\r
+  @retval          Others                 Anrror condition occurred.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -381,12 +382,13 @@ IpIoStop (
   @param[in]       OpenData           The configuration data and callbacks for\r
                                       the IP_IO instance.\r
 \r
-  @retval          EFI_SUCCESS        The IP_IO instance opened with OpenData\r
-                                      successfully.\r
-  @retval          EFI_ACCESS_DENIED  The IP_IO instance is configured; avoid  \r
-                                      reopening it.\r
-  @retval          EFI_UNSUPPORTED    IPv4 RawData mode is no supported.\r
-  @retval          Others             An error condition occurred.\r
+  @retval          EFI_SUCCESS            The IP_IO instance opened with OpenData\r
+                                          successfully.\r
+  @retval          EFI_ACCESS_DENIED      The IP_IO instance is configured, avoid to \r
+                                          reopen it.\r
+  @retval          EFI_UNSUPPORTED        IPv4 RawData mode is no supported.\r
+  @retval          EFI_INVALID_PARAMETER  Invalid input parameter.\r
+  @retval          Others                 Error condition occurred.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -522,7 +524,7 @@ IpIoRemoveIp (
   @param[in]       Src               The local IP address.\r
 \r
   @return The pointer to the IP protocol can be used for sending purpose and its local\r
-          address is the same with Src.\r
+          address is the same with Src. NULL if failed.\r
 \r
 **/\r
 IP_IO_IP_INFO *\r