Support functions implementation for UEFI HTTP boot driver.\r
\r
Copyright (c) 2015 - 2018, 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
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+(C) Copyright 2016 - 2020 Hewlett Packard Enterprise Development LP<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
return Status;\r
}\r
-/**\r
- Create a HTTP_IO_HEADER to hold the HTTP header items.\r
-\r
- @param[in] MaxHeaderCount The maximun number of HTTP header in this holder.\r
-\r
- @return A pointer of the HTTP header holder or NULL if failed.\r
-\r
-**/\r
-HTTP_IO_HEADER *\r
-HttpBootCreateHeader (\r
- UINTN MaxHeaderCount\r
- )\r
-{\r
- HTTP_IO_HEADER *HttpIoHeader;\r
-\r
- if (MaxHeaderCount == 0) {\r
- return NULL;\r
- }\r
-\r
- HttpIoHeader = AllocateZeroPool (sizeof (HTTP_IO_HEADER) + MaxHeaderCount * sizeof (EFI_HTTP_HEADER));\r
- if (HttpIoHeader == NULL) {\r
- return NULL;\r
- }\r
-\r
- HttpIoHeader->MaxHeaderCount = MaxHeaderCount;\r
- HttpIoHeader->Headers = (EFI_HTTP_HEADER *) (HttpIoHeader + 1);\r
-\r
- return HttpIoHeader;\r
-}\r
-\r
-/**\r
- Destroy the HTTP_IO_HEADER and release the resouces.\r
-\r
- @param[in] HttpIoHeader Point to the HTTP header holder to be destroyed.\r
-\r
-**/\r
-VOID\r
-HttpBootFreeHeader (\r
- IN HTTP_IO_HEADER *HttpIoHeader\r
- )\r
-{\r
- UINTN Index;\r
-\r
- if (HttpIoHeader != NULL) {\r
- if (HttpIoHeader->HeaderCount != 0) {\r
- for (Index = 0; Index < HttpIoHeader->HeaderCount; Index++) {\r
- FreePool (HttpIoHeader->Headers[Index].FieldName);\r
- FreePool (HttpIoHeader->Headers[Index].FieldValue);\r
- }\r
- }\r
- FreePool (HttpIoHeader);\r
- }\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] FieldValue Null terminated string which describes the corresponding field value.\r
-\r
- @retval EFI_SUCCESS The HTTP header has been set or updated.\r
- @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
- @retval EFI_OUT_OF_RESOURCES Insufficient resource to complete the operation.\r
- @retval Other Unexpected error happened.\r
-\r
-**/\r
-EFI_STATUS\r
-HttpBootSetHeader (\r
- IN HTTP_IO_HEADER *HttpIoHeader,\r
- IN CHAR8 *FieldName,\r
- IN CHAR8 *FieldValue\r
- )\r
-{\r
- EFI_HTTP_HEADER *Header;\r
- UINTN StrSize;\r
- CHAR8 *NewFieldValue;\r
-\r
- if (HttpIoHeader == NULL || FieldName == NULL || FieldValue == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- Header = HttpFindHeader (HttpIoHeader->HeaderCount, HttpIoHeader->Headers, FieldName);\r
- if (Header == NULL) {\r
- //\r
- // Add a new header.\r
- //\r
- if (HttpIoHeader->HeaderCount >= HttpIoHeader->MaxHeaderCount) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
- Header = &HttpIoHeader->Headers[HttpIoHeader->HeaderCount];\r
-\r
- StrSize = AsciiStrSize (FieldName);\r
- Header->FieldName = AllocatePool (StrSize);\r
- if (Header->FieldName == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
- CopyMem (Header->FieldName, FieldName, StrSize);\r
- Header->FieldName[StrSize -1] = '\0';\r
-\r
- StrSize = AsciiStrSize (FieldValue);\r
- Header->FieldValue = AllocatePool (StrSize);\r
- if (Header->FieldValue == NULL) {\r
- FreePool (Header->FieldName);\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
- CopyMem (Header->FieldValue, FieldValue, StrSize);\r
- Header->FieldValue[StrSize -1] = '\0';\r
-\r
- HttpIoHeader->HeaderCount++;\r
- } else {\r
- //\r
- // Update an existing one.\r
- //\r
- StrSize = AsciiStrSize (FieldValue);\r
- NewFieldValue = AllocatePool (StrSize);\r
- if (NewFieldValue == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
- CopyMem (NewFieldValue, FieldValue, StrSize);\r
- NewFieldValue[StrSize -1] = '\0';\r
-\r
- if (Header->FieldValue != NULL) {\r
- FreePool (Header->FieldValue);\r
- }\r
- Header->FieldValue = NewFieldValue;\r
- }\r
-\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
-\r
- @param[in] Image The handle of the driver image.\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
- @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
- @retval EFI_UNSUPPORTED One or more of the control options are not\r
- supported in the implementation.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval Others Failed to create the HTTP_IO or configure it.\r
-\r
-**/\r
-EFI_STATUS\r
-HttpIoCreateIo (\r
- IN EFI_HANDLE Image,\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
- EFI_STATUS Status;\r
- EFI_HTTP_CONFIG_DATA HttpConfigData;\r
- EFI_HTTPv4_ACCESS_POINT Http4AccessPoint;\r
- EFI_HTTPv6_ACCESS_POINT Http6AccessPoint;\r
- EFI_HTTP_PROTOCOL *Http;\r
- EFI_EVENT Event;\r
-\r
- if ((Image == NULL) || (Controller == NULL) || (ConfigData == NULL) || (HttpIo == NULL)) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- if (IpVersion != IP_VERSION_4 && IpVersion != IP_VERSION_6) {\r
- return EFI_UNSUPPORTED;\r
- }\r
-\r
- ZeroMem (HttpIo, sizeof (HTTP_IO));\r
-\r
- //\r
- // Create the HTTP child instance and get the HTTP protocol.\r
- //\r
- Status = NetLibCreateServiceChild (\r
- Controller,\r
- Image,\r
- &gEfiHttpServiceBindingProtocolGuid,\r
- &HttpIo->Handle\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Status = gBS->OpenProtocol (\r
- HttpIo->Handle,\r
- &gEfiHttpProtocolGuid,\r
- (VOID **) &Http,\r
- Image,\r
- Controller,\r
- EFI_OPEN_PROTOCOL_BY_DRIVER\r
- );\r
- if (EFI_ERROR (Status) || (Http == NULL)) {\r
- goto ON_ERROR;\r
- }\r
-\r
- //\r
- // Init the configuration data and configure the HTTP child.\r
- //\r
- HttpIo->Image = Image;\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
- HttpConfigData.TimeOutMillisec = ConfigData->Config4.RequestTimeOut;\r
- if (HttpIo->IpVersion == IP_VERSION_4) {\r
- HttpConfigData.LocalAddressIsIPv6 = FALSE;\r
-\r
- Http4AccessPoint.UseDefaultAddress = ConfigData->Config4.UseDefaultAddress;\r
- Http4AccessPoint.LocalPort = ConfigData->Config4.LocalPort;\r
- IP4_COPY_ADDRESS (&Http4AccessPoint.LocalAddress, &ConfigData->Config4.LocalIp);\r
- IP4_COPY_ADDRESS (&Http4AccessPoint.LocalSubnet, &ConfigData->Config4.SubnetMask);\r
- HttpConfigData.AccessPoint.IPv4Node = &Http4AccessPoint;\r
- } else {\r
- HttpConfigData.LocalAddressIsIPv6 = TRUE;\r
- Http6AccessPoint.LocalPort = ConfigData->Config6.LocalPort;\r
- IP6_COPY_ADDRESS (&Http6AccessPoint.LocalAddress, &ConfigData->Config6.LocalIp);\r
- HttpConfigData.AccessPoint.IPv6Node = &Http6AccessPoint;\r
- }\r
-\r
- Status = Http->Configure (Http, &HttpConfigData);\r
- if (EFI_ERROR (Status)) {\r
- goto ON_ERROR;\r
- }\r
-\r
- //\r
- // Create events for variuos asynchronous operations.\r
- //\r
- Status = gBS->CreateEvent (\r
- EVT_NOTIFY_SIGNAL,\r
- TPL_NOTIFY,\r
- HttpIoNotify,\r
- &HttpIo->IsTxDone,\r
- &Event\r
- );\r
- if (EFI_ERROR (Status)) {\r
- goto ON_ERROR;\r
- }\r
- HttpIo->ReqToken.Event = Event;\r
- HttpIo->ReqToken.Message = &HttpIo->ReqMessage;\r
-\r
- Status = gBS->CreateEvent (\r
- EVT_NOTIFY_SIGNAL,\r
- TPL_NOTIFY,\r
- HttpIoNotify,\r
- &HttpIo->IsRxDone,\r
- &Event\r
- );\r
- if (EFI_ERROR (Status)) {\r
- goto ON_ERROR;\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
- HttpIoDestroyIo (HttpIo);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Destroy the HTTP_IO and release the resouces.\r
-\r
- @param[in] HttpIo The HTTP_IO which wraps the HTTP service to be destroyed.\r
-\r
-**/\r
-VOID\r
-HttpIoDestroyIo (\r
- IN HTTP_IO *HttpIo\r
- )\r
-{\r
- EFI_HTTP_PROTOCOL *Http;\r
- EFI_EVENT Event;\r
-\r
- if (HttpIo == NULL) {\r
- return;\r
- }\r
-\r
- Event = HttpIo->ReqToken.Event;\r
- if (Event != NULL) {\r
- gBS->CloseEvent (Event);\r
- }\r
-\r
- Event = HttpIo->RspToken.Event;\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
- Http->Configure (Http, NULL);\r
- gBS->CloseProtocol (\r
- HttpIo->Handle,\r
- &gEfiHttpProtocolGuid,\r
- HttpIo->Image,\r
- HttpIo->Controller\r
- );\r
- }\r
-\r
- NetLibDestroyServiceChild (\r
- HttpIo->Controller,\r
- HttpIo->Image,\r
- &gEfiHttpServiceBindingProtocolGuid,\r
- HttpIo->Handle\r
- );\r
-}\r
-\r
-/**\r
- Synchronously send a HTTP REQUEST message to the server.\r
-\r
- @param[in] HttpIo The HttpIo wrapping the HTTP service.\r
- @param[in] Request A pointer to storage such data as URL and HTTP method.\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] BodyLength Length in bytes of the HTTP body.\r
- @param[in] Body Body associated with the HTTP request.\r
-\r
- @retval EFI_SUCCESS The HTTP request is trasmitted.\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
- @retval Others Other errors as indicated.\r
-\r
-**/\r
-EFI_STATUS\r
-HttpIoSendRequest (\r
- IN HTTP_IO *HttpIo,\r
- IN EFI_HTTP_REQUEST_DATA *Request,\r
- IN UINTN HeaderCount,\r
- IN EFI_HTTP_HEADER *Headers,\r
- IN UINTN BodyLength,\r
- IN VOID *Body\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_HTTP_PROTOCOL *Http;\r
-\r
- if (HttpIo == NULL || HttpIo->Http == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- HttpIo->ReqToken.Status = EFI_NOT_READY;\r
- HttpIo->ReqToken.Message->Data.Request = Request;\r
- HttpIo->ReqToken.Message->HeaderCount = HeaderCount;\r
- HttpIo->ReqToken.Message->Headers = Headers;\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
- Http = HttpIo->Http;\r
- HttpIo->IsTxDone = FALSE;\r
- Status = Http->Request (\r
- Http,\r
- &HttpIo->ReqToken\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Poll the network until transmit finish.\r
- //\r
- while (!HttpIo->IsTxDone) {\r
- Http->Poll (Http);\r
- }\r
-\r
- return HttpIo->ReqToken.Status;\r
-}\r
-\r
-/**\r
- Synchronously receive a HTTP RESPONSE message from the server.\r
-\r
- @param[in] HttpIo The HttpIo wrapping the HTTP service.\r
- @param[in] RecvMsgHeader TRUE to receive a new HTTP response (from message header).\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 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
- @retval Others Other errors as indicated.\r
-\r
-**/\r
-EFI_STATUS\r
-HttpIoRecvResponse (\r
- IN HTTP_IO *HttpIo,\r
- IN BOOLEAN RecvMsgHeader,\r
- OUT HTTP_IO_RESPONSE_DATA *ResponseData\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_HTTP_PROTOCOL *Http;\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
- HttpIo->RspToken.Status = EFI_NOT_READY;\r
- if (RecvMsgHeader) {\r
- HttpIo->RspToken.Message->Data.Response = &ResponseData->Response;\r
- } else {\r
- HttpIo->RspToken.Message->Data.Response = NULL;\r
- }\r
- HttpIo->RspToken.Message->HeaderCount = 0;\r
- HttpIo->RspToken.Message->Headers = NULL;\r
- HttpIo->RspToken.Message->BodyLength = ResponseData->BodyLength;\r
- HttpIo->RspToken.Message->Body = ResponseData->Body;\r
-\r
- Http = HttpIo->Http;\r
- HttpIo->IsRxDone = FALSE;\r
- Status = Http->Response (\r
- Http,\r
- &HttpIo->RspToken\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 && ((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 ((HttpIo->Callback != NULL) &&\r
- (HttpIo->RspToken.Status == EFI_SUCCESS || HttpIo->RspToken.Status == EFI_HTTP_ERROR)) {\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
- 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
@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
+ @retval Others Unexpected error happened.\r
\r
**/\r
EFI_STATUS\r
projects / mirror_edk2.git / blobdiff