diff options
| author | Fu Siyuan <siyuan.fu@intel.com> | 2017-12-13 15:30:14 +0800 |
|---|---|---|
| committer | Fu Siyuan <siyuan.fu@intel.com> | 2017-12-22 13:37:08 +0800 |
| commit | 6dbfed92f8cdcd35a09267327c0f9a876d180928 (patch) | |
| tree | bdd6280501896daa9fbf86f6dcc7ad0030061441 /MdeModulePkg/Include/Library | |
| parent | c167ef913106048db68acfdbe27987a79fefda82 (diff) | |
| download | edk2-6dbfed92f8cdcd35a09267327c0f9a876d180928.tar.gz edk2-6dbfed92f8cdcd35a09267327c0f9a876d180928.tar.bz2 edk2-6dbfed92f8cdcd35a09267327c0f9a876d180928.zip | |
MdeModulePkg/IpIoDxe: Update API description to match the function implementation.
This patch updates some API descriptions in DxeIpIoLib to match the real
implementation.
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 | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/MdeModulePkg/Include/Library/IpIoLib.h b/MdeModulePkg/Include/Library/IpIoLib.h index 059eb05f17..bae7113407 100644 --- a/MdeModulePkg/Include/Library/IpIoLib.h +++ b/MdeModulePkg/Include/Library/IpIoLib.h @@ -385,6 +385,7 @@ IpIoStop ( successfully.
@retval EFI_ACCESS_DENIED The IP_IO instance is configured; avoid
reopening it.
+ @retval EFI_UNSUPPORTED IPv4 RawData mode is no supported.
@retval Others An error condition occurred.
**/
@@ -418,6 +419,7 @@ IpIoOpen ( @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 limit.
+ @retval Others Error condition occurred.
**/
EFI_STATUS
@@ -543,6 +545,7 @@ IpIoFindSender ( @param[out] IsHard If TRUE, indicates that it is a hard error.
@param[out] Notify If TRUE, SockError needs to be notified.
+ @retval EFI_UNSUPPORTED Unrecognizable ICMP error code
@return The ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.
**/
@@ -576,6 +579,7 @@ IpIoGetIcmpErrStatus ( @retval EFI_INVALID_PARAMETER The Neighbor Address is invalid.
@retval EFI_NOT_FOUND The neighbor cache entry is not in the
neighbor table.
+ @retval EFI_UNSUPPORTED IP version is IPv4, which doesn't support neighbor cache refresh.
@retval EFI_OUT_OF_RESOURCES Failed due to resource limitations.
**/
|