BaseTools: remove uncalled functions

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

diff --git a/NetworkPkg/HttpBootDxe/HttpBootImpl.c b/NetworkPkg/HttpBootDxe/HttpBootImpl.c
index 4b850b6628be2215a8ff3e194d1a64ce02c8a9db..a0fd934ec4c7bf6794a5a15e2d90e2d5c76d85fd 100644 (file)
--- a/NetworkPkg/HttpBootDxe/HttpBootImpl.c
+++ b/NetworkPkg/HttpBootDxe/HttpBootImpl.c
@@ -1,7 +1,7 @@
 /** @file\r
   The implementation of EFI_LOAD_FILE_PROTOCOL for UEFI HTTP boot.\r
 \r
 /** @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
+Copyright (c) 2015 - 2018, 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
 (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


@@ -15,6 +15,84 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "HttpBootDxe.h"\r
 \r
 \r
 #include "HttpBootDxe.h"\r
 \r

+/**\r
+  Install HTTP Boot Callback Protocol if not installed before.\r
+\r
+  @param[in] Private           Pointer to HTTP Boot private data.\r
+\r
+  @retval EFI_SUCCESS          HTTP Boot Callback Protocol installed succesfully.\r
+  @retval Others               Failed to install HTTP Boot Callback Protocol.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootInstallCallback (\r
+  IN HTTP_BOOT_PRIVATE_DATA           *Private\r
+  )\r
+{\r
+  EFI_STATUS                  Status;\r
+  EFI_HANDLE                  ControllerHandle;\r
+\r
+  if (!Private->UsingIpv6) {\r
+    ControllerHandle = Private->Ip4Nic->Controller;\r
+  } else {\r
+    ControllerHandle = Private->Ip6Nic->Controller;\r
+  }\r
+\r
+  //\r
+  // Check whether gEfiHttpBootCallbackProtocolGuid already installed.\r
+  //\r
+  Status = gBS->HandleProtocol (\r
+                  ControllerHandle,\r
+                  &gEfiHttpBootCallbackProtocolGuid,\r
+                  (VOID **) &Private->HttpBootCallback\r
+                  );\r
+  if (Status == EFI_UNSUPPORTED) {\r
+\r
+    CopyMem (\r
+      &Private->LoadFileCallback,\r
+      &gHttpBootDxeHttpBootCallback,\r
+      sizeof (EFI_HTTP_BOOT_CALLBACK_PROTOCOL)\r
+      );\r
+\r
+    //\r
+    // Install a default callback if user didn't offer one.\r
+    //\r
+    Status = gBS->InstallProtocolInterface (\r
+                    &ControllerHandle,\r
+                    &gEfiHttpBootCallbackProtocolGuid,\r
+                    EFI_NATIVE_INTERFACE,\r
+                    &Private->LoadFileCallback\r
+                    );\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+    Private->HttpBootCallback = &Private->LoadFileCallback;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Uninstall HTTP Boot Callback Protocol if it's installed by this driver.\r
+\r
+  @param[in] Private           Pointer to HTTP Boot private data.\r
+\r
+**/\r
+VOID\r
+HttpBootUninstallCallback (\r
+  IN HTTP_BOOT_PRIVATE_DATA           *Private\r
+  )\r
+{\r
+  if (Private->HttpBootCallback == &Private->LoadFileCallback) {\r
+    gBS->UninstallProtocolInterface (\r
+          Private->Controller,\r
+          &gEfiHttpBootCallbackProtocolGuid,\r
+          &Private->HttpBootCallback\r
+          );\r
+    Private->HttpBootCallback = NULL;\r
+  }\r
+}\r
+\r

 /**\r
   Enable the use of UEFI HTTP boot function.\r
 \r
 /**\r
   Enable the use of UEFI HTTP boot function.\r
 \r


@@ -44,8 +122,9 @@ HttpBootStart (
   UINTN                Index;\r
   EFI_STATUS           Status;\r
   CHAR8                *Uri;\r
   UINTN                Index;\r
   EFI_STATUS           Status;\r
   CHAR8                *Uri;\r

-  \r

 \r
 \r

+  Uri = NULL;\r
+  \r

   if (Private == NULL || FilePath == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
   if (Private == NULL || FilePath == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r


@@ -76,6 +155,9 @@ HttpBootStart (
       //\r
       Status = HttpBootStop (Private);\r
       if (EFI_ERROR (Status)) {\r
       //\r
       Status = HttpBootStop (Private);\r
       if (EFI_ERROR (Status)) {\r

+        if (Uri != NULL) {\r
+          FreePool (Uri);\r
+        }\r

         return Status;\r
       }\r
     } else {\r
         return Status;\r
       }\r
     } else {\r


@@ -126,11 +208,11 @@ HttpBootStart (
   ZeroMem (Private->OfferBuffer, sizeof (Private->OfferBuffer));\r
   if (!Private->UsingIpv6) {\r
     for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {\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_BOOT_DHCP4_PACKET_MAX_SIZE;\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
     }\r
   } else {\r
     for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {\r

-      Private->OfferBuffer[Index].Dhcp6.Packet.Offer.Size = HTTP_BOOT_DHCP6_PACKET_MAX_SIZE;\r
+      Private->OfferBuffer[Index].Dhcp6.Packet.Offer.Size = HTTP_CACHED_DHCP6_PACKET_MAX_SIZE;\r

     }\r
   }\r
 \r
     }\r
   }\r
 \r


@@ -144,6 +226,7 @@ HttpBootStart (
     }\r
   }\r
   Private->Started   = TRUE;\r
     }\r
   }\r
   Private->Started   = TRUE;\r

+  Print (L"\n>>Start HTTP Boot over IPv%d", Private->UsingIpv6 ? 6 : 4);\r

 \r
   return EFI_SUCCESS;\r
 }\r
 \r
   return EFI_SUCCESS;\r
 }\r


@@ -237,7 +320,10 @@ HttpBootLoadFile (
     return EFI_NOT_STARTED;\r
   }\r
 \r
     return EFI_NOT_STARTED;\r
   }\r
 \r

-  Status = EFI_DEVICE_ERROR;\r
+  Status = HttpBootInstallCallback (Private);\r
+  if (EFI_ERROR(Status)) {\r
+    goto ON_EXIT;\r
+  }\r

 \r
   if (Private->BootFileUri == NULL) {\r
     //\r
 \r
   if (Private->BootFileUri == NULL) {\r
     //\r


@@ -245,7 +331,8 @@ HttpBootLoadFile (
     //\r
     Status = HttpBootDiscoverBootInfo (Private);\r
     if (EFI_ERROR (Status)) {\r
     //\r
     Status = HttpBootDiscoverBootInfo (Private);\r
     if (EFI_ERROR (Status)) {\r

-      return Status;\r
+      AsciiPrint ("\n  Error: Could not retrieve NBP file size from HTTP server.\n");\r
+      goto ON_EXIT;\r

     }\r
   }\r
 \r
     }\r
   }\r
 \r


@@ -255,7 +342,7 @@ HttpBootLoadFile (
     //\r
     Status = HttpBootCreateHttpIo (Private);\r
     if (EFI_ERROR (Status)) {\r
     //\r
     Status = HttpBootCreateHttpIo (Private);\r
     if (EFI_ERROR (Status)) {\r

-      return Status;\r
+      goto ON_EXIT;\r

     }\r
   }\r
 \r
     }\r
   }\r
 \r


@@ -287,7 +374,8 @@ HttpBootLoadFile (
                  &Private->ImageType\r
                  );\r
       if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {\r
                  &Private->ImageType\r
                  );\r
       if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {\r

-        return Status;\r
+        AsciiPrint ("\n  Error: Could not retrieve NBP file size from HTTP server.\n");\r
+        goto ON_EXIT;\r

       }\r
     }\r
   }\r
       }\r
     }\r
   }\r


@@ -295,19 +383,43 @@ HttpBootLoadFile (
   if (*BufferSize < Private->BootFileSize) {\r
     *BufferSize = Private->BootFileSize;\r
     *ImageType = Private->ImageType;\r
   if (*BufferSize < Private->BootFileSize) {\r
     *BufferSize = Private->BootFileSize;\r
     *ImageType = Private->ImageType;\r

-    return EFI_BUFFER_TOO_SMALL;\r
+    Status = EFI_BUFFER_TOO_SMALL;\r
+    goto ON_EXIT;\r

   }\r
 \r
   //\r
   // Load the boot file into Buffer\r
   //\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
+  Status = HttpBootGetBootFile (\r
+             Private,\r
+             FALSE,\r
+             BufferSize,\r
+             Buffer,\r
+             ImageType\r
+             );\r
+  \r
+ON_EXIT:\r
+  HttpBootUninstallCallback (Private);\r
+  \r
+  if (EFI_ERROR (Status)) {\r
+    if (Status == EFI_ACCESS_DENIED) {\r
+      AsciiPrint ("\n  Error: Could not establish connection with HTTP server.\n");\r
+    } else if (Status == EFI_BUFFER_TOO_SMALL && Buffer != NULL) {\r
+      AsciiPrint ("\n  Error: Buffer size is smaller than the requested file.\n");\r
+    } else if (Status == EFI_OUT_OF_RESOURCES) {\r
+      AsciiPrint ("\n  Error: Could not allocate I/O buffers.\n");\r
+    } else if (Status == EFI_DEVICE_ERROR) {\r
+      AsciiPrint ("\n  Error: Network device error.\n");\r
+    } else if (Status == EFI_TIMEOUT) {\r
+      AsciiPrint ("\n  Error: Server response timeout.\n");\r
+    } else if (Status == EFI_ABORTED) {\r
+      AsciiPrint ("\n  Error: Remote boot cancelled.\n");\r
+    } else if (Status != EFI_BUFFER_TOO_SMALL) {\r
+      AsciiPrint ("\n  Error: Unexpected network error.\n");\r
+    }\r
+  }\r
+  \r
+  return Status;\r

 }\r
 \r
 /**\r
 }\r
 \r
 /**\r


@@ -378,6 +490,11 @@ HttpBootStop (
     }\r
   }\r
 \r
     }\r
   }\r
 \r

+  if (Private->DnsServerIp != NULL) {\r
+    FreePool (Private->DnsServerIp);\r
+    Private->DnsServerIp = NULL;\r
+  }\r
+\r

   if (Private->FilePathUri!= NULL) {\r
     FreePool (Private->FilePathUri);\r
     HttpUrlFreeParser (Private->FilePathUriParser);\r
   if (Private->FilePathUri!= NULL) {\r
     FreePool (Private->FilePathUri);\r
     HttpUrlFreeParser (Private->FilePathUriParser);\r


@@ -438,7 +555,7 @@ HttpBootDxeLoadFile (
 {\r
   HTTP_BOOT_PRIVATE_DATA        *Private;\r
   HTTP_BOOT_VIRTUAL_NIC         *VirtualNic;\r
 {\r
   HTTP_BOOT_PRIVATE_DATA        *Private;\r
   HTTP_BOOT_VIRTUAL_NIC         *VirtualNic;\r

-  BOOLEAN                       MediaPresent;\r
+  EFI_STATUS                    MediaStatus;\r

   BOOLEAN                       UsingIpv6;\r
   EFI_STATUS                    Status;\r
   HTTP_BOOT_IMAGE_TYPE          ImageType;\r
   BOOLEAN                       UsingIpv6;\r
   EFI_STATUS                    Status;\r
   HTTP_BOOT_IMAGE_TYPE          ImageType;\r


@@ -460,9 +577,10 @@ HttpBootDxeLoadFile (
   //\r
   // Check media status before HTTP boot start\r
   //\r
   //\r
   // Check media status before HTTP boot start\r
   //\r

-  MediaPresent = TRUE;\r
-  NetLibDetectMedia (Private->Controller, &MediaPresent);\r
-  if (!MediaPresent) {\r
+  MediaStatus = EFI_SUCCESS;\r
+  NetLibDetectMediaWaitTimeout (Private->Controller, HTTP_BOOT_CHECK_MEDIA_WAITING_TIME, &MediaStatus);\r
+  if (MediaStatus != EFI_SUCCESS) {\r
+    AsciiPrint ("\n  Error: Could not detect network connection.\n");\r

     return EFI_NO_MEDIA;\r
   }\r
   \r
     return EFI_NO_MEDIA;\r
   }\r
   \r


@@ -503,9 +621,15 @@ HttpBootDxeLoadFile (
     Status = HttpBootRegisterRamDisk (Private, *BufferSize, Buffer, ImageType);\r
     if (!EFI_ERROR (Status)) {\r
       Status = EFI_WARN_FILE_SYSTEM;\r
     Status = HttpBootRegisterRamDisk (Private, *BufferSize, Buffer, ImageType);\r
     if (!EFI_ERROR (Status)) {\r
       Status = EFI_WARN_FILE_SYSTEM;\r

+    } else {\r
+      AsciiPrint ("\n  Error: Could not register RAM disk to the system.\n");\r

     }\r
   }\r
     }\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
   return Status;\r
 }\r
 \r


@@ -516,3 +640,134 @@ GLOBAL_REMOVE_IF_UNREFERENCED
 EFI_LOAD_FILE_PROTOCOL  gHttpBootDxeLoadFile = {\r
   HttpBootDxeLoadFile\r
 };\r
 EFI_LOAD_FILE_PROTOCOL  gHttpBootDxeLoadFile = {\r
   HttpBootDxeLoadFile\r
 };\r

+\r
+/**\r
+  Callback function that is invoked when the HTTP Boot driver is about to transmit or has received a\r
+  packet.\r
+\r
+  This function is invoked when the HTTP Boot driver is about to transmit or has received packet.\r
+  Parameters DataType and Received specify the type of event and the format of the buffer pointed\r
+  to by Data. Due to the polling nature of UEFI device drivers, this callback function should not\r
+  execute for more than 5 ms.\r
+  The returned status code determines the behavior of the HTTP Boot driver.\r
+\r
+  @param[in]  This                Pointer to the EFI_HTTP_BOOT_CALLBACK_PROTOCOL instance.\r
+  @param[in]  DataType            The event that occurs in the current state.\r
+  @param[in]  Received            TRUE if the callback is being invoked due to a receive event.\r
+                                  FALSE if the callback is being invoked due to a transmit event.\r
+  @param[in]  DataLength          The length in bytes of the buffer pointed to by Data.\r
+  @param[in]  Data                A pointer to the buffer of data, the data type is specified by\r
+                                  DataType.\r
+                                  \r
+  @retval EFI_SUCCESS             Tells the HTTP Boot driver to continue the HTTP Boot process.\r
+  @retval EFI_ABORTED             Tells the HTTP Boot driver to abort the current HTTP Boot process.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+HttpBootCallback (\r
+  IN EFI_HTTP_BOOT_CALLBACK_PROTOCOL     *This,\r
+  IN EFI_HTTP_BOOT_CALLBACK_DATA_TYPE    DataType,\r
+  IN BOOLEAN                             Received,\r
+  IN UINT32                              DataLength,\r
+  IN VOID                                *Data     OPTIONAL\r
+  )\r
+{\r
+  EFI_HTTP_MESSAGE        *HttpMessage;\r
+  EFI_HTTP_HEADER         *HttpHeader;\r
+  HTTP_BOOT_PRIVATE_DATA  *Private;\r
+  UINT32                  Percentage;\r
+\r
+  Private = HTTP_BOOT_PRIVATE_DATA_FROM_CALLBACK_PROTOCOL(This);\r
+\r
+  switch (DataType) {\r
+  case HttpBootDhcp4:\r
+  case HttpBootDhcp6:\r
+    Print (L".");\r
+    break;\r
+\r
+  case HttpBootHttpRequest:\r
+    if (Data != NULL) {\r
+      HttpMessage = (EFI_HTTP_MESSAGE *) Data;\r
+      if (HttpMessage->Data.Request->Method == HttpMethodGet &&\r
+          HttpMessage->Data.Request->Url != NULL) {\r
+        Print (L"\n  URI: %s\n", HttpMessage->Data.Request->Url);\r
+      }\r
+    }\r
+    break;\r
+\r
+  case HttpBootHttpResponse:\r
+    if (Data != NULL) {\r
+      HttpMessage = (EFI_HTTP_MESSAGE *) Data;\r
+      \r
+      if (HttpMessage->Data.Response != NULL) {\r
+        if (HttpBootIsHttpRedirectStatusCode (HttpMessage->Data.Response->StatusCode)) {\r
+          //\r
+          // Server indicates the resource has been redirected to a different URL\r
+          // according to the section 6.4 of RFC7231 and the RFC 7538.\r
+          // Display the redirect information on the screen.\r
+          //\r
+          HttpHeader = HttpFindHeader (\r
+                 HttpMessage->HeaderCount,\r
+                 HttpMessage->Headers,\r
+                 HTTP_HEADER_LOCATION\r
+                 );\r
+          if (HttpHeader != NULL) {\r
+            Print (L"\n  HTTP ERROR: Resource Redirected.\n  New Location: %a\n", HttpHeader->FieldValue);\r
+          }\r
+          break; \r
+        }\r
+      }\r
+      \r
+      HttpHeader = HttpFindHeader (\r
+                     HttpMessage->HeaderCount,\r
+                     HttpMessage->Headers,\r
+                     HTTP_HEADER_CONTENT_LENGTH\r
+                     );\r
+      if (HttpHeader != NULL) {\r
+        Private->FileSize = AsciiStrDecimalToUintn (HttpHeader->FieldValue);\r
+        Private->ReceivedSize = 0;\r
+        Private->Percentage   = 0;\r
+      }\r
+    }\r
+    break;\r
+\r
+  case HttpBootHttpEntityBody:\r
+    if (DataLength != 0) {\r
+      if (Private->FileSize != 0) {\r
+        //\r
+        // We already know the file size, print in percentage format.\r
+        //\r
+        if (Private->ReceivedSize == 0) {\r
+          Print (L"  File Size: %lu Bytes\n", Private->FileSize);\r
+        }\r
+        Private->ReceivedSize += DataLength;\r
+        Percentage = (UINT32) DivU64x64Remainder (MultU64x32 (Private->ReceivedSize, 100), Private->FileSize, NULL);\r
+        if (Private->Percentage != Percentage) {\r
+          Private->Percentage = Percentage;\r
+          Print (L"\r  Downloading...%d%%", Percentage);\r
+        }\r
+      } else {\r
+        //\r
+        // In some case we couldn't get the file size from the HTTP header, so we\r
+        // just print the downloaded file size.\r
+        //\r
+        Private->ReceivedSize += DataLength;\r
+        Print (L"\r  Downloading...%lu Bytes", Private->ReceivedSize);\r
+      }\r
+    }\r
+    break;\r
+\r
+  default:\r
+    break;\r
+  };\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+///\r
+/// HTTP Boot Callback Protocol instance\r
+///\r
+GLOBAL_REMOVE_IF_UNREFERENCED \r
+EFI_HTTP_BOOT_CALLBACK_PROTOCOL  gHttpBootDxeHttpBootCallback = {\r
+  HttpBootCallback\r
+};\r