tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NetworkPkg/UefiPxeBcDxe: Correct comments to align with the input parameter. 

Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1230

Cc: Fu Siyuan <siyuan.fu@intel.com>
Cc: Ye Ting <ting.ye@intel.com>
Cc: Bi Dandan <dandan.bi@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com>
Reviewed-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>
This commit is contained in:
Jiaxin Wu 2018-10-08 10:48:20 +08:00
parent fab334b278
commit e8601e972f
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.c
View File

@ -1,7 +1,7 @@
/** @file /** @file
Functions implementation related with Mtftp for UefiPxeBc Driver. Functions implementation related with Mtftp for UefiPxeBc Driver.
Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR> Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -109,6 +109,7 @@ PxeBcMtftp6CheckPacket (
@param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA. @param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Sucessfully obtained the size of file. @retval EFI_SUCCESS Sucessfully obtained the size of file.
@ -248,6 +249,7 @@ ON_ERROR:
@param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA. @param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer. @param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether with a receive buffer. @param[in] DontUseBuffer Indicates whether with a receive buffer.
@ -416,6 +418,7 @@ PxeBcMtftp6WriteFile (
@param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA. @param[in] Config Pointer to EFI_MTFTP6_CONFIG_DATA.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer. @param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer. @param[in] DontUseBuffer Indicates whether to use a receive buffer.
@ -586,6 +589,7 @@ PxeBcMtftp4CheckPacket (
@param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA. @param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Successfully obtained the size of file. @retval EFI_SUCCESS Successfully obtained the size of file.
@ -725,6 +729,7 @@ ON_ERROR:
@param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA. @param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer. @param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer. @param[in] DontUseBuffer Indicates whether to use a receive buffer.
@ -892,6 +897,7 @@ PxeBcMtftp4WriteFile (
@param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA. @param[in] Config Pointer to EFI_MTFTP4_CONFIG_DATA.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer. @param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer. @param[in] DontUseBuffer Indicates whether to use a receive buffer.
@ -984,6 +990,7 @@ PxeBcMtftp4ReadDirectory (
@param[in] Config Pointer to configure data. @param[in] Config Pointer to configure data.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Successfully obtained the size of file. @retval EFI_SUCCESS Successfully obtained the size of file.
@ -1031,6 +1038,7 @@ PxeBcTftpGetFileSize (
@param[in] Config Pointer to config data. @param[in] Config Pointer to config data.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer. @param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer. @param[in] DontUseBuffer Indicates whether to use a receive buffer.
@ -1136,6 +1144,7 @@ PxeBcTftpWriteFile (
@param[in] Config Pointer to config data. @param[in] Config Pointer to config data.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer. @param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicatse whether to use a receive buffer. @param[in] DontUseBuffer Indicatse whether to use a receive buffer.

5
NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
View File

@ -1,7 +1,7 @@
/** @file /** @file
Functions declaration related with Mtftp for UefiPxeBc Driver. Functions declaration related with Mtftp for UefiPxeBc Driver.
Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR> Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -35,6 +35,7 @@
@param[in] Config Pointer to configure data. @param[in] Config Pointer to configure data.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@retval EFI_SUCCESS Successfully obtained the size of file. @retval EFI_SUCCESS Successfully obtained the size of file.
@ -61,6 +62,7 @@ PxeBcTftpGetFileSize (
@param[in] Config Pointer to config data. @param[in] Config Pointer to config data.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer. @param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether to use a receive buffer. @param[in] DontUseBuffer Indicates whether to use a receive buffer.
@ -118,6 +120,7 @@ PxeBcTftpWriteFile (
@param[in] Config Pointer to config data. @param[in] Config Pointer to config data.
@param[in] Filename Pointer to boot file name. @param[in] Filename Pointer to boot file name.
@param[in] BlockSize Pointer to required block size. @param[in] BlockSize Pointer to required block size.
@param[in] WindowSize Pointer to required window size.
@param[in] BufferPtr Pointer to buffer. @param[in] BufferPtr Pointer to buffer.
@param[in, out] BufferSize Pointer to buffer size. @param[in, out] BufferSize Pointer to buffer size.
@param[in] DontUseBuffer Indicates whether with a receive buffer. @param[in] DontUseBuffer Indicates whether with a receive buffer.