2 The EFI UDPv6 (User Datagram Protocol version 6) Protocol Definition, which is built upon
3 the EFI IPv6 Protocol and provides simple packet-oriented services to transmit and receive
6 Copyright (c) 2008 - 2009, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef __EFI_UDP6_PROTOCOL_H__
18 #define __EFI_UDP6_PROTOCOL_H__
20 #include <Protocol/Ip6.h>
22 #define EFI_UDP6_SERVICE_BINDING_PROTOCOL_GUID \
24 0x66ed4721, 0x3c98, 0x4d3e, {0x81, 0xe3, 0xd0, 0x3d, 0xd3, 0x9a, 0x72, 0x54 } \
27 #define EFI_UDP6_PROTOCOL_GUID \
29 0x4f948815, 0xb4b9, 0x43cb, {0x8a, 0x33, 0x90, 0xe0, 0x60, 0xb3, 0x49, 0x55 } \
34 /// The EFI UDPv6 Protocol instance handle that is using this address/port pair.
36 EFI_HANDLE InstanceHandle
;
38 /// The IPv6 address to which this instance of the EFI UDPv6 Protocol is bound.
39 /// Set to 0::/128, if this instance is used to listen all packets from any
42 EFI_IPv6_ADDRESS LocalAddress
;
44 /// The port number in host byte order on which the service is listening.
48 /// The IPv6 address of the remote host. May be 0::/128 if it is not connected
49 /// to any remote host or connected with more than one remote host.
51 EFI_IPv6_ADDRESS RemoteAddress
;
53 /// The port number in host byte order on which the remote host is
54 /// listening. Maybe zero if it is not connected to any remote host.
57 } EFI_UDP6_SERVICE_POINT
;
61 /// The handle of the driver that creates this entry.
63 EFI_HANDLE DriverHandle
;
65 /// The number of address/port pairs that follow this data structure.
69 /// List of address/port pairs that are currently in use.
71 EFI_UDP6_SERVICE_POINT Services
[1];
72 } EFI_UDP6_VARIABLE_DATA
;
74 typedef struct _EFI_UDP6_PROTOCOL EFI_UDP6_PROTOCOL
;
77 /// EFI_UDP6_FRAGMENT_DATA allows multiple receive or transmit buffers to be specified.
78 /// The purpose of this structure is to avoid copying the same packet multiple times.
81 UINT32 FragmentLength
; ///< Length of the fragment data buffer.
82 VOID
*FragmentBuffer
; ///< Pointer to the fragment data buffer.
83 } EFI_UDP6_FRAGMENT_DATA
;
86 /// The EFI_UDP6_SESSION_DATA is used to retrieve the settings when receiving packets or
87 /// to override the existing settings (only DestinationAddress and DestinationPort can
88 /// be overridden) of this EFI UDPv6 Protocol instance when sending packets.
92 /// Address from which this packet is sent. This field should not be used when
95 EFI_IPv6_ADDRESS SourceAddress
;
97 /// Port from which this packet is sent. It is in host byte order. This field should
98 /// not be used when sending packets.
102 /// Address to which this packet is sent. When sending packet, it'll be ignored
105 EFI_IPv6_ADDRESS DestinationAddress
;
107 /// Port to which this packet is sent. When sending packet, it'll be
108 /// ignored if it is zero.
110 UINT16 DestinationPort
;
111 } EFI_UDP6_SESSION_DATA
;
115 /// Set to TRUE to accept UDP packets that are sent to any address.
117 BOOLEAN AcceptPromiscuous
;
119 /// Set to TRUE to accept UDP packets that are sent to any port.
121 BOOLEAN AcceptAnyPort
;
123 /// Set to TRUE to allow this EFI UDPv6 Protocol child instance to open a port number
124 /// that is already being used by another EFI UDPv6 Protocol child instance.
126 BOOLEAN AllowDuplicatePort
;
128 /// TrafficClass field in transmitted IPv6 packets.
132 /// HopLimit field in transmitted IPv6 packets.
136 /// The receive timeout value (number of microseconds) to be associated with each
137 /// incoming packet. Zero means do not drop incoming packets.
139 UINT32 ReceiveTimeout
;
141 /// The transmit timeout value (number of microseconds) to be associated with each
142 /// outgoing packet. Zero means do not drop outgoing packets.
144 UINT32 TransmitTimeout
;
146 /// The station IP address that will be assigned to this EFI UDPv6 Protocol instance.
147 /// The EFI UDPv6 and EFI IPv6 Protocol drivers will only deliver incoming packets
148 /// whose destination matches this IP address exactly. Address 0::/128 is also accepted
149 /// as a special case. Under this situation, underlying IPv6 driver is responsible for
150 /// binding a source address to this EFI IPv6 protocol instance according to source
151 /// address selection algorithm. Only incoming packet from the selected source address
152 /// is delivered. This field can be set and changed only when the EFI IPv6 driver is
153 /// transitioning from the stopped to the started states. If no address is available
154 /// for selecting, the EFI IPv6 Protocol driver will use EFI_IP6_CONFIG_PROTOCOL to
155 /// retrieve the IPv6 address.
156 EFI_IPv6_ADDRESS StationAddress
;
158 /// The port number to which this EFI UDPv6 Protocol instance is bound. If a client
159 /// of the EFI UDPv6 Protocol does not care about the port number, set StationPort
160 /// to zero. The EFI UDPv6 Protocol driver will assign a random port number to transmitted
161 /// UDP packets. Ignored it if AcceptAnyPort is TRUE.
165 /// The IP address of remote host to which this EFI UDPv6 Protocol instance is connecting.
166 /// If RemoteAddress is not 0::/128, this EFI UDPv6 Protocol instance will be connected to
167 /// RemoteAddress; i.e., outgoing packets of this EFI UDPv6 Protocol instance will be sent
168 /// to this address by default and only incoming packets from this address will be delivered
169 /// to client. Ignored for incoming filtering if AcceptPromiscuous is TRUE.
170 EFI_IPv6_ADDRESS RemoteAddress
;
172 /// The port number of the remote host to which this EFI UDPv6 Protocol instance is connecting.
173 /// If it is not zero, outgoing packets of this EFI UDPv6 Protocol instance will be sent to
174 /// this port number by default and only incoming packets from this port will be delivered
175 /// to client. Ignored if RemoteAddress is 0::/128 and ignored for incoming filtering if
176 /// AcceptPromiscuous is TRUE.
178 } EFI_UDP6_CONFIG_DATA
;
181 /// The EFI UDPv6 Protocol client must fill this data structure before sending a packet.
182 /// The packet may contain multiple buffers that may be not in a continuous memory location.
186 /// If not NULL, the data that is used to override the transmitting settings.Only the two
187 /// filed UdpSessionData.DestinationAddress and UdpSessionData.DestionPort can be used as
188 /// the transmitting setting filed.
190 EFI_UDP6_SESSION_DATA
*UdpSessionData
;
192 /// Sum of the fragment data length. Must not exceed the maximum UDP packet size.
196 /// Number of fragments.
198 UINT32 FragmentCount
;
200 /// Array of fragment descriptors.
202 EFI_UDP6_FRAGMENT_DATA FragmentTable
[1];
203 } EFI_UDP6_TRANSMIT_DATA
;
206 /// EFI_UDP6_RECEIVE_DATA is filled by the EFI UDPv6 Protocol driver when this EFI UDPv6
207 /// Protocol instance receives an incoming packet. If there is a waiting token for incoming
208 /// packets, the CompletionToken.Packet.RxData field is updated to this incoming packet and
209 /// the CompletionToken.Event is signaled. The EFI UDPv6 Protocol client must signal the
210 /// RecycleSignal after processing the packet.
211 /// FragmentTable could contain multiple buffers that are not in the continuous memory locations.
212 /// The EFI UDPv6 Protocol client might need to combine two or more buffers in FragmentTable to
213 /// form their own protocol header.
217 /// Time when the EFI UDPv6 Protocol accepted the packet.
221 /// Indicates the event to signal when the received data has been processed.
223 EFI_EVENT RecycleSignal
;
225 /// The UDP session data including SourceAddress, SourcePort, DestinationAddress,
226 /// and DestinationPort.
228 EFI_UDP6_SESSION_DATA UdpSession
;
230 /// The sum of the fragment data length.
234 /// Number of fragments. Maybe zero.
236 UINT32 FragmentCount
;
238 /// Array of fragment descriptors. Maybe zero.
240 EFI_UDP6_FRAGMENT_DATA FragmentTable
[1];
241 } EFI_UDP6_RECEIVE_DATA
;
244 /// The EFI_UDP6_COMPLETION_TOKEN structures are used for both transmit and receive operations.
245 /// When used for transmitting, the Event and TxData fields must be filled in by the EFI UDPv6
246 /// Protocol client. After the transmit operation completes, the Status field is updated by the
247 /// EFI UDPv6 Protocol and the Event is signaled.
248 /// When used for receiving, only the Event field must be filled in by the EFI UDPv6 Protocol
249 /// client. After a packet is received, RxData and Status are filled in by the EFI UDPv6 Protocol
250 /// and the Event is signaled.
254 /// This Event will be signaled after the Status field is updated by the EFI UDPv6 Protocol
255 /// driver. The type of Event must be EVT_NOTIFY_SIGNAL.
259 /// Will be set to one of the following values:
260 /// - EFI_SUCCESS: The receive or transmit operation completed successfully.
261 /// - EFI_ABORTED: The receive or transmit was aborted.
262 /// - EFI_TIMEOUT: The transmit timeout expired.
263 /// - EFI_NETWORK_UNREACHABLE: The destination network is unreachable. RxData is set to
264 /// NULL in this situation.
265 /// - EFI_HOST_UNREACHABLE: The destination host is unreachable. RxData is set to NULL in
267 /// - EFI_PROTOCOL_UNREACHABLE: The UDP protocol is unsupported in the remote system.
268 /// RxData is set to NULL in this situation.
269 /// - EFI_PORT_UNREACHABLE: No service is listening on the remote port. RxData is set to
270 /// NULL in this situation.
271 /// - EFI_ICMP_ERROR: Some other Internet Control Message Protocol (ICMP) error report was
272 /// received. For example, packets are being sent too fast for the destination to receive them
273 /// and the destination sent an ICMP source quench report. RxData is set to NULL in this situation.
274 /// - EFI_DEVICE_ERROR: An unexpected system or network error occurred.
275 /// - EFI_SECURITY_VIOLATION: The transmit or receive was failed because of IPsec policy check.
280 /// When this token is used for receiving, RxData is a pointer to EFI_UDP6_RECEIVE_DATA.
282 EFI_UDP6_RECEIVE_DATA
*RxData
;
284 /// When this token is used for transmitting, TxData is a pointer to EFI_UDP6_TRANSMIT_DATA.
286 EFI_UDP6_TRANSMIT_DATA
*TxData
;
288 } EFI_UDP6_COMPLETION_TOKEN
;
291 Read the current operational settings.
293 The GetModeData() function copies the current operational settings of this EFI UDPv6 Protocol
294 instance into user-supplied buffers. This function is used optionally to retrieve the operational
295 mode data of underlying networks or drivers.
297 @param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
298 @param[out] Udp6ConfigData The buffer in which the current UDP configuration data is returned.
299 @param[out] Ip6ModeData The buffer in which the current EFI IPv6 Protocol mode data is returned.
300 @param[out] MnpConfigData The buffer in which the current managed network configuration data is
302 @param[out] SnpModeData The buffer in which the simple network mode data is returned.
304 @retval EFI_SUCCESS The mode data was read.
305 @retval EFI_NOT_STARTED When Udp6ConfigData is queried, no configuration data is available
306 because this instance has not been started.
307 @retval EFI_INVALID_PARAMETER This is NULL.
312 (EFIAPI
*EFI_UDP6_GET_MODE_DATA
)(
313 IN EFI_UDP6_PROTOCOL
*This
,
314 OUT EFI_UDP6_CONFIG_DATA
*Udp6ConfigData OPTIONAL
,
315 OUT EFI_IP6_MODE_DATA
*Ip6ModeData OPTIONAL
,
316 OUT EFI_MANAGED_NETWORK_CONFIG_DATA
*MnpConfigData OPTIONAL
,
317 OUT EFI_SIMPLE_NETWORK_MODE
*SnpModeData OPTIONAL
321 Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv6
324 The Configure() function is used to do the following:
325 - Initialize and start this instance of the EFI UDPv6 Protocol.
326 - Change the filtering rules and operational parameters.
327 - Reset this instance of the EFI UDPv6 Protocol.
329 Until these parameters are initialized, no network traffic can be sent or received by this instance.
330 This instance can be also reset by calling Configure() with UdpConfigData set to NULL.
331 Once reset, the receiving queue and transmitting queue are flushed and no traffic is allowed through
334 With different parameters in UdpConfigData, Configure() can be used to bind this instance to specified
337 @param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
338 @param[in] UdpConfigData Pointer to the buffer contained the configuration data.
340 @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.
341 @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
342 address for this instance, but no source address was available for use.
343 @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:
345 - UdpConfigData.StationAddress neither zero nor one of the configured IP
346 addresses in the underlying IPv6 driver.
347 - UdpConfigData.RemoteAddress is not a valid unicast IPv6 address if it
349 @retval EFI_ALREADY_STARTED The EFI UDPv6 Protocol instance is already started/configured and must be
350 stopped/reset before it can be reconfigured. Only TrafficClass, HopLimit,
351 ReceiveTimeout, and TransmitTimeout can be reconfigured without stopping
352 the current instance of the EFI UDPv6 Protocol.
353 @retval EFI_ACCESS_DENIED UdpConfigData.AllowDuplicatePort is FALSE and UdpConfigData.StationPort
354 is already used by other instance.
355 @retval EFI_OUT_OF_RESOURCES The EFI UDPv6 Protocol driver cannot allocate memory for this EFI UDPv6
357 @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance was not
363 (EFIAPI
*EFI_UDP6_CONFIGURE
)(
364 IN EFI_UDP6_PROTOCOL
*This
,
365 IN EFI_UDP6_CONFIG_DATA
*UdpConfigData OPTIONAL
369 Joins and leaves multicast groups.
371 The Groups() function is used to join or leave one or more multicast group.
372 If the JoinFlag is FALSE and the MulticastAddress is NULL, then all currently joined groups are left.
374 @param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
375 @param[in] JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one
376 or all multicast groups.
377 @param[in] MulticastAddress Pointer to multicast group address to join or leave.
379 @retval EFI_SUCCESS The operation completed successfully.
380 @retval EFI_NOT_STARTED The EFI UDPv6 Protocol instance has not been started.
381 @retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group.
382 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
384 - JoinFlag is TRUE and MulticastAddress is NULL.
385 - JoinFlag is TRUE and *MulticastAddress is not a valid multicast address.
386 @retval EFI_ALREADY_STARTED The group address is already in the group table (when JoinFlag is TRUE).
387 @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).
388 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
393 (EFIAPI
*EFI_UDP6_GROUPS
)(
394 IN EFI_UDP6_PROTOCOL
*This
,
396 IN EFI_IPv6_ADDRESS
*MulticastAddress OPTIONAL
400 Queues outgoing data packets into the transmit queue.
402 The Transmit() function places a sending request to this instance of the EFI UDPv6 Protocol,
403 alongside the transmit data that was filled by the user. Whenever the packet in the token is
404 sent out or some errors occur, the Token.Event will be signaled and Token.Status is updated.
405 Providing a proper notification function and context for the event will enable the user to
406 receive the notification and transmitting status.
408 @param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
409 @param[in] Token Pointer to the completion token that will be placed into the
412 @retval EFI_SUCCESS The data has been queued for transmission.
413 @retval EFI_NOT_STARTED This EFI UDPv6 Protocol instance has not been started.
414 @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
415 address for this instance, but no source address was available
417 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
420 - Token.Event is NULL.
421 - Token.Packet.TxData is NULL.
422 - Token.Packet.TxData.FragmentCount is zero.
423 - Token.Packet.TxData.DataLength is not equal to the sum of fragment
425 - One or more of the Token.Packet.TxData.FragmentTable[].FragmentLength
427 - One or more of the Token.Packet.TxData.FragmentTable[].FragmentBuffer
429 - Token.Packet.TxData.UdpSessionData.DestinationAddress is not zero
430 and is not valid unicast Ipv6 address if UdpSessionData is not NULL.
431 - Token.Packet.TxData.UdpSessionData is NULL and this instance's
432 UdpConfigData.RemoteAddress is unspecified.
433 - Token.Packet.TxData.UdpSessionData.DestinationAddress is non-zero
434 when DestinationAddress is configured as non-zero when doing Configure()
435 for this EFI Udp6 protocol instance.
436 - Token.Packet.TxData.UdpSesionData.DestinationAddress is zero when
437 DestinationAddress is unspecified when doing Configure() for this
438 EFI Udp6 protocol instance.
439 @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event was already
440 in the transmit queue.
441 @retval EFI_NOT_READY The completion token could not be queued because the transmit queue
443 @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.
444 @retval EFI_NOT_FOUND There is no route to the destination network or address.
445 @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP packet size.
450 (EFIAPI
*EFI_UDP6_TRANSMIT
)(
451 IN EFI_UDP6_PROTOCOL
*This
,
452 IN EFI_UDP6_COMPLETION_TOKEN
*Token
456 Places an asynchronous receive request into the receiving queue.
458 The Receive() function places a completion token into the receive packet queue. This function is
460 The caller must fill in the Token.Event field in the completion token, and this field cannot be
461 NULL. When the receive operation completes, the EFI UDPv6 Protocol driver updates the Token.Status
462 and Token.Packet.RxData fields and the Token.Event is signaled.
463 Providing a proper notification function and context for the event will enable the user to receive
464 the notification and receiving status. That notification function is guaranteed to not be re-entered.
466 @param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
467 @param[in] Token Pointer to a token that is associated with the receive data descriptor.
469 @retval EFI_SUCCESS The receive completion token was cached.
470 @retval EFI_NOT_STARTED This EFI UDPv6 Protocol instance has not been started.
471 @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
472 address for this instance, but no source address was available
474 @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
477 - Token.Event is NULL.
478 @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system
479 resources (usually memory).
480 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI UDPv6 Protocol
481 instance has been reset to startup defaults.
482 @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in
484 @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
489 (EFIAPI
*EFI_UDP6_RECEIVE
)(
490 IN EFI_UDP6_PROTOCOL
*This
,
491 IN EFI_UDP6_COMPLETION_TOKEN
*Token
495 Aborts an asynchronous transmit or receive request.
497 The Cancel() function is used to abort a pending transmit or receive request. If the token is in the
498 transmit or receive request queues, after calling this function, Token.Status will be set to
499 EFI_ABORTED and then Token.Event will be signaled. If the token is not in one of the queues,
500 which usually means that the asynchronous operation has completed, this function will not signal the
501 token and EFI_NOT_FOUND is returned.
503 @param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
504 @param[in] Token Pointer to a token that has been issued by EFI_UDP6_PROTOCOL.Transmit()
505 or EFI_UDP6_PROTOCOL.Receive().If NULL, all pending tokens are aborted.
507 @retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event was signaled.
508 When Token is NULL, all pending requests are aborted and their events
510 @retval EFI_INVALID_PARAMETER This is NULL.
511 @retval EFI_NOT_STARTED This instance has not been started.
512 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was not found in
513 the transmit or receive queue. It has either completed or was not issued
514 by Transmit() and Receive().
519 (EFIAPI
*EFI_UDP6_CANCEL
)(
520 IN EFI_UDP6_PROTOCOL
*This
,
521 IN EFI_UDP6_COMPLETION_TOKEN
*Token OPTIONAL
525 Polls for incoming data packets and processes outgoing data packets.
527 The Poll() function can be used by network drivers and applications to increase the rate that data
528 packets are moved between the communications device and the transmit and receive queues.
529 In some systems, the periodic timer event in the managed network driver may not poll the underlying
530 communications device fast enough to transmit and/or receive all data packets without missing incoming
531 packets or dropping outgoing packets. Drivers and applications that are experiencing packet loss should
532 try calling the Poll() function more often.
534 @param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
536 @retval EFI_SUCCESS Incoming or outgoing data was processed.
537 @retval EFI_INVALID_PARAMETER This is NULL.
538 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
539 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
540 Consider increasing the polling rate.
545 (EFIAPI
*EFI_UDP6_POLL
)(
546 IN EFI_UDP6_PROTOCOL
*This
550 /// The EFI_UDP6_PROTOCOL defines an EFI UDPv6 Protocol session that can be used by any network drivers,
551 /// applications, or daemons to transmit or receive UDP packets. This protocol instance can either be
552 /// bound to a specified port as a service or connected to some remote peer as an active client.
553 /// Each instance has its own settings, such as group table, that are independent from each other.
555 struct _EFI_UDP6_PROTOCOL
{
556 EFI_UDP6_GET_MODE_DATA GetModeData
;
557 EFI_UDP6_CONFIGURE Configure
;
558 EFI_UDP6_GROUPS Groups
;
559 EFI_UDP6_TRANSMIT Transmit
;
560 EFI_UDP6_RECEIVE Receive
;
561 EFI_UDP6_CANCEL Cancel
;
565 extern EFI_GUID gEfiUdp6ServiceBindingProtocolGuid
;
566 extern EFI_GUID gEfiUdp6ProtocolGuid
;