]> git.proxmox.com Git - mirror_edk2.git/blobdiff - NetworkPkg/HttpBootDxe/HttpBootClient.c
NetworkPkg/HttpBootDxe: Add HTTP Boot Callback protocol support.
[mirror_edk2.git] / NetworkPkg / HttpBootDxe / HttpBootClient.c
index 3b4afc396f01071b272df5014a51ba5685fb6f27..68f5a49bad9ab609a3b6f34209b5cfd940c46ff3 100644 (file)
@@ -1,7 +1,8 @@
 /** @file\r
   Implementation of the boot file download function.\r
 \r
-Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2015 - 2017, 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
@@ -54,14 +55,27 @@ HttpBootUpdateDevicePath (
     Node->Ipv4.StaticIpAddress = FALSE;\r
     CopyMem (&Node->Ipv4.GatewayIpAddress, &Private->GatewayIp, sizeof (EFI_IPv4_ADDRESS));\r
     CopyMem (&Node->Ipv4.SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
-    \r
-    TmpDevicePath = AppendDevicePathNode (Private->ParentDevicePath, (EFI_DEVICE_PATH_PROTOCOL*) Node);\r
-    FreePool (Node);\r
-    if (TmpDevicePath == NULL) {\r
+  } else {\r
+    Node = AllocateZeroPool (sizeof (IPv6_DEVICE_PATH));\r
+    if (Node == NULL) {\r
       return EFI_OUT_OF_RESOURCES;\r
     }\r
-  } else {\r
-    ASSERT (FALSE);\r
+    Node->Ipv6.Header.Type     = MESSAGING_DEVICE_PATH;\r
+    Node->Ipv6.Header.SubType  = MSG_IPv6_DP;\r
+    SetDevicePathNodeLength (Node, sizeof (IPv6_DEVICE_PATH));\r
+    Node->Ipv6.PrefixLength    = IP6_PREFIX_LENGTH;\r
+    Node->Ipv6.RemotePort      = Private->Port;\r
+    Node->Ipv6.Protocol        = EFI_IP_PROTO_TCP; \r
+    Node->Ipv6.IpAddressOrigin = 0;\r
+    CopyMem (&Node->Ipv6.LocalIpAddress, &Private->StationIp.v6, sizeof (EFI_IPv6_ADDRESS));\r
+    CopyMem (&Node->Ipv6.RemoteIpAddress, &Private->ServerIp.v6, sizeof (EFI_IPv6_ADDRESS));\r
+    CopyMem (&Node->Ipv6.GatewayIpAddress, &Private->GatewayIp.v6, sizeof (EFI_IPv6_ADDRESS));\r
+  }\r
+  \r
+  TmpDevicePath = AppendDevicePathNode (Private->ParentDevicePath, (EFI_DEVICE_PATH_PROTOCOL*) Node);\r
+  FreePool (Node);\r
+  if (TmpDevicePath == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
   //\r
@@ -85,21 +99,39 @@ HttpBootUpdateDevicePath (
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
-  //\r
-  // Reinstall the device path protocol of the child handle.\r
-  //\r
-  Status = gBS->ReinstallProtocolInterface (\r
-                  Private->ChildHandle,\r
-                  &gEfiDevicePathProtocolGuid,\r
-                  Private->DevicePath,\r
-                  NewDevicePath\r
-                  );\r
-  if (EFI_ERROR (Status)) {\r
-    return Status;\r
+  if (!Private->UsingIpv6) {\r
+    //\r
+    // Reinstall the device path protocol of the child handle.\r
+    //\r
+    Status = gBS->ReinstallProtocolInterface (\r
+                    Private->Ip4Nic->Controller,\r
+                    &gEfiDevicePathProtocolGuid,\r
+                    Private->Ip4Nic->DevicePath,\r
+                    NewDevicePath\r
+                    );\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+    \r
+    FreePool (Private->Ip4Nic->DevicePath);\r
+    Private->Ip4Nic->DevicePath = NewDevicePath;\r
+  } else {\r
+    //\r
+    // Reinstall the device path protocol of the child handle.\r
+    //\r
+    Status = gBS->ReinstallProtocolInterface (\r
+                    Private->Ip6Nic->Controller,\r
+                    &gEfiDevicePathProtocolGuid,\r
+                    Private->Ip6Nic->DevicePath,\r
+                    NewDevicePath\r
+                    );\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+    FreePool (Private->Ip6Nic->DevicePath);\r
+    Private->Ip6Nic->DevicePath = NewDevicePath;\r
   }\r
   \r
-  FreePool (Private->DevicePath);\r
-  Private->DevicePath = NewDevicePath;\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -113,7 +145,7 @@ HttpBootUpdateDevicePath (
 \r
 **/\r
 EFI_STATUS\r
