/** @file
  Header file for check memory consistency realted functions

;******************************************************************************
;* Copyright (c) 2013 - 2018, Insyde Software Corp. All Rights Reserved.
;*
;* You may not reproduce, distribute, publish, display, perform, modify, adapt,
;* transmit, broadcast, present, recite, release, license or otherwise exploit
;* any part of this publication in any form, by any means, without the prior
;* written permission of Insyde Software Corporation.
;*
;******************************************************************************
*/


#ifndef _MEMORY_CHECK_H_
#define _MEMORY_CHECK_H_

#include <Uefi/UefiBaseType.h>
#include <Library/DebugLib.h>

typedef struct {
  UINTN                     Signature;
  LIST_ENTRY                Link;
  EFI_PHYSICAL_ADDRESS      MemStart;
  EFI_PHYSICAL_ADDRESS      MemEnd;
} SKIP_MEMORY_RANGE;

#pragma pack (1)
typedef struct {
  EFI_PHYSICAL_ADDRESS      MemStart;
  EFI_PHYSICAL_ADDRESS      MemEnd;
} MEMORY_RANGE;
#pragma pack ()

#define SKIP_MEMORY_RANGE_SIGNATURE SIGNATURE_32 ('S', 'M', 'R', 'S')
#define SKIP_MEMORY_RANGE_FROM_THIS(a)           CR(a, SKIP_MEMORY_RANGE, Link, SKIP_MEMORY_RANGE_SIGNATURE)

#define MAX_ADJUSTABLE_MEMORY_TYPES              3
#define MAX_BS_DATA_PAGES                        0x10000
#define MAX_PRE_ALLOCATE_PAGES                   0x40000
#define MAX_INCREASE_PAGES                       0x180
#define MIN_DECREASE_PAGES                       0x200

#define H2O_MEMORY_TYPE_UPDATE_INFO_VARIABLE_NAME L"MemoryTypeUpdateInfo"

/**
  Check the usage size of each runtime and boot services memory type.
  If the usage size exceeds the default size, adjust memory type information automatically.
  And then reset system.
**/
VOID
CheckRtAndBsMemUsage (
  VOID
  );

#ifndef MDEPKG_NDEBUG
/**
  Dump memory information if EFI_DEBUG is enabled.
**/
VOID
DumpMemoryMap (
  VOID
  );
#endif

extern EFI_GET_MEMORY_MAP   mBdsOrgGetMemoryMap;
#endif