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