[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel2CommandsLib / Map.c

/** @file\r
  Main file for map shell level 2 command.\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "UefiShellLevel2CommandsLib.h"\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/BlockIo.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/HandleParsingLib.h>\r
#include <Library/SortLib.h>\r
\r
BOOLEAN\r
EFIAPI\r
SearchList(\r
  IN CONST CHAR16   *List,\r
  IN CONST CHAR16   *MetaTarget,\r
  OUT CHAR16        **FullName OPTIONAL,\r
  IN CONST BOOLEAN  Meta,\r
  IN CONST BOOLEAN  SkipTrailingNumbers,\r
  IN CONST CHAR16   *Target\r
\r
  )\r
{\r
  CHAR16        *TempList;\r
  CONST CHAR16  *ListWalker;\r
  BOOLEAN       Result;\r
  CHAR16        *TempSpot;\r
\r
  for (ListWalker = List , TempList = NULL\r
     ; ListWalker != NULL && *ListWalker != CHAR_NULL\r
     ;\r
   ) {\r
    TempList = StrnCatGrow(&TempList, NULL, ListWalker, 0);\r
    ASSERT(TempList != NULL);\r
    TempSpot = StrStr(TempList, Target);\r
    if (TempSpot != NULL) {\r
      *TempSpot = CHAR_NULL;\r
    }\r
\r
    while (SkipTrailingNumbers && (ShellIsDecimalDigitCharacter(TempList[StrLen(TempList)-1]) || TempList[StrLen(TempList)-1] == L':')) {\r
      TempList[StrLen(TempList)-1] = CHAR_NULL;\r
    }\r
\r
    ListWalker = StrStr(ListWalker, Target);\r
    while(ListWalker != NULL && *ListWalker == *Target) {\r
      ListWalker++;\r
    }\r
    if (Meta) {\r
      Result = gUnicodeCollation->MetaiMatch(gUnicodeCollation, (CHAR16*)TempList, (CHAR16*)MetaTarget);\r
    } else {\r
      Result = (BOOLEAN)(StrCmp(TempList, MetaTarget)==0);\r
    }\r
    if (Result) {\r
      if (FullName != NULL) {\r
        *FullName = TempList;\r
      } else {\r
        FreePool(TempList);\r
      }\r
      return (TRUE);\r
    }\r
    FreePool(TempList);\r
    TempList = NULL;\r
  }\r
\r
  return (FALSE);\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
UpdateMapping (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_HANDLE                *HandleList;\r
  UINTN                     Count;\r
  EFI_DEVICE_PATH_PROTOCOL  **DevicePathList;\r
  CHAR16                    *NewDefaultName;\r
  CHAR16                    *NewConsistName;\r
  EFI_DEVICE_PATH_PROTOCOL  **ConsistMappingTable;\r
\r
  HandleList  = NULL;\r
  Status      = EFI_SUCCESS;\r
\r
  //\r
  // remove mappings that represent removed devices.\r
  //\r
\r
  //\r
  // Find each handle with Simple File System\r
  //\r
  HandleList = GetHandleListByProtocol(&gEfiSimpleFileSystemProtocolGuid);\r
  if (HandleList != NULL) {\r
    //\r
    // Do a count of the handles\r
    //\r
    for (Count = 0 ; HandleList[Count] != NULL ; Count++);\r
\r
    //\r
    // Get all Device Paths\r
    //\r
    DevicePathList = AllocatePool(sizeof(EFI_DEVICE_PATH_PROTOCOL*) * Count);\r
    ASSERT(DevicePathList != NULL);\r
\r
    for (Count = 0 ; HandleList[Count] != NULL ; Count++) {\r
      DevicePathList[Count] = DevicePathFromHandle(HandleList[Count]);\r
    }\r
\r
    //\r
    // Sort all DevicePaths\r
    //\r
    PerformQuickSort(DevicePathList, Count, sizeof(EFI_DEVICE_PATH_PROTOCOL*), DevicePathCompare);\r
\r
    ShellCommandConsistMappingInitialize(&ConsistMappingTable);\r
\r
    //\r
    // Assign new Mappings to remainders\r
    //\r
    for (Count = 0 ; HandleList[Count] != NULL && !EFI_ERROR(Status); Count++) {\r
      //\r
      // Skip ones that already have\r
      //\r
      if (gEfiShellProtocol->GetMapFromDevicePath(&DevicePathList[Count]) != NULL) {\r
        continue;\r
      }\r
      //\r
      // Get default name\r
      //\r
      NewDefaultName = ShellCommandCreateNewMappingName(MappingTypeFileSystem);\r
      ASSERT(NewDefaultName != NULL);\r
\r
      //\r
      // Call shell protocol SetMap function now...\r
      //\r
      Status = gEfiShellProtocol->SetMap(DevicePathList[Count], NewDefaultName);\r
\r
      if (!EFI_ERROR(Status)) {\r
        //\r
        // Now do consistent name\r
        //\r
        NewConsistName = ShellCommandConsistMappingGenMappingName(DevicePathList[Count], ConsistMappingTable);\r
        if (NewConsistName != NULL) {\r
          Status = gEfiShellProtocol->SetMap(DevicePathList[Count], NewConsistName);\r
          FreePool(NewConsistName);\r
        }\r
      }\r
\r
      FreePool(NewDefaultName);\r
    }\r
    ShellCommandConsistMappingUnInitialize(ConsistMappingTable);\r
    SHELL_FREE_NON_NULL(HandleList);\r
    SHELL_FREE_NON_NULL(DevicePathList);\r
\r
    HandleList = NULL;\r
  } else {\r
    Count = (UINTN)-1;\r
  }\r
  //\r
  // Do it all over again for gEfiBlockIoProtocolGuid\r
  //\r
\r
  return (Status);\r
}\r
\r
CHAR16*\r
EFIAPI\r
GetDeviceMediaType (\r
  IN  EFI_DEVICE_PATH_PROTOCOL     *DevicePath\r
  )\r
{\r
  ACPI_HID_DEVICE_PATH  *Acpi;\r
\r
  //\r
  //  Parse the device path:\r
  //  Devicepath sub type                 mediatype\r
  //    MEDIA_HANRDDRIVE_DP      ->       Hard Disk\r
  //    MEDIA_CDROM_DP           ->       CD Rom\r
  //    Acpi.HID = 0X0604        ->       Floppy\r
  //\r
  if (NULL == DevicePath) {\r
    return HiiGetString(gShellLevel2HiiHandle, STRING_TOKEN(STR_MAP_MEDIA_UNKNOWN), NULL);\r
  }\r
\r
  for (;!IsDevicePathEndType (DevicePath) ;DevicePath = NextDevicePathNode (DevicePath)) {\r
    if (DevicePathType (DevicePath) == MEDIA_DEVICE_PATH) {\r
      switch (DevicePathSubType (DevicePath)) {\r
      case MEDIA_HARDDRIVE_DP:\r
        return HiiGetString(gShellLevel2HiiHandle, STRING_TOKEN(STR_MAP_MEDIA_HARDDISK), NULL);\r
      case MEDIA_CDROM_DP:\r
        return HiiGetString(gShellLevel2HiiHandle, STRING_TOKEN(STR_MAP_MEDIA_CDROM), NULL);\r
      }\r
    } else if (DevicePathType (DevicePath) == ACPI_DEVICE_PATH) {\r
      Acpi = (ACPI_HID_DEVICE_PATH *) DevicePath;\r
      if (EISA_ID_TO_NUM (Acpi->HID) == 0x0604) {\r
        return HiiGetString(gShellLevel2HiiHandle, STRING_TOKEN(STR_MAP_MEDIA_FLOPPY), NULL);\r
      }\r
    }\r
  }\r
\r
  return HiiGetString(gShellLevel2HiiHandle, STRING_TOKEN(STR_MAP_MEDIA_UNKNOWN), NULL);\r
}\r
\r
/**\r
  Function to detemine if a handle has removable storage.\r
\r
  @param[in] DevicePath             DevicePath to test.\r
\r
  @retval TRUE                      The handle has removable storage.\r
  @retval FALSE                     The handle does not have removable storage.\r
**/\r
BOOLEAN\r
EFIAPI\r
IsRemoveableDevice (\r
  IN EFI_DEVICE_PATH_PROTOCOL      *DevicePath\r
  )\r
{\r
  if (NULL == DevicePath) {\r
    return FALSE;\r
  }\r
\r
  while (!IsDevicePathEndType (DevicePath)) {\r
    if (DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) {\r
      switch (DevicePathSubType (DevicePath)) {\r
      case MSG_USB_DP:\r
      case MSG_SCSI_DP:\r
        return TRUE;\r
      default:\r
        return FALSE;\r
      }\r
    }\r
    DevicePath = NextDevicePathNode (DevicePath);\r
  }\r
  return FALSE;\r
}\r
\r
/**\r
  Function to detemine if a something on the map list matches.\r
\r
  @param[in] MapList          The pointer to the list to test.\r
  @param[in] Specific         The pointer to a specific name to test for.\r
  @param[in] TypeString       The pointer to the list of types.\r
  @param[in] Normal           Always show normal mappings.\r
  @param[in] Consist          Always show consistent mappings.\r
\r
  @retval TRUE                The map should be displayed.\r
  @retval FALSE               The map should not be displayed.\r
**/\r
BOOLEAN\r
EFIAPI\r
MappingListHasType(\r
  IN CONST CHAR16     *MapList,\r
  IN CONST CHAR16     *Specific,\r
  IN CONST CHAR16     *TypeString,\r
  IN CONST BOOLEAN    Normal,\r
  IN CONST BOOLEAN    Consist\r
  )\r
{\r
  //\r
  // specific has priority\r
  //\r
  if ( Specific != NULL\r
    && SearchList(MapList, Specific, NULL, TRUE, FALSE, L";")) {\r
    return (TRUE);\r
  }\r
\r
  if (  Consist\r
    && (SearchList(MapList, L"HD*",  NULL, TRUE, TRUE, L";")\r
      ||SearchList(MapList, L"CD*",  NULL, TRUE, TRUE, L";")\r
      ||SearchList(MapList, L"F*",   NULL, TRUE, TRUE, L";")\r
      ||SearchList(MapList, L"FP*",  NULL, TRUE, TRUE, L";"))){\r
    return (TRUE);\r
  }\r
\r
  if (  Normal\r
    && (SearchList(MapList, L"FS",  NULL, FALSE, TRUE, L";")\r
      ||SearchList(MapList, L"BLK", NULL, FALSE, TRUE, L";"))){\r
    return (TRUE);\r
  }\r
\r
  if (TypeString != NULL && SearchList(MapList, TypeString,  NULL, TRUE, TRUE, L";")) {\r
    return (TRUE);\r
  }\r
  return (FALSE);\r
}\r
\r
\r
VOID\r
EFIAPI\r
PerformSingleMappingDisplay(\r
  IN CONST BOOLEAN    Verbose,\r
  IN CONST BOOLEAN    Consist,\r
  IN CONST BOOLEAN    Normal,\r
  IN CONST CHAR16     *TypeString,\r
  IN CONST BOOLEAN    SFO,\r
  IN CONST CHAR16     *Specific OPTIONAL,\r
  IN CONST EFI_HANDLE Handle\r
  )\r
{\r
  EFI_DEVICE_PATH_PROTOCOL  *DevPath;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevPathCopy;\r
  CONST CHAR16              *MapList;\r
  CHAR16                    *CurrentName;\r
  CHAR16                    *MediaType;\r
  CHAR16                    *DevPathString;\r
  CHAR16                    *TempSpot;\r
  UINTN                     TempLen;\r
  BOOLEAN                   Removable;\r
  CONST CHAR16              *TempSpot2;\r
\r
  DevPath = DevicePathFromHandle(Handle);\r
  DevPathCopy = DevPath;\r
  MapList = gEfiShellProtocol->GetMapFromDevicePath(&DevPathCopy);\r
  if (MapList == NULL) {\r
    return;\r
  }\r
\r
  if (!MappingListHasType(MapList, Specific, TypeString, Normal, Consist)){\r
    return;\r
  }\r
\r
  CurrentName = NULL;\r
  CurrentName = StrnCatGrow(&CurrentName, 0, MapList, 0);\r
  TempSpot = StrStr(CurrentName, L";");\r
  if (TempSpot != NULL) {\r
    *TempSpot = CHAR_NULL;\r
  }\r
  DevPathString = gDevPathToText->ConvertDevicePathToText(DevPath, TRUE, FALSE);\r
  if (!SFO) {\r
    TempLen = StrLen(CurrentName);\r
    ShellPrintHiiEx (\r
      -1,\r
      -1,\r
      NULL,\r
      STRING_TOKEN (STR_MAP_ENTRY),\r
      gShellLevel2HiiHandle,\r
      CurrentName,\r
      TempLen < StrLen(MapList)?MapList + TempLen+1:L"",\r
      DevPathString\r
     );\r
    if (Verbose) {\r
      //\r
      // also print handle, media type, removable (y/n), and current directory\r
      //\r
      MediaType = GetDeviceMediaType(DevPath);\r
      if ((TypeString != NULL &&MediaType != NULL && StrStr(TypeString, MediaType) != NULL) || TypeString == NULL) {\r
        Removable = IsRemoveableDevice(DevPath);\r
        TempSpot2 = ShellGetCurrentDir(CurrentName);\r
        ShellPrintHiiEx (\r
          -1,\r
          -1,\r
          NULL,\r
          STRING_TOKEN (STR_MAP_ENTRY_VERBOSE),\r
          gShellLevel2HiiHandle,\r
          ConvertHandleToHandleIndex(Handle),\r
          MediaType,\r
          Removable?L"Yes":L"No",\r
          TempSpot2\r
         );\r
      }\r
      FreePool(MediaType);\r
    }\r
  } else {\r
    TempLen = StrLen(CurrentName);\r
    ShellPrintHiiEx (\r
      -1,\r
      -1,\r
      NULL,\r
      STRING_TOKEN (STR_MAP_SFO_MAPPINGS),\r
      gShellLevel2HiiHandle,\r
      CurrentName,\r
      DevPathString,\r
      TempLen < StrLen(MapList)?MapList + TempLen+1:L""\r
     );\r
  }\r
  FreePool(DevPathString);\r
  FreePool(CurrentName);\r
  return;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
PerformSingleMappingDelete(\r
  IN CONST CHAR16     *Specific,\r
  IN CONST EFI_HANDLE Handle\r
  )\r
{\r
  EFI_DEVICE_PATH_PROTOCOL  *DevPath;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevPathCopy;\r
  CONST CHAR16              *MapList;\r
  CHAR16                    *CurrentName;\r
\r
  DevPath     = DevicePathFromHandle(Handle);\r
  DevPathCopy = DevPath;\r
  MapList     = gEfiShellProtocol->GetMapFromDevicePath(&DevPathCopy);\r
  CurrentName = NULL;\r
\r
  if (MapList == NULL) {\r
    return (EFI_NOT_FOUND);\r
  }\r
  //\r
  // if there is a specific and its not on the list...\r
  //\r
  if (!SearchList(MapList, Specific, &CurrentName, TRUE, FALSE, L";")) {\r
    return (EFI_NOT_FOUND);\r
  }\r
  return (gEfiShellProtocol->SetMap(NULL, CurrentName));\r
}\r
\r
/**\r
  Function to display mapping information to the user.\r
\r
  if Specific is specified then Consist and Normal will be ignored since information will\r
  be printed for the specific item only.\r
\r
  @param[in] Verbose                TRUE to display (extra) verbose information\r
  @param[in] Consist                TRUE to display consistent mappings\r
  @param[in] Normal                 TRUE to display normal (not consist) mappings\r
  @param[in] TypeString             pointer to string of filter types\r
  @param[in] SFO                    TRUE to display output in Standard Output Format\r
  @param[in] Specific               pointer to string for specific map to display\r
\r
  @retval SHELL_SUCCESS               the display was printed\r
  @retval SHELL_INVALID_PARAMETER     one of Consist or Normal must be TRUE if no Specific\r
\r
**/\r
CONST CHAR16 Cd[] = L"cd*";\r
CONST CHAR16 Hd[] = L"hd*";\r
CONST CHAR16 Fp[] = L"fp*";\r
CONST CHAR16 F[] = L"F*";\r
SHELL_STATUS\r
EFIAPI\r
PerformMappingDisplay(\r
  IN CONST BOOLEAN Verbose,\r
  IN CONST BOOLEAN Consist,\r
  IN CONST BOOLEAN Normal,\r
  IN CONST CHAR16  *TypeString,\r
  IN CONST BOOLEAN SFO,\r
  IN CONST CHAR16  *Specific OPTIONAL,\r
  IN CONST BOOLEAN Header\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_HANDLE                *HandleBuffer;\r
  UINTN                     BufferSize;\r
  UINTN                     LoopVar;\r
  CHAR16                    *Test;\r
\r
  if (!Consist && !Normal && Specific == NULL && TypeString == NULL) {\r
    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel2HiiHandle);\r
    return (SHELL_INVALID_PARAMETER);\r
  }\r
\r
  if (TypeString != NULL) {\r
    Test = (CHAR16*)Cd;\r
    if (StrnCmp(TypeString, Test, StrLen(Test)-1) != 0) {\r
      Test = (CHAR16*)Hd;\r
      if (StrnCmp(TypeString, Test, StrLen(Test)-1) != 0) {\r
        Test = (CHAR16*)Fp;\r
        if (StrnCmp(TypeString, Test, StrLen(Test)-1) != 0) {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, TypeString);\r
          return (SHELL_INVALID_PARAMETER);\r
        }\r
      } else if (Test == NULL) {\r
        Test = (CHAR16*)F;\r
      }\r
    }\r
  } else {\r
    Test = NULL;\r
  }\r
\r
  if (Header) {\r
    //\r
    // Print the header\r
    //\r
    if (!SFO) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_MAP_HEADER), gShellLevel2HiiHandle);\r
    } else {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_SFO_HEADER), gShellLevel2HiiHandle, L"map");\r
    }\r
  }\r