-HttpBootExtractUriInfo (\r
+HttpBootDhcp4ExtractUriInfo (\r
   IN     HTTP_BOOT_PRIVATE_DATA   *Private\r
   )\r
 {\r
@@ -136,18 +168,44 @@ HttpBootExtractUriInfo (
   // HttpOffer contains the boot file URL.\r
   //\r
   SelectOffer = &Private->OfferBuffer[SelectIndex].Dhcp4;\r
-  if ((SelectOffer->OfferType == HttpOfferTypeDhcpIpUri) || (SelectOffer->OfferType == HttpOfferTypeDhcpNameUriDns)) {\r
-    HttpOffer = SelectOffer;\r
+  if (Private->FilePathUri == NULL) {\r
+    //\r
+    // In Corporate environment, we need a HttpOffer.\r
+    //\r
+    if ((SelectOffer->OfferType == HttpOfferTypeDhcpIpUri) || \r
+        (SelectOffer->OfferType == HttpOfferTypeDhcpIpUriDns) ||\r
+        (SelectOffer->OfferType == HttpOfferTypeDhcpNameUriDns)) {\r
+      HttpOffer = SelectOffer;\r
+    } else {\r
+      ASSERT (Private->SelectProxyType != HttpOfferTypeMax);\r
+      ProxyIndex = Private->OfferIndex[Private->SelectProxyType][0];\r
+      HttpOffer = &Private->OfferBuffer[ProxyIndex].Dhcp4;\r
+    }\r
+    Private->BootFileUriParser = HttpOffer->UriParser;\r
+    Private->BootFileUri = (CHAR8*) HttpOffer->OptList[HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE]->Data;\r
   } else {\r
-    ASSERT (Private->SelectProxyType != HttpOfferTypeMax);\r
-    ProxyIndex = Private->OfferIndex[Private->SelectProxyType][0];\r
-    HttpOffer = &Private->OfferBuffer[ProxyIndex].Dhcp4;\r
+    //\r
+    // In Home environment the BootFileUri comes from the FilePath.\r
+    //\r
+    Private->BootFileUriParser = Private->FilePathUriParser;\r
+    Private->BootFileUri = Private->FilePathUri;\r
+  }\r
+\r
+  //\r
+  // Check the URI scheme.\r
+  //\r
+  Status = HttpBootCheckUriScheme (Private->BootFileUri);\r
+  if (EFI_ERROR (Status)) {\r
+    DEBUG ((EFI_D_ERROR, "HttpBootDhcp4ExtractUriInfo: %r.\n", Status));\r
+    return Status;\r
   }\r
 \r
   //\r
   // Configure the default DNS server if server assigned.\r
   //\r
-  if ((SelectOffer->OfferType == HttpOfferTypeDhcpNameUriDns) || (SelectOffer->OfferType == HttpOfferTypeDhcpDns)) {\r
+  if ((SelectOffer->OfferType == HttpOfferTypeDhcpNameUriDns) || \r
+      (SelectOffer->OfferType == HttpOfferTypeDhcpDns) ||\r
+      (SelectOffer->OfferType == HttpOfferTypeDhcpIpUriDns)) {\r
     Option = SelectOffer->OptList[HTTP_BOOT_DHCP4_TAG_INDEX_DNS_SERVER];\r
     ASSERT (Option != NULL);\r
     Status = HttpBootRegisterIp4Dns (\r
@@ -164,8 +222,8 @@ HttpBootExtractUriInfo (
   // Extract the port from URL, and use default HTTP port 80 if not provided.\r
   //\r
   Status = HttpUrlGetPort (\r
-             (CHAR8*) HttpOffer->OptList[HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE]->Data,\r
-             HttpOffer->UriParser,\r
+             Private->BootFileUri,\r
+             Private->BootFileUriParser,\r
              &Private->Port\r
              );\r
   if (EFI_ERROR (Status) || Private->Port == 0) {\r
@@ -173,25 +231,191 @@ HttpBootExtractUriInfo (
   }\r
   \r
   //\r
-  // Record the URI of boot file from the selected HTTP offer.\r
+  // All boot informations are valid here.\r
+  //\r
+\r
+  //\r
+  // Update the device path to include the IP and boot URI information.\r
+  //\r
+  Status = HttpBootUpdateDevicePath (Private);\r
+\r
+  return Status;\r
+}\r
+\r
+/**\r
+  Parse the boot file URI information from the selected Dhcp6 offer packet.\r
+\r
+  @param[in]    Private        The pointer to the driver's private data.\r
+\r
+  @retval EFI_SUCCESS          Successfully parsed out all the boot information.\r
+  @retval Others               Failed to parse out the boot information.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootDhcp6ExtractUriInfo (\r
+  IN     HTTP_BOOT_PRIVATE_DATA   *Private\r
+  )\r
+{\r
+  HTTP_BOOT_DHCP6_PACKET_CACHE    *SelectOffer;\r
+  HTTP_BOOT_DHCP6_PACKET_CACHE    *HttpOffer;\r
+  UINT32                          SelectIndex;\r
+  UINT32                          ProxyIndex;\r
+  EFI_DHCP6_PACKET_OPTION         *Option;\r
+  EFI_IPv6_ADDRESS                IpAddr;\r
+  CHAR8                           *HostName;\r
+  UINTN                           HostNameSize;\r
+  CHAR16                          *HostNameStr;\r
+  EFI_STATUS                      Status;\r
+\r
+  ASSERT (Private != NULL);\r
+  ASSERT (Private->SelectIndex != 0);\r
+  SelectIndex = Private->SelectIndex - 1;\r
+  ASSERT (SelectIndex < HTTP_BOOT_OFFER_MAX_NUM);\r
+\r
+  Status   = EFI_SUCCESS;\r
+  HostName = NULL;\r
+  //\r
+  // SelectOffer contains the IP address configuration and name server configuration.\r
+  // HttpOffer contains the boot file URL.\r
+  //\r
+  SelectOffer = &Private->OfferBuffer[SelectIndex].Dhcp6;\r
+  if (Private->FilePathUri == NULL) {\r
+    //\r
+    // In Corporate environment, we need a HttpOffer.\r
+    //\r
+    if ((SelectOffer->OfferType == HttpOfferTypeDhcpIpUri) ||\r
+        (SelectOffer->OfferType == HttpOfferTypeDhcpIpUriDns) ||\r
+        (SelectOffer->OfferType == HttpOfferTypeDhcpNameUriDns)) {\r
+      HttpOffer = SelectOffer;\r
+    } else {\r
+      ASSERT (Private->SelectProxyType != HttpOfferTypeMax);\r
+      ProxyIndex = Private->OfferIndex[Private->SelectProxyType][0];\r
+      HttpOffer = &Private->OfferBuffer[ProxyIndex].Dhcp6;\r
+    }\r
+    Private->BootFileUriParser = HttpOffer->UriParser;\r
+    Private->BootFileUri = (CHAR8*) HttpOffer->OptList[HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL]->Data;\r
+  } else {\r
+    //\r
+    // In Home environment the BootFileUri comes from the FilePath.\r
+    //\r
+    Private->BootFileUriParser = Private->FilePathUriParser;\r
+    Private->BootFileUri = Private->FilePathUri;\r
+  }\r
+\r
+  //\r
+  // Check the URI scheme.\r
+  //\r
+  Status = HttpBootCheckUriScheme (Private->BootFileUri);\r
+  if (EFI_ERROR (Status)) {\r
+    DEBUG ((EFI_D_ERROR, "HttpBootDhcp6ExtractUriInfo: %r.\n", Status));\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  //  Set the Local station address to IP layer.\r
+  //\r
+  Status = HttpBootSetIp6Address (Private);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Register the IPv6 gateway address to the network device.\r
+  //\r
+  Status = HttpBootSetIp6Gateway (Private);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+  \r
+  //\r
+  // Configure the default DNS server if server assigned.\r
   //\r
-  Private->BootFileUriParser = HttpOffer->UriParser;\r
-  Private->BootFileUri = (CHAR8*) HttpOffer->OptList[HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE]->Data;\r
+  if ((SelectOffer->OfferType == HttpOfferTypeDhcpNameUriDns) || \r
+      (SelectOffer->OfferType == HttpOfferTypeDhcpDns) ||\r
+      (SelectOffer->OfferType == HttpOfferTypeDhcpIpUriDns)) {\r
+    Option = SelectOffer->OptList[HTTP_BOOT_DHCP6_IDX_DNS_SERVER];\r
+    ASSERT (Option != NULL);\r
+    Status = HttpBootSetIp6Dns (\r
+               Private,\r
+               HTONS (Option->OpLen),\r
+               Option->Data\r
+               );\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+  }\r
+  \r
+  //\r
+  // Extract the HTTP server Ip frome URL. This is used to Check route table \r
+  // whether can send message to HTTP Server Ip through the GateWay.\r
+  //\r
+  Status = HttpUrlGetIp6 (\r
+             Private->BootFileUri,\r
+             Private->BootFileUriParser,\r
+             &IpAddr\r
+             );\r
+  \r
+  if (EFI_ERROR (Status)) {\r
+    //\r
+    // The Http server address is expressed by Name Ip, so perform DNS resolution\r
+    //\r
+    Status = HttpUrlGetHostName (\r
+               Private->BootFileUri,\r
+               Private->BootFileUriParser,\r
+               &HostName\r
+               );\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
 \r
+    HostNameSize = AsciiStrSize (HostName);\r
+    HostNameStr = AllocateZeroPool (HostNameSize * sizeof (CHAR16));\r
+    if (HostNameStr == NULL) {\r
+      Status = EFI_OUT_OF_RESOURCES;\r
+      goto Error;\r
+    }\r
+    \r
+    AsciiStrToUnicodeStrS (HostName, HostNameStr, HostNameSize);\r
+    Status = HttpBootDns (Private, HostNameStr, &IpAddr);\r
+    FreePool (HostNameStr);\r
+    if (EFI_ERROR (Status)) {\r
+      goto Error;\r
+    }  \r
+  } \r
+  \r
+  CopyMem (&Private->ServerIp.v6, &IpAddr, sizeof (EFI_IPv6_ADDRESS));\r
+  \r
+  //\r
+  // Extract the port from URL, and use default HTTP port 80 if not provided.\r
+  //\r
+  Status = HttpUrlGetPort (\r
+             Private->BootFileUri,\r
+             Private->BootFileUriParser,\r
+             &Private->Port\r
+             );\r
+  if (EFI_ERROR (Status) || Private->Port == 0) {\r
+    Private->Port = 80;\r
+  }\r
   \r
   //\r
   // All boot informations are valid here.\r
   //\r
-  AsciiPrint ("\n  URI: %a", Private->BootFileUri);\r
 \r
   //\r
   // Update the device path to include the IP and boot URI information.\r
   //\r
   Status = HttpBootUpdateDevicePath (Private);\r
 \r
+Error:\r
+  \r
+  if (HostName != NULL) {\r
+    FreePool (HostName);\r
+  }\r
+    \r
   return Status;\r
 }\r
 \r
+\r
 /**\r
   Discover all the boot information for boot file.\r
 \r
@@ -218,14 +442,48 @@ HttpBootDiscoverBootInfo (
   }\r
 \r
   if (!Private->UsingIpv6) {\r
-    Status = HttpBootExtractUriInfo (Private);\r
+    Status = HttpBootDhcp4ExtractUriInfo (Private);\r
   } else {\r
-    ASSERT (FALSE);\r
+    Status = HttpBootDhcp6ExtractUriInfo (Private);\r
   }\r
 \r
   return Status;\r
 }\r
 \r
+/**\r
+  HttpIo Callback function which will be invoked when specified HTTP_IO_CALLBACK_EVENT happened.\r
+\r
+  @param[in]    EventType      Indicate the Event type that occurs in the current callback.\r
+  @param[in]    Message        HTTP message which will be send to, or just received from HTTP server.\r
+  @param[in]    Context        The Callback Context pointer.\r
+  \r
+  @retval EFI_SUCCESS          Tells the HttpIo to continue the HTTP process.\r
+  @retval Others               Tells the HttpIo to abort the current HTTP process.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+HttpBootHttpIoCallback (\r
+  IN  HTTP_IO_CALLBACK_EVENT    EventType,\r
+  IN  EFI_HTTP_MESSAGE          *Message,\r
+  IN  VOID                      *Context\r
+  )\r
+{\r
+  HTTP_BOOT_PRIVATE_DATA       *Private;\r
+  EFI_STATUS                   Status;\r
+  Private = (HTTP_BOOT_PRIVATE_DATA *) Context;\r
+  if (Private->HttpBootCallback != NULL) {\r
+    Status = Private->HttpBootCallback->Callback (\r
+               Private->HttpBootCallback,\r
+               EventType == HttpIoRequest ? HttpBootHttpRequest : HttpBootHttpResponse,\r
+               EventType == HttpIoRequest ? FALSE : TRUE,\r
+               sizeof (EFI_HTTP_MESSAGE),\r
+               (VOID *) Message\r
+               );\r
+    return Status;\r
+  }\r
+  return EFI_SUCCESS;\r
+}\r
+\r
 /**\r
   Create a HttpIo instance for the file download.\r
 \r
@@ -242,24 +500,31 @@ HttpBootCreateHttpIo (
 {\r
   HTTP_IO_CONFIG_DATA          ConfigData;\r
   EFI_STATUS                   Status;\r
+  EFI_HANDLE                   ImageHandle;\r
 \r
   ASSERT (Private != NULL);\r
 \r
   ZeroMem (&ConfigData, sizeof (HTTP_IO_CONFIG_DATA));\r
   if (!Private->UsingIpv6) {\r
-    ConfigData.Config4.HttpVersion = HttpVersion11;\r
+    ConfigData.Config4.HttpVersion    = HttpVersion11;\r
     ConfigData.Config4.RequestTimeOut = HTTP_BOOT_REQUEST_TIMEOUT;\r
     IP4_COPY_ADDRESS (&ConfigData.Config4.LocalIp, &Private->StationIp.v4);\r
     IP4_COPY_ADDRESS (&ConfigData.Config4.SubnetMask, &Private->SubnetMask.v4);\r
+    ImageHandle = Private->Ip4Nic->ImageHandle;\r
   } else {\r
-    ASSERT (FALSE);\r
+    ConfigData.Config6.HttpVersion    = HttpVersion11;\r
+    ConfigData.Config6.RequestTimeOut = HTTP_BOOT_REQUEST_TIMEOUT;\r
+    IP6_COPY_ADDRESS (&ConfigData.Config6.LocalIp, &Private->StationIp.v6);\r
+    ImageHandle = Private->Ip6Nic->ImageHandle;\r
   }\r
 \r
   Status = HttpIoCreateIo (\r
-             Private->Image,\r
+             ImageHandle,\r
              Private->Controller,\r
              Private->UsingIpv6 ? IP_VERSION_6 : IP_VERSION_4,\r
              &ConfigData,\r
+             HttpBootHttpIoCallback,\r
+             (VOID *) Private,\r
              &Private->HttpIo\r
              );\r
   if (EFI_ERROR (Status)) {\r
@@ -270,81 +535,6 @@ HttpBootCreateHttpIo (
   return EFI_SUCCESS;\r
 }\r
 \r
-/**\r
-  Get the file content from cached data.\r
-\r
-  @param[in]          Private         The pointer to the driver's private data.\r
-  @param[in]          Uri             Uri of the file to be retrieved from cache.\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[out]         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          Successfully created.\r
-  @retval Others               Failed to create HttpIo.\r
-\r
-**/\r
-EFI_STATUS\r
-HttpBootGetFileFromCache (\r
-  IN     HTTP_BOOT_PRIVATE_DATA   *Private,\r
-  IN     CHAR16                   *Uri,\r
-  IN OUT UINTN                    *BufferSize,\r
-     OUT UINT8                    *Buffer\r
-  )\r
-{\r
-  LIST_ENTRY                  *Entry;\r
-  LIST_ENTRY                  *Entry2;\r
-  HTTP_BOOT_CACHE_CONTENT     *Cache;\r
-  HTTP_BOOT_ENTITY_DATA       *EntityData;\r
-  UINTN                       CopyedSize;\r
-  \r
-  if (Uri == NULL || BufferSize == 0 || Buffer == NULL) {\r
-    return EFI_INVALID_PARAMETER;\r
-  }\r
-\r
-  NET_LIST_FOR_EACH (Entry, &Private->CacheList) {\r
-    Cache = NET_LIST_USER_STRUCT (Entry, HTTP_BOOT_CACHE_CONTENT, Link);\r
-    //\r
-    // Compare the URI to see whether we already have a cache for this file.\r
-    //\r
-    if ((Cache->RequestData != NULL) &&\r
-        (Cache->RequestData->Url != NULL) &&\r
-        (StrCmp (Uri, Cache->RequestData->Url) == 0)) \r
-    {\r
-      //\r
-      // Hit cache, check buffer size.\r
-      //\r
-      if (*BufferSize < Cache->EntityLength) {\r
-        *BufferSize = Cache->EntityLength;\r
-        return EFI_BUFFER_TOO_SMALL;\r
-      }\r
-\r
-      //\r
-      // Fill data to buffer.\r
-      //\r
-      CopyedSize = 0;\r
-      NET_LIST_FOR_EACH (Entry2, &Cache->EntityDataList) {\r
-        EntityData = NET_LIST_USER_STRUCT (Entry2, HTTP_BOOT_ENTITY_DATA, Link);\r
-        if (*BufferSize > CopyedSize) {\r
-          CopyMem (\r
-            Buffer + CopyedSize,\r
-            EntityData->DataStart,\r
-            MIN (EntityData->DataLength, *BufferSize - CopyedSize)\r
-            );\r
-          CopyedSize += MIN (EntityData->DataLength, *BufferSize - CopyedSize);\r
-        }\r
-      }\r
-      *BufferSize = CopyedSize;\r
-      return EFI_SUCCESS;\r
-    }\r
-  }\r
-\r
-  return EFI_NOT_FOUND;\r
-}\r
-\r
 /**\r
   Release all the resource of a cache item.\r
 \r
@@ -423,6 +613,88 @@ HttpBootFreeCacheList (
   }\r
 }\r
 \r
+/**\r
+  Get the file content from cached data.\r
+\r
+  @param[in]          Private         The pointer to the driver's private data.\r
+  @param[in]          Uri             Uri of the file to be retrieved from cache.\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[out]         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          Successfully created.\r
+  @retval Others               Failed to create HttpIo.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootGetFileFromCache (\r
+  IN     HTTP_BOOT_PRIVATE_DATA   *Private,\r
+  IN     CHAR16                   *Uri,\r
+  IN OUT UINTN                    *BufferSize,\r
+     OUT UINT8                    *Buffer,\r
+     OUT HTTP_BOOT_IMAGE_TYPE     *ImageType\r
+  )\r
+{\r
+  LIST_ENTRY                  *Entry;\r
+  LIST_ENTRY                  *Entry2;\r
+  HTTP_BOOT_CACHE_CONTENT     *Cache;\r
+  HTTP_BOOT_ENTITY_DATA       *EntityData;\r
+  UINTN                       CopyedSize;\r
+  \r
+  if (Uri == NULL || BufferSize == 0 || Buffer == NULL || ImageType == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  NET_LIST_FOR_EACH (Entry, &Private->CacheList) {\r
+    Cache = NET_LIST_USER_STRUCT (Entry, HTTP_BOOT_CACHE_CONTENT, Link);\r
+    //\r
+    // Compare the URI to see whether we already have a cache for this file.\r
+    //\r
+    if ((Cache->RequestData != NULL) &&\r
+        (Cache->RequestData->Url != NULL) &&\r
+        (StrCmp (Uri, Cache->RequestData->Url) == 0)) \r
+    {\r
+      //\r
+      // Hit in cache, record image type.\r
+      //\r
+      *ImageType  = Cache->ImageType;\r
+\r
+      //\r
+      // Check buffer size.\r
+      //\r
+      if (*BufferSize < Cache->EntityLength) {\r
+        *BufferSize = Cache->EntityLength;\r
+        return EFI_BUFFER_TOO_SMALL;\r
+      }\r
+\r
+      //\r
+      // Fill data to buffer.\r
+      //\r
+      CopyedSize = 0;\r
+      NET_LIST_FOR_EACH (Entry2, &Cache->EntityDataList) {\r
+        EntityData = NET_LIST_USER_STRUCT (Entry2, HTTP_BOOT_ENTITY_DATA, Link);\r
+        if (*BufferSize > CopyedSize) {\r
+          CopyMem (\r
+            Buffer + CopyedSize,\r
+            EntityData->DataStart,\r
+            MIN (EntityData->DataLength, *BufferSize - CopyedSize)\r
+            );\r
+          CopyedSize += MIN (EntityData->DataLength, *BufferSize - CopyedSize);\r
+        }\r
+      }\r
+      *BufferSize = CopyedSize;\r
+      return EFI_SUCCESS;\r
+    }\r
+  }\r
+\r
+  return EFI_NOT_FOUND;\r
+}\r
+\r
 /**\r
   A callback function to intercept events during message parser.\r
 \r
@@ -449,6 +721,8 @@ HttpBootGetBootFileCallback (
 {\r
   HTTP_BOOT_CALLBACK_DATA      *CallbackData;\r
   HTTP_BOOT_ENTITY_DATA        *NewEntityData;\r
+  EFI_STATUS                   Status;\r
+  EFI_HTTP_BOOT_CALLBACK_PROTOCOL   *HttpBootCallback;\r
 \r
   //\r
   // We only care about the entity data.\r
@@ -458,22 +732,19 @@ HttpBootGetBootFileCallback (
   }\r
 \r
   CallbackData = (HTTP_BOOT_CALLBACK_DATA *) Context;\r
-\r
-  //\r
-  // Save the data into cache list.\r
-  //\r
-  NewEntityData = AllocatePool (sizeof (HTTP_BOOT_ENTITY_DATA));\r
-  if (NewEntityData == NULL) {\r
-    return EFI_OUT_OF_RESOURCES;\r
-  }\r
-  if (CallbackData->NewBlock) {\r
-    NewEntityData->Block = CallbackData->Block;\r
-    CallbackData->Block = NULL;\r
+  HttpBootCallback = CallbackData->Private->HttpBootCallback;\r
+  if (HttpBootCallback != NULL) {\r
+    Status = HttpBootCallback->Callback (\r
+               HttpBootCallback,\r
+               HttpBootHttpEntityBody,\r
+               TRUE,\r
+               (UINT32)Length,\r
+               Data\r
+               );\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
   }\r
-  NewEntityData->DataLength = Length;\r
-  NewEntityData->DataStart  = (UINT8*) Data;\r
-  InsertTailList (&CallbackData->Cache->EntityDataList, &NewEntityData->Link);\r
-\r
   //\r
   // Copy data if caller has provided a buffer.\r
   //\r
@@ -486,6 +757,22 @@ HttpBootGetBootFileCallback (
     CallbackData->CopyedSize += MIN (Length, CallbackData->BufferSize - CallbackData->CopyedSize);\r
   }\r
 \r
+  //\r
+  // The caller doesn't provide a buffer, save the block into cache list.\r
+  //\r
+  if (CallbackData->Cache != NULL) {\r
+    NewEntityData = AllocatePool (sizeof (HTTP_BOOT_ENTITY_DATA));\r
+    if (NewEntityData == NULL) {\r
+      return EFI_OUT_OF_RESOURCES;\r
+    }\r
+    if (CallbackData->NewBlock) {\r
+      NewEntityData->Block = CallbackData->Block;\r
+      CallbackData->Block = NULL;\r
+    }\r
+    NewEntityData->DataLength = Length;\r
+    NewEntityData->DataStart  = (UINT8*) Data;\r
+    InsertTailList (&CallbackData->Cache->EntityDataList, &NewEntityData->Link);\r
+  }\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -502,6 +789,7 @@ HttpBootGetBootFileCallback (
   @param[out]      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              The file was loaded.\r
   @retval EFI_INVALID_PARAMETER    BufferSize is NULL or Buffer Size is not NULL but Buffer is NULL.\r
@@ -517,14 +805,16 @@ HttpBootGetBootFile (
   IN     HTTP_BOOT_PRIVATE_DATA   *Private,\r
   IN     BOOLEAN                  HeaderOnly,\r
   IN OUT UINTN                    *BufferSize,\r
-     OUT UINT8                    *Buffer\r
+     OUT UINT8                    *Buffer,\r
+     OUT HTTP_BOOT_IMAGE_TYPE     *ImageType\r
   )\r
 {\r
   EFI_STATUS                 Status;\r
+  EFI_HTTP_STATUS_CODE       StatusCode;\r
   CHAR8                      *HostName;\r
   EFI_HTTP_REQUEST_DATA      *RequestData;\r
-  HTTP_IO_RESOPNSE_DATA      *ResponseData;\r
-  HTTP_IO_RESOPNSE_DATA      ResponseBody;\r
+  HTTP_IO_RESPONSE_DATA      *ResponseData;\r
+  HTTP_IO_RESPONSE_DATA      ResponseBody;\r
   HTTP_IO                    *HttpIo;\r
   HTTP_IO_HEADER             *HttpIoHeader;\r
   VOID                       *Parser;\r
@@ -532,12 +822,15 @@ HttpBootGetBootFile (
   UINTN                      ContentLength;\r
   HTTP_BOOT_CACHE_CONTENT    *Cache;\r
   UINT8                      *Block;\r
+  UINTN                      UrlSize;\r
   CHAR16                     *Url;\r
+  BOOLEAN                    IdentityMode;\r
+  UINTN                      ReceivedSize;\r
   \r
   ASSERT (Private != NULL);\r
   ASSERT (Private->HttpCreated);\r
 \r
-  if (BufferSize == NULL) {\r
+  if (BufferSize == NULL || ImageType == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
 \r
@@ -548,13 +841,14 @@ HttpBootGetBootFile (
   //\r
   // First, check whether we already cached the requested Uri.\r
   //\r
-  Url = AllocatePool ((AsciiStrLen (Private->BootFileUri) + 1) * sizeof (CHAR16));\r
+  UrlSize = AsciiStrSize (Private->BootFileUri);\r
+  Url = AllocatePool (UrlSize * sizeof (CHAR16));\r
   if (Url == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
-  AsciiStrToUnicodeStr (Private->BootFileUri, Url);\r
+  AsciiStrToUnicodeStrS (Private->BootFileUri, Url, UrlSize);\r
   if (!HeaderOnly) {\r
-    Status = HttpBootGetFileFromCache (Private, Url, BufferSize, Buffer);\r
+    Status = HttpBootGetFileFromCache (Private, Url, BufferSize, Buffer, ImageType);\r
     if (Status != EFI_NOT_FOUND) {\r
       FreePool (Url);\r
       return Status;\r
@@ -566,15 +860,16 @@ HttpBootGetBootFile (
   //\r
 \r
   //\r
-  // 1. Create a temp cache item for the requested URI.\r
+  // 1. Create a temp cache item for the requested URI if caller doesn't provide buffer.\r
   //\r
   Cache = NULL;\r
-  if (!HeaderOnly) {\r
+  if ((!HeaderOnly) && (*BufferSize == 0)) {\r
     Cache = AllocateZeroPool (sizeof (HTTP_BOOT_CACHE_CONTENT));\r
     if (Cache == NULL) {\r
       Status = EFI_OUT_OF_RESOURCES;\r
       goto ERROR_1;\r
     }\r
+    Cache->ImageType = ImageTypeMax;\r
     InitializeListHead (&Cache->EntityDataList);\r
   }\r
 \r
@@ -608,7 +903,7 @@ HttpBootGetBootFile (
   }\r
   Status = HttpBootSetHeader (\r
              HttpIoHeader,\r
-             HTTP_FIELD_NAME_HOST,\r
+             HTTP_HEADER_HOST,\r
              HostName\r
              );\r
   FreePool (HostName);\r
@@ -621,7 +916,7 @@ HttpBootGetBootFile (
   //\r
   Status = HttpBootSetHeader (\r
              HttpIoHeader,\r
-             HTTP_FIELD_NAME_ACCEPT,\r
+             HTTP_HEADER_ACCEPT,\r
              "*/*"\r
              );\r
   if (EFI_ERROR (Status)) {\r
@@ -633,7 +928,7 @@ HttpBootGetBootFile (
   //\r
   Status = HttpBootSetHeader (\r
              HttpIoHeader,\r
-             HTTP_FIELD_NAME_USER_AGENT,\r
+             HTTP_HEADER_USER_AGENT,\r
              HTTP_USER_AGENT_EFI_HTTP_BOOT\r
              );\r
   if (EFI_ERROR (Status)) {\r
@@ -650,16 +945,11 @@ HttpBootGetBootFile (
   }\r
   RequestData->Method = HeaderOnly ? HttpMethodHead : HttpMethodGet;\r
   RequestData->Url = Url;\r
-  if (RequestData->Url == NULL) {\r
-    Status = EFI_OUT_OF_RESOURCES;\r
-    goto ERROR_4;\r
-  }\r
-  AsciiStrToUnicodeStr (Private->BootFileUri, RequestData->Url);\r
 \r
   //\r
   // 2.3 Record the request info in a temp cache item.\r
   //\r
-  if (!HeaderOnly) {\r
+  if (Cache != NULL) {\r
     Cache->RequestData = RequestData;\r
   }\r
 \r
@@ -686,7 +976,7 @@ HttpBootGetBootFile (
   //\r
   // 3.1 First step, use zero BodyLength to only receive the response headers.\r
   //\r
-  ResponseData = AllocateZeroPool (sizeof(HTTP_IO_RESOPNSE_DATA));\r
+  ResponseData = AllocateZeroPool (sizeof(HTTP_IO_RESPONSE_DATA));\r
   if (ResponseData == NULL) {\r
     Status = EFI_OUT_OF_RESOURCES;\r
     goto ERROR_4;\r
@@ -696,6 +986,25 @@ HttpBootGetBootFile (
              TRUE,\r
              ResponseData\r
              );\r
+  if (EFI_ERROR (Status) || EFI_ERROR (ResponseData->Status)) {\r
+    if (EFI_ERROR (ResponseData->Status)) {\r
+      StatusCode = HttpIo->RspToken.Message->Data.Response->StatusCode;\r
+      HttpBootPrintErrorMessage (StatusCode);\r
+      Status = ResponseData->Status;\r
+    }\r
+    goto ERROR_5;\r
+  }\r
+\r
+  //\r
+  // Check the image type according to server's response.\r
+  //\r
+  Status = HttpBootCheckImageType (\r
+             Private->BootFileUri,\r
+             Private->BootFileUriParser,\r
+             ResponseData->HeaderCount,\r
+             ResponseData->Headers,\r
+             ImageType\r
+             );\r
   if (EFI_ERROR (Status)) {\r
     goto ERROR_5;\r
   }\r
@@ -703,8 +1012,9 @@ HttpBootGetBootFile (
   //\r
   // 3.2 Cache the response header.\r
   //\r
-  if (!HeaderOnly) {\r
+  if (Cache != NULL) {\r
     Cache->ResponseData = ResponseData;\r
+    Cache->ImageType = *ImageType;\r
   }\r
   \r
   //\r
@@ -717,6 +1027,7 @@ HttpBootGetBootFile (
   Context.Buffer     = Buffer;\r
   Context.BufferSize = *BufferSize;\r
   Context.Cache      = Cache;\r
+  Context.Private    = Private;\r
   Status = HttpInitMsgParser (\r
              HeaderOnly? HttpMethodHead : HttpMethodGet,\r
              ResponseData->Response.StatusCode,\r
@@ -733,46 +1044,114 @@ HttpBootGetBootFile (
   //\r
   // 3.4 Continue to receive and parse message-body if needed.\r
   //\r
+  Block = NULL;\r
   if (!HeaderOnly) {\r
-    ZeroMem (&ResponseBody, sizeof (HTTP_IO_RESOPNSE_DATA));\r
-    while (!HttpIsMessageComplete (Parser)) {\r
+    //\r
+    // 3.4.1, check whether we are in identity transfer-coding.\r
+    //\r
+    ContentLength = 0;\r
+    Status = HttpGetEntityLength (Parser, &ContentLength);\r
+    if (!EFI_ERROR (Status)) {\r
+      IdentityMode = TRUE;\r
+    } else {\r
+      IdentityMode = FALSE;\r
+    }\r
+\r
+    //\r
+    // 3.4.2, start the message-body download, the identity and chunked transfer-coding\r
+    // is handled in different path here.\r
+    //\r
+    ZeroMem (&ResponseBody, sizeof (HTTP_IO_RESPONSE_DATA));\r
+    if (IdentityMode) {\r
       //\r
-      // Allocate a new block to hold the message-body.\r
+      // In identity transfer-coding there is no need to parse the message body,\r
+      // just download the message body to the user provided buffer directly.\r
       //\r
-      Block = AllocatePool (HTTP_BOOT_BLOCK_SIZE);\r
-      if (Block == NULL) {\r
-        Status = EFI_OUT_OF_RESOURCES;\r
-        goto ERROR_6;\r
-      }\r
-      ResponseBody.Body       = (CHAR8*) Block;\r
-      ResponseBody.BodyLength = HTTP_BOOT_BLOCK_SIZE;\r
-      Status = HttpIoRecvResponse (\r
-                 &Private->HttpIo,\r
-                 FALSE,\r
-                 &ResponseBody\r
-                 );\r
-      if (EFI_ERROR (Status)) {\r
-        goto ERROR_6;\r
+      ReceivedSize = 0;\r
+      while (ReceivedSize < ContentLength) {\r
+        ResponseBody.Body       = (CHAR8*) Buffer + ReceivedSize;\r
+        ResponseBody.BodyLength = *BufferSize - ReceivedSize;\r
+        Status = HttpIoRecvResponse (\r
+                   &Private->HttpIo,\r
+                   FALSE,\r
+                   &ResponseBody\r
+                   );\r
+        if (EFI_ERROR (Status) || EFI_ERROR (ResponseBody.Status)) {\r
+          if (EFI_ERROR (ResponseBody.Status)) {\r
+            Status = ResponseBody.Status;\r
+          }\r
+          goto ERROR_6;\r
+        }\r
+        ReceivedSize += ResponseBody.BodyLength;\r
+        if (Private->HttpBootCallback != NULL) {\r
+          Status = Private->HttpBootCallback->Callback (\r
+                     Private->HttpBootCallback,\r
+                     HttpBootHttpEntityBody,\r
+                     TRUE,\r
+                     (UINT32)ResponseBody.BodyLength,\r
+                     ResponseBody.Body\r
+                     );\r
+          if (EFI_ERROR (Status)) {\r
+            goto ERROR_6;\r
+          }\r
+        }\r
       }\r
-\r
+    } else {\r
       //\r
-      // Parse the new received block of the message-body, the block will be saved in cache.\r
+      // In "chunked" transfer-coding mode, so we need to parse the received\r
+      // data to get the real entity content.\r
       //\r
-      Context.NewBlock = TRUE;\r
-      Context.Block    = Block;\r
-      Status = HttpParseMessageBody (\r
-                 Parser,\r
-                 ResponseBody.BodyLength,\r
-                 ResponseBody.Body\r
-                 );\r
-      if (EFI_ERROR (Status)) {\r
-        goto ERROR_6;\r
+      Block = NULL;\r
+      while (!HttpIsMessageComplete (Parser)) {\r
+        //\r
+        // Allocate a buffer in Block to hold the message-body.\r
+        // If caller provides a buffer, this Block will be reused in every HttpIoRecvResponse().\r
+        // Otherwise a buffer, the buffer in Block will be cached and we should allocate a new before\r
+        // every HttpIoRecvResponse().\r
+        //\r
+        if (Block == NULL || Context.BufferSize == 0) {\r
+          Block = AllocatePool (HTTP_BOOT_BLOCK_SIZE);\r
+          if (Block == NULL) {\r
+            Status = EFI_OUT_OF_RESOURCES;\r
+            goto ERROR_6;\r
+          }\r
+          Context.NewBlock = TRUE;\r
+          Context.Block = Block;\r
+        } else {\r
+          Context.NewBlock = FALSE;\r
+        }\r
+\r
+        ResponseBody.Body       = (CHAR8*) Block;\r
+        ResponseBody.BodyLength = HTTP_BOOT_BLOCK_SIZE;\r
+        Status = HttpIoRecvResponse (\r
+                   &Private->HttpIo,\r
+                   FALSE,\r
+                   &ResponseBody\r
+                   );\r
+        if (EFI_ERROR (Status) || EFI_ERROR (ResponseBody.Status)) {\r
+          if (EFI_ERROR (ResponseBody.Status)) {\r
+            Status = ResponseBody.Status;\r
+          }\r
+          goto ERROR_6;\r
+        }\r
+\r
+        //\r
+        // Parse the new received block of the message-body, the block will be saved in cache.\r
+        //\r
+        Status = HttpParseMessageBody (\r
+                   Parser,\r
+                   ResponseBody.BodyLength,\r
+                   ResponseBody.Body\r
+                   );\r
+        if (EFI_ERROR (Status)) {\r
+          goto ERROR_6;\r
+        }\r
       }\r
     }\r
   }\r
-  \r
+\r
   //\r
-  // 3.5 Message-body receive & parse is completed, get the file size.\r
+  // 3.5 Message-body receive & parse is completed, we should be able to get the file size now.\r
   //\r
   Status = HttpGetEntityLength (Parser, &ContentLength);\r
   if (EFI_ERROR (Status)) {\r
@@ -781,13 +1160,15 @@ HttpBootGetBootFile (
 \r
   if (*BufferSize < ContentLength) {\r
     Status = EFI_BUFFER_TOO_SMALL;\r
+  } else {\r
+    Status = EFI_SUCCESS;\r
   }\r
   *BufferSize = ContentLength;\r
 \r
   //\r
   // 4. Save the cache item to driver's cache list and return.\r
   //\r
-  if (!HeaderOnly) {\r
+  if (Cache != NULL) {\r
     Cache->EntityLength = ContentLength;\r
     InsertTailList (&Private->CacheList, &Cache->Link);\r
   }\r
@@ -796,7 +1177,7 @@ HttpBootGetBootFile (
     HttpFreeMsgParser (Parser);\r
   }\r
 \r
-  return EFI_SUCCESS;\r
+  return Status;\r
   \r
 ERROR_6:\r
   if (Parser != NULL) {\r
@@ -828,3 +1209,4 @@ ERROR_1:
 \r
   return Status;\r
 }\r
+\r