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

/** @file\r
  The header files of implementation of EFI_HTTP_PROTOCOL protocol interfaces.\r
\r
  Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
  (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>  \r
\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_IMPL_H__\r
#define __EFI_HTTP_IMPL_H__\r
\r
#define HTTP_DEFAULT_PORT        80\r
#define HTTP_END_OF_HDR_STR      "\r\n\r\n"\r
#define HTTP_CRLF_STR            "\r\n"\r
#define HTTP_VERSION_STR         HTTP_VERSION\r
#define HTTP_VERSION_CRLF_STR    " HTTP/1.1\r\n"\r
#define HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE         300\r
\r
\r
/**\r
  Returns the operational parameters for the current HTTP child instance.\r
\r
  The GetModeData() function is used to read the current mode data (operational\r
  parameters) for this HTTP protocol instance.\r
\r
  @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.\r
  @param[out] HttpConfigData      Point to buffer for operational parameters of this\r
                                  HTTP instance.\r
\r
  @retval EFI_SUCCESS             Operation succeeded.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  HttpConfigData is NULL.\r
                                  HttpInstance->LocalAddressIsIPv6 is FALSE and\r
                                  HttpConfigData->IPv4Node is NULL.\r
                                  HttpInstance->LocalAddressIsIPv6 is TRUE and\r
                                  HttpConfigData->IPv6Node is NULL.\r
  @retval EFI_NOT_STARTED         This EFI HTTP Protocol instance has not been started.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiHttpGetModeData (\r
  IN  EFI_HTTP_PROTOCOL         *This,\r
  OUT EFI_HTTP_CONFIG_DATA      *HttpConfigData\r
  );\r
\r
/**\r
  Initialize or brutally reset the operational parameters for this EFI HTTP instance.\r
\r
  The Configure() function does the following:\r
  When HttpConfigData is not NULL Initialize this EFI HTTP instance by configuring\r
  timeout, local address, port, etc.\r
  When HttpConfigData is NULL, reset this EFI HTTP instance by closing all active\r
  connections with remote hosts, canceling all asynchronous tokens, and flush request\r
  and response buffers without informing the appropriate hosts.\r
\r
  No other EFI HTTP function can be executed by this instance until the Configure() \r
  function is executed and returns successfully.\r
\r
  @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.\r
  @param[in]  HttpConfigData      Pointer to the configure data to configure the instance.\r
\r
  @retval EFI_SUCCESS             Operation succeeded.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  HttpConfigData is NULL.\r
                                  HttpConfigData->LocalAddressIsIPv6 is FALSE and\r
                                  HttpConfigData->IPv4Node is NULL.\r
                                  HttpConfigData->LocalAddressIsIPv6 is TRUE and\r
                                  HttpConfigData->IPv6Node is NULL.\r
  @retval EFI_ALREADY_STARTED     Reinitialize this HTTP instance without calling\r
                                  Configure() with NULL to reset it.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate enough system resources when\r
                                  executing Configure().\r
  @retval EFI_UNSUPPORTED         One or more options in ConfigData are not supported\r
                                  in the implementation.\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiHttpConfigure (\r
  IN  EFI_HTTP_PROTOCOL         *This,\r
  IN  EFI_HTTP_CONFIG_DATA      *HttpConfigData\r
  );\r
\r
/**\r
  The Request() function queues an HTTP request to this HTTP instance.\r
\r
  Similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent\r
  successfully, or if there is an error, Status in token will be updated and Event will\r
  be signaled.\r
\r
  @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.\r
  @param[in]  Token               Pointer to storage containing HTTP request token.\r
\r
  @retval EFI_SUCCESS             Outgoing data was processed.\r
  @retval EFI_NOT_STARTED         This EFI HTTP Protocol instance has not been started.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.\r
  @retval EFI_TIMEOUT             Data was dropped out of the transmit or receive queue.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate enough system resources.\r
  @retval EFI_UNSUPPORTED         The HTTP method is not supported in current\r
                                  implementation.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  Token is NULL.\r
                                  Token->Message is NULL.\r
                                  Token->Message->Body is not NULL,\r
                                  Token->Message->BodyLength is non-zero, and\r
                                  Token->Message->Data is NULL, but a previous call to\r
                                  Request()has not been completed successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiHttpRequest (\r
  IN  EFI_HTTP_PROTOCOL         *This,\r
  IN  EFI_HTTP_TOKEN            *Token\r
  );\r
\r
/**\r
  Abort an asynchronous HTTP request or response token.\r
\r
  The Cancel() function aborts a pending HTTP request or response transaction. If\r
  Token is not NULL and the token is in transmit or receive queues when it is being\r
  cancelled, its Token->Status will be set to EFI_ABORTED and then Token->Event will\r
  be signaled. If the token is not in one of the queues, which usually means that the\r
  asynchronous operation has completed, EFI_NOT_FOUND is returned. If Token is NULL,\r
  all asynchronous tokens issued by Request() or Response() will be aborted.\r
\r
  @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.\r
  @param[in]  Token               Point to storage containing HTTP request or response\r
                                  token.\r
\r
  @retval EFI_SUCCESS             Request and Response queues are successfully flushed.\r
  @retval EFI_INVALID_PARAMETER   This is NULL.\r
  @retval EFI_NOT_STARTED         This instance hasn't been configured.\r
  @retval EFI_NOT_FOUND           The asynchronous request or response token is not\r
                                  found.\r
  @retval EFI_UNSUPPORTED         The implementation does not support this function.\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiHttpCancel (\r
  IN  EFI_HTTP_PROTOCOL         *This,\r
  IN  EFI_HTTP_TOKEN            *Token\r
  );\r
\r
/**\r
  The Response() function queues an HTTP response to this HTTP instance, similar to\r
  Receive() function in the EFI TCP driver. When the HTTP response is received successfully,\r
  or if there is an error, Status in token will be updated and Event will be signaled.\r
\r
  The HTTP driver will queue a receive token to the underlying TCP instance. When data\r
  is received in the underlying TCP instance, the data will be parsed and Token will\r
  be populated with the response data. If the data received from the remote host\r
  contains an incomplete or invalid HTTP header, the HTTP driver will continue waiting\r
  (asynchronously) for more data to be sent from the remote host before signaling\r
  Event in Token.\r
\r
  It is the responsibility of the caller to allocate a buffer for Body and specify the\r
  size in BodyLength. If the remote host provides a response that contains a content\r
  body, up to BodyLength bytes will be copied from the receive buffer into Body and\r
  BodyLength will be updated with the amount of bytes received and copied to Body. This\r
  allows the client to download a large file in chunks instead of into one contiguous\r
  block of memory. Similar to HTTP request, if Body is not NULL and BodyLength is\r
  non-zero and all other fields are NULL or 0, the HTTP driver will queue a receive\r
  token to underlying TCP instance. If data arrives in the receive buffer, up to\r
  BodyLength bytes of data will be copied to Body. The HTTP driver will then update\r
  BodyLength with the amount of bytes received and copied to Body.\r
\r
  If the HTTP driver does not have an open underlying TCP connection with the host\r
  specified in the response URL, Request() will return EFI_ACCESS_DENIED. This is\r
  consistent with RFC 2616 recommendation that HTTP clients should attempt to maintain\r
  an open TCP connection between client and host.\r
\r
  @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.\r
  @param[in]  Token               Pointer to storage containing HTTP response token.\r
\r
  @retval EFI_SUCCESS             Allocation succeeded.\r
  @retval EFI_NOT_STARTED         This EFI HTTP Protocol instance has not been\r
                                  initialized.\r
  @retval EFI_INVALID_PARAMETER   One or more of the following conditions is TRUE:\r
                                  This is NULL.\r
                                  Token is NULL.\r
                                  Token->Message->Headers is NULL.\r
                                  Token->Message is NULL.\r
                                  Token->Message->Body is not NULL,\r
                                  Token->Message->BodyLength is non-zero, and\r
                                  Token->Message->Data is NULL, but a previous call to\r
                                  Response() has not been completed successfully.\r
  @retval EFI_OUT_OF_RESOURCES    Could not allocate enough system resources.\r
  @retval EFI_ACCESS_DENIED       An open TCP connection is not present with the host\r
                                  specified by response URL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiHttpResponse (\r
  IN  EFI_HTTP_PROTOCOL         *This,\r
  IN  EFI_HTTP_TOKEN            *Token\r
  );\r
\r
/**\r
  The Poll() function can be used by network drivers and applications to increase the\r
  rate that data packets are moved between the communication devices and the transmit\r
  and receive queues.\r
\r
  In some systems, the periodic timer event in the managed network driver may not poll\r
  the underlying communications device fast enough to transmit and/or receive all data\r
  packets without missing incoming packets or dropping outgoing packets. Drivers and\r
  applications that are experiencing packet loss should try calling the Poll() function\r
  more often.\r
\r
  @param[in]  This                Pointer to EFI_HTTP_PROTOCOL instance.\r
\r
  @retval EFI_SUCCESS             Incoming or outgoing data was processed.\r
  @retval EFI_DEVICE_ERROR        An unexpected system or network error occurred.\r
  @retval EFI_INVALID_PARAMETER   This is NULL.\r
  @retval EFI_NOT_READY           No incoming or outgoing data is processed.\r
  @retval EFI_NOT_STARTED         This EFI HTTP Protocol instance has not been started.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiHttpPoll (\r
  IN  EFI_HTTP_PROTOCOL         *This\r
  );\r
\r
extern EFI_HTTP_PROTOCOL  mEfiHttpTemplate;\r
\r
#endif\r
Commit	Line	Data
47f51a06 YT	1	/** @file\r
	2	The header files of implementation of EFI_HTTP_PROTOCOL protocol interfaces.\r
	3	\r
072289f4	4	Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>\r
90f658c4	5	(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR> \r
47f51a06 YT	6	\r
	7	This program and the accompanying materials\r
	8	are licensed and made available under the terms and conditions of the BSD License\r
	9	which accompanies this distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php.\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
	15	**/\r
	16	\r
	17	#ifndef __EFI_HTTP_IMPL_H__\r
	18	#define __EFI_HTTP_IMPL_H__\r
	19	\r
	20	#define HTTP_DEFAULT_PORT 80\r
	21	#define HTTP_END_OF_HDR_STR "\r\n\r\n"\r
	22	#define HTTP_CRLF_STR "\r\n"\r