\r
  BufferSize    = 0;\r
  HandleBuffer  = NULL;\r
\r
  //\r
  // Look up all SimpleFileSystems in the platform\r
  //\r
  Status = gBS->LocateHandle(\r
    ByProtocol,\r
    &gEfiDevicePathProtocolGuid,\r
    NULL,\r
    &BufferSize,\r
    HandleBuffer);\r
  if (Status == EFI_BUFFER_TOO_SMALL) {\r
    HandleBuffer = AllocatePool(BufferSize);\r
    if (HandleBuffer == NULL) {\r
      return (SHELL_OUT_OF_RESOURCES);\r
    }\r
    Status = gBS->LocateHandle(\r
      ByProtocol,\r
      &gEfiDevicePathProtocolGuid,\r
      NULL,\r
      &BufferSize,\r
      HandleBuffer);\r
  }\r
  ASSERT_EFI_ERROR(Status);\r
  ASSERT(HandleBuffer != NULL);\r
\r
  //\r
  // Get the map name(s) for each one.\r
  //\r
  for ( LoopVar = 0\r
      ; LoopVar < (BufferSize / sizeof(EFI_HANDLE))\r
      ; LoopVar ++\r
     ){\r
    PerformSingleMappingDisplay(\r
      Verbose,\r
      Consist,\r
      Normal,\r
      Test,\r
      SFO,\r
      Specific,\r
      HandleBuffer[LoopVar]);\r
  }\r
