/** @file\r
Support functions implementation for UEFI HTTP boot driver.\r
\r
-Copyright (c) 2015, Intel Corporation. All rights reserved.<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
+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
http://opensource.org/licenses/bsd-license.php. \r
\r
{\r
UINTN Remainder;\r
\r
- while (Length > 0) {\r
- Length--;\r
+ for (; Length > 0; Length--) {\r
Remainder = Number % 10;\r
Number /= 10;\r
- Buffer[Length] = (UINT8) ('0' + Remainder);\r
+ Buffer[Length - 1] = (UINT8) ('0' + Remainder);\r
}\r
}\r
\r
\r
case HTTP_STATUS_307_TEMPORARY_REDIRECT:\r
AsciiPrint ("\n Redirection: 307 Temporary Redirect");\r
+ break;\r
+\r
+ case HTTP_STATUS_308_PERMANENT_REDIRECT:\r
+ AsciiPrint ("\n Redirection: 308 Permanent Redirect");\r
break; \r
\r
case HTTP_STATUS_400_BAD_REQUEST:\r
//\r
Status = NetLibCreateServiceChild (\r
Private->Controller,\r
- Private->Image,\r
+ Private->Ip6Nic->ImageHandle,\r
&gEfiDns6ServiceBindingProtocolGuid,\r
&Dns6Handle\r
);\r
Dns6Handle,\r
&gEfiDns6ProtocolGuid,\r
(VOID **) &Dns6,\r
- Private->Image,\r
+ Private->Ip6Nic->ImageHandle,\r
Private->Controller,\r
EFI_OPEN_PROTOCOL_BY_DRIVER\r
);\r
gBS->CloseProtocol (\r
Dns6Handle,\r
&gEfiDns6ProtocolGuid,\r
- Private->Image,\r
+ Private->Ip6Nic->ImageHandle,\r
Private->Controller\r
);\r
}\r
if (Dns6Handle != NULL) {\r
NetLibDestroyServiceChild (\r
Private->Controller,\r
- Private->Image,\r
+ Private->Ip6Nic->ImageHandle,\r
&gEfiDns6ServiceBindingProtocolGuid,\r
Dns6Handle\r
);\r
}\r
}\r
\r
-/**\r
- Find a specified header field according to the field name.\r
-\r
- @param[in] HeaderCount Number of HTTP header structures in Headers list. \r
- @param[in] Headers Array containing list of HTTP headers.\r
- @param[in] FieldName Null terminated string which describes a field name. \r
-\r
- @return Pointer to the found header or NULL.\r
-\r
-**/\r
-EFI_HTTP_HEADER *\r
-HttpBootFindHeader (\r
- IN UINTN HeaderCount,\r
- IN EFI_HTTP_HEADER *Headers,\r
- IN CHAR8 *FieldName\r
- )\r
-{\r
- UINTN Index;\r
- \r
- if (HeaderCount == 0 || Headers == NULL || FieldName == NULL) {\r
- return NULL;\r
- }\r
-\r
- for (Index = 0; Index < HeaderCount; Index++){\r
- //\r
- // Field names are case-insensitive (RFC 2616).\r
- //\r
- if (AsciiStriCmp (Headers[Index].FieldName, FieldName) == 0) {\r
- return &Headers[Index];\r
- }\r
- }\r
- return NULL;\r
-}\r
-\r
/**\r
Set or update a HTTP header with the field name and corresponding value.\r
\r
@param[in] HttpIoHeader Point to the HTTP header holder.\r
- @param[in] FieldName Null terminated string which describes a field name. \r
+ @param[in] FieldName Null terminated string which describes a field name.\r
@param[in] FieldValue Null terminated string which describes the corresponding field value.\r
\r
@retval EFI_SUCCESS The HTTP header has been set or updated.\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- Header = HttpBootFindHeader (HttpIoHeader->HeaderCount, HttpIoHeader->Headers, FieldName);\r
+ Header = HttpFindHeader (HttpIoHeader->HeaderCount, HttpIoHeader->Headers, FieldName);\r
if (Header == NULL) {\r
//\r
// Add a new header.\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Notify the callback function when an event is triggered.\r
+\r
+ @param[in] Context The opaque parameter to the function.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HttpIoNotifyDpc (\r
+ IN VOID *Context\r
+ )\r
+{\r
+ *((BOOLEAN *) Context) = TRUE;\r
+}\r
+\r
+/**\r
+ Request HttpIoNotifyDpc as a DPC at TPL_CALLBACK.\r
+\r
+ @param[in] Event The event signaled.\r
+ @param[in] Context The opaque parameter to the function.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HttpIoNotify (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
+{\r
+ //\r
+ // Request HttpIoNotifyDpc as a DPC at TPL_CALLBACK\r
+ //\r
+ QueueDpc (TPL_CALLBACK, HttpIoNotifyDpc, Context);\r
+}\r
+\r
/**\r
Create a HTTP_IO to access the HTTP service. It will create and configure\r
a HTTP child handle.\r
@param[in] Controller The handle of the controller.\r
@param[in] IpVersion IP_VERSION_4 or IP_VERSION_6.\r
@param[in] ConfigData The HTTP_IO configuration data.\r
+ @param[in] Callback Callback function which will be invoked when specified\r
+ HTTP_IO_CALLBACK_EVENT happened.\r
+ @param[in] Context The Context data which will be passed to the Callback function.\r
@param[out] HttpIo The HTTP_IO.\r
\r
@retval EFI_SUCCESS The HTTP_IO is created and configured.\r
IN EFI_HANDLE Controller,\r
IN UINT8 IpVersion,\r
IN HTTP_IO_CONFIG_DATA *ConfigData,\r
+ IN HTTP_IO_CALLBACK Callback,\r
+ IN VOID *Context,\r
OUT HTTP_IO *HttpIo\r
)\r
{\r
HttpIo->Controller = Controller;\r
HttpIo->IpVersion = IpVersion;\r
HttpIo->Http = Http;\r
+ HttpIo->Callback = Callback;\r
+ HttpIo->Context = Context;\r
\r
ZeroMem (&HttpConfigData, sizeof (EFI_HTTP_CONFIG_DATA));\r
HttpConfigData.HttpVersion = HttpVersion11;\r
Status = gBS->CreateEvent (\r
EVT_NOTIFY_SIGNAL,\r
TPL_NOTIFY,\r
- HttpBootCommonNotify,\r
+ HttpIoNotify,\r
&HttpIo->IsTxDone,\r
&Event\r
);\r
Status = gBS->CreateEvent (\r
EVT_NOTIFY_SIGNAL,\r
TPL_NOTIFY,\r
- HttpBootCommonNotify,\r
+ HttpIoNotify,\r
&HttpIo->IsRxDone,\r
&Event\r
);\r
HttpIo->RspToken.Event = Event;\r
HttpIo->RspToken.Message = &HttpIo->RspMessage;\r
\r
+ //\r
+ // Create TimeoutEvent for response\r
+ //\r
+ Status = gBS->CreateEvent (\r
+ EVT_TIMER,\r
+ TPL_CALLBACK,\r
+ NULL,\r
+ NULL,\r
+ &Event\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_ERROR;\r
+ }\r
+ HttpIo->TimeoutEvent = Event;\r
+\r
return EFI_SUCCESS;\r
\r
ON_ERROR:\r
if (Event != NULL) {\r
gBS->CloseEvent (Event);\r
}\r
+\r
+ Event = HttpIo->TimeoutEvent;\r
+ if (Event != NULL) {\r
+ gBS->CloseEvent (Event);\r
+ }\r
\r
Http = HttpIo->Http;\r
if (Http != NULL) {\r
HttpIo->ReqToken.Message->BodyLength = BodyLength;\r
HttpIo->ReqToken.Message->Body = Body;\r
\r
+ if (HttpIo->Callback != NULL) {\r
+ Status = HttpIo->Callback (\r
+ HttpIoRequest,\r
+ HttpIo->ReqToken.Message,\r
+ HttpIo->Context\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ }\r
+\r
//\r
// Queue the request token to HTTP instances.\r
//\r
FALSE to continue receive the previous response message.\r
@param[out] ResponseData Point to a wrapper of the received response data.\r
\r
- @retval EFI_SUCCESS The HTTP resopnse is received.\r
+ @retval EFI_SUCCESS The HTTP response is received.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.\r
HttpIoRecvResponse (\r
IN HTTP_IO *HttpIo,\r
IN BOOLEAN RecvMsgHeader,\r
- OUT HTTP_IO_RESOPNSE_DATA *ResponseData\r
+ OUT HTTP_IO_RESPONSE_DATA *ResponseData\r
)\r
{\r
EFI_STATUS Status;\r
EFI_HTTP_PROTOCOL *Http;\r
- EFI_HTTP_STATUS_CODE StatusCode;\r
\r
if (HttpIo == NULL || HttpIo->Http == NULL || ResponseData == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
+ //\r
+ // Start the timer, and wait Timeout seconds to receive the header packet.\r
+ //\r
+ Status = gBS->SetTimer (HttpIo->TimeoutEvent, TimerRelative, HTTP_BOOT_RESPONSE_TIMEOUT * TICKS_PER_MS);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
//\r
// Queue the response token to HTTP instances.\r
//\r
);\r
\r
if (EFI_ERROR (Status)) {\r
+ gBS->SetTimer (HttpIo->TimeoutEvent, TimerCancel, 0);\r
return Status;\r
}\r
\r
//\r
// Poll the network until receive finish.\r
//\r
- while (!HttpIo->IsRxDone) {\r
+ while (!HttpIo->IsRxDone && ((HttpIo->TimeoutEvent == NULL) || EFI_ERROR (gBS->CheckEvent (HttpIo->TimeoutEvent)))) {\r
Http->Poll (Http);\r
}\r
\r
+ gBS->SetTimer (HttpIo->TimeoutEvent, TimerCancel, 0);\r
+\r
+ if (!HttpIo->IsRxDone) {\r
+ //\r
+ // Timeout occurs, cancel the response token.\r
+ //\r
+ Http->Cancel (Http, &HttpIo->RspToken);\r
+ \r
+ Status = EFI_TIMEOUT;\r
+ \r
+ return Status;\r
+ } else {\r
+ HttpIo->IsRxDone = FALSE;\r
+ }\r
+\r
+ if (!EFI_ERROR (HttpIo->RspToken.Status) && HttpIo->Callback != NULL) {\r
+ Status = HttpIo->Callback (\r
+ HttpIoResponse,\r
+ HttpIo->RspToken.Message,\r
+ HttpIo->Context\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ }\r
+\r
//\r
// Store the received data into the wrapper.\r
//\r
- Status = HttpIo->RspToken.Status;\r
- if (!EFI_ERROR (Status)) {\r
- ResponseData->HeaderCount = HttpIo->RspToken.Message->HeaderCount;\r
- ResponseData->Headers = HttpIo->RspToken.Message->Headers;\r
- ResponseData->BodyLength = HttpIo->RspToken.Message->BodyLength;\r
+ ResponseData->Status = HttpIo->RspToken.Status;\r
+ ResponseData->HeaderCount = HttpIo->RspToken.Message->HeaderCount;\r
+ ResponseData->Headers = HttpIo->RspToken.Message->Headers;\r
+ ResponseData->BodyLength = HttpIo->RspToken.Message->BodyLength;\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+ This function checks the HTTP(S) URI scheme.\r
+\r
+ @param[in] Uri The pointer to the URI string.\r
+ \r
+ @retval EFI_SUCCESS The URI scheme is valid.\r
+ @retval EFI_INVALID_PARAMETER The URI scheme is not HTTP or HTTPS.\r
+ @retval EFI_ACCESS_DENIED HTTP is disabled and the URI is HTTP.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootCheckUriScheme (\r
+ IN CHAR8 *Uri\r
+ )\r
+{\r
+ UINTN Index;\r
+ EFI_STATUS Status;\r
+\r
+ Status = EFI_SUCCESS;\r
+\r
+ //\r
+ // Convert the scheme to all lower case.\r
+ //\r
+ for (Index = 0; Index < AsciiStrLen (Uri); Index++) {\r
+ if (Uri[Index] == ':') {\r
+ break;\r
+ }\r
+ if (Uri[Index] >= 'A' && Uri[Index] <= 'Z') {\r
+ Uri[Index] -= (CHAR8)('A' - 'a');\r
+ }\r
+ }\r
+\r
+ //\r
+ // Return EFI_INVALID_PARAMETER if the URI is not HTTP or HTTPS.\r
+ //\r
+ if ((AsciiStrnCmp (Uri, "http://", 7) != 0) && (AsciiStrnCmp (Uri, "https://", 8) != 0)) {\r
+ DEBUG ((EFI_D_ERROR, "HttpBootCheckUriScheme: Invalid Uri.\n"));\r
+ return EFI_INVALID_PARAMETER;\r
}\r
\r
- if (RecvMsgHeader) {\r
- StatusCode = HttpIo->RspToken.Message->Data.Response->StatusCode;\r
- HttpBootPrintErrorMessage (StatusCode);\r
+ //\r
+ // HTTP is disabled, return EFI_ACCESS_DENIED if the URI is HTTP.\r
+ //\r
+ if (!PcdGetBool (PcdAllowHttpConnections) && (AsciiStrnCmp (Uri, "http://", 7) == 0)) {\r
+ DEBUG ((EFI_D_ERROR, "HttpBootCheckUriScheme: HTTP is disabled.\n"));\r
+ return EFI_ACCESS_DENIED;\r
+ }\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+ Get the URI address string from the input device path.\r
+\r
+ Caller need to free the buffer in the UriAddress pointer.\r
+ \r
+ @param[in] FilePath Pointer to the device path which contains a URI device path node.\r
+ @param[out] UriAddress The URI address string extract from the device path.\r
+ \r
+ @retval EFI_SUCCESS The URI string is returned.\r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootParseFilePath (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
+ OUT CHAR8 **UriAddress\r
+ )\r
+{\r
+ EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
+ URI_DEVICE_PATH *UriDevicePath;\r
+ CHAR8 *Uri;\r
+ UINTN UriStrLength;\r
+\r
+ if (FilePath == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ *UriAddress = NULL;\r
+\r
+ //\r
+ // Extract the URI address from the FilePath\r
+ //\r
+ TempDevicePath = FilePath;\r
+ while (!IsDevicePathEnd (TempDevicePath)) {\r
+ if ((DevicePathType (TempDevicePath) == MESSAGING_DEVICE_PATH) &&\r
+ (DevicePathSubType (TempDevicePath) == MSG_URI_DP)) {\r
+ UriDevicePath = (URI_DEVICE_PATH*) TempDevicePath;\r
+ //\r
+ // UEFI Spec doesn't require the URI to be a NULL-terminated string\r
+ // So we allocate a new buffer and always append a '\0' to it.\r
+ //\r
+ UriStrLength = DevicePathNodeLength (UriDevicePath) - sizeof(EFI_DEVICE_PATH_PROTOCOL);\r
+ if (UriStrLength == 0) {\r
+ //\r
+ // return a NULL UriAddress if it's a empty URI device path node.\r
+ //\r
+ break;\r
+ }\r
+ Uri = AllocatePool (UriStrLength + 1);\r
+ if (Uri == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ CopyMem (Uri, UriDevicePath->Uri, DevicePathNodeLength (UriDevicePath) - sizeof(EFI_DEVICE_PATH_PROTOCOL));\r
+ Uri[DevicePathNodeLength (UriDevicePath) - sizeof(EFI_DEVICE_PATH_PROTOCOL)] = '\0';\r
+\r
+ *UriAddress = Uri;\r
+ }\r
+ TempDevicePath = NextDevicePathNode (TempDevicePath);\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ This function returns the image type according to server replied HTTP message\r
+ and also the image's URI info.\r
+\r
+ @param[in] Uri The pointer to the image's URI string.\r
+ @param[in] UriParser URI Parse result returned by NetHttpParseUrl(). \r
+ @param[in] HeaderCount Number of HTTP header structures in Headers list. \r
+ @param[in] Headers Array containing list of HTTP headers.\r
+ @param[out] ImageType The image type of the downloaded file.\r
+ \r
+ @retval EFI_SUCCESS The image type is returned in ImageType.\r
+ @retval EFI_INVALID_PARAMETER ImageType, Uri or UriParser is NULL.\r
+ @retval EFI_INVALID_PARAMETER HeaderCount is not zero, and Headers is NULL.\r
+ @retval EFI_NOT_FOUND Failed to identify the image type.\r
+ @retval Others Unexpect error happened.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootCheckImageType (\r
+ IN CHAR8 *Uri,\r
+ IN VOID *UriParser,\r
+ IN UINTN HeaderCount,\r
+ IN EFI_HTTP_HEADER *Headers,\r
+ OUT HTTP_BOOT_IMAGE_TYPE *ImageType\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_HTTP_HEADER *Header;\r
+ CHAR8 *FilePath;\r
+ CHAR8 *FilePost;\r
+\r
+ if (Uri == NULL || UriParser == NULL || ImageType == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ if (HeaderCount != 0 && Headers == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Determine the image type by the HTTP Content-Type header field first.\r
+ // "application/efi" -> EFI Image\r
+ // "application/vnd.efi-iso" -> CD/DVD Image\r
+ // "application/vnd.efi-img" -> Virtual Disk Image\r
+ //\r
+ Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_CONTENT_TYPE);\r
+ if (Header != NULL) {\r
+ if (AsciiStriCmp (Header->FieldValue, HTTP_CONTENT_TYPE_APP_EFI) == 0) {\r
+ *ImageType = ImageTypeEfi;\r
+ return EFI_SUCCESS;\r
+ } else if (AsciiStriCmp (Header->FieldValue, HTTP_CONTENT_TYPE_APP_ISO) == 0) {\r
+ *ImageType = ImageTypeVirtualCd;\r
+ return EFI_SUCCESS;\r
+ } else if (AsciiStriCmp (Header->FieldValue, HTTP_CONTENT_TYPE_APP_IMG) == 0) {\r
+ *ImageType = ImageTypeVirtualDisk;\r
+ return EFI_SUCCESS;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Determine the image type by file extension:\r
+ // *.efi -> EFI Image\r
+ // *.iso -> CD/DVD Image\r
+ // *.img -> Virtual Disk Image\r
+ //\r
+ Status = HttpUrlGetPath (\r
+ Uri,\r
+ UriParser,\r
+ &FilePath\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ FilePost = FilePath + AsciiStrLen (FilePath) - 4;\r
+ if (AsciiStrCmp (FilePost, ".efi") == 0) {\r
+ *ImageType = ImageTypeEfi;\r
+ } else if (AsciiStrCmp (FilePost, ".iso") == 0) {\r
+ *ImageType = ImageTypeVirtualCd;\r
+ } else if (AsciiStrCmp (FilePost, ".img") == 0) {\r
+ *ImageType = ImageTypeVirtualDisk;\r
+ } else {\r
+ *ImageType = ImageTypeMax;\r
+ }\r
+\r
+ FreePool (FilePath);\r
+\r
+ return (*ImageType < ImageTypeMax) ? EFI_SUCCESS : EFI_NOT_FOUND;\r
+}\r
+\r
+/**\r
+ This function register the RAM disk info to the system.\r
+ \r
+ @param[in] Private The pointer to the driver's private data.\r
+ @param[in] BufferSize The size of Buffer in bytes.\r
+ @param[in] Buffer The base address of the RAM disk.\r
+ @param[in] ImageType The image type of the file in Buffer.\r
+\r
+ @retval EFI_SUCCESS The RAM disk has been registered.\r
+ @retval EFI_NOT_FOUND No RAM disk protocol instances were found.\r
+ @retval EFI_UNSUPPORTED The ImageType is not supported.\r
+ @retval Others Unexpected error happened.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootRegisterRamDisk (\r
+ IN HTTP_BOOT_PRIVATE_DATA *Private,\r
+ IN UINTN BufferSize,\r
+ IN VOID *Buffer,\r
+ IN HTTP_BOOT_IMAGE_TYPE ImageType\r
+ )\r
+{\r
+ EFI_RAM_DISK_PROTOCOL *RamDisk;\r
+ EFI_STATUS Status;\r
+ EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
+ EFI_GUID *RamDiskType;\r
+ \r
+ ASSERT (Private != NULL);\r
+ ASSERT (Buffer != NULL);\r
+ ASSERT (BufferSize != 0);\r
+\r
+ Status = gBS->LocateProtocol (&gEfiRamDiskProtocolGuid, NULL, (VOID**) &RamDisk);\r
+ if (EFI_ERROR (Status)) {\r
+ DEBUG ((EFI_D_ERROR, "HTTP Boot: Couldn't find the RAM Disk protocol - %r\n", Status));\r
+ return Status;\r
+ }\r
+\r
+ if (ImageType == ImageTypeVirtualCd) {\r
+ RamDiskType = &gEfiVirtualCdGuid;\r
+ } else if (ImageType == ImageTypeVirtualDisk) {\r
+ RamDiskType = &gEfiVirtualDiskGuid;\r
+ } else {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ \r
+ Status = RamDisk->Register (\r
+ (UINTN)Buffer,\r
+ (UINT64)BufferSize,\r
+ RamDiskType,\r
+ Private->UsingIpv6 ? Private->Ip6Nic->DevicePath : Private->Ip4Nic->DevicePath,\r
+ &DevicePath\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ DEBUG ((EFI_D_ERROR, "HTTP Boot: Failed to register RAM Disk - %r\n", Status));\r
}\r
\r
return Status;\r
}\r
+\r
projects / mirror_edk2.git / blobdiff