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, 233 insertions, 27 deletions

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/ComponentName.c
index 587f7c665b..dd0af8d7b4 100644
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/ComponentName.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/ComponentName.c
@@ -1,7 +1,7 @@
 /** @file

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

 

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

+Copyright (c) 2005 - 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

@@ -171,6 +171,8 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mTcpDriverNameTable[] = {
   }

 };

 

+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gTcpControllerNameTable = NULL;

+

 /**

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

 

@@ -228,6 +230,76 @@ TcpComponentNameGetDriverName (
 }

 

 /**

+  Update the component name for the Tcp4 child handle.

+

+  @param  Tcp4[in]                   A pointer to the EFI_TCP4_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_TCP4_PROTOCOL             *Tcp4

+  )

+{

+  EFI_STATUS                       Status;

+  CHAR16                           HandleName[80];

+  EFI_TCP4_CONFIG_DATA             Tcp4ConfigData;

+

+  if (Tcp4 == NULL) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  //

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

+  // TCPv4 (SrcPort=59, DestPort=60, ActiveFlag=TRUE)

+  //

+  Status = Tcp4->GetModeData (Tcp4, NULL, &Tcp4ConfigData, NULL, NULL, NULL);

+  if (!EFI_ERROR (Status)) {

+    UnicodeSPrint (HandleName, sizeof (HandleName),

+      L"TCPv4 (SrcPort=%d, DestPort=&d, ActiveFlag=%s)",

+      Tcp4ConfigData.AccessPoint.StationPort,

+      Tcp4ConfigData.AccessPoint.RemotePort,

+      (Tcp4ConfigData.AccessPoint.ActiveFlag ? L"TRUE" : L"FALSE")

+      );

+  } if (Status == EFI_NOT_STARTED) {

+    UnicodeSPrint (

+      HandleName,

+      sizeof (HandleName),

+      L"TCPv4 (Not started)"

+      );

+  } else {

+    return Status;

+  }

+

+  if (gTcpControllerNameTable != NULL) {

+    FreeUnicodeStringTable (gTcpControllerNameTable);

+    gTcpControllerNameTable = NULL;

+  }

+  

+  Status = AddUnicodeString2 (

+             "eng",

+             gTcp4ComponentName.SupportedLanguages,

+             &gTcpControllerNameTable,

+             HandleName,

+             TRUE

+             );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+  

+  return AddUnicodeString2 (

+           "en",

+           gTcp4ComponentName2.SupportedLanguages,

+           &gTcpControllerNameTable,

+           HandleName,

+           FALSE

+           );

+}

+

+/**

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

   that is being managed by a driver.

 

@@ -305,5 +377,56 @@ TcpComponentNameGetControllerName (
      OUT CHAR16                       **ControllerName

   )

 {

-  return EFI_UNSUPPORTED;

+  EFI_STATUS                    Status;

+  EFI_TCP4_PROTOCOL             *Tcp4;

+

+  //

+  // Only provide names for child handles.

+  //

+  if (ChildHandle == NULL) {

+    return EFI_UNSUPPORTED;

+  }

+  

+  // 

+  // Make sure this driver produced ChildHandle 

+  // 

+  Status = EfiTestChildHandle (

+             ControllerHandle,

+             ChildHandle,

+             &gEfiIp4ProtocolGuid

+             );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  // 

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

+  // 

+  Status = gBS->OpenProtocol (

+                  ChildHandle,

+                  &gEfiTcp4ProtocolGuid,

+                  (VOID **)&Tcp4,

+                  NULL,

+                  NULL,

+                  EFI_OPEN_PROTOCOL_GET_PROTOCOL

+                  );

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  //

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

+  //

+  Status = UpdateName (Tcp4);

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

+

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           gTcpControllerNameTable,

+           ControllerName,

+           (BOOLEAN)(This == &gTcp4ComponentName)

+           );

 }

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/SockInterface.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/SockInterface.c
index ac36460da8..feed86c590 100644
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/SockInterface.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/SockInterface.c
@@ -1,7 +1,7 @@
 /** @file

   Interface function of the Socket.

 

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

+Copyright (c) 2005 - 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

@@ -148,11 +148,11 @@ SockDestroyChild (
 

   ASSERT ((Sock != NULL) && (Sock->ProtoHandler != NULL));

 

-  if (Sock->IsDestroyed) {

+  if (Sock->InDestroy) {

     return EFI_SUCCESS;

   }

 

-  Sock->IsDestroyed = TRUE;

+  Sock->InDestroy = TRUE;

 

   Status = EfiAcquireLockOrFail (&(Sock->Lock));

   if (EFI_ERROR (Status)) {

@@ -173,7 +173,7 @@ SockDestroyChild (
     DEBUG ((EFI_D_ERROR, "SockDestroyChild: Protocol detach socket"

       " failed with %r\n", Status));

 

-    Sock->IsDestroyed = FALSE;

+    Sock->InDestroy = FALSE;

   } else if (SOCK_IS_CONFIGURED (Sock)) {

 

     SockConnFlush (Sock);

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Socket.h b/MdeModulePkg/Universal/Network/Tcp4Dxe/Socket.h
index b8ace790ca..8c25c63b11 100644
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Socket.h
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Socket.h
@@ -30,6 +30,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/UefiDriverEntryPoint.h>

 #include <Library/UefiLib.h>

 #include <Library/DpcLib.h>

+#include <Library/PrintLib.h>

 

 #define SOCK_SND_BUF        0

 #define SOCK_RCV_BUF        1

@@ -645,7 +646,7 @@ struct _SOCKET {
   SOCK_BUFFER           SndBuffer;  ///< Send buffer of application's data

   SOCK_BUFFER           RcvBuffer;  ///< Receive buffer of received data

   EFI_STATUS            SockError;  ///< The error returned by low layer protocol

-  BOOLEAN               IsDestroyed;

+  BOOLEAN               InDestroy;

 

   //

   // Fields used to manage the connection request

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dispatcher.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dispatcher.c
index 688f9a7e99..93d10c9eb2 100644
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dispatcher.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dispatcher.c
@@ -1,7 +1,7 @@
 /** @file

   Tcp request dispatcher implementation.

 

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

+Copyright (c) 2005 - 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

@@ -263,6 +263,8 @@ Tcp4AttachPcb (
   TCP_CB            *Tcb;

   TCP4_PROTO_DATA   *ProtoData;

   IP_IO             *IpIo;

+  EFI_STATUS        Status;

+  VOID              *Ip;

 

   Tcb = AllocateZeroPool (sizeof (TCP_CB));

 

@@ -286,6 +288,22 @@ Tcp4AttachPcb (
     return EFI_OUT_OF_RESOURCES;

   }

 

+  //

+  // Open the new created IP instance BY_CHILD.

+  //

+  Status = gBS->OpenProtocol (

+                  Tcb->IpInfo->ChildHandle,

+                  &gEfiIp4ProtocolGuid,

+                  &Ip,

+                  IpIo->Image,

+                  Sk->SockHandle,

+                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER

+                  );

+  if (EFI_ERROR (Status)) {

+    IpIoRemoveIp (IpIo, Tcb->IpInfo);

+    return Status;

+  }

+

   InitializeListHead (&Tcb->List);

   InitializeListHead (&Tcb->SndQue);

   InitializeListHead (&Tcb->RcvQue);

@@ -318,6 +336,16 @@ Tcp4DetachPcb (
 

   Tcp4FlushPcb (Tcb);

 

+  //

+  // Close the IP protocol.

+  //

+  gBS->CloseProtocol (

+         Tcb->IpInfo->ChildHandle,

+         &gEfiIp4ProtocolGuid,

+         ProtoData->TcpService->IpIo->Image,

+         Sk->SockHandle

+         );

+  

   IpIoRemoveIp (ProtoData->TcpService->IpIo, Tcb->IpInfo);

 

   FreePool (Tcb);

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Driver.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Driver.c
index a29b6bc434..1021252300 100644
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Driver.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Driver.c
@@ -1,7 +1,7 @@
 /** @file

   Tcp driver function.

 

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

+Copyright (c) 2005 - 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

@@ -18,6 +18,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 UINT16                                mTcp4RandomPort;

 extern EFI_COMPONENT_NAME_PROTOCOL    gTcp4ComponentName;

 extern EFI_COMPONENT_NAME2_PROTOCOL   gTcp4ComponentName2;

+extern EFI_UNICODE_STRING_TABLE       *gTcpControllerNameTable;

 

 TCP4_HEARTBEAT_TIMER  mTcp4Timer = {

   NULL,

@@ -136,6 +137,43 @@ Tcp4DestroyTimer (
 }

 

 /**

+  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

+Tcp4DestroyChildEntryInHandleBuffer (

+  IN LIST_ENTRY         *Entry,

+  IN VOID               *Context

+)

+{

+  SOCKET                        *Sock;

+  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;

+  UINTN                         NumberOfChildren;

+  EFI_HANDLE                    *ChildHandleBuffer;

+

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

+    return EFI_INVALID_PARAMETER;

+  }

+

+  Sock = NET_LIST_USER_STRUCT_S (Entry, SOCKET, Link, SOCK_SIGNATURE);

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

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

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

+

+  if (!NetIsInHandleBuffer (Sock->SockHandle, NumberOfChildren, ChildHandleBuffer)) {

+    return EFI_SUCCESS;

+  }

+

+  return ServiceBinding->DestroyChild (ServiceBinding, Sock->SockHandle);

+}

+

+/**

   The entry point for Tcp4 driver, used to install Tcp4 driver on the ImageHandle.

 

   @param  ImageHandle   The firmware allocated handle for this

@@ -387,6 +425,7 @@ ON_ERROR:
 

   if (TcpServiceData->IpIo != NULL) {

     IpIoDestroy (TcpServiceData->IpIo);

+    TcpServiceData->IpIo = NULL;

   }

 

   FreePool (TcpServiceData);

@@ -431,17 +470,18 @@ Tcp4DriverBindingStop (
   IN  EFI_HANDLE                   *ChildHandleBuffer

   )

 {

-  EFI_STATUS                          Status;

-  EFI_HANDLE                          NicHandle;

-  EFI_SERVICE_BINDING_PROTOCOL        *ServiceBinding;

-  TCP4_SERVICE_DATA                   *TcpServiceData;

-  SOCKET                              *Sock;

+  EFI_STATUS                                Status;

+  EFI_HANDLE                                NicHandle;

+  EFI_SERVICE_BINDING_PROTOCOL              *ServiceBinding;

+  TCP4_SERVICE_DATA                         *TcpServiceData;

+  LIST_ENTRY                                *List;

+  TCP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT  Context;

 

   // Find the NicHandle where Tcp4 ServiceBinding Protocol is installed.

   //

   NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiIp4ProtocolGuid);

   if (NicHandle == NULL) {

-    return EFI_DEVICE_ERROR;

+    return EFI_SUCCESS;

   }

 

   //

@@ -465,7 +505,18 @@ Tcp4DriverBindingStop (
 

   TcpServiceData = TCP4_FROM_THIS (ServiceBinding);

 

-  if (NumberOfChildren == 0) {

+  if (NumberOfChildren != 0) {

+    List = &TcpServiceData->SocketList; 

+    Context.ServiceBinding = ServiceBinding;

+    Context.NumberOfChildren = NumberOfChildren;

+    Context.ChildHandleBuffer = ChildHandleBuffer;

+    Status = NetDestroyLinkList (

+               List,

+               Tcp4DestroyChildEntryInHandleBuffer,

+               &Context,

+               NULL

+               );

+  } else if (IsListEmpty (&TcpServiceData->SocketList)) {

     //

     // Uninstall TCP servicebinding protocol

     //

@@ -480,6 +531,7 @@ Tcp4DriverBindingStop (
     // Destroy the IpIO consumed by TCP driver

     //

     IpIoDestroy (TcpServiceData->IpIo);

+    TcpServiceData->IpIo = NULL;

 

     //

     // Destroy the heartbeat timer.

@@ -491,17 +543,17 @@ Tcp4DriverBindingStop (
     //

     TcpClearVariableData (TcpServiceData);

 

+    if (gTcpControllerNameTable != NULL) {

+      FreeUnicodeStringTable (gTcpControllerNameTable);

+      gTcpControllerNameTable = NULL;

+    }

+    

     //

     // Release the TCP service data

     //

     FreePool (TcpServiceData);

-  } else {

-

-    while (!IsListEmpty (&TcpServiceData->SocketList)) {

-      Sock = NET_LIST_HEAD (&TcpServiceData->SocketList, SOCKET, Link);

 

-      ServiceBinding->DestroyChild (ServiceBinding, Sock->SockHandle);

-    }

+    Status = EFI_SUCCESS;

   }

 

   return Status;

@@ -713,14 +765,11 @@ Tcp4ServiceBindingDestroyChild (
   EFI_STATUS         Status;

   EFI_TCP4_PROTOCOL  *Tcp4;

   SOCKET             *Sock;

-  EFI_TPL            OldTpl;

 

   if (NULL == This || NULL == ChildHandle) {

     return EFI_INVALID_PARAMETER;

   }

 

-  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

-

   //

   // retrieve the Tcp4 protocol from ChildHandle

   //

@@ -744,7 +793,6 @@ Tcp4ServiceBindingDestroyChild (
     SockDestroyChild (Sock);

   }

 

-  gBS->RestoreTPL (OldTpl);

   return Status;

 }

 

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Main.h b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Main.h
index c59075780f..cd904584bf 100644
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Main.h
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Main.h
@@ -1,7 +1,7 @@
 /** @file

   TCP4 protocol services header file.

 

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

+Copyright (c) 2005 - 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

@@ -75,6 +75,12 @@ typedef struct _TCP4_ROUTE_INFO {
   EFI_IPv4_ADDRESS  *GatewayAddress;

 } TCP4_ROUTE_INFO;

 

+typedef struct {

+  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;

+  UINTN                         NumberOfChildren;

+  EFI_HANDLE                    *ChildHandleBuffer;

+} TCP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT;

+

 /**

   Get the current operational status of a TCP instance.