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