\r
  //\r
  // Look up all BlockIo in the platform\r
  //\r
  Status = gBS->LocateHandle(\r
    ByProtocol,\r
    &gEfiBlockIoProtocolGuid,\r
    NULL,\r
    &BufferSize,\r
    HandleBuffer);\r
  if (Status == EFI_BUFFER_TOO_SMALL) {\r
    FreePool(HandleBuffer);\r
    HandleBuffer = AllocatePool(BufferSize);\r
    if (HandleBuffer == NULL) {\r
      return (SHELL_OUT_OF_RESOURCES);\r
    }\r
    Status = gBS->LocateHandle(\r
      ByProtocol,\r
      &gEfiBlockIoProtocolGuid,\r
      NULL,\r
      &BufferSize,\r
      HandleBuffer);\r
  }\r
  if (!EFI_ERROR(Status)) {\r
    //\r
    // Get the map name(s) for each one.\r
    //\r
    for ( LoopVar = 0\r
        ; LoopVar < BufferSize / sizeof(EFI_HANDLE)\r
        ; LoopVar ++\r
       ){\r
      //\r
      // Skip any that were already done...\r
      //\r
      if (gBS->OpenProtocol(\r
        HandleBuffer[LoopVar],\r
        &gEfiDevicePathProtocolGuid,\r
        NULL,\r
        gImageHandle,\r
        NULL,\r
        EFI_OPEN_PROTOCOL_TEST_PROTOCOL) == EFI_SUCCESS) {\r
          continue;\r
      }\r
      PerformSingleMappingDisplay(\r
        Verbose,\r
        Consist,\r
        Normal,\r
        Test,\r
        SFO,\r
        Specific,\r
        HandleBuffer[LoopVar]);\r
    }\r
    FreePool(HandleBuffer);\r
  }\r
  return (SHELL_SUCCESS);\r
}\r
\r
SHELL_STATUS\r
EFIAPI\r
PerformMappingDisplay2(\r
  IN CONST BOOLEAN Verbose,\r
  IN CONST BOOLEAN Consist,\r
  IN CONST BOOLEAN Normal,\r
  IN CONST CHAR16  *TypeString,\r
  IN CONST BOOLEAN SFO,\r
  IN CONST CHAR16  *Specific OPTIONAL\r
  )\r
{\r
  CONST CHAR16  *TypeWalker;\r
  SHELL_STATUS  ShellStatus;\r
  CHAR16        *Comma;\r
\r
\r
  if (TypeString == NULL) {\r
    return (PerformMappingDisplay(Verbose, Consist, Normal, NULL, SFO, Specific, TRUE));\r
  }\r
  ShellStatus = SHELL_SUCCESS;\r
  for (TypeWalker = TypeString ; TypeWalker != NULL && *TypeWalker != CHAR_NULL ;) {\r
    Comma = StrStr(TypeWalker, L",");\r
    if (Comma == NULL) {\r
      if (ShellStatus == SHELL_SUCCESS) {\r
        ShellStatus = PerformMappingDisplay(Verbose, Consist, Normal, TypeWalker, SFO, Specific, (BOOLEAN)(TypeWalker == TypeString));\r
      } else {\r
        PerformMappingDisplay(Verbose, Consist, Normal, TypeWalker, SFO, Specific, (BOOLEAN)(TypeWalker == TypeString));\r
      }\r
      break;\r
    } else {\r
      *Comma = CHAR_NULL;\r
      if (ShellStatus == SHELL_SUCCESS) {\r
        ShellStatus = PerformMappingDisplay(Verbose, Consist, Normal, TypeWalker, SFO, Specific, (BOOLEAN)(TypeWalker == TypeString));\r
      } else {\r
        PerformMappingDisplay(Verbose, Consist, Normal, TypeWalker, SFO, Specific, (BOOLEAN)(TypeWalker == TypeString));\r
      }\r
      *Comma = L',';\r
      TypeWalker = Comma + 1;\r
    }\r
  }\r
\r
  return (ShellStatus);\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
PerformMappingDelete(\r
  IN CONST CHAR16  *Specific\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_HANDLE                *HandleBuffer;\r
  UINTN                     BufferSize;\r
  UINTN                     LoopVar;\r
  BOOLEAN                   Deleted;\r
\r
  if (Specific == NULL) {\r
    return (EFI_INVALID_PARAMETER);\r
  }\r
\r
  BufferSize    = 0;\r
  HandleBuffer  = NULL;\r
  Deleted       = FALSE;\r
\r
  //\r
  // Look up all SimpleFileSystems in the platform\r
  //\r
  Status = gBS->LocateHandle(\r
    ByProtocol,\r
    &gEfiDevicePathProtocolGuid,\r
    NULL,\r
    &BufferSize,\r
    HandleBuffer);\r
  if (Status == EFI_BUFFER_TOO_SMALL) {\r
    HandleBuffer = AllocatePool(BufferSize);\r
    if (HandleBuffer == NULL) {\r
      return (EFI_OUT_OF_RESOURCES);\r
    }\r
    Status = gBS->LocateHandle(\r
      ByProtocol,\r
      &gEfiDevicePathProtocolGuid,\r
      NULL,\r
      &BufferSize,\r
      HandleBuffer);\r
  }\r
  if (EFI_ERROR(Status)) {\r
    SHELL_FREE_NON_NULL(HandleBuffer);\r
    return (Status);\r
  }\r
\r
  //\r
  // Get the map name(s) for each one.\r
  //\r
  for ( LoopVar = 0\r
      ; LoopVar < BufferSize / sizeof(EFI_HANDLE)\r
      ; LoopVar ++\r
     ){\r
    if (PerformSingleMappingDelete(Specific,HandleBuffer[LoopVar]) == SHELL_SUCCESS) {\r
        Deleted = TRUE;\r
    }\r
  }\r
\r
  //\r
  // Look up all BlockIo in the platform\r
  //\r
  Status = gBS->LocateHandle(\r
    ByProtocol,\r
    &gEfiBlockIoProtocolGuid,\r
    NULL,\r
    &BufferSize,\r
    HandleBuffer);\r
  if (Status == EFI_BUFFER_TOO_SMALL) {\r
    FreePool(HandleBuffer);\r
    HandleBuffer = AllocatePool(BufferSize);\r
    if (HandleBuffer == NULL) {\r
      return (EFI_OUT_OF_RESOURCES);\r
    }\r
    Status = gBS->LocateHandle(\r
      ByProtocol,\r
      &gEfiBlockIoProtocolGuid,\r
      NULL,\r
      &BufferSize,\r
      HandleBuffer);\r
  }\r
  if (EFI_ERROR(Status)) {\r
    SHELL_FREE_NON_NULL(HandleBuffer);\r
    return (Status);\r
  }\r
\r
  //\r
  // Get the map name(s) for each one.\r
  //\r
  for ( LoopVar = 0\r
      ; LoopVar < BufferSize / sizeof(EFI_HANDLE)\r
      ; LoopVar ++\r
     ){\r
    //\r
    // Skip any that were already done...\r
    //\r
    if (gBS->OpenProtocol(\r
      HandleBuffer[LoopVar],\r
      &gEfiDevicePathProtocolGuid,\r
      NULL,\r
      gImageHandle,\r
      NULL,\r
      EFI_OPEN_PROTOCOL_TEST_PROTOCOL) == EFI_SUCCESS) {\r
        continue;\r
    }\r
    if (PerformSingleMappingDelete(Specific,HandleBuffer[LoopVar]) == SHELL_SUCCESS) {\r
        Deleted = TRUE;\r
    }\r
  }\r
  FreePool(HandleBuffer);\r
  if (!Deleted) {\r
    return (EFI_NOT_FOUND);\r
  }\r
  return (EFI_SUCCESS);\r
}\r
\r
/**\r
  function to add a mapping from mapping.\r
\r
  This function will get the device path associated with the mapping and call SetMap.\r
\r
  @param[in] Map         The Map to add a mapping for\r
  @param[in] SName       The name of the new mapping\r
\r
  @retval SHELL_SUCCESS             the mapping was added\r
  @retval SHELL_INVALID_PARAMETER   the device path for Map could not be retrieved.\r
  @return                           Shell version of a return value from EfiShellProtocol->SetMap\r
\r
**/\r
SHELL_STATUS\r
EFIAPI\r
AddMappingFromMapping(\r
  IN CONST CHAR16     *Map,\r
  IN CONST CHAR16     *SName\r
  )\r
{\r
  CONST EFI_DEVICE_PATH_PROTOCOL  *DevPath;\r
  EFI_STATUS                      Status;\r
\r
  if (StrStr(SName, L"*") != NULL\r
    ||StrStr(SName, L"?") != NULL\r
    ||StrStr(SName, L"[") != NULL\r
    ||StrStr(SName, L"]") != NULL) {\r
    return (SHELL_INVALID_PARAMETER);\r
  }\r
\r
  DevPath = gEfiShellProtocol->GetDevicePathFromMap(Map);\r
  if (DevPath == NULL) {\r
    return (SHELL_INVALID_PARAMETER);\r
  }\r
\r
  Status = gEfiShellProtocol->SetMap(DevPath, SName);\r
  if (EFI_ERROR(Status)) {\r
    return (SHELL_DEVICE_ERROR);\r
  }\r
  return (SHELL_SUCCESS);\r
}\r
\r
/**\r
  function to determine if a string has only numbers and letters\r
\r
  This is useful for such things as Map names which can only be letters and numbers\r
\r
  @param[in] String       pointer to the string to analyze\r
\r
  @retval TRUE            String has only numbers and letters\r
  @retval FALSE           String has at least one other character.\r
**/\r
BOOLEAN\r
EFIAPI\r
IsNumberLetterOnly(\r
  IN CONST CHAR16 *String\r
  )\r
{\r
  while(String != NULL && *String != CHAR_NULL) {\r
    if (! ((*String >= L'a' && *String <= L'z') ||\r
           (*String >= L'A' && *String <= L'Z') ||\r
           (*String >= L'0' && *String <= L'9'))\r
        ){\r
      return (FALSE);\r
    }\r
    String++;\r
  }\r
  return (TRUE);\r
}\r
\r
/**\r
  function to add a mapping from an EFI_HANDLE.\r
\r
  This function will get the device path associated with the Handle and call SetMap.\r
\r
  @param[in] Handle       The handle to add a mapping for\r
  @param[in] SName        The name of the new mapping\r
\r
  @retval SHELL_SUCCESS           the mapping was added\r
  @retval SHELL_INVALID_PARAMETER SName was not valid for a map name.\r
  @return                         Shell version of a return value from either\r
                                  gBS->OpenProtocol or EfiShellProtocol->SetMap\r
\r
**/\r
SHELL_STATUS\r
EFIAPI\r
AddMappingFromHandle(\r
  IN CONST EFI_HANDLE Handle,\r
  IN CONST CHAR16     *SName\r
  )\r
{\r
  EFI_DEVICE_PATH_PROTOCOL  *DevPath;\r
  EFI_STATUS                Status;\r
\r
  if (!IsNumberLetterOnly(SName)) {\r
    return (SHELL_INVALID_PARAMETER);\r
  }\r
\r
  Status = gBS->OpenProtocol(\r
    Handle,\r
    &gEfiDevicePathProtocolGuid,\r
    (VOID**)&DevPath,\r
    gImageHandle,\r
    NULL,\r
    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
   );\r
  if (EFI_ERROR(Status)) {\r
    return (SHELL_DEVICE_ERROR);\r
  }\r
  Status = gEfiShellProtocol->SetMap(DevPath, SName);\r
  if (EFI_ERROR(Status)) {\r
    return (SHELL_DEVICE_ERROR);\r
  }\r
  return (SHELL_SUCCESS);\r
}\r
\r
STATIC CONST SHELL_PARAM_ITEM MapParamList[] = {\r
  {L"-d", TypeValue},\r
  {L"-r", TypeFlag},\r
  {L"-v", TypeFlag},\r
  {L"-c", TypeFlag},\r
  {L"-f", TypeFlag},\r
  {L"-u", TypeFlag},\r
  {L"-t", TypeValue},\r
  {L"-sfo", TypeValue},\r
  {NULL, TypeMax}\r
  };\r
\r
/**\r
  Function for 'map' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunMap (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS    Status;\r
  LIST_ENTRY    *Package;\r
  CHAR16        *ProblemParam;\r
  CONST CHAR16  *SName;\r
  CONST CHAR16  *Mapping;\r
  EFI_HANDLE    MappingAsHandle;\r
  CONST EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
  SHELL_STATUS  ShellStatus;\r
  BOOLEAN       SfoMode;\r
  BOOLEAN       ConstMode;\r
  BOOLEAN       NormlMode;\r
  CONST CHAR16  *Param1;\r
  CONST CHAR16  *TypeString;\r
\r
  ProblemParam  = NULL;\r
  Mapping       = NULL;\r
  SName         = NULL;\r
  DevPath       = NULL;\r
  ShellStatus   = SHELL_SUCCESS;\r
  MappingAsHandle = NULL;\r
\r
  //\r
  // initialize the shell lib (we must be in non-auto-init...)\r
  //\r
  Status = ShellInitialize();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  Status = CommandInit();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  //\r
  // parse the command line\r
  //\r
  Status = ShellCommandLineParse (MapParamList, &Package, &ProblemParam, TRUE);\r
  if (EFI_ERROR(Status)) {\r
    if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, ProblemParam);\r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
    //\r
    // check for "-?"\r
    //\r
    SfoMode   = ShellCommandLineGetFlag(Package, L"-sfo");\r
    ConstMode = ShellCommandLineGetFlag(Package, L"-c");\r
    NormlMode = ShellCommandLineGetFlag(Package, L"-f");\r
    if (ShellCommandLineGetFlag(Package, L"-?")) {\r
      ASSERT(FALSE);\r
    } else if (ShellCommandLineGetRawValue(Package, 3) != NULL) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellLevel2HiiHandle);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      //\r
      // Deleting a map name...\r
      //\r
      if (ShellCommandLineGetFlag(Package, L"-d")) {\r
        if ( ShellCommandLineGetFlag(Package, L"-r")\r
          || ShellCommandLineGetFlag(Package, L"-v")\r
          || ConstMode\r
          || NormlMode\r
          || ShellCommandLineGetFlag(Package, L"-u")\r
          || ShellCommandLineGetFlag(Package, L"-t")\r
         ){\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_CON), gShellLevel2HiiHandle);\r
          ShellStatus = SHELL_INVALID_PARAMETER;\r
        } else {\r
          SName = ShellCommandLineGetValue(Package, L"-d");\r
          if (SName != NULL) {\r
            Status = PerformMappingDelete(SName);\r
            if (EFI_ERROR(Status)) {\r
              switch (Status) {\r
                case EFI_ACCESS_DENIED:\r
                  ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_AD), gShellLevel2HiiHandle);\r
                  ShellStatus = SHELL_ACCESS_DENIED;\r
                  break;\r
                case EFI_NOT_FOUND:\r
                  ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_MAP_NF), gShellLevel2HiiHandle, SName);\r
                  ShellStatus = SHELL_INVALID_PARAMETER;\r
                  break;\r
                default:\r
                  ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_UK), gShellLevel2HiiHandle, Status);\r
                  ShellStatus = SHELL_UNSUPPORTED;\r
              }\r
            }\r
          } else {\r
            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellLevel2HiiHandle);\r
            ShellStatus = SHELL_INVALID_PARAMETER;\r
          }\r
        }\r
      } else if ( ShellCommandLineGetFlag(Package, L"-r")\r
//               || ShellCommandLineGetFlag(Package, L"-v")\r
               || ConstMode\r
               || NormlMode\r
               || ShellCommandLineGetFlag(Package, L"-u")\r
               || ShellCommandLineGetFlag(Package, L"-t")\r
              ){\r
        if ( ShellCommandLineGetFlag(Package, L"-r")) {\r
          //\r
          // Do the reset\r
          //\r
          Status = ShellCommandCreateInitialMappingsAndPaths();\r
          if (EFI_ERROR(Status)) {\r
            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_UK), gShellLevel2HiiHandle, Status);\r
            ShellStatus = SHELL_UNSUPPORTED;\r
          }\r
        }\r
        if ( ShellStatus == SHELL_SUCCESS && ShellCommandLineGetFlag(Package, L"-u")) {\r
          //\r
          // Do the Update\r
          //\r
          Status = UpdateMapping();\r
          if (EFI_ERROR(Status)) {\r
            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_UK), gShellLevel2HiiHandle, Status);\r
            ShellStatus = SHELL_UNSUPPORTED;\r
          }\r
        }\r
        if (ShellStatus == SHELL_SUCCESS) {\r
          Param1 = ShellCommandLineGetRawValue(Package, 1);\r
          TypeString = ShellCommandLineGetValue(Package, L"-t");\r
          if (!ConstMode\r
            &&!NormlMode\r
            &&TypeString  == NULL\r
            ) {\r
            //\r
            // now do the display...\r
            //\r
            ShellStatus = PerformMappingDisplay(\r
              ShellCommandLineGetFlag(Package, L"-v"),\r
              TRUE,\r
              TRUE,\r
              NULL,\r
              SfoMode,\r
              Param1,\r
              TRUE\r
             );\r
          } else {\r
            //\r
            // now do the display...\r
            //\r
            ShellStatus = PerformMappingDisplay2(\r
              ShellCommandLineGetFlag(Package, L"-v"),\r
              ConstMode,\r
              NormlMode,\r
              TypeString,\r
              SfoMode,\r
              Param1\r
             );\r
          }\r
        }\r
      } else {\r
        //\r
        // adding or displaying (there were no flags)\r
        //\r
        SName = ShellCommandLineGetRawValue(Package, 1);\r
        Mapping = ShellCommandLineGetRawValue(Package, 2);\r
        if ( SName == NULL\r
          && Mapping == NULL\r
         ){\r
          //\r
          // display only since no flags\r
          //\r
          ShellStatus = PerformMappingDisplay(\r
            ShellCommandLineGetFlag(Package, L"-v"),\r
            TRUE,\r
            TRUE,\r
            NULL,\r
            SfoMode,\r
            NULL,\r
            TRUE\r
           );\r
        } else if ( SName == NULL\r
          || Mapping == NULL\r
         ){\r
            //\r
            // Display only the one specified\r
            //\r
          ShellStatus = PerformMappingDisplay(\r
            FALSE,\r
            FALSE,\r
            FALSE,\r
            NULL,\r
            SfoMode,\r
            SName, // note the variable here...\r
            TRUE\r
           );\r
        } else {\r
          if (ShellIsHexOrDecimalNumber(Mapping, TRUE, FALSE)) {\r
            MappingAsHandle = ConvertHandleIndexToHandle(StrHexToUintn(Mapping));\r
          } else {\r
            MappingAsHandle = NULL;\r
          }\r
          if (MappingAsHandle == NULL && Mapping[StrLen(Mapping)-1] != L':') {\r
            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellLevel2HiiHandle, Mapping);\r
            ShellStatus = SHELL_INVALID_PARAMETER;\r
          } else {\r
            if (MappingAsHandle != NULL) {\r
              ShellStatus = AddMappingFromHandle(MappingAsHandle, SName);\r
            } else {\r
              ShellStatus = AddMappingFromMapping(Mapping, SName);\r
            }\r
            if (ShellStatus != SHELL_SUCCESS) {\r
              switch (ShellStatus) {\r
                case SHELL_ACCESS_DENIED:\r
                  ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_AD), gShellLevel2HiiHandle);\r
                  break;\r
                case SHELL_INVALID_PARAMETER:\r
                  ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellLevel2HiiHandle);\r
                  break;\r
                default:\r
                  ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_ERR_UK), gShellLevel2HiiHandle, ShellStatus|MAX_BIT);\r
              }\r
            } else {\r
              //\r
              // now do the display...\r
              //\r
              ShellStatus = PerformMappingDisplay(\r
                FALSE,\r
                FALSE,\r
                FALSE,\r
                NULL,\r
                SfoMode,\r
                SName,\r
                TRUE\r
               );\r
            } // we were sucessful so do an output\r
          } // got a valid map target\r
        } // got 2 variables\r
      } // we are adding a mapping\r
    } // got valid parameters\r
  }\r
\r
  //\r
  // free the command line package\r
  //\r
  ShellCommandLineFreeVarList (Package);\r
\r
  return (ShellStatus);\r
}\r
\r