ArmPlatformPkg/BootMonFs: Added support for new revision of the NOR Flash file system

[mirror_edk2.git] / ArmPlatformPkg / Bds / BdsHelper.c

/** @file\r
*\r
*  Copyright (c) 2011-2013, ARM Limited. All rights reserved.\r
*  \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 "BdsInternal.h"\r
\r
EFI_STATUS\r
EditHIInputStr (\r
  IN OUT CHAR16  *CmdLine,\r
  IN     UINTN   MaxCmdLine\r
  )\r
{\r
  UINTN           CmdLineIndex;\r
  UINTN           WaitIndex;\r
  CHAR8           Char;\r
  EFI_INPUT_KEY   Key;\r
  EFI_STATUS      Status;\r
\r
  // The command line must be at least one character long\r
  ASSERT (MaxCmdLine > 0);\r
\r
  // Ensure the last character of the buffer is the NULL character\r
  CmdLine[MaxCmdLine - 1] = '\0';\r
\r
  Print (CmdLine);\r
\r
  // To prevent a buffer overflow, we only allow to enter (MaxCmdLine-1) characters\r
  for (CmdLineIndex = StrLen (CmdLine); CmdLineIndex < MaxCmdLine - 1; ) {\r
    Status = gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &WaitIndex);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    // Unicode character is valid when Scancode is NUll\r
    if (Key.ScanCode == SCAN_NULL) {\r
      // Scan code is NUll, hence read Unicode character\r
      Char = (CHAR8)Key.UnicodeChar;\r
    } else {\r
      Char = CHAR_NULL;\r
    }\r
\r
    if ((Char == CHAR_LINEFEED) || (Char == CHAR_CARRIAGE_RETURN) || (Char == 0x7f)) {\r
      CmdLine[CmdLineIndex] = '\0';\r
      Print (L"\r\n");\r
\r
      return EFI_SUCCESS;\r
    } else if ((Key.UnicodeChar == L'\b') || (Key.ScanCode == SCAN_LEFT) || (Key.ScanCode == SCAN_DELETE)){\r
      if (CmdLineIndex != 0) {\r
        CmdLineIndex--;\r
        Print (L"\b \b");\r
      }\r
    } else if ((Key.ScanCode == SCAN_ESC) || (Char == 0x1B) || (Char == 0x0)) {\r
      return EFI_INVALID_PARAMETER;\r
    } else {\r
      CmdLine[CmdLineIndex++] = Key.UnicodeChar;\r
      Print (L"%c", Key.UnicodeChar);\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
GetHIInputStr (\r
  IN OUT CHAR16  *CmdLine,\r
  IN     UINTN   MaxCmdLine\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  // For a new input just passed an empty string\r
  CmdLine[0] = L'\0';\r
\r
  Status = EditHIInputStr (CmdLine, MaxCmdLine);\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EditHIInputAscii (\r
  IN OUT CHAR8   *CmdLine,\r
  IN     UINTN   MaxCmdLine\r
  )\r
{\r
  CHAR16*     Str;\r
  EFI_STATUS  Status;\r
\r
  Str = (CHAR16*)AllocatePool (MaxCmdLine * sizeof(CHAR16));\r
  AsciiStrToUnicodeStr (CmdLine, Str);\r
\r
  Status = EditHIInputStr (Str, MaxCmdLine);\r
  if (!EFI_ERROR(Status)) {\r
    UnicodeStrToAsciiStr (Str, CmdLine);\r
  }\r
  FreePool (Str);\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
GetHIInputAscii (\r
  IN OUT CHAR8   *CmdLine,\r
  IN     UINTN   MaxCmdLine\r
  )\r
{\r
  // For a new input just passed an empty string\r
  CmdLine[0] = '\0';\r
\r
  return EditHIInputAscii (CmdLine,MaxCmdLine);\r
}\r
\r
EFI_STATUS\r
GetHIInputInteger (\r
  OUT UINTN   *Integer\r
  )\r
{\r
  CHAR16      CmdLine[255];\r
  EFI_STATUS  Status;\r
\r
  CmdLine[0] = '\0';\r
  Status = EditHIInputStr (CmdLine, 255);\r
  if (!EFI_ERROR(Status)) {\r
    *Integer = StrDecimalToUintn (CmdLine);\r
  }\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
GetHIInputIP (\r
  OUT EFI_IP_ADDRESS   *Ip\r
  )\r
{\r
  CHAR16  CmdLine[255];\r
  CHAR16  *Str;\r
  EFI_STATUS  Status;\r
\r
  CmdLine[0] = '\0';\r
  Status = EditHIInputStr (CmdLine,255);\r
  if (!EFI_ERROR(Status)) {\r
    Str = CmdLine;\r
    Ip->v4.Addr[0] = (UINT8)StrDecimalToUintn (Str);\r
\r
    Str = StrStr (Str, L".");\r
    if (Str == NULL) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    Ip->v4.Addr[1] = (UINT8)StrDecimalToUintn (++Str);\r
\r
    Str = StrStr (Str, L".");\r
    if (Str == NULL) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    Ip->v4.Addr[2] = (UINT8)StrDecimalToUintn (++Str);\r
\r
    Str = StrStr (Str, L".");\r
    if (Str == NULL) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    Ip->v4.Addr[3] = (UINT8)StrDecimalToUintn (++Str);\r
  }\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
GetHIInputBoolean (\r
  OUT BOOLEAN *Value\r
  )\r
{\r
  CHAR16      CmdBoolean[2];\r
  EFI_STATUS  Status;\r
\r
  while(1) {\r
    Print (L"[y/n] ");\r
    // Set MaxCmdLine to 3 to give space for carriage return (when the user\r
    // hits enter) and terminal '\0'.\r
    Status = GetHIInputStr (CmdBoolean, 3);\r
    if (EFI_ERROR(Status)) {\r
      return Status;\r
    } else if ((CmdBoolean[0] == L'y') || (CmdBoolean[0] == L'Y')) {\r
      if (Value) *Value = TRUE;\r
      return EFI_SUCCESS;\r
    } else if ((CmdBoolean[0] == L'n') || (CmdBoolean[0] == L'N')) {\r
      if (Value) *Value = FALSE;\r
      return EFI_SUCCESS;\r
    }\r
  }\r
}\r
\r
BOOLEAN\r
HasFilePathEfiExtension (\r
  IN CHAR16* FilePath\r
  )\r
{\r
  return (StrCmp (FilePath + (StrSize (FilePath) / sizeof (CHAR16)) - 5, L".EFI") == 0) ||\r
         (StrCmp (FilePath + (StrSize (FilePath) / sizeof (CHAR16)) - 5, L".efi") == 0);\r
}\r
\r
// Return the last non end-type Device Path Node from a Device Path\r
EFI_DEVICE_PATH*\r
GetLastDevicePathNode (\r
  IN EFI_DEVICE_PATH*  DevicePath\r
  )\r
{\r
  EFI_DEVICE_PATH*     PrevDevicePathNode;\r
\r
  PrevDevicePathNode = DevicePath;\r
  while (!IsDevicePathEndType (DevicePath)) {\r
    PrevDevicePathNode = DevicePath;\r
    DevicePath = NextDevicePathNode (DevicePath);\r
  }\r
\r
  return PrevDevicePathNode;\r
}\r
\r
EFI_STATUS\r
GenerateDeviceDescriptionName (\r
  IN  EFI_HANDLE  Handle,\r
  IN OUT CHAR16*  Description\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EFI_COMPONENT_NAME_PROTOCOL*      ComponentName2Protocol;\r
  EFI_DEVICE_PATH_TO_TEXT_PROTOCOL* DevicePathToTextProtocol;\r
  EFI_DEVICE_PATH_PROTOCOL*         DevicePathProtocol;\r
  CHAR16*                           DriverName;\r
  CHAR16*                           DevicePathTxt;\r
  EFI_DEVICE_PATH*                  DevicePathNode;\r
\r
  ComponentName2Protocol = NULL;\r
  Status = gBS->HandleProtocol (Handle, &gEfiComponentName2ProtocolGuid, (VOID **)&ComponentName2Protocol);\r
  if (!EFI_ERROR(Status)) {\r
    //TODO: Fixme. we must find the best langague\r
    Status = ComponentName2Protocol->GetDriverName (ComponentName2Protocol,"en",&DriverName);\r
    if (!EFI_ERROR(Status)) {\r
      StrnCpy (Description, DriverName, BOOT_DEVICE_DESCRIPTION_MAX);\r
    }\r
  }\r
\r
  if (EFI_ERROR(Status)) {\r
    // Use the lastest non null entry of the Device path as a description\r
    Status = gBS->HandleProtocol (Handle, &gEfiDevicePathProtocolGuid, (VOID **)&DevicePathProtocol);\r
    if (EFI_ERROR(Status)) {\r
      return Status;\r
    }\r
\r
    // Convert the last non end-type Device Path Node in text for the description\r
    DevicePathNode = GetLastDevicePathNode (DevicePathProtocol);\r
    Status = gBS->LocateProtocol (&gEfiDevicePathToTextProtocolGuid, NULL, (VOID **)&DevicePathToTextProtocol);\r
    ASSERT_EFI_ERROR(Status);\r
    DevicePathTxt = DevicePathToTextProtocol->ConvertDevicePathToText (DevicePathNode, TRUE, TRUE);\r
    StrnCpy (Description, DevicePathTxt, BOOT_DEVICE_DESCRIPTION_MAX);\r
    FreePool (DevicePathTxt);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
BdsStartBootOption (\r
  IN CHAR16* BootOption\r
  )\r
{\r
  EFI_STATUS          Status;\r
  BDS_LOAD_OPTION     *BdsLoadOption;\r
\r
  Status = BootOptionFromLoadOptionVariable (BootOption, &BdsLoadOption);\r
  if (!EFI_ERROR(Status)) {\r
    Status = BootOptionStart (BdsLoadOption);\r
    FreePool (BdsLoadOption);\r
\r
    if (!EFI_ERROR(Status)) {\r
      Status = EFI_SUCCESS;\r
    } else {\r
      Status = EFI_NOT_STARTED;\r
    }\r
  } else {\r
    Status = EFI_NOT_FOUND;\r
  }\r
  return Status;\r
}\r
\r
UINTN\r
GetUnalignedDevicePathSize (\r
  IN EFI_DEVICE_PATH* DevicePath\r
  )\r
{\r
  UINTN Size;\r
  EFI_DEVICE_PATH* AlignedDevicePath;\r
\r
  if ((UINTN)DevicePath & 0x1) {\r
    AlignedDevicePath = DuplicateDevicePath (DevicePath);\r
    Size = GetDevicePathSize (AlignedDevicePath);\r
    FreePool (AlignedDevicePath);\r
  } else {\r
    Size = GetDevicePathSize (DevicePath);\r
  }\r
  return Size;\r
}\r
\r
EFI_DEVICE_PATH*\r
GetAlignedDevicePath (\r
  IN EFI_DEVICE_PATH* DevicePath\r
  )\r
{\r
  if ((UINTN)DevicePath & 0x1) {\r
    return DuplicateDevicePath (DevicePath);\r
  } else {\r
    return DevicePath;\r
  }\r
}\r
\r