PxeBcMtftp.h File Reference

Go to the source code of this file.

Macros
#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_WINDOWSIZE_INDEX   4
#define	PXE_MTFTP_OPTION_MAXIMUM_INDEX   5
#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 UINTN *WindowSize, IN OUT UINT64 *BufferSize)
EFI_STATUS	PxeBcTftpReadFile (IN PXEBC_PRIVATE_DATA *Private, IN VOID *Config, IN UINT8 *Filename, IN UINTN *BlockSize, IN UINTN *WindowSize, 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 UINTN *WindowSize, IN UINT8 *BufferPtr, IN OUT UINT64 *BufferSize, IN BOOLEAN DontUseBuffer)

Detailed Description

Functions declaration related with Mtftp for UefiPxeBc Driver.

Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PxeBcMtftp.h.

Macro Definition Documentation

PXE_MTFTP_DEFAULT_BLOCK_SIZE

#define PXE_MTFTP_DEFAULT_BLOCK_SIZE   512

Definition at line 22 of file PxeBcMtftp.h.

PXE_MTFTP_ERROR_STRING_LENGTH

#define PXE_MTFTP_ERROR_STRING_LENGTH   127

Definition at line 21 of file PxeBcMtftp.h.

PXE_MTFTP_OPTBUF_MAXNUM_INDEX

#define PXE_MTFTP_OPTBUF_MAXNUM_INDEX   128

Definition at line 19 of file PxeBcMtftp.h.

PXE_MTFTP_OPTION_BLKSIZE_INDEX

#define PXE_MTFTP_OPTION_BLKSIZE_INDEX   0

Definition at line 13 of file PxeBcMtftp.h.

PXE_MTFTP_OPTION_MAXIMUM_INDEX

#define PXE_MTFTP_OPTION_MAXIMUM_INDEX   5

Definition at line 18 of file PxeBcMtftp.h.

PXE_MTFTP_OPTION_MULTICAST_INDEX

#define PXE_MTFTP_OPTION_MULTICAST_INDEX   3

Definition at line 16 of file PxeBcMtftp.h.

PXE_MTFTP_OPTION_TIMEOUT_INDEX

#define PXE_MTFTP_OPTION_TIMEOUT_INDEX   1

Definition at line 14 of file PxeBcMtftp.h.

PXE_MTFTP_OPTION_TSIZE_INDEX

#define PXE_MTFTP_OPTION_TSIZE_INDEX   2

Definition at line 15 of file PxeBcMtftp.h.

PXE_MTFTP_OPTION_WINDOWSIZE_INDEX

#define PXE_MTFTP_OPTION_WINDOWSIZE_INDEX   4

Definition at line 17 of file PxeBcMtftp.h.

Function Documentation

PxeBcTftpGetFileSize()

EFI_STATUS PxeBcTftpGetFileSize	(	IN PXEBC_PRIVATE_DATA *	Private,
		IN VOID *	Config,
		IN UINT8 *	Filename,
		IN UINTN *	BlockSize,
		IN UINTN *	WindowSize,
		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]	WindowSize	Pointer to required window 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.

Definition at line 993 of file PxeBcMtftp.c.

PxeBcTftpReadDirectory()

EFI_STATUS PxeBcTftpReadDirectory	(	IN PXEBC_PRIVATE_DATA *	Private,
		IN VOID *	Config,
		IN UINT8 *	Filename,
		IN UINTN *	BlockSize,
		IN UINTN *	WindowSize,
		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]	WindowSize	Pointer to required window size.
[in]	BufferPtr	Pointer to buffer.
[in,out]	BufferSize	Pointer to buffer size.
[in]	DontUseBuffer	Indicates whether with a receive buffer.

Return values

EFI_SUCCESS	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]	WindowSize	Pointer to required window 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_SUCCESS	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.

Definition at line 1145 of file PxeBcMtftp.c.

PxeBcTftpReadFile()

EFI_STATUS PxeBcTftpReadFile	(	IN PXEBC_PRIVATE_DATA *	Private,
		IN VOID *	Config,
		IN UINT8 *	Filename,
		IN UINTN *	BlockSize,
		IN UINTN *	WindowSize,
		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]	WindowSize	Pointer to required window 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]	WindowSize	Pointer to required window 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.

Definition at line 1041 of file PxeBcMtftp.c.

PxeBcTftpWriteFile()

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.

Definition at line 1094 of file PxeBcMtftp.c.