2 Main file for map shell level 2 command.
4 Copyright (c) 2009 - 2011, 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
);
348 && (SearchList(MapList
, L
"HD*", NULL
, TRUE
, TRUE
, L
";")
349 ||SearchList(MapList
, L
"CD*", NULL
, TRUE
, TRUE
, L
";")
350 ||SearchList(MapList
, L
"F*", NULL
, TRUE
, TRUE
, L
";")
351 ||SearchList(MapList
, L
"FP*", NULL
, TRUE
, TRUE
, L
";"))){
356 && (SearchList(MapList
, L
"FS", NULL
, FALSE
, TRUE
, L
";")
357 ||SearchList(MapList
, L
"BLK", NULL
, FALSE
, TRUE
, L
";"))){
361 if (TypeString
!= NULL
&& SearchList(MapList
, TypeString
, NULL
, TRUE
, TRUE
, L
";")) {
369 Display a single map line for device Handle if conditions are met.
371 @param[in] Verbose TRUE to display (extra) verbose information.
372 @param[in] Consist TRUE to display consistent mappings.
373 @param[in] Normal TRUE to display normal (not consist) mappings.
374 @param[in] TypeString pointer to string of filter types.
375 @param[in] SFO TRUE to display output in Standard Output Format.
376 @param[in] Specific pointer to string for specific map to display.
377 @param[in] Handle The handle to display from.
379 @retval EFI_SUCCESS The mapping was displayed.
383 PerformSingleMappingDisplay(
384 IN CONST BOOLEAN Verbose
,
385 IN CONST BOOLEAN Consist
,
386 IN CONST BOOLEAN Normal
,
387 IN CONST CHAR16
*TypeString
,
388 IN CONST BOOLEAN SFO
,
389 IN CONST CHAR16
*Specific OPTIONAL
,
390 IN CONST EFI_HANDLE Handle
393 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
394 EFI_DEVICE_PATH_PROTOCOL
*DevPathCopy
;
395 CONST CHAR16
*MapList
;
398 CHAR16
*DevPathString
;
402 CONST CHAR16
*TempSpot2
;
404 DevPath
= DevicePathFromHandle(Handle
);
405 DevPathCopy
= DevPath
;
406 MapList
= gEfiShellProtocol
->GetMapFromDevicePath(&DevPathCopy
);
407 if (MapList
== NULL
) {
408 return EFI_NOT_FOUND
;
411 if (!MappingListHasType(MapList
, Specific
, TypeString
, Normal
, Consist
)){
412 return EFI_NOT_FOUND
;
416 CurrentName
= StrnCatGrow(&CurrentName
, 0, MapList
, 0);
417 TempSpot
= StrStr(CurrentName
, L
";");
418 if (TempSpot
!= NULL
) {
419 *TempSpot
= CHAR_NULL
;
421 DevPathString
= gDevPathToText
->ConvertDevicePathToText(DevPath
, TRUE
, FALSE
);
423 TempLen
= StrLen(CurrentName
);
428 STRING_TOKEN (STR_MAP_ENTRY
),
429 gShellLevel2HiiHandle
,
431 TempLen
< StrLen(MapList
)?MapList
+ TempLen
+1:L
"",
436 // also print handle, media type, removable (y/n), and current directory
438 MediaType
= GetDeviceMediaType(DevPath
);
439 if ((TypeString
!= NULL
&&MediaType
!= NULL
&& StrStr(TypeString
, MediaType
) != NULL
) || TypeString
== NULL
) {
440 Removable
= IsRemoveableDevice(DevPath
);
441 TempSpot2
= ShellGetCurrentDir(CurrentName
);
446 STRING_TOKEN (STR_MAP_ENTRY_VERBOSE
),
447 gShellLevel2HiiHandle
,
448 ConvertHandleToHandleIndex(Handle
),
450 Removable
?L
"Yes":L
"No",
457 TempLen
= StrLen(CurrentName
);
462 STRING_TOKEN (STR_MAP_SFO_MAPPINGS
),
463 gShellLevel2HiiHandle
,
466 TempLen
< StrLen(MapList
)?MapList
+ TempLen
+1:L
""
469 FreePool(DevPathString
);
470 FreePool(CurrentName
);
475 Delete Specific from the list of maps for device Handle.
477 @param[in] Specific The name to delete.
478 @param[in] Handle The device to look on.
480 @retval EFI_SUCCESS The delete was successful.
481 @retval EFI_NOT_FOUND Name was not a map on Handle.
485 PerformSingleMappingDelete(
486 IN CONST CHAR16
*Specific
,
487 IN CONST EFI_HANDLE Handle
490 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
491 EFI_DEVICE_PATH_PROTOCOL
*DevPathCopy
;
492 CONST CHAR16
*MapList
;
495 DevPath
= DevicePathFromHandle(Handle
);
496 DevPathCopy
= DevPath
;
497 MapList
= gEfiShellProtocol
->GetMapFromDevicePath(&DevPathCopy
);
500 if (MapList
== NULL
) {
501 return (EFI_NOT_FOUND
);
504 // if there is a specific and its not on the list...
506 if (!SearchList(MapList
, Specific
, &CurrentName
, TRUE
, FALSE
, L
";")) {
507 return (EFI_NOT_FOUND
);
509 return (gEfiShellProtocol
->SetMap(NULL
, CurrentName
));
512 CONST CHAR16 Cd
[] = L
"cd*";
513 CONST CHAR16 Hd
[] = L
"hd*";
514 CONST CHAR16 Fp
[] = L
"fp*";
515 CONST CHAR16 AnyF
[] = L
"F*";
517 Function to display mapping information to the user.
519 If Specific is specified then Consist and Normal will be ignored since information will
520 be printed for the specific item only.
522 @param[in] Verbose TRUE to display (extra) verbose information.
523 @param[in] Consist TRUE to display consistent mappings.
524 @param[in] Normal TRUE to display normal (not consist) mappings.
525 @param[in] TypeString Pointer to string of filter types.
526 @param[in] SFO TRUE to display output in Standard Output Format.
527 @param[in] Specific Pointer to string for specific map to display.
528 @param[in] Header TRUE to print the header block.
530 @retval SHELL_SUCCESS The display was printed.
531 @retval SHELL_INVALID_PARAMETER One of Consist or Normal must be TRUE if no Specific.
536 PerformMappingDisplay(
537 IN CONST BOOLEAN Verbose
,
538 IN CONST BOOLEAN Consist
,
539 IN CONST BOOLEAN Normal
,
540 IN CONST CHAR16
*TypeString
,
541 IN CONST BOOLEAN SFO
,
542 IN CONST CHAR16
*Specific OPTIONAL
,
543 IN CONST BOOLEAN Header
547 EFI_HANDLE
*HandleBuffer
;
553 if (!Consist
&& !Normal
&& Specific
== NULL
&& TypeString
== NULL
) {
554 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellLevel2HiiHandle
);
555 return (SHELL_INVALID_PARAMETER
);
558 if (TypeString
!= NULL
) {
560 if (StrnCmp(TypeString
, Test
, StrLen(Test
)-1) != 0) {
562 if (StrnCmp(TypeString
, Test
, StrLen(Test
)-1) != 0) {
564 if (StrnCmp(TypeString
, Test
, StrLen(Test
)-1) != 0) {
565 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, TypeString
);
566 return (SHELL_INVALID_PARAMETER
);
568 } else if (Test
== NULL
) {
569 Test
= (CHAR16
*)AnyF
;
581 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MAP_HEADER
), gShellLevel2HiiHandle
);
583 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_SFO_HEADER
), gShellLevel2HiiHandle
, L
"map");
591 // Look up all SimpleFileSystems in the platform
593 Status
= gBS
->LocateHandle(
595 &gEfiSimpleFileSystemProtocolGuid
,
599 if (Status
== EFI_BUFFER_TOO_SMALL
) {
600 HandleBuffer
= AllocateZeroPool(BufferSize
);
601 if (HandleBuffer
== NULL
) {
602 return (SHELL_OUT_OF_RESOURCES
);
604 Status
= gBS
->LocateHandle(
606 &gEfiSimpleFileSystemProtocolGuid
,
613 // Get the map name(s) for each one.
615 for ( LoopVar
= 0, Found
= FALSE
616 ; LoopVar
< (BufferSize
/ sizeof(EFI_HANDLE
)) && HandleBuffer
!= NULL
619 Status
= PerformSingleMappingDisplay(
626 HandleBuffer
[LoopVar
]);
627 if (!EFI_ERROR(Status
)) {
633 // Look up all BlockIo in the platform
635 Status
= gBS
->LocateHandle(
637 &gEfiBlockIoProtocolGuid
,
641 if (Status
== EFI_BUFFER_TOO_SMALL
) {
642 SHELL_FREE_NON_NULL(HandleBuffer
);
643 HandleBuffer
= AllocateZeroPool(BufferSize
);
644 if (HandleBuffer
== NULL
) {
645 return (SHELL_OUT_OF_RESOURCES
);
647 Status
= gBS
->LocateHandle(
649 &gEfiBlockIoProtocolGuid
,
654 if (!EFI_ERROR(Status
) && HandleBuffer
!= NULL
) {
656 // Get the map name(s) for each one.
659 ; LoopVar
< BufferSize
/ sizeof(EFI_HANDLE
)
663 // Skip any that were already done...
665 if (gBS
->OpenProtocol(
666 HandleBuffer
[LoopVar
],
667 &gEfiSimpleFileSystemProtocolGuid
,
671 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
) == EFI_SUCCESS
) {
674 Status
= PerformSingleMappingDisplay(
681 HandleBuffer
[LoopVar
]);
682 if (!EFI_ERROR(Status
)) {
686 FreePool(HandleBuffer
);
689 if (Specific
!= NULL
) {
690 ShellPrintHiiEx(gST
->ConOut
->Mode
->CursorColumn
, gST
->ConOut
->Mode
->CursorRow
-1, NULL
, STRING_TOKEN (STR_MAP_NF
), gShellLevel2HiiHandle
, Specific
);
692 ShellPrintHiiEx(gST
->ConOut
->Mode
->CursorColumn
, gST
->ConOut
->Mode
->CursorRow
-1, NULL
, STRING_TOKEN (STR_CD_NF
), gShellLevel2HiiHandle
);
695 return (SHELL_SUCCESS
);
699 Perform a mapping display and parse for multiple types in the TypeString.
701 @param[in] Verbose TRUE to use verbose output.
702 @param[in] Consist TRUE to display consistent names.
703 @param[in] Normal TRUE to display normal names.
704 @param[in] TypeString An optional comma-delimited list of types.
705 @param[in] SFO TRUE to display in SFO format. See Spec.
706 @param[in] Specific An optional specific map name to display alone.
708 @retval SHELL_INVALID_PARAMETER A parameter was invalid.
709 @retval SHELL_SUCCESS The display was successful.
710 @sa PerformMappingDisplay
714 PerformMappingDisplay2(
715 IN CONST BOOLEAN Verbose
,
716 IN CONST BOOLEAN Consist
,
717 IN CONST BOOLEAN Normal
,
718 IN CONST CHAR16
*TypeString
,
719 IN CONST BOOLEAN SFO
,
720 IN CONST CHAR16
*Specific OPTIONAL
723 CONST CHAR16
*TypeWalker
;
724 SHELL_STATUS ShellStatus
;
728 if (TypeString
== NULL
) {
729 return (PerformMappingDisplay(Verbose
, Consist
, Normal
, NULL
, SFO
, Specific
, TRUE
));
731 ShellStatus
= SHELL_SUCCESS
;
732 for (TypeWalker
= TypeString
; TypeWalker
!= NULL
&& *TypeWalker
!= CHAR_NULL
;) {
733 Comma
= StrStr(TypeWalker
, L
",");
735 if (ShellStatus
== SHELL_SUCCESS
) {
736 ShellStatus
= PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
738 PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
743 if (ShellStatus
== SHELL_SUCCESS
) {
744 ShellStatus
= PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
746 PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
749 TypeWalker
= Comma
+ 1;
753 return (ShellStatus
);
757 Delete a specific map.
759 @param[in] Specific The pointer to the name of the map to delete.
761 @retval EFI_INVALID_PARAMETER Specific was NULL.
762 @retval EFI_SUCCESS The operation was successful.
763 @retval EFI_NOT_FOUND Specific could not be found.
767 PerformMappingDelete(
768 IN CONST CHAR16
*Specific
772 EFI_HANDLE
*HandleBuffer
;
777 if (Specific
== NULL
) {
778 return (EFI_INVALID_PARAMETER
);
786 // Look up all SimpleFileSystems in the platform
788 Status
= gBS
->LocateHandle(
790 &gEfiDevicePathProtocolGuid
,
794 if (Status
== EFI_BUFFER_TOO_SMALL
) {
795 HandleBuffer
= AllocateZeroPool(BufferSize
);
796 if (HandleBuffer
== NULL
) {
797 return (EFI_OUT_OF_RESOURCES
);
799 Status
= gBS
->LocateHandle(
801 &gEfiDevicePathProtocolGuid
,
806 if (EFI_ERROR(Status
)) {
807 SHELL_FREE_NON_NULL(HandleBuffer
);
811 if (HandleBuffer
!= NULL
) {
813 // Get the map name(s) for each one.
816 ; LoopVar
< BufferSize
/ sizeof(EFI_HANDLE
)
819 if (PerformSingleMappingDelete(Specific
,HandleBuffer
[LoopVar
]) == SHELL_SUCCESS
) {
825 // Look up all BlockIo in the platform
827 Status
= gBS
->LocateHandle(
829 &gEfiBlockIoProtocolGuid
,
833 if (Status
== EFI_BUFFER_TOO_SMALL
) {
834 FreePool(HandleBuffer
);
835 HandleBuffer
= AllocateZeroPool(BufferSize
);
836 if (HandleBuffer
== NULL
) {
837 return (EFI_OUT_OF_RESOURCES
);
839 Status
= gBS
->LocateHandle(
841 &gEfiBlockIoProtocolGuid
,
846 if (EFI_ERROR(Status
)) {
847 SHELL_FREE_NON_NULL(HandleBuffer
);
851 if (HandleBuffer
!= NULL
) {
853 // Get the map name(s) for each one.
856 ; LoopVar
< BufferSize
/ sizeof(EFI_HANDLE
)
860 // Skip any that were already done...
862 if (gBS
->OpenProtocol(
863 HandleBuffer
[LoopVar
],
864 &gEfiDevicePathProtocolGuid
,
868 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
) == EFI_SUCCESS
) {
871 if (PerformSingleMappingDelete(Specific
,HandleBuffer
[LoopVar
]) == SHELL_SUCCESS
) {
876 SHELL_FREE_NON_NULL(HandleBuffer
);
878 return (EFI_NOT_FOUND
);
880 return (EFI_SUCCESS
);
884 function to add a mapping from mapping.
886 This function will get the device path associated with the mapping and call SetMap.
888 @param[in] Map The Map to add a mapping for
889 @param[in] SName The name of the new mapping
891 @retval SHELL_SUCCESS the mapping was added
892 @retval SHELL_INVALID_PARAMETER the device path for Map could not be retrieved.
893 @return Shell version of a return value from EfiShellProtocol->SetMap
898 AddMappingFromMapping(
899 IN CONST CHAR16
*Map
,
900 IN CONST CHAR16
*SName
903 CONST EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
907 NewSName
= AllocateZeroPool(StrSize(SName
) + sizeof(CHAR16
));
908 if (NewSName
== NULL
) {
909 return (SHELL_OUT_OF_RESOURCES
);
911 StrCpy(NewSName
, SName
);
912 if (NewSName
[StrLen(NewSName
)-1] != L
':') {
913 StrCat(NewSName
, L
":");
916 if (!IsNumberLetterOnly(NewSName
, StrLen(NewSName
)-1)) {
918 return (SHELL_INVALID_PARAMETER
);
921 DevPath
= gEfiShellProtocol
->GetDevicePathFromMap(Map
);
922 if (DevPath
== NULL
) {
924 return (SHELL_INVALID_PARAMETER
);
927 Status
= gEfiShellProtocol
->SetMap(DevPath
, NewSName
);
929 if (EFI_ERROR(Status
)) {
930 return (SHELL_DEVICE_ERROR
);
932 return (SHELL_SUCCESS
);
936 function to add a mapping from an EFI_HANDLE.
938 This function will get the device path associated with the Handle and call SetMap.
940 @param[in] Handle The handle to add a mapping for
941 @param[in] SName The name of the new mapping
943 @retval SHELL_SUCCESS the mapping was added
944 @retval SHELL_INVALID_PARAMETER SName was not valid for a map name.
945 @return Shell version of a return value from either
946 gBS->OpenProtocol or EfiShellProtocol->SetMap
951 AddMappingFromHandle(
952 IN CONST EFI_HANDLE Handle
,
953 IN CONST CHAR16
*SName
956 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
960 NewSName
= AllocateZeroPool(StrSize(SName
) + sizeof(CHAR16
));
961 if (NewSName
== NULL
) {
962 return (SHELL_OUT_OF_RESOURCES
);
964 StrCpy(NewSName
, SName
);
965 if (NewSName
[StrLen(NewSName
)-1] != L
':') {
966 StrCat(NewSName
, L
":");
969 if (!IsNumberLetterOnly(NewSName
, StrLen(NewSName
)-1)) {
971 return (SHELL_INVALID_PARAMETER
);
974 Status
= gBS
->OpenProtocol(
976 &gEfiDevicePathProtocolGuid
,
980 EFI_OPEN_PROTOCOL_GET_PROTOCOL
982 if (EFI_ERROR(Status
)) {
984 return (SHELL_DEVICE_ERROR
);
986 Status
= gEfiShellProtocol
->SetMap(DevPath
, NewSName
);
988 if (EFI_ERROR(Status
)) {
989 return (SHELL_DEVICE_ERROR
);
991 return (SHELL_SUCCESS
);
994 STATIC CONST SHELL_PARAM_ITEM MapParamList
[] = {
1002 {L
"-sfo", TypeValue
},
1007 Function for 'map' command.
1009 @param[in] ImageHandle Handle to the Image (NULL if Internal).
1010 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
1014 ShellCommandRunMap (
1015 IN EFI_HANDLE ImageHandle
,
1016 IN EFI_SYSTEM_TABLE
*SystemTable
1020 LIST_ENTRY
*Package
;
1021 CHAR16
*ProblemParam
;
1022 CONST CHAR16
*SName
;
1023 CONST CHAR16
*Mapping
;
1024 EFI_HANDLE MapAsHandle
;
1025 CONST EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1026 SHELL_STATUS ShellStatus
;
1030 CONST CHAR16
*Param1
;
1031 CONST CHAR16
*TypeString
;
1032 UINTN TempStringLength
;
1034 ProblemParam
= NULL
;
1038 ShellStatus
= SHELL_SUCCESS
;
1042 // initialize the shell lib (we must be in non-auto-init...)
1044 Status
= ShellInitialize();
1045 ASSERT_EFI_ERROR(Status
);
1047 Status
= CommandInit();
1048 ASSERT_EFI_ERROR(Status
);
1051 // parse the command line
1053 Status
= ShellCommandLineParse (MapParamList
, &Package
, &ProblemParam
, TRUE
);
1054 if (EFI_ERROR(Status
)) {
1055 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
1056 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, ProblemParam
);
1057 FreePool(ProblemParam
);
1058 ShellStatus
= SHELL_INVALID_PARAMETER
;
1066 SfoMode
= ShellCommandLineGetFlag(Package
, L
"-sfo");
1067 ConstMode
= ShellCommandLineGetFlag(Package
, L
"-c");
1068 NormlMode
= ShellCommandLineGetFlag(Package
, L
"-f");
1069 if (ShellCommandLineGetFlag(Package
, L
"-?")) {
1071 } else if (ShellCommandLineGetRawValue(Package
, 3) != NULL
) {
1072 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellLevel2HiiHandle
);
1073 ShellStatus
= SHELL_INVALID_PARAMETER
;
1076 // Deleting a map name...
1078 if (ShellCommandLineGetFlag(Package
, L
"-d")) {
1079 if ( ShellCommandLineGetFlag(Package
, L
"-r")
1080 || ShellCommandLineGetFlag(Package
, L
"-v")
1083 || ShellCommandLineGetFlag(Package
, L
"-u")
1084 || ShellCommandLineGetFlag(Package
, L
"-t")
1086 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CON
), gShellLevel2HiiHandle
);
1087 ShellStatus
= SHELL_INVALID_PARAMETER
;
1089 SName
= ShellCommandLineGetValue(Package
, L
"-d");
1090 if (SName
!= NULL
) {
1091 Status
= PerformMappingDelete(SName
);
1092 if (EFI_ERROR(Status
)) {
1094 case EFI_ACCESS_DENIED
:
1095 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellLevel2HiiHandle
);
1096 ShellStatus
= SHELL_ACCESS_DENIED
;
1099 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MAP_NF
), gShellLevel2HiiHandle
, SName
);
1100 ShellStatus
= SHELL_INVALID_PARAMETER
;
1103 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
1104 ShellStatus
= SHELL_UNSUPPORTED
;
1108 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellLevel2HiiHandle
);
1109 ShellStatus
= SHELL_INVALID_PARAMETER
;
1112 } else if ( ShellCommandLineGetFlag(Package
, L
"-r")
1113 // || ShellCommandLineGetFlag(Package, L"-v")
1116 || ShellCommandLineGetFlag(Package
, L
"-u")
1117 || ShellCommandLineGetFlag(Package
, L
"-t")
1119 if ( ShellCommandLineGetFlag(Package
, L
"-r")) {
1123 Status
= ShellCommandCreateInitialMappingsAndPaths();
1124 if (EFI_ERROR(Status
)) {
1125 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
1126 ShellStatus
= SHELL_UNSUPPORTED
;
1129 if ( ShellStatus
== SHELL_SUCCESS
&& ShellCommandLineGetFlag(Package
, L
"-u")) {
1133 Status
= UpdateMapping();
1134 if (EFI_ERROR(Status
)) {
1135 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
1136 ShellStatus
= SHELL_UNSUPPORTED
;
1139 if (ShellStatus
== SHELL_SUCCESS
) {
1140 Param1
= ShellCommandLineGetRawValue(Package
, 1);
1141 TypeString
= ShellCommandLineGetValue(Package
, L
"-t");
1144 &&TypeString
== NULL
1147 // now do the display...
1149 ShellStatus
= PerformMappingDisplay(
1150 ShellCommandLineGetFlag(Package
, L
"-v"),
1160 // now do the display...
1162 ShellStatus
= PerformMappingDisplay2(
1163 ShellCommandLineGetFlag(Package
, L
"-v"),
1174 // adding or displaying (there were no flags)
1176 SName
= ShellCommandLineGetRawValue(Package
, 1);
1177 Mapping
= ShellCommandLineGetRawValue(Package
, 2);
1182 // display only since no flags
1184 ShellStatus
= PerformMappingDisplay(
1185 ShellCommandLineGetFlag(Package
, L
"-v"),
1193 } else if ( SName
== NULL
1197 // Display only the one specified
1199 ShellStatus
= PerformMappingDisplay(
1205 SName
, // note the variable here...
1209 if (ShellIsHexOrDecimalNumber(Mapping
, TRUE
, FALSE
)) {
1210 MapAsHandle
= ConvertHandleIndexToHandle(ShellStrToUintn(Mapping
));
1214 if (MapAsHandle
== NULL
&& Mapping
[StrLen(Mapping
)-1] != L
':') {
1215 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, Mapping
);
1216 ShellStatus
= SHELL_INVALID_PARAMETER
;
1218 if (MapAsHandle
!= NULL
) {
1219 TempStringLength
= StrLen(SName
);
1220 if (!IsNumberLetterOnly(SName
, TempStringLength
-(SName
[TempStringLength
-1]==L
':'?1:0))) {
1221 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, SName
);
1222 ShellStatus
= SHELL_INVALID_PARAMETER
;
1224 ShellStatus
= AddMappingFromHandle(MapAsHandle
, SName
);
1227 TempStringLength
= StrLen(SName
);
1228 if (!IsNumberLetterOnly(SName
, TempStringLength
-(SName
[TempStringLength
-1]==L
':'?1:0))) {
1229 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, SName
);
1230 ShellStatus
= SHELL_INVALID_PARAMETER
;
1232 ShellStatus
= AddMappingFromMapping(Mapping
, SName
);
1235 if (ShellStatus
!= SHELL_SUCCESS
) {
1236 switch (ShellStatus
) {
1237 case SHELL_ACCESS_DENIED
:
1238 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellLevel2HiiHandle
);
1240 case SHELL_INVALID_PARAMETER
:
1241 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
), gShellLevel2HiiHandle
);
1243 case SHELL_DEVICE_ERROR
:
1244 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MAP_NOF
), gShellLevel2HiiHandle
, Mapping
);
1247 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, ShellStatus
|MAX_BIT
);
1251 // now do the display...
1253 ShellStatus
= PerformMappingDisplay(
1262 } // we were sucessful so do an output
1263 } // got a valid map target
1264 } // got 2 variables
1265 } // we are adding a mapping
1266 } // got valid parameters
1270 // free the command line package
1272 ShellCommandLineFreeVarList (Package
);
1274 return (ShellStatus
);