QuarkSocPkg/QuarkNorthCluster/Include/Library/QNCSmmLib.h

   1 /** @file
   2 QNC Smm Library Services header file.
   3
   4 Copyright (c) 2013-2015 Intel Corporation.
   5
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef __QNC_SMM_LIB_H__
  11 #define __QNC_SMM_LIB_H__
  12
  13 /**
  14   This routine is the chipset code that accepts a request to "open" a region of SMRAM.
  15   The region could be legacy ABSEG, HSEG, or TSEG near top of physical memory.
  16   The use of "open" means that the memory is visible from all boot-service
  17   and SMM agents.
  18
  19   @retval FALSE  Cannot open a locked SMRAM region
  20   @retval TRUE   Success to open SMRAM region.
  21 **/
  22 BOOLEAN
  23 EFIAPI
  24 QNCOpenSmramRegion (
  25   VOID
  26   );
  27
  28 /**
  29   This routine is the chipset code that accepts a request to "close" a region of SMRAM.
  30   The region could be legacy AB or TSEG near top of physical memory.
  31   The use of "close" means that the memory is only visible from SMM agents,
  32   not from BS or RT code.
  33
  34   @retval FALSE  Cannot open a locked SMRAM region
  35   @retval TRUE   Success to open SMRAM region.
  36 **/
  37 BOOLEAN
  38 EFIAPI
  39 QNCCloseSmramRegion (
  40   VOID
  41   );
  42
  43 /**
  44   This routine is the chipset code that accepts a request to "lock" SMRAM.
  45   The region could be legacy AB or TSEG near top of physical memory.
  46   The use of "lock" means that the memory can no longer be opened
  47   to BS state.
  48 **/
  49 VOID
  50 EFIAPI
  51 QNCLockSmramRegion (
  52   VOID
  53   );
  54
  55
  56 #endif
  57