[mirror_edk2.git] / NetworkPkg / HttpDxe / HttpProto.h

/** @file\r
  The header files of miscellaneous routines for HttpDxe driver.\r
\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\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  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
\r
**/\r
\r
#ifndef __EFI_HTTP_PROTO_H__\r
#define __EFI_HTTP_PROTO_H__\r
\r
#define DEF_BUF_LEN                         2048\r
\r
#define HTTP_SERVICE_SIGNATURE  SIGNATURE_32('H', 't', 't', 'S')\r
\r
#define HTTP_SERVICE_FROM_PROTOCOL(a) \\r
  CR ( \\r
  (a), \\r
  HTTP_SERVICE, \\r
  ServiceBinding, \\r
  HTTP_SERVICE_SIGNATURE \\r
  )\r
\r
\r
//\r
// The state of HTTP protocol. It starts from UNCONFIGED.\r
//\r
#define HTTP_STATE_UNCONFIGED        0\r
#define HTTP_STATE_HTTP_CONFIGED     1\r
#define HTTP_STATE_TCP_CONFIGED      2\r
#define HTTP_STATE_TCP_UNCONFIGED    3\r
#define HTTP_STATE_TCP_CONNECTED     4\r
#define HTTP_STATE_TCP_CLOSED        5\r
\r
//\r
// TCP configured data.\r
//\r
#define HTTP_TOS_DEAULT              8\r
#define HTTP_TTL_DEAULT              255\r
#define HTTP_BUFFER_SIZE_DEAULT      65535\r
#define HTTP_MAX_SYN_BACK_LOG        5\r
#define HTTP_CONNECTION_TIMEOUT      60\r
#define HTTP_RESPONSE_TIMEOUT        5\r
#define HTTP_DATA_RETRIES            12\r
#define HTTP_FIN_TIMEOUT             2\r
#define HTTP_KEEP_ALIVE_PROBES       6\r
#define HTTP_KEEP_ALIVE_TIME         7200\r
#define HTTP_KEEP_ALIVE_INTERVAL     30\r
\r
#define HTTP_URL_BUFFER_LEN          4096\r
\r
typedef struct _HTTP_SERVICE {\r
  UINT32                        Signature;\r
  EFI_SERVICE_BINDING_PROTOCOL  ServiceBinding;\r
  EFI_HANDLE                    Ip4DriverBindingHandle;\r
  EFI_HANDLE                    Ip6DriverBindingHandle;\r
  EFI_HANDLE                    ControllerHandle;\r
  EFI_HANDLE                    Tcp4ChildHandle;\r
  EFI_HANDLE                    Tcp6ChildHandle;\r
  LIST_ENTRY                    ChildrenList;\r
  UINTN                         ChildrenNumber;\r
  INTN                          State;\r
} HTTP_SERVICE;\r
\r
typedef struct {\r
  EFI_TCP4_IO_TOKEN             Tx4Token;\r
  EFI_TCP4_TRANSMIT_DATA        Tx4Data;\r
  EFI_TCP6_IO_TOKEN             Tx6Token;\r
  EFI_TCP6_TRANSMIT_DATA        Tx6Data;\r
  EFI_TCP4_IO_TOKEN             Rx4Token;\r
  EFI_TCP4_RECEIVE_DATA         Rx4Data;\r
  EFI_TCP6_IO_TOKEN             Rx6Token;\r
  EFI_TCP6_RECEIVE_DATA         Rx6Data;\r
  BOOLEAN                       IsTxDone;\r
  BOOLEAN                       IsRxDone;\r
  UINTN                         BodyLen;\r
  EFI_HTTP_METHOD               Method;\r
} HTTP_TCP_TOKEN_WRAP;\r
\r
typedef struct {\r
  EFI_TLS_VERSION               Version;\r
  EFI_TLS_CONNECTION_END        ConnectionEnd;\r
  EFI_TLS_VERIFY                VerifyMethod;\r
  EFI_TLS_SESSION_STATE         SessionState;\r
} TLS_CONFIG_DATA;\r
\r
typedef struct _HTTP_PROTOCOL {\r
  UINT32                        Signature;\r
  EFI_HTTP_PROTOCOL             Http;\r
  EFI_HANDLE                    Handle;\r
  HTTP_SERVICE                  *Service;\r
  LIST_ENTRY                    Link;   // Link to all HTTP instance from the service.\r
  BOOLEAN                       InDestroy;\r
  INTN                          State;\r
  EFI_HTTP_METHOD               Method;\r
\r
  UINTN                         StatusCode;\r
\r
  EFI_EVENT                     TimeoutEvent;\r
\r
  EFI_HANDLE                    Tcp4ChildHandle;\r
  EFI_TCP4_PROTOCOL             *Tcp4;\r
  EFI_TCP4_CONFIG_DATA          Tcp4CfgData;\r
  EFI_TCP4_OPTION               Tcp4Option;\r
\r
  EFI_TCP4_CONNECTION_TOKEN     Tcp4ConnToken;\r
  BOOLEAN                       IsTcp4ConnDone;\r
  EFI_TCP4_CLOSE_TOKEN          Tcp4CloseToken;\r
  BOOLEAN                       IsTcp4CloseDone;\r
  CHAR8                         *RemoteHost;\r
  UINT16                        RemotePort;\r
  EFI_IPv4_ADDRESS              RemoteAddr;\r
  \r
  EFI_HANDLE                    Tcp6ChildHandle;\r
  EFI_TCP6_PROTOCOL             *Tcp6;\r
  EFI_TCP6_CONFIG_DATA          Tcp6CfgData;\r
  EFI_TCP6_OPTION               Tcp6Option;\r
  \r
  EFI_TCP6_CONNECTION_TOKEN     Tcp6ConnToken;\r
  BOOLEAN                       IsTcp6ConnDone;\r
  EFI_TCP6_CLOSE_TOKEN          Tcp6CloseToken;\r
  BOOLEAN                       IsTcp6CloseDone;\r
  EFI_IPv6_ADDRESS              RemoteIpv6Addr;\r
 \r
  //\r
  // Rx4Token or Rx6Token used for receiving HTTP header.\r
  //\r
  EFI_TCP4_IO_TOKEN             Rx4Token;\r
  EFI_TCP4_RECEIVE_DATA         Rx4Data;\r
  EFI_TCP6_IO_TOKEN             Rx6Token;\r
  EFI_TCP6_RECEIVE_DATA         Rx6Data;\r
  BOOLEAN                       IsRxDone;\r
\r
  CHAR8                         **EndofHeader;\r
  CHAR8                         **HttpHeaders;\r
  CHAR8                         *CacheBody;\r
  CHAR8                         *NextMsg;\r
  UINTN                         CacheLen;\r
  UINTN                         CacheOffset;\r
\r
  //\r
  // HTTP message-body parser.\r
  //\r
  VOID                          *MsgParser;\r
  \r
  EFI_HTTP_VERSION              HttpVersion;\r
  UINT32                        TimeOutMillisec;\r
  BOOLEAN                       LocalAddressIsIPv6;\r
\r
  EFI_HTTPv4_ACCESS_POINT       IPv4Node;\r
  EFI_HTTPv6_ACCESS_POINT       Ipv6Node;\r
\r
  NET_MAP                       TxTokens;\r
  NET_MAP                       RxTokens;\r
\r
  CHAR8                         *Url;\r
\r
  //\r
  // Https Support\r
  //\r
  BOOLEAN                          UseHttps;\r
  \r
  EFI_HANDLE                       TlsChildHandle; /// Tls ChildHandle\r
  TLS_CONFIG_DATA                  TlsConfigData;\r
  EFI_TLS_PROTOCOL                 *Tls;\r
  EFI_TLS_CONFIGURATION_PROTOCOL   *TlsConfiguration;\r
  EFI_TLS_SESSION_STATE            TlsSessionState;\r
\r
  //\r
  // TlsTxData used for transmitting TLS related messages.\r
  //\r
  EFI_TCP4_IO_TOKEN                Tcp4TlsTxToken;\r
  EFI_TCP4_TRANSMIT_DATA           Tcp4TlsTxData;\r
  EFI_TCP6_IO_TOKEN                Tcp6TlsTxToken;\r
  EFI_TCP6_TRANSMIT_DATA           Tcp6TlsTxData;\r
  BOOLEAN                          TlsIsTxDone;\r
\r
  //\r
  // TlsRxData used for receiving TLS related messages.\r
  //\r
  EFI_TCP4_IO_TOKEN                Tcp4TlsRxToken;\r
  EFI_TCP4_RECEIVE_DATA            Tcp4TlsRxData;\r
  EFI_TCP6_IO_TOKEN                Tcp6TlsRxToken;\r
  EFI_TCP6_RECEIVE_DATA            Tcp6TlsRxData;\r
  BOOLEAN                          TlsIsRxDone;\r
} HTTP_PROTOCOL;\r
\r
typedef struct {\r
  EFI_HTTP_TOKEN                *HttpToken;\r
  HTTP_PROTOCOL                 *HttpInstance;\r
  HTTP_TCP_TOKEN_WRAP           TcpWrap;\r
} HTTP_TOKEN_WRAP;\r
\r
\r
#define HTTP_PROTOCOL_SIGNATURE  SIGNATURE_32('H', 't', 't', 'P')\r
\r
#define HTTP_INSTANCE_FROM_PROTOCOL(a) \\r
  CR ( \\r
  (a), \\r
  HTTP_PROTOCOL, \\r
  Http, \\r
  HTTP_PROTOCOL_SIGNATURE \\r
  )\r
