OvmfPkg: Apply uncrustify changes

[mirror_edk2.git] / OvmfPkg / SmmAccess / SmramInternal.h

/** @file\r
\r
  Functions and types shared by the SMM accessor PEI and DXE modules.\r
\r
  Copyright (C) 2015, Red Hat, Inc.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Pi/PiMultiPhase.h>\r
\r
//\r
// We'll have two SMRAM ranges.\r
//\r
// The first is a tiny one that hosts an SMM_S3_RESUME_STATE object, to be\r
// filled in by the CPU SMM driver during normal boot, for the PEI instance of\r
// the LockBox library (which will rely on the object during S3 resume).\r
//\r
// The other SMRAM range is the main one, for the SMM core and the SMM drivers.\r
//\r
typedef enum {\r
  DescIdxSmmS3ResumeState = 0,\r
  DescIdxMain             = 1,\r
  DescIdxCount            = 2\r
} DESCRIPTOR_INDEX;\r
\r
//\r
// The value of PcdQ35TsegMbytes is saved into this variable at module startup.\r
//\r
extern UINT16  mQ35TsegMbytes;\r
\r
/**\r
  Save PcdQ35TsegMbytes into mQ35TsegMbytes.\r
**/\r
VOID\r
InitQ35TsegMbytes (\r
  VOID\r
  );\r
\r
/**\r
  Save PcdQ35SmramAtDefaultSmbase into mQ35SmramAtDefaultSmbase.\r
**/\r
VOID\r
InitQ35SmramAtDefaultSmbase (\r
  VOID\r
  );\r
\r
/**\r
  Read the MCH_SMRAM and ESMRAMC registers, and update the LockState and\r
  OpenState fields in the PEI_SMM_ACCESS_PPI / EFI_SMM_ACCESS2_PROTOCOL object,\r
  from the D_LCK and T_EN bits.\r
\r
  PEI_SMM_ACCESS_PPI and EFI_SMM_ACCESS2_PROTOCOL member functions can rely on\r
  the LockState and OpenState fields being up-to-date on entry, and they need\r
  to restore the same invariant on exit, if they touch the bits in question.\r
\r
  @param[out] LockState  Reflects the D_LCK bit on output; TRUE iff SMRAM is\r
                         locked.\r
  @param[out] OpenState  Reflects the inverse of the T_EN bit on output; TRUE\r
                         iff SMRAM is open.\r
**/\r
VOID\r
GetStates (\r
  OUT BOOLEAN  *LockState,\r
  OUT BOOLEAN  *OpenState\r
  );\r
\r
//\r
// The functions below follow the PEI_SMM_ACCESS_PPI and\r
// EFI_SMM_ACCESS2_PROTOCOL member declarations. The PeiServices and This\r
// pointers are removed (TSEG doesn't depend on them), and so is the\r
// DescriptorIndex parameter (TSEG doesn't support range-wise locking).\r
//\r
// The LockState and OpenState members that are common to both\r
// PEI_SMM_ACCESS_PPI and EFI_SMM_ACCESS2_PROTOCOL are taken and updated in\r
// isolation from the rest of the (non-shared) members.\r
//\r
\r
EFI_STATUS\r
SmramAccessOpen (\r
  OUT BOOLEAN  *LockState,\r
  OUT BOOLEAN  *OpenState\r
  );\r
\r
EFI_STATUS\r
SmramAccessClose (\r
  OUT BOOLEAN  *LockState,\r
  OUT BOOLEAN  *OpenState\r
  );\r
\r
EFI_STATUS\r
SmramAccessLock (\r
  OUT    BOOLEAN  *LockState,\r
  IN OUT BOOLEAN  *OpenState\r
  );\r
\r
EFI_STATUS\r
SmramAccessGetCapabilities (\r
  IN BOOLEAN                   LockState,\r
  IN BOOLEAN                   OpenState,\r
  IN OUT UINTN                 *SmramMapSize,\r
  IN OUT EFI_SMRAM_DESCRIPTOR  *SmramMap\r
  );\r