Add more comments for IntelFramework's header files.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Library / SmmLib.h
CommitLineData
f4a9471d 1/** @file\r
4a71b21a 2 Library class name: SmmLib\r
3 \r
f4a9471d 4 SMM Library Services that abstracts both S/W SMI generation and detection. \r
5\r
6 Copyright (c) 2007, Intel Corporation \r
7 All rights reserved. This program and the accompanying materials \r
8 are licensed and made available under the terms and conditions of the BSD License \r
9 which accompanies this distribution. The full text of the license may be found at \r
10 http://opensource.org/licenses/bsd-license.php \r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
14\r
15**/\r
16\r
17#ifndef __SMM_LIB_H__\r
18#define __SMM_LIB_H__\r
19\r
20\r
21/**\r
22 Triggers an SMI at boot time. \r
23\r
24 This function triggers a software SMM interrupt at boot time.\r
25\r
26**/\r
27VOID\r
28EFIAPI\r
29TriggerBootServiceSoftwareSmi (\r
30 VOID\r
31 );\r
32\r
33\r
34/**\r
35 Triggers an SMI at run time. \r
36\r
37 This function triggers a software SMM interrupt at run time.\r
38\r
39**/\r
40VOID\r
41EFIAPI\r
42TriggerRuntimeSoftwareSmi (\r
43 VOID\r
44 );\r
45\r
46\r
47/**\r
48 Test if a boot time software SMI happens. \r
49\r
50 This function tests if a software SMM interrupt happens. If a software SMM interrupt happens and\r
51 it is triggered at boot time, it returns TRUE. Otherwise, it returns FALSE.\r
52\r
53 @retval TRUE A software SMI triggered at boot time happens.\r
54 @retval FLASE No software SMI happens or the software SMI is triggered at run time.\r
55\r
56**/\r
57BOOLEAN\r
58EFIAPI\r
59IsBootServiceSoftwareSmi (\r
60 VOID\r
61 );\r
62\r
63\r
64/**\r
65 Test if a run time software SMI happens. \r
66\r
67 This function tests if a software SMM interrupt happens. If a software SMM interrupt happens and\r
68 it is triggered at run time, it returns TRUE. Otherwise, it returns FALSE.\r
69\r
70 @retval TRUE A software SMI triggered at run time happens.\r
71 @retval FLASE No software SMI happens or the software SMI is triggered at boot time.\r
72\r
73**/\r
74BOOLEAN\r
75EFIAPI\r
76IsRuntimeSoftwareSmi (\r
77 VOID\r
78 );\r
79\r
80#endif\r