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 This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __QNC_SMM_LIB_H__
  17 #define __QNC_SMM_LIB_H__
  18
  19 /**
  20   This routine is the chipset code that accepts a request to "open" a region of SMRAM.
  21   The region could be legacy ABSEG, HSEG, or TSEG near top of physical memory.
  22   The use of "open" means that the memory is visible from all boot-service
  23   and SMM agents.
  24
  25   @retval FALSE  Cannot open a locked SMRAM region
  26   @retval TRUE   Success to open SMRAM region.
  27 **/
  28 BOOLEAN
  29 EFIAPI
  30 QNCOpenSmramRegion (
  31   VOID
  32   );
  33
  34 /**
  35   This routine is the chipset code that accepts a request to "close" a region of SMRAM.
  36   The region could be legacy AB or TSEG near top of physical memory.
  37   The use of "close" means that the memory is only visible from SMM agents,
  38   not from BS or RT code.
  39
  40   @retval FALSE  Cannot open a locked SMRAM region
  41   @retval TRUE   Success to open SMRAM region.
  42 **/
  43 BOOLEAN
  44 EFIAPI
  45 QNCCloseSmramRegion (
  46   VOID
  47   );
  48
  49 /**
  50   This routine is the chipset code that accepts a request to "lock" SMRAM.
  51   The region could be legacy AB or TSEG near top of physical memory.
  52   The use of "lock" means that the memory can no longer be opened
  53   to BS state.
  54 **/
  55 VOID
  56 EFIAPI
  57 QNCLockSmramRegion (
  58   VOID
  59   );
  60
  61
  62 #endif
  63