NetworkPkg/UefiPxeBcDxe/PxeBcMtftp.h File Reference


Defines

#define PXE_MTFTP_OPTION_BLKSIZE_INDEX   0
#define PXE_MTFTP_OPTION_TIMEOUT_INDEX   1
#define PXE_MTFTP_OPTION_TSIZE_INDEX   2
#define PXE_MTFTP_OPTION_MULTICAST_INDEX   3
#define PXE_MTFTP_OPTION_MAXIMUM_INDEX   4
#define PXE_MTFTP_OPTBUF_MAXNUM_INDEX   128
#define PXE_MTFTP_ERROR_STRING_LENGTH   127
#define PXE_MTFTP_DEFAULT_BLOCK_SIZE   512

Functions

EFI_STATUS PxeBcTftpGetFileSize (IN PXEBC_PRIVATE_DATA *Private, IN VOID *Config, IN UINT8 *Filename, IN UINTN *BlockSize, IN OUT UINT64 *BufferSize)
EFI_STATUS PxeBcTftpReadFile (IN PXEBC_PRIVATE_DATA *Private, IN VOID *Config, IN UINT8 *Filename, IN UINTN *BlockSize, IN UINT8 *BufferPtr, IN OUT UINT64 *BufferSize, IN BOOLEAN DontUseBuffer)
EFI_STATUS PxeBcTftpWriteFile (IN PXEBC_PRIVATE_DATA *Private, IN VOID *Config, IN UINT8 *Filename, IN BOOLEAN Overwrite, IN UINTN *BlockSize, IN UINT8 *BufferPtr, IN OUT UINT64 *BufferSize)
EFI_STATUS PxeBcTftpReadDirectory (IN PXEBC_PRIVATE_DATA *Private, IN VOID *Config, IN UINT8 *Filename, IN UINTN *BlockSize, IN UINT8 *BufferPtr, IN OUT UINT64 *BufferSize, IN BOOLEAN DontUseBuffer)

Detailed Description

Functions declaration related with Mtftp for UefiPxeBc Driver.

Copyright (c) 2007 - 2015, 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.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define PXE_MTFTP_DEFAULT_BLOCK_SIZE   512

Referenced by EfiPxeBcMtftp().

#define PXE_MTFTP_ERROR_STRING_LENGTH   127

#define PXE_MTFTP_OPTBUF_MAXNUM_INDEX   128

#define PXE_MTFTP_OPTION_BLKSIZE_INDEX   0

#define PXE_MTFTP_OPTION_MAXIMUM_INDEX   4

#define PXE_MTFTP_OPTION_MULTICAST_INDEX   3

#define PXE_MTFTP_OPTION_TIMEOUT_INDEX   1

#define PXE_MTFTP_OPTION_TSIZE_INDEX   2


Function Documentation

EFI_STATUS PxeBcTftpGetFileSize ( IN PXEBC_PRIVATE_DATA Private,
IN VOID *  Config,
IN UINT8 *  Filename,
IN UINTN *  BlockSize,
IN OUT UINT64 *  BufferSize 
)

This function is wrapper to get the file size using TFTP.

Parameters:
[in] Private Pointer to PxeBc private data.
[in] Config Pointer to configure data.
[in] Filename Pointer to boot file name.
[in] BlockSize Pointer to required block size.
[in,out] BufferSize Pointer to buffer size.
Return values:
EFI_SUCCESS Successfully obtained the size of file.
EFI_NOT_FOUND Parse the tftp ptions failed.
EFI_DEVICE_ERROR The network device encountered an error during this operation.
Others Did not obtain the size of the file.
This function is wrapper to get the file size using TFTP.

Parameters:
[in] Private Pointer to PxeBc private data.
[in] Config Pointer to configure data.
[in] Filename Pointer to boot file name.
[in] BlockSize Pointer to required block size.
[in,out] BufferSize Pointer to buffer size.
Return values:
EFI_SUCCESS Successfully obtained the size of file.
EFI_NOT_FOUND Parse the tftp options failed.
EFI_DEVICE_ERROR The network device encountered an error during this operation.
Others Did not obtain the size of the file.

References PxeBcMtftp4GetFileSize(), and PxeBcMtftp6GetFileSize().

Referenced by EfiPxeBcMtftp().

EFI_STATUS PxeBcTftpReadDirectory ( IN PXEBC_PRIVATE_DATA Private,
IN VOID *  Config,
IN UINT8 *  Filename,
IN UINTN *  BlockSize,
IN UINT8 *  BufferPtr,
IN OUT UINT64 *  BufferSize,
IN BOOLEAN  DontUseBuffer 
)

This function is a wrapper to get the data (file) from a directory using TFTP.

