2 The driver binding and service binding protocol for IP6 driver.
4 Copyright (c) 2009 - 2014, 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.
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.
18 EFI_DRIVER_BINDING_PROTOCOL gIp6DriverBinding
= {
19 Ip6DriverBindingSupported
,
20 Ip6DriverBindingStart
,
28 This is the declaration of an EFI image entry point. This entry point is
29 the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
30 both device drivers and bus drivers.
32 The entry point for IP6 driver which installs the driver
33 binding and component name protocol on its image.
35 @param[in] ImageHandle The firmware allocated handle for the UEFI image.
36 @param[in] SystemTable A pointer to the EFI System Table.
38 @retval EFI_SUCCESS The operation completed successfully.
39 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
45 IN EFI_HANDLE ImageHandle
,
46 IN EFI_SYSTEM_TABLE
*SystemTable
49 return EfiLibInstallDriverBindingComponentName2 (
60 Test to see if this driver supports ControllerHandle.
62 @param[in] This Protocol instance pointer.
63 @param[in] ControllerHandle Handle of device to test.
64 @param[in] RemainingDevicePath Optional parameter use to pick a specific child
67 @retval EFI_SUCCESS This driver supports this device.
68 @retval EFI_ALREADY_STARTED This driver is already running on this device.
69 @retval other This driver does not support this device.
74 Ip6DriverBindingSupported (
75 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
76 IN EFI_HANDLE ControllerHandle
,
77 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
81 // Test for the MNP service binding Protocol
83 return gBS
->OpenProtocol (
85 &gEfiManagedNetworkServiceBindingProtocolGuid
,
87 This
->DriverBindingHandle
,
89 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
94 Clean up an IP6 service binding instance. It releases all
95 the resource allocated by the instance. The instance may be
96 partly initialized, or partly destroyed. If a resource is
97 destroyed, it is marked as that in case the destroy failed and
98 being called again later.
100 @param[in] IpSb The IP6 service binding instance to clean up.
102 @retval EFI_SUCCESS The resource used by the instance are cleaned up.
103 @retval Others Failed to clean up some of the resources.
112 EFI_IPv6_ADDRESS AllNodes
;
113 IP6_NEIGHBOR_ENTRY
*NeighborCache
;
115 Ip6ConfigCleanInstance (&IpSb
->Ip6ConfigInstance
);
117 if (!IpSb
->LinkLocalDadFail
) {
119 // Leave link-scope all-nodes multicast address (FF02::1)
121 Ip6SetToAllNodeMulticast (FALSE
, IP6_LINK_LOCAL_SCOPE
, &AllNodes
);
123 Status
= Ip6LeaveGroup (IpSb
, &AllNodes
);
124 if (EFI_ERROR (Status
)) {
129 if (IpSb
->DefaultInterface
!= NULL
) {
130 Ip6CleanInterface (IpSb
->DefaultInterface
, NULL
);
131 IpSb
->DefaultInterface
= NULL
;
134 Ip6CleanDefaultRouterList (IpSb
);
136 Ip6CleanPrefixListTable (IpSb
, &IpSb
->OnlinkPrefix
);
137 Ip6CleanPrefixListTable (IpSb
, &IpSb
->AutonomousPrefix
);
139 if (IpSb
->RouteTable
!= NULL
) {
140 Ip6CleanRouteTable (IpSb
->RouteTable
);
141 IpSb
->RouteTable
= NULL
;
144 if (IpSb
->InterfaceId
!= NULL
) {
145 FreePool (IpSb
->InterfaceId
);
148 IpSb
->InterfaceId
= NULL
;
150 Ip6CleanAssembleTable (&IpSb
->Assemble
);
152 if (IpSb
->MnpChildHandle
!= NULL
) {
153 if (IpSb
->Mnp
!= NULL
) {
154 IpSb
->Mnp
->Cancel (IpSb
->Mnp
, NULL
);
155 IpSb
->Mnp
->Configure (IpSb
->Mnp
, NULL
);
157 IpSb
->MnpChildHandle
,
158 &gEfiManagedNetworkProtocolGuid
,
166 NetLibDestroyServiceChild (
169 &gEfiManagedNetworkServiceBindingProtocolGuid
,
173 IpSb
->MnpChildHandle
= NULL
;
176 if (IpSb
->RecvRequest
.MnpToken
.Event
!= NULL
) {
177 gBS
->CloseEvent (IpSb
->RecvRequest
.MnpToken
.Event
);
180 if (IpSb
->Timer
!= NULL
) {
181 gBS
->SetTimer (IpSb
->Timer
, TimerCancel
, 0);
182 gBS
->CloseEvent (IpSb
->Timer
);
187 if (IpSb
->FasterTimer
!= NULL
) {
188 gBS
->SetTimer (IpSb
->FasterTimer
, TimerCancel
, 0);
189 gBS
->CloseEvent (IpSb
->FasterTimer
);
191 IpSb
->FasterTimer
= NULL
;
194 // Free the Neighbor Discovery resources
196 while (!IsListEmpty (&IpSb
->NeighborTable
)) {
197 NeighborCache
= NET_LIST_HEAD (&IpSb
->NeighborTable
, IP6_NEIGHBOR_ENTRY
, Link
);
198 Ip6FreeNeighborEntry (IpSb
, NeighborCache
, FALSE
, TRUE
, EFI_SUCCESS
, NULL
, NULL
);
205 Create a new IP6 driver service binding protocol.
207 @param[in] Controller The controller that has MNP service binding
209 @param[in] ImageHandle The IP6 driver's image handle.
210 @param[out] Service The variable to receive the newly created IP6
213 @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.
214 @retval EFI_SUCCESS A new IP6 service binding private is created.
219 IN EFI_HANDLE Controller
,
220 IN EFI_HANDLE ImageHandle
,
221 OUT IP6_SERVICE
**Service
226 EFI_MANAGED_NETWORK_COMPLETION_TOKEN
*MnpToken
;
227 EFI_MANAGED_NETWORK_CONFIG_DATA
*Config
;
228 IP6_CONFIG_DATA_ITEM
*DataItem
;
230 ASSERT (Service
!= NULL
);
235 // allocate a service private data then initialize all the filed to
236 // empty resources, so if any thing goes wrong when allocating
237 // resources, Ip6CleanService can be called to clean it up.
239 IpSb
= AllocateZeroPool (sizeof (IP6_SERVICE
));
242 return EFI_OUT_OF_RESOURCES
;
245 IpSb
->Signature
= IP6_SERVICE_SIGNATURE
;
246 IpSb
->ServiceBinding
.CreateChild
= Ip6ServiceBindingCreateChild
;
247 IpSb
->ServiceBinding
.DestroyChild
= Ip6ServiceBindingDestroyChild
;
248 IpSb
->State
= IP6_SERVICE_UNSTARTED
;
250 IpSb
->NumChildren
= 0;
251 InitializeListHead (&IpSb
->Children
);
253 InitializeListHead (&IpSb
->Interfaces
);
254 IpSb
->DefaultInterface
= NULL
;
255 IpSb
->RouteTable
= NULL
;
257 IpSb
->RecvRequest
.Signature
= IP6_LINK_RX_SIGNATURE
;
258 IpSb
->RecvRequest
.CallBack
= NULL
;
259 IpSb
->RecvRequest
.Context
= NULL
;
260 MnpToken
= &IpSb
->RecvRequest
.MnpToken
;
261 MnpToken
->Event
= NULL
;
262 MnpToken
->Status
= EFI_NOT_READY
;
263 MnpToken
->Packet
.RxData
= NULL
;
265 Ip6CreateAssembleTable (&IpSb
->Assemble
);
267 IpSb
->MldCtrl
.Mldv1QuerySeen
= 0;
268 InitializeListHead (&IpSb
->MldCtrl
.Groups
);
270 ZeroMem (&IpSb
->LinkLocalAddr
, sizeof (EFI_IPv6_ADDRESS
));
271 IpSb
->LinkLocalOk
= FALSE
;
272 IpSb
->LinkLocalDadFail
= FALSE
;
273 IpSb
->Dhcp6NeedStart
= FALSE
;
274 IpSb
->Dhcp6NeedInfoRequest
= FALSE
;
276 IpSb
->CurHopLimit
= IP6_HOP_LIMIT
;
277 IpSb
->LinkMTU
= IP6_MIN_LINK_MTU
;
278 IpSb
->BaseReachableTime
= IP6_REACHABLE_TIME
;
279 Ip6UpdateReachableTime (IpSb
);
281 // RFC4861 RETRANS_TIMER: 1,000 milliseconds
283 IpSb
->RetransTimer
= IP6_RETRANS_TIMER
;
285 IpSb
->RoundRobin
= 0;
287 InitializeListHead (&IpSb
->NeighborTable
);
288 InitializeListHead (&IpSb
->DefaultRouterList
);
289 InitializeListHead (&IpSb
->OnlinkPrefix
);
290 InitializeListHead (&IpSb
->AutonomousPrefix
);
292 IpSb
->InterfaceIdLen
= IP6_IF_ID_LEN
;
293 IpSb
->InterfaceId
= NULL
;
295 IpSb
->RouterAdvertiseReceived
= FALSE
;
296 IpSb
->SolicitTimer
= IP6_MAX_RTR_SOLICITATIONS
;
299 IpSb
->Image
= ImageHandle
;
300 IpSb
->Controller
= Controller
;
302 IpSb
->MnpChildHandle
= NULL
;
305 Config
= &IpSb
->MnpConfigData
;
306 Config
->ReceivedQueueTimeoutValue
= 0;
307 Config
->TransmitQueueTimeoutValue
= 0;
308 Config
->ProtocolTypeFilter
= IP6_ETHER_PROTO
;
309 Config
->EnableUnicastReceive
= TRUE
;
310 Config
->EnableMulticastReceive
= TRUE
;
311 Config
->EnableBroadcastReceive
= TRUE
;
312 Config
->EnablePromiscuousReceive
= FALSE
;
313 Config
->FlushQueuesOnReset
= TRUE
;
314 Config
->EnableReceiveTimestamps
= FALSE
;
315 Config
->DisableBackgroundPolling
= FALSE
;
317 ZeroMem (&IpSb
->SnpMode
, sizeof (EFI_SIMPLE_NETWORK_MODE
));
320 IpSb
->FasterTimer
= NULL
;
322 ZeroMem (&IpSb
->Ip6ConfigInstance
, sizeof (IP6_CONFIG_INSTANCE
));
324 IpSb
->MacString
= NULL
;
327 // Create various resources. First create the route table, timer
328 // event, MNP token event and MNP child.
331 IpSb
->RouteTable
= Ip6CreateRouteTable ();
332 if (IpSb
->RouteTable
== NULL
) {
333 Status
= EFI_OUT_OF_RESOURCES
;
337 Status
= gBS
->CreateEvent (
338 EVT_NOTIFY_SIGNAL
| EVT_TIMER
,
344 if (EFI_ERROR (Status
)) {
348 Status
= gBS
->CreateEvent (
349 EVT_NOTIFY_SIGNAL
| EVT_TIMER
,
351 Ip6NdFasterTimerTicking
,
355 if (EFI_ERROR (Status
)) {
359 Status
= NetLibCreateServiceChild (
362 &gEfiManagedNetworkServiceBindingProtocolGuid
,
363 &IpSb
->MnpChildHandle
365 if (EFI_ERROR (Status
)) {
369 Status
= gBS
->OpenProtocol (
370 IpSb
->MnpChildHandle
,
371 &gEfiManagedNetworkProtocolGuid
,
372 (VOID
**) (&IpSb
->Mnp
),
375 EFI_OPEN_PROTOCOL_BY_DRIVER
377 if (EFI_ERROR (Status
)) {
381 Status
= Ip6ServiceConfigMnp (IpSb
, TRUE
);
382 if (EFI_ERROR (Status
)) {
386 Status
= IpSb
->Mnp
->GetModeData (IpSb
->Mnp
, NULL
, &IpSb
->SnpMode
);
387 if (EFI_ERROR (Status
)) {
391 IpSb
->MaxPacketSize
= IP6_MIN_LINK_MTU
- sizeof (EFI_IP6_HEADER
);
392 if (NetLibGetVlanId (IpSb
->Controller
) != 0) {
394 // This is a VLAN device, reduce MTU by VLAN tag length
396 IpSb
->MaxPacketSize
-= NET_VLAN_TAG_LEN
;
398 IpSb
->OldMaxPacketSize
= IpSb
->MaxPacketSize
;
401 // Currently only ETHERNET is supported in IPv6 stack, since
402 // link local address requires an IEEE 802 48-bit MACs for
403 // EUI-64 format interface identifier mapping.
405 if (IpSb
->SnpMode
.IfType
!= NET_IFTYPE_ETHERNET
) {
406 Status
= EFI_UNSUPPORTED
;
410 Status
= Ip6InitMld (IpSb
);
411 if (EFI_ERROR (Status
)) {
415 Status
= NetLibGetMacString (IpSb
->Controller
, IpSb
->Image
, &IpSb
->MacString
);
416 if (EFI_ERROR (Status
)) {
420 Status
= Ip6ConfigInitInstance (&IpSb
->Ip6ConfigInstance
);
421 if (EFI_ERROR (Status
)) {
425 IpSb
->DefaultInterface
= Ip6CreateInterface (IpSb
, TRUE
);
426 if (IpSb
->DefaultInterface
== NULL
) {
427 Status
= EFI_DEVICE_ERROR
;
431 Status
= gBS
->CreateEvent (
438 if (EFI_ERROR (Status
)) {
443 // If there is any manual address, set it.
445 DataItem
= &IpSb
->Ip6ConfigInstance
.DataItem
[Ip6ConfigDataTypeManualAddress
];
446 if (DataItem
->Data
.Ptr
!= NULL
) {
448 &IpSb
->Ip6ConfigInstance
,
455 // If there is any gateway address, set it.
457 DataItem
= &IpSb
->Ip6ConfigInstance
.DataItem
[Ip6ConfigDataTypeGateway
];
458 if (DataItem
->Data
.Ptr
!= NULL
) {
460 &IpSb
->Ip6ConfigInstance
,
466 InsertHeadList (&IpSb
->Interfaces
, &IpSb
->DefaultInterface
->Link
);
472 Ip6CleanService (IpSb
);
479 Start this driver on ControllerHandle.
481 @param[in] This Protocol instance pointer.
482 @param[in] ControllerHandle Handle of device to bind driver to.
483 @param[in] RemainingDevicePath Optional parameter used to pick a specific child
486 @retval EFI_SUCCES This driver is added to ControllerHandle.
487 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.
488 @retval other This driver does not support this device.
493 Ip6DriverBindingStart (
494 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
495 IN EFI_HANDLE ControllerHandle
,
496 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
503 // Test for the Ip6 service binding protocol
505 Status
= gBS
->OpenProtocol (
507 &gEfiIp6ServiceBindingProtocolGuid
,
509 This
->DriverBindingHandle
,
511 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
514 if (Status
== EFI_SUCCESS
) {
515 return EFI_ALREADY_STARTED
;
518 Status
= Ip6CreateService (ControllerHandle
, This
->DriverBindingHandle
, &IpSb
);
520 if (EFI_ERROR (Status
)) {
524 ASSERT (IpSb
!= NULL
);
527 // Install the Ip6ServiceBinding Protocol onto ControlerHandle
529 Status
= gBS
->InstallMultipleProtocolInterfaces (
531 &gEfiIp6ServiceBindingProtocolGuid
,
532 &IpSb
->ServiceBinding
,
533 &gEfiIp6ConfigProtocolGuid
,
534 &IpSb
->Ip6ConfigInstance
.Ip6Config
,
538 if (!EFI_ERROR (Status
)) {
540 // ready to go: start the receiving and timer
542 Status
= Ip6ReceiveFrame (Ip6AcceptFrame
, IpSb
);
543 if (EFI_ERROR (Status
)) {
548 // The timer expires every 100 (IP6_TIMER_INTERVAL_IN_MS) milliseconds.
550 Status
= gBS
->SetTimer (
553 TICKS_PER_MS
* IP6_TIMER_INTERVAL_IN_MS
555 if (EFI_ERROR (Status
)) {
560 // The timer expires every 1000 (IP6_ONE_SECOND_IN_MS) milliseconds.
562 Status
= gBS
->SetTimer (
565 TICKS_PER_MS
* IP6_ONE_SECOND_IN_MS
567 if (EFI_ERROR (Status
)) {
572 // Initialize the IP6 ID
574 mIp6Id
= NET_RANDOM (NetRandomInitSeed ());
580 Ip6CleanService (IpSb
);
586 Callback function which provided by user to remove one node in NetDestroyLinkList process.
588 @param[in] Entry The entry to be removed.
589 @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
591 @retval EFI_SUCCESS The entry has been removed successfully.
592 @retval Others Fail to remove the entry.
597 Ip6DestroyChildEntryInHandleBuffer (
598 IN LIST_ENTRY
*Entry
,
602 IP6_PROTOCOL
*IpInstance
;
603 EFI_SERVICE_BINDING_PROTOCOL
*ServiceBinding
;
604 UINTN NumberOfChildren
;
605 EFI_HANDLE
*ChildHandleBuffer
;
607 if (Entry
== NULL
|| Context
== NULL
) {
608 return EFI_INVALID_PARAMETER
;
611 IpInstance
= NET_LIST_USER_STRUCT_S (Entry
, IP6_PROTOCOL
, Link
, IP6_PROTOCOL_SIGNATURE
);
612 ServiceBinding
= ((IP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT
*) Context
)->ServiceBinding
;
613 NumberOfChildren
= ((IP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT
*) Context
)->NumberOfChildren
;
614 ChildHandleBuffer
= ((IP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT
*) Context
)->ChildHandleBuffer
;
616 if (!NetIsInHandleBuffer (IpInstance
->Handle
, NumberOfChildren
, ChildHandleBuffer
)) {
620 return ServiceBinding
->DestroyChild (ServiceBinding
, IpInstance
->Handle
);
624 Stop this driver on ControllerHandle.
626 @param[in] This Protocol instance pointer.
627 @param[in] ControllerHandle Handle of device to stop driver on.
628 @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number
629 of children is zero, stop the entire bus driver.
630 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
631 if NumberOfChildren is 0.
633 @retval EFI_SUCCESS The device was stopped.
634 @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
639 Ip6DriverBindingStop (
640 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
641 IN EFI_HANDLE ControllerHandle
,
642 IN UINTN NumberOfChildren
,
643 IN EFI_HANDLE
*ChildHandleBuffer OPTIONAL
646 EFI_SERVICE_BINDING_PROTOCOL
*ServiceBinding
;
648 EFI_HANDLE NicHandle
;
653 IP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context
;
656 NicHandle
= NetLibGetNicHandle (ControllerHandle
, &gEfiManagedNetworkProtocolGuid
);
657 if (NicHandle
== NULL
) {
658 NicHandle
= NetLibGetNicHandle (ControllerHandle
, &gEfiDhcp6ProtocolGuid
);
659 if (NicHandle
!= NULL
) {
666 Status
= gBS
->OpenProtocol (
668 &gEfiIp6ServiceBindingProtocolGuid
,
669 (VOID
**) &ServiceBinding
,
670 This
->DriverBindingHandle
,
672 EFI_OPEN_PROTOCOL_GET_PROTOCOL
674 if (EFI_ERROR (Status
)) {
675 return EFI_DEVICE_ERROR
;
678 IpSb
= IP6_SERVICE_FROM_PROTOCOL (ServiceBinding
);
681 Status
= Ip6ConfigDestroyDhcp6 (&IpSb
->Ip6ConfigInstance
);
682 gBS
->CloseEvent (IpSb
->Ip6ConfigInstance
.Dhcp6Event
);
683 IpSb
->Ip6ConfigInstance
.Dhcp6Event
= NULL
;
684 } else if (NumberOfChildren
!= 0) {
686 // NumberOfChildren is not zero, destroy the IP6 children instances in ChildHandleBuffer.
688 List
= &IpSb
->Children
;
689 Context
.ServiceBinding
= ServiceBinding
;
690 Context
.NumberOfChildren
= NumberOfChildren
;
691 Context
.ChildHandleBuffer
= ChildHandleBuffer
;
692 Status
= NetDestroyLinkList (
694 Ip6DestroyChildEntryInHandleBuffer
,
698 } else if (IsListEmpty (&IpSb
->Children
)) {
700 IpSb
->State
= IP6_SERVICE_DESTROY
;
702 Status
= Ip6CleanService (IpSb
);
703 if (EFI_ERROR (Status
)) {
708 Status
= gBS
->UninstallMultipleProtocolInterfaces (
710 &gEfiIp6ServiceBindingProtocolGuid
,
712 &gEfiIp6ConfigProtocolGuid
,
713 &IpSb
->Ip6ConfigInstance
.Ip6Config
,
716 ASSERT_EFI_ERROR (Status
);
718 Status
= EFI_SUCCESS
;
727 Creates a child handle with a set of I/O services.
729 @param[in] This Protocol instance pointer.
730 @param[in] ChildHandle Pointer to the handle of the child to create. If
731 it is NULL, then a new handle is created. If it
732 is not NULL, then the I/O services are added to
733 the existing child handle.
735 @retval EFI_SUCCES The child handle was created with the I/O services.
736 @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
738 @retval other The child handle was not created.
743 Ip6ServiceBindingCreateChild (
744 IN EFI_SERVICE_BINDING_PROTOCOL
*This
,
745 IN EFI_HANDLE
*ChildHandle
749 IP6_PROTOCOL
*IpInstance
;
754 if ((This
== NULL
) || (ChildHandle
== NULL
)) {
755 return EFI_INVALID_PARAMETER
;
758 IpSb
= IP6_SERVICE_FROM_PROTOCOL (This
);
760 if (IpSb
->LinkLocalDadFail
) {
761 return EFI_DEVICE_ERROR
;
764 IpInstance
= AllocatePool (sizeof (IP6_PROTOCOL
));
766 if (IpInstance
== NULL
) {
767 return EFI_OUT_OF_RESOURCES
;
770 Ip6InitProtocol (IpSb
, IpInstance
);
773 // Install Ip6 onto ChildHandle
775 Status
= gBS
->InstallMultipleProtocolInterfaces (
777 &gEfiIp6ProtocolGuid
,
778 &IpInstance
->Ip6Proto
,
781 if (EFI_ERROR (Status
)) {
785 IpInstance
->Handle
= *ChildHandle
;
788 // Open the Managed Network protocol BY_CHILD.
790 Status
= gBS
->OpenProtocol (
791 IpSb
->MnpChildHandle
,
792 &gEfiManagedNetworkProtocolGuid
,
794 gIp6DriverBinding
.DriverBindingHandle
,
796 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
798 if (EFI_ERROR (Status
)) {
799 gBS
->UninstallMultipleProtocolInterfaces (
801 &gEfiIp6ProtocolGuid
,
802 &IpInstance
->Ip6Proto
,
810 // Insert it into the service binding instance.
812 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
814 InsertTailList (&IpSb
->Children
, &IpInstance
->Link
);
817 gBS
->RestoreTPL (OldTpl
);
821 if (EFI_ERROR (Status
)) {
823 Ip6CleanProtocol (IpInstance
);
825 FreePool (IpInstance
);
832 Destroys a child handle with a set of I/O services.
834 @param[in] This Protocol instance pointer.
835 @param[in] ChildHandle Handle of the child to destroy.
837 @retval EFI_SUCCES The I/O services were removed from the child
839 @retval EFI_UNSUPPORTED The child handle does not support the I/O services
840 that are being removed.
841 @retval EFI_INVALID_PARAMETER Child handle is NULL.
842 @retval EFI_ACCESS_DENIED The child handle could not be destroyed because
843 its I/O services are being used.
844 @retval other The child handle was not destroyed.
849 Ip6ServiceBindingDestroyChild (
850 IN EFI_SERVICE_BINDING_PROTOCOL
*This
,
851 IN EFI_HANDLE ChildHandle
856 IP6_PROTOCOL
*IpInstance
;
857 EFI_IP6_PROTOCOL
*Ip6
;
860 if ((This
== NULL
) || (ChildHandle
== NULL
)) {
861 return EFI_INVALID_PARAMETER
;
865 // Retrieve the private context data structures
867 IpSb
= IP6_SERVICE_FROM_PROTOCOL (This
);
869 Status
= gBS
->OpenProtocol (
871 &gEfiIp6ProtocolGuid
,
873 gIp6DriverBinding
.DriverBindingHandle
,
875 EFI_OPEN_PROTOCOL_GET_PROTOCOL
878 if (EFI_ERROR (Status
)) {
879 return EFI_UNSUPPORTED
;
882 IpInstance
= IP6_INSTANCE_FROM_PROTOCOL (Ip6
);
884 if (IpInstance
->Service
!= IpSb
) {
885 return EFI_INVALID_PARAMETER
;
888 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
891 // A child can be destroyed more than once. For example,
892 // Ip6DriverBindingStop will destroy all of its children.
893 // when UDP driver is being stopped, it will destroy all
894 // the IP child it opens.
896 if (IpInstance
->InDestroy
) {
897 gBS
->RestoreTPL (OldTpl
);
901 IpInstance
->InDestroy
= TRUE
;
904 // Close the Managed Network protocol.
907 IpSb
->MnpChildHandle
,
908 &gEfiManagedNetworkProtocolGuid
,
909 gIp6DriverBinding
.DriverBindingHandle
,
914 // Uninstall the IP6 protocol first. Many thing happens during
916 // 1. The consumer of the IP6 protocol will be stopped if it
917 // opens the protocol BY_DRIVER. For eaxmple, if MNP driver is
918 // stopped, IP driver's stop function will be called, and uninstall
919 // EFI_IP6_PROTOCOL will trigger the UDP's stop function. This
920 // makes it possible to create the network stack bottom up, and
922 // 2. the upper layer will recycle the received packet. The recycle
923 // event's TPL is higher than this function. The recycle events
924 // will be called back before preceeding. If any packets not recycled,
925 // that means there is a resource leak.
927 gBS
->RestoreTPL (OldTpl
);
928 Status
= gBS
->UninstallProtocolInterface (
930 &gEfiIp6ProtocolGuid
,
931 &IpInstance
->Ip6Proto
933 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
934 if (EFI_ERROR (Status
)) {
938 Status
= Ip6CleanProtocol (IpInstance
);
939 if (EFI_ERROR (Status
)) {
940 gBS
->InstallMultipleProtocolInterfaces (
942 &gEfiIp6ProtocolGuid
,
950 RemoveEntryList (&IpInstance
->Link
);
951 ASSERT (IpSb
->NumChildren
> 0);
954 gBS
->RestoreTPL (OldTpl
);
956 FreePool (IpInstance
);
960 gBS
->RestoreTPL (OldTpl
);