/** @file\r
- EFI Multicast Trivial File Tranfer Protocol Definition\r
+ EFI Multicast Trivial File Transfer Protocol Definition\r
\r
- Copyright (c) 2006 - 2009, 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
- http://opensource.org/licenses/bsd-license.php \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\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
- @par Revision Reference: \r
+ @par Revision Reference:\r
This Protocol is introduced in UEFI Specification 2.0\r
\r
**/\r
#pragma pack()\r
\r
///\r
-/// MTFTP4 option definition\r
+/// MTFTP4 option definition.\r
///\r
typedef struct {\r
UINT8 *OptionStr;\r
\r
typedef struct {\r
EFI_MTFTP4_CONFIG_DATA ConfigData;\r
- UINT8 SupportedOptionCount; \r
+ UINT8 SupportedOptionCount;\r
UINT8 **SupportedOptoins;\r
- UINT8 UnsupportedOptionCount; \r
+ UINT8 UnsupportedOptionCount;\r
UINT8 **UnsupportedOptoins;\r
} EFI_MTFTP4_MODE_DATA;\r
\r
//\r
\r
/**\r
- A callback function that is provided by the caller to intercept \r
+ A callback function that is provided by the caller to intercept\r
the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the\r
- EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept \r
- EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to \r
- EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory(). \r
+ EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept\r
+ EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to\r
+ EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param Token The token that the caller provided in the\r
EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile()\r
or ReadDirectory() function.\r
@param PacketLen Indicates the length of the packet.\r
- @param Packet Pointer to an MTFTPv4 packet.\r
+ @param Packet The pointer to an MTFTPv4 packet.\r
\r
- @retval EFI_SUCCESS Operation sucess\r
- @retval Others Abort transfer process\r
+ @retval EFI_SUCCESS The operation was successful.\r
+ @retval Others Aborts the transfer process.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_CHECK_PACKET)( \r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_MTFTP4_CHECK_PACKET)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_TOKEN *Token,\r
IN UINT16 PacketLen,\r
);\r
\r
/**\r
- Timeout callback funtion. \r
+ Timeout callback function.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param Token The token that is provided in the\r
EFI_MTFTP4_PROTOCOL.ReadFile() or\r
EFI_MTFTP4_PROTOCOL.WriteFile() or\r
EFI_MTFTP4_PROTOCOL.ReadDirectory() functions\r
by the caller.\r
- \r
- @retval EFI_SUCCESS Operation sucess\r
+\r
+ @retval EFI_SUCCESS The operation was successful.\r
@retval Others Aborts download process.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_TIMEOUT_CALLBACK)( \r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_MTFTP4_TIMEOUT_CALLBACK)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_TOKEN *Token\r
);\r
A callback function that the caller provides to feed data to the\r
EFI_MTFTP4_PROTOCOL.WriteFile() function.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param Token The token provided in the\r
EFI_MTFTP4_PROTOCOL.WriteFile() by the caller.\r
@param Length Indicates the length of the raw data wanted on input, and the\r
length the data available on output.\r
- @param Buffer Pointer to the buffer where the data is stored.\r
+ @param Buffer The pointer to the buffer where the data is stored.\r
\r
- @retval EFI_SUCCESS Operation sucess\r
+ @retval EFI_SUCCESS The operation was successful.\r
@retval Others Aborts session.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
-(EFIAPI *EFI_MTFTP4_PACKET_NEEDED)( \r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_MTFTP4_PACKET_NEEDED)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_TOKEN *Token,\r
IN OUT UINT16 *Length,\r
/**\r
Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
- @param ModeData Pointer to storage for the EFI MTFTPv4 Protocol driver mode data.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param ModeData The pointer to storage for the EFI MTFTPv4 Protocol driver mode data.\r
\r
@retval EFI_SUCCESS The configuration data was successfully returned.\r
@retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r
@retval EFI_INVALID_PARAMETER This is NULL or ModeData is NULL.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\r
(EFIAPI *EFI_MTFTP4_GET_MODE_DATA)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
OUT EFI_MTFTP4_MODE_DATA *ModeData\r
\r
\r
/**\r
- Initializes, changes, or resets the default operational setting for this \r
+ Initializes, changes, or resets the default operational setting for this\r
EFI MTFTPv4 Protocol driver instance.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
- @param MtftpConfigData Pointer to the configuration data structure.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param MtftpConfigData The pointer to the configuration data structure.\r
\r
@retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured successfully.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
MTFTPv4 Protocol driver instance is not configured.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\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
/**\r
Gets information about a file from an MTFTPv4 server.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param OverrideData Data that is used to override the existing parameters. If NULL,\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 Filename The pointer to null-terminated ASCII file name string.\r
+ @param ModeStr The pointer to null-terminated ASCII 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
+ @param OptionList The pointer to array of option/value string pairs. Ignored if\r
OptionCount is zero.\r
@param PacketLength The number of bytes in the returned packet.\r
@param Packet The pointer to the received packet. This buffer must be freed by\r
@retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is in the Packet.\r
@retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.\r
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
+ @retval EFI_NO_MEDIA There was a media error.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\r
(EFIAPI *EFI_MTFTP4_GET_INFO)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData OPTIONAL,\r
/**\r
Parses the options in an MTFTPv4 OACK packet.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param PacketLen Length of the OACK packet to be parsed.\r
- @param Packet Pointer to the OACK packet to be parsed.\r
- @param OptionCount Pointer to the number of options in following OptionList.\r
- @param OptionList Pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot\r
+ @param Packet The pointer to the OACK packet to be parsed.\r
+ @param OptionCount The pointer to the number of options in following OptionList.\r
+ @param OptionList The pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot\r
Service FreePool() to release the OptionList if the options\r
in this OptionList are not needed any more.\r
\r
@retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\r
(EFIAPI *EFI_MTFTP4_PARSE_OPTIONS)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN UINT32 PacketLen,\r
IN EFI_MTFTP4_PACKET *Packet,\r
OUT UINT32 *OptionCount,\r
OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL\r
- ); \r
+ );\r
\r
\r
/**\r
Downloads a file from an MTFTPv4 server.\r
\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
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param Token The pointer to the token structure to provide the parameters that are\r
used in this operation.\r
\r
@retval EFI_SUCCESS The data file has been transferred successfully.\r
@retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.\r
@retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received.\r
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
+ @retval EFI_NO_MEDIA There was a media error.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\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 Token Pointer to the token structure to provide the parameters that are\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param Token The pointer to the token structure to provide the parameters that are\r
used in this operation.\r
\r
@retval EFI_SUCCESS The upload session has started.\r
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\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
- implementations. \r
+ implementations.\r
\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
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param Token The pointer to the token structure to provide the parameters that are\r
used in this operation.\r
\r
@retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded.\r
@retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\r
(EFIAPI *EFI_MTFTP4_READ_DIRECTORY)(\r
IN EFI_MTFTP4_PROTOCOL *This,\r
IN EFI_MTFTP4_TOKEN *Token\r
- ); \r
+ );\r
\r
/**\r
Polls for incoming data packets and processes outgoing data packets.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started.\r
EFI_STATUS\r
(EFIAPI *EFI_MTFTP4_POLL)(\r
IN EFI_MTFTP4_PROTOCOL *This\r
- ); \r
- \r
+ );\r
+\r
///\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 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
+///\r
struct _EFI_MTFTP4_PROTOCOL {\r
EFI_MTFTP4_GET_MODE_DATA GetModeData;\r
EFI_MTFTP4_CONFIGURE Configure;\r
///\r
EFI_MTFTP4_OVERRIDE_DATA *OverrideData;\r
///\r
- /// Pointer to the ASCIIZ file name string.\r
+ /// The pointer to the null-terminated ASCII file name string.\r
///\r
UINT8 *Filename;\r
///\r
- /// Pointer to the ASCIIZ mode string. If NULL, "octet" is used.\r
+ /// The pointer to the null-terminated ASCII mode string. If NULL, "octet" is used.\r
///\r
UINT8 *ModeStr;\r
///\r
///\r
UINT32 OptionCount;\r
///\r
- /// Pointer to an array of option/value string pairs. Ignored if OptionCount is zero.\r
+ /// The pointer to an array of option/value string pairs. Ignored if OptionCount is zero.\r
///\r
EFI_MTFTP4_OPTION *OptionList;\r
///\r
- /// Size of the data buffer.\r
+ /// The size of the data buffer.\r
///\r
UINT64 BufferSize;\r
///\r
- /// Pointer to the data buffer. Data that is downloaded from the\r
+ /// The pointer to the data buffer. Data that is downloaded from the\r
/// MTFTPv4 server is stored here. Data that is uploaded to the\r
/// MTFTPv4 server is read from here. Ignored if BufferSize is zero.\r
///\r
VOID *Buffer;\r
///\r
- /// Pointer to the context that will be used by CheckPacket, \r
+ /// The pointer to the context that will be used by CheckPacket,\r
/// TimeoutCallback and PacketNeeded.\r
///\r
VOID *Context;\r
///\r
- /// Pointer to the callback function to check the contents of the received packet.\r
+ /// The pointer to the callback function to check the contents of the received packet.\r
///\r
EFI_MTFTP4_CHECK_PACKET CheckPacket;\r
///\r
- /// Pointer to the function to be called when a timeout occurs.\r
+ /// The pointer to the function to be called when a timeout occurs.\r
///\r
EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;\r
///\r
- /// Pointer to the function to provide the needed packet contents.\r
+ /// The pointer to the function to provide the needed packet contents.\r
///\r
EFI_MTFTP4_PACKET_NEEDED PacketNeeded;\r
};\r
\r
extern EFI_GUID gEfiMtftp4ServiceBindingProtocolGuid;\r
-extern EFI_GUID gEfiMtftp4ProtocolGuid; \r
+extern EFI_GUID gEfiMtftp4ProtocolGuid;\r
\r
#endif\r
\r
projects / mirror_edk2.git / blobdiff