NetworkPkg: Update cache management in HTTP boot driver.

[mirror_edk2.git] / NetworkPkg / HttpBootDxe / HttpBootDxe.c

/** @file\r
  Driver Binding functions implementation for UEFI HTTP boot.\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
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 "HttpBootDxe.h"\r
\r
///\r
/// Driver Binding Protocol instance\r
///\r
EFI_DRIVER_BINDING_PROTOCOL gHttpBootIp4DxeDriverBinding = {\r
  HttpBootIp4DxeDriverBindingSupported,\r
  HttpBootIp4DxeDriverBindingStart,\r
  HttpBootIp4DxeDriverBindingStop,\r
  HTTP_BOOT_DXE_VERSION,\r
  NULL,\r
  NULL\r
};\r
\r
/**\r
  Destroy the HTTP child based on IPv4 stack.\r
\r
  @param[in]  This              Pointer to the EFI_DRIVER_BINDING_PROTOCOL.\r
  @param[in]  Private           Pointer to HTTP_BOOT_PRIVATE_DATA.\r
\r
**/\r
VOID\r
HttpBootDestroyIp4Children (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN HTTP_BOOT_PRIVATE_DATA       *Private\r
  )\r
{\r
  ASSERT (This != NULL);\r
  ASSERT (Private != NULL);\r
  ASSERT (Private->UsingIpv6 == FALSE);\r
\r
  if (Private->Dhcp4Child != NULL) {\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->HttpCreated) {\r
    HttpIoDestroyIo (&Private->HttpIo);\r
    Private->HttpCreated = FALSE;\r
  }\r
\r
  gBS->CloseProtocol (\r
         Private->Controller,\r
         &gEfiCallerIdGuid,\r
         This->DriverBindingHandle,\r
         Private->ChildHandle\r
         );\r
\r
  gBS->UninstallMultipleProtocolInterfaces (\r
         Private->ChildHandle,\r
         &gEfiLoadFileProtocolGuid,\r
         &Private->LoadFile,\r
         &gEfiDevicePathProtocolGuid,\r
         Private->DevicePath,\r
         NULL\r
         );\r
\r
  if (Private->DevicePath != NULL) {\r
    FreePool (Private->DevicePath);\r
    Private->DevicePath = NULL;\r
  }\r
}\r
\r
/**\r
  Tests to see if this driver supports a given controller. If a child device is provided, \r
  it further tests to see if this driver supports creating a handle for the specified child device.\r
\r
  This function checks to see if the driver specified by This supports the device specified by \r
  ControllerHandle. Drivers will typically use the device path attached to \r
  ControllerHandle and/or the services from the bus I/O abstraction attached to \r
  ControllerHandle to determine if the driver supports ControllerHandle. This function \r
  may be called many times during platform initialization. In order to reduce boot times, the tests \r
  performed by this function must be very small, and take as little time as possible to execute. This \r
  function must not change the state of any hardware devices, and this function must be aware that the \r
  device specified by ControllerHandle may already be managed by the same driver or a \r
  different driver. This function must match its calls to AllocatePages() with FreePages(), \r
  AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().  \r
  Because ControllerHandle may have been previously started by the same driver, if a protocol is \r
  already in the opened state, then it must not be closed with CloseProtocol(). This is required \r
  to guarantee the state of ControllerHandle is not modified by this function.\r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to test. This handle \r
                                   must support a protocol interface that supplies \r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This \r
                                   parameter is ignored by device drivers, and is optional for bus \r
                                   drivers. For bus drivers, if this parameter is not NULL, then \r
                                   the bus driver must determine if the bus controller specified \r
                                   by ControllerHandle and the child controller specified \r
                                   by RemainingDevicePath are both supported by this \r
                                   bus driver.\r
\r
  @retval EFI_SUCCESS              The device specified by ControllerHandle and\r
                                   RemainingDevicePath is supported by the driver specified by This.\r
  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by the driver\r
                                   specified by This.\r
  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
                                   RemainingDevicePath is already being managed by a different\r
                                   driver or an application that requires exclusive access.\r
                                   Currently not implemented.\r
  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
                                   RemainingDevicePath is not supported by the driver specified by This.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootIp4DxeDriverBindingSupported (\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
  // Try to open the DHCP4, HTTP4 and Device Path protocol.\r
  //\r
  Status = gBS->OpenProtocol (\r
                   ControllerHandle,\r
                   &gEfiDhcp4ServiceBindingProtocolGuid,\r
                   NULL,\r
                   This->DriverBindingHandle,\r
                   ControllerHandle,\r
                   EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                   );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                   ControllerHandle,\r
                   &gEfiHttpServiceBindingProtocolGuid,\r
                   NULL,\r
                   This->DriverBindingHandle,\r
                   ControllerHandle,\r
                   EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                   );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                   ControllerHandle,\r
                   &gEfiDevicePathProtocolGuid,\r
                   NULL,\r
                   This->DriverBindingHandle,\r
                   ControllerHandle,\r
                   EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                   );\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Starts a device controller or a bus controller.\r
\r
  The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
  As a result, much of the error checking on the parameters to Start() has been moved into this \r
  common boot service. It is legal to call Start() from other locations, \r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE.\r
  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
     EFI_DEVICE_PATH_PROTOCOL.\r
  3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
     have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.  \r
\r
  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in]  ControllerHandle     The handle of the controller to start. This handle \r
                                   must support a protocol interface that supplies \r
                                   an I/O abstraction to the driver.\r
  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This \r
                                   parameter is ignored by device drivers, and is optional for bus \r
                                   drivers. For a bus driver, if this parameter is NULL, then handles \r
                                   for all the children of Controller are created by this driver.  \r
                                   If this parameter is not NULL and the first Device Path Node is \r
                                   not the End of Device Path Node, then only the handle for the \r
                                   child device specified by the first Device Path Node of \r
                                   RemainingDevicePath is created by this driver.\r
                                   If the first Device Path Node of RemainingDevicePath is \r
                                   the End of Device Path Node, no child handle is created by this\r
                                   driver.\r
\r
  @retval EFI_SUCCESS              The device was started.\r
  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
  @retval Others                   The driver failded to start the device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootIp4DxeDriverBindingStart (\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
  HTTP_BOOT_PRIVATE_DATA     *Private;\r
  EFI_DEV_PATH               *Node;\r
  EFI_DEVICE_PATH_PROTOCOL   *DevicePath;\r
  UINT32                     *Id;\r
\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
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  //\r
  // Initialize the private data structure.\r
  //\r
  Private = AllocateZeroPool (sizeof (HTTP_BOOT_PRIVATE_DATA));\r
  if (Private == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  Private->Signature = HTTP_BOOT_PRIVATE_DATA_SIGNATURE;\r
  Private->Controller = ControllerHandle;\r
  Private->Image = This->ImageHandle;\r
  Private->UsingIpv6 = FALSE;\r
  InitializeListHead (&Private->CacheList);\r
\r
  //\r
  // Create DHCP child instance.\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
  // Get the Ip4Config2 protocol, it's required to configure the default gateway address.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiIp4Config2ProtocolGuid,\r
                  (VOID **) &Private->Ip4Config2,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\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
  // Open Device Path Protocol to prepare for appending IP and URI node.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  (VOID **) &Private->ParentDevicePath,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Append IPv4 device path node.\r
  //\r
  Node = AllocateZeroPool (sizeof (IPv4_DEVICE_PATH));\r
  if (Node == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_ERROR;\r
  }\r
  Node->Ipv4.Header.Type = MESSAGING_DEVICE_PATH;\r
  Node->Ipv4.Header.SubType = MSG_IPv4_DP;\r
  SetDevicePathNodeLength (Node, sizeof (IPv4_DEVICE_PATH));\r
  Node->Ipv4.StaticIpAddress = FALSE;\r
  DevicePath = AppendDevicePathNode (Private->ParentDevicePath, (EFI_DEVICE_PATH_PROTOCOL*) Node);\r
  FreePool (Node);\r
  if (DevicePath == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Append URI device path node.\r
  //\r
  Node = AllocateZeroPool (sizeof (EFI_DEVICE_PATH_PROTOCOL));\r
  if (Node == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_ERROR;\r
  }\r
  Node->DevPath.Type = MESSAGING_DEVICE_PATH;\r
  Node->DevPath.SubType = MSG_URI_DP;\r
  SetDevicePathNodeLength (Node, sizeof (EFI_DEVICE_PATH_PROTOCOL));\r
  Private->DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL*) Node);\r
  FreePool (Node);\r
  FreePool (DevicePath);\r
  if (Private->DevicePath == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Create a child handle for the HTTP boot and install DevPath and Load file protocol on it.\r
  //\r
  CopyMem (&Private->LoadFile, &gHttpBootDxeLoadFile, sizeof (Private->LoadFile));\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Private->ChildHandle,\r
                  &gEfiLoadFileProtocolGuid,\r
                  &Private->LoadFile,\r
                  &gEfiDevicePathProtocolGuid,\r
                  Private->DevicePath,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  //\r
  // Install a protocol with Caller Id Guid to the NIC, this is just to build the relationship between\r
  // NIC handle and the private data.\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
  // Open the Caller Id child to setup a parent-child relationship between\r
  // real NIC handle and the HTTP boot child handle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiCallerIdGuid,\r
                  (VOID **) &Id,\r
                  This->DriverBindingHandle,\r
                  Private->ChildHandle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
  \r
  HttpBootDestroyIp4Children (This, Private);\r
  FreePool (Private);\r
\r
  return Status;\r
}\r
\r
/**\r
  Stops a device controller or a bus controller.\r
  \r
  The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
  As a result, much of the error checking on the parameters to Stop() has been moved \r
  into this common boot service. It is legal to call Stop() from other locations, \r
  but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
     same driver's Start() function.\r
  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
     EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
     Start() function, and the Start() function must have called OpenProtocol() on\r
     ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\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
HttpBootIp4DxeDriverBindingStop (\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
  EFI_STATUS                      Status;\r
  EFI_LOAD_FILE_PROTOCOL          *LoadFile;\r
  HTTP_BOOT_PRIVATE_DATA          *Private;\r
  EFI_HANDLE                      NicHandle;\r
  UINT32                          *Id;\r
\r
  //\r
  // Try to get the Load File Protocol from the controller handle.\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
    // If failed, try to find the NIC handle for this controller.\r
    //\r
    NicHandle = HttpBootGetNicByIp4Children (ControllerHandle);\r
    if (NicHandle == NULL) {\r
      return EFI_SUCCESS;\r
    }\r
\r
    //\r
    // Try to retrieve the private data by the Caller Id Guid.\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 = HTTP_BOOT_PRIVATE_DATA_FROM_ID (Id);\r
  } else {\r
    Private = HTTP_BOOT_PRIVATE_DATA_FROM_LOADFILE (LoadFile);\r
    NicHandle = Private->Controller;\r
  }\r
\r
  //\r
  // Disable the HTTP boot function.\r
  //\r
  Status = HttpBootStop (Private);\r
  if (Status != EFI_SUCCESS && Status != EFI_NOT_STARTED) {\r
    return Status;\r
  }\r
\r
  //\r
  // Destory all child instance and uninstall protocol interface.\r
  //\r
  HttpBootDestroyIp4Children (This, Private);\r
\r
  //\r
  // Release the cached data.\r
  //\r
  HttpBootFreeCacheList (Private);\r
\r
  gBS->UninstallProtocolInterface (\r
         NicHandle,\r
         &gEfiCallerIdGuid,\r
         &Private->Id\r
         );\r
  FreePool (Private);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This is the declaration of an EFI image entry point. This entry point is\r
  the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r
  both device drivers and bus drivers.\r
\r
  @param[in]  ImageHandle       The firmware allocated handle for the UEFI image.\r
  @param[in]  SystemTable       A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval Others                An unexpected error occurred.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootDxeDriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  //\r
  // Install UEFI Driver Model protocol(s).\r
  //\r
  return EfiLibInstallDriverBindingComponentName2 (\r
           ImageHandle,\r
           SystemTable,\r
           &gHttpBootIp4DxeDriverBinding,\r
           ImageHandle,\r
           &gHttpBootDxeComponentName,\r
           &gHttpBootDxeComponentName2\r
           );\r
}\r
\r