]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c
projects / mirror_edk2.git / blob
? search:


ab4df80768dc5ef6433da7bf8c35d3d849aca5ac
[mirror_edk2.git] / MdeModulePkg / Library / DxeIpIoLib / DxeIpIoLib.c
1 /** @file
2 IpIo Library.
3
4 (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 **/
14
15 #include <Uefi.h>
16
17 #include <Protocol/Udp4.h>
18
19 #include <Library/IpIoLib.h>
20 #include <Library/BaseLib.h>
21 #include <Library/DebugLib.h>
22 #include <Library/BaseMemoryLib.h>
23 #include <Library/UefiBootServicesTableLib.h>
24 #include <Library/MemoryAllocationLib.h>
25 #include <Library/DpcLib.h>
26
27
28 GLOBAL_REMOVE_IF_UNREFERENCED LIST_ENTRY mActiveIpIoList = {
29 &mActiveIpIoList,
30 &mActiveIpIoList
31 };
32
33 GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData = {
34 EFI_IP_PROTO_UDP,
35 FALSE,
36 TRUE,
37 FALSE,
38 FALSE,
39 FALSE,
40 {{0, 0, 0, 0}},
41 {{0, 0, 0, 0}},
42 0,
43 255,
44 FALSE,
45 FALSE,
46 0,
47 0
48 };
49
50 GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData = {
51 EFI_IP_PROTO_UDP,
52 FALSE,
53 TRUE,
54 FALSE,
55 {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
56 {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}},
57 0,
58 255,
59 0,
60 0,
61 0
62 };
63
64 GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmpErrMap[10] = {
65 {FALSE, TRUE }, // ICMP_ERR_UNREACH_NET
66 {FALSE, TRUE }, // ICMP_ERR_UNREACH_HOST
67 {TRUE, TRUE }, // ICMP_ERR_UNREACH_PROTOCOL
68 {TRUE, TRUE }, // ICMP_ERR_UNREACH_PORT
69 {TRUE, TRUE }, // ICMP_ERR_MSGSIZE
70 {FALSE, TRUE }, // ICMP_ERR_UNREACH_SRCFAIL
71 {FALSE, TRUE }, // ICMP_ERR_TIMXCEED_INTRANS
72 {FALSE, TRUE }, // ICMP_ERR_TIMEXCEED_REASS
73 {FALSE, FALSE}, // ICMP_ERR_QUENCH
74 {FALSE, TRUE } // ICMP_ERR_PARAMPROB
75 };
76
77 GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmp6ErrMap[10] = {
78 {FALSE, TRUE}, // ICMP6_ERR_UNREACH_NET
79 {FALSE, TRUE}, // ICMP6_ERR_UNREACH_HOST
80 {TRUE, TRUE}, // ICMP6_ERR_UNREACH_PROTOCOL
81 {TRUE, TRUE}, // ICMP6_ERR_UNREACH_PORT
82 {TRUE, TRUE}, // ICMP6_ERR_PACKAGE_TOOBIG
83 {FALSE, TRUE}, // ICMP6_ERR_TIMXCEED_HOPLIMIT
84 {FALSE, TRUE}, // ICMP6_ERR_TIMXCEED_REASS
85 {FALSE, TRUE}, // ICMP6_ERR_PARAMPROB_HEADER
86 {FALSE, TRUE}, // ICMP6_ERR_PARAMPROB_NEXHEADER
87 {FALSE, TRUE} // ICMP6_ERR_PARAMPROB_IPV6OPTION
88 };
89
90
91 /**
92 Notify function for IP transmit token.
93
94 @param[in] Context The context passed in by the event notifier.
95
96 **/
97 VOID
98 EFIAPI
99 IpIoTransmitHandlerDpc (
100 IN VOID *Context
101 );
102
103
104 /**
105 Notify function for IP transmit token.
106
107 @param[in] Event The event signaled.
108 @param[in] Context The context passed in by the event notifier.
109
110 **/
111 VOID
112 EFIAPI
113 IpIoTransmitHandler (
114 IN EFI_EVENT Event,
115 IN VOID *Context
116 );
117
118
119 /**
120 This function create an IP child ,open the IP protocol, and return the opened
121 IP protocol as Interface.
122
123 @param[in] ControllerHandle The controller handle.
124 @param[in] ImageHandle The image handle.
125 @param[in] ChildHandle Pointer to the buffer to save the IP child handle.
126 @param[in] IpVersion The version of the IP protocol to use, either
127 IPv4 or IPv6.
128 @param[out] Interface Pointer used to get the IP protocol interface.
129
130 @retval EFI_SUCCESS The IP child is created and the IP protocol
131 interface is retrieved.
132 @retval Others The required operation failed.
133
134 **/
135 EFI_STATUS
136 IpIoCreateIpChildOpenProtocol (
137 IN EFI_HANDLE ControllerHandle,
138 IN EFI_HANDLE ImageHandle,
139 IN EFI_HANDLE *ChildHandle,
140 IN UINT8 IpVersion,
141 OUT VOID **Interface
142 )
143 {
144 EFI_STATUS Status;
145 EFI_GUID *ServiceBindingGuid;
146 EFI_GUID *IpProtocolGuid;
147
148 if (IpVersion == IP_VERSION_4) {
149 ServiceBindingGuid = &gEfiIp4ServiceBindingProtocolGuid;
150 IpProtocolGuid = &gEfiIp4ProtocolGuid;
151 } else if (IpVersion == IP_VERSION_6){
152 ServiceBindingGuid = &gEfiIp6ServiceBindingProtocolGuid;
153 IpProtocolGuid = &gEfiIp6ProtocolGuid;
154 } else {
155 return EFI_UNSUPPORTED;
156 }
157
158 //
159 // Create an IP child.
160 //
161 Status = NetLibCreateServiceChild (
162 ControllerHandle,
163 ImageHandle,
164 ServiceBindingGuid,
165 ChildHandle
166 );
167 if (EFI_ERROR (Status)) {
168 return Status;
169 }
170
171 //
172 // Open the IP protocol installed on the *ChildHandle.
173 //
174 Status = gBS->OpenProtocol (
175 *ChildHandle,
176 IpProtocolGuid,
177 Interface,
178 ImageHandle,
179 ControllerHandle,
180 EFI_OPEN_PROTOCOL_BY_DRIVER
181 );
182 if (EFI_ERROR (Status)) {
183 //
184 // On failure, destroy the IP child.
185 //
186 NetLibDestroyServiceChild (
187 ControllerHandle,
188 ImageHandle,
189 ServiceBindingGuid,
190 *ChildHandle
191 );
192 }
193
194 return Status;
195 }
196
197
198 /**
199 This function close the previously openned IP protocol and destroy the IP child.
200
201 @param[in] ControllerHandle The controller handle.
202 @param[in] ImageHandle The image handle.
203 @param[in] ChildHandle The child handle of the IP child.
204 @param[in] IpVersion The version of the IP protocol to use, either
205 IPv4 or IPv6.
206
207 @retval EFI_SUCCESS The IP protocol is closed and the relevant IP child
208 is destroyed.
209 @retval Others The required operation failed.
210
211 **/
212 EFI_STATUS
213 IpIoCloseProtocolDestroyIpChild (
214 IN EFI_HANDLE ControllerHandle,
215 IN EFI_HANDLE ImageHandle,
216 IN EFI_HANDLE ChildHandle,
217 IN UINT8 IpVersion
218 )
219 {
220 EFI_STATUS Status;
221 EFI_GUID *ServiceBindingGuid;
222 EFI_GUID *IpProtocolGuid;
223
224 if (IpVersion == IP_VERSION_4) {
225 ServiceBindingGuid = &gEfiIp4ServiceBindingProtocolGuid;
226 IpProtocolGuid = &gEfiIp4ProtocolGuid;
227 } else if (IpVersion == IP_VERSION_6) {
228 ServiceBindingGuid = &gEfiIp6ServiceBindingProtocolGuid;
229 IpProtocolGuid = &gEfiIp6ProtocolGuid;
230 } else {
231 return EFI_UNSUPPORTED;
232 }
233
234 //
235 // Close the previously openned IP protocol.
236 //
237 gBS->CloseProtocol (
238 ChildHandle,
239 IpProtocolGuid,
240 ImageHandle,
241 ControllerHandle
242 );
243
244 //
245 // Destroy the IP child.
246 //
247 Status = NetLibDestroyServiceChild (
248 ControllerHandle,
249 ImageHandle,
250 ServiceBindingGuid,
251 ChildHandle
252 );
253
254 return Status;
255 }
256
257 /**
258 This function handles ICMPv4 packets. It is the worker function of
259 IpIoIcmpHandler.
260
261 @param[in] IpIo Pointer to the IP_IO instance.
262 @param[in, out] Pkt Pointer to the ICMPv4 packet.
263 @param[in] Session Pointer to the net session of this ICMPv4 packet.
264
265 @retval EFI_SUCCESS The ICMPv4 packet is handled successfully.
266 @retval EFI_ABORTED This type of ICMPv4 packet is not supported.
267
268 **/
269 EFI_STATUS
270 IpIoIcmpv4Handler (
271 IN IP_IO *IpIo,
272 IN OUT NET_BUF *Pkt,
273 IN EFI_NET_SESSION_DATA *Session
274 )
275 {
276 IP4_ICMP_ERROR_HEAD *IcmpHdr;
277 EFI_IP4_HEADER *IpHdr;
278 UINT8 IcmpErr;
279 UINT8 *PayLoadHdr;
280 UINT8 Type;
281 UINT8 Code;
282 UINT32 TrimBytes;
283
284 ASSERT (IpIo->IpVersion == IP_VERSION_4);
285
286 IcmpHdr = NET_PROTO_HDR (Pkt, IP4_ICMP_ERROR_HEAD);
287 IpHdr = (EFI_IP4_HEADER *) (&IcmpHdr->IpHead);
288
289 //
290 // Check the ICMP packet length.
291 //
292 if (Pkt->TotalSize < ICMP_ERRLEN (IpHdr)) {
293
294 return EFI_ABORTED;
295 }
296
297 Type = IcmpHdr->Head.Type;
298 Code = IcmpHdr->Head.Code;
299
300 //
301 // Analyze the ICMP Error in this ICMP pkt
302 //
303 switch (Type) {
304 case ICMP_TYPE_UNREACH:
305 switch (Code) {
306 case ICMP_CODE_UNREACH_NET:
307 case ICMP_CODE_UNREACH_HOST:
308 case ICMP_CODE_UNREACH_PROTOCOL:
309 case ICMP_CODE_UNREACH_PORT:
310 case ICMP_CODE_UNREACH_SRCFAIL:
311 IcmpErr = (UINT8) (ICMP_ERR_UNREACH_NET + Code);
312
313 break;
314
315 case ICMP_CODE_UNREACH_NEEDFRAG:
316 IcmpErr = ICMP_ERR_MSGSIZE;
317
318 break;
319
320 case ICMP_CODE_UNREACH_NET_UNKNOWN:
321 case ICMP_CODE_UNREACH_NET_PROHIB:
322 case ICMP_CODE_UNREACH_TOSNET:
323 IcmpErr = ICMP_ERR_UNREACH_NET;
324
325 break;
326
327 case ICMP_CODE_UNREACH_HOST_UNKNOWN:
328 case ICMP_CODE_UNREACH_ISOLATED:
329 case ICMP_CODE_UNREACH_HOST_PROHIB:
330 case ICMP_CODE_UNREACH_TOSHOST:
331 IcmpErr = ICMP_ERR_UNREACH_HOST;
332
333 break;
334
335 default:
336 return EFI_ABORTED;
337 }
338
339 break;
340
341 case ICMP_TYPE_TIMXCEED:
342 if (Code > 1) {
343 return EFI_ABORTED;
344 }
345
346 IcmpErr = (UINT8) (Code + ICMP_ERR_TIMXCEED_INTRANS);
347
348 break;
349
350 case ICMP_TYPE_PARAMPROB:
351 if (Code > 1) {
352 return EFI_ABORTED;
353 }
354
355 IcmpErr = ICMP_ERR_PARAMPROB;
356
357 break;
358
359 case ICMP_TYPE_SOURCEQUENCH:
360 if (Code != 0) {
361 return EFI_ABORTED;
362 }
363
364 IcmpErr = ICMP_ERR_QUENCH;
365
366 break;
367
368 default:
369 return EFI_ABORTED;
370 }
371
372 //
373 // Notify user the ICMP pkt only containing payload except
374 // IP and ICMP header
375 //
376 PayLoadHdr = (UINT8 *) ((UINT8 *) IpHdr + EFI_IP4_HEADER_LEN (IpHdr));
377 TrimBytes = (UINT32) (PayLoadHdr - (UINT8 *) IcmpHdr);
378
379 NetbufTrim (Pkt, TrimBytes, TRUE);
380
381 IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext);
382
383 return EFI_SUCCESS;
384 }
385
386 /**
387 This function handles ICMPv6 packets. It is the worker function of
388 IpIoIcmpHandler.
389
390 @param[in] IpIo Pointer to the IP_IO instance.
391 @param[in, out] Pkt Pointer to the ICMPv6 packet.
392 @param[in] Session Pointer to the net session of this ICMPv6 packet.
393
394 @retval EFI_SUCCESS The ICMPv6 packet is handled successfully.
395 @retval EFI_ABORTED This type of ICMPv6 packet is not supported.
396
397 **/
398 EFI_STATUS
399 IpIoIcmpv6Handler (
400 IN IP_IO *IpIo,
401 IN OUT NET_BUF *Pkt,
402 IN EFI_NET_SESSION_DATA *Session
403 )
404 {
405 IP6_ICMP_ERROR_HEAD *IcmpHdr;
406 EFI_IP6_HEADER *IpHdr;
407 UINT8 IcmpErr;
408 UINT8 *PayLoadHdr;
409 UINT8 Type;
410 UINT8 Code;
411 UINT8 NextHeader;
412 UINT32 TrimBytes;
413 BOOLEAN Flag;
414
415 ASSERT (IpIo->IpVersion == IP_VERSION_6);
416
417 //
418 // Check the ICMPv6 packet length.
419 //
420 if (Pkt->TotalSize < sizeof (IP6_ICMP_ERROR_HEAD)) {
421
422 return EFI_ABORTED;
423 }
424
425 IcmpHdr = NET_PROTO_HDR (Pkt, IP6_ICMP_ERROR_HEAD);
426 Type = IcmpHdr->Head.Type;
427 Code = IcmpHdr->Head.Code;
428
429 //
430 // Analyze the ICMPv6 Error in this ICMPv6 packet
431 //
432 switch (Type) {
433 case ICMP_V6_DEST_UNREACHABLE:
434 switch (Code) {
435 case ICMP_V6_NO_ROUTE_TO_DEST:
436 case ICMP_V6_BEYOND_SCOPE:
437 case ICMP_V6_ROUTE_REJECTED:
438 IcmpErr = ICMP6_ERR_UNREACH_NET;
439
440 break;
441
442 case ICMP_V6_COMM_PROHIBITED:
443 case ICMP_V6_ADDR_UNREACHABLE:
444 case ICMP_V6_SOURCE_ADDR_FAILED:
445 IcmpErr = ICMP6_ERR_UNREACH_HOST;
446
447 break;
448
449 case ICMP_V6_PORT_UNREACHABLE:
450 IcmpErr = ICMP6_ERR_UNREACH_PORT;
451
452 break;
453
454 default:
455 return EFI_ABORTED;
456 }
457
458 break;
459
460 case ICMP_V6_PACKET_TOO_BIG:
461 if (Code >= 1) {
462 return EFI_ABORTED;
463 }
464
465 IcmpErr = ICMP6_ERR_PACKAGE_TOOBIG;
466
467 break;
468
469 case ICMP_V6_TIME_EXCEEDED:
470 if (Code > 1) {
471 return EFI_ABORTED;
472 }
473
474 IcmpErr = (UINT8) (ICMP6_ERR_TIMXCEED_HOPLIMIT + Code);
475
476 break;
477
478 case ICMP_V6_PARAMETER_PROBLEM:
479 if (Code > 3) {
480 return EFI_ABORTED;
481 }
482
483 IcmpErr = (UINT8) (ICMP6_ERR_PARAMPROB_HEADER + Code);
484
485 break;
486
487 default:
488
489 return EFI_ABORTED;
490 }
491
492 //
493 // Notify user the ICMPv6 packet only containing payload except
494 // IPv6 basic header, extension header and ICMP header
495 //
496
497 IpHdr = (EFI_IP6_HEADER *) (&IcmpHdr->IpHead);
498 NextHeader = IpHdr->NextHeader;
499 PayLoadHdr = (UINT8 *) ((UINT8 *) IcmpHdr + sizeof (IP6_ICMP_ERROR_HEAD));
500 Flag = TRUE;
501
502 do {
503 switch (NextHeader) {
504 case EFI_IP_PROTO_UDP:
505 case EFI_IP_PROTO_TCP:
506 case EFI_IP_PROTO_ICMP:
507 case IP6_NO_NEXT_HEADER:
508 Flag = FALSE;
509
510 break;
511
512 case IP6_HOP_BY_HOP:
513 case IP6_DESTINATION:
514 //
515 // The Hdr Ext Len is 8-bit unsigned integer in 8-octet units, not including
516 // the first 8 octets.
517 //
518 NextHeader = *(PayLoadHdr);
519 PayLoadHdr = (UINT8 *) (PayLoadHdr + (*(PayLoadHdr + 1) + 1) * 8);
520
521 break;
522
523 case IP6_FRAGMENT:
524 //
525 // The Fragment Header Length is 8 octets.
526 //
527 NextHeader = *(PayLoadHdr);
528 PayLoadHdr = (UINT8 *) (PayLoadHdr + 8);
529
530 break;
531
532 default:
533
534 return EFI_ABORTED;
535 }
536 } while (Flag);
537
538 TrimBytes = (UINT32) (PayLoadHdr - (UINT8 *) IcmpHdr);
539
540 NetbufTrim (Pkt, TrimBytes, TRUE);
541
542 IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext);
543
544 return EFI_SUCCESS;
545 }
546
547 /**
548 This function handles ICMP packets.
549
550 @param[in] IpIo Pointer to the IP_IO instance.
551 @param[in, out] Pkt Pointer to the ICMP packet.
552 @param[in] Session Pointer to the net session of this ICMP packet.
553
554 @retval EFI_SUCCESS The ICMP packet is handled successfully.
555 @retval EFI_ABORTED This type of ICMP packet is not supported.
556 @retval EFI_UNSUPPORTED The IP protocol version in IP_IO is not supported.
557
558 **/
559 EFI_STATUS
560 IpIoIcmpHandler (
561 IN IP_IO *IpIo,
562 IN OUT NET_BUF *Pkt,
563 IN EFI_NET_SESSION_DATA *Session
564 )
565 {
566
567 if (IpIo->IpVersion == IP_VERSION_4) {
568
569 return IpIoIcmpv4Handler (IpIo, Pkt, Session);
570
571 } else if (IpIo->IpVersion == IP_VERSION_6) {
572
573 return IpIoIcmpv6Handler (IpIo, Pkt, Session);
574
575 } else {
576
577 return EFI_UNSUPPORTED;
578 }
579 }
580
581
582 /**
583 Free function for receive token of IP_IO. It is used to
584 signal the recycle event to notify IP to recycle the
585 data buffer.
586
587 @param[in] Event The event to be signaled.
588
589 **/
590 VOID
591 EFIAPI
592 IpIoExtFree (
593 IN VOID *Event
594 )
595 {
596 gBS->SignalEvent ((EFI_EVENT) Event);
597 }
598
599
600 /**
601 Create a send entry to wrap a packet before sending
602 out it through IP.
603
604 @param[in, out] IpIo Pointer to the IP_IO instance.
605 @param[in, out] Pkt Pointer to the packet.
606 @param[in] Sender Pointer to the IP sender.
607 @param[in] Context Pointer to the context.
608 @param[in] NotifyData Pointer to the notify data.
609 @param[in] Dest Pointer to the destination IP address.
610 @param[in] Override Pointer to the overriden IP_IO data.
611
612 @return Pointer to the data structure created to wrap the packet. If NULL,
613 @return resource limit occurred.
614
615 **/
616 IP_IO_SEND_ENTRY *
617 IpIoCreateSndEntry (
618 IN OUT IP_IO *IpIo,
619 IN OUT NET_BUF *Pkt,
620 IN IP_IO_IP_PROTOCOL Sender,
621 IN VOID *Context OPTIONAL,
622 IN VOID *NotifyData OPTIONAL,
623 IN EFI_IP_ADDRESS *Dest OPTIONAL,
624 IN IP_IO_OVERRIDE *Override
625 )
626 {
627 IP_IO_SEND_ENTRY *SndEntry;
628 EFI_EVENT Event;
629 EFI_STATUS Status;
630 NET_FRAGMENT *ExtFragment;
631 UINT32 FragmentCount;
632 IP_IO_OVERRIDE *OverrideData;
633 IP_IO_IP_TX_DATA *TxData;
634 EFI_IP4_TRANSMIT_DATA *Ip4TxData;
635 EFI_IP6_TRANSMIT_DATA *Ip6TxData;
636
637 if ((IpIo->IpVersion != IP_VERSION_4) && (IpIo->IpVersion != IP_VERSION_6)) {
638 return NULL;
639 }
640
641 Event = NULL;
642 TxData = NULL;
643 OverrideData = NULL;
644
645 //
646 // Allocate resource for SndEntry
647 //
648 SndEntry = AllocatePool (sizeof (IP_IO_SEND_ENTRY));
649 if (NULL == SndEntry) {
650 return NULL;
651 }
652
653 Status = gBS->CreateEvent (
654 EVT_NOTIFY_SIGNAL,
655 TPL_NOTIFY,
656 IpIoTransmitHandler,
657 SndEntry,
658 &Event
659 );
660 if (EFI_ERROR (Status)) {
661 goto ON_ERROR;
662 }
663
664 FragmentCount = Pkt->BlockOpNum;
665
666 //
667 // Allocate resource for TxData
668 //
669 TxData = (IP_IO_IP_TX_DATA *) AllocatePool (
670 sizeof (IP_IO_IP_TX_DATA) + sizeof (NET_FRAGMENT) * (FragmentCount - 1)
671 );
672
673 if (NULL == TxData) {
674 goto ON_ERROR;
675 }
676
677 //
678 // Build a fragment table to contain the fragments in the packet.
679 //
680 if (IpIo->IpVersion == IP_VERSION_4) {
681 ExtFragment = (NET_FRAGMENT *) TxData->Ip4TxData.FragmentTable;
682 } else {
683 ExtFragment = (NET_FRAGMENT *) TxData->Ip6TxData.FragmentTable;
684 }
685
686 NetbufBuildExt (Pkt, ExtFragment, &FragmentCount);
687
688
689 //
690 // Allocate resource for OverrideData if needed
691 //
692 if (NULL != Override) {
693
694 OverrideData = AllocateCopyPool (sizeof (IP_IO_OVERRIDE), Override);
695 if (NULL == OverrideData) {
696 goto ON_ERROR;
697 }
698 }
699
700 //
701 // Set other fields of TxData except the fragment table
702 //
703 if (IpIo->IpVersion == IP_VERSION_4) {
704
705 Ip4TxData = &TxData->Ip4TxData;
706
707 IP4_COPY_ADDRESS (&Ip4TxData->DestinationAddress, Dest);
708
709 Ip4TxData->OverrideData = &OverrideData->Ip4OverrideData;
710 Ip4TxData->OptionsLength = 0;
711 Ip4TxData->OptionsBuffer = NULL;
712 Ip4TxData->TotalDataLength = Pkt->TotalSize;
713 Ip4TxData->FragmentCount = FragmentCount;
714
715 //
716 // Set the fields of SndToken
717 //
718 SndEntry->SndToken.Ip4Token.Event = Event;
719 SndEntry->SndToken.Ip4Token.Packet.TxData = Ip4TxData;
720 } else {
721
722 Ip6TxData = &TxData->Ip6TxData;
723
724 if (Dest != NULL) {
725 CopyMem (&Ip6TxData->DestinationAddress, Dest, sizeof (EFI_IPv6_ADDRESS));
726 } else {
727 ZeroMem (&Ip6TxData->DestinationAddress, sizeof (EFI_IPv6_ADDRESS));
728 }
729
730 Ip6TxData->OverrideData = &OverrideData->Ip6OverrideData;
731 Ip6TxData->DataLength = Pkt->TotalSize;
732 Ip6TxData->FragmentCount = FragmentCount;
733 Ip6TxData->ExtHdrsLength = 0;
734 Ip6TxData->ExtHdrs = NULL;
735
736 //
737 // Set the fields of SndToken
738 //
739 SndEntry->SndToken.Ip6Token.Event = Event;
740 SndEntry->SndToken.Ip6Token.Packet.TxData = Ip6TxData;
741 }
742
743 //
744 // Set the fields of SndEntry
745 //
746 SndEntry->IpIo = IpIo;
747 SndEntry->Ip = Sender;
748 SndEntry->Context = Context;
749 SndEntry->NotifyData = NotifyData;
750
751 SndEntry->Pkt = Pkt;
752 NET_GET_REF (Pkt);
753
754 InsertTailList (&IpIo->PendingSndList, &SndEntry->Entry);
755
756 return SndEntry;
757
758 ON_ERROR:
759
760 if (OverrideData != NULL) {
761 FreePool (OverrideData);
762 }
763
764 if (TxData != NULL) {
765 FreePool (TxData);
766 }
767
768 if (SndEntry != NULL) {
769 FreePool (SndEntry);
770 }
771
772 if (Event != NULL) {
773 gBS->CloseEvent (Event);
774 }
775
776 return NULL;
777 }
778
779
780 /**
781 Destroy the SndEntry.
782
783 This function pairs with IpIoCreateSndEntry().
784
785 @param[in] SndEntry Pointer to the send entry to be destroyed.
786
787 **/
788 VOID
789 IpIoDestroySndEntry (
790 IN IP_IO_SEND_ENTRY *SndEntry
791 )
792 {
793 EFI_EVENT Event;
794 IP_IO_IP_TX_DATA *TxData;
795 IP_IO_OVERRIDE *Override;
796
797 if (SndEntry->IpIo->IpVersion == IP_VERSION_4) {
798 Event = SndEntry->SndToken.Ip4Token.Event;
799 TxData = (IP_IO_IP_TX_DATA *) SndEntry->SndToken.Ip4Token.Packet.TxData;
800 Override = (IP_IO_OVERRIDE *) TxData->Ip4TxData.OverrideData;
801 } else if (SndEntry->IpIo->IpVersion == IP_VERSION_6) {
802 Event = SndEntry->SndToken.Ip6Token.Event;
803 TxData = (IP_IO_IP_TX_DATA *) SndEntry->SndToken.Ip6Token.Packet.TxData;
804 Override = (IP_IO_OVERRIDE *) TxData->Ip6TxData.OverrideData;
805 } else {
806 return ;
807 }
808
809 gBS->CloseEvent (Event);
810
811 FreePool (TxData);
812
813 if (NULL != Override) {
814 FreePool (Override);
815 }
816
817 NetbufFree (SndEntry->Pkt);
818
819 RemoveEntryList (&SndEntry->Entry);
820
821 FreePool (SndEntry);
822 }
823
824
825 /**
826 Notify function for IP transmit token.
827
828 @param[in] Context The context passed in by the event notifier.
829
830 **/
831 VOID
832 EFIAPI
833 IpIoTransmitHandlerDpc (
834 IN VOID *Context
835 )
836 {
837 IP_IO *IpIo;
838 IP_IO_SEND_ENTRY *SndEntry;
839 EFI_STATUS Status;
840
841 SndEntry = (IP_IO_SEND_ENTRY *) Context;
842
843 IpIo = SndEntry->IpIo;
844
845 if (IpIo->IpVersion == IP_VERSION_4) {
846 Status = SndEntry->SndToken.Ip4Token.Status;
847 } else if (IpIo->IpVersion == IP_VERSION_6){
848 Status = SndEntry->SndToken.Ip6Token.Status;
849 } else {
850 return ;
851 }
852
853 if ((IpIo->PktSentNotify != NULL) && (SndEntry->NotifyData != NULL)) {
854 IpIo->PktSentNotify (
855 Status,
856 SndEntry->Context,
857 SndEntry->Ip,
858 SndEntry->NotifyData
859 );
860 }
861
862 IpIoDestroySndEntry (SndEntry);
863 }
864
865
866 /**
867 Notify function for IP transmit token.
868
869 @param[in] Event The event signaled.
870 @param[in] Context The context passed in by the event notifier.
871
872 **/
873 VOID
874 EFIAPI
875 IpIoTransmitHandler (
876 IN EFI_EVENT Event,
877 IN VOID *Context
878 )
879 {
880 //
881 // Request IpIoTransmitHandlerDpc as a DPC at TPL_CALLBACK
882 //
883 QueueDpc (TPL_CALLBACK, IpIoTransmitHandlerDpc, Context);
884 }
885
886
887 /**
888 The dummy handler for the dummy IP receive token.
889
890 @param[in] Context The context passed in by the event notifier.
891
892 **/
893 VOID
894 EFIAPI
895 IpIoDummyHandlerDpc (
896 IN VOID *Context
897 )
898 {
899 IP_IO_IP_INFO *IpInfo;
900 EFI_STATUS Status;
901 EFI_EVENT RecycleEvent;
902
903 IpInfo = (IP_IO_IP_INFO *) Context;
904
905 if ((IpInfo->IpVersion != IP_VERSION_4) && (IpInfo->IpVersion != IP_VERSION_6)) {
906 return ;
907 }
908
909 RecycleEvent = NULL;
910
911 if (IpInfo->IpVersion == IP_VERSION_4) {
912 Status = IpInfo->DummyRcvToken.Ip4Token.Status;
913
914 if (IpInfo->DummyRcvToken.Ip4Token.Packet.RxData != NULL) {
915 RecycleEvent = IpInfo->DummyRcvToken.Ip4Token.Packet.RxData->RecycleSignal;
916 }
917 } else {
918 Status = IpInfo->DummyRcvToken.Ip6Token.Status;
919
920 if (IpInfo->DummyRcvToken.Ip6Token.Packet.RxData != NULL) {
921 RecycleEvent = IpInfo->DummyRcvToken.Ip6Token.Packet.RxData->RecycleSignal;
922 }
923 }
924
925
926
927 if (EFI_ABORTED == Status) {
928 //
929 // The reception is actively aborted by the consumer, directly return.
930 //
931 return;
932 } else if (EFI_SUCCESS == Status) {
933 //
934 // Recycle the RxData.
935 //
936 ASSERT (RecycleEvent != NULL);
937
938 gBS->SignalEvent (RecycleEvent);
939 }
940
941 //
942 // Continue the receive.
943 //
944 if (IpInfo->IpVersion == IP_VERSION_4) {
945 IpInfo->Ip.Ip4->Receive (
946 IpInfo->Ip.Ip4,
947 &IpInfo->DummyRcvToken.Ip4Token
948 );
949 } else {
950 IpInfo->Ip.Ip6->Receive (
951 IpInfo->Ip.Ip6,
952 &IpInfo->DummyRcvToken.Ip6Token
953 );
954 }
955 }
956
957
958 /**
959 This function add IpIoDummyHandlerDpc to the end of the DPC queue.
960
961 @param[in] Event The event signaled.
962 @param[in] Context The context passed in by the event notifier.
963
964 **/
965 VOID
966 EFIAPI
967 IpIoDummyHandler (
968 IN EFI_EVENT Event,
969 IN VOID *Context
970 )
971 {
972 //
973 // Request IpIoDummyHandlerDpc as a DPC at TPL_CALLBACK
974 //
975 QueueDpc (TPL_CALLBACK, IpIoDummyHandlerDpc, Context);
976 }
977
978
979 /**
980 Notify function for the IP receive token, used to process
981 the received IP packets.
982
983 @param[in] Context The context passed in by the event notifier.
984
985 **/
986 VOID
987 EFIAPI
988 IpIoListenHandlerDpc (
989 IN VOID *Context
990 )
991 {
992 IP_IO *IpIo;
993 EFI_STATUS Status;
994 IP_IO_IP_RX_DATA *RxData;
995 EFI_NET_SESSION_DATA Session;
996 NET_BUF *Pkt;
997
998 IpIo = (IP_IO *) Context;
999
1000 if (IpIo->IpVersion == IP_VERSION_4) {
1001 Status = IpIo->RcvToken.Ip4Token.Status;
1002 RxData = (IP_IO_IP_RX_DATA *) IpIo->RcvToken.Ip4Token.Packet.RxData;
1003 } else if (IpIo->IpVersion == IP_VERSION_6) {
1004 Status = IpIo->RcvToken.Ip6Token.Status;
1005 RxData = (IP_IO_IP_RX_DATA *) IpIo->RcvToken.Ip6Token.Packet.RxData;
1006 } else {
1007 return;
1008 }
1009
1010 if (EFI_ABORTED == Status) {
1011 //
1012 // The reception is actively aborted by the consumer, directly return.
1013 //
1014 return;
1015 }
1016
1017 if (((EFI_SUCCESS != Status) && (EFI_ICMP_ERROR != Status)) || (NULL == RxData)) {
1018 //
1019 // @bug Only process the normal packets and the icmp error packets, if RxData is NULL
1020 // @bug with Status == EFI_SUCCESS or EFI_ICMP_ERROR, just resume the receive although
1021 // @bug this should be a bug of the low layer (IP).
1022 //
1023 goto Resume;
1024 }
1025
1026 if (NULL == IpIo->PktRcvdNotify) {
1027 goto CleanUp;
1028 }
1029
1030 if (IpIo->IpVersion == IP_VERSION_4) {
1031 if ((EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress) != 0) &&
1032 !NetIp4IsUnicast (EFI_NTOHL (((EFI_IP4_RECEIVE_DATA *) RxData)->Header->SourceAddress), 0)) {
1033 //
1034 // The source address is not zero and it's not a unicast IP address, discard it.
1035 //
1036 goto CleanUp;
1037 }
1038
1039 if (RxData->Ip4RxData.DataLength == 0) {
1040 //
1041 // Discard zero length data payload packet.
1042 //
1043 goto CleanUp;
1044 }
1045
1046 //
1047 // Create a netbuffer representing IPv4 packet
1048 //
1049 Pkt = NetbufFromExt (
1050 (NET_FRAGMENT *) RxData->Ip4RxData.FragmentTable,
1051 RxData->Ip4RxData.FragmentCount,
1052 0,
1053 0,
1054 IpIoExtFree,
1055 RxData->Ip4RxData.RecycleSignal
1056 );
1057 if (NULL == Pkt) {
1058 goto CleanUp;
1059 }
1060
1061 //
1062 // Create a net session
1063 //
1064 Session.Source.Addr[0] = EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress);
1065 Session.Dest.Addr[0] = EFI_IP4 (RxData->Ip4RxData.Header->DestinationAddress);
1066 Session.IpHdr.Ip4Hdr = RxData->Ip4RxData.Header;
1067 Session.IpHdrLen = RxData->Ip4RxData.HeaderLength;
1068 Session.IpVersion = IP_VERSION_4;
1069 } else {
1070
1071 if (!NetIp6IsValidUnicast(&RxData->Ip6RxData.Header->SourceAddress)) {
1072 goto CleanUp;
1073 }
1074
1075 if (RxData->Ip6RxData.DataLength == 0) {
1076 //
1077 // Discard zero length data payload packet.
1078 //
1079 goto CleanUp;
1080 }
1081
1082 //
1083 // Create a netbuffer representing IPv6 packet
1084 //
1085 Pkt = NetbufFromExt (
1086 (NET_FRAGMENT *) RxData->Ip6RxData.FragmentTable,
1087 RxData->Ip6RxData.FragmentCount,
1088 0,
1089 0,
1090 IpIoExtFree,
1091 RxData->Ip6RxData.RecycleSignal
1092 );
1093 if (NULL == Pkt) {
1094 goto CleanUp;
1095 }
1096
1097 //
1098 // Create a net session
1099 //
1100 CopyMem (
1101 &Session.Source,
1102 &RxData->Ip6RxData.Header->SourceAddress,
1103 sizeof(EFI_IPv6_ADDRESS)
1104 );
1105 CopyMem (
1106 &Session.Dest,
1107 &RxData->Ip6RxData.Header->DestinationAddress,
1108 sizeof(EFI_IPv6_ADDRESS)
1109 );
1110 Session.IpHdr.Ip6Hdr = RxData->Ip6RxData.Header;
1111 Session.IpHdrLen = RxData->Ip6RxData.HeaderLength;
1112 Session.IpVersion = IP_VERSION_6;
1113 }
1114
1115 if (EFI_SUCCESS == Status) {
1116
1117 IpIo->PktRcvdNotify (EFI_SUCCESS, 0, &Session, Pkt, IpIo->RcvdContext);
1118 } else {
1119 //
1120 // Status is EFI_ICMP_ERROR
1121 //
1122 Status = IpIoIcmpHandler (IpIo, Pkt, &Session);
1123 if (EFI_ERROR (Status)) {
1124 NetbufFree (Pkt);
1125 }
1126 }
1127
1128 goto Resume;
1129
1130 CleanUp:
1131
1132 if (IpIo->IpVersion == IP_VERSION_4){
1133 gBS->SignalEvent (RxData->Ip4RxData.RecycleSignal);
1134 } else {
1135 gBS->SignalEvent (RxData->Ip6RxData.RecycleSignal);
1136 }
1137
1138 Resume:
1139
1140 if (IpIo->IpVersion == IP_VERSION_4){
1141 IpIo->Ip.Ip4->Receive (IpIo->Ip.Ip4, &(IpIo->RcvToken.Ip4Token));
1142 } else {
1143 IpIo->Ip.Ip6->Receive (IpIo->Ip.Ip6, &(IpIo->RcvToken.Ip6Token));
1144 }
1145 }
1146
1147 /**
1148 This function add IpIoListenHandlerDpc to the end of the DPC queue.
1149
1150 @param[in] Event The event signaled.
1151 @param[in] Context The context passed in by the event notifier.
1152
1153 **/
1154 VOID
1155 EFIAPI
1156 IpIoListenHandler (
1157 IN EFI_EVENT Event,
1158 IN VOID *Context
1159 )
1160 {
1161 //
1162 // Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK
1163 //
1164 QueueDpc (TPL_CALLBACK, IpIoListenHandlerDpc, Context);
1165 }
1166
1167
1168 /**
1169 Create a new IP_IO instance.
1170
1171 This function uses IP4/IP6 service binding protocol in Controller to create
1172 an IP4/IP6 child (aka IP4/IP6 instance).
1173
1174 @param[in] Image The image handle of the driver or application that
1175 consumes IP_IO.
1176 @param[in] Controller The controller handle that has IP4 or IP6 service
1177 binding protocol installed.
1178 @param[in] IpVersion The version of the IP protocol to use, either
1179 IPv4 or IPv6.
1180
1181 @return Pointer to a newly created IP_IO instance, or NULL if failed.
1182
1183 **/
1184 IP_IO *
1185 EFIAPI
1186 IpIoCreate (
1187 IN EFI_HANDLE Image,
1188 IN EFI_HANDLE Controller,
1189 IN UINT8 IpVersion
1190 )
1191 {
1192 EFI_STATUS Status;
1193 IP_IO *IpIo;
1194 EFI_EVENT Event;
1195
1196 ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));
1197
1198 IpIo = AllocateZeroPool (sizeof (IP_IO));
1199 if (NULL == IpIo) {
1200 return NULL;
1201 }
1202
1203 InitializeListHead (&(IpIo->PendingSndList));
1204 InitializeListHead (&(IpIo->IpList));
1205 IpIo->Controller = Controller;
1206 IpIo->Image = Image;
1207 IpIo->IpVersion = IpVersion;
1208 Event = NULL;
1209
1210 Status = gBS->CreateEvent (
1211 EVT_NOTIFY_SIGNAL,
1212 TPL_NOTIFY,
1213 IpIoListenHandler,
1214 IpIo,
1215 &Event
1216 );
1217 if (EFI_ERROR (Status)) {
1218 goto ReleaseIpIo;
1219 }
1220
1221 if (IpVersion == IP_VERSION_4) {
1222 IpIo->RcvToken.Ip4Token.Event = Event;
1223 } else {
1224 IpIo->RcvToken.Ip6Token.Event = Event;
1225 }
1226
1227 //
1228 // Create an IP child and open IP protocol
1229 //
1230 Status = IpIoCreateIpChildOpenProtocol (
1231 Controller,
1232 Image,
1233 &IpIo->ChildHandle,
1234 IpVersion,
1235 (VOID **)&(IpIo->Ip)
1236 );
1237 if (EFI_ERROR (Status)) {
1238 goto ReleaseIpIo;
1239 }
1240
1241 return IpIo;
1242
1243 ReleaseIpIo:
1244
1245 if (Event != NULL) {
1246 gBS->CloseEvent (Event);
1247 }
1248
1249 gBS->FreePool (IpIo);
1250
1251 return NULL;
1252 }
1253
1254
1255 /**
1256 Open an IP_IO instance for use.
1257
1258 This function is called after IpIoCreate(). It is used for configuring the IP
1259 instance and register the callbacks and their context data for sending and
1260 receiving IP packets.
1261
1262 @param[in, out] IpIo Pointer to an IP_IO instance that needs
1263 to open.
1264 @param[in] OpenData The configuration data and callbacks for
1265 the IP_IO instance.
1266
1267 @retval EFI_SUCCESS The IP_IO instance opened with OpenData
1268 successfully.
1269 @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to
1270 reopen it.
1271 @retval Others Error condition occurred.
1272
1273 **/
1274 EFI_STATUS
1275 EFIAPI
1276 IpIoOpen (
1277 IN OUT IP_IO *IpIo,
1278 IN IP_IO_OPEN_DATA *OpenData
1279 )
1280 {
1281 EFI_STATUS Status;
1282 UINT8 IpVersion;
1283
1284 if (IpIo->IsConfigured) {
1285 return EFI_ACCESS_DENIED;
1286 }
1287
1288 IpVersion = IpIo->IpVersion;
1289
1290 ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));
1291
1292 //
1293 // configure ip
1294 //
1295 if (IpVersion == IP_VERSION_4){
1296 //
1297 // RawData mode is no supported.
1298 //
1299 ASSERT (!OpenData->IpConfigData.Ip4CfgData.RawData);
1300 if (OpenData->IpConfigData.Ip4CfgData.RawData) {
1301 return EFI_UNSUPPORTED;
1302 }
1303
1304 Status = IpIo->Ip.Ip4->Configure (
1305 IpIo->Ip.Ip4,
1306 &OpenData->IpConfigData.Ip4CfgData
1307 );
1308 } else {
1309
1310 Status = IpIo->Ip.Ip6->Configure (
1311 IpIo->Ip.Ip6,
1312 &OpenData->IpConfigData.Ip6CfgData
1313 );
1314 }
1315
1316 if (EFI_ERROR (Status)) {
1317 return Status;
1318 }
1319
1320 //
1321 // @bug To delete the default route entry in this Ip, if it is:
1322 // @bug (0.0.0.0, 0.0.0.0, 0.0.0.0). Delete this statement if Ip modified
1323 // @bug its code
1324 //
1325 if (IpVersion == IP_VERSION_4){
1326 Status = IpIo->Ip.Ip4->Routes (
1327 IpIo->Ip.Ip4,
1328 TRUE,
1329 &mZeroIp4Addr,
1330 &mZeroIp4Addr,
1331 &mZeroIp4Addr
1332 );
1333
1334 if (EFI_ERROR (Status) && (EFI_NOT_FOUND != Status)) {
1335 return Status;
1336 }
1337 }
1338
1339 IpIo->PktRcvdNotify = OpenData->PktRcvdNotify;
1340 IpIo->PktSentNotify = OpenData->PktSentNotify;
1341
1342 IpIo->RcvdContext = OpenData->RcvdContext;
1343 IpIo->SndContext = OpenData->SndContext;
1344
1345 if (IpVersion == IP_VERSION_4){
1346 IpIo->Protocol = OpenData->IpConfigData.Ip4CfgData.DefaultProtocol;
1347
1348 //
1349 // start to listen incoming packet
1350 //
1351 Status = IpIo->Ip.Ip4->Receive (
1352 IpIo->Ip.Ip4,
1353 &(IpIo->RcvToken.Ip4Token)
1354 );
1355 if (EFI_ERROR (Status)) {
1356 IpIo->Ip.Ip4->Configure (IpIo->Ip.Ip4, NULL);
1357 goto ErrorExit;
1358 }
1359
1360 } else {
1361
1362 IpIo->Protocol = OpenData->IpConfigData.Ip6CfgData.DefaultProtocol;
1363 Status = IpIo->Ip.Ip6->Receive (
1364 IpIo->Ip.Ip6,
1365 &(IpIo->RcvToken.Ip6Token)
1366 );
1367 if (EFI_ERROR (Status)) {
1368 IpIo->Ip.Ip6->Configure (IpIo->Ip.Ip6, NULL);
1369 goto ErrorExit;
1370 }
1371 }
1372
1373 IpIo->IsConfigured = TRUE;
1374 InsertTailList (&mActiveIpIoList, &IpIo->Entry);
1375
1376 ErrorExit:
1377
1378 return Status;
1379 }
1380
1381
1382 /**
1383 Stop an IP_IO instance.
1384
1385 This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all
1386 the pending send/receive tokens will be canceled.
1387
1388 @param[in, out] IpIo Pointer to the IP_IO instance that needs to stop.
1389
1390 @retval EFI_SUCCESS The IP_IO instance stopped successfully.
1391 @retval Others Error condition occurred.
1392
1393 **/
1394 EFI_STATUS
1395 EFIAPI
1396 IpIoStop (
1397 IN OUT IP_IO *IpIo
1398 )
1399 {
1400 EFI_STATUS Status;
1401 IP_IO_IP_INFO *IpInfo;
1402 UINT8 IpVersion;
1403
1404 if (!IpIo->IsConfigured) {
1405 return EFI_SUCCESS;
1406 }
1407
1408 IpVersion = IpIo->IpVersion;
1409
1410 ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));
1411
1412 //
1413 // Remove the IpIo from the active IpIo list.
1414 //
1415 RemoveEntryList (&IpIo->Entry);
1416
1417 //
1418 // Configure NULL Ip
1419 //
1420 if (IpVersion == IP_VERSION_4) {
1421 Status = IpIo->Ip.Ip4->Configure (IpIo->Ip.Ip4, NULL);
1422 } else {
1423 Status = IpIo->Ip.Ip6->Configure (IpIo->Ip.Ip6, NULL);
1424 }
1425 if (EFI_ERROR (Status)) {
1426 return Status;
1427 }
1428
1429 IpIo->IsConfigured = FALSE;
1430
1431 //
1432 // Detroy the Ip List used by IpIo
1433 //
1434
1435 while (!IsListEmpty (&(IpIo->IpList))) {
1436 IpInfo = NET_LIST_HEAD (&(IpIo->IpList), IP_IO_IP_INFO, Entry);
1437
1438 IpIoRemoveIp (IpIo, IpInfo);
1439 }
1440
1441 //
1442 // All pending send tokens should be flushed by reseting the IP instances.
1443 //
1444 ASSERT (IsListEmpty (&IpIo->PendingSndList));
1445
1446 //
1447 // Close the receive event.
1448 //
1449 if (IpVersion == IP_VERSION_4){
1450 gBS->CloseEvent (IpIo->RcvToken.Ip4Token.Event);
1451 } else {
1452 gBS->CloseEvent (IpIo->RcvToken.Ip6Token.Event);
1453 }
1454
1455 return EFI_SUCCESS;
1456 }
1457
1458
1459 /**
1460 Destroy an IP_IO instance.
1461
1462 This function is paired with IpIoCreate(). The IP_IO will be closed first.
1463 Resource will be freed afterwards. See IpIoCloseProtocolDestroyIpChild().
1464
1465 @param[in, out] IpIo Pointer to the IP_IO instance that needs to be
1466 destroyed.
1467
1468 @retval EFI_SUCCESS The IP_IO instance destroyed successfully.
1469 @retval Others Error condition occurred.
1470
1471 **/
1472 EFI_STATUS
1473 EFIAPI
1474 IpIoDestroy (
1475 IN OUT IP_IO *IpIo
1476 )
1477 {
1478 //
1479 // Stop the IpIo.
1480 //
1481 IpIoStop (IpIo);
1482
1483 //
1484 // Close the IP protocol and destroy the child.
1485 //
1486 IpIoCloseProtocolDestroyIpChild (
1487 IpIo->Controller,
1488 IpIo->Image,
1489 IpIo->ChildHandle,
1490 IpIo->IpVersion
1491 );
1492
1493 gBS->FreePool (IpIo);
1494
1495 return EFI_SUCCESS;
1496 }
1497
1498
1499 /**
1500 Send out an IP packet.
1501
1502 This function is called after IpIoOpen(). The data to be sent are wrapped in
1503 Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
1504 overriden by Sender. Other sending configs, like source address and gateway
1505 address etc., are specified in OverrideData.
1506
1507 @param[in, out] IpIo Pointer to an IP_IO instance used for sending IP
1508 packet.
1509 @param[in, out] Pkt Pointer to the IP packet to be sent.
1510 @param[in] Sender The IP protocol instance used for sending.
1511 @param[in] Context Optional context data.
1512 @param[in] NotifyData Optional notify data.
1513 @param[in] Dest The destination IP address to send this packet to.
1514 @param[in] OverrideData The data to override some configuration of the IP
1515 instance used for sending.
1516
1517 @retval EFI_SUCCESS The operation is completed successfully.
1518 @retval EFI_NOT_STARTED The IpIo is not configured.
1519 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
1520
1521 **/
1522 EFI_STATUS
1523 EFIAPI
1524 IpIoSend (
1525 IN OUT IP_IO *IpIo,
1526 IN OUT NET_BUF *Pkt,
1527 IN IP_IO_IP_INFO *Sender OPTIONAL,
1528 IN VOID *Context OPTIONAL,
1529 IN VOID *NotifyData OPTIONAL,
1530 IN EFI_IP_ADDRESS *Dest,
1531 IN IP_IO_OVERRIDE *OverrideData OPTIONAL
1532 )
1533 {
1534 EFI_STATUS Status;
1535 IP_IO_IP_PROTOCOL Ip;
1536 IP_IO_SEND_ENTRY *SndEntry;
1537
1538 ASSERT ((IpIo->IpVersion != IP_VERSION_4) || (Dest != NULL));
1539
1540 if (!IpIo->IsConfigured) {
1541 return EFI_NOT_STARTED;
1542 }
1543
1544 Ip = (NULL == Sender) ? IpIo->Ip : Sender->Ip;
1545
1546 //
1547 // create a new SndEntry
1548 //
1549 SndEntry = IpIoCreateSndEntry (IpIo, Pkt, Ip, Context, NotifyData, Dest, OverrideData);
1550 if (NULL == SndEntry) {
1551 return EFI_OUT_OF_RESOURCES;
1552 }
1553
1554 //
1555 // Send this Packet
1556 //
1557 if (IpIo->IpVersion == IP_VERSION_4){
1558 Status = Ip.Ip4->Transmit (
1559 Ip.Ip4,
1560 &SndEntry->SndToken.Ip4Token
1561 );
1562 } else {
1563 Status = Ip.Ip6->Transmit (
1564 Ip.Ip6,
1565 &SndEntry->SndToken.Ip6Token
1566 );
1567 }
1568
1569 if (EFI_ERROR (Status)) {
1570 IpIoDestroySndEntry (SndEntry);
1571 }
1572
1573 return Status;
1574 }
1575
1576
1577 /**
1578 Cancel the IP transmit token which wraps this Packet.
1579
1580 @param[in] IpIo Pointer to the IP_IO instance.
1581 @param[in] Packet Pointer to the packet of NET_BUF to cancel.
1582
1583 **/
1584 VOID
1585 EFIAPI
1586 IpIoCancelTxToken (
1587 IN IP_IO *IpIo,
1588 IN VOID *Packet
1589 )
1590 {
1591 LIST_ENTRY *Node;
1592 IP_IO_SEND_ENTRY *SndEntry;
1593 IP_IO_IP_PROTOCOL Ip;
1594
1595 ASSERT ((IpIo != NULL) && (Packet != NULL));
1596
1597 NET_LIST_FOR_EACH (Node, &IpIo->PendingSndList) {
1598
1599 SndEntry = NET_LIST_USER_STRUCT (Node, IP_IO_SEND_ENTRY, Entry);
1600
1601 if (SndEntry->Pkt == Packet) {
1602
1603 Ip = SndEntry->Ip;
1604
1605 if (IpIo->IpVersion == IP_VERSION_4) {
1606 Ip.Ip4->Cancel (
1607 Ip.Ip4,
1608 &SndEntry->SndToken.Ip4Token
1609 );
1610 } else {
1611 Ip.Ip6->Cancel (
1612 Ip.Ip6,
1613 &SndEntry->SndToken.Ip6Token
1614 );
1615 }
1616
1617 break;
1618 }
1619 }
1620
1621 }
1622
1623
1624 /**
1625 Add a new IP instance for sending data.
1626
1627 The function is used to add the IP_IO to the IP_IO sending list. The caller
1628 can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send
1629 data.
1630
1631 @param[in, out] IpIo Pointer to a IP_IO instance to add a new IP
1632 instance for sending purpose.
1633
1634 @return Pointer to the created IP_IO_IP_INFO structure, NULL if failed.
1635
1636 **/
1637 IP_IO_IP_INFO *
1638 EFIAPI
1639 IpIoAddIp (
1640 IN OUT IP_IO *IpIo
1641 )
1642 {
1643 EFI_STATUS Status;
1644 IP_IO_IP_INFO *IpInfo;
1645 EFI_EVENT Event;
1646
1647 ASSERT (IpIo != NULL);
1648
1649 IpInfo = AllocatePool (sizeof (IP_IO_IP_INFO));
1650 if (IpInfo == NULL) {
1651 return NULL;
1652 }
1653
1654 //
1655 // Init this IpInfo, set the Addr and SubnetMask to 0 before we configure the IP
1656 // instance.
1657 //
1658 InitializeListHead (&IpInfo->Entry);
1659 IpInfo->ChildHandle = NULL;
1660 ZeroMem (&IpInfo->Addr, sizeof (IpInfo->Addr));
1661 ZeroMem (&IpInfo->PreMask, sizeof (IpInfo->PreMask));
1662
1663 IpInfo->RefCnt = 1;
1664 IpInfo->IpVersion = IpIo->IpVersion;
1665
1666 //
1667 // Create the IP instance and open the IP protocol.
1668 //
1669 Status = IpIoCreateIpChildOpenProtocol (
1670 IpIo->Controller,
1671 IpIo->Image,
1672 &IpInfo->ChildHandle,
1673 IpInfo->IpVersion,
1674 (VOID **) &IpInfo->Ip
1675 );
1676 if (EFI_ERROR (Status)) {
1677 goto ReleaseIpInfo;
1678 }
1679
1680 //
1681 // Create the event for the DummyRcvToken.
1682 //
1683 Status = gBS->CreateEvent (
1684 EVT_NOTIFY_SIGNAL,
1685 TPL_NOTIFY,
1686 IpIoDummyHandler,
1687 IpInfo,
1688 &Event
1689 );
1690 if (EFI_ERROR (Status)) {
1691 goto ReleaseIpChild;
1692 }
1693
1694 if (IpInfo->IpVersion == IP_VERSION_4) {
1695 IpInfo->DummyRcvToken.Ip4Token.Event = Event;
1696 } else {
1697 IpInfo->DummyRcvToken.Ip6Token.Event = Event;
1698 }
1699
1700 //
1701 // Link this IpInfo into the IpIo.
1702 //
1703 InsertTailList (&IpIo->IpList, &IpInfo->Entry);
1704
1705 return IpInfo;
1706
1707 ReleaseIpChild:
1708
1709 IpIoCloseProtocolDestroyIpChild (
1710 IpIo->Controller,
1711 IpIo->Image,
1712 IpInfo->ChildHandle,
1713 IpInfo->IpVersion
1714 );
1715
1716 ReleaseIpInfo:
1717
1718 gBS->FreePool (IpInfo);
1719
1720 return NULL;
1721 }
1722
1723
1724 /**
1725 Configure the IP instance of this IpInfo and start the receiving if IpConfigData
1726 is not NULL.
1727
1728 @param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance.
1729 @param[in, out] IpConfigData The IP configure data used to configure the IP
1730 instance, if NULL the IP instance is reset. If
1731 UseDefaultAddress is set to TRUE, and the configure
1732 operation succeeds, the default address information
1733 is written back in this IpConfigData.
1734
1735 @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully
1736 or no need to reconfigure it.
1737 @retval Others Configuration fails.
1738
1739 **/
1740 EFI_STATUS
1741 EFIAPI
1742 IpIoConfigIp (
1743 IN OUT IP_IO_IP_INFO *IpInfo,
1744 IN OUT VOID *IpConfigData OPTIONAL
1745 )
1746 {
1747 EFI_STATUS Status;
1748 IP_IO_IP_PROTOCOL Ip;
1749 UINT8 IpVersion;
1750 EFI_IP4_MODE_DATA Ip4ModeData;
1751 EFI_IP6_MODE_DATA Ip6ModeData;
1752
1753 ASSERT (IpInfo != NULL);
1754
1755 if (IpInfo->RefCnt > 1) {
1756 //
1757 // This IP instance is shared, don't reconfigure it until it has only one
1758 // consumer. Currently, only the tcp children cloned from their passive parent
1759 // will share the same IP. So this cases only happens while IpConfigData is NULL,
1760 // let the last consumer clean the IP instance.
1761 //
1762 return EFI_SUCCESS;
1763 }
1764
1765 IpVersion = IpInfo->IpVersion;
1766 ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));
1767
1768 Ip = IpInfo->Ip;
1769
1770 if (IpInfo->IpVersion == IP_VERSION_4) {
1771 Status = Ip.Ip4->Configure (Ip.Ip4, IpConfigData);
1772 } else {
1773 Status = Ip.Ip6->Configure (Ip.Ip6, IpConfigData);
1774 }
1775
1776 if (EFI_ERROR (Status)) {
1777 goto OnExit;
1778 }
1779
1780 if (IpConfigData != NULL) {
1781 if (IpInfo->IpVersion == IP_VERSION_4){
1782
1783 if (((EFI_IP4_CONFIG_DATA *) IpConfigData)->UseDefaultAddress) {
1784 Ip.Ip4->GetModeData (
1785 Ip.Ip4,
1786 &Ip4ModeData,
1787 NULL,
1788 NULL
1789 );
1790
1791 IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->StationAddress, &Ip4ModeData.ConfigData.StationAddress);
1792 IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->SubnetMask, &Ip4ModeData.ConfigData.SubnetMask);
1793 }
1794
1795 CopyMem (
1796 &IpInfo->Addr.Addr,
1797 &((EFI_IP4_CONFIG_DATA *) IpConfigData)->StationAddress,
1798 sizeof (IP4_ADDR)
1799 );
1800 CopyMem (
1801 &IpInfo->PreMask.SubnetMask,
1802 &((EFI_IP4_CONFIG_DATA *) IpConfigData)->SubnetMask,
1803 sizeof (IP4_ADDR)
1804 );
1805
1806 Status = Ip.Ip4->Receive (
1807 Ip.Ip4,
1808 &IpInfo->DummyRcvToken.Ip4Token
1809 );
1810 if (EFI_ERROR (Status)) {
1811 Ip.Ip4->Configure (Ip.Ip4, NULL);
1812 }
1813 } else {
1814 Ip.Ip6->GetModeData (
1815 Ip.Ip6,
1816 &Ip6ModeData,
1817 NULL,
1818 NULL
1819 );
1820
1821 if (Ip6ModeData.IsConfigured) {
1822 CopyMem (
1823 &((EFI_IP6_CONFIG_DATA *) IpConfigData)->StationAddress,
1824 &Ip6ModeData.ConfigData.StationAddress,
1825 sizeof (EFI_IPv6_ADDRESS)
1826 );
1827
1828 if (Ip6ModeData.AddressList != NULL) {
1829 FreePool (Ip6ModeData.AddressList);
1830 }
1831
1832 if (Ip6ModeData.GroupTable != NULL) {
1833 FreePool (Ip6ModeData.GroupTable);
1834 }
1835
1836 if (Ip6ModeData.RouteTable != NULL) {
1837 FreePool (Ip6ModeData.RouteTable);
1838 }
1839
1840 if (Ip6ModeData.NeighborCache != NULL) {
1841 FreePool (Ip6ModeData.NeighborCache);
1842 }
1843
1844 if (Ip6ModeData.PrefixTable != NULL) {
1845 FreePool (Ip6ModeData.PrefixTable);
1846 }
1847
1848 if (Ip6ModeData.IcmpTypeList != NULL) {
1849 FreePool (Ip6ModeData.IcmpTypeList);
1850 }
1851
1852 } else {
1853 Status = EFI_NO_MAPPING;
1854 goto OnExit;
1855 }
1856
1857 CopyMem (
1858 &IpInfo->Addr,
1859 &Ip6ModeData.ConfigData.StationAddress,
1860 sizeof (EFI_IPv6_ADDRESS)
1861 );
1862
1863 Status = Ip.Ip6->Receive (
1864 Ip.Ip6,
1865 &IpInfo->DummyRcvToken.Ip6Token
1866 );
1867 if (EFI_ERROR (Status)) {
1868 Ip.Ip6->Configure (Ip.Ip6, NULL);
1869 }
1870 }
1871 } else {
1872 //
1873 // The IP instance is reset, set the stored Addr and SubnetMask to zero.
1874 //
1875 ZeroMem (&IpInfo->Addr, sizeof (IpInfo->Addr));
1876 ZeroMem (&IpInfo->PreMask, sizeof (IpInfo->PreMask));
1877 }
1878
1879 OnExit:
1880
1881 return Status;
1882 }
1883
1884
1885 /**
1886 Destroy an IP instance maintained in IpIo->IpList for
1887 sending purpose.
1888
1889 This function pairs with IpIoAddIp(). The IpInfo is previously created by
1890 IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
1891 will be dstroyed if the RefCnt is zero.
1892
1893 @param[in] IpIo Pointer to the IP_IO instance.
1894 @param[in] IpInfo Pointer to the IpInfo to be removed.
1895
1896 **/
1897 VOID
1898 EFIAPI
1899 IpIoRemoveIp (
1900 IN IP_IO *IpIo,
1901 IN IP_IO_IP_INFO *IpInfo
1902 )
1903 {
1904
1905 UINT8 IpVersion;
1906
1907 ASSERT (IpInfo->RefCnt > 0);
1908
1909 NET_PUT_REF (IpInfo);
1910
1911 if (IpInfo->RefCnt > 0) {
1912
1913 return;
1914 }
1915
1916 IpVersion = IpIo->IpVersion;
1917
1918 ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));
1919
1920 RemoveEntryList (&IpInfo->Entry);
1921
1922 if (IpVersion == IP_VERSION_4){
1923 IpInfo->Ip.Ip4->Configure (
1924 IpInfo->Ip.Ip4,
1925 NULL
1926 );
1927 IpIoCloseProtocolDestroyIpChild (
1928 IpIo->Controller,
1929 IpIo->Image,
1930 IpInfo->ChildHandle,
1931 IP_VERSION_4
1932 );
1933
1934 gBS->CloseEvent (IpInfo->DummyRcvToken.Ip4Token.Event);
1935
1936 } else {
1937
1938 IpInfo->Ip.Ip6->Configure (
1939 IpInfo->Ip.Ip6,
1940 NULL
1941 );
1942
1943 IpIoCloseProtocolDestroyIpChild (
1944 IpIo->Controller,
1945 IpIo->Image,
1946 IpInfo->ChildHandle,
1947 IP_VERSION_6
1948 );
1949
1950 gBS->CloseEvent (IpInfo->DummyRcvToken.Ip6Token.Event);
1951 }
1952
1953 FreePool (IpInfo);
1954 }
1955
1956
1957 /**
1958 Find the first IP protocol maintained in IpIo whose local
1959 address is the same as Src.
1960
1961 This function is called when the caller needs the IpIo to send data to the
1962 specified Src. The IpIo was added previously by IpIoAddIp().
1963
1964 @param[in, out] IpIo Pointer to the pointer of the IP_IO instance.
1965 @param[in] IpVersion The version of the IP protocol to use, either
1966 IPv4 or IPv6.
1967 @param[in] Src The local IP address.
1968
1969 @return Pointer to the IP protocol can be used for sending purpose and its local
1970 address is the same with Src.
1971
1972 **/
1973 IP_IO_IP_INFO *
1974 EFIAPI
1975 IpIoFindSender (
1976 IN OUT IP_IO **IpIo,
1977 IN UINT8 IpVersion,
1978 IN EFI_IP_ADDRESS *Src
1979 )
1980 {
1981 LIST_ENTRY *IpIoEntry;
1982 IP_IO *IpIoPtr;
1983 LIST_ENTRY *IpInfoEntry;
1984 IP_IO_IP_INFO *IpInfo;
1985
1986 ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));
1987
1988 NET_LIST_FOR_EACH (IpIoEntry, &mActiveIpIoList) {
1989 IpIoPtr = NET_LIST_USER_STRUCT (IpIoEntry, IP_IO, Entry);
1990
1991 if (((*IpIo != NULL) && (*IpIo != IpIoPtr)) || (IpIoPtr->IpVersion != IpVersion)) {
1992 continue;
1993 }
1994
1995 NET_LIST_FOR_EACH (IpInfoEntry, &IpIoPtr->IpList) {
1996 IpInfo = NET_LIST_USER_STRUCT (IpInfoEntry, IP_IO_IP_INFO, Entry);
1997 if (IpInfo->IpVersion == IP_VERSION_4){
1998
1999 if (EFI_IP4_EQUAL (&IpInfo->Addr.v4, &Src->v4)) {
2000 *IpIo = IpIoPtr;
2001 return IpInfo;
2002 }
2003
2004 } else {
2005
2006 if (EFI_IP6_EQUAL (&IpInfo->Addr.v6, &Src->v6)) {
2007 *IpIo = IpIoPtr;
2008 return IpInfo;
2009 }
2010 }
2011
2012 }
2013 }
2014
2015 //
2016 // No match.
2017 //
2018 return NULL;
2019 }
2020
2021
2022 /**
2023 Get the ICMP error map information.
2024
2025 The ErrorStatus will be returned. The IsHard and Notify are optional. If they
2026 are not NULL, this routine will fill them.
2027
2028 @param[in] IcmpError IcmpError Type.
2029 @param[in] IpVersion The version of the IP protocol to use,
2030 either IPv4 or IPv6.
2031 @param[out] IsHard If TRUE, indicates that it is a hard error.
2032 @param[out] Notify If TRUE, SockError needs to be notified.
2033
2034 @return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.
2035
2036 **/
2037 EFI_STATUS
2038 EFIAPI
2039 IpIoGetIcmpErrStatus (
2040 IN UINT8 IcmpError,
2041 IN UINT8 IpVersion,
2042 OUT BOOLEAN *IsHard OPTIONAL,
2043 OUT BOOLEAN *Notify OPTIONAL
2044 )
2045 {
2046 if (IpVersion == IP_VERSION_4 ) {
2047 ASSERT (IcmpError <= ICMP_ERR_PARAMPROB);
2048
2049 if (IsHard != NULL) {
2050 *IsHard = mIcmpErrMap[IcmpError].IsHard;
2051 }
2052
2053 if (Notify != NULL) {
2054 *Notify = mIcmpErrMap[IcmpError].Notify;
2055 }
2056
2057 switch (IcmpError) {
2058 case ICMP_ERR_UNREACH_NET:
2059 return EFI_NETWORK_UNREACHABLE;
2060
2061 case ICMP_ERR_TIMXCEED_INTRANS:
2062 case ICMP_ERR_TIMXCEED_REASS:
2063 case ICMP_ERR_UNREACH_HOST:
2064 return EFI_HOST_UNREACHABLE;
2065
2066 case ICMP_ERR_UNREACH_PROTOCOL:
2067 return EFI_PROTOCOL_UNREACHABLE;
2068
2069 case ICMP_ERR_UNREACH_PORT:
2070 return EFI_PORT_UNREACHABLE;
2071
2072 case ICMP_ERR_MSGSIZE:
2073 case ICMP_ERR_UNREACH_SRCFAIL:
2074 case ICMP_ERR_QUENCH:
2075 case ICMP_ERR_PARAMPROB:
2076 return EFI_ICMP_ERROR;
2077
2078 default:
2079 ASSERT (FALSE);
2080 return EFI_UNSUPPORTED;
2081 }
2082
2083 } else if (IpVersion == IP_VERSION_6) {
2084
2085 ASSERT (IcmpError <= ICMP6_ERR_PARAMPROB_IPV6OPTION);
2086
2087 if (IsHard != NULL) {
2088 *IsHard = mIcmp6ErrMap[IcmpError].IsHard;
2089 }
2090
2091 if (Notify != NULL) {
2092 *Notify = mIcmp6ErrMap[IcmpError].Notify;
2093 }
2094
2095 switch (IcmpError) {
2096 case ICMP6_ERR_UNREACH_NET:
2097 return EFI_NETWORK_UNREACHABLE;
2098
2099 case ICMP6_ERR_UNREACH_HOST:
2100 case ICMP6_ERR_TIMXCEED_HOPLIMIT:
2101 case ICMP6_ERR_TIMXCEED_REASS:
2102 return EFI_HOST_UNREACHABLE;
2103
2104 case ICMP6_ERR_UNREACH_PROTOCOL:
2105 return EFI_PROTOCOL_UNREACHABLE;
2106
2107 case ICMP6_ERR_UNREACH_PORT:
2108 return EFI_PORT_UNREACHABLE;
2109
2110 case ICMP6_ERR_PACKAGE_TOOBIG:
2111 case ICMP6_ERR_PARAMPROB_HEADER:
2112 case ICMP6_ERR_PARAMPROB_NEXHEADER:
2113 case ICMP6_ERR_PARAMPROB_IPV6OPTION:
2114 return EFI_ICMP_ERROR;
2115
2116 default:
2117 ASSERT (FALSE);
2118 return EFI_UNSUPPORTED;
2119 }
2120
2121 } else {
2122 //
2123 // Should never be here
2124 //
2125 ASSERT (FALSE);
2126 return EFI_UNSUPPORTED;
2127 }
2128 }
2129
2130
2131 /**
2132 Refresh the remote peer's Neighbor Cache entries.
2133
2134 This function is called when the caller needs the IpIo to refresh the existing
2135 IPv6 neighbor cache entries since the neighbor is considered reachable by the
2136 node has recently received a confirmation that packets sent recently to the
2137 neighbor were received by its IP layer.
2138
2139 @param[in] IpIo Pointer to an IP_IO instance
2140 @param[in] Neighbor The IP address of the neighbor
2141 @param[in] Timeout Time in 100-ns units that this entry will
2142 remain in the neighbor cache. A value of
2143 zero means that the entry is permanent.
2144 A value of non-zero means that the entry is
2145 dynamic and will be deleted after Timeout.
2146
2147 @retval EFI_SUCCESS The operation is completed successfully.
2148 @retval EFI_NOT_STARTED The IpIo is not configured.
2149 @retval EFI_INVALID_PARAMETER Neighbor Address is invalid.
2150 @retval EFI_NOT_FOUND The neighbor cache entry is not in the
2151 neighbor table.
2152 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.
2153
2154 **/
2155 EFI_STATUS
2156 IpIoRefreshNeighbor (
2157 IN IP_IO *IpIo,
2158 IN EFI_IP_ADDRESS *Neighbor,
2159 IN UINT32 Timeout
2160 )
2161 {
2162 EFI_IP6_PROTOCOL *Ip;
2163
2164 if (!IpIo->IsConfigured || IpIo->IpVersion != IP_VERSION_6) {
2165 return EFI_NOT_STARTED;
2166 }
2167
2168 Ip = IpIo->Ip.Ip6;
2169
2170 return Ip->Neighbors (Ip, FALSE, &Neighbor->v6, NULL, Timeout, TRUE);
2171 }
2172
EFI Development Kit II mirror for PVE