NetworkPkg/HttpBootDxe/HttpBootConfig.h

   1 /** @file
   2   The header file of functions for configuring or getting the parameters
   3   relating to HTTP Boot.
   4
   5 Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _HTTP_BOOT_CONFIG_H_
  11 #define _HTTP_BOOT_CONFIG_H_
  12
  13 #include "HttpBootConfigNVDataStruc.h"
  14
  15 typedef struct _HTTP_BOOT_FORM_CALLBACK_INFO HTTP_BOOT_FORM_CALLBACK_INFO;
  16
  17 extern   UINT8  HttpBootDxeStrings[];
  18 extern   UINT8  HttpBootConfigVfrBin[];
  19
  20 #pragma pack()
  21
  22 #define HTTP_BOOT_FORM_CALLBACK_INFO_SIGNATURE  SIGNATURE_32 ('H', 'B', 'f', 'c')
  23
  24 #define HTTP_BOOT_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(Callback) \
  25   CR ( \
  26   Callback, \
  27   HTTP_BOOT_FORM_CALLBACK_INFO, \
  28   ConfigAccess, \
  29   HTTP_BOOT_FORM_CALLBACK_INFO_SIGNATURE \
  30   )
  31
  32 struct _HTTP_BOOT_FORM_CALLBACK_INFO {
  33   UINT32                            Signature;
  34   BOOLEAN                           Initialized;
  35   EFI_HANDLE                        ChildHandle;
  36   EFI_DEVICE_PATH_PROTOCOL          *HiiVendorDevicePath;
  37   EFI_HII_HANDLE                    RegisteredHandle;
  38   EFI_HII_CONFIG_ACCESS_PROTOCOL    ConfigAccess;
  39   HTTP_BOOT_CONFIG_IFR_NVDATA       HttpBootNvData;
  40 };
  41
  42 /**
  43   Initialize the configuration form.
  44
  45   @param[in]  Private             Pointer to the driver private data.
  46
  47   @retval EFI_SUCCESS             The configuration form is initialized.
  48   @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.
  49
  50 **/
  51 EFI_STATUS
  52 HttpBootConfigFormInit (
  53   IN HTTP_BOOT_PRIVATE_DATA  *Private
  54   );
  55
  56 /**
  57   Unload the configuration form, this includes: delete all the configuration
  58   entries, uninstall the form callback protocol, and free the resources used.
  59   The form will only be unload completely when both IP4 and IP6 stack are stopped.
  60
  61   @param[in]  Private             Pointer to the driver private data.
  62
  63   @retval EFI_SUCCESS             The configuration form is unloaded.
  64   @retval Others                  Failed to unload the form.
  65
  66 **/
  67 EFI_STATUS
  68 HttpBootConfigFormUnload (
  69   IN HTTP_BOOT_PRIVATE_DATA  *Private
  70   );
  71
  72 #endif