]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Include/Library/IpIoLib.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
MdeModulePkg: Add match2 opcode support in SetupBrowserDxe and sample code in DriverS...
[mirror_edk2.git] / MdeModulePkg / Include / Library / IpIoLib.h
CommitLineData
97b38d4e 1/** @file\r
fb115c61 2 This library is only intended to be used by UEFI network stack modules.\r
3 It provides the combined IpIo layer on the EFI IP4 Protocol and EFI IP6 protocol.\r
97b38d4e 4\r
cd5ebaa0 5Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r
64a80549 6This program and the accompanying materials are licensed and made available under \r
7the terms and conditions of the BSD License that accompanies this distribution. \r
8The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php. \r
97b38d4e 10\r
64a80549 11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
97b38d4e 12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef _IP_IO_H_\r
17#define _IP_IO_H_\r
18\r
19#include <Protocol/Ip4.h>\r
fb115c61 20#include <Protocol/Ip6.h>\r
cdfdbb97 21\r
97b38d4e 22#include <Library/NetLib.h>\r
23\r
24//\r
e9b67286 25// type and code define for ICMP protocol error \r
97b38d4e 26// from IP\r
27//\r
28#define ICMP_TYPE_UNREACH 3\r
cdfdbb97 29#define ICMP_TYPE_TIMXCEED 11\r
97b38d4e 30#define ICMP_TYPE_PARAMPROB 12\r
31#define ICMP_TYPE_SOURCEQUENCH 4\r
32\r
33#define ICMP_CODE_UNREACH_NET 0\r
34#define ICMP_CODE_UNREACH_HOST 1\r
35#define ICMP_CODE_UNREACH_PROTOCOL 2\r
36#define ICMP_CODE_UNREACH_PORT 3\r
37#define ICMP_CODE_UNREACH_NEEDFRAG 4\r
38#define ICMP_CODE_UNREACH_SRCFAIL 5\r
39#define ICMP_CODE_UNREACH_NET_UNKNOWN 6\r
40#define ICMP_CODE_UNREACH_HOST_UNKNOWN 7\r
41#define ICMP_CODE_UNREACH_ISOLATED 8\r
42#define ICMP_CODE_UNREACH_NET_PROHIB 9\r
43#define ICMP_CODE_UNREACH_HOST_PROHIB 10\r
44#define ICMP_CODE_UNREACH_TOSNET 11\r
45#define ICMP_CODE_UNREACH_TOSHOST 12\r
46\r
cdfdbb97 47/**\r
e9b67286 48 Get the IP header length from the struct EFI_IP4_HEADER. HeaderLength is\r
cdfdbb97 49 Internet header length in 32-bit words, so HeaderLength<<2 is the real\r
50 length of IP header.\r
51 \r
64a80549 52 @param[out] HdrPtr A pointer to EFI_IP4_HEADER.\r
cdfdbb97 53 \r
64a80549 54 @return The IP header length.\r
cdfdbb97 55**/\r
56#define EFI_IP4_HEADER_LEN(HdrPtr) ((HdrPtr)->HeaderLength << 2)\r
57\r
58/**\r
59 To types of ICMP error which consist of ICMP header, IP header and original \r
60 datagram's data, get length from sum of ICMP header length, IP header length \r
61 and first 64 bits of datagram's data length.\r
62 \r
64a80549 63 @param[in] IpHdr A pointer to EFI_IP4_HEADER.\r
cdfdbb97 64 \r
64a80549 65 @return The ICMP error length.\r
cdfdbb97 66**/\r
67#define ICMP_ERRLEN(IpHdr) \\r
68 (sizeof(IP4_ICMP_HEAD) + EFI_IP4_HEADER_LEN(IpHdr) + 8)\r
69\r
70/**\r
71 Get the packet header from NET_BUF.\r
72 \r
64a80549 73 @param[out] Buf A pointer to NET_BUF.\r
74 @param[in] Type Header type.\r
cdfdbb97 75 \r
64a80549 76 @return The pointer to packet header.\r
cdfdbb97 77**/\r
78#define NET_PROTO_HDR(Buf, Type) ((Type *) ((Buf)->BlockOp[0].Head))\r
79\r
80 \r
fb115c61 81extern EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData;\r
82extern EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData;\r
83\r
cdfdbb97 84\r
e29a2e7e 85///\r
86/// This error will be delivered to the\r
87/// listening transportation layer protocol\r
88/// that consumes IpIO.\r
89///\r
b45b45b2 90\r
91#define ICMP_ERR_UNREACH_NET 0\r
92#define ICMP_ERR_UNREACH_HOST 1\r
93#define ICMP_ERR_UNREACH_PROTOCOL 2\r
94#define ICMP_ERR_UNREACH_PORT 3\r
95#define ICMP_ERR_MSGSIZE 4\r
96#define ICMP_ERR_UNREACH_SRCFAIL 5\r
97#define ICMP_ERR_TIMXCEED_INTRANS 6\r
98#define ICMP_ERR_TIMXCEED_REASS 7\r
99#define ICMP_ERR_QUENCH 8\r
100#define ICMP_ERR_PARAMPROB 9\r
101\r
102#define ICMP6_ERR_UNREACH_NET 0\r
103#define ICMP6_ERR_UNREACH_HOST 1\r
104#define ICMP6_ERR_UNREACH_PROTOCOL 2\r
105#define ICMP6_ERR_UNREACH_PORT 3\r
106#define ICMP6_ERR_PACKAGE_TOOBIG 4\r
107#define ICMP6_ERR_TIMXCEED_HOPLIMIT 5\r
108#define ICMP6_ERR_TIMXCEED_REASS 6\r
109#define ICMP6_ERR_PARAMPROB_HEADER 7\r
110#define ICMP6_ERR_PARAMPROB_NEXHEADER 8\r
111#define ICMP6_ERR_PARAMPROB_IPV6OPTION 9\r
fb115c61 112\r
e29a2e7e 113///\r
e9b67286 114/// The helper struct for IpIoGetIcmpErrStatus(). It is for internal use only.\r
e29a2e7e 115///\r
cdfdbb97 116typedef struct {\r
fb115c61 117 BOOLEAN IsHard;\r
118 BOOLEAN Notify;\r
97b38d4e 119} ICMP_ERROR_INFO;\r
120\r
fb115c61 121typedef union {\r
122 EFI_IP4_COMPLETION_TOKEN Ip4Token;\r
123 EFI_IP6_COMPLETION_TOKEN Ip6Token;\r
124} IP_IO_IP_COMPLETION_TOKEN;\r
125\r
126typedef union {\r
127 EFI_IP4_TRANSMIT_DATA Ip4TxData;\r
128 EFI_IP6_TRANSMIT_DATA Ip6TxData;\r
129} IP_IO_IP_TX_DATA;\r
130\r
131typedef union {\r
132 EFI_IP4_RECEIVE_DATA Ip4RxData;\r
133 EFI_IP6_RECEIVE_DATA Ip6RxData;\r
134} IP_IO_IP_RX_DATA;\r
135\r
136typedef union {\r
137 EFI_IP4_OVERRIDE_DATA Ip4OverrideData;\r
138 EFI_IP6_OVERRIDE_DATA Ip6OverrideData;\r
139} IP_IO_OVERRIDE;\r
140\r
141typedef union {\r
142 EFI_IP4_CONFIG_DATA Ip4CfgData;\r
143 EFI_IP6_CONFIG_DATA Ip6CfgData;\r
144} IP_IO_IP_CONFIG_DATA;\r
145\r
b45b45b2 146typedef union {\r
147 EFI_IP4_HEADER *Ip4Hdr;\r
148 EFI_IP6_HEADER *Ip6Hdr;\r
149} IP_IO_IP_HEADER;\r
150\r
151typedef union {\r
152 IP4_ADDR SubnetMask;\r
153 UINT8 PrefixLength;\r
154} IP_IO_IP_MASK;\r
155\r
2a2e33b2 156typedef union {\r
157 EFI_IP4_PROTOCOL *Ip4;\r
158 EFI_IP6_PROTOCOL *Ip6;\r
159} IP_IO_IP_PROTOCOL;\r
160\r
e29a2e7e 161///\r
162/// The IP session for an IP receive packet.\r
163///\r
97b38d4e 164typedef struct _EFI_NET_SESSION_DATA {\r
64a80549 165 EFI_IP_ADDRESS Source; ///< Source IP of the received packet.\r
166 EFI_IP_ADDRESS Dest; ///< Destination IP of the received packet.\r
167 IP_IO_IP_HEADER IpHdr; ///< IP header of the received packet.\r
a09ee46d 168 UINT32 IpHdrLen; ///< IP header length of the received packet. \r
169 ///< For IPv6, it includes the IP6 header \r
170 ///< length and extension header length. For\r
171 ///< IPv4, it includes the IP4 header length\r
172 ///< and options length.\r
64a80549 173 UINT8 IpVersion; ///< The IP version of the received packet.\r
97b38d4e 174} EFI_NET_SESSION_DATA;\r
175\r
e29a2e7e 176/**\r
177 The prototype is called back when an IP packet is received.\r
178 \r
64a80549 179 @param[in] Status The result of the receive request.\r
180 @param[in] IcmpErr Valid when Status is EFI_ICMP_ERROR.\r
181 @param[in] NetSession The IP session for the received packet.\r
182 @param[in] Pkt The packet received.\r
e9b67286 183 @param[in] Context The data provided by the user for the received packet when\r
cdfdbb97 184 the callback is registered in IP_IO_OPEN_DATA::RcvdContext.\r
e29a2e7e 185 \r
186**/\r
97b38d4e 187typedef\r
188VOID\r
e798cd87 189(EFIAPI *PKT_RCVD_NOTIFY) (\r
e29a2e7e 190 IN EFI_STATUS Status, \r
b45b45b2 191 IN UINT8 IcmpErr,\r
e29a2e7e 192 IN EFI_NET_SESSION_DATA *NetSession,\r
193 IN NET_BUF *Pkt,\r
194 IN VOID *Context\r
97b38d4e 195 );\r
196\r
e29a2e7e 197/**\r
198 The prototype is called back when an IP packet is sent.\r
199 \r
64a80549 200 @param[in] Status Result of the IP packet being sent.\r
cdfdbb97 201 @param[in] Context The data provided by user for the received packet when\r
202 the callback is registered in IP_IO_OPEN_DATA::SndContext.\r
2a2e33b2 203 @param[in] Sender A Union type to specify a pointer of EFI_IP4_PROTOCOL \r
204 or EFI_IP6_PROTOCOL.\r
64a80549 205 @param[in] NotifyData The Context data specified when calling IpIoSend()\r
e29a2e7e 206 \r
207**/\r
97b38d4e 208typedef\r
209VOID\r
e798cd87 210(EFIAPI *PKT_SENT_NOTIFY) (\r
2a2e33b2 211 IN EFI_STATUS Status,\r
212 IN VOID *Context,\r
213 IN IP_IO_IP_PROTOCOL Sender,\r
214 IN VOID *NotifyData\r
97b38d4e 215 );\r
216\r
e29a2e7e 217///\r
fb115c61 218/// This data structure wraps Ip4/Ip6 instances. The IpIo Library uses it for all\r
219/// Ip4/Ip6 operations.\r
e29a2e7e 220///\r
97b38d4e 221typedef struct _IP_IO {\r
e29a2e7e 222 ///\r
223 /// The node used to link this IpIo to the active IpIo list.\r
224 ///\r
97b38d4e 225 LIST_ENTRY Entry;\r
226\r
e29a2e7e 227 ///\r
228 /// The list used to maintain the IP instance for different sending purpose.\r
229 ///\r
97b38d4e 230 LIST_ENTRY IpList;\r
e29a2e7e 231 \r
97b38d4e 232 EFI_HANDLE Controller;\r
233 EFI_HANDLE Image;\r
234 EFI_HANDLE ChildHandle;\r
e29a2e7e 235 //\r
236 // The IP instance consumed by this IP_IO\r
237 //\r
2a2e33b2 238 IP_IO_IP_PROTOCOL Ip;\r
97b38d4e 239 BOOLEAN IsConfigured;\r
240\r
e29a2e7e 241 ///\r
64a80549 242 /// Some ip configuration data can be changed.\r
e29a2e7e 243 ///\r
97b38d4e 244 UINT8 Protocol;\r
245\r
e29a2e7e 246 ///\r
64a80549 247 /// Token and event used to get data from IP.\r
e29a2e7e 248 ///\r
fb115c61 249 IP_IO_IP_COMPLETION_TOKEN RcvToken; \r
97b38d4e 250\r
e29a2e7e 251 ///\r
64a80549 252 /// List entry used to link the token passed to IP_IO.\r
e29a2e7e 253 ///\r
97b38d4e 254 LIST_ENTRY PendingSndList;\r
255\r
256 //\r
257 // User interface used to get notify from IP_IO\r
258 //\r
64a80549 259 VOID *RcvdContext; ///< See IP_IO_OPEN_DATA::RcvdContext.\r
260 VOID *SndContext; ///< See IP_IO_OPEN_DATA::SndContext.\r
261 PKT_RCVD_NOTIFY PktRcvdNotify; ///< See IP_IO_OPEN_DATA::PktRcvdNotify.\r
262 PKT_SENT_NOTIFY PktSentNotify; ///< See IP_IO_OPEN_DATA::PktSentNotify.\r
b45b45b2 263 UINT8 IpVersion;\r
97b38d4e 264} IP_IO;\r
265\r
e29a2e7e 266///\r
e9b67286 267/// The struct is for the user to pass IP configuration and callbacks to IP_IO.\r
e29a2e7e 268/// It is used by IpIoOpen().\r
269///\r
97b38d4e 270typedef struct _IP_IO_OPEN_DATA {\r
64a80549 271 IP_IO_IP_CONFIG_DATA IpConfigData; ///< Configuration of the IP instance.\r
272 VOID *RcvdContext; ///< Context data used by receive callback.\r
273 VOID *SndContext; ///< Context data used by send callback.\r
274 PKT_RCVD_NOTIFY PktRcvdNotify; ///< Receive callback.\r
275 PKT_SENT_NOTIFY PktSentNotify; ///< Send callback.\r
97b38d4e 276} IP_IO_OPEN_DATA;\r
277\r
e29a2e7e 278///\r
279/// Internal struct book-keeping send request of IP_IO.\r
280///\r
281/// An IP_IO_SEND_ENTRY will be created each time a send request is issued to\r
282/// IP_IO via IpIoSend().\r
283///\r
97b38d4e 284typedef struct _IP_IO_SEND_ENTRY {\r
285 LIST_ENTRY Entry;\r
286 IP_IO *IpIo;\r
287 VOID *Context;\r
288 VOID *NotifyData;\r
2a2e33b2 289 IP_IO_IP_PROTOCOL Ip;\r
97b38d4e 290 NET_BUF *Pkt;\r
fb115c61 291 IP_IO_IP_COMPLETION_TOKEN SndToken;\r
97b38d4e 292} IP_IO_SEND_ENTRY;\r
293\r
e29a2e7e 294///\r
295/// The IP_IO_IP_INFO is used in IpIoSend() to override the default IP instance\r
296/// in IP_IO.\r
297///\r
97b38d4e 298typedef struct _IP_IO_IP_INFO {\r
fb115c61 299 EFI_IP_ADDRESS Addr;\r
b45b45b2 300 IP_IO_IP_MASK PreMask;\r
97b38d4e 301 LIST_ENTRY Entry;\r
302 EFI_HANDLE ChildHandle;\r
2a2e33b2 303 IP_IO_IP_PROTOCOL Ip;\r
fb115c61 304 IP_IO_IP_COMPLETION_TOKEN DummyRcvToken;\r
97b38d4e 305 INTN RefCnt;\r
b45b45b2 306 UINT8 IpVersion;\r
97b38d4e 307} IP_IO_IP_INFO;\r
308\r
309/**\r
310 Create a new IP_IO instance.\r
e29a2e7e 311 \r
fb115c61 312 This function uses IP4/IP6 service binding protocol in Controller to create\r
313 an IP4/IP6 child (aka IP4/IP6 instance).\r
97b38d4e 314\r
cdfdbb97 315 @param[in] Image The image handle of the driver or application that\r
e29a2e7e 316 consumes IP_IO.\r
fb115c61 317 @param[in] Controller The controller handle that has IP4 or IP6 service\r
318 binding protocol installed.\r
319 @param[in] IpVersion The version of the IP protocol to use, either\r
320 IPv4 or IPv6. \r
97b38d4e 321\r
64a80549 322 @return The pointer to a newly created IP_IO instance, or NULL if failed.\r
97b38d4e 323\r
324**/\r
325IP_IO *\r
326EFIAPI\r
327IpIoCreate (\r
328 IN EFI_HANDLE Image,\r
fb115c61 329 IN EFI_HANDLE Controller,\r
b45b45b2 330 IN UINT8 IpVersion\r
97b38d4e 331 );\r
332\r
333/**\r
334 Destroy an IP_IO instance.\r
e29a2e7e 335 \r
336 This function is paired with IpIoCreate(). The IP_IO will be closed first.\r
337 Resource will be freed afterwards. See IpIoClose().\r
97b38d4e 338\r
64a80549 339 @param[in, out] IpIo The pointer to the IP_IO instance that needs to be\r
e29a2e7e 340 destroyed.\r
97b38d4e 341\r
64a80549 342 @retval EFI_SUCCESS The IP_IO instance was destroyed successfully.\r
343 @retval Others An error condition occurred.\r
97b38d4e 344\r
345**/\r
346EFI_STATUS\r
347EFIAPI\r
348IpIoDestroy (\r
cdfdbb97 349 IN OUT IP_IO *IpIo\r
97b38d4e 350 );\r
351\r
352/**\r
353 Stop an IP_IO instance.\r
e29a2e7e 354 \r
e9b67286 355 This function is paired with IpIoOpen(). The IP_IO will be unconfigured, and all\r
356 pending send/receive tokens will be canceled.\r
97b38d4e 357\r
64a80549 358 @param[in, out] IpIo The pointer to the IP_IO instance that needs to stop.\r
97b38d4e 359\r
cdfdbb97 360 @retval EFI_SUCCESS The IP_IO instance stopped successfully.\r
64a80549 361 @retval Others Anrror condition occurred.\r
97b38d4e 362\r
363**/\r
364EFI_STATUS\r
365EFIAPI\r
366IpIoStop (\r
cdfdbb97 367 IN OUT IP_IO *IpIo\r
97b38d4e 368 );\r
369\r
370/**\r
371 Open an IP_IO instance for use.\r
e29a2e7e 372 \r
373 This function is called after IpIoCreate(). It is used for configuring the IP\r
374 instance and register the callbacks and their context data for sending and\r
375 receiving IP packets.\r
97b38d4e 376\r
64a80549 377 @param[in, out] IpIo The pointer to an IP_IO instance that needs\r
cdfdbb97 378 to open.\r
379 @param[in] OpenData The configuration data and callbacks for\r
380 the IP_IO instance.\r
97b38d4e 381\r
cdfdbb97 382 @retval EFI_SUCCESS The IP_IO instance opened with OpenData\r
383 successfully.\r
64a80549 384 @retval EFI_ACCESS_DENIED The IP_IO instance is configured; avoid \r
385 reopening it.\r
386 @retval Others An error condition occurred.\r
97b38d4e 387\r
388**/\r
389EFI_STATUS\r
e29a2e7e 390EFIAPI\r
97b38d4e 391IpIoOpen (\r
cdfdbb97 392 IN OUT IP_IO *IpIo,\r
393 IN IP_IO_OPEN_DATA *OpenData\r
97b38d4e 394 );\r
395\r
396/**\r
397 Send out an IP packet.\r
e29a2e7e 398 \r
399 This function is called after IpIoOpen(). The data to be sent are wrapped in\r
e9b67286 400 Pkt. The IP instance wrapped in IpIo is used for sending by default, but can be\r
401 overriden by Sender. Other sending configurations, such as source address and gateway\r
402 address, are specified in OverrideData.\r
97b38d4e 403\r
64a80549 404 @param[in, out] IpIo The pointer to an IP_IO instance used for sending IP\r
cdfdbb97 405 packet.\r
64a80549 406 @param[in, out] Pkt The pointer to the IP packet to be sent.\r
e9b67286 407 @param[in] Sender Optional. The IP protocol instance used for sending.\r
64a80549 408 @param[in] Context The optional context data.\r
409 @param[in] NotifyData The optional notify data.\r
cdfdbb97 410 @param[in] Dest The destination IP address to send this packet to.\r
411 @param[in] OverrideData The data to override some configuration of the IP\r
412 instance used for sending.\r
97b38d4e 413\r
64a80549 414 @retval EFI_SUCCESS The operation completed successfully.\r
cdfdbb97 415 @retval EFI_NOT_STARTED The IpIo is not configured.\r
64a80549 416 @retval EFI_OUT_OF_RESOURCES Failed due to resource limitations.\r
97b38d4e 417\r
418**/\r
419EFI_STATUS\r
420EFIAPI\r
421IpIoSend (\r
cdfdbb97 422 IN OUT IP_IO *IpIo,\r
423 IN OUT NET_BUF *Pkt,\r
424 IN IP_IO_IP_INFO *Sender OPTIONAL,\r
425 IN VOID *Context OPTIONAL,\r
426 IN VOID *NotifyData OPTIONAL,\r
fb115c61 427 IN EFI_IP_ADDRESS *Dest,\r
cdfdbb97 428 IN IP_IO_OVERRIDE *OverrideData OPTIONAL\r
97b38d4e 429 );\r
430\r
431/**\r
64a80549 432 Cancel the IP transmit token that wraps this Packet.\r
97b38d4e 433\r
64a80549 434 @param[in] IpIo The pointer to the IP_IO instance.\r
435 @param[in] Packet The pointer to the packet of NET_BUF to cancel.\r
97b38d4e 436\r
437**/\r
438VOID\r
439EFIAPI\r
440IpIoCancelTxToken (\r
441 IN IP_IO *IpIo,\r
442 IN VOID *Packet\r
443 );\r
444\r
445/**\r
446 Add a new IP instance for sending data.\r
e29a2e7e 447 \r
448 The function is used to add the IP_IO to the IP_IO sending list. The caller\r
449 can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send\r
450 data.\r
97b38d4e 451\r
64a80549 452 @param[in, out] IpIo The pointer to an IP_IO instance to add a new IP\r
e9b67286 453 instance for sending purposes.\r
97b38d4e 454\r
64a80549 455 @return The pointer to the created IP_IO_IP_INFO structure; NULL if failed.\r
97b38d4e 456\r
457**/\r
458IP_IO_IP_INFO *\r
459EFIAPI\r
460IpIoAddIp (\r
cdfdbb97 461 IN OUT IP_IO *IpIo\r
97b38d4e 462 );\r
463\r
464/**\r
fb115c61 465 Configure the IP instance of this IpInfo and start the receiving if IpConfigData\r
97b38d4e 466 is not NULL.\r
467\r
64a80549 468 @param[in, out] IpInfo The pointer to the IP_IO_IP_INFO instance.\r
fb115c61 469 @param[in, out] IpConfigData The IP4 or IP6 configure data used to configure \r
470 the IP instance. If NULL, the IP instance is reset.\r
471 If UseDefaultAddress is set to TRUE, and the configure\r
cdfdbb97 472 operation succeeds, the default address information\r
fb115c61 473 is written back in this IpConfigData.\r
97b38d4e 474\r
64a80549 475 @retval EFI_SUCCESS The IP instance of this IpInfo was configured successfully,\r
e9b67286 476 or there is no need to reconfigure it.\r
64a80549 477 @retval Others The configuration failed.\r
97b38d4e 478\r
479**/\r
480EFI_STATUS\r
481EFIAPI\r
482IpIoConfigIp (\r
cdfdbb97 483 IN OUT IP_IO_IP_INFO *IpInfo,\r
fb115c61 484 IN OUT VOID *IpConfigData OPTIONAL\r
97b38d4e 485 );\r
486\r
487/**\r
488 Destroy an IP instance maintained in IpIo->IpList for\r
489 sending purpose.\r
e29a2e7e 490 \r
491 This function pairs with IpIoAddIp(). The IpInfo is previously created by\r
492 IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance\r
493 will be dstroyed if the RefCnt is zero.\r
97b38d4e 494\r
64a80549 495 @param[in] IpIo The pointer to the IP_IO instance.\r
496 @param[in] IpInfo The pointer to the IpInfo to be removed.\r
97b38d4e 497\r
97b38d4e 498**/\r
499VOID\r
500EFIAPI\r
501IpIoRemoveIp (\r
502 IN IP_IO *IpIo,\r
503 IN IP_IO_IP_INFO *IpInfo\r
504 );\r
505\r
506/**\r
507 Find the first IP protocol maintained in IpIo whose local\r
e9b67286 508 address is the same as Src.\r
e29a2e7e 509 \r
510 This function is called when the caller needs the IpIo to send data to the\r
511 specified Src. The IpIo was added previously by IpIoAddIp().\r
97b38d4e 512\r
64a80549 513 @param[in, out] IpIo The pointer to the pointer of the IP_IO instance.\r
fb115c61 514 @param[in] IpVersion The version of the IP protocol to use, either\r
515 IPv4 or IPv6.\r
cdfdbb97 516 @param[in] Src The local IP address.\r
97b38d4e 517\r
64a80549 518 @return The pointer to the IP protocol can be used for sending purpose and its local\r
e29a2e7e 519 address is the same with Src.\r
97b38d4e 520\r
521**/\r
522IP_IO_IP_INFO *\r
523EFIAPI\r
524IpIoFindSender (\r
fb115c61 525 IN OUT IP_IO **IpIo,\r
b45b45b2 526 IN UINT8 IpVersion,\r
fb115c61 527 IN EFI_IP_ADDRESS *Src\r
97b38d4e 528 );\r
529\r
530/**\r
e29a2e7e 531 Get the ICMP error map information.\r
532 \r
533 The ErrorStatus will be returned. The IsHard and Notify are optional. If they\r
534 are not NULL, this routine will fill them.\r
97b38d4e 535\r
3a1ab4bc 536 @param[in] IcmpError IcmpError Type.\r
fb115c61 537 @param[in] IpVersion The version of the IP protocol to use,\r
3b1464d5 538 either IPv4 or IPv6. \r
539 @param[out] IsHard If TRUE, indicates that it is a hard error.\r
540 @param[out] Notify If TRUE, SockError needs to be notified.\r
97b38d4e 541\r
64a80549 542 @return The ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.\r
97b38d4e 543\r
544**/\r
545EFI_STATUS\r
546EFIAPI\r
547IpIoGetIcmpErrStatus (\r
b45b45b2 548 IN UINT8 IcmpError,\r
549 IN UINT8 IpVersion,\r
e29a2e7e 550 OUT BOOLEAN *IsHard OPTIONAL,\r
551 OUT BOOLEAN *Notify OPTIONAL\r
97b38d4e 552 );\r
553\r
fb115c61 554/**\r
555 Refresh the remote peer's Neighbor Cache entries.\r
556\r
557 This function is called when the caller needs the IpIo to refresh the existing\r
558 IPv6 neighbor cache entries since the neighbor is considered reachable by the \r
559 node has recently received a confirmation that packets sent recently to the \r
560 neighbor were received by its IP layer. \r
561\r
64a80549 562 @param[in] IpIo The pointer to an IP_IO instance\r
fb115c61 563 @param[in] Neighbor The IP address of the neighbor\r
64a80549 564 @param[in] Timeout The time in 100-ns units that this entry will\r
fb115c61 565 remain in the neighbor cache. A value of \r
566 zero means that the entry is permanent. \r
567 A value of non-zero means that the entry is \r
568 dynamic and will be deleted after Timeout.\r
569\r
64a80549 570 @retval EFI_SUCCESS The operation completed successfully.\r
fb115c61 571 @retval EFI_NOT_STARTED The IpIo is not configured.\r
64a80549 572 @retval EFI_INVALID_PARAMETER The Neighbor Address is invalid.\r
fb115c61 573 @retval EFI_NOT_FOUND The neighbor cache entry is not in the \r
574 neighbor table. \r
64a80549 575 @retval EFI_OUT_OF_RESOURCES Failed due to resource limitations.\r
fb115c61 576\r
577**/\r
578EFI_STATUS\r
579IpIoRefreshNeighbor (\r
580 IN IP_IO *IpIo,\r
581 IN EFI_IP_ADDRESS *Neighbor,\r
582 IN UINT32 Timeout \r
583 );\r
584\r
97b38d4e 585#endif\r
fb115c61 586\r
EFI Development Kit II mirror for PVE