From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.100; helo=mga07.intel.com; envelope-from=jiaxin.wu@intel.com; receiver=edk2-devel@lists.01.org Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id E75F3208F7A23 for ; Thu, 21 Dec 2017 00:48:12 -0800 (PST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga105.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 21 Dec 2017 00:53:01 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.45,435,1508828400"; d="scan'208";a="13570268" Received: from fmsmsx105.amr.corp.intel.com ([10.18.124.203]) by FMSMGA003.fm.intel.com with ESMTP; 21 Dec 2017 00:53:00 -0800 Received: from fmsmsx152.amr.corp.intel.com (10.18.125.5) by FMSMSX105.amr.corp.intel.com (10.18.124.203) with Microsoft SMTP Server (TLS) id 14.3.319.2; Thu, 21 Dec 2017 00:53:00 -0800 Received: from shsmsx152.ccr.corp.intel.com (10.239.6.52) by FMSMSX152.amr.corp.intel.com (10.18.125.5) with Microsoft SMTP Server (TLS) id 14.3.319.2; Thu, 21 Dec 2017 00:52:59 -0800 Received: from shsmsx103.ccr.corp.intel.com ([169.254.4.213]) by SHSMSX152.ccr.corp.intel.com ([169.254.6.93]) with mapi id 14.03.0319.002; Thu, 21 Dec 2017 16:52:58 +0800 From: "Wu, Jiaxin" To: "Fu, Siyuan" , "edk2-devel@lists.01.org" CC: "Ye, Ting" , "Wang, Fan" Thread-Topic: [edk2] [Patch] MdeModulePkg/IpIoDxe: Update API description to match the function implementation. Thread-Index: AQHTc+ReitDI0mUce0aqMs10gz47K6NNii4g Date: Thu, 21 Dec 2017 08:52:58 +0000 Message-ID: <895558F6EA4E3B41AC93A00D163B727416355B23@SHSMSX103.ccr.corp.intel.com> References: <20171213073055.13668-1-siyuan.fu@intel.com> In-Reply-To: <20171213073055.13668-1-siyuan.fu@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNWIwMmQyMGEtNDZmNS00OGM0LTg3ZTUtNzhkMjliZDBlYzZlIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6IjREejBvTURFWGFDZkRROTFQT21vSjlnR2J6bDEzVXcrSG4wOEtvMloreEE9In0= x-ctpclassification: CTP_IC dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [Patch] MdeModulePkg/IpIoDxe: Update API description to match the function implementation. X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 21 Dec 2017 08:48:13 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Hi Siyuan , I can't apply this patch, but looks good to me. Reviewed-by: Jiaxin Wu Thanks, Jiaxin > -----Original Message----- > From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Fu= , > Siyuan > Sent: Wednesday, December 13, 2017 3:31 PM > To: edk2-devel@lists.01.org > Cc: Ye, Ting ; Wang, Fan ; Wu, > Jiaxin > Subject: [edk2] [Patch] MdeModulePkg/IpIoDxe: Update API description to > match the function implementation. >=20 > This patch updates some API descriptions in DxeIpIoLib to match the real > implementation. >=20 > Cc: Ye Ting > Cc: Wu Jiaxin > Cc: Wang Fan > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Fu Siyuan > --- > MdeModulePkg/Include/Library/IpIoLib.h | 4 ++++ > MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c | 34 > +++++++++++++++++++++------- > 2 files changed, 30 insertions(+), 8 deletions(-) >=20 > diff --git a/MdeModulePkg/Include/Library/IpIoLib.h > b/MdeModulePkg/Include/Library/IpIoLib.h > index aab0c68059..ecb3f11e5c 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. >=20 > **/ > @@ -416,6 +417,7 @@ IpIoOpen ( > @retval EFI_SUCCESS The operation completed success= fully. > @retval EFI_NOT_STARTED The IpIo is not configured. > @retval EFI_OUT_OF_RESOURCES Failed due to resource limitati= ons. > + @retval Others Error condition occurred. >=20 > **/ > EFI_STATUS > @@ -541,6 +543,7 @@ IpIoFindSender ( > @param[out] IsHard If TRUE, indicates that it is a har= d error. > @param[out] Notify If TRUE, SockError needs to be noti= fied. >=20 > + @retval EFI_UNSUPPORTED Unrecognizable ICMP error code > @return The ICMP Error Status, such as EFI_NETWORK_UNREACHABLE. >=20 > **/ > @@ -574,6 +577,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 s= upport > neighbor cache refresh. > @retval EFI_OUT_OF_RESOURCES Failed due to resource limitations. >=20 > **/ > diff --git a/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c > b/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c > index abc07fb0ff..c880818d42 100644 > --- a/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c > +++ b/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c > @@ -129,6 +129,7 @@ IpIoTransmitHandler ( >=20 > @retval EFI_SUCCESS The IP child is created and the IP pr= otocol > interface is retrieved. > + @retval EFI_UNSUPPORTED Upsupported IpVersion. > @retval Others The required operation failed. >=20 > **/ > @@ -206,6 +207,7 @@ IpIoCreateIpChildOpenProtocol ( >=20 > @retval EFI_SUCCESS The IP protocol is closed and the rele= vant IP > child > is destroyed. > + @retval EFI_UNSUPPORTED Upsupported IpVersion. > @retval Others The required operation failed. >=20 > **/ > @@ -1276,6 +1278,7 @@ ReleaseIpIo: > successfully. > @retval EFI_ACCESS_DENIED The IP_IO instance is configured, = avoid to > reopen it. > + @retval EFI_UNSUPPORTED IPv4 RawData mode is no supported. > @retval Others Error condition occurred. >=20 > **/ > @@ -1488,20 +1491,28 @@ IpIoDestroy ( > IN OUT IP_IO *IpIo > ) > { > + EFI_STATUS Status; > + > // > // Stop the IpIo. > // > - IpIoStop (IpIo); > + Status =3D IpIoStop (IpIo); > + if (EFI_ERROR (Status)) { > + return Status; > + } >=20 > // > // Close the IP protocol and destroy the child. > // > - IpIoCloseProtocolDestroyIpChild ( > - IpIo->Controller, > - IpIo->Image, > - IpIo->ChildHandle, > - IpIo->IpVersion > - ); > + Status =3D IpIoCloseProtocolDestroyIpChild ( > + IpIo->Controller, > + IpIo->Image, > + IpIo->ChildHandle, > + IpIo->IpVersion > + ); > + if (EFI_ERROR (Status)) { > + return Status; > + } >=20 > gBS->FreePool (IpIo); >=20 > @@ -1530,6 +1541,7 @@ IpIoDestroy ( > @retval EFI_SUCCESS The operation is completed succ= essfully. > @retval EFI_NOT_STARTED The IpIo is not configured. > @retval EFI_OUT_OF_RESOURCES Failed due to resource limit. > + @retval Others Error condition occurred. >=20 > **/ > EFI_STATUS > @@ -2044,6 +2056,7 @@ IpIoFindSender ( > @param[out] IsHard If TRUE, indicates that it is a har= d error. > @param[out] Notify If TRUE, SockError needs to be noti= fied. >=20 > + @retval EFI_UNSUPPORTED Unrecognizable ICMP error code. > @return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE. >=20 > **/ > @@ -2162,6 +2175,7 @@ IpIoGetIcmpErrStatus ( > @retval EFI_INVALID_PARAMETER 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 s= upport > neighbor cache refresh. > @retval EFI_OUT_OF_RESOURCES Failed due to resource limit. >=20 > **/ > @@ -2174,10 +2188,14 @@ IpIoRefreshNeighbor ( > { > EFI_IP6_PROTOCOL *Ip; >=20 > - if (!IpIo->IsConfigured || IpIo->IpVersion !=3D IP_VERSION_6) { > + if (!IpIo->IsConfigured) { > return EFI_NOT_STARTED; > } >=20 > + if (IpIo->IpVersion !=3D IP_VERSION_6) { > + return EFI_UNSUPPORTED; > + } > + > Ip =3D IpIo->Ip.Ip6; >=20 > return Ip->Neighbors (Ip, FALSE, &Neighbor->v6, NULL, Timeout, TRUE); > -- > 2.13.0.windows.1 >=20 > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel