123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065 |
- /** @file
- The driver binding and service binding protocol for IP4 driver.
- Copyright (c) 2005 - 2019, Intel Corporation. All rights reserved.<BR>
- (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #include "Ip4Impl.h"
- EFI_DRIVER_BINDING_PROTOCOL gIp4DriverBinding = {
- Ip4DriverBindingSupported,
- Ip4DriverBindingStart,
- Ip4DriverBindingStop,
- 0xa,
- NULL,
- NULL
- };
- BOOLEAN mIpSec2Installed = FALSE;
- /**
- Callback function for IpSec2 Protocol install.
- @param[in] Event Event whose notification function is being invoked
- @param[in] Context Pointer to the notification function's context
- **/
- VOID
- EFIAPI
- IpSec2InstalledCallback (
- IN EFI_EVENT Event,
- IN VOID *Context
- )
- {
- EFI_STATUS Status;
- //
- // Test if protocol was even found.
- // Notification function will be called at least once.
- //
- Status = gBS->LocateProtocol (&gEfiIpSec2ProtocolGuid, NULL, (VOID **)&mIpSec);
- if ((Status == EFI_SUCCESS) && (mIpSec != NULL)) {
- //
- // Close the event so it does not get called again.
- //
- gBS->CloseEvent (Event);
- mIpSec2Installed = TRUE;
- }
- }
- /**
- This is the declaration of an EFI image entry point. This entry point is
- the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
- both device drivers and bus drivers.
- The entry point for IP4 driver which install the driver
- binding and component name protocol on its image.
- @param[in] ImageHandle The firmware allocated handle for the UEFI image.
- @param[in] SystemTable A pointer to the EFI System Table.
- @retval EFI_SUCCESS The operation completed successfully.
- @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
- **/
- EFI_STATUS
- EFIAPI
- Ip4DriverEntryPoint (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
- {
- VOID *Registration;
- EfiCreateProtocolNotifyEvent (
- &gEfiIpSec2ProtocolGuid,
- TPL_CALLBACK,
- IpSec2InstalledCallback,
- NULL,
- &Registration
- );
- return EfiLibInstallDriverBindingComponentName2 (
- ImageHandle,
- SystemTable,
- &gIp4DriverBinding,
- ImageHandle,
- &gIp4ComponentName,
- &gIp4ComponentName2
- );
- }
- /**
- Test to see if this driver supports ControllerHandle. This service
- is called by the EFI boot service ConnectController(). In
- order to make drivers as small as possible, there are a few calling
- restrictions for this service. ConnectController() must
- follow these calling restrictions. If any other agent wishes to call
- Supported() it must also follow these calling restrictions.
- @param[in] This Protocol instance pointer.
- @param[in] ControllerHandle Handle of device to test
- @param[in] RemainingDevicePath Optional parameter use to pick a specific child
- device to start.
- @retval EFI_SUCCESS This driver supports this device
- @retval EFI_ALREADY_STARTED This driver is already running on this device
- @retval other This driver does not support this device
- **/
- EFI_STATUS
- EFIAPI
- Ip4DriverBindingSupported (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- //
- // Test for the MNP service binding Protocol
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiManagedNetworkServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return Status;
- }
- //
- // Test for the Arp service binding Protocol
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiArpServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- return Status;
- }
- /**
- Clean up a IP4 service binding instance. It will release all
- the resource allocated by the instance. The instance may be
- partly initialized, or partly destroyed. If a resource is
- destroyed, it is marked as that in case the destroy failed and
- being called again later.
- @param[in] IpSb The IP4 service binding instance to clean up
- @retval EFI_SUCCESS The resource used by the instance are cleaned up
- @retval other Failed to clean up some of the resources.
- **/
- EFI_STATUS
- Ip4CleanService (
- IN IP4_SERVICE *IpSb
- );
- /**
- Create a new IP4 driver service binding private instance.
- @param Controller The controller that has MNP service binding
- installed
- @param ImageHandle The IP4 driver's image handle
- @param Service The variable to receive the newly created IP4
- service.
- @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource
- @retval EFI_SUCCESS A new IP4 service binding private is created.
- @retval other Other error occurs.
- **/
- EFI_STATUS
- Ip4CreateService (
- IN EFI_HANDLE Controller,
- IN EFI_HANDLE ImageHandle,
- OUT IP4_SERVICE **Service
- )
- {
- IP4_SERVICE *IpSb;
- EFI_STATUS Status;
- ASSERT (Service != NULL);
- *Service = NULL;
- //
- // allocate a service private data then initialize all the filed to
- // empty resources, so if any thing goes wrong when allocating
- // resources, Ip4CleanService can be called to clean it up.
- //
- IpSb = AllocateZeroPool (sizeof (IP4_SERVICE));
- if (IpSb == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
- IpSb->Signature = IP4_SERVICE_SIGNATURE;
- IpSb->ServiceBinding.CreateChild = Ip4ServiceBindingCreateChild;
- IpSb->ServiceBinding.DestroyChild = Ip4ServiceBindingDestroyChild;
- IpSb->State = IP4_SERVICE_UNSTARTED;
- IpSb->NumChildren = 0;
- InitializeListHead (&IpSb->Children);
- InitializeListHead (&IpSb->Interfaces);
- IpSb->DefaultInterface = NULL;
- IpSb->DefaultRouteTable = NULL;
- Ip4InitAssembleTable (&IpSb->Assemble);
- IpSb->IgmpCtrl.Igmpv1QuerySeen = 0;
- InitializeListHead (&IpSb->IgmpCtrl.Groups);
- IpSb->Image = ImageHandle;
- IpSb->Controller = Controller;
- IpSb->MnpChildHandle = NULL;
- IpSb->Mnp = NULL;
- IpSb->MnpConfigData.ReceivedQueueTimeoutValue = 0;
- IpSb->MnpConfigData.TransmitQueueTimeoutValue = 0;
- IpSb->MnpConfigData.ProtocolTypeFilter = IP4_ETHER_PROTO;
- IpSb->MnpConfigData.EnableUnicastReceive = TRUE;
- IpSb->MnpConfigData.EnableMulticastReceive = TRUE;
- IpSb->MnpConfigData.EnableBroadcastReceive = TRUE;
- IpSb->MnpConfigData.EnablePromiscuousReceive = FALSE;
- IpSb->MnpConfigData.FlushQueuesOnReset = TRUE;
- IpSb->MnpConfigData.EnableReceiveTimestamps = FALSE;
- IpSb->MnpConfigData.DisableBackgroundPolling = FALSE;
- ZeroMem (&IpSb->SnpMode, sizeof (EFI_SIMPLE_NETWORK_MODE));
- IpSb->Timer = NULL;
- IpSb->ReconfigCheckTimer = NULL;
- IpSb->ReconfigEvent = NULL;
- IpSb->Reconfig = FALSE;
- IpSb->MediaPresent = TRUE;
- //
- // Create various resources. First create the route table, timer
- // event, ReconfigEvent and MNP child. IGMP, interface's initialization depend
- // on the MNP child.
- //
- IpSb->DefaultRouteTable = Ip4CreateRouteTable ();
- if (IpSb->DefaultRouteTable == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- Status = gBS->CreateEvent (
- EVT_NOTIFY_SIGNAL | EVT_TIMER,
- TPL_CALLBACK,
- Ip4TimerTicking,
- IpSb,
- &IpSb->Timer
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = gBS->CreateEvent (
- EVT_NOTIFY_SIGNAL | EVT_TIMER,
- TPL_CALLBACK,
- Ip4TimerReconfigChecking,
- IpSb,
- &IpSb->ReconfigCheckTimer
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = gBS->CreateEvent (
- EVT_NOTIFY_SIGNAL,
- TPL_NOTIFY,
- Ip4AutoReconfigCallBack,
- IpSb,
- &IpSb->ReconfigEvent
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = NetLibCreateServiceChild (
- Controller,
- ImageHandle,
- &gEfiManagedNetworkServiceBindingProtocolGuid,
- &IpSb->MnpChildHandle
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = gBS->OpenProtocol (
- IpSb->MnpChildHandle,
- &gEfiManagedNetworkProtocolGuid,
- (VOID **)&IpSb->Mnp,
- ImageHandle,
- Controller,
- EFI_OPEN_PROTOCOL_BY_DRIVER
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = Ip4ServiceConfigMnp (IpSb, TRUE);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = IpSb->Mnp->GetModeData (IpSb->Mnp, NULL, &IpSb->SnpMode);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- Status = Ip4InitIgmp (IpSb);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- IpSb->MacString = NULL;
- Status = NetLibGetMacString (IpSb->Controller, IpSb->Image, &IpSb->MacString);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- IpSb->DefaultInterface = Ip4CreateInterface (IpSb->Mnp, Controller, ImageHandle);
- if (IpSb->DefaultInterface == NULL) {
- Status = EFI_OUT_OF_RESOURCES;
- goto ON_ERROR;
- }
- InsertHeadList (&IpSb->Interfaces, &IpSb->DefaultInterface->Link);
- ZeroMem (&IpSb->Ip4Config2Instance, sizeof (IP4_CONFIG2_INSTANCE));
- Status = Ip4Config2InitInstance (&IpSb->Ip4Config2Instance);
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- IpSb->MaxPacketSize = IpSb->SnpMode.MaxPacketSize - sizeof (IP4_HEAD);
- if (NetLibGetVlanId (IpSb->Controller) != 0) {
- //
- // This is a VLAN device, reduce MTU by VLAN tag length
- //
- IpSb->MaxPacketSize -= NET_VLAN_TAG_LEN;
- }
- IpSb->OldMaxPacketSize = IpSb->MaxPacketSize;
- *Service = IpSb;
- return EFI_SUCCESS;
- ON_ERROR:
- Ip4CleanService (IpSb);
- FreePool (IpSb);
- return Status;
- }
- /**
- Clean up a IP4 service binding instance. It will release all
- the resource allocated by the instance. The instance may be
- partly initialized, or partly destroyed. If a resource is
- destroyed, it is marked as that in case the destroy failed and
- being called again later.
- @param[in] IpSb The IP4 service binding instance to clean up
- @retval EFI_SUCCESS The resource used by the instance are cleaned up
- @retval other Failed to clean up some of the resources.
- **/
- EFI_STATUS
- Ip4CleanService (
- IN IP4_SERVICE *IpSb
- )
- {
- EFI_STATUS Status;
- IpSb->State = IP4_SERVICE_DESTROY;
- if (IpSb->Timer != NULL) {
- gBS->SetTimer (IpSb->Timer, TimerCancel, 0);
- gBS->CloseEvent (IpSb->Timer);
- IpSb->Timer = NULL;
- }
- if (IpSb->ReconfigCheckTimer != NULL) {
- gBS->SetTimer (IpSb->ReconfigCheckTimer, TimerCancel, 0);
- gBS->CloseEvent (IpSb->ReconfigCheckTimer);
- IpSb->ReconfigCheckTimer = NULL;
- }
- if (IpSb->DefaultInterface != NULL) {
- Status = Ip4FreeInterface (IpSb->DefaultInterface, NULL);
- if (EFI_ERROR (Status)) {
- return Status;
- }
- IpSb->DefaultInterface = NULL;
- }
- if (IpSb->DefaultRouteTable != NULL) {
- Ip4FreeRouteTable (IpSb->DefaultRouteTable);
- IpSb->DefaultRouteTable = NULL;
- }
- Ip4CleanAssembleTable (&IpSb->Assemble);
- if (IpSb->MnpChildHandle != NULL) {
- if (IpSb->Mnp != NULL) {
- gBS->CloseProtocol (
- IpSb->MnpChildHandle,
- &gEfiManagedNetworkProtocolGuid,
- IpSb->Image,
- IpSb->Controller
- );
- IpSb->Mnp = NULL;
- }
- NetLibDestroyServiceChild (
- IpSb->Controller,
- IpSb->Image,
- &gEfiManagedNetworkServiceBindingProtocolGuid,
- IpSb->MnpChildHandle
- );
- IpSb->MnpChildHandle = NULL;
- }
- if (IpSb->ReconfigEvent != NULL) {
- gBS->CloseEvent (IpSb->ReconfigEvent);
- IpSb->ReconfigEvent = NULL;
- }
- IpSb->Reconfig = FALSE;
- if (IpSb->MacString != NULL) {
- FreePool (IpSb->MacString);
- }
- Ip4Config2CleanInstance (&IpSb->Ip4Config2Instance);
- return EFI_SUCCESS;
- }
- /**
- Callback function which provided by user to remove one node in NetDestroyLinkList process.
- @param[in] Entry The entry to be removed.
- @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
- @retval EFI_SUCCESS The entry has been removed successfully.
- @retval Others Fail to remove the entry.
- **/
- EFI_STATUS
- EFIAPI
- Ip4DestroyChildEntryInHandleBuffer (
- IN LIST_ENTRY *Entry,
- IN VOID *Context
- )
- {
- IP4_PROTOCOL *IpInstance;
- EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
- UINTN NumberOfChildren;
- EFI_HANDLE *ChildHandleBuffer;
- if ((Entry == NULL) || (Context == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- IpInstance = NET_LIST_USER_STRUCT_S (Entry, IP4_PROTOCOL, Link, IP4_PROTOCOL_SIGNATURE);
- ServiceBinding = ((IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ServiceBinding;
- NumberOfChildren = ((IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->NumberOfChildren;
- ChildHandleBuffer = ((IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ChildHandleBuffer;
- if (!NetIsInHandleBuffer (IpInstance->Handle, NumberOfChildren, ChildHandleBuffer)) {
- return EFI_SUCCESS;
- }
- return ServiceBinding->DestroyChild (ServiceBinding, IpInstance->Handle);
- }
- /**
- Start this driver on ControllerHandle. This service is called by the
- EFI boot service ConnectController(). In order to make
- drivers as small as possible, there are a few calling restrictions for
- this service. ConnectController() must follow these
- calling restrictions. If any other agent wishes to call Start() it
- must also follow these calling restrictions.
- @param[in] This Protocol instance pointer.
- @param[in] ControllerHandle Handle of device to bind driver to
- @param[in] RemainingDevicePath Optional parameter use to pick a specific child
- device to start.
- @retval EFI_SUCCESS This driver is added to ControllerHandle
- @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
- @retval other This driver does not support this device
- **/
- EFI_STATUS
- EFIAPI
- Ip4DriverBindingStart (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
- )
- {
- EFI_STATUS Status;
- IP4_SERVICE *IpSb;
- EFI_IP4_CONFIG2_PROTOCOL *Ip4Cfg2;
- UINTN Index;
- IP4_CONFIG2_DATA_ITEM *DataItem;
- IpSb = NULL;
- Ip4Cfg2 = NULL;
- DataItem = NULL;
- //
- // Test for the Ip4 service binding protocol
- //
- Status = gBS->OpenProtocol (
- ControllerHandle,
- &gEfiIp4ServiceBindingProtocolGuid,
- NULL,
- This->DriverBindingHandle,
- ControllerHandle,
- EFI_OPEN_PROTOCOL_TEST_PROTOCOL
- );
- if (Status == EFI_SUCCESS) {
- return EFI_ALREADY_STARTED;
- }
- Status = Ip4CreateService (ControllerHandle, This->DriverBindingHandle, &IpSb);
- if (EFI_ERROR (Status)) {
- return Status;
- }
- ASSERT (IpSb != NULL);
- Ip4Cfg2 = &IpSb->Ip4Config2Instance.Ip4Config2;
- //
- // Install the Ip4ServiceBinding Protocol onto ControllerHandle
- //
- Status = gBS->InstallMultipleProtocolInterfaces (
- &ControllerHandle,
- &gEfiIp4ServiceBindingProtocolGuid,
- &IpSb->ServiceBinding,
- &gEfiIp4Config2ProtocolGuid,
- Ip4Cfg2,
- NULL
- );
- if (EFI_ERROR (Status)) {
- goto FREE_SERVICE;
- }
- //
- // Read the config data from NV variable again.
- // The default data can be changed by other drivers.
- //
- Status = Ip4Config2ReadConfigData (IpSb->MacString, &IpSb->Ip4Config2Instance);
- if (EFI_ERROR (Status)) {
- goto UNINSTALL_PROTOCOL;
- }
- //
- // Consume the installed EFI_IP4_CONFIG2_PROTOCOL to set the default data items.
- //
- for (Index = Ip4Config2DataTypePolicy; Index < Ip4Config2DataTypeMaximum; Index++) {
- DataItem = &IpSb->Ip4Config2Instance.DataItem[Index];
- if (DataItem->Data.Ptr != NULL) {
- Status = Ip4Cfg2->SetData (
- Ip4Cfg2,
- Index,
- DataItem->DataSize,
- DataItem->Data.Ptr
- );
- if (EFI_ERROR (Status)) {
- goto UNINSTALL_PROTOCOL;
- }
- if ((Index == Ip4Config2DataTypePolicy) && (*(DataItem->Data.Policy) == Ip4Config2PolicyDhcp)) {
- break;
- }
- }
- }
- //
- // Ready to go: start the receiving and timer.
- // Ip4Config2SetPolicy maybe call Ip4ReceiveFrame() to set the default interface's RecvRequest first after
- // Ip4Config2 instance is initialized. So, EFI_ALREADY_STARTED is the allowed return status.
- //
- Status = Ip4ReceiveFrame (IpSb->DefaultInterface, NULL, Ip4AccpetFrame, IpSb);
- if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {
- goto UNINSTALL_PROTOCOL;
- }
- Status = gBS->SetTimer (IpSb->Timer, TimerPeriodic, TICKS_PER_SECOND);
- if (EFI_ERROR (Status)) {
- goto UNINSTALL_PROTOCOL;
- }
- Status = gBS->SetTimer (IpSb->ReconfigCheckTimer, TimerPeriodic, 500 * TICKS_PER_MS);
- if (EFI_ERROR (Status)) {
- goto UNINSTALL_PROTOCOL;
- }
- //
- // Initialize the IP4 ID
- //
- mIp4Id = (UINT16)NET_RANDOM (NetRandomInitSeed ());
- return Status;
- UNINSTALL_PROTOCOL:
- gBS->UninstallMultipleProtocolInterfaces (
- ControllerHandle,
- &gEfiIp4ServiceBindingProtocolGuid,
- &IpSb->ServiceBinding,
- &gEfiIp4Config2ProtocolGuid,
- Ip4Cfg2,
- NULL
- );
- FREE_SERVICE:
- Ip4CleanService (IpSb);
- FreePool (IpSb);
- return Status;
- }
- /**
- Stop this driver on ControllerHandle. This service is called by the
- EFI boot service DisconnectController(). In order to
- make drivers as small as possible, there are a few calling
- restrictions for this service. DisconnectController()
- must follow these calling restrictions. If any other agent wishes
- to call Stop() it must also follow these calling restrictions.
- @param[in] This Protocol instance pointer.
- @param[in] ControllerHandle Handle of device to stop driver on
- @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number
- of children is zero stop the entire bus driver.
- @param[in] ChildHandleBuffer List of Child Handles to Stop.
- @retval EFI_SUCCESS This driver is removed ControllerHandle
- @retval other This driver was not removed from this device
- **/
- EFI_STATUS
- EFIAPI
- Ip4DriverBindingStop (
- IN EFI_DRIVER_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ControllerHandle,
- IN UINTN NumberOfChildren,
- IN EFI_HANDLE *ChildHandleBuffer
- )
- {
- EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
- IP4_SERVICE *IpSb;
- EFI_HANDLE NicHandle;
- EFI_STATUS Status;
- INTN State;
- LIST_ENTRY *List;
- IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context;
- IP4_INTERFACE *IpIf;
- IP4_ROUTE_TABLE *RouteTable;
- BOOLEAN IsDhcp4;
- IsDhcp4 = FALSE;
- NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiManagedNetworkProtocolGuid);
- if (NicHandle == NULL) {
- NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiArpProtocolGuid);
- if (NicHandle == NULL) {
- NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiDhcp4ProtocolGuid);
- if (NicHandle != NULL) {
- IsDhcp4 = TRUE;
- } else {
- return EFI_SUCCESS;
- }
- }
- }
- Status = gBS->OpenProtocol (
- NicHandle,
- &gEfiIp4ServiceBindingProtocolGuid,
- (VOID **)&ServiceBinding,
- This->DriverBindingHandle,
- NicHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return EFI_DEVICE_ERROR;
- }
- IpSb = IP4_SERVICE_FROM_PROTOCOL (ServiceBinding);
- if (IsDhcp4) {
- Status = Ip4Config2DestroyDhcp4 (&IpSb->Ip4Config2Instance);
- gBS->CloseEvent (IpSb->Ip4Config2Instance.Dhcp4Event);
- IpSb->Ip4Config2Instance.Dhcp4Event = NULL;
- } else if (NumberOfChildren != 0) {
- List = &IpSb->Children;
- Context.ServiceBinding = ServiceBinding;
- Context.NumberOfChildren = NumberOfChildren;
- Context.ChildHandleBuffer = ChildHandleBuffer;
- Status = NetDestroyLinkList (
- List,
- Ip4DestroyChildEntryInHandleBuffer,
- &Context,
- NULL
- );
- } else if (IpSb->DefaultInterface->ArpHandle == ControllerHandle) {
- //
- // The ARP protocol for the default interface is being uninstalled and all
- // its IP child handles should have been destroyed before. So, release the
- // default interface and route table, create a new one and mark it as not started.
- //
- Ip4CancelReceive (IpSb->DefaultInterface);
- Ip4FreeInterface (IpSb->DefaultInterface, NULL);
- Ip4FreeRouteTable (IpSb->DefaultRouteTable);
- IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image);
- if (IpIf == NULL) {
- goto ON_ERROR;
- }
- RouteTable = Ip4CreateRouteTable ();
- if (RouteTable == NULL) {
- Ip4FreeInterface (IpIf, NULL);
- goto ON_ERROR;
- }
- IpSb->DefaultInterface = IpIf;
- InsertHeadList (&IpSb->Interfaces, &IpIf->Link);
- IpSb->DefaultRouteTable = RouteTable;
- Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb);
- IpSb->State = IP4_SERVICE_UNSTARTED;
- } else if (IsListEmpty (&IpSb->Children)) {
- State = IpSb->State;
- //
- // OK, clean other resources then uninstall the service binding protocol.
- //
- Status = Ip4CleanService (IpSb);
- if (EFI_ERROR (Status)) {
- IpSb->State = State;
- goto ON_ERROR;
- }
- gBS->UninstallMultipleProtocolInterfaces (
- NicHandle,
- &gEfiIp4ServiceBindingProtocolGuid,
- ServiceBinding,
- &gEfiIp4Config2ProtocolGuid,
- &IpSb->Ip4Config2Instance.Ip4Config2,
- NULL
- );
- if (gIp4ControllerNameTable != NULL) {
- FreeUnicodeStringTable (gIp4ControllerNameTable);
- gIp4ControllerNameTable = NULL;
- }
- FreePool (IpSb);
- }
- ON_ERROR:
- return Status;
- }
- /**
- Creates a child handle and installs a protocol.
- The CreateChild() function installs a protocol on ChildHandle.
- If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
- If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
- @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,
- then a new handle is created. If it is a pointer to an existing UEFI handle,
- then the protocol is added to the existing UEFI handle.
- @retval EFI_SUCCESS The protocol was added to ChildHandle.
- @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
- the child
- @retval other The child handle was not created
- **/
- EFI_STATUS
- EFIAPI
- Ip4ServiceBindingCreateChild (
- IN EFI_SERVICE_BINDING_PROTOCOL *This,
- IN OUT EFI_HANDLE *ChildHandle
- )
- {
- IP4_SERVICE *IpSb;
- IP4_PROTOCOL *IpInstance;
- EFI_TPL OldTpl;
- EFI_STATUS Status;
- VOID *Mnp;
- if ((This == NULL) || (ChildHandle == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- IpSb = IP4_SERVICE_FROM_PROTOCOL (This);
- IpInstance = AllocatePool (sizeof (IP4_PROTOCOL));
- if (IpInstance == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
- Ip4InitProtocol (IpSb, IpInstance);
- //
- // Install Ip4 onto ChildHandle
- //
- Status = gBS->InstallMultipleProtocolInterfaces (
- ChildHandle,
- &gEfiIp4ProtocolGuid,
- &IpInstance->Ip4Proto,
- NULL
- );
- if (EFI_ERROR (Status)) {
- goto ON_ERROR;
- }
- IpInstance->Handle = *ChildHandle;
- //
- // Open the Managed Network protocol BY_CHILD.
- //
- Status = gBS->OpenProtocol (
- IpSb->MnpChildHandle,
- &gEfiManagedNetworkProtocolGuid,
- (VOID **)&Mnp,
- gIp4DriverBinding.DriverBindingHandle,
- IpInstance->Handle,
- EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
- );
- if (EFI_ERROR (Status)) {
- gBS->UninstallMultipleProtocolInterfaces (
- *ChildHandle,
- &gEfiIp4ProtocolGuid,
- &IpInstance->Ip4Proto,
- NULL
- );
- goto ON_ERROR;
- }
- //
- // Insert it into the service binding instance.
- //
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- InsertTailList (&IpSb->Children, &IpInstance->Link);
- IpSb->NumChildren++;
- gBS->RestoreTPL (OldTpl);
- ON_ERROR:
- if (EFI_ERROR (Status)) {
- Ip4CleanProtocol (IpInstance);
- FreePool (IpInstance);
- }
- return Status;
- }
- /**
- Destroys a child handle with a protocol installed on it.
- The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
- that was installed by CreateChild() from ChildHandle. If the removed protocol is the
- last protocol on ChildHandle, then ChildHandle is destroyed.
- @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
- @param ChildHandle Handle of the child to destroy
- @retval EFI_SUCCESS The protocol was removed from ChildHandle.
- @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
- @retval EFI_INVALID_PARAMETER Child handle is NULL.
- @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
- because its services are being used.
- @retval other The child handle was not destroyed
- **/
- EFI_STATUS
- EFIAPI
- Ip4ServiceBindingDestroyChild (
- IN EFI_SERVICE_BINDING_PROTOCOL *This,
- IN EFI_HANDLE ChildHandle
- )
- {
- EFI_STATUS Status;
- IP4_SERVICE *IpSb;
- IP4_PROTOCOL *IpInstance;
- EFI_IP4_PROTOCOL *Ip4;
- EFI_TPL OldTpl;
- if ((This == NULL) || (ChildHandle == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- //
- // Retrieve the private context data structures
- //
- IpSb = IP4_SERVICE_FROM_PROTOCOL (This);
- Status = gBS->OpenProtocol (
- ChildHandle,
- &gEfiIp4ProtocolGuid,
- (VOID **)&Ip4,
- gIp4DriverBinding.DriverBindingHandle,
- ChildHandle,
- EFI_OPEN_PROTOCOL_GET_PROTOCOL
- );
- if (EFI_ERROR (Status)) {
- return EFI_UNSUPPORTED;
- }
- IpInstance = IP4_INSTANCE_FROM_PROTOCOL (Ip4);
- if (IpInstance->Service != IpSb) {
- return EFI_INVALID_PARAMETER;
- }
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- //
- // A child can be destroyed more than once. For example,
- // Ip4DriverBindingStop will destroy all of its children.
- // when UDP driver is being stopped, it will destroy all
- // the IP child it opens.
- //
- if (IpInstance->InDestroy) {
- gBS->RestoreTPL (OldTpl);
- return EFI_SUCCESS;
- }
- IpInstance->InDestroy = TRUE;
- //
- // Close the Managed Network protocol.
- //
- gBS->CloseProtocol (
- IpSb->MnpChildHandle,
- &gEfiManagedNetworkProtocolGuid,
- gIp4DriverBinding.DriverBindingHandle,
- ChildHandle
- );
- if ((IpInstance->Interface != NULL) && (IpInstance->Interface->Arp != NULL)) {
- gBS->CloseProtocol (
- IpInstance->Interface->ArpHandle,
- &gEfiArpProtocolGuid,
- gIp4DriverBinding.DriverBindingHandle,
- ChildHandle
- );
- }
- //
- // Uninstall the IP4 protocol first. Many thing happens during
- // this:
- // 1. The consumer of the IP4 protocol will be stopped if it
- // opens the protocol BY_DRIVER. For example, if MNP driver is
- // stopped, IP driver's stop function will be called, and uninstall
- // EFI_IP4_PROTOCOL will trigger the UDP's stop function. This
- // makes it possible to create the network stack bottom up, and
- // stop it top down.
- // 2. the upper layer will recycle the received packet. The recycle
- // event's TPL is higher than this function. The recycle events
- // will be called back before preceding. If any packets not recycled,
- // that means there is a resource leak.
- //
- gBS->RestoreTPL (OldTpl);
- Status = gBS->UninstallProtocolInterface (
- ChildHandle,
- &gEfiIp4ProtocolGuid,
- &IpInstance->Ip4Proto
- );
- OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
- if (EFI_ERROR (Status)) {
- IpInstance->InDestroy = FALSE;
- goto ON_ERROR;
- }
- Status = Ip4CleanProtocol (IpInstance);
- if (EFI_ERROR (Status)) {
- gBS->InstallMultipleProtocolInterfaces (
- &ChildHandle,
- &gEfiIp4ProtocolGuid,
- Ip4,
- NULL
- );
- goto ON_ERROR;
- }
- RemoveEntryList (&IpInstance->Link);
- IpSb->NumChildren--;
- gBS->RestoreTPL (OldTpl);
- FreePool (IpInstance);
- return EFI_SUCCESS;
- ON_ERROR:
- gBS->RestoreTPL (OldTpl);
- return Status;
- }
|