]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Variable/RuntimeDxe/VariableExLib.c
MdeModulePkg: Apply uncrustify changes
[mirror_edk2.git] / MdeModulePkg / Universal / Variable / RuntimeDxe / VariableExLib.c
CommitLineData
fa0737a8
SZ
1/** @file\r
2 Provides variable driver extended services.\r
3\r
20a27a64 4Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>\r
9d510e61 5SPDX-License-Identifier: BSD-2-Clause-Patent\r
fa0737a8
SZ
6\r
7**/\r
8\r
9#include "Variable.h"\r
20a27a64 10#include "VariableParsing.h"\r
fa0737a8
SZ
11\r
12/**\r
13 Finds variable in storage blocks of volatile and non-volatile storage areas.\r
14\r
15 This code finds variable in storage blocks of volatile and non-volatile storage areas.\r
16 If VariableName is an empty string, then we just return the first\r
17 qualified variable without comparing VariableName and VendorGuid.\r
18\r
19 @param[in] VariableName Name of the variable to be found.\r
20 @param[in] VendorGuid Variable vendor GUID to be found.\r
21 @param[out] AuthVariableInfo Pointer to AUTH_VARIABLE_INFO structure for\r
22 output of the variable found.\r
23\r
24 @retval EFI_INVALID_PARAMETER If VariableName is not an empty string,\r
25 while VendorGuid is NULL.\r
26 @retval EFI_SUCCESS Variable successfully found.\r
27 @retval EFI_NOT_FOUND Variable not found\r
28\r
29**/\r
30EFI_STATUS\r
31EFIAPI\r
32VariableExLibFindVariable (\r
1436aea4
MK
33 IN CHAR16 *VariableName,\r
34 IN EFI_GUID *VendorGuid,\r
35 OUT AUTH_VARIABLE_INFO *AuthVariableInfo\r
fa0737a8
SZ
36 )\r
37{\r
1436aea4
MK
38 EFI_STATUS Status;\r
39 VARIABLE_POINTER_TRACK Variable;\r
40 AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r
fa0737a8
SZ
41\r
42 Status = FindVariable (\r
43 VariableName,\r
44 VendorGuid,\r
45 &Variable,\r
46 &mVariableModuleGlobal->VariableGlobal,\r
47 FALSE\r
48 );\r
49 if (EFI_ERROR (Status)) {\r
1436aea4
MK
50 AuthVariableInfo->Data = NULL;\r
51 AuthVariableInfo->DataSize = 0;\r
52 AuthVariableInfo->Attributes = 0;\r
53 AuthVariableInfo->PubKeyIndex = 0;\r
fa0737a8 54 AuthVariableInfo->MonotonicCount = 0;\r
1436aea4 55 AuthVariableInfo->TimeStamp = NULL;\r
fa0737a8
SZ
56 return Status;\r
57 }\r
58\r
1436aea4
MK
59 AuthVariableInfo->DataSize = DataSizeOfVariable (Variable.CurrPtr, mVariableModuleGlobal->VariableGlobal.AuthFormat);\r
60 AuthVariableInfo->Data = GetVariableDataPtr (Variable.CurrPtr, mVariableModuleGlobal->VariableGlobal.AuthFormat);\r
61 AuthVariableInfo->Attributes = Variable.CurrPtr->Attributes;\r
fa0737a8 62 if (mVariableModuleGlobal->VariableGlobal.AuthFormat) {\r
1436aea4
MK
63 AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *)Variable.CurrPtr;\r
64 AuthVariableInfo->PubKeyIndex = AuthVariable->PubKeyIndex;\r
65 AuthVariableInfo->MonotonicCount = ReadUnaligned64 (&(AuthVariable->MonotonicCount));\r
66 AuthVariableInfo->TimeStamp = &AuthVariable->TimeStamp;\r
fa0737a8
SZ
67 }\r
68\r
69 return EFI_SUCCESS;\r
70}\r
71\r
72/**\r
73 Finds next variable in storage blocks of volatile and non-volatile storage areas.\r
74\r
75 This code finds next variable in storage blocks of volatile and non-volatile storage areas.\r
76 If VariableName is an empty string, then we just return the first\r
77 qualified variable without comparing VariableName and VendorGuid.\r
78\r
79 @param[in] VariableName Name of the variable to be found.\r
80 @param[in] VendorGuid Variable vendor GUID to be found.\r
81 @param[out] AuthVariableInfo Pointer to AUTH_VARIABLE_INFO structure for\r
82 output of the next variable.\r
83\r
84 @retval EFI_INVALID_PARAMETER If VariableName is not an empty string,\r
85 while VendorGuid is NULL.\r
86 @retval EFI_SUCCESS Variable successfully found.\r
87 @retval EFI_NOT_FOUND Variable not found\r
88\r
89**/\r
90EFI_STATUS\r
91EFIAPI\r
92VariableExLibFindNextVariable (\r
1436aea4
MK
93 IN CHAR16 *VariableName,\r
94 IN EFI_GUID *VendorGuid,\r
95 OUT AUTH_VARIABLE_INFO *AuthVariableInfo\r
fa0737a8
SZ
96 )\r
97{\r
1436aea4
MK
98 EFI_STATUS Status;\r
99 VARIABLE_HEADER *VariablePtr;\r
100 AUTHENTICATED_VARIABLE_HEADER *AuthVariablePtr;\r
101 VARIABLE_STORE_HEADER *VariableStoreHeader[VariableStoreTypeMax];\r
f8ff4cca 102\r
1436aea4
MK
103 VariableStoreHeader[VariableStoreTypeVolatile] = (VARIABLE_STORE_HEADER *)(UINTN)mVariableModuleGlobal->VariableGlobal.VolatileVariableBase;\r
104 VariableStoreHeader[VariableStoreTypeHob] = (VARIABLE_STORE_HEADER *)(UINTN)mVariableModuleGlobal->VariableGlobal.HobVariableBase;\r
f8ff4cca 105 VariableStoreHeader[VariableStoreTypeNv] = mNvVariableCache;\r
fa0737a8
SZ
106\r
107 Status = VariableServiceGetNextVariableInternal (\r
108 VariableName,\r
109 VendorGuid,\r
f8ff4cca 110 VariableStoreHeader,\r
04401023
MK
111 &VariablePtr,\r
112 mVariableModuleGlobal->VariableGlobal.AuthFormat\r
fa0737a8
SZ
113 );\r
114 if (EFI_ERROR (Status)) {\r
1436aea4
MK
115 AuthVariableInfo->VariableName = NULL;\r
116 AuthVariableInfo->VendorGuid = NULL;\r
117 AuthVariableInfo->Data = NULL;\r
118 AuthVariableInfo->DataSize = 0;\r
119 AuthVariableInfo->Attributes = 0;\r
120 AuthVariableInfo->PubKeyIndex = 0;\r
fa0737a8 121 AuthVariableInfo->MonotonicCount = 0;\r
1436aea4 122 AuthVariableInfo->TimeStamp = NULL;\r
fa0737a8
SZ
123 return Status;\r
124 }\r
125\r
1436aea4
MK
126 AuthVariableInfo->VariableName = GetVariableNamePtr (VariablePtr, mVariableModuleGlobal->VariableGlobal.AuthFormat);\r
127 AuthVariableInfo->VendorGuid = GetVendorGuidPtr (VariablePtr, mVariableModuleGlobal->VariableGlobal.AuthFormat);\r
128 AuthVariableInfo->DataSize = DataSizeOfVariable (VariablePtr, mVariableModuleGlobal->VariableGlobal.AuthFormat);\r
129 AuthVariableInfo->Data = GetVariableDataPtr (VariablePtr, mVariableModuleGlobal->VariableGlobal.AuthFormat);\r
130 AuthVariableInfo->Attributes = VariablePtr->Attributes;\r
fa0737a8 131 if (mVariableModuleGlobal->VariableGlobal.AuthFormat) {\r
1436aea4
MK
132 AuthVariablePtr = (AUTHENTICATED_VARIABLE_HEADER *)VariablePtr;\r
133 AuthVariableInfo->PubKeyIndex = AuthVariablePtr->PubKeyIndex;\r
134 AuthVariableInfo->MonotonicCount = ReadUnaligned64 (&(AuthVariablePtr->MonotonicCount));\r
135 AuthVariableInfo->TimeStamp = &AuthVariablePtr->TimeStamp;\r
fa0737a8
SZ
136 }\r
137\r
138 return EFI_SUCCESS;\r
139}\r
140\r
141/**\r
142 Update the variable region with Variable information.\r
143\r
144 @param[in] AuthVariableInfo Pointer AUTH_VARIABLE_INFO structure for\r
145 input of the variable.\r
146\r
147 @retval EFI_SUCCESS The update operation is success.\r
148 @retval EFI_INVALID_PARAMETER Invalid parameter.\r
149 @retval EFI_WRITE_PROTECTED Variable is write-protected.\r
150 @retval EFI_OUT_OF_RESOURCES There is not enough resource.\r
151\r
152**/\r
153EFI_STATUS\r
154EFIAPI\r
155VariableExLibUpdateVariable (\r
1436aea4 156 IN AUTH_VARIABLE_INFO *AuthVariableInfo\r
fa0737a8
SZ
157 )\r
158{\r
1436aea4 159 VARIABLE_POINTER_TRACK Variable;\r
fa0737a8
SZ
160\r
161 FindVariable (AuthVariableInfo->VariableName, AuthVariableInfo->VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r
162 return UpdateVariable (\r
163 AuthVariableInfo->VariableName,\r
164 AuthVariableInfo->VendorGuid,\r
165 AuthVariableInfo->Data,\r
166 AuthVariableInfo->DataSize,\r
167 AuthVariableInfo->Attributes,\r
168 AuthVariableInfo->PubKeyIndex,\r
169 AuthVariableInfo->MonotonicCount,\r
170 &Variable,\r
171 AuthVariableInfo->TimeStamp\r
172 );\r
173}\r
174\r
175/**\r
176 Get scratch buffer.\r
177\r
178 @param[in, out] ScratchBufferSize Scratch buffer size. If input size is greater than\r
179 the maximum supported buffer size, this value contains\r
180 the maximum supported buffer size as output.\r
181 @param[out] ScratchBuffer Pointer to scratch buffer address.\r
182\r
183 @retval EFI_SUCCESS Get scratch buffer successfully.\r
184 @retval EFI_UNSUPPORTED If input size is greater than the maximum supported buffer size.\r
185\r
186**/\r
187EFI_STATUS\r
188EFIAPI\r
189VariableExLibGetScratchBuffer (\r
1436aea4
MK
190 IN OUT UINTN *ScratchBufferSize,\r
191 OUT VOID **ScratchBuffer\r
fa0737a8
SZ
192 )\r
193{\r
1436aea4 194 UINTN MaxBufferSize;\r
fa0737a8
SZ
195\r
196 MaxBufferSize = mVariableModuleGlobal->ScratchBufferSize;\r
197 if (*ScratchBufferSize > MaxBufferSize) {\r
198 *ScratchBufferSize = MaxBufferSize;\r
199 return EFI_UNSUPPORTED;\r
200 }\r
201\r
1436aea4 202 *ScratchBuffer = GetEndPointer ((VARIABLE_STORE_HEADER *)((UINTN)mVariableModuleGlobal->VariableGlobal.VolatileVariableBase));\r
fa0737a8
SZ
203 return EFI_SUCCESS;\r
204}\r
205\r
206/**\r
207 This function is to check if the remaining variable space is enough to set\r
208 all Variables from argument list successfully. The purpose of the check\r
209 is to keep the consistency of the Variables to be in variable storage.\r
210\r
211 Note: Variables are assumed to be in same storage.\r
212 The set sequence of Variables will be same with the sequence of VariableEntry from argument list,\r
213 so follow the argument sequence to check the Variables.\r
214\r
215 @param[in] Attributes Variable attributes for Variable entries.\r
216 @param ... The variable argument list with type VARIABLE_ENTRY_CONSISTENCY *.\r
217 A NULL terminates the list. The VariableSize of\r
218 VARIABLE_ENTRY_CONSISTENCY is the variable data size as input.\r
219 It will be changed to variable total size as output.\r
220\r
221 @retval TRUE Have enough variable space to set the Variables successfully.\r
222 @retval FALSE No enough variable space to set the Variables successfully.\r
223\r
224**/\r
225BOOLEAN\r
226EFIAPI\r
227VariableExLibCheckRemainingSpaceForConsistency (\r
1436aea4 228 IN UINT32 Attributes,\r
fa0737a8
SZ
229 ...\r
230 )\r
231{\r
1436aea4
MK
232 VA_LIST Marker;\r
233 BOOLEAN Return;\r
fa0737a8
SZ
234\r
235 VA_START (Marker, Attributes);\r
236\r
237 Return = CheckRemainingSpaceForConsistencyInternal (Attributes, Marker);\r
238\r
239 VA_END (Marker);\r
240\r
241 return Return;\r
242}\r
243\r
244/**\r
245 Return TRUE if at OS runtime.\r
246\r
247 @retval TRUE If at OS runtime.\r
248 @retval FALSE If at boot time.\r
249\r
250**/\r
251BOOLEAN\r
252EFIAPI\r
253VariableExLibAtRuntime (\r
254 VOID\r
255 )\r
256{\r
257 return AtRuntime ();\r
258}\r