MdeModulePkg: Add VarCheckHiiLib NULL class library

[mirror_edk2.git] / MdeModulePkg / Library / VarCheckHiiLib / VarCheckHiiGen.h

/** @file\r
  Include file for Var Check Hii bin generation.\r
\r
Copyright (c) 2015, 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 _VAR_CHECK_HII_GEN_H_\r
#define _VAR_CHECK_HII_GEN_H_\r
\r
#include "VarCheckHii.h"\r
\r
/**\r
  Dump Hii Package.\r
\r
  @param[in] HiiPackage         Pointer to Hii Package.\r
\r
**/\r
VOID\r
DumpHiiPackage (\r
  IN VOID       *HiiPackage\r
  );\r
\r
/**\r
  Dump Hii Database.\r
\r
  @param[in] HiiDatabase        Pointer to Hii Database.\r
  @param[in] HiiDatabaseSize    Hii Database size.\r
\r
**/\r
VOID\r
DumpHiiDatabase (\r
  IN VOID       *HiiDatabase,\r
  IN UINTN      HiiDatabaseSize\r
  );\r
\r
/**\r
  Allocates and zeros a buffer of type EfiBootServicesData.\r
\r
  Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the\r
  buffer with zeros, and returns a pointer to the allocated buffer.  If AllocationSize is 0, then a\r
  valid buffer of 0 size is returned.  If there is not enough memory remaining to satisfy the\r
  request, then NULL is returned.\r
\r
  @param  AllocationSize        The number of bytes to allocate and zero.\r
\r
  @return A pointer to the allocated buffer or NULL if allocation fails.\r
\r
**/\r
VOID *\r
InternalVarCheckAllocateZeroPool (\r
  IN UINTN            AllocationSize\r
  );\r
\r
/**\r
  Frees a buffer that was previously allocated with one of the pool allocation functions in the\r
  Memory Allocation Library.\r
\r
  Frees the buffer specified by Buffer.  Buffer must have been allocated on a previous call to the\r
  pool allocation services of the Memory Allocation Library.  If it is not possible to free pool\r
  resources, then this function will perform no actions.\r
\r
  If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,\r
  then ASSERT().\r
\r
  @param  Buffer                The pointer to the buffer to free.\r
\r
**/\r
VOID\r
EFIAPI\r
InternalVarCheckFreePool (\r
  IN VOID   *Buffer\r
  );\r
\r
/**\r
  Var Check Parse Hii Package.\r
\r
  @param[in] HiiPackage         Pointer to Hii Package.\r
  @param[in] FromFv             Hii Package from FV.\r
\r
**/\r
VOID\r
VarCheckParseHiiPackage (\r
  IN VOID       *HiiPackage,\r
  IN BOOLEAN    FromFv\r
  );\r
\r
/**\r
  Var Check Parse Hii Database.\r
\r
  @param[in] HiiDatabase        Pointer to Hii Database.\r
  @param[in] HiiDatabaseSize    Hii Database size.\r
\r
**/\r
VOID\r
VarCheckParseHiiDatabase (\r
  IN VOID       *HiiDatabase,\r
  IN UINTN      HiiDatabaseSize\r
  );\r
\r
/**\r
  Generate from FV.\r
\r
**/\r
VOID\r
VarCheckHiiGenFromFv (\r
  VOID\r
  );\r
\r
/**\r
  Generate from Hii Database.\r
\r
**/\r
VOID\r
VarCheckHiiGenFromHiiDatabase (\r
  VOID\r
  );\r
\r
/**\r
  Generate VarCheckHiiBin from Hii Database and FV.\r
\r
**/\r
VOID\r
EFIAPI\r
VarCheckHiiGen (\r
  VOID\r
  );\r
\r
#endif\r