projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 504214c4 | 1 | /** @file\r |
| 8d3a5c82 | 2 | \r |
| 504214c4 LG |
3 | Emulation Variable services operate on the runtime volatile memory.\r |
| 4 | The nonvolatile variable space doesn't exist.\r | |
| 5 | \r | |
| 6 | Copyright (c) 2006 - 2008, Intel Corporation\r | |
| 8d3a5c82 | 7 | All rights reserved. This program and the accompanying materials\r |
| 8 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 9 | which accompanies this distribution. The full text of the license may be found at\r | |
| 10 | http://opensource.org/licenses/bsd-license.php\r | |
| 11 | \r | |
| 12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 14 | \r | |
| 504214c4 | 15 | **/\r |
| 8d3a5c82 | 16 | \r |
| 17 | #include "Variable.h"\r | |
| 18 | \r | |
| 1794e506 | 19 | ///\r |
| 20 | /// Don't use module globals after the SetVirtualAddress map is signaled\r | |
| 21 | ///\r | |
| 8d3a5c82 | 22 | ESAL_VARIABLE_GLOBAL *mVariableModuleGlobal;\r |
| 23 | \r | |
| e4ddc008 | 24 | VARIABLE_INFO_ENTRY *gVariableInfo = NULL;\r |
| 1794e506 | 25 | \r |
| 72399dae | 26 | ///\r |
| 27 | /// The size of a 3 character ISO639 language code.\r | |
| 28 | ///\r | |
| 29 | #define ISO_639_2_ENTRY_SIZE 3\r | |
| 30 | \r | |
| 31 | /**\r | |
| 32 | Update the variable region with Variable information. These are the same \r | |
| 33 | arguments as the EFI Variable services.\r | |
| 34 | \r | |
| 35 | @param[in] VariableName Name of variable\r | |
| 36 | \r | |
| 37 | @param[in] VendorGuid Guid of variable\r | |
| 38 | \r | |
| 39 | @param[in] Data Variable data\r | |
| 40 | \r | |
| 41 | @param[in] DataSize Size of data. 0 means delete\r | |
| 42 | \r | |
| 43 | @param[in] Attributes Attribues of the variable\r | |
| 44 | \r | |
| 45 | @param[in] Variable The variable information which is used to keep track of variable usage.\r | |
| 46 | \r | |
| 47 | @retval EFI_SUCCESS The update operation is success.\r | |
| 48 | \r | |
| 49 | @retval EFI_OUT_OF_RESOURCES Variable region is full, can not write other data into this region.\r | |
| 50 | \r | |
| 51 | **/\r | |
| 52 | EFI_STATUS\r | |
| 53 | EFIAPI\r | |
| 54 | UpdateVariable (\r | |
| 55 | IN CHAR16 *VariableName,\r | |
| 56 | IN EFI_GUID *VendorGuid,\r | |
| 57 | IN VOID *Data,\r | |
| 58 | IN UINTN DataSize,\r | |
| 59 | IN UINT32 Attributes OPTIONAL,\r | |
| 60 | IN VARIABLE_POINTER_TRACK *Variable\r | |
| 61 | );\r | |
| 62 | \r | |
| 63 | /**\r | |
| 64 | Finds variable in storage blocks of volatile and non-volatile storage areas.\r | |
| 65 | \r | |
| 66 | This code finds variable in storage blocks of volatile and non-volatile storage areas.\r | |
| 67 | If VariableName is an empty string, then we just return the first\r | |
| 68 | qualified variable without comparing VariableName and VendorGuid.\r | |
| 69 | Otherwise, VariableName and VendorGuid are compared.\r | |
| 70 | \r | |
| 71 | @param VariableName Name of the variable to be found.\r | |
| 72 | @param VendorGuid Vendor GUID to be found.\r | |
| 73 | @param PtrTrack VARIABLE_POINTER_TRACK structure for output,\r | |
| 74 | including the range searched and the target position.\r | |
| 75 | @param Global Pointer to VARIABLE_GLOBAL structure, including\r | |
| 76 | base of volatile variable storage area, base of\r | |
| 77 | NV variable storage area, and a lock.\r | |
| 78 | \r | |
| 79 | @retval EFI_INVALID_PARAMETER If VariableName is not an empty string, while\r | |
| 80 | VendorGuid is NULL.\r | |
| 81 | @retval EFI_SUCCESS Variable successfully found.\r | |
| 82 | @retval EFI_NOT_FOUND Variable not found.\r | |
| 83 | \r | |
| 84 | **/\r | |
| 85 | EFI_STATUS\r | |
| 86 | FindVariable (\r | |
| 87 | IN CHAR16 *VariableName,\r | |
| 88 | IN EFI_GUID *VendorGuid,\r | |
| 89 | OUT VARIABLE_POINTER_TRACK *PtrTrack,\r | |
| 90 | IN VARIABLE_GLOBAL *Global\r | |
| 91 | );\r | |
| 92 | \r | |
| 1794e506 | 93 | /**\r |
| 94 | Acquires lock only at boot time. Simply returns at runtime.\r | |
| 95 | \r | |
| 96 | This is a temperary function which will be removed when\r | |
| 97 | EfiAcquireLock() in UefiLib can handle the call in UEFI\r | |
| 98 | Runtimer driver in RT phase.\r | |
| 99 | It calls EfiAcquireLock() at boot time, and simply returns\r | |
| 100 | at runtime\r | |
| 101 | \r | |
| 102 | @param Lock A pointer to the lock to acquire\r | |
| 103 | \r | |
| 104 | **/\r | |
| 8d3a5c82 | 105 | VOID\r |
| 106 | AcquireLockOnlyAtBootTime (\r | |
| 107 | IN EFI_LOCK *Lock\r | |
| 108 | )\r | |
| 109 | {\r | |
| 110 | if (!EfiAtRuntime ()) {\r | |
| 111 | EfiAcquireLock (Lock);\r | |
| 112 | }\r | |
| 113 | }\r | |
| 114 | \r | |
| 1794e506 | 115 | /**\r |
| 116 | Releases lock only at boot time. Simply returns at runtime.\r | |
| 117 | \r | |
| 118 | This is a temperary function which will be removed when\r | |
| 119 | EfiReleaseLock() in UefiLib can handle the call in UEFI\r | |
| 120 | Runtimer driver in RT phase.\r | |
| 121 | It calls EfiReleaseLock() at boot time, and simply returns\r | |
| 122 | at runtime\r | |
| 123 | \r | |
| 124 | @param Lock A pointer to the lock to release\r | |
| 125 | \r | |
| 126 | **/\r | |
| 8d3a5c82 | 127 | VOID\r |
| 128 | ReleaseLockOnlyAtBootTime (\r | |
| 129 | IN EFI_LOCK *Lock\r | |
| 130 | )\r | |
| 131 | {\r | |
| 132 | if (!EfiAtRuntime ()) {\r | |
| 133 | EfiReleaseLock (Lock);\r | |
| 134 | }\r | |
| 135 | }\r | |
| 136 | \r | |
| 1794e506 | 137 | /**\r |
| 138 | Gets pointer to the variable data.\r | |
| 8d3a5c82 | 139 | \r |
| 1794e506 | 140 | This function gets the pointer to the variable data according\r |
| 141 | to the input pointer to the variable header.\r | |
| 8d3a5c82 | 142 | \r |
| 1794e506 | 143 | @param Variable Pointer to the variable header.\r |
| 8d3a5c82 | 144 | \r |
| 1794e506 | 145 | @return Pointer to variable data\r |
| 8d3a5c82 | 146 | \r |
| 1794e506 | 147 | **/\r |
| 148 | UINT8 *\r | |
| 149 | GetVariableDataPtr (\r | |
| 150 | IN VARIABLE_HEADER *Variable\r | |
| 151 | )\r | |
| 8d3a5c82 | 152 | {\r |
| 153 | if (Variable->StartId != VARIABLE_DATA) {\r | |
| 154 | return NULL;\r | |
| 155 | }\r | |
| 156 | //\r | |
| 157 | // Be careful about pad size for alignment\r | |
| 158 | //\r | |
| 159 | return (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (Variable) + Variable->NameSize + GET_PAD_SIZE (Variable->NameSize));\r | |
| 160 | }\r | |
| 161 | \r | |
| 1794e506 | 162 | /**\r |
| 163 | Gets pointer to header of the next variable.\r | |
| 8d3a5c82 | 164 | \r |
| 1794e506 | 165 | This function gets the pointer to the next variable header according\r |
| 166 | to the input point to the variable header.\r | |
| 8d3a5c82 | 167 | \r |
| 1794e506 | 168 | @param Variable Pointer to header of the next variable\r |
| 8d3a5c82 | 169 | \r |
| 1794e506 | 170 | @return Pointer to next variable header.\r |
| 8d3a5c82 | 171 | \r |
| 1794e506 | 172 | **/\r |
| 173 | VARIABLE_HEADER *\r | |
| 174 | GetNextVariablePtr (\r | |
| 175 | IN VARIABLE_HEADER *Variable\r | |
| 176 | )\r | |
| 8d3a5c82 | 177 | {\r |
| 178 | VARIABLE_HEADER *VarHeader;\r | |
| 179 | \r | |
| 180 | if (Variable->StartId != VARIABLE_DATA) {\r | |
| 181 | return NULL;\r | |
| 182 | }\r | |
| 183 | //\r | |
| 184 | // Be careful about pad size for alignment\r | |
| 185 | //\r | |
| 186 | VarHeader = (VARIABLE_HEADER *) (GetVariableDataPtr (Variable) + Variable->DataSize + GET_PAD_SIZE (Variable->DataSize));\r | |
| 187 | \r | |
| 72399dae | 188 | if (VarHeader->StartId != VARIABLE_DATA) {\r |
| 8d3a5c82 | 189 | return NULL;\r |
| 190 | }\r | |
| 191 | \r | |
| 192 | return VarHeader;\r | |
| 193 | }\r | |
| 194 | \r | |
| 1794e506 | 195 | /**\r |
| 196 | Gets pointer to the end of the variable storage area.\r | |
| 8d3a5c82 | 197 | \r |
| 1794e506 | 198 | This function gets pointer to the end of the variable storage\r |
| 199 | area, according to the input variable store header.\r | |
| 8d3a5c82 | 200 | \r |
| 1794e506 | 201 | @param VolHeader Pointer to the variale store header\r |
| 8d3a5c82 | 202 | \r |
| 1794e506 | 203 | @return Pointer to the end of the variable storage area.\r |
| 8d3a5c82 | 204 | \r |
| 1794e506 | 205 | **/\r |
| 206 | VARIABLE_HEADER *\r | |
| 207 | GetEndPointer (\r | |
| 208 | IN VARIABLE_STORE_HEADER *VolHeader\r | |
| 209 | )\r | |
| 8d3a5c82 | 210 | {\r |
| 211 | //\r | |
| 212 | // The end of variable store\r | |
| 213 | //\r | |
| 214 | return (VARIABLE_HEADER *) ((UINTN) VolHeader + VolHeader->Size);\r | |
| 215 | }\r | |
| 216 | \r | |
| e4ddc008 | 217 | /**\r |
| 218 | Routine used to track statistical information about variable usage. \r | |
| 219 | The data is stored in the EFI system table so it can be accessed later.\r | |
| 220 | VariableInfo.efi can dump out the table. Only Boot Services variable \r | |
| 221 | accesses are tracked by this code. The PcdVariableCollectStatistics\r | |
| 222 | build flag controls if this feature is enabled. \r | |
| 223 | \r | |
| 224 | A read that hits in the cache will have Read and Cache true for \r | |
| 225 | the transaction. Data is allocated by this routine, but never\r | |
| 226 | freed.\r | |
| 227 | \r | |
| 228 | @param[in] VariableName Name of the Variable to track\r | |
| 229 | @param[in] VendorGuid Guid of the Variable to track\r | |
| 230 | @param[in] Volatile TRUE if volatile FALSE if non-volatile\r | |
| 231 | @param[in] Read TRUE if GetVariable() was called\r | |
| 232 | @param[in] Write TRUE if SetVariable() was called\r | |
| 233 | @param[in] Delete TRUE if deleted via SetVariable()\r | |
| 234 | @param[in] Cache TRUE for a cache hit.\r | |
| 235 | \r | |
| 236 | **/\r | |
| 237 | VOID\r | |
| 238 | UpdateVariableInfo (\r | |
| 239 | IN CHAR16 *VariableName,\r | |
| 240 | IN EFI_GUID *VendorGuid,\r | |
| 241 | IN BOOLEAN Volatile,\r | |
| 242 | IN BOOLEAN Read,\r | |
| 243 | IN BOOLEAN Write,\r | |
| 244 | IN BOOLEAN Delete,\r | |
| 245 | IN BOOLEAN Cache\r | |
| 246 | )\r | |
| 247 | {\r | |
| 248 | VARIABLE_INFO_ENTRY *Entry;\r | |
| 249 | \r | |
| 250 | if (FeaturePcdGet (PcdVariableCollectStatistics)) {\r | |
| 251 | \r | |
| 252 | if (EfiAtRuntime ()) {\r | |
| 253 | // Don't collect statistics at runtime\r | |
| 254 | return;\r | |
| 255 | }\r | |
| 256 | \r | |
| 257 | if (gVariableInfo == NULL) {\r | |
| 258 | //\r | |
| 259 | // on the first call allocate a entry and place a pointer to it in\r | |
| 260 | // the EFI System Table\r | |
| 261 | //\r | |
| 262 | gVariableInfo = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r | |
| 263 | ASSERT (gVariableInfo != NULL);\r | |
| 264 | \r | |
| 265 | CopyGuid (&gVariableInfo->VendorGuid, VendorGuid);\r | |
| 266 | gVariableInfo->Name = AllocatePool (StrLen (VariableName));\r | |
| 267 | ASSERT (gVariableInfo->Name != NULL);\r | |
| 268 | StrCpy (gVariableInfo->Name, VariableName);\r | |
| 269 | gVariableInfo->Volatile = Volatile;\r | |
| 270 | \r | |
| 271 | gBS->InstallConfigurationTable (&gEfiVariableGuid, gVariableInfo);\r | |
| 272 | }\r | |
| 273 | \r | |
| 274 | \r | |
| 275 | for (Entry = gVariableInfo; Entry != NULL; Entry = Entry->Next) {\r | |
| 276 | if (CompareGuid (VendorGuid, &Entry->VendorGuid)) {\r | |
| 277 | if (StrCmp (VariableName, Entry->Name) == 0) {\r | |
| 278 | if (Read) {\r | |
| 279 | Entry->ReadCount++;\r | |
| 280 | }\r | |
| 281 | if (Write) {\r | |
| 282 | Entry->WriteCount++;\r | |
| 283 | }\r | |
| 284 | if (Delete) {\r | |
| 285 | Entry->DeleteCount++;\r | |
| 286 | }\r | |
| 287 | if (Cache) {\r | |
| 288 | Entry->CacheCount++;\r | |
| 289 | }\r | |
| 290 | \r | |
| 291 | return;\r | |
| 292 | }\r | |
| 293 | }\r | |
| 294 | \r | |
| 295 | if (Entry->Next == NULL) {\r | |
| 296 | //\r | |
| 297 | // If the entry is not in the table add it.\r | |
| 298 | // Next iteration of the loop will fill in the data\r | |
| 299 | //\r | |
| 300 | Entry->Next = AllocateZeroPool (sizeof (VARIABLE_INFO_ENTRY));\r | |
| 301 | ASSERT (Entry->Next != NULL);\r | |
| 302 | \r | |
| 303 | CopyGuid (&Entry->Next->VendorGuid, VendorGuid);\r | |
| 304 | Entry->Next->Name = AllocatePool (StrLen (VariableName));\r | |
| 305 | ASSERT (Entry->Next->Name != NULL);\r | |
| 306 | StrCpy (Entry->Next->Name, VariableName);\r | |
| 307 | Entry->Next->Volatile = Volatile;\r | |
| 308 | }\r | |
| 309 | \r | |
| 310 | }\r | |
| 311 | }\r | |
| 312 | }\r | |
| 313 | \r | |
| 72399dae | 314 | /**\r |
| 315 | Get index from supported language codes according to language string.\r | |
| 316 | \r | |
| 317 | This code is used to get corresponding index in supported language codes. It can handle\r | |
| 318 | RFC3066 and ISO639 language tags.\r | |
| 319 | In ISO639 language tags, take 3-characters as a delimitation to find matched string and calculate the index.\r | |
| 320 | In RFC3066 language tags, take semicolon as a delimitation to find matched string and calculate the index.\r | |
| 321 | \r | |
| 322 | For example:\r | |
| 323 | SupportedLang = "engfraengfra"\r | |
| 324 | Lang = "eng"\r | |
| 325 | Iso639Language = TRUE\r | |
| 326 | The return value is "0".\r | |
| 327 | Another example:\r | |
| 328 | SupportedLang = "en;fr;en-US;fr-FR"\r | |
| 329 | Lang = "fr-FR"\r | |
| 330 | Iso639Language = FALSE\r | |
| 331 | The return value is "3".\r | |
| 332 | \r | |
| 333 | @param SupportedLang Platform supported language codes.\r | |
| 334 | @param Lang Configured language.\r | |
| 335 | @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC3066.\r | |
| 336 | \r | |
| 337 | @retval the index of language in the language codes.\r | |
| 338 | \r | |
| 339 | **/\r | |
| 340 | UINTN\r | |
| 341 | EFIAPI\r | |
| 342 | GetIndexFromSupportedLangCodes(\r | |
| 343 | IN CHAR8 *SupportedLang,\r | |
| 344 | IN CHAR8 *Lang,\r | |
| 345 | IN BOOLEAN Iso639Language\r | |
| 346 | ) \r | |
| 347 | {\r | |
| 348 | UINTN Index;\r | |
| 349 | UINT32 CompareLength;\r | |
| 350 | CHAR8 *Supported;\r | |
| 351 | \r | |
| 352 | Index = 0;\r | |
| 353 | Supported = SupportedLang;\r | |
| 354 | if (Iso639Language) {\r | |
| 355 | CompareLength = 3;\r | |
| 356 | for (Index = 0; Index < AsciiStrLen (SupportedLang); Index += CompareLength) {\r | |
| 357 | if (AsciiStrnCmp (Lang, SupportedLang + Index, CompareLength) == 0) {\r | |
| 358 | //\r | |
| 359 | // Successfully find the index of Lang string in SupportedLang string.\r | |
| 360 | //\r | |
| 361 | Index = Index / CompareLength;\r | |
| 362 | return Index;\r | |
| 363 | }\r | |
| 364 | }\r | |
| 365 | ASSERT (FALSE);\r | |
| 366 | return 0;\r | |
| 367 | } else {\r | |
| 368 | //\r | |
| 369 | // Compare RFC3066 language code\r | |
| 370 | //\r | |
| 371 | while (*Supported != '\0') {\r | |
| 372 | //\r | |
| 373 | // take semicolon as delimitation, sequentially traverse supported language codes.\r | |
| 374 | //\r | |
| 375 | for (CompareLength = 0; *Supported != ';' && *Supported != '\0'; CompareLength++) {\r | |
| 376 | Supported++;\r | |
| 377 | }\r | |
| 378 | if (AsciiStrnCmp (Lang, Supported - CompareLength, CompareLength) == 0) {\r | |
| 379 | //\r | |
| 380 | // Successfully find the index of Lang string in SupportedLang string.\r | |
| 381 | //\r | |
| 382 | return Index;\r | |
| 383 | }\r | |
| 384 | Index++;\r | |
| 385 | }\r | |
| 386 | ASSERT (FALSE);\r | |
| 387 | return 0;\r | |
| 388 | }\r | |
| 389 | }\r | |
| 390 | \r | |
| 391 | /**\r | |
| 392 | Get language string from supported language codes according to index.\r | |
| 393 | \r | |
| 394 | This code is used to get corresponding language string in supported language codes. It can handle\r | |
| 395 | RFC3066 and ISO639 language tags.\r | |
| 396 | In ISO639 language tags, take 3-characters as a delimitation. Find language string according to the index.\r | |
| 397 | In RFC3066 language tags, take semicolon as a delimitation. Find language string according to the index.\r | |
| 398 | \r | |
| 399 | For example:\r | |
| 400 | SupportedLang = "engfraengfra"\r | |
| 401 | Index = "1"\r | |
| 402 | Iso639Language = TRUE\r | |
| 403 | The return value is "fra".\r | |
| 404 | Another example:\r | |
| 405 | SupportedLang = "en;fr;en-US;fr-FR"\r | |
| 406 | Index = "1"\r | |
| 407 | Iso639Language = FALSE\r | |
| 408 | The return value is "fr".\r | |
| 409 | \r | |
| 410 | @param SupportedLang Platform supported language codes.\r | |
| 411 | @param Index the index in supported language codes.\r | |
| 412 | @param Iso639Language A bool value to signify if the handler is operated on ISO639 or RFC3066.\r | |
| 413 | \r | |
| 414 | @retval the language string in the language codes.\r | |
| 415 | \r | |
| 416 | **/\r | |
| 417 | CHAR8 *\r | |
| 418 | EFIAPI\r | |
| 419 | GetLangFromSupportedLangCodes (\r | |
| 420 | IN CHAR8 *SupportedLang,\r | |
| 421 | IN UINTN Index,\r | |
| 422 | IN BOOLEAN Iso639Language\r | |
| 423 | )\r | |
| 424 | {\r | |
| 425 | UINTN SubIndex;\r | |
| 426 | UINT32 CompareLength;\r | |
| 427 | CHAR8 *Supported;\r | |
| 428 | \r | |
| 429 | SubIndex = 0;\r | |
| 430 | Supported = SupportedLang;\r | |
| 431 | if (Iso639Language) {\r | |
| 432 | //\r | |
| 433 | // according to the index of Lang string in SupportedLang string to get the language.\r | |
| 434 | // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.\r | |
| 435 | // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.\r | |
| 436 | //\r | |
| 437 | CompareLength = 3;\r | |
| 438 | SetMem (mVariableModuleGlobal->Lang, sizeof(mVariableModuleGlobal->Lang), 0);\r | |
| 439 | return CopyMem (mVariableModuleGlobal->Lang, SupportedLang + Index * CompareLength, CompareLength);\r | |
| 440 | \r | |
| 441 | } else {\r | |
| 442 | while (TRUE) {\r | |
| 443 | //\r | |
| 444 | // take semicolon as delimitation, sequentially traverse supported language codes.\r | |
| 445 | //\r | |
| 446 | for (CompareLength = 0; *Supported != ';' && *Supported != '\0'; CompareLength++) {\r | |
| 447 | Supported++;\r | |
| 448 | }\r | |
| 449 | if ((*Supported == '\0') && (SubIndex != Index)) {\r | |
| 450 | //\r | |
| 451 | // Have completed the traverse, but not find corrsponding string.\r | |
| 452 | // This case is not allowed to happen.\r | |
| 453 | //\r | |
| 454 | ASSERT(FALSE);\r | |
| 455 | return NULL;\r | |
| 456 | }\r | |
| 457 | if (SubIndex == Index) {\r | |
| 458 | //\r | |
| 459 | // according to the index of Lang string in SupportedLang string to get the language.\r | |
| 460 | // As this code will be invoked in RUNTIME, therefore there is not memory allocate/free operation.\r | |
| 461 | // In driver entry, it pre-allocates a runtime attribute memory to accommodate this string.\r | |
| 462 | //\r | |
| 463 | SetMem (mVariableModuleGlobal->PlatformLang, sizeof (mVariableModuleGlobal->PlatformLang), 0);\r | |
| 464 | return CopyMem (mVariableModuleGlobal->PlatformLang, Supported - CompareLength, CompareLength);\r | |
| 465 | }\r | |
| 466 | SubIndex++; \r | |
| 467 | }\r | |
| 468 | }\r | |
| 469 | }\r | |
| 470 | \r | |
| 471 | /**\r | |
| 472 | Hook the operations in PlatformLangCodes, LangCodes, PlatformLang and Lang.\r | |
| 473 | \r | |
| 474 | When setting Lang/LangCodes, simultaneously update PlatformLang/PlatformLangCodes.\r | |
| 475 | \r | |
| 476 | According to UEFI spec, PlatformLangCodes/LangCodes are only set once in firmware initialization,\r | |
| 477 | and are read-only. Therefore, in variable driver, only store the original value for other use.\r | |
| 478 | \r | |
| 479 | @param[in] VariableName Name of variable\r | |
| 480 | \r | |
| 481 | @param[in] Data Variable data\r | |
| 482 | \r | |
| 483 | @param[in] DataSize Size of data. 0 means delete\r | |
| 484 | \r | |
| 485 | @retval EFI_SUCCESS auto update operation is successful.\r | |
| 486 | \r | |
| 487 | **/\r | |
| 488 | EFI_STATUS\r | |
| 489 | EFIAPI\r | |
| 490 | AutoUpdateLangVariable(\r | |
| 491 | IN CHAR16 *VariableName,\r | |
| 492 | IN VOID *Data,\r | |
| 493 | IN UINTN DataSize\r | |
| 494 | )\r | |
| 495 | {\r | |
| 496 | EFI_STATUS Status;\r | |
| 497 | CHAR8 *BestPlatformLang;\r | |
| 498 | CHAR8 *BestLang;\r | |
| 499 | UINTN Index;\r | |
| 500 | UINT32 Attributes;\r | |
| 501 | VARIABLE_POINTER_TRACK Variable;\r | |
| 502 | \r | |
| 503 | //\r | |
| 504 | // According to UEFI spec, "Lang" and "PlatformLang" is NV|BS|RT attributions.\r | |
| 505 | //\r | |
| 506 | Attributes = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS;\r | |
| 507 | \r | |
| 508 | if (StrCmp (VariableName, L"PlatformLangCodes") == 0) {\r | |
| 509 | //\r | |
| 510 | // According to UEFI spec, PlatformLangCodes is only set once in firmware initialization, and is read-only\r | |
| 511 | // Therefore, in variable driver, only store the original value for other use.\r | |
| 512 | //\r | |
| 513 | AsciiStrnCpy (mVariableModuleGlobal->PlatformLangCodes, Data, DataSize);\r | |
| 514 | } else if (StrCmp (VariableName, L"LangCodes") == 0) {\r | |
| 515 | //\r | |
| 516 | // According to UEFI spec, LangCodes is only set once in firmware initialization, and is read-only\r | |
| 517 | // Therefore, in variable driver, only store the original value for other use.\r | |
| 518 | //\r | |
| 519 | AsciiStrnCpy (mVariableModuleGlobal->LangCodes, Data, DataSize);\r | |
| 520 | } else if (StrCmp (VariableName, L"PlatformLang") == 0) {\r | |
| 521 | ASSERT (AsciiStrLen (mVariableModuleGlobal->PlatformLangCodes) != 0);\r | |
| 522 | \r | |
| 523 | //\r | |
| 524 | // When setting PlatformLang, firstly get most matched language string from supported language codes.\r | |
| 525 | //\r | |
| 526 | BestPlatformLang = GetBestLanguage(mVariableModuleGlobal->PlatformLangCodes, FALSE, Data);\r | |
| 527 | \r | |
| 528 | //\r | |
| 529 | // Get the corresponding index in language codes.\r | |
| 530 | //\r | |
| 531 | Index = GetIndexFromSupportedLangCodes(mVariableModuleGlobal->PlatformLangCodes, BestPlatformLang, FALSE);\r | |
| 532 | \r | |
| 533 | //\r | |
| 534 | // Get the corresponding ISO639 language tag according to RFC3066 language tag.\r | |
| 535 | //\r | |
| 536 | BestLang = GetLangFromSupportedLangCodes(mVariableModuleGlobal->LangCodes, Index, TRUE);\r | |
| 537 | \r | |
| 538 | //\r | |
| 539 | // Successfully convert PlatformLang to Lang, and set the BestLang value into Lang variable simultaneously.\r | |
| 540 | //\r | |
| 541 | FindVariable(L"Lang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal);\r | |
| 542 | \r | |
| 543 | Status = UpdateVariable(L"Lang", &gEfiGlobalVariableGuid, \r | |
| 544 | BestLang, ISO_639_2_ENTRY_SIZE + 1, Attributes, &Variable);\r | |
| 545 | \r | |
| 546 | DEBUG((EFI_D_INFO, "Variable Driver Auto Update PlatformLang, PlatformLang:%a, Lang:%a\n", BestPlatformLang, BestLang));\r | |
| 547 | \r | |
| 548 | ASSERT_EFI_ERROR(Status);\r | |
| 549 | \r | |
| 550 | } else if (StrCmp (VariableName, L"Lang") == 0) {\r | |
| 551 | ASSERT (AsciiStrLen (mVariableModuleGlobal->LangCodes) != 0);\r | |
| 552 | \r | |
| 553 | //\r | |
| 554 | // When setting Lang, firstly get most matched language string from supported language codes.\r | |
| 555 | //\r | |
| 556 | BestLang = GetBestLanguage(mVariableModuleGlobal->LangCodes, TRUE, Data);\r | |
| 557 | \r | |
| 558 | //\r | |
| 559 | // Get the corresponding index in language codes.\r | |
| 560 | //\r | |
| 561 | Index = GetIndexFromSupportedLangCodes(mVariableModuleGlobal->LangCodes, BestLang, TRUE);\r | |
| 562 | \r | |
| 563 | //\r | |
| 564 | // Get the corresponding RFC3066 language tag according to ISO639 language tag.\r | |
| 565 | //\r | |
| 566 | BestPlatformLang = GetLangFromSupportedLangCodes(mVariableModuleGlobal->PlatformLangCodes, Index, FALSE);\r | |
| 567 | \r | |
| 568 | //\r | |
| 569 | // Successfully convert Lang to PlatformLang, and set the BestPlatformLang value into PlatformLang variable simultaneously.\r | |
| 570 | //\r | |
| 571 | FindVariable(L"PlatformLang", &gEfiGlobalVariableGuid, &Variable, (VARIABLE_GLOBAL *)mVariableModuleGlobal);\r | |
| 572 | \r | |
| 573 | Status = UpdateVariable(L"PlatformLang", &gEfiGlobalVariableGuid, \r | |
| 574 | BestPlatformLang, AsciiStrLen (BestPlatformLang), Attributes, &Variable);\r | |
| 575 | \r | |
| 576 | DEBUG((EFI_D_INFO, "Variable Driver Auto Update Lang, Lang:%a, PlatformLang:%a\n", BestLang, BestPlatformLang));\r | |
| 577 | ASSERT_EFI_ERROR(Status);\r | |
| 578 | }\r | |
| 579 | return EFI_SUCCESS;\r | |
| 580 | }\r | |
| 581 | \r | |
| 582 | /**\r | |
| 583 | Update the variable region with Variable information. These are the same \r | |
| 584 | arguments as the EFI Variable services.\r | |
| 585 | \r | |
| 586 | @param[in] VariableName Name of variable\r | |
| 587 | \r | |
| 588 | @param[in] VendorGuid Guid of variable\r | |
| 589 | \r | |
| 590 | @param[in] Data Variable data\r | |
| 591 | \r | |
| 592 | @param[in] DataSize Size of data. 0 means delete\r | |
| 593 | \r | |
| 594 | @param[in] Attributes Attribues of the variable\r | |
| 595 | \r | |
| 596 | @param[in] Variable The variable information which is used to keep track of variable usage.\r | |
| 597 | \r | |
| 598 | @retval EFI_SUCCESS The update operation is success.\r | |
| 599 | \r | |
| 600 | @retval EFI_OUT_OF_RESOURCES Variable region is full, can not write other data into this region.\r | |
| 601 | \r | |
| 602 | **/\r | |
| 603 | EFI_STATUS\r | |
| 604 | EFIAPI\r | |
| 605 | UpdateVariable (\r | |
| 606 | IN CHAR16 *VariableName,\r | |
| 607 | IN EFI_GUID *VendorGuid,\r | |
| 608 | IN VOID *Data,\r | |
| 609 | IN UINTN DataSize,\r | |
| 610 | IN UINT32 Attributes OPTIONAL,\r | |
| 611 | IN VARIABLE_POINTER_TRACK *Variable\r | |
| 612 | )\r | |
| 613 | {\r | |
| 614 | EFI_STATUS Status;\r | |
| 615 | VARIABLE_HEADER *NextVariable;\r | |
| 616 | UINTN VarNameSize;\r | |
| 617 | UINTN VarNameOffset;\r | |
| 618 | UINTN VarDataOffset;\r | |
| 619 | UINTN VarSize;\r | |
| 620 | VARIABLE_GLOBAL *Global;\r | |
| 621 | UINTN NonVolatileVarableStoreSize;\r | |
| 622 | \r | |
| 623 | Global = &mVariableModuleGlobal->VariableGlobal[Physical];\r | |
| 624 | \r | |
| 625 | if (Variable->CurrPtr != NULL) {\r | |
| 626 | //\r | |
| 627 | // Update/Delete existing variable\r | |
| 628 | //\r | |
| 629 | \r | |
| 630 | if (EfiAtRuntime ()) { \r | |
| 631 | //\r | |
| 632 | // If EfiAtRuntime and the variable is Volatile and Runtime Access, \r | |
| 633 | // the volatile is ReadOnly, and SetVariable should be aborted and \r | |
| 634 | // return EFI_WRITE_PROTECTED.\r | |
| 635 | //\r | |
| 636 | if (Variable->Volatile) {\r | |
| 637 | Status = EFI_WRITE_PROTECTED;\r | |
| 638 | goto Done;\r | |
| 639 | }\r | |
| 640 | //\r | |
| 641 | // Only variable have NV attribute can be updated/deleted in Runtime\r | |
| 642 | //\r | |
| 643 | if ((Variable->CurrPtr->Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {\r | |
| 644 | Status = EFI_INVALID_PARAMETER;\r | |
| 645 | goto Done;\r | |
| 646 | }\r | |
| 647 | }\r | |
| 648 | \r | |
| 649 | //\r | |
| 650 | // Setting a data variable with no access, or zero DataSize attributes\r | |
| 651 | // specified causes it to be deleted.\r | |
| 652 | //\r | |
| 653 | if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {\r | |
| 654 | Variable->CurrPtr->State &= VAR_DELETED;\r | |
| 655 | UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE, FALSE, TRUE, FALSE);\r | |
| 656 | Status = EFI_SUCCESS;\r | |
| 657 | goto Done;\r | |
| 658 | }\r | |
| 659 | \r | |
| 660 | //\r | |
| 661 | // If the variable is marked valid and the same data has been passed in\r | |
| 662 | // then return to the caller immediately.\r | |
| 663 | //\r | |
| 664 | if (Variable->CurrPtr->DataSize == DataSize &&\r | |
| 665 | CompareMem (Data, GetVariableDataPtr (Variable->CurrPtr), DataSize) == 0\r | |
| 666 | ) {\r | |
| 667 | Status = EFI_SUCCESS;\r | |
| 668 | goto Done;\r | |
| 669 | } else if (Variable->CurrPtr->State == VAR_ADDED) {\r | |
| 670 | //\r | |
| 671 | // Mark the old variable as in delete transition\r | |
| 672 | //\r | |
| 673 | Variable->CurrPtr->State &= VAR_IN_DELETED_TRANSITION;\r | |
| 674 | }\r | |
| 675 | \r | |
| 676 | } else {\r | |
| 677 | //\r | |
| 678 | // No found existing variable, Create a new variable\r | |
| 679 | // \r | |
| 680 | \r | |
| 681 | //\r | |
| 682 | // Make sure we are trying to create a new variable.\r | |
| 683 | // Setting a data variable with no access, or zero DataSize attributes means to delete it. \r | |
| 684 | //\r | |
| 685 | if (DataSize == 0 || (Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == 0) {\r | |
| 686 | Status = EFI_NOT_FOUND;\r | |
| 687 | goto Done;\r | |
| 688 | }\r | |
| 689 | \r | |
| 690 | //\r | |
| 691 | // Only variable have NV|RT attribute can be created in Runtime\r | |
| 692 | //\r | |
| 693 | if (EfiAtRuntime () &&\r | |
| 694 | (((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0) || ((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0))) {\r | |
| 695 | Status = EFI_INVALID_PARAMETER;\r | |
| 696 | goto Done;\r | |
| 697 | } \r | |
| 698 | }\r | |
| 699 | \r | |
| 700 | //\r | |
| 701 | // Function part - create a new variable and copy the data.\r | |
| 702 | // Both update a variable and create a variable will come here.\r | |
| 703 | //\r | |
| 704 | \r | |
| 705 | VarNameOffset = sizeof (VARIABLE_HEADER);\r | |
| 706 | VarNameSize = StrSize (VariableName);\r | |
| 707 | VarDataOffset = VarNameOffset + VarNameSize + GET_PAD_SIZE (VarNameSize);\r | |
| 708 | VarSize = VarDataOffset + DataSize + GET_PAD_SIZE (DataSize);\r | |
| 709 | \r | |
| 710 | if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {\r | |
| 711 | NonVolatileVarableStoreSize = ((VARIABLE_STORE_HEADER *)(UINTN)(Global->NonVolatileVariableBase))->Size;\r | |
| 712 | if ((((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) \r | |
| 713 | && ((VarSize + mVariableModuleGlobal->HwErrVariableTotalSize) > FixedPcdGet32(PcdHwErrStorageSize)))\r | |
| 714 | || (((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == 0) \r | |
| 715 | && ((VarSize + mVariableModuleGlobal->CommonVariableTotalSize) > NonVolatileVarableStoreSize - sizeof (VARIABLE_STORE_HEADER) - FixedPcdGet32(PcdHwErrStorageSize)))) {\r | |
| 716 | Status = EFI_OUT_OF_RESOURCES;\r | |
| 717 | goto Done;\r | |
| 718 | }\r | |
| 719 | \r | |
| 720 | NextVariable = (VARIABLE_HEADER *) (UINT8 *) (mVariableModuleGlobal->NonVolatileLastVariableOffset\r | |
| 721 | + (UINTN) Global->NonVolatileVariableBase);\r | |
| 722 | mVariableModuleGlobal->NonVolatileLastVariableOffset += VarSize;\r | |
| 723 | \r | |
| 724 | if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) != 0) {\r | |
| 725 | mVariableModuleGlobal->HwErrVariableTotalSize += VarSize;\r | |
| 726 | } else {\r | |
| 727 | mVariableModuleGlobal->CommonVariableTotalSize += VarSize;\r | |
| 728 | }\r | |
| 729 | } else {\r | |
| 730 | if ((UINT32) (VarSize + mVariableModuleGlobal->VolatileLastVariableOffset) >\r | |
| 731 | ((VARIABLE_STORE_HEADER *) ((UINTN) (Global->VolatileVariableBase)))->Size\r | |
| 732 | ) {\r | |
| 733 | Status = EFI_OUT_OF_RESOURCES;\r | |
| 734 | goto Done;\r | |
| 735 | }\r | |
| 736 | \r | |
| 737 | NextVariable = (VARIABLE_HEADER *) (UINT8 *) (mVariableModuleGlobal->VolatileLastVariableOffset\r | |
| 738 | + (UINTN) Global->VolatileVariableBase);\r | |
| 739 | mVariableModuleGlobal->VolatileLastVariableOffset += VarSize;\r | |
| 740 | }\r | |
| 741 | \r | |
| 742 | NextVariable->StartId = VARIABLE_DATA;\r | |
| 743 | NextVariable->Attributes = Attributes;\r | |
| 744 | NextVariable->State = VAR_ADDED;\r | |
| 745 | NextVariable->Reserved = 0;\r | |
| 746 | \r | |
| 747 | //\r | |
| 748 | // There will be pad bytes after Data, the NextVariable->NameSize and\r | |
| 749 | // NextVariable->NameSize should not include pad size so that variable\r | |
| 750 | // service can get actual size in GetVariable\r | |
| 751 | //\r | |
| 752 | NextVariable->NameSize = (UINT32)VarNameSize;\r | |
| 753 | NextVariable->DataSize = (UINT32)DataSize;\r | |
| 754 | \r | |
| 755 | CopyMem (&NextVariable->VendorGuid, VendorGuid, sizeof (EFI_GUID));\r | |
| 756 | CopyMem (\r | |
| 757 | (UINT8 *) ((UINTN) NextVariable + VarNameOffset),\r | |
| 758 | VariableName,\r | |
| 759 | VarNameSize\r | |
| 760 | );\r | |
| 761 | CopyMem (\r | |
| 762 | (UINT8 *) ((UINTN) NextVariable + VarDataOffset),\r | |
| 763 | Data,\r | |
| 764 | DataSize\r | |
| 765 | );\r | |
| 766 | \r | |
| 767 | //\r | |
| 768 | // Mark the old variable as deleted\r | |
| 769 | //\r | |
| 770 | Variable->CurrPtr->State &= VAR_DELETED;\r | |
| 771 | \r | |
| 772 | UpdateVariableInfo (VariableName, VendorGuid, Variable->Volatile, FALSE, TRUE, FALSE, FALSE);\r | |
| 773 | \r | |
| 774 | Status = EFI_SUCCESS;\r | |
| 775 | \r | |
| 776 | Done:\r | |
| 777 | return Status;\r | |
| 778 | }\r | |
| 779 | \r | |
| 1794e506 | 780 | /**\r |
| 781 | Finds variable in storage blocks of volatile and non-volatile storage areas.\r | |
| 782 | \r | |
| 783 | This code finds variable in storage blocks of volatile and non-volatile storage areas.\r | |
| 784 | If VariableName is an empty string, then we just return the first\r | |
| 785 | qualified variable without comparing VariableName and VendorGuid.\r | |
| 786 | Otherwise, VariableName and VendorGuid are compared.\r | |
| 787 | \r | |
| 788 | @param VariableName Name of the variable to be found.\r | |
| 789 | @param VendorGuid Vendor GUID to be found.\r | |
| 790 | @param PtrTrack VARIABLE_POINTER_TRACK structure for output,\r | |
| 791 | including the range searched and the target position.\r | |
| 792 | @param Global Pointer to VARIABLE_GLOBAL structure, including\r | |
| 793 | base of volatile variable storage area, base of\r | |
| 794 | NV variable storage area, and a lock.\r | |
| 795 | \r | |
| 796 | @retval EFI_INVALID_PARAMETER If VariableName is not an empty string, while\r | |
| 797 | VendorGuid is NULL.\r | |
| 798 | @retval EFI_SUCCESS Variable successfully found.\r | |
| 799 | @retval EFI_NOT_FOUND Variable not found.\r | |
| 800 | \r | |
| 801 | **/\r | |
| 8d3a5c82 | 802 | EFI_STATUS\r |
| 8d3a5c82 | 803 | FindVariable (\r |
| 804 | IN CHAR16 *VariableName,\r | |
| 805 | IN EFI_GUID *VendorGuid,\r | |
| 806 | OUT VARIABLE_POINTER_TRACK *PtrTrack,\r | |
| 807 | IN VARIABLE_GLOBAL *Global\r | |
| 808 | )\r | |
| 8d3a5c82 | 809 | {\r |
| 810 | VARIABLE_HEADER *Variable[2];\r | |
| 811 | VARIABLE_STORE_HEADER *VariableStoreHeader[2];\r | |
| 812 | UINTN Index;\r | |
| 813 | \r | |
| 814 | //\r | |
| 815 | // We aquire the lock at the entry of FindVariable as GetVariable, GetNextVariableName\r | |
| 816 | // SetVariable all call FindVariable at entry point. Please move "Aquire Lock" to\r | |
| 817 | // the correct places if this assumption does not hold TRUE anymore.\r | |
| 818 | //\r | |
| 819 | AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);\r | |
| 820 | \r | |
| 821 | //\r | |
| 822 | // 0: Non-Volatile, 1: Volatile\r | |
| 823 | //\r | |
| 824 | VariableStoreHeader[0] = (VARIABLE_STORE_HEADER *) ((UINTN) Global->NonVolatileVariableBase);\r | |
| 825 | VariableStoreHeader[1] = (VARIABLE_STORE_HEADER *) ((UINTN) Global->VolatileVariableBase);\r | |
| 826 | \r | |
| 827 | //\r | |
| 828 | // Start Pointers for the variable.\r | |
| 829 | // Actual Data Pointer where data can be written.\r | |
| 830 | //\r | |
| 831 | Variable[0] = (VARIABLE_HEADER *) (VariableStoreHeader[0] + 1);\r | |
| 832 | Variable[1] = (VARIABLE_HEADER *) (VariableStoreHeader[1] + 1);\r | |
| 833 | \r | |
| 834 | if (VariableName[0] != 0 && VendorGuid == NULL) {\r | |
| 835 | return EFI_INVALID_PARAMETER;\r | |
| 836 | }\r | |
| 837 | //\r | |
| 838 | // Find the variable by walk through non-volatile and volatile variable store\r | |
| 839 | //\r | |
| 840 | for (Index = 0; Index < 2; Index++) {\r | |
| 841 | PtrTrack->StartPtr = (VARIABLE_HEADER *) (VariableStoreHeader[Index] + 1);\r | |
| 842 | PtrTrack->EndPtr = GetEndPointer (VariableStoreHeader[Index]);\r | |
| 843 | \r | |
| fba0ee1f | 844 | while ((Variable[Index] < GetEndPointer (VariableStoreHeader[Index])) && (Variable[Index] != NULL)) {\r |
| 8d3a5c82 | 845 | if (Variable[Index]->StartId == VARIABLE_DATA && Variable[Index]->State == VAR_ADDED) {\r |
| 2374b973 | 846 | if (!(EfiAtRuntime () && ((Variable[Index]->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0))) {\r |
| 8d3a5c82 | 847 | if (VariableName[0] == 0) {\r |
| 848 | PtrTrack->CurrPtr = Variable[Index];\r | |
| 849 | PtrTrack->Volatile = (BOOLEAN) Index;\r | |
| 850 | return EFI_SUCCESS;\r | |
| 851 | } else {\r | |
| 852 | if (CompareGuid (VendorGuid, &Variable[Index]->VendorGuid)) {\r | |
| c24b392c | 853 | if (CompareMem (VariableName, GET_VARIABLE_NAME_PTR (Variable[Index]), Variable[Index]->NameSize) == 0) {\r |
| 8d3a5c82 | 854 | PtrTrack->CurrPtr = Variable[Index];\r |
| 855 | PtrTrack->Volatile = (BOOLEAN) Index;\r | |
| 856 | return EFI_SUCCESS;\r | |
| 857 | }\r | |
| 858 | }\r | |
| 859 | }\r | |
| 860 | }\r | |
| 861 | }\r | |
| 862 | \r | |
| 863 | Variable[Index] = GetNextVariablePtr (Variable[Index]);\r | |
| 864 | }\r | |
| 865 | }\r | |
| 866 | PtrTrack->CurrPtr = NULL;\r | |
| 867 | return EFI_NOT_FOUND;\r | |
| 868 | }\r | |
| 869 | \r | |
| 1794e506 | 870 | /**\r |
| 871 | This code finds variable in storage blocks (Volatile or Non-Volatile).\r | |
| 872 | \r | |
| 873 | @param VariableName A Null-terminated Unicode string that is the name of\r | |
| 874 | the vendor's variable.\r | |
| 875 | @param VendorGuid A unique identifier for the vendor.\r | |
| 876 | @param Attributes If not NULL, a pointer to the memory location to return the \r | |
| 877 | attributes bitmask for the variable.\r | |
| 878 | @param DataSize Size of Data found. If size is less than the\r | |
| 879 | data, this value contains the required size.\r | |
| 880 | @param Data On input, the size in bytes of the return Data buffer. \r | |
| 881 | On output, the size of data returned in Data.\r | |
| 882 | @param Global Pointer to VARIABLE_GLOBAL structure\r | |
| 1794e506 | 883 | \r |
| 884 | @retval EFI_SUCCESS The function completed successfully. \r | |
| 885 | @retval EFI_NOT_FOUND The variable was not found.\r | |
| 886 | @retval EFI_BUFFER_TOO_SMALL DataSize is too small for the result. DataSize has \r | |
| 887 | been updated with the size needed to complete the request.\r | |
| 888 | @retval EFI_INVALID_PARAMETER VariableName or VendorGuid or DataSize is NULL.\r | |
| 889 | \r | |
| 890 | **/\r | |
| 8d3a5c82 | 891 | EFI_STATUS\r |
| 892 | EFIAPI\r | |
| bd682470 | 893 | EmuGetVariable (\r |
| 8d3a5c82 | 894 | IN CHAR16 *VariableName,\r |
| 72399dae | 895 | IN EFI_GUID *VendorGuid,\r |
| 8d3a5c82 | 896 | OUT UINT32 *Attributes OPTIONAL,\r |
| 897 | IN OUT UINTN *DataSize,\r | |
| 898 | OUT VOID *Data,\r | |
| 72399dae | 899 | IN VARIABLE_GLOBAL *Global\r |
| 8d3a5c82 | 900 | )\r |
| 8d3a5c82 | 901 | {\r |
| 902 | VARIABLE_POINTER_TRACK Variable;\r | |
| 903 | UINTN VarDataSize;\r | |
| 904 | EFI_STATUS Status;\r | |
| 905 | \r | |
| 906 | if (VariableName == NULL || VendorGuid == NULL || DataSize == NULL) {\r | |
| 907 | return EFI_INVALID_PARAMETER;\r | |
| 908 | }\r | |
| 909 | //\r | |
| 910 | // Find existing variable\r | |
| 911 | //\r | |
| 912 | Status = FindVariable (VariableName, VendorGuid, &Variable, Global);\r | |
| 913 | \r | |
| 914 | if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r | |
| 915 | goto Done;\r | |
| 916 | }\r | |
| 917 | //\r | |
| 918 | // Get data size\r | |
| 919 | //\r | |
| 920 | VarDataSize = Variable.CurrPtr->DataSize;\r | |
| 921 | if (*DataSize >= VarDataSize) {\r | |
| 922 | if (Data == NULL) {\r | |
| 923 | Status = EFI_INVALID_PARAMETER;\r | |
| 924 | goto Done;\r | |
| 925 | }\r | |
| 926 | \r | |
| 927 | CopyMem (Data, GetVariableDataPtr (Variable.CurrPtr), VarDataSize);\r | |
| 928 | if (Attributes != NULL) {\r | |
| 929 | *Attributes = Variable.CurrPtr->Attributes;\r | |
| 930 | }\r | |
| 931 | \r | |
| 932 | *DataSize = VarDataSize;\r | |
| e4ddc008 | 933 | UpdateVariableInfo (VariableName, VendorGuid, Variable.Volatile, TRUE, FALSE, FALSE, FALSE);\r |
| 8d3a5c82 | 934 | Status = EFI_SUCCESS;\r |
| 935 | goto Done;\r | |
| 936 | } else {\r | |
| 937 | *DataSize = VarDataSize;\r | |
| 938 | Status = EFI_BUFFER_TOO_SMALL;\r | |
| 939 | goto Done;\r | |
| 940 | }\r | |
| 941 | \r | |
| 942 | Done:\r | |
| 943 | ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);\r | |
| 944 | return Status;\r | |
| 945 | }\r | |
| 946 | \r | |
| 1794e506 | 947 | /**\r |
| 948 | \r | |
| 949 | This code Finds the Next available variable.\r | |
| 950 | \r | |
| 951 | @param VariableNameSize Size of the variable.\r | |
| 952 | @param VariableName On input, supplies the last VariableName that was returned by GetNextVariableName().\r | |
| 953 | On output, returns the Null-terminated Unicode string of the current variable.\r | |
| 954 | @param VendorGuid On input, supplies the last VendorGuid that was returned by GetNextVariableName().\r | |
| 955 | On output, returns the VendorGuid of the current variable. \r | |
| 956 | @param Global Pointer to VARIABLE_GLOBAL structure.\r | |
| 1794e506 | 957 | \r |
| 958 | @retval EFI_SUCCESS The function completed successfully. \r | |
| 959 | @retval EFI_NOT_FOUND The next variable was not found.\r | |
| 960 | @retval EFI_BUFFER_TOO_SMALL VariableNameSize is too small for the result. \r | |
| 961 | VariableNameSize has been updated with the size needed to complete the request.\r | |
| 962 | @retval EFI_INVALID_PARAMETER VariableNameSize or VariableName or VendorGuid is NULL.\r | |
| 963 | \r | |
| 964 | **/\r | |
| 8d3a5c82 | 965 | EFI_STATUS\r |
| 966 | EFIAPI\r | |
| bd682470 | 967 | EmuGetNextVariableName (\r |
| 8d3a5c82 | 968 | IN OUT UINTN *VariableNameSize,\r |
| 969 | IN OUT CHAR16 *VariableName,\r | |
| 970 | IN OUT EFI_GUID *VendorGuid,\r | |
| 72399dae | 971 | IN VARIABLE_GLOBAL *Global\r |
| 8d3a5c82 | 972 | )\r |
| 8d3a5c82 | 973 | {\r |
| 974 | VARIABLE_POINTER_TRACK Variable;\r | |
| 975 | UINTN VarNameSize;\r | |
| 976 | EFI_STATUS Status;\r | |
| 977 | \r | |
| 978 | if (VariableNameSize == NULL || VariableName == NULL || VendorGuid == NULL) {\r | |
| 979 | return EFI_INVALID_PARAMETER;\r | |
| 980 | }\r | |
| 981 | \r | |
| 982 | Status = FindVariable (VariableName, VendorGuid, &Variable, Global);\r | |
| 983 | \r | |
| 984 | if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r | |
| 985 | goto Done;\r | |
| 986 | }\r | |
| 987 | \r | |
| 988 | while (TRUE) {\r | |
| 989 | if (VariableName[0] != 0) {\r | |
| 990 | //\r | |
| 991 | // If variable name is not NULL, get next variable\r | |
| 992 | //\r | |
| 993 | Variable.CurrPtr = GetNextVariablePtr (Variable.CurrPtr);\r | |
| 994 | }\r | |
| 995 | //\r | |
| 996 | // If both volatile and non-volatile variable store are parsed,\r | |
| 997 | // return not found\r | |
| 998 | //\r | |
| 999 | if (Variable.CurrPtr >= Variable.EndPtr || Variable.CurrPtr == NULL) {\r | |
| 1000 | Variable.Volatile = (BOOLEAN) (Variable.Volatile ^ ((BOOLEAN) 0x1));\r | |
| 1001 | if (Variable.Volatile) {\r | |
| 1002 | Variable.StartPtr = (VARIABLE_HEADER *) ((UINTN) (Global->VolatileVariableBase + sizeof (VARIABLE_STORE_HEADER)));\r | |
| 1003 | Variable.EndPtr = (VARIABLE_HEADER *) GetEndPointer ((VARIABLE_STORE_HEADER *) ((UINTN) Global->VolatileVariableBase));\r | |
| 1004 | } else {\r | |
| 1005 | Status = EFI_NOT_FOUND;\r | |
| 1006 | goto Done;\r | |
| 1007 | }\r | |
| 1008 | \r | |
| 1009 | Variable.CurrPtr = Variable.StartPtr;\r | |
| 1010 | if (Variable.CurrPtr->StartId != VARIABLE_DATA) {\r | |
| 1011 | continue;\r | |
| 1012 | }\r | |
| 1013 | }\r | |
| 1014 | //\r | |
| 1015 | // Variable is found\r | |
| 1016 | //\r | |
| 1017 | if (Variable.CurrPtr->StartId == VARIABLE_DATA && Variable.CurrPtr->State == VAR_ADDED) {\r | |
| ba5e88f9 | 1018 | if (!(EfiAtRuntime () && ((Variable.CurrPtr->Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0))) {\r |
| 8d3a5c82 | 1019 | VarNameSize = Variable.CurrPtr->NameSize;\r |
| 1020 | if (VarNameSize <= *VariableNameSize) {\r | |
| 1021 | CopyMem (\r | |
| 1022 | VariableName,\r | |
| 1023 | GET_VARIABLE_NAME_PTR (Variable.CurrPtr),\r | |
| 1024 | VarNameSize\r | |
| 1025 | );\r | |
| 1026 | CopyMem (\r | |
| 1027 | VendorGuid,\r | |
| 1028 | &Variable.CurrPtr->VendorGuid,\r | |
| 1029 | sizeof (EFI_GUID)\r | |
| 1030 | );\r | |
| 1031 | Status = EFI_SUCCESS;\r | |
| 1032 | } else {\r | |
| 1033 | Status = EFI_BUFFER_TOO_SMALL;\r | |
| 1034 | }\r | |
| 1035 | \r | |
| 1036 | *VariableNameSize = VarNameSize;\r | |
| 1037 | goto Done;\r | |
| 1038 | }\r | |
| 1039 | }\r | |
| 1040 | }\r | |
| 1041 | \r | |
| 1042 | Done:\r | |
| 1043 | ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);\r | |
| 1044 | return Status;\r | |
| 1045 | \r | |
| 1046 | }\r | |
| 1047 | \r | |
| 1794e506 | 1048 | /**\r |
| 1049 | \r | |
| 1050 | This code sets variable in storage blocks (Volatile or Non-Volatile).\r | |
| 1051 | \r | |
| 1052 | @param VariableName A Null-terminated Unicode string that is the name of the vendor's\r | |
| 1053 | variable. Each VariableName is unique for each \r | |
| 1054 | VendorGuid. VariableName must contain 1 or more \r | |
| 1055 | Unicode characters. If VariableName is an empty Unicode \r | |
| 1056 | string, then EFI_INVALID_PARAMETER is returned.\r | |
| 1057 | @param VendorGuid A unique identifier for the vendor\r | |
| 1058 | @param Attributes Attributes bitmask to set for the variable\r | |
| 1059 | @param DataSize The size in bytes of the Data buffer. A size of zero causes the\r | |
| 1060 | variable to be deleted.\r | |
| 1061 | @param Data The contents for the variable\r | |
| 1062 | @param Global Pointer to VARIABLE_GLOBAL structure\r | |
| 1063 | @param VolatileOffset The offset of last volatile variable\r | |
| 1064 | @param NonVolatileOffset The offset of last non-volatile variable\r | |
| 1794e506 | 1065 | \r |
| 1066 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as \r | |
| 1067 | defined by the Attributes.\r | |
| 1068 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the \r | |
| 1069 | DataSize exceeds the maximum allowed, or VariableName is an empty \r | |
| 1070 | Unicode string, or VendorGuid is NULL.\r | |
| 1071 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
| 1072 | @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r | |
| 1073 | @retval EFI_WRITE_PROTECTED The variable in question is read-only or cannot be deleted.\r | |
| 1074 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
| 1075 | \r | |
| 1076 | **/\r | |
| 8d3a5c82 | 1077 | EFI_STATUS\r |
| 1078 | EFIAPI\r | |
| bd682470 | 1079 | EmuSetVariable (\r |
| 8d3a5c82 | 1080 | IN CHAR16 *VariableName,\r |
| 1081 | IN EFI_GUID *VendorGuid,\r | |
| 1082 | IN UINT32 Attributes,\r | |
| 1083 | IN UINTN DataSize,\r | |
| 1084 | IN VOID *Data,\r | |
| 1085 | IN VARIABLE_GLOBAL *Global,\r | |
| 1086 | IN UINTN *VolatileOffset,\r | |
| 72399dae | 1087 | IN UINTN *NonVolatileOffset\r |
| 8d3a5c82 | 1088 | )\r |
| 8d3a5c82 | 1089 | {\r |
| 1090 | VARIABLE_POINTER_TRACK Variable;\r | |
| 1091 | EFI_STATUS Status;\r | |
| 8d3a5c82 | 1092 | \r |
| c6492839 | 1093 | //\r |
| 1094 | // Check input parameters\r | |
| 1095 | //\r | |
| 8d3a5c82 | 1096 | if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) {\r |
| 1097 | return EFI_INVALID_PARAMETER;\r | |
| c6492839 | 1098 | } \r |
| 1099 | //\r | |
| 1100 | // Make sure if runtime bit is set, boot service bit is set also\r | |
| 1101 | //\r | |
| 1102 | if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {\r | |
| 1103 | return EFI_INVALID_PARAMETER;\r | |
| 8d3a5c82 | 1104 | }\r |
| c6492839 | 1105 | //\r |
| 1106 | // The size of the VariableName, including the Unicode Null in bytes plus\r | |
| e5618791 LG |
1107 | // the DataSize is limited to maximum size of FixedPcdGet32(PcdMaxHardwareErrorVariableSize)\r |
| 1108 | // bytes for HwErrRec, and FixedPcdGet32(PcdMaxVariableSize) bytes for the others.\r | |
| c6492839 | 1109 | //\r |
| 1110 | if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r | |
| e5618791 LG |
1111 | if ((DataSize > FixedPcdGet32(PcdMaxHardwareErrorVariableSize)) || \r |
| 1112 | (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > FixedPcdGet32(PcdMaxHardwareErrorVariableSize))) {\r | |
| c6492839 | 1113 | return EFI_INVALID_PARAMETER;\r |
| 0c420e26 | 1114 | }\r |
| 1115 | //\r | |
| 1116 | // According to UEFI spec, HARDWARE_ERROR_RECORD variable name convention should be L"HwErrRecXXXX"\r | |
| 1117 | //\r | |
| 1118 | if (StrnCmp(VariableName, L"HwErrRec", StrLen(L"HwErrRec")) != 0) {\r | |
| 1119 | return EFI_INVALID_PARAMETER;\r | |
| 1120 | }\r | |
| c6492839 | 1121 | } else {\r |
| 1122 | //\r | |
| 1123 | // The size of the VariableName, including the Unicode Null in bytes plus\r | |
| e5618791 | 1124 | // the DataSize is limited to maximum size of FixedPcdGet32(PcdMaxVariableSize) bytes.\r |
| c6492839 | 1125 | //\r |
| e5618791 LG |
1126 | if ((DataSize > FixedPcdGet32(PcdMaxVariableSize)) ||\r |
| 1127 | (sizeof (VARIABLE_HEADER) + StrSize (VariableName) + DataSize > FixedPcdGet32(PcdMaxVariableSize))) {\r | |
| c6492839 | 1128 | return EFI_INVALID_PARAMETER;\r |
| 1129 | } \r | |
| 0c420e26 | 1130 | }\r |
| 1131 | \r | |
| c6492839 | 1132 | //\r |
| 1133 | // Check whether the input variable is already existed\r | |
| 1134 | //\r | |
| 1135 | \r | |
| 8d3a5c82 | 1136 | Status = FindVariable (VariableName, VendorGuid, &Variable, Global);\r |
| 1137 | \r | |
| c6492839 | 1138 | //\r |
| 72399dae | 1139 | // Hook the operation of setting PlatformLangCodes/PlatformLang and LangCodes/Lang\r |
| c6492839 | 1140 | //\r |
| 72399dae | 1141 | AutoUpdateLangVariable (VariableName, Data, DataSize);\r |
| c6492839 | 1142 | \r |
| 72399dae | 1143 | Status = UpdateVariable (VariableName, VendorGuid, Data, DataSize, Attributes, &Variable);\r |
| c6492839 | 1144 | \r |
| 8d3a5c82 | 1145 | ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);\r |
| 1146 | return Status;\r | |
| 1147 | }\r | |
| 1148 | \r | |
| 1794e506 | 1149 | /**\r |
| 1150 | \r | |
| 1151 | This code returns information about the EFI variables.\r | |
| 1152 | \r | |
| 1153 | @param Attributes Attributes bitmask to specify the type of variables\r | |
| 1154 | on which to return information.\r | |
| 1155 | @param MaximumVariableStorageSize On output the maximum size of the storage space available for \r | |
| 1156 | the EFI variables associated with the attributes specified. \r | |
| 1157 | @param RemainingVariableStorageSize Returns the remaining size of the storage space available for EFI \r | |
| 1158 | variables associated with the attributes specified.\r | |
| 1159 | @param MaximumVariableSize Returns the maximum size of an individual EFI variable \r | |
| 1160 | associated with the attributes specified.\r | |
| 1161 | @param Global Pointer to VARIABLE_GLOBAL structure.\r | |
| 1794e506 | 1162 | \r |
| 1163 | @retval EFI_SUCCESS Valid answer returned.\r | |
| 1164 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied\r | |
| 1165 | @retval EFI_UNSUPPORTED The attribute is not supported on this platform, and the \r | |
| 1166 | MaximumVariableStorageSize, RemainingVariableStorageSize, \r | |
| 1167 | MaximumVariableSize are undefined.\r | |
| 1168 | \r | |
| 1169 | **/\r | |
| 8d3a5c82 | 1170 | EFI_STATUS\r |
| 1171 | EFIAPI\r | |
| bd682470 | 1172 | EmuQueryVariableInfo (\r |
| 8d3a5c82 | 1173 | IN UINT32 Attributes,\r |
| 1174 | OUT UINT64 *MaximumVariableStorageSize,\r | |
| 1175 | OUT UINT64 *RemainingVariableStorageSize,\r | |
| 1176 | OUT UINT64 *MaximumVariableSize,\r | |
| 72399dae | 1177 | IN VARIABLE_GLOBAL *Global\r |
| 8d3a5c82 | 1178 | )\r |
| 8d3a5c82 | 1179 | {\r |
| 1180 | VARIABLE_HEADER *Variable;\r | |
| 1181 | VARIABLE_HEADER *NextVariable;\r | |
| 1182 | UINT64 VariableSize;\r | |
| 1183 | VARIABLE_STORE_HEADER *VariableStoreHeader;\r | |
| 72399dae | 1184 | UINT64 CommonVariableTotalSize;\r |
| 1185 | UINT64 HwErrVariableTotalSize;\r | |
| 1186 | \r | |
| 1187 | CommonVariableTotalSize = 0;\r | |
| 1188 | HwErrVariableTotalSize = 0;\r | |
| 8d3a5c82 | 1189 | \r |
| c6492839 | 1190 | if(MaximumVariableStorageSize == NULL || RemainingVariableStorageSize == NULL || MaximumVariableSize == NULL || Attributes == 0) {\r |
| 8d3a5c82 | 1191 | return EFI_INVALID_PARAMETER;\r |
| 1192 | }\r | |
| c6492839 | 1193 | \r |
| 1194 | if((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == 0) {\r | |
| 8d3a5c82 | 1195 | //\r |
| 1196 | // Make sure the Attributes combination is supported by the platform.\r | |
| 1197 | //\r | |
| c6492839 | 1198 | return EFI_UNSUPPORTED; \r |
| 8d3a5c82 | 1199 | } else if ((Attributes & (EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS)) == EFI_VARIABLE_RUNTIME_ACCESS) {\r |
| 1200 | //\r | |
| 1201 | // Make sure if runtime bit is set, boot service bit is set also.\r | |
| 1202 | //\r | |
| 1203 | return EFI_INVALID_PARAMETER;\r | |
| 1794e506 | 1204 | } else if (EfiAtRuntime () && ((Attributes & EFI_VARIABLE_RUNTIME_ACCESS) == 0)) {\r |
| 8d3a5c82 | 1205 | //\r |
| 1206 | // Make sure RT Attribute is set if we are in Runtime phase.\r | |
| 1207 | //\r | |
| 1208 | return EFI_INVALID_PARAMETER;\r | |
| 72399dae | 1209 | } else if ((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r |
| 1210 | //\r | |
| 1211 | // Make sure Hw Attribute is set with NV.\r | |
| 1212 | //\r | |
| 1213 | return EFI_INVALID_PARAMETER;\r | |
| 8d3a5c82 | 1214 | }\r |
| 1215 | \r | |
| 1216 | AcquireLockOnlyAtBootTime(&Global->VariableServicesLock);\r | |
| 1217 | \r | |
| 1218 | if((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0) {\r | |
| 1219 | //\r | |
| 1220 | // Query is Volatile related.\r | |
| 1221 | //\r | |
| 1222 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) Global->VolatileVariableBase);\r | |
| 1223 | } else {\r | |
| 1224 | //\r | |
| 1225 | // Query is Non-Volatile related.\r | |
| 1226 | //\r | |
| 1227 | VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINTN) Global->NonVolatileVariableBase);\r | |
| 1228 | }\r | |
| 1229 | \r | |
| 1230 | //\r | |
| 1231 | // Now let's fill *MaximumVariableStorageSize *RemainingVariableStorageSize\r | |
| 1232 | // with the storage size (excluding the storage header size)\r | |
| 1233 | //\r | |
| 1234 | *MaximumVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER);\r | |
| c6492839 | 1235 | \r |
| 1236 | //\r | |
| 1237 | // Harware error record variable needs larger size.\r | |
| 1238 | //\r | |
| 72399dae | 1239 | if ((Attributes & (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) == (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_HARDWARE_ERROR_RECORD)) {\r |
| 1240 | *MaximumVariableStorageSize = FixedPcdGet32(PcdHwErrStorageSize);\r | |
| e5618791 | 1241 | *MaximumVariableSize = FixedPcdGet32(PcdMaxHardwareErrorVariableSize) - sizeof (VARIABLE_HEADER);\r |
| 72399dae | 1242 | } else {\r |
| 1243 | if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {\r | |
| 1244 | ASSERT (FixedPcdGet32(PcdHwErrStorageSize) < VariableStoreHeader->Size);\r | |
| 1245 | *MaximumVariableStorageSize = VariableStoreHeader->Size - sizeof (VARIABLE_STORE_HEADER) - FixedPcdGet32(PcdHwErrStorageSize);\r | |
| 1246 | }\r | |
| 1247 | \r | |
| 1248 | //\r | |
| 1249 | // Let *MaximumVariableSize be FixedPcdGet32(PcdMaxVariableSize) with the exception of the variable header size.\r | |
| 1250 | //\r | |
| 1251 | *MaximumVariableSize = FixedPcdGet32(PcdMaxVariableSize) - sizeof (VARIABLE_HEADER);\r | |
| c6492839 | 1252 | }\r |
| 8d3a5c82 | 1253 | \r |
| 1254 | //\r | |
| 1255 | // Point to the starting address of the variables.\r | |
| 1256 | //\r | |
| 1257 | Variable = (VARIABLE_HEADER *) (VariableStoreHeader + 1);\r | |
| 1258 | \r | |
| 1259 | //\r | |
| 1260 | // Now walk through the related variable store.\r | |
| 1261 | //\r | |
| 1262 | while (Variable < GetEndPointer (VariableStoreHeader)) {\r | |
| 72399dae | 1263 | NextVariable = GetNextVariablePtr(Variable);\r |
| 1264 | if (NextVariable == NULL) {\r | |
| 8d3a5c82 | 1265 | break;\r |
| 1266 | }\r | |
| 8d3a5c82 | 1267 | VariableSize = (UINT64) (UINTN) NextVariable - (UINT64) (UINTN) Variable;\r |
| 1268 | \r | |
| 72399dae | 1269 | if ((NextVariable->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r |
| 1270 | HwErrVariableTotalSize += VariableSize;\r | |
| 1271 | } else {\r | |
| 1272 | CommonVariableTotalSize += VariableSize;\r | |
| 8d3a5c82 | 1273 | }\r |
| 1274 | \r | |
| 1275 | //\r | |
| 1276 | // Go to the next one.\r | |
| 1277 | //\r | |
| 1278 | Variable = NextVariable;\r | |
| 1279 | }\r | |
| 1280 | \r | |
| 72399dae | 1281 | if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD){\r |
| 1282 | *RemainingVariableStorageSize = *MaximumVariableStorageSize - HwErrVariableTotalSize;\r | |
| 1283 | } else {\r | |
| 1284 | *RemainingVariableStorageSize = *MaximumVariableStorageSize - CommonVariableTotalSize;\r | |
| 1285 | }\r | |
| 1286 | \r | |
| c6492839 | 1287 | if (*RemainingVariableStorageSize < sizeof (VARIABLE_HEADER)) {\r |
| 1288 | *MaximumVariableSize = 0;\r | |
| 1289 | } else if ((*RemainingVariableStorageSize - sizeof (VARIABLE_HEADER)) < *MaximumVariableSize) {\r | |
| 1290 | *MaximumVariableSize = *RemainingVariableStorageSize - sizeof (VARIABLE_HEADER);\r | |
| 1291 | }\r | |
| 1292 | \r | |
| 8d3a5c82 | 1293 | ReleaseLockOnlyAtBootTime (&Global->VariableServicesLock);\r |
| 1294 | return EFI_SUCCESS;\r | |
| 1295 | }\r | |
| 1296 | \r | |
| 1794e506 | 1297 | /**\r |
| 1298 | Initializes variable store area.\r | |
| 1299 | \r | |
| 1300 | This function allocates memory space for variable store area and initializes its attributes.\r | |
| 1301 | \r | |
| 1302 | @param VariableBase Base of the variable store area created\r | |
| 1303 | @param LastVariableOffset Size of VARIABLE_STORE_HEADER\r | |
| 1304 | \r | |
| 1305 | **/\r | |
| 8d3a5c82 | 1306 | EFI_STATUS\r |
| 8d3a5c82 | 1307 | InitializeVariableStore (\r |
| 1308 | OUT EFI_PHYSICAL_ADDRESS *VariableBase,\r | |
| 1309 | OUT UINTN *LastVariableOffset\r | |
| 1310 | )\r | |
| 8d3a5c82 | 1311 | {\r |
| 1312 | VARIABLE_STORE_HEADER *VariableStore;\r | |
| 1313 | \r | |
| 1314 | //\r | |
| 1315 | // Allocate memory for volatile variable store\r | |
| 1316 | //\r | |
| 1317 | VariableStore = (VARIABLE_STORE_HEADER *) AllocateRuntimePool (\r | |
| e5618791 | 1318 | FixedPcdGet32(PcdVariableStoreSize)\r |
| 8d3a5c82 | 1319 | );\r |
| 1320 | if (NULL == VariableStore) {\r | |
| 1321 | return EFI_OUT_OF_RESOURCES;\r | |
| 1322 | }\r | |
| 1323 | \r | |
| e5618791 | 1324 | SetMem (VariableStore, FixedPcdGet32(PcdVariableStoreSize), 0xff);\r |
| 8d3a5c82 | 1325 | \r |
| 1326 | //\r | |
| 1327 | // Variable Specific Data\r | |
| 1328 | //\r | |
| 1329 | *VariableBase = (EFI_PHYSICAL_ADDRESS) (UINTN) VariableStore;\r | |
| 1330 | *LastVariableOffset = sizeof (VARIABLE_STORE_HEADER);\r | |
| 1331 | \r | |
| 3709c4cd | 1332 | CopyGuid (&VariableStore->Signature, &gEfiVariableGuid);\r |
| e5618791 | 1333 | VariableStore->Size = FixedPcdGet32(PcdVariableStoreSize);\r |
| 8d3a5c82 | 1334 | VariableStore->Format = VARIABLE_STORE_FORMATTED;\r |
| 1335 | VariableStore->State = VARIABLE_STORE_HEALTHY;\r | |
| 1336 | VariableStore->Reserved = 0;\r | |
| 1337 | VariableStore->Reserved1 = 0;\r | |
| 1338 | \r | |
| 1339 | return EFI_SUCCESS;\r | |
| 1340 | }\r | |
| 1341 | \r | |
| 1794e506 | 1342 | /**\r |
| 1343 | Initializes variable store area for non-volatile and volatile variable.\r | |
| 1344 | \r | |
| 1345 | This function allocates and initializes memory space for global context of ESAL\r | |
| 1346 | variable service and variable store area for non-volatile and volatile variable.\r | |
| 1347 | \r | |
| 1348 | @param ImageHandle The Image handle of this driver.\r | |
| 1349 | @param SystemTable The pointer of EFI_SYSTEM_TABLE.\r | |
| 1350 | \r | |
| 1351 | @retval EFI_SUCCESS Function successfully executed.\r | |
| 1352 | @retval EFI_OUT_OF_RESOURCES Fail to allocate enough memory resource.\r | |
| 1353 | \r | |
| 1354 | **/\r | |
| 8d3a5c82 | 1355 | EFI_STATUS\r |
| 1356 | EFIAPI\r | |
| 1357 | VariableCommonInitialize (\r | |
| 1358 | IN EFI_HANDLE ImageHandle,\r | |
| 1359 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
| 1360 | )\r | |
| 8d3a5c82 | 1361 | {\r |
| 1362 | EFI_STATUS Status;\r | |
| 1363 | \r | |
| 1364 | //\r | |
| 1365 | // Allocate memory for mVariableModuleGlobal\r | |
| 1366 | //\r | |
| 72399dae | 1367 | mVariableModuleGlobal = (ESAL_VARIABLE_GLOBAL *) AllocateRuntimeZeroPool (\r |
| 8d3a5c82 | 1368 | sizeof (ESAL_VARIABLE_GLOBAL)\r |
| 1369 | );\r | |
| 1370 | if (NULL == mVariableModuleGlobal) {\r | |
| 1371 | return EFI_OUT_OF_RESOURCES;\r | |
| 1372 | }\r | |
| 1373 | \r | |
| 1374 | EfiInitializeLock(&mVariableModuleGlobal->VariableGlobal[Physical].VariableServicesLock, TPL_NOTIFY);\r | |
| 1375 | \r | |
| 1376 | //\r | |
| 1377 | // Intialize volatile variable store\r | |
| 1378 | //\r | |
| 1379 | Status = InitializeVariableStore (\r | |
| 1380 | &mVariableModuleGlobal->VariableGlobal[Physical].VolatileVariableBase,\r | |
| 1381 | &mVariableModuleGlobal->VolatileLastVariableOffset\r | |
| 1382 | );\r | |
| 1383 | \r | |
| 1384 | if (EFI_ERROR (Status)) {\r | |
| 5bb820af | 1385 | FreePool(mVariableModuleGlobal);\r |
| 8d3a5c82 | 1386 | return Status;\r |
| 1387 | }\r | |
| 1388 | //\r | |
| 1389 | // Intialize non volatile variable store\r | |
| 1390 | //\r | |
| 1391 | Status = InitializeVariableStore (\r | |
| 1392 | &mVariableModuleGlobal->VariableGlobal[Physical].NonVolatileVariableBase,\r | |
| 1393 | &mVariableModuleGlobal->NonVolatileLastVariableOffset\r | |
| 1394 | );\r | |
| 1395 | \r | |
| 1396 | return Status;\r | |
| 1397 | }\r |