]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellDebug1CommandsLib/SetVar.c
ShellPkg/comp: Use proper parameter names
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SetVar.c
CommitLineData
5d73d92f 1/** @file\r
2 Main file for SetVar shell Debug1 function.\r
3\r
c011b6c9 4 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
7f6511ee 5 Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r
5d73d92f 6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#include "UefiShellDebug1CommandsLib.h"\r
17\r
18STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
19 {L"-guid", TypeValue},\r
20 {L"-bs", TypeFlag},\r
21 {L"-rt", TypeFlag},\r
22 {L"-nv", TypeFlag},\r
23 {NULL, TypeMax}\r
24 };\r
25\r
bbf57d4f
LE
26\r
27/**\r
28 Check if the input is a (potentially empty) string of hexadecimal nibbles.\r
29\r
30 @param[in] String The CHAR16 string to check.\r
31\r
32 @retval FALSE A character has been found in String for which\r
33 ShellIsHexaDecimalDigitCharacter() returned FALSE.\r
34\r
35 @retval TRUE Otherwise. (Note that this covers the case when String is\r
36 empty.)\r
37**/\r
38BOOLEAN\r
bbf57d4f
LE
39IsStringOfHexNibbles (\r
40 IN CONST CHAR16 *String\r
41 )\r
42{\r
43 CONST CHAR16 *Pos;\r
44\r
45 for (Pos = String; *Pos != L'\0'; ++Pos) {\r
46 if (!ShellIsHexaDecimalDigitCharacter (*Pos)) {\r
47 return FALSE;\r
48 }\r
49 }\r
50 return TRUE;\r
51}\r
52\r
53\r
3737ac2b 54/**\r
55 Function for 'setvar' command.\r
56\r
57 @param[in] ImageHandle Handle to the Image (NULL if Internal).\r
58 @param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
59**/\r
5d73d92f 60SHELL_STATUS\r
61EFIAPI\r
62ShellCommandRunSetVar (\r
63 IN EFI_HANDLE ImageHandle,\r
64 IN EFI_SYSTEM_TABLE *SystemTable\r
65 )\r
66{\r
67 EFI_STATUS Status;\r
7f6511ee 68 RETURN_STATUS RStatus;\r
5d73d92f 69 LIST_ENTRY *Package;\r
70 CHAR16 *ProblemParam;\r
71 SHELL_STATUS ShellStatus;\r
72 CONST CHAR16 *VariableName;\r
73 CONST CHAR16 *Data;\r
74 EFI_GUID Guid;\r
75 CONST CHAR16 *StringGuid;\r
76 UINT32 Attributes;\r
77 VOID *Buffer;\r
78 UINTN Size;\r
79 UINTN LoopVar;\r
80 EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
5d73d92f 81\r
82 ShellStatus = SHELL_SUCCESS;\r
83 Status = EFI_SUCCESS;\r
84 Buffer = NULL;\r
85 Size = 0;\r
86 Attributes = 0;\r
87 DevPath = NULL;\r
88\r
89 //\r
90 // initialize the shell lib (we must be in non-auto-init...)\r
91 //\r
92 Status = ShellInitialize();\r
93 ASSERT_EFI_ERROR(Status);\r
94\r
95 Status = CommandInit();\r
96 ASSERT_EFI_ERROR(Status);\r
97\r
98 //\r
99 // parse the command line\r
100 //\r
101 Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
102 if (EFI_ERROR(Status)) {\r
103 if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
4092a8f6 104 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"setvar", ProblemParam); \r
5d73d92f 105 FreePool(ProblemParam);\r
106 ShellStatus = SHELL_INVALID_PARAMETER;\r
107 } else {\r
108 ASSERT(FALSE);\r
109 }\r
110 } else {\r
111 if (ShellCommandLineGetCount(Package) < 2) {\r
4092a8f6 112 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle, L"setvar"); \r
5d73d92f 113 ShellStatus = SHELL_INVALID_PARAMETER;\r
114 } else if (ShellCommandLineGetCount(Package) > 3) {\r
4092a8f6 115 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle, L"setvar"); \r
5d73d92f 116 ShellStatus = SHELL_INVALID_PARAMETER;\r
117 } else {\r
118 VariableName = ShellCommandLineGetRawValue(Package, 1);\r
119 Data = ShellCommandLineGetRawValue(Package, 2);\r
120 if (!ShellCommandLineGetFlag(Package, L"-guid")){\r
121 CopyGuid(&Guid, &gEfiGlobalVariableGuid);\r
122 } else {\r
123 StringGuid = ShellCommandLineGetValue(Package, L"-guid");\r
7f6511ee
RN
124 RStatus = StrToGuid (StringGuid, &Guid);\r
125 if (RETURN_ERROR (RStatus) || (StringGuid[GUID_STRING_LENGTH] != L'\0')) {\r
4092a8f6 126 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"setvar", StringGuid); \r
3737ac2b 127 ShellStatus = SHELL_INVALID_PARAMETER;\r
5d73d92f 128 }\r
129 }\r
475387e9 130 if (Data == NULL || Data[0] != L'=') {\r
5d73d92f 131 //\r
132 // Display what's there\r
133 //\r
134 Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
135 if (Status == EFI_BUFFER_TOO_SMALL) {\r
3737ac2b 136 Buffer = AllocateZeroPool(Size);\r
5d73d92f 137 Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
138 }\r
139 if (!EFI_ERROR(Status)&& Buffer != NULL) {\r
140 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_PRINT), gShellDebug1HiiHandle, &Guid, VariableName, Size);\r
141 for (LoopVar = 0 ; LoopVar < Size ; LoopVar++) {\r
142 ShellPrintEx(-1, -1, L"%02x ", ((UINT8*)Buffer)[LoopVar]);\r
143 }\r
144 ShellPrintEx(-1, -1, L"\r\n");\r
145 } else {\r
4092a8f6 146 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_GET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName); \r
5d73d92f 147 ShellStatus = SHELL_ACCESS_DENIED;\r
148 }\r
149 } else if (StrCmp(Data, L"=") == 0) {\r
150 //\r
151 // Delete what's there!\r
152 //\r
153 Status = gRT->SetVariable((CHAR16*)VariableName, &Guid, Attributes, 0, NULL);\r
154 if (EFI_ERROR(Status)) {\r
4092a8f6 155 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_SET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName); \r
5d73d92f 156 ShellStatus = SHELL_ACCESS_DENIED;\r
157 } else {\r
158 ASSERT(ShellStatus == SHELL_SUCCESS);\r
159 }\r
160 } else {\r
5d73d92f 161 //\r
475387e9 162 // Change what's there or create a new one.\r
5d73d92f 163 //\r
475387e9
JC
164\r
165 ASSERT(Data[0] == L'=');\r
166 Data++;\r
bbf57d4f 167 ASSERT(Data[0] != L'\0');\r
475387e9
JC
168\r
169 //\r
170 // Determine if the variable exists and get the attributes\r
171 //\r
172 Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
173 if (Status == EFI_BUFFER_TOO_SMALL) {\r
174 Buffer = AllocateZeroPool(Size);\r
175 Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
5d73d92f 176 }\r
475387e9
JC
177\r
178 if (EFI_ERROR(Status) || Buffer == NULL) {\r
179 //\r
180 // Creating a new variable. determine attributes from command line.\r
181 //\r
182 Attributes = 0;\r
183 if (ShellCommandLineGetFlag(Package, L"-bs")) {\r
184 Attributes |= EFI_VARIABLE_BOOTSERVICE_ACCESS;\r
185 }\r
186 if (ShellCommandLineGetFlag(Package, L"-rt")) {\r
187 Attributes |= EFI_VARIABLE_RUNTIME_ACCESS |\r
188 EFI_VARIABLE_BOOTSERVICE_ACCESS;\r
189 }\r
190 if (ShellCommandLineGetFlag(Package, L"-nv")) {\r
191 Attributes |= EFI_VARIABLE_NON_VOLATILE;\r
192 }\r
5d73d92f 193 }\r
475387e9
JC
194 SHELL_FREE_NON_NULL(Buffer);\r
195\r
196 //\r
197 // What type is the new data.\r
198 //\r
bbf57d4f 199 if (IsStringOfHexNibbles(Data)) {\r
3737ac2b 200 if (StrLen(Data) % 2 != 0) {\r
4092a8f6 201 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"setvar", Data); \r
3737ac2b 202 ShellStatus = SHELL_INVALID_PARAMETER;\r
5d73d92f 203 } else {\r
3737ac2b 204 //\r
205 // arbitrary buffer\r
206 //\r
207 Buffer = AllocateZeroPool((StrLen(Data) / 2));\r
33c031ee 208 if (Buffer == NULL) {\r
209 Status = EFI_OUT_OF_RESOURCES;\r
210 } else {\r
7f6511ee 211 StrHexToBytes (Data, StrLen (Data), Buffer, StrLen (Data) / 2);\r
33c031ee 212 Status = gRT->SetVariable((CHAR16*)VariableName, &Guid, Attributes, StrLen(Data) / 2, Buffer);\r
3737ac2b 213 }\r
3737ac2b 214 if (EFI_ERROR(Status)) {\r
4092a8f6 215 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_SET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName); \r
3737ac2b 216 ShellStatus = SHELL_ACCESS_DENIED;\r
217 } else {\r
218 ASSERT(ShellStatus == SHELL_SUCCESS);\r
219 }\r
5d73d92f 220 }\r
221 } else if (StrnCmp(Data, L"\"", 1) == 0) {\r
222 //\r
223 // ascii text\r
224 //\r
225 Data++;\r
226 Buffer = AllocateZeroPool(StrSize(Data) / 2);\r
33c031ee 227 if (Buffer == NULL) {\r
228 Status = EFI_OUT_OF_RESOURCES;\r
229 } else {\r
230 AsciiSPrint(Buffer, StrSize(Data) / 2, "%s", Data);\r
231 ((CHAR8*)Buffer)[AsciiStrLen(Buffer)-1] = CHAR_NULL;\r
232 Status = gRT->SetVariable((CHAR16*)VariableName, &Guid, Attributes, AsciiStrSize(Buffer)-sizeof(CHAR8), Buffer);\r
233 }\r
5d73d92f 234 if (EFI_ERROR(Status)) {\r
4092a8f6 235 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_SET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName); \r
5d73d92f 236 ShellStatus = SHELL_ACCESS_DENIED;\r
237 } else {\r
238 ASSERT(ShellStatus == SHELL_SUCCESS);\r
239 }\r
240 } else if (StrnCmp(Data, L"L\"", 2) == 0) {\r
241 //\r
242 // ucs2 text\r
243 //\r
244 Data++;\r
245 Data++;\r
246 Buffer = AllocateZeroPool(StrSize(Data));\r
cbdd109b 247 if (Buffer == NULL) {\r
4092a8f6 248 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_OUT_MEM), gShellDebug1HiiHandle, L"setvar"); \r
cbdd109b 249 ShellStatus = SHELL_OUT_OF_RESOURCES;\r
5d73d92f 250 } else {\r
cbdd109b 251 UnicodeSPrint(Buffer, StrSize(Data), L"%s", Data);\r
252 ((CHAR16*)Buffer)[StrLen(Buffer)-1] = CHAR_NULL;\r
253\r
254 Status = gRT->SetVariable((CHAR16*)VariableName, &Guid, Attributes, StrSize(Buffer)-sizeof(CHAR16), Buffer);\r
255 if (EFI_ERROR(Status)) {\r
4092a8f6 256 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_SET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName); \r
cbdd109b 257 ShellStatus = SHELL_ACCESS_DENIED;\r
258 } else {\r
259 ASSERT(ShellStatus == SHELL_SUCCESS);\r
260 }\r
5d73d92f 261 }\r
262 } else if (StrnCmp(Data, L"--", 2) == 0) {\r
263 //\r
264 // device path in text format\r
265 //\r
266 Data++;\r
267 Data++;\r
863986b3 268 DevPath = ConvertTextToDevicePath(Data);\r
5d73d92f 269 if (DevPath == NULL) {\r
4092a8f6 270 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_DPFT), gShellDebug1HiiHandle, L"setvar"); \r
5d73d92f 271 ShellStatus = SHELL_INVALID_PARAMETER;\r
272 } else {\r
273 Status = gRT->SetVariable((CHAR16*)VariableName, &Guid, Attributes, GetDevicePathSize(DevPath), DevPath);\r
274 if (EFI_ERROR(Status)) {\r
4092a8f6 275 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_SET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName); \r
5d73d92f 276 ShellStatus = SHELL_ACCESS_DENIED;\r
277 } else {\r
278 ASSERT(ShellStatus == SHELL_SUCCESS);\r
279 }\r
280 }\r
281 } else {\r
4092a8f6 282 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"setvar", Data); \r
5d73d92f 283 ShellStatus = SHELL_INVALID_PARAMETER;\r
284 }\r
285 }\r
286 }\r
287 ShellCommandLineFreeVarList (Package);\r
288 }\r
289\r
290 if (Buffer != NULL) {\r
291 FreePool(Buffer);\r
292 }\r
293\r
294 if (DevPath != NULL) {\r
295 FreePool(DevPath);\r
296 }\r
297\r
298 return (ShellStatus);\r
299}\r