[mirror_edk2.git] / NetworkPkg / UefiPxeBcDxe / PxeBcDriver.c

/** @file\r
  Driver Binding functions implementationfor for UefiPxeBc Driver.\r
\r
  (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  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
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "PxeBcImpl.h"\r
\r
\r
EFI_DRIVER_BINDING_PROTOCOL gPxeBcIp4DriverBinding = {\r
  PxeBcIp4DriverBindingSupported,\r
  PxeBcIp4DriverBindingStart,\r
  PxeBcIp4DriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_DRIVER_BINDING_PROTOCOL gPxeBcIp6DriverBinding = {\r
  PxeBcIp6DriverBindingSupported,\r
  PxeBcIp6DriverBindingStart,\r
  PxeBcIp6DriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
/**\r
  Get the Nic handle using any child handle in the IPv4 stack.\r
\r
  @param[in]  ControllerHandle    Pointer to child handle over IPv4.\r
\r
  @return NicHandle               The pointer to the Nic handle.\r
\r
**/\r
EFI_HANDLE\r
PxeBcGetNicByIp4Children (\r
  IN EFI_HANDLE                 ControllerHandle\r
  )\r
{\r
  EFI_HANDLE                    NicHandle;\r
\r
  NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiArpProtocolGuid);\r
  if (NicHandle == NULL) {\r
    NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiIp4ProtocolGuid);\r
    if (NicHandle == NULL) {\r
      NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp4ProtocolGuid);\r
      if (NicHandle == NULL) {\r
        NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiDhcp4ProtocolGuid);\r
        if (NicHandle == NULL) {\r
          NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiMtftp4ProtocolGuid);\r
          if (NicHandle == NULL) {\r
            return NULL;\r
          }\r
        }\r
      }\r
    }\r
  }\r
\r
  return NicHandle;\r
}\r
\r
\r
/**\r
  Get the Nic handle using any child handle in the IPv6 stack.\r
\r
  @param[in]  ControllerHandle    Pointer to child handle over IPv6.\r
\r
  @return NicHandle               The pointer to the Nic handle.\r
\r
**/\r
EFI_HANDLE\r
PxeBcGetNicByIp6Children (\r
  IN EFI_HANDLE                  ControllerHandle\r
  )\r
{\r
  EFI_HANDLE                     NicHandle;\r
\r
  NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiIp6ProtocolGuid);\r
  if (NicHandle == NULL) {\r
    NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp6ProtocolGuid);\r
    if (NicHandle == NULL) {\r
      NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiDhcp6ProtocolGuid);\r
      if (NicHandle == NULL) {\r
        NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiMtftp6ProtocolGuid);\r
        if (NicHandle == NULL) {\r
          return NULL;\r
        }\r
      }\r
    }\r
  }\r
\r
  return NicHandle;\r
}\r
\r
\r
/**\r
  Destroy the opened instances based on IPv4.\r
\r
  @param[in]  This              Pointer to the EFI_DRIVER_BINDING_PROTOCOL.\r
  @param[in]  Private           Pointer to PXEBC_PRIVATE_DATA.\r
\r
**/\r
VOID\r
PxeBcDestroyIp4Children (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN PXEBC_PRIVATE_DATA           *Private\r
  )\r
{\r
  ASSERT(Private != NULL);\r
\r
  if (Private->ArpChild != NULL) {\r
    //\r
    // Close Arp for PxeBc->Arp and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
           Private->ArpChild,\r
           &gEfiArpProtocolGuid,\r
           This->DriverBindingHandle,\r
           Private->Controller\r
           );\r
\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiArpServiceBindingProtocolGuid,\r
      Private->ArpChild\r
      );\r
  }\r
\r
  if (Private->Ip4Child != NULL) {\r
    //\r
    // Close Ip4 for background ICMP error message and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
           Private->Ip4Child,\r
           &gEfiIp4ProtocolGuid,\r
           This->DriverBindingHandle,\r
           Private->Controller\r
           );\r
\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiIp4ServiceBindingProtocolGuid,\r
      Private->Ip4Child\r
      );\r
  }\r
\r
  if (Private->Udp4WriteChild != NULL) {\r
    //\r
    // Close Udp4 for PxeBc->UdpWrite and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
           Private->Udp4WriteChild,\r
           &gEfiUdp4ProtocolGuid,\r
           This->DriverBindingHandle,\r
           Private->Controller\r
           );\r
\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiUdp4ServiceBindingProtocolGuid,\r
      Private->Udp4WriteChild\r
      );\r
  }\r
\r
  if (Private->Udp4ReadChild != NULL) {\r
    //\r
    // Close Udp4 for PxeBc->UdpRead and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
          Private->Udp4ReadChild,\r
          &gEfiUdp4ProtocolGuid,\r
          This->DriverBindingHandle,\r
          Private->Controller\r
          );\r
\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiUdp4ServiceBindingProtocolGuid,\r
      Private->Udp4ReadChild\r
      );\r
  }\r
\r
  if (Private->Mtftp4Child != NULL) {\r
    //\r
    // Close Mtftp4 for PxeBc->Mtftp4 and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
          Private->Mtftp4Child,\r
          &gEfiMtftp4ProtocolGuid,\r
          This->DriverBindingHandle,\r
          Private->Controller\r
          );\r
\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiMtftp4ServiceBindingProtocolGuid,\r
      Private->Mtftp4Child\r
      );\r
  }\r
\r
  if (Private->Dhcp4Child != NULL) {\r
    //\r
    // Close Dhcp4 for PxeBc->Dhcp4 and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
          Private->Dhcp4Child,\r
          &gEfiDhcp4ProtocolGuid,\r
          This->DriverBindingHandle,\r
          Private->Controller\r
          );\r
\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiDhcp4ServiceBindingProtocolGuid,\r
      Private->Dhcp4Child\r
      );\r
  }\r
