sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

MdeModulePkg/IpIoDxe: Update API description to match the function implementation.

Browse Source 
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>
This commit is contained in:
Fu Siyuan
2017-12-13 15:30:14 +08:00
parent c167ef9131
commit 6dbfed92f8
2 changed files with 30 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
MdeModulePkg/Include/Library/IpIoLib.h
View File

@@ -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.
**/