MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Library / PlatformVarCleanupLib / PlatVarCleanup.h

/** @file\r
  Include file for platform variable cleanup.\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _PLAT_VAR_CLEANUP_\r
#define _PLAT_VAR_CLEANUP_\r
\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/PlatformVarCleanupLib.h>\r
\r
#include <Protocol/Variable.h>\r
#include <Protocol/VarCheck.h>\r
#include <Protocol/FormBrowser2.h>\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/HiiConfigRouting.h>\r
#include <Protocol/DevicePath.h>\r
\r
#include <Guid/EventGroup.h>\r
#include <Guid/MdeModuleHii.h>\r
#include <Guid/ImageAuthentication.h>\r
#include <Guid/VarErrorFlag.h>\r
\r
#include "PlatVarCleanupHii.h"\r
\r
//\r
// This is the generated IFR binary data for each formset defined in VFR.\r
// This data array is ready to be used as input of HiiAddPackages() to\r
// create a packagelist (which contains Form packages, String packages, etc).\r
//\r
extern UINT8 PlatVarCleanupBin[];\r
\r
//\r
// This is the generated String package data for all .UNI files.\r
// This data array is ready to be used as input of HiiAddPackages() to\r
// create a packagelist (which contains Form packages, String packages, etc).\r
//\r
extern UINT8 PlatformVarCleanupLibStrings[];\r
\r
#define USER_VARIABLE_NODE_SIGNATURE SIGNATURE_32 ('U', 'V', 'N', 'S')\r
\r
typedef struct {\r
  UINTN             Signature;\r
  LIST_ENTRY        Link;\r
  EFI_GUID          Guid;\r
  CHAR16            *PromptString;\r
  LIST_ENTRY        NameLink;\r
} USER_VARIABLE_NODE;\r
\r
#define USER_VARIABLE_FROM_LINK(a) CR (a, USER_VARIABLE_NODE, Link, USER_VARIABLE_NODE_SIGNATURE)\r
\r
#define USER_VARIABLE_NAME_NODE_SIGNATURE SIGNATURE_32 ('U', 'V', 'N', 'N')\r
\r
typedef struct {\r
  UINTN             Signature;\r
  LIST_ENTRY        Link;\r
  CHAR16            *Name;\r
  UINTN             DataSize;\r
  UINT32            Attributes;\r
  UINT16            Index;\r
  EFI_QUESTION_ID   QuestionId;\r
  CHAR16            *PromptString;\r
  CHAR16            *HelpString;\r
  BOOLEAN           Deleted;\r
} USER_VARIABLE_NAME_NODE;\r
\r
#define USER_VARIABLE_NAME_FROM_LINK(a) CR (a, USER_VARIABLE_NAME_NODE, Link, USER_VARIABLE_NAME_NODE_SIGNATURE)\r
\r
#pragma pack(1)\r
//\r
// HII specific Vendor Device Path definition.\r
//\r
typedef struct {\r
  VENDOR_DEVICE_PATH            VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL      End;\r
} HII_VENDOR_DEVICE_PATH;\r
#pragma pack()\r
\r
#define VARIABLE_CLEANUP_HII_PRIVATE_SIGNATURE SIGNATURE_32 ('V', 'C', 'H', 'P')\r
\r
typedef struct {\r
  UINTN                             Signature;\r
  EFI_HANDLE                        DriverHandle;\r
  EFI_HII_HANDLE                    HiiHandle;\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL    ConfigAccess;\r
  EFI_HII_CONFIG_ROUTING_PROTOCOL   *ConfigRouting;\r
  VARIABLE_CLEANUP_DATA             VariableCleanupData;\r
} VARIABLE_CLEANUP_HII_PRIVATE_DATA;\r
\r
#define VARIABLE_CLEANUP_HII_PRIVATE_FROM_THIS(a) CR (a, VARIABLE_CLEANUP_HII_PRIVATE_DATA, ConfigAccess, VARIABLE_CLEANUP_HII_PRIVATE_SIGNATURE)\r
\r
#endif\r