InOsEmuPkg: Update code to support BerkeleyPacketFilter, and add a template for Linux...

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

/** @file\r
*\r
*  Copyright (c) 2011, 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
extern EFI_HANDLE mImageHandle;\r
extern BDS_LOAD_OPTION_SUPPORT *BdsLoadOptionSupportList;\r
\r
EFI_STATUS\r
BootMenuAddBootOption (\r
  IN LIST_ENTRY *BootOptionsList\r
  )\r
{\r
  EFI_STATUS    Status;\r
  LIST_ENTRY  SupportedDeviceList;\r
  UINTN       SupportedDeviceCount;\r
  BDS_SUPPORTED_DEVICE* SupportedBootDevice;\r
  LIST_ENTRY* Entry;\r
  UINTN       SupportedDeviceSelected;\r
  CHAR8       AsciiBootOption[BOOT_DEVICE_OPTION_MAX];\r
  CHAR8       AsciiBootDescription[BOOT_DEVICE_DESCRIPTION_MAX];\r
  CHAR16      *BootDescription;\r
  UINT32      Attributes;\r
  BDS_LOADER_TYPE   BootType;\r
  UINTN       Index;\r
  BDS_LOAD_OPTION *BdsLoadOption;\r
  EFI_DEVICE_PATH*  DevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL *DevicePathNode;\r
\r
  Attributes = 0;\r
\r
  //\r
  // List the Boot Devices supported\r
  //\r
\r
  // Start all the drivers first\r
  BdsConnectAllDrivers ();\r
\r
  // List the supported devices\r
  Status = BootDeviceListSupportedInit (&SupportedDeviceList);\r
  ASSERT_EFI_ERROR(Status);\r
\r
  SupportedDeviceCount = 0;\r
  for (Entry = GetFirstNode (&SupportedDeviceList);\r
       !IsNull (&SupportedDeviceList,Entry);\r
       Entry = GetNextNode (&SupportedDeviceList,Entry)\r
       )\r
  {\r
    SupportedBootDevice = SUPPORTED_BOOT_DEVICE_FROM_LINK(Entry);\r
    Print(L"[%d] %s\n",SupportedDeviceCount+1,SupportedBootDevice->Description);\r
\r
    DEBUG_CODE_BEGIN();\r
      CHAR16*                           DevicePathTxt;\r
      EFI_DEVICE_PATH_TO_TEXT_PROTOCOL* DevicePathToTextProtocol;\r
\r
      Status = gBS->LocateProtocol(&gEfiDevicePathToTextProtocolGuid, NULL, (VOID **)&DevicePathToTextProtocol);\r
      ASSERT_EFI_ERROR(Status);\r
      DevicePathTxt = DevicePathToTextProtocol->ConvertDevicePathToText(SupportedBootDevice->DevicePathProtocol,TRUE,TRUE);\r
\r
      Print(L"\t- %s\n",DevicePathTxt);\r
\r
      FreePool(DevicePathTxt);\r
    DEBUG_CODE_END();\r
\r
    SupportedDeviceCount++;\r
  }\r
\r
  if (SupportedDeviceCount == 0) {\r
    Print(L"There is no supported device.\n");\r
    Status = EFI_ABORTED;\r
    goto EXIT;\r
  }\r
\r
  //\r
  // Select the Boot Device\r
  //\r
  SupportedDeviceSelected = 0;\r
  while (SupportedDeviceSelected == 0) {\r
    Print(L"Select the Boot Device: ");\r
    Status = GetHIInputInteger (&SupportedDeviceSelected);\r
    if (EFI_ERROR(Status)) {\r
      Status = EFI_ABORTED;\r
      goto EXIT;\r
    } else if ((SupportedDeviceSelected == 0) || (SupportedDeviceSelected > SupportedDeviceCount)) {\r
      Print(L"Invalid input (max %d)\n",SupportedDeviceSelected);\r
      SupportedDeviceSelected = 0;\r
    }\r
  }\r
\r
  //\r
  // Get the Device Path for the selected boot device\r
  //\r
  Index = 1;\r
  for (Entry = GetFirstNode (&SupportedDeviceList);\r
       !IsNull (&SupportedDeviceList,Entry);\r
       Entry = GetNextNode (&SupportedDeviceList,Entry)\r
       )\r
  {\r
    if (Index == SupportedDeviceSelected) {\r
      SupportedBootDevice = SUPPORTED_BOOT_DEVICE_FROM_LINK(Entry);\r
      break;\r
    }\r
    Index++;\r
  }\r
\r
  // Create the specific device path node\r
  Status = SupportedBootDevice->Support->CreateDevicePathNode (SupportedBootDevice, &DevicePathNode, &BootType, &Attributes);\r
  if (EFI_ERROR(Status)) {\r
    Status = EFI_ABORTED;\r
    goto EXIT;\r
  }\r
  // Append the Device Path node to the select device path\r
  DevicePath = AppendDevicePathNode (SupportedBootDevice->DevicePathProtocol, (CONST EFI_DEVICE_PATH_PROTOCOL *)DevicePathNode);\r
\r
  Print(L"Arguments to pass to the binary: ");\r
  Status = GetHIInputAscii (AsciiBootOption,BOOT_DEVICE_OPTION_MAX);\r
  if (EFI_ERROR(Status)) {\r
    Status = EFI_ABORTED;\r
    goto FREE_DEVICE_PATH;\r
  }\r
\r
  Print(L"Description for this new Entry: ");\r
  Status = GetHIInputAscii (AsciiBootDescription,BOOT_DEVICE_DESCRIPTION_MAX);\r
  if (EFI_ERROR(Status)) {\r
    Status = EFI_ABORTED;\r
    goto FREE_DEVICE_PATH;\r
  }\r
\r
  // Convert Ascii into Unicode\r
  BootDescription = (CHAR16*)AllocatePool(AsciiStrSize(AsciiBootDescription) * sizeof(CHAR16));\r
  AsciiStrToUnicodeStr (AsciiBootDescription, BootDescription);\r
\r
  // Create new entry\r
  Status = BootOptionCreate (Attributes, BootDescription, DevicePath, BootType, AsciiBootOption, &BdsLoadOption);\r
  if (!EFI_ERROR(Status)) {\r
    InsertTailList (BootOptionsList,&BdsLoadOption->Link);\r
  }\r
\r
  FreePool (BootDescription);\r
\r
FREE_DEVICE_PATH:\r
  FreePool (DevicePath);\r
\r
EXIT:\r
  BootDeviceListSupportedFree (&SupportedDeviceList);\r
  return Status;\r
}\r
\r
STATIC\r
EFI_STATUS\r
BootMenuSelectBootOption (\r
  IN  LIST_ENTRY *BootOptionsList,\r
  IN  CONST CHAR16* InputStatement,\r
  OUT BDS_LOAD_OPTION **BdsLoadOption\r
  )\r
{\r
  EFI_STATUS    Status;\r
  LIST_ENTRY*   Entry;\r
  BDS_LOAD_OPTION *BootOption;\r
  UINTN         BootOptionSelected;\r
  UINTN         BootOptionCount;\r
  UINTN         Index;\r
\r
  // Display the list of supported boot devices\r
  BootOptionCount = 1;\r
  for (Entry = GetFirstNode (BootOptionsList);\r
       !IsNull (BootOptionsList,Entry);\r
       Entry = GetNextNode (BootOptionsList,Entry)\r
       )\r
  {\r
    BootOption = LOAD_OPTION_FROM_LINK(Entry);\r
    Print(L"[%d] %s\n",BootOptionCount,BootOption->Description);\r
\r
    DEBUG_CODE_BEGIN();\r
      CHAR16*                           DevicePathTxt;\r
      EFI_DEVICE_PATH_TO_TEXT_PROTOCOL* DevicePathToTextProtocol;\r
\r
      Status = gBS->LocateProtocol(&gEfiDevicePathToTextProtocolGuid, NULL, (VOID **)&DevicePathToTextProtocol);\r
      ASSERT_EFI_ERROR(Status);\r
      DevicePathTxt = DevicePathToTextProtocol->ConvertDevicePathToText(BootOption->FilePathList,TRUE,TRUE);\r
\r
      Print(L"\t- %s\n",DevicePathTxt);\r
      if ((BootOption->OptionalData != NULL) && (BootOption->OptionalData->Arguments != NULL)) {\r
        Print(L"\t- Arguments: %a\n",BootOption->OptionalData->Arguments);\r
      }\r
\r
      FreePool(DevicePathTxt);\r
    DEBUG_CODE_END();\r
\r
    BootOptionCount++;\r
  }\r
\r
  // Get the index of the boot device to delete\r
  BootOptionSelected = 0;\r
  while (BootOptionSelected == 0) {\r
    Print(InputStatement);\r
    Status = GetHIInputInteger (&BootOptionSelected);\r
    if (EFI_ERROR(Status)) {\r
      return Status;\r
    } else if ((BootOptionSelected == 0) || (BootOptionSelected >= BootOptionCount)) {\r
      Print(L"Invalid input (max %d)\n",BootOptionCount);\r
      BootOptionSelected = 0;\r
    }\r
  }\r
\r
  // Get the structure of the Boot device to delete\r
  Index = 1;\r
  for (Entry = GetFirstNode (BootOptionsList);\r
       !IsNull (BootOptionsList,Entry);\r
       Entry = GetNextNode (BootOptionsList,Entry)\r
       )\r
  {\r
    if (Index == BootOptionSelected) {\r
      *BdsLoadOption = LOAD_OPTION_FROM_LINK(Entry);\r
      break;\r
    }\r
    Index++;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
BootMenuRemoveBootOption (\r
  IN LIST_ENTRY *BootOptionsList\r
  )\r
{\r
  EFI_STATUS    Status;\r
  BDS_LOAD_OPTION *BootOption;\r
\r
  Status = BootMenuSelectBootOption (BootOptionsList,L"Delete entry: ",&BootOption);\r
  if (EFI_ERROR(Status)) {\r
    return Status;\r
  }\r
\r
  // Delete the BDS Load option structures\r
  BootOptionDelete (BootOption);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
BootMenuUpdateBootOption (\r
  IN LIST_ENTRY *BootOptionsList\r
  )\r
{\r
  EFI_STATUS    Status;\r
  BDS_LOAD_OPTION *BootOption;\r
  BDS_LOAD_OPTION_SUPPORT*  DeviceSupport;\r
  CHAR8       AsciiBootOption[BOOT_DEVICE_OPTION_MAX];\r
  CHAR8       AsciiBootDescription[BOOT_DEVICE_DESCRIPTION_MAX];\r
  CHAR16      *BootDescription;\r
  EFI_DEVICE_PATH* DevicePath;\r
  UINT32      Attributes;\r
  BDS_LOADER_TYPE   BootType;\r
\r
  Status = BootMenuSelectBootOption (BootOptionsList,L"Update entry: ",&BootOption);\r
  if (EFI_ERROR(Status)) {\r
    return Status;\r
  }\r
\r
  // Get the device support for this Boot Option\r
  Status = BootDeviceGetDeviceSupport (BootOption,&DeviceSupport);\r
  if (EFI_ERROR(Status)) {\r
    Print(L"Impossible to retrieve the supported device for the update\n");\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Status = DeviceSupport->UpdateDevicePathNode (BootOption,&DevicePath,&BootType,&Attributes);\r
  if (EFI_ERROR(Status)) {\r
    Status = EFI_ABORTED;\r
    goto EXIT;\r
  }\r
\r
  Print(L"Arguments to pass to the binary: ");\r
  if (BootOption->OptionalData) {\r
    AsciiStrnCpy(AsciiBootOption,BootOption->OptionalData->Arguments,BOOT_DEVICE_FILEPATH_MAX);\r
  } else {\r
    AsciiBootOption[0] = '\0';\r
  }\r
  Status = EditHIInputAscii (AsciiBootOption,BOOT_DEVICE_OPTION_MAX);\r
  if (EFI_ERROR(Status)) {\r
    Status = EFI_ABORTED;\r
    goto FREE_DEVICE_PATH;\r
  }\r
\r
  Print(L"Description for this new Entry: ");\r
  UnicodeStrToAsciiStr (BootOption->Description,AsciiBootDescription);\r
  Status = EditHIInputAscii (AsciiBootDescription,BOOT_DEVICE_DESCRIPTION_MAX);\r
  if (EFI_ERROR(Status)) {\r
    Status = EFI_ABORTED;\r
    goto FREE_DEVICE_PATH;\r
  }\r
\r
  // Convert Ascii into Unicode\r
  BootDescription = (CHAR16*)AllocatePool(AsciiStrSize(AsciiBootDescription) * sizeof(CHAR16));\r
  AsciiStrToUnicodeStr (AsciiBootDescription, BootDescription);\r
\r
  // Update the entry\r
  Status = BootOptionUpdate (BootOption, Attributes, BootDescription, DevicePath, BootType, AsciiBootOption);\r
\r
  FreePool (BootDescription);\r
\r
FREE_DEVICE_PATH:\r
  FreePool (DevicePath);\r
\r
EXIT:\r
  return Status;\r
}\r
\r
struct BOOT_MANAGER_ENTRY {\r
  CONST CHAR16* Description;\r
  EFI_STATUS (*Callback) (IN LIST_ENTRY *BootOptionsList);\r
} BootManagerEntries[] = {\r
    { L"Add Boot Device Entry", BootMenuAddBootOption },\r
    { L"Update Boot Device Entry", BootMenuUpdateBootOption },\r
    { L"Remove Boot Device Entry", BootMenuRemoveBootOption },\r
};\r
\r
EFI_STATUS\r
BootMenuManager (\r
  IN LIST_ENTRY *BootOptionsList\r
  )\r
{\r
  UINTN Index;\r
  UINTN OptionSelected;\r
  UINTN BootManagerEntryCount;\r
  EFI_STATUS Status;\r
\r
  BootManagerEntryCount = sizeof(BootManagerEntries) / sizeof(struct BOOT_MANAGER_ENTRY);\r
\r
  while (TRUE) {\r
    // Display Boot Manager menu\r
    for (Index = 0; Index < BootManagerEntryCount; Index++) {\r
      Print(L"[%d] %s\n",Index+1,BootManagerEntries[Index]);\r
    }\r
    Print(L"[%d] Return to main menu\n",Index+1);\r
\r
    // Select which entry to call\r
    Print(L"Choice: ");\r
    Status = GetHIInputInteger (&OptionSelected);\r
    if (EFI_ERROR(Status) || (OptionSelected == (BootManagerEntryCount+1))) {\r
      return EFI_SUCCESS;\r
    } else if ((OptionSelected > 0) && (OptionSelected <= BootManagerEntryCount))  {\r
      Status = BootManagerEntries[OptionSelected-1].Callback (BootOptionsList);\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
BootEBL (\r
  IN LIST_ENTRY *BootOptionsList\r
  )\r
{\r
  EFI_STATUS Status;\r
\r
  // Start EFI Shell\r
  Status = BdsLoadApplication(mImageHandle, L"Ebl");\r
  if (Status == EFI_NOT_FOUND) {\r
    Print (L"Error: EFI Application not found.\n");\r
  } else if (EFI_ERROR(Status)) {\r
    Print (L"Error: Status Code: 0x%X\n",(UINT32)Status);\r
  }\r
\r
  return Status;\r
}\r
\r
struct BOOT_MAIN_ENTRY {\r
  CONST CHAR16* Description;\r
  EFI_STATUS (*Callback) (IN LIST_ENTRY *BootOptionsList);\r
} BootMainEntries[] = {\r
    { L"EBL", BootEBL },\r
    { L"Boot Manager", BootMenuManager },\r
};\r
\r
\r
EFI_STATUS\r
BootMenuMain (\r
  VOID\r
  )\r
{\r
  LIST_ENTRY BootOptionsList;\r
  UINTN       OptionCount;\r
  UINTN       BootOptionCount;\r
  EFI_STATUS  Status;\r
  LIST_ENTRY  *Entry;\r
  BDS_LOAD_OPTION *BootOption;\r
  UINTN   BootOptionSelected;\r
  UINTN   Index;\r
  UINTN   BootMainEntryCount;\r
\r
  BootMainEntryCount = sizeof(BootMainEntries) / sizeof(struct BOOT_MAIN_ENTRY);\r

  // Get Boot#### list\r
  BootOptionList (&BootOptionsList);\r
\r
  while (TRUE) {\r
    OptionCount = 1;\r
\r
    // Display the Boot options\r
    for (Entry = GetFirstNode (&BootOptionsList);\r
         !IsNull (&BootOptionsList,Entry);\r
         Entry = GetNextNode (&BootOptionsList,Entry)\r
         )\r
    {\r
      BootOption = LOAD_OPTION_FROM_LINK(Entry);\r
\r
      Print(L"[%d] %s\n",OptionCount,BootOption->Description);\r
\r
      DEBUG_CODE_BEGIN();\r
        CHAR16*                           DevicePathTxt;\r
        EFI_DEVICE_PATH_TO_TEXT_PROTOCOL* DevicePathToTextProtocol;\r
\r
        Status = gBS->LocateProtocol(&gEfiDevicePathToTextProtocolGuid, NULL, (VOID **)&DevicePathToTextProtocol);\r
        ASSERT_EFI_ERROR(Status);\r
        DevicePathTxt = DevicePathToTextProtocol->ConvertDevicePathToText(BootOption->FilePathList,TRUE,TRUE);\r
\r
        Print(L"\t- %s\n",DevicePathTxt);\r
        if (BootOption->OptionalData != NULL) {\r
          Print(L"\t- LoaderType: %d\n",BootOption->OptionalData->LoaderType);\r
          if (BootOption->OptionalData->Arguments != NULL) {\r
            Print(L"\t- Arguments: %a\n",BootOption->OptionalData->Arguments);\r
          }\r
        }\r
\r
        FreePool(DevicePathTxt);\r
      DEBUG_CODE_END();\r
\r
      OptionCount++;\r
    }\r
    BootOptionCount = OptionCount-1;\r
\r
    // Display the hardcoded Boot entries\r
    for (Index = 0; Index < BootMainEntryCount; Index++) {\r
      Print(L"[%d] %s\n",OptionCount,BootMainEntries[Index]);\r
      OptionCount++;\r
    }\r
\r
    // Request the boot entry from the user\r
    BootOptionSelected = 0;\r
    while (BootOptionSelected == 0) {\r
      Print(L"Start: ");\r
      Status = GetHIInputInteger (&BootOptionSelected);\r
      if (EFI_ERROR(Status) || (BootOptionSelected == 0) || (BootOptionSelected > OptionCount)) {\r
        Print(L"Invalid input (max %d)\n",(OptionCount-1));\r
        BootOptionSelected = 0;\r
      }\r
    }\r
\r
    // Start the selected entry\r
    if (BootOptionSelected > BootOptionCount) {\r
      // Start the hardcoded entry\r
      Status = BootMainEntries[BootOptionSelected - BootOptionCount - 1].Callback (&BootOptionsList);\r
    } else {\r
      // Find the selected entry from the Boot#### list\r
      Index = 1;\r
      for (Entry = GetFirstNode (&BootOptionsList);\r
           !IsNull (&BootOptionsList,Entry);\r
           Entry = GetNextNode (&BootOptionsList,Entry)\r
           )\r
      {\r
        if (Index == BootOptionSelected) {\r
          BootOption = LOAD_OPTION_FROM_LINK(Entry);\r
          break;\r
        }\r
        Index++;\r
      }\r
\r
      Status = BootOptionStart (BootOption);\r
    }\r
  }\r
\r
  return Status;\r
}\r