\r
/**\r
  The common notify function used in HTTP driver. \r
\r
  @param[in]  Event   The event signaled.\r
  @param[in]  Context The context.\r
\r
**/\r
VOID\r
EFIAPI\r
HttpCommonNotify (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
\r
/**\r
  Create events for the TCP connection token and TCP close token.\r
\r
  @param[in]  HttpInstance       Pointer to HTTP_PROTOCOL structure.\r
\r
  @retval EFI_SUCCESS            The events are created successfully.\r
  @retval others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpCreateTcpConnCloseEvent (\r
  IN  HTTP_PROTOCOL        *HttpInstance\r
  );\r
\r
/**\r
  Close events in the TCP connection token and TCP close token.\r
\r
  @param[in]  HttpInstance   Pointer to HTTP_PROTOCOL structure.\r
\r
**/\r
VOID\r
HttpCloseTcpConnCloseEvent (\r
  IN  HTTP_PROTOCOL        *HttpInstance\r
  );\r
\r
/**\r
  Create event for the TCP transmit token.\r
\r
  @param[in]  Wrap               Point to HTTP token's wrap data.\r
\r
  @retval EFI_SUCCESS            The events is created successfully.\r
  @retval others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpCreateTcpTxEvent (\r
  IN  HTTP_TOKEN_WRAP      *Wrap\r
  );\r
\r
/**\r
  Create event for the TCP receive token which is used to receive HTTP header.\r
\r
  @param[in]  HttpInstance       Pointer to HTTP_PROTOCOL structure.\r
\r
  @retval EFI_SUCCESS            The events is created successfully.\r
  @retval others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpCreateTcpRxEventForHeader (\r
  IN  HTTP_PROTOCOL        *HttpInstance\r
  );\r
\r
/**\r
  Create event for the TCP receive token which is used to receive HTTP body.\r
\r
  @param[in]  Wrap               Point to HTTP token's wrap data.\r
\r
  @retval EFI_SUCCESS            The events is created successfully.\r
  @retval others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpCreateTcpRxEvent (\r
  IN  HTTP_TOKEN_WRAP      *Wrap \r
  );\r
\r
/**\r
  Close Events for Tcp Receive Tokens for HTTP body and HTTP header.\r
\r
  @param[in]  Wrap               Pointer to HTTP token's wrap data.\r
  \r
**/\r
VOID\r
HttpCloseTcpRxEvent (\r
  IN  HTTP_TOKEN_WRAP      *Wrap\r
  );\r
\r
/**\r
  Intiialize the HTTP_PROTOCOL structure to the unconfigured state.\r
\r
  @param[in, out]  HttpInstance         Pointer to HTTP_PROTOCOL structure.\r
  @param[in]       IpVersion            Indicate us TCP4 protocol or TCP6 protocol.\r
\r
  @retval EFI_SUCCESS       HTTP_PROTOCOL structure is initialized successfully.                                          \r
  @retval Others            Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpInitProtocol (\r
  IN OUT HTTP_PROTOCOL           *HttpInstance,\r
  IN     BOOLEAN                 IpVersion\r
  );\r
\r
/**\r
  Clean up the HTTP child, release all the resources used by it.\r
\r
  @param[in]  HttpInstance       The HTTP child to clean up.\r
\r
**/\r
VOID\r
HttpCleanProtocol (\r
  IN  HTTP_PROTOCOL          *HttpInstance\r
  );\r
\r
/**\r
  Establish TCP connection with HTTP server.\r
\r
  @param[in]  HttpInstance       The HTTP instance private data.\r
\r
  @retval EFI_SUCCESS            The TCP connection is established.\r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpCreateConnection (\r
  IN  HTTP_PROTOCOL        *HttpInstance\r
  );\r
\r
/**\r
  Close existing TCP connection.\r
\r
  @param[in]  HttpInstance       The HTTP instance private data.\r
\r
  @retval EFI_SUCCESS            The TCP connection is closed.\r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpCloseConnection (\r
  IN  HTTP_PROTOCOL        *HttpInstance\r
  );\r
\r
/**\r
  Configure TCP4 protocol child.\r
\r
  @param[in]  HttpInstance       The HTTP instance private data.\r
  @param[in]  Wrap               The HTTP token's wrap data.\r
\r
  @retval EFI_SUCCESS            The TCP4 protocol child is configured.\r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpConfigureTcp4 (\r
  IN  HTTP_PROTOCOL        *HttpInstance,\r
  IN  HTTP_TOKEN_WRAP      *Wrap\r
  );\r
\r
/**\r
  Configure TCP6 protocol child.\r
\r
  @param[in]  HttpInstance       The HTTP instance private data.\r
  @param[in]  Wrap               The HTTP token's wrap data.\r
\r
  @retval EFI_SUCCESS            The TCP6 protocol child is configured.\r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpConfigureTcp6 (\r
  IN  HTTP_PROTOCOL        *HttpInstance,\r
  IN  HTTP_TOKEN_WRAP      *Wrap\r
  );\r
\r
/**\r
  Check existing TCP connection, if in error state, recover TCP4 connection. Then, \r
  connect one TLS session if required.\r
\r
  @param[in]  HttpInstance       The HTTP instance private data.\r
\r
  @retval EFI_SUCCESS            The TCP connection is established.\r
  @retval EFI_NOT_READY          TCP4 protocol child is not created or configured.\r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpConnectTcp4 (\r
  IN  HTTP_PROTOCOL        *HttpInstance\r
  );\r
\r
/**\r
  Check existing TCP connection, if in error state, recover TCP6 connection. Then, \r
  connect one TLS session if required.\r
\r
  @param[in]  HttpInstance       The HTTP instance private data.\r
\r
  @retval EFI_SUCCESS            The TCP connection is established.\r
  @retval EFI_NOT_READY          TCP6 protocol child is not created or configured.\r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpConnectTcp6 (\r
  IN  HTTP_PROTOCOL        *HttpInstance\r
  );\r
\r
/**\r
  Send the HTTP or HTTPS message through TCP4 or TCP6.\r
\r
  @param[in]  HttpInstance       The HTTP instance private data.\r
  @param[in]  Wrap               The HTTP token's wrap data.\r
  @param[in]  TxString           Buffer containing the HTTP message string.\r
  @param[in]  TxStringLen        Length of the HTTP message string in bytes.\r
\r
  @retval EFI_SUCCESS            The HTTP message is queued into TCP transmit queue.\r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpTransmitTcp (\r
  IN  HTTP_PROTOCOL    *HttpInstance,\r
  IN  HTTP_TOKEN_WRAP  *Wrap,\r
  IN  UINT8            *TxString,\r
  IN  UINTN            TxStringLen\r
  );\r
\r
/**\r
  Check whether the user's token or event has already\r
  been enqueue on HTTP Tx or Rx Token list.\r
\r
  @param[in]  Map                The container of either user's transmit or receive\r
                                 token.\r
  @param[in]  Item               Current item to check against.\r
  @param[in]  Context            The Token to check againist.\r
\r
  @retval EFI_ACCESS_DENIED      The token or event has already been enqueued in IP\r
  @retval EFI_SUCCESS            The current item isn't the same token/event as the\r
                                 context.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpTokenExist (\r
  IN NET_MAP                *Map,\r
  IN NET_MAP_ITEM           *Item,\r
  IN VOID                   *Context\r
  );\r
\r
/**\r
  Check whether the HTTP message associated with TxToken or Tx6Token is already sent out.\r
\r
  @param[in]  Map                The container of TxToken.\r
  @param[in]  Item               Current item to check against.\r
  @param[in]  Context            The Token to check againist.\r
\r
  @retval EFI_NOT_READY          The HTTP message is still queued in the list.\r
  @retval EFI_SUCCESS            The HTTP message has been sent out.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpTcpNotReady (\r
  IN NET_MAP                *Map,\r
  IN NET_MAP_ITEM           *Item,\r
  IN VOID                   *Context\r
  );\r
\r
/**\r
  Initialize Http session.\r
\r
  @param[in]  HttpInstance       The HTTP instance private data.\r
  @param[in]  Wrap               The HTTP token's wrap data.\r
  @param[in]  Configure          The Flag indicates whether need to initialize session.\r
  @param[in]  TlsConfigure       The Flag indicates whether it's the new Tls session.\r
\r
  @retval EFI_SUCCESS            The initialization of session is done. \r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpInitSession (\r
  IN  HTTP_PROTOCOL    *HttpInstance,\r
  IN  HTTP_TOKEN_WRAP  *Wrap,\r
  IN  BOOLEAN          Configure,\r
  IN  BOOLEAN          TlsConfigure\r
  );\r
\r
/**\r
  Transmit the HTTP or HTTPS mssage by processing the associated HTTP token.\r
\r
  @param[in]  Map                The container of TxToken or Tx6Token.\r
  @param[in]  Item               Current item to check against.\r
  @param[in]  Context            The Token to check againist.\r
\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources.\r
  @retval EFI_SUCCESS            The HTTP message is queued into TCP transmit\r
                                 queue.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpTcpTransmit (\r
  IN NET_MAP                *Map,\r
  IN NET_MAP_ITEM           *Item,\r
  IN VOID                   *Context\r
  );\r
\r
/**\r
  Receive the HTTP response by processing the associated HTTP token.\r
\r
  @param[in]  Map                The container of Rx4Token or Rx6Token.\r
  @param[in]  Item               Current item to check against.\r
  @param[in]  Context            The Token to check againist.\r
\r
  @retval EFI_SUCCESS            The HTTP response is queued into TCP receive\r
                                 queue.\r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
HttpTcpReceive (\r
  IN NET_MAP                *Map,\r
  IN NET_MAP_ITEM           *Item,\r
  IN VOID                   *Context\r
  );\r
\r
/**\r
  Receive the HTTP header by processing the associated HTTP token.\r
\r
  @param[in]       HttpInstance    The HTTP instance private data.\r
  @param[in, out]  SizeofHeaders   The HTTP header length.\r
  @param[in, out]  BufferSize      The size of buffer to cacahe the header message.\r
  @param[in]       Timeout         The time to wait for receiving the header packet.\r
\r
  @retval EFI_SUCCESS              The HTTP header is received.                          \r
  @retval Others                   Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpTcpReceiveHeader (\r
  IN  HTTP_PROTOCOL         *HttpInstance,\r
  IN  OUT UINTN             *SizeofHeaders,\r
  IN  OUT UINTN             *BufferSize,\r
  IN  EFI_EVENT             Timeout\r
  );\r
\r
/**\r
  Receive the HTTP body by processing the associated HTTP token.\r
\r
  @param[in]  Wrap               The HTTP token's wrap data.\r
  @param[in]  HttpMsg            The HTTP message data.\r
\r
  @retval EFI_SUCCESS            The HTTP body is received.                          \r
  @retval Others                 Other error as indicated.\r
\r
**/\r
EFI_STATUS\r
HttpTcpReceiveBody (\r
  IN  HTTP_TOKEN_WRAP       *Wrap,\r
  IN  EFI_HTTP_MESSAGE      *HttpMsg\r
  );\r
\r
/**\r
  Clean up Tcp Tokens while the Tcp transmission error occurs.\r
\r
  @param[in]  Wrap               Pointer to HTTP token's wrap data.\r
  \r
**/\r
VOID\r
HttpTcpTokenCleanup (\r
  IN  HTTP_TOKEN_WRAP      *Wrap\r
  );\r
\r
/**\r
  The work function of EfiHttpResponse().\r
\r
  @param[in]  Wrap                Pointer to HTTP token's wrap data.\r
\r
  @retval EFI_SUCCESS             Allocation succeeded.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to complete the opration due to lack of resources.\r
  @retval EFI_NOT_READY           Can't find a corresponding TxToken.\r
\r
**/\r
EFI_STATUS\r
HttpResponseWorker (\r
  IN  HTTP_TOKEN_WRAP           *Wrap\r
  );\r
\r
#endif\r
Commit	Line	Data
47f51a06 YT	1	/** @file\r
	2	The header files of miscellaneous routines for HttpDxe driver.\r
	3	\r
7cf59c85	4	Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>\r
f58554fc	5	(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
47f51a06 YT	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef __EFI_HTTP_PROTO_H__\r
	17	#define __EFI_HTTP_PROTO_H__\r
	18	\r
	19	#define DEF_BUF_LEN 2048\r
	20	\r
	21	#define HTTP_SERVICE_SIGNATURE SIGNATURE_32('H', 't', 't', 'S')\r
	22	\r
	23	#define HTTP_SERVICE_FROM_PROTOCOL(a) \\r
	24	CR ( \\r
	25	(a), \\r
	26	HTTP_SERVICE, \\r
	27	ServiceBinding, \\r
	28	HTTP_SERVICE_SIGNATURE \\r
	29	)\r
	30	\r
b659408b	31	\r
47f51a06 YT	32	//\r
	33	// The state of HTTP protocol. It starts from UNCONFIGED.\r
	34	//\r
	35	#define HTTP_STATE_UNCONFIGED 0\r
	36	#define HTTP_STATE_HTTP_CONFIGED 1\r
	37	#define HTTP_STATE_TCP_CONFIGED 2\r
	38	#define HTTP_STATE_TCP_UNCONFIGED 3\r
	39	#define HTTP_STATE_TCP_CONNECTED 4\r
	40	#define HTTP_STATE_TCP_CLOSED 5\r
	41	\r
	42	//\r
	43	// TCP configured data.\r
	44	//\r
	45	#define HTTP_TOS_DEAULT 8\r
	46	#define HTTP_TTL_DEAULT 255\r
	47	#define HTTP_BUFFER_SIZE_DEAULT 65535\r
	48	#define HTTP_MAX_SYN_BACK_LOG 5\r
	49	#define HTTP_CONNECTION_TIMEOUT 60\r
b347a22a	50	#define HTTP_RESPONSE_TIMEOUT 5\r
47f51a06 YT	51	#define HTTP_DATA_RETRIES 12\r
	52	#define HTTP_FIN_TIMEOUT 2\r
	53	#define HTTP_KEEP_ALIVE_PROBES 6\r
	54	#define HTTP_KEEP_ALIVE_TIME 7200\r
	55	#define HTTP_KEEP_ALIVE_INTERVAL 30\r
	56	\r
51b0450e FS	57	#define HTTP_URL_BUFFER_LEN 4096\r
51b0450e FS	58	\r
47f51a06 YT	59	typedef struct _HTTP_SERVICE {\r
	60	UINT32 Signature;\r
	61	EFI_SERVICE_BINDING_PROTOCOL ServiceBinding;\r
7cf59c85 ZL	62	EFI_HANDLE Ip4DriverBindingHandle;\r
7cf59c85 ZL	63	EFI_HANDLE Ip6DriverBindingHandle;\r
47f51a06	64	EFI_HANDLE ControllerHandle;\r
b659408b ZL	65	EFI_HANDLE Tcp4ChildHandle;\r
b659408b ZL	66	EFI_HANDLE Tcp6ChildHandle;\r
47f51a06 YT	67	LIST_ENTRY ChildrenList;\r
47f51a06 YT	68	UINTN ChildrenNumber;\r
47f51a06 YT	69	INTN State;\r
	70	} HTTP_SERVICE;\r
	71	\r
	72	typedef struct {\r
b659408b ZL	73	EFI_TCP4_IO_TOKEN Tx4Token;\r
	74	EFI_TCP4_TRANSMIT_DATA Tx4Data;\r
	75	EFI_TCP6_IO_TOKEN Tx6Token;\r
	76	EFI_TCP6_TRANSMIT_DATA Tx6Data;\r
	77	EFI_TCP4_IO_TOKEN Rx4Token;\r
	78	EFI_TCP4_RECEIVE_DATA Rx4Data;\r
	79	EFI_TCP6_IO_TOKEN Rx6Token;\r
	80	EFI_TCP6_RECEIVE_DATA Rx6Data;\r
47f51a06	81	BOOLEAN IsTxDone;\r
47f51a06 YT	82	BOOLEAN IsRxDone;\r
	83	UINTN BodyLen;\r
	84	EFI_HTTP_METHOD Method;\r
	85	} HTTP_TCP_TOKEN_WRAP;\r
	86	\r
dac45de3 JW	87	typedef struct {\r
	88	EFI_TLS_VERSION Version;\r
	89	EFI_TLS_CONNECTION_END ConnectionEnd;\r
	90	EFI_TLS_VERIFY VerifyMethod;\r
	91	EFI_TLS_SESSION_STATE SessionState;\r
	92	} TLS_CONFIG_DATA;\r
	93	\r
47f51a06 YT	94	typedef struct _HTTP_PROTOCOL {\r
	95	UINT32 Signature;\r
	96	EFI_HTTP_PROTOCOL Http;\r
	97	EFI_HANDLE Handle;\r
	98	HTTP_SERVICE *Service;\r
	99	LIST_ENTRY Link; // Link to all HTTP instance from the service.\r
	100	BOOLEAN InDestroy;\r
	101	INTN State;\r
d8293d31	102	EFI_HTTP_METHOD Method;\r
47f51a06	103	\r
072289f4 ZL	104	UINTN StatusCode;\r
072289f4 ZL	105	\r
b347a22a JW	106	EFI_EVENT TimeoutEvent;\r
b347a22a JW	107	\r
b659408b	108	EFI_HANDLE Tcp4ChildHandle;\r
47f51a06 YT	109	EFI_TCP4_PROTOCOL *Tcp4;\r
	110	EFI_TCP4_CONFIG_DATA Tcp4CfgData;\r
	111	EFI_TCP4_OPTION Tcp4Option;\r
	112	\r
b659408b ZL	113	EFI_TCP4_CONNECTION_TOKEN Tcp4ConnToken;\r
	114	BOOLEAN IsTcp4ConnDone;\r
	115	EFI_TCP4_CLOSE_TOKEN Tcp4CloseToken;\r
	116	BOOLEAN IsTcp4CloseDone;\r
47f51a06 YT	117	CHAR8 *RemoteHost;\r
	118	UINT16 RemotePort;\r
	119	EFI_IPv4_ADDRESS RemoteAddr;\r
b659408b ZL	120	\r
	121	EFI_HANDLE Tcp6ChildHandle;\r
	122	EFI_TCP6_PROTOCOL *Tcp6;\r
	123	EFI_TCP6_CONFIG_DATA Tcp6CfgData;\r
	124	EFI_TCP6_OPTION Tcp6Option;\r
	125	\r
	126	EFI_TCP6_CONNECTION_TOKEN Tcp6ConnToken;\r
	127	BOOLEAN IsTcp6ConnDone;\r
	128	EFI_TCP6_CLOSE_TOKEN Tcp6CloseToken;\r
	129	BOOLEAN IsTcp6CloseDone;\r
	130	EFI_IPv6_ADDRESS RemoteIpv6Addr;\r
b347a22a	131	\r
47f51a06	132	//\r
b659408b	133	// Rx4Token or Rx6Token used for receiving HTTP header.\r
47f51a06	134	//\r
b659408b ZL	135	EFI_TCP4_IO_TOKEN Rx4Token;\r
	136	EFI_TCP4_RECEIVE_DATA Rx4Data;\r
	137	EFI_TCP6_IO_TOKEN Rx6Token;\r
	138	EFI_TCP6_RECEIVE_DATA Rx6Data;\r
47f51a06 YT	139	BOOLEAN IsRxDone;\r
47f51a06 YT	140	\r
b659408b ZL	141	CHAR8 **EndofHeader;\r
b659408b ZL	142	CHAR8 **HttpHeaders;\r
47f51a06 YT	143	CHAR8 *CacheBody;\r
	144	CHAR8 *NextMsg;\r
	145	UINTN CacheLen;\r
	146	UINTN CacheOffset;\r
	147	\r
	148	//\r
	149	// HTTP message-body parser.\r
	150	//\r
	151	VOID *MsgParser;\r
	152	\r
	153	EFI_HTTP_VERSION HttpVersion;\r
	154	UINT32 TimeOutMillisec;\r
	155	BOOLEAN LocalAddressIsIPv6;\r
	156	\r
	157	EFI_HTTPv4_ACCESS_POINT IPv4Node;\r
b659408b	158	EFI_HTTPv6_ACCESS_POINT Ipv6Node;\r
47f51a06 YT	159	\r
	160	NET_MAP TxTokens;\r
	161	NET_MAP RxTokens;\r
51b0450e FS	162	\r
51b0450e FS	163	CHAR8 *Url;\r
dac45de3 JW	164	\r
	165	//\r
	166	// Https Support\r
	167	//\r
	168	BOOLEAN UseHttps;\r
	169	\r
	170	EFI_HANDLE TlsChildHandle; /// Tls ChildHandle\r
	171	TLS_CONFIG_DATA TlsConfigData;\r
	172	EFI_TLS_PROTOCOL *Tls;\r
	173	EFI_TLS_CONFIGURATION_PROTOCOL *TlsConfiguration;\r
	174	EFI_TLS_SESSION_STATE TlsSessionState;\r
	175	\r
	176	//\r
	177	// TlsTxData used for transmitting TLS related messages.\r
	178	//\r
	179	EFI_TCP4_IO_TOKEN Tcp4TlsTxToken;\r
	180	EFI_TCP4_TRANSMIT_DATA Tcp4TlsTxData;\r
	181	EFI_TCP6_IO_TOKEN Tcp6TlsTxToken;\r
	182	EFI_TCP6_TRANSMIT_DATA Tcp6TlsTxData;\r
	183	BOOLEAN TlsIsTxDone;\r
	184	\r
	185	//\r
	186	// TlsRxData used for receiving TLS related messages.\r
	187	//\r
	188	EFI_TCP4_IO_TOKEN Tcp4TlsRxToken;\r
	189	EFI_TCP4_RECEIVE_DATA Tcp4TlsRxData;\r
	190	EFI_TCP6_IO_TOKEN Tcp6TlsRxToken;\r
	191	EFI_TCP6_RECEIVE_DATA Tcp6TlsRxData;\r
	192	BOOLEAN TlsIsRxDone;\r
47f51a06 YT	193	} HTTP_PROTOCOL;\r
	194	\r
	195	typedef struct {\r
	196	EFI_HTTP_TOKEN *HttpToken;\r
	197	HTTP_PROTOCOL *HttpInstance;\r
	198	HTTP_TCP_TOKEN_WRAP TcpWrap;\r
	199	} HTTP_TOKEN_WRAP;\r
	200	\r
	201	\r
	202	#define HTTP_PROTOCOL_SIGNATURE SIGNATURE_32('H', 't', 't', 'P')\r
	203	\r
	204	#define HTTP_INSTANCE_FROM_PROTOCOL(a) \\r
	205	CR ( \\r
	206	(a), \\r
	207	HTTP_PROTOCOL, \\r
	208	Http, \\r
	209	HTTP_PROTOCOL_SIGNATURE \\r
	210	)\r
	211	\r
	212	/**\r
	213	The common notify function used in HTTP driver. \r
	214	\r
	215	@param[in] Event The event signaled.\r
	216	@param[in] Context The context.\r
	217	\r
	218	**/\r
	219	VOID\r
	220	EFIAPI\r
	221	HttpCommonNotify (\r
	222	IN EFI_EVENT Event,\r
	223	IN VOID *Context\r
	224	);\r
	225	\r
	226	/**\r
b659408b	227	Create events for the TCP connection token and TCP close token.\r
47f51a06 YT	228	\r
	229	@param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.\r
	230	\r
	231	@retval EFI_SUCCESS The events are created successfully.\r
	232	@retval others Other error as indicated.\r
	233	\r
	234	**/\r
	235	EFI_STATUS\r
b659408b	236	HttpCreateTcpConnCloseEvent (\r
47f51a06 YT	237	IN HTTP_PROTOCOL *HttpInstance\r
	238	);\r
	239	\r
	240	/**\r
b659408b	241	Close events in the TCP connection token and TCP close token.\r
47f51a06 YT	242	\r
	243	@param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.\r
	244	\r
	245	**/\r
	246	VOID\r
b659408b	247	HttpCloseTcpConnCloseEvent (\r
47f51a06 YT	248	IN HTTP_PROTOCOL *HttpInstance\r
	249	);\r
	250	\r
	251	/**\r
b659408b	252	Create event for the TCP transmit token.\r
47f51a06 YT	253	\r
	254	@param[in] Wrap Point to HTTP token's wrap data.\r
	255	\r
	256	@retval EFI_SUCCESS The events is created successfully.\r
	257	@retval others Other error as indicated.\r
	258	\r
	259	**/\r
	260	EFI_STATUS\r
b659408b	261	HttpCreateTcpTxEvent (\r
47f51a06 YT	262	IN HTTP_TOKEN_WRAP *Wrap\r
	263	);\r
	264	\r
	265	/**\r
b659408b	266	Create event for the TCP receive token which is used to receive HTTP header.\r
47f51a06 YT	267	\r
	268	@param[in] HttpInstance Pointer to HTTP_PROTOCOL structure.\r
	269	\r
	270	@retval EFI_SUCCESS The events is created successfully.\r
	271	@retval others Other error as indicated.\r
	272	\r
	273	**/\r
	274	EFI_STATUS\r
b659408b	275	HttpCreateTcpRxEventForHeader (\r
47f51a06 YT	276	IN HTTP_PROTOCOL *HttpInstance\r
	277	);\r
	278	\r
	279	/**\r
b659408b	280	Create event for the TCP receive token which is used to receive HTTP body.\r
47f51a06 YT	281	\r
	282	@param[in] Wrap Point to HTTP token's wrap data.\r
	283	\r
	284	@retval EFI_SUCCESS The events is created successfully.\r
	285	@retval others Other error as indicated.\r
	286	\r
	287	**/\r
	288	EFI_STATUS\r
b659408b	289	HttpCreateTcpRxEvent (\r
47f51a06 YT	290	IN HTTP_TOKEN_WRAP *Wrap \r
	291	);\r
	292	\r
b659408b ZL	293	/**\r
	294	Close Events for Tcp Receive Tokens for HTTP body and HTTP header.\r
	295	\r
	296	@param[in] Wrap Pointer to HTTP token's wrap data.\r
	297	\r
	298	**/\r
	299	VOID\r
	300	HttpCloseTcpRxEvent (\r
	301	IN HTTP_TOKEN_WRAP *Wrap\r
	302	);\r
	303	\r
47f51a06 YT	304	/**\r
	305	Intiialize the HTTP_PROTOCOL structure to the unconfigured state.\r
	306	\r
47f51a06	307	@param[in, out] HttpInstance Pointer to HTTP_PROTOCOL structure.\r
b659408b	308	@param[in] IpVersion Indicate us TCP4 protocol or TCP6 protocol.\r
47f51a06 YT	309	\r
	310	@retval EFI_SUCCESS HTTP_PROTOCOL structure is initialized successfully. \r
	311	@retval Others Other error as indicated.\r
	312	\r
	313	**/\r
	314	EFI_STATUS\r
	315	HttpInitProtocol (\r
b659408b ZL	316	IN OUT HTTP_PROTOCOL *HttpInstance,\r
b659408b ZL	317	IN BOOLEAN IpVersion\r
47f51a06 YT	318	);\r
	319	\r
	320	/**\r
	321	Clean up the HTTP child, release all the resources used by it.\r
	322	\r
	323	@param[in] HttpInstance The HTTP child to clean up.\r
	324	\r
	325	**/\r
	326	VOID\r
	327	HttpCleanProtocol (\r
	328	IN HTTP_PROTOCOL *HttpInstance\r
	329	);\r
	330	\r
	331	/**\r
	332	Establish TCP connection with HTTP server.\r
	333	\r
	334	@param[in] HttpInstance The HTTP instance private data.\r
	335	\r
	336	@retval EFI_SUCCESS The TCP connection is established.\r
	337	@retval Others Other error as indicated.\r
	338	\r
	339	**/\r
	340	EFI_STATUS\r
	341	HttpCreateConnection (\r
	342	IN HTTP_PROTOCOL *HttpInstance\r
	343	);\r
	344	\r
	345	/**\r
	346	Close existing TCP connection.\r
	347	\r
	348	@param[in] HttpInstance The HTTP instance private data.\r
	349	\r
	350	@retval EFI_SUCCESS The TCP connection is closed.\r
	351	@retval Others Other error as indicated.\r
	352	\r
	353	**/\r
	354	EFI_STATUS\r
	355	HttpCloseConnection (\r
	356	IN HTTP_PROTOCOL *HttpInstance\r
	357	);\r
	358	\r
	359	/**\r
	360	Configure TCP4 protocol child.\r
	361	\r
	362	@param[in] HttpInstance The HTTP instance private data.\r
	363	@param[in] Wrap The HTTP token's wrap data.\r
	364	\r
	365	@retval EFI_SUCCESS The TCP4 protocol child is configured.\r
	366	@retval Others Other error as indicated.\r
	367	\r
	368	**/\r
	369	EFI_STATUS\r
	370	HttpConfigureTcp4 (\r
	371	IN HTTP_PROTOCOL *HttpInstance,\r
	372	IN HTTP_TOKEN_WRAP *Wrap\r
	373	);\r
	374	\r
b659408b ZL	375	/**\r
	376	Configure TCP6 protocol child.\r
	377	\r
	378	@param[in] HttpInstance The HTTP instance private data.\r
	379	@param[in] Wrap The HTTP token's wrap data.\r
	380	\r
	381	@retval EFI_SUCCESS The TCP6 protocol child is configured.\r
	382	@retval Others Other error as indicated.\r
	383	\r
	384	**/\r
	385	EFI_STATUS\r
	386	HttpConfigureTcp6 (\r
	387	IN HTTP_PROTOCOL *HttpInstance,\r
	388	IN HTTP_TOKEN_WRAP *Wrap\r
	389	);\r
	390	\r
47f51a06	391	/**\r
dac45de3 JW	392	Check existing TCP connection, if in error state, recover TCP4 connection. Then, \r
dac45de3 JW	393	connect one TLS session if required.\r
47f51a06 YT	394	\r
	395	@param[in] HttpInstance The HTTP instance private data.\r
	396	\r
	397	@retval EFI_SUCCESS The TCP connection is established.\r
	398	@retval EFI_NOT_READY TCP4 protocol child is not created or configured.\r
	399	@retval Others Other error as indicated.\r
	400	\r
	401	**/\r
	402	EFI_STATUS\r
	403	HttpConnectTcp4 (\r
	404	IN HTTP_PROTOCOL *HttpInstance\r
	405	);\r
	406	\r
	407	/**\r
dac45de3 JW	408	Check existing TCP connection, if in error state, recover TCP6 connection. Then, \r
dac45de3 JW	409	connect one TLS session if required.\r
b659408b ZL	410	\r
	411	@param[in] HttpInstance The HTTP instance private data.\r
	412	\r
	413	@retval EFI_SUCCESS The TCP connection is established.\r
	414	@retval EFI_NOT_READY TCP6 protocol child is not created or configured.\r
	415	@retval Others Other error as indicated.\r
	416	\r
	417	**/\r
	418	EFI_STATUS\r
	419	HttpConnectTcp6 (\r
	420	IN HTTP_PROTOCOL *HttpInstance\r
	421	);\r
	422	\r
	423	/**\r
dac45de3	424	Send the HTTP or HTTPS message through TCP4 or TCP6.\r
47f51a06 YT	425	\r
	426	@param[in] HttpInstance The HTTP instance private data.\r
	427	@param[in] Wrap The HTTP token's wrap data.\r
	428	@param[in] TxString Buffer containing the HTTP message string.\r
	429	@param[in] TxStringLen Length of the HTTP message string in bytes.\r
	430	\r
	431	@retval EFI_SUCCESS The HTTP message is queued into TCP transmit queue.\r
	432	@retval Others Other error as indicated.\r
	433	\r
	434	**/\r
	435	EFI_STATUS\r
b659408b	436	HttpTransmitTcp (\r
47f51a06 YT	437	IN HTTP_PROTOCOL *HttpInstance,\r
	438	IN HTTP_TOKEN_WRAP *Wrap,\r
	439	IN UINT8 *TxString,\r
	440	IN UINTN TxStringLen\r
	441	);\r
	442	\r
47f51a06 YT	443	/**\r
47f51a06 YT	444	Check whether the user's token or event has already\r
b659408b	445	been enqueue on HTTP Tx or Rx Token list.\r
47f51a06 YT	446	\r
	447	@param[in] Map The container of either user's transmit or receive\r
	448	token.\r
	449	@param[in] Item Current item to check against.\r
	450	@param[in] Context The Token to check againist.\r
	451	\r
	452	@retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP\r
	453	@retval EFI_SUCCESS The current item isn't the same token/event as the\r
	454	context.\r
	455	\r
	456	**/\r
	457	EFI_STATUS\r
	458	EFIAPI\r
	459	HttpTokenExist (\r
	460	IN NET_MAP *Map,\r
	461	IN NET_MAP_ITEM *Item,\r
	462	IN VOID *Context\r
	463	);\r
	464	\r
	465	/**\r
b659408b	466	Check whether the HTTP message associated with TxToken or Tx6Token is already sent out.\r
47f51a06 YT	467	\r
	468	@param[in] Map The container of TxToken.\r
	469	@param[in] Item Current item to check against.\r
	470	@param[in] Context The Token to check againist.\r
	471	\r
	472	@retval EFI_NOT_READY The HTTP message is still queued in the list.\r
	473	@retval EFI_SUCCESS The HTTP message has been sent out.\r
	474	\r
	475	**/\r
	476	EFI_STATUS\r
	477	EFIAPI\r
	478	HttpTcpNotReady (\r
	479	IN NET_MAP *Map,\r
	480	IN NET_MAP_ITEM *Item,\r
	481	IN VOID *Context\r
	482	);\r
	483	\r
b659408b	484	/**\r
dac45de3	485	Initialize Http session.\r
b659408b ZL	486	\r
	487	@param[in] HttpInstance The HTTP instance private data.\r
	488	@param[in] Wrap The HTTP token's wrap data.\r
dac45de3 JW	489	@param[in] Configure The Flag indicates whether need to initialize session.\r
dac45de3 JW	490	@param[in] TlsConfigure The Flag indicates whether it's the new Tls session.\r
b659408b	491	\r
dac45de3	492	@retval EFI_SUCCESS The initialization of session is done. \r
b659408b ZL	493	@retval Others Other error as indicated.\r
	494	\r
	495	**/\r
	496	EFI_STATUS\r
dac45de3	497	HttpInitSession (\r
b659408b	498	IN HTTP_PROTOCOL *HttpInstance,\r
a2e61982	499	IN HTTP_TOKEN_WRAP *Wrap,\r
dac45de3 JW	500	IN BOOLEAN Configure,\r
dac45de3 JW	501	IN BOOLEAN TlsConfigure\r
b659408b ZL	502	);\r
b659408b ZL	503	\r
47f51a06	504	/**\r
dac45de3	505	Transmit the HTTP or HTTPS mssage by processing the associated HTTP token.\r
47f51a06	506	\r
b659408b	507	@param[in] Map The container of TxToken or Tx6Token.\r
47f51a06 YT	508	@param[in] Item Current item to check against.\r
	509	@param[in] Context The Token to check againist.\r
	510	\r
	511	@retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r
	512	@retval EFI_SUCCESS The HTTP message is queued into TCP transmit\r
	513	queue.\r
	514	\r
	515	**/\r
	516	EFI_STATUS\r
	517	EFIAPI\r
	518	HttpTcpTransmit (\r
	519	IN NET_MAP *Map,\r
	520	IN NET_MAP_ITEM *Item,\r
	521	IN VOID *Context\r
	522	);\r
	523	\r
	524	/**\r
	525	Receive the HTTP response by processing the associated HTTP token.\r
	526	\r
b659408b	527	@param[in] Map The container of Rx4Token or Rx6Token.\r
47f51a06 YT	528	@param[in] Item Current item to check against.\r
	529	@param[in] Context The Token to check againist.\r
	530	\r
	531	@retval EFI_SUCCESS The HTTP response is queued into TCP receive\r
	532	queue.\r
	533	@retval Others Other error as indicated.\r
	534	\r
	535	**/\r
	536	EFI_STATUS\r
	537	EFIAPI\r
	538	HttpTcpReceive (\r
	539	IN NET_MAP *Map,\r
	540	IN NET_MAP_ITEM *Item,\r
	541	IN VOID *Context\r
	542	);\r
	543	\r
b659408b ZL	544	/**\r
	545	Receive the HTTP header by processing the associated HTTP token.\r
	546	\r
	547	@param[in] HttpInstance The HTTP instance private data.\r
	548	@param[in, out] SizeofHeaders The HTTP header length.\r
	549	@param[in, out] BufferSize The size of buffer to cacahe the header message.\r
b347a22a	550	@param[in] Timeout The time to wait for receiving the header packet.\r
b659408b ZL	551	\r
	552	@retval EFI_SUCCESS The HTTP header is received. \r
	553	@retval Others Other errors as indicated.\r
	554	\r
	555	**/\r
	556	EFI_STATUS\r
	557	HttpTcpReceiveHeader (\r
	558	IN HTTP_PROTOCOL *HttpInstance,\r
	559	IN OUT UINTN *SizeofHeaders,\r
b347a22a JW	560	IN OUT UINTN *BufferSize,\r
b347a22a JW	561	IN EFI_EVENT Timeout\r
b659408b ZL	562	);\r
	563	\r
	564	/**\r
	565	Receive the HTTP body by processing the associated HTTP token.\r
	566	\r
	567	@param[in] Wrap The HTTP token's wrap data.\r
	568	@param[in] HttpMsg The HTTP message data.\r
	569	\r
	570	@retval EFI_SUCCESS The HTTP body is received. \r
	571	@retval Others Other error as indicated.\r
	572	\r
	573	**/\r
	574	EFI_STATUS\r
	575	HttpTcpReceiveBody (\r
	576	IN HTTP_TOKEN_WRAP *Wrap,\r
30526a51	577	IN EFI_HTTP_MESSAGE *HttpMsg\r
b659408b ZL	578	);\r
	579	\r
	580	/**\r
	581	Clean up Tcp Tokens while the Tcp transmission error occurs.\r
	582	\r
	583	@param[in] Wrap Pointer to HTTP token's wrap data.\r
	584	\r
	585	**/\r
	586	VOID\r
	587	HttpTcpTokenCleanup (\r
	588	IN HTTP_TOKEN_WRAP *Wrap\r
	589	);\r
	590	\r
47f51a06 YT	591	/**\r
	592	The work function of EfiHttpResponse().\r
	593	\r
	594	@param[in] Wrap Pointer to HTTP token's wrap data.\r
	595	\r
	596	@retval EFI_SUCCESS Allocation succeeded.\r
	597	@retval EFI_OUT_OF_RESOURCES Failed to complete the opration due to lack of resources.\r
	598	@retval EFI_NOT_READY Can't find a corresponding TxToken.\r
	599	\r
	600	**/\r
	601	EFI_STATUS\r
	602	HttpResponseWorker (\r
	603	IN HTTP_TOKEN_WRAP *Wrap\r
	604	);\r
	605	\r
	606	#endif\r