Parameters:
[in] Private Pointer to PxeBc private data.
[in] Config Pointer to config data.
[in] Filename Pointer to boot file name.
[in] BlockSize Pointer to required block size.
[in] BufferPtr Pointer to buffer.
[in,out] BufferSize Pointer to buffer size.
[in] DontUseBuffer Indicates whether with a receive buffer.
Return values:
EFI_SUCCES Successfully obtained the data from the file included in directory.
EFI_DEVICE_ERROR The network device encountered an error during this operation.
Others Operation failed.
This function is a wrapper to get the data (file) from a directory using TFTP.

Parameters:
[in] Private Pointer to PxeBc private data.
[in] Config Pointer to config data.
[in] Filename Pointer to boot file name.
[in] BlockSize Pointer to required block size.
[in] BufferPtr Pointer to buffer.
[in,out] BufferSize Pointer to buffer size.
[in] DontUseBuffer Indicatse whether to use a receive buffer.
Return values:
EFI_SUCCES Successfully obtained the data from the file included in the directory.
EFI_DEVICE_ERROR The network device encountered an error during this operation.
Others Operation failed.

References PxeBcMtftp4ReadDirectory(), and PxeBcMtftp6ReadDirectory().

Referenced by EfiPxeBcMtftp().

EFI_STATUS PxeBcTftpReadFile ( IN PXEBC_PRIVATE_DATA Private,
IN VOID *  Config,
IN UINT8 *  Filename,
IN UINTN *  BlockSize,
IN UINT8 *  BufferPtr,
IN OUT UINT64 *  BufferSize,
IN BOOLEAN  DontUseBuffer 
)

This function is a wrapper to get a file using TFTP.

Parameters:
[in] Private Pointer to PxeBc private data.
[in] Config Pointer to config data.
[in] Filename Pointer to boot file name.
[in] BlockSize Pointer to required block size.
[in] BufferPtr Pointer to buffer.
[in,out] BufferSize Pointer to buffer size.
[in] DontUseBuffer Indicates whether to use a receive buffer.
Return values:
EFI_SUCCESS Successfully read the data from the special file.
EFI_DEVICE_ERROR The network device encountered an error during this operation.
Others Read data from file failed.
This function is a wrapper to get file using TFTP.

Parameters:
[in] Private Pointer to PxeBc private data.
[in] Config Pointer to config data.
[in] Filename Pointer to boot file name.
[in] BlockSize Pointer to required block size.
[in] BufferPtr Pointer to buffer.
[in,out] BufferSize Pointer to buffer size.
[in] DontUseBuffer Indicates whether to use a receive buffer.
Return values:
EFI_SUCCESS Sucessfully read the data from the special file.
EFI_DEVICE_ERROR The network device encountered an error during this operation.
Others Read data from file failed.

References PxeBcMtftp4ReadFile(), and PxeBcMtftp6ReadFile().

Referenced by EfiPxeBcMtftp().

EFI_STATUS PxeBcTftpWriteFile ( IN PXEBC_PRIVATE_DATA Private,
IN VOID *  Config,
IN UINT8 *  Filename,
IN BOOLEAN  Overwrite,
IN UINTN *  BlockSize,
IN UINT8 *  BufferPtr,
IN OUT UINT64 *  BufferSize 
)

This function is a wrapper to put file with TFTP.

Parameters:
[in] Private Pointer to PxeBc private data.
[in] Config Pointer to config data.
[in] Filename Pointer to boot file name.
[in] Overwrite Indicates whether to use an overwrite attribute.
[in] BlockSize Pointer to required block size.
[in] BufferPtr Pointer to buffer.
[in,out] BufferSize Pointer to buffer size.
Return values:
EFI_SUCCESS Successfully wrote the data into the special file.
EFI_DEVICE_ERROR The network device encountered an error during this operation.
other Write data into file failed.
This function is a wrapper to write file using TFTP.

Parameters:
[in] Private Pointer to PxeBc private data.
[in] Config Pointer to config data.
[in] Filename Pointer to boot file name.
[in] Overwrite Indicate whether with overwrite attribute.
[in] BlockSize Pointer to required block size.
[in] BufferPtr Pointer to buffer.
[in,out] BufferSize Pointer to buffer size.
Return values:
EFI_SUCCESS Successfully wrote the data into a special file.
EFI_DEVICE_ERROR The network device encountered an error during this operation.
other Write data into file failed.

References PxeBcMtftp4WriteFile(), and PxeBcMtftp6WriteFile().

Referenced by EfiPxeBcMtftp().


Generated on Mon Sep 28 08:49:07 2015 for NetworkPkg[ALL] by  doxygen 1.5.7.1