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