NetworkPkg:Replace unsafe string functions.

[mirror_edk2.git] / NetworkPkg / UefiPxeBcDxe / PxeBcMtftp.h

/** @file\r
  Functions declaration related with Mtftp for UefiPxeBc Driver.\r
\r
  Copyright (c) 2007 - 2015, 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
\r
**/\r
\r
#ifndef __EFI_PXEBC_MTFTP_H__\r
#define __EFI_PXEBC_MTFTP_H__\r
\r
#define PXE_MTFTP_OPTION_BLKSIZE_INDEX     0\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_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
\r
/**\r
  This function is wrapper to get the file size using TFTP.\r
\r
  @param[in]      Private        Pointer to PxeBc private data.\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, 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_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
  );\r
\r
\r
/**\r
  This function is a wrapper to get a file using TFTP.\r
\r
  @param[in]      Private        Pointer to PxeBc private data.\r
  @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]      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
\r
  @retval EFI_SUCCESS        Successfully read the data from the special file.\r
  @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
  @retval Others             Read data from file failed.\r
\r
**/\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
  );\r
\r
\r
/**\r
  This function is a wrapper to put file with TFTP.\r
\r
  @param[in]       Private        Pointer to PxeBc private data.\r
  @param[in]       Config         Pointer to config data.\r
  @param[in]       Filename       Pointer to boot file name.\r
  @param[in]       Overwrite      Indicates whether to use an overwrite attribute.\r
  @param[in]       BlockSize      Pointer to required block size.\r
  @param[in]       BufferPtr      Pointer to buffer.\r
  @param[in, out]  BufferSize     Pointer to buffer size.\r
\r
  @retval EFI_SUCCESS        Successfully wrote the data into the special file.\r
  @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
  @retval other              Write data into file failed.\r
\r
**/\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
  );\r
\r
\r
/**\r
  This function is a wrapper to get the data (file) from a directory using TFTP.\r
\r
  @param[in]       Private        Pointer to PxeBc private data.\r
  @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]       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_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
  );\r
#endif\r