diff options
| author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-09 14:04:41 +0000 |
|---|---|---|
| committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-09 14:04:41 +0000 |
| commit | 992f22b99a90d1b217b1e6f702b238f1ff319753 (patch) | |
| tree | 50fb6f472776aef941ad8a2661d9d776a9b6145c /MdePkg/Include/Protocol/Mtftp4.h | |
| parent | d0a915a5ad4efb7e2d0d7a29fc157bdf1b475d80 (diff) | |
| download | edk2-platforms-992f22b99a90d1b217b1e6f702b238f1ff319753.tar.xz | |
Add the detailed descriptions for the structure data member in these protocol.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6935 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/Mtftp4.h')
| -rw-r--r-- | MdePkg/Include/Protocol/Mtftp4.h | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h index f2c3084b88..15cfd98831 100644 --- a/MdePkg/Include/Protocol/Mtftp4.h +++ b/MdePkg/Include/Protocol/Mtftp4.h @@ -98,14 +98,41 @@ typedef struct { } EFI_MTFTP4_ERROR_HEADER;
typedef union {
+ ///
+ /// Type of packets as defined by the MTFTPv4 packet opcodes.
+ ///
UINT16 OpCode;
+ ///
+ /// Read request packet header.
+ ///
EFI_MTFTP4_REQ_HEADER Rrq;
+ ///
+ /// Write request packet header.
+ ///
EFI_MTFTP4_REQ_HEADER Wrq;
+ ///
+ /// Option acknowledge packet header.
+ ///
EFI_MTFTP4_OACK_HEADER Oack;
+ ///
+ /// Data packet header.
+ ///
EFI_MTFTP4_DATA_HEADER Data;
+ ///
+ /// Acknowledgement packet header.
+ ///
EFI_MTFTP4_ACK_HEADER Ack;
+ ///
+ /// Data packet header with big block number.
+ ///
EFI_MTFTP4_DATA8_HEADER Data8;
+ ///
+ /// Acknowledgement header with big block num.
+ ///
EFI_MTFTP4_ACK8_HEADER Ack8;
+ ///
+ /// Error packet header.
+ ///
EFI_MTFTP4_ERROR_HEADER Error;
} EFI_MTFTP4_PACKET;
@@ -477,17 +504,60 @@ struct _EFI_MTFTP4_PROTOCOL { };
struct _EFI_MTFTP4_TOKEN {
+ ///
+ /// The status that is returned to the caller at the end of the operation
+ /// to indicate whether this operation completed successfully.
+ ///
EFI_STATUS Status;
+ ///
+ /// 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. The Task Priority Level (TPL) of
+ /// Event must be lower than or equal to TPL_CALLBACK.
+ ///
EFI_EVENT Event;
+ ///
+ /// If not NULL, the data that will be used to override the existing configure data.
+ ///
EFI_MTFTP4_OVERRIDE_DATA *OverrideData;
+ ///
+ /// Pointer to the ASCIIZ file name string.
+ ///
UINT8 *Filename;
+ ///
+ /// Pointer to the ASCIIZ mode string. If NULL, ˇ°octetˇ± is used.
+ ///
UINT8 *ModeStr;
+ ///
+ /// Number of option/value string pairs.
+ ///
UINT32 OptionCount;
+ ///
+ /// Pointer to an array of option/value string pairs. Ignored if OptionCount is zero.
+ ///
EFI_MTFTP4_OPTION *OptionList;
+ ///
+ /// Size of the data buffer.
+ ///
OUT UINT64 BufferSize;
+ ///
+ /// Pointer to the data buffer. Data that is downloaded from the
+ /// MTFTPv4 server is stored here. Data that is uploaded to the
+ /// MTFTPv4 server is read from here. Ignored if BufferSize is zero.
+ ///
OUT VOID *Buffer;
+ ///
+ /// Pointer to the callback function to check the contents of the received packet.
+ ///
EFI_MTFTP4_CHECK_PACKET CheckPacket;
+ ///
+ /// Pointer to the function to be called when a timeout occurs.
+ ///
EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;
+ ///
+ /// Pointer to the function to provide the needed packet contents.
+ ///
EFI_MTFTP4_PACKET_NEEDED PacketNeeded;
};
|