/** @file\r
The implementation of EFI_LOAD_FILE_PROTOCOL for UEFI HTTP boot.\r
\r
-Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\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
\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
+ 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.\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 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) {\r
+ if (Private == NULL || FilePath == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\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
- return EFI_ALREADY_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
} 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
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
return Status;\r
}\r
}\r
- Private->Started = TRUE;\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
@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.\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
HttpBootLoadFile (\r
IN HTTP_BOOT_PRIVATE_DATA *Private,\r
IN OUT UINTN *BufferSize,\r
- IN VOID *Buffer OPTIONAL\r
+ IN VOID *Buffer, OPTIONAL\r
+ OUT HTTP_BOOT_IMAGE_TYPE *ImageType\r
)\r
{\r
EFI_STATUS Status;\r
\r
- if (Private == NULL) {\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
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
Status = HttpBootDiscoverBootInfo (Private);\r
if (EFI_ERROR (Status)) {\r
- return Status;\r
+ goto ON_EXIT;\r
}\r
}\r
\r
//\r
Status = HttpBootCreateHttpIo (Private);\r
if (EFI_ERROR (Status)) {\r
- return Status;\r
+ goto ON_EXIT;\r
}\r
}\r
\r
Private,\r
TRUE,\r
&Private->BootFileSize,\r
- NULL\r
+ NULL,\r
+ &Private->ImageType\r
);\r
if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {\r
//\r
Private,\r
FALSE,\r
&Private->BootFileSize,\r
- NULL\r
+ NULL,\r
+ &Private->ImageType\r
);\r
if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {\r
- return Status;\r
+ goto ON_EXIT;\r
}\r
}\r
}\r
\r
if (*BufferSize < Private->BootFileSize) {\r
*BufferSize = Private->BootFileSize;\r
- return EFI_BUFFER_TOO_SMALL;\r
+ *ImageType = Private->ImageType;\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
- );\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
}\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
+ \r
+ HttpBootFreeCacheList (Private);\r
+ \r
return EFI_SUCCESS;\r
}\r
\r
BOOLEAN MediaPresent;\r
BOOLEAN UsingIpv6;\r
EFI_STATUS Status;\r
+ HTTP_BOOT_IMAGE_TYPE ImageType;\r
\r
- if (This == NULL || BufferSize == NULL) {\r
+ if (This == NULL || BufferSize == NULL || FilePath == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
\r
VirtualNic = HTTP_BOOT_VIRTUAL_NIC_FROM_LOADFILE (This);\r
Private = VirtualNic->Private;\r
- UsingIpv6 = FALSE;\r
\r
//\r
// Check media status before HTTP boot start\r
if (!MediaPresent) {\r
return EFI_NO_MEDIA;\r
}\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
- // Initialize HTTP boot and load the boot file.\r
+ // Load the boot file.\r
//\r
- Status = HttpBootStart (Private, UsingIpv6);\r
- if (Status == EFI_ALREADY_STARTED && UsingIpv6 != Private->UsingIpv6) {\r
- //\r
- // Http boot Driver has already been started but not on the required IP version, restart it.\r
- //\r
- Status = HttpBootStop (Private);\r
- if (!EFI_ERROR (Status)) {\r
- Status = HttpBootStart (Private, UsingIpv6);\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
- }\r
- if (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED) {\r
- Status = HttpBootLoadFile (Private, BufferSize, Buffer);\r
+ return Status;\r
}\r
\r
- if (Status != EFI_SUCCESS && Status != EFI_BUFFER_TOO_SMALL) {\r
- HttpBootStop (Private);\r
- } else {\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
- } 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
+ // 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
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
projects / mirror_edk2.git / blobdiff