]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.c
Scrubbed part of the code.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Dhcp4Dxe / Dhcp4Driver.c
index 4d78b87ad1187ffa24591d0572fd9060d9f17f11..c804172e109f627f7f81234052299ca95b2135b4 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation\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
@@ -31,35 +31,31 @@ EFI_DRIVER_BINDING_PROTOCOL gDhcp4DriverBinding = {
   NULL\r
 };\r
 \r
-EFI_SERVICE_BINDING_PROTOCOL mDhcp4ServiceBindingTemplete = {\r
+EFI_SERVICE_BINDING_PROTOCOL mDhcp4ServiceBindingTemplate = {\r
   Dhcp4ServiceBindingCreateChild,\r
   Dhcp4ServiceBindingDestroyChild\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
+  Entry point of the DHCP driver to install various protocols.\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 EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 Dhcp4DriverEntryPoint (\r
   IN EFI_HANDLE             ImageHandle,\r
   IN EFI_SYSTEM_TABLE       *SystemTable\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Entry point of the DHCP driver to install various protocols.\r
-\r
-Arguments:\r
-\r
-  ImageHandle - The driver's image handle\r
-  SystemTable - The system table\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - All the related protocols are installed.\r
-  Others      - Failed to install the protocols.\r
-\r
---*/\r
 {\r
   return EfiLibInstallDriverBindingComponentName2 (\r
            ImageHandle,\r
@@ -73,15 +69,21 @@ Returns:
 \r
 \r
 /**\r
-  Test to see if DHCP driver supports the ControllerHandle.\r
-\r
-  @param  This                   Protocol instance pointer.\r
-  @param  ControllerHandle       Handle of device to test\r
-  @param  RemainingDevicePath    Optional parameter use to pick a specific child\r
-                                 device to start.\r
-\r
-  @retval EFI_SUCCES             This driver supports this device\r
-  @retval other                  This driver does not support this device\r
+  Test to see if this driver supports ControllerHandle. This service\r
+  is called by the EFI boot service ConnectController(). In\r
+  order to make drivers as small as possible, there are a few calling\r
+  restrictions for this service. ConnectController() must\r
+  follow these calling restrictions. If any other agent wishes to call\r
+  Supported() it must also follow these calling restrictions.\r
+\r
+  @param  This                Protocol instance pointer.\r
+  @param  ControllerHandle    Handle of device to test\r
+  @param  RemainingDevicePath Optional parameter use to pick a specific child\r
+                              device to start.\r
+\r
+  @retval EFI_SUCCESS         This driver supports this device\r
+  @retval EFI_ALREADY_STARTED This driver is already running on this device\r
+  @retval other               This driver does not support this device\r
 \r
 **/\r
 EFI_STATUS\r
@@ -141,9 +143,9 @@ DhcpConfigUdpIo (
   UdpConfigData.StationPort               = DHCP_CLIENT_PORT;\r
   UdpConfigData.RemotePort                = DHCP_SERVER_PORT;\r
 \r
-  NetZeroMem (&UdpConfigData.StationAddress, sizeof (EFI_IPv4_ADDRESS));\r
-  NetZeroMem (&UdpConfigData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
-  NetZeroMem (&UdpConfigData.RemoteAddress, sizeof (EFI_IPv4_ADDRESS));\r
+  ZeroMem (&UdpConfigData.StationAddress, sizeof (EFI_IPv4_ADDRESS));\r
+  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
 }\r
@@ -152,12 +154,12 @@ DhcpConfigUdpIo (
 \r
 /**\r
   Destory the DHCP service. The Dhcp4 service may be partly initialized,\r
-  or partly destoried. If a resource is destoried, it is marked as so in\r
-  case the destory failed and being called again later.\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  DhcpSb                 The DHCP service instance to destory.\r
 \r
-  @retval EFI_SUCCESS            The DHCP service is successfully closed.\r
+  @retval EFI_SUCCESS            Always return success.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -195,6 +197,7 @@ Dhcp4CloseService (
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate resource .\r
   @retval EFI_SUCCESS            The DHCP service instance is created.\r
+  @retval other                  Other error occurs.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -208,28 +211,31 @@ Dhcp4CreateService (
   EFI_STATUS                Status;\r
 \r
   *Service  = NULL;\r
-  DhcpSb    = NetAllocateZeroPool (sizeof (DHCP_SERVICE));\r
+  DhcpSb    = AllocateZeroPool (sizeof (DHCP_SERVICE));\r
 \r
   if (DhcpSb == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
   DhcpSb->Signature       = DHCP_SERVICE_SIGNATURE;\r
-  DhcpSb->ServiceBinding  = mDhcp4ServiceBindingTemplete;\r
   DhcpSb->ServiceState    = DHCP_UNCONFIGED;\r
   DhcpSb->InDestory       = FALSE;\r
   DhcpSb->Controller      = Controller;\r
   DhcpSb->Image           = ImageHandle;\r
-  NetListInit (&DhcpSb->Children);\r
+  InitializeListHead (&DhcpSb->Children);\r
   DhcpSb->DhcpState       = Dhcp4Stopped;\r
   DhcpSb->Xid             = NET_RANDOM (NetRandomInitSeed ());\r
-\r
+  CopyMem (\r
+    &DhcpSb->ServiceBinding,\r
+    &mDhcp4ServiceBindingTemplate,\r
+    sizeof (EFI_SERVICE_BINDING_PROTOCOL)\r
+    );\r
   //\r
   // Create various resources, UdpIo, Timer, and get Mac address\r
   //\r
   Status = gBS->CreateEvent (\r
                   EVT_NOTIFY_SIGNAL | EVT_TIMER,\r
-                  NET_TPL_TIMER,\r
+                  TPL_CALLBACK,\r
                   DhcpOnTimerTick,\r
                   DhcpSb,\r
                   &DhcpSb->Timer\r
@@ -255,23 +261,28 @@ Dhcp4CreateService (
 \r
 ON_ERROR:\r
   Dhcp4CloseService (DhcpSb);\r
-  NetFreePool (DhcpSb);\r
+  gBS->FreePool (DhcpSb);\r
 \r
   return Status;\r
 }\r
 \r
 \r
 /**\r
-  Start this driver on ControllerHandle.\r
-\r
-  @param  This                   Protocol instance pointer.\r
-  @param  ControllerHandle       Handle of device to bind driver to\r
-  @param  RemainingDevicePath    Optional parameter use to pick a specific child\r
-                                 device to start.\r
-\r
-  @retval EFI_SUCCES             This driver is added to ControllerHandle\r
-  @retval EFI_ALREADY_STARTED    This driver is already running on ControllerHandle\r
-  @retval other                  This driver does not support this device\r
+  Start this driver on ControllerHandle. This service is called by the\r
+  EFI boot service ConnectController(). In order to make\r
+  drivers as small as possible, there are a few calling restrictions for\r
+  this service. ConnectController() must follow these\r
+  calling restrictions. If any other agent wishes to call Start() it\r
+  must also follow these calling restrictions.\r
+\r
+  @param  This                 Protocol instance pointer.\r
+  @param  ControllerHandle     Handle of device to bind driver to\r
+  @param  RemainingDevicePath  Optional parameter use to pick a specific child\r
+                               device to start.\r
+\r
+  @retval EFI_SUCCESS          This driver is added to ControllerHandle\r
+  @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle\r
+  @retval other                This driver does not support this device\r
 \r
 **/\r
 EFI_STATUS\r
@@ -331,22 +342,27 @@ Dhcp4DriverBindingStart (
 \r
 ON_ERROR:\r
   Dhcp4CloseService (DhcpSb);\r
-  NetFreePool (DhcpSb);\r
+  gBS->FreePool (DhcpSb);\r
   return Status;\r
 }\r
 \r
 \r
 /**\r
-  Stop this driver on ControllerHandle.\r
-\r
-  @param  This                   Protocol instance pointer.\r
-  @param  ControllerHandle       Handle of device to stop driver on\r
-  @param  NumberOfChildren       Number of Handles in ChildHandleBuffer. If number\r
-                                 of  children is zero stop the entire bus driver.\r
-  @param  ChildHandleBuffer      List of Child Handles to Stop.\r
-\r
-  @retval EFI_SUCCES             This driver is removed ControllerHandle\r
-  @retval other                  This driver was not removed from this device\r
+  Stop this driver on ControllerHandle. This service is called by the\r
+  EFI boot service DisconnectController(). In order to\r
+  make drivers as small as possible, there are a few calling\r
+  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
+  @param  This              Protocol instance pointer.\r
+  @param  ControllerHandle  Handle of device to stop driver on\r
+  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
+                            children is zero stop the entire bus driver.\r
+  @param  ChildHandleBuffer List of Child Handles to Stop.\r
+\r
+  @retval EFI_SUCCESS       This driver is removed ControllerHandle\r
+  @retval other             This driver was not removed from this device\r
 \r
 **/\r
 EFI_STATUS\r
@@ -394,7 +410,7 @@ Dhcp4DriverBindingStop (
     return EFI_SUCCESS;\r
   }\r
 \r
-  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
+  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
   if (NumberOfChildren == 0) {\r
 \r
@@ -409,13 +425,13 @@ Dhcp4DriverBindingStop (
 \r
     Dhcp4CloseService (DhcpSb);\r
 \r
-    NetFreePool (DhcpSb);\r
+    gBS->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 (!NetListIsEmpty (&DhcpSb->Children)) {\r
+    while (!IsListEmpty (&DhcpSb->Children)) {\r
       Instance = NET_LIST_HEAD (&DhcpSb->Children, DHCP_PROTOCOL, Link);\r
       ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
     }\r
@@ -425,14 +441,14 @@ Dhcp4DriverBindingStop (
     }\r
   }\r
 \r
-  NET_RESTORE_TPL (OldTpl);\r
+  gBS->RestoreTPL (OldTpl);\r
 \r
   return Status;\r
 }\r
 \r
 \r
 /**\r
-  Initialize a new DHCP child\r
+  Initialize a new DHCP instance.\r
 \r
   @param  DhcpSb                 The dhcp service instance\r
   @param  Instance               The dhcp instance to initialize\r
@@ -442,13 +458,13 @@ Dhcp4DriverBindingStop (
 **/\r
 VOID\r
 DhcpInitProtocol (\r
-  IN DHCP_SERVICE           *DhcpSb,\r
-  IN DHCP_PROTOCOL          *Instance\r
+  IN     DHCP_SERVICE           *DhcpSb,\r
+  IN OUT DHCP_PROTOCOL          *Instance\r
   )\r
 {\r
   Instance->Signature         = DHCP_PROTOCOL_SIGNATURE;\r
   CopyMem (&Instance->Dhcp4Protocol, &mDhcp4ProtocolTemplate, sizeof (Instance->Dhcp4Protocol));\r
-  NetListInit (&Instance->Link);\r
+  InitializeListHead (&Instance->Link);\r
   Instance->Handle            = NULL;\r
   Instance->Service           = DhcpSb;\r
   Instance->InDestory         = FALSE;\r
@@ -461,18 +477,18 @@ DhcpInitProtocol (
 \r
 \r
 /**\r
-  Creates a child handle with a set of DHCP4 services.\r
+  Creates a child handle with a set of I/O services.\r
 \r
-  @param  This                   Protocol instance pointer.\r
-  @param  ChildHandle            Pointer to the handle of the child to create.  If\r
-                                 it  is NULL, then a new handle is created.  If it\r
-                                 is not  NULL, then the DHCP4 services are added to\r
-                                 the existing  child handle.\r
+  @param  This        Protocol instance pointer.\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 not NULL, then the\r
+                      I/O services are added to the existing child handle.\r
 \r
-  @retval EFI_SUCCES             The child handle was created with the DHCP4\r
-                                 services\r
-  @retval EFI_OUT_OF_RESOURCES   There are not enough resources to create the child\r
-  @retval other                  The child handle was not created\r
+  @retval EFI_SUCCES            The child handle was created with the I/O services\r
+  @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES  There are not enough resources availabe to create\r
+                                the child\r
+  @retval other                 The child handle was not created\r
 \r
 **/\r
 EFI_STATUS\r
@@ -492,7 +508,7 @@ Dhcp4ServiceBindingCreateChild (
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
-  Instance = NetAllocatePool (sizeof (*Instance));\r
+  Instance = AllocatePool (sizeof (*Instance));\r
 \r
   if (Instance == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
@@ -512,7 +528,7 @@ Dhcp4ServiceBindingCreateChild (
                   );\r
 \r
   if (EFI_ERROR (Status)) {\r
-    NetFreePool (Instance);\r
+    gBS->FreePool (Instance);\r
     return Status;\r
   }\r
 \r
@@ -537,34 +553,34 @@ Dhcp4ServiceBindingCreateChild (
            NULL\r
            );\r
 \r
-    NetFreePool (Instance);\r
+    gBS->FreePool (Instance);\r
     return Status;\r
   }\r
 \r
-  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
+  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
-  NetListInsertTail (&DhcpSb->Children, &Instance->Link);\r
+  InsertTailList (&DhcpSb->Children, &Instance->Link);\r
   DhcpSb->NumChildren++;\r
 \r
-  NET_RESTORE_TPL (OldTpl);\r
+  gBS->RestoreTPL (OldTpl);\r
 \r
   return EFI_SUCCESS;\r
 }\r
 \r
 \r
 /**\r
-  Destroys a child handle with a set of DHCP4 services.\r
+  Destroys a child handle with a set of I/O services.\r
 \r
-  @param  This                   Protocol instance pointer.\r
-  @param  ChildHandle            Handle of the child to destroy\r
+  @param  This        Protocol instance pointer.\r
+  @param  ChildHandle Handle of the child to destroy\r
 \r
-  @retval EFI_SUCCES             The DHCP4 service is removed from the child handle\r
-  @retval EFI_UNSUPPORTED        The child handle does not support the DHCP4\r
-                                 service\r
-  @retval EFI_INVALID_PARAMETER  Child handle is not a valid EFI Handle.\r
-  @retval EFI_ACCESS_DENIED      The child handle could not be destroyed because\r
-                                 its  DHCP4 services are being used.\r
-  @retval other                  The child handle was not destroyed\r
+  @retval EFI_SUCCES            The I/O services were removed from the child handle\r
+  @retval EFI_UNSUPPORTED       The child handle does not support the I/O services\r
+                                that are being removed.\r
+  @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
+  @retval EFI_ACCESS_DENIED     The child handle could not be destroyed because its\r
+                                I/O services are being used.\r
+  @retval other                 The child handle was not destroyed\r
 \r
 **/\r
 EFI_STATUS\r
@@ -608,8 +624,8 @@ Dhcp4ServiceBindingDestroyChild (
   }\r
 \r
   //\r
-  // A child can be destoried more than once. For example,\r
-  // Dhcp4DriverBindingStop will destory all of its children.\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
   // dhcp child it opens.\r
   //\r
@@ -617,7 +633,7 @@ Dhcp4ServiceBindingDestroyChild (
     return EFI_SUCCESS;\r
   }\r
 \r
-  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
+  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
   Instance->InDestory = TRUE;\r
 \r
   //\r
@@ -642,7 +658,7 @@ Dhcp4ServiceBindingDestroyChild (
   if (EFI_ERROR (Status)) {\r
     Instance->InDestory = FALSE;\r
 \r
-    NET_RESTORE_TPL (OldTpl);\r
+    gBS->RestoreTPL (OldTpl);\r
     return Status;\r
   }\r
 \r
@@ -650,11 +666,11 @@ Dhcp4ServiceBindingDestroyChild (
     DhcpYieldControl (DhcpSb);\r
   }\r
 \r
-  NetListRemoveEntry (&Instance->Link);\r
+  RemoveEntryList (&Instance->Link);\r
   DhcpSb->NumChildren--;\r
 \r
-  NET_RESTORE_TPL (OldTpl);\r
+  gBS->RestoreTPL (OldTpl);\r
 \r
-  NetFreePool (Instance);\r
+  gBS->FreePool (Instance);\r
   return EFI_SUCCESS;\r
 }\r