#include <Mtftp6.h>

Data Fields
EFI_STATUS	Status
	The status that is returned to the caller at the end of the operation to indicate whether this operation completed successfully. More...

EFI_EVENT	Event
	The event that will be signaled when the operation completes. More...

EFI_MTFTP6_OVERRIDE_DATA *	OverrideData
	If not NULL, the data that will be used to override the existing configure data. More...

UINT8 *	Filename
	Pointer to the null-terminated ASCII file name string. More...

UINT8 *	ModeStr
	Pointer to the null-terminated ASCII mode string. More...

UINT32	OptionCount
	Number of option/value string pairs. More...

EFI_MTFTP6_OPTION *	OptionList
	Pointer to an array of option/value string pairs. More...

UINT64	BufferSize
	On input, the size, in bytes, of Buffer. More...

VOID *	Buffer
	Pointer to the data buffer. More...

VOID *	Context
	Pointer to the context that will be used by CheckPacket, TimeoutCallback and PacketNeeded. More...

EFI_MTFTP6_CHECK_PACKET	CheckPacket
	Pointer to the callback function to check the contents of the received packet. More...

EFI_MTFTP6_TIMEOUT_CALLBACK	TimeoutCallback
	Pointer to the function to be called when a timeout occurs. More...

EFI_MTFTP6_PACKET_NEEDED	PacketNeeded
	Pointer to the function to provide the needed packet contents. More...

Detailed Description

Definition at line 390 of file Mtftp6.h.

Field Documentation

◆ Status

EFI_STATUS _EFI_MTFTP6_TOKEN::Status

The status that is returned to the caller at the end of the operation to indicate whether this operation completed successfully.

Defined Status values are listed below.

Definition at line 396 of file Mtftp6.h.

◆ Event

EFI_EVENT _EFI_MTFTP6_TOKEN::Event

The event that will be signaled when the operation completes.

If set to NULL, the corresponding function will wait until the read or write operation finishes. The type of Event must be EVT_NOTIFY_SIGNAL.

Definition at line 402 of file Mtftp6.h.

◆ OverrideData

EFI_MTFTP6_OVERRIDE_DATA* _EFI_MTFTP6_TOKEN::OverrideData

If not NULL, the data that will be used to override the existing configure data.

Definition at line 407 of file Mtftp6.h.

◆ Filename

UINT8* _EFI_MTFTP6_TOKEN::Filename

Pointer to the null-terminated ASCII file name string.

Definition at line 411 of file Mtftp6.h.

◆ ModeStr

UINT8* _EFI_MTFTP6_TOKEN::ModeStr

Pointer to the null-terminated ASCII mode string.

If NULL, octet is used.

Definition at line 415 of file Mtftp6.h.

◆ OptionCount

UINT32 _EFI_MTFTP6_TOKEN::OptionCount

Number of option/value string pairs.

Definition at line 419 of file Mtftp6.h.

◆ OptionList

EFI_MTFTP6_OPTION* _EFI_MTFTP6_TOKEN::OptionList

Pointer to an array of option/value string pairs.

Ignored if OptionCount is zero. Both a remote server and this driver implementation should support these options. If one or more options are unrecognized by this implementation, it is sent to the remote server without being changed.

Definition at line 427 of file Mtftp6.h.

◆ BufferSize

UINT64 _EFI_MTFTP6_TOKEN::BufferSize

On input, the size, in bytes, of Buffer.

On output, the number of bytes transferred.

Definition at line 432 of file Mtftp6.h.

◆ Buffer

VOID* _EFI_MTFTP6_TOKEN::Buffer

Pointer to the data buffer.

Data that is downloaded from the MTFTPv6 server is stored here. Data that is uploaded to the MTFTPv6 server is read from here. Ignored if BufferSize is zero.

Definition at line 438 of file Mtftp6.h.

◆ Context

VOID* _EFI_MTFTP6_TOKEN::Context

Pointer to the context that will be used by CheckPacket, TimeoutCallback and PacketNeeded.

Definition at line 443 of file Mtftp6.h.

◆ CheckPacket

EFI_MTFTP6_CHECK_PACKET _EFI_MTFTP6_TOKEN::CheckPacket

Pointer to the callback function to check the contents of the received packet.

Definition at line 448 of file Mtftp6.h.

◆ TimeoutCallback

EFI_MTFTP6_TIMEOUT_CALLBACK _EFI_MTFTP6_TOKEN::TimeoutCallback

Pointer to the function to be called when a timeout occurs.

Definition at line 452 of file Mtftp6.h.

◆ PacketNeeded

EFI_MTFTP6_PACKET_NEEDED _EFI_MTFTP6_TOKEN::PacketNeeded

Pointer to the function to provide the needed packet contents.

Only used in WriteFile() operation.

Definition at line 457 of file Mtftp6.h.

The documentation for this struct was generated from the following file:

include/ipxe/efi/Protocol/Mtftp6.h

Data Fields