From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.93; helo=mga11.intel.com; envelope-from=jiaxin.wu@intel.com; receiver=edk2-devel@lists.01.org Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) (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 87AE321161B05 for ; Sun, 7 Oct 2018 20:03:32 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 07 Oct 2018 20:03:32 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.54,355,1534834800"; d="scan'208";a="90017799" Received: from jiaxinwu-mobl.ccr.corp.intel.com ([10.239.192.155]) by orsmga003.jf.intel.com with ESMTP; 07 Oct 2018 20:03:30 -0700 From: Jiaxin Wu To: edk2-devel@lists.01.org Cc: Fu Siyuan , Ye Ting , Bi Dandan , Wu Jiaxin Date: Mon, 8 Oct 2018 11:03:24 +0800 Message-Id: <20181008030325.4188-2-Jiaxin.wu@intel.com> X-Mailer: git-send-email 2.17.1.windows.2 In-Reply-To: <20181008030325.4188-1-Jiaxin.wu@intel.com> References: <20181008030325.4188-1-Jiaxin.wu@intel.com> Subject: [Patch 1/2] NetworkPkg/UefiPxeBcDxe: Correct comments to align with the input parameter. X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 08 Oct 2018 03:03:32 -0000 Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1230 Cc: Fu Siyuan Cc: Ye Ting Cc: Bi Dandan Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Wu Jiaxin --- NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c | 11 ++++++++++- NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h | 5 ++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c index 9725fb40dd..61d2d59675 100644 --- a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c +++ b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c @@ -1,9 +1,9 @@ /** @file Functions implementation related with Mtftp for UefiPxeBc Driver. - Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.
+ Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php. @@ -107,10 +107,11 @@ PxeBcMtftp6CheckPacket ( @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in, out] BufferSize Pointer to buffer size. @retval EFI_SUCCESS Sucessfully obtained the size of file. @retval EFI_NOT_FOUND Parse the tftp ptions failed. @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. @@ -246,10 +247,11 @@ ON_ERROR: @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in] BufferPtr Pointer to buffer. @param[in, out] BufferSize Pointer to buffer size. @param[in] DontUseBuffer Indicates whether with a receive buffer. @retval EFI_SUCCESS Successfully read the data from the special file. @@ -414,10 +416,11 @@ PxeBcMtftp6WriteFile ( @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in] BufferPtr Pointer to buffer. @param[in, out] BufferSize Pointer to buffer size. @param[in] DontUseBuffer Indicates whether to use a receive buffer. @retval EFI_SUCCESS Successfully obtained the data from the file included in directory. @@ -584,10 +587,11 @@ PxeBcMtftp4CheckPacket ( @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in, out] BufferSize Pointer to buffer size. @retval EFI_SUCCESS Successfully obtained the size of file. @retval EFI_NOT_FOUND Parse the tftp options failed. @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. @@ -723,10 +727,11 @@ ON_ERROR: @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in] BufferPtr Pointer to buffer. @param[in, out] BufferSize Pointer to buffer size. @param[in] DontUseBuffer Indicates whether to use a receive buffer. @retval EFI_SUCCESS Successfully read the data from the special file. @@ -890,10 +895,11 @@ PxeBcMtftp4WriteFile ( @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in] BufferPtr Pointer to buffer. @param[in, out] BufferSize Pointer to buffer size. @param[in] DontUseBuffer Indicates whether to use a receive buffer. @retval EFI_SUCCES Successfully obtained the data from the file included in the directory. @@ -982,10 +988,11 @@ PxeBcMtftp4ReadDirectory ( @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to configure data. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in, out] BufferSize Pointer to buffer size. @retval EFI_SUCCESS Successfully obtained the size of file. @retval EFI_NOT_FOUND Parse the tftp options failed. @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. @@ -1029,10 +1036,11 @@ PxeBcTftpGetFileSize ( @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to config data. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in] BufferPtr Pointer to buffer. @param[in, out] BufferSize Pointer to buffer size. @param[in] DontUseBuffer Indicates whether to use a receive buffer. @retval EFI_SUCCESS Sucessfully read the data from the special file. @@ -1134,10 +1142,11 @@ PxeBcTftpWriteFile ( @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to config data. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in] BufferPtr Pointer to buffer. @param[in, out] BufferSize Pointer to buffer size. @param[in] DontUseBuffer Indicatse whether to use a receive buffer. @retval EFI_SUCCES Successfully obtained the data from the file included in the directory. diff --git a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h index edd8decbd8..30d5cfe343 100644 --- a/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h +++ b/NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h @@ -1,9 +1,9 @@ /** @file Functions declaration related with Mtftp for UefiPxeBc Driver. - Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.
+ Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php. @@ -33,10 +33,11 @@ @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to configure data. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in, out] BufferSize Pointer to buffer size. @retval EFI_SUCCESS Successfully obtained the size of file. @retval EFI_NOT_FOUND Parse the tftp ptions failed. @retval EFI_DEVICE_ERROR The network device encountered an error during this operation. @@ -59,10 +60,11 @@ PxeBcTftpGetFileSize ( @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to config data. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in] BufferPtr Pointer to buffer. @param[in, out] BufferSize Pointer to buffer size. @param[in] DontUseBuffer Indicates whether to use a receive buffer. @retval EFI_SUCCESS Successfully read the data from the special file. @@ -116,10 +118,11 @@ PxeBcTftpWriteFile ( @param[in] Private Pointer to PxeBc private data. @param[in] Config Pointer to config data. @param[in] Filename Pointer to boot file name. @param[in] BlockSize Pointer to required block size. + @param[in] WindowSize Pointer to required window size. @param[in] BufferPtr Pointer to buffer. @param[in, out] BufferSize Pointer to buffer size. @param[in] DontUseBuffer Indicates whether with a receive buffer. @retval EFI_SUCCES Successfully obtained the data from the file included in directory. -- 2.17.1.windows.2