]>
Commit | Line | Data |
---|---|---|
a3bcde70 HT |
1 | /** @file\r |
2 | The driver binding and service binding protocol for IP6 driver.\r | |
3 | \r | |
2d663932 | 4 | Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.<BR>\r |
c79de074 | 5 | (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r |
a3bcde70 | 6 | \r |
ecf98fbc | 7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
a3bcde70 HT |
8 | \r |
9 | **/\r | |
10 | \r | |
11 | #include "Ip6Impl.h"\r | |
12 | \r | |
d1050b9d | 13 | EFI_DRIVER_BINDING_PROTOCOL gIp6DriverBinding = {\r |
a3bcde70 HT |
14 | Ip6DriverBindingSupported,\r |
15 | Ip6DriverBindingStart,\r | |
16 | Ip6DriverBindingStop,\r | |
17 | 0xa,\r | |
18 | NULL,\r | |
19 | NULL\r | |
20 | };\r | |
21 | \r | |
c79de074 SEHM |
22 | BOOLEAN mIpSec2Installed = FALSE;\r |
23 | \r | |
24 | /**\r | |
25 | Callback function for IpSec2 Protocol install.\r | |
26 | \r | |
27 | @param[in] Event Event whose notification function is being invoked\r | |
28 | @param[in] Context Pointer to the notification function's context\r | |
29 | \r | |
c79de074 SEHM |
30 | **/\r |
31 | VOID\r | |
32 | EFIAPI\r | |
33 | IpSec2InstalledCallback (\r | |
34 | IN EFI_EVENT Event,\r | |
35 | IN VOID *Context\r | |
36 | )\r | |
37 | {\r | |
d1050b9d MK |
38 | EFI_STATUS Status;\r |
39 | \r | |
c79de074 | 40 | //\r |
9a04dcff FS |
41 | // Test if protocol was even found.\r |
42 | // Notification function will be called at least once.\r | |
c79de074 | 43 | //\r |
b80a4097 | 44 | Status = gBS->LocateProtocol (&gEfiIpSec2ProtocolGuid, NULL, (VOID **)&mIpSec);\r |
d1050b9d | 45 | if ((Status == EFI_SUCCESS) && (mIpSec != NULL)) {\r |
9a04dcff FS |
46 | //\r |
47 | // Close the event so it does not get called again.\r | |
48 | //\r | |
49 | gBS->CloseEvent (Event);\r | |
c79de074 | 50 | \r |
9a04dcff FS |
51 | mIpSec2Installed = TRUE;\r |
52 | }\r | |
c79de074 SEHM |
53 | }\r |
54 | \r | |
a3bcde70 HT |
55 | /**\r |
56 | This is the declaration of an EFI image entry point. This entry point is\r | |
57 | the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r | |
58 | both device drivers and bus drivers.\r | |
59 | \r | |
60 | The entry point for IP6 driver which installs the driver\r | |
61 | binding and component name protocol on its image.\r | |
62 | \r | |
63 | @param[in] ImageHandle The firmware allocated handle for the UEFI image.\r | |
64 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
65 | \r | |
66 | @retval EFI_SUCCESS The operation completed successfully.\r | |
67 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
68 | \r | |
69 | **/\r | |
70 | EFI_STATUS\r | |
71 | EFIAPI\r | |
72 | Ip6DriverEntryPoint (\r | |
d1050b9d MK |
73 | IN EFI_HANDLE ImageHandle,\r |
74 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
a3bcde70 HT |
75 | )\r |
76 | {\r | |
d1050b9d | 77 | VOID *Registration;\r |
c79de074 SEHM |
78 | \r |
79 | EfiCreateProtocolNotifyEvent (\r | |
80 | &gEfiIpSec2ProtocolGuid,\r | |
81 | TPL_CALLBACK,\r | |
82 | IpSec2InstalledCallback,\r | |
83 | NULL,\r | |
84 | &Registration\r | |
85 | );\r | |
86 | \r | |
a3bcde70 HT |
87 | return EfiLibInstallDriverBindingComponentName2 (\r |
88 | ImageHandle,\r | |
89 | SystemTable,\r | |
90 | &gIp6DriverBinding,\r | |
91 | ImageHandle,\r | |
92 | &gIp6ComponentName,\r | |
93 | &gIp6ComponentName2\r | |
94 | );\r | |
95 | }\r | |
96 | \r | |
97 | /**\r | |
98 | Test to see if this driver supports ControllerHandle.\r | |
99 | \r | |
100 | @param[in] This Protocol instance pointer.\r | |
101 | @param[in] ControllerHandle Handle of device to test.\r | |
102 | @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r | |
103 | device to start.\r | |
104 | \r | |
105 | @retval EFI_SUCCESS This driver supports this device.\r | |
106 | @retval EFI_ALREADY_STARTED This driver is already running on this device.\r | |
107 | @retval other This driver does not support this device.\r | |
108 | \r | |
109 | **/\r | |
110 | EFI_STATUS\r | |
111 | EFIAPI\r | |
112 | Ip6DriverBindingSupported (\r | |
113 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
114 | IN EFI_HANDLE ControllerHandle,\r | |
115 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
116 | )\r | |
117 | {\r | |
118 | //\r | |
119 | // Test for the MNP service binding Protocol\r | |
120 | //\r | |
121 | return gBS->OpenProtocol (\r | |
122 | ControllerHandle,\r | |
123 | &gEfiManagedNetworkServiceBindingProtocolGuid,\r | |
124 | NULL,\r | |
125 | This->DriverBindingHandle,\r | |
126 | ControllerHandle,\r | |
127 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
128 | );\r | |
129 | }\r | |
130 | \r | |
131 | /**\r | |
132 | Clean up an IP6 service binding instance. It releases all\r | |
133 | the resource allocated by the instance. The instance may be\r | |
134 | partly initialized, or partly destroyed. If a resource is\r | |
75dce340 | 135 | destroyed, it is marked as that in case the destroy failed and\r |
a3bcde70 HT |
136 | being called again later.\r |
137 | \r | |
138 | @param[in] IpSb The IP6 service binding instance to clean up.\r | |
139 | \r | |
140 | @retval EFI_SUCCESS The resource used by the instance are cleaned up.\r | |
141 | @retval Others Failed to clean up some of the resources.\r | |
142 | \r | |
143 | **/\r | |
144 | EFI_STATUS\r | |
145 | Ip6CleanService (\r | |
d1050b9d | 146 | IN IP6_SERVICE *IpSb\r |
a3bcde70 HT |
147 | )\r |
148 | {\r | |
d1050b9d MK |
149 | EFI_STATUS Status;\r |
150 | EFI_IPv6_ADDRESS AllNodes;\r | |
151 | IP6_NEIGHBOR_ENTRY *NeighborCache;\r | |
a3bcde70 | 152 | \r |
d1050b9d | 153 | IpSb->State = IP6_SERVICE_DESTROY;\r |
5c944a65 FS |
154 | \r |
155 | if (IpSb->Timer != NULL) {\r | |
156 | gBS->SetTimer (IpSb->Timer, TimerCancel, 0);\r | |
157 | gBS->CloseEvent (IpSb->Timer);\r | |
158 | \r | |
159 | IpSb->Timer = NULL;\r | |
160 | }\r | |
161 | \r | |
162 | if (IpSb->FasterTimer != NULL) {\r | |
163 | gBS->SetTimer (IpSb->FasterTimer, TimerCancel, 0);\r | |
164 | gBS->CloseEvent (IpSb->FasterTimer);\r | |
165 | \r | |
166 | IpSb->FasterTimer = NULL;\r | |
167 | }\r | |
168 | \r | |
a3bcde70 HT |
169 | Ip6ConfigCleanInstance (&IpSb->Ip6ConfigInstance);\r |
170 | \r | |
216f7970 | 171 | if (!IpSb->LinkLocalDadFail) {\r |
172 | //\r | |
173 | // Leave link-scope all-nodes multicast address (FF02::1)\r | |
174 | //\r | |
175 | Ip6SetToAllNodeMulticast (FALSE, IP6_LINK_LOCAL_SCOPE, &AllNodes);\r | |
a3bcde70 | 176 | \r |
216f7970 | 177 | Status = Ip6LeaveGroup (IpSb, &AllNodes);\r |
178 | if (EFI_ERROR (Status)) {\r | |
179 | return Status;\r | |
f75a7f56 | 180 | }\r |
a3bcde70 HT |
181 | }\r |
182 | \r | |
183 | if (IpSb->DefaultInterface != NULL) {\r | |
184 | Ip6CleanInterface (IpSb->DefaultInterface, NULL);\r | |
185 | IpSb->DefaultInterface = NULL;\r | |
186 | }\r | |
187 | \r | |
188 | Ip6CleanDefaultRouterList (IpSb);\r | |
189 | \r | |
190 | Ip6CleanPrefixListTable (IpSb, &IpSb->OnlinkPrefix);\r | |
191 | Ip6CleanPrefixListTable (IpSb, &IpSb->AutonomousPrefix);\r | |
192 | \r | |
193 | if (IpSb->RouteTable != NULL) {\r | |
194 | Ip6CleanRouteTable (IpSb->RouteTable);\r | |
195 | IpSb->RouteTable = NULL;\r | |
196 | }\r | |
197 | \r | |
198 | if (IpSb->InterfaceId != NULL) {\r | |
199 | FreePool (IpSb->InterfaceId);\r | |
200 | }\r | |
201 | \r | |
202 | IpSb->InterfaceId = NULL;\r | |
203 | \r | |
204 | Ip6CleanAssembleTable (&IpSb->Assemble);\r | |
205 | \r | |
206 | if (IpSb->MnpChildHandle != NULL) {\r | |
207 | if (IpSb->Mnp != NULL) {\r | |
208 | IpSb->Mnp->Cancel (IpSb->Mnp, NULL);\r | |
209 | IpSb->Mnp->Configure (IpSb->Mnp, NULL);\r | |
210 | gBS->CloseProtocol (\r | |
d1050b9d MK |
211 | IpSb->MnpChildHandle,\r |
212 | &gEfiManagedNetworkProtocolGuid,\r | |
213 | IpSb->Image,\r | |
214 | IpSb->Controller\r | |
215 | );\r | |
a3bcde70 HT |
216 | \r |
217 | IpSb->Mnp = NULL;\r | |
218 | }\r | |
219 | \r | |
220 | NetLibDestroyServiceChild (\r | |
221 | IpSb->Controller,\r | |
222 | IpSb->Image,\r | |
223 | &gEfiManagedNetworkServiceBindingProtocolGuid,\r | |
224 | IpSb->MnpChildHandle\r | |
225 | );\r | |
226 | \r | |
227 | IpSb->MnpChildHandle = NULL;\r | |
228 | }\r | |
229 | \r | |
230 | if (IpSb->RecvRequest.MnpToken.Event != NULL) {\r | |
231 | gBS->CloseEvent (IpSb->RecvRequest.MnpToken.Event);\r | |
232 | }\r | |
233 | \r | |
a3bcde70 HT |
234 | //\r |
235 | // Free the Neighbor Discovery resources\r | |
236 | //\r | |
237 | while (!IsListEmpty (&IpSb->NeighborTable)) {\r | |
238 | NeighborCache = NET_LIST_HEAD (&IpSb->NeighborTable, IP6_NEIGHBOR_ENTRY, Link);\r | |
239 | Ip6FreeNeighborEntry (IpSb, NeighborCache, FALSE, TRUE, EFI_SUCCESS, NULL, NULL);\r | |
240 | }\r | |
241 | \r | |
242 | return EFI_SUCCESS;\r | |
243 | }\r | |
244 | \r | |
245 | /**\r | |
246 | Create a new IP6 driver service binding protocol.\r | |
247 | \r | |
248 | @param[in] Controller The controller that has MNP service binding\r | |
249 | installed.\r | |
250 | @param[in] ImageHandle The IP6 driver's image handle.\r | |
251 | @param[out] Service The variable to receive the newly created IP6\r | |
252 | service.\r | |
253 | \r | |
254 | @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.\r | |
255 | @retval EFI_SUCCESS A new IP6 service binding private is created.\r | |
256 | \r | |
257 | **/\r | |
258 | EFI_STATUS\r | |
259 | Ip6CreateService (\r | |
d1050b9d MK |
260 | IN EFI_HANDLE Controller,\r |
261 | IN EFI_HANDLE ImageHandle,\r | |
262 | OUT IP6_SERVICE **Service\r | |
a3bcde70 HT |
263 | )\r |
264 | {\r | |
265 | IP6_SERVICE *IpSb;\r | |
266 | EFI_STATUS Status;\r | |
267 | EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken;\r | |
268 | EFI_MANAGED_NETWORK_CONFIG_DATA *Config;\r | |
a3bcde70 HT |
269 | \r |
270 | ASSERT (Service != NULL);\r | |
271 | \r | |
272 | *Service = NULL;\r | |
273 | \r | |
274 | //\r | |
275 | // allocate a service private data then initialize all the filed to\r | |
276 | // empty resources, so if any thing goes wrong when allocating\r | |
277 | // resources, Ip6CleanService can be called to clean it up.\r | |
278 | //\r | |
279 | IpSb = AllocateZeroPool (sizeof (IP6_SERVICE));\r | |
280 | \r | |
281 | if (IpSb == NULL) {\r | |
282 | return EFI_OUT_OF_RESOURCES;\r | |
283 | }\r | |
284 | \r | |
285 | IpSb->Signature = IP6_SERVICE_SIGNATURE;\r | |
286 | IpSb->ServiceBinding.CreateChild = Ip6ServiceBindingCreateChild;\r | |
287 | IpSb->ServiceBinding.DestroyChild = Ip6ServiceBindingDestroyChild;\r | |
288 | IpSb->State = IP6_SERVICE_UNSTARTED;\r | |
a3bcde70 | 289 | \r |
d1050b9d | 290 | IpSb->NumChildren = 0;\r |
a3bcde70 HT |
291 | InitializeListHead (&IpSb->Children);\r |
292 | \r | |
293 | InitializeListHead (&IpSb->Interfaces);\r | |
d1050b9d MK |
294 | IpSb->DefaultInterface = NULL;\r |
295 | IpSb->RouteTable = NULL;\r | |
a3bcde70 | 296 | \r |
d1050b9d MK |
297 | IpSb->RecvRequest.Signature = IP6_LINK_RX_SIGNATURE;\r |
298 | IpSb->RecvRequest.CallBack = NULL;\r | |
299 | IpSb->RecvRequest.Context = NULL;\r | |
300 | MnpToken = &IpSb->RecvRequest.MnpToken;\r | |
301 | MnpToken->Event = NULL;\r | |
302 | MnpToken->Status = EFI_NOT_READY;\r | |
303 | MnpToken->Packet.RxData = NULL;\r | |
a3bcde70 HT |
304 | \r |
305 | Ip6CreateAssembleTable (&IpSb->Assemble);\r | |
306 | \r | |
d1050b9d | 307 | IpSb->MldCtrl.Mldv1QuerySeen = 0;\r |
a3bcde70 HT |
308 | InitializeListHead (&IpSb->MldCtrl.Groups);\r |
309 | \r | |
310 | ZeroMem (&IpSb->LinkLocalAddr, sizeof (EFI_IPv6_ADDRESS));\r | |
d1050b9d MK |
311 | IpSb->LinkLocalOk = FALSE;\r |
312 | IpSb->LinkLocalDadFail = FALSE;\r | |
313 | IpSb->Dhcp6NeedStart = FALSE;\r | |
314 | IpSb->Dhcp6NeedInfoRequest = FALSE;\r | |
315 | \r | |
316 | IpSb->CurHopLimit = IP6_HOP_LIMIT;\r | |
317 | IpSb->LinkMTU = IP6_MIN_LINK_MTU;\r | |
318 | IpSb->BaseReachableTime = IP6_REACHABLE_TIME;\r | |
a3bcde70 HT |
319 | Ip6UpdateReachableTime (IpSb);\r |
320 | //\r | |
321 | // RFC4861 RETRANS_TIMER: 1,000 milliseconds\r | |
322 | //\r | |
d1050b9d | 323 | IpSb->RetransTimer = IP6_RETRANS_TIMER;\r |
a3bcde70 | 324 | \r |
d1050b9d | 325 | IpSb->RoundRobin = 0;\r |
a3bcde70 HT |
326 | \r |
327 | InitializeListHead (&IpSb->NeighborTable);\r | |
328 | InitializeListHead (&IpSb->DefaultRouterList);\r | |
329 | InitializeListHead (&IpSb->OnlinkPrefix);\r | |
330 | InitializeListHead (&IpSb->AutonomousPrefix);\r | |
331 | \r | |
d1050b9d MK |
332 | IpSb->InterfaceIdLen = IP6_IF_ID_LEN;\r |
333 | IpSb->InterfaceId = NULL;\r | |
a3bcde70 | 334 | \r |
d1050b9d MK |
335 | IpSb->RouterAdvertiseReceived = FALSE;\r |
336 | IpSb->SolicitTimer = IP6_MAX_RTR_SOLICITATIONS;\r | |
337 | IpSb->Ticks = 0;\r | |
a3bcde70 | 338 | \r |
d1050b9d MK |
339 | IpSb->Image = ImageHandle;\r |
340 | IpSb->Controller = Controller;\r | |
a3bcde70 | 341 | \r |
d1050b9d MK |
342 | IpSb->MnpChildHandle = NULL;\r |
343 | IpSb->Mnp = NULL;\r | |
a3bcde70 HT |
344 | \r |
345 | Config = &IpSb->MnpConfigData;\r | |
346 | Config->ReceivedQueueTimeoutValue = 0;\r | |
347 | Config->TransmitQueueTimeoutValue = 0;\r | |
348 | Config->ProtocolTypeFilter = IP6_ETHER_PROTO;\r | |
349 | Config->EnableUnicastReceive = TRUE;\r | |
350 | Config->EnableMulticastReceive = TRUE;\r | |
351 | Config->EnableBroadcastReceive = TRUE;\r | |
352 | Config->EnablePromiscuousReceive = FALSE;\r | |
353 | Config->FlushQueuesOnReset = TRUE;\r | |
354 | Config->EnableReceiveTimestamps = FALSE;\r | |
355 | Config->DisableBackgroundPolling = FALSE;\r | |
356 | \r | |
357 | ZeroMem (&IpSb->SnpMode, sizeof (EFI_SIMPLE_NETWORK_MODE));\r | |
358 | \r | |
d1050b9d MK |
359 | IpSb->Timer = NULL;\r |
360 | IpSb->FasterTimer = NULL;\r | |
a3bcde70 HT |
361 | \r |
362 | ZeroMem (&IpSb->Ip6ConfigInstance, sizeof (IP6_CONFIG_INSTANCE));\r | |
363 | \r | |
d1050b9d | 364 | IpSb->MacString = NULL;\r |
a3bcde70 HT |
365 | \r |
366 | //\r | |
367 | // Create various resources. First create the route table, timer\r | |
368 | // event, MNP token event and MNP child.\r | |
369 | //\r | |
370 | \r | |
371 | IpSb->RouteTable = Ip6CreateRouteTable ();\r | |
372 | if (IpSb->RouteTable == NULL) {\r | |
373 | Status = EFI_OUT_OF_RESOURCES;\r | |
374 | goto ON_ERROR;\r | |
375 | }\r | |
376 | \r | |
377 | Status = gBS->CreateEvent (\r | |
378 | EVT_NOTIFY_SIGNAL | EVT_TIMER,\r | |
379 | TPL_CALLBACK,\r | |
380 | Ip6TimerTicking,\r | |
381 | IpSb,\r | |
382 | &IpSb->Timer\r | |
383 | );\r | |
384 | if (EFI_ERROR (Status)) {\r | |
385 | goto ON_ERROR;\r | |
386 | }\r | |
387 | \r | |
388 | Status = gBS->CreateEvent (\r | |
389 | EVT_NOTIFY_SIGNAL | EVT_TIMER,\r | |
390 | TPL_CALLBACK,\r | |
391 | Ip6NdFasterTimerTicking,\r | |
392 | IpSb,\r | |
393 | &IpSb->FasterTimer\r | |
394 | );\r | |
395 | if (EFI_ERROR (Status)) {\r | |
396 | goto ON_ERROR;\r | |
397 | }\r | |
398 | \r | |
399 | Status = NetLibCreateServiceChild (\r | |
400 | Controller,\r | |
401 | ImageHandle,\r | |
402 | &gEfiManagedNetworkServiceBindingProtocolGuid,\r | |
403 | &IpSb->MnpChildHandle\r | |
404 | );\r | |
405 | if (EFI_ERROR (Status)) {\r | |
406 | goto ON_ERROR;\r | |
407 | }\r | |
408 | \r | |
409 | Status = gBS->OpenProtocol (\r | |
410 | IpSb->MnpChildHandle,\r | |
411 | &gEfiManagedNetworkProtocolGuid,\r | |
d1050b9d | 412 | (VOID **)(&IpSb->Mnp),\r |
a3bcde70 HT |
413 | ImageHandle,\r |
414 | Controller,\r | |
415 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
416 | );\r | |
417 | if (EFI_ERROR (Status)) {\r | |
418 | goto ON_ERROR;\r | |
419 | }\r | |
420 | \r | |
421 | Status = Ip6ServiceConfigMnp (IpSb, TRUE);\r | |
422 | if (EFI_ERROR (Status)) {\r | |
423 | goto ON_ERROR;\r | |
424 | }\r | |
425 | \r | |
426 | Status = IpSb->Mnp->GetModeData (IpSb->Mnp, NULL, &IpSb->SnpMode);\r | |
427 | if (EFI_ERROR (Status)) {\r | |
428 | goto ON_ERROR;\r | |
429 | }\r | |
430 | \r | |
431 | IpSb->MaxPacketSize = IP6_MIN_LINK_MTU - sizeof (EFI_IP6_HEADER);\r | |
432 | if (NetLibGetVlanId (IpSb->Controller) != 0) {\r | |
433 | //\r | |
434 | // This is a VLAN device, reduce MTU by VLAN tag length\r | |
435 | //\r | |
436 | IpSb->MaxPacketSize -= NET_VLAN_TAG_LEN;\r | |
437 | }\r | |
d1050b9d | 438 | \r |
a3bcde70 HT |
439 | IpSb->OldMaxPacketSize = IpSb->MaxPacketSize;\r |
440 | \r | |
441 | //\r | |
442 | // Currently only ETHERNET is supported in IPv6 stack, since\r | |
443 | // link local address requires an IEEE 802 48-bit MACs for\r | |
444 | // EUI-64 format interface identifier mapping.\r | |
445 | //\r | |
446 | if (IpSb->SnpMode.IfType != NET_IFTYPE_ETHERNET) {\r | |
447 | Status = EFI_UNSUPPORTED;\r | |
448 | goto ON_ERROR;\r | |
449 | }\r | |
450 | \r | |
451 | Status = Ip6InitMld (IpSb);\r | |
452 | if (EFI_ERROR (Status)) {\r | |
453 | goto ON_ERROR;\r | |
454 | }\r | |
455 | \r | |
8fedfc04 | 456 | Status = NetLibGetMacString (IpSb->Controller, IpSb->Image, &IpSb->MacString);\r |
a3bcde70 HT |
457 | if (EFI_ERROR (Status)) {\r |
458 | goto ON_ERROR;\r | |
459 | }\r | |
460 | \r | |
8fedfc04 | 461 | Status = Ip6ConfigInitInstance (&IpSb->Ip6ConfigInstance);\r |
a3bcde70 HT |
462 | if (EFI_ERROR (Status)) {\r |
463 | goto ON_ERROR;\r | |
464 | }\r | |
465 | \r | |
8fedfc04 YT |
466 | IpSb->DefaultInterface = Ip6CreateInterface (IpSb, TRUE);\r |
467 | if (IpSb->DefaultInterface == NULL) {\r | |
468 | Status = EFI_DEVICE_ERROR;\r | |
469 | goto ON_ERROR;\r | |
470 | }\r | |
a3bcde70 HT |
471 | \r |
472 | Status = gBS->CreateEvent (\r | |
473 | EVT_NOTIFY_SIGNAL,\r | |
474 | TPL_NOTIFY,\r | |
475 | Ip6OnFrameReceived,\r | |
476 | &IpSb->RecvRequest,\r | |
477 | &MnpToken->Event\r | |
478 | );\r | |
479 | if (EFI_ERROR (Status)) {\r | |
480 | goto ON_ERROR;\r | |
481 | }\r | |
482 | \r | |
a3bcde70 HT |
483 | InsertHeadList (&IpSb->Interfaces, &IpSb->DefaultInterface->Link);\r |
484 | \r | |
485 | *Service = IpSb;\r | |
486 | return EFI_SUCCESS;\r | |
487 | \r | |
488 | ON_ERROR:\r | |
489 | Ip6CleanService (IpSb);\r | |
490 | FreePool (IpSb);\r | |
491 | return Status;\r | |
492 | }\r | |
493 | \r | |
a3bcde70 HT |
494 | /**\r |
495 | Start this driver on ControllerHandle.\r | |
496 | \r | |
497 | @param[in] This Protocol instance pointer.\r | |
498 | @param[in] ControllerHandle Handle of device to bind driver to.\r | |
499 | @param[in] RemainingDevicePath Optional parameter used to pick a specific child\r | |
500 | device to start.\r | |
501 | \r | |
7de8045a | 502 | @retval EFI_SUCCESS This driver is added to ControllerHandle.\r |
a3bcde70 HT |
503 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.\r |
504 | @retval other This driver does not support this device.\r | |
505 | \r | |
506 | **/\r | |
507 | EFI_STATUS\r | |
508 | EFIAPI\r | |
509 | Ip6DriverBindingStart (\r | |
510 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
511 | IN EFI_HANDLE ControllerHandle,\r | |
512 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
513 | )\r | |
514 | {\r | |
d1050b9d MK |
515 | IP6_SERVICE *IpSb;\r |
516 | EFI_STATUS Status;\r | |
517 | EFI_IP6_CONFIG_PROTOCOL *Ip6Cfg;\r | |
518 | IP6_CONFIG_DATA_ITEM *DataItem;\r | |
4720106b JW |
519 | \r |
520 | IpSb = NULL;\r | |
521 | Ip6Cfg = NULL;\r | |
522 | DataItem = NULL;\r | |
a3bcde70 HT |
523 | \r |
524 | //\r | |
525 | // Test for the Ip6 service binding protocol\r | |
526 | //\r | |
527 | Status = gBS->OpenProtocol (\r | |
528 | ControllerHandle,\r | |
529 | &gEfiIp6ServiceBindingProtocolGuid,\r | |
530 | NULL,\r | |
531 | This->DriverBindingHandle,\r | |
532 | ControllerHandle,\r | |
533 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
534 | );\r | |
535 | \r | |
536 | if (Status == EFI_SUCCESS) {\r | |
537 | return EFI_ALREADY_STARTED;\r | |
538 | }\r | |
539 | \r | |
540 | Status = Ip6CreateService (ControllerHandle, This->DriverBindingHandle, &IpSb);\r | |
541 | \r | |
542 | if (EFI_ERROR (Status)) {\r | |
543 | return Status;\r | |
544 | }\r | |
545 | \r | |
546 | ASSERT (IpSb != NULL);\r | |
547 | \r | |
d1050b9d | 548 | Ip6Cfg = &IpSb->Ip6ConfigInstance.Ip6Config;\r |
4720106b | 549 | \r |
a3bcde70 | 550 | //\r |
7de8045a | 551 | // Install the Ip6ServiceBinding Protocol onto ControllerHandle\r |
a3bcde70 HT |
552 | //\r |
553 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
554 | &ControllerHandle,\r | |
555 | &gEfiIp6ServiceBindingProtocolGuid,\r | |
556 | &IpSb->ServiceBinding,\r | |
557 | &gEfiIp6ConfigProtocolGuid,\r | |
4720106b | 558 | Ip6Cfg,\r |
a3bcde70 HT |
559 | NULL\r |
560 | );\r | |
4720106b | 561 | if (EFI_ERROR (Status)) {\r |
2d663932 | 562 | goto FREE_SERVICE;\r |
4720106b JW |
563 | }\r |
564 | \r | |
565 | //\r | |
f75a7f56 | 566 | // Read the config data from NV variable again.\r |
4720106b JW |
567 | // The default data can be changed by other drivers.\r |
568 | //\r | |
569 | Status = Ip6ConfigReadConfigData (IpSb->MacString, &IpSb->Ip6ConfigInstance);\r | |
570 | if (EFI_ERROR (Status)) {\r | |
2d663932 | 571 | goto UNINSTALL_PROTOCOL;\r |
4720106b | 572 | }\r |
f75a7f56 | 573 | \r |
4720106b JW |
574 | //\r |
575 | // If there is any default manual address, set it.\r | |
576 | //\r | |
577 | DataItem = &IpSb->Ip6ConfigInstance.DataItem[Ip6ConfigDataTypeManualAddress];\r | |
578 | if (DataItem->Data.Ptr != NULL) {\r | |
579 | Status = Ip6Cfg->SetData (\r | |
580 | Ip6Cfg,\r | |
581 | Ip6ConfigDataTypeManualAddress,\r | |
582 | DataItem->DataSize,\r | |
583 | DataItem->Data.Ptr\r | |
584 | );\r | |
d1050b9d | 585 | if ((Status == EFI_INVALID_PARAMETER) || (Status == EFI_BAD_BUFFER_SIZE)) {\r |
a169a04f JW |
586 | //\r |
587 | // Clean the invalid ManualAddress configuration.\r | |
588 | //\r | |
589 | Status = Ip6Cfg->SetData (\r | |
590 | Ip6Cfg,\r | |
591 | Ip6ConfigDataTypeManualAddress,\r | |
592 | 0,\r | |
593 | NULL\r | |
594 | );\r | |
c49ca4a2 | 595 | DEBUG ((DEBUG_WARN, "Ip6DriverBindingStart: Clean the invalid ManualAddress configuration.\n"));\r |
4720106b JW |
596 | }\r |
597 | }\r | |
598 | \r | |
599 | //\r | |
600 | // If there is any default gateway address, set it.\r | |
601 | //\r | |
602 | DataItem = &IpSb->Ip6ConfigInstance.DataItem[Ip6ConfigDataTypeGateway];\r | |
603 | if (DataItem->Data.Ptr != NULL) {\r | |
604 | Status = Ip6Cfg->SetData (\r | |
605 | Ip6Cfg,\r | |
606 | Ip6ConfigDataTypeGateway,\r | |
607 | DataItem->DataSize,\r | |
608 | DataItem->Data.Ptr\r | |
609 | );\r | |
d1050b9d | 610 | if ((Status == EFI_INVALID_PARAMETER) || (Status == EFI_BAD_BUFFER_SIZE)) {\r |
a169a04f JW |
611 | //\r |
612 | // Clean the invalid Gateway configuration.\r | |
613 | //\r | |
614 | Status = Ip6Cfg->SetData (\r | |
615 | Ip6Cfg,\r | |
616 | Ip6ConfigDataTypeGateway,\r | |
617 | 0,\r | |
618 | NULL\r | |
619 | );\r | |
c49ca4a2 | 620 | DEBUG ((DEBUG_WARN, "Ip6DriverBindingStart: Clean the invalid Gateway configuration.\n"));\r |
4720106b JW |
621 | }\r |
622 | }\r | |
a3bcde70 | 623 | \r |
7959b067 JW |
624 | //\r |
625 | // ready to go: start the receiving and timer\r | |
626 | //\r | |
627 | Status = Ip6ReceiveFrame (Ip6AcceptFrame, IpSb);\r | |
628 | if (EFI_ERROR (Status)) {\r | |
2d663932 | 629 | goto UNINSTALL_PROTOCOL;\r |
7959b067 | 630 | }\r |
8fedfc04 | 631 | \r |
7959b067 JW |
632 | //\r |
633 | // The timer expires every 100 (IP6_TIMER_INTERVAL_IN_MS) milliseconds.\r | |
634 | //\r | |
635 | Status = gBS->SetTimer (\r | |
636 | IpSb->FasterTimer,\r | |
637 | TimerPeriodic,\r | |
638 | TICKS_PER_MS * IP6_TIMER_INTERVAL_IN_MS\r | |
639 | );\r | |
640 | if (EFI_ERROR (Status)) {\r | |
2d663932 | 641 | goto UNINSTALL_PROTOCOL;\r |
7959b067 | 642 | }\r |
8fedfc04 | 643 | \r |
7959b067 JW |
644 | //\r |
645 | // The timer expires every 1000 (IP6_ONE_SECOND_IN_MS) milliseconds.\r | |
646 | //\r | |
647 | Status = gBS->SetTimer (\r | |
648 | IpSb->Timer,\r | |
649 | TimerPeriodic,\r | |
650 | TICKS_PER_MS * IP6_ONE_SECOND_IN_MS\r | |
651 | );\r | |
652 | if (EFI_ERROR (Status)) {\r | |
2d663932 | 653 | goto UNINSTALL_PROTOCOL;\r |
f75a7f56 | 654 | }\r |
a3bcde70 | 655 | \r |
7959b067 JW |
656 | //\r |
657 | // Initialize the IP6 ID\r | |
658 | //\r | |
659 | mIp6Id = NET_RANDOM (NetRandomInitSeed ());\r | |
a3bcde70 | 660 | \r |
7959b067 | 661 | return EFI_SUCCESS;\r |
a3bcde70 | 662 | \r |
2d663932 JW |
663 | UNINSTALL_PROTOCOL:\r |
664 | gBS->UninstallMultipleProtocolInterfaces (\r | |
665 | ControllerHandle,\r | |
666 | &gEfiIp6ServiceBindingProtocolGuid,\r | |
667 | &IpSb->ServiceBinding,\r | |
668 | &gEfiIp6ConfigProtocolGuid,\r | |
669 | Ip6Cfg,\r | |
670 | NULL\r | |
671 | );\r | |
672 | \r | |
673 | FREE_SERVICE:\r | |
8fedfc04 YT |
674 | Ip6CleanService (IpSb);\r |
675 | FreePool (IpSb);\r | |
a3bcde70 HT |
676 | return Status;\r |
677 | }\r | |
678 | \r | |
216f7970 | 679 | /**\r |
680 | Callback function which provided by user to remove one node in NetDestroyLinkList process.\r | |
f75a7f56 | 681 | \r |
216f7970 | 682 | @param[in] Entry The entry to be removed.\r |
683 | @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.\r | |
684 | \r | |
685 | @retval EFI_SUCCESS The entry has been removed successfully.\r | |
686 | @retval Others Fail to remove the entry.\r | |
687 | \r | |
688 | **/\r | |
689 | EFI_STATUS\r | |
1f7eb561 | 690 | EFIAPI\r |
216f7970 | 691 | Ip6DestroyChildEntryInHandleBuffer (\r |
d1050b9d MK |
692 | IN LIST_ENTRY *Entry,\r |
693 | IN VOID *Context\r | |
1f7eb561 | 694 | )\r |
216f7970 | 695 | {\r |
696 | IP6_PROTOCOL *IpInstance;\r | |
697 | EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;\r | |
698 | UINTN NumberOfChildren;\r | |
699 | EFI_HANDLE *ChildHandleBuffer;\r | |
700 | \r | |
d1050b9d | 701 | if ((Entry == NULL) || (Context == NULL)) {\r |
216f7970 | 702 | return EFI_INVALID_PARAMETER;\r |
703 | }\r | |
704 | \r | |
d1050b9d MK |
705 | IpInstance = NET_LIST_USER_STRUCT_S (Entry, IP6_PROTOCOL, Link, IP6_PROTOCOL_SIGNATURE);\r |
706 | ServiceBinding = ((IP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ServiceBinding;\r | |
707 | NumberOfChildren = ((IP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->NumberOfChildren;\r | |
708 | ChildHandleBuffer = ((IP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ChildHandleBuffer;\r | |
216f7970 | 709 | \r |
710 | if (!NetIsInHandleBuffer (IpInstance->Handle, NumberOfChildren, ChildHandleBuffer)) {\r | |
711 | return EFI_SUCCESS;\r | |
712 | }\r | |
713 | \r | |
714 | return ServiceBinding->DestroyChild (ServiceBinding, IpInstance->Handle);\r | |
715 | }\r | |
716 | \r | |
a3bcde70 HT |
717 | /**\r |
718 | Stop this driver on ControllerHandle.\r | |
719 | \r | |
720 | @param[in] This Protocol instance pointer.\r | |
721 | @param[in] ControllerHandle Handle of device to stop driver on.\r | |
722 | @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number\r | |
723 | of children is zero, stop the entire bus driver.\r | |
724 | @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r | |
725 | if NumberOfChildren is 0.\r | |
726 | \r | |
727 | @retval EFI_SUCCESS The device was stopped.\r | |
728 | @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.\r | |
729 | \r | |
730 | **/\r | |
731 | EFI_STATUS\r | |
732 | EFIAPI\r | |
733 | Ip6DriverBindingStop (\r | |
734 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
735 | IN EFI_HANDLE ControllerHandle,\r | |
736 | IN UINTN NumberOfChildren,\r | |
737 | IN EFI_HANDLE *ChildHandleBuffer OPTIONAL\r | |
738 | )\r | |
739 | {\r | |
d1050b9d MK |
740 | EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;\r |
741 | IP6_SERVICE *IpSb;\r | |
742 | EFI_HANDLE NicHandle;\r | |
743 | EFI_STATUS Status;\r | |
744 | LIST_ENTRY *List;\r | |
745 | INTN State;\r | |
746 | BOOLEAN IsDhcp6;\r | |
747 | IP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context;\r | |
a3bcde70 HT |
748 | \r |
749 | IsDhcp6 = FALSE;\r | |
216f7970 | 750 | NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiManagedNetworkProtocolGuid);\r |
751 | if (NicHandle == NULL) {\r | |
752 | NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiDhcp6ProtocolGuid);\r | |
753 | if (NicHandle != NULL) {\r | |
754 | IsDhcp6 = TRUE;\r | |
755 | } else {\r | |
756 | return EFI_SUCCESS;\r | |
a3bcde70 HT |
757 | }\r |
758 | }\r | |
759 | \r | |
760 | Status = gBS->OpenProtocol (\r | |
761 | NicHandle,\r | |
762 | &gEfiIp6ServiceBindingProtocolGuid,\r | |
d1050b9d | 763 | (VOID **)&ServiceBinding,\r |
a3bcde70 HT |
764 | This->DriverBindingHandle,\r |
765 | NicHandle,\r | |
766 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
767 | );\r | |
768 | if (EFI_ERROR (Status)) {\r | |
769 | return EFI_DEVICE_ERROR;\r | |
770 | }\r | |
771 | \r | |
772 | IpSb = IP6_SERVICE_FROM_PROTOCOL (ServiceBinding);\r | |
773 | \r | |
a3bcde70 | 774 | if (IsDhcp6) {\r |
a3bcde70 HT |
775 | Status = Ip6ConfigDestroyDhcp6 (&IpSb->Ip6ConfigInstance);\r |
776 | gBS->CloseEvent (IpSb->Ip6ConfigInstance.Dhcp6Event);\r | |
777 | IpSb->Ip6ConfigInstance.Dhcp6Event = NULL;\r | |
216f7970 | 778 | } else if (NumberOfChildren != 0) {\r |
779 | //\r | |
780 | // NumberOfChildren is not zero, destroy the IP6 children instances in ChildHandleBuffer.\r | |
781 | //\r | |
d1050b9d | 782 | List = &IpSb->Children;\r |
216f7970 | 783 | Context.ServiceBinding = ServiceBinding;\r |
784 | Context.NumberOfChildren = NumberOfChildren;\r | |
785 | Context.ChildHandleBuffer = ChildHandleBuffer;\r | |
d1050b9d MK |
786 | Status = NetDestroyLinkList (\r |
787 | List,\r | |
788 | Ip6DestroyChildEntryInHandleBuffer,\r | |
789 | &Context,\r | |
790 | NULL\r | |
791 | );\r | |
216f7970 | 792 | } else if (IsListEmpty (&IpSb->Children)) {\r |
d1050b9d | 793 | State = IpSb->State;\r |
a3bcde70 HT |
794 | Status = Ip6CleanService (IpSb);\r |
795 | if (EFI_ERROR (Status)) {\r | |
796 | IpSb->State = State;\r | |
797 | goto Exit;\r | |
798 | }\r | |
799 | \r | |
800 | Status = gBS->UninstallMultipleProtocolInterfaces (\r | |
801 | NicHandle,\r | |
802 | &gEfiIp6ServiceBindingProtocolGuid,\r | |
803 | ServiceBinding,\r | |
804 | &gEfiIp6ConfigProtocolGuid,\r | |
805 | &IpSb->Ip6ConfigInstance.Ip6Config,\r | |
806 | NULL\r | |
807 | );\r | |
808 | ASSERT_EFI_ERROR (Status);\r | |
809 | FreePool (IpSb);\r | |
216f7970 | 810 | Status = EFI_SUCCESS;\r |
a3bcde70 | 811 | }\r |
f75a7f56 | 812 | \r |
a3bcde70 | 813 | Exit:\r |
a3bcde70 HT |
814 | return Status;\r |
815 | }\r | |
816 | \r | |
a3bcde70 HT |
817 | /**\r |
818 | Creates a child handle with a set of I/O services.\r | |
819 | \r | |
820 | @param[in] This Protocol instance pointer.\r | |
821 | @param[in] ChildHandle Pointer to the handle of the child to create. If\r | |
822 | it is NULL, then a new handle is created. If it\r | |
823 | is not NULL, then the I/O services are added to\r | |
824 | the existing child handle.\r | |
825 | \r | |
7de8045a | 826 | @retval EFI_SUCCESS The child handle was created with the I/O services.\r |
c2adf51f | 827 | @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create\r |
a3bcde70 HT |
828 | the child.\r |
829 | @retval other The child handle was not created.\r | |
830 | \r | |
831 | **/\r | |
832 | EFI_STATUS\r | |
833 | EFIAPI\r | |
834 | Ip6ServiceBindingCreateChild (\r | |
835 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
836 | IN EFI_HANDLE *ChildHandle\r | |
837 | )\r | |
838 | {\r | |
d1050b9d MK |
839 | IP6_SERVICE *IpSb;\r |
840 | IP6_PROTOCOL *IpInstance;\r | |
841 | EFI_TPL OldTpl;\r | |
842 | EFI_STATUS Status;\r | |
843 | VOID *Mnp;\r | |
a3bcde70 HT |
844 | \r |
845 | if ((This == NULL) || (ChildHandle == NULL)) {\r | |
846 | return EFI_INVALID_PARAMETER;\r | |
847 | }\r | |
848 | \r | |
d1050b9d | 849 | IpSb = IP6_SERVICE_FROM_PROTOCOL (This);\r |
a3bcde70 HT |
850 | \r |
851 | if (IpSb->LinkLocalDadFail) {\r | |
852 | return EFI_DEVICE_ERROR;\r | |
853 | }\r | |
854 | \r | |
855 | IpInstance = AllocatePool (sizeof (IP6_PROTOCOL));\r | |
856 | \r | |
857 | if (IpInstance == NULL) {\r | |
858 | return EFI_OUT_OF_RESOURCES;\r | |
859 | }\r | |
860 | \r | |
861 | Ip6InitProtocol (IpSb, IpInstance);\r | |
862 | \r | |
863 | //\r | |
864 | // Install Ip6 onto ChildHandle\r | |
865 | //\r | |
866 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
867 | ChildHandle,\r | |
868 | &gEfiIp6ProtocolGuid,\r | |
869 | &IpInstance->Ip6Proto,\r | |
870 | NULL\r | |
871 | );\r | |
872 | if (EFI_ERROR (Status)) {\r | |
873 | goto ON_ERROR;\r | |
874 | }\r | |
875 | \r | |
876 | IpInstance->Handle = *ChildHandle;\r | |
877 | \r | |
878 | //\r | |
879 | // Open the Managed Network protocol BY_CHILD.\r | |
880 | //\r | |
881 | Status = gBS->OpenProtocol (\r | |
882 | IpSb->MnpChildHandle,\r | |
883 | &gEfiManagedNetworkProtocolGuid,\r | |
d1050b9d | 884 | (VOID **)&Mnp,\r |
a3bcde70 HT |
885 | gIp6DriverBinding.DriverBindingHandle,\r |
886 | IpInstance->Handle,\r | |
887 | EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r | |
888 | );\r | |
889 | if (EFI_ERROR (Status)) {\r | |
890 | gBS->UninstallMultipleProtocolInterfaces (\r | |
bf7249df | 891 | *ChildHandle,\r |
a3bcde70 HT |
892 | &gEfiIp6ProtocolGuid,\r |
893 | &IpInstance->Ip6Proto,\r | |
894 | NULL\r | |
895 | );\r | |
896 | \r | |
897 | goto ON_ERROR;\r | |
898 | }\r | |
899 | \r | |
900 | //\r | |
901 | // Insert it into the service binding instance.\r | |
902 | //\r | |
903 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
904 | \r | |
905 | InsertTailList (&IpSb->Children, &IpInstance->Link);\r | |
906 | IpSb->NumChildren++;\r | |
907 | \r | |
908 | gBS->RestoreTPL (OldTpl);\r | |
909 | \r | |
910 | ON_ERROR:\r | |
911 | \r | |
912 | if (EFI_ERROR (Status)) {\r | |
a3bcde70 HT |
913 | Ip6CleanProtocol (IpInstance);\r |
914 | \r | |
915 | FreePool (IpInstance);\r | |
916 | }\r | |
917 | \r | |
918 | return Status;\r | |
919 | }\r | |
920 | \r | |
921 | /**\r | |
922 | Destroys a child handle with a set of I/O services.\r | |
923 | \r | |
924 | @param[in] This Protocol instance pointer.\r | |
925 | @param[in] ChildHandle Handle of the child to destroy.\r | |
926 | \r | |
7de8045a | 927 | @retval EFI_SUCCESS The I/O services were removed from the child\r |
a3bcde70 HT |
928 | handle.\r |
929 | @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r | |
930 | that are being removed.\r | |
15ee13fc | 931 | @retval EFI_INVALID_PARAMETER Child handle is NULL.\r |
a3bcde70 HT |
932 | @retval EFI_ACCESS_DENIED The child handle could not be destroyed because\r |
933 | its I/O services are being used.\r | |
934 | @retval other The child handle was not destroyed.\r | |
935 | \r | |
936 | **/\r | |
937 | EFI_STATUS\r | |
938 | EFIAPI\r | |
939 | Ip6ServiceBindingDestroyChild (\r | |
940 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
941 | IN EFI_HANDLE ChildHandle\r | |
942 | )\r | |
943 | {\r | |
d1050b9d MK |
944 | EFI_STATUS Status;\r |
945 | IP6_SERVICE *IpSb;\r | |
946 | IP6_PROTOCOL *IpInstance;\r | |
947 | EFI_IP6_PROTOCOL *Ip6;\r | |
948 | EFI_TPL OldTpl;\r | |
a3bcde70 HT |
949 | \r |
950 | if ((This == NULL) || (ChildHandle == NULL)) {\r | |
951 | return EFI_INVALID_PARAMETER;\r | |
952 | }\r | |
953 | \r | |
954 | //\r | |
955 | // Retrieve the private context data structures\r | |
956 | //\r | |
d1050b9d | 957 | IpSb = IP6_SERVICE_FROM_PROTOCOL (This);\r |
a3bcde70 HT |
958 | \r |
959 | Status = gBS->OpenProtocol (\r | |
960 | ChildHandle,\r | |
961 | &gEfiIp6ProtocolGuid,\r | |
d1050b9d | 962 | (VOID **)&Ip6,\r |
a3bcde70 HT |
963 | gIp6DriverBinding.DriverBindingHandle,\r |
964 | ChildHandle,\r | |
965 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
966 | );\r | |
967 | \r | |
968 | if (EFI_ERROR (Status)) {\r | |
969 | return EFI_UNSUPPORTED;\r | |
970 | }\r | |
971 | \r | |
972 | IpInstance = IP6_INSTANCE_FROM_PROTOCOL (Ip6);\r | |
973 | \r | |
974 | if (IpInstance->Service != IpSb) {\r | |
975 | return EFI_INVALID_PARAMETER;\r | |
976 | }\r | |
977 | \r | |
978 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
979 | \r | |
980 | //\r | |
981 | // A child can be destroyed more than once. For example,\r | |
75dce340 | 982 | // Ip6DriverBindingStop will destroy all of its children.\r |
983 | // when UDP driver is being stopped, it will destroy all\r | |
a3bcde70 HT |
984 | // the IP child it opens.\r |
985 | //\r | |
216f7970 | 986 | if (IpInstance->InDestroy) {\r |
a3bcde70 HT |
987 | gBS->RestoreTPL (OldTpl);\r |
988 | return EFI_SUCCESS;\r | |
989 | }\r | |
990 | \r | |
216f7970 | 991 | IpInstance->InDestroy = TRUE;\r |
a3bcde70 HT |
992 | \r |
993 | //\r | |
994 | // Close the Managed Network protocol.\r | |
995 | //\r | |
996 | gBS->CloseProtocol (\r | |
997 | IpSb->MnpChildHandle,\r | |
998 | &gEfiManagedNetworkProtocolGuid,\r | |
999 | gIp6DriverBinding.DriverBindingHandle,\r | |
1000 | ChildHandle\r | |
1001 | );\r | |
1002 | \r | |
1003 | //\r | |
1004 | // Uninstall the IP6 protocol first. Many thing happens during\r | |
1005 | // this:\r | |
1006 | // 1. The consumer of the IP6 protocol will be stopped if it\r | |
7de8045a | 1007 | // opens the protocol BY_DRIVER. For example, if MNP driver is\r |
a3bcde70 HT |
1008 | // stopped, IP driver's stop function will be called, and uninstall\r |
1009 | // EFI_IP6_PROTOCOL will trigger the UDP's stop function. This\r | |
1010 | // makes it possible to create the network stack bottom up, and\r | |
1011 | // stop it top down.\r | |
1012 | // 2. the upper layer will recycle the received packet. The recycle\r | |
1013 | // event's TPL is higher than this function. The recycle events\r | |
7de8045a | 1014 | // will be called back before preceding. If any packets not recycled,\r |
a3bcde70 HT |
1015 | // that means there is a resource leak.\r |
1016 | //\r | |
216f7970 | 1017 | gBS->RestoreTPL (OldTpl);\r |
a3bcde70 HT |
1018 | Status = gBS->UninstallProtocolInterface (\r |
1019 | ChildHandle,\r | |
1020 | &gEfiIp6ProtocolGuid,\r | |
1021 | &IpInstance->Ip6Proto\r | |
1022 | );\r | |
216f7970 | 1023 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
a3bcde70 HT |
1024 | if (EFI_ERROR (Status)) {\r |
1025 | goto ON_ERROR;\r | |
1026 | }\r | |
1027 | \r | |
1028 | Status = Ip6CleanProtocol (IpInstance);\r | |
a3bcde70 HT |
1029 | if (EFI_ERROR (Status)) {\r |
1030 | gBS->InstallMultipleProtocolInterfaces (\r | |
1031 | &ChildHandle,\r | |
1032 | &gEfiIp6ProtocolGuid,\r | |
1033 | Ip6,\r | |
1034 | NULL\r | |
1035 | );\r | |
1036 | \r | |
1037 | goto ON_ERROR;\r | |
1038 | }\r | |
1039 | \r | |
1040 | RemoveEntryList (&IpInstance->Link);\r | |
1041 | ASSERT (IpSb->NumChildren > 0);\r | |
1042 | IpSb->NumChildren--;\r | |
1043 | \r | |
1044 | gBS->RestoreTPL (OldTpl);\r | |
1045 | \r | |
1046 | FreePool (IpInstance);\r | |
1047 | return EFI_SUCCESS;\r | |
1048 | \r | |
1049 | ON_ERROR:\r | |
a3bcde70 HT |
1050 | gBS->RestoreTPL (OldTpl);\r |
1051 | \r | |
1052 | return Status;\r | |
1053 | }\r |