79964ac8 |
1 | /** @file\r |
2 | This file declares SMM Base abstraction protocol.\r |
8411f1c0 |
3 | This protocol is used to install SMM handlers for support of subsequent SMI/PMI activations. This\r |
3471dae2 |
4 | protocol is available on both IA-32 and Itanium based systems.\r |
8411f1c0 |
5 | \r |
6 | The EFI_SMM_BASE_PROTOCOL is a set of services that is exported by a processor device. It is\r |
7 | a required protocol for the platform processor. This protocol can be used in both boot services and\r |
8 | runtime mode. However, only the following member functions need to exist into runtime:\r |
9 | - InSmm()\r |
10 | - Communicate()\r |
11 | This protocol is responsible for registering the handler services. The order in which the handlers are\r |
12 | executed is prescribed only with respect to the MakeLast flag in the RegisterCallback()\r |
13 | service. The driver exports these registration and unregistration services in boot services mode, but\r |
14 | the registered handlers will execute through the preboot and runtime. The only way to change the\r |
15 | behavior of a registered driver after ExitBootServices() has been invoked is to use some\r |
16 | private communication mechanism with the driver to order it to quiesce. This model permits typical\r |
17 | use cases, such as invoking the handler to enter ACPI mode, where the OS loader would make this\r |
18 | call before boot services are terminated. On the other hand, handlers for services such as chipset\r |
19 | workarounds for the century rollover in CMOS should provide commensurate services throughout\r |
20 | preboot and OS runtime.\r |
79964ac8 |
21 | \r |
79964ac8 |
22 | @par Revision Reference:\r |
23 | This Protocol is defined in Framework of EFI SMM Core Interface Spec\r |
24 | Version 0.9.\r |
25 | \r |
ac9868ec |
26 | Copyright (c) 2007 - 2009, Intel Corporation\r |
27 | All rights reserved. This program and the accompanying materials\r |
28 | are licensed and made available under the terms and conditions of the BSD License\r |
29 | which accompanies this distribution. The full text of the license may be found at\r |
30 | http://opensource.org/licenses/bsd-license.php\r |
31 | \r |
32 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
33 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
34 | \r |
79964ac8 |
35 | **/\r |
36 | \r |
37 | #ifndef _SMM_BASE_H_\r |
38 | #define _SMM_BASE_H_\r |
39 | \r |
b80fbe85 |
40 | #include <FrameworkSmm.h>\r |
41 | \r |
79964ac8 |
42 | #define EFI_SMM_BASE_PROTOCOL_GUID \\r |
43 | { \\r |
44 | 0x1390954D, 0xda95, 0x4227, {0x93, 0x28, 0x72, 0x82, 0xc2, 0x17, 0xda, 0xa8 } \\r |
45 | }\r |
46 | \r |
47 | typedef struct _EFI_SMM_BASE_PROTOCOL EFI_SMM_BASE_PROTOCOL;\r |
48 | \r |
49 | //\r |
50 | // SMM Handler Definition\r |
51 | //\r |
52 | #define EFI_HANDLER_SUCCESS 0x0000\r |
53 | #define EFI_HANDLER_CRITICAL_EXIT 0x0001\r |
54 | #define EFI_HANDLER_SOURCE_QUIESCED 0x0002\r |
55 | #define EFI_HANDLER_SOURCE_PENDING 0x0003\r |
56 | \r |
57 | /**\r |
58 | Entry Point to Callback service\r |
59 | \r |
ac9868ec |
60 | @param[in] SmmImageHandle A handle allocated by the SMM infrastructure code\r |
61 | to uniquely designate a specific DXE SMM driver.\r |
62 | @param[in] CommunicationBuffer A pointer to a collection of data in memory\r |
63 | that will be conveyed from a non-SMM environment into an SMM environment.\r |
64 | The buffer must be contiguous, physically mapped, and be a physical address.\r |
65 | @param[in] SourceSize The size of the CommunicationBuffer.\r |
79964ac8 |
66 | \r |
ac9868ec |
67 | @return Status code\r |
79964ac8 |
68 | \r |
69 | **/\r |
70 | typedef\r |
71 | EFI_STATUS\r |
69686d56 |
72 | (EFIAPI *EFI_SMM_CALLBACK_ENTRY_POINT)(\r |
79964ac8 |
73 | IN EFI_HANDLE SmmImageHandle,\r |
74 | IN OUT VOID *CommunicationBuffer OPTIONAL,\r |
75 | IN OUT UINTN *SourceSize OPTIONAL\r |
76 | );\r |
77 | \r |
78 | //\r |
79 | // SMM Base Protocol Definition\r |
80 | //\r |
81 | /**\r |
82 | Register a given driver into SMRAM.This is the equivalent of performing\r |
83 | the LoadImage/StartImage into System Management Mode.\r |
84 | \r |
ac9868ec |
85 | @param[in] This Protocol instance pointer.\r |
86 | @param[in] FilePath Location of the image to be installed as the handler.\r |
87 | @param[in] SourceBuffer Optional source buffer in case of the image file\r |
88 | being in memory.\r |
89 | @param[in] SourceSize Size of the source image file, if in memory.\r |
90 | @param[out] ImageHandle The handle that the base driver uses to decode \r |
91 | the handler. Unique among SMM handlers only, \r |
92 | not unique across DXE/EFI.\r |
93 | @param[in] LegacyIA32Binary An optional parameter that details that the associated \r |
94 | file is a real-mode IA-32 binary.\r |
95 | \r |
96 | @retval EFI_SUCCESS The operation was successful.\r |
97 | @retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler\r |
98 | @retval EFI_UNSUPPORTED This platform does not support 16-bit handlers.\r |
99 | @retval EFI_UNSUPPORTED In runtime.\r |
100 | @retval EFI_INVALID_PARAMETER The handlers was not the correct image type\r |
79964ac8 |
101 | \r |
102 | **/\r |
103 | typedef\r |
104 | EFI_STATUS\r |
69686d56 |
105 | (EFIAPI *EFI_SMM_REGISTER_HANDLER)(\r |
79964ac8 |
106 | IN EFI_SMM_BASE_PROTOCOL *This,\r |
107 | IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r |
108 | IN VOID *SourceBuffer OPTIONAL,\r |
109 | IN UINTN SourceSize,\r |
110 | OUT EFI_HANDLE *ImageHandle,\r |
111 | IN BOOLEAN LegacyIA32Binary OPTIONAL\r |
ed66e1bc |
112 | );\r |
79964ac8 |
113 | \r |
114 | /**\r |
700a7869 |
115 | Removes a handler from execution within SMRAM. This is the equivalent of performing\r |
116 | the UnloadImage in System Management Mode.\r |
79964ac8 |
117 | \r |
ac9868ec |
118 | @param[in] This Protocol instance pointer.\r |
119 | @param[in] ImageHandle The handler to be removed.\r |
79964ac8 |
120 | \r |
ac9868ec |
121 | @retval EFI_SUCCESS The operation was successful\r |
122 | @retval EFI_INVALID_PARAMETER The handler did not exist\r |
123 | @retval EFI_UNSUPPORTED In runtime.\r |
79964ac8 |
124 | \r |
125 | **/\r |
126 | typedef\r |
127 | EFI_STATUS\r |
69686d56 |
128 | (EFIAPI *EFI_SMM_UNREGISTER_HANDLER)(\r |
79964ac8 |
129 | IN EFI_SMM_BASE_PROTOCOL *This,\r |
130 | IN EFI_HANDLE ImageHandle\r |
ed66e1bc |
131 | );\r |
79964ac8 |
132 | \r |
133 | /**\r |
134 | The SMM Inter-module Communicate Service Communicate() function\r |
135 | provides a services to send/received messages from a registered\r |
136 | EFI service. The BASE protocol driver is responsible for doing\r |
700a7869 |
137 | any of the copies such that the data lives in boot-service-accessible RAM.\r |
79964ac8 |
138 | \r |
ac9868ec |
139 | @param[in] This Protocol instance pointer.\r |
140 | @param[in] ImageHandle The handle of the registered driver.\r |
141 | @param[in,out] CommunicationBuffer Pointer to the buffer to convey into SMRAM.\r |
142 | @param[in,out] SourceSize The size of the data buffer being passed in.\r |
79964ac8 |
143 | \r |
ac9868ec |
144 | @retval EFI_SUCCESS The message was successfully posted\r |
145 | @retval EFI_INVALID_PARAMETER The buffer was NULL\r |
79964ac8 |
146 | \r |
147 | **/\r |
148 | typedef\r |
149 | EFI_STATUS\r |
69686d56 |
150 | (EFIAPI *EFI_SMM_COMMUNICATE)(\r |
79964ac8 |
151 | IN EFI_SMM_BASE_PROTOCOL *This,\r |
152 | IN EFI_HANDLE ImageHandle,\r |
153 | IN OUT VOID *CommunicationBuffer,\r |
154 | IN OUT UINTN *SourceSize\r |
ed66e1bc |
155 | );\r |
79964ac8 |
156 | \r |
157 | /**\r |
158 | Register a callback to execute within SMM.\r |
700a7869 |
159 | This allows receipt of messages created with EFI_SMM_BASE_PROTOCOL.Communicate().\r |
79964ac8 |
160 | \r |
ac9868ec |
161 | @param[in] This Protocol instance pointer.\r |
162 | @param[in] SmmImageHandle Handle of the callback service.\r |
163 | @param[in] CallbackAddress Address of the callback service.\r |
164 | @param[in] MakeLast If present, will stipulate that the handler is posted to \r |
165 | be executed last in the dispatch table.\r |
166 | @param[in] FloatingPointSave This is an optional parameter which informs the\r |
167 | EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save\r |
168 | the floating point register state. If any of the handlers\r |
169 | require this, then the state will be saved for all of the handlers.\r |
170 | \r |
171 | @retval EFI_SUCCESS The operation was successful\r |
172 | @retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue\r |
173 | @retval EFI_UNSUPPORTED In runtime.\r |
174 | @retval EFI_UNSUPPORTED The caller is not in SMM.\r |
79964ac8 |
175 | \r |
176 | **/\r |
177 | typedef\r |
178 | EFI_STATUS\r |
69686d56 |
179 | (EFIAPI *EFI_SMM_CALLBACK_SERVICE)(\r |
79964ac8 |
180 | IN EFI_SMM_BASE_PROTOCOL *This,\r |
181 | IN EFI_HANDLE SmmImageHandle,\r |
182 | IN EFI_SMM_CALLBACK_ENTRY_POINT CallbackAddress,\r |
183 | IN BOOLEAN MakeLast OPTIONAL,\r |
184 | IN BOOLEAN FloatingPointSave OPTIONAL\r |
ed66e1bc |
185 | );\r |
79964ac8 |
186 | \r |
187 | /**\r |
188 | The SmmAllocatePool() function allocates a memory region of Size bytes from memory of\r |
189 | type PoolType and returns the address of the allocated memory in the location referenced\r |
190 | by Buffer. This function allocates pages from EFI SMRAM Memory as needed to grow the\r |
191 | requested pool type. All allocations are eight-byte aligned.\r |
192 | \r |
ac9868ec |
193 | @param[in] This Protocol instance pointer.\r |
194 | @param[in] PoolType The type of pool to allocate.\r |
195 | The only supported type is EfiRuntimeServicesData;\r |
196 | the interface will internally map this runtime request to \r |
197 | SMRAM for IA-32 and leave as this type for the Itanium \r |
198 | processor family. Other types can be ignored.\r |
199 | @param[in] Size The number of bytes to allocate from the pool.\r |
200 | @param[out] Buffer A pointer to a pointer to the allocated buffer if the call\r |
201 | succeeds; undefined otherwise.\r |
202 | \r |
203 | @retval EFI_SUCCESS The requested number of bytes was allocated.\r |
204 | @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.\r |
205 | @retval EFI_INVALID_PARAMETER PoolType was invalid.\r |
206 | @retval EFI_UNSUPPORTED In runtime.\r |
79964ac8 |
207 | \r |
208 | **/\r |
209 | typedef\r |
210 | EFI_STATUS\r |
69686d56 |
211 | (EFIAPI *EFI_SMM_ALLOCATE_POOL)(\r |
79964ac8 |
212 | IN EFI_SMM_BASE_PROTOCOL *This,\r |
213 | IN EFI_MEMORY_TYPE PoolType,\r |
214 | IN UINTN Size,\r |
215 | OUT VOID **Buffer\r |
ed66e1bc |
216 | );\r |
79964ac8 |
217 | \r |
218 | /**\r |
219 | The SmmFreePool() function returns the memory specified by Buffer to the system.\r |
220 | On return, the memory's type is EFI SMRAM Memory. The Buffer that is freed must\r |
221 | have been allocated by SmmAllocatePool().\r |
222 | \r |
ac9868ec |
223 | @param[in] This Protocol instance pointer.\r |
224 | @param[in] Buffer Pointer to the buffer allocation.\r |
79964ac8 |
225 | \r |
ac9868ec |
226 | @retval EFI_SUCCESS The memory was returned to the system.\r |
227 | @retval EFI_INVALID_PARAMETER Buffer was invalid.\r |
228 | @retval EFI_UNSUPPORTED In runtime.\r |
79964ac8 |
229 | \r |
230 | **/\r |
231 | typedef\r |
232 | EFI_STATUS\r |
69686d56 |
233 | (EFIAPI *EFI_SMM_FREE_POOL)(\r |
79964ac8 |
234 | IN EFI_SMM_BASE_PROTOCOL *This,\r |
235 | IN VOID *Buffer\r |
ed66e1bc |
236 | );\r |
79964ac8 |
237 | \r |
238 | /**\r |
239 | This routine tells caller if execution context is SMM or not.\r |
240 | \r |
ac9868ec |
241 | @param[in] This Protocol instance pointer.\r |
242 | @param[out] InSmm Whether the caller is inside SMM for IA-32\r |
243 | or servicing a PMI for the Itanium processor\r |
244 | family.\r |
79964ac8 |
245 | \r |
ac9868ec |
246 | @retval EFI_SUCCESS The operation was successful\r |
247 | @retval EFI_INVALID_PARAMETER InSmm was NULL.\r |
79964ac8 |
248 | \r |
249 | **/\r |
250 | typedef\r |
251 | EFI_STATUS\r |
69686d56 |
252 | (EFIAPI *EFI_SMM_INSIDE_OUT)(\r |
79964ac8 |
253 | IN EFI_SMM_BASE_PROTOCOL *This,\r |
254 | OUT BOOLEAN *InSmm\r |
ed66e1bc |
255 | );\r |
79964ac8 |
256 | \r |
257 | /**\r |
258 | The GetSmstLocation() function returns the locatin of the System Management\r |
259 | Service Table. The use of the API is such that a driver can discover the\r |
260 | location of the SMST in its entry point and then cache it in some driver\r |
261 | global variable so that the SMST can be invoked in subsequent callbacks.\r |
262 | \r |
ac9868ec |
263 | @param[in] This Protocol instance pointer.\r |
264 | @param[in] Smst Pointer to the SMST.\r |
79964ac8 |
265 | \r |
ac9868ec |
266 | @retval EFI_SUCCESS The operation was successful\r |
267 | @retval EFI_INVALID_PARAMETER Smst was invalid.\r |
268 | @retval EFI_UNSUPPORTED Not in SMM.\r |
79964ac8 |
269 | \r |
270 | **/\r |
271 | typedef\r |
272 | EFI_STATUS\r |
69686d56 |
273 | (EFIAPI *EFI_SMM_GET_SMST_LOCATION)(\r |
79964ac8 |
274 | IN EFI_SMM_BASE_PROTOCOL *This,\r |
275 | IN OUT EFI_SMM_SYSTEM_TABLE **Smst\r |
ed66e1bc |
276 | );\r |
79964ac8 |
277 | \r |
278 | /**\r |
279 | @par Protocol Description:\r |
280 | This protocol is used to install SMM handlers for support of subsequent SMI/PMI\r |
281 | activations. This protocol is available on both IA-32 and Itanium-based systems.\r |
282 | \r |
79964ac8 |
283 | **/\r |
284 | struct _EFI_SMM_BASE_PROTOCOL {\r |
ac9868ec |
285 | ///\r |
286 | /// Registers a handler to run in System Management RAM (SMRAM).\r |
287 | ///\r |
79964ac8 |
288 | EFI_SMM_REGISTER_HANDLER Register;\r |
ac9868ec |
289 | \r |
290 | ///\r |
291 | /// Removes a handler from execution in SMRAM.\r |
292 | ///\r |
79964ac8 |
293 | EFI_SMM_UNREGISTER_HANDLER UnRegister;\r |
ac9868ec |
294 | \r |
295 | ///\r |
296 | /// Sends/receives a message for a registered handler.\r |
297 | ///\r |
79964ac8 |
298 | EFI_SMM_COMMUNICATE Communicate;\r |
ac9868ec |
299 | \r |
300 | ///\r |
301 | /// Registers a callback from the constructor.\r |
302 | ///\r |
79964ac8 |
303 | EFI_SMM_CALLBACK_SERVICE RegisterCallback;\r |
ac9868ec |
304 | \r |
305 | ///\r |
306 | /// Detects whether the caller is inside or outside of SMM. SName\r |
307 | ///\r |
79964ac8 |
308 | EFI_SMM_INSIDE_OUT InSmm;\r |
ac9868ec |
309 | \r |
310 | ///\r |
311 | /// Allocates SMRAM.\r |
312 | ///\r |
79964ac8 |
313 | EFI_SMM_ALLOCATE_POOL SmmAllocatePool;\r |
ac9868ec |
314 | \r |
315 | ///\r |
316 | /// Deallocates SMRAM.\r |
317 | ///\r |
79964ac8 |
318 | EFI_SMM_FREE_POOL SmmFreePool;\r |
ac9868ec |
319 | \r |
320 | ///\r |
321 | /// Retrieves the location of the System Management System Table (SMST).\r |
322 | ///\r |
79964ac8 |
323 | EFI_SMM_GET_SMST_LOCATION GetSmstLocation;\r |
324 | };\r |
325 | \r |
326 | extern EFI_GUID gEfiSmmBaseProtocolGuid;\r |
327 | \r |
328 | #endif\r |