2 UDP4 Service Binding Protocol as defined in UEFI specification.
4 The EFI UDPv4 Protocol provides simple packet-oriented services
5 to transmit and receive UDP packets.
7 Copyright (c) 2006 - 2008, Intel Corporation
8 All rights reserved. This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #ifndef __EFI_UDP4_PROTOCOL_H__
19 #define __EFI_UDP4_PROTOCOL_H__
21 #include <Protocol/Ip4.h>
25 #define EFI_UDP4_SERVICE_BINDING_PROTOCOL_GUID \
27 0x83f01464, 0x99bd, 0x45e5, {0xb3, 0x83, 0xaf, 0x63, 0x05, 0xd8, 0xe9, 0xe6 } \
30 #define EFI_UDP4_PROTOCOL_GUID \
32 0x3ad9df29, 0x4501, 0x478d, {0xb1, 0xf8, 0x7f, 0x7f, 0xe7, 0x0e, 0x50, 0xf3 } \
35 typedef struct _EFI_UDP4_PROTOCOL EFI_UDP4_PROTOCOL
;
38 EFI_HANDLE InstanceHandle
;
39 EFI_IPv4_ADDRESS LocalAddress
;
41 EFI_IPv4_ADDRESS RemoteAddress
;
43 } EFI_UDP4_SERVICE_POINT
;
46 EFI_HANDLE DriverHandle
;
48 EFI_UDP4_SERVICE_POINT Services
[1];
49 } EFI_UDP4_VARIABLE_DATA
;
52 //ICMP error definitions
54 #define EFI_NETWORK_UNREACHABLE EFIERR(100)
55 #define EFI_HOST_UNREACHABLE EFIERR(101)
56 #define EFI_PROTOCOL_UNREACHABLE EFIERR(102)
57 #define EFI_PORT_UNREACHABLE EFIERR(103)
61 UINT32 FragmentLength
;
63 } EFI_UDP4_FRAGMENT_DATA
;
66 EFI_IPv4_ADDRESS SourceAddress
;
68 EFI_IPv4_ADDRESS DestinationAddress
;
69 UINT16 DestinationPort
;
70 } EFI_UDP4_SESSION_DATA
;
75 BOOLEAN AcceptBroadcast
;
76 BOOLEAN AcceptPromiscuous
;
77 BOOLEAN AcceptAnyPort
;
78 BOOLEAN AllowDuplicatePort
;
84 BOOLEAN DoNotFragment
;
85 UINT32 ReceiveTimeout
;
86 UINT32 TransmitTimeout
;
90 BOOLEAN UseDefaultAddress
;
91 EFI_IPv4_ADDRESS StationAddress
;
92 EFI_IPv4_ADDRESS SubnetMask
;
94 EFI_IPv4_ADDRESS RemoteAddress
;
96 } EFI_UDP4_CONFIG_DATA
;
99 EFI_UDP4_SESSION_DATA
*UdpSessionData
; //OPTIONAL
100 EFI_IPv4_ADDRESS
*GatewayAddress
; //OPTIONAL
102 UINT32 FragmentCount
;
103 EFI_UDP4_FRAGMENT_DATA FragmentTable
[1];
104 } EFI_UDP4_TRANSMIT_DATA
;
108 EFI_EVENT RecycleSignal
;
109 EFI_UDP4_SESSION_DATA UdpSession
;
111 UINT32 FragmentCount
;
112 EFI_UDP4_FRAGMENT_DATA FragmentTable
[1];
113 } EFI_UDP4_RECEIVE_DATA
;
120 EFI_UDP4_RECEIVE_DATA
*RxData
;
121 EFI_UDP4_TRANSMIT_DATA
*TxData
;
123 } EFI_UDP4_COMPLETION_TOKEN
;
126 Reads the current operational settings.
128 @param This Pointer to the EFI_UDP4_PROTOCOL instance.
129 @param Udp4ConfigData Pointer to the buffer to receive the current configuration data.
130 @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.
131 @param MnpConfigData Pointer to the managed network configuration data structure.
132 @param SnpModeData Pointer to the simple network mode data structure.
134 @retval EFI_SUCCESS The mode data was read.
135 @retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is
136 available because this instance has not been started.
137 @retval EFI_INVALID_PARAMETER This is NULL.
142 (EFIAPI
*EFI_UDP4_GET_MODE_DATA
)(
143 IN EFI_UDP4_PROTOCOL
*This
,
144 OUT EFI_UDP4_CONFIG_DATA
*Udp4ConfigData OPTIONAL
,
145 OUT EFI_IP4_MODE_DATA
*Ip4ModeData OPTIONAL
,
146 OUT EFI_MANAGED_NETWORK_CONFIG_DATA
*MnpConfigData OPTIONAL
,
147 OUT EFI_SIMPLE_NETWORK_MODE
*SnpModeData OPTIONAL
153 Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4
156 @param This Pointer to the EFI_UDP4_PROTOCOL instance.
157 @param Udp4ConfigData Pointer to the buffer to receive the current configuration data.
159 @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.
160 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
161 RARP, etc.) is not finished yet.
162 @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:
163 @retval EFI_ALREADY_STARTED The EFI UDPv4 Protocol instance is already started/configured
164 and must be stopped/reset before it can be reconfigured.
165 @retval EFI_ACCESS_DENIED UdpConfigData. AllowDuplicatePort is FALSE
166 and UdpConfigData.StationPort is already used by
168 @retval EFI_OUT_OF_RESOURCES The EFI UDPv4 Protocol driver cannot allocate memory for this
169 EFI UDPv4 Protocol instance.
170 @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance
176 (EFIAPI
*EFI_UDP4_CONFIGURE
)(
177 IN EFI_UDP4_PROTOCOL
*This
,
178 IN EFI_UDP4_CONFIG_DATA
*UdpConfigData OPTIONAL
183 Joins and leaves multicast groups.
185 @param This Pointer to the EFI_UDP4_PROTOCOL instance.
186 @param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one
187 or all multicast groups.
188 @param MulticastAddress Pointer to multicast group address to join or leave.
190 @retval EFI_SUCCESS The operation completed successfully.
191 @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.
192 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
193 RARP, etc.) is not finished yet.
194 @retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group.
195 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
197 - JoinFlag is TRUE and MulticastAddress is NULL.
198 - JoinFlag is TRUE and *MulticastAddress is not
199 a valid multicast address.
200 @retval EFI_ALREADY_STARTED The group address is already in the group table (when
202 @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is
204 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
209 (EFIAPI
*EFI_UDP4_GROUPS
)(
210 IN EFI_UDP4_PROTOCOL
*This
,
212 IN EFI_IPv4_ADDRESS
*MulticastAddress OPTIONAL
217 Adds and deletes routing table entries.
219 @param This Pointer to the EFI_UDP4_PROTOCOL instance.
220 @param DeleteRoute Set to TRUE to delete this route from the routing table.
221 Set to FALSE to add this route to the routing table.
222 @param SubnetAddress The destination network address that needs to be routed.
223 @param SubnetMask The subnet mask of SubnetAddress.
224 @param GatewayAddress The gateway IP address for this route.
226 @retval EFI_SUCCESS The operation completed successfully.
227 @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.
228 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
229 - RARP, etc.) is not finished yet.
230 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
231 @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.
232 @retval EFI_NOT_FOUND This route is not in the routing table.
233 @retval EFI_ACCESS_DENIED The route is already defined in the routing table.
238 (EFIAPI
*EFI_UDP4_ROUTES
)(
239 IN EFI_UDP4_PROTOCOL
*This
,
240 IN BOOLEAN DeleteRoute
,
241 IN EFI_IPv4_ADDRESS
*SubnetAddress
,
242 IN EFI_IPv4_ADDRESS
*SubnetMask
,
243 IN EFI_IPv4_ADDRESS
*GatewayAddress
248 Polls for incoming data packets and processes outgoing data packets.
250 @param This Pointer to the EFI_UDP4_PROTOCOL instance.
252 @retval EFI_SUCCESS Incoming or outgoing data was processed.
253 @retval EFI_INVALID_PARAMETER This is NULL.
254 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
255 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
260 (EFIAPI
*EFI_UDP4_POLL
)(
261 IN EFI_UDP4_PROTOCOL
*This
266 Places an asynchronous receive request into the receiving queue.
268 @param This Pointer to the EFI_UDP4_PROTOCOL instance.
269 @param Token Pointer to a token that is associated with the receive data
272 @retval EFI_SUCCESS The receive completion token was cached.
273 @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.
274 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.)
276 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
277 @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system
278 resources (usually memory).
279 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
280 @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in
282 @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
287 (EFIAPI
*EFI_UDP4_RECEIVE
)(
288 IN EFI_UDP4_PROTOCOL
*This
,
289 IN EFI_UDP4_COMPLETION_TOKEN
*Token
294 Queues outgoing data packets into the transmit queue.
296 @param This Pointer to the EFI_UDP4_PROTOCOL instance.
297 @param Token Pointer to the completion token that will be placed into the
300 @retval EFI_SUCCESS The data has been queued for transmission.
301 @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.
302 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
303 RARP, etc.) is not finished yet.
304 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
305 @retval EFI_ACCESS_DENIED The transmit completion token with the same
306 Token.Event was already in the transmit queue.
307 @retval EFI_NOT_READY The completion token could not be queued because the
308 transmit queue is full.
309 @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.
310 @retval EFI_NOT_FOUND There is no route to the destination network or address.
311 @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP packet
312 size. Or the length of the IP header + UDP header + data
313 length is greater than MTU if DoNotFragment is TRUE.
318 (EFIAPI
*EFI_UDP4_TRANSMIT
)(
319 IN EFI_UDP4_PROTOCOL
*This
,
320 IN EFI_UDP4_COMPLETION_TOKEN
*Token
325 Aborts an asynchronous transmit or receive request.
327 @param This Pointer to the EFI_UDP4_PROTOCOL instance.
328 @param Token Pointer to a token that has been issued by
329 EFI_UDP4_PROTOCOL.Transmit() or
330 EFI_UDP4_PROTOCOL.Receive().If NULL, all pending
333 @retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event
334 was signaled. When Token is NULL, all pending requests are
335 aborted and their events are signaled.
336 @retval EFI_INVALID_PARAMETER This is NULL.
337 @retval EFI_NOT_STARTED This instance has not been started.
338 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
339 RARP, etc.) is not finished yet.
340 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was
341 not found in the transmit or receive queue. It has either completed
342 or was not issued by Transmit() and Receive().
347 (EFIAPI
*EFI_UDP4_CANCEL
)(
348 IN EFI_UDP4_PROTOCOL
*This
,
349 IN EFI_UDP4_COMPLETION_TOKEN
*Token OPTIONAL
354 @par Protocol Description:
355 The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used
356 by any network drivers, applications, or daemons to transmit or receive UDP packets.
357 This protocol instance can either be bound to a specified port as a service or
358 connected to some remote peer as an active client. Each instance has its own settings,
359 such as the routing table and group table, which are independent from each other.
362 Reads the current operational settings.
365 Initializes, changes, or resets operational settings for the EFI UDPv4 Protocol.
368 Joins and leaves multicast groups.
371 Add and deletes routing table entries.
374 Queues outgoing data packets into the transmit queue. This function is a nonblocked operation.
377 Places a receiving request token into the receiving queue. This function is a nonblocked operation.
380 Aborts a pending transmit or receive request.
383 Polls for incoming data packets and processes outgoing data packets.
385 struct _EFI_UDP4_PROTOCOL
{
386 EFI_UDP4_GET_MODE_DATA GetModeData
;
387 EFI_UDP4_CONFIGURE Configure
;
388 EFI_UDP4_GROUPS Groups
;
389 EFI_UDP4_ROUTES Routes
;
390 EFI_UDP4_TRANSMIT Transmit
;
391 EFI_UDP4_RECEIVE Receive
;
392 EFI_UDP4_CANCEL Cancel
;
396 extern EFI_GUID gEfiUdp4ServiceBindingProtocolGuid
;
397 extern EFI_GUID gEfiUdp4ProtocolGuid
;