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