NetworkPkg/HttpDxe/HttpImpl.h

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