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