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