]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellLib/UefiShellLib.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Refine code and check null pointer error.
[mirror_edk2.git] / ShellPkg / Library / UefiShellLib / UefiShellLib.c
CommitLineData
94b17fa1 1/** @file\r
2 Provides interface to shell functionality for shell commands and applications.\r
3\r
252d9457 4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
1e6e84c7 5 This program and the accompanying materials\r
b3011f40 6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
94b17fa1 9\r
b3011f40 10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
94b17fa1 12\r
13**/\r
14\r
b1f95a06 15#include "UefiShellLib.h"\r
a405b86d 16#include <ShellBase.h>\r
252d9457 17#include <Library/SortLib.h>\r
d2b4564b 18\r
94b17fa1 19#define FIND_XXXXX_FILE_BUFFER_SIZE (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)\r
20\r
d2b4564b 21//\r
a405b86d 22// globals...\r
d2b4564b 23//\r
24SHELL_PARAM_ITEM EmptyParamList[] = {\r
25 {NULL, TypeMax}\r
26 };\r
a405b86d 27SHELL_PARAM_ITEM SfoParamList[] = {\r
28 {L"-sfo", TypeFlag},\r
29 {NULL, TypeMax}\r
30 };\r
31EFI_SHELL_ENVIRONMENT2 *mEfiShellEnvironment2;\r
32EFI_SHELL_INTERFACE *mEfiShellInterface;\r
366f81a0 33EFI_SHELL_PROTOCOL *gEfiShellProtocol;\r
34EFI_SHELL_PARAMETERS_PROTOCOL *gEfiShellParametersProtocol;\r
a405b86d 35EFI_HANDLE mEfiShellEnvironment2Handle;\r
36FILE_HANDLE_FUNCTION_MAP FileFunctionMap;\r
b3011f40 37\r
2247dde4 38/**\r
39 Check if a Unicode character is a hexadecimal character.\r
40\r
1e6e84c7 41 This internal function checks if a Unicode character is a\r
a405b86d 42 numeric character. The valid hexadecimal characters are\r
2247dde4 43 L'0' to L'9', L'a' to L'f', or L'A' to L'F'.\r
44\r
2247dde4 45 @param Char The character to check against.\r
46\r
47 @retval TRUE If the Char is a hexadecmial character.\r
48 @retval FALSE If the Char is not a hexadecmial character.\r
49\r
50**/\r
51BOOLEAN\r
52EFIAPI\r
969c783b 53ShellIsHexaDecimalDigitCharacter (\r
2247dde4 54 IN CHAR16 Char\r
a405b86d 55 )\r
56{\r
2247dde4 57 return (BOOLEAN) ((Char >= L'0' && Char <= L'9') || (Char >= L'A' && Char <= L'F') || (Char >= L'a' && Char <= L'f'));\r
58}\r
94b17fa1 59\r
60/**\r
a405b86d 61 Check if a Unicode character is a decimal character.\r
62\r
63 This internal function checks if a Unicode character is a\r
64 decimal character. The valid characters are\r
65 L'0' to L'9'.\r
66\r
67\r
68 @param Char The character to check against.\r
69\r
70 @retval TRUE If the Char is a hexadecmial character.\r
71 @retval FALSE If the Char is not a hexadecmial character.\r
72\r
73**/\r
74BOOLEAN\r
75EFIAPI\r
76ShellIsDecimalDigitCharacter (\r
77 IN CHAR16 Char\r
78 )\r
79{\r
80 return (BOOLEAN) (Char >= L'0' && Char <= L'9');\r
81}\r
82\r
83/**\r
84 Helper function to find ShellEnvironment2 for constructor.\r
85\r
86 @param[in] ImageHandle A copy of the calling image's handle.\r
beab0fc5 87\r
88 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.\r
94b17fa1 89**/\r
90EFI_STATUS\r
91EFIAPI\r
92ShellFindSE2 (\r
93 IN EFI_HANDLE ImageHandle\r
a405b86d 94 )\r
95{\r
94b17fa1 96 EFI_STATUS Status;\r
97 EFI_HANDLE *Buffer;\r
98 UINTN BufferSize;\r
99 UINTN HandleIndex;\r
100\r
101 BufferSize = 0;\r
102 Buffer = NULL;\r
1e6e84c7 103 Status = gBS->OpenProtocol(ImageHandle,\r
94b17fa1 104 &gEfiShellEnvironment2Guid,\r
105 (VOID **)&mEfiShellEnvironment2,\r
106 ImageHandle,\r
107 NULL,\r
108 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
a405b86d 109 );\r
94b17fa1 110 //\r
111 // look for the mEfiShellEnvironment2 protocol at a higher level\r
112 //\r
a405b86d 113 if (EFI_ERROR (Status) || !(CompareGuid (&mEfiShellEnvironment2->SESGuid, &gEfiShellEnvironment2ExtGuid))){\r
94b17fa1 114 //\r
115 // figure out how big of a buffer we need.\r
116 //\r
117 Status = gBS->LocateHandle (ByProtocol,\r
118 &gEfiShellEnvironment2Guid,\r
119 NULL, // ignored for ByProtocol\r
120 &BufferSize,\r
121 Buffer\r
a405b86d 122 );\r
2247dde4 123 //\r
124 // maybe it's not there???\r
125 //\r
126 if (Status == EFI_BUFFER_TOO_SMALL) {\r
252d9457 127 Buffer = (EFI_HANDLE*)AllocateZeroPool(BufferSize);\r
beab0fc5 128 if (Buffer == NULL) {\r
129 return (EFI_OUT_OF_RESOURCES);\r
130 }\r
2247dde4 131 Status = gBS->LocateHandle (ByProtocol,\r
132 &gEfiShellEnvironment2Guid,\r
133 NULL, // ignored for ByProtocol\r
134 &BufferSize,\r
135 Buffer\r
a405b86d 136 );\r
2247dde4 137 }\r
1cd45e78 138 if (!EFI_ERROR (Status) && Buffer != NULL) {\r
94b17fa1 139 //\r
140 // now parse the list of returned handles\r
141 //\r
142 Status = EFI_NOT_FOUND;\r
143 for (HandleIndex = 0; HandleIndex < (BufferSize/sizeof(Buffer[0])); HandleIndex++) {\r
1e6e84c7 144 Status = gBS->OpenProtocol(Buffer[HandleIndex],\r
94b17fa1 145 &gEfiShellEnvironment2Guid,\r
146 (VOID **)&mEfiShellEnvironment2,\r
147 ImageHandle,\r
148 NULL,\r
149 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
a405b86d 150 );\r
151 if (CompareGuid (&mEfiShellEnvironment2->SESGuid, &gEfiShellEnvironment2ExtGuid)) {\r
94b17fa1 152 mEfiShellEnvironment2Handle = Buffer[HandleIndex];\r
153 Status = EFI_SUCCESS;\r
154 break;\r
155 }\r
156 }\r
157 }\r
158 }\r
159 if (Buffer != NULL) {\r
160 FreePool (Buffer);\r
161 }\r
162 return (Status);\r
163}\r
164\r
252d9457 165/**\r
a405b86d 166 Function to do most of the work of the constructor. Allows for calling \r
167 multiple times without complete re-initialization.\r
168\r
169 @param[in] ImageHandle A copy of the ImageHandle.\r
170 @param[in] SystemTable A pointer to the SystemTable for the application.\r
252d9457 171\r
172 @retval EFI_SUCCESS The operationw as successful.\r
a405b86d 173**/\r
94b17fa1 174EFI_STATUS\r
175EFIAPI\r
d2b4564b 176ShellLibConstructorWorker (\r
94b17fa1 177 IN EFI_HANDLE ImageHandle,\r
178 IN EFI_SYSTEM_TABLE *SystemTable\r
a405b86d 179 )\r
180{\r
181 EFI_STATUS Status;\r
ecd3d59f 182\r
94b17fa1 183 //\r
184 // UEFI 2.0 shell interfaces (used preferentially)\r
185 //\r
a405b86d 186 Status = gBS->OpenProtocol(\r
187 ImageHandle,\r
188 &gEfiShellProtocolGuid,\r
366f81a0 189 (VOID **)&gEfiShellProtocol,\r
a405b86d 190 ImageHandle,\r
191 NULL,\r
192 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
193 );\r
94b17fa1 194 if (EFI_ERROR(Status)) {\r
a405b86d 195 //\r
196 // Search for the shell protocol\r
197 //\r
198 Status = gBS->LocateProtocol(\r
199 &gEfiShellProtocolGuid,\r
200 NULL,\r
366f81a0 201 (VOID **)&gEfiShellProtocol\r
a405b86d 202 );\r
203 if (EFI_ERROR(Status)) {\r
366f81a0 204 gEfiShellProtocol = NULL;\r
a405b86d 205 }\r
94b17fa1 206 }\r
a405b86d 207 Status = gBS->OpenProtocol(\r
208 ImageHandle,\r
209 &gEfiShellParametersProtocolGuid,\r
366f81a0 210 (VOID **)&gEfiShellParametersProtocol,\r
a405b86d 211 ImageHandle,\r
212 NULL,\r
213 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
214 );\r
94b17fa1 215 if (EFI_ERROR(Status)) {\r
366f81a0 216 gEfiShellParametersProtocol = NULL;\r
94b17fa1 217 }\r
218\r
366f81a0 219 if (gEfiShellParametersProtocol == NULL || gEfiShellProtocol == NULL) {\r
94b17fa1 220 //\r
221 // Moved to seperate function due to complexity\r
222 //\r
223 Status = ShellFindSE2(ImageHandle);\r
224\r
225 if (EFI_ERROR(Status)) {\r
226 DEBUG((DEBUG_ERROR, "Status: 0x%08x\r\n", Status));\r
227 mEfiShellEnvironment2 = NULL;\r
228 }\r
1e6e84c7 229 Status = gBS->OpenProtocol(ImageHandle,\r
94b17fa1 230 &gEfiShellInterfaceGuid,\r
231 (VOID **)&mEfiShellInterface,\r
232 ImageHandle,\r
233 NULL,\r
234 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
a405b86d 235 );\r
94b17fa1 236 if (EFI_ERROR(Status)) {\r
237 mEfiShellInterface = NULL;\r
238 }\r
239 }\r
c9d92df0 240\r
94b17fa1 241 //\r
242 // only success getting 2 of either the old or new, but no 1/2 and 1/2\r
243 //\r
1e6e84c7 244 if ((mEfiShellEnvironment2 != NULL && mEfiShellInterface != NULL) ||\r
366f81a0 245 (gEfiShellProtocol != NULL && gEfiShellParametersProtocol != NULL) ) {\r
246 if (gEfiShellProtocol != NULL) {\r
247 FileFunctionMap.GetFileInfo = gEfiShellProtocol->GetFileInfo;\r
248 FileFunctionMap.SetFileInfo = gEfiShellProtocol->SetFileInfo;\r
249 FileFunctionMap.ReadFile = gEfiShellProtocol->ReadFile;\r
250 FileFunctionMap.WriteFile = gEfiShellProtocol->WriteFile;\r
251 FileFunctionMap.CloseFile = gEfiShellProtocol->CloseFile;\r
252 FileFunctionMap.DeleteFile = gEfiShellProtocol->DeleteFile;\r
253 FileFunctionMap.GetFilePosition = gEfiShellProtocol->GetFilePosition;\r
254 FileFunctionMap.SetFilePosition = gEfiShellProtocol->SetFilePosition;\r
255 FileFunctionMap.FlushFile = gEfiShellProtocol->FlushFile;\r
256 FileFunctionMap.GetFileSize = gEfiShellProtocol->GetFileSize;\r
d2b4564b 257 } else {\r
a405b86d 258 FileFunctionMap.GetFileInfo = (EFI_SHELL_GET_FILE_INFO)FileHandleGetInfo;\r
259 FileFunctionMap.SetFileInfo = (EFI_SHELL_SET_FILE_INFO)FileHandleSetInfo;\r
260 FileFunctionMap.ReadFile = (EFI_SHELL_READ_FILE)FileHandleRead;\r
261 FileFunctionMap.WriteFile = (EFI_SHELL_WRITE_FILE)FileHandleWrite;\r
262 FileFunctionMap.CloseFile = (EFI_SHELL_CLOSE_FILE)FileHandleClose;\r
263 FileFunctionMap.DeleteFile = (EFI_SHELL_DELETE_FILE)FileHandleDelete;\r
264 FileFunctionMap.GetFilePosition = (EFI_SHELL_GET_FILE_POSITION)FileHandleGetPosition;\r
265 FileFunctionMap.SetFilePosition = (EFI_SHELL_SET_FILE_POSITION)FileHandleSetPosition;\r
266 FileFunctionMap.FlushFile = (EFI_SHELL_FLUSH_FILE)FileHandleFlush;\r
267 FileFunctionMap.GetFileSize = (EFI_SHELL_GET_FILE_SIZE)FileHandleGetSize;\r
d2b4564b 268 }\r
94b17fa1 269 return (EFI_SUCCESS);\r
270 }\r
271 return (EFI_NOT_FOUND);\r
272}\r
d2b4564b 273/**\r
274 Constructor for the Shell library.\r
275\r
276 Initialize the library and determine if the underlying is a UEFI Shell 2.0 or an EFI shell.\r
277\r
278 @param ImageHandle the image handle of the process\r
279 @param SystemTable the EFI System Table pointer\r
280\r
281 @retval EFI_SUCCESS the initialization was complete sucessfully\r
282 @return others an error ocurred during initialization\r
283**/\r
284EFI_STATUS\r
285EFIAPI\r
286ShellLibConstructor (\r
287 IN EFI_HANDLE ImageHandle,\r
288 IN EFI_SYSTEM_TABLE *SystemTable\r
a405b86d 289 )\r
290{\r
d2b4564b 291 mEfiShellEnvironment2 = NULL;\r
366f81a0 292 gEfiShellProtocol = NULL;\r
293 gEfiShellParametersProtocol = NULL;\r
d2b4564b 294 mEfiShellInterface = NULL;\r
295 mEfiShellEnvironment2Handle = NULL;\r
296\r
d2b4564b 297 //\r
298 // verify that auto initialize is not set false\r
1e6e84c7 299 //\r
d2b4564b 300 if (PcdGetBool(PcdShellLibAutoInitialize) == 0) {\r
301 return (EFI_SUCCESS);\r
302 }\r
1e6e84c7 303\r
d2b4564b 304 return (ShellLibConstructorWorker(ImageHandle, SystemTable));\r
305}\r
94b17fa1 306\r
307/**\r
a405b86d 308 Destructor for the library. free any resources.\r
309\r
310 @param[in] ImageHandle A copy of the ImageHandle.\r
311 @param[in] SystemTable A pointer to the SystemTable for the application.\r
312\r
313 @retval EFI_SUCCESS The operation was successful.\r
314 @return An error from the CloseProtocol function.\r
94b17fa1 315**/\r
316EFI_STATUS\r
317EFIAPI\r
318ShellLibDestructor (\r
319 IN EFI_HANDLE ImageHandle,\r
320 IN EFI_SYSTEM_TABLE *SystemTable\r
a405b86d 321 )\r
322{\r
94b17fa1 323 if (mEfiShellEnvironment2 != NULL) {\r
324 gBS->CloseProtocol(mEfiShellEnvironment2Handle==NULL?ImageHandle:mEfiShellEnvironment2Handle,\r
325 &gEfiShellEnvironment2Guid,\r
326 ImageHandle,\r
327 NULL);\r
d2b4564b 328 mEfiShellEnvironment2 = NULL;\r
94b17fa1 329 }\r
330 if (mEfiShellInterface != NULL) {\r
331 gBS->CloseProtocol(ImageHandle,\r
332 &gEfiShellInterfaceGuid,\r
333 ImageHandle,\r
1e6e84c7 334 NULL);\r
d2b4564b 335 mEfiShellInterface = NULL;\r
94b17fa1 336 }\r
366f81a0 337 if (gEfiShellProtocol != NULL) {\r
94b17fa1 338 gBS->CloseProtocol(ImageHandle,\r
339 &gEfiShellProtocolGuid,\r
340 ImageHandle,\r
1e6e84c7 341 NULL);\r
366f81a0 342 gEfiShellProtocol = NULL;\r
94b17fa1 343 }\r
366f81a0 344 if (gEfiShellParametersProtocol != NULL) {\r
94b17fa1 345 gBS->CloseProtocol(ImageHandle,\r
346 &gEfiShellParametersProtocolGuid,\r
347 ImageHandle,\r
1e6e84c7 348 NULL);\r
366f81a0 349 gEfiShellParametersProtocol = NULL;\r
94b17fa1 350 }\r
d2b4564b 351 mEfiShellEnvironment2Handle = NULL;\r
ecd3d59f 352\r
94b17fa1 353 return (EFI_SUCCESS);\r
354}\r
d2b4564b 355\r
356/**\r
357 This function causes the shell library to initialize itself. If the shell library\r
358 is already initialized it will de-initialize all the current protocol poitners and\r
359 re-populate them again.\r
360\r
361 When the library is used with PcdShellLibAutoInitialize set to true this function\r
362 will return EFI_SUCCESS and perform no actions.\r
363\r
364 This function is intended for internal access for shell commands only.\r
365\r
366 @retval EFI_SUCCESS the initialization was complete sucessfully\r
367\r
368**/\r
369EFI_STATUS\r
370EFIAPI\r
371ShellInitialize (\r
a405b86d 372 )\r
373{\r
d2b4564b 374 //\r
375 // if auto initialize is not false then skip\r
376 //\r
377 if (PcdGetBool(PcdShellLibAutoInitialize) != 0) {\r
378 return (EFI_SUCCESS);\r
379 }\r
380\r
381 //\r
382 // deinit the current stuff\r
383 //\r
384 ASSERT_EFI_ERROR(ShellLibDestructor(gImageHandle, gST));\r
385\r
386 //\r
387 // init the new stuff\r
388 //\r
389 return (ShellLibConstructorWorker(gImageHandle, gST));\r
390}\r
391\r
94b17fa1 392/**\r
1e6e84c7 393 This function will retrieve the information about the file for the handle\r
94b17fa1 394 specified and store it in allocated pool memory.\r
395\r
1e6e84c7 396 This function allocates a buffer to store the file's information. It is the\r
69817bf8 397 caller's responsibility to free the buffer\r
94b17fa1 398\r
1e6e84c7 399 @param FileHandle The file handle of the file for which information is\r
94b17fa1 400 being requested.\r
401\r
402 @retval NULL information could not be retrieved.\r
403\r
404 @return the information about the file\r
405**/\r
406EFI_FILE_INFO*\r
407EFIAPI\r
408ShellGetFileInfo (\r
a405b86d 409 IN SHELL_FILE_HANDLE FileHandle\r
410 )\r
411{\r
d2b4564b 412 return (FileFunctionMap.GetFileInfo(FileHandle));\r
94b17fa1 413}\r
414\r
415/**\r
a405b86d 416 This function sets the information about the file for the opened handle\r
94b17fa1 417 specified.\r
418\r
a405b86d 419 @param[in] FileHandle The file handle of the file for which information\r
420 is being set.\r
94b17fa1 421\r
a405b86d 422 @param[in] FileInfo The information to set.\r
94b17fa1 423\r
a405b86d 424 @retval EFI_SUCCESS The information was set.\r
425 @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.\r
426 @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.\r
427 @retval EFI_NO_MEDIA The device has no medium.\r
428 @retval EFI_DEVICE_ERROR The device reported an error.\r
94b17fa1 429 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
a405b86d 430 @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r
431 @retval EFI_ACCESS_DENIED The file was opened read only.\r
432 @retval EFI_VOLUME_FULL The volume is full.\r
94b17fa1 433**/\r
434EFI_STATUS\r
435EFIAPI\r
436ShellSetFileInfo (\r
a405b86d 437 IN SHELL_FILE_HANDLE FileHandle,\r
94b17fa1 438 IN EFI_FILE_INFO *FileInfo\r
a405b86d 439 )\r
440{\r
d2b4564b 441 return (FileFunctionMap.SetFileInfo(FileHandle, FileInfo));\r
1e6e84c7 442}\r
443\r
94b17fa1 444 /**\r
445 This function will open a file or directory referenced by DevicePath.\r
446\r
1e6e84c7 447 This function opens a file with the open mode according to the file path. The\r
94b17fa1 448 Attributes is valid only for EFI_FILE_MODE_CREATE.\r
449\r
1e6e84c7 450 @param FilePath on input the device path to the file. On output\r
94b17fa1 451 the remaining device path.\r
452 @param DeviceHandle pointer to the system device handle.\r
453 @param FileHandle pointer to the file handle.\r
454 @param OpenMode the mode to open the file with.\r
455 @param Attributes the file's file attributes.\r
456\r
457 @retval EFI_SUCCESS The information was set.\r
458 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
1e6e84c7 459 @retval EFI_UNSUPPORTED Could not open the file path.\r
460 @retval EFI_NOT_FOUND The specified file could not be found on the\r
461 device or the file system could not be found on\r
94b17fa1 462 the device.\r
463 @retval EFI_NO_MEDIA The device has no medium.\r
1e6e84c7 464 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r
94b17fa1 465 medium is no longer supported.\r
466 @retval EFI_DEVICE_ERROR The device reported an error.\r
467 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
468 @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r
a405b86d 469 @retval EFI_ACCESS_DENIED The file was opened read only.\r
1e6e84c7 470 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r
94b17fa1 471 file.\r
472 @retval EFI_VOLUME_FULL The volume is full.\r
473**/\r
474EFI_STATUS\r
475EFIAPI\r
476ShellOpenFileByDevicePath(\r
477 IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,\r
478 OUT EFI_HANDLE *DeviceHandle,\r
a405b86d 479 OUT SHELL_FILE_HANDLE *FileHandle,\r
94b17fa1 480 IN UINT64 OpenMode,\r
481 IN UINT64 Attributes\r
a405b86d 482 )\r
483{\r
484 CHAR16 *FileName;\r
485 EFI_STATUS Status;\r
94b17fa1 486 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *EfiSimpleFileSystemProtocol;\r
a405b86d 487 EFI_FILE_PROTOCOL *Handle1;\r
488 EFI_FILE_PROTOCOL *Handle2;\r
94b17fa1 489\r
92a5447e 490 if (FilePath == NULL || FileHandle == NULL || DeviceHandle == NULL) {\r
491 return (EFI_INVALID_PARAMETER);\r
492 }\r
493\r
1e6e84c7 494 //\r
94b17fa1 495 // which shell interface should we use\r
496 //\r
366f81a0 497 if (gEfiShellProtocol != NULL) {\r
94b17fa1 498 //\r
499 // use UEFI Shell 2.0 method.\r
500 //\r
366f81a0 501 FileName = gEfiShellProtocol->GetFilePathFromDevicePath(*FilePath);\r
94b17fa1 502 if (FileName == NULL) {\r
503 return (EFI_INVALID_PARAMETER);\r
504 }\r
505 Status = ShellOpenFileByName(FileName, FileHandle, OpenMode, Attributes);\r
506 FreePool(FileName);\r
507 return (Status);\r
1e6e84c7 508 }\r
d2b4564b 509\r
510\r
511 //\r
512 // use old shell method.\r
513 //\r
1e6e84c7 514 Status = gBS->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid,\r
515 FilePath,\r
d2b4564b 516 DeviceHandle);\r
517 if (EFI_ERROR (Status)) {\r
518 return Status;\r
519 }\r
520 Status = gBS->OpenProtocol(*DeviceHandle,\r
521 &gEfiSimpleFileSystemProtocolGuid,\r
b1f95a06 522 (VOID**)&EfiSimpleFileSystemProtocol,\r
d2b4564b 523 gImageHandle,\r
524 NULL,\r
525 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
526 if (EFI_ERROR (Status)) {\r
527 return Status;\r
528 }\r
a405b86d 529 Status = EfiSimpleFileSystemProtocol->OpenVolume(EfiSimpleFileSystemProtocol, &Handle1);\r
d2b4564b 530 if (EFI_ERROR (Status)) {\r
531 FileHandle = NULL;\r
532 return Status;\r
533 }\r
534\r
535 //\r
536 // go down directories one node at a time.\r
537 //\r
538 while (!IsDevicePathEnd (*FilePath)) {\r
94b17fa1 539 //\r
d2b4564b 540 // For file system access each node should be a file path component\r
94b17fa1 541 //\r
d2b4564b 542 if (DevicePathType (*FilePath) != MEDIA_DEVICE_PATH ||\r
543 DevicePathSubType (*FilePath) != MEDIA_FILEPATH_DP\r
a405b86d 544 ) {\r
94b17fa1 545 FileHandle = NULL;\r
d2b4564b 546 return (EFI_INVALID_PARAMETER);\r
94b17fa1 547 }\r
d2b4564b 548 //\r
549 // Open this file path node\r
550 //\r
a405b86d 551 Handle2 = Handle1;\r
552 Handle1 = NULL;\r
94b17fa1 553\r
554 //\r
d2b4564b 555 // Try to test opening an existing file\r
94b17fa1 556 //\r
a405b86d 557 Status = Handle2->Open (\r
558 Handle2,\r
559 &Handle1,\r
d2b4564b 560 ((FILEPATH_DEVICE_PATH*)*FilePath)->PathName,\r
561 OpenMode &~EFI_FILE_MODE_CREATE,\r
562 0\r
a405b86d 563 );\r
94b17fa1 564\r
d2b4564b 565 //\r
566 // see if the error was that it needs to be created\r
567 //\r
568 if ((EFI_ERROR (Status)) && (OpenMode != (OpenMode &~EFI_FILE_MODE_CREATE))) {\r
a405b86d 569 Status = Handle2->Open (\r
570 Handle2,\r
571 &Handle1,\r
94b17fa1 572 ((FILEPATH_DEVICE_PATH*)*FilePath)->PathName,\r
d2b4564b 573 OpenMode,\r
574 Attributes\r
a405b86d 575 );\r
d2b4564b 576 }\r
577 //\r
578 // Close the last node\r
579 //\r
a405b86d 580 Handle2->Close (Handle2);\r
94b17fa1 581\r
d2b4564b 582 if (EFI_ERROR(Status)) {\r
583 return (Status);\r
94b17fa1 584 }\r
d2b4564b 585\r
586 //\r
587 // Get the next node\r
588 //\r
589 *FilePath = NextDevicePathNode (*FilePath);\r
94b17fa1 590 }\r
a405b86d 591\r
592 //\r
593 // This is a weak spot since if the undefined SHELL_FILE_HANDLE format changes this must change also!\r
594 //\r
595 *FileHandle = (VOID*)Handle1;\r
d2b4564b 596 return (EFI_SUCCESS);\r
94b17fa1 597}\r
598\r
599/**\r
600 This function will open a file or directory referenced by filename.\r
601\r
1e6e84c7 602 If return is EFI_SUCCESS, the Filehandle is the opened file's handle;\r
603 otherwise, the Filehandle is NULL. The Attributes is valid only for\r
94b17fa1 604 EFI_FILE_MODE_CREATE.\r
605\r
92a5447e 606 if FileName is NULL then ASSERT()\r
94b17fa1 607\r
608 @param FileName pointer to file name\r
609 @param FileHandle pointer to the file handle.\r
610 @param OpenMode the mode to open the file with.\r
611 @param Attributes the file's file attributes.\r
612\r
613 @retval EFI_SUCCESS The information was set.\r
614 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
1e6e84c7 615 @retval EFI_UNSUPPORTED Could not open the file path.\r
616 @retval EFI_NOT_FOUND The specified file could not be found on the\r
617 device or the file system could not be found\r
94b17fa1 618 on the device.\r
619 @retval EFI_NO_MEDIA The device has no medium.\r
1e6e84c7 620 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r
94b17fa1 621 medium is no longer supported.\r
622 @retval EFI_DEVICE_ERROR The device reported an error.\r
623 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
624 @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r
625 @retval EFI_ACCESS_DENIED The file was opened read only.\r
1e6e84c7 626 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r
94b17fa1 627 file.\r
628 @retval EFI_VOLUME_FULL The volume is full.\r
629**/\r
630EFI_STATUS\r
631EFIAPI\r
632ShellOpenFileByName(\r
b82bfcc1 633 IN CONST CHAR16 *FileName,\r
a405b86d 634 OUT SHELL_FILE_HANDLE *FileHandle,\r
94b17fa1 635 IN UINT64 OpenMode,\r
636 IN UINT64 Attributes\r
a405b86d 637 )\r
638{\r
94b17fa1 639 EFI_HANDLE DeviceHandle;\r
640 EFI_DEVICE_PATH_PROTOCOL *FilePath;\r
b1f95a06 641 EFI_STATUS Status;\r
642 EFI_FILE_INFO *FileInfo;\r
94b17fa1 643\r
644 //\r
645 // ASSERT if FileName is NULL\r
646 //\r
647 ASSERT(FileName != NULL);\r
648\r
a405b86d 649 if (FileName == NULL) {\r
650 return (EFI_INVALID_PARAMETER);\r
651 }\r
652\r
366f81a0 653 if (gEfiShellProtocol != NULL) {\r
a405b86d 654 if ((OpenMode & EFI_FILE_MODE_CREATE) == EFI_FILE_MODE_CREATE && (Attributes & EFI_FILE_DIRECTORY) == EFI_FILE_DIRECTORY) {\r
655 return ShellCreateDirectory(FileName, FileHandle);\r
656 }\r
94b17fa1 657 //\r
658 // Use UEFI Shell 2.0 method\r
659 //\r
366f81a0 660 Status = gEfiShellProtocol->OpenFileByName(FileName,\r
b1f95a06 661 FileHandle,\r
662 OpenMode);\r
a405b86d 663 if (StrCmp(FileName, L"NUL") != 0 && !EFI_ERROR(Status) && ((OpenMode & EFI_FILE_MODE_CREATE) != 0)){\r
2247dde4 664 FileInfo = FileFunctionMap.GetFileInfo(*FileHandle);\r
b1f95a06 665 ASSERT(FileInfo != NULL);\r
666 FileInfo->Attribute = Attributes;\r
2247dde4 667 Status = FileFunctionMap.SetFileInfo(*FileHandle, FileInfo);\r
668 FreePool(FileInfo);\r
b1f95a06 669 }\r
670 return (Status);\r
1e6e84c7 671 }\r
94b17fa1 672 //\r
673 // Using EFI Shell version\r
674 // this means convert name to path and call that function\r
675 // since this will use EFI method again that will open it.\r
676 //\r
677 ASSERT(mEfiShellEnvironment2 != NULL);\r
b82bfcc1 678 FilePath = mEfiShellEnvironment2->NameToPath ((CHAR16*)FileName);\r
90bfa227 679 if (FilePath != NULL) {\r
94b17fa1 680 return (ShellOpenFileByDevicePath(&FilePath,\r
681 &DeviceHandle,\r
682 FileHandle,\r
683 OpenMode,\r
a405b86d 684 Attributes));\r
94b17fa1 685 }\r
686 return (EFI_DEVICE_ERROR);\r
687}\r
688/**\r
689 This function create a directory\r
690\r
1e6e84c7 691 If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;\r
692 otherwise, the Filehandle is NULL. If the directory already existed, this\r
94b17fa1 693 function opens the existing directory.\r
694\r
695 @param DirectoryName pointer to directory name\r
696 @param FileHandle pointer to the file handle.\r
697\r
698 @retval EFI_SUCCESS The information was set.\r
699 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
1e6e84c7 700 @retval EFI_UNSUPPORTED Could not open the file path.\r
701 @retval EFI_NOT_FOUND The specified file could not be found on the\r
702 device or the file system could not be found\r
94b17fa1 703 on the device.\r
704 @retval EFI_NO_MEDIA The device has no medium.\r
1e6e84c7 705 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r
94b17fa1 706 medium is no longer supported.\r
707 @retval EFI_DEVICE_ERROR The device reported an error.\r
708 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
709 @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r
710 @retval EFI_ACCESS_DENIED The file was opened read only.\r
1e6e84c7 711 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r
94b17fa1 712 file.\r
713 @retval EFI_VOLUME_FULL The volume is full.\r
714 @sa ShellOpenFileByName\r
715**/\r
716EFI_STATUS\r
717EFIAPI\r
718ShellCreateDirectory(\r
b82bfcc1 719 IN CONST CHAR16 *DirectoryName,\r
a405b86d 720 OUT SHELL_FILE_HANDLE *FileHandle\r
721 )\r
722{\r
366f81a0 723 if (gEfiShellProtocol != NULL) {\r
2247dde4 724 //\r
725 // Use UEFI Shell 2.0 method\r
726 //\r
366f81a0 727 return (gEfiShellProtocol->CreateFile(DirectoryName,\r
2247dde4 728 EFI_FILE_DIRECTORY,\r
729 FileHandle\r
a405b86d 730 ));\r
2247dde4 731 } else {\r
732 return (ShellOpenFileByName(DirectoryName,\r
733 FileHandle,\r
734 EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE | EFI_FILE_MODE_CREATE,\r
735 EFI_FILE_DIRECTORY\r
a405b86d 736 ));\r
2247dde4 737 }\r
94b17fa1 738}\r
739\r
740/**\r
741 This function reads information from an opened file.\r
742\r
1e6e84c7 743 If FileHandle is not a directory, the function reads the requested number of\r
744 bytes from the file at the file's current position and returns them in Buffer.\r
94b17fa1 745 If the read goes beyond the end of the file, the read length is truncated to the\r
1e6e84c7 746 end of the file. The file's current position is increased by the number of bytes\r
747 returned. If FileHandle is a directory, the function reads the directory entry\r
748 at the file's current position and returns the entry in Buffer. If the Buffer\r
749 is not large enough to hold the current directory entry, then\r
750 EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.\r
751 BufferSize is set to be the size of the buffer needed to read the entry. On\r
752 success, the current position is updated to the next directory entry. If there\r
753 are no more directory entries, the read returns a zero-length buffer.\r
94b17fa1 754 EFI_FILE_INFO is the structure returned as the directory entry.\r
755\r
756 @param FileHandle the opened file handle\r
1e6e84c7 757 @param BufferSize on input the size of buffer in bytes. on return\r
94b17fa1 758 the number of bytes written.\r
759 @param Buffer the buffer to put read data into.\r
760\r
761 @retval EFI_SUCCESS Data was read.\r
762 @retval EFI_NO_MEDIA The device has no media.\r
763 @retval EFI_DEVICE_ERROR The device reported an error.\r
764 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
1e6e84c7 765 @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required\r
94b17fa1 766 size.\r
767\r
768**/\r
769EFI_STATUS\r
770EFIAPI\r
771ShellReadFile(\r
a405b86d 772 IN SHELL_FILE_HANDLE FileHandle,\r
94b17fa1 773 IN OUT UINTN *BufferSize,\r
774 OUT VOID *Buffer\r
a405b86d 775 )\r
776{\r
d2b4564b 777 return (FileFunctionMap.ReadFile(FileHandle, BufferSize, Buffer));\r
94b17fa1 778}\r
779\r
780\r
781/**\r
782 Write data to a file.\r
783\r
1e6e84c7 784 This function writes the specified number of bytes to the file at the current\r
785 file position. The current file position is advanced the actual number of bytes\r
786 written, which is returned in BufferSize. Partial writes only occur when there\r
787 has been a data error during the write attempt (such as "volume space full").\r
788 The file is automatically grown to hold the data if required. Direct writes to\r
94b17fa1 789 opened directories are not supported.\r
790\r
791 @param FileHandle The opened file for writing\r
792 @param BufferSize on input the number of bytes in Buffer. On output\r
793 the number of bytes written.\r
794 @param Buffer the buffer containing data to write is stored.\r
795\r
796 @retval EFI_SUCCESS Data was written.\r
797 @retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r
798 @retval EFI_NO_MEDIA The device has no media.\r
799 @retval EFI_DEVICE_ERROR The device reported an error.\r
800 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
801 @retval EFI_WRITE_PROTECTED The device is write-protected.\r
802 @retval EFI_ACCESS_DENIED The file was open for read only.\r
803 @retval EFI_VOLUME_FULL The volume is full.\r
804**/\r
805EFI_STATUS\r
806EFIAPI\r
807ShellWriteFile(\r
252d9457 808 IN SHELL_FILE_HANDLE FileHandle,\r
94b17fa1 809 IN OUT UINTN *BufferSize,\r
810 IN VOID *Buffer\r
a405b86d 811 )\r
812{\r
d2b4564b 813 return (FileFunctionMap.WriteFile(FileHandle, BufferSize, Buffer));\r
94b17fa1 814}\r
815\r
1e6e84c7 816/**\r
94b17fa1 817 Close an open file handle.\r
818\r
1e6e84c7 819 This function closes a specified file handle. All "dirty" cached file data is\r
820 flushed to the device, and the file is closed. In all cases the handle is\r
94b17fa1 821 closed.\r
822\r
823@param FileHandle the file handle to close.\r
824\r
825@retval EFI_SUCCESS the file handle was closed sucessfully.\r
826**/\r
827EFI_STATUS\r
828EFIAPI\r
829ShellCloseFile (\r
a405b86d 830 IN SHELL_FILE_HANDLE *FileHandle\r
831 )\r
832{\r
d2b4564b 833 return (FileFunctionMap.CloseFile(*FileHandle));\r
94b17fa1 834}\r
835\r
836/**\r
837 Delete a file and close the handle\r
838\r
839 This function closes and deletes a file. In all cases the file handle is closed.\r
1e6e84c7 840 If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is\r
94b17fa1 841 returned, but the handle is still closed.\r
842\r
843 @param FileHandle the file handle to delete\r
844\r
845 @retval EFI_SUCCESS the file was closed sucessfully\r
1e6e84c7 846 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not\r
94b17fa1 847 deleted\r
848 @retval INVALID_PARAMETER One of the parameters has an invalid value.\r
849**/\r
850EFI_STATUS\r
851EFIAPI\r
852ShellDeleteFile (\r
a405b86d 853 IN SHELL_FILE_HANDLE *FileHandle\r
854 )\r
855{\r
d2b4564b 856 return (FileFunctionMap.DeleteFile(*FileHandle));\r
94b17fa1 857}\r
858\r
859/**\r
860 Set the current position in a file.\r
861\r
1e6e84c7 862 This function sets the current file position for the handle to the position\r
94b17fa1 863 supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only\r
1e6e84c7 864 absolute positioning is supported, and seeking past the end of the file is\r
865 allowed (a subsequent write would grow the file). Seeking to position\r
94b17fa1 866 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.\r
1e6e84c7 867 If FileHandle is a directory, the only position that may be set is zero. This\r
94b17fa1 868 has the effect of starting the read process of the directory entries over.\r
869\r
870 @param FileHandle The file handle on which the position is being set\r
871 @param Position Byte position from begining of file\r
872\r
873 @retval EFI_SUCCESS Operation completed sucessfully.\r
1e6e84c7 874 @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on\r
94b17fa1 875 directories.\r
876 @retval INVALID_PARAMETER One of the parameters has an invalid value.\r
877**/\r
878EFI_STATUS\r
879EFIAPI\r
880ShellSetFilePosition (\r
a405b86d 881 IN SHELL_FILE_HANDLE FileHandle,\r
94b17fa1 882 IN UINT64 Position\r
a405b86d 883 )\r
884{\r
d2b4564b 885 return (FileFunctionMap.SetFilePosition(FileHandle, Position));\r
94b17fa1 886}\r
887\r
1e6e84c7 888/**\r
94b17fa1 889 Gets a file's current position\r
890\r
1e6e84c7 891 This function retrieves the current file position for the file handle. For\r
892 directories, the current file position has no meaning outside of the file\r
94b17fa1 893 system driver and as such the operation is not supported. An error is returned\r
894 if FileHandle is a directory.\r
895\r
896 @param FileHandle The open file handle on which to get the position.\r
897 @param Position Byte position from begining of file.\r
898\r
899 @retval EFI_SUCCESS the operation completed sucessfully.\r
900 @retval INVALID_PARAMETER One of the parameters has an invalid value.\r
901 @retval EFI_UNSUPPORTED the request is not valid on directories.\r
902**/\r
903EFI_STATUS\r
904EFIAPI\r
905ShellGetFilePosition (\r
a405b86d 906 IN SHELL_FILE_HANDLE FileHandle,\r
94b17fa1 907 OUT UINT64 *Position\r
a405b86d 908 )\r
909{\r
d2b4564b 910 return (FileFunctionMap.GetFilePosition(FileHandle, Position));\r
94b17fa1 911}\r
912/**\r
913 Flushes data on a file\r
1e6e84c7 914\r
94b17fa1 915 This function flushes all modified data associated with a file to a device.\r
916\r
917 @param FileHandle The file handle on which to flush data\r
918\r
919 @retval EFI_SUCCESS The data was flushed.\r
920 @retval EFI_NO_MEDIA The device has no media.\r
921 @retval EFI_DEVICE_ERROR The device reported an error.\r
922 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
923 @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r
924 @retval EFI_ACCESS_DENIED The file was opened for read only.\r
925**/\r
926EFI_STATUS\r
927EFIAPI\r
928ShellFlushFile (\r
a405b86d 929 IN SHELL_FILE_HANDLE FileHandle\r
930 )\r
931{\r
d2b4564b 932 return (FileFunctionMap.FlushFile(FileHandle));\r
94b17fa1 933}\r
934\r
935/**\r
936 Retrieves the first file from a directory\r
937\r
1e6e84c7 938 This function opens a directory and gets the first file's info in the\r
939 directory. Caller can use ShellFindNextFile() to get other files. When\r
94b17fa1 940 complete the caller is responsible for calling FreePool() on Buffer.\r
941\r
942 @param DirHandle The file handle of the directory to search\r
943 @param Buffer Pointer to buffer for file's information\r
944\r
945 @retval EFI_SUCCESS Found the first file.\r
946 @retval EFI_NOT_FOUND Cannot find the directory.\r
947 @retval EFI_NO_MEDIA The device has no media.\r
948 @retval EFI_DEVICE_ERROR The device reported an error.\r
949 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
950 @return Others status of ShellGetFileInfo, ShellSetFilePosition,\r
951 or ShellReadFile\r
952**/\r
953EFI_STATUS\r
954EFIAPI\r
955ShellFindFirstFile (\r
a405b86d 956 IN SHELL_FILE_HANDLE DirHandle,\r
d2b4564b 957 OUT EFI_FILE_INFO **Buffer\r
a405b86d 958 )\r
959{\r
94b17fa1 960 //\r
d2b4564b 961 // pass to file handle lib\r
94b17fa1 962 //\r
d2b4564b 963 return (FileHandleFindFirstFile(DirHandle, Buffer));\r
94b17fa1 964}\r
965/**\r
966 Retrieves the next file in a directory.\r
967\r
a405b86d 968 To use this function, caller must call the ShellFindFirstFile() to get the\r
1e6e84c7 969 first file, and then use this function get other files. This function can be\r
970 called for several times to get each file's information in the directory. If\r
971 the call of ShellFindNextFile() got the last file in the directory, the next\r
972 call of this function has no file to get. *NoFile will be set to TRUE and the\r
973 Buffer memory will be automatically freed.\r
94b17fa1 974\r
975 @param DirHandle the file handle of the directory\r
976 @param Buffer pointer to buffer for file's information\r
977 @param NoFile pointer to boolean when last file is found\r
978\r
979 @retval EFI_SUCCESS Found the next file, or reached last file\r
980 @retval EFI_NO_MEDIA The device has no media.\r
981 @retval EFI_DEVICE_ERROR The device reported an error.\r
982 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
983**/\r
984EFI_STATUS\r
985EFIAPI\r
986ShellFindNextFile(\r
a405b86d 987 IN SHELL_FILE_HANDLE DirHandle,\r
94b17fa1 988 OUT EFI_FILE_INFO *Buffer,\r
989 OUT BOOLEAN *NoFile\r
a405b86d 990 )\r
991{\r
94b17fa1 992 //\r
d2b4564b 993 // pass to file handle lib\r
94b17fa1 994 //\r
d2b4564b 995 return (FileHandleFindNextFile(DirHandle, Buffer, NoFile));\r
94b17fa1 996}\r
997/**\r
998 Retrieve the size of a file.\r
999\r
1000 if FileHandle is NULL then ASSERT()\r
1001 if Size is NULL then ASSERT()\r
1002\r
1e6e84c7 1003 This function extracts the file size info from the FileHandle's EFI_FILE_INFO\r
94b17fa1 1004 data.\r
1005\r
1006 @param FileHandle file handle from which size is retrieved\r
1007 @param Size pointer to size\r
1008\r
1009 @retval EFI_SUCCESS operation was completed sucessfully\r
1010 @retval EFI_DEVICE_ERROR cannot access the file\r
1011**/\r
1012EFI_STATUS\r
1013EFIAPI\r
1014ShellGetFileSize (\r
a405b86d 1015 IN SHELL_FILE_HANDLE FileHandle,\r
94b17fa1 1016 OUT UINT64 *Size\r
a405b86d 1017 )\r
1018{\r
d2b4564b 1019 return (FileFunctionMap.GetFileSize(FileHandle, Size));\r
94b17fa1 1020}\r
1021/**\r
1022 Retrieves the status of the break execution flag\r
1023\r
1024 this function is useful to check whether the application is being asked to halt by the shell.\r
1025\r
1026 @retval TRUE the execution break is enabled\r
1027 @retval FALSE the execution break is not enabled\r
1028**/\r
1029BOOLEAN\r
1030EFIAPI\r
1031ShellGetExecutionBreakFlag(\r
1032 VOID\r
1033 )\r
1034{\r
1e6e84c7 1035 //\r
94b17fa1 1036 // Check for UEFI Shell 2.0 protocols\r
1037 //\r
366f81a0 1038 if (gEfiShellProtocol != NULL) {\r
94b17fa1 1039\r
1040 //\r
1041 // We are using UEFI Shell 2.0; see if the event has been triggered\r
1042 //\r
366f81a0 1043 if (gBS->CheckEvent(gEfiShellProtocol->ExecutionBreak) != EFI_SUCCESS) {\r
94b17fa1 1044 return (FALSE);\r
1045 }\r
1046 return (TRUE);\r
1e6e84c7 1047 }\r
94b17fa1 1048\r
1049 //\r
1050 // using EFI Shell; call the function to check\r
1051 //\r
92a5447e 1052 if (mEfiShellEnvironment2 != NULL) {\r
1053 return (mEfiShellEnvironment2->GetExecutionBreak());\r
1054 }\r
1055\r
1056 return (FALSE);\r
94b17fa1 1057}\r
1058/**\r
1059 return the value of an environment variable\r
1060\r
1e6e84c7 1061 this function gets the value of the environment variable set by the\r
94b17fa1 1062 ShellSetEnvironmentVariable function\r
1063\r
1064 @param EnvKey The key name of the environment variable.\r
1065\r
1066 @retval NULL the named environment variable does not exist.\r
1067 @return != NULL pointer to the value of the environment variable\r
1068**/\r
1069CONST CHAR16*\r
1070EFIAPI\r
1071ShellGetEnvironmentVariable (\r
9b3bf083 1072 IN CONST CHAR16 *EnvKey\r
94b17fa1 1073 )\r
1074{\r
1e6e84c7 1075 //\r
94b17fa1 1076 // Check for UEFI Shell 2.0 protocols\r
1077 //\r
366f81a0 1078 if (gEfiShellProtocol != NULL) {\r
1079 return (gEfiShellProtocol->GetEnv(EnvKey));\r
94b17fa1 1080 }\r
1081\r
1082 //\r
92a5447e 1083 // Check for EFI shell\r
94b17fa1 1084 //\r
92a5447e 1085 if (mEfiShellEnvironment2 != NULL) {\r
1086 return (mEfiShellEnvironment2->GetEnv((CHAR16*)EnvKey));\r
1087 }\r
94b17fa1 1088\r
92a5447e 1089 return NULL;\r
94b17fa1 1090}\r
1091/**\r
1092 set the value of an environment variable\r
1093\r
1094This function changes the current value of the specified environment variable. If the\r
1095environment variable exists and the Value is an empty string, then the environment\r
1096variable is deleted. If the environment variable exists and the Value is not an empty\r
1097string, then the value of the environment variable is changed. If the environment\r
1098variable does not exist and the Value is an empty string, there is no action. If the\r
1099environment variable does not exist and the Value is a non-empty string, then the\r
1100environment variable is created and assigned the specified value.\r
1101\r
1102 This is not supported pre-UEFI Shell 2.0.\r
1103\r
1104 @param EnvKey The key name of the environment variable.\r
1105 @param EnvVal The Value of the environment variable\r
1106 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r
1107\r
1108 @retval EFI_SUCCESS the operation was completed sucessfully\r
1109 @retval EFI_UNSUPPORTED This operation is not allowed in pre UEFI 2.0 Shell environments\r
1110**/\r
1111EFI_STATUS\r
1112EFIAPI\r
1113ShellSetEnvironmentVariable (\r
1114 IN CONST CHAR16 *EnvKey,\r
1115 IN CONST CHAR16 *EnvVal,\r
1116 IN BOOLEAN Volatile\r
1117 )\r
1118{\r
1e6e84c7 1119 //\r
94b17fa1 1120 // Check for UEFI Shell 2.0 protocols\r
1121 //\r
366f81a0 1122 if (gEfiShellProtocol != NULL) {\r
1123 return (gEfiShellProtocol->SetEnv(EnvKey, EnvVal, Volatile));\r
1e6e84c7 1124 }\r
94b17fa1 1125\r
1126 //\r
1127 // This feature does not exist under EFI shell\r
1128 //\r
1129 return (EFI_UNSUPPORTED);\r
1130}\r
a405b86d 1131\r
94b17fa1 1132/**\r
a405b86d 1133 Cause the shell to parse and execute a command line.\r
94b17fa1 1134\r
1135 This function creates a nested instance of the shell and executes the specified\r
a405b86d 1136 command (CommandLine) with the specified environment (Environment). Upon return,\r
1137 the status code returned by the specified command is placed in StatusCode.\r
1138 If Environment is NULL, then the current environment is used and all changes made\r
1139 by the commands executed will be reflected in the current environment. If the\r
1140 Environment is non-NULL, then the changes made will be discarded.\r
1141 The CommandLine is executed from the current working directory on the current\r
1142 device.\r
1143\r
1144 The EnvironmentVariables and Status parameters are ignored in a pre-UEFI Shell 2.0\r
1145 environment. The values pointed to by the parameters will be unchanged by the\r
1146 ShellExecute() function. The Output parameter has no effect in a\r
1147 UEFI Shell 2.0 environment.\r
1148\r
1149 @param[in] ParentHandle The parent image starting the operation.\r
1150 @param[in] CommandLine The pointer to a NULL terminated command line.\r
1151 @param[in] Output True to display debug output. False to hide it.\r
1152 @param[in] EnvironmentVariables Optional pointer to array of environment variables\r
1153 in the form "x=y". If NULL, the current set is used.\r
1154 @param[out] Status The status of the run command line.\r
1155\r
1156 @retval EFI_SUCCESS The operation completed sucessfully. Status\r
1157 contains the status code returned.\r
1158 @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.\r
1159 @retval EFI_OUT_OF_RESOURCES Out of resources.\r
1160 @retval EFI_UNSUPPORTED The operation is not allowed.\r
94b17fa1 1161**/\r
1162EFI_STATUS\r
1163EFIAPI\r
1164ShellExecute (\r
1165 IN EFI_HANDLE *ParentHandle,\r
1166 IN CHAR16 *CommandLine OPTIONAL,\r
1167 IN BOOLEAN Output OPTIONAL,\r
1168 IN CHAR16 **EnvironmentVariables OPTIONAL,\r
1169 OUT EFI_STATUS *Status OPTIONAL\r
1170 )\r
1171{\r
1e6e84c7 1172 //\r
94b17fa1 1173 // Check for UEFI Shell 2.0 protocols\r
1174 //\r
366f81a0 1175 if (gEfiShellProtocol != NULL) {\r
94b17fa1 1176 //\r
1177 // Call UEFI Shell 2.0 version (not using Output parameter)\r
1178 //\r
366f81a0 1179 return (gEfiShellProtocol->Execute(ParentHandle,\r
94b17fa1 1180 CommandLine,\r
1181 EnvironmentVariables,\r
1182 Status));\r
1e6e84c7 1183 }\r
92a5447e 1184\r
94b17fa1 1185 //\r
92a5447e 1186 // Check for EFI shell\r
94b17fa1 1187 //\r
92a5447e 1188 if (mEfiShellEnvironment2 != NULL) {\r
1189 //\r
1190 // Call EFI Shell version (not using EnvironmentVariables or Status parameters)\r
1191 // Due to oddity in the EFI shell we want to dereference the ParentHandle here\r
1192 //\r
1193 return (mEfiShellEnvironment2->Execute(*ParentHandle,\r
1194 CommandLine,\r
1195 Output));\r
1196 }\r
1197\r
1198 return (EFI_UNSUPPORTED);\r
94b17fa1 1199}\r
1200/**\r
1201 Retreives the current directory path\r
1202\r
1e6e84c7 1203 If the DeviceName is NULL, it returns the current device's current directory\r
1204 name. If the DeviceName is not NULL, it returns the current directory name\r
94b17fa1 1205 on specified drive.\r
1206\r
1207 @param DeviceName the name of the drive to get directory on\r
1208\r
1209 @retval NULL the directory does not exist\r
1210 @return != NULL the directory\r
1211**/\r
1212CONST CHAR16*\r
1213EFIAPI\r
1214ShellGetCurrentDir (\r
a405b86d 1215 IN CHAR16 * CONST DeviceName OPTIONAL\r
94b17fa1 1216 )\r
1217{\r
1e6e84c7 1218 //\r
94b17fa1 1219 // Check for UEFI Shell 2.0 protocols\r
1220 //\r
366f81a0 1221 if (gEfiShellProtocol != NULL) {\r
1222 return (gEfiShellProtocol->GetCurDir(DeviceName));\r
1e6e84c7 1223 }\r
92a5447e 1224\r
94b17fa1 1225 //\r
8bd282be 1226 // Check for EFI shell\r
94b17fa1 1227 //\r
8bd282be 1228 if (mEfiShellEnvironment2 != NULL) {\r
1229 return (mEfiShellEnvironment2->CurDir(DeviceName));\r
1230 }\r
1231\r
1232 return (NULL);\r
94b17fa1 1233}\r
1234/**\r
1235 sets (enabled or disabled) the page break mode\r
1236\r
1e6e84c7 1237 when page break mode is enabled the screen will stop scrolling\r
94b17fa1 1238 and wait for operator input before scrolling a subsequent screen.\r
1239\r
1240 @param CurrentState TRUE to enable and FALSE to disable\r
1241**/\r
1e6e84c7 1242VOID\r
94b17fa1 1243EFIAPI\r
1244ShellSetPageBreakMode (\r
1245 IN BOOLEAN CurrentState\r
1246 )\r
1247{\r
1248 //\r
1249 // check for enabling\r
1250 //\r
1251 if (CurrentState != 0x00) {\r
1e6e84c7 1252 //\r
94b17fa1 1253 // check for UEFI Shell 2.0\r
1254 //\r
366f81a0 1255 if (gEfiShellProtocol != NULL) {\r
94b17fa1 1256 //\r
1257 // Enable with UEFI 2.0 Shell\r
1258 //\r
366f81a0 1259 gEfiShellProtocol->EnablePageBreak();\r
94b17fa1 1260 return;\r
1261 } else {\r
1e6e84c7 1262 //\r
92a5447e 1263 // Check for EFI shell\r
94b17fa1 1264 //\r
92a5447e 1265 if (mEfiShellEnvironment2 != NULL) {\r
1266 //\r
1267 // Enable with EFI Shell\r
1268 //\r
1269 mEfiShellEnvironment2->EnablePageBreak (DEFAULT_INIT_ROW, DEFAULT_AUTO_LF);\r
1270 return;\r
1271 }\r
94b17fa1 1272 }\r
1273 } else {\r
1e6e84c7 1274 //\r
94b17fa1 1275 // check for UEFI Shell 2.0\r
1276 //\r
366f81a0 1277 if (gEfiShellProtocol != NULL) {\r
94b17fa1 1278 //\r
1279 // Disable with UEFI 2.0 Shell\r
1280 //\r
366f81a0 1281 gEfiShellProtocol->DisablePageBreak();\r
94b17fa1 1282 return;\r
1283 } else {\r
1e6e84c7 1284 //\r
92a5447e 1285 // Check for EFI shell\r
94b17fa1 1286 //\r
92a5447e 1287 if (mEfiShellEnvironment2 != NULL) {\r
1288 //\r
1289 // Disable with EFI Shell\r
1290 //\r
1291 mEfiShellEnvironment2->DisablePageBreak ();\r
1292 return;\r
1293 }\r
94b17fa1 1294 }\r
1295 }\r
1296}\r
1297\r
1298///\r
1299/// version of EFI_SHELL_FILE_INFO struct, except has no CONST pointers.\r
1300/// This allows for the struct to be populated.\r
1301///\r
1302typedef struct {\r
d2b4564b 1303 LIST_ENTRY Link;\r
94b17fa1 1304 EFI_STATUS Status;\r
1305 CHAR16 *FullName;\r
1306 CHAR16 *FileName;\r
a405b86d 1307 SHELL_FILE_HANDLE Handle;\r
94b17fa1 1308 EFI_FILE_INFO *Info;\r
1309} EFI_SHELL_FILE_INFO_NO_CONST;\r
1310\r
1311/**\r
1312 Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.\r
1313\r
1314 if OldStyleFileList is NULL then ASSERT()\r
1315\r
1e6e84c7 1316 this function will convert a SHELL_FILE_ARG based list into a callee allocated\r
94b17fa1 1317 EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via\r
1318 the ShellCloseFileMetaArg function.\r
1319\r
4ff7e37b
ED		 1320 @param[in] FileList the EFI shell list type\r
1321 @param[in, out] ListHead the list to add to\r
94b17fa1 1322\r
1323 @retval the resultant head of the double linked new format list;\r
1324**/\r
1325LIST_ENTRY*\r
1326EFIAPI\r
1327InternalShellConvertFileListType (\r
9b3bf083 1328 IN LIST_ENTRY *FileList,\r
1329 IN OUT LIST_ENTRY *ListHead\r
125c2cf4 1330 )\r
1331{\r
94b17fa1 1332 SHELL_FILE_ARG *OldInfo;\r
9b3bf083 1333 LIST_ENTRY *Link;\r
94b17fa1 1334 EFI_SHELL_FILE_INFO_NO_CONST *NewInfo;\r
1335\r
1336 //\r
9b3bf083 1337 // ASSERTs\r
94b17fa1 1338 //\r
9b3bf083 1339 ASSERT(FileList != NULL);\r
1340 ASSERT(ListHead != NULL);\r
94b17fa1 1341\r
1342 //\r
1343 // enumerate through each member of the old list and copy\r
1344 //\r
d2b4564b 1345 for (Link = FileList->ForwardLink; Link != FileList; Link = Link->ForwardLink) {\r
94b17fa1 1346 OldInfo = CR (Link, SHELL_FILE_ARG, Link, SHELL_FILE_ARG_SIGNATURE);\r
a405b86d 1347 ASSERT(OldInfo != NULL);\r
1348\r
1349 //\r
1350 // Skip ones that failed to open...\r
1351 //\r
1352 if (OldInfo->Status != EFI_SUCCESS) {\r
1353 continue;\r
1354 }\r
94b17fa1 1355\r
1356 //\r
1357 // make sure the old list was valid\r
1358 //\r
94b17fa1 1359 ASSERT(OldInfo->Info != NULL);\r
1360 ASSERT(OldInfo->FullName != NULL);\r
1361 ASSERT(OldInfo->FileName != NULL);\r
1362\r
1363 //\r
1364 // allocate a new EFI_SHELL_FILE_INFO object\r
1365 //\r
1366 NewInfo = AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r
c9d92df0 1367 if (NewInfo == NULL) {\r
beab0fc5 1368 ShellCloseFileMetaArg(&(EFI_SHELL_FILE_INFO*)ListHead);\r
1369 ListHead = NULL;\r
c9d92df0 1370 break;\r
1371 }\r
1e6e84c7 1372\r
1373 //\r
94b17fa1 1374 // copy the simple items\r
1375 //\r
1376 NewInfo->Handle = OldInfo->Handle;\r
1377 NewInfo->Status = OldInfo->Status;\r
1378\r
d2b4564b 1379 // old shell checks for 0 not NULL\r
1380 OldInfo->Handle = 0;\r
1381\r
94b17fa1 1382 //\r
1383 // allocate new space to copy strings and structure\r
1384 //\r
1385 NewInfo->FullName = AllocateZeroPool(StrSize(OldInfo->FullName));\r
1386 NewInfo->FileName = AllocateZeroPool(StrSize(OldInfo->FileName));\r
1387 NewInfo->Info = AllocateZeroPool((UINTN)OldInfo->Info->Size);\r
1e6e84c7 1388\r
94b17fa1 1389 //\r
1390 // make sure all the memory allocations were sucessful\r
1391 //\r
beab0fc5 1392 if (NULL == NewInfo->FullName || NewInfo->FileName == NULL || NewInfo->Info == NULL) {\r
1393 ShellCloseFileMetaArg(&(EFI_SHELL_FILE_INFO*)ListHead);\r
1394 ListHead = NULL;\r
1395 break;\r
1396 }\r
94b17fa1 1397\r
1398 //\r
1399 // Copt the strings and structure\r
1400 //\r
1401 StrCpy(NewInfo->FullName, OldInfo->FullName);\r
1402 StrCpy(NewInfo->FileName, OldInfo->FileName);\r
1403 gBS->CopyMem (NewInfo->Info, OldInfo->Info, (UINTN)OldInfo->Info->Size);\r
1404\r
1405 //\r
1406 // add that to the list\r
1407 //\r
9b3bf083 1408 InsertTailList(ListHead, &NewInfo->Link);\r
94b17fa1 1409 }\r
1410 return (ListHead);\r
1411}\r
1412/**\r
1413 Opens a group of files based on a path.\r
1414\r
1e6e84c7 1415 This function uses the Arg to open all the matching files. Each matched\r
1416 file has a SHELL_FILE_ARG structure to record the file information. These\r
1417 structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG\r
94b17fa1 1418 structures from ListHead to access each file. This function supports wildcards\r
1e6e84c7 1419 and will process '?' and '*' as such. the list must be freed with a call to\r
94b17fa1 1420 ShellCloseFileMetaArg().\r
1421\r
1e6e84c7 1422 If you are NOT appending to an existing list *ListHead must be NULL. If\r
5f7431d0 1423 *ListHead is NULL then it must be callee freed.\r
94b17fa1 1424\r
1425 @param Arg pointer to path string\r
1426 @param OpenMode mode to open files with\r
1427 @param ListHead head of linked list of results\r
1428\r
1e6e84c7 1429 @retval EFI_SUCCESS the operation was sucessful and the list head\r
94b17fa1 1430 contains the list of opened files\r
94b17fa1 1431 @return != EFI_SUCCESS the operation failed\r
1432\r
1433 @sa InternalShellConvertFileListType\r
1434**/\r
1435EFI_STATUS\r
1436EFIAPI\r
1437ShellOpenFileMetaArg (\r
1438 IN CHAR16 *Arg,\r
1439 IN UINT64 OpenMode,\r
1440 IN OUT EFI_SHELL_FILE_INFO **ListHead\r
1441 )\r
1442{\r
1443 EFI_STATUS Status;\r
9b3bf083 1444 LIST_ENTRY mOldStyleFileList;\r
1e6e84c7 1445\r
94b17fa1 1446 //\r
1447 // ASSERT that Arg and ListHead are not NULL\r
1448 //\r
1449 ASSERT(Arg != NULL);\r
1450 ASSERT(ListHead != NULL);\r
1451\r
1e6e84c7 1452 //\r
94b17fa1 1453 // Check for UEFI Shell 2.0 protocols\r
1454 //\r
366f81a0 1455 if (gEfiShellProtocol != NULL) {\r
5f7431d0 1456 if (*ListHead == NULL) {\r
1457 *ListHead = (EFI_SHELL_FILE_INFO*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r
1458 if (*ListHead == NULL) {\r
1459 return (EFI_OUT_OF_RESOURCES);\r
1460 }\r
1461 InitializeListHead(&((*ListHead)->Link));\r
1e6e84c7 1462 }\r
366f81a0 1463 Status = gEfiShellProtocol->OpenFileList(Arg,\r
1e6e84c7 1464 OpenMode,\r
2247dde4 1465 ListHead);\r
1466 if (EFI_ERROR(Status)) {\r
366f81a0 1467 gEfiShellProtocol->RemoveDupInFileList(ListHead);\r
2247dde4 1468 } else {\r
366f81a0 1469 Status = gEfiShellProtocol->RemoveDupInFileList(ListHead);\r
2247dde4 1470 }\r
a405b86d 1471 if (*ListHead != NULL && IsListEmpty(&(*ListHead)->Link)) {\r
1472 FreePool(*ListHead);\r
1473 *ListHead = NULL;\r
1474 return (EFI_NOT_FOUND);\r
1475 }\r
2247dde4 1476 return (Status);\r
1e6e84c7 1477 }\r
94b17fa1 1478\r
1479 //\r
92a5447e 1480 // Check for EFI shell\r
94b17fa1 1481 //\r
92a5447e 1482 if (mEfiShellEnvironment2 != NULL) {\r
1483 //\r
1484 // make sure the list head is initialized\r
1485 //\r
1486 InitializeListHead(&mOldStyleFileList);\r
94b17fa1 1487\r
92a5447e 1488 //\r
1489 // Get the EFI Shell list of files\r
1490 //\r
1491 Status = mEfiShellEnvironment2->FileMetaArg(Arg, &mOldStyleFileList);\r
1492 if (EFI_ERROR(Status)) {\r
1493 *ListHead = NULL;\r
1494 return (Status);\r
1495 }\r
94b17fa1 1496\r
9b3bf083 1497 if (*ListHead == NULL) {\r
92a5447e 1498 *ListHead = (EFI_SHELL_FILE_INFO *)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO));\r
1499 if (*ListHead == NULL) {\r
1500 return (EFI_OUT_OF_RESOURCES);\r
1501 }\r
1502 InitializeListHead(&((*ListHead)->Link));\r
9b3bf083 1503 }\r
9b3bf083 1504\r
92a5447e 1505 //\r
1506 // Convert that to equivalent of UEFI Shell 2.0 structure\r
1507 //\r
1508 InternalShellConvertFileListType(&mOldStyleFileList, &(*ListHead)->Link);\r
94b17fa1 1509\r
92a5447e 1510 //\r
1511 // Free the EFI Shell version that was converted.\r
1512 //\r
1513 mEfiShellEnvironment2->FreeFileList(&mOldStyleFileList);\r
94b17fa1 1514\r
92a5447e 1515 if ((*ListHead)->Link.ForwardLink == (*ListHead)->Link.BackLink && (*ListHead)->Link.BackLink == &((*ListHead)->Link)) {\r
1516 FreePool(*ListHead);\r
1517 *ListHead = NULL;\r
1518 Status = EFI_NOT_FOUND;\r
1519 }\r
1520 return (Status);\r
a405b86d 1521 }\r
1522\r
92a5447e 1523 return (EFI_UNSUPPORTED);\r
94b17fa1 1524}\r
1525/**\r
a405b86d 1526 Free the linked list returned from ShellOpenFileMetaArg.\r
94b17fa1 1527\r
a405b86d 1528 if ListHead is NULL then ASSERT().\r
94b17fa1 1529\r
a405b86d 1530 @param ListHead the pointer to free.\r
94b17fa1 1531\r
a405b86d 1532 @retval EFI_SUCCESS the operation was sucessful.\r
94b17fa1 1533**/\r
1534EFI_STATUS\r
1535EFIAPI\r
1536ShellCloseFileMetaArg (\r
1537 IN OUT EFI_SHELL_FILE_INFO **ListHead\r
1538 )\r
1539{\r
1540 LIST_ENTRY *Node;\r
1541\r
1542 //\r
1543 // ASSERT that ListHead is not NULL\r
1544 //\r
1545 ASSERT(ListHead != NULL);\r
1546\r
1e6e84c7 1547 //\r
94b17fa1 1548 // Check for UEFI Shell 2.0 protocols\r
1549 //\r
366f81a0 1550 if (gEfiShellProtocol != NULL) {\r
1551 return (gEfiShellProtocol->FreeFileList(ListHead));\r
92a5447e 1552 } else if (mEfiShellEnvironment2 != NULL) {\r
94b17fa1 1553 //\r
1e6e84c7 1554 // Since this is EFI Shell version we need to free our internally made copy\r
94b17fa1 1555 // of the list\r
1556 //\r
1e6e84c7 1557 for ( Node = GetFirstNode(&(*ListHead)->Link)\r
a405b86d 1558 ; *ListHead != NULL && !IsListEmpty(&(*ListHead)->Link)\r
9b3bf083 1559 ; Node = GetFirstNode(&(*ListHead)->Link)) {\r
94b17fa1 1560 RemoveEntryList(Node);\r
a405b86d 1561 ((EFI_FILE_PROTOCOL*)((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Handle)->Close(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Handle);\r
94b17fa1 1562 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->FullName);\r
1563 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->FileName);\r
1564 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST*)Node)->Info);\r
1565 FreePool((EFI_SHELL_FILE_INFO_NO_CONST*)Node);\r
1566 }\r
1567 return EFI_SUCCESS;\r
1568 }\r
92a5447e 1569\r
1570 return (EFI_UNSUPPORTED);\r
94b17fa1 1571}\r
1572\r
125c2cf4 1573/**\r
1574 Find a file by searching the CWD and then the path.\r
1575\r
b3011f40 1576 If FileName is NULL then ASSERT.\r
125c2cf4 1577\r
b3011f40 1578 If the return value is not NULL then the memory must be caller freed.\r
125c2cf4 1579\r
1580 @param FileName Filename string.\r
1581\r
1582 @retval NULL the file was not found\r
1583 @return !NULL the full path to the file.\r
1584**/\r
1585CHAR16 *\r
1586EFIAPI\r
1587ShellFindFilePath (\r
1588 IN CONST CHAR16 *FileName\r
1589 )\r
1590{\r
1591 CONST CHAR16 *Path;\r
a405b86d 1592 SHELL_FILE_HANDLE Handle;\r
125c2cf4 1593 EFI_STATUS Status;\r
1594 CHAR16 *RetVal;\r
1595 CHAR16 *TestPath;\r
1596 CONST CHAR16 *Walker;\r
36a9d672 1597 UINTN Size;\r
1cd45e78 1598 CHAR16 *TempChar;\r
125c2cf4 1599\r
1600 RetVal = NULL;\r
1601\r
a405b86d 1602 //\r
1603 // First make sure its not an absolute path.\r
1604 //\r
1605 Status = ShellOpenFileByName(FileName, &Handle, EFI_FILE_MODE_READ, 0);\r
1606 if (!EFI_ERROR(Status)){\r
1607 if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r
1608 ASSERT(RetVal == NULL);\r
1609 RetVal = StrnCatGrow(&RetVal, NULL, FileName, 0);\r
1610 ShellCloseFile(&Handle);\r
1611 return (RetVal);\r
1612 } else {\r
1613 ShellCloseFile(&Handle);\r
1614 }\r
1615 }\r
1616\r
125c2cf4 1617 Path = ShellGetEnvironmentVariable(L"cwd");\r
1618 if (Path != NULL) {\r
36a9d672 1619 Size = StrSize(Path);\r
1620 Size += StrSize(FileName);\r
1621 TestPath = AllocateZeroPool(Size);\r
c9d92df0 1622 if (TestPath == NULL) {\r
1623 return (NULL);\r
1624 }\r
125c2cf4 1625 StrCpy(TestPath, Path);\r
1626 StrCat(TestPath, FileName);\r
1627 Status = ShellOpenFileByName(TestPath, &Handle, EFI_FILE_MODE_READ, 0);\r
1628 if (!EFI_ERROR(Status)){\r
a405b86d 1629 if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r
1630 ASSERT(RetVal == NULL);\r
1631 RetVal = StrnCatGrow(&RetVal, NULL, TestPath, 0);\r
1632 ShellCloseFile(&Handle);\r
1633 FreePool(TestPath);\r
1634 return (RetVal);\r
1635 } else {\r
1636 ShellCloseFile(&Handle);\r
1637 }\r
125c2cf4 1638 }\r
1639 FreePool(TestPath);\r
1640 }\r
1641 Path = ShellGetEnvironmentVariable(L"path");\r
1642 if (Path != NULL) {\r
a405b86d 1643 Size = StrSize(Path)+sizeof(CHAR16);\r
36a9d672 1644 Size += StrSize(FileName);\r
1645 TestPath = AllocateZeroPool(Size);\r
3e082d58 1646 if (TestPath == NULL) {\r
1647 return (NULL);\r
1648 }\r
1e6e84c7 1649 Walker = (CHAR16*)Path;\r
125c2cf4 1650 do {\r
1651 CopyMem(TestPath, Walker, StrSize(Walker));\r
3e082d58 1652 if (TestPath != NULL) {\r
1653 TempChar = StrStr(TestPath, L";");\r
1654 if (TempChar != NULL) {\r
1655 *TempChar = CHAR_NULL;\r
1656 }\r
1657 if (TestPath[StrLen(TestPath)-1] != L'\\') {\r
1658 StrCat(TestPath, L"\\");\r
1659 }\r
89e8537a 1660 if (FileName[0] == L'\\') {\r
1661 FileName++;\r
1662 }\r
3e082d58 1663 StrCat(TestPath, FileName);\r
1664 if (StrStr(Walker, L";") != NULL) {\r
1665 Walker = StrStr(Walker, L";") + 1;\r
a405b86d 1666 } else {\r
3e082d58 1667 Walker = NULL;\r
1668 }\r
1669 Status = ShellOpenFileByName(TestPath, &Handle, EFI_FILE_MODE_READ, 0);\r
1670 if (!EFI_ERROR(Status)){\r
1671 if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r
1672 ASSERT(RetVal == NULL);\r
1673 RetVal = StrnCatGrow(&RetVal, NULL, TestPath, 0);\r
1674 ShellCloseFile(&Handle);\r
1675 break;\r
1676 } else {\r
1677 ShellCloseFile(&Handle);\r
1678 }\r
a405b86d 1679 }\r
125c2cf4 1680 }\r
1681 } while (Walker != NULL && Walker[0] != CHAR_NULL);\r
1682 FreePool(TestPath);\r
1683 }\r
1684 return (RetVal);\r
1685}\r
1686\r
b3011f40 1687/**\r
1e6e84c7 1688 Find a file by searching the CWD and then the path with a variable set of file\r
1689 extensions. If the file is not found it will append each extension in the list\r
b3011f40 1690 in the order provided and return the first one that is successful.\r
1691\r
1692 If FileName is NULL, then ASSERT.\r
1693 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.\r
1694\r
1695 If the return value is not NULL then the memory must be caller freed.\r
1696\r
1697 @param[in] FileName Filename string.\r
1698 @param[in] FileExtension Semi-colon delimeted list of possible extensions.\r
1699\r
1700 @retval NULL The file was not found.\r
1701 @retval !NULL The path to the file.\r
1702**/\r
1703CHAR16 *\r
1704EFIAPI\r
1705ShellFindFilePathEx (\r
1706 IN CONST CHAR16 *FileName,\r
1707 IN CONST CHAR16 *FileExtension\r
1708 )\r
1709{\r
1710 CHAR16 *TestPath;\r
1711 CHAR16 *RetVal;\r
1712 CONST CHAR16 *ExtensionWalker;\r
9e926b69 1713 UINTN Size;\r
1cd45e78 1714 CHAR16 *TempChar;\r
c9d92df0 1715 CHAR16 *TempChar2;\r
1cd45e78 1716\r
b3011f40 1717 ASSERT(FileName != NULL);\r
1718 if (FileExtension == NULL) {\r
1719 return (ShellFindFilePath(FileName));\r
1720 }\r
1721 RetVal = ShellFindFilePath(FileName);\r
1722 if (RetVal != NULL) {\r
1723 return (RetVal);\r
1724 }\r
9e926b69 1725 Size = StrSize(FileName);\r
1726 Size += StrSize(FileExtension);\r
1727 TestPath = AllocateZeroPool(Size);\r
c9d92df0 1728 if (TestPath == NULL) {\r
1729 return (NULL);\r
1730 }\r
a405b86d 1731 for (ExtensionWalker = FileExtension, TempChar2 = (CHAR16*)FileExtension; TempChar2 != NULL ; ExtensionWalker = TempChar2 + 1){\r
b3011f40 1732 StrCpy(TestPath, FileName);\r
a405b86d 1733 if (ExtensionWalker != NULL) {\r
1734 StrCat(TestPath, ExtensionWalker);\r
1735 }\r
1cd45e78 1736 TempChar = StrStr(TestPath, L";");\r
1737 if (TempChar != NULL) {\r
1738 *TempChar = CHAR_NULL;\r
b3011f40 1739 }\r
1740 RetVal = ShellFindFilePath(TestPath);\r
1741 if (RetVal != NULL) {\r
1742 break;\r
1743 }\r
a405b86d 1744 ASSERT(ExtensionWalker != NULL);\r
c9d92df0 1745 TempChar2 = StrStr(ExtensionWalker, L";");\r
b3011f40 1746 }\r
1747 FreePool(TestPath);\r
1748 return (RetVal);\r
1749}\r
1750\r
94b17fa1 1751typedef struct {\r
9b3bf083 1752 LIST_ENTRY Link;\r
94b17fa1 1753 CHAR16 *Name;\r
a405b86d 1754 SHELL_PARAM_TYPE Type;\r
94b17fa1 1755 CHAR16 *Value;\r
1756 UINTN OriginalPosition;\r
1757} SHELL_PARAM_PACKAGE;\r
1758\r
1759/**\r
1e6e84c7 1760 Checks the list of valid arguments and returns TRUE if the item was found. If the\r
94b17fa1 1761 return value is TRUE then the type parameter is set also.\r
1e6e84c7 1762\r
94b17fa1 1763 if CheckList is NULL then ASSERT();\r
1764 if Name is NULL then ASSERT();\r
1765 if Type is NULL then ASSERT();\r
1766\r
94b17fa1 1767 @param Name pointer to Name of parameter found\r
1768 @param CheckList List to check against\r
a405b86d 1769 @param Type pointer to type of parameter if it was found\r
94b17fa1 1770\r
1771 @retval TRUE the Parameter was found. Type is valid.\r
1772 @retval FALSE the Parameter was not found. Type is not valid.\r
1773**/\r
1774BOOLEAN\r
1775EFIAPI\r
d2b4564b 1776InternalIsOnCheckList (\r
94b17fa1 1777 IN CONST CHAR16 *Name,\r
1778 IN CONST SHELL_PARAM_ITEM *CheckList,\r
252d9457 1779 OUT SHELL_PARAM_TYPE *Type\r
a405b86d 1780 )\r
1781{\r
94b17fa1 1782 SHELL_PARAM_ITEM *TempListItem;\r
252d9457 1783 CHAR16 *TempString;\r
94b17fa1 1784\r
1785 //\r
1786 // ASSERT that all 3 pointer parameters aren't NULL\r
1787 //\r
1788 ASSERT(CheckList != NULL);\r
1789 ASSERT(Type != NULL);\r
1790 ASSERT(Name != NULL);\r
1791\r
d2b4564b 1792 //\r
1793 // question mark and page break mode are always supported\r
1794 //\r
1795 if ((StrCmp(Name, L"-?") == 0) ||\r
1796 (StrCmp(Name, L"-b") == 0)\r
a405b86d 1797 ) {\r
252d9457 1798 *Type = TypeFlag;\r
d2b4564b 1799 return (TRUE);\r
1800 }\r
1801\r
94b17fa1 1802 //\r
1803 // Enumerate through the list\r
1804 //\r
1805 for (TempListItem = (SHELL_PARAM_ITEM*)CheckList ; TempListItem->Name != NULL ; TempListItem++) {\r
1806 //\r
9eb53ac3 1807 // If the Type is TypeStart only check the first characters of the passed in param\r
1808 // If it matches set the type and return TRUE\r
94b17fa1 1809 //\r
252d9457 1810 if (TempListItem->Type == TypeStart) { \r
1811 if (StrnCmp(Name, TempListItem->Name, StrLen(TempListItem->Name)) == 0) {\r
1812 *Type = TempListItem->Type;\r
1813 return (TRUE);\r
1814 }\r
1815 TempString = NULL;\r
1816 TempString = StrnCatGrow(&TempString, NULL, Name, StrLen(TempListItem->Name));\r
1817 if (TempString != NULL) {\r
1818 if (StringNoCaseCompare(&TempString, &TempListItem->Name) == 0) {\r
1819 *Type = TempListItem->Type;\r
1820 FreePool(TempString);\r
1821 return (TRUE);\r
1822 }\r
1823 FreePool(TempString);\r
1824 }\r
1825 } else if (StringNoCaseCompare(&Name, &TempListItem->Name) == 0) {\r
94b17fa1 1826 *Type = TempListItem->Type;\r
1827 return (TRUE);\r
1828 }\r
1829 }\r
2247dde4 1830\r
94b17fa1 1831 return (FALSE);\r
1832}\r
1833/**\r
d2b4564b 1834 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'\r
94b17fa1 1835\r
a405b86d 1836 @param[in] Name pointer to Name of parameter found\r
1837 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.\r
94b17fa1 1838\r
1839 @retval TRUE the Parameter is a flag.\r
a405b86d 1840 @retval FALSE the Parameter not a flag.\r
94b17fa1 1841**/\r
1842BOOLEAN\r
1843EFIAPI\r
d2b4564b 1844InternalIsFlag (\r
2247dde4 1845 IN CONST CHAR16 *Name,\r
1846 IN BOOLEAN AlwaysAllowNumbers\r
94b17fa1 1847 )\r
1848{\r
1849 //\r
1850 // ASSERT that Name isn't NULL\r
1851 //\r
1852 ASSERT(Name != NULL);\r
1853\r
2247dde4 1854 //\r
1855 // If we accept numbers then dont return TRUE. (they will be values)\r
1856 //\r
a405b86d 1857 if (((Name[0] == L'-' || Name[0] == L'+') && ShellIsHexaDecimalDigitCharacter(Name[1])) && AlwaysAllowNumbers) {\r
2247dde4 1858 return (FALSE);\r
1859 }\r
1860\r
94b17fa1 1861 //\r
a405b86d 1862 // If the Name has a /, +, or - as the first character return TRUE\r
94b17fa1 1863 //\r
1e6e84c7 1864 if ((Name[0] == L'/') ||\r
d2b4564b 1865 (Name[0] == L'-') ||\r
1866 (Name[0] == L'+')\r
a405b86d 1867 ) {\r
94b17fa1 1868 return (TRUE);\r
1869 }\r
1870 return (FALSE);\r
1871}\r
1872\r
1873/**\r
1e6e84c7 1874 Checks the command line arguments passed against the list of valid ones.\r
94b17fa1 1875\r
1876 If no initialization is required, then return RETURN_SUCCESS.\r
1e6e84c7 1877\r
a405b86d 1878 @param[in] CheckList pointer to list of parameters to check\r
1879 @param[out] CheckPackage pointer to pointer to list checked values\r
1880 @param[out] ProblemParam optional pointer to pointer to unicode string for\r
d2b4564b 1881 the paramater that caused failure. If used then the\r
1882 caller is responsible for freeing the memory.\r
a405b86d 1883 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter\r
1884 @param[in] Argv pointer to array of parameters\r
1885 @param[in] Argc Count of parameters in Argv\r
1886 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.\r
94b17fa1 1887\r
1888 @retval EFI_SUCCESS The operation completed sucessfully.\r
1889 @retval EFI_OUT_OF_RESOURCES A memory allocation failed\r
1890 @retval EFI_INVALID_PARAMETER A parameter was invalid\r
1e6e84c7 1891 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was\r
1892 duplicated. the duplicated command line argument\r
94b17fa1 1893 was returned in ProblemParam if provided.\r
1e6e84c7 1894 @retval EFI_NOT_FOUND a argument required a value that was missing.\r
94b17fa1 1895 the invalid command line argument was returned in\r
1896 ProblemParam if provided.\r
1897**/\r
1898EFI_STATUS\r
1899EFIAPI\r
1900InternalCommandLineParse (\r
1901 IN CONST SHELL_PARAM_ITEM *CheckList,\r
1902 OUT LIST_ENTRY **CheckPackage,\r
1903 OUT CHAR16 **ProblemParam OPTIONAL,\r
1904 IN BOOLEAN AutoPageBreak,\r
1905 IN CONST CHAR16 **Argv,\r
2247dde4 1906 IN UINTN Argc,\r
1907 IN BOOLEAN AlwaysAllowNumbers\r
a405b86d 1908 )\r
1909{\r
94b17fa1 1910 UINTN LoopCounter;\r
252d9457 1911 SHELL_PARAM_TYPE CurrentItemType;\r
94b17fa1 1912 SHELL_PARAM_PACKAGE *CurrentItemPackage;\r
125c2cf4 1913 UINTN GetItemValue;\r
1914 UINTN ValueSize;\r
a405b86d 1915 UINTN Count;\r
252d9457 1916 CONST CHAR16 *TempPointer;\r
94b17fa1 1917\r
1918 CurrentItemPackage = NULL;\r
125c2cf4 1919 GetItemValue = 0;\r
1920 ValueSize = 0;\r
a405b86d 1921 Count = 0;\r
94b17fa1 1922\r
1923 //\r
1924 // If there is only 1 item we dont need to do anything\r
1925 //\r
a405b86d 1926 if (Argc < 1) {\r
94b17fa1 1927 *CheckPackage = NULL;\r
1928 return (EFI_SUCCESS);\r
1929 }\r
1930\r
2247dde4 1931 //\r
1932 // ASSERTs\r
1933 //\r
1934 ASSERT(CheckList != NULL);\r
1935 ASSERT(Argv != NULL);\r
1936\r
94b17fa1 1937 //\r
1938 // initialize the linked list\r
1939 //\r
1940 *CheckPackage = (LIST_ENTRY*)AllocateZeroPool(sizeof(LIST_ENTRY));\r
02a758cb 1941 if (*CheckPackage == NULL) {\r
beab0fc5 1942 return (EFI_OUT_OF_RESOURCES);\r
02a758cb 1943 }\r
beab0fc5 1944\r
94b17fa1 1945 InitializeListHead(*CheckPackage);\r
1946\r
1947 //\r
1948 // loop through each of the arguments\r
1949 //\r
1950 for (LoopCounter = 0 ; LoopCounter < Argc ; ++LoopCounter) {\r
1951 if (Argv[LoopCounter] == NULL) {\r
1952 //\r
1953 // do nothing for NULL argv\r
1954 //\r
a405b86d 1955 } else if (InternalIsOnCheckList(Argv[LoopCounter], CheckList, &CurrentItemType)) {\r
2247dde4 1956 //\r
1957 // We might have leftover if last parameter didnt have optional value\r
1958 //\r
125c2cf4 1959 if (GetItemValue != 0) {\r
1960 GetItemValue = 0;\r
2247dde4 1961 InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r
1962 }\r
94b17fa1 1963 //\r
1964 // this is a flag\r
1965 //\r
252d9457 1966 CurrentItemPackage = AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE));\r
beab0fc5 1967 if (CurrentItemPackage == NULL) {\r
1968 ShellCommandLineFreeVarList(*CheckPackage);\r
1969 *CheckPackage = NULL;\r
1970 return (EFI_OUT_OF_RESOURCES);\r
1971 }\r
252d9457 1972 CurrentItemPackage->Name = AllocateZeroPool(StrSize(Argv[LoopCounter]));\r
beab0fc5 1973 if (CurrentItemPackage->Name == NULL) {\r
1974 ShellCommandLineFreeVarList(*CheckPackage);\r
1975 *CheckPackage = NULL;\r
1976 return (EFI_OUT_OF_RESOURCES);\r
1977 }\r
94b17fa1 1978 StrCpy(CurrentItemPackage->Name, Argv[LoopCounter]);\r
1979 CurrentItemPackage->Type = CurrentItemType;\r
1980 CurrentItemPackage->OriginalPosition = (UINTN)(-1);\r
b1f95a06 1981 CurrentItemPackage->Value = NULL;\r
94b17fa1 1982\r
1983 //\r
1984 // Does this flag require a value\r
1985 //\r
125c2cf4 1986 switch (CurrentItemPackage->Type) {\r
94b17fa1 1987 //\r
125c2cf4 1988 // possibly trigger the next loop(s) to populate the value of this item\r
1e6e84c7 1989 //\r
125c2cf4 1990 case TypeValue:\r
1e6e84c7 1991 GetItemValue = 1;\r
125c2cf4 1992 ValueSize = 0;\r
1993 break;\r
1994 case TypeDoubleValue:\r
1995 GetItemValue = 2;\r
1996 ValueSize = 0;\r
1997 break;\r
1998 case TypeMaxValue:\r
1999 GetItemValue = (UINTN)(-1);\r
2000 ValueSize = 0;\r
2001 break;\r
2002 default:\r
2003 //\r
2004 // this item has no value expected; we are done\r
2005 //\r
2006 InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r
2007 ASSERT(GetItemValue == 0);\r
2008 break;\r
94b17fa1 2009 }\r
a405b86d 2010 } else if (GetItemValue != 0 && !InternalIsFlag(Argv[LoopCounter], AlwaysAllowNumbers)) {\r
b1f95a06 2011 ASSERT(CurrentItemPackage != NULL);\r
2012 //\r
125c2cf4 2013 // get the item VALUE for a previous flag\r
b1f95a06 2014 //\r
125c2cf4 2015 CurrentItemPackage->Value = ReallocatePool(ValueSize, ValueSize + StrSize(Argv[LoopCounter]) + sizeof(CHAR16), CurrentItemPackage->Value);\r
b1f95a06 2016 ASSERT(CurrentItemPackage->Value != NULL);\r
125c2cf4 2017 if (ValueSize == 0) {\r
2018 StrCpy(CurrentItemPackage->Value, Argv[LoopCounter]);\r
2019 } else {\r
2020 StrCat(CurrentItemPackage->Value, L" ");\r
2021 StrCat(CurrentItemPackage->Value, Argv[LoopCounter]);\r
2022 }\r
2023 ValueSize += StrSize(Argv[LoopCounter]) + sizeof(CHAR16);\r
2024 GetItemValue--;\r
2025 if (GetItemValue == 0) {\r
2026 InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r
2027 }\r
a405b86d 2028 } else if (!InternalIsFlag(Argv[LoopCounter], AlwaysAllowNumbers) ){ //|| ProblemParam == NULL) {\r
b1f95a06 2029 //\r
2030 // add this one as a non-flag\r
2031 //\r
252d9457 2032\r
2033 TempPointer = Argv[LoopCounter];\r
2034 if ((*TempPointer == L'^' && *(TempPointer+1) == L'-') \r
2035 || (*TempPointer == L'^' && *(TempPointer+1) == L'/')\r
2036 || (*TempPointer == L'^' && *(TempPointer+1) == L'+')\r
2037 ){\r
2038 TempPointer++;\r
2039 }\r
2040 CurrentItemPackage = AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE));\r
beab0fc5 2041 if (CurrentItemPackage == NULL) {\r
2042 ShellCommandLineFreeVarList(*CheckPackage);\r
2043 *CheckPackage = NULL;\r
2044 return (EFI_OUT_OF_RESOURCES);\r
2045 }\r
b1f95a06 2046 CurrentItemPackage->Name = NULL;\r
2047 CurrentItemPackage->Type = TypePosition;\r
252d9457 2048 CurrentItemPackage->Value = AllocateZeroPool(StrSize(TempPointer));\r
beab0fc5 2049 if (CurrentItemPackage->Value == NULL) {\r
2050 ShellCommandLineFreeVarList(*CheckPackage);\r
2051 *CheckPackage = NULL;\r
2052 return (EFI_OUT_OF_RESOURCES);\r
2053 }\r
252d9457 2054 StrCpy(CurrentItemPackage->Value, TempPointer);\r
a405b86d 2055 CurrentItemPackage->OriginalPosition = Count++;\r
9b3bf083 2056 InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r
252d9457 2057 } else {\r
94b17fa1 2058 //\r
2059 // this was a non-recognised flag... error!\r
2060 //\r
252d9457 2061 if (ProblemParam != NULL) {\r
2062 *ProblemParam = AllocateZeroPool(StrSize(Argv[LoopCounter]));\r
beab0fc5 2063 if (*ProblemParam != NULL) {\r
2064 StrCpy(*ProblemParam, Argv[LoopCounter]); \r
2065 }\r
252d9457 2066 }\r
94b17fa1 2067 ShellCommandLineFreeVarList(*CheckPackage);\r
2068 *CheckPackage = NULL;\r
2069 return (EFI_VOLUME_CORRUPTED);\r
94b17fa1 2070 }\r
2071 }\r
125c2cf4 2072 if (GetItemValue != 0) {\r
2073 GetItemValue = 0;\r
2074 InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r
2075 }\r
94b17fa1 2076 //\r
2077 // support for AutoPageBreak\r
2078 //\r
2079 if (AutoPageBreak && ShellCommandLineGetFlag(*CheckPackage, L"-b")) {\r
2080 ShellSetPageBreakMode(TRUE);\r
2081 }\r
2082 return (EFI_SUCCESS);\r
2083}\r
2084\r
2085/**\r
1e6e84c7 2086 Checks the command line arguments passed against the list of valid ones.\r
94b17fa1 2087 Optionally removes NULL values first.\r
1e6e84c7 2088\r
94b17fa1 2089 If no initialization is required, then return RETURN_SUCCESS.\r
1e6e84c7 2090\r
a405b86d 2091 @param[in] CheckList The pointer to list of parameters to check.\r
2092 @param[out] CheckPackage The package of checked values.\r
2093 @param[out] ProblemParam Optional pointer to pointer to unicode string for\r
94b17fa1 2094 the paramater that caused failure.\r
a405b86d 2095 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.\r
2096 @param[in] AlwaysAllowNumbers Will never fail for number based flags.\r
94b17fa1 2097\r
2098 @retval EFI_SUCCESS The operation completed sucessfully.\r
a405b86d 2099 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
2100 @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
2101 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.\r
2102 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One\r
1e6e84c7 2103 of the command line arguments was returned in\r
94b17fa1 2104 ProblemParam if provided.\r
a405b86d 2105 @retval EFI_NOT_FOUND A argument required a value that was missing.\r
2106 The invalid command line argument was returned in\r
94b17fa1 2107 ProblemParam if provided.\r
2108**/\r
2109EFI_STATUS\r
2110EFIAPI\r
2247dde4 2111ShellCommandLineParseEx (\r
94b17fa1 2112 IN CONST SHELL_PARAM_ITEM *CheckList,\r
2113 OUT LIST_ENTRY **CheckPackage,\r
2114 OUT CHAR16 **ProblemParam OPTIONAL,\r
2247dde4 2115 IN BOOLEAN AutoPageBreak,\r
2116 IN BOOLEAN AlwaysAllowNumbers\r
a405b86d 2117 )\r
2118{\r
1e6e84c7 2119 //\r
94b17fa1 2120 // ASSERT that CheckList and CheckPackage aren't NULL\r
2121 //\r
2122 ASSERT(CheckList != NULL);\r
2123 ASSERT(CheckPackage != NULL);\r
2124\r
1e6e84c7 2125 //\r
94b17fa1 2126 // Check for UEFI Shell 2.0 protocols\r
2127 //\r
366f81a0 2128 if (gEfiShellParametersProtocol != NULL) {\r
1e6e84c7 2129 return (InternalCommandLineParse(CheckList,\r
2130 CheckPackage,\r
2131 ProblemParam,\r
2132 AutoPageBreak,\r
366f81a0 2133 (CONST CHAR16**) gEfiShellParametersProtocol->Argv,\r
2134 gEfiShellParametersProtocol->Argc,\r
2247dde4 2135 AlwaysAllowNumbers));\r
94b17fa1 2136 }\r
2137\r
1e6e84c7 2138 //\r
94b17fa1 2139 // ASSERT That EFI Shell is not required\r
2140 //\r
2141 ASSERT (mEfiShellInterface != NULL);\r
1e6e84c7 2142 return (InternalCommandLineParse(CheckList,\r
2143 CheckPackage,\r
2144 ProblemParam,\r
2145 AutoPageBreak,\r
08d7f8e8 2146 (CONST CHAR16**) mEfiShellInterface->Argv,\r
2247dde4 2147 mEfiShellInterface->Argc,\r
2148 AlwaysAllowNumbers));\r
94b17fa1 2149}\r
2150\r
2151/**\r
2152 Frees shell variable list that was returned from ShellCommandLineParse.\r
2153\r
2154 This function will free all the memory that was used for the CheckPackage\r
2155 list of postprocessed shell arguments.\r
2156\r
2157 this function has no return value.\r
2158\r
2159 if CheckPackage is NULL, then return\r
2160\r
2161 @param CheckPackage the list to de-allocate\r
2162 **/\r
2163VOID\r
2164EFIAPI\r
2165ShellCommandLineFreeVarList (\r
2166 IN LIST_ENTRY *CheckPackage\r
a405b86d 2167 )\r
2168{\r
94b17fa1 2169 LIST_ENTRY *Node;\r
2170\r
2171 //\r
2172 // check for CheckPackage == NULL\r
2173 //\r
2174 if (CheckPackage == NULL) {\r
2175 return;\r
2176 }\r
2177\r
2178 //\r
2179 // for each node in the list\r
2180 //\r
9eb53ac3 2181 for ( Node = GetFirstNode(CheckPackage)\r
a405b86d 2182 ; !IsListEmpty(CheckPackage)\r
9eb53ac3 2183 ; Node = GetFirstNode(CheckPackage)\r
a405b86d 2184 ){\r
94b17fa1 2185 //\r
2186 // Remove it from the list\r
2187 //\r
2188 RemoveEntryList(Node);\r
2189\r
2190 //\r
2191 // if it has a name free the name\r
2192 //\r
2193 if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r
2194 FreePool(((SHELL_PARAM_PACKAGE*)Node)->Name);\r
2195 }\r
2196\r
2197 //\r
2198 // if it has a value free the value\r
2199 //\r
2200 if (((SHELL_PARAM_PACKAGE*)Node)->Value != NULL) {\r
2201 FreePool(((SHELL_PARAM_PACKAGE*)Node)->Value);\r
2202 }\r
1e6e84c7 2203\r
94b17fa1 2204 //\r
2205 // free the node structure\r
2206 //\r
2207 FreePool((SHELL_PARAM_PACKAGE*)Node);\r
2208 }\r
2209 //\r
2210 // free the list head node\r
2211 //\r
2212 FreePool(CheckPackage);\r
2213}\r
2214/**\r
2215 Checks for presence of a flag parameter\r
2216\r
2217 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key\r
2218\r
2219 if CheckPackage is NULL then return FALSE.\r
2220 if KeyString is NULL then ASSERT()\r
1e6e84c7 2221\r
94b17fa1 2222 @param CheckPackage The package of parsed command line arguments\r
2223 @param KeyString the Key of the command line argument to check for\r
2224\r
2225 @retval TRUE the flag is on the command line\r
2226 @retval FALSE the flag is not on the command line\r
2227 **/\r
2228BOOLEAN\r
2229EFIAPI\r
2230ShellCommandLineGetFlag (\r
a405b86d 2231 IN CONST LIST_ENTRY * CONST CheckPackage,\r
2232 IN CONST CHAR16 * CONST KeyString\r
2233 )\r
2234{\r
94b17fa1 2235 LIST_ENTRY *Node;\r
252d9457 2236 CHAR16 *TempString;\r
94b17fa1 2237\r
2238 //\r
2239 // ASSERT that both CheckPackage and KeyString aren't NULL\r
2240 //\r
2241 ASSERT(KeyString != NULL);\r
2242\r
2243 //\r
2244 // return FALSE for no package\r
2245 //\r
2246 if (CheckPackage == NULL) {\r
2247 return (FALSE);\r
2248 }\r
2249\r
2250 //\r
2251 // enumerate through the list of parametrs\r
2252 //\r
1e6e84c7 2253 for ( Node = GetFirstNode(CheckPackage)\r
2254 ; !IsNull (CheckPackage, Node)\r
2255 ; Node = GetNextNode(CheckPackage, Node)\r
252d9457 2256 ){\r
94b17fa1 2257 //\r
2258 // If the Name matches, return TRUE (and there may be NULL name)\r
2259 //\r
2260 if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r
9eb53ac3 2261 //\r
2262 // If Type is TypeStart then only compare the begining of the strings\r
2263 //\r
252d9457 2264 if (((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart) {\r
2265 if (StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0) {\r
2266 return (TRUE);\r
2267 }\r
2268 TempString = NULL;\r
2269 TempString = StrnCatGrow(&TempString, NULL, KeyString, StrLen(((SHELL_PARAM_PACKAGE*)Node)->Name));\r
2270 if (TempString != NULL) {\r
2271 if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
2272 FreePool(TempString);\r
2273 return (TRUE);\r
2274 }\r
2275 FreePool(TempString);\r
2276 }\r
2277 } else if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
94b17fa1 2278 return (TRUE);\r
2279 }\r
2280 }\r
2281 }\r
2282 return (FALSE);\r
2283}\r
2284/**\r
a405b86d 2285 Returns value from command line argument.\r
94b17fa1 2286\r
a405b86d 2287 Value parameters are in the form of "-<Key> value" or "/<Key> value".\r
1e6e84c7 2288\r
a405b86d 2289 If CheckPackage is NULL, then return NULL.\r
94b17fa1 2290\r
a405b86d 2291 @param[in] CheckPackage The package of parsed command line arguments.\r
2292 @param[in] KeyString The Key of the command line argument to check for.\r
94b17fa1 2293\r
a405b86d 2294 @retval NULL The flag is not on the command line.\r
2295 @retval !=NULL The pointer to unicode string of the value.\r
2296**/\r
94b17fa1 2297CONST CHAR16*\r
2298EFIAPI\r
2299ShellCommandLineGetValue (\r
2300 IN CONST LIST_ENTRY *CheckPackage,\r
2301 IN CHAR16 *KeyString\r
a405b86d 2302 )\r
2303{\r
94b17fa1 2304 LIST_ENTRY *Node;\r
252d9457 2305 CHAR16 *TempString;\r
94b17fa1 2306\r
2307 //\r
2308 // check for CheckPackage == NULL\r
2309 //\r
2310 if (CheckPackage == NULL) {\r
2311 return (NULL);\r
2312 }\r
2313\r
2314 //\r
2315 // enumerate through the list of parametrs\r
2316 //\r
1e6e84c7 2317 for ( Node = GetFirstNode(CheckPackage)\r
2318 ; !IsNull (CheckPackage, Node)\r
2319 ; Node = GetNextNode(CheckPackage, Node)\r
252d9457 2320 ){\r
94b17fa1 2321 //\r
252d9457 2322 // If the Name matches, return TRUE (and there may be NULL name)\r
94b17fa1 2323 //\r
2324 if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r
9eb53ac3 2325 //\r
2326 // If Type is TypeStart then only compare the begining of the strings\r
2327 //\r
252d9457 2328 if (((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart) {\r
2329 if (StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0) {\r
2330 return (((SHELL_PARAM_PACKAGE*)Node)->Name + StrLen(KeyString));\r
2331 }\r
2332 TempString = NULL;\r
2333 TempString = StrnCatGrow(&TempString, NULL, KeyString, StrLen(((SHELL_PARAM_PACKAGE*)Node)->Name));\r
2334 if (TempString != NULL) {\r
2335 if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
2336 FreePool(TempString);\r
2337 return (((SHELL_PARAM_PACKAGE*)Node)->Name + StrLen(KeyString));\r
2338 }\r
2339 FreePool(TempString);\r
2340 }\r
2341 } else if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
94b17fa1 2342 return (((SHELL_PARAM_PACKAGE*)Node)->Value);\r
2343 }\r
2344 }\r
2345 }\r
2346 return (NULL);\r
2347}\r
a405b86d 2348\r
94b17fa1 2349/**\r
a405b86d 2350 Returns raw value from command line argument.\r
94b17fa1 2351\r
a405b86d 2352 Raw value parameters are in the form of "value" in a specific position in the list.\r
1e6e84c7 2353\r
a405b86d 2354 If CheckPackage is NULL, then return NULL.\r
94b17fa1 2355\r
a405b86d 2356 @param[in] CheckPackage The package of parsed command line arguments.\r
2357 @param[in] Position The position of the value.\r
94b17fa1 2358\r
a405b86d 2359 @retval NULL The flag is not on the command line.\r
2360 @retval !=NULL The pointer to unicode string of the value.\r
94b17fa1 2361 **/\r
2362CONST CHAR16*\r
2363EFIAPI\r
2364ShellCommandLineGetRawValue (\r
a405b86d 2365 IN CONST LIST_ENTRY * CONST CheckPackage,\r
2366 IN UINTN Position\r
2367 )\r
2368{\r
94b17fa1 2369 LIST_ENTRY *Node;\r
2370\r
2371 //\r
2372 // check for CheckPackage == NULL\r
2373 //\r
2374 if (CheckPackage == NULL) {\r
2375 return (NULL);\r
2376 }\r
2377\r
2378 //\r
2379 // enumerate through the list of parametrs\r
2380 //\r
1e6e84c7 2381 for ( Node = GetFirstNode(CheckPackage)\r
2382 ; !IsNull (CheckPackage, Node)\r
2383 ; Node = GetNextNode(CheckPackage, Node)\r
a405b86d 2384 ){\r
94b17fa1 2385 //\r
2386 // If the position matches, return the value\r
2387 //\r
2388 if (((SHELL_PARAM_PACKAGE*)Node)->OriginalPosition == Position) {\r
2389 return (((SHELL_PARAM_PACKAGE*)Node)->Value);\r
2390 }\r
2391 }\r
2392 return (NULL);\r
b1f95a06 2393}\r
2247dde4 2394\r
2395/**\r
1e6e84c7 2396 returns the number of command line value parameters that were parsed.\r
2397\r
2247dde4 2398 this will not include flags.\r
2399\r
a405b86d 2400 @param[in] CheckPackage The package of parsed command line arguments.\r
2401\r
2247dde4 2402 @retval (UINTN)-1 No parsing has ocurred\r
2403 @return other The number of value parameters found\r
2404**/\r
2405UINTN\r
2406EFIAPI\r
2407ShellCommandLineGetCount(\r
a405b86d 2408 IN CONST LIST_ENTRY *CheckPackage\r
125c2cf4 2409 )\r
2410{\r
a405b86d 2411 LIST_ENTRY *Node1;\r
2412 UINTN Count;\r
2413\r
2414 if (CheckPackage == NULL) {\r
2415 return (0);\r
2416 }\r
2417 for ( Node1 = GetFirstNode(CheckPackage), Count = 0\r
2418 ; !IsNull (CheckPackage, Node1)\r
2419 ; Node1 = GetNextNode(CheckPackage, Node1)\r
2420 ){\r
2421 if (((SHELL_PARAM_PACKAGE*)Node1)->Name == NULL) {\r
2422 Count++;\r
2423 }\r
2424 }\r
2425 return (Count);\r
2247dde4 2426}\r
2427\r
36a9d672 2428/**\r
2429 Determins if a parameter is duplicated.\r
2430\r
1e6e84c7 2431 If Param is not NULL then it will point to a callee allocated string buffer\r
36a9d672 2432 with the parameter value if a duplicate is found.\r
2433\r
2434 If CheckPackage is NULL, then ASSERT.\r
2435\r
2436 @param[in] CheckPackage The package of parsed command line arguments.\r
2437 @param[out] Param Upon finding one, a pointer to the duplicated parameter.\r
2438\r
2439 @retval EFI_SUCCESS No parameters were duplicated.\r
2440 @retval EFI_DEVICE_ERROR A duplicate was found.\r
2441 **/\r
2442EFI_STATUS\r
2443EFIAPI\r
2444ShellCommandLineCheckDuplicate (\r
2445 IN CONST LIST_ENTRY *CheckPackage,\r
2446 OUT CHAR16 **Param\r
2447 )\r
2448{\r
2449 LIST_ENTRY *Node1;\r
2450 LIST_ENTRY *Node2;\r
1e6e84c7 2451\r
36a9d672 2452 ASSERT(CheckPackage != NULL);\r
2453\r
1e6e84c7 2454 for ( Node1 = GetFirstNode(CheckPackage)\r
2455 ; !IsNull (CheckPackage, Node1)\r
2456 ; Node1 = GetNextNode(CheckPackage, Node1)\r
a405b86d 2457 ){\r
1e6e84c7 2458 for ( Node2 = GetNextNode(CheckPackage, Node1)\r
2459 ; !IsNull (CheckPackage, Node2)\r
2460 ; Node2 = GetNextNode(CheckPackage, Node2)\r
a405b86d 2461 ){\r
2462 if ((((SHELL_PARAM_PACKAGE*)Node1)->Name != NULL) && (((SHELL_PARAM_PACKAGE*)Node2)->Name != NULL) && StrCmp(((SHELL_PARAM_PACKAGE*)Node1)->Name, ((SHELL_PARAM_PACKAGE*)Node2)->Name) == 0) {\r
36a9d672 2463 if (Param != NULL) {\r
2464 *Param = NULL;\r
2465 *Param = StrnCatGrow(Param, NULL, ((SHELL_PARAM_PACKAGE*)Node1)->Name, 0);\r
2466 }\r
2467 return (EFI_DEVICE_ERROR);\r
2468 }\r
2469 }\r
2470 }\r
2471 return (EFI_SUCCESS);\r
2472}\r
2473\r
975136ab 2474/**\r
1e6e84c7 2475 This is a find and replace function. Upon successful return the NewString is a copy of\r
975136ab 2476 SourceString with each instance of FindTarget replaced with ReplaceWith.\r
2477\r
b3011f40 2478 If SourceString and NewString overlap the behavior is undefined.\r
2479\r
975136ab 2480 If the string would grow bigger than NewSize it will halt and return error.\r
2481\r
4ff7e37b
ED		 2482 @param[in] SourceString The string with source buffer.\r
2483 @param[in, out] NewString The string with resultant buffer.\r
2484 @param[in] NewSize The size in bytes of NewString.\r
2485 @param[in] FindTarget The string to look for.\r
2486 @param[in] ReplaceWith The string to replace FindTarget with.\r
2487 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r
2488 immediately before it.\r
2489 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r
969c783b 2490\r
2491 @retval EFI_INVALID_PARAMETER SourceString was NULL.\r
2492 @retval EFI_INVALID_PARAMETER NewString was NULL.\r
2493 @retval EFI_INVALID_PARAMETER FindTarget was NULL.\r
2494 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.\r
2495 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.\r
2496 @retval EFI_INVALID_PARAMETER SourceString had length < 1.\r
1e6e84c7 2497 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold\r
969c783b 2498 the new string (truncation occurred).\r
a405b86d 2499 @retval EFI_SUCCESS The string was successfully copied with replacement.\r
975136ab 2500**/\r
975136ab 2501EFI_STATUS\r
2502EFIAPI\r
a405b86d 2503ShellCopySearchAndReplace(\r
975136ab 2504 IN CHAR16 CONST *SourceString,\r
a405b86d 2505 IN OUT CHAR16 *NewString,\r
975136ab 2506 IN UINTN NewSize,\r
2507 IN CONST CHAR16 *FindTarget,\r
969c783b 2508 IN CONST CHAR16 *ReplaceWith,\r
a405b86d 2509 IN CONST BOOLEAN SkipPreCarrot,\r
2510 IN CONST BOOLEAN ParameterReplacing\r
1e6e84c7 2511 )\r
2247dde4 2512{\r
0158294b 2513 UINTN Size;\r
a405b86d 2514 CHAR16 *Replace;\r
2515\r
975136ab 2516 if ( (SourceString == NULL)\r
2517 || (NewString == NULL)\r
2518 || (FindTarget == NULL)\r
2519 || (ReplaceWith == NULL)\r
2520 || (StrLen(FindTarget) < 1)\r
2521 || (StrLen(SourceString) < 1)\r
a405b86d 2522 ){\r
975136ab 2523 return (EFI_INVALID_PARAMETER);\r
2524 }\r
a405b86d 2525 Replace = NULL;\r
2526 if (StrStr(ReplaceWith, L" ") == NULL || !ParameterReplacing) {\r
2527 Replace = StrnCatGrow(&Replace, NULL, ReplaceWith, 0);\r
2528 } else {\r
2529 Replace = AllocateZeroPool(StrSize(ReplaceWith) + 2*sizeof(CHAR16));\r
beab0fc5 2530 if (Replace != NULL) {\r
2531 UnicodeSPrint(Replace, StrSize(ReplaceWith) + 2*sizeof(CHAR16), L"\"%s\"", ReplaceWith);\r
2532 }\r
a405b86d 2533 }\r
3e082d58 2534 if (Replace == NULL) {\r
2535 return (EFI_OUT_OF_RESOURCES);\r
2536 }\r
2247dde4 2537 NewString = SetMem16(NewString, NewSize, CHAR_NULL);\r
2538 while (*SourceString != CHAR_NULL) {\r
969c783b 2539 //\r
a405b86d 2540 // if we find the FindTarget and either Skip == FALSE or Skip and we\r
969c783b 2541 // dont have a carrot do a replace...\r
2542 //\r
1e6e84c7 2543 if (StrnCmp(SourceString, FindTarget, StrLen(FindTarget)) == 0\r
a405b86d 2544 && ((SkipPreCarrot && *(SourceString-1) != L'^') || !SkipPreCarrot)\r
2545 ){\r
975136ab 2546 SourceString += StrLen(FindTarget);\r
0158294b 2547 Size = StrSize(NewString);\r
a405b86d 2548 if ((Size + (StrLen(Replace)*sizeof(CHAR16))) > NewSize) {\r
2549 FreePool(Replace);\r
975136ab 2550 return (EFI_BUFFER_TOO_SMALL);\r
2551 }\r
a405b86d 2552 StrCat(NewString, Replace);\r
975136ab 2553 } else {\r
0158294b 2554 Size = StrSize(NewString);\r
2555 if (Size + sizeof(CHAR16) > NewSize) {\r
a405b86d 2556 FreePool(Replace);\r
975136ab 2557 return (EFI_BUFFER_TOO_SMALL);\r
2558 }\r
2559 StrnCat(NewString, SourceString, 1);\r
2560 SourceString++;\r
2561 }\r
2562 }\r
a405b86d 2563 FreePool(Replace);\r
975136ab 2564 return (EFI_SUCCESS);\r
2565}\r
b1f95a06 2566\r
e2f8297f 2567/**\r
2568 Internal worker function to output a string.\r
2569\r
2570 This function will output a string to the correct StdOut.\r
2571\r
2572 @param[in] String The string to print out.\r
2573\r
2574 @retval EFI_SUCCESS The operation was sucessful.\r
2575 @retval !EFI_SUCCESS The operation failed.\r
2576**/\r
2577EFI_STATUS\r
2578EFIAPI\r
2579InternalPrintTo (\r
2580 IN CONST CHAR16 *String\r
2581 )\r
2582{\r
2583 UINTN Size;\r
2584 Size = StrSize(String) - sizeof(CHAR16);\r
a405b86d 2585 if (Size == 0) {\r
2586 return (EFI_SUCCESS);\r
2587 }\r
366f81a0 2588 if (gEfiShellParametersProtocol != NULL) {\r
2589 return (gEfiShellProtocol->WriteFile(gEfiShellParametersProtocol->StdOut, &Size, (VOID*)String));\r
e2f8297f 2590 }\r
2591 if (mEfiShellInterface != NULL) {\r
ecd3d59f 2592 //\r
2593 // Divide in half for old shell. Must be string length not size.\r
2594 //\r
2595 Size /= 2;\r
a405b86d 2596 return (mEfiShellInterface->StdOut->Write(mEfiShellInterface->StdOut, &Size, (VOID*)String));\r
e2f8297f 2597 }\r
2598 ASSERT(FALSE);\r
2599 return (EFI_UNSUPPORTED);\r
2600}\r
2601\r
b1f95a06 2602/**\r
2603 Print at a specific location on the screen.\r
2604\r
f1b87e7a 2605 This function will move the cursor to a given screen location and print the specified string\r
1e6e84c7 2606\r
2607 If -1 is specified for either the Row or Col the current screen location for BOTH\r
f1b87e7a 2608 will be used.\r
b1f95a06 2609\r
2610 if either Row or Col is out of range for the current console, then ASSERT\r
2611 if Format is NULL, then ASSERT\r
2612\r
1e6e84c7 2613 In addition to the standard %-based flags as supported by UefiLib Print() this supports\r
b1f95a06 2614 the following additional flags:\r
2615 %N - Set output attribute to normal\r
2616 %H - Set output attribute to highlight\r
2617 %E - Set output attribute to error\r
2618 %B - Set output attribute to blue color\r
2619 %V - Set output attribute to green color\r
2620\r
2621 Note: The background color is controlled by the shell command cls.\r
2622\r
b1f95a06 2623 @param[in] Col the column to print at\r
252d9457 2624 @param[in] Row the row to print at\r
b1f95a06 2625 @param[in] Format the format string\r
2247dde4 2626 @param[in] Marker the marker for the variable argument list\r
b1f95a06 2627\r
a405b86d 2628 @return EFI_SUCCESS The operation was successful.\r
2629 @return EFI_DEVICE_ERROR The console device reported an error.\r
b1f95a06 2630**/\r
a405b86d 2631EFI_STATUS\r
b1f95a06 2632EFIAPI\r
2247dde4 2633InternalShellPrintWorker(\r
b1f95a06 2634 IN INT32 Col OPTIONAL,\r
2635 IN INT32 Row OPTIONAL,\r
2636 IN CONST CHAR16 *Format,\r
252d9457 2637 IN VA_LIST Marker\r
1e6e84c7 2638 )\r
2247dde4 2639{\r
b1f95a06 2640 EFI_STATUS Status;\r
975136ab 2641 CHAR16 *ResumeLocation;\r
2642 CHAR16 *FormatWalker;\r
a405b86d 2643 UINTN OriginalAttribute;\r
89e8537a 2644 CHAR16 *mPostReplaceFormat;\r
2645 CHAR16 *mPostReplaceFormat2;\r
2646\r
2647 mPostReplaceFormat = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r
2648 mPostReplaceFormat2 = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r
a405b86d 2649\r
f8d3e689 2650 if (mPostReplaceFormat == NULL || mPostReplaceFormat2 == NULL) {\r
2651 SHELL_FREE_NON_NULL(mPostReplaceFormat);\r
2652 SHELL_FREE_NON_NULL(mPostReplaceFormat2);\r
2653 return (EFI_OUT_OF_RESOURCES);\r
2654 }\r
2655\r
a405b86d 2656 Status = EFI_SUCCESS;\r
2657 OriginalAttribute = gST->ConOut->Mode->Attribute;\r
1e6e84c7 2658\r
975136ab 2659 //\r
2660 // Back and forth each time fixing up 1 of our flags...\r
2661 //\r
a405b86d 2662 Status = ShellCopySearchAndReplace(Format, mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%N", L"%%N", FALSE, FALSE);\r
975136ab 2663 ASSERT_EFI_ERROR(Status);\r
a405b86d 2664 Status = ShellCopySearchAndReplace(mPostReplaceFormat, mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), L"%E", L"%%E", FALSE, FALSE);\r
975136ab 2665 ASSERT_EFI_ERROR(Status);\r
a405b86d 2666 Status = ShellCopySearchAndReplace(mPostReplaceFormat2, mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%H", L"%%H", FALSE, FALSE);\r
975136ab 2667 ASSERT_EFI_ERROR(Status);\r
a405b86d 2668 Status = ShellCopySearchAndReplace(mPostReplaceFormat, mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), L"%B", L"%%B", FALSE, FALSE);\r
975136ab 2669 ASSERT_EFI_ERROR(Status);\r
a405b86d 2670 Status = ShellCopySearchAndReplace(mPostReplaceFormat2, mPostReplaceFormat, PcdGet16 (PcdShellPrintBufferSize), L"%V", L"%%V", FALSE, FALSE);\r
975136ab 2671 ASSERT_EFI_ERROR(Status);\r
2672\r
2673 //\r
2674 // Use the last buffer from replacing to print from...\r
2675 //\r
a405b86d 2676 UnicodeVSPrint (mPostReplaceFormat2, PcdGet16 (PcdShellPrintBufferSize), mPostReplaceFormat, Marker);\r
b1f95a06 2677\r
2678 if (Col != -1 && Row != -1) {\r
b1f95a06 2679 Status = gST->ConOut->SetCursorPosition(gST->ConOut, Col, Row);\r
975136ab 2680 }\r
2681\r
ecd3d59f 2682 FormatWalker = mPostReplaceFormat2;\r
2247dde4 2683 while (*FormatWalker != CHAR_NULL) {\r
975136ab 2684 //\r
2685 // Find the next attribute change request\r
2686 //\r
2687 ResumeLocation = StrStr(FormatWalker, L"%");\r
2688 if (ResumeLocation != NULL) {\r
2247dde4 2689 *ResumeLocation = CHAR_NULL;\r
975136ab 2690 }\r
2691 //\r
2692 // print the current FormatWalker string\r
2693 //\r
a405b86d 2694 if (StrLen(FormatWalker)>0) {\r
2695 Status = InternalPrintTo(FormatWalker);\r
2696 if (EFI_ERROR(Status)) {\r
2697 break;\r
2698 }\r
2699 }\r
2700\r
975136ab 2701 //\r
2702 // update the attribute\r
2703 //\r
2704 if (ResumeLocation != NULL) {\r
5d46f17b 2705 if (*(ResumeLocation-1) == L'^') {\r
2706 //\r
2707 // Print a simple '%' symbol\r
2708 //\r
2709 Status = InternalPrintTo(L"%");\r
2710 ResumeLocation = ResumeLocation - 1;\r
2711 } else {\r
2712 switch (*(ResumeLocation+1)) {\r
2713 case (L'N'):\r
2714 gST->ConOut->SetAttribute(gST->ConOut, OriginalAttribute);\r
a405b86d 2715 break;\r
5d46f17b 2716 case (L'E'):\r
2717 gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_YELLOW, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r
2718 break;\r
2719 case (L'H'):\r
2720 gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_WHITE, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r
2721 break;\r
2722 case (L'B'):\r
2723 gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_BLUE, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r
2724 break;\r
2725 case (L'V'):\r
2726 gST->ConOut->SetAttribute(gST->ConOut, EFI_TEXT_ATTR(EFI_GREEN, ((OriginalAttribute&(BIT4|BIT5|BIT6))>>4)));\r
2727 break;\r
2728 default:\r
2729 //\r
2730 // Print a simple '%' symbol\r
2731 //\r
2732 Status = InternalPrintTo(L"%");\r
2733 if (EFI_ERROR(Status)) {\r
2734 break;\r
2735 }\r
2736 ResumeLocation = ResumeLocation - 1;\r
2737 break;\r
2738 }\r
975136ab 2739 }\r
2740 } else {\r
2741 //\r
2742 // reset to normal now...\r
2743 //\r
975136ab 2744 break;\r
2745 }\r
2746\r
2747 //\r
2748 // update FormatWalker to Resume + 2 (skip the % and the indicator)\r
2749 //\r
2750 FormatWalker = ResumeLocation + 2;\r
2751 }\r
b1f95a06 2752\r
a405b86d 2753 gST->ConOut->SetAttribute(gST->ConOut, OriginalAttribute);\r
89e8537a 2754\r
2755 SHELL_FREE_NON_NULL(mPostReplaceFormat);\r
2756 SHELL_FREE_NON_NULL(mPostReplaceFormat2);\r
a405b86d 2757 return (Status);\r
5f7431d0 2758}\r
2247dde4 2759\r
2760/**\r
2761 Print at a specific location on the screen.\r
2762\r
e2f8297f 2763 This function will move the cursor to a given screen location and print the specified string.\r
1e6e84c7 2764\r
2765 If -1 is specified for either the Row or Col the current screen location for BOTH\r
2247dde4 2766 will be used.\r
2767\r
e2f8297f 2768 If either Row or Col is out of range for the current console, then ASSERT.\r
2769 If Format is NULL, then ASSERT.\r
2247dde4 2770\r
1e6e84c7 2771 In addition to the standard %-based flags as supported by UefiLib Print() this supports\r
2247dde4 2772 the following additional flags:\r
2773 %N - Set output attribute to normal\r
2774 %H - Set output attribute to highlight\r
2775 %E - Set output attribute to error\r
2776 %B - Set output attribute to blue color\r
2777 %V - Set output attribute to green color\r
2778\r
2779 Note: The background color is controlled by the shell command cls.\r
2780\r
2247dde4 2781 @param[in] Col the column to print at\r
a405b86d 2782 @param[in] Row the row to print at\r
2247dde4 2783 @param[in] Format the format string\r
a405b86d 2784 @param[in] ... The variable argument list.\r
2247dde4 2785\r
a405b86d 2786 @return EFI_SUCCESS The printing was successful.\r
2787 @return EFI_DEVICE_ERROR The console device reported an error.\r
2247dde4 2788**/\r
a405b86d 2789EFI_STATUS\r
2247dde4 2790EFIAPI\r
2791ShellPrintEx(\r
2792 IN INT32 Col OPTIONAL,\r
2793 IN INT32 Row OPTIONAL,\r
2794 IN CONST CHAR16 *Format,\r
2795 ...\r
1e6e84c7 2796 )\r
2247dde4 2797{\r
2798 VA_LIST Marker;\r
a405b86d 2799 EFI_STATUS RetVal;\r
3e082d58 2800 if (Format == NULL) {\r
2801 return (EFI_INVALID_PARAMETER);\r
2802 }\r
2247dde4 2803 VA_START (Marker, Format);\r
a405b86d 2804 RetVal = InternalShellPrintWorker(Col, Row, Format, Marker);\r
e2f8297f 2805 VA_END(Marker);\r
a405b86d 2806 return(RetVal);\r
2247dde4 2807}\r
2808\r
2809/**\r
2810 Print at a specific location on the screen.\r
2811\r
e2f8297f 2812 This function will move the cursor to a given screen location and print the specified string.\r
1e6e84c7 2813\r
2814 If -1 is specified for either the Row or Col the current screen location for BOTH\r
e2f8297f 2815 will be used.\r
2247dde4 2816\r
e2f8297f 2817 If either Row or Col is out of range for the current console, then ASSERT.\r
2818 If Format is NULL, then ASSERT.\r
2247dde4 2819\r
1e6e84c7 2820 In addition to the standard %-based flags as supported by UefiLib Print() this supports\r
2247dde4 2821 the following additional flags:\r
1e6e84c7 2822 %N - Set output attribute to normal.\r
2823 %H - Set output attribute to highlight.\r
2824 %E - Set output attribute to error.\r
2825 %B - Set output attribute to blue color.\r
2826 %V - Set output attribute to green color.\r
2247dde4 2827\r
2828 Note: The background color is controlled by the shell command cls.\r
2829\r
1e6e84c7 2830 @param[in] Col The column to print at.\r
a405b86d 2831 @param[in] Row The row to print at.\r
1e6e84c7 2832 @param[in] Language The language of the string to retrieve. If this parameter\r
2833 is NULL, then the current platform language is used.\r
2834 @param[in] HiiFormatStringId The format string Id for getting from Hii.\r
2835 @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r
a405b86d 2836 @param[in] ... The variable argument list.\r
2247dde4 2837\r
a405b86d 2838 @return EFI_SUCCESS The printing was successful.\r
2839 @return EFI_DEVICE_ERROR The console device reported an error.\r
2247dde4 2840**/\r
a405b86d 2841EFI_STATUS\r
2247dde4 2842EFIAPI\r
2843ShellPrintHiiEx(\r
2844 IN INT32 Col OPTIONAL,\r
2845 IN INT32 Row OPTIONAL,\r
1e6e84c7 2846 IN CONST CHAR8 *Language OPTIONAL,\r
2247dde4 2847 IN CONST EFI_STRING_ID HiiFormatStringId,\r
2848 IN CONST EFI_HANDLE HiiFormatHandle,\r
2849 ...\r
2850 )\r
2851{\r
2852 VA_LIST Marker;\r
2853 CHAR16 *HiiFormatString;\r
a405b86d 2854 EFI_STATUS RetVal;\r
2247dde4 2855\r
2856 VA_START (Marker, HiiFormatHandle);\r
1e6e84c7 2857 HiiFormatString = HiiGetString(HiiFormatHandle, HiiFormatStringId, Language);\r
2247dde4 2858 ASSERT(HiiFormatString != NULL);\r
2859\r
2860 RetVal = InternalShellPrintWorker(Col, Row, HiiFormatString, Marker);\r
2861\r
a405b86d 2862 SHELL_FREE_NON_NULL(HiiFormatString);\r
e2f8297f 2863 VA_END(Marker);\r
2247dde4 2864\r
2865 return (RetVal);\r
2866}\r
2867\r
2868/**\r
2869 Function to determine if a given filename represents a file or a directory.\r
2870\r
2871 @param[in] DirName Path to directory to test.\r
2872\r
2873 @retval EFI_SUCCESS The Path represents a directory\r
2874 @retval EFI_NOT_FOUND The Path does not represent a directory\r
2875 @return other The path failed to open\r
2876**/\r
2877EFI_STATUS\r
2878EFIAPI\r
2879ShellIsDirectory(\r
2880 IN CONST CHAR16 *DirName\r
2881 )\r
2882{\r
2883 EFI_STATUS Status;\r
a405b86d 2884 SHELL_FILE_HANDLE Handle;\r
3e082d58 2885 CHAR16 *TempLocation;\r
2886 CHAR16 *TempLocation2;\r
2247dde4 2887\r
ecd3d59f 2888 ASSERT(DirName != NULL);\r
2889\r
a405b86d 2890 Handle = NULL;\r
2891 TempLocation = NULL;\r
2247dde4 2892\r
2893 Status = ShellOpenFileByName(DirName, &Handle, EFI_FILE_MODE_READ, 0);\r
2894 if (EFI_ERROR(Status)) {\r
a405b86d 2895 //\r
2896 // try good logic first.\r
2897 //\r
366f81a0 2898 if (gEfiShellProtocol != NULL) {\r
3e082d58 2899 TempLocation = StrnCatGrow(&TempLocation, NULL, DirName, 0);\r
2900 TempLocation2 = StrStr(TempLocation, L":");\r
2901 if (TempLocation2 != NULL && StrLen(StrStr(TempLocation, L":")) == 2) {\r
2902 *(TempLocation2+1) = CHAR_NULL;\r
a405b86d 2903 }\r
366f81a0 2904 if (gEfiShellProtocol->GetDevicePathFromMap(TempLocation) != NULL) {\r
a405b86d 2905 FreePool(TempLocation);\r
2906 return (EFI_SUCCESS);\r
2907 }\r
2908 FreePool(TempLocation);\r
2909 } else {\r
2910 //\r
2911 // probably a map name?!?!!?\r
2912 //\r
2913 TempLocation = StrStr(DirName, L"\\");\r
2914 if (TempLocation != NULL && *(TempLocation+1) == CHAR_NULL) {\r
2915 return (EFI_SUCCESS);\r
2916 }\r
2917 }\r
2247dde4 2918 return (Status);\r
2919 }\r
2920\r
2921 if (FileHandleIsDirectory(Handle) == EFI_SUCCESS) {\r
2922 ShellCloseFile(&Handle);\r
2923 return (EFI_SUCCESS);\r
2924 }\r
2925 ShellCloseFile(&Handle);\r
2926 return (EFI_NOT_FOUND);\r
2927}\r
2928\r
36a9d672 2929/**\r
2930 Function to determine if a given filename represents a file.\r
2931\r
2932 @param[in] Name Path to file to test.\r
2933\r
2934 @retval EFI_SUCCESS The Path represents a file.\r
2935 @retval EFI_NOT_FOUND The Path does not represent a file.\r
2936 @retval other The path failed to open.\r
2937**/\r
2938EFI_STATUS\r
2939EFIAPI\r
2940ShellIsFile(\r
2941 IN CONST CHAR16 *Name\r
2942 )\r
2943{\r
2944 EFI_STATUS Status;\r
a405b86d 2945 SHELL_FILE_HANDLE Handle;\r
36a9d672 2946\r
ecd3d59f 2947 ASSERT(Name != NULL);\r
2948\r
36a9d672 2949 Handle = NULL;\r
2950\r
2951 Status = ShellOpenFileByName(Name, &Handle, EFI_FILE_MODE_READ, 0);\r
2952 if (EFI_ERROR(Status)) {\r
2953 return (Status);\r
2954 }\r
2955\r
2956 if (FileHandleIsDirectory(Handle) != EFI_SUCCESS) {\r
2957 ShellCloseFile(&Handle);\r
2958 return (EFI_SUCCESS);\r
2959 }\r
2960 ShellCloseFile(&Handle);\r
2961 return (EFI_NOT_FOUND);\r
2962}\r
2963\r
b3011f40 2964/**\r
2965 Function to determine if a given filename represents a file.\r
2966\r
2967 This will search the CWD and then the Path.\r
2968\r
2969 If Name is NULL, then ASSERT.\r
2970\r
2971 @param[in] Name Path to file to test.\r
2972\r
2973 @retval EFI_SUCCESS The Path represents a file.\r
2974 @retval EFI_NOT_FOUND The Path does not represent a file.\r
2975 @retval other The path failed to open.\r
2976**/\r
2977EFI_STATUS\r
2978EFIAPI\r
2979ShellIsFileInPath(\r
2980 IN CONST CHAR16 *Name\r
a405b86d 2981 )\r
2982{\r
b3011f40 2983 CHAR16 *NewName;\r
2984 EFI_STATUS Status;\r
2985\r
2986 if (!EFI_ERROR(ShellIsFile(Name))) {\r
a405b86d 2987 return (EFI_SUCCESS);\r
b3011f40 2988 }\r
2989\r
2990 NewName = ShellFindFilePath(Name);\r
2991 if (NewName == NULL) {\r
2992 return (EFI_NOT_FOUND);\r
2993 }\r
2994 Status = ShellIsFile(NewName);\r
2995 FreePool(NewName);\r
2996 return (Status);\r
2997}\r
252d9457 2998\r
125c2cf4 2999/**\r
1e6e84c7 3000 Function to determine whether a string is decimal or hex representation of a number\r
125c2cf4 3001 and return the number converted from the string.\r
3002\r
3003 @param[in] String String representation of a number\r
3004\r
252d9457 3005 @return the number\r
3006 @retval (UINTN)(-1) An error ocurred.\r
125c2cf4 3007**/\r
3008UINTN\r
3009EFIAPI\r
3010ShellStrToUintn(\r
3011 IN CONST CHAR16 *String\r
3012 )\r
3013{\r
252d9457 3014 UINT64 RetVal;\r
3015 BOOLEAN Hex;\r
3016\r
3017 Hex = FALSE;\r
3018\r
3019 if (!InternalShellIsHexOrDecimalNumber(String, Hex, TRUE)) {\r
3020 Hex = TRUE;\r
125c2cf4 3021 }\r
252d9457 3022\r
3023 if (!EFI_ERROR(ShellConvertStringToUint64(String, &RetVal, Hex, TRUE))) {\r
3024 return ((UINTN)RetVal);\r
3025 }\r
3026 return ((UINTN)(-1));\r
125c2cf4 3027}\r
3028\r
3029/**\r
3030 Safely append with automatic string resizing given length of Destination and\r
3031 desired length of copy from Source.\r
3032\r
3033 append the first D characters of Source to the end of Destination, where D is\r
3034 the lesser of Count and the StrLen() of Source. If appending those D characters\r
3035 will fit within Destination (whose Size is given as CurrentSize) and\r
1e6e84c7 3036 still leave room for a NULL terminator, then those characters are appended,\r
3037 starting at the original terminating NULL of Destination, and a new terminating\r
3038 NULL is appended.\r
125c2cf4 3039\r
3040 If appending D characters onto Destination will result in a overflow of the size\r
3041 given in CurrentSize the string will be grown such that the copy can be performed\r
3042 and CurrentSize will be updated to the new size.\r
3043\r
3044 If Source is NULL, there is nothing to append, just return the current buffer in\r
3045 Destination.\r
3046\r
3047 if Destination is NULL, then ASSERT()\r
3048 if Destination's current length (including NULL terminator) is already more then\r
3049 CurrentSize, then ASSERT()\r
3050\r
4ff7e37b
ED		 3051 @param[in, out] Destination The String to append onto\r
3052 @param[in, out] CurrentSize on call the number of bytes in Destination. On\r
125c2cf4 3053 return possibly the new size (still in bytes). if NULL\r
3054 then allocate whatever is needed.\r
3055 @param[in] Source The String to append from\r
3056 @param[in] Count Maximum number of characters to append. if 0 then\r
3057 all are appended.\r
3058\r
3059 @return Destination return the resultant string.\r
3060**/\r
3061CHAR16*\r
3062EFIAPI\r
3063StrnCatGrow (\r
3064 IN OUT CHAR16 **Destination,\r
3065 IN OUT UINTN *CurrentSize,\r
3066 IN CONST CHAR16 *Source,\r
3067 IN UINTN Count\r
3068 )\r
3069{\r
3070 UINTN DestinationStartSize;\r
3071 UINTN NewSize;\r
3072\r
3073 //\r
3074 // ASSERTs\r
3075 //\r
3076 ASSERT(Destination != NULL);\r
3077\r
3078 //\r
3079 // If there's nothing to do then just return Destination\r
3080 //\r
3081 if (Source == NULL) {\r
3082 return (*Destination);\r
3083 }\r
3084\r
3085 //\r
3086 // allow for un-initialized pointers, based on size being 0\r
3087 //\r
3088 if (CurrentSize != NULL && *CurrentSize == 0) {\r
3089 *Destination = NULL;\r
3090 }\r
3091\r
3092 //\r
3093 // allow for NULL pointers address as Destination\r
3094 //\r
3095 if (*Destination != NULL) {\r
3096 ASSERT(CurrentSize != 0);\r
3097 DestinationStartSize = StrSize(*Destination);\r
3098 ASSERT(DestinationStartSize <= *CurrentSize);\r
3099 } else {\r
3100 DestinationStartSize = 0;\r
3101// ASSERT(*CurrentSize == 0);\r
3102 }\r
3103\r
3104 //\r
3105 // Append all of Source?\r
3106 //\r
3107 if (Count == 0) {\r
3108 Count = StrLen(Source);\r
3109 }\r
3110\r
3111 //\r
3112 // Test and grow if required\r
3113 //\r
3114 if (CurrentSize != NULL) {\r
3115 NewSize = *CurrentSize;\r
3116 while (NewSize < (DestinationStartSize + (Count*sizeof(CHAR16)))) {\r
3117 NewSize += 2 * Count * sizeof(CHAR16);\r
3118 }\r
3119 *Destination = ReallocatePool(*CurrentSize, NewSize, *Destination);\r
3120 *CurrentSize = NewSize;\r
3121 } else {\r
3122 *Destination = AllocateZeroPool((Count+1)*sizeof(CHAR16));\r
3123 }\r
3124\r
3125 //\r
3126 // Now use standard StrnCat on a big enough buffer\r
3127 //\r
c9d92df0 3128 if (*Destination == NULL) {\r
3129 return (NULL);\r
3130 }\r
125c2cf4 3131 return StrnCat(*Destination, Source, Count);\r
3132}\r
c9d92df0 3133\r
3134/**\r
3135 Prompt the user and return the resultant answer to the requestor.\r
3136\r
3137 This function will display the requested question on the shell prompt and then\r
3138 wait for an apropriate answer to be input from the console.\r
3139\r
a405b86d 3140 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue\r
c9d92df0 3141 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.\r
3142\r
a405b86d 3143 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type\r
c9d92df0 3144 CHAR16*.\r
3145\r
3146 In either case *Response must be callee freed if Response was not NULL;\r
3147\r
3148 @param Type What type of question is asked. This is used to filter the input\r
3149 to prevent invalid answers to question.\r
3150 @param Prompt Pointer to string prompt to use to request input.\r
3151 @param Response Pointer to Response which will be populated upon return.\r
3152\r
3153 @retval EFI_SUCCESS The operation was sucessful.\r
3154 @retval EFI_UNSUPPORTED The operation is not supported as requested.\r
3155 @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
3156 @return other The operation failed.\r
3157**/\r
3158EFI_STATUS\r
3159EFIAPI\r
3160ShellPromptForResponse (\r
3161 IN SHELL_PROMPT_REQUEST_TYPE Type,\r
3162 IN CHAR16 *Prompt OPTIONAL,\r
3163 IN OUT VOID **Response OPTIONAL\r
3164 )\r
3165{\r
3166 EFI_STATUS Status;\r
3167 EFI_INPUT_KEY Key;\r
3168 UINTN EventIndex;\r
3169 SHELL_PROMPT_RESPONSE *Resp;\r
a405b86d 3170 UINTN Size;\r
3171 CHAR16 *Buffer;\r
c9d92df0 3172\r
a405b86d 3173 Status = EFI_UNSUPPORTED;\r
3174 Resp = NULL;\r
3175 Buffer = NULL;\r
3176 Size = 0;\r
3177 if (Type != ShellPromptResponseTypeFreeform) {\r
252d9457 3178 Resp = (SHELL_PROMPT_RESPONSE*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE));\r
3e082d58 3179 if (Resp == NULL) {\r
3180 return (EFI_OUT_OF_RESOURCES);\r
3181 }\r
90bfa227 3182 }\r
c9d92df0 3183\r
3184 switch(Type) {\r
a405b86d 3185 case ShellPromptResponseTypeQuitContinue:\r
c9d92df0 3186 if (Prompt != NULL) {\r
3187 ShellPrintEx(-1, -1, L"%s", Prompt);\r
3188 }\r
3189 //\r
3190 // wait for valid response\r
3191 //\r
3192 gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r
3193 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3194 ASSERT_EFI_ERROR(Status);\r
3195 ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r
3196 if (Key.UnicodeChar == L'Q' || Key.UnicodeChar ==L'q') {\r
a405b86d 3197 *Resp = ShellPromptResponseQuit;\r
c9d92df0 3198 } else {\r
a405b86d 3199 *Resp = ShellPromptResponseContinue;\r
c9d92df0 3200 }\r
3201 break;\r
a405b86d 3202 case ShellPromptResponseTypeYesNoCancel:\r
c9d92df0 3203 if (Prompt != NULL) {\r
3204 ShellPrintEx(-1, -1, L"%s", Prompt);\r
3205 }\r
3206 //\r
3207 // wait for valid response\r
3208 //\r
a405b86d 3209 *Resp = ShellPromptResponseMax;\r
3210 while (*Resp == ShellPromptResponseMax) {\r
c9d92df0 3211 gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r
3212 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3213 ASSERT_EFI_ERROR(Status);\r
3214 ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r
3215 switch (Key.UnicodeChar) {\r
3216 case L'Y':\r
3217 case L'y':\r
a405b86d 3218 *Resp = ShellPromptResponseYes;\r
c9d92df0 3219 break;\r
3220 case L'N':\r
3221 case L'n':\r
a405b86d 3222 *Resp = ShellPromptResponseNo;\r
3223 break;\r
3224 case L'C':\r
3225 case L'c':\r
3226 *Resp = ShellPromptResponseCancel;\r
3227 break;\r
3228 }\r
3229 }\r
3230 break; case ShellPromptResponseTypeYesNoAllCancel:\r
3231 if (Prompt != NULL) {\r
3232 ShellPrintEx(-1, -1, L"%s", Prompt);\r
3233 }\r
3234 //\r
3235 // wait for valid response\r
3236 //\r
3237 *Resp = ShellPromptResponseMax;\r
3238 while (*Resp == ShellPromptResponseMax) {\r
3239 gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r
3240 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3241 ASSERT_EFI_ERROR(Status);\r
3242 ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r
3243 switch (Key.UnicodeChar) {\r
3244 case L'Y':\r
3245 case L'y':\r
3246 *Resp = ShellPromptResponseYes;\r
3247 break;\r
3248 case L'N':\r
3249 case L'n':\r
3250 *Resp = ShellPromptResponseNo;\r
c9d92df0 3251 break;\r
3252 case L'A':\r
3253 case L'a':\r
a405b86d 3254 *Resp = ShellPromptResponseAll;\r
c9d92df0 3255 break;\r
3256 case L'C':\r
3257 case L'c':\r
a405b86d 3258 *Resp = ShellPromptResponseCancel;\r
c9d92df0 3259 break;\r
3260 }\r
3261 }\r
3262 break;\r
a405b86d 3263 case ShellPromptResponseTypeEnterContinue:\r
3264 case ShellPromptResponseTypeAnyKeyContinue:\r
c9d92df0 3265 if (Prompt != NULL) {\r
3266 ShellPrintEx(-1, -1, L"%s", Prompt);\r
3267 }\r
3268 //\r
3269 // wait for valid response\r
3270 //\r
a405b86d 3271 *Resp = ShellPromptResponseMax;\r
3272 while (*Resp == ShellPromptResponseMax) {\r
c9d92df0 3273 gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r
a405b86d 3274 if (Type == ShellPromptResponseTypeEnterContinue) {\r
c9d92df0 3275 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3276 ASSERT_EFI_ERROR(Status);\r
3277 ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r
3278 if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r
a405b86d 3279 *Resp = ShellPromptResponseContinue;\r
c9d92df0 3280 break;\r
3281 }\r
3282 }\r
a405b86d 3283 if (Type == ShellPromptResponseTypeAnyKeyContinue) {\r
3284 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3285 ASSERT_EFI_ERROR(Status);\r
3286 *Resp = ShellPromptResponseContinue;\r
3287 break;\r
3288 }\r
3289 }\r
3290 break;\r
3291 case ShellPromptResponseTypeYesNo:\r
3292 if (Prompt != NULL) {\r
3293 ShellPrintEx(-1, -1, L"%s", Prompt);\r
3294 }\r
3295 //\r
3296 // wait for valid response\r
3297 //\r
3298 *Resp = ShellPromptResponseMax;\r
3299 while (*Resp == ShellPromptResponseMax) {\r
3300 gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r
3301 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3302 ASSERT_EFI_ERROR(Status);\r
3303 ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r
3304 switch (Key.UnicodeChar) {\r
3305 case L'Y':\r
3306 case L'y':\r
3307 *Resp = ShellPromptResponseYes;\r
3308 break;\r
3309 case L'N':\r
3310 case L'n':\r
3311 *Resp = ShellPromptResponseNo;\r
3312 break;\r
3313 }\r
3314 }\r
3315 break;\r
3316 case ShellPromptResponseTypeFreeform:\r
3317 if (Prompt != NULL) {\r
3318 ShellPrintEx(-1, -1, L"%s", Prompt);\r
3319 }\r
3320 while(1) {\r
3321 gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &EventIndex);\r
3322 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3323 ASSERT_EFI_ERROR(Status);\r
3324 ShellPrintEx(-1, -1, L"%c", Key.UnicodeChar);\r
3325 if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r
c9d92df0 3326 break;\r
3327 }\r
a405b86d 3328 ASSERT((Buffer == NULL && Size == 0) || (Buffer != NULL));\r
3329 StrnCatGrow(&Buffer, &Size, &Key.UnicodeChar, 1);\r
c9d92df0 3330 }\r
3331 break;\r
a405b86d 3332 //\r
3333 // This is the location to add new prompt types.\r
3334 //\r
c9d92df0 3335 default:\r
a405b86d 3336 ASSERT(FALSE);\r
c9d92df0 3337 }\r
3338\r
3339 if (Response != NULL) {\r
a405b86d 3340 if (Resp != NULL) {\r
3341 *Response = Resp;\r
3342 } else if (Buffer != NULL) {\r
3343 *Response = Buffer;\r
3344 }\r
c9d92df0 3345 } else {\r
a405b86d 3346 if (Resp != NULL) {\r
3347 FreePool(Resp);\r
3348 }\r
3349 if (Buffer != NULL) {\r
3350 FreePool(Buffer);\r
3351 }\r
c9d92df0 3352 }\r
3353\r
a405b86d 3354 ShellPrintEx(-1, -1, L"\r\n");\r
c9d92df0 3355 return (Status);\r
3356}\r
3357\r
3358/**\r
3359 Prompt the user and return the resultant answer to the requestor.\r
3360\r
3361 This function is the same as ShellPromptForResponse, except that the prompt is\r
3362 automatically pulled from HII.\r
3363\r
3364 @param Type What type of question is asked. This is used to filter the input\r
3365 to prevent invalid answers to question.\r
a405b86d 3366 @param[in] HiiFormatStringId The format string Id for getting from Hii.\r
3367 @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r
3368 @param Response Pointer to Response which will be populated upon return.\r
c9d92df0 3369\r
3370 @retval EFI_SUCCESS the operation was sucessful.\r
3371 @return other the operation failed.\r
3372\r
3373 @sa ShellPromptForResponse\r
3374**/\r
3375EFI_STATUS\r
3376EFIAPI\r
3377ShellPromptForResponseHii (\r
3378 IN SHELL_PROMPT_REQUEST_TYPE Type,\r
3379 IN CONST EFI_STRING_ID HiiFormatStringId,\r
3380 IN CONST EFI_HANDLE HiiFormatHandle,\r
3381 IN OUT VOID **Response\r
3382 )\r
3383{\r
3384 CHAR16 *Prompt;\r
3385 EFI_STATUS Status;\r
3386\r
3387 Prompt = HiiGetString(HiiFormatHandle, HiiFormatStringId, NULL);\r
3388 Status = ShellPromptForResponse(Type, Prompt, Response);\r
3389 FreePool(Prompt);\r
3390 return (Status);\r
3391}\r
3392\r
a405b86d 3393/**\r
3394 Function to determin if an entire string is a valid number.\r
3395\r
3396 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r
c9d92df0 3397\r
a405b86d 3398 @param[in] String The string to evaluate.\r
3399 @param[in] ForceHex TRUE - always assume hex.\r
3400 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.\r
3401\r
3402 @retval TRUE It is all numeric (dec/hex) characters.\r
3403 @retval FALSE There is a non-numeric character.\r
3404**/\r
3405BOOLEAN\r
3406EFIAPI\r
252d9457 3407InternalShellIsHexOrDecimalNumber (\r
a405b86d 3408 IN CONST CHAR16 *String,\r
3409 IN CONST BOOLEAN ForceHex,\r
3410 IN CONST BOOLEAN StopAtSpace\r
3411 )\r
3412{\r
3413 BOOLEAN Hex;\r
3414\r
3415 //\r
3416 // chop off a single negative sign\r
3417 //\r
3418 if (String != NULL && *String == L'-') {\r
3419 String++;\r
3420 }\r
3421 \r
3422 if (String == NULL) {\r
3423 return (FALSE);\r
3424 }\r
3425\r
3426 //\r
3427 // chop leading zeroes\r
3428 //\r
3429 while(String != NULL && *String == L'0'){\r
3430 String++;\r
3431 }\r
3432 //\r
3433 // allow '0x' or '0X', but not 'x' or 'X'\r
3434 //\r
3435 if (String != NULL && (*String == L'x' || *String == L'X')) {\r
3436 if (*(String-1) != L'0') {\r
3437 //\r
3438 // we got an x without a preceeding 0\r
3439 //\r
3440 return (FALSE);\r
3441 }\r
3442 String++;\r
3443 Hex = TRUE;\r
3444 } else if (ForceHex) {\r
3445 Hex = TRUE;\r
3446 } else {\r
3447 Hex = FALSE;\r
3448 }\r
3449\r
3450 //\r
3451 // loop through the remaining characters and use the lib function\r
3452 //\r
3453 for ( ; String != NULL && *String != CHAR_NULL && !(StopAtSpace && *String == L' ') ; String++){\r
3454 if (Hex) {\r
3455 if (!ShellIsHexaDecimalDigitCharacter(*String)) {\r
3456 return (FALSE);\r
3457 }\r
3458 } else {\r
3459 if (!ShellIsDecimalDigitCharacter(*String)) {\r
3460 return (FALSE);\r
3461 }\r
3462 }\r
3463 }\r
252d9457 3464\r
a405b86d 3465 return (TRUE);\r
3466}\r
3467\r
3468/**\r
3469 Function to determine if a given filename exists.\r
3470\r
3471 @param[in] Name Path to test.\r
3472\r
3473 @retval EFI_SUCCESS The Path represents a file.\r
3474 @retval EFI_NOT_FOUND The Path does not represent a file.\r
3475 @retval other The path failed to open.\r
3476**/\r
3477EFI_STATUS\r
3478EFIAPI\r
3479ShellFileExists(\r
3480 IN CONST CHAR16 *Name\r
3481 )\r
3482{\r
3483 EFI_STATUS Status;\r
3484 EFI_SHELL_FILE_INFO *List;\r
3485\r
3486 ASSERT(Name != NULL);\r
3487\r
3488 List = NULL;\r
3489 Status = ShellOpenFileMetaArg((CHAR16*)Name, EFI_FILE_MODE_READ, &List);\r
3490 if (EFI_ERROR(Status)) {\r
3491 return (Status);\r
3492 }\r
3493\r
3494 ShellCloseFileMetaArg(&List);\r
3495\r
3496 return (EFI_SUCCESS);\r
3497}\r
252d9457 3498\r
3499/**\r
3500 Convert a Unicode character to upper case only if \r
3501 it maps to a valid small-case ASCII character.\r
3502\r
3503 This internal function only deal with Unicode character\r
3504 which maps to a valid small-case ASCII character, i.e.\r
3505 L'a' to L'z'. For other Unicode character, the input character\r
3506 is returned directly.\r
3507\r
3508 @param Char The character to convert.\r
3509\r
3510 @retval LowerCharacter If the Char is with range L'a' to L'z'.\r
3511 @retval Unchanged Otherwise.\r
3512\r
3513**/\r
3514CHAR16\r
3515EFIAPI\r
3516InternalShellCharToUpper (\r
3517 IN CHAR16 Char\r
3518 )\r
3519{\r
3520 if (Char >= L'a' && Char <= L'z') {\r
3521 return (CHAR16) (Char - (L'a' - L'A'));\r
3522 }\r
3523\r
3524 return Char;\r
3525}\r
3526\r
3527/**\r
3528 Convert a Unicode character to numerical value.\r
3529\r
3530 This internal function only deal with Unicode character\r
3531 which maps to a valid hexadecimal ASII character, i.e.\r
3532 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other \r
3533 Unicode character, the value returned does not make sense.\r
3534\r
3535 @param Char The character to convert.\r
3536\r
3537 @return The numerical value converted.\r
3538\r
3539**/\r
3540UINTN\r
3541EFIAPI\r
3542InternalShellHexCharToUintn (\r
3543 IN CHAR16 Char\r
3544 )\r
3545{\r
3546 if (ShellIsDecimalDigitCharacter (Char)) {\r
3547 return Char - L'0';\r
3548 }\r
3549\r
3550 return (UINTN) (10 + InternalShellCharToUpper (Char) - L'A');\r
3551}\r
3552\r
3553/**\r
3554 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.\r
3555\r
3556 This function returns a value of type UINTN by interpreting the contents\r
3557 of the Unicode string specified by String as a hexadecimal number.\r
3558 The format of the input Unicode string String is:\r
3559\r
3560 [spaces][zeros][x][hexadecimal digits].\r
3561\r
3562 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].\r
3563 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.\r
3564 If "x" appears in the input string, it must be prefixed with at least one 0.\r
3565 The function will ignore the pad space, which includes spaces or tab characters,\r
3566 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or\r
3567 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the\r
3568 first valid hexadecimal digit. Then, the function stops at the first character that is\r
3569 a not a valid hexadecimal character or NULL, whichever one comes first.\r
3570\r
3571 If String has only pad spaces, then zero is returned.\r
3572 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,\r
3573 then zero is returned.\r
3574\r
3575 @param[in] String A pointer to a Null-terminated Unicode string.\r
3576 @param[out] Value Upon a successful return the value of the conversion.\r
3577 @param[in] StopAtSpace FALSE to skip spaces.\r
3578\r
3579 @retval EFI_SUCCESS The conversion was successful.\r
3580 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.\r
3581 @retval EFI_DEVICE_ERROR An overflow occured.\r
3582**/\r
3583EFI_STATUS\r
3584EFIAPI\r
3585InternalShellStrHexToUint64 (\r
3586 IN CONST CHAR16 *String,\r
3587 OUT UINT64 *Value,\r
3588 IN CONST BOOLEAN StopAtSpace\r
3589 )\r
3590{\r
3591 UINT64 Result;\r
3592\r
3593 if (String == NULL || StrSize(String) == 0 || Value == NULL) {\r
3594 return (EFI_INVALID_PARAMETER);\r
3595 }\r
3596 \r
3597 //\r
3598 // Ignore the pad spaces (space or tab) \r
3599 //\r
3600 while ((*String == L' ') || (*String == L'\t')) {\r
3601 String++;\r
3602 }\r
3603\r
3604 //\r
3605 // Ignore leading Zeros after the spaces\r
3606 //\r
3607 while (*String == L'0') {\r
3608 String++;\r
3609 }\r
3610\r
3611 if (InternalShellCharToUpper (*String) == L'X') {\r
3612 if (*(String - 1) != L'0') {\r
3613 return 0;\r
3614 }\r
3615 //\r
3616 // Skip the 'X'\r
3617 //\r
3618 String++;\r
3619 }\r
3620\r
3621 Result = 0;\r
3622 \r
3623 //\r
3624 // Skip spaces if requested\r
3625 //\r
3626 while (StopAtSpace && *String == L' ') {\r
3627 String++;\r
3628 }\r
3629 \r
3630 while (ShellIsHexaDecimalDigitCharacter (*String)) {\r
3631 //\r
3632 // If the Hex Number represented by String overflows according \r
3633 // to the range defined by UINTN, then ASSERT().\r
3634 //\r
3635 if (!(Result <= (RShiftU64((((UINT64) ~0) - InternalShellHexCharToUintn (*String)), 4)))) {\r
3636// if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {\r
3637 return (EFI_DEVICE_ERROR);\r
3638 }\r
3639\r
3640 Result = (LShiftU64(Result, 4));\r
3641 Result += InternalShellHexCharToUintn (*String);\r
3642 String++;\r
3643\r
3644 //\r
3645 // Skip spaces if requested\r
3646 //\r
3647 while (StopAtSpace && *String == L' ') {\r
3648 String++;\r
3649 }\r
3650 }\r
3651\r
3652 *Value = Result;\r
3653 return (EFI_SUCCESS);\r
3654}\r
3655\r
3656/**\r
3657 Convert a Null-terminated Unicode decimal string to a value of\r
3658 type UINT64.\r
3659\r
3660 This function returns a value of type UINT64 by interpreting the contents\r
3661 of the Unicode string specified by String as a decimal number. The format\r
3662 of the input Unicode string String is:\r
3663\r
3664 [spaces] [decimal digits].\r
3665\r
3666 The valid decimal digit character is in the range [0-9]. The\r
3667 function will ignore the pad space, which includes spaces or\r
3668 tab characters, before [decimal digits]. The running zero in the\r
3669 beginning of [decimal digits] will be ignored. Then, the function\r
3670 stops at the first character that is a not a valid decimal character\r
3671 or a Null-terminator, whichever one comes first.\r
3672\r
3673 If String has only pad spaces, then 0 is returned.\r
3674 If String has no pad spaces or valid decimal digits,\r
3675 then 0 is returned.\r
3676\r
3677 @param[in] String A pointer to a Null-terminated Unicode string.\r
3678 @param[out] Value Upon a successful return the value of the conversion.\r
3679 @param[in] StopAtSpace FALSE to skip spaces.\r
3680\r
3681 @retval EFI_SUCCESS The conversion was successful.\r
3682 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.\r
3683 @retval EFI_DEVICE_ERROR An overflow occured.\r
3684**/\r
3685EFI_STATUS\r
3686EFIAPI\r
3687InternalShellStrDecimalToUint64 (\r
3688 IN CONST CHAR16 *String,\r
3689 OUT UINT64 *Value,\r
3690 IN CONST BOOLEAN StopAtSpace\r
3691 )\r
3692{\r
3693 UINT64 Result;\r
3694\r
3695 if (String == NULL || StrSize (String) == 0 || Value == NULL) {\r
3696 return (EFI_INVALID_PARAMETER);\r
3697 }\r
3698\r
3699 //\r
3700 // Ignore the pad spaces (space or tab)\r
3701 //\r
3702 while ((*String == L' ') || (*String == L'\t')) {\r
3703 String++;\r
3704 }\r
3705\r
3706 //\r
3707 // Ignore leading Zeros after the spaces\r
3708 //\r
3709 while (*String == L'0') {\r
3710 String++;\r
3711 }\r
3712\r
3713 Result = 0;\r
3714\r
3715 //\r
3716 // Skip spaces if requested\r
3717 //\r
3718 while (StopAtSpace && *String == L' ') {\r
3719 String++;\r
3720 }\r
3721 while (ShellIsDecimalDigitCharacter (*String)) {\r
3722 //\r
3723 // If the number represented by String overflows according \r
3724 // to the range defined by UINT64, then ASSERT().\r
3725 //\r
3726 \r
3727 if (!(Result <= (DivU64x32((((UINT64) ~0) - (*String - L'0')),10)))) {\r
3728 return (EFI_DEVICE_ERROR);\r
3729 }\r
3730\r
3731 Result = MultU64x32(Result, 10) + (*String - L'0');\r
3732 String++;\r
3733\r
3734 //\r
3735 // Stop at spaces if requested\r
3736 //\r
3737 if (StopAtSpace && *String == L' ') {\r
3738 break;\r
3739 }\r
3740 }\r
3741\r
3742 *Value = Result;\r
3743 \r
3744 return (EFI_SUCCESS);\r
3745}\r
3746\r
3747/**\r
3748 Function to verify and convert a string to its numerical value.\r
3749\r
3750 If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.\r
3751\r
3752 @param[in] String The string to evaluate.\r
3753 @param[out] Value Upon a successful return the value of the conversion.\r
3754 @param[in] ForceHex TRUE - always assume hex.\r
3755 @param[in] StopAtSpace FALSE to skip spaces.\r
3756 \r
3757 @retval EFI_SUCCESS The conversion was successful.\r
3758 @retval EFI_INVALID_PARAMETER String contained an invalid character.\r
3759 @retval EFI_NOT_FOUND String was a number, but Value was NULL.\r
3760**/\r
3761EFI_STATUS\r
3762EFIAPI\r
3763ShellConvertStringToUint64(\r
3764 IN CONST CHAR16 *String,\r
3765 OUT UINT64 *Value,\r
3766 IN CONST BOOLEAN ForceHex,\r
3767 IN CONST BOOLEAN StopAtSpace\r
3768 )\r
3769{\r
3770 UINT64 RetVal;\r
3771 CONST CHAR16 *Walker;\r
3772 EFI_STATUS Status;\r
3773 BOOLEAN Hex;\r
3774\r
3775 Hex = ForceHex;\r
3776\r
3777 if (!InternalShellIsHexOrDecimalNumber(String, Hex, StopAtSpace)) {\r
3778 if (!Hex) {\r
3779 Hex = TRUE;\r
3780 if (!InternalShellIsHexOrDecimalNumber(String, Hex, StopAtSpace)) {\r
3781 return (EFI_INVALID_PARAMETER);\r
3782 }\r
3783 } else {\r
3784 return (EFI_INVALID_PARAMETER);\r
3785 }\r
3786 }\r
3787\r
3788 //\r
3789 // Chop off leading spaces\r
3790 //\r
3791 for (Walker = String; Walker != NULL && *Walker != CHAR_NULL && *Walker == L' '; Walker++);\r
3792\r
3793 //\r
3794 // make sure we have something left that is numeric.\r
3795 //\r
3796 if (Walker == NULL || *Walker == CHAR_NULL || !InternalShellIsHexOrDecimalNumber(Walker, Hex, StopAtSpace)) {\r
3797 return (EFI_INVALID_PARAMETER);\r
3798 } \r
3799\r
3800 //\r
3801 // do the conversion.\r
3802 //\r
3803 if (Hex || StrnCmp(Walker, L"0x", 2) == 0 || StrnCmp(Walker, L"0X", 2) == 0){\r
3804 Status = InternalShellStrHexToUint64(Walker, &RetVal, StopAtSpace);\r
3805 } else {\r
3806 Status = InternalShellStrDecimalToUint64(Walker, &RetVal, StopAtSpace);\r
3807 }\r
3808\r
3809 if (Value == NULL && !EFI_ERROR(Status)) {\r
3810 return (EFI_NOT_FOUND);\r
3811 }\r
3812\r
3813 if (Value != NULL) {\r
3814 *Value = RetVal;\r
3815 }\r
3816\r
3817 return (Status);\r
3818}\r
3819\r
3820/**\r
3821 Function to determin if an entire string is a valid number.\r
3822\r
3823 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r
3824\r
3825 @param[in] String The string to evaluate.\r
3826 @param[in] ForceHex TRUE - always assume hex.\r
3827 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.\r
3828\r
3829 @retval TRUE It is all numeric (dec/hex) characters.\r
3830 @retval FALSE There is a non-numeric character.\r
3831**/\r
3832BOOLEAN\r
3833EFIAPI\r
3834ShellIsHexOrDecimalNumber (\r
3835 IN CONST CHAR16 *String,\r
3836 IN CONST BOOLEAN ForceHex,\r
3837 IN CONST BOOLEAN StopAtSpace\r
3838 )\r
3839{\r
3840 if (ShellConvertStringToUint64(String, NULL, ForceHex, StopAtSpace) == EFI_NOT_FOUND) {\r
3841 return (TRUE);\r
3842 }\r
3843 return (FALSE);\r
3844}\r
4d0a4fce 3845\r
3846/**\r
3847 Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned\r
3848 buffer. The returned buffer must be callee freed.\r
3849\r
3850 If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
3851 maintained and not changed for all operations with the same file.\r
3852\r
4ff7e37b
ED		 3853 @param[in] Handle SHELL_FILE_HANDLE to read from.\r
3854 @param[in, out] Ascii Boolean value for indicating whether the file is\r
3855 Ascii (TRUE) or UCS2 (FALSE).\r
4d0a4fce 3856\r
beab0fc5 3857 @return The line of text from the file.\r
3858 @retval NULL There was not enough memory available.\r
4d0a4fce 3859\r
3860 @sa ShellFileHandleReadLine\r
3861**/\r
3862CHAR16*\r
3863EFIAPI\r
3864ShellFileHandleReturnLine(\r
3865 IN SHELL_FILE_HANDLE Handle,\r
3866 IN OUT BOOLEAN *Ascii\r
3867 )\r
3868{\r
3869 CHAR16 *RetVal;\r
3870 UINTN Size;\r
3871 EFI_STATUS Status;\r
3872\r
3873 Size = 0;\r
3874 RetVal = NULL;\r
3875\r
3876 Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);\r
3877 if (Status == EFI_BUFFER_TOO_SMALL) {\r
3878 RetVal = AllocateZeroPool(Size);\r
beab0fc5 3879 if (RetVal == NULL) {\r
3880 return (NULL);\r
3881 }\r
4d0a4fce 3882 Status = ShellFileHandleReadLine(Handle, RetVal, &Size, FALSE, Ascii);\r
beab0fc5 3883 \r
4d0a4fce 3884 }\r
4d0a4fce 3885 if (EFI_ERROR(Status) && (RetVal != NULL)) {\r
3886 FreePool(RetVal);\r
3887 RetVal = NULL;\r
3888 }\r
3889 return (RetVal);\r
3890}\r
3891\r
3892/**\r
3893 Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.\r
3894\r
3895 If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
3896 maintained and not changed for all operations with the same file.\r
3897\r
4ff7e37b
ED		 3898 @param[in] Handle SHELL_FILE_HANDLE to read from.\r
3899 @param[in, out] Buffer The pointer to buffer to read into.\r
3900 @param[in, out] Size The pointer to number of bytes in Buffer.\r
3901 @param[in] Truncate If the buffer is large enough, this has no effect.\r
3902 If the buffer is is too small and Truncate is TRUE,\r
3903 the line will be truncated.\r
3904 If the buffer is is too small and Truncate is FALSE,\r
3905 then no read will occur.\r
3906\r
3907 @param[in, out] Ascii Boolean value for indicating whether the file is\r
3908 Ascii (TRUE) or UCS2 (FALSE).\r
4d0a4fce 3909\r
3910 @retval EFI_SUCCESS The operation was successful. The line is stored in\r
3911 Buffer.\r
3912 @retval EFI_INVALID_PARAMETER Handle was NULL.\r
3913 @retval EFI_INVALID_PARAMETER Size was NULL.\r
3914 @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.\r
3915 Size was updated to the minimum space required.\r
3916**/\r
3917EFI_STATUS\r
3918EFIAPI\r
3919ShellFileHandleReadLine(\r
3920 IN SHELL_FILE_HANDLE Handle,\r
3921 IN OUT CHAR16 *Buffer,\r
3922 IN OUT UINTN *Size,\r
3923 IN BOOLEAN Truncate,\r
3924 IN OUT BOOLEAN *Ascii\r
3925 )\r
3926{\r
3927 EFI_STATUS Status;\r
3928 CHAR16 CharBuffer;\r
3929 UINTN CharSize;\r
3930 UINTN CountSoFar;\r
3931 UINT64 OriginalFilePosition;\r
3932\r
3933\r
3934 if (Handle == NULL\r
3935 ||Size == NULL\r
3936 ){\r
3937 return (EFI_INVALID_PARAMETER);\r
3938 }\r
3939 if (Buffer == NULL) {\r
3940 ASSERT(*Size == 0);\r
3941 } else {\r
3942 *Buffer = CHAR_NULL;\r
3943 }\r
3944 gEfiShellProtocol->GetFilePosition(Handle, &OriginalFilePosition);\r
3945 if (OriginalFilePosition == 0) {\r
3946 CharSize = sizeof(CHAR16);\r
3947 Status = gEfiShellProtocol->ReadFile(Handle, &CharSize, &CharBuffer);\r
3948 ASSERT_EFI_ERROR(Status);\r
3949 if (CharBuffer == gUnicodeFileTag) {\r
3950 *Ascii = FALSE;\r
3951 } else {\r
3952 *Ascii = TRUE;\r
3953 gEfiShellProtocol->SetFilePosition(Handle, OriginalFilePosition);\r
3954 }\r
3955 }\r
3956\r
3957 for (CountSoFar = 0;;CountSoFar++){\r
3958 CharBuffer = 0;\r
3959 if (*Ascii) {\r
3960 CharSize = sizeof(CHAR8);\r
3961 } else {\r
3962 CharSize = sizeof(CHAR16);\r
3963 }\r
3964 Status = gEfiShellProtocol->ReadFile(Handle, &CharSize, &CharBuffer);\r
3965 if ( EFI_ERROR(Status)\r
3966 || CharSize == 0\r
3967 || (CharBuffer == L'\n' && !(*Ascii))\r
3968 || (CharBuffer == '\n' && *Ascii)\r
3969 ){\r
3970 break;\r
3971 }\r
3972 //\r
3973 // if we have space save it...\r
3974 //\r
3975 if ((CountSoFar+1)*sizeof(CHAR16) < *Size){\r
3976 ASSERT(Buffer != NULL);\r
3977 ((CHAR16*)Buffer)[CountSoFar] = CharBuffer;\r
3978 ((CHAR16*)Buffer)[CountSoFar+1] = CHAR_NULL;\r
3979 }\r
3980 }\r
3981\r
3982 //\r
3983 // if we ran out of space tell when...\r
3984 //\r
3985 if ((CountSoFar+1)*sizeof(CHAR16) > *Size){\r
3986 *Size = (CountSoFar+1)*sizeof(CHAR16);\r
3987 if (!Truncate) {\r
3988 gEfiShellProtocol->SetFilePosition(Handle, OriginalFilePosition);\r
3989 } else {\r
3990 DEBUG((DEBUG_WARN, "The line was truncated in ShellFileHandleReadLine"));\r
3991 }\r
3992 return (EFI_BUFFER_TOO_SMALL);\r
3993 }\r
3994 while(Buffer[StrLen(Buffer)-1] == L'\r') {\r
3995 Buffer[StrLen(Buffer)-1] = CHAR_NULL;\r
3996 }\r
3997\r
3998 return (Status);\r
3999}\r
EFI Development Kit II mirror for PVE