ArmPlatformPkg/Bds: Upgrade the BDS to be more conformed to the UEFI Specification

[mirror_edk2.git] / ArmPlatformPkg / Bds / BootOption.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
\r
EFI_STATUS\r
BootOptionStart (\r
  IN BDS_LOAD_OPTION *BootOption\r
  )\r
{\r
  EFI_STATUS Status;\r
  EFI_DEVICE_PATH* FdtDevicePath;\r
  EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL  *EfiDevicePathFromTextProtocol;\r
\r
  Status = EFI_UNSUPPORTED;\r
\r
  if (BootOption->OptionalData->LoaderType == BDS_LOADER_EFI_APPLICATION) {\r
    // Need to connect every drivers to ensure no dependencies are missing for the application\r
    BdsConnectAllDrivers();\r
\r
    Status = BdsStartEfiApplication (mImageHandle, BootOption->FilePathList);\r
  } else if (BootOption->OptionalData->LoaderType == BDS_LOADER_KERNEL_LINUX_ATAG) {\r
    Status = BdsBootLinux (BootOption->FilePathList, BootOption->OptionalData->Arguments, NULL);\r
  } else if (BootOption->OptionalData->LoaderType == BDS_LOADER_KERNEL_LINUX_FDT) {\r
    // Convert the FDT path into a Device Path\r
    Status = gBS->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid, NULL, (VOID **)&EfiDevicePathFromTextProtocol);\r
    ASSERT_EFI_ERROR(Status);\r
    FdtDevicePath = EfiDevicePathFromTextProtocol->ConvertTextToDevicePath ((CHAR16*)PcdGetPtr(PcdFdtDevicePath));\r
\r
    Status = BdsBootLinux (BootOption->FilePathList, BootOption->OptionalData->Arguments, FdtDevicePath);\r
    FreePool(FdtDevicePath);\r
  }\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
