]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
e0c047a0 | 2 | Include file that supports UEFI.\r |
959ccb23 | 3 | \r |
e0c047a0 | 4 | This include file must only contain things defined in the UEFI 2.1 specification.\r |
5 | If a code construct is defined in the UEFI 2.1 specification it must be included\r | |
959ccb23 | 6 | by this include file.\r |
7 | \r | |
e0c047a0 | 8 | Copyright (c) 2006 - 2008, Intel Corporation\r |
959ccb23 | 9 | All rights reserved. This program and the accompanying materials\r |
10 | are licensed and made available under the terms and conditions of the BSD License\r | |
11 | which accompanies this distribution. The full text of the license may be found at\r | |
12 | http://opensource.org/licenses/bsd-license.php\r | |
13 | \r | |
14 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
15 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
16 | \r | |
959ccb23 | 17 | **/\r |
18 | \r | |
19 | #ifndef __UEFI_SPEC_H__\r | |
20 | #define __UEFI_SPEC_H__\r | |
21 | \r | |
22 | #include <Uefi/UefiMultiPhase.h>\r | |
23 | \r | |
24 | #include <Protocol/DevicePath.h>\r | |
25 | #include <Protocol/SimpleTextIn.h>\r | |
26 | #include <Protocol/SimpleTextOut.h>\r | |
27 | \r | |
8b13229b | 28 | ///\r |
2a3f6a21 | 29 | /// Enumeration of EFI memory allocation types.\r |
8b13229b | 30 | ///\r |
959ccb23 | 31 | typedef enum {\r |
2a3f6a21 | 32 | ///\r |
33 | /// Allocate any available range of pages that satisfies the request\r | |
34 | ///\r | |
959ccb23 | 35 | AllocateAnyPages,\r |
2a3f6a21 | 36 | ///\r |
37 | /// Allocate any available range of pages whose uppermost address is less than \r | |
38 | /// or equal to a specified maximum address\r | |
39 | ///\r | |
959ccb23 | 40 | AllocateMaxAddress,\r |
2a3f6a21 | 41 | ///\r |
42 | /// Allocate pages at a specified address\r | |
43 | ///\r | |
959ccb23 | 44 | AllocateAddress,\r |
2a3f6a21 | 45 | ///\r |
46 | /// Maximum enumeration value that may be used for bounds checking\r | |
47 | ///\r | |
959ccb23 | 48 | MaxAllocateType\r |
49 | } EFI_ALLOCATE_TYPE;\r | |
50 | \r | |
5413e8e8 | 51 | //\r |
52 | // Bit definitions for EFI_TIME.Daylight\r | |
53 | //\r | |
54 | #define EFI_TIME_ADJUST_DAYLIGHT 0x01\r | |
55 | #define EFI_TIME_IN_DAYLIGHT 0x02\r | |
56 | \r | |
8b13229b | 57 | ///\r |
58 | /// Value definition for EFI_TIME.TimeZone\r | |
59 | ///\r | |
5413e8e8 | 60 | #define EFI_UNSPECIFIED_TIMEZONE 0x07FF\r |
959ccb23 | 61 | \r |
62 | //\r | |
e0c047a0 | 63 | // Memory cacheability attributes\r |
959ccb23 | 64 | //\r |
65 | #define EFI_MEMORY_UC 0x0000000000000001ULL\r | |
66 | #define EFI_MEMORY_WC 0x0000000000000002ULL\r | |
67 | #define EFI_MEMORY_WT 0x0000000000000004ULL\r | |
68 | #define EFI_MEMORY_WB 0x0000000000000008ULL\r | |
69 | #define EFI_MEMORY_UCE 0x0000000000000010ULL\r | |
959ccb23 | 70 | //\r |
e0c047a0 | 71 | // Physical memory protection attributes\r |
959ccb23 | 72 | //\r |
00edb218 A |
73 | #define EFI_MEMORY_WP 0x0000000000001000ULL\r |
74 | #define EFI_MEMORY_RP 0x0000000000002000ULL\r | |
75 | #define EFI_MEMORY_XP 0x0000000000004000ULL\r | |
e0c047a0 | 76 | //\r |
77 | // Runtime memory attribute\r | |
78 | //\r | |
79 | #define EFI_MEMORY_RUNTIME 0x8000000000000000ULL\r | |
959ccb23 | 80 | \r |
8b13229b | 81 | ///\r |
e0c047a0 | 82 | /// Memory descriptor version number\r |
8b13229b | 83 | ///\r |
959ccb23 | 84 | #define EFI_MEMORY_DESCRIPTOR_VERSION 1\r |
e0c047a0 | 85 | \r |
86 | ///\r | |
2a3f6a21 | 87 | /// Definition of an EFI memory descriptor\r |
e0c047a0 | 88 | ///\r |
959ccb23 | 89 | typedef struct {\r |
2a3f6a21 | 90 | ///\r |
91 | /// Type of the memory region. See EFI_MEMORY_TYPE\r | |
92 | ///\r | |
00edb218 | 93 | UINT32 Type;\r |
2a3f6a21 | 94 | ///\r |
95 | /// Physical address of the first byte of the memory region. Must aligned \r | |
96 | /// on a 4 KB boundary.\r | |
97 | ///\r | |
00edb218 | 98 | EFI_PHYSICAL_ADDRESS PhysicalStart;\r |
2a3f6a21 | 99 | ///\r |
100 | /// Virtual address of the first byte of the memory region. Must aligned \r | |
101 | /// on a 4 KB boundary.\r | |
102 | ///\r | |
00edb218 | 103 | EFI_VIRTUAL_ADDRESS VirtualStart;\r |
2a3f6a21 | 104 | ///\r |
105 | /// Number of 4KB pages in the memory region.\r | |
106 | ///\r | |
00edb218 | 107 | UINT64 NumberOfPages;\r |
2a3f6a21 | 108 | ///\r |
109 | /// Attributes of the memory region that describe the bit mask of capabilities\r | |
110 | /// for that memory region, and not necessarily the current settings for that \r | |
111 | /// memory region.\r | |
112 | ///\r | |
00edb218 | 113 | UINT64 Attribute;\r |
959ccb23 | 114 | } EFI_MEMORY_DESCRIPTOR;\r |
115 | \r | |
959ccb23 | 116 | /**\r |
117 | Allocates memory pages from the system.\r | |
118 | \r | |
119 | @param Type The type of allocation to perform.\r | |
120 | @param MemoryType The type of memory to allocate.\r | |
121 | @param Pages The number of contiguous 4 KB pages to allocate.\r | |
122 | @param Memory Pointer to a physical address. On input, the way in which the address is\r | |
123 | used depends on the value of Type.\r | |
124 | \r | |
125 | @retval EFI_SUCCESS The requested pages were allocated.\r | |
126 | @retval EFI_INVALID_PARAMETER 1) Type is not AllocateAnyPages or\r | |
127 | AllocateMaxAddress or AllocateAddress.\r | |
128 | 2) MemoryType is in the range\r | |
129 | EfiMaxMemoryType..0x7FFFFFFF.\r | |
130 | @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r | |
131 | @retval EFI_NOT_FOUND The requested pages could not be found.\r | |
132 | \r | |
133 | **/\r | |
134 | typedef\r | |
135 | EFI_STATUS\r | |
8b13229b | 136 | (EFIAPI *EFI_ALLOCATE_PAGES)(\r |
959ccb23 | 137 | IN EFI_ALLOCATE_TYPE Type,\r |
138 | IN EFI_MEMORY_TYPE MemoryType,\r | |
139 | IN UINTN Pages,\r | |
140 | IN OUT EFI_PHYSICAL_ADDRESS *Memory\r | |
141 | );\r | |
142 | \r | |
143 | /**\r | |
144 | Frees memory pages.\r | |
145 | \r | |
146 | @param Memory The base physical address of the pages to be freed.\r | |
147 | @param Pages The number of contiguous 4 KB pages to free.\r | |
148 | \r | |
149 | @retval EFI_SUCCESS The requested pages were freed.\r | |
150 | @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.\r | |
151 | @retval EFI_NOT_FOUND The requested memory pages were not allocated with\r | |
152 | AllocatePages().\r | |
153 | \r | |
154 | **/\r | |
155 | typedef\r | |
156 | EFI_STATUS\r | |
8b13229b | 157 | (EFIAPI *EFI_FREE_PAGES)(\r |
959ccb23 | 158 | IN EFI_PHYSICAL_ADDRESS Memory,\r |
159 | IN UINTN Pages\r | |
160 | );\r | |
161 | \r | |
162 | /**\r | |
163 | Returns the current memory map.\r | |
164 | \r | |
165 | @param MemoryMapSize A pointer to the size, in bytes, of the MemoryMap buffer.\r | |
e0c047a0 | 166 | On input, this is the size of the buffer allocated by the caller.\r |
167 | On output, it is the size of the buffer returned by the firmware if\r | |
168 | the buffer was large enough, or the size of the buffer needed to contain\r | |
169 | the map if the buffer was too small.\r | |
959ccb23 | 170 | @param MemoryMap A pointer to the buffer in which firmware places the current memory\r |
171 | map.\r | |
172 | @param MapKey A pointer to the location in which firmware returns the key for the\r | |
173 | current memory map.\r | |
174 | @param DescriptorSize A pointer to the location in which firmware returns the size, in bytes, of\r | |
175 | an individual EFI_MEMORY_DESCRIPTOR.\r | |
176 | @param DescriptorVersion A pointer to the location in which firmware returns the version number\r | |
177 | associated with the EFI_MEMORY_DESCRIPTOR.\r | |
178 | \r | |
179 | @retval EFI_SUCCESS The memory map was returned in the MemoryMap buffer.\r | |
180 | @retval EFI_BUFFER_TOO_SMALL The MemoryMap buffer was too small. The current buffer size\r | |
181 | needed to hold the memory map is returned in MemoryMapSize.\r | |
182 | @retval EFI_INVALID_PARAMETER 1) MemoryMapSize is NULL.\r | |
183 | 2) The MemoryMap buffer is not too small and MemoryMap is\r | |
184 | NULL.\r | |
185 | \r | |
186 | **/\r | |
187 | typedef\r | |
188 | EFI_STATUS\r | |
8b13229b | 189 | (EFIAPI *EFI_GET_MEMORY_MAP)(\r |
959ccb23 | 190 | IN OUT UINTN *MemoryMapSize,\r |
191 | IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,\r | |
192 | OUT UINTN *MapKey,\r | |
193 | OUT UINTN *DescriptorSize,\r | |
194 | OUT UINT32 *DescriptorVersion\r | |
195 | );\r | |
196 | \r | |
197 | /**\r | |
198 | Allocates pool memory.\r | |
199 | \r | |
200 | @param PoolType The type of pool to allocate.\r | |
201 | @param Size The number of bytes to allocate from the pool.\r | |
202 | @param Buffer A pointer to a pointer to the allocated buffer if the call succeeds;\r | |
203 | undefined otherwise.\r | |
204 | \r | |
205 | @retval EFI_SUCCESS The requested number of bytes was allocated.\r | |
206 | @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.\r | |
207 | @retval EFI_INVALID_PARAMETER PoolType was invalid.\r | |
208 | \r | |
209 | **/\r | |
210 | typedef\r | |
211 | EFI_STATUS\r | |
8b13229b | 212 | (EFIAPI *EFI_ALLOCATE_POOL)(\r |
959ccb23 | 213 | IN EFI_MEMORY_TYPE PoolType,\r |
214 | IN UINTN Size,\r | |
215 | OUT VOID **Buffer\r | |
216 | );\r | |
217 | \r | |
218 | /**\r | |
219 | Returns pool memory to the system.\r | |
220 | \r | |
221 | @param Buffer Pointer to the buffer to free.\r | |
222 | \r | |
223 | @retval EFI_SUCCESS The memory was returned to the system.\r | |
224 | @retval EFI_INVALID_PARAMETER Buffer was invalid.\r | |
225 | \r | |
226 | **/\r | |
227 | typedef\r | |
228 | EFI_STATUS\r | |
8b13229b | 229 | (EFIAPI *EFI_FREE_POOL)(\r |
959ccb23 | 230 | IN VOID *Buffer\r |
231 | );\r | |
232 | \r | |
233 | /**\r | |
234 | Changes the runtime addressing mode of EFI firmware from physical to virtual.\r | |
235 | \r | |
236 | @param MemoryMapSize The size in bytes of VirtualMap.\r | |
237 | @param DescriptorSize The size in bytes of an entry in the VirtualMap.\r | |
238 | @param DescriptorVersion The version of the structure entries in VirtualMap.\r | |
239 | @param VirtualMap An array of memory descriptors which contain new virtual\r | |
240 | address mapping information for all runtime ranges.\r | |
241 | \r | |
242 | @retval EFI_SUCCESS The virtual address map has been applied.\r | |
243 | @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in\r | |
244 | virtual address mapped mode.\r | |
245 | @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is invalid.\r | |
246 | @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory\r | |
247 | map that requires a mapping.\r | |
248 | @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found\r | |
249 | in the memory map.\r | |
250 | \r | |
251 | **/\r | |
252 | typedef\r | |
253 | EFI_STATUS\r | |
8b13229b | 254 | (EFIAPI *EFI_SET_VIRTUAL_ADDRESS_MAP)(\r |
959ccb23 | 255 | IN UINTN MemoryMapSize,\r |
256 | IN UINTN DescriptorSize,\r | |
257 | IN UINT32 DescriptorVersion,\r | |
258 | IN EFI_MEMORY_DESCRIPTOR *VirtualMap\r | |
259 | );\r | |
260 | \r | |
261 | /**\r | |
262 | Connects one or more drivers to a controller.\r | |
263 | \r | |
264 | @param ControllerHandle The handle of the controller to which driver(s) are to be connected.\r | |
265 | @param DriverImageHandle A pointer to an ordered list handles that support the\r | |
266 | EFI_DRIVER_BINDING_PROTOCOL.\r | |
267 | @param RemainingDevicePath A pointer to the device path that specifies a child of the\r | |
268 | controller specified by ControllerHandle.\r | |
269 | @param Recursive If TRUE, then ConnectController() is called recursively\r | |
270 | until the entire tree of controllers below the controller specified\r | |
271 | by ControllerHandle have been created. If FALSE, then\r | |
272 | the tree of controllers is only expanded one level.\r | |
273 | \r | |
274 | @retval EFI_SUCCESS 1) One or more drivers were connected to ControllerHandle.\r | |
275 | 2) No drivers were connected to ControllerHandle, but\r | |
276 | RemainingDevicePath is not NULL, and it is an End Device\r | |
277 | Path Node.\r | |
278 | @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r | |
279 | @retval EFI_NOT_FOUND 1) There are no EFI_DRIVER_BINDING_PROTOCOL instances\r | |
280 | present in the system.\r | |
281 | 2) No drivers were connected to ControllerHandle.\r | |
282 | \r | |
283 | **/\r | |
284 | typedef\r | |
285 | EFI_STATUS\r | |
8b13229b | 286 | (EFIAPI *EFI_CONNECT_CONTROLLER)(\r |
959ccb23 | 287 | IN EFI_HANDLE ControllerHandle,\r |
288 | IN EFI_HANDLE *DriverImageHandle, OPTIONAL\r | |
289 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath, OPTIONAL\r | |
290 | IN BOOLEAN Recursive\r | |
291 | );\r | |
292 | \r | |
293 | /**\r | |
294 | Disconnects one or more drivers from a controller.\r | |
295 | \r | |
296 | @param ControllerHandle The handle of the controller from which driver(s) are to be disconnected.\r | |
297 | @param DriverImageHandle The driver to disconnect from ControllerHandle.\r | |
e0c047a0 | 298 | If DriverImageHandle is NULL, then all the drivers currently managing\r |
299 | ControllerHandle are disconnected from ControllerHandle.\r | |
959ccb23 | 300 | @param ChildHandle The handle of the child to destroy.\r |
e0c047a0 | 301 | If ChildHandle is NULL, then all the children of ControllerHandle are\r |
302 | destroyed before the drivers are disconnected from ControllerHandle.\r | |
959ccb23 | 303 | \r |
304 | @retval EFI_SUCCESS 1) One or more drivers were disconnected from the controller.\r | |
305 | 2) On entry, no drivers are managing ControllerHandle.\r | |
306 | 3) DriverImageHandle is not NULL, and on entry\r | |
307 | DriverImageHandle is not managing ControllerHandle.\r | |
e0c047a0 | 308 | @retval EFI_INVALID_PARAMETER 1) ControllerHandle is not a valid EFI_HANDLE.\r |
309 | 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.\r | |
310 | 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.\r | |
311 | 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.\r | |
959ccb23 | 312 | @retval EFI_OUT_OF_RESOURCES There are not enough resources available to disconnect any drivers from\r |
313 | ControllerHandle.\r | |
314 | @retval EFI_DEVICE_ERROR The controller could not be disconnected because of a device error.\r | |
315 | \r | |
316 | **/\r | |
317 | typedef\r | |
318 | EFI_STATUS\r | |
8b13229b | 319 | (EFIAPI *EFI_DISCONNECT_CONTROLLER)(\r |
959ccb23 | 320 | IN EFI_HANDLE ControllerHandle,\r |
321 | IN EFI_HANDLE DriverImageHandle, OPTIONAL\r | |
322 | IN EFI_HANDLE ChildHandle OPTIONAL\r | |
323 | );\r | |
324 | \r | |
325 | \r | |
326 | \r | |
327 | //\r | |
328 | // ConvertPointer DebugDisposition type.\r | |
329 | //\r | |
330 | #define EFI_OPTIONAL_PTR 0x00000001\r | |
959ccb23 | 331 | \r |
332 | /**\r | |
333 | Determines the new virtual address that is to be used on subsequent memory accesses.\r | |
334 | \r | |
335 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
336 | @param Address A pointer to a pointer that is to be fixed to be the value needed\r | |
337 | for the new virtual address mappings being applied.\r | |
338 | \r | |
339 | @retval EFI_SUCCESS The pointer pointed to by Address was modified.\r | |
340 | @retval EFI_INVALID_PARAMETER 1) Address is NULL.\r | |
341 | 2) *Address is NULL and DebugDisposition does\r | |
342 | not have the EFI_OPTIONAL_PTR bit set.\r | |
343 | @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part\r | |
344 | of the current memory map. This is normally fatal.\r | |
345 | \r | |
346 | **/\r | |
347 | typedef\r | |
348 | EFI_STATUS\r | |
8b13229b | 349 | (EFIAPI *EFI_CONVERT_POINTER)(\r |
959ccb23 | 350 | IN UINTN DebugDisposition,\r |
351 | IN OUT VOID **Address\r | |
352 | );\r | |
353 | \r | |
354 | \r | |
355 | //\r | |
ac644614 | 356 | // These types can be ORed together as needed - for example,\r |
93ce5aca | 357 | // EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or\r |
959ccb23 | 358 | // EVT_NOTIFY_SIGNAL.\r |
359 | //\r | |
00edb218 A |
360 | #define EVT_TIMER 0x80000000\r |
361 | #define EVT_RUNTIME 0x40000000\r | |
00edb218 A |
362 | #define EVT_NOTIFY_WAIT 0x00000100\r |
363 | #define EVT_NOTIFY_SIGNAL 0x00000200\r | |
93ce5aca | 364 | \r |
00edb218 | 365 | #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201\r |
93ce5aca | 366 | #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202\r |
959ccb23 | 367 | \r |
368 | //\r | |
ac644614 | 369 | // The event's NotifyContext pointer points to a runtime memory\r |
d0c64728 | 370 | // address.\r |
959ccb23 | 371 | // The event is deprecated in UEFI2.0 and later specifications.\r |
d0c64728 | 372 | //\r |
959ccb23 | 373 | #define EVT_RUNTIME_CONTEXT 0x20000000\r |
374 | \r | |
375 | \r | |
376 | /**\r | |
377 | Invoke a notification event\r | |
378 | \r | |
379 | @param Event Event whose notification function is being invoked.\r | |
380 | @param Context Pointer to the notification function's context,\r | |
381 | which is implementation-dependent.\r | |
382 | \r | |
383 | **/\r | |
384 | typedef\r | |
385 | VOID\r | |
8b13229b | 386 | (EFIAPI *EFI_EVENT_NOTIFY)(\r |
959ccb23 | 387 | IN EFI_EVENT Event,\r |
388 | IN VOID *Context\r | |
389 | );\r | |
390 | \r | |
391 | /**\r | |
392 | Creates an event.\r | |
393 | \r | |
394 | @param Type The type of event to create and its mode and attributes.\r | |
e0c047a0 | 395 | @param NotifyTpl The task priority level of event notifications, if needed.\r |
959ccb23 | 396 | @param NotifyFunction Pointer to the event's notification function, if any.\r |
397 | @param NotifyContext Pointer to the notification function's context; corresponds to parameter\r | |
398 | Context in the notification function.\r | |
399 | @param Event Pointer to the newly created event if the call succeeds; undefined\r | |
400 | otherwise.\r | |
401 | \r | |
402 | @retval EFI_SUCCESS The event structure was created.\r | |
403 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
404 | @retval EFI_OUT_OF_RESOURCES The event could not be allocated.\r | |
405 | \r | |
406 | **/\r | |
407 | typedef\r | |
408 | EFI_STATUS\r | |
8b13229b | 409 | (EFIAPI *EFI_CREATE_EVENT)(\r |
959ccb23 | 410 | IN UINT32 Type,\r |
411 | IN EFI_TPL NotifyTpl,\r | |
412 | IN EFI_EVENT_NOTIFY NotifyFunction,\r | |
413 | IN VOID *NotifyContext,\r | |
414 | OUT EFI_EVENT *Event\r | |
415 | );\r | |
416 | \r | |
417 | /**\r | |
418 | Creates an event in a group.\r | |
419 | \r | |
420 | @param Type The type of event to create and its mode and attributes.\r | |
e0c047a0 | 421 | @param NotifyTpl The task priority level of event notifications,if needed.\r |
959ccb23 | 422 | @param NotifyFunction Pointer to the event's notification function, if any.\r |
423 | @param NotifyContext Pointer to the notification function's context; corresponds to parameter\r | |
424 | Context in the notification function.\r | |
425 | @param EventGroup Pointer to the unique identifier of the group to which this event belongs.\r | |
e0c047a0 | 426 | If this is NULL, then the function behaves as if the parameters were passed\r |
427 | to CreateEvent.\r | |
959ccb23 | 428 | @param Event Pointer to the newly created event if the call succeeds; undefined\r |
429 | otherwise.\r | |
430 | \r | |
431 | @retval EFI_SUCCESS The event structure was created.\r | |
432 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
433 | @retval EFI_OUT_OF_RESOURCES The event could not be allocated.\r | |
434 | \r | |
435 | **/\r | |
436 | typedef\r | |
437 | EFI_STATUS\r | |
8b13229b | 438 | (EFIAPI *EFI_CREATE_EVENT_EX)(\r |
959ccb23 | 439 | IN UINT32 Type,\r |
e0c047a0 | 440 | IN EFI_TPL NotifyTpl,\r |
959ccb23 | 441 | IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,\r |
442 | IN CONST VOID *NotifyContext OPTIONAL,\r | |
443 | IN CONST EFI_GUID *EventGroup OPTIONAL,\r | |
444 | OUT EFI_EVENT *Event\r | |
445 | );\r | |
446 | \r | |
e0c047a0 | 447 | ///\r |
448 | /// Timer delay types\r | |
449 | ///\r | |
959ccb23 | 450 | typedef enum {\r |
2a3f6a21 | 451 | ///\r |
452 | /// An event's timer settings is to be cancelled and not trigger time is to be set\r | |
453 | ///\r | |
959ccb23 | 454 | TimerCancel,\r |
2a3f6a21 | 455 | ///\r |
456 | /// An event is to be signalled periodically at a specified interval from the current time.\r | |
457 | ///\r | |
959ccb23 | 458 | TimerPeriodic,\r |
2a3f6a21 | 459 | ///\r |
460 | /// An event is to be signalled once at a specified interval from the current time.\r | |
461 | ///\r | |
959ccb23 | 462 | TimerRelative\r |
463 | } EFI_TIMER_DELAY;\r | |
464 | \r | |
465 | /**\r | |
466 | Sets the type of timer and the trigger time for a timer event.\r | |
467 | \r | |
468 | @param Event The timer event that is to be signaled at the specified time.\r | |
469 | @param Type The type of time that is specified in TriggerTime.\r | |
470 | @param TriggerTime The number of 100ns units until the timer expires.\r | |
e0c047a0 | 471 | A TriggerTime of 0 is legal.\r |
472 | If Type is TimerRelative and TriggerTime is 0, then the timer\r | |
473 | event will be signaled on the next timer tick.\r | |
474 | If Type is TimerPeriodic and TriggerTime is 0, then the timer\r | |
475 | event will be signaled on every timer tick.\r | |
959ccb23 | 476 | \r |
477 | @retval EFI_SUCCESS The event has been set to be signaled at the requested time.\r | |
478 | @retval EFI_INVALID_PARAMETER Event or Type is not valid.\r | |
479 | \r | |
480 | **/\r | |
481 | typedef\r | |
482 | EFI_STATUS\r | |
8b13229b | 483 | (EFIAPI *EFI_SET_TIMER)(\r |
959ccb23 | 484 | IN EFI_EVENT Event,\r |
485 | IN EFI_TIMER_DELAY Type,\r | |
486 | IN UINT64 TriggerTime\r | |
487 | );\r | |
488 | \r | |
489 | /**\r | |
490 | Signals an event.\r | |
491 | \r | |
492 | @param Event The event to signal.\r | |
493 | \r | |
494 | @retval EFI_SUCCESS The event has been signaled.\r | |
495 | \r | |
496 | **/\r | |
497 | typedef\r | |
498 | EFI_STATUS\r | |
8b13229b | 499 | (EFIAPI *EFI_SIGNAL_EVENT)(\r |
959ccb23 | 500 | IN EFI_EVENT Event\r |
501 | );\r | |
502 | \r | |
503 | /**\r | |
504 | Stops execution until an event is signaled.\r | |
505 | \r | |
506 | @param NumberOfEvents The number of events in the Event array.\r | |
507 | @param Event An array of EFI_EVENT.\r | |
508 | @param Index Pointer to the index of the event which satisfied the wait condition.\r | |
509 | \r | |
510 | @retval EFI_SUCCESS The event indicated by Index was signaled.\r | |
511 | @retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.\r | |
512 | 2) The event indicated by Index is of type\r | |
513 | EVT_NOTIFY_SIGNAL.\r | |
514 | @retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION.\r | |
515 | \r | |
516 | **/\r | |
517 | typedef\r | |
518 | EFI_STATUS\r | |
8b13229b | 519 | (EFIAPI *EFI_WAIT_FOR_EVENT)(\r |
959ccb23 | 520 | IN UINTN NumberOfEvents,\r |
521 | IN EFI_EVENT *Event,\r | |
522 | OUT UINTN *Index\r | |
523 | );\r | |
524 | \r | |
525 | /**\r | |
526 | Closes an event.\r | |
527 | \r | |
528 | @param Event The event to close.\r | |
529 | \r | |
530 | @retval EFI_SUCCESS The event has been closed.\r | |
531 | \r | |
532 | **/\r | |
533 | typedef\r | |
534 | EFI_STATUS\r | |
8b13229b | 535 | (EFIAPI *EFI_CLOSE_EVENT)(\r |
959ccb23 | 536 | IN EFI_EVENT Event\r |
537 | );\r | |
538 | \r | |
539 | /**\r | |
540 | Checks whether an event is in the signaled state.\r | |
541 | \r | |
542 | @param Event The event to check.\r | |
543 | \r | |
544 | @retval EFI_SUCCESS The event is in the signaled state.\r | |
545 | @retval EFI_NOT_READY The event is not in the signaled state.\r | |
546 | @retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL.\r | |
547 | \r | |
548 | **/\r | |
549 | typedef\r | |
550 | EFI_STATUS\r | |
8b13229b | 551 | (EFIAPI *EFI_CHECK_EVENT)(\r |
959ccb23 | 552 | IN EFI_EVENT Event\r |
553 | );\r | |
554 | \r | |
555 | \r | |
556 | //\r | |
e0c047a0 | 557 | // Task priority level\r |
959ccb23 | 558 | //\r |
559 | #define TPL_APPLICATION 4\r | |
560 | #define TPL_CALLBACK 8\r | |
561 | #define TPL_NOTIFY 16\r | |
562 | #define TPL_HIGH_LEVEL 31\r | |
563 | \r | |
564 | \r | |
565 | /**\r | |
566 | Raises a task's priority level and returns its previous level.\r | |
567 | \r | |
568 | @param NewTpl The new task priority level.\r | |
569 | \r | |
e0c047a0 | 570 | @return Previous task priority level\r |
959ccb23 | 571 | \r |
572 | **/\r | |
573 | typedef\r | |
574 | EFI_TPL\r | |
8b13229b | 575 | (EFIAPI *EFI_RAISE_TPL)(\r |
959ccb23 | 576 | IN EFI_TPL NewTpl\r |
577 | );\r | |
578 | \r | |
579 | /**\r | |
580 | Restores a task's priority level to its previous value.\r | |
581 | \r | |
e0c047a0 | 582 | @param OldTpl The previous task priority level to restore.\r |
959ccb23 | 583 | \r |
584 | **/\r | |
585 | typedef\r | |
586 | VOID\r | |
8b13229b | 587 | (EFIAPI *EFI_RESTORE_TPL)(\r |
959ccb23 | 588 | IN EFI_TPL OldTpl\r |
589 | );\r | |
590 | \r | |
591 | /**\r | |
592 | Returns the value of a variable.\r | |
593 | \r | |
594 | @param VariableName A Null-terminated Unicode string that is the name of the\r | |
595 | vendor's variable.\r | |
596 | @param VendorGuid A unique identifier for the vendor.\r | |
597 | @param Attributes If not NULL, a pointer to the memory location to return the\r | |
598 | attributes bitmask for the variable.\r | |
599 | @param DataSize On input, the size in bytes of the return Data buffer.\r | |
600 | On output the size of data returned in Data.\r | |
601 | @param Data The buffer to return the contents of the variable.\r | |
602 | \r | |
e0c047a0 | 603 | @retval EFI_SUCCESS The function completed successfully.\r |
604 | @retval EFI_NOT_FOUND The variable was not found.\r | |
605 | @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.\r | |
606 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
607 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
608 | @retval EFI_INVALID_PARAMETER DataSize is NULL.\r | |
609 | @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.\r | |
610 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
611 | @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r | |
959ccb23 | 612 | \r |
613 | **/\r | |
614 | typedef\r | |
615 | EFI_STATUS\r | |
8b13229b | 616 | (EFIAPI *EFI_GET_VARIABLE)(\r |
959ccb23 | 617 | IN CHAR16 *VariableName,\r |
618 | IN EFI_GUID *VendorGuid,\r | |
619 | OUT UINT32 *Attributes, OPTIONAL\r | |
620 | IN OUT UINTN *DataSize,\r | |
621 | OUT VOID *Data\r | |
622 | );\r | |
623 | \r | |
624 | /**\r | |
625 | Enumerates the current variable names.\r | |
626 | \r | |
627 | @param VariableNameSize The size of the VariableName buffer.\r | |
628 | @param VariableName On input, supplies the last VariableName that was returned\r | |
629 | by GetNextVariableName(). On output, returns the Nullterminated\r | |
630 | Unicode string of the current variable.\r | |
631 | @param VendorGuid On input, supplies the last VendorGuid that was returned by\r | |
632 | GetNextVariableName(). On output, returns the\r | |
633 | VendorGuid of the current variable.\r | |
634 | \r | |
635 | @retval EFI_SUCCESS The function completed successfully.\r | |
636 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
637 | @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r | |
e0c047a0 | 638 | @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r |
639 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
640 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
959ccb23 | 641 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r |
642 | \r | |
643 | **/\r | |
644 | typedef\r | |
645 | EFI_STATUS\r | |
8b13229b | 646 | (EFIAPI *EFI_GET_NEXT_VARIABLE_NAME)(\r |
959ccb23 | 647 | IN OUT UINTN *VariableNameSize,\r |
648 | IN OUT CHAR16 *VariableName,\r | |
649 | IN OUT EFI_GUID *VendorGuid\r | |
650 | );\r | |
651 | \r | |
652 | /**\r | |
653 | Sets the value of a variable.\r | |
654 | \r | |
655 | @param VariableName A Null-terminated Unicode string that is the name of the\r | |
656 | vendor's variable.\r | |
657 | @param VendorGuid A unique identifier for the vendor.\r | |
658 | @param Attributes Attributes bitmask to set for the variable.\r | |
659 | @param DataSize The size in bytes of the Data buffer.\r | |
660 | @param Data The contents for the variable.\r | |
661 | \r | |
e0c047a0 | 662 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r |
663 | defined by the Attributes.\r | |
664 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the\r | |
665 | DataSize exceeds the maximum allowed.\r | |
666 | @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.\r | |
667 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
668 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
669 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
670 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
671 | @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r | |
672 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
959ccb23 | 673 | \r |
674 | **/\r | |
675 | typedef\r | |
676 | EFI_STATUS\r | |
8b13229b | 677 | (EFIAPI *EFI_SET_VARIABLE)(\r |
959ccb23 | 678 | IN CHAR16 *VariableName,\r |
679 | IN EFI_GUID *VendorGuid,\r | |
680 | IN UINT32 Attributes,\r | |
681 | IN UINTN DataSize,\r | |
682 | IN VOID *Data\r | |
683 | );\r | |
684 | \r | |
685 | \r | |
e0c047a0 | 686 | ///\r |
687 | /// This provides the capabilities of the\r | |
688 | /// real time clock device as exposed through the EFI interfaces.\r | |
689 | ///\r | |
959ccb23 | 690 | typedef struct {\r |
1bf79370 LG |
691 | ///\r |
692 | /// Provides the reporting resolution of the real-time clock device in\r | |
693 | /// counts per second. For a normal PC-AT CMOS RTC device, this\r | |
694 | /// value would be 1 Hz, or 1, to indicate that the device only reports\r | |
695 | /// the time to the resolution of 1 second.\r | |
696 | ///\r | |
00edb218 | 697 | UINT32 Resolution;\r |
1bf79370 LG |
698 | ///\r |
699 | /// Provides the timekeeping accuracy of the real-time clock in an\r | |
700 | /// error rate of 1E-6 parts per million. For a clock with an accuracy\r | |
701 | /// of 50 parts per million, the value in this field would be\r | |
702 | /// 50,000,000.\r | |
703 | ///\r | |
00edb218 | 704 | UINT32 Accuracy;\r |
1bf79370 | 705 | ///\r |
de2314f8 | 706 | /// A TRUE indicates that a time set operation clears the device's\r |
1bf79370 LG |
707 | /// time below the Resolution reporting level. A FALSE\r |
708 | /// indicates that the state below the Resolution level of the\r | |
709 | /// device is not cleared when the time is set. Normal PC-AT CMOS\r | |
710 | /// RTC devices set this value to FALSE.\r | |
711 | ///\r | |
00edb218 | 712 | BOOLEAN SetsToZero;\r |
959ccb23 | 713 | } EFI_TIME_CAPABILITIES;\r |
714 | \r | |
715 | /**\r | |
716 | Returns the current time and date information, and the time-keeping capabilities\r | |
717 | of the hardware platform.\r | |
718 | \r | |
719 | @param Time A pointer to storage to receive a snapshot of the current time.\r | |
720 | @param Capabilities An optional pointer to a buffer to receive the real time clock\r | |
721 | device's capabilities.\r | |
722 | \r | |
723 | @retval EFI_SUCCESS The operation completed successfully.\r | |
724 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
725 | @retval EFI_DEVICE_ERROR The time could not be retrieved due to hardware error.\r | |
726 | \r | |
727 | **/\r | |
728 | typedef\r | |
729 | EFI_STATUS\r | |
8b13229b | 730 | (EFIAPI *EFI_GET_TIME)(\r |
959ccb23 | 731 | OUT EFI_TIME *Time,\r |
732 | OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL\r | |
733 | );\r | |
734 | \r | |
735 | /**\r | |
736 | Sets the current local time and date information.\r | |
737 | \r | |
738 | @param Time A pointer to the current time.\r | |
739 | \r | |
740 | @retval EFI_SUCCESS The operation completed successfully.\r | |
741 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
742 | @retval EFI_DEVICE_ERROR The time could not be set due due to hardware error.\r | |
743 | \r | |
744 | **/\r | |
745 | typedef\r | |
746 | EFI_STATUS\r | |
8b13229b | 747 | (EFIAPI *EFI_SET_TIME)(\r |
959ccb23 | 748 | IN EFI_TIME *Time\r |
749 | );\r | |
750 | \r | |
751 | /**\r | |
752 | Returns the current wakeup alarm clock setting.\r | |
753 | \r | |
754 | @param Enabled Indicates if the alarm is currently enabled or disabled.\r | |
755 | @param Pending Indicates if the alarm signal is pending and requires acknowledgement.\r | |
756 | @param Time The current alarm setting.\r | |
757 | \r | |
758 | @retval EFI_SUCCESS The alarm settings were returned.\r | |
e0c047a0 | 759 | @retval EFI_INVALID_PARAMETER Enabled is NULL.\r |
760 | @retval EFI_INVALID_PARAMETER Pending is NULL.\r | |
761 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
959ccb23 | 762 | @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r |
e0c047a0 | 763 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r |
959ccb23 | 764 | \r |
765 | **/\r | |
766 | typedef\r | |
767 | EFI_STATUS\r | |
8b13229b | 768 | (EFIAPI *EFI_GET_WAKEUP_TIME)(\r |
959ccb23 | 769 | OUT BOOLEAN *Enabled,\r |
770 | OUT BOOLEAN *Pending,\r | |
771 | OUT EFI_TIME *Time\r | |
772 | );\r | |
773 | \r | |
774 | /**\r | |
775 | Sets the system wakeup alarm clock time.\r | |
776 | \r | |
777 | @param Enabled Enable or disable the wakeup alarm.\r | |
778 | @param Time If Enable is TRUE, the time to set the wakeup alarm for.\r | |
e0c047a0 | 779 | If Enable is FALSE, then this parameter is optional, and may be NULL.\r |
959ccb23 | 780 | \r |
781 | @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled. If\r | |
782 | Enable is FALSE, then the wakeup alarm was disabled.\r | |
783 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
784 | @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r | |
785 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
786 | \r | |
787 | **/\r | |
788 | typedef\r | |
789 | EFI_STATUS\r | |
8b13229b | 790 | (EFIAPI *EFI_SET_WAKEUP_TIME)(\r |
959ccb23 | 791 | IN BOOLEAN Enable,\r |
792 | IN EFI_TIME *Time OPTIONAL\r | |
793 | );\r | |
794 | \r | |
959ccb23 | 795 | /**\r |
796 | Loads an EFI image into memory.\r | |
797 | \r | |
798 | @param BootPolicy If TRUE, indicates that the request originates from the boot\r | |
799 | manager, and that the boot manager is attempting to load\r | |
800 | FilePath as a boot selection. Ignored if SourceBuffer is\r | |
801 | not NULL.\r | |
802 | @param ParentImageHandle The caller's image handle.\r | |
e0c047a0 | 803 | @param DevicePath The DeviceHandle specific file path from which the image is\r |
959ccb23 | 804 | loaded.\r |
805 | @param SourceBuffer If not NULL, a pointer to the memory location containing a copy\r | |
806 | of the image to be loaded.\r | |
e0c047a0 | 807 | @param SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.\r |
959ccb23 | 808 | @param ImageHandle Pointer to the returned image handle that is created when the\r |
809 | image is successfully loaded.\r | |
810 | \r | |
811 | @retval EFI_SUCCESS Image was loaded into memory correctly.\r | |
e0c047a0 | 812 | @retval EFI_NOT_FOUND Both SourceBuffer and DevicePath are NULL.\r |
959ccb23 | 813 | @retval EFI_INVALID_PARAMETER One or more parametes are invalid.\r |
814 | @retval EFI_UNSUPPORTED The image type is not supported.\r | |
815 | @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.\r | |
816 | @retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not\r | |
817 | understood.\r | |
818 | @retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.\r | |
819 | \r | |
820 | **/\r | |
821 | typedef\r | |
822 | EFI_STATUS\r | |
8b13229b | 823 | (EFIAPI *EFI_IMAGE_LOAD)(\r |
959ccb23 | 824 | IN BOOLEAN BootPolicy,\r |
825 | IN EFI_HANDLE ParentImageHandle,\r | |
e0c047a0 | 826 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r |
959ccb23 | 827 | IN VOID *SourceBuffer OPTIONAL,\r |
828 | IN UINTN SourceSize,\r | |
829 | OUT EFI_HANDLE *ImageHandle\r | |
830 | );\r | |
831 | \r | |
832 | /**\r | |
833 | Transfers control to a loaded image's entry point.\r | |
834 | \r | |
835 | @param ImageHandle Handle of image to be started.\r | |
836 | @param ExitDataSize Pointer to the size, in bytes, of ExitData.\r | |
837 | @param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated\r | |
838 | Unicode string, optionally followed by additional binary data.\r | |
839 | \r | |
840 | @retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image\r | |
841 | has already been initialized with StartImage\r | |
e0c047a0 | 842 | @return Exit code from image\r |
959ccb23 | 843 | \r |
844 | **/\r | |
845 | typedef\r | |
846 | EFI_STATUS\r | |
8b13229b | 847 | (EFIAPI *EFI_IMAGE_START)(\r |
959ccb23 | 848 | IN EFI_HANDLE ImageHandle,\r |
849 | OUT UINTN *ExitDataSize,\r | |
850 | OUT CHAR16 **ExitData OPTIONAL\r | |
851 | );\r | |
852 | \r | |
853 | /**\r | |
854 | Terminates a loaded EFI image and returns control to boot services.\r | |
855 | \r | |
856 | @param ImageHandle Handle that identifies the image.\r | |
857 | @param ExitStatus The image's exit code.\r | |
858 | @param ExitDataSize The size, in bytes, of ExitData.\r | |
859 | @param ExitData Pointer to a data buffer that includes a Null-terminated Unicode string,\r | |
860 | optionally followed by additional binary data.\r | |
861 | \r | |
862 | @retval EFI_SUCCESS The image specified by ImageHandle was unloaded.\r | |
863 | @retval EFI_INVALID_PARAMETER The image specified by ImageHandle has been loaded and\r | |
864 | started with LoadImage() and StartImage(), but the\r | |
865 | image is not the currently executing image.\r | |
866 | \r | |
867 | **/\r | |
868 | typedef\r | |
869 | EFI_STATUS\r | |
8b13229b | 870 | (EFIAPI *EFI_EXIT)(\r |
959ccb23 | 871 | IN EFI_HANDLE ImageHandle,\r |
872 | IN EFI_STATUS ExitStatus,\r | |
873 | IN UINTN ExitDataSize,\r | |
874 | IN CHAR16 *ExitData OPTIONAL\r | |
875 | );\r | |
876 | \r | |
877 | /**\r | |
878 | Unloads an image.\r | |
879 | \r | |
880 | @param ImageHandle Handle that identifies the image to be unloaded.\r | |
881 | \r | |
882 | @retval EFI_SUCCESS The image has been unloaded.\r | |
883 | @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.\r | |
959ccb23 | 884 | \r |
885 | **/\r | |
886 | typedef\r | |
887 | EFI_STATUS\r | |
8b13229b | 888 | (EFIAPI *EFI_IMAGE_UNLOAD)(\r |
959ccb23 | 889 | IN EFI_HANDLE ImageHandle\r |
890 | );\r | |
891 | \r | |
892 | /**\r | |
893 | Terminates all boot services.\r | |
894 | \r | |
895 | @param ImageHandle Handle that identifies the exiting image.\r | |
896 | @param MapKey Key to the latest memory map.\r | |
897 | \r | |
898 | @retval EFI_SUCCESS Boot services have been terminated.\r | |
899 | @retval EFI_INVALID_PARAMETER MapKey is incorrect.\r | |
900 | \r | |
901 | **/\r | |
902 | typedef\r | |
903 | EFI_STATUS\r | |
8b13229b | 904 | (EFIAPI *EFI_EXIT_BOOT_SERVICES)(\r |
959ccb23 | 905 | IN EFI_HANDLE ImageHandle,\r |
906 | IN UINTN MapKey\r | |
907 | );\r | |
908 | \r | |
909 | /**\r | |
910 | Induces a fine-grained stall.\r | |
911 | \r | |
912 | @param Microseconds The number of microseconds to stall execution.\r | |
913 | \r | |
914 | @retval EFI_SUCCESS Execution was stalled at least the requested number of\r | |
915 | Microseconds.\r | |
916 | \r | |
917 | **/\r | |
918 | typedef\r | |
919 | EFI_STATUS\r | |
8b13229b | 920 | (EFIAPI *EFI_STALL)(\r |
959ccb23 | 921 | IN UINTN Microseconds\r |
922 | );\r | |
923 | \r | |
924 | /**\r | |
925 | Sets the system's watchdog timer.\r | |
926 | \r | |
927 | @param Timeout The number of seconds to set the watchdog timer to.\r | |
928 | @param WatchdogCode The numeric code to log on a watchdog timer timeout event.\r | |
929 | @param DataSize The size, in bytes, of WatchdogData.\r | |
930 | @param WatchdogData A data buffer that includes a Null-terminated Unicode string, optionally\r | |
931 | followed by additional binary data.\r | |
932 | \r | |
933 | @retval EFI_SUCCESS The timeout has been set.\r | |
934 | @retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.\r | |
935 | @retval EFI_UNSUPPORTED The system does not have a watchdog timer.\r | |
936 | @retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware\r | |
937 | error.\r | |
938 | \r | |
939 | **/\r | |
940 | typedef\r | |
941 | EFI_STATUS\r | |
8b13229b | 942 | (EFIAPI *EFI_SET_WATCHDOG_TIMER)(\r |
959ccb23 | 943 | IN UINTN Timeout,\r |
944 | IN UINT64 WatchdogCode,\r | |
945 | IN UINTN DataSize,\r | |
946 | IN CHAR16 *WatchdogData OPTIONAL\r | |
947 | );\r | |
948 | \r | |
e0c047a0 | 949 | ///\r |
950 | /// Enumeration of reset types.\r | |
951 | ///\r | |
959ccb23 | 952 | typedef enum {\r |
2a3f6a21 | 953 | ///\r |
954 | /// Used to induce a system-wide reset. This sets all circuitry within the \r | |
955 | /// system to its initial state. This type of reset is asynchronous to system\r | |
956 | /// operation and operates withgout regard to cycle boundaries. EfiColdReset \r | |
957 | /// is tantamount to a system power cycle.\r | |
958 | ///\r | |
959ccb23 | 959 | EfiResetCold,\r |
2a3f6a21 | 960 | ///\r |
961 | /// Used to induce a system-wide initialization. The processors are set to their\r | |
962 | /// initial state, and pending cycles are not corrupted. If the system does \r | |
963 | /// not support this reset type, then an EfiResetCold must be performed.\r | |
964 | ///\r | |
959ccb23 | 965 | EfiResetWarm,\r |
2a3f6a21 | 966 | ///\r |
f754f721 | 967 | /// Used to induce an entry into a power state equivalent to the ACPI G2/S5 or G3\r |
2a3f6a21 | 968 | /// state. If the system does not support this reset type, then when the system\r |
969 | /// is rebooted, it should exhibit the EfiResetCold attributes.\r | |
970 | ///\r | |
971 | EfiResetShutdown\r | |
959ccb23 | 972 | } EFI_RESET_TYPE;\r |
973 | \r | |
974 | /**\r | |
975 | Resets the entire platform.\r | |
976 | \r | |
977 | @param ResetType The type of reset to perform.\r | |
978 | @param ResetStatus The status code for the reset.\r | |
979 | @param DataSize The size, in bytes, of WatchdogData.\r | |
980 | @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or\r | |
981 | EfiResetShutdown the data buffer starts with a Null-terminated\r | |
982 | Unicode string, optionally followed by additional binary data.\r | |
983 | \r | |
984 | **/\r | |
985 | typedef\r | |
986 | VOID\r | |
8b13229b | 987 | (EFIAPI *EFI_RESET_SYSTEM)(\r |
959ccb23 | 988 | IN EFI_RESET_TYPE ResetType,\r |
989 | IN EFI_STATUS ResetStatus,\r | |
990 | IN UINTN DataSize,\r | |
b058028b | 991 | IN VOID *ResetData OPTIONAL\r |
959ccb23 | 992 | );\r |
993 | \r | |
994 | /**\r | |
995 | Returns a monotonically increasing count for the platform.\r | |
996 | \r | |
997 | @param Count Pointer to returned value.\r | |
998 | \r | |
999 | @retval EFI_SUCCESS The next monotonic count was returned.\r | |
1000 | @retval EFI_INVALID_PARAMETER Count is NULL.\r | |
1001 | @retval EFI_DEVICE_ERROR The device is not functioning properly.\r | |
1002 | \r | |
1003 | **/\r | |
1004 | typedef\r | |
1005 | EFI_STATUS\r | |
8b13229b | 1006 | (EFIAPI *EFI_GET_NEXT_MONOTONIC_COUNT)(\r |
959ccb23 | 1007 | OUT UINT64 *Count\r |
1008 | );\r | |
1009 | \r | |
1010 | /**\r | |
1011 | Returns the next high 32 bits of the platform's monotonic counter.\r | |
1012 | \r | |
1013 | @param HighCount Pointer to returned value.\r | |
1014 | \r | |
1015 | @retval EFI_SUCCESS The next high monotonic count was returned.\r | |
1016 | @retval EFI_INVALID_PARAMETER HighCount is NULL.\r | |
1017 | @retval EFI_DEVICE_ERROR The device is not functioning properly.\r | |
1018 | \r | |
1019 | **/\r | |
1020 | typedef\r | |
1021 | EFI_STATUS\r | |
8b13229b | 1022 | (EFIAPI *EFI_GET_NEXT_HIGH_MONO_COUNT)(\r |
959ccb23 | 1023 | OUT UINT32 *HighCount\r |
1024 | );\r | |
1025 | \r | |
1026 | /**\r | |
1027 | Computes and returns a 32-bit CRC for a data buffer.\r | |
1028 | \r | |
1029 | @param Data A pointer to the buffer on which the 32-bit CRC is to be computed.\r | |
1030 | @param DataSize The number of bytes in the buffer Data.\r | |
1031 | @param Crc32 The 32-bit CRC that was computed for the data buffer specified by Data\r | |
1032 | and DataSize.\r | |
1033 | \r | |
1034 | @retval EFI_SUCCESS The 32-bit CRC was computed for the data buffer and returned in\r | |
1035 | Crc32.\r | |
e0c047a0 | 1036 | @retval EFI_INVALID_PARAMETER Data is NULL.\r |
1037 | @retval EFI_INVALID_PARAMETER Crc32 is NULL.\r | |
1038 | @retval EFI_INVALID_PARAMETER DataSize is 0.\r | |
959ccb23 | 1039 | \r |
1040 | **/\r | |
1041 | typedef\r | |
1042 | EFI_STATUS\r | |
8b13229b | 1043 | (EFIAPI *EFI_CALCULATE_CRC32)(\r |
959ccb23 | 1044 | IN VOID *Data,\r |
1045 | IN UINTN DataSize,\r | |
1046 | OUT UINT32 *Crc32\r | |
1047 | );\r | |
1048 | \r | |
1049 | /**\r | |
1050 | Copies the contents of one buffer to another buffer.\r | |
1051 | \r | |
1052 | @param Destination Pointer to the destination buffer of the memory copy.\r | |
1053 | @param Source Pointer to the source buffer of the memory copy.\r | |
1054 | @param Length Number of bytes to copy from Source to Destination.\r | |
1055 | \r | |
1056 | **/\r | |
1057 | typedef\r | |
1058 | VOID\r | |
8b13229b | 1059 | (EFIAPI *EFI_COPY_MEM)(\r |
959ccb23 | 1060 | IN VOID *Destination,\r |
1061 | IN VOID *Source,\r | |
1062 | IN UINTN Length\r | |
1063 | );\r | |
1064 | \r | |
1065 | /**\r | |
1066 | The SetMem() function fills a buffer with a specified value.\r | |
1067 | \r | |
1068 | @param Buffer Pointer to the buffer to fill.\r | |
1069 | @param Size Number of bytes in Buffer to fill.\r | |
1070 | @param Value Value to fill Buffer with.\r | |
1071 | \r | |
1072 | **/\r | |
1073 | typedef\r | |
1074 | VOID\r | |
8b13229b | 1075 | (EFIAPI *EFI_SET_MEM)(\r |
959ccb23 | 1076 | IN VOID *Buffer,\r |
1077 | IN UINTN Size,\r | |
1078 | IN UINT8 Value\r | |
1079 | );\r | |
1080 | \r | |
2a3f6a21 | 1081 | ///\r |
1082 | /// Enumeration of EFI Interface Types\r | |
1083 | ///\r | |
959ccb23 | 1084 | typedef enum {\r |
2a3f6a21 | 1085 | ///\r |
1086 | /// Indicates that the supplied protocol interface is supplied in native form.\r | |
1087 | ///\r | |
959ccb23 | 1088 | EFI_NATIVE_INTERFACE\r |
1089 | } EFI_INTERFACE_TYPE;\r | |
1090 | \r | |
1091 | /**\r | |
1092 | Installs a protocol interface on a device handle. If the handle does not exist, it is created and added\r | |
1093 | to the list of handles in the system. InstallMultipleProtocolInterfaces() performs\r | |
1094 | more error checking than InstallProtocolInterface(), so it is recommended that\r | |
1095 | InstallMultipleProtocolInterfaces() be used in place of\r | |
1096 | InstallProtocolInterface()\r | |
1097 | \r | |
1098 | @param Handle A pointer to the EFI_HANDLE on which the interface is to be installed.\r | |
1099 | @param Protocol The numeric ID of the protocol interface.\r | |
1100 | @param InterfaceType Indicates whether Interface is supplied in native form.\r | |
1101 | @param Interface A pointer to the protocol interface.\r | |
1102 | \r | |
1103 | @retval EFI_SUCCESS The protocol interface was installed.\r | |
1104 | @retval EFI_OUT_OF_RESOURCES Space for a new handle could not be allocated.\r | |
e0c047a0 | 1105 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
1106 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r | |
1107 | @retval EFI_INVALID_PARAMETER InterfaceType is not EFI_NATIVE_INTERFACE.\r | |
1108 | @retval EFI_INVALID_PARAMETER Protocol is already installed on the handle specified by Handle.\r | |
959ccb23 | 1109 | \r |
1110 | **/\r | |
1111 | typedef\r | |
1112 | EFI_STATUS\r | |
8b13229b | 1113 | (EFIAPI *EFI_INSTALL_PROTOCOL_INTERFACE)(\r |
959ccb23 | 1114 | IN OUT EFI_HANDLE *Handle,\r |
1115 | IN EFI_GUID *Protocol,\r | |
1116 | IN EFI_INTERFACE_TYPE InterfaceType,\r | |
1117 | IN VOID *Interface\r | |
1118 | );\r | |
1119 | \r | |
1120 | /**\r | |
1121 | Installs one or more protocol interfaces into the boot services environment.\r | |
1122 | \r | |
1123 | @param Handle The handle to install the new protocol interfaces on, or NULL if a new\r | |
1124 | handle is to be allocated.\r | |
1125 | @param ... A variable argument list containing pairs of protocol GUIDs and protocol\r | |
1126 | interfaces.\r | |
1127 | \r | |
1128 | @retval EFI_SUCCESS All the protocol interface was installed.\r | |
1129 | @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r | |
1130 | @retval EFI_ALREADY_STARTED A Device Path Protocol instance was passed in that is already present in\r | |
1131 | the handle database.\r | |
1132 | \r | |
1133 | **/\r | |
1134 | typedef\r | |
1135 | EFI_STATUS\r | |
8b13229b | 1136 | (EFIAPI *EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES)(\r |
959ccb23 | 1137 | IN OUT EFI_HANDLE *Handle,\r |
1138 | ...\r | |
1139 | );\r | |
1140 | \r | |
1141 | /**\r | |
1142 | Reinstalls a protocol interface on a device handle.\r | |
1143 | \r | |
1144 | @param Handle Handle on which the interface is to be reinstalled.\r | |
1145 | @param Protocol The numeric ID of the interface.\r | |
1146 | @param OldInterface A pointer to the old interface. NULL can be used if a structure is not\r | |
1147 | associated with Protocol.\r | |
1148 | @param NewInterface A pointer to the new interface.\r | |
1149 | \r | |
1150 | @retval EFI_SUCCESS The protocol interface was reinstalled.\r | |
1151 | @retval EFI_NOT_FOUND The OldInterface on the handle was not found.\r | |
1152 | @retval EFI_ACCESS_DENIED The protocol interface could not be reinstalled,\r | |
1153 | because OldInterface is still being used by a\r | |
1154 | driver that will not release it.\r | |
e0c047a0 | 1155 | @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r |
1156 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r | |
959ccb23 | 1157 | \r |
1158 | **/\r | |
1159 | typedef\r | |
1160 | EFI_STATUS\r | |
8b13229b | 1161 | (EFIAPI *EFI_REINSTALL_PROTOCOL_INTERFACE)(\r |
959ccb23 | 1162 | IN EFI_HANDLE Handle,\r |
1163 | IN EFI_GUID *Protocol,\r | |
1164 | IN VOID *OldInterface,\r | |
1165 | IN VOID *NewInterface\r | |
1166 | );\r | |
1167 | \r | |
1168 | /**\r | |
1169 | Removes a protocol interface from a device handle. It is recommended that\r | |
1170 | UninstallMultipleProtocolInterfaces() be used in place of\r | |
1171 | UninstallProtocolInterface().\r | |
1172 | \r | |
1173 | @param Handle The handle on which the interface was installed.\r | |
1174 | @param Protocol The numeric ID of the interface.\r | |
1175 | @param Interface A pointer to the interface.\r | |
1176 | \r | |
1177 | @retval EFI_SUCCESS The interface was removed.\r | |
1178 | @retval EFI_NOT_FOUND The interface was not found.\r | |
1179 | @retval EFI_ACCESS_DENIED The interface was not removed because the interface\r | |
1180 | is still being used by a driver.\r | |
e0c047a0 | 1181 | @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r |
1182 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r | |
959ccb23 | 1183 | \r |
1184 | **/\r | |
1185 | typedef\r | |
1186 | EFI_STATUS\r | |
8b13229b | 1187 | (EFIAPI *EFI_UNINSTALL_PROTOCOL_INTERFACE)(\r |
959ccb23 | 1188 | IN EFI_HANDLE Handle,\r |
1189 | IN EFI_GUID *Protocol,\r | |
1190 | IN VOID *Interface\r | |
1191 | );\r | |
1192 | \r | |
1193 | /**\r | |
1194 | Removes one or more protocol interfaces into the boot services environment.\r | |
1195 | \r | |
1196 | @param Handle The handle to remove the protocol interfaces from.\r | |
1197 | @param ... A variable argument list containing pairs of protocol GUIDs and\r | |
1198 | protocol interfaces.\r | |
1199 | \r | |
1200 | @retval EFI_SUCCESS All the protocol interfaces were removed.\r | |
1201 | @retval EFI_INVALID_PARAMETER One of the protocol interfaces was not previously installed on Handle.\r | |
1202 | \r | |
1203 | **/\r | |
1204 | typedef\r | |
1205 | EFI_STATUS\r | |
8b13229b | 1206 | (EFIAPI *EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES)(\r |
959ccb23 | 1207 | IN EFI_HANDLE Handle,\r |
1208 | ...\r | |
1209 | );\r | |
1210 | \r | |
1211 | /**\r | |
1212 | Queries a handle to determine if it supports a specified protocol.\r | |
1213 | \r | |
1214 | @param Handle The handle being queried.\r | |
1215 | @param Protocol The published unique identifier of the protocol.\r | |
1216 | @param Interface Supplies the address where a pointer to the corresponding Protocol\r | |
1217 | Interface is returned.\r | |
e0c047a0 | 1218 | \r |
959ccb23 | 1219 | @retval EFI_SUCCESS The interface information for the specified protocol was returned.\r |
1220 | @retval EFI_UNSUPPORTED The device does not support the specified protocol.\r | |
e0c047a0 | 1221 | @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r |
1222 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r | |
1223 | @retval EFI_INVALID_PARAMETER Interface is NULL.\r | |
959ccb23 | 1224 | \r |
1225 | **/\r | |
1226 | typedef\r | |
1227 | EFI_STATUS\r | |
8b13229b | 1228 | (EFIAPI *EFI_HANDLE_PROTOCOL)(\r |
959ccb23 | 1229 | IN EFI_HANDLE Handle,\r |
1230 | IN EFI_GUID *Protocol,\r | |
1231 | OUT VOID **Interface\r | |
1232 | );\r | |
1233 | \r | |
1234 | #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001\r | |
1235 | #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002\r | |
1236 | #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004\r | |
1237 | #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008\r | |
1238 | #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010\r | |
1239 | #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020\r | |
1240 | \r | |
1241 | /**\r | |
1242 | Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the\r | |
1243 | handle, it opens the protocol on behalf of the calling agent.\r | |
1244 | \r | |
1245 | @param Handle The handle for the protocol interface that is being opened.\r | |
1246 | @param Protocol The published unique identifier of the protocol.\r | |
1247 | @param Interface Supplies the address where a pointer to the corresponding Protocol\r | |
1248 | Interface is returned.\r | |
1249 | @param AgentHandle The handle of the agent that is opening the protocol interface\r | |
1250 | specified by Protocol and Interface.\r | |
1251 | @param ControllerHandle If the agent that is opening a protocol is a driver that follows the\r | |
1252 | UEFI Driver Model, then this parameter is the controller handle\r | |
1253 | that requires the protocol interface. If the agent does not follow\r | |
1254 | the UEFI Driver Model, then this parameter is optional and may\r | |
1255 | be NULL.\r | |
1256 | @param Attributes The open mode of the protocol interface specified by Handle\r | |
1257 | and Protocol.\r | |
1258 | \r | |
1259 | @retval EFI_SUCCESS An item was added to the open list for the protocol interface, and the\r | |
1260 | protocol interface was returned in Interface.\r | |
1261 | @retval EFI_UNSUPPORTED Handle does not support Protocol.\r | |
1262 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r | |
1263 | @retval EFI_ACCESS_DENIED Required attributes can't be supported in current environment.\r | |
1264 | @retval EFI_ALREADY_STARTED Item on the open list already has requierd attributes whose agent\r | |
1265 | handle is the same as AgentHandle.\r | |
1266 | \r | |
1267 | **/\r | |
1268 | typedef\r | |
1269 | EFI_STATUS\r | |
8b13229b | 1270 | (EFIAPI *EFI_OPEN_PROTOCOL)(\r |
959ccb23 | 1271 | IN EFI_HANDLE Handle,\r |
1272 | IN EFI_GUID *Protocol,\r | |
e0c047a0 | 1273 | OUT VOID **Interface, OPTIONAL\r |
959ccb23 | 1274 | IN EFI_HANDLE AgentHandle,\r |
e0c047a0 | 1275 | IN EFI_HANDLE ControllerHandle,\r |
959ccb23 | 1276 | IN UINT32 Attributes\r |
1277 | );\r | |
1278 | \r | |
1279 | \r | |
1280 | /**\r | |
1281 | Closes a protocol on a handle that was opened using OpenProtocol().\r | |
1282 | \r | |
1283 | @param Handle The handle for the protocol interface that was previously opened\r | |
1284 | with OpenProtocol(), and is now being closed.\r | |
1285 | @param Protocol The published unique identifier of the protocol.\r | |
959ccb23 | 1286 | @param AgentHandle The handle of the agent that is closing the protocol interface.\r |
1287 | @param ControllerHandle If the agent that opened a protocol is a driver that follows the\r | |
1288 | UEFI Driver Model, then this parameter is the controller handle\r | |
1289 | that required the protocol interface.\r | |
1290 | \r | |
1291 | @retval EFI_SUCCESS The protocol instance was closed.\r | |
e0c047a0 | 1292 | @retval EFI_INVALID_PARAMETER 1) Handle is not a valid EFI_HANDLE.\r |
1293 | 2) AgentHandle is not a valid EFI_HANDLE.\r | |
1294 | 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.\r | |
1295 | 4) Protocol is NULL.\r | |
959ccb23 | 1296 | @retval EFI_NOT_FOUND 1) Handle does not support the protocol specified by Protocol.\r |
1297 | 2) The protocol interface specified by Handle and Protocol is not\r | |
1298 | currently open by AgentHandle and ControllerHandle.\r | |
1299 | \r | |
1300 | **/\r | |
1301 | typedef\r | |
1302 | EFI_STATUS\r | |
8b13229b | 1303 | (EFIAPI *EFI_CLOSE_PROTOCOL)(\r |
959ccb23 | 1304 | IN EFI_HANDLE Handle,\r |
1305 | IN EFI_GUID *Protocol,\r | |
1306 | IN EFI_HANDLE AgentHandle,\r | |
1307 | IN EFI_HANDLE ControllerHandle\r | |
1308 | );\r | |
1309 | \r | |
2a3f6a21 | 1310 | ///\r |
1311 | /// EFI Oprn Protocol Information Entry\r | |
1312 | ///\r | |
959ccb23 | 1313 | typedef struct {\r |
1314 | EFI_HANDLE AgentHandle;\r | |
1315 | EFI_HANDLE ControllerHandle;\r | |
1316 | UINT32 Attributes;\r | |
1317 | UINT32 OpenCount;\r | |
1318 | } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY;\r | |
1319 | \r | |
1320 | /**\r | |
1321 | Retrieves the list of agents that currently have a protocol interface opened.\r | |
1322 | \r | |
1323 | @param Handle The handle for the protocol interface that is being queried.\r | |
1324 | @param Protocol The published unique identifier of the protocol.\r | |
1325 | @param EntryBuffer A pointer to a buffer of open protocol information in the form of\r | |
1326 | EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.\r | |
1327 | @param EntryCount A pointer to the number of entries in EntryBuffer.\r | |
1328 | \r | |
1329 | @retval EFI_SUCCESS The open protocol information was returned in EntryBuffer, and the\r | |
1330 | number of entries was returned EntryCount.\r | |
1331 | @retval EFI_OUT_OF_RESOURCES There are not enough resources available to allocate EntryBuffer.\r | |
1332 | @retval EFI_NOT_FOUND Handle does not support the protocol specified by Protocol.\r | |
1333 | \r | |
1334 | **/\r | |
1335 | typedef\r | |
1336 | EFI_STATUS\r | |
8b13229b | 1337 | (EFIAPI *EFI_OPEN_PROTOCOL_INFORMATION)(\r |
959ccb23 | 1338 | IN EFI_HANDLE Handle,\r |
1339 | IN EFI_GUID *Protocol,\r | |
e0c047a0 | 1340 | OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,\r |
959ccb23 | 1341 | OUT UINTN *EntryCount\r |
1342 | );\r | |
1343 | \r | |
1344 | /**\r | |
1345 | Retrieves the list of protocol interface GUIDs that are installed on a handle in a buffer allocated\r | |
1346 | from pool.\r | |
1347 | \r | |
1348 | @param Handle The handle from which to retrieve the list of protocol interface\r | |
1349 | GUIDs.\r | |
1350 | @param ProtocolBuffer A pointer to the list of protocol interface GUID pointers that are\r | |
1351 | installed on Handle.\r | |
1352 | @param ProtocolBufferCount A pointer to the number of GUID pointers present in\r | |
1353 | ProtocolBuffer.\r | |
1354 | \r | |
1355 | @retval EFI_SUCCESS The list of protocol interface GUIDs installed on Handle was returned in\r | |
1356 | ProtocolBuffer. The number of protocol interface GUIDs was\r | |
1357 | returned in ProtocolBufferCount.\r | |
1358 | @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.\r | |
e0c047a0 | 1359 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r |
1360 | @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.\r | |
1361 | @retval EFI_INVALID_PARAMETER ProtocolBuffer is NULL.\r | |
1362 | @retval EFI_INVALID_PARAMETER ProtocolBufferCount is NULL.\r | |
959ccb23 | 1363 | \r |
1364 | **/\r | |
1365 | typedef\r | |
1366 | EFI_STATUS\r | |
8b13229b | 1367 | (EFIAPI *EFI_PROTOCOLS_PER_HANDLE)(\r |
959ccb23 | 1368 | IN EFI_HANDLE Handle,\r |
1369 | OUT EFI_GUID ***ProtocolBuffer,\r | |
1370 | OUT UINTN *ProtocolBufferCount\r | |
1371 | );\r | |
1372 | \r | |
1373 | /**\r | |
1374 | Creates an event that is to be signaled whenever an interface is installed for a specified protocol.\r | |
1375 | \r | |
1376 | @param Protocol The numeric ID of the protocol for which the event is to be registered.\r | |
1377 | @param Event Event that is to be signaled whenever a protocol interface is registered\r | |
1378 | for Protocol.\r | |
1379 | @param Registration A pointer to a memory location to receive the registration value.\r | |
1380 | \r | |
1381 | @retval EFI_SUCCESS The notification event has been registered.\r | |
1382 | @retval EFI_OUT_OF_RESOURCES Space for the notification event could not be allocated.\r | |
e0c047a0 | 1383 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
1384 | @retval EFI_INVALID_PARAMETER Event is NULL.\r | |
1385 | @retval EFI_INVALID_PARAMETER Registration is NULL.\r | |
959ccb23 | 1386 | \r |
1387 | **/\r | |
1388 | typedef\r | |
1389 | EFI_STATUS\r | |
8b13229b | 1390 | (EFIAPI *EFI_REGISTER_PROTOCOL_NOTIFY)(\r |
959ccb23 | 1391 | IN EFI_GUID *Protocol,\r |
1392 | IN EFI_EVENT Event,\r | |
1393 | OUT VOID **Registration\r | |
1394 | );\r | |
1395 | \r | |
2a3f6a21 | 1396 | ///\r |
1397 | /// Enumeration of EFI Locate Search Types\r | |
1398 | ///\r | |
959ccb23 | 1399 | typedef enum {\r |
2a3f6a21 | 1400 | ///\r |
1401 | /// Retrieve all the handles in the handle database.\r | |
1402 | ///\r | |
959ccb23 | 1403 | AllHandles,\r |
2a3f6a21 | 1404 | ///\r |
1405 | /// Retrieve the next handle fron a RegisterProtocolNotify() event.\r | |
1406 | ///\r | |
959ccb23 | 1407 | ByRegisterNotify,\r |
2a3f6a21 | 1408 | ///\r |
1409 | /// Retrieve the set of handles from the handle database that support a \r | |
1410 | /// specified protocol.\r | |
1411 | ///\r | |
959ccb23 | 1412 | ByProtocol\r |
1413 | } EFI_LOCATE_SEARCH_TYPE;\r | |
1414 | \r | |
1415 | /**\r | |
1416 | Returns an array of handles that support a specified protocol.\r | |
1417 | \r | |
1418 | @param SearchType Specifies which handle(s) are to be returned.\r | |
1419 | @param Protocol Specifies the protocol to search by.\r | |
1420 | @param SearchKey Specifies the search key.\r | |
1421 | @param BufferSize On input, the size in bytes of Buffer. On output, the size in bytes of\r | |
1422 | the array returned in Buffer (if the buffer was large enough) or the\r | |
1423 | size, in bytes, of the buffer needed to obtain the array (if the buffer was\r | |
1424 | not large enough).\r | |
1425 | @param Buffer The buffer in which the array is returned.\r | |
1426 | \r | |
1427 | @retval EFI_SUCCESS The array of handles was returned.\r | |
1428 | @retval EFI_NOT_FOUND No handles match the search.\r | |
1429 | @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.\r | |
e0c047a0 | 1430 | @retval EFI_INVALID_PARAMETER SearchType is not a member of EFI_LOCATE_SEARCH_TYPE.\r |
1431 | @retval EFI_INVALID_PARAMETER SearchType is ByRegisterNotify and SearchKey is NULL.\r | |
1432 | @retval EFI_INVALID_PARAMETER SearchType is ByProtocol and Protocol is NULL.\r | |
1433 | @retval EFI_INVALID_PARAMETER One or more matches are found and BufferSize is NULL.\r | |
1434 | @retval EFI_INVALID_PARAMETER BufferSize is large enough for the result and Buffer is NULL.\r | |
959ccb23 | 1435 | \r |
1436 | **/\r | |
1437 | typedef\r | |
1438 | EFI_STATUS\r | |
8b13229b | 1439 | (EFIAPI *EFI_LOCATE_HANDLE)(\r |
959ccb23 | 1440 | IN EFI_LOCATE_SEARCH_TYPE SearchType,\r |
1441 | IN EFI_GUID *Protocol, OPTIONAL\r | |
1442 | IN VOID *SearchKey, OPTIONAL\r | |
1443 | IN OUT UINTN *BufferSize,\r | |
1444 | OUT EFI_HANDLE *Buffer\r | |
1445 | );\r | |
1446 | \r | |
1447 | /**\r | |
1448 | Locates the handle to a device on the device path that supports the specified protocol.\r | |
1449 | \r | |
1450 | @param Protocol Specifies the protocol to search for.\r | |
1451 | @param DevicePath On input, a pointer to a pointer to the device path. On output, the device\r | |
1452 | path pointer is modified to point to the remaining part of the device\r | |
1453 | path.\r | |
1454 | @param Device A pointer to the returned device handle.\r | |
1455 | \r | |
1456 | @retval EFI_SUCCESS The resulting handle was returned.\r | |
1457 | @retval EFI_NOT_FOUND No handles match the search.\r | |
e0c047a0 | 1458 | @retval EFI_INVALID_PARAMETER Protocol is NULL.\r |
1459 | @retval EFI_INVALID_PARAMETER DevicePath is NULL.\r | |
1460 | @retval EFI_INVALID_PARAMETER A handle matched the search and Device is NULL.\r | |
959ccb23 | 1461 | \r |
1462 | **/\r | |
1463 | typedef\r | |
1464 | EFI_STATUS\r | |
8b13229b | 1465 | (EFIAPI *EFI_LOCATE_DEVICE_PATH)(\r |
959ccb23 | 1466 | IN EFI_GUID *Protocol,\r |
1467 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath,\r | |
1468 | OUT EFI_HANDLE *Device\r | |
1469 | );\r | |
1470 | \r | |
1471 | /**\r | |
1472 | Adds, updates, or removes a configuration table entry from the EFI System Table.\r | |
1473 | \r | |
1474 | @param Guid A pointer to the GUID for the entry to add, update, or remove.\r | |
1475 | @param Table A pointer to the configuration table for the entry to add, update, or\r | |
1476 | remove. May be NULL.\r | |
1477 | \r | |
1478 | @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.\r | |
1479 | @retval EFI_NOT_FOUND An attempt was made to delete a nonexistent entry.\r | |
1480 | @retval EFI_INVALID_PARAMETER Guid is not valid.\r | |
1481 | @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.\r | |
1482 | \r | |
1483 | **/\r | |
1484 | typedef\r | |
1485 | EFI_STATUS\r | |
8b13229b | 1486 | (EFIAPI *EFI_INSTALL_CONFIGURATION_TABLE)(\r |
959ccb23 | 1487 | IN EFI_GUID *Guid,\r |
1488 | IN VOID *Table\r | |
1489 | );\r | |
1490 | \r | |
959ccb23 | 1491 | /**\r |
1492 | Returns an array of handles that support the requested protocol in a buffer allocated from pool.\r | |
1493 | \r | |
1494 | @param SearchType Specifies which handle(s) are to be returned.\r | |
e0c047a0 | 1495 | @param Protocol Provides the protocol to search by.\r |
1496 | This parameter is only valid for a SearchType of ByProtocol.\r | |
959ccb23 | 1497 | @param SearchKey Supplies the search key depending on the SearchType.\r |
1498 | @param NoHandles The number of handles returned in Buffer.\r | |
1499 | @param Buffer A pointer to the buffer to return the requested array of handles that\r | |
1500 | support Protocol.\r | |
1501 | \r | |
1502 | @retval EFI_SUCCESS The array of handles was returned in Buffer, and the number of\r | |
1503 | handles in Buffer was returned in NoHandles.\r | |
1504 | @retval EFI_NOT_FOUND No handles match the search.\r | |
1505 | @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the matching results.\r | |
e0c047a0 | 1506 | @retval EFI_INVALID_PARAMETER NoHandles is NULL.\r |
1507 | @retval EFI_INVALID_PARAMETER Buffer is NULL.\r | |
959ccb23 | 1508 | \r |
1509 | **/\r | |
1510 | typedef\r | |
1511 | EFI_STATUS\r | |
8b13229b | 1512 | (EFIAPI *EFI_LOCATE_HANDLE_BUFFER)(\r |
959ccb23 | 1513 | IN EFI_LOCATE_SEARCH_TYPE SearchType,\r |
1514 | IN EFI_GUID *Protocol, OPTIONAL\r | |
1515 | IN VOID *SearchKey, OPTIONAL\r | |
1516 | IN OUT UINTN *NoHandles,\r | |
1517 | OUT EFI_HANDLE **Buffer\r | |
1518 | );\r | |
1519 | \r | |
1520 | /**\r | |
1521 | Returns the first protocol instance that matches the given protocol.\r | |
1522 | \r | |
1523 | @param Protocol Provides the protocol to search for.\r | |
1524 | @param Registration Optional registration key returned from\r | |
1525 | RegisterProtocolNotify().\r | |
1526 | @param Interface On return, a pointer to the first interface that matches Protocol and\r | |
1527 | Registration.\r | |
1528 | \r | |
1529 | @retval EFI_SUCCESS A protocol instance matching Protocol was found and returned in\r | |
1530 | Interface.\r | |
1531 | @retval EFI_NOT_FOUND No protocol instances were found that match Protocol and\r | |
1532 | Registration.\r | |
1533 | @retval EFI_INVALID_PARAMETER Interface is NULL.\r | |
1534 | \r | |
1535 | **/\r | |
1536 | typedef\r | |
1537 | EFI_STATUS\r | |
8b13229b | 1538 | (EFIAPI *EFI_LOCATE_PROTOCOL)(\r |
959ccb23 | 1539 | IN EFI_GUID *Protocol,\r |
1540 | IN VOID *Registration, OPTIONAL\r | |
1541 | OUT VOID **Interface\r | |
1542 | );\r | |
1543 | \r | |
2a3f6a21 | 1544 | ///\r |
1545 | /// EFI Capsule Block Descriptor\r | |
1546 | ///\r | |
959ccb23 | 1547 | typedef struct {\r |
1bf79370 LG |
1548 | ///\r |
1549 | /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.\r | |
1550 | ///\r | |
2a3f6a21 | 1551 | UINT64 Length;\r |
959ccb23 | 1552 | union {\r |
1bf79370 LG |
1553 | ///\r |
1554 | /// Physical address of the data block. This member of the union is\r | |
1555 | /// used if Length is not equal to zero.\r | |
1556 | ///\r | |
959ccb23 | 1557 | EFI_PHYSICAL_ADDRESS DataBlock;\r |
1bf79370 LG |
1558 | ///\r |
1559 | /// Physical address of another block of\r | |
1560 | /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This\r | |
1561 | /// member of the union is used if Length is equal to zero. If\r | |
1562 | /// ContinuationPointer is zero this entry represents the end of the list.\r | |
1563 | ///\r | |
959ccb23 | 1564 | EFI_PHYSICAL_ADDRESS ContinuationPointer;\r |
1565 | } Union;\r | |
45ad5569 | 1566 | } EFI_CAPSULE_BLOCK_DESCRIPTOR;\r |
959ccb23 | 1567 | \r |
2a3f6a21 | 1568 | ///\r |
1569 | /// EFI Capsule Header\r | |
1570 | ///\r | |
959ccb23 | 1571 | typedef struct {\r |
1bf79370 LG |
1572 | ///\r |
1573 | /// A GUID that defines the contents of a capsule.\r | |
1574 | ///\r | |
959ccb23 | 1575 | EFI_GUID CapsuleGuid;\r |
1bf79370 LG |
1576 | ///\r |
1577 | /// The size of the capsule header. This may be larger than the size of\r | |
1578 | /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply\r | |
1579 | /// extended header entries\r | |
1580 | ///\r | |
959ccb23 | 1581 | UINT32 HeaderSize;\r |
1bf79370 LG |
1582 | ///\r |
1583 | /// Bit-mapped list describing the capsule attributes. The Flag values\r | |
f6d2bcc6 | 1584 | /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values\r |
a0d58c21 | 1585 | /// of 0x10000 - 0xFFFFFFFF are defined by this specification\r |
1bf79370 | 1586 | ///\r |
959ccb23 | 1587 | UINT32 Flags;\r |
1bf79370 LG |
1588 | ///\r |
1589 | /// Size in bytes of the capsule.\r | |
1590 | ///\r | |
959ccb23 | 1591 | UINT32 CapsuleImageSize;\r |
45ad5569 | 1592 | } EFI_CAPSULE_HEADER;\r |
959ccb23 | 1593 | \r |
1bf79370 LG |
1594 | ///\r |
1595 | /// The EFI System Table entry must point to an array of capsules\r | |
1596 | /// that contain the same CapsuleGuid value. The array must be\r | |
1597 | /// prefixed by a UINT32 that represents the size of the array of capsules.\r | |
1598 | ///\r | |
176a6bb3 | 1599 | typedef struct {\r |
1bf79370 LG |
1600 | ///\r |
1601 | /// the size of the array of capsules.\r | |
1602 | ///\r | |
176a6bb3 | 1603 | UINT32 CapsuleArrayNumber;\r |
1bf79370 LG |
1604 | ///\r |
1605 | /// Point to an array of capsules that contain the same CapsuleGuid value.\r | |
1606 | ///\r | |
176a6bb3 LG |
1607 | VOID* CapsulePtr[1];\r |
1608 | } EFI_CAPSULE_TABLE;\r | |
1609 | \r | |
959ccb23 | 1610 | #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000\r |
1611 | #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000\r | |
1612 | \r | |
1613 | /**\r | |
1614 | Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended\r | |
1615 | consumption, the firmware may process the capsule immediately. If the payload should persist\r | |
1616 | across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must\r | |
1617 | be passed into ResetSystem() and will cause the capsule to be processed by the firmware as\r | |
1618 | part of the reset process.\r | |
1619 | \r | |
1620 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r | |
1621 | being passed into update capsule.\r | |
1622 | @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
1623 | CaspuleHeaderArray.\r | |
1624 | @param ScatterGatherList Physical pointer to a set of\r | |
1625 | EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the\r | |
1626 | location in physical memory of a set of capsules.\r | |
1627 | \r | |
1628 | @retval EFI_SUCCESS Valid capsule was passed. If\r | |
1629 | CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the\r | |
1630 | capsule has been successfully processed by the firmware.\r | |
a0d58c21 | 1631 | @retval EFI_INVALID_PARAMETER CapsuleSize or HeaderSize is NULL.\r |
1632 | @retval EFI_INVALID_PARAMETER CapsuleCount is 0.\r | |
959ccb23 | 1633 | @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r |
e0c047a0 | 1634 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.\r |
1635 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.\r | |
959ccb23 | 1636 | \r |
1637 | **/\r | |
1638 | typedef\r | |
1639 | EFI_STATUS\r | |
8b13229b | 1640 | (EFIAPI *EFI_UPDATE_CAPSULE)(\r |
531febc2 | 1641 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
959ccb23 | 1642 | IN UINTN CapsuleCount,\r |
1643 | IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL\r | |
1644 | );\r | |
1645 | \r | |
1646 | /**\r | |
1647 | Returns if the capsule can be supported via UpdateCapsule().\r | |
1648 | \r | |
1649 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r | |
1650 | being passed into update capsule.\r | |
1651 | @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
1652 | CaspuleHeaderArray.\r | |
1653 | @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can\r | |
1654 | support as an argument to UpdateCapsule() via\r | |
1655 | CapsuleHeaderArray and ScatterGatherList.\r | |
1656 | @param ResetType Returns the type of reset required for the capsule update.\r | |
1657 | \r | |
1658 | @retval EFI_SUCCESS Valid answer returned.\r | |
1659 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and\r | |
1660 | MaximumCapsuleSize and ResetType are undefined.\r | |
1661 | @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r | |
e0c047a0 | 1662 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.\r |
959ccb23 | 1663 | \r |
1664 | **/\r | |
1665 | typedef\r | |
1666 | EFI_STATUS\r | |
8b13229b | 1667 | (EFIAPI *EFI_QUERY_CAPSULE_CAPABILITIES)(\r |
531febc2 | 1668 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
959ccb23 | 1669 | IN UINTN CapsuleCount,\r |
1670 | OUT UINT64 *MaximumCapsuleSize,\r | |
1671 | OUT EFI_RESET_TYPE *ResetType\r | |
1672 | );\r | |
1673 | \r | |
1674 | /**\r | |
1675 | Returns information about the EFI variables.\r | |
1676 | \r | |
1677 | @param Attributes Attributes bitmask to specify the type of variables on\r | |
1678 | which to return information.\r | |
1679 | @param MaximumVariableStorageSize On output the maximum size of the storage space\r | |
1680 | available for the EFI variables associated with the\r | |
1681 | attributes specified.\r | |
1682 | @param RemainingVariableStorageSize Returns the remaining size of the storage space\r | |
1683 | available for the EFI variables associated with the\r | |
1684 | attributes specified.\r | |
1685 | @param MaximumVariableSize Returns the maximum size of the individual EFI\r | |
1686 | variables associated with the attributes specified.\r | |
1687 | \r | |
1688 | @retval EFI_SUCCESS Valid answer returned.\r | |
1689 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied\r | |
1690 | @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r | |
1691 | MaximumVariableStorageSize,\r | |
1692 | RemainingVariableStorageSize, MaximumVariableSize\r | |
1693 | are undefined.\r | |
1694 | \r | |
1695 | **/\r | |
1696 | typedef\r | |
1697 | EFI_STATUS\r | |
8b13229b | 1698 | (EFIAPI *EFI_QUERY_VARIABLE_INFO)(\r |
959ccb23 | 1699 | IN UINT32 Attributes,\r |
1700 | OUT UINT64 *MaximumVariableStorageSize,\r | |
1701 | OUT UINT64 *RemainingVariableStorageSize,\r | |
1702 | OUT UINT64 *MaximumVariableSize\r | |
1703 | );\r | |
1704 | \r | |
1705 | \r | |
1706 | //\r | |
1707 | // EFI Runtime Services Table\r | |
1708 | //\r | |
07636730 | 1709 | #define EFI_SYSTEM_TABLE_SIGNATURE SIGNATURE_64 ('I','B','I',' ','S','Y','S','T')\r |
2a3f6a21 | 1710 | #define EFI_SYSTEM_TABLE_REVISION ((2 << 16) | (10))\r |
1711 | #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))\r | |
1712 | #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))\r | |
1713 | #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))\r | |
1714 | #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))\r | |
1715 | \r | |
07636730 | 1716 | #define EFI_RUNTIME_SERVICES_SIGNATURE SIGNATURE_64 ('R','U','N','T','S','E','R','V')\r |
d1f95000 | 1717 | #define EFI_RUNTIME_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION\r |
959ccb23 | 1718 | \r |
e0c047a0 | 1719 | ///\r |
1720 | /// EFI Runtime Services Table\r | |
1721 | ///\r | |
959ccb23 | 1722 | typedef struct {\r |
e0c047a0 | 1723 | ///\r |
1724 | /// The table header for the EFI Runtime Services Table.\r | |
1725 | ///\r | |
c9a0a0fc | 1726 | EFI_TABLE_HEADER Hdr;\r |
00edb218 A |
1727 | \r |
1728 | //\r | |
1729 | // Time Services\r | |
1730 | //\r | |
1731 | EFI_GET_TIME GetTime;\r | |
1732 | EFI_SET_TIME SetTime;\r | |
1733 | EFI_GET_WAKEUP_TIME GetWakeupTime;\r | |
1734 | EFI_SET_WAKEUP_TIME SetWakeupTime;\r | |
1735 | \r | |
1736 | //\r | |
1737 | // Virtual Memory Services\r | |
1738 | //\r | |
1739 | EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap;\r | |
1740 | EFI_CONVERT_POINTER ConvertPointer;\r | |
1741 | \r | |
1742 | //\r | |
1743 | // Variable Services\r | |
1744 | //\r | |
1745 | EFI_GET_VARIABLE GetVariable;\r | |
1746 | EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName;\r | |
1747 | EFI_SET_VARIABLE SetVariable;\r | |
1748 | \r | |
1749 | //\r | |
1750 | // Miscellaneous Services\r | |
1751 | //\r | |
1752 | EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount;\r | |
1753 | EFI_RESET_SYSTEM ResetSystem;\r | |
1754 | \r | |
1755 | //\r | |
1756 | // UEFI 2.0 Capsule Services\r | |
1757 | //\r | |
1758 | EFI_UPDATE_CAPSULE UpdateCapsule;\r | |
1759 | EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities;\r | |
1760 | \r | |
1761 | //\r | |
1762 | // Miscellaneous UEFI 2.0 Service\r | |
1763 | //\r | |
1764 | EFI_QUERY_VARIABLE_INFO QueryVariableInfo;\r | |
959ccb23 | 1765 | } EFI_RUNTIME_SERVICES;\r |
1766 | \r | |
1767 | \r | |
07636730 | 1768 | #define EFI_BOOT_SERVICES_SIGNATURE SIGNATURE_64 ('B','O','O','T','S','E','R','V')\r |
d1f95000 | 1769 | #define EFI_BOOT_SERVICES_REVISION EFI_2_10_SYSTEM_TABLE_REVISION\r |
959ccb23 | 1770 | \r |
e0c047a0 | 1771 | ///\r |
1772 | /// EFI Boot Services Table\r | |
1773 | ///\r | |
959ccb23 | 1774 | typedef struct {\r |
e0c047a0 | 1775 | ///\r |
1776 | /// The table header for the EFI Boot Services Table.\r | |
1777 | ///\r | |
c9a0a0fc | 1778 | EFI_TABLE_HEADER Hdr;\r |
d0c64728 | 1779 | \r |
00edb218 A |
1780 | //\r |
1781 | // Task Priority Services\r | |
1782 | //\r | |
1783 | EFI_RAISE_TPL RaiseTPL;\r | |
1784 | EFI_RESTORE_TPL RestoreTPL;\r | |
1785 | \r | |
1786 | //\r | |
1787 | // Memory Services\r | |
1788 | //\r | |
1789 | EFI_ALLOCATE_PAGES AllocatePages;\r | |
1790 | EFI_FREE_PAGES FreePages;\r | |
1791 | EFI_GET_MEMORY_MAP GetMemoryMap;\r | |
1792 | EFI_ALLOCATE_POOL AllocatePool;\r | |
1793 | EFI_FREE_POOL FreePool;\r | |
1794 | \r | |
1795 | //\r | |
1796 | // Event & Timer Services\r | |
1797 | //\r | |
1798 | EFI_CREATE_EVENT CreateEvent;\r | |
1799 | EFI_SET_TIMER SetTimer;\r | |
1800 | EFI_WAIT_FOR_EVENT WaitForEvent;\r | |
1801 | EFI_SIGNAL_EVENT SignalEvent;\r | |
1802 | EFI_CLOSE_EVENT CloseEvent;\r | |
1803 | EFI_CHECK_EVENT CheckEvent;\r | |
1804 | \r | |
1805 | //\r | |
1806 | // Protocol Handler Services\r | |
1807 | //\r | |
1808 | EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface;\r | |
1809 | EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface;\r | |
1810 | EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface;\r | |
1811 | EFI_HANDLE_PROTOCOL HandleProtocol;\r | |
1812 | VOID *Reserved;\r | |
1813 | EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify;\r | |
1814 | EFI_LOCATE_HANDLE LocateHandle;\r | |
1815 | EFI_LOCATE_DEVICE_PATH LocateDevicePath;\r | |
1816 | EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable;\r | |
1817 | \r | |
1818 | //\r | |
1819 | // Image Services\r | |
1820 | //\r | |
1821 | EFI_IMAGE_LOAD LoadImage;\r | |
1822 | EFI_IMAGE_START StartImage;\r | |
1823 | EFI_EXIT Exit;\r | |
1824 | EFI_IMAGE_UNLOAD UnloadImage;\r | |
1825 | EFI_EXIT_BOOT_SERVICES ExitBootServices;\r | |
1826 | \r | |
1827 | //\r | |
1828 | // Miscellaneous Services\r | |
1829 | //\r | |
1830 | EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount;\r | |
1831 | EFI_STALL Stall;\r | |
1832 | EFI_SET_WATCHDOG_TIMER SetWatchdogTimer;\r | |
1833 | \r | |
1834 | //\r | |
1835 | // DriverSupport Services\r | |
1836 | //\r | |
1837 | EFI_CONNECT_CONTROLLER ConnectController;\r | |
1838 | EFI_DISCONNECT_CONTROLLER DisconnectController;\r | |
1839 | \r | |
1840 | //\r | |
1841 | // Open and Close Protocol Services\r | |
1842 | //\r | |
1843 | EFI_OPEN_PROTOCOL OpenProtocol;\r | |
1844 | EFI_CLOSE_PROTOCOL CloseProtocol;\r | |
1845 | EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation;\r | |
1846 | \r | |
1847 | //\r | |
1848 | // Library Services\r | |
1849 | //\r | |
1850 | EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle;\r | |
1851 | EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer;\r | |
1852 | EFI_LOCATE_PROTOCOL LocateProtocol;\r | |
1853 | EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces;\r | |
1854 | EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces;\r | |
1855 | \r | |
1856 | //\r | |
1857 | // 32-bit CRC Services\r | |
1858 | //\r | |
1859 | EFI_CALCULATE_CRC32 CalculateCrc32;\r | |
1860 | \r | |
1861 | //\r | |
1862 | // Miscellaneous Services\r | |
1863 | //\r | |
1864 | EFI_COPY_MEM CopyMem;\r | |
1865 | EFI_SET_MEM SetMem;\r | |
00edb218 | 1866 | EFI_CREATE_EVENT_EX CreateEventEx;\r |
959ccb23 | 1867 | } EFI_BOOT_SERVICES;\r |
1868 | \r | |
e0c047a0 | 1869 | ///\r |
1870 | /// Contains a set of GUID/pointer pairs comprised of the ConfigurationTable field in the\r | |
1871 | /// EFI System Table.\r | |
1872 | ///\r | |
2a3f6a21 | 1873 | typedef struct {\r |
e0c047a0 | 1874 | ///\r |
1875 | /// The 128-bit GUID value that uniquely identifies the system configuration table.\r | |
1876 | ///\r | |
00edb218 | 1877 | EFI_GUID VendorGuid;\r |
e0c047a0 | 1878 | ///\r |
1879 | /// A pointer to the table associated with VendorGuid.\r | |
1880 | ///\r | |
00edb218 | 1881 | VOID *VendorTable;\r |
959ccb23 | 1882 | } EFI_CONFIGURATION_TABLE;\r |
1883 | \r | |
e0c047a0 | 1884 | ///\r |
1885 | /// EFI System Table\r | |
1886 | ///\r | |
2a3f6a21 | 1887 | typedef struct {\r |
e0c047a0 | 1888 | ///\r |
1889 | /// The table header for the EFI System Table.\r | |
1890 | ///\r | |
c9a0a0fc | 1891 | EFI_TABLE_HEADER Hdr;\r |
e0c047a0 | 1892 | ///\r |
1893 | /// A pointer to a null terminated Unicode string that identifies\r | |
1894 | /// the vendor that produces the system firmware for the platform.\r | |
1895 | ///\r | |
00edb218 | 1896 | CHAR16 *FirmwareVendor;\r |
e0c047a0 | 1897 | ///\r |
1898 | /// A firmware vendor specific value that identifies the revision\r | |
1899 | /// of the system firmware for the platform.\r | |
1900 | ///\r | |
00edb218 | 1901 | UINT32 FirmwareRevision;\r |
e0c047a0 | 1902 | ///\r |
1903 | /// The handle for the active console input device.\r | |
1904 | ///\r | |
00edb218 | 1905 | EFI_HANDLE ConsoleInHandle;\r |
e0c047a0 | 1906 | ///\r |
11ca63ec | 1907 | /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is\r |
e0c047a0 | 1908 | /// associated with ConsoleInHandle.\r |
1909 | ///\r | |
00edb218 | 1910 | EFI_SIMPLE_TEXT_INPUT_PROTOCOL *ConIn;\r |
e0c047a0 | 1911 | ///\r |
1912 | /// The handle for the active console output device.\r | |
1913 | ///\r | |
00edb218 | 1914 | EFI_HANDLE ConsoleOutHandle;\r |
e0c047a0 | 1915 | ///\r |
11ca63ec | 1916 | /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r |
e0c047a0 | 1917 | /// that is associated with ConsoleOutHandle.\r |
1918 | ///\r | |
00edb218 | 1919 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut;\r |
e0c047a0 | 1920 | ///\r |
1921 | /// The handle for the active standard error console device.\r | |
1922 | ///\r | |
00edb218 | 1923 | EFI_HANDLE StandardErrorHandle;\r |
e0c047a0 | 1924 | ///\r |
11ca63ec | 1925 | /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface\r |
e0c047a0 | 1926 | /// that is associated with StandardErrorHandle.\r |
1927 | ///\r | |
00edb218 | 1928 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *StdErr;\r |
e0c047a0 | 1929 | ///\r |
1930 | /// A pointer to the EFI Runtime Services Table.\r | |
1931 | ///\r | |
00edb218 | 1932 | EFI_RUNTIME_SERVICES *RuntimeServices;\r |
e0c047a0 | 1933 | ///\r |
1934 | /// A pointer to the EFI Boot Services Table.\r | |
1935 | ///\r | |
00edb218 | 1936 | EFI_BOOT_SERVICES *BootServices;\r |
e0c047a0 | 1937 | ///\r |
1938 | /// The number of system configuration tables in the buffer ConfigurationTable.\r | |
1939 | ///\r | |
00edb218 | 1940 | UINTN NumberOfTableEntries;\r |
e0c047a0 | 1941 | ///\r |
1942 | /// A pointer to the system configuration tables.\r | |
1943 | /// The number of entries in the table is NumberOfTableEntries.\r | |
1944 | ///\r | |
00edb218 | 1945 | EFI_CONFIGURATION_TABLE *ConfigurationTable;\r |
2a3f6a21 | 1946 | } EFI_SYSTEM_TABLE;\r |
1947 | \r | |
1948 | /**\r | |
1949 | This is the declaration of an EFI image entry point. This entry point is\r | |
1950 | the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r | |
1951 | both device drivers and bus drivers.\r | |
1952 | \r | |
1953 | @param ImageHandle The firmware allocated handle for the UEFI image.\r | |
1954 | @param SystemTable A pointer to the EFI System Table.\r | |
1955 | \r | |
1956 | @retval EFI_SUCCESS The operation completed successfully.\r | |
1957 | @retval Others Some unexpected error happened.\r | |
1958 | **/\r | |
1959 | typedef\r | |
1960 | EFI_STATUS\r | |
1961 | (EFIAPI *EFI_IMAGE_ENTRY_POINT)(\r | |
1962 | IN EFI_HANDLE ImageHandle,\r | |
1963 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1964 | );\r | |
959ccb23 | 1965 | \r |
95cba3ee A |
1966 | //\r |
1967 | // EFI Load Options Attributes\r | |
1968 | //\r | |
1969 | #define LOAD_OPTION_ACTIVE 0x00000001\r | |
1970 | #define LOAD_OPTION_FORCE_RECONNECT 0x00000002\r | |
95cba3ee A |
1971 | #define LOAD_OPTION_HIDDEN 0x00000008\r |
1972 | #define LOAD_OPTION_CATEGORY 0x00001F00\r | |
1973 | \r | |
1974 | #define LOAD_OPTION_CATEGORY_BOOT 0x00000000\r | |
1975 | #define LOAD_OPTION_CATEGORY_APP 0x00000100\r | |
1976 | \r | |
1977 | #define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001\r | |
1978 | #define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002\r | |
1979 | #define EFI_BOOT_OPTION_SUPPORT_COUNT 0x00000300\r | |
1980 | \r | |
2a3f6a21 | 1981 | ///\r |
1982 | /// EFI Boot Key Data\r | |
1983 | ///\r | |
95cba3ee A |
1984 | typedef union {\r |
1985 | struct {\r | |
1bf79370 LG |
1986 | ///\r |
1987 | /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.\r | |
1988 | ///\r | |
95cba3ee | 1989 | UINT32 Revision : 8;\r |
1bf79370 LG |
1990 | ///\r |
1991 | /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).\r | |
1992 | ///\r | |
95cba3ee | 1993 | UINT32 ShiftPressed : 1;\r |
1bf79370 LG |
1994 | ///\r |
1995 | /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).\r | |
1996 | ///\r | |
95cba3ee | 1997 | UINT32 ControlPressed : 1;\r |
1bf79370 LG |
1998 | ///\r |
1999 | /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).\r | |
2000 | ///\r | |
95cba3ee | 2001 | UINT32 AltPressed : 1;\r |
1bf79370 LG |
2002 | ///\r |
2003 | /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).\r | |
2004 | ///\r | |
95cba3ee | 2005 | UINT32 LogoPressed : 1;\r |
1bf79370 LG |
2006 | ///\r |
2007 | /// The Menu key must be pressed (1) or must not be pressed (0).\r | |
2008 | ///\r | |
95cba3ee | 2009 | UINT32 MenuPressed : 1;\r |
1bf79370 LG |
2010 | ///\r |
2011 | /// The SysReq key must be pressed (1) or must not be pressed (0).\r | |
2012 | ///\r | |
298530bc | 2013 | UINT32 SysReqPressed : 1;\r |
95cba3ee | 2014 | UINT32 Reserved : 16;\r |
1bf79370 LG |
2015 | ///\r |
2016 | /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If\r | |
2017 | /// zero, then only the shift state is considered. If more than one, then the boot option will\r | |
2018 | /// only be launched if all of the specified keys are pressed with the same shift state.\r | |
2019 | ///\r | |
95cba3ee | 2020 | UINT32 InputKeyCount : 2;\r |
e0c047a0 | 2021 | } Options;\r |
95cba3ee | 2022 | UINT32 PackedValue;\r |
2a3f6a21 | 2023 | } EFI_BOOT_KEY_DATA;\r |
95cba3ee | 2024 | \r |
2a3f6a21 | 2025 | ///\r |
2026 | /// EFI Key Option\r | |
2027 | ///\r | |
95cba3ee | 2028 | typedef struct {\r |
1bf79370 LG |
2029 | ///\r |
2030 | /// Specifies options about how the key will be processed.\r | |
2031 | ///\r | |
2032 | EFI_BOOT_KEY_DATA KeyData;\r | |
2033 | ///\r | |
2034 | /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to\r | |
2035 | /// which BootOption refers. If the CRC-32s do not match this value, then this key\r | |
2036 | /// option is ignored.\r | |
2037 | ///\r | |
2a3f6a21 | 2038 | UINT32 BootOptionCrc;\r |
1bf79370 LG |
2039 | ///\r |
2040 | /// The Boot#### option which will be invoked if this key is pressed and the boot option\r | |
2041 | /// is active (LOAD_OPTION_ACTIVE is set).\r | |
2042 | ///\r | |
2a3f6a21 | 2043 | UINT16 BootOption;\r |
1bf79370 LG |
2044 | ///\r |
2045 | /// The key codes to compare against those returned by the\r | |
2046 | /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.\r | |
2047 | /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.\r | |
2048 | ///\r | |
2049 | //EFI_INPUT_KEY Keys[];\r | |
95cba3ee A |
2050 | } EFI_KEY_OPTION;\r |
2051 | \r | |
959ccb23 | 2052 | //\r |
2053 | // EFI File location to boot from on removable media devices\r | |
2054 | //\r | |
2055 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32 L"\\EFI\\BOOT\\BOOTIA32.EFI"\r | |
2056 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64 L"\\EFI\\BOOT\\BOOTIA64.EFI"\r | |
2057 | #define EFI_REMOVABLE_MEDIA_FILE_NAME_X64 L"\\EFI\\BOOT\\BOOTX64.EFI"\r | |
959ccb23 | 2058 | \r |
2059 | #if defined (MDE_CPU_IA32)\r | |
2060 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA32\r | |
2061 | #elif defined (MDE_CPU_IPF)\r | |
2062 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_IA64\r | |
2063 | #elif defined (MDE_CPU_X64)\r | |
2064 | #define EFI_REMOVABLE_MEDIA_FILE_NAME EFI_REMOVABLE_MEDIA_FILE_NAME_X64\r | |
2065 | #elif defined (MDE_CPU_EBC)\r | |
959ccb23 | 2066 | #else\r |
2067 | #error Unknown Processor Type\r | |
2068 | #endif\r | |
2069 | \r | |
959ccb23 | 2070 | #include <Uefi/UefiPxe.h>\r |
2071 | #include <Uefi/UefiGpt.h>\r | |
2072 | #include <Uefi/UefiInternalFormRepresentation.h>\r | |
2073 | \r | |
2074 | #endif\r |