/** @file\r
EFI Multicast Trivial File Tranfer Protocol Definition\r
\r
- Copyright (c) 2006, Intel Corporation \r
+ Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
- Module Name: Mtftp4.h\r
-\r
**/\r
\r
#ifndef __EFI_MTFTP4_PROTOCOL_H__\r
\r
#define EFI_MTFTP4_PROTOCOL_GUID \\r
{ \\r
- 0x3ad9df29, 0x4501, 0x478d, {0xb1, 0xf8, 0x7f, 0x7f, 0xe7, 0x0e, 0x50, 0xf3 } \\r
+ 0x78247c57, 0x63db, 0x4708, {0x99, 0xc2, 0xa8, 0xb4, 0xa9, 0xa6, 0x1f, 0x6b } \\r
}\r
\r
typedef struct _EFI_MTFTP4_PROTOCOL EFI_MTFTP4_PROTOCOL;\r
\r
#pragma pack()\r
\r
-//\r
-// MTFTP4 option definition\r
-//\r
+///\r
+/// MTFTP4 option definition\r
+///\r
typedef struct {\r
UINT8 *OptionStr;\r
UINT8 *ValueStr;\r
IN EFI_MTFTP4_TOKEN *Token,\r
IN UINT16 PacketLen,\r
IN EFI_MTFTP4_PACKET *Paket\r
- )\r
-;\r
+ );\r
\r
/**\r
Timeout callback funtion. \r
(EFIAPI *EFI_MTFTP4_TIMEOUT_CALLBACK)( \r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_TOKEN *Token\r
- )\r
-;\r
+ );\r
\r
/**\r
a callback function that the caller provides to feed data to the\r
IN EFI_MTFTP4_TOKEN *Token,\r
IN OUT UINT16 *Length,\r
OUT VOID **Buffer\r
- )\r
-;\r
+ );\r
\r
\r
/**\r
(EFIAPI *EFI_MTFTP4_GET_MODE_DATA)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
OUT EFI_MTFTP4_MODE_DATA *ModeData\r
- )\r
-;\r
+ );\r
\r
\r
/**\r
(EFIAPI *EFI_MTFTP4_CONFIGURE)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_CONFIG_DATA *MtftpConfigData OPTIONAL\r
- )\r
-; \r
+ ); \r
\r
\r
/**\r
the default parameters that were set in the\r
EFI_MTFTP4_PROTOCOL.Configure() function are used.\r
@param Filename Pointer to ASCIIZ file name string.\r
- @param ModeStr Pointer to ASCIIZ mode string. If NULL, ¡°octet¡± will be used.\r
+ @param ModeStr Pointer to ASCIIZ mode string. If NULL, "octet" will be used.\r
@param OptionCount Number of option/value string pairs in OptionList.\r
@param OptionList Pointer to array of option/value string pairs. Ignored if\r
OptionCount is zero.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
@retval EFI_UNSUPPORTED One or more options in the OptionList are in the\r
unsupported list of structure EFI_MTFTP4_MODE_DATA.\r
- \r
@retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.\r
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
RARP, etc.) has not finished yet.\r
IN EFI_MTFTP4_OPTION *OptionList,\r
OUT UINT32 *PacketLength,\r
OUT EFI_MTFTP4_PACKET **Packet OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Parses the options in an MTFTPv4 OACK packet.\r
IN EFI_MTFTP4_PACKET *Packet,\r
OUT UINT32 *OptionCount,\r
OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL\r
- )\r
-; \r
+ ); \r
\r
\r
/**\r
(EFIAPI *EFI_MTFTP4_READ_FILE)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_TOKEN *Token\r
- )\r
-; \r
+ ); \r
\r
\r
\r
/**\r
Sends a file to an MTFTPv4 server.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param Token Pointer to the token structure to provide the parameters that are\r
- used in this operation.\r
+ used in this operation.\r
\r
@retval EFI_SUCCESS The upload session has started.\r
@retval EFI_UNSUPPORTED The operation is not supported by this implementation.\r
(EFIAPI *EFI_MTFTP4_WRITE_FILE)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_TOKEN *Token\r
- )\r
-; \r
+ ); \r
\r
\r
/**\r
- Downloads a data file ¡°directory¡± from an MTFTPv4 server. May be unsupported in some EFI\r
+ Downloads a data file "directory" from an MTFTPv4 server. May be unsupported in some EFI\r
implementations. \r
\r
@param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
(EFIAPI *EFI_MTFTP4_READ_DIRECTORY)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_TOKEN *Token\r
- )\r
-; \r
+ ); \r
\r
/**\r
Polls for incoming data packets and processes outgoing data packets.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_MTFTP4_POLL) (\r
+(EFIAPI *EFI_MTFTP4_POLL)(\r
IN EFI_MTFTP4_PROTOCOL *This\r
- )\r
-; \r
+ ); \r
\r
- \r
+/** \r
+ The EFI MTFTPv4 Protocol provides basic services for client-side unicast \r
+ and/or multicast TFTP operations.\r
+\r
+ @par Protocol Description:\r
+ The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications \r
+ to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses \r
+ the underlying EFI UDPv4 Protocol driver and EFI IPv4 Protocol driver.\r
+\r
+ @param GetModeData\r
+ Reads the current operational settings. \r
+\r
+ @param Configure\r
+ Initializes, changes, or resets the operational settings for \r
+ this instance of the EFI MTFTPv4 Protocol driver. \r
+\r
+ @param GetInfo\r
+ Retrieves information about a file from an MTFTPv4 server. \r
+\r
+ @param ParseOptions\r
+ Parses the options in an MTFTPv4 OACK (options acknowledgement) packet. \r
+\r
+ @param ReadFile\r
+ Downloads a file from an MTFTPv4 server. \r
+\r
+ @param WriteFile\r
+ Uploads a file to an MTFTPv4 server. This function may be unsupported \r
+ in some EFI implementations. \r
+\r
+ @param ReadDirectory\r
+ Downloads a related file directory from an MTFTPv4 server. This function \r
+ may be unsupported in some EFI implementations. \r
+\r
+ @param Poll\r
+ Polls for incoming data packets and processes outgoing data packets. \r
+\r
+**/ \r
struct _EFI_MTFTP4_PROTOCOL {\r
EFI_MTFTP4_GET_MODE_DATA GetModeData;\r
EFI_MTFTP4_CONFIGURE Configure;\r
};\r
\r
struct _EFI_MTFTP4_TOKEN {\r
- OUT EFI_STATUS Status;\r
- IN EFI_EVENT Event;\r
- IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData;\r
- IN UINT8 *Filename;\r
- IN UINT8 *ModeStr;\r
- IN UINT32 OptionCount;\r
- IN EFI_MTFTP4_OPTION *OptionList;\r
- IN OUT UINT64 BufferSize;\r
- IN OUT VOID *Buffer;\r
- IN EFI_MTFTP4_CHECK_PACKET CheckPacket;\r
- IN EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;\r
- IN EFI_MTFTP4_PACKET_NEEDED PacketNeeded;\r
+ EFI_STATUS Status;\r
+ EFI_EVENT Event;\r
+ EFI_MTFTP4_OVERRIDE_DATA *OverrideData;\r
+ UINT8 *Filename;\r
+ UINT8 *ModeStr;\r
+ UINT32 OptionCount;\r
+ EFI_MTFTP4_OPTION *OptionList;\r
+ OUT UINT64 BufferSize;\r
+ OUT VOID *Buffer;\r
+ EFI_MTFTP4_CHECK_PACKET CheckPacket;\r
+ EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;\r
+ EFI_MTFTP4_PACKET_NEEDED PacketNeeded;\r
};\r
\r
extern EFI_GUID gEfiMtftp4ServiceBindingProtocolGuid;\r
projects / mirror_edk2.git / blobdiff