BaseTools:Change the path of the file that Binary Cache
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Dhcp4Dxe / Dhcp4Driver.c
index 5ccbefd..e891b68 100644 (file)
@@ -1,13 +1,7 @@
 /** @file\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation.<BR>\r
-All rights reserved. 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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -32,7 +26,7 @@ EFI_SERVICE_BINDING_PROTOCOL mDhcp4ServiceBindingTemplate = {
   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
+\r
   Entry point of the DHCP driver to install various protocols.\r
 \r
   @param[in]  ImageHandle           The firmware allocated handle for the UEFI image.\r
@@ -106,16 +100,17 @@ Dhcp4DriverBindingSupported (
   Configure the default UDP child to receive all the DHCP traffics\r
   on this network interface.\r
 \r
-  @param[in]  UdpIo                  The UDP IO port to configure\r
+  @param[in]  UdpIo                  The UDP IO to configure\r
   @param[in]  Context                The context to the function\r
 \r
-  @retval EFI_SUCCESS            The UDP IO port is successfully configured.\r
+  @retval EFI_SUCCESS            The UDP IO is successfully configured.\r
   @retval Others                 Failed to configure the UDP child.\r
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 DhcpConfigUdpIo (\r
-  IN UDP_IO_PORT            *UdpIo,\r
+  IN UDP_IO                 *UdpIo,\r
   IN VOID                   *Context\r
   )\r
 {\r
@@ -139,17 +134,17 @@ DhcpConfigUdpIo (
   ZeroMem (&UdpConfigData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
   ZeroMem (&UdpConfigData.RemoteAddress, sizeof (EFI_IPv4_ADDRESS));\r
 \r
-  return UdpIo->Udp->Configure (UdpIo->Udp, &UdpConfigData);;\r
+  return UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfigData);;\r
 }\r
 \r
 \r
 \r
 /**\r
-  Destory the DHCP service. The Dhcp4 service may be partly initialized,\r
+  Destroy the DHCP service. The Dhcp4 service may be partly initialized,\r
   or partly destroyed. If a resource is destroyed, it is marked as so in\r
   case the destroy failed and being called again later.\r
 \r
-  @param[in]  DhcpSb                 The DHCP service instance to destory.\r
+  @param[in]  DhcpSb                 The DHCP service instance to destroy.\r
 \r
   @retval EFI_SUCCESS            Always return success.\r
 \r
@@ -162,7 +157,7 @@ Dhcp4CloseService (
   DhcpCleanLease (DhcpSb);\r
 \r
   if (DhcpSb->UdpIo != NULL) {\r
-    UdpIoFreePort (DhcpSb->UdpIo);\r
+    UdpIoFreeIo (DhcpSb->UdpIo);\r
     DhcpSb->UdpIo = NULL;\r
   }\r
 \r
@@ -211,7 +206,6 @@ Dhcp4CreateService (
 \r
   DhcpSb->Signature       = DHCP_SERVICE_SIGNATURE;\r
   DhcpSb->ServiceState    = DHCP_UNCONFIGED;\r
-  DhcpSb->InDestory       = FALSE;\r
   DhcpSb->Controller      = Controller;\r
   DhcpSb->Image           = ImageHandle;\r
   InitializeListHead (&DhcpSb->Children);\r
@@ -237,7 +231,13 @@ Dhcp4CreateService (
     goto ON_ERROR;\r
   }\r
 \r
-  DhcpSb->UdpIo = UdpIoCreatePort (Controller, ImageHandle, DhcpConfigUdpIo, NULL);\r
+  DhcpSb->UdpIo = UdpIoCreateIo (\r
+                    Controller,\r
+                    ImageHandle,\r
+                    DhcpConfigUdpIo,\r
+                    UDP_IO_UDP4_VERSION,\r
+                    NULL\r
+                    );\r
 \r
   if (DhcpSb->UdpIo == NULL) {\r
     Status = EFI_OUT_OF_RESOURCES;\r
@@ -309,7 +309,16 @@ Dhcp4DriverBindingStart (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
+  ASSERT (DhcpSb != NULL);\r
 \r
+  //\r
+  // Start the receiving\r
+  //\r
+  Status = UdpIoRecvDatagram (DhcpSb->UdpIo, DhcpInput, DhcpSb, 0);\r
+\r
+  if (EFI_ERROR (Status)) {\r
+    goto ON_ERROR;\r
+  }\r
   Status = gBS->SetTimer (DhcpSb->Timer, TimerPeriodic, TICKS_PER_SECOND);\r
 \r
   if (EFI_ERROR (Status)) {\r
@@ -338,6 +347,36 @@ ON_ERROR:
   return Status;\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
+Dhcp4DestroyChildEntry (\r
+  IN LIST_ENTRY         *Entry,\r
+  IN VOID               *Context\r
+  )\r
+{\r
+  DHCP_PROTOCOL                    *Instance;\r
+  EFI_SERVICE_BINDING_PROTOCOL     *ServiceBinding;\r
+\r
+  if (Entry == NULL || Context == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Instance = NET_LIST_USER_STRUCT_S (Entry, DHCP_PROTOCOL, Link, DHCP_PROTOCOL_SIGNATURE);\r
+  ServiceBinding = (EFI_SERVICE_BINDING_PROTOCOL *) Context;\r
+\r
+  return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
+}\r
+\r
 \r
 /**\r
   Stop this driver on ControllerHandle. This service is called by the\r
@@ -346,7 +385,7 @@ ON_ERROR:
   restrictions for this service. DisconnectController()\r
   must follow these calling restrictions. If any other agent wishes\r
   to call Stop() it must also follow these calling restrictions.\r
-  \r
+\r
   @param[in]  This              Protocol instance pointer.\r
   @param[in]  ControllerHandle  Handle of device to stop driver on\r
   @param[in]  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
@@ -368,10 +407,10 @@ Dhcp4DriverBindingStop (
 {\r
   EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;\r
   DHCP_SERVICE                  *DhcpSb;\r
-  DHCP_PROTOCOL                 *Instance;\r
   EFI_HANDLE                    NicHandle;\r
   EFI_STATUS                    Status;\r
-  EFI_TPL                       OldTpl;\r
+  LIST_ENTRY                    *List;\r
+  UINTN                         ListLength;\r
 \r
   //\r
   // DHCP driver opens UDP child, So, the ControllerHandle is the\r
@@ -380,7 +419,7 @@ Dhcp4DriverBindingStop (
   NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp4ProtocolGuid);\r
 \r
   if (NicHandle == NULL) {\r
-    return EFI_DEVICE_ERROR;\r
+    return EFI_SUCCESS;\r
   }\r
 \r
    Status = gBS->OpenProtocol (\r
@@ -397,17 +436,31 @@ Dhcp4DriverBindingStop (
   }\r
 \r
   DhcpSb = DHCP_SERVICE_FROM_THIS (ServiceBinding);\r
-\r
-  if (DhcpSb->InDestory) {\r
-    return EFI_SUCCESS;\r
+  if (!IsListEmpty (&DhcpSb->Children)) {\r
+    //\r
+    // Destroy all the children instances before destory the service.\r
+    //\r
+    List = &DhcpSb->Children;\r
+    Status = NetDestroyLinkList (\r
+               List,\r
+               Dhcp4DestroyChildEntry,\r
+               ServiceBinding,\r
+               &ListLength\r
+               );\r
+    if (EFI_ERROR (Status) || ListLength != 0) {\r
+      Status = EFI_DEVICE_ERROR;\r
+    }\r
   }\r
 \r
-  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
-\r
-  if (NumberOfChildren == 0) {\r
+  if (NumberOfChildren == 0 && !IsListEmpty (&DhcpSb->Children)) {\r
+    Status = EFI_DEVICE_ERROR;\r
+  }\r
 \r
-    DhcpSb->InDestory    = TRUE;\r
-    DhcpSb->ServiceState = DHCP_DESTORY;\r
+  if (NumberOfChildren == 0 && IsListEmpty (&DhcpSb->Children)) {\r
+    //\r
+    // Destroy the service itself if no child instance left.\r
+    //\r
+    DhcpSb->ServiceState = DHCP_DESTROY;\r
 \r
     gBS->UninstallProtocolInterface (\r
            NicHandle,\r
@@ -417,24 +470,15 @@ Dhcp4DriverBindingStop (
 \r
     Dhcp4CloseService (DhcpSb);\r
 \r
-    FreePool (DhcpSb);\r
-  } else {\r
-    //\r
-    // Don't use NET_LIST_FOR_EACH_SAFE here, Dhcp4ServiceBindingDestoryChild\r
-    // may cause other child to be deleted.\r
-    //\r
-    while (!IsListEmpty (&DhcpSb->Children)) {\r
-      Instance = NET_LIST_HEAD (&DhcpSb->Children, DHCP_PROTOCOL, Link);\r
-      ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
+    if (gDhcpControllerNameTable != NULL) {\r
+      FreeUnicodeStringTable (gDhcpControllerNameTable);\r
+      gDhcpControllerNameTable = NULL;\r
     }\r
+    FreePool (DhcpSb);\r
 \r
-    if (DhcpSb->NumChildren != 0) {\r
-      Status = EFI_DEVICE_ERROR;\r
-    }\r
+    Status = EFI_SUCCESS;\r
   }\r
 \r
-  gBS->RestoreTPL (OldTpl);\r
-\r
   return Status;\r
 }\r
 \r
@@ -457,30 +501,31 @@ DhcpInitProtocol (
   InitializeListHead (&Instance->Link);\r
   Instance->Handle            = NULL;\r
   Instance->Service           = DhcpSb;\r
-  Instance->InDestory         = FALSE;\r
+  Instance->InDestroy         = FALSE;\r
   Instance->CompletionEvent   = NULL;\r
   Instance->RenewRebindEvent  = NULL;\r
   Instance->Token             = NULL;\r
   Instance->UdpIo             = NULL;\r
+  Instance->ElaspedTime       = 0;\r
   NetbufQueInit (&Instance->ResponseQueue);\r
 }\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
+\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  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
   @param  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 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 availabe to create\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
@@ -564,9 +609,9 @@ Dhcp4ServiceBindingCreateChild (
 \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
+\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  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@@ -574,7 +619,7 @@ Dhcp4ServiceBindingCreateChild (
 \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 not a valid UEFI Handle.\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
@@ -623,15 +668,15 @@ Dhcp4ServiceBindingDestroyChild (
   //\r
   // A child can be destroyed more than once. For example,\r
   // Dhcp4DriverBindingStop will destroy all of its children.\r
-  // when caller driver is being stopped, it will destory the\r
+  // when caller driver is being stopped, it will destroy the\r
   // dhcp child it opens.\r
   //\r
-  if (Instance->InDestory) {\r
+  if (Instance->InDestroy) {\r
     return EFI_SUCCESS;\r
   }\r
 \r
   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
-  Instance->InDestory = TRUE;\r
+  Instance->InDestroy = TRUE;\r
 \r
   //\r
   // Close the Udp4 protocol.\r
@@ -646,14 +691,15 @@ Dhcp4ServiceBindingDestroyChild (
   //\r
   // Uninstall the DHCP4 protocol first to enable a top down destruction.\r
   //\r
+  gBS->RestoreTPL (OldTpl);\r
   Status = gBS->UninstallProtocolInterface (\r
                   ChildHandle,\r
                   &gEfiDhcp4ProtocolGuid,\r
                   Dhcp\r
                   );\r
-\r
+  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
   if (EFI_ERROR (Status)) {\r
-    Instance->InDestory = FALSE;\r
+    Instance->InDestroy = FALSE;\r
 \r
     gBS->RestoreTPL (OldTpl);\r
     return Status;\r
@@ -666,6 +712,19 @@ Dhcp4ServiceBindingDestroyChild (
   RemoveEntryList (&Instance->Link);\r
   DhcpSb->NumChildren--;\r
 \r
+  if (Instance->UdpIo != NULL) {\r
+    UdpIoCleanIo (Instance->UdpIo);\r
+    gBS->CloseProtocol (\r
+           Instance->UdpIo->UdpHandle,\r
+           &gEfiUdp4ProtocolGuid,\r
+           Instance->Service->Image,\r
+           Instance->Handle\r
+           );\r
+    UdpIoFreeIo (Instance->UdpIo);\r
+    Instance->UdpIo = NULL;\r
+    Instance->Token = NULL;\r
+  }\r
+\r
   gBS->RestoreTPL (OldTpl);\r
 \r
   FreePool (Instance);\r