2 Implementation of EFI_HTTP_PROTOCOL protocol interfaces.
4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "HttpDriver.h"
19 EFI_HTTP_PROTOCOL mEfiHttpTemplate
= {
29 Returns the operational parameters for the current HTTP child instance.
31 The GetModeData() function is used to read the current mode data (operational
32 parameters) for this HTTP protocol instance.
34 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
35 @param[out] HttpConfigData Point to buffer for operational parameters of this
38 @retval EFI_SUCCESS Operation succeeded.
39 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
41 HttpConfigData is NULL.
42 HttpInstance->LocalAddressIsIPv6 is FALSE and
43 HttpConfigData->IPv4Node is NULL.
44 HttpInstance->LocalAddressIsIPv6 is TRUE and
45 HttpConfigData->IPv6Node is NULL.
46 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
52 IN EFI_HTTP_PROTOCOL
*This
,
53 OUT EFI_HTTP_CONFIG_DATA
*HttpConfigData
56 HTTP_PROTOCOL
*HttpInstance
;
59 // Check input parameters.
61 if ((This
== NULL
) || (HttpConfigData
== NULL
)) {
62 return EFI_INVALID_PARAMETER
;
65 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
66 ASSERT (HttpInstance
!= NULL
);
68 if ((HttpInstance
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv6Node
== NULL
) ||
69 (!HttpInstance
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv4Node
== NULL
)) {
70 return EFI_INVALID_PARAMETER
;
73 if (HttpInstance
->State
< HTTP_STATE_HTTP_CONFIGED
) {
74 return EFI_NOT_STARTED
;
77 HttpConfigData
->HttpVersion
= HttpInstance
->HttpVersion
;
78 HttpConfigData
->TimeOutMillisec
= HttpInstance
->TimeOutMillisec
;
79 HttpConfigData
->LocalAddressIsIPv6
= HttpInstance
->LocalAddressIsIPv6
;
81 if (HttpInstance
->LocalAddressIsIPv6
) {
83 HttpConfigData
->AccessPoint
.IPv6Node
,
84 &HttpInstance
->Ipv6Node
,
85 sizeof (HttpInstance
->Ipv6Node
)
89 HttpConfigData
->AccessPoint
.IPv4Node
,
90 &HttpInstance
->IPv4Node
,
91 sizeof (HttpInstance
->IPv4Node
)
99 Initialize or brutally reset the operational parameters for this EFI HTTP instance.
101 The Configure() function does the following:
102 When HttpConfigData is not NULL Initialize this EFI HTTP instance by configuring
103 timeout, local address, port, etc.
104 When HttpConfigData is NULL, reset this EFI HTTP instance by closing all active
105 connections with remote hosts, canceling all asynchronous tokens, and flush request
106 and response buffers without informing the appropriate hosts.
108 No other EFI HTTP function can be executed by this instance until the Configure()
109 function is executed and returns successfully.
111 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
112 @param[in] HttpConfigData Pointer to the configure data to configure the instance.
114 @retval EFI_SUCCESS Operation succeeded.
115 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
117 HttpConfigData->LocalAddressIsIPv6 is FALSE and
118 HttpConfigData->IPv4Node is NULL.
119 HttpConfigData->LocalAddressIsIPv6 is TRUE and
120 HttpConfigData->IPv6Node is NULL.
121 @retval EFI_ALREADY_STARTED Reinitialize this HTTP instance without calling
122 Configure() with NULL to reset it.
123 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
124 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources when
125 executing Configure().
126 @retval EFI_UNSUPPORTED One or more options in HttpConfigData are not supported
127 in the implementation.
132 IN EFI_HTTP_PROTOCOL
*This
,
133 IN EFI_HTTP_CONFIG_DATA
*HttpConfigData
136 HTTP_PROTOCOL
*HttpInstance
;
140 // Check input parameters.
143 (HttpConfigData
!= NULL
&&
144 ((HttpConfigData
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv6Node
== NULL
) ||
145 (!HttpConfigData
->LocalAddressIsIPv6
&& HttpConfigData
->AccessPoint
.IPv4Node
== NULL
)))) {
146 return EFI_INVALID_PARAMETER
;
149 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
150 ASSERT (HttpInstance
!= NULL
&& HttpInstance
->Service
!= NULL
);
152 if (HttpConfigData
!= NULL
) {
155 // Now configure this HTTP instance.
157 if (HttpInstance
->State
!= HTTP_STATE_UNCONFIGED
) {
158 return EFI_ALREADY_STARTED
;
161 HttpInstance
->HttpVersion
= HttpConfigData
->HttpVersion
;
162 HttpInstance
->TimeOutMillisec
= HttpConfigData
->TimeOutMillisec
;
163 HttpInstance
->LocalAddressIsIPv6
= HttpConfigData
->LocalAddressIsIPv6
;
165 if (HttpConfigData
->LocalAddressIsIPv6
) {
167 &HttpInstance
->Ipv6Node
,
168 HttpConfigData
->AccessPoint
.IPv6Node
,
169 sizeof (HttpInstance
->Ipv6Node
)
173 &HttpInstance
->IPv4Node
,
174 HttpConfigData
->AccessPoint
.IPv4Node
,
175 sizeof (HttpInstance
->IPv4Node
)
182 Status
= HttpInitProtocol (HttpInstance
, HttpInstance
->LocalAddressIsIPv6
);
183 if (EFI_ERROR (Status
)) {
187 HttpInstance
->State
= HTTP_STATE_HTTP_CONFIGED
;
192 // Reset all the resources related to HttpInsance.
194 HttpCleanProtocol (HttpInstance
);
195 HttpInstance
->State
= HTTP_STATE_UNCONFIGED
;
202 The Request() function queues an HTTP request to this HTTP instance.
204 Similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent
205 successfully, or if there is an error, Status in token will be updated and Event will
208 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
209 @param[in] Token Pointer to storage containing HTTP request token.
211 @retval EFI_SUCCESS Outgoing data was processed.
212 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
213 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
214 @retval EFI_TIMEOUT Data was dropped out of the transmit or receive queue.
215 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
216 @retval EFI_UNSUPPORTED The HTTP method is not supported in current
218 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
221 Token->Message is NULL.
222 Token->Message->Body is not NULL,
223 Token->Message->BodyLength is non-zero, and
224 Token->Message->Data is NULL, but a previous call to
225 Request()has not been completed successfully.
230 IN EFI_HTTP_PROTOCOL
*This
,
231 IN EFI_HTTP_TOKEN
*Token
234 EFI_HTTP_MESSAGE
*HttpMsg
;
235 EFI_HTTP_REQUEST_DATA
*Request
;
241 HTTP_PROTOCOL
*HttpInstance
;
244 BOOLEAN TlsConfigure
;
249 HTTP_TOKEN_WRAP
*Wrap
;
251 UINTN RequestMsgSize
;
264 TlsConfigure
= FALSE
;
266 if ((This
== NULL
) || (Token
== NULL
)) {
267 return EFI_INVALID_PARAMETER
;
270 HttpMsg
= Token
->Message
;
271 if (HttpMsg
== NULL
) {
272 return EFI_INVALID_PARAMETER
;
275 Request
= HttpMsg
->Data
.Request
;
278 // Only support GET, HEAD, PUT and POST method in current implementation.
280 if ((Request
!= NULL
) && (Request
->Method
!= HttpMethodGet
) &&
281 (Request
->Method
!= HttpMethodHead
) && (Request
->Method
!= HttpMethodPut
) && (Request
->Method
!= HttpMethodPost
)) {
282 return EFI_UNSUPPORTED
;
285 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
286 ASSERT (HttpInstance
!= NULL
);
289 // Capture the method into HttpInstance.
291 if (Request
!= NULL
) {
292 HttpInstance
->Method
= Request
->Method
;
295 if (HttpInstance
->State
< HTTP_STATE_HTTP_CONFIGED
) {
296 return EFI_NOT_STARTED
;
299 if (Request
== NULL
) {
301 // Request would be NULL only for PUT/POST operation (in the current implementation)
303 if ((HttpInstance
->Method
!= HttpMethodPut
) && (HttpInstance
->Method
!= HttpMethodPost
)) {
304 return EFI_INVALID_PARAMETER
;
308 // For PUT/POST, we need to have the TCP already configured. Bail out if it is not!
310 if (HttpInstance
->State
< HTTP_STATE_TCP_CONFIGED
) {
311 return EFI_INVALID_PARAMETER
;
315 // We need to have the Message Body for sending the HTTP message across in these cases.
317 if (HttpMsg
->Body
== NULL
|| HttpMsg
->BodyLength
== 0) {
318 return EFI_INVALID_PARAMETER
;
322 // Use existing TCP instance to transmit the packet.
328 // Check whether the token already existed.
330 if (EFI_ERROR (NetMapIterate (&HttpInstance
->TxTokens
, HttpTokenExist
, Token
))) {
331 return EFI_ACCESS_DENIED
;
335 // Parse the URI of the remote host.
337 Url
= HttpInstance
->Url
;
338 UrlLen
= StrLen (Request
->Url
) + 1;
339 if (UrlLen
> HTTP_URL_BUFFER_LEN
) {
340 Url
= AllocateZeroPool (UrlLen
);
342 return EFI_OUT_OF_RESOURCES
;
344 FreePool (HttpInstance
->Url
);
345 HttpInstance
->Url
= Url
;
349 UnicodeStrToAsciiStrS (Request
->Url
, Url
, UrlLen
);
352 // From the information in Url, the HTTP instance will
353 // be able to determine whether to use http or https.
355 HttpInstance
->UseHttps
= IsHttpsUrl (Url
);
358 // Check whether we need to create Tls child and open the TLS protocol.
360 if (HttpInstance
->UseHttps
&& HttpInstance
->TlsChildHandle
== NULL
) {
362 // Use TlsSb to create Tls child and open the TLS protocol.
364 HttpInstance
->TlsChildHandle
= TlsCreateChild (
365 HttpInstance
->Service
->ImageHandle
,
366 &(HttpInstance
->Tls
),
367 &(HttpInstance
->TlsConfiguration
)
369 if (HttpInstance
->TlsChildHandle
== NULL
) {
370 return EFI_DEVICE_ERROR
;
377 Status
= HttpParseUrl (Url
, (UINT32
) AsciiStrLen (Url
), FALSE
, &UrlParser
);
378 if (EFI_ERROR (Status
)) {
383 Status
= HttpUrlGetHostName (Url
, UrlParser
, &HostName
);
384 if (EFI_ERROR (Status
)) {
388 Status
= HttpUrlGetPort (Url
, UrlParser
, &RemotePort
);
389 if (EFI_ERROR (Status
)) {
390 if (HttpInstance
->UseHttps
) {
391 RemotePort
= HTTPS_DEFAULT_PORT
;
393 RemotePort
= HTTP_DEFAULT_PORT
;
397 // If Configure is TRUE, it indicates the first time to call Request();
398 // If ReConfigure is TRUE, it indicates the request URL is not same
399 // with the previous call to Request();
404 if (HttpInstance
->RemoteHost
== NULL
) {
406 // Request() is called the first time.
410 if ((HttpInstance
->RemotePort
== RemotePort
) &&
411 (AsciiStrCmp (HttpInstance
->RemoteHost
, HostName
) == 0) &&
412 (!HttpInstance
->UseHttps
|| (HttpInstance
->UseHttps
&&
414 HttpInstance
->TlsSessionState
== EfiTlsSessionDataTransferring
))) {
416 // Host Name and port number of the request URL are the same with previous call to Request().
417 // If Https protocol used, the corresponding SessionState is EfiTlsSessionDataTransferring.
418 // Check whether previous TCP packet sent out.
421 if (EFI_ERROR (NetMapIterate (&HttpInstance
->TxTokens
, HttpTcpNotReady
, NULL
))) {
423 // Wrap the HTTP token in HTTP_TOKEN_WRAP
425 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
427 Status
= EFI_OUT_OF_RESOURCES
;
431 Wrap
->HttpToken
= Token
;
432 Wrap
->HttpInstance
= HttpInstance
;
434 Status
= HttpCreateTcpTxEvent (Wrap
);
435 if (EFI_ERROR (Status
)) {
439 Status
= NetMapInsertTail (&HttpInstance
->TxTokens
, Token
, Wrap
);
440 if (EFI_ERROR (Status
)) {
444 Wrap
->TcpWrap
.Method
= Request
->Method
;
449 // Queue the HTTP token and return.
454 // Use existing TCP instance to transmit the packet.
461 // Need close existing TCP instance and create a new TCP instance for data transmit.
463 if (HttpInstance
->RemoteHost
!= NULL
) {
464 FreePool (HttpInstance
->RemoteHost
);
465 HttpInstance
->RemoteHost
= NULL
;
466 HttpInstance
->RemotePort
= 0;
474 // Parse Url for IPv4 or IPv6 address, if failed, perform DNS resolution.
476 if (!HttpInstance
->LocalAddressIsIPv6
) {
477 Status
= NetLibAsciiStrToIp4 (HostName
, &HttpInstance
->RemoteAddr
);
479 Status
= HttpUrlGetIp6 (Url
, UrlParser
, &HttpInstance
->RemoteIpv6Addr
);
482 if (EFI_ERROR (Status
)) {
483 HostNameSize
= AsciiStrSize (HostName
);
484 HostNameStr
= AllocateZeroPool (HostNameSize
* sizeof (CHAR16
));
485 if (HostNameStr
== NULL
) {
486 Status
= EFI_OUT_OF_RESOURCES
;
490 AsciiStrToUnicodeStrS (HostName
, HostNameStr
, HostNameSize
);
491 if (!HttpInstance
->LocalAddressIsIPv6
) {
492 Status
= HttpDns4 (HttpInstance
, HostNameStr
, &HttpInstance
->RemoteAddr
);
494 Status
= HttpDns6 (HttpInstance
, HostNameStr
, &HttpInstance
->RemoteIpv6Addr
);
497 FreePool (HostNameStr
);
498 if (EFI_ERROR (Status
)) {
504 // Save the RemotePort and RemoteHost.
506 ASSERT (HttpInstance
->RemoteHost
== NULL
);
507 HttpInstance
->RemotePort
= RemotePort
;
508 HttpInstance
->RemoteHost
= HostName
;
514 // The request URL is different from previous calls to Request(), close existing TCP instance.
516 if (!HttpInstance
->LocalAddressIsIPv6
) {
517 ASSERT (HttpInstance
->Tcp4
!= NULL
);
519 ASSERT (HttpInstance
->Tcp6
!= NULL
);
522 if (HttpInstance
->UseHttps
&& !TlsConfigure
) {
523 Status
= TlsCloseSession (HttpInstance
);
524 if (EFI_ERROR (Status
)) {
528 TlsCloseTxRxEvent (HttpInstance
);
531 HttpCloseConnection (HttpInstance
);
532 EfiHttpCancel (This
, NULL
);
536 // Wrap the HTTP token in HTTP_TOKEN_WRAP
538 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
540 Status
= EFI_OUT_OF_RESOURCES
;
544 Wrap
->HttpToken
= Token
;
545 Wrap
->HttpInstance
= HttpInstance
;
546 if (Request
!= NULL
) {
547 Wrap
->TcpWrap
.Method
= Request
->Method
;
550 Status
= HttpInitSession (
553 Configure
|| ReConfigure
,
556 if (EFI_ERROR (Status
)) {
560 if (!Configure
&& !ReConfigure
&& !TlsConfigure
) {
562 // For the new HTTP token, create TX TCP token events.
564 Status
= HttpCreateTcpTxEvent (Wrap
);
565 if (EFI_ERROR (Status
)) {
571 // Create request message.
574 if (Url
!= NULL
&& *FileUrl
!= '/') {
576 // Convert the absolute-URI to the absolute-path
578 while (*FileUrl
!= ':') {
581 if ((*(FileUrl
+1) == '/') && (*(FileUrl
+2) == '/')) {
583 while (*FileUrl
!= '/') {
587 Status
= EFI_INVALID_PARAMETER
;
592 Status
= HttpGenRequestMessage (HttpMsg
, FileUrl
, &RequestMsg
, &RequestMsgSize
);
594 if (EFI_ERROR (Status
) || NULL
== RequestMsg
) {
598 ASSERT (RequestMsg
!= NULL
);
601 // Every request we insert a TxToken and a response call would remove the TxToken.
602 // In cases of PUT/POST, after an initial request-response pair, we would do a
603 // continuous request without a response call. So, in such cases, where Request
604 // structure is NULL, we would not insert a TxToken.
606 if (Request
!= NULL
) {
607 Status
= NetMapInsertTail (&HttpInstance
->TxTokens
, Token
, Wrap
);
608 if (EFI_ERROR (Status
)) {
614 // Transmit the request message.
616 Status
= HttpTransmitTcp (
622 if (EFI_ERROR (Status
)) {
628 if (HostName
!= NULL
) {
636 // We would have inserted a TxToken only if Request structure is not NULL.
637 // Hence check before we do a remove in this error case.
639 if (Request
!= NULL
) {
640 NetMapRemoveTail (&HttpInstance
->TxTokens
, NULL
);
644 if (RequestMsg
!= NULL
) {
645 FreePool (RequestMsg
);
649 if (HttpInstance
->UseHttps
) {
650 TlsCloseSession (HttpInstance
);
651 TlsCloseTxRxEvent (HttpInstance
);
655 HttpCloseConnection (HttpInstance
);
657 HttpCloseTcpConnCloseEvent (HttpInstance
);
658 if (NULL
!= Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
) {
659 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
);
660 Wrap
->TcpWrap
.Tx4Token
.CompletionToken
.Event
= NULL
;
662 if (NULL
!= Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
) {
663 gBS
->CloseEvent (Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
);
664 Wrap
->TcpWrap
.Tx6Token
.CompletionToken
.Event
= NULL
;
668 if (HostName
!= NULL
) {
674 if (UrlParser
!= NULL
) {
675 HttpUrlFreeParser (UrlParser
);
683 Cancel a user's Token.
685 @param[in] Map The HTTP instance's token queue.
686 @param[in] Item Object container for one HTTP token and token's wrap.
687 @param[in] Context The user's token to cancel.
689 @retval EFI_SUCCESS Continue to check the next Item.
690 @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled.
697 IN NET_MAP_ITEM
*Item
,
701 EFI_HTTP_TOKEN
*Token
;
702 HTTP_TOKEN_WRAP
*Wrap
;
703 HTTP_PROTOCOL
*HttpInstance
;
705 Token
= (EFI_HTTP_TOKEN
*) Context
;
708 // Return EFI_SUCCESS to check the next item in the map if
709 // this one doesn't match.
711 if ((Token
!= NULL
) && (Token
!= Item
->Key
)) {
715 Wrap
= (HTTP_TOKEN_WRAP
*) Item
->Value
;
716 ASSERT (Wrap
!= NULL
);
717 HttpInstance
= Wrap
->HttpInstance
;
719 if (!HttpInstance
->LocalAddressIsIPv6
) {
720 if (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
!= NULL
) {
722 // Cancle the Token before close its Event.
724 HttpInstance
->Tcp4
->Cancel (HttpInstance
->Tcp4
, &Wrap
->TcpWrap
.Rx4Token
.CompletionToken
);
727 // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.
732 if (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
!= NULL
) {
734 // Cancle the Token before close its Event.
736 HttpInstance
->Tcp6
->Cancel (HttpInstance
->Tcp6
, &Wrap
->TcpWrap
.Rx6Token
.CompletionToken
);
739 // Dispatch the DPC queued by the NotifyFunction of the canceled token's events.
746 // If only one item is to be cancel, return EFI_ABORTED to stop
747 // iterating the map any more.
757 Cancel the user's receive/transmit request. It is the worker function of
758 EfiHttpCancel API. If a matching token is found, it will call HttpCancelTokens to cancel the
761 @param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.
762 @param[in] Token The token to cancel. If NULL, all token will be
765 @retval EFI_SUCCESS The token is cancelled.
766 @retval EFI_NOT_FOUND The asynchronous request or response token is not found.
767 @retval Others Other error as indicated.
772 IN HTTP_PROTOCOL
*HttpInstance
,
773 IN EFI_HTTP_TOKEN
*Token
779 // First check the tokens queued by EfiHttpRequest().
781 Status
= NetMapIterate (&HttpInstance
->TxTokens
, HttpCancelTokens
, Token
);
782 if (EFI_ERROR (Status
)) {
784 if (Status
== EFI_ABORTED
) {
792 if (!HttpInstance
->UseHttps
) {
794 // Then check the tokens queued by EfiHttpResponse(), except for Https.
796 Status
= NetMapIterate (&HttpInstance
->RxTokens
, HttpCancelTokens
, Token
);
797 if (EFI_ERROR (Status
)) {
799 if (Status
== EFI_ABORTED
) {
802 return EFI_NOT_FOUND
;
809 if (!HttpInstance
->LocalAddressIsIPv6
) {
810 HttpInstance
->Tcp4
->Cancel (HttpInstance
->Tcp4
, &HttpInstance
->Tcp4TlsRxToken
.CompletionToken
);
812 HttpInstance
->Tcp6
->Cancel (HttpInstance
->Tcp6
, &HttpInstance
->Tcp6TlsRxToken
.CompletionToken
);
821 Abort an asynchronous HTTP request or response token.
823 The Cancel() function aborts a pending HTTP request or response transaction. If
824 Token is not NULL and the token is in transmit or receive queues when it is being
825 cancelled, its Token->Status will be set to EFI_ABORTED and then Token->Event will
826 be signaled. If the token is not in one of the queues, which usually means that the
827 asynchronous operation has completed, EFI_NOT_FOUND is returned. If Token is NULL,
828 all asynchronous tokens issued by Request() or Response() will be aborted.
830 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
831 @param[in] Token Point to storage containing HTTP request or response
834 @retval EFI_SUCCESS Request and Response queues are successfully flushed.
835 @retval EFI_INVALID_PARAMETER This is NULL.
836 @retval EFI_NOT_STARTED This instance hasn't been configured.
837 @retval EFI_NOT_FOUND The asynchronous request or response token is not
839 @retval EFI_UNSUPPORTED The implementation does not support this function.
845 IN EFI_HTTP_PROTOCOL
*This
,
846 IN EFI_HTTP_TOKEN
*Token
849 HTTP_PROTOCOL
*HttpInstance
;
852 return EFI_INVALID_PARAMETER
;
855 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
856 ASSERT (HttpInstance
!= NULL
);
858 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
859 return EFI_NOT_STARTED
;
862 return HttpCancel (HttpInstance
, Token
);
867 A callback function to intercept events during message parser.
869 This function will be invoked during HttpParseMessageBody() with various events type. An error
870 return status of the callback function will cause the HttpParseMessageBody() aborted.
872 @param[in] EventType Event type of this callback call.
873 @param[in] Data A pointer to data buffer.
874 @param[in] Length Length in bytes of the Data.
875 @param[in] Context Callback context set by HttpInitMsgParser().
877 @retval EFI_SUCCESS Continue to parser the message body.
882 HttpBodyParserCallback (
883 IN HTTP_BODY_PARSE_EVENT EventType
,
889 HTTP_TOKEN_WRAP
*Wrap
;
893 if (EventType
!= BodyParseEventOnComplete
) {
897 if (Data
== NULL
|| Length
!= 0 || Context
== NULL
) {
901 Wrap
= (HTTP_TOKEN_WRAP
*) Context
;
902 Body
= Wrap
->HttpToken
->Message
->Body
;
903 BodyLength
= Wrap
->HttpToken
->Message
->BodyLength
;
904 if (Data
< Body
+ BodyLength
) {
905 Wrap
->HttpInstance
->NextMsg
= Data
;
907 Wrap
->HttpInstance
->NextMsg
= NULL
;
912 // Free Tx4Token or Tx6Token since already received corrsponding HTTP response.
920 The work function of EfiHttpResponse().
922 @param[in] Wrap Pointer to HTTP token's wrap data.
924 @retval EFI_SUCCESS Allocation succeeded.
925 @retval EFI_OUT_OF_RESOURCES Failed to complete the opration due to lack of resources.
926 @retval EFI_NOT_READY Can't find a corresponding Tx4Token/Tx6Token or
927 the EFI_HTTP_UTILITIES_PROTOCOL is not available.
932 IN HTTP_TOKEN_WRAP
*Wrap
936 EFI_HTTP_MESSAGE
*HttpMsg
;
944 CHAR8
*StatusCodeStr
;
946 HTTP_PROTOCOL
*HttpInstance
;
947 EFI_HTTP_TOKEN
*Token
;
949 HTTP_TOKEN_WRAP
*ValueInItem
;
951 NET_FRAGMENT Fragment
;
953 if (Wrap
== NULL
|| Wrap
->HttpInstance
== NULL
) {
954 return EFI_INVALID_PARAMETER
;
957 HttpInstance
= Wrap
->HttpInstance
;
958 Token
= Wrap
->HttpToken
;
959 HttpMsg
= Token
->Message
;
961 HttpInstance
->EndofHeader
= NULL
;
962 HttpInstance
->HttpHeaders
= NULL
;
963 HttpMsg
->Headers
= NULL
;
970 Fragment
.Bulk
= NULL
;
972 if (HttpMsg
->Data
.Response
!= NULL
) {
974 // Check whether we have cached header from previous call.
976 if ((HttpInstance
->CacheBody
!= NULL
) && (HttpInstance
->NextMsg
!= NULL
)) {
978 // The data is stored at [NextMsg, CacheBody + CacheLen].
980 HdrLen
= HttpInstance
->CacheBody
+ HttpInstance
->CacheLen
- HttpInstance
->NextMsg
;
981 HttpHeaders
= AllocateZeroPool (HdrLen
);
982 if (HttpHeaders
== NULL
) {
983 Status
= EFI_OUT_OF_RESOURCES
;
987 CopyMem (HttpHeaders
, HttpInstance
->NextMsg
, HdrLen
);
988 FreePool (HttpInstance
->CacheBody
);
989 HttpInstance
->CacheBody
= NULL
;
990 HttpInstance
->NextMsg
= NULL
;
991 HttpInstance
->CacheOffset
= 0;
992 SizeofHeaders
= HdrLen
;
993 BufferSize
= HttpInstance
->CacheLen
;
996 // Check whether we cached the whole HTTP headers.
998 EndofHeader
= AsciiStrStr (HttpHeaders
, HTTP_END_OF_HDR_STR
);
1001 HttpInstance
->EndofHeader
= &EndofHeader
;
1002 HttpInstance
->HttpHeaders
= &HttpHeaders
;
1005 if (HttpInstance
->TimeoutEvent
== NULL
) {
1007 // Create TimeoutEvent for response
1009 Status
= gBS
->CreateEvent (
1014 &HttpInstance
->TimeoutEvent
1016 if (EFI_ERROR (Status
)) {
1022 // Start the timer, and wait Timeout seconds to receive the header packet.
1024 Status
= gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerRelative
, HTTP_RESPONSE_TIMEOUT
* TICKS_PER_SECOND
);
1025 if (EFI_ERROR (Status
)) {
1029 Status
= HttpTcpReceiveHeader (HttpInstance
, &SizeofHeaders
, &BufferSize
, HttpInstance
->TimeoutEvent
);
1031 gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerCancel
, 0);
1033 if (EFI_ERROR (Status
)) {
1037 ASSERT (HttpHeaders
!= NULL
);
1040 // Cache the part of body.
1042 BodyLen
= BufferSize
- (EndofHeader
- HttpHeaders
);
1044 if (HttpInstance
->CacheBody
!= NULL
) {
1045 FreePool (HttpInstance
->CacheBody
);
1048 HttpInstance
->CacheBody
= AllocateZeroPool (BodyLen
);
1049 if (HttpInstance
->CacheBody
== NULL
) {
1050 Status
= EFI_OUT_OF_RESOURCES
;
1054 CopyMem (HttpInstance
->CacheBody
, EndofHeader
, BodyLen
);
1055 HttpInstance
->CacheLen
= BodyLen
;
1059 // Search for Status Code.
1061 StatusCodeStr
= HttpHeaders
+ AsciiStrLen (HTTP_VERSION_STR
) + 1;
1062 if (StatusCodeStr
== NULL
) {
1063 Status
= EFI_NOT_READY
;
1067 StatusCode
= AsciiStrDecimalToUintn (StatusCodeStr
);
1070 // Remove the first line of HTTP message, e.g. "HTTP/1.1 200 OK\r\n".
1072 Tmp
= AsciiStrStr (HttpHeaders
, HTTP_CRLF_STR
);
1074 Status
= EFI_NOT_READY
;
1079 // We could have response with just a HTTP message and no headers. For Example,
1080 // "100 Continue". In such cases, we would not want to unnecessarily call a Parse
1081 // method. A "\r\n" following Tmp string again would indicate an end. Compare and
1082 // set SizeofHeaders to 0.
1084 Tmp
= Tmp
+ AsciiStrLen (HTTP_CRLF_STR
);
1085 if (CompareMem (Tmp
, HTTP_CRLF_STR
, AsciiStrLen (HTTP_CRLF_STR
)) == 0) {
1088 SizeofHeaders
= SizeofHeaders
- (Tmp
- HttpHeaders
);
1091 HttpMsg
->Data
.Response
->StatusCode
= HttpMappingToStatusCode (StatusCode
);
1092 HttpInstance
->StatusCode
= StatusCode
;
1094 Status
= EFI_NOT_READY
;
1098 // In cases of PUT/POST, after an initial request-response pair, we would do a
1099 // continuous request without a response call. So, we would not do an insert of
1100 // TxToken. After we have sent the complete file, we will call a response to get
1101 // a final response from server. In such a case, we would not have any TxTokens.
1102 // Hence, check that case before doing a NetMapRemoveHead.
1104 if (!NetMapIsEmpty (&HttpInstance
->TxTokens
)) {
1105 NetMapRemoveHead (&HttpInstance
->TxTokens
, (VOID
**) &ValueInItem
);
1106 if (ValueInItem
== NULL
) {
1111 // The first Tx Token not transmitted yet, insert back and return error.
1113 if (!ValueInItem
->TcpWrap
.IsTxDone
) {
1118 if (SizeofHeaders
!= 0) {
1119 HeaderTmp
= AllocateZeroPool (SizeofHeaders
);
1120 if (HeaderTmp
== NULL
) {
1121 Status
= EFI_OUT_OF_RESOURCES
;
1125 CopyMem (HeaderTmp
, Tmp
, SizeofHeaders
);
1126 FreePool (HttpHeaders
);
1127 HttpHeaders
= HeaderTmp
;
1130 // Check whether the EFI_HTTP_UTILITIES_PROTOCOL is available.
1132 if (mHttpUtilities
== NULL
) {
1133 Status
= EFI_NOT_READY
;
1138 // Parse the HTTP header into array of key/value pairs.
1140 Status
= mHttpUtilities
->Parse (
1145 &HttpMsg
->HeaderCount
1147 if (EFI_ERROR (Status
)) {
1151 FreePool (HttpHeaders
);
1156 // Init message-body parser by header information.
1158 Status
= HttpInitMsgParser (
1159 HttpInstance
->Method
,
1160 HttpMsg
->Data
.Response
->StatusCode
,
1161 HttpMsg
->HeaderCount
,
1163 HttpBodyParserCallback
,
1164 (VOID
*) ValueInItem
,
1165 &HttpInstance
->MsgParser
1167 if (EFI_ERROR (Status
)) {
1172 // Check whether we received a complete HTTP message.
1174 if (HttpInstance
->CacheBody
!= NULL
) {
1175 Status
= HttpParseMessageBody (HttpInstance
->MsgParser
, HttpInstance
->CacheLen
, HttpInstance
->CacheBody
);
1176 if (EFI_ERROR (Status
)) {
1180 if (HttpIsMessageComplete (HttpInstance
->MsgParser
)) {
1182 // Free the MsgParse since we already have a full HTTP message.
1184 HttpFreeMsgParser (HttpInstance
->MsgParser
);
1185 HttpInstance
->MsgParser
= NULL
;
1190 if ((HttpMsg
->Body
== NULL
) || (HttpMsg
->BodyLength
== 0)) {
1191 Status
= EFI_SUCCESS
;
1197 // Receive the response body.
1202 // First check whether we cached some data.
1204 if (HttpInstance
->CacheBody
!= NULL
) {
1206 // Calculate the length of the cached data.
1208 if (HttpInstance
->NextMsg
!= NULL
) {
1210 // We have a cached HTTP message which includes a part of HTTP header of next message.
1212 BodyLen
= HttpInstance
->NextMsg
- (HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
);
1214 BodyLen
= HttpInstance
->CacheLen
- HttpInstance
->CacheOffset
;
1219 // We have some cached data. Just copy the data and return.
1221 if (HttpMsg
->BodyLength
< BodyLen
) {
1222 CopyMem (HttpMsg
->Body
, HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
, HttpMsg
->BodyLength
);
1223 HttpInstance
->CacheOffset
= HttpInstance
->CacheOffset
+ HttpMsg
->BodyLength
;
1226 // Copy all cached data out.
1228 CopyMem (HttpMsg
->Body
, HttpInstance
->CacheBody
+ HttpInstance
->CacheOffset
, BodyLen
);
1229 HttpInstance
->CacheOffset
= BodyLen
+ HttpInstance
->CacheOffset
;
1230 HttpMsg
->BodyLength
= BodyLen
;
1232 if (HttpInstance
->NextMsg
== NULL
) {
1234 // There is no HTTP header of next message. Just free the cache buffer.
1236 FreePool (HttpInstance
->CacheBody
);
1237 HttpInstance
->CacheBody
= NULL
;
1238 HttpInstance
->NextMsg
= NULL
;
1239 HttpInstance
->CacheOffset
= 0;
1243 // Return since we aready received required data.
1245 Status
= EFI_SUCCESS
;
1249 if (BodyLen
== 0 && HttpInstance
->MsgParser
== NULL
) {
1251 // We received a complete HTTP message, and we don't have more data to return to caller.
1253 HttpMsg
->BodyLength
= 0;
1254 Status
= EFI_SUCCESS
;
1259 ASSERT (HttpInstance
->MsgParser
!= NULL
);
1262 // We still need receive more data when there is no cache data and MsgParser is not NULL;
1264 if (!HttpInstance
->UseHttps
) {
1265 Status
= HttpTcpReceiveBody (Wrap
, HttpMsg
);
1267 if (EFI_ERROR (Status
)) {
1272 if (HttpInstance
->TimeoutEvent
== NULL
) {
1274 // Create TimeoutEvent for response
1276 Status
= gBS
->CreateEvent (
1281 &HttpInstance
->TimeoutEvent
1283 if (EFI_ERROR (Status
)) {
1289 // Start the timer, and wait Timeout seconds to receive the body packet.
1291 Status
= gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerRelative
, HTTP_RESPONSE_TIMEOUT
* TICKS_PER_SECOND
);
1292 if (EFI_ERROR (Status
)) {
1296 Status
= HttpsReceive (HttpInstance
, &Fragment
, HttpInstance
->TimeoutEvent
);
1298 gBS
->SetTimer (HttpInstance
->TimeoutEvent
, TimerCancel
, 0);
1300 if (EFI_ERROR (Status
)) {
1305 // Check whether we receive a complete HTTP message.
1307 Status
= HttpParseMessageBody (
1308 HttpInstance
->MsgParser
,
1309 (UINTN
) Fragment
.Len
,
1310 (CHAR8
*) Fragment
.Bulk
1312 if (EFI_ERROR (Status
)) {
1316 if (HttpIsMessageComplete (HttpInstance
->MsgParser
)) {
1318 // Free the MsgParse since we already have a full HTTP message.
1320 HttpFreeMsgParser (HttpInstance
->MsgParser
);
1321 HttpInstance
->MsgParser
= NULL
;
1325 // We receive part of header of next HTTP msg.
1327 if (HttpInstance
->NextMsg
!= NULL
) {
1328 HttpMsg
->BodyLength
= MIN ((UINTN
) (HttpInstance
->NextMsg
- (CHAR8
*) Fragment
.Bulk
), HttpMsg
->BodyLength
);
1329 CopyMem (HttpMsg
->Body
, Fragment
.Bulk
, HttpMsg
->BodyLength
);
1331 HttpInstance
->CacheLen
= Fragment
.Len
- HttpMsg
->BodyLength
;
1332 if (HttpInstance
->CacheLen
!= 0) {
1333 if (HttpInstance
->CacheBody
!= NULL
) {
1334 FreePool (HttpInstance
->CacheBody
);
1337 HttpInstance
->CacheBody
= AllocateZeroPool (HttpInstance
->CacheLen
);
1338 if (HttpInstance
->CacheBody
== NULL
) {
1339 Status
= EFI_OUT_OF_RESOURCES
;
1343 CopyMem (HttpInstance
->CacheBody
, Fragment
.Bulk
+ HttpMsg
->BodyLength
, HttpInstance
->CacheLen
);
1344 HttpInstance
->CacheOffset
= 0;
1346 HttpInstance
->NextMsg
= HttpInstance
->CacheBody
+ (UINTN
) (HttpInstance
->NextMsg
- (CHAR8
*) (Fragment
.Bulk
+ HttpMsg
->BodyLength
));
1349 HttpMsg
->BodyLength
= MIN (Fragment
.Len
, (UINT32
) HttpMsg
->BodyLength
);
1350 CopyMem (HttpMsg
->Body
, Fragment
.Bulk
, HttpMsg
->BodyLength
);
1351 HttpInstance
->CacheLen
= Fragment
.Len
- HttpMsg
->BodyLength
;
1352 if (HttpInstance
->CacheLen
!= 0) {
1353 if (HttpInstance
->CacheBody
!= NULL
) {
1354 FreePool (HttpInstance
->CacheBody
);
1357 HttpInstance
->CacheBody
= AllocateZeroPool (HttpInstance
->CacheLen
);
1358 if (HttpInstance
->CacheBody
== NULL
) {
1359 Status
= EFI_OUT_OF_RESOURCES
;
1363 CopyMem (HttpInstance
->CacheBody
, Fragment
.Bulk
+ HttpMsg
->BodyLength
, HttpInstance
->CacheLen
);
1364 HttpInstance
->CacheOffset
= 0;
1368 if (Fragment
.Bulk
!= NULL
) {
1369 FreePool (Fragment
.Bulk
);
1370 Fragment
.Bulk
= NULL
;
1379 Item
= NetMapFindKey (&Wrap
->HttpInstance
->RxTokens
, Wrap
->HttpToken
);
1381 NetMapRemoveItem (&Wrap
->HttpInstance
->RxTokens
, Item
, NULL
);
1384 if (HttpInstance
->StatusCode
>= HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE
) {
1385 Token
->Status
= EFI_HTTP_ERROR
;
1387 Token
->Status
= Status
;
1390 gBS
->SignalEvent (Token
->Event
);
1391 HttpCloseTcpRxEvent (Wrap
);
1396 if (ValueInItem
!= NULL
) {
1397 NetMapInsertHead (&HttpInstance
->TxTokens
, ValueInItem
->HttpToken
, ValueInItem
);
1401 Item
= NetMapFindKey (&Wrap
->HttpInstance
->RxTokens
, Wrap
->HttpToken
);
1403 NetMapRemoveItem (&Wrap
->HttpInstance
->RxTokens
, Item
, NULL
);
1406 if (!HttpInstance
->UseHttps
) {
1407 HttpTcpTokenCleanup (Wrap
);
1412 if (HttpHeaders
!= NULL
) {
1413 FreePool (HttpHeaders
);
1417 if (Fragment
.Bulk
!= NULL
) {
1418 FreePool (Fragment
.Bulk
);
1419 Fragment
.Bulk
= NULL
;
1422 if (HttpMsg
->Headers
!= NULL
) {
1423 FreePool (HttpMsg
->Headers
);
1424 HttpMsg
->Headers
= NULL
;
1427 if (HttpInstance
->CacheBody
!= NULL
) {
1428 FreePool (HttpInstance
->CacheBody
);
1429 HttpInstance
->CacheBody
= NULL
;
1432 if (HttpInstance
->StatusCode
>= HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE
) {
1433 Token
->Status
= EFI_HTTP_ERROR
;
1435 Token
->Status
= Status
;
1438 gBS
->SignalEvent (Token
->Event
);
1446 The Response() function queues an HTTP response to this HTTP instance, similar to
1447 Receive() function in the EFI TCP driver. When the HTTP response is received successfully,
1448 or if there is an error, Status in token will be updated and Event will be signaled.
1450 The HTTP driver will queue a receive token to the underlying TCP instance. When data
1451 is received in the underlying TCP instance, the data will be parsed and Token will
1452 be populated with the response data. If the data received from the remote host
1453 contains an incomplete or invalid HTTP header, the HTTP driver will continue waiting
1454 (asynchronously) for more data to be sent from the remote host before signaling
1457 It is the responsibility of the caller to allocate a buffer for Body and specify the
1458 size in BodyLength. If the remote host provides a response that contains a content
1459 body, up to BodyLength bytes will be copied from the receive buffer into Body and
1460 BodyLength will be updated with the amount of bytes received and copied to Body. This
1461 allows the client to download a large file in chunks instead of into one contiguous
1462 block of memory. Similar to HTTP request, if Body is not NULL and BodyLength is
1463 non-zero and all other fields are NULL or 0, the HTTP driver will queue a receive
1464 token to underlying TCP instance. If data arrives in the receive buffer, up to
1465 BodyLength bytes of data will be copied to Body. The HTTP driver will then update
1466 BodyLength with the amount of bytes received and copied to Body.
1468 If the HTTP driver does not have an open underlying TCP connection with the host
1469 specified in the response URL, Request() will return EFI_ACCESS_DENIED. This is
1470 consistent with RFC 2616 recommendation that HTTP clients should attempt to maintain
1471 an open TCP connection between client and host.
1473 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
1474 @param[in] Token Pointer to storage containing HTTP response token.
1476 @retval EFI_SUCCESS Allocation succeeded.
1477 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been
1479 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
1482 Token->Message->Headers is NULL.
1483 Token->Message is NULL.
1484 Token->Message->Body is not NULL,
1485 Token->Message->BodyLength is non-zero, and
1486 Token->Message->Data is NULL, but a previous call to
1487 Response() has not been completed successfully.
1488 @retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.
1489 @retval EFI_ACCESS_DENIED An open TCP connection is not present with the host
1490 specified by response URL.
1495 IN EFI_HTTP_PROTOCOL
*This
,
1496 IN EFI_HTTP_TOKEN
*Token
1500 EFI_HTTP_MESSAGE
*HttpMsg
;
1501 HTTP_PROTOCOL
*HttpInstance
;
1502 HTTP_TOKEN_WRAP
*Wrap
;
1504 if ((This
== NULL
) || (Token
== NULL
)) {
1505 return EFI_INVALID_PARAMETER
;
1508 HttpMsg
= Token
->Message
;
1509 if (HttpMsg
== NULL
) {
1510 return EFI_INVALID_PARAMETER
;
1513 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
1514 ASSERT (HttpInstance
!= NULL
);
1516 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
1517 return EFI_NOT_STARTED
;
1521 // Check whether the token already existed.
1523 if (EFI_ERROR (NetMapIterate (&HttpInstance
->RxTokens
, HttpTokenExist
, Token
))) {
1524 return EFI_ACCESS_DENIED
;
1527 Wrap
= AllocateZeroPool (sizeof (HTTP_TOKEN_WRAP
));
1529 return EFI_OUT_OF_RESOURCES
;
1532 Wrap
->HttpInstance
= HttpInstance
;
1533 Wrap
->HttpToken
= Token
;
1536 // Notes: For Https, receive token wrapped in HTTP_TOKEN_WRAP is not used to
1537 // receive the https response. A special TlsRxToken is used for receiving TLS
1538 // related messages. It should be a blocking response.
1540 if (!HttpInstance
->UseHttps
) {
1541 Status
= HttpCreateTcpRxEvent (Wrap
);
1542 if (EFI_ERROR (Status
)) {
1547 Status
= NetMapInsertTail (&HttpInstance
->RxTokens
, Token
, Wrap
);
1548 if (EFI_ERROR (Status
)) {
1553 // If already have pending RxTokens, return directly.
1555 if (NetMapGetCount (&HttpInstance
->RxTokens
) > 1) {
1559 return HttpResponseWorker (Wrap
);
1563 if (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
!= NULL
) {
1564 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx4Token
.CompletionToken
.Event
);
1567 if (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
!= NULL
) {
1568 gBS
->CloseEvent (Wrap
->TcpWrap
.Rx6Token
.CompletionToken
.Event
);
1577 The Poll() function can be used by network drivers and applications to increase the
1578 rate that data packets are moved between the communication devices and the transmit
1581 In some systems, the periodic timer event in the managed network driver may not poll
1582 the underlying communications device fast enough to transmit and/or receive all data
1583 packets without missing incoming packets or dropping outgoing packets. Drivers and
1584 applications that are experiencing packet loss should try calling the Poll() function
1587 @param[in] This Pointer to EFI_HTTP_PROTOCOL instance.
1589 @retval EFI_SUCCESS Incoming or outgoing data was processed.
1590 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
1591 @retval EFI_INVALID_PARAMETER This is NULL.
1592 @retval EFI_NOT_READY No incoming or outgoing data is processed.
1593 @retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.
1599 IN EFI_HTTP_PROTOCOL
*This
1603 HTTP_PROTOCOL
*HttpInstance
;
1606 return EFI_INVALID_PARAMETER
;
1609 HttpInstance
= HTTP_INSTANCE_FROM_PROTOCOL (This
);
1610 ASSERT (HttpInstance
!= NULL
);
1612 if (HttpInstance
->State
!= HTTP_STATE_TCP_CONNECTED
) {
1613 return EFI_NOT_STARTED
;
1616 if (HttpInstance
->LocalAddressIsIPv6
) {
1617 if (HttpInstance
->Tcp6
== NULL
) {
1618 return EFI_NOT_STARTED
;
1620 Status
= HttpInstance
->Tcp6
->Poll (HttpInstance
->Tcp6
);
1622 if (HttpInstance
->Tcp4
== NULL
) {
1623 return EFI_NOT_STARTED
;
1625 Status
= HttpInstance
->Tcp4
->Poll (HttpInstance
->Tcp4
);