NetworkPkg/HttpBootDxe/HttpBootSupport.h

   1 /** @file
   2   Support functions declaration for UEFI HTTP boot driver.
   3
   4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials are licensed and made available under
   6 the terms and conditions of the BSD License that accompanies this distribution.
   7 The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php.
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __EFI_HTTP_BOOT_SUPPORT_H__
  16 #define __EFI_HTTP_BOOT_SUPPORT_H__
  17
  18 /**
  19   Get the Nic handle using any child handle in the IPv4 stack.
  20
  21   @param[in]  ControllerHandle    Pointer to child handle over IPv4.
  22
  23   @return NicHandle               The pointer to the Nic handle.
  24   @return NULL                    Can't find the Nic handle.
  25
  26 **/
  27 EFI_HANDLE
  28 HttpBootGetNicByIp4Children (
  29   IN EFI_HANDLE                 ControllerHandle
  30   );
  31
  32 /**
  33   Get the Nic handle using any child handle in the IPv6 stack.
  34
  35   @param[in]  ControllerHandle    Pointer to child handle over IPv6.
  36
  37   @return NicHandle               The pointer to the Nic handle.
  38   @return NULL                    Can't find the Nic handle.
  39
  40 **/
  41 EFI_HANDLE
  42 HttpBootGetNicByIp6Children (
  43   IN EFI_HANDLE                 ControllerHandle
  44   );
  45
  46 /**
  47   This function is to convert UINTN to ASCII string with the required formatting.
  48
  49   @param[in]  Number         Numeric value to be converted.
  50   @param[in]  Buffer         The pointer to the buffer for ASCII string.
  51   @param[in]  Length         The length of the required format.
  52
  53 **/
  54 VOID
  55 HttpBootUintnToAscDecWithFormat (
  56   IN UINTN                       Number,
  57   IN UINT8                       *Buffer,
  58   IN INTN                        Length
  59   );
  60
  61
  62 /**
  63   This function is to display the IPv4 address.
  64
  65   @param[in]  Ip        The pointer to the IPv4 address.
  66
  67 **/
  68 VOID
  69 HttpBootShowIp4Addr (
  70   IN EFI_IPv4_ADDRESS   *Ip
  71   );
  72
  73 /**
  74   This function is to display the IPv6 address.
  75
  76   @param[in]  Ip        The pointer to the IPv6 address.
  77
  78 **/
  79 VOID
  80 HttpBootShowIp6Addr (
  81   IN EFI_IPv6_ADDRESS   *Ip
  82   );
  83
  84 /**
  85   This function is to display the HTTP error status.
  86
  87   @param[in]      StatusCode      The status code value in HTTP message.
  88
  89 **/
  90 VOID
  91 HttpBootPrintErrorMessage (
  92   EFI_HTTP_STATUS_CODE            StatusCode
  93   );
  94
  95 //
  96 // A wrapper structure to hold the HTTP headers.
  97 //
  98 typedef struct {
  99   UINTN                       MaxHeaderCount;
 100   UINTN                       HeaderCount;
 101   EFI_HTTP_HEADER             *Headers;
 102 } HTTP_IO_HEADER;
 103
 104 /**
 105   Create a HTTP_IO_HEADER to hold the HTTP header items.
 106
 107   @param[in]  MaxHeaderCount         The maximun number of HTTP header in this holder.
 108
 109   @return    A pointer of the HTTP header holder or NULL if failed.
 110
 111 **/
 112 HTTP_IO_HEADER *
 113 HttpBootCreateHeader (
 114   IN  UINTN                MaxHeaderCount
 115   );
 116
 117 /**
 118   Destroy the HTTP_IO_HEADER and release the resouces.
 119
 120   @param[in]  HttpIoHeader       Point to the HTTP header holder to be destroyed.
 121
 122 **/
 123 VOID
 124 HttpBootFreeHeader (
 125   IN  HTTP_IO_HEADER       *HttpIoHeader
 126   );
 127
 128 /**
 129   Set or update a HTTP header with the field name and corresponding value.
 130
 131   @param[in]  HttpIoHeader       Point to the HTTP header holder.
 132   @param[in]  FieldName          Null terminated string which describes a field name.
 133   @param[in]  FieldValue         Null terminated string which describes the corresponding field value.
 134
 135   @retval  EFI_SUCCESS           The HTTP header has been set or updated.
 136   @retval  EFI_INVALID_PARAMETER Any input parameter is invalid.
 137   @retval  EFI_OUT_OF_RESOURCES  Insufficient resource to complete the operation.
 138   @retval  Other                 Unexpected error happened.
 139
 140 **/
 141 EFI_STATUS
 142 HttpBootSetHeader (
 143   IN  HTTP_IO_HEADER       *HttpIoHeader,
 144   IN  CHAR8                *FieldName,
 145   IN  CHAR8                *FieldValue
 146   );
 147
 148 //
 149 // HTTP_IO configuration data for IPv4
 150 //
 151 typedef struct {
 152   EFI_HTTP_VERSION          HttpVersion;
 153   UINT32                    RequestTimeOut;  // In milliseconds.
 154   UINT32                    ResponseTimeOut; // In milliseconds.
 155   BOOLEAN                   UseDefaultAddress;
 156   EFI_IPv4_ADDRESS          LocalIp;
 157   EFI_IPv4_ADDRESS          SubnetMask;
 158   UINT16                    LocalPort;
 159 } HTTP4_IO_CONFIG_DATA;
 160
 161 //
 162 // HTTP_IO configuration data for IPv6
 163 //
 164 typedef struct {
 165   EFI_HTTP_VERSION          HttpVersion;
 166   UINT32                    RequestTimeOut;  // In milliseconds.
 167   BOOLEAN                   UseDefaultAddress;
 168   EFI_IPv6_ADDRESS          LocalIp;
 169   UINT16                    LocalPort;
 170 } HTTP6_IO_CONFIG_DATA;
 171
 172
 173 //
 174 // HTTP_IO configuration
 175 //
 176 typedef union {
 177   HTTP4_IO_CONFIG_DATA       Config4;
 178   HTTP6_IO_CONFIG_DATA       Config6;
 179 } HTTP_IO_CONFIG_DATA;
 180
 181 //
 182 // HTTP_IO wrapper of the EFI HTTP service.
 183 //
 184 typedef struct {
 185   UINT8                     IpVersion;
 186   EFI_HANDLE                Image;
 187   EFI_HANDLE                Controller;
 188   EFI_HANDLE                Handle;
 189
 190   EFI_HTTP_PROTOCOL         *Http;
 191
 192   EFI_HTTP_TOKEN            ReqToken;
 193   EFI_HTTP_MESSAGE          ReqMessage;
 194   EFI_HTTP_TOKEN            RspToken;
 195   EFI_HTTP_MESSAGE          RspMessage;
 196
 197   BOOLEAN                   IsTxDone;
 198   BOOLEAN                   IsRxDone;
 199 } HTTP_IO;
 200
 201 //
 202 // A wrapper structure to hold the received HTTP response data.
 203 //
 204 typedef struct {
 205   EFI_HTTP_RESPONSE_DATA      Response;
 206   UINTN                       HeaderCount;
 207   EFI_HTTP_HEADER             *Headers;
 208   UINTN                       BodyLength;
 209   CHAR8                       *Body;
 210   EFI_STATUS                  Status;
 211 } HTTP_IO_RESPONSE_DATA;
 212
 213 /**
 214   Retrieve the host address using the EFI_DNS6_PROTOCOL.
 215
 216   @param[in]  Private             The pointer to the driver's private data.
 217   @param[in]  HostName            Pointer to buffer containing hostname.
 218   @param[out] IpAddress           On output, pointer to buffer containing IPv6 address.
 219
 220   @retval EFI_SUCCESS             Operation succeeded.
 221   @retval EFI_DEVICE_ERROR        An unexpected network error occurred.
 222   @retval Others                  Other errors as indicated.
 223 **/
 224 EFI_STATUS
 225 HttpBootDns (
 226   IN     HTTP_BOOT_PRIVATE_DATA   *Private,
 227   IN     CHAR16                   *HostName,
 228      OUT EFI_IPv6_ADDRESS         *IpAddress
 229   );
 230
 231 /**
 232   Notify the callback function when an event is triggered.
 233
 234   @param[in]  Event           The triggered event.
 235   @param[in]  Context         The opaque parameter to the function.
 236
 237 **/
 238 VOID
 239 EFIAPI
 240 HttpBootCommonNotify (
 241   IN EFI_EVENT           Event,
 242   IN VOID                *Context
 243   );
 244
 245 /**
 246   Create a HTTP_IO to access the HTTP service. It will create and configure
 247   a HTTP child handle.
 248
 249   @param[in]  Image          The handle of the driver image.
 250   @param[in]  Controller     The handle of the controller.
 251   @param[in]  IpVersion      IP_VERSION_4 or IP_VERSION_6.
 252   @param[in]  ConfigData     The HTTP_IO configuration data.
 253   @param[out] HttpIo         The HTTP_IO.
 254
 255   @retval EFI_SUCCESS            The HTTP_IO is created and configured.
 256   @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.
 257   @retval EFI_UNSUPPORTED        One or more of the control options are not
 258                                  supported in the implementation.
 259   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.
 260   @retval Others                 Failed to create the HTTP_IO or configure it.
 261
 262 **/
 263 EFI_STATUS
 264 HttpIoCreateIo (
 265   IN EFI_HANDLE             Image,
 266   IN EFI_HANDLE             Controller,
 267   IN UINT8                  IpVersion,
 268   IN HTTP_IO_CONFIG_DATA    *ConfigData,
 269   OUT HTTP_IO               *HttpIo
 270   );
 271
 272 /**
 273   Destroy the HTTP_IO and release the resouces.
 274
 275   @param[in]  HttpIo          The HTTP_IO which wraps the HTTP service to be destroyed.
 276
 277 **/
 278 VOID
 279 HttpIoDestroyIo (
 280   IN HTTP_IO                *HttpIo
 281   );
 282
 283 /**
 284   Synchronously send a HTTP REQUEST message to the server.
 285
 286   @param[in]   HttpIo           The HttpIo wrapping the HTTP service.
 287   @param[in]   Request          A pointer to storage such data as URL and HTTP method.
 288   @param[in]   HeaderCount      Number of HTTP header structures in Headers list.
 289   @param[in]   Headers          Array containing list of HTTP headers.
 290   @param[in]   BodyLength       Length in bytes of the HTTP body.
 291   @param[in]   Body             Body associated with the HTTP request.
 292
 293   @retval EFI_SUCCESS            The HTTP request is trasmitted.
 294   @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.
 295   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.
 296   @retval EFI_DEVICE_ERROR       An unexpected network or system error occurred.
 297   @retval Others                 Other errors as indicated.
 298
 299 **/
 300 EFI_STATUS
 301 HttpIoSendRequest (
 302   IN  HTTP_IO                *HttpIo,
 303   IN  EFI_HTTP_REQUEST_DATA  *Request,      OPTIONAL
 304   IN  UINTN                  HeaderCount,
 305   IN  EFI_HTTP_HEADER        *Headers,      OPTIONAL
 306   IN  UINTN                  BodyLength,
 307   IN  VOID                   *Body          OPTIONAL
 308   );
 309
 310 /**
 311   Synchronously receive a HTTP RESPONSE message from the server.
 312
 313   @param[in]   HttpIo           The HttpIo wrapping the HTTP service.
 314   @param[in]   RecvMsgHeader    TRUE to receive a new HTTP response (from message header).
 315                                 FALSE to continue receive the previous response message.
 316   @param[out]  ResponseData     Point to a wrapper of the received response data.
 317
 318   @retval EFI_SUCCESS            The HTTP response is received.
 319   @retval EFI_INVALID_PARAMETER  One or more parameters are invalid.
 320   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.
 321   @retval EFI_DEVICE_ERROR       An unexpected network or system error occurred.
 322   @retval Others                 Other errors as indicated.
 323
 324 **/
 325 EFI_STATUS
 326 HttpIoRecvResponse (
 327   IN      HTTP_IO                  *HttpIo,
 328   IN      BOOLEAN                  RecvMsgHeader,
 329      OUT  HTTP_IO_RESPONSE_DATA    *ResponseData
 330   );
 331
 332 /**
 333   Get the URI address string from the input device path.
 334
 335   Caller need to free the buffer in the UriAddress pointer.
 336
 337   @param[in]   FilePath         Pointer to the device path which contains a URI device path node.
 338   @param[out]  UriAddress       The URI address string extract from the device path.
 339
 340   @retval EFI_SUCCESS            The URI string is returned.
 341   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory.
 342
 343 **/
 344 EFI_STATUS
 345 HttpBootParseFilePath (
 346   IN     EFI_DEVICE_PATH_PROTOCOL     *FilePath,
 347      OUT CHAR8                        **UriAddress
 348   );
 349
 350 /**
 351   This function returns the image type according to server replied HTTP message
 352   and also the image's URI info.
 353
 354   @param[in]    Uri              The pointer to the image's URI string.
 355   @param[in]    UriParser        URI Parse result returned by NetHttpParseUrl().
 356   @param[in]    HeaderCount      Number of HTTP header structures in Headers list.
 357   @param[in]    Headers          Array containing list of HTTP headers.
 358   @param[out]   ImageType        The image type of the downloaded file.
 359
 360   @retval EFI_SUCCESS            The image type is returned in ImageType.
 361   @retval EFI_INVALID_PARAMETER  ImageType, Uri or UriParser is NULL.
 362   @retval EFI_INVALID_PARAMETER  HeaderCount is not zero, and Headers is NULL.
 363   @retval EFI_NOT_FOUND          Failed to identify the image type.
 364   @retval Others                 Unexpect error happened.
 365
 366 **/
 367 EFI_STATUS
 368 HttpBootCheckImageType (
 369   IN      CHAR8                  *Uri,
 370   IN      VOID                   *UriParser,
 371   IN      UINTN                  HeaderCount,
 372   IN      EFI_HTTP_HEADER        *Headers,
 373      OUT  HTTP_BOOT_IMAGE_TYPE   *ImageType
 374   );
 375
 376 /**
 377   This function register the RAM disk info to the system.
 378
 379   @param[in]       Private         The pointer to the driver's private data.
 380   @param[in]       BufferSize      The size of Buffer in bytes.
 381   @param[in]       Buffer          The base address of the RAM disk.
 382   @param[in]       ImageType       The image type of the file in Buffer.
 383
 384   @retval EFI_SUCCESS              The RAM disk has been registered.
 385   @retval EFI_NOT_FOUND            No RAM disk protocol instances were found.
 386   @retval EFI_UNSUPPORTED          The ImageType is not supported.
 387   @retval Others                   Unexpected error happened.
 388
 389 **/
 390 EFI_STATUS
 391 HttpBootRegisterRamDisk (
 392   IN  HTTP_BOOT_PRIVATE_DATA       *Private,
 393   IN  UINTN                        BufferSize,
 394   IN  VOID                         *Buffer,
 395   IN  HTTP_BOOT_IMAGE_TYPE         ImageType
 396   );
 397 #endif