MdeModulePkg/IpIoLib: return error instead of ASSERT if input parameter is incorrect.

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

diff --git a/MdeModulePkg/Include/Library/IpIoLib.h b/MdeModulePkg/Include/Library/IpIoLib.h
index aab0c6805948573cd37a5be372eead13418e7dcd..0bebdb73b5b32ebd6df05a7a01c7bd23e5df53b8 100644 (file)
--- a/MdeModulePkg/Include/Library/IpIoLib.h
+++ b/MdeModulePkg/Include/Library/IpIoLib.h
@@ -2,7 +2,7 @@
   This library is only intended to be used by UEFI network stack modules.\r
   It provides the combined IpIo layer on the EFI IP4 Protocol and EFI IP6 protocol.\r
 \r
-Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -399,23 +399,25 @@ IpIoOpen (
   Send out an IP packet.\r
   \r
   This function is called after IpIoOpen(). The data to be sent are wrapped in\r
-  Pkt. The IP instance wrapped in IpIo is used for sending by default, but can be\r
-  overriden by Sender. Other sending configurations, such as source address and gateway\r
-  address, are specified in OverrideData.\r
+  Pkt. The IP instance wrapped in IpIo is used for sending by default but can be\r
+  overriden by Sender. Other sending configs, like source address and gateway\r
+  address etc., are specified in OverrideData.\r
 \r
-  @param[in, out]  IpIo                  The pointer to an IP_IO instance used for sending IP\r
+  @param[in, out]  IpIo                  Pointer to an IP_IO instance used for sending IP\r
                                          packet.\r
-  @param[in, out]  Pkt                   The pointer to the IP packet to be sent.\r
-  @param[in]       Sender                Optional. The IP protocol instance used for sending.\r
-  @param[in]       Context               The optional context data.\r
-  @param[in]       NotifyData            The optional notify data.\r
+  @param[in, out]  Pkt                   Pointer to the IP packet to be sent.\r
+  @param[in]       Sender                The IP protocol instance used for sending.\r
+  @param[in]       Context               Optional context data.\r
+  @param[in]       NotifyData            Optional notify data.\r
   @param[in]       Dest                  The destination IP address to send this packet to.\r
+                                         This parameter is optional when using IPv6.\r
   @param[in]       OverrideData          The data to override some configuration of the IP\r
                                          instance used for sending.\r
 \r
-  @retval          EFI_SUCCESS           The operation completed successfully.\r
+  @retval          EFI_SUCCESS           The operation is completed successfully.\r
+  @retval          EFI_INVALID_PARAMETER The input parameter is not correct.\r
   @retval          EFI_NOT_STARTED       The IpIo is not configured.\r
-  @retval          EFI_OUT_OF_RESOURCES  Failed due to resource limitations.\r
+  @retval          EFI_OUT_OF_RESOURCES  Failed due to resource limit.\r
 \r
 **/\r
 EFI_STATUS\r