[mirror_edk2.git] / NetworkPkg / TcpDxe / TcpDriver.c

/** @file\r
  The driver binding and service binding protocol for the TCP driver.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "TcpMain.h"\r
\r
UINT16  mTcp4RandomPort;\r
UINT16  mTcp6RandomPort;\r
\r
TCP_HEARTBEAT_TIMER  mTcpTimer = {\r
  NULL,\r
  0\r
};\r
\r
EFI_TCP4_PROTOCOL  gTcp4ProtocolTemplate = {\r
  Tcp4GetModeData,\r
  Tcp4Configure,\r
  Tcp4Routes,\r
  Tcp4Connect,\r
  Tcp4Accept,\r
  Tcp4Transmit,\r
  Tcp4Receive,\r
  Tcp4Close,\r
  Tcp4Cancel,\r
  Tcp4Poll\r
};\r
\r
EFI_TCP6_PROTOCOL  gTcp6ProtocolTemplate = {\r
  Tcp6GetModeData,\r
  Tcp6Configure,\r
  Tcp6Connect,\r
  Tcp6Accept,\r
  Tcp6Transmit,\r
  Tcp6Receive,\r
  Tcp6Close,\r
  Tcp6Cancel,\r
  Tcp6Poll\r
};\r
\r
SOCK_INIT_DATA  mTcpDefaultSockData = {\r
  SockStream,\r
  SO_CLOSED,\r
  NULL,\r
  TCP_BACKLOG,\r
  TCP_SND_BUF_SIZE,\r
  TCP_RCV_BUF_SIZE,\r
  IP_VERSION_4,\r
  NULL,\r
  TcpCreateSocketCallback,\r
  TcpDestroySocketCallback,\r
  NULL,\r
  NULL,\r
  0,\r
  TcpDispatcher,\r
  NULL,\r
};\r
\r
EFI_DRIVER_BINDING_PROTOCOL  gTcp4DriverBinding = {\r
  Tcp4DriverBindingSupported,\r
  Tcp4DriverBindingStart,\r
  Tcp4DriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_DRIVER_BINDING_PROTOCOL  gTcp6DriverBinding = {\r
  Tcp6DriverBindingSupported,\r
  Tcp6DriverBindingStart,\r
  Tcp6DriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_SERVICE_BINDING_PROTOCOL  gTcpServiceBinding = {\r
  TcpServiceBindingCreateChild,\r
  TcpServiceBindingDestroyChild\r
};\r
\r
/**\r
  Create and start the heartbeat timer for the TCP driver.\r
\r
  @retval EFI_SUCCESS            The timer was successfully created and started.\r
  @retval other                  The timer was not created.\r
\r
**/\r
EFI_STATUS\r
TcpCreateTimer (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = EFI_SUCCESS;\r
\r
  if (mTcpTimer.RefCnt == 0) {\r
    Status = gBS->CreateEvent (\r
                    EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
                    TPL_NOTIFY,\r
                    TcpTicking,\r
                    NULL,\r
                    &mTcpTimer.TimerEvent\r
                    );\r
    if (!EFI_ERROR (Status)) {\r
      Status = gBS->SetTimer (\r
                      mTcpTimer.TimerEvent,\r
                      TimerPeriodic,\r
                      (UINT64)(TICKS_PER_SECOND / TCP_TICK_HZ)\r
                      );\r
    }\r
  }\r
\r
  if (!EFI_ERROR (Status)) {\r
    mTcpTimer.RefCnt++;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Stop and destroy the heartbeat timer for TCP driver.\r
\r
**/\r
VOID\r
TcpDestroyTimer (\r
  VOID\r
  )\r
{\r
  ASSERT (mTcpTimer.RefCnt > 0);\r
\r
  mTcpTimer.RefCnt--;\r
\r
  if (mTcpTimer.RefCnt > 0) {\r
    return;\r
  }\r
\r
  gBS->SetTimer (mTcpTimer.TimerEvent, TimerCancel, 0);\r
  gBS->CloseEvent (mTcpTimer.TimerEvent);\r
  mTcpTimer.TimerEvent = NULL;\r
}\r
\r
/**\r
  The entry point for Tcp driver, which is used to install Tcp driver on the ImageHandle.\r
\r
  @param[in]  ImageHandle   The firmware allocated handle for this driver image.\r
  @param[in]  SystemTable   Pointer to the EFI system table.\r
\r
  @retval EFI_SUCCESS   The driver loaded.\r
  @retval other         The driver did not load.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TcpDriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT32      Seed;\r
\r
  //\r
  // Install the TCP Driver Binding Protocol\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gTcp4DriverBinding,\r
             ImageHandle,\r
             &gTcpComponentName,\r
             &gTcpComponentName2\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Install the TCP Driver Binding Protocol\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gTcp6DriverBinding,\r
             NULL,\r
             &gTcpComponentName,\r
             &gTcpComponentName2\r
             );\r
  if (EFI_ERROR (Status)) {\r
    EfiLibUninstallDriverBindingComponentName2 (\r
      &gTcp4DriverBinding,\r
      &gTcpComponentName,\r
      &gTcpComponentName2\r
      );\r
    return Status;\r
  }\r
\r
  //\r
  // Initialize ISS and random port.\r
  //\r
  Seed            = NetRandomInitSeed ();\r
  mTcpGlobalIss   = NET_RANDOM (Seed) % mTcpGlobalIss;\r
  mTcp4RandomPort = (UINT16)(TCP_PORT_KNOWN + (NET_RANDOM (Seed) % TCP_PORT_KNOWN));\r
  mTcp6RandomPort = mTcp4RandomPort;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Create a new TCP4 or TCP6 driver service binding protocol\r
\r
  @param[in]  Controller         Controller handle of device to bind driver to.\r
  @param[in]  Image              The TCP driver's image handle.\r
  @param[in]  IpVersion          IP_VERSION_4 or IP_VERSION_6.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate some resources.\r
  @retval EFI_SUCCESS            A new IP6 service binding private was created.\r
\r
**/\r
EFI_STATUS\r
TcpCreateService (\r
  IN EFI_HANDLE  Controller,\r
  IN EFI_HANDLE  Image,\r
  IN UINT8       IpVersion\r
  )\r
{\r
  EFI_STATUS        Status;\r
  EFI_GUID          *IpServiceBindingGuid;\r
  EFI_GUID          *TcpServiceBindingGuid;\r
  TCP_SERVICE_DATA  *TcpServiceData;\r
  IP_IO_OPEN_DATA   OpenData;\r
\r
  if (IpVersion == IP_VERSION_4) {\r
    IpServiceBindingGuid  = &gEfiIp4ServiceBindingProtocolGuid;\r
    TcpServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid;\r
  } else {\r
    IpServiceBindingGuid  = &gEfiIp6ServiceBindingProtocolGuid;\r
    TcpServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  TcpServiceBindingGuid,\r
                  NULL,\r
                  Image,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  IpServiceBindingGuid,\r
                  NULL,\r
                  Image,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Create the TCP service data.\r
  //\r
  TcpServiceData = AllocateZeroPool (sizeof (TCP_SERVICE_DATA));\r
  if (TcpServiceData == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  TcpServiceData->Signature           = TCP_DRIVER_SIGNATURE;\r
  TcpServiceData->ControllerHandle    = Controller;\r
  TcpServiceData->DriverBindingHandle = Image;\r
  TcpServiceData->IpVersion           = IpVersion;\r
  CopyMem (\r
    &TcpServiceData->ServiceBinding,\r
    &gTcpServiceBinding,\r
    sizeof (EFI_SERVICE_BINDING_PROTOCOL)\r
    );\r
\r
  TcpServiceData->IpIo = IpIoCreate (Image, Controller, IpVersion);\r
  if (TcpServiceData->IpIo == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_ERROR;\r
  }\r
\r
  InitializeListHead (&TcpServiceData->SocketList);\r
  ZeroMem (&OpenData, sizeof (IP_IO_OPEN_DATA));\r
\r
  if (IpVersion == IP_VERSION_4) {\r
    CopyMem (\r
      &OpenData.IpConfigData.Ip4CfgData,\r
      &mIp4IoDefaultIpConfigData,\r
      sizeof (EFI_IP4_CONFIG_DATA)\r
      );\r
    OpenData.IpConfigData.Ip4CfgData.DefaultProtocol = EFI_IP_PROTO_TCP;\r
  } else {\r
    CopyMem (\r
      &OpenData.IpConfigData.Ip6CfgData,\r
      &mIp6IoDefaultIpConfigData,\r
      sizeof (EFI_IP6_CONFIG_DATA)\r
      );\r
    OpenData.IpConfigData.Ip6CfgData.DefaultProtocol = EFI_IP_PROTO_TCP;\r
  }\r
\r
  OpenData.PktRcvdNotify = TcpRxCallback;\r
  Status                 = IpIoOpen (TcpServiceData->IpIo, &OpenData);\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = TcpCreateTimer ();\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Controller,\r
                  TcpServiceBindingGuid,\r
                  &TcpServiceData->ServiceBinding,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    TcpDestroyTimer ();\r
\r
    goto ON_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
\r
  if (TcpServiceData->IpIo != NULL) {\r
    IpIoDestroy (TcpServiceData->IpIo);\r
    TcpServiceData->IpIo = NULL;\r
  }\r
\r
  FreePool (TcpServiceData);\r
\r
  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
TcpDestroyChildEntryInHandleBuffer (\r
  IN LIST_ENTRY  *Entry,\r
  IN VOID        *Context\r
  )\r
{\r
  SOCKET                        *Sock;\r
  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;\r
  UINTN                         NumberOfChildren;\r
  EFI_HANDLE                    *ChildHandleBuffer;\r
\r
  if ((Entry == NULL) || (Context == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Sock              = NET_LIST_USER_STRUCT_S (Entry, SOCKET, Link, SOCK_SIGNATURE);\r
  ServiceBinding    = ((TCP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ServiceBinding;\r
  NumberOfChildren  = ((TCP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->NumberOfChildren;\r
  ChildHandleBuffer = ((TCP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *)Context)->ChildHandleBuffer;\r
\r
  if (!NetIsInHandleBuffer (Sock->SockHandle, NumberOfChildren, ChildHandleBuffer)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  return ServiceBinding->DestroyChild (ServiceBinding, Sock->SockHandle);\r
}\r
\r
/**\r
  Destroy a TCP6 or TCP4 service binding instance. It will release all\r
  the resources allocated by the instance.\r
\r
  @param[in]  Controller         Controller handle of device to bind driver to.\r
  @param[in]  ImageHandle        The TCP driver's image handle.\r
  @param[in]  NumberOfChildren   Number of Handles in ChildHandleBuffer. If number\r
                                 of children is zero stop the entire bus driver.\r
  @param[in]  ChildHandleBuffer  An array of child handles to be freed. May be NULL\r
                                 if NumberOfChildren is 0.\r
  @param[in]  IpVersion          IP_VERSION_4 or IP_VERSION_6\r
\r
  @retval EFI_SUCCESS            The resources used by the instance were cleaned up.\r
  @retval Others                 Failed to clean up some of the resources.\r
\r
**/\r
EFI_STATUS\r
TcpDestroyService (\r
  IN EFI_HANDLE  Controller,\r
  IN EFI_HANDLE  ImageHandle,\r
  IN UINTN       NumberOfChildren,\r
  IN EFI_HANDLE  *ChildHandleBuffer  OPTIONAL,\r
  IN UINT8       IpVersion\r
  )\r
{\r
  EFI_HANDLE                               NicHandle;\r
  EFI_GUID                                 *IpProtocolGuid;\r
  EFI_GUID                                 *ServiceBindingGuid;\r
  EFI_SERVICE_BINDING_PROTOCOL             *ServiceBinding;\r
  TCP_SERVICE_DATA                         *TcpServiceData;\r
  EFI_STATUS                               Status;\r
  LIST_ENTRY                               *List;\r
  TCP_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT  Context;\r
\r
  ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6));\r
\r
  if (IpVersion == IP_VERSION_4) {\r
    IpProtocolGuid     = &gEfiIp4ProtocolGuid;\r
    ServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid;\r
  } else {\r
    IpProtocolGuid     = &gEfiIp6ProtocolGuid;\r
    ServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid;\r
  }\r
\r
  NicHandle = NetLibGetNicHandle (Controller, IpProtocolGuid);\r
  if (NicHandle == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  NicHandle,\r
                  ServiceBindingGuid,\r
                  (VOID **)&ServiceBinding,\r
                  ImageHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  TcpServiceData = TCP_SERVICE_FROM_THIS (ServiceBinding);\r
\r
  if (NumberOfChildren != 0) {\r
    List                      = &TcpServiceData->SocketList;\r
    Context.ServiceBinding    = ServiceBinding;\r
    Context.NumberOfChildren  = NumberOfChildren;\r
    Context.ChildHandleBuffer = ChildHandleBuffer;\r
    Status                    = NetDestroyLinkList (\r
                                  List,\r
                                  TcpDestroyChildEntryInHandleBuffer,\r
                                  &Context,\r
                                  NULL\r
                                  );\r
  } else if (IsListEmpty (&TcpServiceData->SocketList)) {\r
    //\r
    // Uninstall TCP servicebinding protocol\r
    //\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           NicHandle,\r
           ServiceBindingGuid,\r
           ServiceBinding,\r
           NULL\r
           );\r
\r
    //\r
    // Destroy the IpIO consumed by TCP driver\r
    //\r
    IpIoDestroy (TcpServiceData->IpIo);\r
    TcpServiceData->IpIo = NULL;\r
\r
    //\r
    // Destroy the heartbeat timer.\r
    //\r
    TcpDestroyTimer ();\r
\r
    //\r
    // Release the TCP service data\r
    //\r
    FreePool (TcpServiceData);\r
\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Test to see if this driver supports ControllerHandle.\r
\r
  @param[in]  This                Protocol instance pointer.\r
  @param[in]  ControllerHandle    Handle of device to test.\r
  @param[in]  RemainingDevicePath Optional parameter use to pick a specific\r
                                  child 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
EFIAPI\r
Tcp4DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Test for the Tcp4ServiceBinding Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiTcp4ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  //\r
  // Test for the Ip4ServiceBinding Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiIp4ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  return Status;\r
}\r
\r
/**\r
  Start this driver on ControllerHandle.\r
\r
  @param[in]  This                   Protocol instance pointer.\r
  @param[in]  ControllerHandle       Handle of device to bind driver to.\r
  @param[in]  RemainingDevicePath    Optional parameter use to pick a specific child\r
                                     device to start.\r
\r
  @retval EFI_SUCCESS            The driver is added to ControllerHandle.\r
  @retval EFI_OUT_OF_RESOURCES   There are not enough resources to start the\r
                                 driver.\r
  @retval other                  The driver cannot be added to ControllerHandle.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp4DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = TcpCreateService (ControllerHandle, This->DriverBindingHandle, IP_VERSION_4);\r
  if ((Status == EFI_ALREADY_STARTED) || (Status == EFI_UNSUPPORTED)) {\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Stop this driver on ControllerHandle.\r
\r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must\r
                                support a bus specific I/O protocol for the driver\r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL\r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp4DriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   ControllerHandle,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
  )\r
{\r
  return TcpDestroyService (\r
           ControllerHandle,\r
           This->DriverBindingHandle,\r
           NumberOfChildren,\r
           ChildHandleBuffer,\r
           IP_VERSION_4\r
           );\r
}\r
\r
/**\r
  Test to see if this driver supports ControllerHandle.\r
\r
  @param[in]  This                Protocol instance pointer.\r
  @param[in]  ControllerHandle    Handle of device to test.\r
  @param[in]  RemainingDevicePath Optional parameter use to pick a specific\r
                                  child 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
EFIAPI\r
Tcp6DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Test for the Tcp6ServiceBinding Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiTcp6ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  //\r
  // Test for the Ip6ServiceBinding Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiIp6ServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  return Status;\r
}\r
\r
/**\r
  Start this driver on ControllerHandle.\r
\r
  @param[in]  This                   Protocol instance pointer.\r
  @param[in]  ControllerHandle       Handle of device to bind driver to.\r
  @param[in]  RemainingDevicePath    Optional parameter use to pick a specific child\r
                                     device to start.\r
\r
  @retval EFI_SUCCESS            The driver is added to ControllerHandle.\r
  @retval EFI_OUT_OF_RESOURCES   There are not enough resources to start the\r
                                 driver.\r
  @retval other                  The driver cannot be added to ControllerHandle.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp6DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = TcpCreateService (ControllerHandle, This->DriverBindingHandle, IP_VERSION_6);\r
  if ((Status == EFI_ALREADY_STARTED) || (Status == EFI_UNSUPPORTED)) {\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Stop this driver on ControllerHandle.\r
\r
  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must\r
                                support a bus specific I/O protocol for the driver\r
                                to use to stop the device.\r
  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL\r
                                if NumberOfChildren is 0.\r
\r
  @retval EFI_SUCCESS           The device was stopped.\r
  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tcp6DriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   ControllerHandle,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   *ChildHandleBuffer OPTIONAL\r
  )\r
{\r
  return TcpDestroyService (\r
           ControllerHandle,\r
           This->DriverBindingHandle,\r
           NumberOfChildren,\r
           ChildHandleBuffer,\r
           IP_VERSION_6\r
           );\r
}\r
\r
/**\r
  The Callback function called after the TCP socket was created.\r
\r
  @param[in]  This            Pointer to the socket just created\r
  @param[in]  Context         Context of the socket\r
\r
  @retval EFI_SUCCESS         This protocol installed successfully.\r
  @retval other               An error occurred.\r
\r
**/\r
EFI_STATUS\r
TcpCreateSocketCallback (\r
  IN SOCKET  *This,\r
  IN VOID    *Context\r
  )\r
{\r
  EFI_STATUS        Status;\r
  TCP_SERVICE_DATA  *TcpServiceData;\r
  EFI_GUID          *IpProtocolGuid;\r
  VOID              *Ip;\r
\r
  if (This->IpVersion == IP_VERSION_4) {\r
    IpProtocolGuid = &gEfiIp4ProtocolGuid;\r
  } else {\r
    IpProtocolGuid = &gEfiIp6ProtocolGuid;\r
  }\r
\r
  TcpServiceData = ((TCP_PROTO_DATA *)This->ProtoReserved)->TcpService;\r
\r
  //\r
  // Open the default IP protocol of IP_IO BY_DRIVER.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  TcpServiceData->IpIo->ChildHandle,\r
                  IpProtocolGuid,\r
                  &Ip,\r
                  TcpServiceData->DriverBindingHandle,\r
                  This->SockHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Open the device path on the handle where service binding resides on.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  TcpServiceData->ControllerHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **)&This->ParentDevicePath,\r
                  TcpServiceData->DriverBindingHandle,\r
                  This->SockHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    gBS->CloseProtocol (\r
           TcpServiceData->IpIo->ChildHandle,\r
           IpProtocolGuid,\r
           TcpServiceData->DriverBindingHandle,\r
           This->SockHandle\r
           );\r
  } else {\r
    //\r
    // Insert this socket into the SocketList.\r
    //\r
    InsertTailList (&TcpServiceData->SocketList, &This->Link);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  The callback function called before the TCP socket was to be destroyed.\r
\r
  @param[in]  This                   The TCP socket to be destroyed.\r
  @param[in]  Context                The context of the socket.\r
\r
**/\r
VOID\r
TcpDestroySocketCallback (\r
  IN SOCKET  *This,\r
  IN VOID    *Context\r
  )\r
{\r
  TCP_SERVICE_DATA  *TcpServiceData;\r
  EFI_GUID          *IpProtocolGuid;\r
\r
  if (This->IpVersion == IP_VERSION_4) {\r
    IpProtocolGuid = &gEfiIp4ProtocolGuid;\r
  } else {\r
    IpProtocolGuid = &gEfiIp6ProtocolGuid;\r
  }\r
\r
  TcpServiceData = ((TCP_PROTO_DATA *)This->ProtoReserved)->TcpService;\r
\r
  //\r
  // Remove this node from the list.\r
  //\r
  RemoveEntryList (&This->Link);\r
\r
  //\r
  // Close the IP protocol.\r
  //\r
  gBS->CloseProtocol (\r
         TcpServiceData->IpIo->ChildHandle,\r
         IpProtocolGuid,\r
         TcpServiceData->DriverBindingHandle,\r
         This->SockHandle\r
         );\r
}\r
\r
/**\r
  Creates a child handle with a set of TCP services.\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[in]      This          Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in, out] ChildHandle   Pointer to the handle of the child to create.\r
                                If it is NULL, then a new handle is created.\r
                                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_SUCCESS           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 available to create\r
                                the child.\r
  @retval other                 The child handle was not created.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TcpServiceBindingCreateChild (\r
  IN     EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN OUT EFI_HANDLE                    *ChildHandle\r
  )\r
{\r
  SOCKET            *Sock;\r
  TCP_SERVICE_DATA  *TcpServiceData;\r
  TCP_PROTO_DATA    TcpProto;\r
  EFI_STATUS        Status;\r
  EFI_TPL           OldTpl;\r
\r
  if ((NULL == This) || (NULL == ChildHandle)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  Status              = EFI_SUCCESS;\r
  TcpServiceData      = TCP_SERVICE_FROM_THIS (This);\r
  TcpProto.TcpService = TcpServiceData;\r
  TcpProto.TcpPcb     = NULL;\r
\r
  //\r
  // Create a tcp instance with default Tcp default\r
  // sock init data and TcpProto\r
  //\r
  mTcpDefaultSockData.ProtoData     = &TcpProto;\r
  mTcpDefaultSockData.DataSize      = sizeof (TCP_PROTO_DATA);\r
  mTcpDefaultSockData.DriverBinding = TcpServiceData->DriverBindingHandle;\r
  mTcpDefaultSockData.IpVersion     = TcpServiceData->IpVersion;\r
\r
  if (TcpServiceData->IpVersion == IP_VERSION_4) {\r
    mTcpDefaultSockData.Protocol = &gTcp4ProtocolTemplate;\r
  } else {\r
    mTcpDefaultSockData.Protocol = &gTcp6ProtocolTemplate;\r
  }\r
\r
  Sock = SockCreateChild (&mTcpDefaultSockData);\r
  if (NULL == Sock) {\r
    DEBUG (\r
      (DEBUG_ERROR,\r
       "TcpDriverBindingCreateChild: No resource to create a Tcp Child\n")\r
      );\r
\r
    Status = EFI_OUT_OF_RESOURCES;\r
  } else {\r
    *ChildHandle = Sock->SockHandle;\r
  }\r
\r
  mTcpDefaultSockData.ProtoData = NULL;\r
\r
  gBS->RestoreTPL (OldTpl);\r
  return Status;\r
}\r
\r
/**\r
  Destroys a child handle with a set of TCP services.\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
  @param  ChildHandle Handle of the child to be destroyed.\r
\r
  @retval EFI_SUCCESS           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 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
\r
**/\r
EFI_STATUS\r
EFIAPI\r
TcpServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    ChildHandle\r
  )\r
{\r
  EFI_STATUS  Status;\r
  VOID        *Tcp;\r
  SOCKET      *Sock;\r
\r
  if ((NULL == This) || (NULL == ChildHandle)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // retrieve the Tcp4 protocol from ChildHandle\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ChildHandle,\r
                  &gEfiTcp4ProtocolGuid,\r
                  &Tcp,\r
                  gTcp4DriverBinding.DriverBindingHandle,\r
                  ChildHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // No Tcp4, try the Tcp6 protocol\r
    //\r
    Status = gBS->OpenProtocol (\r
                    ChildHandle,\r
                    &gEfiTcp6ProtocolGuid,\r
                    &Tcp,\r
                    gTcp6DriverBinding.DriverBindingHandle,\r
                    ChildHandle,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // destroy this sock and related Tcp protocol control\r
    // block\r
    //\r
    Sock = SOCK_FROM_THIS (Tcp);\r
\r
    SockDestroyChild (Sock);\r
  }\r
\r
  return Status;\r
}\r