BootOptionParseLoadOption (\r
  IN  EFI_LOAD_OPTION EfiLoadOption,\r
  IN  UINTN           EfiLoadOptionSize,\r
  OUT BDS_LOAD_OPTION **BdsLoadOption\r
  )\r
{\r
  BDS_LOAD_OPTION *LoadOption;\r
  UINTN           FilePathListLength;\r
  UINTN           DescriptionLength;\r
\r
  if (EfiLoadOption == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (EfiLoadOptionSize < sizeof(UINT32) + sizeof(UINT16) + sizeof(CHAR16) + sizeof(EFI_DEVICE_PATH_PROTOCOL)) {\r
    return EFI_BAD_BUFFER_SIZE;\r
  }\r
\r
  LoadOption = (BDS_LOAD_OPTION*)AllocatePool(sizeof(BDS_LOAD_OPTION));\r
  if (LoadOption == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  LoadOption->LoadOption = EfiLoadOption;\r
  LoadOption->LoadOptionSize = EfiLoadOptionSize;\r
\r
  LoadOption->Attributes    = *(UINT32*)EfiLoadOption;\r
  FilePathListLength        = *(UINT16*)(EfiLoadOption + sizeof(UINT32));\r
  LoadOption->Description   = (CHAR16*)(EfiLoadOption + sizeof(UINT32) + sizeof(UINT16));\r
  DescriptionLength         = StrSize (LoadOption->Description);\r
  LoadOption->FilePathList  = (EFI_DEVICE_PATH_PROTOCOL*)(EfiLoadOption + sizeof(UINT32) + sizeof(UINT16) + DescriptionLength);\r
\r
  if ((UINTN)((UINT8*)LoadOption->FilePathList + FilePathListLength - EfiLoadOption) == EfiLoadOptionSize) {\r
    LoadOption->OptionalData = NULL;\r
  } else {\r
    LoadOption->OptionalData = (BDS_LOADER_OPTIONAL_DATA *)((UINT8*)LoadOption->FilePathList + FilePathListLength);\r
  }\r
\r
  *BdsLoadOption = LoadOption;\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
BootOptionFromLoadOptionVariable (\r
  IN  UINT16            LoadOptionIndex,\r
  OUT BDS_LOAD_OPTION **BdsLoadOption\r
  )\r
{\r
  EFI_STATUS  Status;\r
  CHAR16      BootVariableName[9];\r
  EFI_LOAD_OPTION     EfiLoadOption;\r
  UINTN               EfiLoadOptionSize;\r
\r
  UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", LoadOptionIndex);\r
\r
  Status = GetEnvironmentVariable (BootVariableName, NULL, &EfiLoadOptionSize, (VOID**)&EfiLoadOption);\r
  if (!EFI_ERROR(Status)) {\r
    Status = BootOptionParseLoadOption (EfiLoadOption,EfiLoadOptionSize,BdsLoadOption);\r
    if (!EFI_ERROR(Status)) {\r
      (*BdsLoadOption)->LoadOptionIndex = LoadOptionIndex;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
BootOptionList (\r
  IN OUT LIST_ENTRY *BootOptionList\r
  )\r
{\r
  EFI_STATUS        Status;\r
  UINTN             Index;\r
  UINT16            *BootOrder;\r
  UINTN             BootOrderSize;\r
  BDS_LOAD_OPTION   *BdsLoadOption;\r
\r
  InitializeListHead (BootOptionList);\r
\r
  // Get the Boot Option Order from the environment variable\r
  Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
  if (EFI_ERROR(Status)) {\r
    return Status;\r
  }\r
\r
  for (Index = 0; Index < BootOrderSize / sizeof (UINT16); Index++) {\r
    Status = BootOptionFromLoadOptionVariable (BootOrder[Index],&BdsLoadOption);\r
    if (!EFI_ERROR(Status)) {\r
      InsertTailList (BootOptionList,&BdsLoadOption->Link);\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
UINT16\r
BootOptionAllocateBootIndex (\r
  VOID\r
  )\r
{\r
  EFI_STATUS        Status;\r
  UINTN             Index;\r
  UINT32            BootIndex;\r
  UINT16            *BootOrder;\r
  UINTN             BootOrderSize;\r
  BOOLEAN           Found;\r
\r
  // Get the Boot Option Order from the environment variable\r
  Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
  if (!EFI_ERROR(Status)) {\r
    for (BootIndex = 0; BootIndex <= 0xFFFF; BootIndex++) {\r
      Found = FALSE;\r
      for (Index = 0; Index < BootOrderSize / sizeof (UINT16); Index++) {\r
        if (BootOrder[Index] == BootIndex) {\r
          Found = TRUE;\r
          break;\r
        }\r
      }\r
      if (!Found) {\r
        return BootIndex;\r
      }\r
    }\r
  }\r
  // Return the first index\r
  return 0;\r
}\r
\r
STATIC\r
EFI_STATUS\r
BootOptionSetFields (\r
  IN BDS_LOAD_OPTION *BootOption,\r
  IN UINT32 Attributes,\r
  IN CHAR16* BootDescription,\r
  IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
  IN  BDS_LOADER_TYPE   BootType,\r
  IN  CHAR8*            BootArguments\r
  )\r
{\r
  EFI_LOAD_OPTION EfiLoadOption;\r
  UINTN           EfiLoadOptionSize;\r
  UINTN           BootDescriptionSize;\r
  UINTN           BootOptionalDataSize;\r
  UINT16          FilePathListLength;\r
  EFI_DEVICE_PATH_PROTOCOL* DevicePathNode;\r
  UINTN           NodeLength;\r
  UINT8*          EfiLoadOptionPtr;\r
\r
  // If we are overwriting an existent Boot Option then we have to free previously allocated memory\r
  if (BootOption->LoadOption) {\r
    FreePool(BootOption->LoadOption);\r
  }\r
\r
  BootDescriptionSize = StrSize(BootDescription);\r
  BootOptionalDataSize = sizeof(BDS_LOADER_OPTIONAL_DATA) +\r
      (BootArguments == NULL ? 0 : AsciiStrSize(BootArguments));\r
\r
  // Compute the size of the FilePath list\r
  FilePathListLength = 0;\r
  DevicePathNode = DevicePath;\r
  while (!IsDevicePathEndType (DevicePathNode)) {\r
    FilePathListLength += DevicePathNodeLength (DevicePathNode);\r
    DevicePathNode = NextDevicePathNode (DevicePathNode);\r
  }\r
  // Add the length of the DevicePath EndType\r
  FilePathListLength += DevicePathNodeLength (DevicePathNode);\r
\r
  // Allocate the memory for the EFI Load Option\r
  EfiLoadOptionSize = sizeof(UINT32) + sizeof(UINT16) + BootDescriptionSize + FilePathListLength + BootOptionalDataSize;\r
  EfiLoadOption = (EFI_LOAD_OPTION)AllocatePool(EfiLoadOptionSize);\r
  EfiLoadOptionPtr = EfiLoadOption;\r
\r
  //\r
  // Populate the EFI Load Option and BDS Boot Option structures\r
  //\r
\r
  // Attributes fields\r
  BootOption->Attributes = Attributes;\r
  *(UINT32*)EfiLoadOptionPtr = Attributes;\r
  EfiLoadOptionPtr += sizeof(UINT32);\r
\r
  // FilePath List fields\r
  BootOption->FilePathListLength = FilePathListLength;\r
  *(UINT16*)EfiLoadOptionPtr = FilePathListLength;\r
  EfiLoadOptionPtr += sizeof(UINT16);\r
\r
  // Boot description fields\r
  BootOption->Description = (CHAR16*)EfiLoadOptionPtr;\r
  CopyMem (EfiLoadOptionPtr, BootDescription, BootDescriptionSize);\r
  EfiLoadOptionPtr += BootDescriptionSize;\r
\r
  // File path fields\r
  BootOption->FilePathList = (EFI_DEVICE_PATH_PROTOCOL*)EfiLoadOptionPtr;\r
  DevicePathNode = DevicePath;\r
  while (!IsDevicePathEndType (DevicePathNode)) {\r
    NodeLength = DevicePathNodeLength(DevicePathNode);\r
    CopyMem (EfiLoadOptionPtr, DevicePathNode, NodeLength);\r
    EfiLoadOptionPtr += NodeLength;\r
    DevicePathNode = NextDevicePathNode (DevicePathNode);\r
  }\r
\r
  // Set the End Device Path Type\r
  SetDevicePathEndNode (EfiLoadOptionPtr);\r
  EfiLoadOptionPtr = (UINT8 *)EfiLoadOptionPtr + sizeof(EFI_DEVICE_PATH);\r
\r
  // Optional Data fields, Do unaligned writes\r
  WriteUnaligned32 ((UINT32 *)EfiLoadOptionPtr, BootType);\r
\r
  CopyMem (&((BDS_LOADER_OPTIONAL_DATA*)EfiLoadOptionPtr)->Arguments, BootArguments, AsciiStrSize(BootArguments));\r
  BootOption->OptionalData = (BDS_LOADER_OPTIONAL_DATA *)EfiLoadOptionPtr;\r
\r
  // Fill the EFI Load option fields\r
  BootOption->LoadOptionIndex = BootOptionAllocateBootIndex();\r
  BootOption->LoadOption = EfiLoadOption;\r
  BootOption->LoadOptionSize = EfiLoadOptionSize;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
BootOptionCreate (\r
  IN  UINT32 Attributes,\r
  IN  CHAR16* BootDescription,\r
  IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
  IN  BDS_LOADER_TYPE   BootType,\r
  IN  CHAR8*            BootArguments,\r
  OUT BDS_LOAD_OPTION **BdsLoadOption\r
  )\r
{\r
  EFI_STATUS      Status;\r
  BDS_LOAD_OPTION *BootOption;\r
  CHAR16          BootVariableName[9];\r
  UINT16            *BootOrder;\r
  UINTN             BootOrderSize;\r
\r
  //\r
  // Allocate and fill the memory for the BDS Load Option structure\r
  //\r
  BootOption = (BDS_LOAD_OPTION*)AllocateZeroPool(sizeof(BDS_LOAD_OPTION));\r
\r
  InitializeListHead (&BootOption->Link);\r
  BootOptionSetFields (BootOption, Attributes, BootDescription, DevicePath, BootType, BootArguments);\r
\r
  //\r
  // Set the related environment variables\r
  //\r
\r
  // Create Boot#### environment variable\r
  UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BootOption->LoadOptionIndex);\r
  Status = gRT->SetVariable (\r
      BootVariableName,\r
      &gEfiGlobalVariableGuid,\r
      EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
      BootOption->LoadOptionSize,\r
      BootOption->LoadOption\r
      );\r
\r
  // Add the new Boot Index to the list\r
  Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
  if (!EFI_ERROR(Status)) {\r
    BootOrder = ReallocatePool (BootOrderSize, BootOrderSize + sizeof(UINT16), BootOrder);\r
    // Add the new index at the end\r
    BootOrder[BootOrderSize / sizeof(UINT16)] = BootOption->LoadOptionIndex;\r
    BootOrderSize += sizeof(UINT16);\r
  } else {\r
    // BootOrder does not exist. Create it\r
    BootOrderSize = sizeof(UINT16);\r
    BootOrder = &(BootOption->LoadOptionIndex);\r
  }\r
\r
  // Update (or Create) the BootOrder environment variable\r
  Status = gRT->SetVariable (\r
      L"BootOrder",\r
      &gEfiGlobalVariableGuid,\r
      EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
      BootOrderSize,\r
      BootOrder\r
      );\r
\r
  *BdsLoadOption = BootOption;\r
  return Status;\r
}\r
\r
EFI_STATUS\r
BootOptionUpdate (\r
  IN  BDS_LOAD_OPTION *BdsLoadOption,\r
  IN  UINT32 Attributes,\r
  IN  CHAR16* BootDescription,\r
  IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
  IN  BDS_LOADER_TYPE   BootType,\r
  IN  CHAR8*            BootArguments\r
  )\r
{\r
  EFI_STATUS      Status;\r
  BDS_LOAD_OPTION *BootOption;\r
  CHAR16          BootVariableName[9];\r
\r
  // Update the BDS Load Option structure\r
  BootOptionSetFields (BdsLoadOption, Attributes, BootDescription, DevicePath, BootType, BootArguments);\r
\r
  // Update the related environment variables\r
  UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BootOption->LoadOptionIndex);\r
  Status = gRT->SetVariable (\r
      BootVariableName,\r
      &gEfiGlobalVariableGuid,\r
      EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
      BootOption->LoadOptionSize,\r
      BootOption->LoadOption\r
      );\r
\r
  return Status;\r
}\r
\r
EFI_STATUS\r
BootOptionDelete (\r
  IN  BDS_LOAD_OPTION *BootOption\r
  )\r
{\r
  UINTN Index;\r
  UINTN BootOrderSize;\r
  UINT16* BootOrder;\r
  UINTN BootOrderCount;\r
  EFI_STATUS  Status;\r
\r
  // If the Boot Optiono was attached to a list remove it\r
  if (!IsListEmpty (&BootOption->Link)) {\r
    // Remove the entry from the list\r
    RemoveEntryList (&BootOption->Link);\r
  }\r
\r
  // Remove the entry from the BootOrder environment variable\r
  Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
  if (!EFI_ERROR(Status)) {\r
    BootOrderCount = BootOrderSize / sizeof(UINT16);\r
\r
    // Find the index of the removed entry\r
    for (Index = 0; Index < BootOrderCount; Index++) {\r
      if (BootOrder[Index] == BootOption->LoadOptionIndex) {\r
        // If it the last entry we do not need to rearrange the BootOrder list\r
        if (Index + 1 != BootOrderCount) {\r
          CopyMem (&BootOrder[Index],&BootOrder[Index+1], BootOrderCount - (Index + 1));\r
        }\r
        break;\r
      }\r
    }\r
\r
    // Update the BootOrder environment variable\r
    Status = gRT->SetVariable (\r
        L"BootOrder",\r
        &gEfiGlobalVariableGuid,\r
        EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
        BootOrderSize - sizeof(UINT16),\r
        BootOrder\r
        );\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r