diff options
| author | Fu Siyuan <siyuan.fu@intel.com> | 2017-12-13 14:41:37 +0800 |
|---|---|---|
| committer | Fu Siyuan <siyuan.fu@intel.com> | 2017-12-18 08:57:41 +0800 |
| commit | 8569a87ef0e11127d3d138c1bbb50447256dbaa0 (patch) | |
| tree | d5750164f7d00f731ad126bd806ba4da3d444be2 /MdeModulePkg/Include/Library | |
| parent | 72bdc5f09362872c8865774a9bf003b6b35dcbc1 (diff) | |
| download | edk2-8569a87ef0e11127d3d138c1bbb50447256dbaa0.tar.gz edk2-8569a87ef0e11127d3d138c1bbb50447256dbaa0.tar.bz2 edk2-8569a87ef0e11127d3d138c1bbb50447256dbaa0.zip | |
MdeModulePkg/IpIoLib: return error instead of ASSERT if input parameter is incorrect.
This patch updates the DxeIpIoLib to return EFI_INVALID_PARAMETER instead of
ASSERT if the input pointers are not correct.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Fu Siyuan <siyuan.fu@intel.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>
Diffstat (limited to 'MdeModulePkg/Include/Library')
| -rw-r--r-- | MdeModulePkg/Include/Library/IpIoLib.h | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/MdeModulePkg/Include/Library/IpIoLib.h b/MdeModulePkg/Include/Library/IpIoLib.h index aab0c68059..0bebdb73b5 100644 --- 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.
It provides the combined IpIo layer on the EFI IP4 Protocol and EFI IP6 protocol.
-Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
@@ -399,23 +399,25 @@ IpIoOpen ( Send out an IP packet.
This function is called after IpIoOpen(). The data to be sent are wrapped in
- Pkt. The IP instance wrapped in IpIo is used for sending by default, but can be
- overriden by Sender. Other sending configurations, such as source address and gateway
- address, are specified in OverrideData.
+ Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
+ overriden by Sender. Other sending configs, like source address and gateway
+ address etc., are specified in OverrideData.
- @param[in, out] IpIo The pointer to an IP_IO instance used for sending IP
+ @param[in, out] IpIo Pointer to an IP_IO instance used for sending IP
packet.
- @param[in, out] Pkt The pointer to the IP packet to be sent.
- @param[in] Sender Optional. The IP protocol instance used for sending.
- @param[in] Context The optional context data.
- @param[in] NotifyData The optional notify data.
+ @param[in, out] Pkt Pointer to the IP packet to be sent.
+ @param[in] Sender The IP protocol instance used for sending.
+ @param[in] Context Optional context data.
+ @param[in] NotifyData Optional notify data.
@param[in] Dest The destination IP address to send this packet to.
+ This parameter is optional when using IPv6.
@param[in] OverrideData The data to override some configuration of the IP
instance used for sending.
- @retval EFI_SUCCESS The operation completed successfully.
+ @retval EFI_SUCCESS The operation is completed successfully.
+ @retval EFI_INVALID_PARAMETER The input parameter is not correct.
@retval EFI_NOT_STARTED The IpIo is not configured.
- @retval EFI_OUT_OF_RESOURCES Failed due to resource limitations.
+ @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
**/
EFI_STATUS
|