\r
  if (Private->Ip4Nic != NULL) {\r
    //\r
    // Close PxeBcPrivate from the parent Nic handle and destroy the virtual handle.\r
    //\r
    gBS->CloseProtocol (\r
           Private->Controller,\r
           &gEfiCallerIdGuid,\r
           This->DriverBindingHandle,\r
           Private->Ip4Nic->Controller\r
           );\r
\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           Private->Ip4Nic->Controller,\r
           &gEfiDevicePathProtocolGuid,\r
           Private->Ip4Nic->DevicePath,\r
           &gEfiLoadFileProtocolGuid,\r
           &Private->Ip4Nic->LoadFile,\r
           &gEfiPxeBaseCodeProtocolGuid,\r
           &Private->PxeBc,\r
           NULL\r
           );\r
    FreePool (Private->Ip4Nic->DevicePath);\r
\r
    if (Private->Snp != NULL) {\r
      //\r
      // Close SNP from the child virtual handle\r
      //\r
      gBS->CloseProtocol (\r
             Private->Ip4Nic->Controller,\r
             &gEfiSimpleNetworkProtocolGuid,\r
             This->DriverBindingHandle,\r
             Private->Ip4Nic->Controller\r
             );\r
\r
      gBS->UninstallProtocolInterface (\r
             Private->Ip4Nic->Controller,\r
             &gEfiSimpleNetworkProtocolGuid,\r
             Private->Snp\r
             );\r
    }\r
    FreePool (Private->Ip4Nic);\r
  }\r
\r
  Private->ArpChild         = NULL;\r
  Private->Ip4Child         = NULL;\r
  Private->Udp4WriteChild   = NULL;\r
  Private->Udp4ReadChild    = NULL;\r
  Private->Mtftp4Child      = NULL;\r
  Private->Dhcp4Child       = NULL;\r
  Private->Ip4Nic           = NULL;\r
}\r
\r
\r
/**\r
  Destroy the opened instances based on IPv6.\r
\r
  @param[in]  This              Pointer to the EFI_DRIVER_BINDING_PROTOCOL.\r
  @param[in]  Private           Pointer to PXEBC_PRIVATE_DATA.\r
\r
**/\r
VOID\r
PxeBcDestroyIp6Children (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN PXEBC_PRIVATE_DATA           *Private\r
  )\r
{\r
  ASSERT(Private != NULL);\r
\r
  if (Private->Ip6Child != NULL) {\r
    //\r
    // Close Ip6 for Ip6->Ip6Config and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
          Private->Ip6Child,\r
          &gEfiIp6ProtocolGuid,\r
          This->DriverBindingHandle,\r
          Private->Controller\r
          );\r
\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiIp6ServiceBindingProtocolGuid,\r
      Private->Ip6Child\r
      );\r
  }\r
\r
  if (Private->Udp6WriteChild != NULL) {\r
    //\r
    // Close Udp6 for PxeBc->UdpWrite and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
           Private->Udp6WriteChild,\r
           &gEfiUdp6ProtocolGuid,\r
           This->DriverBindingHandle,\r
           Private->Controller\r
           );\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiUdp6ServiceBindingProtocolGuid,\r
      Private->Udp6WriteChild\r
      );\r
  }\r
\r
  if (Private->Udp6ReadChild != NULL) {\r
    //\r
    // Close Udp6 for PxeBc->UdpRead and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
          Private->Udp6ReadChild,\r
          &gEfiUdp6ProtocolGuid,\r
          This->DriverBindingHandle,\r
          Private->Controller\r
          );\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiUdp6ServiceBindingProtocolGuid,\r
      Private->Udp6ReadChild\r
      );\r
  }\r
\r
  if (Private->Mtftp6Child != NULL) {\r
    //\r
    // Close Mtftp6 for PxeBc->Mtftp and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
          Private->Mtftp6Child,\r
          &gEfiMtftp6ProtocolGuid,\r
          This->DriverBindingHandle,\r
          Private->Controller\r
          );\r
\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiMtftp6ServiceBindingProtocolGuid,\r
      Private->Mtftp6Child\r
      );\r
  }\r
\r
  if (Private->Dhcp6Child != NULL) {\r
    //\r
    // Close Dhcp6 for PxeBc->Dhcp and destroy the instance.\r
    //\r
    gBS->CloseProtocol (\r
          Private->Dhcp6Child,\r
          &gEfiDhcp6ProtocolGuid,\r
          This->DriverBindingHandle,\r
          Private->Controller\r
          );\r
\r
    NetLibDestroyServiceChild (\r
      Private->Controller,\r
      This->DriverBindingHandle,\r
      &gEfiDhcp6ServiceBindingProtocolGuid,\r
      Private->Dhcp6Child\r
      );\r
  }\r
\r
  if (Private->Ip6Nic != NULL) {\r
    //\r
    // Close PxeBcPrivate from the parent Nic handle and destroy the virtual handle.\r
    //\r
    gBS->CloseProtocol (\r
           Private->Controller,\r
           &gEfiCallerIdGuid,\r
           This->DriverBindingHandle,\r
           Private->Ip6Nic->Controller\r
           );\r
\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           Private->Ip6Nic->Controller,\r
           &gEfiDevicePathProtocolGuid,\r
           Private->Ip6Nic->DevicePath,\r
           &gEfiLoadFileProtocolGuid,\r
           &Private->Ip6Nic->LoadFile,\r
           &gEfiPxeBaseCodeProtocolGuid,\r
           &Private->PxeBc,\r
           NULL\r
           );\r
    FreePool (Private->Ip6Nic->DevicePath);\r
\r
    if (Private->Snp != NULL) {\r
      //\r
      // Close SNP from the child virtual handle\r
      //\r
      gBS->CloseProtocol (\r
             Private->Ip6Nic->Controller,\r
             &gEfiSimpleNetworkProtocolGuid,\r
             This->DriverBindingHandle,\r
             Private->Ip6Nic->Controller\r
             );\r
      gBS->UninstallProtocolInterface (\r
             Private->Ip6Nic->Controller,\r
             &gEfiSimpleNetworkProtocolGuid,\r
             Private->Snp\r
             );\r
    }\r
    FreePool (Private->Ip6Nic);\r
  }\r
