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