/**
Enable the use of UEFI HTTP boot function.
If the driver has already been started but not satisfy the requirement (IP stack and
specified boot file path), this function will stop the driver and start it again.
@param[in] Private The pointer to the driver's private data.
@param[in] UsingIpv6 Specifies the type of IP addresses that are to be
used during the session that is being started.
Set to TRUE for IPv6, and FALSE for IPv4.
@param[in] FilePath The device specific path of the file to load.
@retval EFI_SUCCESS HTTP boot was successfully enabled.
@retval EFI_INVALID_PARAMETER Private is NULL or FilePath is NULL.
@retval EFI_INVALID_PARAMETER The FilePath doesn't contain a valid URI device path node.
@retval EFI_ALREADY_STARTED The driver is already in started state.
@retval EFI_OUT_OF_RESOURCES There are not enough resources.
**/
EFI_STATUS
HttpBootStart (
IN HTTP_BOOT_PRIVATE_DATA *Private,
IN BOOLEAN UsingIpv6,
IN EFI_DEVICE_PATH_PROTOCOL *FilePath
)
{
UINTN Index;
EFI_STATUS Status;
CHAR8 *Uri;
if (Private == NULL || FilePath == NULL) {
return EFI_INVALID_PARAMETER;
}
//
// Check the URI in the input FilePath, in order to see whether it is
// required to boot from a new specified boot file.
//
Status = HttpBootParseFilePath (FilePath, &Uri);
if (EFI_ERROR (Status)) {
return EFI_INVALID_PARAMETER;
}
//
// Check whether we need to stop and restart the HTTP boot driver.
//
if (Private->Started) {
//
// Restart is needed in 2 cases:
// 1. Http boot driver has already been started but not on the required IP stack.
// 2. The specified boot file URI in FilePath is different with the one we have
// recorded before.
//
if ((UsingIpv6 != Private->UsingIpv6) ||
((Uri != NULL) && (AsciiStrCmp (Private->BootFileUri, Uri) != 0))) {
//
// Restart is required, first stop then continue this start function.
//
Status = HttpBootStop (Private);
if (EFI_ERROR (Status)) {
return Status;
}
} else {
//
// Restart is not required.
//
if (Uri != NULL) {
FreePool (Uri);
}
return EFI_ALREADY_STARTED;
}
}
//
// Detect whether using ipv6 or not, and set it to the private data.
//
if (UsingIpv6 && Private->Ip6Nic != NULL) {
Private->UsingIpv6 = TRUE;
} else if (!UsingIpv6 && Private->Ip4Nic != NULL) {
Private->UsingIpv6 = FALSE;
} else {
if (Uri != NULL) {
FreePool (Uri);
}
return EFI_UNSUPPORTED;
}
//
// Record the specified URI and prepare the URI parser if needed.
//
Private->FilePathUri = Uri;
if (Private->FilePathUri != NULL) {
Status = HttpParseUrl (
Private->FilePathUri,
(UINT32) AsciiStrLen (Private->FilePathUri),
FALSE,
&Private->FilePathUriParser
);
if (EFI_ERROR (Status)) {
FreePool (Private->FilePathUri);
return Status;
}
}
//
// Init the content of cached DHCP offer list.
//
ZeroMem (Private->OfferBuffer, sizeof (Private->OfferBuffer));
if (!Private->UsingIpv6) {
for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {
Private->OfferBuffer[Index].Dhcp4.Packet.Offer.Size = HTTP_BOOT_DHCP4_PACKET_MAX_SIZE;
}
} else {
for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {
Private->OfferBuffer[Index].Dhcp6.Packet.Offer.Size = HTTP_BOOT_DHCP6_PACKET_MAX_SIZE;
}
}
if (Private->UsingIpv6) {
//
// Set Ip6 policy to Automatic to start the Ip6 router discovery.
//
Status = HttpBootSetIp6Policy (Private);
if (EFI_ERROR (Status)) {
return Status;
}
}
Private->Started = TRUE;
return EFI_SUCCESS;
}
/**
Enable the use of UEFI HTTP boot function.
@param[in] Private The pointer to the driver's private data.
@param[in] UsingIpv6 Specifies the type of IP addresses that are to be
used during the session that is being started.
Set to TRUE for IPv6, and FALSE for IPv4.
@param[in] FilePath The device specific path of the file to load.
@retval EFI_SUCCESS HTTP boot was successfully enabled.
@retval EFI_INVALID_PARAMETER Private is NULL.
@retval EFI_ALREADY_STARTED The driver is already in started state.
@retval EFI_OUT_OF_RESOURCES There are not enough resources.
**/
EFI_STATUS
HttpBootStart (
IN HTTP_BOOT_PRIVATE_DATA *Private,
IN BOOLEAN UsingIpv6,
IN EFI_DEVICE_PATH_PROTOCOL *FilePath
)
{
UINTN Index;
EFI_STATUS Status;
if (Private == NULL || FilePath == NULL) {
return EFI_INVALID_PARAMETER;
}
if (Private->Started) {
return EFI_ALREADY_STARTED;
}
//
// Detect whether using ipv6 or not, and set it to the private data.
//
if (UsingIpv6 && Private->Ip6Nic != NULL) {
Private->UsingIpv6 = TRUE;
} else if (!UsingIpv6 && Private->Ip4Nic != NULL) {
Private->UsingIpv6 = FALSE;
} else {
return EFI_UNSUPPORTED;
}
//
// Check whether the URI address is specified.
//
Status = HttpBootParseFilePath (FilePath, &Private->FilePathUri);
if (EFI_ERROR (Status)) {
return EFI_INVALID_PARAMETER;
}
if (Private->FilePathUri != NULL) {
Status = HttpParseUrl (
Private->FilePathUri,
(UINT32) AsciiStrLen (Private->FilePathUri),
FALSE,
&Private->FilePathUriParser
);
if (EFI_ERROR (Status)) {
return Status;
}
}
//
// Init the content of cached DHCP offer list.
//
ZeroMem (Private->OfferBuffer, sizeof (Private->OfferBuffer));
if (!Private->UsingIpv6) {
for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {
Private->OfferBuffer[Index].Dhcp4.Packet.Offer.Size = HTTP_BOOT_DHCP4_PACKET_MAX_SIZE;
}
} else {
for (Index = 0; Index < HTTP_BOOT_OFFER_MAX_NUM; Index++) {
Private->OfferBuffer[Index].Dhcp6.Packet.Offer.Size = HTTP_BOOT_DHCP6_PACKET_MAX_SIZE;
}
}
if (Private->UsingIpv6) {
//
// Set Ip6 policy to Automatic to start the Ip6 router discovery.
//
Status = HttpBootSetIp6Policy (Private);
if (EFI_ERROR (Status)) {
return Status;
}
}
Private->Started = TRUE;
return EFI_SUCCESS;
}
