]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c
Scrubbed some code for Udp4
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Udp4Dxe / Udp4Driver.c
index dc6fd48ebff9c29905e44968ed3eb4d448b631d7..50959671e8904f94bd76c680563a323177b87259 100644 (file)
@@ -37,15 +37,21 @@ EFI_SERVICE_BINDING_PROTOCOL mUdp4ServiceBinding = {
 \r
 \r
 /**\r
-  Test to see if this driver supports 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 EFI_ALREADY_STARTED    This driver is already running on 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
@@ -90,16 +96,21 @@ Udp4DriverBindingSupported (
 \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
@@ -116,14 +127,15 @@ Udp4DriverBindingStart (
   //\r
   // Allocate Private Context Data Structure.\r
   //\r
-  Udp4Service = NetAllocatePool (sizeof (UDP4_SERVICE_DATA));\r
+  Udp4Service = AllocatePool (sizeof (UDP4_SERVICE_DATA));\r
   if (Udp4Service == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
   Status = Udp4CreateService (Udp4Service, This->DriverBindingHandle, ControllerHandle);\r
   if (EFI_ERROR (Status)) {\r
-    goto FREE_SERVICE;\r
+    gBS->FreePool (Udp4Service);\r
+    return Status;\r
   }\r
 \r
   //\r
@@ -136,36 +148,32 @@ Udp4DriverBindingStart (
                   NULL\r
                   );\r
   if (EFI_ERROR (Status)) {\r
-    goto CLEAN_SERVICE;\r
+    Udp4CleanService (Udp4Service);\r
+    gBS->FreePool (Udp4Service);\r
+  } else {\r
+    Udp4SetVariableData (Udp4Service);\r
   }\r
 \r
-  Udp4SetVariableData (Udp4Service);\r
-\r
-  return Status;\r
-\r
-CLEAN_SERVICE:\r
-\r
-  Udp4CleanService (Udp4Service);\r
-\r
-FREE_SERVICE:\r
-\r
-  NetFreePool (Udp4Service);\r
-\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
@@ -188,7 +196,7 @@ Udp4DriverBindingStop (
   //\r
   NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiIp4ProtocolGuid);\r
   if (NicHandle == NULL) {\r
-    return EFI_SUCCESS;\r
+    return EFI_DEVICE_ERROR;\r
   }\r
 \r
   //\r
@@ -208,51 +216,46 @@ Udp4DriverBindingStop (
 \r
   Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (ServiceBinding);\r
 \r
-  //\r
-  // Uninstall the UDP4 ServiceBinding Protocol.\r
-  //\r
-  Status = gBS->UninstallMultipleProtocolInterfaces (\r
-                  NicHandle,\r
-                  &gEfiUdp4ServiceBindingProtocolGuid,\r
-                  &Udp4Service->ServiceBinding,\r
-                  NULL\r
-                  );\r
-  if (EFI_ERROR (Status)) {\r
-    return EFI_DEVICE_ERROR;\r
-  }\r
+  if (NumberOfChildren == 0) {\r
 \r
-  while (!NetListIsEmpty (&Udp4Service->ChildrenList)) {\r
-    //\r
-    // Destroy all instances.\r
-    //\r
-    Instance = NET_LIST_HEAD (&Udp4Service->ChildrenList, UDP4_INSTANCE_DATA, Link);\r
+    gBS->UninstallMultipleProtocolInterfaces (\r
+           NicHandle,\r
+           &gEfiUdp4ServiceBindingProtocolGuid,\r
+           &Udp4Service->ServiceBinding,\r
+           NULL\r
+           );\r
 \r
-    ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle);\r
-  }\r
+    Udp4ClearVariableData (Udp4Service);\r
 \r
-  Udp4ClearVariableData (Udp4Service);\r
+    Udp4CleanService (Udp4Service);\r
 \r
-  Udp4CleanService (Udp4Service);\r
+    gBS->FreePool (Udp4Service);\r
+  } else {\r
 \r
-  NetFreePool (Udp4Service);\r
+    while (!IsListEmpty (&Udp4Service->ChildrenList)) {\r
+      Instance = NET_LIST_HEAD (&Udp4Service->ChildrenList, UDP4_INSTANCE_DATA, Link);\r
 \r
-  return EFI_SUCCESS;\r
+      ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle);\r
+    }\r
+  }\r
+\r
+  return Status;\r
 }\r
 \r
 \r
 /**\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 I/O 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 I/O services\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
+  @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
@@ -277,7 +280,7 @@ Udp4ServiceBindingCreateChild (
   //\r
   // Allocate the instance private data structure.\r
   //\r
-  Instance = NetAllocatePool (sizeof (UDP4_INSTANCE_DATA));\r
+  Instance = AllocateZeroPool (sizeof (UDP4_INSTANCE_DATA));\r
   if (Instance == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
@@ -290,7 +293,7 @@ Udp4ServiceBindingCreateChild (
   Instance->IpInfo = IpIoAddIp (Udp4Service->IpIo);\r
   if (Instance->IpInfo == NULL) {\r
     Status = EFI_OUT_OF_RESOURCES;\r
-    goto FREE_INSTANCE;\r
+    goto ON_ERROR;\r
   }\r
 \r
   //\r
@@ -303,7 +306,7 @@ Udp4ServiceBindingCreateChild (
                   NULL\r
                   );\r
   if (EFI_ERROR (Status)) {\r
-    goto REMOVE_IPINFO;\r
+    goto ON_ERROR;\r
   }\r
 \r
   Instance->ChildHandle = *ChildHandle;\r
@@ -320,39 +323,39 @@ Udp4ServiceBindingCreateChild (
                   EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                   );\r
   if (EFI_ERROR (Status)) {\r
-    goto UNINSTALL_PROTOCOL;\r
+    goto ON_ERROR;\r
   }\r
 \r
-  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
+  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
   //\r
   // Link this instance into the service context data and increase the ChildrenNumber.\r
   //\r
-  NetListInsertTail (&Udp4Service->ChildrenList, &Instance->Link);\r
+  InsertTailList (&Udp4Service->ChildrenList, &Instance->Link);\r
   Udp4Service->ChildrenNumber++;\r
 \r
-  NET_RESTORE_TPL (OldTpl);\r
-\r
-  return Status;\r
-\r
-UNINSTALL_PROTOCOL:\r
+  gBS->RestoreTPL (OldTpl);\r
 \r
-  gBS->UninstallMultipleProtocolInterfaces (\r
-         Instance->ChildHandle,\r
-         &gEfiUdp4ProtocolGuid,\r
-         &Instance->Udp4Proto,\r
-         NULL\r
-         );\r
+  return EFI_SUCCESS;\r
 \r
-REMOVE_IPINFO:\r
+ON_ERROR:\r
 \r
-  IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo);\r
+  if (Instance->ChildHandle != NULL) {\r
+    gBS->UninstallMultipleProtocolInterfaces (\r
+           Instance->ChildHandle,\r
+           &gEfiUdp4ProtocolGuid,\r
+           &Instance->Udp4Proto,\r
+           NULL\r
+           );\r
+  }\r
 \r
-FREE_INSTANCE:\r
+  if (Instance->IpInfo != NULL) {\r
+    IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo);\r
+  }\r
 \r
   Udp4CleanInstance (Instance);\r
 \r
-  NetFreePool (Instance);\r
+  gBS->FreePool (Instance);\r
 \r
   return Status;\r
 }\r
@@ -361,17 +364,16 @@ FREE_INSTANCE:
 /**\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 I/O services were removed from the child\r
-                                 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\r
-                                 its  I/O 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
@@ -453,12 +455,12 @@ Udp4ServiceBindingDestroyChild (
   //\r
   IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo);\r
 \r
-  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
+  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
   //\r
   // Remove this instance from the service context data's ChildrenList.\r
   //\r
-  NetListRemoveEntry (&Instance->Link);\r
+  RemoveEntryList (&Instance->Link);\r
   Udp4Service->ChildrenNumber--;\r
 \r
   //\r
@@ -466,52 +468,47 @@ Udp4ServiceBindingDestroyChild (
   //\r
   Udp4CleanInstance (Instance);\r
 \r
-  NET_RESTORE_TPL (OldTpl);\r
+  gBS->RestoreTPL (OldTpl);\r
 \r
-  NetFreePool (Instance);\r
+  gBS->FreePool (Instance);\r
 \r
   return EFI_SUCCESS;\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
+  The entry point for Udp4 driver which installs the driver binding\r
+  and component name protocol on its ImageHandle.\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
 Udp4DriverEntryPoint (\r
   IN EFI_HANDLE        ImageHandle,\r
   IN EFI_SYSTEM_TABLE  *SystemTable\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  The entry point for Udp4 driver which installs the driver binding\r
-  and component name protocol on its ImageHandle.\r
-\r
-Arguments:\r
-\r
-  ImageHandle - The image handle of the driver.\r
-  SystemTable - The system table.\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - if the driver binding and component name protocols are\r
-                successfully installed, otherwise if failed.\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
 \r
   //\r
   // Install the Udp4DriverBinding and Udp4ComponentName protocols.\r
   //\r
-  Status = EfiLibInstallAllDriverProtocols (\r
+  Status = EfiLibInstallDriverBindingComponentName2 (\r
              ImageHandle,\r
              SystemTable,\r
              &gUdp4DriverBinding,\r
              ImageHandle,\r
              &gUdp4ComponentName,\r
-             NULL,\r
-             NULL\r
+             &gUdp4ComponentName2\r
              );\r
   if (!EFI_ERROR (Status)) {\r
     //\r