]> git.proxmox.com Git - mirror_edk2.git/blobdiff - NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / NetworkPkg / UefiPxeBcDxe / PxeBcMtftp.h
index f1150762c6e0eb8678724ef7b3d23750ce4b58b0..0b0cfd195b2ac0cd17e864352556e514c318e8e3 100644 (file)
@@ -1,15 +1,9 @@
 /** @file\r
   Functions declaration related with Mtftp for UefiPxeBc Driver.\r
 \r
-  Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
 \r
-  This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php.\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
 #define PXE_MTFTP_OPTION_TIMEOUT_INDEX     1\r
 #define PXE_MTFTP_OPTION_TSIZE_INDEX       2\r
 #define PXE_MTFTP_OPTION_MULTICAST_INDEX   3\r
-#define PXE_MTFTP_OPTION_MAXIMUM_INDEX     4\r
+#define PXE_MTFTP_OPTION_WINDOWSIZE_INDEX  4\r
+#define PXE_MTFTP_OPTION_MAXIMUM_INDEX     5\r
 #define PXE_MTFTP_OPTBUF_MAXNUM_INDEX      128\r
 \r
-#define PXE_MTFTP_ERROR_STRING_LENGTH      127   // refer to definition of struct EFI_PXE_BASE_CODE_TFTP_ERROR.\r
-#define PXE_MTFTP_DEFAULT_BLOCK_SIZE       512   // refer to rfc-1350.\r
-\r
+#define PXE_MTFTP_ERROR_STRING_LENGTH  127       // refer to definition of struct EFI_PXE_BASE_CODE_TFTP_ERROR.\r
+#define PXE_MTFTP_DEFAULT_BLOCK_SIZE   512       // refer to rfc-1350.\r
 \r
 /**\r
   This function is wrapper to get the file size using TFTP.\r
   @param[in]      Config         Pointer to configure data.\r
   @param[in]      Filename       Pointer to boot file name.\r
   @param[in]      BlockSize      Pointer to required block size.\r
+  @param[in]      WindowSize     Pointer to required window size.\r
   @param[in, out] BufferSize     Pointer to buffer size.\r
 \r
   @retval EFI_SUCCESS        Successfully obtained the size of file.\r
-  @retval EFI_NOT_FOUND      Parse the tftp ptions failed.\r
+  @retval EFI_NOT_FOUND      Parse the tftp options failed.\r
   @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
   @retval Others             Did not obtain the size of the file.\r
 \r
 **/\r
 EFI_STATUS\r
 PxeBcTftpGetFileSize (\r
-  IN     PXEBC_PRIVATE_DATA         *Private,\r
-  IN     VOID                       *Config,\r
-  IN     UINT8                      *Filename,\r
-  IN     UINTN                      *BlockSize,\r
-  IN OUT UINT64                     *BufferSize\r
+  IN     PXEBC_PRIVATE_DATA  *Private,\r
+  IN     VOID                *Config,\r
+  IN     UINT8               *Filename,\r
+  IN     UINTN               *BlockSize,\r
+  IN     UINTN               *WindowSize,\r
+  IN OUT UINT64              *BufferSize\r
   );\r
 \r
-\r
 /**\r
   This function is a wrapper to get a file using TFTP.\r
 \r
@@ -59,6 +54,7 @@ PxeBcTftpGetFileSize (
   @param[in]      Config         Pointer to config data.\r
   @param[in]      Filename       Pointer to boot file name.\r
   @param[in]      BlockSize      Pointer to required block size.\r
+  @param[in]      WindowSize     Pointer to required window size.\r
   @param[in]      BufferPtr      Pointer to buffer.\r
   @param[in, out] BufferSize     Pointer to buffer size.\r
   @param[in]      DontUseBuffer  Indicates whether to use a receive buffer.\r
@@ -70,16 +66,16 @@ PxeBcTftpGetFileSize (
 **/\r
 EFI_STATUS\r
 PxeBcTftpReadFile (\r
-  IN     PXEBC_PRIVATE_DATA         *Private,\r
-  IN     VOID                       *Config,\r
-  IN     UINT8                      *Filename,\r
-  IN     UINTN                      *BlockSize,\r
-  IN     UINT8                      *BufferPtr,\r
-  IN OUT UINT64                     *BufferSize,\r
-  IN     BOOLEAN                    DontUseBuffer\r
+  IN     PXEBC_PRIVATE_DATA  *Private,\r
+  IN     VOID                *Config,\r
+  IN     UINT8               *Filename,\r
+  IN     UINTN               *BlockSize,\r
+  IN     UINTN               *WindowSize,\r
+  IN     UINT8               *BufferPtr,\r
+  IN OUT UINT64              *BufferSize,\r
+  IN     BOOLEAN             DontUseBuffer\r
   );\r
 \r
-\r
 /**\r
   This function is a wrapper to put file with TFTP.\r
 \r
@@ -98,16 +94,15 @@ PxeBcTftpReadFile (
 **/\r
 EFI_STATUS\r
 PxeBcTftpWriteFile (\r
-  IN     PXEBC_PRIVATE_DATA         *Private,\r
-  IN     VOID                       *Config,\r
-  IN     UINT8                      *Filename,\r
-  IN     BOOLEAN                    Overwrite,\r
-  IN     UINTN                      *BlockSize,\r
-  IN     UINT8                      *BufferPtr,\r
-  IN OUT UINT64                     *BufferSize\r
+  IN     PXEBC_PRIVATE_DATA  *Private,\r
+  IN     VOID                *Config,\r
+  IN     UINT8               *Filename,\r
+  IN     BOOLEAN             Overwrite,\r
+  IN     UINTN               *BlockSize,\r
+  IN     UINT8               *BufferPtr,\r
+  IN OUT UINT64              *BufferSize\r
   );\r
 \r
-\r
 /**\r
   This function is a wrapper to get the data (file) from a directory using TFTP.\r
 \r
@@ -115,23 +110,26 @@ PxeBcTftpWriteFile (
   @param[in]       Config         Pointer to config data.\r
   @param[in]       Filename       Pointer to boot file name.\r
   @param[in]       BlockSize      Pointer to required block size.\r
+  @param[in]       WindowSize     Pointer to required window size.\r
   @param[in]       BufferPtr      Pointer to buffer.\r
   @param[in, out]  BufferSize     Pointer to buffer size.\r
   @param[in]       DontUseBuffer  Indicates whether with a receive buffer.\r
 \r
-  @retval EFI_SUCCES         Successfully obtained the data from the file included in directory.\r
+  @retval EFI_SUCCESS        Successfully obtained the data from the file included in directory.\r
   @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
   @retval Others             Operation failed.\r
 \r
 **/\r
 EFI_STATUS\r
 PxeBcTftpReadDirectory (\r
-  IN     PXEBC_PRIVATE_DATA            *Private,\r
-  IN     VOID                          *Config,\r
-  IN     UINT8                         *Filename,\r
-  IN     UINTN                         *BlockSize,\r
-  IN     UINT8                         *BufferPtr,\r
-  IN OUT UINT64                        *BufferSize,\r
-  IN     BOOLEAN                       DontUseBuffer\r
+  IN     PXEBC_PRIVATE_DATA  *Private,\r
+  IN     VOID                *Config,\r
+  IN     UINT8               *Filename,\r
+  IN     UINTN               *BlockSize,\r
+  IN     UINTN               *WindowSize,\r
+  IN     UINT8               *BufferPtr,\r
+  IN OUT UINT64              *BufferSize,\r
+  IN     BOOLEAN             DontUseBuffer\r
   );\r
+\r
 #endif\r