1. Add EFI_COMPONENT_NAME2_PROTOCOL.GetControllerName() support.

2. Fix the driver binding Stop() hang issue in the network stack.
3. Add Ip4 raw data support.
4. Add iSCSI Dhcp option 60 support.

Signed-off-by: Fu Siyuan <siyuan.fu@intel.com>
Reviewed-by: Ye Ting <ting.ye@intel.com>
Reviewed-by: Ouyang Qian <qian.ouyang@intel.com>

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13995 6f19259b-4bc3-4df7-8a09-765794883524

6 files changed, 280 insertions, 52 deletions

diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c
index 71f49f6..901c2df 100644
--- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c
+++ b/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c
@@ -1,7 +1,7 @@
 /** @file

   UEFI Component Name(2) protocol implementation for Mtftp4Dxe driver.

   

-Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -12,7 +12,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 **/

 

-#include "Mtftp4Driver.h"

+#include "Mtftp4Impl.h"

 

 //

 // EFI Component Name Functions

@@ -174,6 +174,8 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMtftp4DriverNameTable[]
   }

 };

 

+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gMtftp4ControllerNameTable = NULL;

+

 /**

   Retrieves a Unicode string that is the user readable name of the driver.

 

@@ -231,6 +233,72 @@ Mtftp4ComponentNameGetDriverName (
 }

 

 /**

+  Update the component name for the Mtftp4 child handle.

+

+  @param  Mtftp4[in]                A pointer to the EFI_MTFTP4_PROTOCOL.

+

+  

+  @retval EFI_SUCCESS               Update the ControllerNameTable of this instance successfully.

+  @retval EFI_INVALID_PARAMETER     The input parameter is invalid.

+  

+**/

+EFI_STATUS

+UpdateName (

+  IN   EFI_MTFTP4_PROTOCOL             *Mtftp4

+  )

+{

+  EFI_STATUS                       Status;

+  CHAR16                           HandleName[80];

+  EFI_MTFTP4_MODE_DATA             ModeData;

+

+  if (Mtftp4 == NULL) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  //

+  // Format the child name into the string buffer as:

+  // MTFTPv4 (ServerIp=192.168.1.10, ServerPort=69)

+  //

+  Status = Mtftp4->GetModeData (Mtftp4, &ModeData);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  UnicodeSPrint (HandleName, sizeof (HandleName),

+    L"MTFTPv4 (ServerIp=%d.%d.%d.%d, ServerPort=%d)",

+    ModeData.ConfigData.ServerIp.Addr[0],

+    ModeData.ConfigData.ServerIp.Addr[1],

+    ModeData.ConfigData.ServerIp.Addr[2],

+    ModeData.ConfigData.ServerIp.Addr[3],

+    ModeData.ConfigData.InitialServerPort

+    );

+

+  if (gMtftp4ControllerNameTable != NULL) {

+    FreeUnicodeStringTable (gMtftp4ControllerNameTable);

+    gMtftp4ControllerNameTable = NULL;

+  }

+  

+  Status = AddUnicodeString2 (

+             "eng",

+             gMtftp4ComponentName.SupportedLanguages,

+             &gMtftp4ControllerNameTable,

+             HandleName,

+             TRUE

+             );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+  

+  return AddUnicodeString2 (

+           "en",

+           gMtftp4ComponentName2.SupportedLanguages,

+           &gMtftp4ControllerNameTable,

+           HandleName,

+           FALSE

+           );

+}

+

