NetworkPkg: Add URI configuration form to HTTP boot driver.

[mirror_edk2.git] / NetworkPkg / HttpBootDxe / HttpBootConfig.h

diff --git a/NetworkPkg/HttpBootDxe/HttpBootConfig.h b/NetworkPkg/HttpBootDxe/HttpBootConfig.h
new file mode 100644 (file)
index 0000000..a2afd18
--- /dev/null
+++ b/NetworkPkg/HttpBootDxe/HttpBootConfig.h
@@ -0,0 +1,78 @@
+/** @file\r
+  The header file of functions for configuring or getting the parameters\r
+  relating to HTTP Boot.\r
+\r
+Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\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 _HTTP_BOOT_CONFIG_H_\r
+#define _HTTP_BOOT_CONFIG_H_\r
+\r
+\r
+#include "HttpBootConfigNVDataStruc.h"\r
+\r
+typedef struct _HTTP_BOOT_FORM_CALLBACK_INFO   HTTP_BOOT_FORM_CALLBACK_INFO;\r
+\r
+extern   UINT8                            HttpBootDxeStrings[];\r
+extern   UINT8                            HttpBootConfigVfrBin[];\r
+\r
+#pragma pack()\r
+\r
+#define HTTP_BOOT_FORM_CALLBACK_INFO_SIGNATURE  SIGNATURE_32 ('H', 'B', 'f', 'c')\r
+\r
+#define HTTP_BOOT_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(Callback) \\r
+  CR ( \\r
+  Callback, \\r
+  HTTP_BOOT_FORM_CALLBACK_INFO, \\r
+  ConfigAccess, \\r
+  HTTP_BOOT_FORM_CALLBACK_INFO_SIGNATURE \\r
+  )\r
+\r
+struct _HTTP_BOOT_FORM_CALLBACK_INFO {\r
+  UINT32                           Signature;\r
+  BOOLEAN                          Initilized;\r
+  EFI_HANDLE                       ChildHandle;\r
+  EFI_DEVICE_PATH_PROTOCOL         *HiiVendorDevicePath;\r
+  EFI_HII_HANDLE                   RegisteredHandle;\r
+  EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;\r
+  HTTP_BOOT_CONFIG_IFR_NVDATA      HttpBootNvData;\r
+};\r
+\r
+/**\r
+  Initialize the configuration form.\r
+\r
+  @param[in]  Private             Pointer to the driver private data.\r
+\r
+  @retval EFI_SUCCESS             The configuration form is initialized.\r
+  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootConfigFormInit (\r
+  IN HTTP_BOOT_PRIVATE_DATA     *Private\r
+  );\r
+\r
+/**\r
+  Unload the configuration form, this includes: delete all the configuration\r
+  entries, uninstall the form callback protocol, and free the resources used.\r
+\r
+  @param[in]  Private             Pointer to the driver private data.\r
+\r
+  @retval EFI_SUCCESS             The configuration form is unloaded.\r
+  @retval Others                  Failed to unload the form.\r
+\r
+**/\r
+EFI_STATUS\r
+HttpBootConfigFormUnload (\r
+  IN HTTP_BOOT_PRIVATE_DATA     *Private\r
+  );\r
+\r
+#endif\r