the EFI IPv6 Protocol and provides simple packet-oriented services to transmit and receive\r
UDP packets.\r
\r
- Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
- 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
- \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
+ Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ 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
+\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
This Protocol is introduced in UEFI Specification 2.2\r
\r
**/\r
///\r
EFI_IPv6_ADDRESS RemoteAddress;\r
///\r
- /// The port number in host byte order on which the remote host is \r
+ /// The port number in host byte order on which the remote host is\r
/// listening. Maybe zero if it is not connected to any remote host.\r
///\r
UINT16 RemotePort;\r
///\r
EFI_IPv6_ADDRESS DestinationAddress;\r
///\r
- /// Port to which this packet is sent. When sending packet, it'll be \r
+ /// Port to which this packet is sent. When sending packet, it'll be\r
/// ignored if it is zero.\r
///\r
UINT16 DestinationPort;\r
///\r
/// The port number to which this EFI UDPv6 Protocol instance is bound. If a client\r
/// of the EFI UDPv6 Protocol does not care about the port number, set StationPort\r
- /// to zero. The EFI UDPv6 Protocol driver will assign a random port number to transmitted \r
+ /// to zero. The EFI UDPv6 Protocol driver will assign a random port number to transmitted\r
/// UDP packets. Ignored it if AcceptAnyPort is TRUE.\r
///\r
UINT16 StationPort;\r
/// packets, the CompletionToken.Packet.RxData field is updated to this incoming packet and\r
/// the CompletionToken.Event is signaled. The EFI UDPv6 Protocol client must signal the\r
/// RecycleSignal after processing the packet.\r
-/// FragmentTable could contain multiple buffers that are not in the continuous memory locations. \r
-/// The EFI UDPv6 Protocol client might need to combine two or more buffers in FragmentTable to \r
+/// FragmentTable could contain multiple buffers that are not in the continuous memory locations.\r
+/// The EFI UDPv6 Protocol client might need to combine two or more buffers in FragmentTable to\r
/// form their own protocol header.\r
///\r
typedef struct {\r
/// - EFI_SUCCESS: The receive or transmit operation completed successfully.\r
/// - EFI_ABORTED: The receive or transmit was aborted.\r
/// - EFI_TIMEOUT: The transmit timeout expired.\r
- /// - EFI_NETWORK_UNREACHABLE: The destination network is unreachable. RxData is set to \r
+ /// - EFI_NETWORK_UNREACHABLE: The destination network is unreachable. RxData is set to\r
/// NULL in this situation.\r
- /// - EFI_HOST_UNREACHABLE: The destination host is unreachable. RxData is set to NULL in \r
+ /// - EFI_HOST_UNREACHABLE: The destination host is unreachable. RxData is set to NULL in\r
/// this situation.\r
- /// - EFI_PROTOCOL_UNREACHABLE: The UDP protocol is unsupported in the remote system. \r
+ /// - EFI_PROTOCOL_UNREACHABLE: The UDP protocol is unsupported in the remote system.\r
/// RxData is set to NULL in this situation.\r
- /// - EFI_PORT_UNREACHABLE: No service is listening on the remote port. RxData is set to \r
+ /// - EFI_PORT_UNREACHABLE: No service is listening on the remote port. RxData is set to\r
/// NULL in this situation.\r
- /// - EFI_ICMP_ERROR: Some other Internet Control Message Protocol (ICMP) error report was \r
+ /// - EFI_ICMP_ERROR: Some other Internet Control Message Protocol (ICMP) error report was\r
/// received. For example, packets are being sent too fast for the destination to receive them\r
/// and the destination sent an ICMP source quench report. RxData is set to NULL in this situation.\r
/// - EFI_DEVICE_ERROR: An unexpected system or network error occurred.\r
\r
The GetModeData() function copies the current operational settings of this EFI UDPv6 Protocol\r
instance into user-supplied buffers. This function is used optionally to retrieve the operational\r
- mode data of underlying networks or drivers. \r
+ mode data of underlying networks or drivers.\r
\r
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.\r
@param[out] Udp6ConfigData The buffer in which the current UDP configuration data is returned.\r
);\r
\r
/**\r
- Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv6 \r
+ Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv6\r
Protocol.\r
\r
The Configure() function is used to do the following:\r
- Initialize and start this instance of the EFI UDPv6 Protocol.\r
- Change the filtering rules and operational parameters.\r
- - Reset this instance of the EFI UDPv6 Protocol. \r
+ - Reset this instance of the EFI UDPv6 Protocol.\r
\r
Until these parameters are initialized, no network traffic can be sent or received by this instance.\r
This instance can be also reset by calling Configure() with UdpConfigData set to NULL.\r
@param[in] UdpConfigData Pointer to the buffer contained the configuration data.\r
\r
@retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.\r
- @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source \r
+ @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source\r
address for this instance, but no source address was available for use.\r
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
- This is NULL.\r
ReceiveTimeout, and TransmitTimeout can be reconfigured without stopping\r
the current instance of the EFI UDPv6 Protocol.\r
@retval EFI_ACCESS_DENIED UdpConfigData.AllowDuplicatePort is FALSE and UdpConfigData.StationPort\r
- is already used by other instance. \r
+ is already used by other instance.\r
@retval EFI_OUT_OF_RESOURCES The EFI UDPv6 Protocol driver cannot allocate memory for this EFI UDPv6\r
Protocol instance.\r
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance was not\r
receive the notification and transmitting status.\r
\r
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.\r
- @param[in] Token Pointer to the completion token that will be placed into the \r
+ @param[in] Token Pointer to the completion token that will be placed into the\r
transmit queue.\r
\r
@retval EFI_SUCCESS The data has been queued for transmission.\r
fields is NULL.\r
- Token.Packet.TxData.UdpSessionData.DestinationAddress is not zero\r
and is not valid unicast Ipv6 address if UdpSessionData is not NULL.\r
- - Token.Packet.TxData.UdpSessionData is NULL and this instance's \r
+ - Token.Packet.TxData.UdpSessionData is NULL and this instance's\r
UdpConfigData.RemoteAddress is unspecified.\r
- Token.Packet.TxData.UdpSessionData.DestinationAddress is non-zero\r
when DestinationAddress is configured as non-zero when doing Configure()\r
for this EFI Udp6 protocol instance.\r
- - Token.Packet.TxData.UdpSesionData.DestinationAddress is zero when \r
+ - Token.Packet.TxData.UdpSesionData.DestinationAddress is zero when\r
DestinationAddress is unspecified when doing Configure() for this\r
EFI Udp6 protocol instance.\r
@retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event was already\r
\r
The Receive() function places a completion token into the receive packet queue. This function is\r
always asynchronous.\r
- The caller must fill in the Token.Event field in the completion token, and this field cannot be \r
+ The caller must fill in the Token.Event field in the completion token, and this field cannot be\r
NULL. When the receive operation completes, the EFI UDPv6 Protocol driver updates the Token.Status\r
and Token.Packet.RxData fields and the Token.Event is signaled.\r
Providing a proper notification function and context for the event will enable the user to receive\r
- This is NULL.\r
- Token is NULL.\r
- Token.Event is NULL.\r
- @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system \r
+ @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r
resources (usually memory).\r
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI UDPv6 Protocol\r
instance has been reset to startup defaults.\r
- @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in \r
+ @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in\r
the receive queue.\r
@retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
- @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. \r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
@retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
Consider increasing the polling rate.\r
\r
/// applications, or daemons to transmit or receive UDP packets. This protocol instance can either be\r
/// bound to a specified port as a service or connected to some remote peer as an active client.\r
/// Each instance has its own settings, such as group table, that are independent from each other.\r
-/// \r
+///\r
struct _EFI_UDP6_PROTOCOL {\r
EFI_UDP6_GET_MODE_DATA GetModeData;\r
EFI_UDP6_CONFIGURE Configure;\r
projects / mirror_edk2.git / blobdiff