]> git.proxmox.com Git - mirror_edk2.git/blame - QuarkSocPkg/QuarkNorthCluster/Include/Library/QNCSmmLib.h
QuarkSocPkg: Add new package for Quark SoC X1000
[mirror_edk2.git] / QuarkSocPkg / QuarkNorthCluster / Include / Library / QNCSmmLib.h
CommitLineData
9b6bbcdb
MK
1/** @file\r
2QNC Smm Library Services header file.\r
3\r
4Copyright (c) 2013-2015 Intel Corporation.\r
5\r
6This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef __QNC_SMM_LIB_H__\r
17#define __QNC_SMM_LIB_H__\r
18\r
19/**\r
20 This routine is the chipset code that accepts a request to "open" a region of SMRAM.\r
21 The region could be legacy ABSEG, HSEG, or TSEG near top of physical memory.\r
22 The use of "open" means that the memory is visible from all boot-service\r
23 and SMM agents.\r
24\r
25 @retval FALSE Cannot open a locked SMRAM region\r
26 @retval TRUE Success to open SMRAM region.\r
27**/\r
28BOOLEAN\r
29EFIAPI\r
30QNCOpenSmramRegion (\r
31 VOID\r
32 );\r
33\r
34/**\r
35 This routine is the chipset code that accepts a request to "close" a region of SMRAM.\r
36 The region could be legacy AB or TSEG near top of physical memory.\r
37 The use of "close" means that the memory is only visible from SMM agents,\r
38 not from BS or RT code.\r
39\r
40 @retval FALSE Cannot open a locked SMRAM region\r
41 @retval TRUE Success to open SMRAM region.\r
42**/\r
43BOOLEAN\r
44EFIAPI\r
45QNCCloseSmramRegion (\r
46 VOID\r
47 );\r
48\r
49/**\r
50 This routine is the chipset code that accepts a request to "lock" SMRAM.\r
51 The region could be legacy AB or TSEG near top of physical memory.\r
52 The use of "lock" means that the memory can no longer be opened\r
53 to BS state.\r
54**/\r
55VOID\r
56EFIAPI\r
57QNCLockSmramRegion (\r
58 VOID\r
59 );\r
60\r
61\r
62#endif\r
63\r