\r
  Private->Ip6Child           = NULL;\r
  Private->Udp6WriteChild     = NULL;\r
  Private->Udp6ReadChild      = NULL;\r
  Private->Mtftp6Child        = NULL;\r
  Private->Dhcp6Child         = NULL;\r
  Private->Ip6Nic             = NULL;\r
  Private->Mode.Ipv6Available = FALSE;\r
}\r
\r
/**\r
  Check whether UNDI protocol supports IPv6.\r
\r
  @param[in]   ControllerHandle  Controller handle.\r
  @param[in]   Private           Pointer to PXEBC_PRIVATE_DATA.\r
  @param[out]  Ipv6Support       TRUE if UNDI supports IPv6.\r
\r
  @retval EFI_SUCCESS            Get the result whether UNDI supports IPv6 by NII or AIP protocol successfully.\r
  @retval EFI_NOT_FOUND          Don't know whether UNDI supports IPv6 since NII or AIP is not available.\r
\r
**/\r
EFI_STATUS\r
PxeBcCheckIpv6Support (\r
  IN  EFI_HANDLE                   ControllerHandle,\r
  IN  PXEBC_PRIVATE_DATA           *Private,\r
  OUT BOOLEAN                      *Ipv6Support\r
  )\r
{\r
  EFI_HANDLE                       Handle;\r
  EFI_ADAPTER_INFORMATION_PROTOCOL *Aip;\r
  EFI_STATUS                       Status;\r
  EFI_GUID                         *InfoTypesBuffer;\r
  UINTN                            InfoTypeBufferCount;\r
  UINTN                            TypeIndex;\r
  BOOLEAN                          Supported;\r
  VOID                             *InfoBlock;\r
  UINTN                            InfoBlockSize;\r
\r
  ASSERT (Private != NULL && Ipv6Support != NULL);\r
\r
  //\r
  // Check whether the UNDI supports IPv6 by NII protocol.\r
  //\r
  if (Private->Nii != NULL) {\r
    *Ipv6Support = Private->Nii->Ipv6Supported;\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Check whether the UNDI supports IPv6 by AIP protocol.\r
  //\r
\r
  //\r
  // Get the NIC handle by SNP protocol.\r
  //\r
  Handle = NetLibGetSnpHandle (ControllerHandle, NULL);\r
  if (Handle == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  Aip    = NULL;\r
  Status = gBS->HandleProtocol (\r
                  Handle,\r
                  &gEfiAdapterInformationProtocolGuid,\r
                  (VOID *) &Aip\r
                  );\r
  if (EFI_ERROR (Status) || Aip == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  InfoTypesBuffer     = NULL;\r
  InfoTypeBufferCount = 0;\r
  Status = Aip->GetSupportedTypes (Aip, &InfoTypesBuffer, &InfoTypeBufferCount);\r
  if (EFI_ERROR (Status) || InfoTypesBuffer == NULL) {\r
    FreePool (InfoTypesBuffer);\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  Supported = FALSE;\r
  for (TypeIndex = 0; TypeIndex < InfoTypeBufferCount; TypeIndex++) {\r
    if (CompareGuid (&InfoTypesBuffer[TypeIndex], &gEfiAdapterInfoUndiIpv6SupportGuid)) {\r
      Supported = TRUE;\r
      break;\r
    }\r
  }\r
\r
  FreePool (InfoTypesBuffer);\r
  if (!Supported) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // We now have adapter information block.\r
  //\r
  InfoBlock     = NULL;\r
  InfoBlockSize = 0;\r
  Status = Aip->GetInformation (Aip, &gEfiAdapterInfoUndiIpv6SupportGuid, &InfoBlock, &InfoBlockSize);\r
  if (EFI_ERROR (Status) || InfoBlock == NULL) {\r
    FreePool (InfoBlock);\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  *Ipv6Support = ((EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT *) InfoBlock)->Ipv6Support;\r
  FreePool (InfoBlock);\r
  return EFI_SUCCESS;\r
\r
}\r
\r
/**\r
  Create the opened instances based on IPv4.\r
\r
  @param[in]  This              Pointer to EFI_DRIVER_BINDING_PROTOCOL.\r
  @param[in]  ControllerHandle  Handle of the child to destroy.\r
  @param[in]  Private Handle    Pointer to PXEBC_PRIVATE_DATA.\r
\r
  @retval EFI_SUCCESS           The instances based on IPv4 were all created successfully.\r
  @retval Others                An unexpected error occurred.\r
\r
**/\r
EFI_STATUS\r
PxeBcCreateIp4Children (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN PXEBC_PRIVATE_DATA           *Private\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  IPv4_DEVICE_PATH                Ip4Node;\r
  EFI_PXE_BASE_CODE_MODE          *Mode;\r
  EFI_UDP4_CONFIG_DATA            *Udp4CfgData;\r
  EFI_IP4_CONFIG_DATA             *Ip4CfgData;\r
  EFI_IP4_MODE_DATA               Ip4ModeData;\r
  PXEBC_PRIVATE_PROTOCOL          *Id;\r
  EFI_SIMPLE_NETWORK_PROTOCOL     *Snp;\r
\r
  if (Private->Ip4Nic != NULL) {\r
    //\r
    // Already created before.\r
    //\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Create Dhcp4 child and open Dhcp4 protocol for PxeBc->Dhcp.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiDhcp4ServiceBindingProtocolGuid,\r
             &Private->Dhcp4Child\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Dhcp4Child,\r
                  &gEfiDhcp4ProtocolGuid,\r
                  (VOID **) &Private->Dhcp4,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create Mtftp4 child and open Mtftp4 protocol for PxeBc->Mtftp.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiMtftp4ServiceBindingProtocolGuid,\r
             &Private->Mtftp4Child\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Mtftp4Child,\r
                  &gEfiMtftp4ProtocolGuid,\r
                  (VOID **) &Private->Mtftp4,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create Udp4 child and open Udp4 protocol for PxeBc->UdpRead.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiUdp4ServiceBindingProtocolGuid,\r
             &Private->Udp4ReadChild\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Udp4ReadChild,\r
                  &gEfiUdp4ProtocolGuid,\r
                  (VOID **) &Private->Udp4Read,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create Udp4 child and open Udp4 protocol for PxeBc->UdpWrite.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiUdp4ServiceBindingProtocolGuid,\r
             &Private->Udp4WriteChild\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Udp4WriteChild,\r
                  &gEfiUdp4ProtocolGuid,\r
                  (VOID **) &Private->Udp4Write,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create Arp child and open Arp protocol for PxeBc->Arp.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiArpServiceBindingProtocolGuid,\r
             &Private->ArpChild\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->ArpChild,\r
                  &gEfiArpProtocolGuid,\r
                  (VOID **) &Private->Arp,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create Ip4 child and open Ip4 protocol for background ICMP packets.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiIp4ServiceBindingProtocolGuid,\r
             &Private->Ip4Child\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Ip4Child,\r
                  &gEfiIp4ProtocolGuid,\r
                  (VOID **) &Private->Ip4,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Get max packet size from Ip4 to calculate block size for Tftp later.\r
  //\r
  Status = Private->Ip4->GetModeData (Private->Ip4, &Ip4ModeData, NULL, NULL);\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Private->Ip4MaxPacketSize = Ip4ModeData.MaxPacketSize;\r
\r
  Private->Ip4Nic = AllocateZeroPool (sizeof (PXEBC_VIRTUAL_NIC));\r
  if (Private->Ip4Nic == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Private->Ip4Nic->Private   = Private;\r
  Private->Ip4Nic->Signature = PXEBC_VIRTUAL_NIC_SIGNATURE;\r
\r
   //\r
  // Locate Ip4->Ip4Config2 and store it for set IPv4 Policy.\r
  //\r
  Status = gBS->HandleProtocol (\r
                  ControllerHandle,\r
                  &gEfiIp4Config2ProtocolGuid,\r
                  (VOID **) &Private->Ip4Config2\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create a device path node for Ipv4 virtual nic, and append it.\r
  //\r
  ZeroMem (&Ip4Node, sizeof (IPv4_DEVICE_PATH));\r
  Ip4Node.Header.Type     = MESSAGING_DEVICE_PATH;\r
  Ip4Node.Header.SubType  = MSG_IPv4_DP;\r
  Ip4Node.StaticIpAddress = FALSE;\r
\r
  SetDevicePathNodeLength (&Ip4Node.Header, sizeof (Ip4Node));\r
\r
  Private->Ip4Nic->DevicePath = AppendDevicePathNode (Private->DevicePath, &Ip4Node.Header);\r
\r
  if (Private->Ip4Nic->DevicePath == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_ERROR;\r
  }\r
\r
  CopyMem (\r
    &Private->Ip4Nic->LoadFile,\r
    &gLoadFileProtocolTemplate,\r
    sizeof (EFI_LOAD_FILE_PROTOCOL)\r
    );\r
\r
  //\r
  // Create a new handle for IPv4 virtual nic,\r
  // and install PxeBaseCode, LoadFile and DevicePath protocols.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Private->Ip4Nic->Controller,\r
                  &gEfiDevicePathProtocolGuid,\r
                  Private->Ip4Nic->DevicePath,\r
                  &gEfiLoadFileProtocolGuid,\r
                  &Private->Ip4Nic->LoadFile,\r
                  &gEfiPxeBaseCodeProtocolGuid,\r
                  &Private->PxeBc,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  if (Private->Snp != NULL) {\r
    //\r
    // Install SNP protocol on purpose is for some OS loader backward\r
    // compatibility consideration.\r
    //\r
    Status = gBS->InstallProtocolInterface (\r
                    &Private->Ip4Nic->Controller,\r
                    &gEfiSimpleNetworkProtocolGuid,\r
                    EFI_NATIVE_INTERFACE,\r
                    Private->Snp\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Open SNP on the child handle BY_DRIVER. It will prevent any additionally\r
    // layering to perform the experiment.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    Private->Ip4Nic->Controller,\r
                    &gEfiSimpleNetworkProtocolGuid,\r
                    (VOID **) &Snp,\r
                    This->DriverBindingHandle,\r
                    Private->Ip4Nic->Controller,\r
                    EFI_OPEN_PROTOCOL_BY_DRIVER\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      goto ON_ERROR;\r
    }\r
  }\r
\r
  //\r
  // Open PxeBaseCodePrivate protocol by child to setup a parent-child relationship between\r
  // real NIC handle and the virtual IPv4 NIC handle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiCallerIdGuid,\r
                  (VOID **) &Id,\r
                  This->DriverBindingHandle,\r
                  Private->Ip4Nic->Controller,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Set default configure data for Udp4Read and Ip4 instance.\r
  //\r
  Mode                            = Private->PxeBc.Mode;\r
  Udp4CfgData                     = &Private->Udp4CfgData;\r
  Ip4CfgData                      = &Private->Ip4CfgData;\r
\r
  Udp4CfgData->AcceptBroadcast    = FALSE;\r
  Udp4CfgData->AcceptAnyPort      = TRUE;\r
  Udp4CfgData->AllowDuplicatePort = TRUE;\r
  Udp4CfgData->TypeOfService      = Mode->ToS;\r
  Udp4CfgData->TimeToLive         = Mode->TTL;\r
  Udp4CfgData->ReceiveTimeout     = PXEBC_DEFAULT_LIFETIME;\r
  Udp4CfgData->TransmitTimeout    = PXEBC_DEFAULT_LIFETIME;\r
\r
  Ip4CfgData->AcceptIcmpErrors    = TRUE;\r
  Ip4CfgData->DefaultProtocol     = EFI_IP_PROTO_ICMP;\r
  Ip4CfgData->TypeOfService       = Mode->ToS;\r
  Ip4CfgData->TimeToLive          = Mode->TTL;\r
  Ip4CfgData->ReceiveTimeout      = PXEBC_DEFAULT_LIFETIME;\r
  Ip4CfgData->TransmitTimeout     = PXEBC_DEFAULT_LIFETIME;\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  PxeBcDestroyIp4Children (This, Private);\r
  return Status;\r
}\r
\r
\r
/**\r
  Create the opened instances based on IPv6.\r
\r
  @param[in]  This              Pointer to EFI_DRIVER_BINDING_PROTOCOL.\r
  @param[in]  ControllerHandle  Handle of the child to destroy.\r
  @param[in]  Private Handle    Pointer to PXEBC_PRIVATE_DATA.\r
\r
  @retval EFI_SUCCESS           The instances based on IPv6 were all created successfully.\r
  @retval Others                An unexpected error occurred.\r
\r
**/\r
EFI_STATUS\r
PxeBcCreateIp6Children (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN PXEBC_PRIVATE_DATA           *Private\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  IPv6_DEVICE_PATH                Ip6Node;\r
  EFI_UDP6_CONFIG_DATA            *Udp6CfgData;\r
  EFI_IP6_CONFIG_DATA             *Ip6CfgData;\r
  EFI_IP6_MODE_DATA               Ip6ModeData;\r
  PXEBC_PRIVATE_PROTOCOL          *Id;\r
  EFI_SIMPLE_NETWORK_PROTOCOL     *Snp;\r
  UINTN                           Index;\r
\r
  if (Private->Ip6Nic != NULL) {\r
    //\r
    // Already created before.\r
    //\r
    return EFI_SUCCESS;\r
  }\r
\r
  Private->Ip6Nic = AllocateZeroPool (sizeof (PXEBC_VIRTUAL_NIC));\r
\r
  if (Private->Ip6Nic == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Private->Ip6Nic->Private   = Private;\r
  Private->Ip6Nic->Signature = PXEBC_VIRTUAL_NIC_SIGNATURE;\r
\r
  //\r
  // Create Dhcp6 child and open Dhcp6 protocol for PxeBc->Dhcp.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiDhcp6ServiceBindingProtocolGuid,\r
             &Private->Dhcp6Child\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Dhcp6Child,\r
                  &gEfiDhcp6ProtocolGuid,\r
                  (VOID **) &Private->Dhcp6,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Generate a random IAID for the Dhcp6 assigned address.\r
  //\r
  Private->IaId = NET_RANDOM (NetRandomInitSeed ());\r
  if (Private->Snp != NULL) {\r
    for (Index = 0; Index < Private->Snp->Mode->HwAddressSize; Index++) {\r
      Private->IaId |= (Private->Snp->Mode->CurrentAddress.Addr[Index] << ((Index << 3) & 31));\r
    }\r
  }\r
\r
  //\r
  // Create Mtftp6 child and open Mtftp6 protocol for PxeBc->Mtftp.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiMtftp6ServiceBindingProtocolGuid,\r
             &Private->Mtftp6Child\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Mtftp6Child,\r
                  &gEfiMtftp6ProtocolGuid,\r
                  (VOID **) &Private->Mtftp6,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create Udp6 child and open Udp6 protocol for PxeBc->UdpRead.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiUdp6ServiceBindingProtocolGuid,\r
             &Private->Udp6ReadChild\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Udp6ReadChild,\r
                  &gEfiUdp6ProtocolGuid,\r
                  (VOID **) &Private->Udp6Read,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create Udp6 child and open Udp6 protocol for PxeBc->UdpWrite.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiUdp6ServiceBindingProtocolGuid,\r
             &Private->Udp6WriteChild\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Udp6WriteChild,\r
                  &gEfiUdp6ProtocolGuid,\r
                  (VOID **) &Private->Udp6Write,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create Ip6 child and open Ip6 protocol for background ICMP6 packets.\r
  //\r
  Status = NetLibCreateServiceChild (\r
             ControllerHandle,\r
             This->DriverBindingHandle,\r
             &gEfiIp6ServiceBindingProtocolGuid,\r
             &Private->Ip6Child\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  Private->Ip6Child,\r
                  &gEfiIp6ProtocolGuid,\r
                  (VOID **) &Private->Ip6,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Get max packet size from Ip6 to calculate block size for Tftp later.\r
  //\r
  Status = Private->Ip6->GetModeData (Private->Ip6, &Ip6ModeData, NULL, NULL);\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  Private->Ip6MaxPacketSize = Ip6ModeData.MaxPacketSize;\r
\r
  if (Ip6ModeData.AddressList != NULL) {\r
    FreePool (Ip6ModeData.AddressList);\r
  }\r
\r
  if (Ip6ModeData.GroupTable != NULL) {\r
    FreePool (Ip6ModeData.GroupTable);\r
  }\r
\r
  if (Ip6ModeData.RouteTable != NULL) {\r
    FreePool (Ip6ModeData.RouteTable);\r
  }\r
\r
  if (Ip6ModeData.NeighborCache != NULL) {\r
    FreePool (Ip6ModeData.NeighborCache);\r
  }\r
\r
  if (Ip6ModeData.PrefixTable != NULL) {\r
    FreePool (Ip6ModeData.PrefixTable);\r
  }\r
\r
  if (Ip6ModeData.IcmpTypeList != NULL) {\r
    FreePool (Ip6ModeData.IcmpTypeList);\r
  }\r
\r
  //\r
  // Locate Ip6->Ip6Config and store it for set IPv6 address.\r
  //\r
  Status = gBS->HandleProtocol (\r
                  ControllerHandle,\r
                  &gEfiIp6ConfigProtocolGuid,\r
                  (VOID **) &Private->Ip6Cfg\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create a device path node for Ipv6 virtual nic, and append it.\r
  //\r
  ZeroMem (&Ip6Node, sizeof (IPv6_DEVICE_PATH));\r
  Ip6Node.Header.Type     = MESSAGING_DEVICE_PATH;\r
  Ip6Node.Header.SubType  = MSG_IPv6_DP;\r
  Ip6Node.PrefixLength    = IP6_PREFIX_LENGTH;\r
\r
  SetDevicePathNodeLength (&Ip6Node.Header, sizeof (Ip6Node));\r
\r
  Private->Ip6Nic->DevicePath = AppendDevicePathNode (Private->DevicePath, &Ip6Node.Header);\r
\r
  if (Private->Ip6Nic->DevicePath == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_ERROR;\r
  }\r
\r
  CopyMem (\r
    &Private->Ip6Nic->LoadFile,\r
    &gLoadFileProtocolTemplate,\r
    sizeof (EFI_LOAD_FILE_PROTOCOL)\r
    );\r
\r
  //\r
  // Create a new handle for IPv6 virtual nic,\r
  // and install PxeBaseCode, LoadFile and DevicePath protocols.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Private->Ip6Nic->Controller,\r
                  &gEfiDevicePathProtocolGuid,\r
                  Private->Ip6Nic->DevicePath,\r
                  &gEfiLoadFileProtocolGuid,\r
                  &Private->Ip6Nic->LoadFile,\r
                  &gEfiPxeBaseCodeProtocolGuid,\r
                  &Private->PxeBc,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  if (Private->Snp != NULL) {\r
    //\r
    // Install SNP protocol on purpose is for some OS loader backward\r
    // compatibility consideration.\r
    //\r
    Status = gBS->InstallProtocolInterface (\r
                    &Private->Ip6Nic->Controller,\r
                    &gEfiSimpleNetworkProtocolGuid,\r
                    EFI_NATIVE_INTERFACE,\r
                    Private->Snp\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Open SNP on the child handle BY_DRIVER. It will prevent any additionally\r
    // layering to perform the experiment.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    Private->Ip6Nic->Controller,\r
                    &gEfiSimpleNetworkProtocolGuid,\r
                    (VOID **) &Snp,\r
                    This->DriverBindingHandle,\r
                    Private->Ip6Nic->Controller,\r
                    EFI_OPEN_PROTOCOL_BY_DRIVER\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      goto ON_ERROR;\r
    }\r
  }\r
\r
  //\r
  // Open PxeBaseCodePrivate protocol by child to setup a parent-child relationship between\r
  // real NIC handle and the virtual IPv6 NIC handle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiCallerIdGuid,\r
                  (VOID **) &Id,\r
                  This->DriverBindingHandle,\r
                  Private->Ip6Nic->Controller,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Set IPv6 avaiable flag and set default configure data for\r
  // Udp6Read and Ip6 instance.\r
  //\r
  Status = PxeBcCheckIpv6Support (ControllerHandle, Private, &Private->Mode.Ipv6Available);\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Fail to get the data whether UNDI supports IPv6. Set default value.\r
    //\r
    Private->Mode.Ipv6Available   = TRUE;\r
  }\r
\r
  if (!Private->Mode.Ipv6Available) {\r
    goto ON_ERROR;\r
  }\r
\r
  Udp6CfgData                     = &Private->Udp6CfgData;\r
  Ip6CfgData                      = &Private->Ip6CfgData;\r
\r
  Udp6CfgData->AcceptAnyPort      = TRUE;\r
  Udp6CfgData->AllowDuplicatePort = TRUE;\r
  Udp6CfgData->HopLimit           = PXEBC_DEFAULT_HOPLIMIT;\r
  Udp6CfgData->ReceiveTimeout     = PXEBC_DEFAULT_LIFETIME;\r
  Udp6CfgData->TransmitTimeout    = PXEBC_DEFAULT_LIFETIME;\r
\r
  Ip6CfgData->AcceptIcmpErrors    = TRUE;\r
  Ip6CfgData->DefaultProtocol     = IP6_ICMP;\r
  Ip6CfgData->HopLimit            = PXEBC_DEFAULT_HOPLIMIT;\r
  Ip6CfgData->ReceiveTimeout      = PXEBC_DEFAULT_LIFETIME;\r
  Ip6CfgData->TransmitTimeout     = PXEBC_DEFAULT_LIFETIME;\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  PxeBcDestroyIp6Children (This, Private);\r
  return Status;\r
}\r
\r
\r
/**\r
  The entry point for UefiPxeBc driver that installs the driver\r
  binding and component name protocol on its image.\r
\r
  @param[in]  ImageHandle          The Image handle of the driver.\r
  @param[in]  SystemTable          The system table.\r
\r
  @return EFI_SUCCESS\r
  @return Others\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PxeBcDriverEntryPoint (\r
  IN EFI_HANDLE             ImageHandle,\r
  IN EFI_SYSTEM_TABLE       *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gPxeBcIp4DriverBinding,\r
             ImageHandle,\r
             &gPxeBcComponentName,\r
             &gPxeBcComponentName2\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gPxeBcIp6DriverBinding,\r
             NULL,\r
             &gPxeBcComponentName,\r
             &gPxeBcComponentName2\r
             );\r
  if (EFI_ERROR (Status)) {\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           ImageHandle,\r
           &gEfiDriverBindingProtocolGuid,\r
           &gPxeBcIp4DriverBinding,\r
           &gEfiComponentName2ProtocolGuid,\r
           &gPxeBcComponentName2,\r
           &gEfiComponentNameProtocolGuid,\r
           &gPxeBcComponentName,\r
           NULL\r
           );\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Test to see if this driver supports ControllerHandle. This is the worker function for\r
  PxeBcIp4(6)DriverBindingSupported.\r
\r
  @param[in]  This                The pointer to the driver binding protocol.\r
  @param[in]  ControllerHandle    The handle of device to be tested.\r
  @param[in]  RemainingDevicePath Optional parameter used to pick a specific child\r
                                  device to be started.\r
  @param[in]  IpVersion           IP_VERSION_4 or IP_VERSION_6.\r
\r
  @retval EFI_SUCCESS         This driver supports this device.\r
  @retval EFI_UNSUPPORTED     This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PxeBcSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL,\r
  IN UINT8                        IpVersion\r
  )\r
{\r
  EFI_STATUS                      Status;\r
  EFI_GUID                        *DhcpServiceBindingGuid;\r
  EFI_GUID                        *MtftpServiceBindingGuid;\r
\r
  if (IpVersion == IP_VERSION_4) {\r
    DhcpServiceBindingGuid  = &gEfiDhcp4ServiceBindingProtocolGuid;\r
    MtftpServiceBindingGuid = &gEfiMtftp4ServiceBindingProtocolGuid;\r
  } else {\r
    DhcpServiceBindingGuid  = &gEfiDhcp6ServiceBindingProtocolGuid;\r
    MtftpServiceBindingGuid = &gEfiMtftp6ServiceBindingProtocolGuid;\r
  }\r
\r
  //\r
  // Try to open the Mtftp and Dhcp protocol to test whether IP stack is ready.\r
  //\r
  Status = gBS->OpenProtocol (\r
                     ControllerHandle,\r
                     DhcpServiceBindingGuid,\r
                     NULL,\r
                     This->DriverBindingHandle,\r
                     ControllerHandle,\r
                     EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                     );\r
  if (!EFI_ERROR (Status)) {\r
    Status = gBS->OpenProtocol (\r
                       ControllerHandle,\r
                       MtftpServiceBindingGuid,\r
                       NULL,\r
                       This->DriverBindingHandle,\r
                       ControllerHandle,\r
                       EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                       );\r
  }\r
\r
  //\r
  // It's unsupported case if IP stack are not ready.\r
  //\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Start this driver on ControllerHandle. This is the worker function for\r
  PxeBcIp4(6)DriverBindingStart.\r
\r
  @param[in]  This                 The pointer to the driver binding protocol.\r
  @param[in]  ControllerHandle     The handle of device to be started.\r
  @param[in]  RemainingDevicePath  Optional parameter used to pick a specific child\r
                                   device to be started.\r
  @param[in]  IpVersion            IP_VERSION_4 or IP_VERSION_6.\r
\r
\r
  @retval EFI_SUCCESS          This driver is installed 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
EFIAPI\r
PxeBcStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL,\r
  IN UINT8                        IpVersion\r
  )\r
{\r
  PXEBC_PRIVATE_DATA              *Private;\r
  EFI_STATUS                      Status;\r
  PXEBC_PRIVATE_PROTOCOL          *Id;\r
  BOOLEAN                         FirstStart;\r
\r
  FirstStart = FALSE;\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiCallerIdGuid,\r
                  (VOID **) &Id,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Skip the initialization if the driver has been started already.\r
    //\r
    Private = PXEBC_PRIVATE_DATA_FROM_ID (Id);\r
  } else {\r
    FirstStart = TRUE;\r
    //\r
    // If the driver has not been started yet, it should do initialization.\r
    //\r
    Private = AllocateZeroPool (sizeof (PXEBC_PRIVATE_DATA));\r
    if (Private == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    CopyMem (\r
      &Private->PxeBc,\r
      &gPxeBcProtocolTemplate,\r
      sizeof (EFI_PXE_BASE_CODE_PROTOCOL)\r
      );\r
\r
    Private->Signature          = PXEBC_PRIVATE_DATA_SIGNATURE;\r
    Private->Controller         = ControllerHandle;\r
    Private->Image              = This->ImageHandle;\r
    Private->PxeBc.Mode         = &Private->Mode;\r
    Private->Mode.Ipv6Supported = TRUE;\r
    Private->Mode.AutoArp       = TRUE;\r
    Private->Mode.TTL           = DEFAULT_TTL;\r
    Private->Mode.ToS           = DEFAULT_ToS;\r
\r
    //\r
    // Open device path to prepare for appending virtual NIC node.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    ControllerHandle,\r
                    &gEfiDevicePathProtocolGuid,\r
                    (VOID **) &Private->DevicePath,\r
                    This->DriverBindingHandle,\r
                    ControllerHandle,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
\r
    if (EFI_ERROR (Status)) {\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Get the NII interface if it exists, it's not required.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    ControllerHandle,\r
                    &gEfiNetworkInterfaceIdentifierProtocolGuid_31,\r
                    (VOID **) &Private->Nii,\r
                    This->DriverBindingHandle,\r
                    ControllerHandle,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      Private->Nii = NULL;\r
    }\r
\r
    //\r
    // Install PxeBaseCodePrivate protocol onto the real NIC handler.\r
    // PxeBaseCodePrivate protocol is only used to keep the relationship between\r
    // NIC handle and virtual child handles.\r
    // gEfiCallerIdGuid will be used as its protocol guid.\r
    //\r
    Status = gBS->InstallProtocolInterface (\r
                    &ControllerHandle,\r
                    &gEfiCallerIdGuid,\r
                    EFI_NATIVE_INTERFACE,\r
                    &Private->Id\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      goto ON_ERROR;\r
    }\r
\r
    //\r
    // Try to locate SNP protocol.\r
    //\r
    NetLibGetSnpHandle(ControllerHandle, &Private->Snp);\r
  }\r
\r
  if (IpVersion == IP_VERSION_4) {\r
    //\r
    // Try to create virtual NIC handle for IPv4.\r
    //\r
    Status = PxeBcCreateIp4Children (This, ControllerHandle, Private);\r
  } else {\r
    //\r
    // Try to create virtual NIC handle for IPv6.\r
    //\r
    Status = PxeBcCreateIp6Children (This, ControllerHandle, Private);\r
  }\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Failed to start PXE driver if IPv4 and IPv6 stack are both not available.\r
    //\r
    Status = EFI_DEVICE_ERROR;\r
    goto ON_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  if (FirstStart) {\r
    gBS->UninstallProtocolInterface (\r
           ControllerHandle,\r
           &gEfiCallerIdGuid,\r
           &Private->Id\r
           );\r
  }\r
\r
  if (IpVersion == IP_VERSION_4) {\r
    PxeBcDestroyIp4Children (This, Private);\r
  } else {\r
    PxeBcDestroyIp6Children (This, Private);\r
  }\r
\r
  if (FirstStart && Private != NULL) {\r
    FreePool (Private);\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Stop this driver on ControllerHandle. This is the worker function for\r
  PxeBcIp4(6)DriverBindingStop.\r
\r
  @param[in]  This              Protocol instance pointer.\r
  @param[in]  ControllerHandle  Handle of device to stop driver on.\r
  @param[in]  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                                children is zero stop the entire bus driver.\r
  @param[in]  ChildHandleBuffer List of Child Handles to Stop.\r
  @param[in]  IpVersion         IP_VERSION_4 or IP_VERSION_6.\r
\r
  @retval EFI_SUCCESS           This driver was removed ControllerHandle.\r
  @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
  @retval Others                This driver was not removed from this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PxeBcStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer,\r
  IN UINT8                        IpVersion\r
  )\r
{\r
  PXEBC_PRIVATE_DATA              *Private;\r
  PXEBC_VIRTUAL_NIC               *VirtualNic;\r
  EFI_LOAD_FILE_PROTOCOL          *LoadFile;\r
  EFI_STATUS                      Status;\r
  EFI_HANDLE                      NicHandle;\r
  PXEBC_PRIVATE_PROTOCOL          *Id;\r
\r
  Private    = NULL;\r
  NicHandle  = NULL;\r
  VirtualNic = NULL;\r
  LoadFile   = NULL;\r
  Id         = NULL;\r
\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiLoadFileProtocolGuid,\r
                  (VOID **) &LoadFile,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Get the Nic handle by any pass-over service child handle.\r
    //\r
    if (IpVersion == IP_VERSION_4) {\r
      NicHandle = PxeBcGetNicByIp4Children (ControllerHandle);\r
    } else {\r
      NicHandle = PxeBcGetNicByIp6Children (ControllerHandle);\r
    }\r
    if (NicHandle == NULL) {\r
      return EFI_SUCCESS;\r
    }\r
\r
    //\r
    // Try to retrieve the private data by PxeBcPrivate protocol.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    NicHandle,\r
                    &gEfiCallerIdGuid,\r
                    (VOID **) &Id,\r
                    This->DriverBindingHandle,\r
                    ControllerHandle,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
    Private = PXEBC_PRIVATE_DATA_FROM_ID (Id);\r
\r
  } else {\r
    //\r
    // It's a virtual handle with LoadFileProtocol.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    ControllerHandle,\r
                    &gEfiLoadFileProtocolGuid,\r
                    (VOID **) &LoadFile,\r
                    This->DriverBindingHandle,\r
                    ControllerHandle,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    VirtualNic = PXEBC_VIRTUAL_NIC_FROM_LOADFILE (LoadFile);\r
    Private    = VirtualNic->Private;\r
    NicHandle  = Private->Controller;\r
  }\r
\r
  //\r
  // Stop functionality of PXE Base Code protocol\r
  //\r
  Status = Private->PxeBc.Stop (&Private->PxeBc);\r
  if (Status != EFI_SUCCESS && Status != EFI_NOT_STARTED) {\r
    return Status;\r
  }\r
\r
\r
  if (Private->Ip4Nic != NULL && IpVersion == IP_VERSION_4) {\r
    PxeBcDestroyIp4Children (This, Private);\r
  }\r
\r
  if (Private->Ip6Nic != NULL && IpVersion == IP_VERSION_6) {\r
    PxeBcDestroyIp6Children (This, Private);\r
  }\r
\r
  if (Private->Ip4Nic == NULL && Private->Ip6Nic == NULL) {\r
    gBS->UninstallProtocolInterface (\r
           NicHandle,\r
           &gEfiCallerIdGuid,\r
           &Private->Id\r
           );\r
    FreePool (Private);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\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[in]  This                The pointer to the driver binding protocol.\r
  @param[in]  ControllerHandle    The handle of device to be tested.\r
  @param[in]  RemainingDevicePath Optional parameter used to pick a specific child\r
                                  device to be started.\r
\r
  @retval EFI_SUCCESS         This driver supports this device.\r
  @retval EFI_UNSUPPORTED     This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PxeBcIp4DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  return PxeBcSupported (\r
           This,\r
           ControllerHandle,\r
           RemainingDevicePath,\r
           IP_VERSION_4\r
           );\r
}\r
\r
/**\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[in]  This                 The pointer to the driver binding protocol.\r
  @param[in]  ControllerHandle     The handle of device to be started.\r
  @param[in]  RemainingDevicePath  Optional parameter used to pick a specific child\r
                                   device to be started.\r
\r
  @retval EFI_SUCCESS          This driver is installed 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
EFIAPI\r
PxeBcIp4DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  return PxeBcStart (\r
           This,\r
           ControllerHandle,\r
           RemainingDevicePath,\r
           IP_VERSION_4\r
           );\r
}\r
\r
/**\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[in]  This              Protocol instance pointer.\r
  @param[in]  ControllerHandle  Handle of device to stop driver on\r
  @param[in]  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                                children is zero stop the entire bus driver.\r
  @param[in]  ChildHandleBuffer List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCESS           This driver is removed ControllerHandle\r
  @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
  @retval Others                This driver was not removed from this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PxeBcIp4DriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
{\r
  return PxeBcStop (\r
           This,\r
           ControllerHandle,\r
           NumberOfChildren,\r
           ChildHandleBuffer,\r
           IP_VERSION_4\r
           );\r
}\r
\r
/**\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[in]  This                The pointer to the driver binding protocol.\r
  @param[in]  ControllerHandle    The handle of device to be tested.\r
  @param[in]  RemainingDevicePath Optional parameter use to pick a specific child\r
                                  device to be started.\r
\r
  @retval EFI_SUCCESS         This driver supports this device.\r
  @retval EFI_UNSUPPORTED     This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PxeBcIp6DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  return PxeBcSupported (\r
           This,\r
           ControllerHandle,\r
           RemainingDevicePath,\r
           IP_VERSION_6\r
           );\r
}\r
\r
/**\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[in]  This                 The pointer to the driver binding protocol.\r
  @param[in]  ControllerHandle     The handle of device to be started.\r
  @param[in]  RemainingDevicePath  Optional parameter used to pick a specific child\r
                                   device to be started.\r
\r
  @retval EFI_SUCCESS          This driver is installed 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
EFIAPI\r
PxeBcIp6DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  return PxeBcStart (\r
           This,\r
           ControllerHandle,\r
           RemainingDevicePath,\r
           IP_VERSION_6\r
           );\r
}\r
\r
/**\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[in]  This              Protocol instance pointer.\r
  @param[in]  ControllerHandle  Handle of device to stop driver on\r
  @param[in]  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
                                children is zero stop the entire bus driver.\r
  @param[in]  ChildHandleBuffer List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCESS           This driver is removed ControllerHandle\r
  @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
  @retval Others                This driver was not removed from this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PxeBcIp6DriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
{\r
  return PxeBcStop (\r
           This,\r
           ControllerHandle,\r
           NumberOfChildren,\r
           ChildHandleBuffer,\r
           IP_VERSION_6\r
           );\r
}\r