]>
Commit | Line | Data |
---|---|---|
772db4bb | 1 | /** @file\r |
3e8c18da | 2 | The driver binding and service binding protocol for IP4 driver.\r |
3 | \r | |
a1503a32 | 4 | Copyright (c) 2005 - 2009, Intel Corporation.<BR>\r |
772db4bb | 5 | All rights reserved. This program and the accompanying materials\r |
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 | |
30 | \r | |
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 | |
121 | destroyed, it is marked as that in case the destory failed and\r | |
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 | |
179 | IpSb->InDestory = FALSE;\r | |
180 | \r | |
181 | IpSb->NumChildren = 0;\r | |
e48e37fc | 182 | InitializeListHead (&IpSb->Children);\r |
772db4bb | 183 | \r |
e48e37fc | 184 | InitializeListHead (&IpSb->Interfaces);\r |
772db4bb | 185 | IpSb->DefaultInterface = NULL;\r |
186 | IpSb->DefaultRouteTable = NULL;\r | |
187 | \r | |
188 | Ip4InitAssembleTable (&IpSb->Assemble);\r | |
189 | \r | |
190 | IpSb->IgmpCtrl.Igmpv1QuerySeen = 0;\r | |
e48e37fc | 191 | InitializeListHead (&IpSb->IgmpCtrl.Groups);\r |
772db4bb | 192 | \r |
193 | IpSb->Image = ImageHandle;\r | |
194 | IpSb->Controller = Controller;\r | |
195 | \r | |
196 | IpSb->MnpChildHandle = NULL;\r | |
197 | IpSb->Mnp = NULL;\r | |
198 | \r | |
199 | IpSb->MnpConfigData.ReceivedQueueTimeoutValue = 0;\r | |
200 | IpSb->MnpConfigData.TransmitQueueTimeoutValue = 0;\r | |
201 | IpSb->MnpConfigData.ProtocolTypeFilter = IP4_ETHER_PROTO;\r | |
202 | IpSb->MnpConfigData.EnableUnicastReceive = TRUE;\r | |
203 | IpSb->MnpConfigData.EnableMulticastReceive = TRUE;\r | |
204 | IpSb->MnpConfigData.EnableBroadcastReceive = TRUE;\r | |
205 | IpSb->MnpConfigData.EnablePromiscuousReceive = FALSE;\r | |
206 | IpSb->MnpConfigData.FlushQueuesOnReset = TRUE;\r | |
207 | IpSb->MnpConfigData.EnableReceiveTimestamps = FALSE;\r | |
208 | IpSb->MnpConfigData.DisableBackgroundPolling = FALSE;\r | |
209 | \r | |
e48e37fc | 210 | ZeroMem (&IpSb->SnpMode, sizeof (EFI_SIMPLE_NETWORK_MODE));\r |
772db4bb | 211 | \r |
212 | IpSb->Timer = NULL;\r | |
213 | IpSb->Ip4Config = NULL;\r | |
214 | IpSb->DoneEvent = NULL;\r | |
215 | IpSb->ReconfigEvent = NULL;\r | |
36ee91ca | 216 | IpSb->ActiveEvent = NULL;\r |
772db4bb | 217 | \r |
218 | //\r | |
219 | // Create various resources. First create the route table, timer\r | |
220 | // event and MNP child. IGMP, interface's initialization depend\r | |
221 | // on the MNP child.\r | |
222 | //\r | |
223 | IpSb->DefaultRouteTable = Ip4CreateRouteTable ();\r | |
224 | \r | |
225 | if (IpSb->DefaultRouteTable == NULL) {\r | |
226 | Status = EFI_OUT_OF_RESOURCES;\r | |
227 | goto ON_ERROR;\r | |
228 | }\r | |
229 | \r | |
230 | Status = gBS->CreateEvent (\r | |
231 | EVT_NOTIFY_SIGNAL | EVT_TIMER,\r | |
e48e37fc | 232 | TPL_CALLBACK,\r |
772db4bb | 233 | Ip4TimerTicking,\r |
234 | IpSb,\r | |
235 | &IpSb->Timer\r | |
236 | );\r | |
237 | \r | |
238 | if (EFI_ERROR (Status)) {\r | |
239 | goto ON_ERROR;\r | |
240 | }\r | |
241 | \r | |
242 | Status = NetLibCreateServiceChild (\r | |
243 | Controller,\r | |
244 | ImageHandle,\r | |
245 | &gEfiManagedNetworkServiceBindingProtocolGuid,\r | |
246 | &IpSb->MnpChildHandle\r | |
247 | );\r | |
248 | \r | |
249 | if (EFI_ERROR (Status)) {\r | |
250 | goto ON_ERROR;\r | |
251 | }\r | |
252 | \r | |
253 | Status = gBS->OpenProtocol (\r | |
254 | IpSb->MnpChildHandle,\r | |
255 | &gEfiManagedNetworkProtocolGuid,\r | |
256 | (VOID **) &IpSb->Mnp,\r | |
257 | ImageHandle,\r | |
258 | Controller,\r | |
259 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
260 | );\r | |
261 | \r | |
262 | if (EFI_ERROR (Status)) {\r | |
263 | goto ON_ERROR;\r | |
264 | }\r | |
265 | \r | |
266 | Status = Ip4ServiceConfigMnp (IpSb, TRUE);\r | |
267 | \r | |
268 | if (EFI_ERROR (Status)) {\r | |
269 | goto ON_ERROR;\r | |
270 | }\r | |
271 | \r | |
272 | Status = IpSb->Mnp->GetModeData (IpSb->Mnp, NULL, &IpSb->SnpMode);\r | |
273 | \r | |
274 | if (EFI_ERROR (Status)) {\r | |
275 | goto ON_ERROR;\r | |
276 | }\r | |
277 | \r | |
278 | Status = Ip4InitIgmp (IpSb);\r | |
279 | \r | |
280 | if (EFI_ERROR (Status)) {\r | |
281 | goto ON_ERROR;\r | |
282 | }\r | |
283 | \r | |
284 | IpSb->DefaultInterface = Ip4CreateInterface (IpSb->Mnp, Controller, ImageHandle);\r | |
285 | \r | |
286 | if (IpSb->DefaultInterface == NULL) {\r | |
287 | Status = EFI_OUT_OF_RESOURCES;\r | |
288 | goto ON_ERROR;\r | |
289 | }\r | |
290 | \r | |
e48e37fc | 291 | InsertHeadList (&IpSb->Interfaces, &IpSb->DefaultInterface->Link);\r |
772db4bb | 292 | \r |
a1503a32 | 293 | IpSb->MaxPacketSize = IpSb->SnpMode.MaxPacketSize - sizeof (IP4_HEAD);\r |
779ae357 | 294 | if (NetLibGetVlanId (IpSb->Controller) != 0) {\r |
295 | //\r | |
296 | // This is a VLAN device, reduce MTU by VLAN tag length\r | |
297 | //\r | |
298 | IpSb->MaxPacketSize -= NET_VLAN_TAG_LEN;\r | |
299 | }\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 |
317 | destroyed, it is marked as that in case the destory 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 | |
398 | \r | |
399 | /**\r | |
5405e9a6 | 400 | Start this driver on ControllerHandle. This service is called by the\r |
401 | EFI boot service ConnectController(). In order to make\r | |
402 | drivers as small as possible, there are a few calling restrictions for\r | |
403 | this service. ConnectController() must follow these\r | |
404 | calling restrictions. If any other agent wishes to call Start() it\r | |
405 | must also follow these calling restrictions.\r | |
406 | \r | |
3e8c18da | 407 | @param[in] This Protocol instance pointer.\r |
408 | @param[in] ControllerHandle Handle of device to bind driver to\r | |
409 | @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r | |
410 | device to start.\r | |
5405e9a6 | 411 | \r |
412 | @retval EFI_SUCCESS This driver is added to ControllerHandle\r | |
413 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r | |
414 | @retval other This driver does not support this device\r | |
772db4bb | 415 | \r |
416 | **/\r | |
417 | EFI_STATUS\r | |
418 | EFIAPI\r | |
419 | Ip4DriverBindingStart (\r | |
420 | IN EFI_DRIVER_BINDING_PROTOCOL * This,\r | |
421 | IN EFI_HANDLE ControllerHandle,\r | |
422 | IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r | |
423 | )\r | |
424 | {\r | |
425 | IP4_SERVICE *IpSb;\r | |
426 | EFI_STATUS Status;\r | |
427 | \r | |
428 | //\r | |
429 | // Test for the Ip4 service binding protocol\r | |
430 | //\r | |
431 | Status = gBS->OpenProtocol (\r | |
432 | ControllerHandle,\r | |
433 | &gEfiIp4ServiceBindingProtocolGuid,\r | |
434 | NULL,\r | |
435 | This->DriverBindingHandle,\r | |
436 | ControllerHandle,\r | |
437 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
438 | );\r | |
439 | \r | |
440 | if (Status == EFI_SUCCESS) {\r | |
441 | return EFI_ALREADY_STARTED;\r | |
442 | }\r | |
443 | \r | |
444 | Status = Ip4CreateService (ControllerHandle, This->DriverBindingHandle, &IpSb);\r | |
445 | \r | |
446 | if (EFI_ERROR (Status)) {\r | |
447 | return Status;\r | |
448 | }\r | |
449 | \r | |
450 | //\r | |
451 | // Install the Ip4ServiceBinding Protocol onto ControlerHandle\r | |
452 | //\r | |
453 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
454 | &ControllerHandle,\r | |
455 | &gEfiIp4ServiceBindingProtocolGuid,\r | |
456 | &IpSb->ServiceBinding,\r | |
457 | NULL\r | |
458 | );\r | |
459 | \r | |
460 | if (EFI_ERROR (Status)) {\r | |
461 | goto FREE_SERVICE;\r | |
462 | }\r | |
463 | \r | |
464 | //\r | |
465 | // ready to go: start the receiving and timer\r | |
466 | //\r | |
467 | Status = Ip4ReceiveFrame (IpSb->DefaultInterface, NULL, Ip4AccpetFrame, IpSb);\r | |
468 | \r | |
469 | if (EFI_ERROR (Status)) {\r | |
470 | goto UNINSTALL_PROTOCOL;\r | |
471 | }\r | |
472 | \r | |
473 | Status = gBS->SetTimer (IpSb->Timer, TimerPeriodic, TICKS_PER_SECOND);\r | |
474 | \r | |
475 | if (EFI_ERROR (Status)) {\r | |
476 | goto UNINSTALL_PROTOCOL;\r | |
477 | }\r | |
478 | \r | |
479 | //\r | |
480 | // Initialize the IP4 ID\r | |
481 | //\r | |
482 | mIp4Id = (UINT16)NET_RANDOM (NetRandomInitSeed ());\r | |
483 | \r | |
484 | Ip4SetVariableData (IpSb);\r | |
485 | \r | |
486 | return Status;\r | |
487 | \r | |
488 | UNINSTALL_PROTOCOL:\r | |
489 | gBS->UninstallProtocolInterface (\r | |
490 | ControllerHandle,\r | |
491 | &gEfiIp4ServiceBindingProtocolGuid,\r | |
492 | &IpSb->ServiceBinding\r | |
493 | );\r | |
494 | \r | |
495 | FREE_SERVICE:\r | |
496 | Ip4CleanService (IpSb);\r | |
766c7483 | 497 | FreePool (IpSb);\r |
772db4bb | 498 | \r |
499 | return Status;\r | |
500 | }\r | |
501 | \r | |
502 | \r | |
503 | /**\r | |
5405e9a6 | 504 | Stop this driver on ControllerHandle. This service is called by the\r |
505 | EFI boot service DisconnectController(). In order to\r | |
506 | make drivers as small as possible, there are a few calling\r | |
507 | restrictions for this service. DisconnectController()\r | |
508 | must follow these calling restrictions. If any other agent wishes\r | |
509 | to call Stop() it must also follow these calling restrictions.\r | |
510 | \r | |
3e8c18da | 511 | @param[in] This Protocol instance pointer.\r |
512 | @param[in] ControllerHandle Handle of device to stop driver on\r | |
513 | @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number\r | |
514 | of children is zero stop the entire bus driver.\r | |
515 | @param[in] ChildHandleBuffer List of Child Handles to Stop.\r | |
5405e9a6 | 516 | \r |
3e8c18da | 517 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r |
518 | @retval other This driver was not removed from this device\r | |
772db4bb | 519 | \r |
520 | **/\r | |
521 | EFI_STATUS\r | |
522 | EFIAPI\r | |
523 | Ip4DriverBindingStop (\r | |
524 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
525 | IN EFI_HANDLE ControllerHandle,\r | |
526 | IN UINTN NumberOfChildren,\r | |
527 | IN EFI_HANDLE *ChildHandleBuffer\r | |
528 | )\r | |
529 | {\r | |
530 | EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;\r | |
531 | IP4_SERVICE *IpSb;\r | |
532 | IP4_PROTOCOL *IpInstance;\r | |
533 | EFI_HANDLE NicHandle;\r | |
534 | EFI_STATUS Status;\r | |
535 | EFI_TPL OldTpl;\r | |
536 | INTN State;\r | |
c4a62a12 | 537 | BOOLEAN IsArp;\r |
772db4bb | 538 | \r |
539 | //\r | |
540 | // IP4 driver opens the MNP child, ARP children or the IP4_CONFIG protocol\r | |
541 | // by driver. So the ControllerHandle may be the MNP child handle, ARP child\r | |
542 | // handle, or the NIC (UNDI) handle because IP4_CONFIG protocol is installed\r | |
543 | // in the NIC handle.\r | |
544 | //\r | |
545 | //\r | |
546 | // First, check whether it is the IP4_CONFIG protocol being uninstalled.\r | |
547 | // IP4_CONFIG protocol is installed on the NIC handle. It isn't necessary\r | |
548 | // to clean up the default configuration if IP4_CONFIG is being stopped.\r | |
549 | //\r | |
550 | Status = gBS->OpenProtocol (\r | |
551 | ControllerHandle,\r | |
552 | &gEfiIp4ConfigProtocolGuid,\r | |
553 | NULL,\r | |
554 | This->DriverBindingHandle,\r | |
555 | ControllerHandle,\r | |
556 | EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r | |
557 | );\r | |
558 | \r | |
559 | if (Status == EFI_SUCCESS) {\r | |
560 | //\r | |
561 | // Retrieve the IP4 service binding protocol. If failed, it is\r | |
562 | // likely that Ip4 ServiceBinding is uninstalled already. In this\r | |
563 | // case, return immediately.\r | |
564 | //\r | |
565 | Status = gBS->OpenProtocol (\r | |
566 | ControllerHandle,\r | |
567 | &gEfiIp4ServiceBindingProtocolGuid,\r | |
568 | (VOID **) &ServiceBinding,\r | |
569 | This->DriverBindingHandle,\r | |
570 | ControllerHandle,\r | |
571 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
572 | );\r | |
573 | \r | |
574 | if (EFI_ERROR (Status)) {\r | |
c4a62a12 | 575 | return EFI_DEVICE_ERROR;\r |
772db4bb | 576 | }\r |
577 | \r | |
578 | IpSb = IP4_SERVICE_FROM_PROTOCOL (ServiceBinding);\r | |
579 | \r | |
e48e37fc | 580 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 581 | \r |
5405e9a6 | 582 | if (IpSb->Ip4Config != NULL && (IpSb->State != IP4_SERVICE_DESTORY)) {\r |
772db4bb | 583 | \r |
584 | IpSb->Ip4Config->Stop (IpSb->Ip4Config);\r | |
585 | \r | |
586 | Status = gBS->CloseProtocol (\r | |
587 | ControllerHandle,\r | |
588 | &gEfiIp4ConfigProtocolGuid,\r | |
589 | IpSb->Image,\r | |
590 | ControllerHandle\r | |
591 | );\r | |
592 | \r | |
593 | if (EFI_ERROR (Status)) {\r | |
e48e37fc | 594 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 595 | return Status;\r |
596 | }\r | |
597 | \r | |
598 | //\r | |
599 | // If the auto configure hasn't complete, mark it as not started.\r | |
600 | //\r | |
601 | if (IpSb->State == IP4_SERVICE_STARTED) {\r | |
602 | IpSb->State = IP4_SERVICE_UNSTARTED;\r | |
603 | }\r | |
604 | \r | |
605 | IpSb->Ip4Config = NULL;\r | |
606 | gBS->CloseEvent (IpSb->DoneEvent);\r | |
607 | gBS->CloseEvent (IpSb->ReconfigEvent);\r | |
608 | }\r | |
609 | \r | |
e48e37fc | 610 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 611 | return EFI_SUCCESS;\r |
612 | }\r | |
613 | \r | |
614 | //\r | |
615 | // Either MNP or ARP protocol is being uninstalled. The controller\r | |
616 | // handle is either the MNP child or ARP child. But, the IP4's\r | |
617 | // service binding is installed on the NIC handle. So, need to open\r | |
618 | // the protocol info to find the NIC handle.\r | |
619 | //\r | |
c4a62a12 | 620 | IsArp = FALSE;\r |
772db4bb | 621 | NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiManagedNetworkProtocolGuid);\r |
622 | \r | |
623 | if (NicHandle == NULL) {\r | |
624 | NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiArpProtocolGuid);\r | |
c4a62a12 | 625 | IsArp = TRUE;\r |
772db4bb | 626 | }\r |
627 | \r | |
628 | if (NicHandle == NULL) {\r | |
c4a62a12 | 629 | return EFI_DEVICE_ERROR;\r |
772db4bb | 630 | }\r |
631 | \r | |
632 | //\r | |
633 | // Retrieve the IP4 service binding protocol\r | |
634 | //\r | |
635 | Status = gBS->OpenProtocol (\r | |
636 | NicHandle,\r | |
637 | &gEfiIp4ServiceBindingProtocolGuid,\r | |
638 | (VOID **) &ServiceBinding,\r | |
639 | This->DriverBindingHandle,\r | |
640 | NicHandle,\r | |
641 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
642 | );\r | |
643 | \r | |
644 | if (EFI_ERROR (Status)) {\r | |
645 | return EFI_DEVICE_ERROR;\r | |
646 | }\r | |
647 | \r | |
648 | IpSb = IP4_SERVICE_FROM_PROTOCOL (ServiceBinding);\r | |
649 | \r | |
e48e37fc | 650 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 651 | \r |
652 | if (IpSb->InDestory) {\r | |
e48e37fc | 653 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 654 | return EFI_SUCCESS;\r |
655 | }\r | |
656 | \r | |
c4a62a12 | 657 | if (IsArp) {\r |
e48e37fc | 658 | while (!IsListEmpty (&IpSb->Children)) {\r |
c4a62a12 | 659 | IpInstance = NET_LIST_HEAD (&IpSb->Children, IP4_PROTOCOL, Link);\r |
772db4bb | 660 | \r |
c4a62a12 | 661 | ServiceBinding->DestroyChild (ServiceBinding, IpInstance->Handle);\r |
662 | }\r | |
772db4bb | 663 | \r |
c4a62a12 | 664 | if (IpSb->NumChildren != 0) {\r |
665 | Status = EFI_DEVICE_ERROR;\r | |
666 | goto ON_ERROR;\r | |
667 | }\r | |
772db4bb | 668 | \r |
c4a62a12 | 669 | IpSb->InDestory = TRUE;\r |
772db4bb | 670 | \r |
c4a62a12 | 671 | State = IpSb->State;\r |
672 | IpSb->State = IP4_SERVICE_DESTORY;\r | |
772db4bb | 673 | \r |
c4a62a12 | 674 | //\r |
675 | // Clear the variable data.\r | |
676 | //\r | |
677 | Ip4ClearVariableData (IpSb);\r | |
772db4bb | 678 | \r |
c4a62a12 | 679 | //\r |
680 | // OK, clean other resources then uninstall the service binding protocol.\r | |
681 | //\r | |
682 | Status = Ip4CleanService (IpSb);\r | |
772db4bb | 683 | \r |
c4a62a12 | 684 | if (EFI_ERROR (Status)) {\r |
685 | IpSb->State = State;\r | |
686 | goto ON_ERROR;\r | |
687 | }\r | |
772db4bb | 688 | \r |
c4a62a12 | 689 | gBS->UninstallProtocolInterface (\r |
690 | NicHandle,\r | |
691 | &gEfiIp4ServiceBindingProtocolGuid,\r | |
692 | ServiceBinding\r | |
693 | );\r | |
772db4bb | 694 | \r |
766c7483 | 695 | FreePool (IpSb);\r |
c4a62a12 | 696 | } else if (NumberOfChildren == 0) {\r |
697 | IpSb->InDestory = TRUE;\r | |
698 | \r | |
699 | State = IpSb->State;\r | |
700 | IpSb->State = IP4_SERVICE_DESTORY;\r | |
701 | \r | |
702 | //\r | |
703 | // Clear the variable data.\r | |
704 | //\r | |
705 | Ip4ClearVariableData (IpSb);\r | |
706 | \r | |
707 | //\r | |
708 | // OK, clean other resources then uninstall the service binding protocol.\r | |
709 | //\r | |
710 | Status = Ip4CleanService (IpSb);\r | |
711 | \r | |
712 | if (EFI_ERROR (Status)) {\r | |
713 | IpSb->State = State;\r | |
714 | goto ON_ERROR;\r | |
715 | }\r | |
716 | \r | |
717 | gBS->UninstallProtocolInterface (\r | |
718 | NicHandle,\r | |
719 | &gEfiIp4ServiceBindingProtocolGuid,\r | |
720 | ServiceBinding\r | |
721 | );\r | |
722 | \r | |
766c7483 | 723 | FreePool (IpSb);\r |
c4a62a12 | 724 | } else {\r |
725 | \r | |
e48e37fc | 726 | while (!IsListEmpty (&IpSb->Children)) {\r |
c4a62a12 | 727 | IpInstance = NET_LIST_HEAD (&IpSb->Children, IP4_PROTOCOL, Link);\r |
728 | \r | |
729 | ServiceBinding->DestroyChild (ServiceBinding, IpInstance->Handle);\r | |
730 | }\r | |
731 | \r | |
732 | if (IpSb->NumChildren != 0) {\r | |
733 | Status = EFI_DEVICE_ERROR;\r | |
734 | }\r | |
735 | }\r | |
772db4bb | 736 | \r |
737 | ON_ERROR:\r | |
c4a62a12 | 738 | \r |
e48e37fc | 739 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 740 | return Status;\r |
741 | }\r | |
742 | \r | |
743 | \r | |
744 | /**\r | |
3e8c18da | 745 | Creates a child handle and installs a protocol.\r |
746 | \r | |
747 | The CreateChild() function installs a protocol on ChildHandle. \r | |
748 | If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r | |
749 | If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r | |
772db4bb | 750 | \r |
3e8c18da | 751 | @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r |
752 | @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r | |
753 | then a new handle is created. If it is a pointer to an existing UEFI handle, \r | |
754 | then the protocol is added to the existing UEFI handle.\r | |
772db4bb | 755 | \r |
3e8c18da | 756 | @retval EFI_SUCCES The protocol was added to ChildHandle.\r |
5405e9a6 | 757 | @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r |
758 | @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r | |
759 | the child\r | |
760 | @retval other The child handle was not created\r | |
772db4bb | 761 | \r |
762 | **/\r | |
763 | EFI_STATUS\r | |
764 | EFIAPI\r | |
765 | Ip4ServiceBindingCreateChild (\r | |
766 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
5405e9a6 | 767 | IN OUT EFI_HANDLE *ChildHandle\r |
772db4bb | 768 | )\r |
769 | {\r | |
770 | IP4_SERVICE *IpSb;\r | |
771 | IP4_PROTOCOL *IpInstance;\r | |
772 | EFI_TPL OldTpl;\r | |
773 | EFI_STATUS Status;\r | |
774 | VOID *Mnp;\r | |
775 | \r | |
776 | if ((This == NULL) || (ChildHandle == NULL)) {\r | |
777 | return EFI_INVALID_PARAMETER;\r | |
778 | }\r | |
779 | \r | |
780 | IpSb = IP4_SERVICE_FROM_PROTOCOL (This);\r | |
e48e37fc | 781 | IpInstance = AllocatePool (sizeof (IP4_PROTOCOL));\r |
772db4bb | 782 | \r |
783 | if (IpInstance == NULL) {\r | |
784 | return EFI_OUT_OF_RESOURCES;\r | |
785 | }\r | |
786 | \r | |
787 | Ip4InitProtocol (IpSb, IpInstance);\r | |
788 | \r | |
789 | //\r | |
790 | // Install Ip4 onto ChildHandle\r | |
791 | //\r | |
792 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
793 | ChildHandle,\r | |
794 | &gEfiIp4ProtocolGuid,\r | |
795 | &IpInstance->Ip4Proto,\r | |
796 | NULL\r | |
797 | );\r | |
798 | \r | |
799 | if (EFI_ERROR (Status)) {\r | |
800 | goto ON_ERROR;\r | |
801 | }\r | |
802 | \r | |
803 | IpInstance->Handle = *ChildHandle;\r | |
804 | \r | |
805 | //\r | |
806 | // Open the Managed Network protocol BY_CHILD.\r | |
807 | //\r | |
808 | Status = gBS->OpenProtocol (\r | |
809 | IpSb->MnpChildHandle,\r | |
810 | &gEfiManagedNetworkProtocolGuid,\r | |
811 | (VOID **) &Mnp,\r | |
812 | gIp4DriverBinding.DriverBindingHandle,\r | |
813 | IpInstance->Handle,\r | |
814 | EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r | |
815 | );\r | |
816 | if (EFI_ERROR (Status)) {\r | |
817 | gBS->UninstallMultipleProtocolInterfaces (\r | |
818 | ChildHandle,\r | |
819 | &gEfiIp4ProtocolGuid,\r | |
820 | &IpInstance->Ip4Proto,\r | |
821 | NULL\r | |
822 | );\r | |
823 | \r | |
824 | goto ON_ERROR;\r | |
825 | }\r | |
826 | \r | |
827 | //\r | |
828 | // Insert it into the service binding instance.\r | |
829 | //\r | |
e48e37fc | 830 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 831 | \r |
e48e37fc | 832 | InsertTailList (&IpSb->Children, &IpInstance->Link);\r |
772db4bb | 833 | IpSb->NumChildren++;\r |
834 | \r | |
e48e37fc | 835 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 836 | \r |
837 | ON_ERROR:\r | |
838 | \r | |
839 | if (EFI_ERROR (Status)) {\r | |
840 | \r | |
841 | Ip4CleanProtocol (IpInstance);\r | |
842 | \r | |
766c7483 | 843 | FreePool (IpInstance);\r |
772db4bb | 844 | }\r |
845 | \r | |
846 | return Status;\r | |
847 | }\r | |
848 | \r | |
849 | \r | |
850 | /**\r | |
3e8c18da | 851 | Destroys a child handle with a protocol installed on it.\r |
852 | \r | |
853 | The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r | |
854 | that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r | |
855 | last protocol on ChildHandle, then ChildHandle is destroyed.\r | |
772db4bb | 856 | \r |
3e8c18da | 857 | @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r |
5405e9a6 | 858 | @param ChildHandle Handle of the child to destroy\r |
859 | \r | |
3e8c18da | 860 | @retval EFI_SUCCES The protocol was removed from ChildHandle.\r |
861 | @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r | |
862 | @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r | |
863 | @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r | |
864 | because its services are being used.\r | |
5405e9a6 | 865 | @retval other The child handle was not destroyed\r |
772db4bb | 866 | \r |
867 | **/\r | |
868 | EFI_STATUS\r | |
869 | EFIAPI\r | |
870 | Ip4ServiceBindingDestroyChild (\r | |
871 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
872 | IN EFI_HANDLE ChildHandle\r | |
873 | )\r | |
874 | {\r | |
875 | EFI_STATUS Status;\r | |
876 | IP4_SERVICE *IpSb;\r | |
877 | IP4_PROTOCOL *IpInstance;\r | |
878 | EFI_IP4_PROTOCOL *Ip4;\r | |
879 | EFI_TPL OldTpl;\r | |
880 | INTN State;\r | |
881 | \r | |
882 | if ((This == NULL) || (ChildHandle == NULL)) {\r | |
883 | return EFI_INVALID_PARAMETER;\r | |
884 | }\r | |
885 | \r | |
886 | //\r | |
887 | // Retrieve the private context data structures\r | |
888 | //\r | |
889 | IpSb = IP4_SERVICE_FROM_PROTOCOL (This);\r | |
890 | \r | |
891 | Status = gBS->OpenProtocol (\r | |
892 | ChildHandle,\r | |
893 | &gEfiIp4ProtocolGuid,\r | |
894 | (VOID **) &Ip4,\r | |
895 | gIp4DriverBinding.DriverBindingHandle,\r | |
896 | ChildHandle,\r | |
897 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
898 | );\r | |
899 | \r | |
900 | if (EFI_ERROR (Status)) {\r | |
901 | return EFI_UNSUPPORTED;\r | |
902 | }\r | |
903 | \r | |
904 | IpInstance = IP4_INSTANCE_FROM_PROTOCOL (Ip4);\r | |
905 | \r | |
906 | if (IpInstance->Service != IpSb) {\r | |
907 | return EFI_INVALID_PARAMETER;\r | |
908 | }\r | |
909 | \r | |
e48e37fc | 910 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 911 | \r |
912 | //\r | |
913 | // A child can be destoried more than once. For example,\r | |
914 | // Ip4DriverBindingStop will destory all of its children.\r | |
915 | // when UDP driver is being stopped, it will destory all\r | |
916 | // the IP child it opens.\r | |
917 | //\r | |
918 | if (IpInstance->State == IP4_STATE_DESTORY) {\r | |
e48e37fc | 919 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 920 | return EFI_SUCCESS;\r |
921 | }\r | |
922 | \r | |
923 | State = IpInstance->State;\r | |
924 | IpInstance->State = IP4_STATE_DESTORY;\r | |
925 | \r | |
926 | //\r | |
927 | // Close the Managed Network protocol.\r | |
928 | //\r | |
929 | gBS->CloseProtocol (\r | |
930 | IpSb->MnpChildHandle,\r | |
931 | &gEfiManagedNetworkProtocolGuid,\r | |
932 | gIp4DriverBinding.DriverBindingHandle,\r | |
933 | ChildHandle\r | |
934 | );\r | |
935 | \r | |
936 | //\r | |
937 | // Uninstall the IP4 protocol first. Many thing happens during\r | |
938 | // this:\r | |
939 | // 1. The consumer of the IP4 protocol will be stopped if it\r | |
940 | // opens the protocol BY_DRIVER. For eaxmple, if MNP driver is\r | |
941 | // stopped, IP driver's stop function will be called, and uninstall\r | |
942 | // EFI_IP4_PROTOCOL will trigger the UDP's stop function. This\r | |
943 | // makes it possible to create the network stack bottom up, and\r | |
944 | // stop it top down.\r | |
945 | // 2. the upper layer will recycle the received packet. The recycle\r | |
946 | // event's TPL is higher than this function. The recycle events\r | |
947 | // will be called back before preceeding. If any packets not recycled,\r | |
948 | // that means there is a resource leak.\r | |
949 | //\r | |
950 | Status = gBS->UninstallProtocolInterface (\r | |
951 | ChildHandle,\r | |
952 | &gEfiIp4ProtocolGuid,\r | |
953 | &IpInstance->Ip4Proto\r | |
954 | );\r | |
955 | \r | |
956 | if (EFI_ERROR (Status)) {\r | |
957 | goto ON_ERROR;\r | |
958 | }\r | |
959 | \r | |
960 | Status = Ip4CleanProtocol (IpInstance);\r | |
961 | \r | |
962 | Ip4SetVariableData (IpSb);\r | |
963 | \r | |
964 | if (EFI_ERROR (Status)) {\r | |
965 | gBS->InstallMultipleProtocolInterfaces (\r | |
966 | &ChildHandle,\r | |
967 | &gEfiIp4ProtocolGuid,\r | |
968 | Ip4,\r | |
969 | NULL\r | |
970 | );\r | |
971 | \r | |
972 | goto ON_ERROR;\r | |
973 | }\r | |
974 | \r | |
e48e37fc | 975 | RemoveEntryList (&IpInstance->Link);\r |
772db4bb | 976 | IpSb->NumChildren--;\r |
977 | \r | |
e48e37fc | 978 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 979 | \r |
766c7483 | 980 | FreePool (IpInstance);\r |
772db4bb | 981 | return EFI_SUCCESS;\r |
982 | \r | |
983 | ON_ERROR:\r | |
984 | IpInstance->State = State;\r | |
e48e37fc | 985 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 986 | \r |
987 | return Status;\r | |
988 | }\r |