/** @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
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 HTTP_BOOT_PRIVATE_DATA *Private,\r
+ IN BOOLEAN UsingIpv6,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *FilePath\r
)\r
{\r
- UINTN Index;\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
+ // 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
- //\r
- // Init the content of cached DHCP offer list.\r
- //\r
- ZeroMem (Private->OfferBuffer, sizeof (Private->OfferBuffer));\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
}\r
} else {\r
- ASSERT (FALSE);\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
+ }\r
}\r
\r
- Private->Started = TRUE;\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 sequence to retrieve the boot resource information.\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
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
- ASSERT (FALSE);\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
@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
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
\r
if (*BufferSize < Private->BootFileSize) {\r
*BufferSize = Private->BootFileSize;\r
+ *ImageType = Private->ImageType;\r
return EFI_BUFFER_TOO_SMALL;\r
}\r
\r
Private,\r
FALSE,\r
BufferSize,\r
- Buffer\r
+ Buffer,\r
+ ImageType\r
);\r
}\r
\r
Private->BootFileUriParser = NULL;\r
Private->BootFileSize = 0;\r
Private->SelectIndex = 0;\r
- Private->SelectProxyType = HttpOfferTypeMax;\r
+ Private->SelectProxyType = HttpOfferTypeMax; \r
\r
if (!Private->UsingIpv6) {\r
//\r
}\r
}\r
} else {\r
- ASSERT (FALSE);\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
+ \r
+ HttpBootFreeCacheList (Private);\r
+ \r
return EFI_SUCCESS;\r
}\r
\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) {\r
+ if (This == NULL || BufferSize == NULL || FilePath == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
return EFI_UNSUPPORTED;\r
}\r
\r
- Private = HTTP_BOOT_PRIVATE_DATA_FROM_LOADFILE (This);\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
if (!MediaPresent) {\r
return EFI_NO_MEDIA;\r
}\r
-\r
+ \r
//\r
- // Initialize HTTP boot and load the boot file.\r
+ // Check whether the virtual nic is using IPv6 or not.\r
//\r
- Status = HttpBootStart (Private);\r
- if (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED) {\r
- Status = HttpBootLoadFile (Private, BufferSize, Buffer);\r
+ UsingIpv6 = FALSE;\r
+ if (VirtualNic == Private->Ip6Nic) {\r
+ UsingIpv6 = TRUE;\r
}\r
\r
- if (Status != EFI_SUCCESS && Status != EFI_BUFFER_TOO_SMALL) {\r
- HttpBootStop (Private);\r
- } else {\r
- //\r
- // Stop and release the DHCP4 child.\r
- //\r
- Private->Dhcp4->Stop (Private->Dhcp4);\r
- Private->Dhcp4->Configure (Private->Dhcp4, NULL);\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
return Status;\r
}\r
\r
projects / mirror_edk2.git / blobdiff