+/**

   Retrieves a Unicode string that is the user readable name of the controller

   that is being managed by a driver.

 

@@ -308,5 +376,56 @@ Mtftp4ComponentNameGetControllerName (
      OUT CHAR16                                    **ControllerName

   )

 {

-  return EFI_UNSUPPORTED;

+  EFI_STATUS                    Status;

+  EFI_MTFTP4_PROTOCOL           *Mtftp4;

+

+  //

+  // Only provide names for child handles.

+  //

+  if (ChildHandle == NULL) {

+    return EFI_UNSUPPORTED;

+  }

+  

+  // 

+  // Make sure this driver produced ChildHandle 

+  // 

+  Status = EfiTestChildHandle (

+             ControllerHandle,

+             ChildHandle,

+             &gEfiUdp4ProtocolGuid

+             );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  // 

+  // Retrieve an instance of a produced protocol from ChildHandle

+  // 

+  Status = gBS->OpenProtocol (

+                  ChildHandle,

+                  &gEfiMtftp4ProtocolGuid,

+                  (VOID **)&Mtftp4,

+                  NULL,

+                  NULL,

+                  EFI_OPEN_PROTOCOL_GET_PROTOCOL

+                  );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

+  // Update the component name for this child handle.

+  //

+  Status = UpdateName (Mtftp4);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           gMtftp4ControllerNameTable,

+           ControllerName,

+           (BOOLEAN)(This == &gMtftp4ComponentName)

+           );

 }

diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.c
index 2a12b1d..8da47fc 100644
--- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.c
+++ b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.c
@@ -159,7 +159,6 @@ Mtftp4CreateService (
 

   MtftpSb->Signature      = MTFTP4_SERVICE_SIGNATURE;

   MtftpSb->ServiceBinding = gMtftp4ServiceBindingTemplete;

-  MtftpSb->InDestroy      = FALSE;

   MtftpSb->ChildrenNum    = 0;

   InitializeListHead (&MtftpSb->Children);

 

@@ -318,6 +317,42 @@ ON_ERROR:
   return Status;

 }

 

+/**

+  Callback function which provided by user to remove one node in NetDestroyLinkList process.

+  

+  @param[in]    Entry           The entry to be removed.

+  @param[in]    Context         Pointer to the callback context corresponds to the Context in NetDestroyLinkList.

+

+  @retval EFI_SUCCESS           The entry has been removed successfully.

+  @retval Others                Fail to remove the entry.

+

+**/

+EFI_STATUS

+Mtftp4DestroyChildEntryInHandleBuffer (

+  IN LIST_ENTRY         *Entry,

+  IN VOID               *Context

+)

+{

+  MTFTP4_PROTOCOL               *Instance;

+  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;

+  UINTN                         NumberOfChildren;

+  EFI_HANDLE                    *ChildHandleBuffer;

+

+  if (Entry == NULL || Context == NULL) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  Instance = NET_LIST_USER_STRUCT_S (Entry, MTFTP4_PROTOCOL, Link, MTFTP4_PROTOCOL_SIGNATURE);

+  ServiceBinding    = ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ServiceBinding;

+  NumberOfChildren  = ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->NumberOfChildren;

+  ChildHandleBuffer = ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ChildHandleBuffer;

+

+  if (!NetIsInHandleBuffer (Instance->Handle, NumberOfChildren, ChildHandleBuffer)) {

+    return EFI_SUCCESS;

+  }

+

+  return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);

