12 #ifndef __EFI_MTFTP4_PROTOCOL_H__ 13 #define __EFI_MTFTP4_PROTOCOL_H__ 17 #define EFI_MTFTP4_SERVICE_BINDING_PROTOCOL_GUID \ 19 0x2FE800BE, 0x8F01, 0x4aa6, {0x94, 0x6B, 0xD7, 0x13, 0x88, 0xE1, 0x83, 0x3F } \ 22 #define EFI_MTFTP4_PROTOCOL_GUID \ 24 0x78247c57, 0x63db, 0x4708, {0x99, 0xc2, 0xa8, 0xb4, 0xa9, 0xa6, 0x1f, 0x6b } \ 33 #define EFI_MTFTP4_OPCODE_RRQ 1 34 #define EFI_MTFTP4_OPCODE_WRQ 2 35 #define EFI_MTFTP4_OPCODE_DATA 3 36 #define EFI_MTFTP4_OPCODE_ACK 4 37 #define EFI_MTFTP4_OPCODE_ERROR 5 38 #define EFI_MTFTP4_OPCODE_OACK 6 39 #define EFI_MTFTP4_OPCODE_DIR 7 40 #define EFI_MTFTP4_OPCODE_DATA8 8 41 #define EFI_MTFTP4_OPCODE_ACK8 9 46 #define EFI_MTFTP4_ERRORCODE_NOT_DEFINED 0 47 #define EFI_MTFTP4_ERRORCODE_FILE_NOT_FOUND 1 48 #define EFI_MTFTP4_ERRORCODE_ACCESS_VIOLATION 2 49 #define EFI_MTFTP4_ERRORCODE_DISK_FULL 3 50 #define EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION 4 51 #define EFI_MTFTP4_ERRORCODE_UNKNOWN_TRANSFER_ID 5 52 #define EFI_MTFTP4_ERRORCODE_FILE_ALREADY_EXISTS 6 53 #define EFI_MTFTP4_ERRORCODE_NO_SUCH_USER 7 54 #define EFI_MTFTP4_ERRORCODE_REQUEST_DENIED 8 EFI_IPv4_ADDRESS ServerIp
#define OPTIONAL
Passing the datum to the function is optional, and a NULL is passed if the value is not supplied.
EFI_GUID gEfiMtftp4ServiceBindingProtocolGuid
The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications to transmit and recei...
UINT8 UnsupportedOptionCount
EFI_MTFTP4_OPTION * OptionList
The pointer to an array of option/value string pairs.
EFI_STATUS(EFIAPI * EFI_MTFTP4_READ_DIRECTORY)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_TOKEN *Token)
Downloads a data file "directory" from an MTFTPv4 server.
128 bit buffer containing a unique identifier value.
EFI_STATUS(EFIAPI * EFI_MTFTP4_CHECK_PACKET)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_TOKEN *Token, IN UINT16 PacketLen, IN EFI_MTFTP4_PACKET *Paket)
A callback function that is provided by the caller to intercept the EFI_MTFTP4_OPCODE_DATA or EFI_MTF...
VOID * EFI_EVENT
Handle to an event structure.
EFI_MTFTP4_ERROR_HEADER Error
Error packet header.
VOID * Context
The pointer to the context that will be used by CheckPacket, TimeoutCallback and PacketNeeded.
UINT8_t Length
Length of this structure.
EFI_STATUS(EFIAPI * EFI_MTFTP4_POLL)(IN EFI_MTFTP4_PROTOCOL *This)
Polls for incoming data packets and processes outgoing data packets.
MTFTP4 option definition.
UINT8 * Filename
The pointer to the null-terminated ASCII file name string.
EFI_MTFTP4_READ_FILE ReadFile
EFI_STATUS(EFIAPI * EFI_MTFTP4_WRITE_FILE)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_TOKEN *Token)
Sends a file to an MTFTPv4 server.
EFI_MTFTP4_DATA8_HEADER Data8
Data packet header with big block number.
EFI_MTFTP4_ACK_HEADER Ack
Acknowledgement packet header.
EFI_MTFTP4_DATA_HEADER Data
Data packet header.
EFI_STATUS(EFIAPI * EFI_MTFTP4_PACKET_NEEDED)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_TOKEN *Token, IN OUT UINT16 *Length, OUT VOID **Buffer)
A callback function that the caller provides to feed data to the EFI_MTFTP4_PROTOCOL....
EFI_MTFTP4_ACK8_HEADER Ack8
Acknowledgement header with big block num.
EFI_STATUS Status
The status that is returned to the caller at the end of the operation to indicate whether this operat...
EFI_MTFTP4_PARSE_OPTIONS ParseOptions
EFI_EVENT Event
The event that will be signaled when the operation completes.
EFI_STATUS(EFIAPI * EFI_MTFTP4_TIMEOUT_CALLBACK)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_TOKEN *Token)
Timeout callback function.
EFI_STATUS(EFIAPI * EFI_MTFTP4_CONFIGURE)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_CONFIG_DATA *MtftpConfigData OPTIONAL)
Initializes, changes, or resets the default operational setting for this EFI MTFTPv4 Protocol driver ...
EFI_MTFTP4_WRITE_FILE WriteFile
EFI_STATUS(EFIAPI * EFI_MTFTP4_GET_MODE_DATA)(IN EFI_MTFTP4_PROTOCOL *This, OUT EFI_MTFTP4_MODE_DATA *ModeData)
Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
EFI_MTFTP4_CONFIGURE Configure
FILE_LICENCE(BSD2_PATENT)
UINT8 ** SupportedOptoins
SEGOFF16_t Buffer
Buffer address.
EFI_MTFTP4_OVERRIDE_DATA * OverrideData
If not NULL, the data that will be used to override the existing configure data.
BOOLEAN UseDefaultSetting
EFI_STATUS(EFIAPI * EFI_MTFTP4_PARSE_OPTIONS)(IN EFI_MTFTP4_PROTOCOL *This, IN UINT32 PacketLen, IN EFI_MTFTP4_PACKET *Packet, OUT UINT32 *OptionCount, OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL)
Parses the options in an MTFTPv4 OACK packet.
EFI_MTFTP4_READ_DIRECTORY ReadDirectory
EFI_STATUS(EFIAPI * EFI_MTFTP4_GET_INFO)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData OPTIONAL, IN UINT8 *Filename, IN UINT8 *ModeStr OPTIONAL, IN UINT8 OptionCount, IN EFI_MTFTP4_OPTION *OptionList, OUT UINT32 *PacketLength, OUT EFI_MTFTP4_PACKET **Packet OPTIONAL)
Gets information about a file from an MTFTPv4 server.
#define VOID
Undeclared type.
EFI_MTFTP4_GET_INFO GetInfo
unsigned long long UINT64
EFI_IPv4_ADDRESS GatewayIp
UINT16 OpCode
Type of packets as defined by the MTFTPv4 packet opcodes.
UINT8 ** UnsupportedOptoins
VOID * Buffer
The pointer to the data buffer.
EFI_MTFTP4_PACKET_NEEDED PacketNeeded
The pointer to the function to provide the needed packet contents.
UINT64 BufferSize
The size of the data buffer.
EFI_MTFTP4_REQ_HEADER Rrq
Read request packet header.
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
EFI_MTFTP4_REQ_HEADER Wrq
Write request packet header.
UINT32 OptionCount
Number of option/value string pairs.
EFI_IPv4_ADDRESS SubnetMask
EFI_MTFTP4_OACK_HEADER Oack
Option acknowledge packet header.
EFI_MTFTP4_CONFIG_DATA ConfigData
EFI_STATUS(EFIAPI * EFI_MTFTP4_READ_FILE)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_TOKEN *Token)
Downloads a file from an MTFTPv4 server.
EFI_IPv4_ADDRESS GatewayIp
EFI_IPv4_ADDRESS StationIp
EFI_IPv4_ADDRESS ServerIp
EFI_MTFTP4_GET_MODE_DATA GetModeData
EFI_GUID gEfiMtftp4ProtocolGuid
EFI_MTFTP4_CHECK_PACKET CheckPacket
The pointer to the callback function to check the contents of the received packet.
UINT8 * ModeStr
The pointer to the null-terminated ASCII mode string.
UINT8 SupportedOptionCount
EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback
The pointer to the function to be called when a timeout occurs.