]> git.proxmox.com Git - mirror_edk2.git/blobdiff - NetworkPkg/HttpBootDxe/HttpBootImpl.c
NetworkPkg/HttpBootDxe: Add HTTP Boot Callback protocol support.
[mirror_edk2.git] / NetworkPkg / HttpBootDxe / HttpBootImpl.c
index 4b850b6628be2215a8ff3e194d1a64ce02c8a9db..56f5babeb4bfd5c0d233ed4700b89215073c3d1f 100644 (file)
@@ -15,6 +15,84 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \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
@@ -126,11 +204,11 @@ HttpBootStart (
   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
-      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
@@ -144,6 +222,7 @@ HttpBootStart (
     }\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
@@ -237,7 +316,10 @@ HttpBootLoadFile (
     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
@@ -245,7 +327,7 @@ HttpBootLoadFile (
     //\r
     Status = HttpBootDiscoverBootInfo (Private);\r
     if (EFI_ERROR (Status)) {\r
-      return Status;\r
+      goto ON_EXIT;\r
     }\r
   }\r
 \r
@@ -255,7 +337,7 @@ HttpBootLoadFile (
     //\r
     Status = HttpBootCreateHttpIo (Private);\r
     if (EFI_ERROR (Status)) {\r
-      return Status;\r
+      goto ON_EXIT;\r
     }\r
   }\r
 \r
@@ -287,7 +369,7 @@ HttpBootLoadFile (
                  &Private->ImageType\r
                  );\r
       if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {\r
-        return Status;\r
+        goto ON_EXIT;\r
       }\r
     }\r
   }\r
@@ -295,19 +377,24 @@ HttpBootLoadFile (
   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
-  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
+  return Status;\r
 }\r
 \r
 /**\r
@@ -505,7 +592,11 @@ HttpBootDxeLoadFile (
       Status = EFI_WARN_FILE_SYSTEM;\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
@@ -516,3 +607,113 @@ GLOBAL_REMOVE_IF_UNREFERENCED
 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
+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
+      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\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