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
"AnyF*", 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
529 @retval SHELL_SUCCESS the display was printed
530 @retval SHELL_INVALID_PARAMETER one of Consist or Normal must be TRUE if no Specific
535 PerformMappingDisplay(
536 IN CONST BOOLEAN Verbose
,
537 IN CONST BOOLEAN Consist
,
538 IN CONST BOOLEAN Normal
,
539 IN CONST CHAR16
*TypeString
,
540 IN CONST BOOLEAN SFO
,
541 IN CONST CHAR16
*Specific OPTIONAL
,
542 IN CONST BOOLEAN Header
546 EFI_HANDLE
*HandleBuffer
;
552 if (!Consist
&& !Normal
&& Specific
== NULL
&& TypeString
== NULL
) {
553 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellLevel2HiiHandle
);
554 return (SHELL_INVALID_PARAMETER
);
557 if (TypeString
!= NULL
) {
559 if (StrnCmp(TypeString
, Test
, StrLen(Test
)-1) != 0) {
561 if (StrnCmp(TypeString
, Test
, StrLen(Test
)-1) != 0) {
563 if (StrnCmp(TypeString
, Test
, StrLen(Test
)-1) != 0) {
564 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, TypeString
);
565 return (SHELL_INVALID_PARAMETER
);
567 } else if (Test
== NULL
) {
568 Test
= (CHAR16
*)AnyF
;
580 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MAP_HEADER
), gShellLevel2HiiHandle
);
582 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_SFO_HEADER
), gShellLevel2HiiHandle
, L
"map");
590 // Look up all SimpleFileSystems in the platform
592 Status
= gBS
->LocateHandle(
594 &gEfiSimpleFileSystemProtocolGuid
,
598 if (Status
== EFI_BUFFER_TOO_SMALL
) {
599 HandleBuffer
= AllocateZeroPool(BufferSize
);
600 if (HandleBuffer
== NULL
) {
601 return (SHELL_OUT_OF_RESOURCES
);
603 Status
= gBS
->LocateHandle(
605 &gEfiSimpleFileSystemProtocolGuid
,
612 // Get the map name(s) for each one.
614 for ( LoopVar
= 0, Found
= FALSE
615 ; LoopVar
< (BufferSize
/ sizeof(EFI_HANDLE
)) && HandleBuffer
!= NULL
618 Status
= PerformSingleMappingDisplay(
625 HandleBuffer
[LoopVar
]);
626 if (!EFI_ERROR(Status
)) {
632 // Look up all BlockIo in the platform
634 Status
= gBS
->LocateHandle(
636 &gEfiBlockIoProtocolGuid
,
640 if (Status
== EFI_BUFFER_TOO_SMALL
) {
641 SHELL_FREE_NON_NULL(HandleBuffer
);
642 HandleBuffer
= AllocateZeroPool(BufferSize
);
643 if (HandleBuffer
== NULL
) {
644 return (SHELL_OUT_OF_RESOURCES
);
646 Status
= gBS
->LocateHandle(
648 &gEfiBlockIoProtocolGuid
,
653 if (!EFI_ERROR(Status
)) {
655 // Get the map name(s) for each one.
658 ; LoopVar
< BufferSize
/ sizeof(EFI_HANDLE
)
662 // Skip any that were already done...
664 if (gBS
->OpenProtocol(
665 HandleBuffer
[LoopVar
],
666 &gEfiSimpleFileSystemProtocolGuid
,
670 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
) == EFI_SUCCESS
) {
673 Status
= PerformSingleMappingDisplay(
680 HandleBuffer
[LoopVar
]);
681 if (!EFI_ERROR(Status
)) {
685 FreePool(HandleBuffer
);
688 ShellPrintHiiEx(gST
->ConOut
->Mode
->CursorColumn
, gST
->ConOut
->Mode
->CursorRow
-1, NULL
, STRING_TOKEN (STR_MAP_NF
), gShellLevel2HiiHandle
, Specific
);
690 return (SHELL_SUCCESS
);
694 Perform a mapping display and parse for multiple types in the TypeString.
696 @param[in] Verbose TRUE to use verbose output.
697 @param[in] Consist TRUE to display consistent names.
698 @param[in] Normal TRUE to display normal names.
699 @param[in] TypeString An optional comma-delimited list of types.
700 @param[in] SFO TRUE to display in SFO format. See Spec.
701 @param[in] Specific An optional specific map name to display alone.
703 @retval SHELL_INVALID_PARAMETER A parameter was invalid.
704 @retval SHELL_SUCCESS The display was successful.
705 @sa PerformMappingDisplay
709 PerformMappingDisplay2(
710 IN CONST BOOLEAN Verbose
,
711 IN CONST BOOLEAN Consist
,
712 IN CONST BOOLEAN Normal
,
713 IN CONST CHAR16
*TypeString
,
714 IN CONST BOOLEAN SFO
,
715 IN CONST CHAR16
*Specific OPTIONAL
718 CONST CHAR16
*TypeWalker
;
719 SHELL_STATUS ShellStatus
;
723 if (TypeString
== NULL
) {
724 return (PerformMappingDisplay(Verbose
, Consist
, Normal
, NULL
, SFO
, Specific
, TRUE
));
726 ShellStatus
= SHELL_SUCCESS
;
727 for (TypeWalker
= TypeString
; TypeWalker
!= NULL
&& *TypeWalker
!= CHAR_NULL
;) {
728 Comma
= StrStr(TypeWalker
, L
",");
730 if (ShellStatus
== SHELL_SUCCESS
) {
731 ShellStatus
= PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
733 PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
738 if (ShellStatus
== SHELL_SUCCESS
) {
739 ShellStatus
= PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
741 PerformMappingDisplay(Verbose
, Consist
, Normal
, TypeWalker
, SFO
, Specific
, (BOOLEAN
)(TypeWalker
== TypeString
));
744 TypeWalker
= Comma
+ 1;
748 return (ShellStatus
);
752 Delete a specific map.
754 @param[in] Specific The pointer to the name of the map to delete.
756 @retval EFI_INVALID_PARAMETER Specific was NULL.
757 @retval EFI_SUCCESS The operation was successful.
758 @retval EFI_NOT_FOUND Specific could not be found.
762 PerformMappingDelete(
763 IN CONST CHAR16
*Specific
767 EFI_HANDLE
*HandleBuffer
;
772 if (Specific
== NULL
) {
773 return (EFI_INVALID_PARAMETER
);
781 // Look up all SimpleFileSystems in the platform
783 Status
= gBS
->LocateHandle(
785 &gEfiDevicePathProtocolGuid
,
789 if (Status
== EFI_BUFFER_TOO_SMALL
) {
790 HandleBuffer
= AllocateZeroPool(BufferSize
);
791 if (HandleBuffer
== NULL
) {
792 return (EFI_OUT_OF_RESOURCES
);
794 Status
= gBS
->LocateHandle(
796 &gEfiDevicePathProtocolGuid
,
801 if (EFI_ERROR(Status
)) {
802 SHELL_FREE_NON_NULL(HandleBuffer
);
806 if (HandleBuffer
!= NULL
) {
808 // Get the map name(s) for each one.
811 ; LoopVar
< BufferSize
/ sizeof(EFI_HANDLE
)
814 if (PerformSingleMappingDelete(Specific
,HandleBuffer
[LoopVar
]) == SHELL_SUCCESS
) {
820 // Look up all BlockIo in the platform
822 Status
= gBS
->LocateHandle(
824 &gEfiBlockIoProtocolGuid
,
828 if (Status
== EFI_BUFFER_TOO_SMALL
) {
829 FreePool(HandleBuffer
);
830 HandleBuffer
= AllocateZeroPool(BufferSize
);
831 if (HandleBuffer
== NULL
) {
832 return (EFI_OUT_OF_RESOURCES
);
834 Status
= gBS
->LocateHandle(
836 &gEfiBlockIoProtocolGuid
,
841 if (EFI_ERROR(Status
)) {
842 SHELL_FREE_NON_NULL(HandleBuffer
);
846 if (HandleBuffer
!= NULL
) {
848 // Get the map name(s) for each one.
851 ; LoopVar
< BufferSize
/ sizeof(EFI_HANDLE
)
855 // Skip any that were already done...
857 if (gBS
->OpenProtocol(
858 HandleBuffer
[LoopVar
],
859 &gEfiDevicePathProtocolGuid
,
863 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
) == EFI_SUCCESS
) {
866 if (PerformSingleMappingDelete(Specific
,HandleBuffer
[LoopVar
]) == SHELL_SUCCESS
) {
871 SHELL_FREE_NON_NULL(HandleBuffer
);
873 return (EFI_NOT_FOUND
);
875 return (EFI_SUCCESS
);
879 function to add a mapping from mapping.
881 This function will get the device path associated with the mapping and call SetMap.
883 @param[in] Map The Map to add a mapping for
884 @param[in] SName The name of the new mapping
886 @retval SHELL_SUCCESS the mapping was added
887 @retval SHELL_INVALID_PARAMETER the device path for Map could not be retrieved.
888 @return Shell version of a return value from EfiShellProtocol->SetMap
893 AddMappingFromMapping(
894 IN CONST CHAR16
*Map
,
895 IN CONST CHAR16
*SName
898 CONST EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
902 NewSName
= AllocateZeroPool(StrSize(SName
) + sizeof(CHAR16
));
903 if (NewSName
== NULL
) {
904 return (SHELL_OUT_OF_RESOURCES
);
906 StrCpy(NewSName
, SName
);
907 if (NewSName
[StrLen(NewSName
)-1] != L
':') {
908 StrCat(NewSName
, L
":");
911 if (!IsNumberLetterOnly(NewSName
, StrLen(NewSName
)-1)) {
913 return (SHELL_INVALID_PARAMETER
);
916 DevPath
= gEfiShellProtocol
->GetDevicePathFromMap(Map
);
917 if (DevPath
== NULL
) {
919 return (SHELL_INVALID_PARAMETER
);
922 Status
= gEfiShellProtocol
->SetMap(DevPath
, NewSName
);
924 if (EFI_ERROR(Status
)) {
925 return (SHELL_DEVICE_ERROR
);
927 return (SHELL_SUCCESS
);
931 function to add a mapping from an EFI_HANDLE.
933 This function will get the device path associated with the Handle and call SetMap.
935 @param[in] Handle The handle to add a mapping for
936 @param[in] SName The name of the new mapping
938 @retval SHELL_SUCCESS the mapping was added
939 @retval SHELL_INVALID_PARAMETER SName was not valid for a map name.
940 @return Shell version of a return value from either
941 gBS->OpenProtocol or EfiShellProtocol->SetMap
946 AddMappingFromHandle(
947 IN CONST EFI_HANDLE Handle
,
948 IN CONST CHAR16
*SName
951 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
955 NewSName
= AllocateZeroPool(StrSize(SName
) + sizeof(CHAR16
));
956 if (NewSName
== NULL
) {
957 return (SHELL_OUT_OF_RESOURCES
);
959 StrCpy(NewSName
, SName
);
960 if (NewSName
[StrLen(NewSName
)-1] != L
':') {
961 StrCat(NewSName
, L
":");
964 if (!IsNumberLetterOnly(NewSName
, StrLen(NewSName
)-1)) {
966 return (SHELL_INVALID_PARAMETER
);
969 Status
= gBS
->OpenProtocol(
971 &gEfiDevicePathProtocolGuid
,
975 EFI_OPEN_PROTOCOL_GET_PROTOCOL
977 if (EFI_ERROR(Status
)) {
979 return (SHELL_DEVICE_ERROR
);
981 Status
= gEfiShellProtocol
->SetMap(DevPath
, NewSName
);
983 if (EFI_ERROR(Status
)) {
984 return (SHELL_DEVICE_ERROR
);
986 return (SHELL_SUCCESS
);
989 STATIC CONST SHELL_PARAM_ITEM MapParamList
[] = {
997 {L
"-sfo", TypeValue
},
1002 Function for 'map' command.
1004 @param[in] ImageHandle Handle to the Image (NULL if Internal).
1005 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
1009 ShellCommandRunMap (
1010 IN EFI_HANDLE ImageHandle
,
1011 IN EFI_SYSTEM_TABLE
*SystemTable
1015 LIST_ENTRY
*Package
;
1016 CHAR16
*ProblemParam
;
1017 CONST CHAR16
*SName
;
1018 CONST CHAR16
*Mapping
;
1019 EFI_HANDLE MapAsHandle
;
1020 CONST EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1021 SHELL_STATUS ShellStatus
;
1025 CONST CHAR16
*Param1
;
1026 CONST CHAR16
*TypeString
;
1027 UINTN TempStringLength
;
1029 ProblemParam
= NULL
;
1033 ShellStatus
= SHELL_SUCCESS
;
1037 // initialize the shell lib (we must be in non-auto-init...)
1039 Status
= ShellInitialize();
1040 ASSERT_EFI_ERROR(Status
);
1042 Status
= CommandInit();
1043 ASSERT_EFI_ERROR(Status
);
1046 // parse the command line
1048 Status
= ShellCommandLineParse (MapParamList
, &Package
, &ProblemParam
, TRUE
);
1049 if (EFI_ERROR(Status
)) {
1050 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
1051 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, ProblemParam
);
1052 FreePool(ProblemParam
);
1053 ShellStatus
= SHELL_INVALID_PARAMETER
;
1061 SfoMode
= ShellCommandLineGetFlag(Package
, L
"-sfo");
1062 ConstMode
= ShellCommandLineGetFlag(Package
, L
"-c");
1063 NormlMode
= ShellCommandLineGetFlag(Package
, L
"-f");
1064 if (ShellCommandLineGetFlag(Package
, L
"-?")) {
1066 } else if (ShellCommandLineGetRawValue(Package
, 3) != NULL
) {
1067 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellLevel2HiiHandle
);
1068 ShellStatus
= SHELL_INVALID_PARAMETER
;
1071 // Deleting a map name...
1073 if (ShellCommandLineGetFlag(Package
, L
"-d")) {
1074 if ( ShellCommandLineGetFlag(Package
, L
"-r")
1075 || ShellCommandLineGetFlag(Package
, L
"-v")
1078 || ShellCommandLineGetFlag(Package
, L
"-u")
1079 || ShellCommandLineGetFlag(Package
, L
"-t")
1081 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CON
), gShellLevel2HiiHandle
);
1082 ShellStatus
= SHELL_INVALID_PARAMETER
;
1084 SName
= ShellCommandLineGetValue(Package
, L
"-d");
1085 if (SName
!= NULL
) {
1086 Status
= PerformMappingDelete(SName
);
1087 if (EFI_ERROR(Status
)) {
1089 case EFI_ACCESS_DENIED
:
1090 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellLevel2HiiHandle
);
1091 ShellStatus
= SHELL_ACCESS_DENIED
;
1094 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MAP_NF
), gShellLevel2HiiHandle
, SName
);
1095 ShellStatus
= SHELL_INVALID_PARAMETER
;
1098 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
1099 ShellStatus
= SHELL_UNSUPPORTED
;
1103 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
), gShellLevel2HiiHandle
);
1104 ShellStatus
= SHELL_INVALID_PARAMETER
;
1107 } else if ( ShellCommandLineGetFlag(Package
, L
"-r")
1108 // || ShellCommandLineGetFlag(Package, L"-v")
1111 || ShellCommandLineGetFlag(Package
, L
"-u")
1112 || ShellCommandLineGetFlag(Package
, L
"-t")
1114 if ( ShellCommandLineGetFlag(Package
, L
"-r")) {
1118 Status
= ShellCommandCreateInitialMappingsAndPaths();
1119 if (EFI_ERROR(Status
)) {
1120 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
1121 ShellStatus
= SHELL_UNSUPPORTED
;
1124 if ( ShellStatus
== SHELL_SUCCESS
&& ShellCommandLineGetFlag(Package
, L
"-u")) {
1128 Status
= UpdateMapping();
1129 if (EFI_ERROR(Status
)) {
1130 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, Status
);
1131 ShellStatus
= SHELL_UNSUPPORTED
;
1134 if (ShellStatus
== SHELL_SUCCESS
) {
1135 Param1
= ShellCommandLineGetRawValue(Package
, 1);
1136 TypeString
= ShellCommandLineGetValue(Package
, L
"-t");
1139 &&TypeString
== NULL
1142 // now do the display...
1144 ShellStatus
= PerformMappingDisplay(
1145 ShellCommandLineGetFlag(Package
, L
"-v"),
1155 // now do the display...
1157 ShellStatus
= PerformMappingDisplay2(
1158 ShellCommandLineGetFlag(Package
, L
"-v"),
1169 // adding or displaying (there were no flags)
1171 SName
= ShellCommandLineGetRawValue(Package
, 1);
1172 Mapping
= ShellCommandLineGetRawValue(Package
, 2);
1177 // display only since no flags
1179 ShellStatus
= PerformMappingDisplay(
1180 ShellCommandLineGetFlag(Package
, L
"-v"),
1188 } else if ( SName
== NULL
1192 // Display only the one specified
1194 ShellStatus
= PerformMappingDisplay(
1200 SName
, // note the variable here...
1204 if (ShellIsHexOrDecimalNumber(Mapping
, TRUE
, FALSE
)) {
1205 MapAsHandle
= ConvertHandleIndexToHandle(ShellStrToUintn(Mapping
));
1209 if (MapAsHandle
== NULL
&& Mapping
[StrLen(Mapping
)-1] != L
':') {
1210 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, Mapping
);
1211 ShellStatus
= SHELL_INVALID_PARAMETER
;
1213 if (MapAsHandle
!= NULL
) {
1214 TempStringLength
= StrLen(SName
);
1215 if (!IsNumberLetterOnly(SName
, TempStringLength
-(SName
[TempStringLength
-1]==L
':'?1:0))) {
1216 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, SName
);
1217 ShellStatus
= SHELL_INVALID_PARAMETER
;
1219 ShellStatus
= AddMappingFromHandle(MapAsHandle
, SName
);
1222 TempStringLength
= StrLen(SName
);
1223 if (!IsNumberLetterOnly(SName
, TempStringLength
-(SName
[TempStringLength
-1]==L
':'?1:0))) {
1224 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellLevel2HiiHandle
, SName
);
1225 ShellStatus
= SHELL_INVALID_PARAMETER
;
1227 ShellStatus
= AddMappingFromMapping(Mapping
, SName
);
1230 if (ShellStatus
!= SHELL_SUCCESS
) {
1231 switch (ShellStatus
) {
1232 case SHELL_ACCESS_DENIED
:
1233 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_AD
), gShellLevel2HiiHandle
);
1235 case SHELL_INVALID_PARAMETER
:
1236 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
), gShellLevel2HiiHandle
);
1238 case SHELL_DEVICE_ERROR
:
1239 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_MAP_NOF
), gShellLevel2HiiHandle
, Mapping
);
1242 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_ERR_UK
), gShellLevel2HiiHandle
, ShellStatus
|MAX_BIT
);
1246 // now do the display...
1248 ShellStatus
= PerformMappingDisplay(
1257 } // we were sucessful so do an output
1258 } // got a valid map target
1259 } // got 2 variables
1260 } // we are adding a mapping
1261 } // got valid parameters
1265 // free the command line package
1267 ShellCommandLineFreeVarList (Package
);
1269 return (ShellStatus
);