90f658c4	23	#define HTTP_VERSION_STR HTTP_VERSION\r
47f51a06	24	#define HTTP_VERSION_CRLF_STR " HTTP/1.1\r\n"\r
072289f4 ZL	25	#define HTTP_ERROR_OR_NOT_SUPPORT_STATUS_CODE 300\r
072289f4 ZL	26	\r
47f51a06 YT	27	\r
	28	/**\r
	29	Returns the operational parameters for the current HTTP child instance.\r
	30	\r
	31	The GetModeData() function is used to read the current mode data (operational\r
	32	parameters) for this HTTP protocol instance.\r
	33	\r
	34	@param[in] This Pointer to EFI_HTTP_PROTOCOL instance.\r
	35	@param[out] HttpConfigData Point to buffer for operational parameters of this\r
	36	HTTP instance.\r
	37	\r
	38	@retval EFI_SUCCESS Operation succeeded.\r
	39	@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
	40	This is NULL.\r
	41	HttpConfigData is NULL.\r
f0ab5a81 ZL	42	HttpInstance->LocalAddressIsIPv6 is FALSE and\r
	43	HttpConfigData->IPv4Node is NULL.\r
	44	HttpInstance->LocalAddressIsIPv6 is TRUE and\r
	45	HttpConfigData->IPv6Node is NULL.\r
	46	@retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.\r
47f51a06 YT	47	\r
	48	**/\r
	49	EFI_STATUS\r
	50	EFIAPI\r
	51	EfiHttpGetModeData (\r
	52	IN EFI_HTTP_PROTOCOL *This,\r
	53	OUT EFI_HTTP_CONFIG_DATA *HttpConfigData\r
	54	);\r
	55	\r
	56	/**\r
	57	Initialize or brutally reset the operational parameters for this EFI HTTP instance.\r
	58	\r
	59	The Configure() function does the following:\r
	60	When HttpConfigData is not NULL Initialize this EFI HTTP instance by configuring\r
	61	timeout, local address, port, etc.\r
	62	When HttpConfigData is NULL, reset this EFI HTTP instance by closing all active\r
	63	connections with remote hosts, canceling all asynchronous tokens, and flush request\r
	64	and response buffers without informing the appropriate hosts.\r
	65	\r
f0ab5a81 ZL	66	No other EFI HTTP function can be executed by this instance until the Configure() \r
f0ab5a81 ZL	67	function is executed and returns successfully.\r
47f51a06 YT	68	\r
	69	@param[in] This Pointer to EFI_HTTP_PROTOCOL instance.\r
	70	@param[in] HttpConfigData Pointer to the configure data to configure the instance.\r
	71	\r
	72	@retval EFI_SUCCESS Operation succeeded.\r
	73	@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
	74	This is NULL.\r
f0ab5a81	75	HttpConfigData is NULL.\r
47f51a06 YT	76	HttpConfigData->LocalAddressIsIPv6 is FALSE and\r
	77	HttpConfigData->IPv4Node is NULL.\r
	78	HttpConfigData->LocalAddressIsIPv6 is TRUE and\r
	79	HttpConfigData->IPv6Node is NULL.\r
	80	@retval EFI_ALREADY_STARTED Reinitialize this HTTP instance without calling\r
	81	Configure() with NULL to reset it.\r
	82	@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
	83	@retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources when\r
	84	executing Configure().\r
	85	@retval EFI_UNSUPPORTED One or more options in ConfigData are not supported\r
	86	in the implementation.\r
	87	**/\r
	88	EFI_STATUS\r
	89	EFIAPI\r
	90	EfiHttpConfigure (\r
	91	IN EFI_HTTP_PROTOCOL *This,\r
	92	IN EFI_HTTP_CONFIG_DATA *HttpConfigData\r
	93	);\r
	94	\r
	95	/**\r
	96	The Request() function queues an HTTP request to this HTTP instance.\r
	97	\r
	98	Similar to Transmit() function in the EFI TCP driver. When the HTTP request is sent\r
	99	successfully, or if there is an error, Status in token will be updated and Event will\r
	100	be signaled.\r
	101	\r
	102	@param[in] This Pointer to EFI_HTTP_PROTOCOL instance.\r
	103	@param[in] Token Pointer to storage containing HTTP request token.\r
	104	\r
	105	@retval EFI_SUCCESS Outgoing data was processed.\r
	106	@retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.\r
	107	@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
	108	@retval EFI_TIMEOUT Data was dropped out of the transmit or receive queue.\r
	109	@retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.\r
	110	@retval EFI_UNSUPPORTED The HTTP method is not supported in current\r
	111	implementation.\r
	112	@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
	113	This is NULL.\r
f0ab5a81	114	Token is NULL.\r
47f51a06 YT	115	Token->Message is NULL.\r
	116	Token->Message->Body is not NULL,\r
	117	Token->Message->BodyLength is non-zero, and\r
	118	Token->Message->Data is NULL, but a previous call to\r
	119	Request()has not been completed successfully.\r
	120	**/\r
	121	EFI_STATUS\r
	122	EFIAPI\r
	123	EfiHttpRequest (\r
	124	IN EFI_HTTP_PROTOCOL *This,\r
	125	IN EFI_HTTP_TOKEN *Token\r
	126	);\r
	127	\r
	128	/**\r
	129	Abort an asynchronous HTTP request or response token.\r
	130	\r
	131	The Cancel() function aborts a pending HTTP request or response transaction. If\r
	132	Token is not NULL and the token is in transmit or receive queues when it is being\r
	133	cancelled, its Token->Status will be set to EFI_ABORTED and then Token->Event will\r
	134	be signaled. If the token is not in one of the queues, which usually means that the\r
	135	asynchronous operation has completed, EFI_NOT_FOUND is returned. If Token is NULL,\r
	136	all asynchronous tokens issued by Request() or Response() will be aborted.\r
	137	\r
	138	@param[in] This Pointer to EFI_HTTP_PROTOCOL instance.\r
	139	@param[in] Token Point to storage containing HTTP request or response\r
	140	token.\r
	141	\r
	142	@retval EFI_SUCCESS Request and Response queues are successfully flushed.\r
	143	@retval EFI_INVALID_PARAMETER This is NULL.\r
	144	@retval EFI_NOT_STARTED This instance hasn't been configured.\r
47f51a06 YT	145	@retval EFI_NOT_FOUND The asynchronous request or response token is not\r
	146	found.\r
	147	@retval EFI_UNSUPPORTED The implementation does not support this function.\r
	148	**/\r
	149	EFI_STATUS\r
	150	EFIAPI\r
	151	EfiHttpCancel (\r
	152	IN EFI_HTTP_PROTOCOL *This,\r
	153	IN EFI_HTTP_TOKEN *Token\r
	154	);\r
	155	\r
	156	/**\r
	157	The Response() function queues an HTTP response to this HTTP instance, similar to\r
f0ab5a81	158	Receive() function in the EFI TCP driver. When the HTTP response is received successfully,\r
47f51a06 YT	159	or if there is an error, Status in token will be updated and Event will be signaled.\r
	160	\r
	161	The HTTP driver will queue a receive token to the underlying TCP instance. When data\r
	162	is received in the underlying TCP instance, the data will be parsed and Token will\r
	163	be populated with the response data. If the data received from the remote host\r
	164	contains an incomplete or invalid HTTP header, the HTTP driver will continue waiting\r
	165	(asynchronously) for more data to be sent from the remote host before signaling\r
	166	Event in Token.\r
	167	\r
	168	It is the responsibility of the caller to allocate a buffer for Body and specify the\r
	169	size in BodyLength. If the remote host provides a response that contains a content\r
	170	body, up to BodyLength bytes will be copied from the receive buffer into Body and\r
	171	BodyLength will be updated with the amount of bytes received and copied to Body. This\r
	172	allows the client to download a large file in chunks instead of into one contiguous\r
	173	block of memory. Similar to HTTP request, if Body is not NULL and BodyLength is\r
	174	non-zero and all other fields are NULL or 0, the HTTP driver will queue a receive\r
	175	token to underlying TCP instance. If data arrives in the receive buffer, up to\r
	176	BodyLength bytes of data will be copied to Body. The HTTP driver will then update\r
	177	BodyLength with the amount of bytes received and copied to Body.\r
	178	\r
	179	If the HTTP driver does not have an open underlying TCP connection with the host\r
	180	specified in the response URL, Request() will return EFI_ACCESS_DENIED. This is\r
	181	consistent with RFC 2616 recommendation that HTTP clients should attempt to maintain\r
	182	an open TCP connection between client and host.\r
	183	\r
	184	@param[in] This Pointer to EFI_HTTP_PROTOCOL instance.\r
	185	@param[in] Token Pointer to storage containing HTTP response token.\r
	186	\r
	187	@retval EFI_SUCCESS Allocation succeeded.\r
	188	@retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been\r
	189	initialized.\r
	190	@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
	191	This is NULL.\r
	192	Token is NULL.\r
	193	Token->Message->Headers is NULL.\r
	194	Token->Message is NULL.\r
	195	Token->Message->Body is not NULL,\r
	196	Token->Message->BodyLength is non-zero, and\r
	197	Token->Message->Data is NULL, but a previous call to\r
	198	Response() has not been completed successfully.\r
	199	@retval EFI_OUT_OF_RESOURCES Could not allocate enough system resources.\r
	200	@retval EFI_ACCESS_DENIED An open TCP connection is not present with the host\r
	201	specified by response URL.\r
	202	**/\r
	203	EFI_STATUS\r
	204	EFIAPI\r
	205	EfiHttpResponse (\r
	206	IN EFI_HTTP_PROTOCOL *This,\r
	207	IN EFI_HTTP_TOKEN *Token\r
	208	);\r
	209	\r
	210	/**\r
	211	The Poll() function can be used by network drivers and applications to increase the\r
	212	rate that data packets are moved between the communication devices and the transmit\r
	213	and receive queues.\r
	214	\r
	215	In some systems, the periodic timer event in the managed network driver may not poll\r
	216	the underlying communications device fast enough to transmit and/or receive all data\r
	217	packets without missing incoming packets or dropping outgoing packets. Drivers and\r
	218	applications that are experiencing packet loss should try calling the Poll() function\r
	219	more often.\r
	220	\r
	221	@param[in] This Pointer to EFI_HTTP_PROTOCOL instance.\r
	222	\r
223	@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
224	@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
225	@retval EFI_INVALID_PARAMETER This is NULL.\r
226	@retval EFI_NOT_READY No incoming or outgoing data is processed.\r
227	@retval EFI_NOT_STARTED This EFI HTTP Protocol instance has not been started.\r
228	\r
229	**/\r
230	EFI_STATUS\r
231	EFIAPI\r
232	EfiHttpPoll (\r
233	IN EFI_HTTP_PROTOCOL *This\r
234	);\r
235	\r
236	extern EFI_HTTP_PROTOCOL mEfiHttpTemplate;\r
237	\r
238	#endif\r