QuarkSocPkg: Add new package for Quark SoC X1000

[mirror_edk2.git] / QuarkSocPkg / QuarkNorthCluster / Include / Library / QNCSmmLib.h

diff --git a/QuarkSocPkg/QuarkNorthCluster/Include/Library/QNCSmmLib.h b/QuarkSocPkg/QuarkNorthCluster/Include/Library/QNCSmmLib.h
new file mode 100644 (file)
index 0000000..731aebc
--- /dev/null
+++ b/QuarkSocPkg/QuarkNorthCluster/Include/Library/QNCSmmLib.h
@@ -0,0 +1,63 @@
+/** @file\r
+QNC Smm Library Services header file.\r
+\r
+Copyright (c) 2013-2015 Intel Corporation.\r
+\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 __QNC_SMM_LIB_H__\r
+#define __QNC_SMM_LIB_H__\r
+\r
+/**\r
+  This routine is the chipset code that accepts a request to "open" a region of SMRAM.\r
+  The region could be legacy ABSEG, HSEG, or TSEG near top of physical memory.\r
+  The use of "open" means that the memory is visible from all boot-service\r
+  and SMM agents.\r
+\r
+  @retval FALSE  Cannot open a locked SMRAM region\r
+  @retval TRUE   Success to open SMRAM region.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+QNCOpenSmramRegion (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  This routine is the chipset code that accepts a request to "close" a region of SMRAM.\r
+  The region could be legacy AB or TSEG near top of physical memory.\r
+  The use of "close" means that the memory is only visible from SMM agents,\r
+  not from BS or RT code.\r
+\r
+  @retval FALSE  Cannot open a locked SMRAM region\r
+  @retval TRUE   Success to open SMRAM region.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+QNCCloseSmramRegion (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  This routine is the chipset code that accepts a request to "lock" SMRAM.\r
+  The region could be legacy AB or TSEG near top of physical memory.\r
+  The use of "lock" means that the memory can no longer be opened\r
+  to BS state.\r
+**/\r
+VOID\r
+EFIAPI\r
+QNCLockSmramRegion (\r
+  VOID\r
+  );\r
+\r
+\r
+#endif\r
+\r