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