Sync EDKII BaseTools to BaseTools project r1928
[mirror_edk2.git] / MdePkg / Include / Protocol / Udp4.h
CommitLineData
d1f95000 1/** @file\r
4ca9b6c4 2 UDP4 Service Binding Protocol as defined in UEFI specification.\r
842f5579 3\r
4ca9b6c4
LG
4 The EFI UDPv4 Protocol provides simple packet-oriented services \r
5 to transmit and receive UDP packets. \r
6\r
5899caf0 7 Copyright (c) 2006 - 2009, Intel Corporation \r
d1f95000 8 All rights reserved. This program and the accompanying materials \r
9 are licensed and made available under the terms and conditions of the BSD License \r
10 which accompanies this distribution. The full text of the license may be found at \r
11 http://opensource.org/licenses/bsd-license.php \r
12\r
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
5899caf0 14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
15\r
16 @par Revision Reference: \r
17 This Protocol is introduced in UEFI Specification 2.0 \r
d1f95000 18\r
d1f95000 19**/\r
20\r
21#ifndef __EFI_UDP4_PROTOCOL_H__\r
22#define __EFI_UDP4_PROTOCOL_H__\r
23\r
24#include <Protocol/Ip4.h>\r
25//\r
26//GUID definitions\r
27//\r
28#define EFI_UDP4_SERVICE_BINDING_PROTOCOL_GUID \\r
29 { \\r
30 0x83f01464, 0x99bd, 0x45e5, {0xb3, 0x83, 0xaf, 0x63, 0x05, 0xd8, 0xe9, 0xe6 } \\r
31 }\r
32\r
33#define EFI_UDP4_PROTOCOL_GUID \\r
34 { \\r
35 0x3ad9df29, 0x4501, 0x478d, {0xb1, 0xf8, 0x7f, 0x7f, 0xe7, 0x0e, 0x50, 0xf3 } \\r
36 }\r
37\r
38typedef struct _EFI_UDP4_PROTOCOL EFI_UDP4_PROTOCOL; \r
39 \r
40typedef struct {\r
41 EFI_HANDLE InstanceHandle;\r
42 EFI_IPv4_ADDRESS LocalAddress;\r
43 UINT16 LocalPort;\r
44 EFI_IPv4_ADDRESS RemoteAddress;\r
45 UINT16 RemotePort;\r
46} EFI_UDP4_SERVICE_POINT; \r
47\r
48typedef struct {\r
49 EFI_HANDLE DriverHandle;\r
50 UINT32 ServiceCount;\r
51 EFI_UDP4_SERVICE_POINT Services[1];\r
52} EFI_UDP4_VARIABLE_DATA;\r
53\r
d1f95000 54typedef struct {\r
55 UINT32 FragmentLength;\r
56 VOID *FragmentBuffer;\r
57} EFI_UDP4_FRAGMENT_DATA;\r
58\r
59typedef struct {\r
60 EFI_IPv4_ADDRESS SourceAddress;\r
61 UINT16 SourcePort;\r
62 EFI_IPv4_ADDRESS DestinationAddress;\r
63 UINT16 DestinationPort;\r
64} EFI_UDP4_SESSION_DATA;\r
65typedef struct {\r
66 //\r
67 // Receiving Filters\r
68 //\r
69 BOOLEAN AcceptBroadcast;\r
70 BOOLEAN AcceptPromiscuous;\r
71 BOOLEAN AcceptAnyPort;\r
72 BOOLEAN AllowDuplicatePort;\r
73 //\r
74 // I/O parameters\r
75 //\r
76 UINT8 TypeOfService;\r
77 UINT8 TimeToLive;\r
78 BOOLEAN DoNotFragment;\r
79 UINT32 ReceiveTimeout;\r
80 UINT32 TransmitTimeout;\r
81 //\r
82 // Access Point\r
83 //\r
84 BOOLEAN UseDefaultAddress;\r
85 EFI_IPv4_ADDRESS StationAddress;\r
86 EFI_IPv4_ADDRESS SubnetMask;\r
87 UINT16 StationPort;\r
88 EFI_IPv4_ADDRESS RemoteAddress;\r
89 UINT16 RemotePort;\r
90} EFI_UDP4_CONFIG_DATA;\r
91\r
92typedef struct {\r
93 EFI_UDP4_SESSION_DATA *UdpSessionData; //OPTIONAL\r
94 EFI_IPv4_ADDRESS *GatewayAddress; //OPTIONAL\r
95 UINT32 DataLength;\r
96 UINT32 FragmentCount; \r
97 EFI_UDP4_FRAGMENT_DATA FragmentTable[1];\r
98} EFI_UDP4_TRANSMIT_DATA;\r
99\r
100typedef struct {\r
101 EFI_TIME TimeStamp;\r
102 EFI_EVENT RecycleSignal;\r
103 EFI_UDP4_SESSION_DATA UdpSession;\r
104 UINT32 DataLength;\r
105 UINT32 FragmentCount;\r
106 EFI_UDP4_FRAGMENT_DATA FragmentTable[1];\r
107} EFI_UDP4_RECEIVE_DATA;\r
108\r
109\r
110typedef struct {\r
111 EFI_EVENT Event;\r
112 EFI_STATUS Status;\r
113 union {\r
114 EFI_UDP4_RECEIVE_DATA *RxData;\r
115 EFI_UDP4_TRANSMIT_DATA *TxData;\r
116 } Packet;\r
117} EFI_UDP4_COMPLETION_TOKEN;\r
118\r
119/**\r
120 Reads the current operational settings.\r
121\r
30c99a72 122 The GetModeData() function copies the current operational settings of this EFI\r
123 UDPv4 Protocol instance into user-supplied buffers. This function is used\r
124 optionally to retrieve the operational mode data of underlying networks or\r
125 drivers.\r
126\r
d1f95000 127 @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
128 @param Udp4ConfigData Pointer to the buffer to receive the current configuration data.\r
129 @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
130 @param MnpConfigData Pointer to the managed network configuration data structure.\r
131 @param SnpModeData Pointer to the simple network mode data structure.\r
132\r
133 @retval EFI_SUCCESS The mode data was read.\r
134 @retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is\r
135 available because this instance has not been started.\r
136 @retval EFI_INVALID_PARAMETER This is NULL.\r
137\r
138**/\r
139typedef\r
140EFI_STATUS\r
8b13229b 141(EFIAPI *EFI_UDP4_GET_MODE_DATA)(\r
d1f95000 142 IN EFI_UDP4_PROTOCOL *This,\r
143 OUT EFI_UDP4_CONFIG_DATA *Udp4ConfigData OPTIONAL,\r
144 OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r
145 OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r
146 OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r
ed66e1bc 147 ); \r
d1f95000 148 \r
149\r
150/**\r
151 Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4\r
152 Protocol.\r
30c99a72 153 \r
154 The Configure() function is used to do the following:\r
155 * Initialize and start this instance of the EFI UDPv4 Protocol.\r
156 * Change the filtering rules and operational parameters.\r
157 * Reset this instance of the EFI UDPv4 Protocol.\r
158 Until these parameters are initialized, no network traffic can be sent or\r
159 received by this instance. This instance can be also reset by calling Configure()\r
160 with UdpConfigData set to NULL. Once reset, the receiving queue and transmitting\r
161 queue are flushed and no traffic is allowed through this instance.\r
162 With different parameters in UdpConfigData, Configure() can be used to bind\r
163 this instance to specified port.\r
d1f95000 164\r
165 @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
166 @param Udp4ConfigData Pointer to the buffer to receive the current configuration data.\r
167\r
168 @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.\r
169 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
170 RARP, etc.) is not finished yet.\r
171 @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
172 @retval EFI_ALREADY_STARTED The EFI UDPv4 Protocol instance is already started/configured\r
173 and must be stopped/reset before it can be reconfigured.\r
174 @retval EFI_ACCESS_DENIED UdpConfigData. AllowDuplicatePort is FALSE\r
175 and UdpConfigData.StationPort is already used by\r
176 other instance.\r
177 @retval EFI_OUT_OF_RESOURCES The EFI UDPv4 Protocol driver cannot allocate memory for this\r
178 EFI UDPv4 Protocol instance.\r
179 @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance\r
180 was not opened. \r
181\r
182**/\r
183typedef\r
184EFI_STATUS\r
8b13229b 185(EFIAPI *EFI_UDP4_CONFIGURE)(\r
d1f95000 186 IN EFI_UDP4_PROTOCOL *This,\r
187 IN EFI_UDP4_CONFIG_DATA *UdpConfigData OPTIONAL\r
ed66e1bc 188 ); \r
d1f95000 189\r
190/**\r
191 Joins and leaves multicast groups.\r
30c99a72 192 \r
193 The Groups() function is used to enable and disable the multicast group\r
194 filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all\r
195 currently joined groups are left.\r
d1f95000 196\r
197 @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
198 @param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one\r
199 or all multicast groups.\r
200 @param MulticastAddress Pointer to multicast group address to join or leave.\r
201\r
202 @retval EFI_SUCCESS The operation completed successfully.\r
203 @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.\r
204 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
205 RARP, etc.) is not finished yet.\r
206 @retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group.\r
207 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
208 - This is NULL.\r
209 - JoinFlag is TRUE and MulticastAddress is NULL.\r
210 - JoinFlag is TRUE and *MulticastAddress is not\r
211 a valid multicast address.\r
212 @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r
213 JoinFlag is TRUE).\r
214 @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is\r
215 FALSE).\r
216 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
217\r
218**/\r
219typedef\r
220EFI_STATUS\r
8b13229b 221(EFIAPI *EFI_UDP4_GROUPS)(\r
d1f95000 222 IN EFI_UDP4_PROTOCOL *This,\r
223 IN BOOLEAN JoinFlag,\r
224 IN EFI_IPv4_ADDRESS *MulticastAddress OPTIONAL\r
ed66e1bc 225 ); \r
d1f95000 226\r
227/**\r
228 Adds and deletes routing table entries.\r
30c99a72 229 \r
230 The Routes() function adds a route to or deletes a route from the routing table.\r
231 Routes are determined by comparing the SubnetAddress with the destination IP\r
232 address and arithmetically AND-ing it with the SubnetMask. The gateway address\r
233 must be on the same subnet as the configured station address.\r
234 The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r
235 The default route matches all destination IP addresses that do not match any\r
236 other routes.\r
237 A zero GatewayAddress is a nonroute. Packets are sent to the destination IP\r
238 address if it can be found in the Address Resolution Protocol (ARP) cache or\r
239 on the local subnet. One automatic nonroute entry will be inserted into the\r
240 routing table for outgoing packets that are addressed to a local subnet\r
241 (gateway address of 0.0.0.0).\r
242 Each instance of the EFI UDPv4 Protocol has its own independent routing table.\r
243 Instances of the EFI UDPv4 Protocol that use the default IP address will also\r
244 have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These\r
245 copies will be updated automatically whenever the IP driver reconfigures its\r
246 instances; as a result, the previous modification to these copies will be lost.\r
d1f95000 247\r
248 @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
249 @param DeleteRoute Set to TRUE to delete this route from the routing table.\r
250 Set to FALSE to add this route to the routing table.\r
251 @param SubnetAddress The destination network address that needs to be routed.\r
252 @param SubnetMask The subnet mask of SubnetAddress.\r
253 @param GatewayAddress The gateway IP address for this route.\r
254\r
255 @retval EFI_SUCCESS The operation completed successfully.\r
256 @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.\r
257 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
258 - RARP, etc.) is not finished yet.\r
259 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
260 @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r
261 @retval EFI_NOT_FOUND This route is not in the routing table.\r
262 @retval EFI_ACCESS_DENIED The route is already defined in the routing table.\r
263\r
264**/\r
265typedef\r
266EFI_STATUS\r
8b13229b 267(EFIAPI *EFI_UDP4_ROUTES)(\r
d1f95000 268 IN EFI_UDP4_PROTOCOL *This,\r
269 IN BOOLEAN DeleteRoute,\r
270 IN EFI_IPv4_ADDRESS *SubnetAddress,\r
271 IN EFI_IPv4_ADDRESS *SubnetMask,\r
272 IN EFI_IPv4_ADDRESS *GatewayAddress\r
ed66e1bc 273 ); \r
d1f95000 274\r
275/**\r
276 Polls for incoming data packets and processes outgoing data packets.\r
30c99a72 277 \r
278 The Poll() function can be used by network drivers and applications to increase\r
279 the rate that data packets are moved between the communications device and the\r
280 transmit and receive queues.\r
281 In some systems, the periodic timer event in the managed network driver may not\r
282 poll the underlying communications device fast enough to transmit and/or receive\r
283 all data packets without missing incoming packets or dropping outgoing packets.\r
284 Drivers and applications that are experiencing packet loss should try calling\r
285 the Poll() function more often.\r
d1f95000 286\r
287 @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
288\r
289 @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
290 @retval EFI_INVALID_PARAMETER This is NULL.\r
291 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
292 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
293\r
294**/\r
295typedef\r
296EFI_STATUS\r
8b13229b 297(EFIAPI *EFI_UDP4_POLL)(\r
d1f95000 298 IN EFI_UDP4_PROTOCOL *This\r
ed66e1bc 299 ); \r
d1f95000 300\r
301/**\r
302 Places an asynchronous receive request into the receiving queue.\r
30c99a72 303 \r
304 The Receive() function places a completion token into the receive packet queue.\r
305 This function is always asynchronous.\r
306 The caller must fill in the Token.Event field in the completion token, and this\r
307 field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol\r
308 driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
309 is signaled. Providing a proper notification function and context for the event\r
310 will enable the user to receive the notification and receiving status. That\r
311 notification function is guaranteed to not be re-entered.\r
d1f95000 312\r
313 @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
314 @param Token Pointer to a token that is associated with the receive data\r
315 descriptor.\r
316\r
317 @retval EFI_SUCCESS The receive completion token was cached.\r
318 @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.\r
319 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.)\r
320 is not finished yet.\r
321 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
322 @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r
323 resources (usually memory).\r
324 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
325 @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in\r
326 the receive queue.\r
327 @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
328\r
329**/\r
330typedef\r
331EFI_STATUS\r
8b13229b 332(EFIAPI *EFI_UDP4_RECEIVE)(\r
d1f95000 333 IN EFI_UDP4_PROTOCOL *This,\r
334 IN EFI_UDP4_COMPLETION_TOKEN *Token\r
ed66e1bc 335 ); \r
d1f95000 336\r
337/**\r
338 Queues outgoing data packets into the transmit queue.\r
30c99a72 339 \r
340 The Transmit() function places a sending request to this instance of the EFI\r
341 UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever\r
342 the packet in the token is sent out or some errors occur, the Token.Event will\r
343 be signaled and Token.Status is updated. Providing a proper notification function\r
344 and context for the event will enable the user to receive the notification and\r
345 transmitting status.\r
d1f95000 346\r
347 @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
348 @param Token Pointer to the completion token that will be placed into the\r
349 transmit queue.\r
350\r
351 @retval EFI_SUCCESS The data has been queued for transmission.\r
352 @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.\r
353 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
354 RARP, etc.) is not finished yet.\r
355 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
356 @retval EFI_ACCESS_DENIED The transmit completion token with the same\r
357 Token.Event was already in the transmit queue.\r
358 @retval EFI_NOT_READY The completion token could not be queued because the\r
359 transmit queue is full.\r
360 @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r
361 @retval EFI_NOT_FOUND There is no route to the destination network or address.\r
362 @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP packet\r
363 size. Or the length of the IP header + UDP header + data\r
364 length is greater than MTU if DoNotFragment is TRUE.\r
365\r
366**/\r
367typedef\r
368EFI_STATUS\r
8b13229b 369(EFIAPI *EFI_UDP4_TRANSMIT)(\r
d1f95000 370 IN EFI_UDP4_PROTOCOL *This,\r
371 IN EFI_UDP4_COMPLETION_TOKEN *Token\r
ed66e1bc 372 ); \r
d1f95000 373\r
374/**\r
375 Aborts an asynchronous transmit or receive request.\r
30c99a72 376 \r
377 The Cancel() function is used to abort a pending transmit or receive request.\r
378 If the token is in the transmit or receive request queues, after calling this\r
379 function, Token.Status will be set to EFI_ABORTED and then Token.Event will be\r
380 signaled. If the token is not in one of the queues, which usually means that\r
381 the asynchronous operation has completed, this function will not signal the\r
382 token and EFI_NOT_FOUND is returned.\r
d1f95000 383\r
384 @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
385 @param Token Pointer to a token that has been issued by\r
386 EFI_UDP4_PROTOCOL.Transmit() or\r
387 EFI_UDP4_PROTOCOL.Receive().If NULL, all pending\r
388 tokens are aborted.\r
389\r
390 @retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event\r
391 was signaled. When Token is NULL, all pending requests are\r
392 aborted and their events are signaled.\r
393 @retval EFI_INVALID_PARAMETER This is NULL.\r
394 @retval EFI_NOT_STARTED This instance has not been started.\r
395 @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
396 RARP, etc.) is not finished yet.\r
397 @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r
398 not found in the transmit or receive queue. It has either completed\r
399 or was not issued by Transmit() and Receive().\r
400\r
401**/\r
402typedef\r
403EFI_STATUS\r
404(EFIAPI *EFI_UDP4_CANCEL)(\r
405 IN EFI_UDP4_PROTOCOL *This,\r
406 IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL\r
ed66e1bc 407 ); \r
d1f95000 408\r
44717a39 409///\r
410/// The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used \r
411/// by any network drivers, applications, or daemons to transmit or receive UDP packets. \r
412/// This protocol instance can either be bound to a specified port as a service or \r
413/// connected to some remote peer as an active client. Each instance has its own settings, \r
414/// such as the routing table and group table, which are independent from each other.\r
415///\r
d1f95000 416struct _EFI_UDP4_PROTOCOL {\r
417 EFI_UDP4_GET_MODE_DATA GetModeData;\r
418 EFI_UDP4_CONFIGURE Configure;\r
419 EFI_UDP4_GROUPS Groups;\r
420 EFI_UDP4_ROUTES Routes;\r
421 EFI_UDP4_TRANSMIT Transmit;\r
422 EFI_UDP4_RECEIVE Receive;\r
423 EFI_UDP4_CANCEL Cancel;\r
424 EFI_UDP4_POLL Poll;\r
425};\r
426\r
427extern EFI_GUID gEfiUdp4ServiceBindingProtocolGuid;\r
428extern EFI_GUID gEfiUdp4ProtocolGuid;\r
429\r
430#endif\r