]>
Commit | Line | Data |
---|---|---|
fb3df220 | 1 | /** @file\r |
50a64e5b | 2 | Provides library functions for each of the UEFI Runtime Services.\r |
3 | Only available to DXE and UEFI module types.\r | |
fb3df220 | 4 | \r |
9095d37b | 5 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
fb3df220 | 7 | **/\r |
8 | \r | |
9 | #ifndef __UEFI_RUNTIME_LIB__\r | |
10 | #define __UEFI_RUNTIME_LIB__\r | |
11 | \r | |
fb3df220 | 12 | /**\r |
22d9510d | 13 | This function allows the caller to determine if UEFI ExitBootServices() has been called.\r |
fb3df220 | 14 | \r |
22d9510d | 15 | This function returns TRUE after all the EVT_SIGNAL_EXIT_BOOT_SERVICES functions have\r |
16 | executed as a result of the OS calling ExitBootServices(). Prior to this time FALSE\r | |
17 | is returned. This function is used by runtime code to decide it is legal to access\r | |
18 | services that go away after ExitBootServices().\r | |
fb3df220 | 19 | \r |
22d9510d | 20 | @retval TRUE The system has finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.\r |
21 | @retval FALSE The system has not finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.\r | |
fb3df220 | 22 | \r |
23 | **/\r | |
24 | BOOLEAN\r | |
25 | EFIAPI\r | |
26 | EfiAtRuntime (\r | |
3b89de63 | 27 | VOID\r |
fb3df220 | 28 | );\r |
29 | \r | |
30 | /**\r | |
9095d37b | 31 | This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called.\r |
fb3df220 | 32 | \r |
22d9510d | 33 | This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have\r |
34 | executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE\r | |
35 | is returned. This function is used by runtime code to decide it is legal to access services\r | |
36 | that go away after SetVirtualAddressMap().\r | |
37 | \r | |
38 | @retval TRUE The system has finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r | |
39 | @retval FALSE The system has not finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r | |
fb3df220 | 40 | \r |
41 | **/\r | |
42 | BOOLEAN\r | |
43 | EFIAPI\r | |
44 | EfiGoneVirtual (\r | |
3b89de63 | 45 | VOID\r |
fb3df220 | 46 | );\r |
47 | \r | |
48 | /**\r | |
22d9510d | 49 | This service is a wrapper for the UEFI Runtime Service GetTime().\r |
50 | \r | |
51 | The GetTime() function returns a time that was valid sometime during the call to the function.\r | |
52 | While the returned EFI_TIME structure contains TimeZone and Daylight savings time information,\r | |
53 | the actual clock does not maintain these values. The current time zone and daylight saving time\r | |
54 | information returned by GetTime() are the values that were last set via SetTime().\r | |
55 | The GetTime() function should take approximately the same amount of time to read the time each\r | |
56 | time it is called. All reported device capabilities are to be rounded up.\r | |
1a2f870c | 57 | During runtime, if a PC-AT CMOS device is present in the platform, the caller must synchronize\r |
22d9510d | 58 | access to the device before calling GetTime().\r |
fb3df220 | 59 | \r |
60 | @param Time A pointer to storage to receive a snapshot of the current time.\r | |
61 | @param Capabilities An optional pointer to a buffer to receive the real time clock device's\r | |
62 | capabilities.\r | |
3b89de63 | 63 | \r |
22d9510d | 64 | @retval EFI_SUCCESS The operation completed successfully.\r |
65 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
66 | @retval EFI_DEVICE_ERROR The time could not be retrieved due to a hardware error.\r | |
fb3df220 | 67 | \r |
68 | **/\r | |
69 | EFI_STATUS\r | |
70 | EFIAPI\r | |
71 | EfiGetTime (\r | |
72 | OUT EFI_TIME *Time,\r | |
22d9510d | 73 | OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL\r |
fb3df220 | 74 | );\r |
75 | \r | |
76 | /**\r | |
22d9510d | 77 | This service is a wrapper for the UEFI Runtime Service SetTime().\r |
78 | \r | |
79 | The SetTime() function sets the real time clock device to the supplied time, and records the\r | |
80 | current time zone and daylight savings time information. The SetTime() function is not allowed\r | |
81 | to loop based on the current time. For example, if the device does not support a hardware reset\r | |
82 | for the sub-resolution time, the code is not to implement the feature by waiting for the time to\r | |
83 | wrap.\r | |
1a2f870c | 84 | During runtime, if a PC-AT CMOS device is present in the platform, the caller must synchronize\r |
22d9510d | 85 | access to the device before calling SetTime().\r |
86 | \r | |
87 | @param Time A pointer to the current time. Type EFI_TIME is defined in the GetTime()\r | |
88 | function description. Full error checking is performed on the different\r | |
89 | fields of the EFI_TIME structure (refer to the EFI_TIME definition in the\r | |
90 | GetTime() function description for full details), and EFI_INVALID_PARAMETER\r | |
91 | is returned if any field is out of range.\r | |
92 | \r | |
93 | @retval EFI_SUCCESS The operation completed successfully.\r | |
94 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
95 | @retval EFI_DEVICE_ERROR The time could not be set due to a hardware error.\r | |
fb3df220 | 96 | \r |
97 | **/\r | |
98 | EFI_STATUS\r | |
99 | EFIAPI\r | |
100 | EfiSetTime (\r | |
101 | IN EFI_TIME *Time\r | |
102 | );\r | |
103 | \r | |
104 | /**\r | |
cf8ae2f6 | 105 | This service is a wrapper for the UEFI Runtime Service GetWakeupTime().\r |
fb3df220 | 106 | \r |
22d9510d | 107 | The alarm clock time may be rounded from the set alarm clock time to be within the resolution\r |
108 | of the alarm clock device. The resolution of the alarm clock device is defined to be one second.\r | |
109 | During runtime, if a PC-AT CMOS device is present in the platform the caller must synchronize\r | |
110 | access to the device before calling GetWakeupTime().\r | |
3b89de63 | 111 | \r |
22d9510d | 112 | @param Enabled Indicates if the alarm is currently enabled or disabled.\r |
113 | @param Pending Indicates if the alarm signal is pending and requires acknowledgement.\r | |
114 | @param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()\r | |
115 | function description.\r | |
116 | \r | |
af2dc6a7 | 117 | @retval EFI_SUCCESS The alarm settings were returned.\r |
22d9510d | 118 | @retval EFI_INVALID_PARAMETER Enabled is NULL.\r |
119 | @retval EFI_INVALID_PARAMETER Pending is NULL.\r | |
120 | @retval EFI_INVALID_PARAMETER Time is NULL.\r | |
121 | @retval EFI_DEVICE_ERROR The wakeup time could not be retrieved due to a hardware error.\r | |
122 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
fb3df220 | 123 | \r |
124 | **/\r | |
125 | EFI_STATUS\r | |
126 | EFIAPI\r | |
127 | EfiGetWakeupTime (\r | |
128 | OUT BOOLEAN *Enabled,\r | |
129 | OUT BOOLEAN *Pending,\r | |
130 | OUT EFI_TIME *Time\r | |
131 | );\r | |
132 | \r | |
133 | /**\r | |
cf8ae2f6 | 134 | This service is a wrapper for the UEFI Runtime Service SetWakeupTime()\r |
135 | \r | |
136 | Setting a system wakeup alarm causes the system to wake up or power on at the set time.\r | |
137 | When the alarm fires, the alarm signal is latched until it is acknowledged by calling SetWakeupTime()\r | |
138 | to disable the alarm. If the alarm fires before the system is put into a sleeping or off state,\r | |
139 | since the alarm signal is latched the system will immediately wake up. If the alarm fires while\r | |
140 | the system is off and there is insufficient power to power on the system, the system is powered\r | |
141 | on when power is restored.\r | |
fb3df220 | 142 | \r |
22d9510d | 143 | @param Enable Enable or disable the wakeup alarm.\r |
144 | @param Time If Enable is TRUE, the time to set the wakeup alarm for. Type EFI_TIME\r | |
145 | is defined in the GetTime() function description. If Enable is FALSE,\r | |
146 | then this parameter is optional, and may be NULL.\r | |
3b89de63 | 147 | \r |
22d9510d | 148 | @retval EFI_SUCCESS If Enable is TRUE, then the wakeup alarm was enabled.\r |
149 | If Enable is FALSE, then the wakeup alarm was disabled.\r | |
150 | @retval EFI_INVALID_PARAMETER A time field is out of range.\r | |
151 | @retval EFI_DEVICE_ERROR The wakeup time could not be set due to a hardware error.\r | |
152 | @retval EFI_UNSUPPORTED A wakeup timer is not supported on this platform.\r | |
fb3df220 | 153 | \r |
154 | **/\r | |
155 | EFI_STATUS\r | |
156 | EFIAPI\r | |
157 | EfiSetWakeupTime (\r | |
158 | IN BOOLEAN Enable,\r | |
22d9510d | 159 | IN EFI_TIME *Time OPTIONAL\r |
fb3df220 | 160 | );\r |
161 | \r | |
162 | /**\r | |
cf8ae2f6 | 163 | This service is a wrapper for the UEFI Runtime Service GetVariable().\r |
fb3df220 | 164 | \r |
cf8ae2f6 | 165 | Each vendor may create and manage its own variables without the risk of name conflicts by\r |
1a2f870c | 166 | using a unique VendorGuid. When a variable is set, its Attributes are supplied to indicate\r |
cf8ae2f6 | 167 | how the data variable should be stored and maintained by the system. The attributes affect\r |
168 | when the variable may be accessed and volatility of the data. Any attempts to access a variable\r | |
169 | that does not have the attribute set for runtime access will yield the EFI_NOT_FOUND error.\r | |
170 | If the Data buffer is too small to hold the contents of the variable, the error EFI_BUFFER_TOO_SMALL\r | |
171 | is returned and DataSize is set to the required buffer size to obtain the data.\r | |
172 | \r | |
173 | @param VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String\r | |
fb3df220 | 174 | @param VendorGuid Unify identifier for vendor.\r |
3b89de63 | 175 | @param Attributes Point to memory location to return the attributes of variable. If the point\r |
fb3df220 | 176 | is NULL, the parameter would be ignored.\r |
28d3e14f | 177 | @param DataSize As input, point to the maximum size of return Data-Buffer.\r |
fb3df220 | 178 | As output, point to the actual size of the returned Data-Buffer.\r |
179 | @param Data Point to return Data-Buffer.\r | |
3b89de63 | 180 | \r |
22d9510d | 181 | @retval EFI_SUCCESS The function completed successfully.\r |
182 | @retval EFI_NOT_FOUND The variable was not found.\r | |
183 | @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has\r | |
184 | been updated with the size needed to complete the request.\r | |
185 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
186 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
187 | @retval EFI_INVALID_PARAMETER DataSize is NULL.\r | |
188 | @retval EFI_INVALID_PARAMETER The DataSize is not too small and Data is NULL.\r | |
189 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
190 | @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.\r | |
fb3df220 | 191 | **/\r |
192 | EFI_STATUS\r | |
193 | EFIAPI\r | |
194 | EfiGetVariable (\r | |
195 | IN CHAR16 *VariableName,\r | |
196 | IN EFI_GUID *VendorGuid,\r | |
201c7668 | 197 | OUT UINT32 *Attributes OPTIONAL,\r |
fb3df220 | 198 | IN OUT UINTN *DataSize,\r |
199 | OUT VOID *Data\r | |
bf231ea6 | 200 | );\r |
fb3df220 | 201 | \r |
202 | /**\r | |
cf8ae2f6 | 203 | This service is a wrapper for the UEFI Runtime Service GetNextVariableName().\r |
204 | \r | |
205 | GetNextVariableName() is called multiple times to retrieve the VariableName and VendorGuid of\r | |
206 | all variables currently available in the system. On each call to GetNextVariableName() the\r | |
207 | previous results are passed into the interface, and on output the interface returns the next\r | |
208 | variable name data. When the entire variable list has been returned, the error EFI_NOT_FOUND\r | |
209 | is returned.\r | |
fb3df220 | 210 | \r |
28d3e14f | 211 | @param VariableNameSize As input, point to maximum size of variable name.\r |
212 | As output, point to actual size of variable name.\r | |
3b89de63 | 213 | @param VariableName As input, supplies the last VariableName that was returned by\r |
fb3df220 | 214 | GetNextVariableName().\r |
3b89de63 | 215 | As output, returns the name of variable. The name\r |
fb3df220 | 216 | string is Null-Terminated Unicode string.\r |
3b89de63 | 217 | @param VendorGuid As input, supplies the last VendorGuid that was returned by\r |
fb3df220 | 218 | GetNextVriableName().\r |
219 | As output, returns the VendorGuid of the current variable.\r | |
3b89de63 | 220 | \r |
22d9510d | 221 | @retval EFI_SUCCESS The function completed successfully.\r |
222 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
223 | @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r | |
224 | VariableNameSize has been updated with the size needed\r | |
225 | to complete the request.\r | |
226 | @retval EFI_INVALID_PARAMETER VariableNameSize is NULL.\r | |
227 | @retval EFI_INVALID_PARAMETER VariableName is NULL.\r | |
228 | @retval EFI_INVALID_PARAMETER VendorGuid is NULL.\r | |
229 | @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.\r | |
fb3df220 | 230 | \r |
231 | **/\r | |
232 | EFI_STATUS\r | |
233 | EFIAPI\r | |
234 | EfiGetNextVariableName (\r | |
235 | IN OUT UINTN *VariableNameSize,\r | |
236 | IN OUT CHAR16 *VariableName,\r | |
237 | IN OUT EFI_GUID *VendorGuid\r | |
238 | );\r | |
239 | \r | |
240 | /**\r | |
cf8ae2f6 | 241 | This service is a wrapper for the UEFI Runtime Service GetNextVariableName()\r |
242 | \r | |
243 | Variables are stored by the firmware and may maintain their values across power cycles. Each vendor\r | |
244 | may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.\r | |
fb3df220 | 245 | \r |
1a2f870c | 246 | @param VariableName the name of the vendor's variable, as a\r |
fb3df220 | 247 | Null-Terminated Unicode String\r |
248 | @param VendorGuid Unify identifier for vendor.\r | |
3b89de63 | 249 | @param Attributes Point to memory location to return the attributes of variable. If the point\r |
fb3df220 | 250 | is NULL, the parameter would be ignored.\r |
251 | @param DataSize The size in bytes of Data-Buffer.\r | |
252 | @param Data Point to the content of the variable.\r | |
253 | \r | |
22d9510d | 254 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r |
255 | defined by the Attributes.\r | |
256 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the\r | |
257 | DataSize exceeds the maximum allowed.\r | |
258 | @retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.\r | |
259 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
260 | @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r | |
261 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
262 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
263 | @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r | |
264 | set but the AuthInfo does NOT pass the validation check carried\r | |
265 | out by the firmware.\r | |
266 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
fb3df220 | 267 | \r |
268 | **/\r | |
269 | EFI_STATUS\r | |
270 | EFIAPI\r | |
271 | EfiSetVariable (\r | |
272 | IN CHAR16 *VariableName,\r | |
273 | IN EFI_GUID *VendorGuid,\r | |
274 | IN UINT32 Attributes,\r | |
275 | IN UINTN DataSize,\r | |
276 | IN VOID *Data\r | |
277 | );\r | |
278 | \r | |
279 | /**\r | |
cf8ae2f6 | 280 | This service is a wrapper for the UEFI Runtime Service GetNextHighMonotonicCount().\r |
281 | \r | |
cd2ed84a | 282 | The platform's monotonic counter is comprised of two 32-bit quantities: the high 32 bits and\r |
cf8ae2f6 | 283 | the low 32 bits. During boot service time the low 32-bit value is volatile: it is reset to zero\r |
284 | on every system reset and is increased by 1 on every call to GetNextMonotonicCount(). The high\r | |
285 | 32-bit value is nonvolatile and is increased by 1 whenever the system resets or whenever the low\r | |
286 | 32-bit count (returned by GetNextMonoticCount()) overflows.\r | |
fb3df220 | 287 | \r |
288 | @param HighCount Pointer to returned value.\r | |
289 | \r | |
22d9510d | 290 | @retval EFI_SUCCESS The next high monotonic count was returned.\r |
291 | @retval EFI_DEVICE_ERROR The device is not functioning properly.\r | |
292 | @retval EFI_INVALID_PARAMETER HighCount is NULL.\r | |
fb3df220 | 293 | \r |
294 | **/\r | |
295 | EFI_STATUS\r | |
296 | EFIAPI\r | |
297 | EfiGetNextHighMonotonicCount (\r | |
298 | OUT UINT32 *HighCount\r | |
299 | );\r | |
300 | \r | |
301 | /**\r | |
cf8ae2f6 | 302 | This service is a wrapper for the UEFI Runtime Service ResetSystem().\r |
303 | \r | |
304 | The ResetSystem()function resets the entire platform, including all processors and devices,and reboots the system.\r | |
305 | Calling this interface with ResetType of EfiResetCold causes a system-wide reset. This sets all circuitry within\r | |
306 | the system to its initial state. This type of reset is asynchronous to system operation and operates without regard\r | |
307 | to cycle boundaries. EfiResetCold is tantamount to a system power cycle.\r | |
308 | Calling this interface with ResetType of EfiResetWarm causes a system-wide initialization. The processors are set to\r | |
309 | their initial state, and pending cycles are not corrupted. If the system does not support this reset type, then an\r | |
310 | EfiResetCold must be performed.\r | |
311 | Calling this interface with ResetType of EfiResetShutdown causes the system to enter a power state equivalent to the\r | |
312 | ACPI G2/S5 or G3 states. If the system does not support this reset type, then when the system is rebooted, it should\r | |
313 | exhibit the EfiResetCold attributes.\r | |
28d3e14f | 314 | The platform may optionally log the parameters from any non-normal reset that occurs.\r |
cf8ae2f6 | 315 | The ResetSystem() function does not return.\r |
fb3df220 | 316 | \r |
317 | @param ResetType The type of reset to perform.\r | |
cf8ae2f6 | 318 | @param ResetStatus The status code for the reset. If the system reset is part of a normal operation, the status code\r |
319 | would be EFI_SUCCESS. If the system reset is due to some type of failure the most appropriate EFI\r | |
320 | Status code would be used.\r | |
22d9510d | 321 | @param DataSizeThe size, in bytes, of ResetData.\r |
cf8ae2f6 | 322 | @param ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a\r |
323 | Null-terminated Unicode string, optionally followed by additional binary data. The string is a\r | |
324 | description that the caller may use to further indicate the reason for the system reset. ResetData\r | |
325 | is only valid if ResetStatus is something other then EFI_SUCCESS. This pointer must be a physical\r | |
28426918 DB |
326 | address. For a ResetType of EfiResetPlatformSpecific the data buffer also starts with a Null-terminated\r |
327 | string that is followed by an EFI_GUID that describes the specific type of reset to perform.\r | |
fb3df220 | 328 | **/\r |
329 | VOID\r | |
201c7668 | 330 | EFIAPI\r |
fb3df220 | 331 | EfiResetSystem (\r |
332 | IN EFI_RESET_TYPE ResetType,\r | |
333 | IN EFI_STATUS ResetStatus,\r | |
334 | IN UINTN DataSize,\r | |
008dfe31 | 335 | IN VOID *ResetData OPTIONAL\r |
fb3df220 | 336 | );\r |
337 | \r | |
338 | /**\r | |
9095d37b | 339 | This service is a wrapper for the UEFI Runtime Service ConvertPointer().\r |
cf8ae2f6 | 340 | \r |
341 | The ConvertPointer() function is used by an EFI component during the SetVirtualAddressMap() operation.\r | |
342 | ConvertPointer()must be called using physical address pointers during the execution of SetVirtualAddressMap().\r | |
fb3df220 | 343 | \r |
344 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
3b89de63 | 345 | @param Address The pointer to a pointer that is to be fixed to be the\r |
346 | value needed for the new virtual address mapping being\r | |
fb3df220 | 347 | applied.\r |
348 | \r | |
22d9510d | 349 | @retval EFI_SUCCESS The pointer pointed to by Address was modified.\r |
350 | @retval EFI_NOT_FOUND The pointer pointed to by Address was not found to be part of\r | |
351 | the current memory map. This is normally fatal.\r | |
352 | @retval EFI_INVALID_PARAMETER Address is NULL.\r | |
353 | @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDispositio\r | |
fb3df220 | 354 | \r |
355 | **/\r | |
356 | EFI_STATUS\r | |
357 | EFIAPI\r | |
358 | EfiConvertPointer (\r | |
359 | IN UINTN DebugDisposition,\r | |
360 | IN OUT VOID **Address\r | |
361 | );\r | |
362 | \r | |
20742255 | 363 | /**\r |
364 | Determines the new virtual address that is to be used on subsequent memory accesses.\r | |
365 | \r | |
030cd1a2 | 366 | For IA32, x64, and EBC, this service is a wrapper for the UEFI Runtime Service\r |
9095d37b | 367 | ConvertPointer(). See the UEFI Specification for details.\r |
20742255 | 368 | For IPF, this function interprets Address as a pointer to an EFI_PLABEL structure\r |
369 | and both the EntryPoint and GP fields of an EFI_PLABEL are converted from physical\r | |
370 | to virtiual addressing. Since IPF allows the GP to point to an address outside\r | |
371 | a PE/COFF image, the physical to virtual offset for the EntryPoint field is used\r | |
372 | to adjust the GP field. The UEFI Runtime Service ConvertPointer() is used to convert\r | |
373 | EntryPoint and the status code for this conversion is always returned. If the convertion\r | |
374 | of EntryPoint fails, then neither EntryPoint nor GP are modified. See the UEFI\r | |
375 | Specification for details on the UEFI Runtime Service ConvertPointer().\r | |
376 | \r | |
377 | @param DebugDisposition Supplies type information for the pointer being converted.\r | |
378 | @param Address The pointer to a pointer that is to be fixed to be the\r | |
379 | value needed for the new virtual address mapping being\r | |
380 | applied.\r | |
381 | \r | |
22d9510d | 382 | @return EFI_STATUS value from EfiConvertPointer().\r |
20742255 | 383 | \r |
384 | **/\r | |
385 | EFI_STATUS\r | |
386 | EFIAPI\r | |
387 | EfiConvertFunctionPointer (\r | |
388 | IN UINTN DebugDisposition,\r | |
389 | IN OUT VOID **Address\r | |
390 | );\r | |
fb3df220 | 391 | \r |
392 | /**\r | |
cf8ae2f6 | 393 | This service is a wrapper for the UEFI Runtime Service SetVirtualAddressMap().\r |
394 | \r | |
395 | The SetVirtualAddressMap() function is used by the OS loader. The function can only be called\r | |
cd2ed84a | 396 | at runtime, and is called by the owner of the system's memory map. I.e., the component which\r |
cf8ae2f6 | 397 | called ExitBootServices(). All events of type EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE must be signaled\r |
398 | before SetVirtualAddressMap() returns.\r | |
fb3df220 | 399 | \r |
400 | @param MemoryMapSize The size in bytes of VirtualMap.\r | |
401 | @param DescriptorSize The size in bytes of an entry in the VirtualMap.\r | |
402 | @param DescriptorVersion The version of the structure entries in VirtualMap.\r | |
403 | @param VirtualMap An array of memory descriptors which contain new virtual\r | |
404 | address mapping information for all runtime ranges. Type\r | |
405 | EFI_MEMORY_DESCRIPTOR is defined in the\r | |
406 | GetMemoryMap() function description.\r | |
407 | \r | |
408 | @retval EFI_SUCCESS The virtual address map has been applied.\r | |
409 | @retval EFI_UNSUPPORTED EFI firmware is not at runtime, or the EFI firmware is already in\r | |
410 | virtual address mapped mode.\r | |
411 | @retval EFI_INVALID_PARAMETER DescriptorSize or DescriptorVersion is\r | |
412 | invalid.\r | |
413 | @retval EFI_NO_MAPPING A virtual address was not supplied for a range in the memory\r | |
414 | map that requires a mapping.\r | |
415 | @retval EFI_NOT_FOUND A virtual address was supplied for an address that is not found\r | |
416 | in the memory map.\r | |
417 | **/\r | |
418 | EFI_STATUS\r | |
419 | EFIAPI\r | |
420 | EfiSetVirtualAddressMap (\r | |
421 | IN UINTN MemoryMapSize,\r | |
422 | IN UINTN DescriptorSize,\r | |
423 | IN UINT32 DescriptorVersion,\r | |
424 | IN CONST EFI_MEMORY_DESCRIPTOR *VirtualMap\r | |
425 | );\r | |
426 | \r | |
427 | \r | |
428 | /**\r | |
bf231ea6 | 429 | Convert the standard Lib double linked list to a virtual mapping.\r |
fb3df220 | 430 | \r |
22d9510d | 431 | This service uses EfiConvertPointer() to walk a double linked list and convert all the link\r |
432 | pointers to their virtual mappings. This function is only guaranteed to work during the\r | |
433 | EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event and calling it at other times has undefined results.\r | |
434 | \r | |
fb3df220 | 435 | @param DebugDisposition Supplies type information for the pointer being converted.\r |
436 | @param ListHead Head of linked list to convert.\r | |
437 | \r | |
af2dc6a7 | 438 | @retval EFI_SUCCESS Successfully executed the function.\r |
1a2f870c | 439 | @retval !EFI_SUCCESS Failed to execute the function.\r |
fb3df220 | 440 | \r |
441 | **/\r | |
442 | EFI_STATUS\r | |
443 | EFIAPI\r | |
444 | EfiConvertList (\r | |
445 | IN UINTN DebugDisposition,\r | |
446 | IN OUT LIST_ENTRY *ListHead\r | |
447 | );\r | |
448 | \r | |
449 | /**\r | |
cf8ae2f6 | 450 | This service is a wrapper for the UEFI Runtime Service UpdateCapsule().\r |
451 | \r | |
452 | Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended\r | |
453 | consumption, the firmware may process the capsule immediately. If the payload should persist across a\r | |
454 | system reset, the reset value returned from EFI_QueryCapsuleCapabilities must be passed into ResetSystem()\r | |
455 | and will cause the capsule to be processed by the firmware as part of the reset process.\r | |
3b89de63 | 456 | \r |
fb3df220 | 457 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r |
458 | being passed into update capsule. Each capsules is assumed to\r | |
459 | stored in contiguous virtual memory. The capsules in the\r | |
460 | CapsuleHeaderArray must be the same capsules as the\r | |
461 | ScatterGatherList. The CapsuleHeaderArray must\r | |
462 | have the capsules in the same order as the ScatterGatherList.\r | |
463 | @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
464 | CaspuleHeaderArray.\r | |
465 | @param ScatterGatherList Physical pointer to a set of\r | |
466 | EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the\r | |
467 | location in physical memory of a set of capsules. See Related\r | |
468 | Definitions for an explanation of how more than one capsule is\r | |
469 | passed via this interface. The capsules in the\r | |
470 | ScatterGatherList must be in the same order as the\r | |
471 | CapsuleHeaderArray. This parameter is only referenced if\r | |
472 | the capsules are defined to persist across system reset.\r | |
473 | \r | |
af2dc6a7 | 474 | @retval EFI_SUCCESS A valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,\r |
22d9510d | 475 | the capsule has been successfully processed by the firmware.\r |
eaa8a234 | 476 | @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were\r |
477 | set in the capsule header.\r | |
22d9510d | 478 | @retval EFI_INVALID_PARAMETER CapsuleCount is 0\r |
fb3df220 | 479 | @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r |
22d9510d | 480 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform.\r |
481 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the capsule.\r | |
fb3df220 | 482 | \r |
483 | **/\r | |
484 | EFI_STATUS\r | |
485 | EFIAPI\r | |
486 | EfiUpdateCapsule (\r | |
3b89de63 | 487 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
fb3df220 | 488 | IN UINTN CapsuleCount,\r |
d27e363b | 489 | IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL\r |
fb3df220 | 490 | );\r |
491 | \r | |
492 | \r | |
493 | /**\r | |
cf8ae2f6 | 494 | This service is a wrapper for the UEFI Runtime Service QueryCapsuleCapabilities().\r |
495 | \r | |
fb3df220 | 496 | The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or\r |
497 | capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and\r | |
498 | size of the entire capsule is checked.\r | |
499 | If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be\r | |
500 | constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof\r | |
501 | (EFI_CAPSULE_HEADER). To determine reset requirements,\r | |
502 | CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the\r | |
503 | EFI_CAPSULE_HEADER.\r | |
504 | The firmware must support any capsule that has the\r | |
505 | CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The\r | |
506 | firmware sets the policy for what capsules are supported that do not have the\r | |
507 | CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.\r | |
3b89de63 | 508 | \r |
fb3df220 | 509 | @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r |
510 | being passed into update capsule. The capsules are assumed to\r | |
511 | stored in contiguous virtual memory.\r | |
512 | @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r | |
513 | CaspuleHeaderArray.\r | |
42eedea9 | 514 | @param MaximumCapsuleSize On output the maximum size that UpdateCapsule() can\r |
fb3df220 | 515 | support as an argument to UpdateCapsule() via\r |
516 | CapsuleHeaderArray and ScatterGatherList.\r | |
517 | Undefined on input.\r | |
518 | @param ResetType Returns the type of reset required for the capsule update.\r | |
519 | \r | |
af2dc6a7 | 520 | @retval EFI_SUCCESS A valid answer was returned.\r |
fb3df220 | 521 | @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r |
522 | @retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and\r | |
523 | MaximumCapsuleSize and ResetType are undefined.\r | |
22d9510d | 524 | @retval EFI_OUT_OF_RESOURCES There were insufficient resources to process the query request.\r |
fb3df220 | 525 | \r |
526 | **/\r | |
527 | EFI_STATUS\r | |
528 | EFIAPI\r | |
529 | EfiQueryCapsuleCapabilities (\r | |
3b89de63 | 530 | IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r |
531 | IN UINTN CapsuleCount,\r | |
fb3df220 | 532 | OUT UINT64 *MaximumCapsuleSize,\r |
533 | OUT EFI_RESET_TYPE *ResetType\r | |
534 | );\r | |
535 | \r | |
536 | \r | |
537 | /**\r | |
cf8ae2f6 | 538 | This service is a wrapper for the UEFI Runtime Service QueryVariableInfo().\r |
22d9510d | 539 | \r |
fb3df220 | 540 | The QueryVariableInfo() function allows a caller to obtain the information about the\r |
541 | maximum size of the storage space available for the EFI variables, the remaining size of the storage\r | |
542 | space available for the EFI variables and the maximum size of each individual EFI variable,\r | |
543 | associated with the attributes specified.\r | |
544 | The returned MaximumVariableStorageSize, RemainingVariableStorageSize,\r | |
545 | MaximumVariableSize information may change immediately after the call based on other\r | |
546 | runtime activities including asynchronous error events. Also, these values associated with different\r | |
547 | attributes are not additive in nature.\r | |
3b89de63 | 548 | \r |
fb3df220 | 549 | @param Attributes Attributes bitmask to specify the type of variables on\r |
550 | which to return information. Refer to the\r | |
551 | GetVariable() function description.\r | |
3b89de63 | 552 | @param MaximumVariableStorageSize\r |
fb3df220 | 553 | On output the maximum size of the storage space\r |
554 | available for the EFI variables associated with the\r | |
555 | attributes specified.\r | |
3b89de63 | 556 | @param RemainingVariableStorageSize\r |
fb3df220 | 557 | Returns the remaining size of the storage space\r |
558 | available for the EFI variables associated with the\r | |
af2dc6a7 | 559 | attributes specified.\r |
fb3df220 | 560 | @param MaximumVariableSize Returns the maximum size of the individual EFI\r |
561 | variables associated with the attributes specified.\r | |
562 | \r | |
af2dc6a7 | 563 | @retval EFI_SUCCESS A valid answer was returned.\r |
fb3df220 | 564 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.\r |
565 | @retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r | |
566 | MaximumVariableStorageSize,\r | |
567 | RemainingVariableStorageSize, MaximumVariableSize\r | |
568 | are undefined.\r | |
cf8ae2f6 | 569 | \r |
fb3df220 | 570 | **/\r |
571 | EFI_STATUS\r | |
572 | EFIAPI\r | |
573 | EfiQueryVariableInfo (\r | |
42eedea9 | 574 | IN UINT32 Attributes,\r |
fb3df220 | 575 | OUT UINT64 *MaximumVariableStorageSize,\r |
576 | OUT UINT64 *RemainingVariableStorageSize,\r | |
577 | OUT UINT64 *MaximumVariableSize\r | |
578 | );\r | |
579 | \r | |
580 | #endif\r | |
581 | \r |