NetworkPkg: Fix some typos of "according"

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

/** @file\r
  The implementation of EFI_LOAD_FILE_PROTOCOL for UEFI HTTP boot.\r
\r
Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<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
  Enable the use of UEFI HTTP boot function.\r
\r
  If the driver has already been started but not satisfy the requirement (IP stack and \r
  specified boot file path), this function will stop the driver and start it again.\r
\r
  @param[in]    Private            The pointer to the driver's private data.\r
  @param[in]    UsingIpv6          Specifies the type of IP addresses that are to be\r
                                   used during the session that is being started.\r
                                   Set to TRUE for IPv6, and FALSE for IPv4.\r
  @param[in]    FilePath           The device specific path of the file to load.\r
\r
  @retval EFI_SUCCESS              HTTP boot was successfully enabled.\r
  @retval EFI_INVALID_PARAMETER    Private is NULL or FilePath is NULL.\r
  @retval EFI_INVALID_PARAMETER    The FilePath doesn't contain a valid URI device path node.\r
  @retval EFI_ALREADY_STARTED      The driver is already in started state.\r
  @retval EFI_OUT_OF_RESOURCES     There are not enough resources.\r
  \r
**/\r
EFI_STATUS\r
HttpBootStart (\r
  IN HTTP_BOOT_PRIVATE_DATA           *Private,\r
  IN BOOLEAN                          UsingIpv6,\r
  IN EFI_DEVICE_PATH_PROTOCOL         *FilePath\r
  )\r
{\r
  UINTN                Index;\r
  EFI_STATUS           Status;\r
  CHAR8                *Uri;\r
  \r
\r
  if (Private == NULL || FilePath == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  //\r
  // Check the URI in the input FilePath, in order to see whether it is\r
  // required to boot from a new specified boot file. \r
  //\r
  Status = HttpBootParseFilePath (FilePath, &Uri);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  //\r
  // Check whether we need to stop and restart the HTTP boot driver.\r
  //\r
  if (Private->Started) {\r
    //\r
    // Restart is needed in 2 cases:\r
    // 1. Http boot driver has already been started but not on the required IP stack.\r
    // 2. The specified boot file URI in FilePath is different with the one we have\r
    // recorded before.\r
    //\r
    if ((UsingIpv6 != Private->UsingIpv6) || \r
        ((Uri != NULL) && (AsciiStrCmp (Private->BootFileUri, Uri) != 0))) {\r
      //\r
      // Restart is required, first stop then continue this start function.\r
      //\r
      Status = HttpBootStop (Private);\r
      if (EFI_ERROR (Status)) {\r
        return Status;\r
      }\r
    } else {\r
      //\r
      // Restart is not required.\r
      //\r
      if (Uri != NULL) {\r
        FreePool (Uri);\r
      }\r
      return EFI_ALREADY_STARTED;\r
    }\r
  }\r
\r
  //\r
  // Detect whether using ipv6 or not, and set it to the private data.\r
  //\r
  if (UsingIpv6 && Private->Ip6Nic != NULL) {\r
    Private->UsingIpv6 = TRUE;\r
  } else if (!UsingIpv6 && Private->Ip4Nic != NULL) {\r
    Private->UsingIpv6 = FALSE;\r
  } else {\r
    if (Uri != NULL) {\r
      FreePool (Uri);\r
    }\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Record the specified URI and prepare the URI parser if needed.\r
  //\r
  Private->FilePathUri = Uri;\r
  if (Private->FilePathUri != NULL) {\r
    Status = HttpParseUrl (\r
               Private->FilePathUri,\r
               (UINT32) AsciiStrLen (Private->FilePathUri),\r
               FALSE,\r
               &Private->FilePathUriParser\r
               );\r
    if (EFI_ERROR (Status)) {\r
      FreePool (Private->FilePathUri);\r
      return Status;\r
    }\r
  }\r
  \r
  //\r
  // Init the content of cached DHCP offer list.\r
  //\r
  ZeroMem (Private->OfferBuffer, sizeof (Private->OfferBuffer));\r
  if (!Private->UsingIpv6) {\r
    for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {\r
      Private->OfferBuffer[Index].Dhcp4.Packet.Offer.Size = HTTP_CACHED_DHCP4_PACKET_MAX_SIZE;\r
    }\r
  } else {\r
    for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {\r
      Private->OfferBuffer[Index].Dhcp6.Packet.Offer.Size = HTTP_CACHED_DHCP6_PACKET_MAX_SIZE;\r
    }\r
  }\r
\r
  if (Private->UsingIpv6) {\r
    //\r
    // Set Ip6 policy to Automatic to start the Ip6 router discovery.\r
    //\r
    Status = HttpBootSetIp6Policy (Private);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
  Private->Started   = TRUE;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Attempt to complete a DHCPv4 D.O.R.A or DHCPv6 S.R.A.A sequence to retrieve the boot resource information.\r
\r
  @param[in]    Private            The pointer to the driver's private data.\r
\r
  @retval EFI_SUCCESS              Boot info was successfully retrieved.\r
  @retval EFI_INVALID_PARAMETER    Private is NULL.\r
  @retval EFI_NOT_STARTED          The driver is in stopped state.\r
  @retval EFI_DEVICE_ERROR         An unexpected network error occurred.\r
  @retval Others                   Other errors as indicated.\r
  \r
**/\r
EFI_STATUS\r
HttpBootDhcp (\r
  IN HTTP_BOOT_PRIVATE_DATA           *Private\r
  )\r
{\r
  EFI_STATUS                Status;\r
\r
  if (Private == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  if (!Private->Started) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  Status = EFI_DEVICE_ERROR;\r
\r
  if (!Private->UsingIpv6) {\r
    //\r
    // Start D.O.R.A process to get a IPv4 address and other boot information.\r
    //\r
    Status = HttpBootDhcp4Dora (Private);\r
  } else {\r
     //\r
    // Start S.A.R.R process to get a IPv6 address and other boot information.\r
    //\r
    Status = HttpBootDhcp6Sarr (Private);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Attempt to download the boot file through HTTP message exchange.\r
\r
  @param[in]          Private         The pointer to the driver's private data.\r
  @param[in, out]     BufferSize      On input the size of Buffer in bytes. On output with a return\r
                                      code of EFI_SUCCESS, the amount of data transferred to\r
                                      Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,\r
                                      the size of Buffer required to retrieve the requested file.\r
  @param[in]          Buffer          The memory buffer to transfer the file to. If Buffer is NULL,\r
                                      then the size of the requested file is returned in\r
                                      BufferSize.\r
  @param[out]         ImageType       The image type of the downloaded file.\r
\r
  @retval EFI_SUCCESS                 Boot file was loaded successfully.\r
  @retval EFI_INVALID_PARAMETER       Private is NULL, or ImageType is NULL, or BufferSize is NULL.\r
  @retval EFI_INVALID_PARAMETER       *BufferSize is not zero, and Buffer is NULL.\r
  @retval EFI_NOT_STARTED             The driver is in stopped state.\r
  @retval EFI_BUFFER_TOO_SMALL        The BufferSize is too small to read the boot file. BufferSize has \r
                                      been updated with the size needed to complete the request.\r
  @retval EFI_DEVICE_ERROR            An unexpected network error occurred.\r
  @retval Others                      Other errors as indicated.\r
  \r
**/\r
EFI_STATUS\r
HttpBootLoadFile (\r
  IN     HTTP_BOOT_PRIVATE_DATA       *Private,\r
  IN OUT UINTN                        *BufferSize,\r
  IN     VOID                         *Buffer,       OPTIONAL\r
     OUT HTTP_BOOT_IMAGE_TYPE         *ImageType\r
  )\r
{\r
  EFI_STATUS             Status;\r
\r
  if (Private == NULL || ImageType == NULL || BufferSize == NULL ) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (*BufferSize != 0 && Buffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  if (!Private->Started) {\r
    return EFI_NOT_STARTED;\r
  }\r
\r
  Status = EFI_DEVICE_ERROR;\r
\r
  if (Private->BootFileUri == NULL) {\r
    //\r
    // Parse the cached offer to get the boot file URL first.\r
    //\r
    Status = HttpBootDiscoverBootInfo (Private);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  if (!Private->HttpCreated) {\r
    //\r
    // Create HTTP child.\r
    //\r
    Status = HttpBootCreateHttpIo (Private);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  if (Private->BootFileSize == 0) {\r
    //\r
    // Discover the information about the bootfile if we haven't.\r
    //\r
\r
    //\r
    // Try to use HTTP HEAD method.\r
    //\r
    Status = HttpBootGetBootFile (\r
               Private,\r
               TRUE,\r
               &Private->BootFileSize,\r
               NULL,\r
               &Private->ImageType\r
               );\r
    if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {\r
      //\r
      // Failed to get file size by HEAD method, may be trunked encoding, try HTTP GET method.\r
      //\r
      ASSERT (Private->BootFileSize == 0);\r
      Status = HttpBootGetBootFile (\r
                 Private,\r
                 FALSE,\r
                 &Private->BootFileSize,\r
                 NULL,\r
                 &Private->ImageType\r
                 );\r
      if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {\r
        return Status;\r
      }\r
    }\r
  }\r
\r
  if (*BufferSize < Private->BootFileSize) {\r
    *BufferSize = Private->BootFileSize;\r
    *ImageType = Private->ImageType;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  //\r
  // Load the boot file into Buffer\r
  //\r
  return  HttpBootGetBootFile (\r
            Private,\r
            FALSE,\r
            BufferSize,\r
            Buffer,\r
            ImageType\r
            );\r
}\r
\r
/**\r
  Disable the use of UEFI HTTP boot function.\r
\r
  @param[in]    Private            The pointer to the driver's private data.\r
\r
  @retval EFI_SUCCESS              HTTP boot was successfully disabled.\r
  @retval EFI_NOT_STARTED          The driver is already in stopped state.\r
  @retval EFI_INVALID_PARAMETER    Private is NULL.\r
  @retval Others                   Unexpected error when stop the function.\r
  \r
**/\r
EFI_STATUS\r
HttpBootStop (\r
  IN HTTP_BOOT_PRIVATE_DATA           *Private\r
  )\r
{\r
  UINTN            Index;\r
\r
  if (Private == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  if (!Private->Started) {\r
    return EFI_NOT_STARTED;\r
  }\r
  \r
  if (Private->HttpCreated) {\r
    HttpIoDestroyIo (&Private->HttpIo);\r
    Private->HttpCreated = FALSE;\r
  }\r
  \r
  Private->Started = FALSE;\r
  ZeroMem (&Private->StationIp, sizeof (EFI_IP_ADDRESS));\r
  ZeroMem (&Private->SubnetMask, sizeof (EFI_IP_ADDRESS));\r
  ZeroMem (&Private->GatewayIp, sizeof (EFI_IP_ADDRESS));\r
  Private->Port = 0;\r
  Private->BootFileUri = NULL;\r
  Private->BootFileUriParser = NULL;\r
  Private->BootFileSize = 0;\r
  Private->SelectIndex = 0;\r
  Private->SelectProxyType = HttpOfferTypeMax; \r
\r
  if (!Private->UsingIpv6) {\r
    //\r
    // Stop and release the DHCP4 child.\r
    //\r
    Private->Dhcp4->Stop (Private->Dhcp4);\r
    Private->Dhcp4->Configure (Private->Dhcp4, NULL);\r
\r
    for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {\r
      if (Private->OfferBuffer[Index].Dhcp4.UriParser) {\r
        HttpUrlFreeParser (Private->OfferBuffer[Index].Dhcp4.UriParser);\r
      }\r
    }\r
  } else {\r
    //\r
    // Stop and release the DHCP6 child.\r
    //\r
    Private->Dhcp6->Stop (Private->Dhcp6);\r
    Private->Dhcp6->Configure (Private->Dhcp6, NULL);\r
    \r
    for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {\r
      if (Private->OfferBuffer[Index].Dhcp6.UriParser) {\r
        HttpUrlFreeParser (Private->OfferBuffer[Index].Dhcp6.UriParser);\r
      }\r
    }\r
  }\r
\r
  if (Private->FilePathUri!= NULL) {\r
    FreePool (Private->FilePathUri);\r
    HttpUrlFreeParser (Private->FilePathUriParser);\r
    Private->FilePathUri = NULL;\r
    Private->FilePathUriParser = NULL;\r
  }\r
  \r
  ZeroMem (Private->OfferBuffer, sizeof (Private->OfferBuffer));\r
  Private->OfferNum = 0;\r
  ZeroMem (Private->OfferCount, sizeof (Private->OfferCount));\r
  ZeroMem (Private->OfferIndex, sizeof (Private->OfferIndex));\r
  \r
  HttpBootFreeCacheList (Private);\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Causes the driver to load a specified file.\r
\r
  @param  This       Protocol instance pointer.\r
  @param  FilePath   The device specific path of the file to load.\r
  @param  BootPolicy If TRUE, indicates that the request originates from the\r
                     boot manager is attempting to load FilePath as a boot\r
                     selection. If FALSE, then FilePath must match as exact file\r
                     to be loaded.\r
  @param  BufferSize On input the size of Buffer in bytes. On output with a return\r
                     code of EFI_SUCCESS, the amount of data transferred to\r
                     Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,\r
                     the size of Buffer required to retrieve the requested file.\r
  @param  Buffer     The memory buffer to transfer the file to. IF Buffer is NULL,\r
                     then the size of the requested file is returned in\r
                     BufferSize.\r
\r
  @retval EFI_SUCCESS           The file was loaded.\r
  @retval EFI_UNSUPPORTED       The device does not support the provided BootPolicy\r
  @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or\r
                                BufferSize is NULL.\r
  @retval EFI_NO_MEDIA          No medium was present to load the file.\r
  @retval EFI_DEVICE_ERROR      The file was not loaded due to a device error.\r
  @retval EFI_NO_RESPONSE       The remote system did not respond.\r
  @retval EFI_NOT_FOUND         The file was not found.\r
  @retval EFI_ABORTED           The file load process was manually cancelled.\r
  @retval EFI_BUFFER_TOO_SMALL  The BufferSize is too small to read the current directory entry.\r
                                BufferSize has been updated with the size needed to complete\r
                                the request.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpBootDxeLoadFile (\r
  IN EFI_LOAD_FILE_PROTOCOL           *This,\r
  IN EFI_DEVICE_PATH_PROTOCOL         *FilePath,\r
  IN BOOLEAN                          BootPolicy,\r
  IN OUT UINTN                        *BufferSize,\r
  IN VOID                             *Buffer OPTIONAL\r
  )\r
{\r
  HTTP_BOOT_PRIVATE_DATA        *Private;\r
  HTTP_BOOT_VIRTUAL_NIC         *VirtualNic;\r
  BOOLEAN                       MediaPresent;\r
  BOOLEAN                       UsingIpv6;\r
  EFI_STATUS                    Status;\r
  HTTP_BOOT_IMAGE_TYPE          ImageType;\r
\r
  if (This == NULL || BufferSize == NULL || FilePath == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Only support BootPolicy\r
  //\r
  if (!BootPolicy) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  VirtualNic = HTTP_BOOT_VIRTUAL_NIC_FROM_LOADFILE (This);\r
  Private = VirtualNic->Private;\r
  \r
  //\r
  // Check media status before HTTP boot start\r
  //\r
  MediaPresent = TRUE;\r
  NetLibDetectMedia (Private->Controller, &MediaPresent);\r
  if (!MediaPresent) {\r
    return EFI_NO_MEDIA;\r
  }\r
  \r
  //\r
  // Check whether the virtual nic is using IPv6 or not.\r
  //\r
  UsingIpv6 = FALSE;\r
  if (VirtualNic == Private->Ip6Nic) {\r
    UsingIpv6 = TRUE;\r
  }\r
\r
  //\r
  // Initialize HTTP boot.\r
  //\r
  Status = HttpBootStart (Private, UsingIpv6, FilePath);\r
  if (Status != EFI_SUCCESS && Status != EFI_ALREADY_STARTED) {\r
    return Status;\r
  }\r
  \r
  //\r
  // Load the boot file.\r
  //\r
  ImageType = ImageTypeMax;\r
  Status = HttpBootLoadFile (Private, BufferSize, Buffer, &ImageType);\r
  if (EFI_ERROR (Status)) {\r
    if (Status == EFI_BUFFER_TOO_SMALL && (ImageType == ImageTypeVirtualCd || ImageType == ImageTypeVirtualDisk)) {\r
      Status = EFI_WARN_FILE_SYSTEM;\r
    } else if (Status != EFI_BUFFER_TOO_SMALL) {\r
      HttpBootStop (Private);\r
    }\r
    return Status;\r
  }\r
\r
  //\r
  // Register the RAM Disk to the system if needed.\r
  //\r
  if (ImageType == ImageTypeVirtualCd || ImageType == ImageTypeVirtualDisk) {\r
    Status = HttpBootRegisterRamDisk (Private, *BufferSize, Buffer, ImageType);\r
    if (!EFI_ERROR (Status)) {\r
      Status = EFI_WARN_FILE_SYSTEM;\r
    }\r
  }\r
\r
  //\r
  // Stop the HTTP Boot service after the boot image is downloaded.\r
  //\r
  HttpBootStop (Private);\r
  return Status;\r
}\r
\r
///\r
/// Load File Protocol instance\r
///\r
GLOBAL_REMOVE_IF_UNREFERENCED \r
EFI_LOAD_FILE_PROTOCOL  gHttpBootDxeLoadFile = {\r
  HttpBootDxeLoadFile\r
};\r