+}

 

 /**

   Stop the MTFTP driver on controller. The controller is a UDP

@@ -341,12 +376,12 @@ Mtftp4DriverBindingStop (
   IN EFI_HANDLE                  *ChildHandleBuffer

   )

 {

-  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;

-  MTFTP4_SERVICE                *MtftpSb;

-  MTFTP4_PROTOCOL               *Instance;

-  EFI_HANDLE                    NicHandle;

-  EFI_STATUS                    Status;

-  EFI_TPL                       OldTpl;

+  EFI_SERVICE_BINDING_PROTOCOL               *ServiceBinding;

+  MTFTP4_SERVICE                             *MtftpSb;

+  EFI_HANDLE                                 NicHandle;

+  EFI_STATUS                                 Status;

+  LIST_ENTRY                                 *List;

+  MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context;

 

   //

   // MTFTP driver opens UDP child, So, Controller is a UDP

@@ -356,7 +391,7 @@ Mtftp4DriverBindingStop (
   NicHandle = NetLibGetNicHandle (Controller, &gEfiUdp4ProtocolGuid);

 

   if (NicHandle == NULL) {

-    return EFI_DEVICE_ERROR;

+    return EFI_SUCCESS;

   }

 

   Status = gBS->OpenProtocol (

@@ -374,16 +409,23 @@ Mtftp4DriverBindingStop (
 

   MtftpSb = MTFTP4_SERVICE_FROM_THIS (ServiceBinding);

 

-  if (MtftpSb->InDestroy) {

-    return EFI_SUCCESS;

+  if (!IsListEmpty (&MtftpSb->Children)) {

+    //

+    // Destroy the Mtftp4 child instance in ChildHandleBuffer.

+    //

+    List = &MtftpSb->Children;

+    Context.ServiceBinding    = ServiceBinding;

+    Context.NumberOfChildren  = NumberOfChildren;

+    Context.ChildHandleBuffer = ChildHandleBuffer;

+    Status = NetDestroyLinkList (

+               List,

+               Mtftp4DestroyChildEntryInHandleBuffer,

+               &Context,

+               NULL

+               );

   }

 

-  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

-

-  if (NumberOfChildren == 0) {

-

-    MtftpSb->InDestroy = TRUE;

-

+  if (NumberOfChildren == 0 && IsListEmpty (&MtftpSb->Children)) {

     gBS->UninstallProtocolInterface (

            NicHandle,

            &gEfiMtftp4ServiceBindingProtocolGuid,

@@ -391,21 +433,15 @@ Mtftp4DriverBindingStop (
            );

 

     Mtftp4CleanService (MtftpSb);

-

-    FreePool (MtftpSb);

-  } else {

-

-    while (!IsListEmpty (&MtftpSb->Children)) {

-      Instance = NET_LIST_HEAD (&MtftpSb->Children, MTFTP4_PROTOCOL, Link);

-      Mtftp4ServiceBindingDestroyChild (ServiceBinding, Instance->Handle);

+    if (gMtftp4ControllerNameTable != NULL) {

+      FreeUnicodeStringTable (gMtftp4ControllerNameTable);

+      gMtftp4ControllerNameTable = NULL;

     }

+    FreePool (MtftpSb);

 

-    if (MtftpSb->ChildrenNum != 0) {

-      Status = EFI_DEVICE_ERROR;

-    }

+    Status = EFI_SUCCESS;

   }

 

-  gBS->RestoreTPL (OldTpl);

   return Status;

 }

 

@@ -429,7 +465,6 @@ Mtftp4InitProtocol (
   InitializeListHead (&Instance->Link);

   CopyMem (&Instance->Mtftp4, &gMtftp4ProtocolTemplate, sizeof (Instance->Mtftp4));

   Instance->State     = MTFTP4_STATE_UNCONFIGED;

-  Instance->InDestroy = FALSE;

   Instance->Service   = MtftpSb;

 

   InitializeListHead (&Instance->Blocks);

@@ -499,7 +534,9 @@ Mtftp4ServiceBindingCreateChild (
                   );

 

   if (EFI_ERROR (Status)) {

-    goto ON_ERROR;

+    UdpIoFreeIo (Instance->UnicastPort);

+    FreePool (Instance);

+    return Status;

   }

 

   Instance->Handle  = *ChildHandle;

@@ -516,13 +553,30 @@ Mtftp4ServiceBindingCreateChild (
                   EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER

                   );

   if (EFI_ERROR (Status)) {

-    gBS->UninstallMultipleProtocolInterfaces (

-           Instance->Handle,

-           &gEfiMtftp4ProtocolGuid,

-           &Instance->Mtftp4,

-           NULL

-           );

+    goto ON_ERROR;

+  }

 

+  //

+  // Open the Udp4 protocol by child.

+  //

+  Status = gBS->OpenProtocol (

+                  Instance->UnicastPort->UdpHandle,

+                  &gEfiUdp4ProtocolGuid,

+                  (VOID **) &Udp4,

+                  gMtftp4DriverBinding.DriverBindingHandle,

+                  Instance->Handle,

+                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER

+                  );

+  if (EFI_ERROR (Status)) {

+    //

+    // Close the Udp4 protocol.

+    //

+    gBS->CloseProtocol (

+           MtftpSb->ConnectUdp->UdpHandle,

+           &gEfiUdp4ProtocolGuid,

+           gMtftp4DriverBinding.DriverBindingHandle,

+           ChildHandle

+           );

     goto ON_ERROR;

   }

 

@@ -536,13 +590,21 @@ Mtftp4ServiceBindingCreateChild (
 

   gBS->RestoreTPL (OldTpl);

 

-ON_ERROR:

+  return EFI_SUCCESS;

 

-  if (EFI_ERROR (Status)) {

-    UdpIoFreeIo (Instance->UnicastPort);

-    FreePool (Instance);

+ON_ERROR:

+  if (Instance->Handle != NULL) {

+    gBS->UninstallMultipleProtocolInterfaces (

+           Instance->Handle,

+           &gEfiMtftp4ProtocolGuid,

+           &Instance->Mtftp4,

+           NULL

+           );

   }

 

+  UdpIoFreeIo (Instance->UnicastPort);

+  FreePool (Instance);

+

   return Status;

 }

 

@@ -615,6 +677,22 @@ Mtftp4ServiceBindingDestroyChild (
          ChildHandle

          );

 

+  gBS->CloseProtocol (

+         Instance->UnicastPort->UdpHandle,

+         &gEfiUdp4ProtocolGuid,

+         gMtftp4DriverBinding.DriverBindingHandle,

+         ChildHandle

+         );

+

+  if (Instance->McastUdpPort != NULL) {

+    gBS->CloseProtocol (

+           Instance->McastUdpPort->UdpHandle,

+           &gEfiUdp4ProtocolGuid,

+           gMtftp4DriverBinding.DriverBindingHandle,

+           ChildHandle

+           );  

+  }

+

   //

   // Uninstall the MTFTP4 protocol first to enable a top down destruction.

   //

diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.h b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.h
index 63828bd..936eab1 100644
--- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.h
+++ b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.h
@@ -26,6 +26,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 extern EFI_COMPONENT_NAME_PROTOCOL   gMtftp4ComponentName;

 extern EFI_COMPONENT_NAME2_PROTOCOL  gMtftp4ComponentName2;

 extern EFI_DRIVER_BINDING_PROTOCOL   gMtftp4DriverBinding;

+extern EFI_UNICODE_STRING_TABLE      *gMtftp4ControllerNameTable;

 

 /**

   Test whether MTFTP driver support this controller.

diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c
index 5183e1a..f3a4952 100644
--- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c
+++ b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c
@@ -58,6 +58,12 @@ Mtftp4CleanOperation (
   }

 

   if (Instance->McastUdpPort != NULL) {

+    gBS->CloseProtocol (

+           Instance->McastUdpPort->UdpHandle,

+           &gEfiUdp4ProtocolGuid,

+           gMtftp4DriverBinding.DriverBindingHandle,

+           Instance->Handle

+           );

     UdpIoFreeIo (Instance->McastUdpPort);

     Instance->McastUdpPort = NULL;

   }

diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.h b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.h
index 41f524a..329c6d8 100644
--- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.h
+++ b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.h
@@ -34,6 +34,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/MemoryAllocationLib.h>

 #include <Library/UefiBootServicesTableLib.h>

 #include <Library/UdpIoLib.h>

+#include <LIbrary/PrintLib.h>

 

 extern EFI_MTFTP4_PROTOCOL  gMtftp4ProtocolTemplate;

 

@@ -68,8 +69,6 @@ struct _MTFTP4_SERVICE {
   UINT32                        Signature;

   EFI_SERVICE_BINDING_PROTOCOL  ServiceBinding;

 

-  BOOLEAN                       InDestroy;

-

   UINT16                        ChildrenNum;

   LIST_ENTRY                    Children;

 

@@ -149,6 +148,12 @@ struct _MTFTP4_PROTOCOL {
   UDP_IO                        *McastUdpPort;

 };

 

+typedef struct {

+  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;

+  UINTN                         NumberOfChildren;

+  EFI_HANDLE                    *ChildHandleBuffer;

+} MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT;

+

 /**

   Clean up the MTFTP session to get ready for new operation.

 

diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Rrq.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Rrq.c
index 264598f..ae157c5 100644
--- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Rrq.c
+++ b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Rrq.c
@@ -1,7 +1,7 @@
 /** @file

   Routines to process Rrq (download).

   

-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -486,6 +486,7 @@ Mtftp4RrqHandleOack (
   MTFTP4_OPTION             Reply;

   EFI_STATUS                Status;

   INTN                      Expected;

+  EFI_UDP4_PROTOCOL         *Udp4;

 

   *Completed = FALSE;

 

@@ -548,13 +549,31 @@ Mtftp4RrqHandleOack (
       //

       Instance->McastIp      = Reply.McastIp;

       Instance->McastPort    = Reply.McastPort;

-      Instance->McastUdpPort = UdpIoCreateIo (

-                                 Instance->Service->Controller,

-                                 Instance->Service->Image,

-                                 Mtftp4RrqConfigMcastPort,

-                                 UDP_IO_UDP4_VERSION,

-                                 Instance

-                                 );

+      if (Instance->McastUdpPort == NULL) {

+        Instance->McastUdpPort = UdpIoCreateIo (

+                                   Instance->Service->Controller,

+                                   Instance->Service->Image,

+                                   Mtftp4RrqConfigMcastPort,

+                                   UDP_IO_UDP4_VERSION,

+                                   Instance

+                                   );

+        if (Instance->McastUdpPort != NULL) {

+          Status = gBS->OpenProtocol (

+                          Instance->McastUdpPort->UdpHandle,

+                          &gEfiUdp4ProtocolGuid,

+                          (VOID **) &Udp4,

+                          Instance->Service->Image,

+                          Instance->Handle,

+                          EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER

+                          );

+          if (EFI_ERROR (Status)) {

+            UdpIoFreeIo (Instance->McastUdpPort);

+            Instance->McastUdpPort = NULL;

+            return EFI_DEVICE_ERROR;

+          }

+        }

+      }

+

 

       if (Instance->McastUdpPort == NULL) {

         return EFI_DEVICE_ERROR;