2 Main file for map shell level 2 command.
4 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "UefiShellLevel2CommandsLib.h"
16 #include <Protocol/SimpleFileSystem.h>
17 #include <Protocol/BlockIo.h>
18 #include <Library/DevicePathLib.h>
19 #include <Library/HandleParsingLib.h>
20 #include <Library/SortLib.h>
23 Determine if a string has only numbers and letters.
25 This is useful for such things as Map names which can only be letters and numbers.
27 @param[in] String pointer to the string to analyze,
28 @param[in] Len Number of characters to analyze.
30 @retval TRUE String has only numbers and letters
31 @retval FALSE String has at least one other character.
36 IN CONST CHAR16
*String
,
41 for (Count
= 0 ; Count
< Len
&& String
!= NULL
&& *String
!= CHAR_NULL
; String
++,Count
++) {
42 if (! ((*String
>= L
'a' && *String
<= L
'z') ||
43 (*String
>= L
'A' && *String
<= L
'Z') ||
44 (*String
>= L
'0' && *String
<= L
'9'))
53 Do a search in the Target delimited list.
55 @param[in] List The list to seatch in.
56 @param[in] MetaTarget The item to search for. MetaMatching supported.
57 @param[out] FullName Optional pointer to an allocated buffer containing
59 @param[in] Meta TRUE to use MetaMatching.
60 @param[in] SkipTrailingNumbers TRUE to allow for numbers after the MetaTarget.
61 @param[in] Target The single character that delimits list
67 IN CONST CHAR16
*List
,
68 IN CONST CHAR16
*MetaTarget
,
69 OUT CHAR16
**FullName OPTIONAL
,
70 IN CONST BOOLEAN Meta
,
71 IN CONST BOOLEAN SkipTrailingNumbers
,
72 IN CONST CHAR16
*Target
77 CONST CHAR16
*ListWalker
;
81 for (ListWalker
= List
, TempList
= NULL
82 ; ListWalker
!= NULL
&& *ListWalker
!= CHAR_NULL
85 TempList
= StrnCatGrow(&TempList
, NULL
, ListWalker
, 0);
86 ASSERT(TempList
!= NULL
);
87 TempSpot
= StrStr(TempList
, Target
);
88 if (TempSpot
!= NULL
) {
89 *TempSpot
= CHAR_NULL
;
92 while (SkipTrailingNumbers
&& (ShellIsDecimalDigitCharacter(TempList
[StrLen(TempList
)-1]) || TempList
[StrLen(TempList
)-1] == L
':')) {
93 TempList
[StrLen(TempList
)-1] = CHAR_NULL
;
96 ListWalker
= StrStr(ListWalker
, Target
);
97 while(ListWalker
!= NULL
&& *ListWalker
== *Target
) {
101 Result
= gUnicodeCollation
->MetaiMatch(gUnicodeCollation
, (CHAR16
*)TempList
, (CHAR16
*)MetaTarget
);
103 Result
= (BOOLEAN
)(StrCmp(TempList
, MetaTarget
)==0);
106 if (FullName
!= NULL
) {
107 *FullName
= TempList
;
121 Add mappings for any devices without one. Do not change any existing maps.
123 @retval EFI_SUCCESS The operation was successful.
132 EFI_HANDLE
*HandleList
;
134 EFI_DEVICE_PATH_PROTOCOL
**DevicePathList
;
135 CHAR16
*NewDefaultName
;
136 CHAR16
*NewConsistName
;
137 EFI_DEVICE_PATH_PROTOCOL
**ConsistMappingTable
;
140 Status
= EFI_SUCCESS
;
143 // remove mappings that represent removed devices.
147 // Find each handle with Simple File System
149 HandleList
= GetHandleListByProtocol(&gEfiSimpleFileSystemProtocolGuid
);
150 if (HandleList
!= NULL
) {
152 // Do a count of the handles
154 for (Count
= 0 ; HandleList
[Count
] != NULL
; Count
++);
157 // Get all Device Paths
159 DevicePathList
= AllocateZeroPool(sizeof(EFI_DEVICE_PATH_PROTOCOL
*) * Count
);
160 ASSERT(DevicePathList
!= NULL
);
162 for (Count
= 0 ; HandleList
[Count
] != NULL
; Count
++) {
163 DevicePathList
[Count
] = DevicePathFromHandle(HandleList
[Count
]);
167 // Sort all DevicePaths
169 PerformQuickSort(DevicePathList
, Count
, sizeof(EFI_DEVICE_PATH_PROTOCOL
*), DevicePathCompare
);
171 ShellCommandConsistMappingInitialize(&ConsistMappingTable
);
174 // Assign new Mappings to remainders
176 for (Count
= 0 ; HandleList
[Count
] != NULL
&& !EFI_ERROR(Status
); Count
++) {
178 // Skip ones that already have
180 if (gEfiShellProtocol
->GetMapFromDevicePath(&DevicePathList
[Count
]) != NULL
) {
186 NewDefaultName
= ShellCommandCreateNewMappingName(MappingTypeFileSystem
);
187 ASSERT(NewDefaultName
!= NULL
);
190 // Call shell protocol SetMap function now...
192 Status
= gEfiShellProtocol
->SetMap(DevicePathList
[Count
], NewDefaultName
);
194 if (!EFI_ERROR(Status
)) {
196 // Now do consistent name
198 NewConsistName
= ShellCommandConsistMappingGenMappingName(DevicePathList
[Count
], ConsistMappingTable
);
199 if (NewConsistName
!= NULL
) {
200 Status
= gEfiShellProtocol
->SetMap(DevicePathList
[Count
], NewConsistName
);
201 FreePool(NewConsistName
);
205 FreePool(NewDefaultName
);
207 ShellCommandConsistMappingUnInitialize(ConsistMappingTable
);
208 SHELL_FREE_NON_NULL(HandleList
);
209 SHELL_FREE_NON_NULL(DevicePathList
);
216 // Do it all over again for gEfiBlockIoProtocolGuid
223 Determine what type of device is represented and return it's string. The
224 string is in allocated memory and must be callee freed. The HII is is listed below.
225 The actual string cannot be determined.
227 @param[in] DevicePath The device to analyze.
229 @retval STR_MAP_MEDIA_UNKNOWN The media type is unknown.
230 @retval STR_MAP_MEDIA_HARDDISK The media is a hard drive.
231 @retval STR_MAP_MEDIA_CDROM The media is a CD ROM.
232 @retval STR_MAP_MEDIA_FLOPPY The media is a floppy drive.
237 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
240 ACPI_HID_DEVICE_PATH
*Acpi
;
243 // Parse the device path:
244 // Devicepath sub type mediatype
245 // MEDIA_HANRDDRIVE_DP -> Hard Disk
246 // MEDIA_CDROM_DP -> CD Rom
247 // Acpi.HID = 0X0604 -> Floppy
249 if (NULL
== DevicePath
) {
250 return HiiGetString(gShellLevel2HiiHandle
, STRING_TOKEN(STR_MAP_MEDIA_UNKNOWN
), NULL
);
253 for (;!IsDevicePathEndType (DevicePath
) ;DevicePath
= NextDevicePathNode (DevicePath
)) {
254 if (DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
) {
255 switch (DevicePathSubType (DevicePath
)) {
256 case MEDIA_HARDDRIVE_DP
:
257 return HiiGetString(gShellLevel2HiiHandle
, STRING_TOKEN(STR_MAP_MEDIA_HARDDISK
), NULL
);
259 return HiiGetString(gShellLevel2HiiHandle
, STRING_TOKEN(STR_MAP_MEDIA_CDROM
), NULL
);
261 } else if (DevicePathType (DevicePath
) == ACPI_DEVICE_PATH
) {
262 Acpi
= (ACPI_HID_DEVICE_PATH
*) DevicePath
;
263 if (EISA_ID_TO_NUM (Acpi
->HID
) == 0x0604) {
264 return HiiGetString(gShellLevel2HiiHandle
, STRING_TOKEN(STR_MAP_MEDIA_FLOPPY
), NULL
);
269 return HiiGetString(gShellLevel2HiiHandle
, STRING_TOKEN(STR_MAP_MEDIA_UNKNOWN
), NULL
);
273 Function to detemine if a handle has removable storage.
275 @param[in] DevicePath DevicePath to test.
277 @retval TRUE The handle has removable storage.
278 @retval FALSE The handle does not have removable storage.
283 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
286 if (NULL
== DevicePath
) {
290 while (!IsDevicePathEndType (DevicePath
)) {
291 if (DevicePathType (DevicePath
) == MESSAGING_DEVICE_PATH
) {
292 switch (DevicePathSubType (DevicePath
)) {
300 DevicePath
= NextDevicePathNode (DevicePath
);
306 Function to detemine if a something on the map list matches.
308 @param[in] MapList The pointer to the list to test.
309 @param[in] Specific The pointer to a specific name to test for.
310 @param[in] TypeString The pointer to the list of types.
311 @param[in] Normal Always show normal mappings.
312 @param[in] Consist Always show consistent mappings.
314 @retval TRUE The map should be displayed.
315 @retval FALSE The map should not be displayed.
320 IN CONST CHAR16
*MapList
,
321 IN CONST CHAR16
*Specific
,
322 IN CONST CHAR16
*TypeString
,
323 IN CONST BOOLEAN Normal
,
324 IN CONST BOOLEAN Consist
329 // specific has priority
331 if (Specific
!= NULL
) {
332 NewSpecific
= AllocateZeroPool(StrSize(Specific
) + sizeof(CHAR16
));
333 if (NewSpecific
== NULL
){
336 StrCpy(NewSpecific
, Specific
);
337 if (NewSpecific
[StrLen(NewSpecific
)-1] != L
':') {
338 StrCat(NewSpecific
, L
":");
341 if (SearchList(MapList
, NewSpecific
, NULL
, TRUE
, FALSE
, L
";")) {
342 FreePool(NewSpecific
);
345 FreePool(NewSpecific
);
349 && (SearchList(MapList
, L
"HD*", NULL
, TRUE
, TRUE
, L
";")
350 ||SearchList(MapList
, L
"CD*", NULL
, TRUE
, TRUE
, L
";")
351 ||SearchList(MapList
, L
"F*", NULL
, TRUE
, TRUE
, L
";")
352 ||SearchList(MapList
, L
"FP*", NULL
, TRUE
, TRUE
, L
";"))){
358 && (SearchList(MapList
, L
"FS", NULL
, FALSE
, TRUE
, L
";")
359 ||SearchList(MapList
, L
"BLK", NULL
, FALSE
, TRUE
, L
";"))){
363 if (TypeString
!= NULL
&& SearchList(MapList
, TypeString
, NULL
, TRUE
, TRUE
, L
";")) {
371 Display a single map line for device Handle if conditions are met.
373 @param[in] Verbose TRUE to display (extra) verbose information.
374 @param[in] Consist TRUE to display consistent mappings.
375 @param[in] Normal TRUE to display normal (not consist) mappings.
376 @param[in] TypeString pointer to string of filter types.
377 @param[in] SFO TRUE to display output in Standard Output Format.
378 @param[in] Specific pointer to string for specific map to display.
379 @param[in] Handle The handle to display from.
381 @retval EFI_SUCCESS The mapping was displayed.
385 PerformSingleMappingDisplay(
386 IN CONST BOOLEAN Verbose
,
387 IN CONST BOOLEAN Consist
,
388 IN CONST BOOLEAN Normal
,
389 IN CONST CHAR16
*TypeString
,
390 IN CONST BOOLEAN SFO
,
391 IN CONST CHAR16
*Specific OPTIONAL
,
392 IN CONST EFI_HANDLE Handle
395 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
396 EFI_DEVICE_PATH_PROTOCOL
*DevPathCopy
;
397 CONST CHAR16
*MapList
;
400 CHAR16
*DevPathString
;
405 CONST CHAR16
*TempSpot2
;
410 DevPath
= DevicePathFromHandle(Handle
);
411 DevPathCopy
= DevPath
;
412 MapList
= gEfiShellProtocol
->GetMapFromDevicePath(&DevPathCopy
);
413 if (MapList
== NULL
) {
414 return EFI_NOT_FOUND
;
417 if (!MappingListHasType(MapList
, Specific
, TypeString
, Normal
, Consist
)){
418 return EFI_NOT_FOUND
;
421 if (Normal
|| !Consist
) {
423 // need the Normal here since people can use both on command line. otherwise unused.
430 CurrentName
= StrnCatGrow(&CurrentName
, 0, MapList
, 0);
431 if (CurrentName
== NULL
) {
432 return (EFI_OUT_OF_RESOURCES
);
436 // Chop off the other names that become "Alias(s)"
437 // leaving just the normal name
439 TempSpot
= StrStr(CurrentName
, L
";");
440 if (TempSpot
!= NULL
) {
441 *TempSpot
= CHAR_NULL
;
447 // Skip the first name. This is the standard name.
449 TempSpot
= StrStr(MapList
, L
";");
450 if (TempSpot
!= NULL
) {
453 SearchList(TempSpot
, L
"HD*", &CurrentName
, TRUE
, FALSE
, L
";");
454 if (CurrentName
== NULL
) {
455 SearchList(TempSpot
, L
"CD*", &CurrentName
, TRUE
, FALSE
, L
";");
457 if (CurrentName
== NULL
) {
458 SearchList(TempSpot
, L
"FP*", &CurrentName
, TRUE
, FALSE
, L
";");
460 if (CurrentName
== NULL
) {
461 SearchList(TempSpot
, L
"F*", &CurrentName
, TRUE
, FALSE
, L
";");
463 if (CurrentName
== NULL
) {
465 // We didnt find anything, so just the first one in the list...
467 CurrentName
= StrnCatGrow(&CurrentName
, 0, MapList
, 0);
468 if (CurrentName
== NULL
) {
469 return (EFI_OUT_OF_RESOURCES
);
471 TempSpot
= StrStr(CurrentName
, L
";");
472 if (TempSpot
!= NULL
) {
473 *TempSpot
= CHAR_NULL
;
476 Alias
= StrnCatGrow(&Alias
, 0, MapList
, 0);
478 return EFI_OUT_OF_RESOURCES
;
480 TempSpot
= StrStr(Alias
, CurrentName
);
481 if (TempSpot
!= NULL
) {
482 TempSpot2
= StrStr(TempSpot
, L
";");
483 if (TempSpot2
!= NULL
) {
484 TempSpot2
++; // Move past ";" from CurrentName
485 CopyMem(TempSpot
, TempSpot2
, StrSize(TempSpot2
));
487 *TempSpot
= CHAR_NULL
;
490 if (Alias
[StrLen(Alias
)-1] == L
';') {
491 Alias
[StrLen(Alias
)-1] = CHAR_NULL
;
495 DevPathString
= ConvertDevicePathToText(DevPath
, TRUE
, FALSE
);
496 TempLen
= StrLen(CurrentName
);
502 STRING_TOKEN (STR_MAP_ENTRY
),
503 gShellLevel2HiiHandle
,
505 Alias
!=NULL
?Alias
:(TempLen
< StrLen(MapList
)?MapList
+ TempLen
+1:L
""),
510 // also print handle, media type, removable (y/n), and current directory
512 MediaType
= GetDeviceMediaType(DevPath
);
513 if ((TypeString
!= NULL
&&MediaType
!= NULL
&& StrStr(TypeString
, MediaType
) != NULL
) || TypeString
== NULL
) {
514 Removable
= IsRemoveableDevice(DevPath
);
515 TempSpot2
= ShellGetCurrentDir(CurrentName
);
520 STRING_TOKEN (STR_MAP_ENTRY_VERBOSE
),
521 gShellLevel2HiiHandle
,
522 ConvertHandleToHandleIndex(Handle
),
524 Removable
?L
"Yes":L
"No",
528 SHELL_FREE_NON_NULL(MediaType
);
535 STRING_TOKEN (STR_MAP_SFO_MAPPINGS
),
536 gShellLevel2HiiHandle
,
539 Consist
?L
"":(TempLen
< StrLen(MapList
)?MapList
+ TempLen
+1:L
"")
542 SHELL_FREE_NON_NULL(DevPathString
);
543 SHELL_FREE_NON_NULL(CurrentName
);
544 SHELL_FREE_NON_NULL(Alias
);
549 Delete Specific from the list of maps for device Handle.
551 @param[in] Specific The name to delete.
552 @param[in] Handle The device to look on.
554 @retval EFI_SUCCESS The delete was successful.
555 @retval EFI_NOT_FOUND Name was not a map on Handle.
559 PerformSingleMappingDelete(
560 IN CONST CHAR16
*Specific
,
561 IN CONST EFI_HANDLE Handle
564 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
565 EFI_DEVICE_PATH_PROTOCOL
*DevPathCopy
;
566 CONST CHAR16
*MapList
;
569 DevPath
= DevicePathFromHandle(Handle
);
570 DevPathCopy
= DevPath
;
571 MapList
= gEfiShellProtocol
->GetMapFromDevicePath(&DevPathCopy
);
574 if (MapList
== NULL
) {
575 return (EFI_NOT_FOUND
);
578 // if there is a specific and its not on the list...
580 if (!SearchList(MapList
, Specific
, &CurrentName
, TRUE
, FALSE
, L
";")) {
581 return (EFI_NOT_FOUND
);
583 return (gEfiShellProtocol
->SetMap(NULL
, CurrentName
));
586 CONST CHAR16 Cd
[] = L
"cd*";
587 CONST CHAR16 Hd
[] = L
"hd*";
588 CONST CHAR16 Fp
[] = L
"fp*";
589 CONST CHAR16 AnyF
[] = L
"F*";
591 Function to display mapping information to the user.
593 If Specific is specified then Consist and Normal will be ignored since information will
594 be printed for the specific item only.
596 @param[in] Verbose TRUE to display (extra) verbose information.
597 @param[in] Consist TRUE to display consistent mappings.
598 @param[in] Normal TRUE to display normal (not consist) mappings.
599 @param[in] TypeString Pointer to string of filter types.
600 @param[in] SFO TRUE to display output in Standard Output Format.
601 @param[in] Specific Pointer to string for specific map to display.
602 @param[in] Header TRUE to print the header block.
604 @retval SHELL_SUCCESS The display was printed.
605 @retval SHELL_INVALID_PARAMETER One of Consist or Normal must be TRUE if no Specific.
610 PerformMappingDisplay(
611 IN CONST BOOLEAN Verbose
,
612 IN CONST BOOLEAN Consist
,
613 IN CONST BOOLEAN Normal
,
614 IN CONST CHAR16
*TypeString
,
615 IN CONST BOOLEAN SFO
,
616 IN CONST CHAR16
*Specific OPTIONAL
,
617 IN CONST BOOLEAN Header
621 EFI_HANDLE
*HandleBuffer
;
627 if (!Consist
&& !Normal
&& Specific
== NULL
&& TypeString
== NULL
) {
628 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellLevel2HiiHandle
);
629 return (SHELL_INVALID_PARAMETER
);
632 if (TypeString
!= NULL
) {
634 if (StrnCmp(TypeString
, Test
, StrLen(Test
)-1) != 0) {
636 if (StrnCmp(TypeString
, Test
, StrLen(Test
)-1) != 0) {
638 if (StrnCmp(TypeString
, Test
, StrLen(Test
)-1) != 0) {
639 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, TypeString
);
640 return (SHELL_INVALID_PARAMETER
);
642 } else if (Test
== NULL
) {
643 Test
= (CHAR16
*)AnyF
;
655 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MAP_HEADER
), gShellLevel2HiiHandle
);
657 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_SFO_HEADER
), gShellLevel2HiiHandle
, L
"map");
665 // Look up all SimpleFileSystems in the platform
667 Status
= gBS
->LocateHandle(
669 &gEfiSimpleFileSystemProtocolGuid
,
673 if (Status
== EFI_BUFFER_TOO_SMALL
) {
674 HandleBuffer
= AllocateZeroPool(BufferSize
);
675 if (HandleBuffer
== NULL
) {
676 return (SHELL_OUT_OF_RESOURCES
);
678 Status
= gBS
->LocateHandle(
680 &gEfiSimpleFileSystemProtocolGuid
,
687 // Get the map name(s) for each one.
689 for ( LoopVar
= 0, Found
= FALSE
690 ; LoopVar
< (BufferSize
/ sizeof(EFI_HANDLE
)) && HandleBuffer
!= NULL
693 Status
= PerformSingleMappingDisplay(
700 HandleBuffer
[LoopVar
]);
701 if (!EFI_ERROR(Status
)) {
707 // Look up all BlockIo in the platform
709 Status
= gBS
->LocateHandle(
711 &gEfiBlockIoProtocolGuid
,
715 if (Status
== EFI_BUFFER_TOO_SMALL
) {
716 SHELL_FREE_NON_NULL(HandleBuffer
);
717 HandleBuffer
= AllocateZeroPool(BufferSize
);
718 if (HandleBuffer
== NULL
) {
719 return (SHELL_OUT_OF_RESOURCES
);
721 Status
= gBS
->LocateHandle(
723 &gEfiBlockIoProtocolGuid
,
728 if (!EFI_ERROR(Status
) && HandleBuffer
!= NULL
) {
730 // Get the map name(s) for each one.
733 ; LoopVar
< BufferSize
/ sizeof(EFI_HANDLE
)
737 // Skip any that were already done...
739 if (gBS
->OpenProtocol(
740 HandleBuffer
[LoopVar
],
741 &gEfiSimpleFileSystemProtocolGuid
,
745 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
) == EFI_SUCCESS
) {
748 Status
= PerformSingleMappingDisplay(
755 HandleBuffer
[LoopVar
]);
756 if (!EFI_ERROR(Status
)) {
760 FreePool(HandleBuffer
);
763 if (Specific
!= NULL
) {
764 ShellPrintHiiEx(gST
->ConOut
->Mode
->CursorColumn
, gST
->ConOut
->Mode
->CursorRow
-1, NULL
, STRING_TOKEN (STR_MAP_NF
), gShellLevel2HiiHandle
, Specific
);
766 ShellPrintHiiEx(gST
->ConOut
->Mode
->CursorColumn
, gST
->ConOut
->Mode
->CursorRow
-1, NULL
, STRING_TOKEN (STR_CD_NF
), gShellLevel2HiiHandle
);
769 return (SHELL_SUCCESS
);
773 Perform a mapping display and parse for multiple types in the TypeString.
775 @param[in] Verbose TRUE to use verbose output.
776 @param[in] Consist TRUE to display consistent names.
777 @param[in] Normal TRUE to display normal names.
778 @param[in] TypeString An optional comma-delimited list of types.
779 @param[in] SFO TRUE to display in SFO format. See Spec.
780 @param[in] Specific An optional specific map name to display alone.
782 @retval SHELL_INVALID_PARAMETER A parameter was invalid.
783 @retval SHELL_SUCCESS The display was successful.
784 @sa PerformMappingDisplay
788 PerformMappingDisplay2(
789 IN CONST BOOLEAN Verbose
,
790 IN CONST BOOLEAN Consist
,
791 IN CONST BOOLEAN Normal
,
792 IN CONST CHAR16
*TypeString
,
793 IN CONST BOOLEAN SFO
,
794 IN CONST CHAR16
*Specific OPTIONAL
797 CONST CHAR16
*TypeWalker
;
798 SHELL_STATUS ShellStatus
;
802 if (TypeString
== NULL
) {
803 return (PerformMappingDisplay(Verbose
, Consist
, Normal
, NULL
, SFO
, Specific
, TRUE
));
805 ShellStatus
= SHELL_SUCCESS
;
806 for (TypeWalker
= TypeString
; TypeWalker
!= NULL
&& *TypeWalker
!= CHAR_NULL
;) {
807 Comma
= StrStr(TypeWalker
, L
",");
809 if (ShellStatus
== SHELL_SUCCESS
) {
810 ShellStatus
= PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
812 PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
817 if (ShellStatus
== SHELL_SUCCESS
) {
818 ShellStatus
= PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
820 PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
823 TypeWalker
= Comma
+ 1;
827 return (ShellStatus
);
831 Delete a specific map.
833 @param[in] Specific The pointer to the name of the map to delete.
835 @retval EFI_INVALID_PARAMETER Specific was NULL.
836 @retval EFI_SUCCESS The operation was successful.
837 @retval EFI_NOT_FOUND Specific could not be found.
841 PerformMappingDelete(
842 IN CONST CHAR16
*Specific
846 EFI_HANDLE
*HandleBuffer
;
851 if (Specific
== NULL
) {
852 return (EFI_INVALID_PARAMETER
);
860 // Look up all SimpleFileSystems in the platform
862 Status
= gBS
->LocateHandle(
864 &gEfiDevicePathProtocolGuid
,
868 if (Status
== EFI_BUFFER_TOO_SMALL
) {
869 HandleBuffer
= AllocateZeroPool(BufferSize
);
870 if (HandleBuffer
== NULL
) {
871 return (EFI_OUT_OF_RESOURCES
);
873 Status
= gBS
->LocateHandle(
875 &gEfiDevicePathProtocolGuid
,
880 if (EFI_ERROR(Status
)) {
881 SHELL_FREE_NON_NULL(HandleBuffer
);
885 if (HandleBuffer
!= NULL
) {
887 // Get the map name(s) for each one.
890 ; LoopVar
< BufferSize
/ sizeof(EFI_HANDLE
)
893 if (PerformSingleMappingDelete(Specific
,HandleBuffer
[LoopVar
]) == SHELL_SUCCESS
) {
899 // Look up all BlockIo in the platform
901 Status
= gBS
->LocateHandle(
903 &gEfiBlockIoProtocolGuid
,
907 if (Status
== EFI_BUFFER_TOO_SMALL
) {
908 FreePool(HandleBuffer
);
909 HandleBuffer
= AllocateZeroPool(BufferSize
);
910 if (HandleBuffer
== NULL
) {
911 return (EFI_OUT_OF_RESOURCES
);
913 Status
= gBS
->LocateHandle(
915 &gEfiBlockIoProtocolGuid
,
920 if (EFI_ERROR(Status
)) {
921 SHELL_FREE_NON_NULL(HandleBuffer
);
925 if (HandleBuffer
!= NULL
) {
927 // Get the map name(s) for each one.
930 ; LoopVar
< BufferSize
/ sizeof(EFI_HANDLE
)
934 // Skip any that were already done...
936 if (gBS
->OpenProtocol(
937 HandleBuffer
[LoopVar
],
938 &gEfiDevicePathProtocolGuid
,
942 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
) == EFI_SUCCESS
) {
945 if (PerformSingleMappingDelete(Specific
,HandleBuffer
[LoopVar
]) == SHELL_SUCCESS
) {
950 SHELL_FREE_NON_NULL(HandleBuffer
);
952 return (EFI_NOT_FOUND
);
954 return (EFI_SUCCESS
);
958 function to add a mapping from mapping.
960 This function will get the device path associated with the mapping and call SetMap.
962 @param[in] Map The Map to add a mapping for
963 @param[in] SName The name of the new mapping
965 @retval SHELL_SUCCESS the mapping was added
966 @retval SHELL_INVALID_PARAMETER the device path for Map could not be retrieved.
967 @return Shell version of a return value from EfiShellProtocol->SetMap
972 AddMappingFromMapping(
973 IN CONST CHAR16
*Map
,
974 IN CONST CHAR16
*SName
977 CONST EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
981 NewSName
= AllocateZeroPool(StrSize(SName
) + sizeof(CHAR16
));
982 if (NewSName
== NULL
) {
983 return (SHELL_OUT_OF_RESOURCES
);
985 StrCpy(NewSName
, SName
);
986 if (NewSName
[StrLen(NewSName
)-1] != L
':') {
987 StrCat(NewSName
, L
":");
990 if (!IsNumberLetterOnly(NewSName
, StrLen(NewSName
)-1)) {
992 return (SHELL_INVALID_PARAMETER
);
995 DevPath
= gEfiShellProtocol
->GetDevicePathFromMap(Map
);
996 if (DevPath
== NULL
) {
998 return (SHELL_INVALID_PARAMETER
);
1001 Status
= gEfiShellProtocol
->SetMap(DevPath
, NewSName
);
1003 if (EFI_ERROR(Status
)) {
1004 return (SHELL_DEVICE_ERROR
);
1006 return (SHELL_SUCCESS
);
1010 function to add a mapping from an EFI_HANDLE.
1012 This function will get the device path associated with the Handle and call SetMap.
1014 @param[in] Handle The handle to add a mapping for
1015 @param[in] SName The name of the new mapping
1017 @retval SHELL_SUCCESS the mapping was added
1018 @retval SHELL_INVALID_PARAMETER SName was not valid for a map name.
1019 @return Shell version of a return value from either
1020 gBS->OpenProtocol or EfiShellProtocol->SetMap
1025 AddMappingFromHandle(
1026 IN CONST EFI_HANDLE Handle
,
1027 IN CONST CHAR16
*SName
1030 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1034 NewSName
= AllocateZeroPool(StrSize(SName
) + sizeof(CHAR16
));
1035 if (NewSName
== NULL
) {
1036 return (SHELL_OUT_OF_RESOURCES
);
1038 StrCpy(NewSName
, SName
);
1039 if (NewSName
[StrLen(NewSName
)-1] != L
':') {
1040 StrCat(NewSName
, L
":");
1043 if (!IsNumberLetterOnly(NewSName
, StrLen(NewSName
)-1)) {
1045 return (SHELL_INVALID_PARAMETER
);
1048 Status
= gBS
->OpenProtocol(
1050 &gEfiDevicePathProtocolGuid
,
1054 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1056 if (EFI_ERROR(Status
)) {
1058 return (SHELL_DEVICE_ERROR
);
1060 Status
= gEfiShellProtocol
->SetMap(DevPath
, NewSName
);
1062 if (EFI_ERROR(Status
)) {
1063 return (SHELL_DEVICE_ERROR
);
1065 return (SHELL_SUCCESS
);
1068 STATIC CONST SHELL_PARAM_ITEM MapParamList
[] = {
1076 {L
"-sfo", TypeValue
},
1081 Function for 'map' command.
1083 @param[in] ImageHandle Handle to the Image (NULL if Internal).
1084 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
1088 ShellCommandRunMap (
1089 IN EFI_HANDLE ImageHandle
,
1090 IN EFI_SYSTEM_TABLE
*SystemTable
1094 LIST_ENTRY
*Package
;
1095 CHAR16
*ProblemParam
;
1096 CONST CHAR16
*SName
;
1097 CONST CHAR16
*Mapping
;
1098 EFI_HANDLE MapAsHandle
;
1099 SHELL_STATUS ShellStatus
;
1103 CONST CHAR16
*Param1
;
1104 CONST CHAR16
*TypeString
;
1105 UINTN TempStringLength
;
1107 ProblemParam
= NULL
;
1110 ShellStatus
= SHELL_SUCCESS
;
1114 // initialize the shell lib (we must be in non-auto-init...)
1116 Status
= ShellInitialize();
1117 ASSERT_EFI_ERROR(Status
);
1119 Status
= CommandInit();
1120 ASSERT_EFI_ERROR(Status
);
1123 // parse the command line
1125 Status
= ShellCommandLineParse (MapParamList
, &Package
, &ProblemParam
, TRUE
);
1126 if (EFI_ERROR(Status
)) {
1127 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
1128 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, ProblemParam
);
1129 FreePool(ProblemParam
);
1130 ShellStatus
= SHELL_INVALID_PARAMETER
;
1138 SfoMode
= ShellCommandLineGetFlag(Package
, L
"-sfo");
1139 ConstMode
= ShellCommandLineGetFlag(Package
, L
"-c");
1140 NormlMode
= ShellCommandLineGetFlag(Package
, L
"-f");
1141 if (ShellCommandLineGetFlag(Package
, L
"-?")) {
1143 } else if (ShellCommandLineGetRawValue(Package
, 3) != NULL
) {
1144 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellLevel2HiiHandle
);
1145 ShellStatus
= SHELL_INVALID_PARAMETER
;
1148 // Deleting a map name...
1150 if (ShellCommandLineGetFlag(Package
, L
"-d")) {
1151 if ( ShellCommandLineGetFlag(Package
, L
"-r")
1152 || ShellCommandLineGetFlag(Package
, L
"-v")
1155 || ShellCommandLineGetFlag(Package
, L
"-u")
1156 || ShellCommandLineGetFlag(Package
, L
"-t")
1158 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CON
), gShellLevel2HiiHandle
);
1159 ShellStatus
= SHELL_INVALID_PARAMETER
;
1161 SName
= ShellCommandLineGetValue(Package
, L
"-d");
1162 if (SName
!= NULL
) {
1163 Status
= PerformMappingDelete(SName
);
1164 if (EFI_ERROR(Status
)) {
1165 if (Status
== EFI_ACCESS_DENIED
) {
1166 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellLevel2HiiHandle
);
1167 ShellStatus
= SHELL_ACCESS_DENIED
;
1168 } else if (Status
== EFI_NOT_FOUND
) {
1169 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MAP_NF
), gShellLevel2HiiHandle
, SName
);
1170 ShellStatus
= SHELL_INVALID_PARAMETER
;
1172 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
1173 ShellStatus
= SHELL_UNSUPPORTED
;
1177 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellLevel2HiiHandle
);
1178 ShellStatus
= SHELL_INVALID_PARAMETER
;
1181 } else if ( ShellCommandLineGetFlag(Package
, L
"-r")
1182 // || ShellCommandLineGetFlag(Package, L"-v")
1185 || ShellCommandLineGetFlag(Package
, L
"-u")
1186 || ShellCommandLineGetFlag(Package
, L
"-t")
1188 if ( ShellCommandLineGetFlag(Package
, L
"-r")) {
1192 Status
= ShellCommandCreateInitialMappingsAndPaths();
1193 if (EFI_ERROR(Status
)) {
1194 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
1195 ShellStatus
= SHELL_UNSUPPORTED
;
1198 if ( ShellStatus
== SHELL_SUCCESS
&& ShellCommandLineGetFlag(Package
, L
"-u")) {
1202 Status
= UpdateMapping();
1203 if (EFI_ERROR(Status
)) {
1204 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
1205 ShellStatus
= SHELL_UNSUPPORTED
;
1208 if (ShellStatus
== SHELL_SUCCESS
) {
1209 Param1
= ShellCommandLineGetRawValue(Package
, 1);
1210 TypeString
= ShellCommandLineGetValue(Package
, L
"-t");
1213 &&TypeString
== NULL
1216 // now do the display...
1218 ShellStatus
= PerformMappingDisplay(
1219 ShellCommandLineGetFlag(Package
, L
"-v"),
1229 // now do the display...
1231 ShellStatus
= PerformMappingDisplay2(
1232 ShellCommandLineGetFlag(Package
, L
"-v"),
1243 // adding or displaying (there were no flags)
1245 SName
= ShellCommandLineGetRawValue(Package
, 1);
1246 Mapping
= ShellCommandLineGetRawValue(Package
, 2);
1251 // display only since no flags
1253 ShellStatus
= PerformMappingDisplay(
1254 ShellCommandLineGetFlag(Package
, L
"-v"),
1262 } else if ( SName
== NULL
1266 // Display only the one specified
1268 ShellStatus
= PerformMappingDisplay(
1274 SName
, // note the variable here...
1278 if (ShellIsHexOrDecimalNumber(Mapping
, TRUE
, FALSE
)) {
1279 MapAsHandle
= ConvertHandleIndexToHandle(ShellStrToUintn(Mapping
));
1283 if (MapAsHandle
== NULL
&& Mapping
[StrLen(Mapping
)-1] != L
':') {
1284 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, Mapping
);
1285 ShellStatus
= SHELL_INVALID_PARAMETER
;
1287 if (MapAsHandle
!= NULL
) {
1288 TempStringLength
= StrLen(SName
);
1289 if (!IsNumberLetterOnly(SName
, TempStringLength
-(SName
[TempStringLength
-1]==L
':'?1:0))) {
1290 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, SName
);
1291 ShellStatus
= SHELL_INVALID_PARAMETER
;
1293 ShellStatus
= AddMappingFromHandle(MapAsHandle
, SName
);
1296 TempStringLength
= StrLen(SName
);
1297 if (!IsNumberLetterOnly(SName
, TempStringLength
-(SName
[TempStringLength
-1]==L
':'?1:0))) {
1298 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, SName
);
1299 ShellStatus
= SHELL_INVALID_PARAMETER
;
1301 ShellStatus
= AddMappingFromMapping(Mapping
, SName
);
1304 if (ShellStatus
!= SHELL_SUCCESS
) {
1305 switch (ShellStatus
) {
1306 case SHELL_ACCESS_DENIED
:
1307 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellLevel2HiiHandle
);
1309 case SHELL_INVALID_PARAMETER
:
1310 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
), gShellLevel2HiiHandle
);
1312 case SHELL_DEVICE_ERROR
:
1313 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MAP_NOF
), gShellLevel2HiiHandle
, Mapping
);
1316 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, ShellStatus
|MAX_BIT
);
1320 // now do the display...
1322 ShellStatus
= PerformMappingDisplay(
1331 } // we were sucessful so do an output
1332 } // got a valid map target
1333 } // got 2 variables
1334 } // we are adding a mapping
1335 } // got valid parameters
1339 // free the command line package
1341 ShellCommandLineFreeVarList (Package
);
1343 return (ShellStatus
);