]>
Commit | Line | Data |
---|---|---|
2a452a56 | 1 | /** @file\r |
2 | EFI SMM Base2 Protocol as defined in the PI 1.2 specification.\r | |
3 | \r | |
4 | This protocol is utilized by all SMM drivers to locate the SMM infrastructure services and determine\r | |
5 | whether the driver is being invoked inside SMRAM or outside of SMRAM.\r | |
6 | \r | |
7 | Copyright (c) 2009, Intel Corporation \r | |
8 | All rights reserved. This program and the accompanying materials \r | |
9 | are licensed and made available under the terms and conditions of the BSD License \r | |
10 | which accompanies this distribution. The full text of the license may be found at \r | |
11 | http://opensource.org/licenses/bsd-license.php \r | |
12 | \r | |
13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
15 | \r | |
16 | **/\r | |
17 | \r | |
18 | #ifndef _SMM_BASE2_H_\r | |
19 | #define _SMM_BASE2_H_\r | |
20 | \r | |
21 | #include <Pi/PiSmmCis.h>\r | |
22 | \r | |
23 | #define EFI_SMM_BASE2_PROTOCOL_GUID \\r | |
24 | { \\r | |
25 | 0xf4ccbfb7, 0xf6e0, 0x47fd, {0x9d, 0xd4, 0x10, 0xa8, 0xf1, 0x50, 0xc1, 0x91 } \\r | |
26 | }\r | |
27 | \r | |
28 | typedef struct _EFI_SMM_BASE2_PROTOCOL EFI_SMM_BASE2_PROTOCOL;\r | |
29 | \r | |
30 | /**\r | |
31 | Service to indicate whether the driver is currently executing in the SMM Initialization phase.\r | |
32 | \r | |
33 | This service is used to indicate whether the driver is currently executing in the SMM Initialization \r | |
34 | phase. For SMM drivers, this will return TRUE in InSmram while inside the driver's entry point and \r | |
35 | otherwise FALSE. For combination SMM/DXE drivers, this will return FALSE in the DXE launch. For the\r | |
36 | SMM launch, it behaves as an SMM driver.\r | |
37 | \r | |
38 | @param[in] This The EFI_SMM_BASE2_PROTOCOL instance. \r | |
39 | @param[out] InSmram Pointer to a Boolean which, on return, indicates that the driver is\r | |
40 | currently executing inside of SMRAM (TRUE) or outside of SMRAM (FALSE).\r | |
41 | \r | |
42 | @retval EFI_SUCCESS The call returned successfully.\r | |
43 | @retval EFI_INVALID_PARAMETER InSmram was NULL.\r | |
44 | **/\r | |
45 | typedef\r | |
46 | EFI_STATUS\r | |
47 | (EFIAPI *EFI_SMM_INSIDE_OUT)(\r | |
48 | IN CONST EFI_SMM_BASE2_PROTOCOL *This,\r | |
49 | OUT BOOLEAN *InSmram\r | |
50 | )\r | |
51 | ;\r | |
52 | \r | |
53 | /**\r | |
54 | Returns the location of the System Management Service Table (SMST).\r | |
55 | \r | |
56 | This function returns the location of the System Management Service Table (SMST). The use of the \r | |
57 | API is such that a driver can discover the location of the SMST in its entry point and then cache it in \r | |
58 | some driver global variable so that the SMST can be invoked in subsequent handlers.\r | |
59 | \r | |
60 | @param[in] This The EFI_SMM_BASE2_PROTOCOL instance.\r | |
61 | @param[in,out] Smst On return, points to a pointer to the System Management Service Table (SMST).\r | |
62 | \r | |
63 | @retval EFI_SUCCESS The operation was successful.\r | |
64 | @retval EFI_INVALID_PARAMETER Smst was invalid.\r | |
65 | @retval EFI_UNSUPPORTED Not in SMM.\r | |
66 | **/\r | |
67 | typedef\r | |
68 | EFI_STATUS\r | |
69 | (EFIAPI *EFI_SMM_GET_SMST_LOCATION)(\r | |
70 | IN CONST EFI_SMM_BASE2_PROTOCOL *This,\r | |
71 | IN OUT EFI_SMM_SYSTEM_TABLE **Smst\r | |
72 | )\r | |
73 | ;\r | |
74 | \r | |
75 | ///\r | |
76 | /// EFI SMM Base2 Protocol is utilized by all SMM drivers to locate the SMM infrastructure\r | |
77 | /// services and determine whether the driver is being invoked inside SMRAM or outside of SMRAM.\r | |
78 | ///\r | |
79 | struct _EFI_SMM_BASE2_PROTOCOL {\r | |
80 | EFI_SMM_INSIDE_OUT InSmm;\r | |
81 | EFI_SMM_GET_SMST_LOCATION GetSmstLocation;\r | |
82 | };\r | |
83 | \r | |
84 | extern EFI_GUID gEfiSmmBase2ProtocolGuid;\r | |
85 | \r | |
86 | #endif\r | |
87 | \r |