[mirror_edk2.git] / NetworkPkg / DnsDxe / DnsDriver.c

/** @file\r
The driver binding and service binding protocol for DnsDxe driver.\r
\r
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "DnsImpl.h"\r
\r
EFI_DRIVER_BINDING_PROTOCOL gDns4DriverBinding = {\r
  Dns4DriverBindingSupported,\r
  Dns4DriverBindingStart,\r
  Dns4DriverBindingStop,\r
  DNS_VERSION,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_DRIVER_BINDING_PROTOCOL gDns6DriverBinding = {\r
  Dns6DriverBindingSupported,\r
  Dns6DriverBindingStart,\r
  Dns6DriverBindingStop,\r
  DNS_VERSION,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_SERVICE_BINDING_PROTOCOL mDns4ServiceBinding = {\r
  Dns4ServiceBindingCreateChild,\r
  Dns4ServiceBindingDestroyChild\r
};\r
\r
EFI_SERVICE_BINDING_PROTOCOL mDns6ServiceBinding = {\r
  Dns6ServiceBindingCreateChild,\r
  Dns6ServiceBindingDestroyChild\r
};\r
\r
DNS_DRIVER_DATA          *mDriverData = NULL;\r
\r
/**\r
  Destroy the DNS instance and recycle the resources.\r
\r
  @param[in]  Instance        The pointer to the DNS instance.\r
\r
**/\r
VOID\r
DnsDestroyInstance (\r
  IN DNS_INSTANCE         *Instance\r
  )\r
{\r
  ZeroMem (&Instance->Dns4CfgData, sizeof (EFI_DNS4_CONFIG_DATA));\r
\r
  ZeroMem (&Instance->Dns6CfgData, sizeof (EFI_DNS6_CONFIG_DATA));\r
\r
  if (!NetMapIsEmpty (&Instance->Dns4TxTokens)) {\r
    Dns4InstanceCancelToken (Instance, NULL);\r
  }\r
\r
  if (!NetMapIsEmpty (&Instance->Dns6TxTokens)) {\r
    Dns6InstanceCancelToken (Instance, NULL);\r
  }\r
\r
  if (Instance->UdpIo!= NULL) {\r
    UdpIoFreeIo (Instance->UdpIo);\r
  }\r
\r
  FreePool (Instance);\r
}\r
\r
/**\r
  Create the DNS instance and initialize it.\r
\r
  @param[in]  Service              The pointer to the DNS service.\r
  @param[out] Instance             The pointer to the DNS instance.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources.\r
  @retval EFI_SUCCESS            The DNS instance is created.\r
\r
**/\r
EFI_STATUS\r
DnsCreateInstance (\r
  IN  DNS_SERVICE         *Service,\r
  OUT DNS_INSTANCE        **Instance\r
  )\r
{\r
  DNS_INSTANCE            *DnsIns;\r
\r
  *Instance = NULL;\r
\r
  DnsIns = AllocateZeroPool (sizeof (DNS_INSTANCE));\r
  if (DnsIns == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  DnsIns->Signature = DNS_INSTANCE_SIGNATURE;\r
  InitializeListHead (&DnsIns->Link);\r
  DnsIns->State     = DNS_STATE_UNCONFIGED;\r
  DnsIns->InDestroy = FALSE;\r
  DnsIns->Service   = Service;\r
\r
  if (Service->IpVersion == IP_VERSION_4) {\r
    CopyMem (&DnsIns->Dns4, &mDns4Protocol, sizeof (DnsIns->Dns4));\r
    NetMapInit (&DnsIns->Dns4TxTokens);\r
  } else {\r
    CopyMem (&DnsIns->Dns6, &mDns6Protocol, sizeof (DnsIns->Dns6));\r
    NetMapInit (&DnsIns->Dns6TxTokens);\r
  }\r
\r
  DnsIns->UdpIo = UdpIoCreateIo (\r
                    Service->ControllerHandle, /// NicHandle\r
                    Service->ImageHandle,\r
                    DnsConfigNullUdp,\r
                    Service->IpVersion,\r
                    DnsIns\r
                    );\r
  if (DnsIns->UdpIo == NULL) {\r
    FreePool (DnsIns);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  *Instance = DnsIns;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Callback function which provided by user to remove one node in NetDestroyLinkList process.\r
\r
  @param[in]    Entry           The entry to be removed.\r
  @param[in]    Context         Pointer to the callback context corresponds to the Context in NetDestroyLinkList.\r
\r
  @retval EFI_SUCCESS           The entry has been removed successfully.\r
  @retval Others                Fail to remove the entry.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DnsDestroyChildEntryInHandleBuffer (\r
  IN LIST_ENTRY         *Entry,\r
  IN VOID               *Context\r
  )\r
{\r
  DNS_INSTANCE                  *Instance;\r
  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;\r
  UINTN                         NumberOfChildren;\r
  EFI_HANDLE                    *ChildHandleBuffer;\r
\r
  if (Entry == NULL || Context == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Instance = NET_LIST_USER_STRUCT_S (Entry, DNS_INSTANCE, Link, DNS_INSTANCE_SIGNATURE);\r
  ServiceBinding    = ((DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ServiceBinding;\r
  NumberOfChildren  = ((DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->NumberOfChildren;\r
  ChildHandleBuffer = ((DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ChildHandleBuffer;\r
\r
  if (!NetIsInHandleBuffer (Instance->ChildHandle, NumberOfChildren, ChildHandleBuffer)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  return ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle);\r
}\r
\r
/**\r
  Config a NULL UDP that is used to keep the connection between UDP and DNS.\r
\r
  Just leave the Udp child unconfigured. When UDP is unloaded,\r
    DNS will be informed with DriverBinding Stop.\r
\r
  @param  UdpIo                  The UDP_IO to configure\r
  @param  Context                The opaque parameter to the callback\r
\r
  @retval EFI_SUCCESS            It always return EFI_SUCCESS directly.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DnsConfigNullUdp (\r
  IN UDP_IO                 *UdpIo,\r
  IN VOID                   *Context\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Release all the resource used the DNS service binding instance.\r
\r
  @param  DnsSb                The Dns service binding instance.\r
\r
**/\r
VOID\r
DnsDestroyService (\r
  IN DNS_SERVICE     *DnsSb\r
  )\r
{\r
  UdpIoFreeIo (DnsSb->ConnectUdp);\r
\r
  if (DnsSb->TimerToGetMap != NULL){\r
    gBS->CloseEvent (DnsSb->TimerToGetMap);\r
  }\r
\r
  if (DnsSb->Timer != NULL){\r
    gBS->CloseEvent (DnsSb->Timer);\r
  }\r
\r
  FreePool (DnsSb);\r
}\r
\r
/**\r
  Create then initialize a Dns service binding instance.\r
\r
  @param  Controller             The controller to install the DNS service\r
                                 binding on\r
  @param  Image                  The driver binding image of the DNS driver\r
  @param  IpVersion              IpVersion for this service\r
  @param  Service                The variable to receive the created service\r
                                 binding instance.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resource to create the instance.\r
  @retval EFI_DEVICE_ERROR       Failed to create a NULL UDP port to keep\r
                                 connection  with UDP.\r
  @retval EFI_SUCCESS            The service instance is created for the\r
                                 controller.\r
\r
**/\r
EFI_STATUS\r
DnsCreateService (\r
  IN     EFI_HANDLE            Controller,\r
  IN     EFI_HANDLE            Image,\r
  IN     UINT8                 IpVersion,\r
     OUT DNS_SERVICE           **Service\r
  )\r
{\r
  EFI_STATUS             Status;\r
  DNS_SERVICE            *DnsSb;\r
\r
  Status    = EFI_SUCCESS;\r
  DnsSb     = NULL;\r
\r
  *Service  = NULL;\r
\r
  DnsSb = AllocateZeroPool (sizeof (DNS_SERVICE));\r
  if (DnsSb == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  DnsSb->Signature = DNS_SERVICE_SIGNATURE;\r
\r
  if (IpVersion == IP_VERSION_4) {\r
    DnsSb->ServiceBinding = mDns4ServiceBinding;\r
  } else {\r
    DnsSb->ServiceBinding = mDns6ServiceBinding;\r
  }\r
\r
  DnsSb->Dns4ChildrenNum = 0;\r
  InitializeListHead (&DnsSb->Dns4ChildrenList);\r
\r
  DnsSb->Dns6ChildrenNum = 0;\r
  InitializeListHead (&DnsSb->Dns6ChildrenList);\r
\r
  DnsSb->ControllerHandle = Controller;\r
  DnsSb->ImageHandle      = Image;\r
\r
  DnsSb->TimerToGetMap    = NULL;\r
\r
  DnsSb->Timer            = NULL;\r
\r
  DnsSb->IpVersion        = IpVersion;\r
\r
  //\r
  // Create the timer used to time out the procedure which is used to\r
  // get the default IP address.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_TIMER,\r
                  TPL_CALLBACK,\r
                  NULL,\r
                  NULL,\r
                  &DnsSb->TimerToGetMap\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    FreePool (DnsSb);\r
    return Status;\r
  }\r
\r
  //\r
  // Create the timer to retransmit packets.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL | EVT_TIMER,\r
                  TPL_CALLBACK,\r
                  DnsOnTimerRetransmit,\r
                  DnsSb,\r
                  &DnsSb->Timer\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    if (DnsSb->TimerToGetMap != NULL) {\r
      gBS->CloseEvent (DnsSb->TimerToGetMap);\r
    }\r
    FreePool (DnsSb);\r
    return Status;\r
  }\r
\r
  DnsSb->ConnectUdp = NULL;\r
  DnsSb->ConnectUdp = UdpIoCreateIo (\r
                        Controller,\r
                        Image,\r
                        DnsConfigNullUdp,\r
                        DnsSb->IpVersion,\r
                        NULL\r
                        );\r
  if (DnsSb->ConnectUdp == NULL) {\r
    if (DnsSb->TimerToGetMap != NULL) {\r
      gBS->CloseEvent (DnsSb->TimerToGetMap);\r
    }\r
    gBS->CloseEvent (DnsSb->Timer);\r
    FreePool (DnsSb);\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  *Service = DnsSb;\r
  return Status;\r
}\r
\r
/**\r
  Unloads an image.\r
\r
  @param  ImageHandle           Handle that identifies the image to be unloaded.\r
\r
  @retval EFI_SUCCESS           The image has been unloaded.\r
  @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DnsUnload (\r
  IN EFI_HANDLE  ImageHandle\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  LIST_ENTRY                      *Entry;\r
  DNS4_CACHE                      *ItemCache4;\r
  DNS4_SERVER_IP                  *ItemServerIp4;\r
  DNS6_CACHE                      *ItemCache6;\r
  DNS6_SERVER_IP                  *ItemServerIp6;\r
\r
  ItemCache4    = NULL;\r
  ItemServerIp4 = NULL;\r
  ItemCache6    = NULL;\r
  ItemServerIp6 = NULL;\r
\r
  //\r
  // Disconnect the driver specified by ImageHandle\r
  //\r
  Status = NetLibDefaultUnload(ImageHandle);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Free mDriverData.\r
  //\r
  if (mDriverData != NULL) {\r
    if (mDriverData->Timer != NULL) {\r
      gBS->CloseEvent (mDriverData->Timer);\r
    }\r
\r
    while (!IsListEmpty (&mDriverData->Dns4CacheList)) {\r
      Entry = NetListRemoveHead (&mDriverData->Dns4CacheList);\r
      ItemCache4 = NET_LIST_USER_STRUCT (Entry, DNS4_CACHE, AllCacheLink);\r
      if (ItemCache4->DnsCache.HostName != NULL) {\r
        FreePool (ItemCache4->DnsCache.HostName);\r
      }\r
      if (ItemCache4->DnsCache.IpAddress != NULL) {\r
        FreePool (ItemCache4->DnsCache.IpAddress);\r
      }\r
      FreePool (ItemCache4);\r
    }\r
\r
    while (!IsListEmpty (&mDriverData->Dns4ServerList)) {\r
      Entry = NetListRemoveHead (&mDriverData->Dns4ServerList);\r
      ItemServerIp4 = NET_LIST_USER_STRUCT (Entry, DNS4_SERVER_IP, AllServerLink);\r
      FreePool (ItemServerIp4);\r
    }\r
\r
    while (!IsListEmpty (&mDriverData->Dns6CacheList)) {\r
      Entry = NetListRemoveHead (&mDriverData->Dns6CacheList);\r
      ItemCache6 = NET_LIST_USER_STRUCT (Entry, DNS6_CACHE, AllCacheLink);\r
      if (ItemCache6->DnsCache.HostName != NULL) {\r
        FreePool (ItemCache6->DnsCache.HostName);\r
      }\r
      if (ItemCache6->DnsCache.IpAddress != NULL) {\r
        FreePool (ItemCache6->DnsCache.IpAddress);\r
      }\r
      FreePool (ItemCache6);\r
    }\r
\r
    while (!IsListEmpty (&mDriverData->Dns6ServerList)) {\r
      Entry = NetListRemoveHead (&mDriverData->Dns6ServerList);\r
      ItemServerIp6 = NET_LIST_USER_STRUCT (Entry, DNS6_SERVER_IP, AllServerLink);\r
      FreePool (ItemServerIp6);\r
    }\r
\r
    FreePool (mDriverData);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  This is the declaration of an EFI image entry point. This entry point is\r
  the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r
  both device drivers and bus drivers.\r
\r
  @param  ImageHandle           The firmware allocated handle for the UEFI image.\r
  @param  SystemTable           A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval Others                An unexpected error occurred.\r
**/\r
EFI_STATUS\r
EFIAPI\r
DnsDriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = EFI_SUCCESS;\r
\r
  //\r
  // Install the Dns4 Driver Binding Protocol.\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gDns4DriverBinding,\r
             ImageHandle,\r
             &gDnsComponentName,\r
             &gDnsComponentName2\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Install the Dns6 Driver Binding Protocol.\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gDns6DriverBinding,\r
             NULL,\r
             &gDnsComponentName,\r
             &gDnsComponentName2\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Error1;\r
  }\r
\r
  //\r
  // Create the driver data structures.\r
  //\r
  mDriverData = AllocateZeroPool (sizeof (DNS_DRIVER_DATA));\r
  if (mDriverData == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error2;\r
  }\r
\r
  //\r
  // Create the timer event to update DNS cache list.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL | EVT_TIMER,\r
                  TPL_CALLBACK,\r
                  DnsOnTimerUpdate,\r
                  NULL,\r
                  &mDriverData->Timer\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto Error3;\r
  }\r
\r
  Status = gBS->SetTimer (mDriverData->Timer, TimerPeriodic, TICKS_PER_SECOND);\r
  if (EFI_ERROR (Status)) {\r
    goto Error4;\r
  }\r
\r
  InitializeListHead (&mDriverData->Dns4CacheList);\r
  InitializeListHead (&mDriverData->Dns4ServerList);\r
  InitializeListHead (&mDriverData->Dns6CacheList);\r
  InitializeListHead (&mDriverData->Dns6ServerList);\r
\r
  return Status;\r
\r
  Error4:\r
    gBS->CloseEvent (mDriverData->Timer);\r
\r
  Error3:\r
    FreePool (mDriverData);\r
\r
  Error2:\r
     EfiLibUninstallDriverBindingComponentName2 (\r
       &gDns6DriverBinding,\r
       &gDnsComponentName,\r
       &gDnsComponentName2\r
       );\r
\r
  Error1:\r
    EfiLibUninstallDriverBindingComponentName2 (\r
      &gDns4DriverBinding,\r
      &gDnsComponentName,\r
      &gDnsComponentName2\r
      );\r
\r
  return Status;\r
}\r
\r
/**\r
  Tests to see if this driver supports a given controller. If a child device is provided,\r
  it further tests to see if this driver supports creating a handle for the specified child device.\r
\r
  This function checks to see if the driver specified by This supports the device specified by\r
  ControllerHandle. Drivers will typically use the device path attached to\r
  ControllerHandle and/or the services from the bus I/O abstraction attached to\r
  ControllerHandle to determine if the driver supports ControllerHandle. This function\r
  may be called many times during platform initialization. In order to reduce boot times, the tests\r
  performed by this function must be very small, and take as little time as possible to execute. This\r
  function must not change the state of any hardware devices, and this function must be aware that the\r
  device specified by ControllerHandle may already be managed by the same driver or a\r
  different driver. This function must match its calls to AllocatePages() with FreePages(),\r
  AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r
  Because ControllerHandle may have been previously started by the same driver, if a protocol is\r
  already in the opened state, then it must not be closed with CloseProtocol(). This is required\r
  to guarantee the state of ControllerHandle is not modified by this function.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to test. This handle\r
                                   must support a protocol interface that supplies\r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This\r
                                   parameter is ignored by device drivers, and is optional for bus\r
                                   drivers. For bus drivers, if this parameter is not NULL, then\r
                                   the bus driver must determine if the bus controller specified\r
                                   by ControllerHandle and the child controller specified\r
                                   by RemainingDevicePath are both supported by this\r
                                   bus driver.\r
\r
  @retval EFI_SUCCESS              The device specified by ControllerHandle and\r
                                   RemainingDevicePath is supported by the driver specified by This.\r
  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by the driver\r
                                   specified by This.\r
  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by a different\r
                                   driver or an application that requires exclusive access.\r
                                   Currently not implemented.\r
  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                   RemainingDevicePath is not supported by the driver specified by This.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns4DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Test for the Dns4ServiceBinding Protocol.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiDns4ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  //\r
  // Test for the Udp4ServiceBinding Protocol.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiUdp4ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
\r
  return Status;\r
}\r
\r
/**\r
  Starts a device controller or a bus controller.\r
\r
  The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
  As a result, much of the error checking on the parameters to Start() has been moved into this\r
  common boot service. It is legal to call Start() from other locations,\r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE.\r
  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
     EFI_DEVICE_PATH_PROTOCOL.\r
  3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to start. This handle\r
                                   must support a protocol interface that supplies\r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This\r
                                   parameter is ignored by device drivers, and is optional for bus\r
                                   drivers. For a bus driver, if this parameter is NULL, then handles\r
                                   for all the children of Controller are created by this driver.\r
                                   If this parameter is not NULL and the first Device Path Node is\r
                                   not the End of Device Path Node, then only the handle for the\r
                                   child device specified by the first Device Path Node of\r
                                   RemainingDevicePath is created by this driver.\r
                                   If the first Device Path Node of RemainingDevicePath is\r
                                   the End of Device Path Node, no child handle is created by this\r
                                   driver.\r
\r
  @retval EFI_SUCCESS              The device was started.\r
  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
  @retval Others                   The driver failded to start the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns4DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  DNS_SERVICE            *DnsSb;\r
  EFI_STATUS             Status;\r
\r
  Status = DnsCreateService (ControllerHandle, This->DriverBindingHandle, IP_VERSION_4, &DnsSb);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ASSERT (DnsSb != NULL);\r
\r
  Status = gBS->SetTimer (DnsSb->Timer, TimerPeriodic, TICKS_PER_SECOND);\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Install the Dns4ServiceBinding Protocol onto ControllerHandle.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &ControllerHandle,\r
                  &gEfiDns4ServiceBindingProtocolGuid,\r
                  &DnsSb->ServiceBinding,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  DnsDestroyService (DnsSb);\r
\r
  return Status;\r
}\r
\r
/**\r
  Stops a device controller or a bus controller.\r
\r
  The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r
  As a result, much of the error checking on the parameters to Stop() has been moved\r
  into this common boot service. It is legal to call Stop() from other locations,\r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
     same driver's Start() function.\r
  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
     EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
     Start() function, and the Start() function must have called OpenProtocol() on\r
     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
\r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must\r
                                support a bus specific I/O protocol for the driver\r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL\r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns4DriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
  )\r
{\r
  EFI_SERVICE_BINDING_PROTOCOL               *ServiceBinding;\r
  DNS_SERVICE                                *DnsSb;\r
  EFI_HANDLE                                 NicHandle;\r
  EFI_STATUS                                 Status;\r
  LIST_ENTRY                                 *List;\r
  DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT    Context;\r
\r
  //\r
  // DNS driver opens UDP child, So, Controller is a UDP\r
  // child handle. Locate the Nic handle first. Then get the\r
  // DNS private data back.\r
  //\r
  NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp4ProtocolGuid);\r
\r
  if (NicHandle == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  NicHandle,\r
                  &gEfiDns4ServiceBindingProtocolGuid,\r
                  (VOID **) &ServiceBinding,\r
                  This->DriverBindingHandle,\r
                  NicHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  DnsSb = DNS_SERVICE_FROM_THIS (ServiceBinding);\r
\r
  if (!IsListEmpty (&DnsSb->Dns4ChildrenList)) {\r
    //\r
    // Destroy the Dns child instance in ChildHandleBuffer.\r
    //\r
    List = &DnsSb->Dns4ChildrenList;\r
    Context.ServiceBinding    = ServiceBinding;\r
    Context.NumberOfChildren  = NumberOfChildren;\r
    Context.ChildHandleBuffer = ChildHandleBuffer;\r
    Status = NetDestroyLinkList (\r
               List,\r
               DnsDestroyChildEntryInHandleBuffer,\r
               &Context,\r
               NULL\r
               );\r
  }\r
\r
  if (NumberOfChildren == 0 && IsListEmpty (&DnsSb->Dns4ChildrenList)) {\r
    gBS->UninstallProtocolInterface (\r
           NicHandle,\r
           &gEfiDns4ServiceBindingProtocolGuid,\r
           ServiceBinding\r
           );\r
\r
    DnsDestroyService (DnsSb);\r
\r
    if (gDnsControllerNameTable != NULL) {\r
      FreeUnicodeStringTable (gDnsControllerNameTable);\r
      gDnsControllerNameTable = NULL;\r
    }\r
\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Tests to see if this driver supports a given controller. If a child device is provided,\r
  it further tests to see if this driver supports creating a handle for the specified child device.\r
\r
  This function checks to see if the driver specified by This supports the device specified by\r
  ControllerHandle. Drivers will typically use the device path attached to\r
  ControllerHandle and/or the services from the bus I/O abstraction attached to\r
  ControllerHandle to determine if the driver supports ControllerHandle. This function\r
  may be called many times during platform initialization. In order to reduce boot times, the tests\r
  performed by this function must be very small, and take as little time as possible to execute. This\r
  function must not change the state of any hardware devices, and this function must be aware that the\r
  device specified by ControllerHandle may already be managed by the same driver or a\r
  different driver. This function must match its calls to AllocatePages() with FreePages(),\r
  AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r
  Because ControllerHandle may have been previously started by the same driver, if a protocol is\r
  already in the opened state, then it must not be closed with CloseProtocol(). This is required\r
  to guarantee the state of ControllerHandle is not modified by this function.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to test. This handle\r
                                   must support a protocol interface that supplies\r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This\r
                                   parameter is ignored by device drivers, and is optional for bus\r
                                   drivers. For bus drivers, if this parameter is not NULL, then\r
                                   the bus driver must determine if the bus controller specified\r
                                   by ControllerHandle and the child controller specified\r
                                   by RemainingDevicePath are both supported by this\r
                                   bus driver.\r
\r
  @retval EFI_SUCCESS              The device specified by ControllerHandle and\r
                                   RemainingDevicePath is supported by the driver specified by This.\r
  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by the driver\r
                                   specified by This.\r
  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by a different\r
                                   driver or an application that requires exclusive access.\r
                                   Currently not implemented.\r
  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                   RemainingDevicePath is not supported by the driver specified by This.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns6DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Test for the Dns6ServiceBinding Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiDns6ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  //\r
  // Test for the Udp6ServiceBinding Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiUdp6ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
\r
  return Status;\r
}\r
\r
/**\r
  Starts a device controller or a bus controller.\r
\r
  The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
  As a result, much of the error checking on the parameters to Start() has been moved into this\r
  common boot service. It is legal to call Start() from other locations,\r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE.\r
  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
     EFI_DEVICE_PATH_PROTOCOL.\r
  3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to start. This handle\r
                                   must support a protocol interface that supplies\r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This\r
                                   parameter is ignored by device drivers, and is optional for bus\r
                                   drivers. For a bus driver, if this parameter is NULL, then handles\r
                                   for all the children of Controller are created by this driver.\r
                                   If this parameter is not NULL and the first Device Path Node is\r
                                   not the End of Device Path Node, then only the handle for the\r
                                   child device specified by the first Device Path Node of\r
                                   RemainingDevicePath is created by this driver.\r
                                   If the first Device Path Node of RemainingDevicePath is\r
                                   the End of Device Path Node, no child handle is created by this\r
                                   driver.\r
\r
  @retval EFI_SUCCESS              The device was started.\r
  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
  @retval Others                   The driver failded to start the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns6DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  DNS_SERVICE            *DnsSb;\r
  EFI_STATUS             Status;\r
\r
  Status = DnsCreateService (ControllerHandle, This->DriverBindingHandle, IP_VERSION_6, &DnsSb);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ASSERT (DnsSb != NULL);\r
\r
  Status = gBS->SetTimer (DnsSb->Timer, TimerPeriodic, TICKS_PER_SECOND);\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Install the Dns6ServiceBinding Protocol onto ControllerHandle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &ControllerHandle,\r
                  &gEfiDns6ServiceBindingProtocolGuid,\r
                  &DnsSb->ServiceBinding,\r
                  NULL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  DnsDestroyService (DnsSb);\r
\r
  return Status;\r
}\r
\r
/**\r
  Stops a device controller or a bus controller.\r
\r
  The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r
  As a result, much of the error checking on the parameters to Stop() has been moved\r
  into this common boot service. It is legal to call Stop() from other locations,\r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
     same driver's Start() function.\r
  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
     EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
     Start() function, and the Start() function must have called OpenProtocol() on\r
     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
\r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must\r
                                support a bus specific I/O protocol for the driver\r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL\r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns6DriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
  )\r
{\r
  EFI_SERVICE_BINDING_PROTOCOL               *ServiceBinding;\r
  DNS_SERVICE                                *DnsSb;\r
  EFI_HANDLE                                 NicHandle;\r
  EFI_STATUS                                 Status;\r
  LIST_ENTRY                                 *List;\r
  DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT    Context;\r
\r
  //\r
  // DNS driver opens UDP child, So, Controller is a UDP\r
  // child handle. Locate the Nic handle first. Then get the\r
  // DNS private data back.\r
  //\r
  NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp6ProtocolGuid);\r
\r
  if (NicHandle == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  NicHandle,\r
                  &gEfiDns6ServiceBindingProtocolGuid,\r
                  (VOID **) &ServiceBinding,\r
                  This->DriverBindingHandle,\r
                  NicHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  DnsSb = DNS_SERVICE_FROM_THIS (ServiceBinding);\r
\r
  if (!IsListEmpty (&DnsSb->Dns6ChildrenList)) {\r
    //\r
    // Destroy the Dns child instance in ChildHandleBuffer.\r
    //\r
    List = &DnsSb->Dns6ChildrenList;\r
    Context.ServiceBinding    = ServiceBinding;\r
    Context.NumberOfChildren  = NumberOfChildren;\r
    Context.ChildHandleBuffer = ChildHandleBuffer;\r
    Status = NetDestroyLinkList (\r
               List,\r
               DnsDestroyChildEntryInHandleBuffer,\r
               &Context,\r
               NULL\r
               );\r
  }\r
\r
  if (NumberOfChildren == 0 && IsListEmpty (&DnsSb->Dns6ChildrenList)) {\r
    gBS->UninstallProtocolInterface (\r
           NicHandle,\r
           &gEfiDns6ServiceBindingProtocolGuid,\r
           ServiceBinding\r
           );\r
\r
    DnsDestroyService (DnsSb);\r
\r
    if (gDnsControllerNameTable != NULL) {\r
      FreeUnicodeStringTable (gDnsControllerNameTable);\r
      gDnsControllerNameTable = NULL;\r
    }\r
\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Creates a child handle and installs a protocol.\r
\r
  The CreateChild() function installs a protocol on ChildHandle.\r
  If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.\r
  If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
  @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
                         then a new handle is created. If it is a pointer to an existing UEFI handle,\r
                         then the protocol is added to the existing UEFI handle.\r
\r
  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r
  @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                the child\r
  @retval other                 The child handle was not created\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns4ServiceBindingCreateChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    *ChildHandle\r
  )\r
{\r
  DNS_SERVICE               *DnsSb;\r
  DNS_INSTANCE              *Instance;\r
  EFI_STATUS                Status;\r
  EFI_TPL                   OldTpl;\r
  VOID                      *Udp4;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  DnsSb = DNS_SERVICE_FROM_THIS (This);\r
\r
  Status = DnsCreateInstance (DnsSb, &Instance);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  ASSERT (Instance != NULL);\r
\r
  //\r
  // Install the DNS protocol onto ChildHandle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiDns4ProtocolGuid,\r
                  &Instance->Dns4,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Instance->ChildHandle = *ChildHandle;\r
\r
  //\r
  // Open the Udp4 protocol BY_CHILD.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  DnsSb->ConnectUdp->UdpHandle,\r
                  &gEfiUdp4ProtocolGuid,\r
                  (VOID **) &Udp4,\r
                  gDns4DriverBinding.DriverBindingHandle,\r
                  Instance->ChildHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           Instance->ChildHandle,\r
           &gEfiDns4ProtocolGuid,\r
           &Instance->Dns4,\r
           NULL\r
           );\r
\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Open the Udp4 protocol by child.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Instance->UdpIo->UdpHandle,\r
                  &gEfiUdp4ProtocolGuid,\r
                  (VOID **) &Udp4,\r
                  gDns4DriverBinding.DriverBindingHandle,\r
                  Instance->ChildHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Close the Udp4 protocol.\r
    //\r
    gBS->CloseProtocol (\r
           DnsSb->ConnectUdp->UdpHandle,\r
           &gEfiUdp4ProtocolGuid,\r
           gDns4DriverBinding.DriverBindingHandle,\r
           ChildHandle\r
           );\r
\r
     gBS->UninstallMultipleProtocolInterfaces (\r
            Instance->ChildHandle,\r
            &gEfiDns4ProtocolGuid,\r
            &Instance->Dns4,\r
            NULL\r
            );\r
\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Add it to the parent's child list.\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  InsertTailList (&DnsSb->Dns4ChildrenList, &Instance->Link);\r
  DnsSb->Dns4ChildrenNum++;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
\r
  DnsDestroyInstance (Instance);\r
  return Status;\r
}\r
\r
/**\r
  Destroys a child handle with a protocol installed on it.\r
\r
  The DestroyChild() function does the opposite of CreateChild(). It removes a protocol\r
  that was installed by CreateChild() from ChildHandle. If the removed protocol is the\r
  last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
  @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in] ChildHandle Handle of the child to destroy\r
\r
  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
  @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
  @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
  @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r
                                because its services are being used.\r
  @retval other                 The child handle was not destroyed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns4ServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    ChildHandle\r
  )\r
{\r
  DNS_SERVICE               *DnsSb;\r
  DNS_INSTANCE              *Instance;\r
\r
  EFI_DNS4_PROTOCOL         *Dns4;\r
  EFI_STATUS                Status;\r
  EFI_TPL                   OldTpl;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Retrieve the private context data structures\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ChildHandle,\r
                  &gEfiDns4ProtocolGuid,\r
                  (VOID **) &Dns4,\r
                  gDns4DriverBinding.DriverBindingHandle,\r
                  ChildHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Instance  = DNS_INSTANCE_FROM_THIS_PROTOCOL4 (Dns4);\r
  DnsSb     = DNS_SERVICE_FROM_THIS (This);\r
\r
  if (Instance->Service != DnsSb) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (Instance->InDestroy) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  Instance->InDestroy = TRUE;\r
\r
  //\r
  // Close the Udp4 protocol.\r
  //\r
  gBS->CloseProtocol (\r
         DnsSb->ConnectUdp->UdpHandle,\r
         &gEfiUdp4ProtocolGuid,\r
         gDns4DriverBinding.DriverBindingHandle,\r
         ChildHandle\r
         );\r
\r
  gBS->CloseProtocol (\r
         Instance->UdpIo->UdpHandle,\r
         &gEfiUdp4ProtocolGuid,\r
         gDns4DriverBinding.DriverBindingHandle,\r
         ChildHandle\r
         );\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  //\r
  // Uninstall the DNS protocol first to enable a top down destruction.\r
  //\r
  Status = gBS->UninstallProtocolInterface (\r
                  ChildHandle,\r
                  &gEfiDns4ProtocolGuid,\r
                  Dns4\r
                  );\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  if (EFI_ERROR (Status)) {\r
    Instance->InDestroy = FALSE;\r
    gBS->RestoreTPL (OldTpl);\r
    return Status;\r
  }\r
\r
  RemoveEntryList (&Instance->Link);\r
  DnsSb->Dns4ChildrenNum--;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  DnsDestroyInstance (Instance);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Creates a child handle and installs a protocol.\r
\r
  The CreateChild() function installs a protocol on ChildHandle.\r
  If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.\r
  If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
  @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
                         then a new handle is created. If it is a pointer to an existing UEFI handle,\r
                         then the protocol is added to the existing UEFI handle.\r
\r
  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r
  @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
  @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r
                                the child\r
  @retval other                 The child handle was not created\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns6ServiceBindingCreateChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    *ChildHandle\r
  )\r
{\r
  DNS_SERVICE               *DnsSb;\r
  DNS_INSTANCE              *Instance;\r
  EFI_STATUS                Status;\r
  EFI_TPL                   OldTpl;\r
  VOID                      *Udp6;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  DnsSb = DNS_SERVICE_FROM_THIS (This);\r
\r
  Status = DnsCreateInstance (DnsSb, &Instance);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  ASSERT (Instance != NULL);\r
\r
  //\r
  // Install the DNS protocol onto ChildHandle\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiDns6ProtocolGuid,\r
                  &Instance->Dns6,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Instance->ChildHandle = *ChildHandle;\r
\r
  //\r
  // Open the Udp6 protocol BY_CHILD.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  DnsSb->ConnectUdp->UdpHandle,\r
                  &gEfiUdp6ProtocolGuid,\r
                  (VOID **) &Udp6,\r
                  gDns6DriverBinding.DriverBindingHandle,\r
                  Instance->ChildHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           Instance->ChildHandle,\r
           &gEfiDns6ProtocolGuid,\r
           &Instance->Dns6,\r
           NULL\r
           );\r
\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Open the Udp6 protocol by child.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Instance->UdpIo->UdpHandle,\r
                  &gEfiUdp6ProtocolGuid,\r
                  (VOID **) &Udp6,\r
                  gDns6DriverBinding.DriverBindingHandle,\r
                  Instance->ChildHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Close the Udp6 protocol.\r
    //\r
    gBS->CloseProtocol (\r
           DnsSb->ConnectUdp->UdpHandle,\r
           &gEfiUdp6ProtocolGuid,\r
           gDns6DriverBinding.DriverBindingHandle,\r
           ChildHandle\r
           );\r
\r
     gBS->UninstallMultipleProtocolInterfaces (\r
            Instance->ChildHandle,\r
            &gEfiDns6ProtocolGuid,\r
            &Instance->Dns6,\r
            NULL\r
            );\r
\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Add it to the parent's child list.\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  InsertTailList (&DnsSb->Dns6ChildrenList, &Instance->Link);\r
  DnsSb->Dns6ChildrenNum++;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
\r
  DnsDestroyInstance (Instance);\r
  return Status;\r
}\r
\r
/**\r
  Destroys a child handle with a protocol installed on it.\r
\r
  The DestroyChild() function does the opposite of CreateChild(). It removes a protocol\r
  that was installed by CreateChild() from ChildHandle. If the removed protocol is the\r
  last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
  @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in] ChildHandle Handle of the child to destroy\r
\r
  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
  @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
  @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
  @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r
                                because its services are being used.\r
  @retval other                 The child handle was not destroyed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Dns6ServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    ChildHandle\r
  )\r
{\r
  DNS_SERVICE               *DnsSb;\r
  DNS_INSTANCE              *Instance;\r
\r
  EFI_DNS6_PROTOCOL         *Dns6;\r
  EFI_STATUS                Status;\r
  EFI_TPL                   OldTpl;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Retrieve the private context data structures\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ChildHandle,\r
                  &gEfiDns6ProtocolGuid,\r
                  (VOID **) &Dns6,\r
                  gDns6DriverBinding.DriverBindingHandle,\r
                  ChildHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Instance  = DNS_INSTANCE_FROM_THIS_PROTOCOL6 (Dns6);\r
  DnsSb     = DNS_SERVICE_FROM_THIS (This);\r
\r
  if (Instance->Service != DnsSb) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (Instance->InDestroy) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  Instance->InDestroy = TRUE;\r
\r
  //\r
  // Close the Udp6 protocol.\r
  //\r
  gBS->CloseProtocol (\r
         DnsSb->ConnectUdp->UdpHandle,\r
         &gEfiUdp6ProtocolGuid,\r
         gDns6DriverBinding.DriverBindingHandle,\r
         ChildHandle\r
         );\r
\r
  gBS->CloseProtocol (\r
         Instance->UdpIo->UdpHandle,\r
         &gEfiUdp6ProtocolGuid,\r
         gDns6DriverBinding.DriverBindingHandle,\r
         ChildHandle\r
         );\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  //\r
  // Uninstall the DNS protocol first to enable a top down destruction.\r
  //\r
  Status = gBS->UninstallProtocolInterface (\r
                  ChildHandle,\r
                  &gEfiDns6ProtocolGuid,\r
                  Dns6\r
                  );\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  if (EFI_ERROR (Status)) {\r
    Instance->InDestroy = FALSE;\r
    gBS->RestoreTPL (OldTpl);\r
    return Status;\r
  }\r
\r
  RemoveEntryList (&Instance->Link);\r
  DnsSb->Dns6ChildrenNum--;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  DnsDestroyInstance (Instance);\r
  return EFI_SUCCESS;\r
}\r