iPXE
Mtftp4.h
Go to the documentation of this file.
1 /** @file
2  EFI Multicast Trivial File Transfer Protocol Definition
3 
4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
6 
7  @par Revision Reference:
8  This Protocol is introduced in UEFI Specification 2.0
9 
10 **/
11 
12 #ifndef __EFI_MTFTP4_PROTOCOL_H__
13 #define __EFI_MTFTP4_PROTOCOL_H__
14 
15 FILE_LICENCE ( BSD2_PATENT );
16 FILE_SECBOOT ( PERMITTED );
17 
18 #define EFI_MTFTP4_SERVICE_BINDING_PROTOCOL_GUID \
19  { \
20  0x2FE800BE, 0x8F01, 0x4aa6, {0x94, 0x6B, 0xD7, 0x13, 0x88, 0xE1, 0x83, 0x3F } \
21  }
22 
23 #define EFI_MTFTP4_PROTOCOL_GUID \
24  { \
25  0x78247c57, 0x63db, 0x4708, {0x99, 0xc2, 0xa8, 0xb4, 0xa9, 0xa6, 0x1f, 0x6b } \
26  }
27 
30 
31 //
32 // MTFTP4 packet opcode definition
33 //
34 #define EFI_MTFTP4_OPCODE_RRQ 1
35 #define EFI_MTFTP4_OPCODE_WRQ 2
36 #define EFI_MTFTP4_OPCODE_DATA 3
37 #define EFI_MTFTP4_OPCODE_ACK 4
38 #define EFI_MTFTP4_OPCODE_ERROR 5
39 #define EFI_MTFTP4_OPCODE_OACK 6
40 #define EFI_MTFTP4_OPCODE_DIR 7
41 #define EFI_MTFTP4_OPCODE_DATA8 8
42 #define EFI_MTFTP4_OPCODE_ACK8 9
43 
44 //
45 // MTFTP4 error code definition
46 //
47 #define EFI_MTFTP4_ERRORCODE_NOT_DEFINED 0
48 #define EFI_MTFTP4_ERRORCODE_FILE_NOT_FOUND 1
49 #define EFI_MTFTP4_ERRORCODE_ACCESS_VIOLATION 2
50 #define EFI_MTFTP4_ERRORCODE_DISK_FULL 3
51 #define EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION 4
52 #define EFI_MTFTP4_ERRORCODE_UNKNOWN_TRANSFER_ID 5
53 #define EFI_MTFTP4_ERRORCODE_FILE_ALREADY_EXISTS 6
54 #define EFI_MTFTP4_ERRORCODE_NO_SUCH_USER 7
55 #define EFI_MTFTP4_ERRORCODE_REQUEST_DENIED 8
56 
57 //
58 // MTFTP4 pacekt definitions
59 //
60 #pragma pack(1)
61 
62 typedef struct {
66 
67 typedef struct {
69  UINT8 Data[1];
71 
72 typedef struct {
75  UINT8 Data[1];
77 
78 typedef struct {
80  UINT16 Block[1];
82 
83 typedef struct {
86  UINT8 Data[1];
88 
89 typedef struct {
91  UINT64 Block[1];
93 
94 typedef struct {
97  UINT8 ErrorMessage[1];
99 
100 typedef union {
101  ///
102  /// Type of packets as defined by the MTFTPv4 packet opcodes.
103  ///
105  ///
106  /// Read request packet header.
107  ///
109  ///
110  /// Write request packet header.
111  ///
113  ///
114  /// Option acknowledge packet header.
115  ///
117  ///
118  /// Data packet header.
119  ///
121  ///
122  /// Acknowledgement packet header.
123  ///
125  ///
126  /// Data packet header with big block number.
127  ///
129  ///
130  /// Acknowledgement header with big block num.
131  ///
133  ///
134  /// Error packet header.
135  ///
138 
139 #pragma pack()
140 
141 ///
142 /// MTFTP4 option definition.
143 ///
144 typedef struct {
148 
149 typedef struct {
160 
161 typedef struct {
168 
169 typedef struct {
176 
177 //
178 // Protocol interfaces definition
179 //
180 
181 /**
182  A callback function that is provided by the caller to intercept
183  the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the
184  EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept
185  EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to
186  EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().
187 
188  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
189  @param Token The token that the caller provided in the
190  EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile()
191  or ReadDirectory() function.
192  @param PacketLen Indicates the length of the packet.
193  @param Packet The pointer to an MTFTPv4 packet.
194 
195  @retval EFI_SUCCESS The operation was successful.
196  @retval Others Aborts the transfer process.
197 
198 **/
199 typedef
202  IN EFI_MTFTP4_PROTOCOL *This,
203  IN EFI_MTFTP4_TOKEN *Token,
204  IN UINT16 PacketLen,
205  IN EFI_MTFTP4_PACKET *Paket
206  );
207 
208 /**
209  Timeout callback function.
210 
211  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
212  @param Token The token that is provided in the
213  EFI_MTFTP4_PROTOCOL.ReadFile() or
214  EFI_MTFTP4_PROTOCOL.WriteFile() or
215  EFI_MTFTP4_PROTOCOL.ReadDirectory() functions
216  by the caller.
217 
218  @retval EFI_SUCCESS The operation was successful.
219  @retval Others Aborts download process.
220 
221 **/
222 typedef
225  IN EFI_MTFTP4_PROTOCOL *This,
226  IN EFI_MTFTP4_TOKEN *Token
227  );
228 
229 /**
230  A callback function that the caller provides to feed data to the
231  EFI_MTFTP4_PROTOCOL.WriteFile() function.
232 
233  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
234  @param Token The token provided in the
235  EFI_MTFTP4_PROTOCOL.WriteFile() by the caller.
236  @param Length Indicates the length of the raw data wanted on input, and the
237  length the data available on output.
238  @param Buffer The pointer to the buffer where the data is stored.
239 
240  @retval EFI_SUCCESS The operation was successful.
241  @retval Others Aborts session.
242 
243 **/
244 typedef
247  IN EFI_MTFTP4_PROTOCOL *This,
248  IN EFI_MTFTP4_TOKEN *Token,
249  IN OUT UINT16 *Length,
250  OUT VOID **Buffer
251  );
252 
253 /**
254  Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
255 
256  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
257  @param ModeData The pointer to storage for the EFI MTFTPv4 Protocol driver mode data.
258 
259  @retval EFI_SUCCESS The configuration data was successfully returned.
260  @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.
261  @retval EFI_INVALID_PARAMETER This is NULL or ModeData is NULL.
262 
263 **/
264 typedef
267  IN EFI_MTFTP4_PROTOCOL *This,
268  OUT EFI_MTFTP4_MODE_DATA *ModeData
269  );
270 
271 /**
272  Initializes, changes, or resets the default operational setting for this
273  EFI MTFTPv4 Protocol driver instance.
274 
275  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
276  @param MtftpConfigData The pointer to the configuration data structure.
277 
278  @retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured successfully.
279  @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
280  @retval EFI_ACCESS_DENIED The EFI configuration could not be changed at this time because
281  there is one MTFTP background operation in progress.
282  @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
283  RARP, etc.) has not finished yet.
284  @retval EFI_UNSUPPORTED A configuration protocol (DHCP, BOOTP, RARP, etc.) could not
285  be located when clients choose to use the default address
286  settings.
287  @retval EFI_OUT_OF_RESOURCES The EFI MTFTPv4 Protocol driver instance data could not be
288  allocated.
289  @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI
290  MTFTPv4 Protocol driver instance is not configured.
291 
292 **/
293 typedef
296  IN EFI_MTFTP4_PROTOCOL *This,
297  IN EFI_MTFTP4_CONFIG_DATA *MtftpConfigData OPTIONAL
298  );
299 
300 /**
301  Gets information about a file from an MTFTPv4 server.
302 
303  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
304  @param OverrideData Data that is used to override the existing parameters. If NULL,
305  the default parameters that were set in the
306  EFI_MTFTP4_PROTOCOL.Configure() function are used.
307  @param Filename The pointer to null-terminated ASCII file name string.
308  @param ModeStr The pointer to null-terminated ASCII mode string. If NULL, "octet" will be used.
309  @param OptionCount Number of option/value string pairs in OptionList.
310  @param OptionList The pointer to array of option/value string pairs. Ignored if
311  OptionCount is zero.
312  @param PacketLength The number of bytes in the returned packet.
313  @param Packet The pointer to the received packet. This buffer must be freed by
314  the caller.
315 
316  @retval EFI_SUCCESS An MTFTPv4 OACK packet was received and is in the Packet.
317  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
318  - This is NULL.
319  - Filename is NULL.
320  - OptionCount is not zero and OptionList is NULL.
321  - One or more options in OptionList have wrong format.
322  - PacketLength is NULL.
323  - One or more IPv4 addresses in OverrideData are not valid
324  unicast IPv4 addresses if OverrideData is not NULL.
325  @retval EFI_UNSUPPORTED One or more options in the OptionList are in the
326  unsupported list of structure EFI_MTFTP4_MODE_DATA.
327  @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
328  @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
329  RARP, etc.) has not finished yet.
330  @retval EFI_ACCESS_DENIED The previous operation has not completed yet.
331  @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
332  @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received and is in the Packet.
333  @retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received and the Packet is set to NULL.
334  @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received and the Packet is set to NULL.
335  @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.
336  @retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received and the Packet is set to NULL.
337  @retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received and is in the Buffer.
338  @retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is in the Packet.
339  @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
340  @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
341  @retval EFI_NO_MEDIA There was a media error.
342 
343 **/
344 typedef
347  IN EFI_MTFTP4_PROTOCOL *This,
348  IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData OPTIONAL,
349  IN UINT8 *Filename,
350  IN UINT8 *ModeStr OPTIONAL,
351  IN UINT8 OptionCount,
352  IN EFI_MTFTP4_OPTION *OptionList,
353  OUT UINT32 *PacketLength,
355  );
356 
357 /**
358  Parses the options in an MTFTPv4 OACK packet.
359 
360  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
361  @param PacketLen Length of the OACK packet to be parsed.
362  @param Packet The pointer to the OACK packet to be parsed.
363  @param OptionCount The pointer to the number of options in following OptionList.
364  @param OptionList The pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot
365  Service FreePool() to release the OptionList if the options
366  in this OptionList are not needed any more.
367 
368  @retval EFI_SUCCESS The OACK packet was valid and the OptionCount and
369  OptionList parameters have been updated.
370  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
371  - PacketLen is 0.
372  - Packet is NULL or Packet is not a valid MTFTPv4 packet.
373  - OptionCount is NULL.
374  @retval EFI_NOT_FOUND No options were found in the OACK packet.
375  @retval EFI_OUT_OF_RESOURCES Storage for the OptionList array cannot be allocated.
376  @retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid.
377 
378 **/
379 typedef
382  IN EFI_MTFTP4_PROTOCOL *This,
383  IN UINT32 PacketLen,
384  IN EFI_MTFTP4_PACKET *Packet,
385  OUT UINT32 *OptionCount,
386  OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL
387  );
388 
389 /**
390  Downloads a file from an MTFTPv4 server.
391 
392  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
393  @param Token The pointer to the token structure to provide the parameters that are
394  used in this operation.
395 
396  @retval EFI_SUCCESS The data file has been transferred successfully.
397  @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
398  @retval EFI_BUFFER_TOO_SMALL BufferSize is not zero but not large enough to hold the
399  downloaded data in downloading process.
400  @retval EFI_ABORTED Current operation is aborted by user.
401  @retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received.
402  @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received.
403  @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.
404  @retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received.
405  @retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received.
406  @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
407  @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received.
408  @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
409  @retval EFI_NO_MEDIA There was a media error.
410 
411 **/
412 typedef
415  IN EFI_MTFTP4_PROTOCOL *This,
416  IN EFI_MTFTP4_TOKEN *Token
417  );
418 
419 /**
420  Sends a file to an MTFTPv4 server.
421 
422  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
423  @param Token The pointer to the token structure to provide the parameters that are
424  used in this operation.
425 
426  @retval EFI_SUCCESS The upload session has started.
427  @retval EFI_UNSUPPORTED The operation is not supported by this implementation.
428  @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
429  @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in
430  the unsupported list of structure EFI_MTFTP4_MODE_DATA.
431  @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
432  @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
433  RARP, etc.) is not finished yet.
434  @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 session.
435  @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
436  @retval EFI_ACCESS_DENIED The previous operation has not completed yet.
437  @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
438 
439 **/
440 typedef
443  IN EFI_MTFTP4_PROTOCOL *This,
444  IN EFI_MTFTP4_TOKEN *Token
445  );
446 
447 /**
448  Downloads a data file "directory" from an MTFTPv4 server. May be unsupported in some EFI
449  implementations.
450 
451  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
452  @param Token The pointer to the token structure to provide the parameters that are
453  used in this operation.
454 
455  @retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded.
456  @retval EFI_UNSUPPORTED The operation is not supported by this implementation.
457  @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
458  @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in
459  the unsupported list of structure EFI_MTFTP4_MODE_DATA.
460  @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
461  @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
462  RARP, etc.) is not finished yet.
463  @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 session.
464  @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
465  @retval EFI_ACCESS_DENIED The previous operation has not completed yet.
466  @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
467 
468 **/
469 typedef
472  IN EFI_MTFTP4_PROTOCOL *This,
473  IN EFI_MTFTP4_TOKEN *Token
474  );
475 
476 /**
477  Polls for incoming data packets and processes outgoing data packets.
478 
479  @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
480 
481  @retval EFI_SUCCESS Incoming or outgoing data was processed.
482  @retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started.
483  @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
484  RARP, etc.) is not finished yet.
485  @retval EFI_INVALID_PARAMETER This is NULL.
486  @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
487  @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
488  Consider increasing the polling rate.
489 
490 **/
491 typedef
494  IN EFI_MTFTP4_PROTOCOL *This
495  );
496 
497 ///
498 /// The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications
499 /// to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses
500 /// the underlying EFI UDPv4 Protocol driver and EFI IPv4 Protocol driver.
501 ///
511 };
512 
514  ///
515  /// The status that is returned to the caller at the end of the operation
516  /// to indicate whether this operation completed successfully.
517  ///
519  ///
520  /// The event that will be signaled when the operation completes. If
521  /// set to NULL, the corresponding function will wait until the read or
522  /// write operation finishes. The type of Event must be
523  /// EVT_NOTIFY_SIGNAL. The Task Priority Level (TPL) of
524  /// Event must be lower than or equal to TPL_CALLBACK.
525  ///
527  ///
528  /// If not NULL, the data that will be used to override the existing configure data.
529  ///
531  ///
532  /// The pointer to the null-terminated ASCII file name string.
533  ///
535  ///
536  /// The pointer to the null-terminated ASCII mode string. If NULL, "octet" is used.
537  ///
539  ///
540  /// Number of option/value string pairs.
541  ///
543  ///
544  /// The pointer to an array of option/value string pairs. Ignored if OptionCount is zero.
545  ///
547  ///
548  /// The size of the data buffer.
549  ///
551  ///
552  /// The pointer to the data buffer. Data that is downloaded from the
553  /// MTFTPv4 server is stored here. Data that is uploaded to the
554  /// MTFTPv4 server is read from here. Ignored if BufferSize is zero.
555  ///
557  ///
558  /// The pointer to the context that will be used by CheckPacket,
559  /// TimeoutCallback and PacketNeeded.
560  ///
562  ///
563  /// The pointer to the callback function to check the contents of the received packet.
564  ///
566  ///
567  /// The pointer to the function to be called when a timeout occurs.
568  ///
570  ///
571  /// The pointer to the function to provide the needed packet contents.
572  ///
574 };
575 
578 
579 #endif
EFI_IPv4_ADDRESS ServerIp
Definition: Mtftp4.h:155
#define OPTIONAL
Passing the datum to the function is optional, and a NULL is passed if the value is not supplied.
Definition: Base.h:293
EFI_GUID gEfiMtftp4ServiceBindingProtocolGuid
The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications to transmit and recei...
Definition: Mtftp4.h:502
FILE_SECBOOT(PERMITTED)
UINT8 UnsupportedOptionCount
Definition: Mtftp4.h:165
EFI_MTFTP4_OPTION * OptionList
The pointer to an array of option/value string pairs.
Definition: Mtftp4.h:546
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.
Definition: Mtftp4.h:471
128 bit buffer containing a unique identifier value.
Definition: Base.h:216
Definition: efi.h:63
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...
Definition: Mtftp4.h:201
unsigned char BOOLEAN
unsigned int UINT32
Definition: ProcessorBind.h:99
EFI_MTFTP4_ERROR_HEADER Error
Error packet header.
Definition: Mtftp4.h:136
VOID * Context
The pointer to the context that will be used by CheckPacket, TimeoutCallback and PacketNeeded.
Definition: Mtftp4.h:561
UINT8_t Length
Length of this structure.
Definition: pxe_api.h:70
EFI_STATUS(EFIAPI * EFI_MTFTP4_POLL)(IN EFI_MTFTP4_PROTOCOL *This)
Polls for incoming data packets and processes outgoing data packets.
Definition: Mtftp4.h:493
unsigned char UINT8
MTFTP4 option definition.
Definition: Mtftp4.h:144
UINT8 * Filename
The pointer to the null-terminated ASCII file name string.
Definition: Mtftp4.h:534
EFI_MTFTP4_READ_FILE ReadFile
Definition: Mtftp4.h:507
EFI_STATUS(EFIAPI * EFI_MTFTP4_WRITE_FILE)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_TOKEN *Token)
Sends a file to an MTFTPv4 server.
Definition: Mtftp4.h:442
EFI_MTFTP4_DATA8_HEADER Data8
Data packet header with big block number.
Definition: Mtftp4.h:128
#define OUT
Definition: mlx_utils.h:29
EFI_MTFTP4_ACK_HEADER Ack
Acknowledgement packet header.
Definition: Mtftp4.h:124
EFI_MTFTP4_DATA_HEADER Data
Data packet header.
Definition: Mtftp4.h:120
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....
Definition: Mtftp4.h:246
EFI_MTFTP4_ACK8_HEADER Ack8
Acknowledgement header with big block num.
Definition: Mtftp4.h:132
EFI_STATUS Status
The status that is returned to the caller at the end of the operation to indicate whether this operat...
Definition: Mtftp4.h:518
EFI_MTFTP4_PARSE_OPTIONS ParseOptions
Definition: Mtftp4.h:506
UINT8 * OptionStr
Definition: Mtftp4.h:145
4-byte buffer.
Definition: Base.h:226
EFI_EVENT Event
The event that will be signaled when the operation completes.
Definition: Mtftp4.h:526
EFI_STATUS(EFIAPI * EFI_MTFTP4_TIMEOUT_CALLBACK)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_TOKEN *Token)
Timeout callback function.
Definition: Mtftp4.h:224
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 ...
Definition: Mtftp4.h:295
EFI_MTFTP4_WRITE_FILE WriteFile
Definition: Mtftp4.h:508
unsigned short UINT16
#define EFIAPI
EFI_MTFTP4_POLL Poll
Definition: Mtftp4.h:510
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.
Definition: Mtftp4.h:266
EFI_MTFTP4_CONFIGURE Configure
Definition: Mtftp4.h:504
FILE_LICENCE(BSD2_PATENT)
UINT8 ** SupportedOptoins
Definition: Mtftp4.h:164
SEGOFF16_t Buffer
Buffer address.
Definition: pxe_api.h:65
EFI_MTFTP4_OVERRIDE_DATA * OverrideData
If not NULL, the data that will be used to override the existing configure data.
Definition: Mtftp4.h:530
BOOLEAN UseDefaultSetting
Definition: Mtftp4.h:150
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.
Definition: Mtftp4.h:381
UINT8 * ValueStr
Definition: Mtftp4.h:146
EFI_MTFTP4_READ_DIRECTORY ReadDirectory
Definition: Mtftp4.h:509
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.
Definition: Mtftp4.h:346
#define VOID
Undeclared type.
Definition: Base.h:272
EFI_MTFTP4_GET_INFO GetInfo
Definition: Mtftp4.h:505
unsigned long long UINT64
Definition: ProcessorBind.h:97
EFI_IPv4_ADDRESS GatewayIp
Definition: Mtftp4.h:154
UINT16 OpCode
Type of packets as defined by the MTFTPv4 packet opcodes.
Definition: Mtftp4.h:104
#define IN
Definition: mlx_utils.h:28
UINT8 ** UnsupportedOptoins
Definition: Mtftp4.h:166
VOID * Buffer
The pointer to the data buffer.
Definition: Mtftp4.h:556
EFI_MTFTP4_PACKET_NEEDED PacketNeeded
The pointer to the function to provide the needed packet contents.
Definition: Mtftp4.h:573
UINT64 BufferSize
The size of the data buffer.
Definition: Mtftp4.h:550
EFI_MTFTP4_REQ_HEADER Rrq
Read request packet header.
Definition: Mtftp4.h:108
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:32
EFI_MTFTP4_REQ_HEADER Wrq
Write request packet header.
Definition: Mtftp4.h:112
UINT32 OptionCount
Number of option/value string pairs.
Definition: Mtftp4.h:542
EFI_IPv4_ADDRESS SubnetMask
Definition: Mtftp4.h:152
EFI_MTFTP4_OACK_HEADER Oack
Option acknowledge packet header.
Definition: Mtftp4.h:116
EFI_MTFTP4_CONFIG_DATA ConfigData
Definition: Mtftp4.h:162
EFI_STATUS(EFIAPI * EFI_MTFTP4_READ_FILE)(IN EFI_MTFTP4_PROTOCOL *This, IN EFI_MTFTP4_TOKEN *Token)
Downloads a file from an MTFTPv4 server.
Definition: Mtftp4.h:414
EFI_IPv4_ADDRESS GatewayIp
Definition: Mtftp4.h:170
EFI_IPv4_ADDRESS StationIp
Definition: Mtftp4.h:151
UINT16 InitialServerPort
Definition: Mtftp4.h:156
EFI_IPv4_ADDRESS ServerIp
Definition: Mtftp4.h:171
EFI_MTFTP4_GET_MODE_DATA GetModeData
Definition: Mtftp4.h:503
EFI_GUID gEfiMtftp4ProtocolGuid
EFI_MTFTP4_CHECK_PACKET CheckPacket
The pointer to the callback function to check the contents of the received packet.
Definition: Mtftp4.h:565
UINT8 * ModeStr
The pointer to the null-terminated ASCII mode string.
Definition: Mtftp4.h:538
UINT8 SupportedOptionCount
Definition: Mtftp4.h:163
EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback
The pointer to the function to be called when a timeout occurs.
Definition: Mtftp4.h:569