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

/** @file\r
*\r
*  Copyright (c) 2011-2014, 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 <Guid/ArmGlobalVariableHob.h>\r
#include "BdsInternal.h"\r
\r
EFI_STATUS\r
BootOptionStart (\r
  IN BDS_LOAD_OPTION *BootOption\r
  )\r
{\r
  EFI_STATUS                            Status;\r
  EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL*   EfiDevicePathFromTextProtocol;\r
  UINT32                                LoaderType;\r
  ARM_BDS_LOADER_OPTIONAL_DATA*         OptionalData;\r
  ARM_BDS_LINUX_ARGUMENTS*              LinuxArguments;\r
  EFI_DEVICE_PATH_PROTOCOL*             FdtDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL*             DefaultFdtDevicePath;\r
  UINTN                                 FdtDevicePathSize;\r
  UINTN                                 CmdLineSize;\r
  UINTN                                 InitrdSize;\r
  EFI_DEVICE_PATH*                      Initrd;\r
  UINT16                                LoadOptionIndexSize;\r
\r
  if (IS_ARM_BDS_BOOTENTRY (BootOption)) {\r
    Status = EFI_UNSUPPORTED;\r
    OptionalData = BootOption->OptionalData;\r
    LoaderType = ReadUnaligned32 ((CONST UINT32*)&OptionalData->Header.LoaderType);\r
\r
    if (LoaderType == BDS_LOADER_EFI_APPLICATION) {\r
      if ((BootOption->Attributes & LOAD_OPTION_CATEGORY) == LOAD_OPTION_CATEGORY_APP) {\r
        // Need to connect every drivers to ensure no dependencies are missing for the application\r
        BdsConnectAllDrivers ();\r
      }\r
\r
      Status = BdsStartEfiApplication (gImageHandle, BootOption->FilePathList, 0, NULL);\r
    } else if (LoaderType == BDS_LOADER_KERNEL_LINUX_ATAG) {\r
      LinuxArguments = &(OptionalData->Arguments.LinuxArguments);\r
      CmdLineSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->CmdLineSize);\r
      InitrdSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->InitrdSize);\r
\r
      if (InitrdSize > 0) {\r
        Initrd = GetAlignedDevicePath ((EFI_DEVICE_PATH*)((UINTN)(LinuxArguments + 1) + CmdLineSize));\r
      } else {\r
        Initrd = NULL;\r
      }\r
\r
      Status = BdsBootLinuxAtag (BootOption->FilePathList,\r
                                 Initrd, // Initrd\r
                                 (CHAR8*)(LinuxArguments + 1)); // CmdLine\r
    } else if (LoaderType == BDS_LOADER_KERNEL_LINUX_FDT) {\r
      LinuxArguments = &(OptionalData->Arguments.LinuxArguments);\r
      CmdLineSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->CmdLineSize);\r
      InitrdSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->InitrdSize);\r
\r
      if (InitrdSize > 0) {\r
        Initrd = GetAlignedDevicePath ((EFI_DEVICE_PATH*)((UINTN)(LinuxArguments + 1) + CmdLineSize));\r
      } else {\r
        Initrd = NULL;\r
      }\r
\r
      // Get the default FDT device path\r
      Status = gBS->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid, NULL, (VOID **)&EfiDevicePathFromTextProtocol);\r
      ASSERT_EFI_ERROR(Status);\r
      DefaultFdtDevicePath = EfiDevicePathFromTextProtocol->ConvertTextToDevicePath ((CHAR16*)PcdGetPtr(PcdFdtDevicePath));\r
\r
      // Get the FDT device path\r
      FdtDevicePathSize = GetDevicePathSize (DefaultFdtDevicePath);\r
      Status = GetEnvironmentVariable ((CHAR16 *)L"Fdt", &gArmGlobalVariableGuid,\r
                 DefaultFdtDevicePath, &FdtDevicePathSize, (VOID **)&FdtDevicePath);\r
      ASSERT_EFI_ERROR(Status);\r
\r
      Status = BdsBootLinuxFdt (BootOption->FilePathList,\r
                                Initrd, // Initrd\r
                                (CHAR8*)(LinuxArguments + 1),\r
                                FdtDevicePath);\r
\r
      FreePool (DefaultFdtDevicePath);\r
      FreePool (FdtDevicePath);\r
    }\r
  } else {\r
    // Connect all the drivers if the EFI Application is not a EFI OS Loader\r
    if ((BootOption->Attributes & LOAD_OPTION_CATEGORY) == LOAD_OPTION_CATEGORY_APP) {\r
      BdsConnectAllDrivers ();\r
    }\r
\r
    // Set BootCurrent variable\r
    LoadOptionIndexSize = sizeof(UINT16);\r
    gRT->SetVariable (L"BootCurrent", &gEfiGlobalVariableGuid,\r
              EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
              LoadOptionIndexSize, &(BootOption->LoadOptionIndex));\r
\r
    Status = BdsStartEfiApplication (gImageHandle, BootOption->FilePathList, BootOption->OptionalDataSize, BootOption->OptionalData);\r
\r
    // Clear BootCurrent variable\r
    LoadOptionIndexSize = sizeof(UINT16);\r
    gRT->SetVariable (L"BootCurrent", &gEfiGlobalVariableGuid,\r
              EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
              0, NULL);\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
  BDS_LOAD_OPTION_ENTRY*        BdsLoadOptionEntry;\r
\r
  InitializeListHead (BootOptionList);\r
\r
  // Get the Boot Option Order from the environment variable\r
  Status = GetGlobalEnvironmentVariable (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 = BootOptionFromLoadOptionIndex (BootOrder[Index], &BdsLoadOption);\r
    if (!EFI_ERROR(Status)) {\r
      BdsLoadOptionEntry = (BDS_LOAD_OPTION_ENTRY*)AllocatePool(sizeof(BDS_LOAD_OPTION_ENTRY));\r
      BdsLoadOptionEntry->BdsLoadOption = BdsLoadOption;\r
      InsertTailList (BootOptionList,&BdsLoadOptionEntry->Link);\r
    }\r
  }\r
\r
  FreePool (BootOrder);\r
\r
  return EFI_SUCCESS;\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 ARM_BDS_LOADER_TYPE        BootType,\r
  IN UINT8*                     OptionalData,\r
  IN UINTN                      OptionalDataSize\r
  )\r
{\r
  EFI_LOAD_OPTION               EfiLoadOption;\r
  UINTN                         EfiLoadOptionSize;\r
  UINTN                         BootDescriptionSize;\r
  UINT16                        FilePathListLength;\r
  UINT8*                        EfiLoadOptionPtr;\r
  UINT8*                        InitrdPathListPtr;\r
  ARM_BDS_LINUX_ARGUMENTS*      DestLinuxArguments;\r
  ARM_BDS_LINUX_ARGUMENTS*      SrcLinuxArguments;\r
  ARM_BDS_LOADER_ARGUMENTS*     BootArguments;\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
\r
  // Fixup the size in case of entry specific to ArmPlatformPkg/Bds\r
  if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\r
    OptionalDataSize += sizeof(ARM_BDS_LOADER_OPTIONAL_DATA_HEADER);\r
  }\r
\r
  // Compute the size of the FilePath list\r
  FilePathListLength = GetUnalignedDevicePathSize (DevicePath);\r
\r
  // Allocate the memory for the EFI Load Option\r
  EfiLoadOptionSize = sizeof(UINT32) + sizeof(UINT16) + BootDescriptionSize + FilePathListLength + OptionalDataSize;\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
  CopyMem (EfiLoadOptionPtr, DevicePath, FilePathListLength);\r
  EfiLoadOptionPtr += FilePathListLength;\r
\r
  // Optional Data fields, Do unaligned writes\r
  BootOption->OptionalData = EfiLoadOptionPtr;\r
\r
  if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\r
    // Write the header\r
    WriteUnaligned32 ((UINT32 *)EfiLoadOptionPtr, ARM_BDS_OPTIONAL_DATA_SIGNATURE);\r
    WriteUnaligned32 ((UINT32 *)(EfiLoadOptionPtr + 4), BootType);\r
\r
    BootArguments = (ARM_BDS_LOADER_ARGUMENTS*)OptionalData;\r
    SrcLinuxArguments = &(BootArguments->LinuxArguments);\r
    DestLinuxArguments = &((ARM_BDS_LOADER_OPTIONAL_DATA*)EfiLoadOptionPtr)->Arguments.LinuxArguments;\r
\r
    WriteUnaligned16 ((UINT16 *)&(DestLinuxArguments->CmdLineSize), SrcLinuxArguments->CmdLineSize);\r
    WriteUnaligned16 ((UINT16 *)&(DestLinuxArguments->InitrdSize), SrcLinuxArguments->InitrdSize);\r
\r
    if (SrcLinuxArguments->CmdLineSize > 0) {\r
      CopyMem ((VOID*)(DestLinuxArguments + 1), (VOID*)(SrcLinuxArguments + 1), SrcLinuxArguments->CmdLineSize);\r
    }\r
\r
    if (SrcLinuxArguments->InitrdSize > 0) {\r
      InitrdPathListPtr = (UINT8*)((UINTN)(DestLinuxArguments + 1) + SrcLinuxArguments->CmdLineSize);\r
      CopyMem (InitrdPathListPtr, (VOID*)((UINTN)(SrcLinuxArguments + 1) + SrcLinuxArguments->CmdLineSize), SrcLinuxArguments->InitrdSize);\r
    }\r
  } else {\r
    CopyMem (BootOption->OptionalData, OptionalData, OptionalDataSize);\r
  }\r
  BootOption->OptionalDataSize = OptionalDataSize;\r
\r
  // If this function is called at the creation of the Boot Device entry (not at the update) the\r
  // BootOption->LoadOptionSize must be zero then we get a new BootIndex for this entry\r
  if (BootOption->LoadOptionSize == 0) {\r
    BootOption->LoadOptionIndex = BootOptionAllocateBootIndex ();\r
  }\r
\r
  // Fill the EFI Load option fields\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  ARM_BDS_LOADER_TYPE       BootType,\r
  IN  UINT8*                    OptionalData,\r
  IN  UINTN                     OptionalDataSize,\r
  OUT BDS_LOAD_OPTION**         BdsLoadOption\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  BDS_LOAD_OPTION_ENTRY*        BootOptionEntry;\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
  BootOptionEntry = (BDS_LOAD_OPTION_ENTRY*)AllocatePool (sizeof (BDS_LOAD_OPTION_ENTRY));\r
  InitializeListHead (&BootOptionEntry->Link);\r
  BootOptionEntry->BdsLoadOption = (BDS_LOAD_OPTION*)AllocateZeroPool (sizeof(BDS_LOAD_OPTION));\r
\r
  BootOption = BootOptionEntry->BdsLoadOption;\r
  BootOptionSetFields (BootOption, Attributes, BootDescription, DevicePath, BootType, OptionalData, OptionalDataSize);\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 = GetGlobalEnvironmentVariable (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
  // We only free it if the UEFI Variable 'BootOrder' was already existing\r
  if (BootOrderSize > sizeof(UINT16)) {\r
    FreePool (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  ARM_BDS_LOADER_TYPE       BootType,\r
  IN UINT8*                     OptionalData,\r
  IN UINTN                      OptionalDataSize\r
  )\r
{\r
  EFI_STATUS      Status;\r
  CHAR16          BootVariableName[9];\r
\r
  // Update the BDS Load Option structure\r
  BootOptionSetFields (BdsLoadOption, Attributes, BootDescription, DevicePath, BootType, OptionalData, OptionalDataSize);\r
\r
  // Update the related environment variables\r
  UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BdsLoadOption->LoadOptionIndex);\r
\r
  Status = gRT->SetVariable (\r
      BootVariableName,\r
      &gEfiGlobalVariableGuid,\r
      EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
      BdsLoadOption->LoadOptionSize,\r
      BdsLoadOption->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
  // Remove the entry from the BootOrder environment variable\r
  Status = GetGlobalEnvironmentVariable (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 (\r
            &BootOrder[Index],\r
            &BootOrder[Index + 1],\r
            (BootOrderCount - (Index + 1)) * sizeof(UINT16)\r
            );\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
  FreePool (BootOrder);\r
\r
  return EFI_SUCCESS;\r
}\r
Commit	Line	Data
ea46ebbe	1	/** @file\r
ea46ebbe	2	*\r
c3b6d975	3	* Copyright (c) 2011-2014, ARM Limited. All rights reserved.\r
ea46ebbe	4	*\r
	5	* This program and the accompanying materials\r
	6	* are licensed and made available under the terms and conditions of the BSD License\r
	7	* which accompanies this distribution. The full text of the license may be found at\r
	8	* http://opensource.org/licenses/bsd-license.php\r
	9	*\r
	10	* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	*\r
	13	**/\r
	14	\r
c0b2e477	15	#include <Guid/ArmGlobalVariableHob.h>\r
ea46ebbe	16	#include "BdsInternal.h"\r
ea46ebbe	17	\r
ea46ebbe	18	EFI_STATUS\r
	19	BootOptionStart (\r
	20	IN BDS_LOAD_OPTION *BootOption\r
	21	)\r
	22	{\r
c60ea9a8	23	EFI_STATUS Status;\r
c60ea9a8	24	EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL* EfiDevicePathFromTextProtocol;\r
c60ea9a8	25	UINT32 LoaderType;\r
2ccfb71e	26	ARM_BDS_LOADER_OPTIONAL_DATA* OptionalData;\r
	27	ARM_BDS_LINUX_ARGUMENTS* LinuxArguments;\r
	28	EFI_DEVICE_PATH_PROTOCOL* FdtDevicePath;\r
	29	EFI_DEVICE_PATH_PROTOCOL* DefaultFdtDevicePath;\r
	30	UINTN FdtDevicePathSize;\r
	31	UINTN CmdLineSize;\r
	32	UINTN InitrdSize;\r
	33	EFI_DEVICE_PATH* Initrd;\r
91213ad3	34	UINT16 LoadOptionIndexSize;\r
2ccfb71e	35	\r
a6e97d28	36	if (IS_ARM_BDS_BOOTENTRY (BootOption)) {\r
2ccfb71e	37	Status = EFI_UNSUPPORTED;\r
	38	OptionalData = BootOption->OptionalData;\r
	39	LoaderType = ReadUnaligned32 ((CONST UINT32*)&OptionalData->Header.LoaderType);\r
	40	\r
	41	if (LoaderType == BDS_LOADER_EFI_APPLICATION) {\r
5c670b21	42	if ((BootOption->Attributes & LOAD_OPTION_CATEGORY) == LOAD_OPTION_CATEGORY_APP) {\r
4c8bb1eb OM	43	// Need to connect every drivers to ensure no dependencies are missing for the application\r
	44	BdsConnectAllDrivers ();\r
	45	}\r
2ccfb71e	46	\r
c3b6d975	47	Status = BdsStartEfiApplication (gImageHandle, BootOption->FilePathList, 0, NULL);\r
2ccfb71e	48	} else if (LoaderType == BDS_LOADER_KERNEL_LINUX_ATAG) {\r
	49	LinuxArguments = &(OptionalData->Arguments.LinuxArguments);\r
	50	CmdLineSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->CmdLineSize);\r
	51	InitrdSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->InitrdSize);\r
	52	\r
	53	if (InitrdSize > 0) {\r
	54	Initrd = GetAlignedDevicePath ((EFI_DEVICE_PATH*)((UINTN)(LinuxArguments + 1) + CmdLineSize));\r
	55	} else {\r
	56	Initrd = NULL;\r
	57	}\r
ea46ebbe	58	\r
76d17c31	59	Status = BdsBootLinuxAtag (BootOption->FilePathList,\r
2ccfb71e	60	Initrd, // Initrd\r
76d17c31	61	(CHAR8*)(LinuxArguments + 1)); // CmdLine\r
2ccfb71e	62	} else if (LoaderType == BDS_LOADER_KERNEL_LINUX_FDT) {\r
	63	LinuxArguments = &(OptionalData->Arguments.LinuxArguments);\r
	64	CmdLineSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->CmdLineSize);\r
	65	InitrdSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->InitrdSize);\r
	66	\r
	67	if (InitrdSize > 0) {\r
	68	Initrd = GetAlignedDevicePath ((EFI_DEVICE_PATH*)((UINTN)(LinuxArguments + 1) + CmdLineSize));\r
	69	} else {\r
	70	Initrd = NULL;\r
	71	}\r
	72	\r
	73	// Get the default FDT device path\r
	74	Status = gBS->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid, NULL, (VOID **)&EfiDevicePathFromTextProtocol);\r
	75	ASSERT_EFI_ERROR(Status);\r
	76	DefaultFdtDevicePath = EfiDevicePathFromTextProtocol->ConvertTextToDevicePath ((CHAR16*)PcdGetPtr(PcdFdtDevicePath));\r
	77	\r
	78	// Get the FDT device path\r
	79	FdtDevicePathSize = GetDevicePathSize (DefaultFdtDevicePath);\r
c0b2e477	80	Status = GetEnvironmentVariable ((CHAR16 *)L"Fdt", &gArmGlobalVariableGuid,\r
c0b2e477	81	DefaultFdtDevicePath, &FdtDevicePathSize, (VOID **)&FdtDevicePath);\r
2ccfb71e	82	ASSERT_EFI_ERROR(Status);\r
2ccfb71e	83	\r
76d17c31	84	Status = BdsBootLinuxFdt (BootOption->FilePathList,\r
2ccfb71e	85	Initrd, // Initrd\r
	86	(CHAR8*)(LinuxArguments + 1),\r
	87	FdtDevicePath);\r
b148591a	88	\r
79480c8d	89	FreePool (DefaultFdtDevicePath);\r
b148591a	90	FreePool (FdtDevicePath);\r
a6e97d28	91	}\r
a6e97d28	92	} else {\r
4c8bb1eb	93	// Connect all the drivers if the EFI Application is not a EFI OS Loader\r
5c670b21	94	if ((BootOption->Attributes & LOAD_OPTION_CATEGORY) == LOAD_OPTION_CATEGORY_APP) {\r
4c8bb1eb OM	95	BdsConnectAllDrivers ();\r
	96	}\r
	97	\r
91213ad3	98	// Set BootCurrent variable\r
	99	LoadOptionIndexSize = sizeof(UINT16);\r
	100	gRT->SetVariable (L"BootCurrent", &gEfiGlobalVariableGuid,\r
	101	EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
	102	LoadOptionIndexSize, &(BootOption->LoadOptionIndex));\r
	103	\r
c3b6d975	104	Status = BdsStartEfiApplication (gImageHandle, BootOption->FilePathList, BootOption->OptionalDataSize, BootOption->OptionalData);\r
91213ad3	105	\r
	106	// Clear BootCurrent variable\r
	107	LoadOptionIndexSize = sizeof(UINT16);\r
	108	gRT->SetVariable (L"BootCurrent", &gEfiGlobalVariableGuid,\r
	109	EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
	110	0, NULL);\r
a6e97d28	111	}\r
ea46ebbe	112	\r
	113	return Status;\r
	114	}\r
	115	\r
ea46ebbe	116	EFI_STATUS\r
	117	BootOptionList (\r
	118	IN OUT LIST_ENTRY *BootOptionList\r
	119	)\r
	120	{\r
a6e97d28	121	EFI_STATUS Status;\r
	122	UINTN Index;\r
	123	UINT16* BootOrder;\r
	124	UINTN BootOrderSize;\r
	125	BDS_LOAD_OPTION* BdsLoadOption;\r
	126	BDS_LOAD_OPTION_ENTRY* BdsLoadOptionEntry;\r
ea46ebbe	127	\r
	128	InitializeListHead (BootOptionList);\r
	129	\r
	130	// Get the Boot Option Order from the environment variable\r
c0b2e477	131	Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
ea46ebbe	132	if (EFI_ERROR(Status)) {\r
	133	return Status;\r
	134	}\r
	135	\r
	136	for (Index = 0; Index < BootOrderSize / sizeof (UINT16); Index++) {\r
4aa24170	137	Status = BootOptionFromLoadOptionIndex (BootOrder[Index], &BdsLoadOption);\r
ea46ebbe	138	if (!EFI_ERROR(Status)) {\r
a6e97d28	139	BdsLoadOptionEntry = (BDS_LOAD_OPTION_ENTRY*)AllocatePool(sizeof(BDS_LOAD_OPTION_ENTRY));\r
	140	BdsLoadOptionEntry->BdsLoadOption = BdsLoadOption;\r
	141	InsertTailList (BootOptionList,&BdsLoadOptionEntry->Link);\r
ea46ebbe	142	}\r
	143	}\r
	144	\r
b148591a	145	FreePool (BootOrder);\r
b148591a	146	\r
ea46ebbe	147	return EFI_SUCCESS;\r
	148	}\r
	149	\r
ea46ebbe	150	STATIC\r
	151	EFI_STATUS\r
	152	BootOptionSetFields (\r
c60ea9a8	153	IN BDS_LOAD_OPTION* BootOption,\r
	154	IN UINT32 Attributes,\r
	155	IN CHAR16* BootDescription,\r
	156	IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
2ccfb71e	157	IN ARM_BDS_LOADER_TYPE BootType,\r
90a44ec4 OM	158	IN UINT8* OptionalData,\r
90a44ec4 OM	159	IN UINTN OptionalDataSize\r
ea46ebbe	160	)\r
ea46ebbe	161	{\r
2ccfb71e	162	EFI_LOAD_OPTION EfiLoadOption;\r
	163	UINTN EfiLoadOptionSize;\r
	164	UINTN BootDescriptionSize;\r
2ccfb71e	165	UINT16 FilePathListLength;\r
	166	UINT8* EfiLoadOptionPtr;\r
	167	UINT8* InitrdPathListPtr;\r
2ccfb71e	168	ARM_BDS_LINUX_ARGUMENTS* DestLinuxArguments;\r
2ccfb71e	169	ARM_BDS_LINUX_ARGUMENTS* SrcLinuxArguments;\r
90a44ec4	170	ARM_BDS_LOADER_ARGUMENTS* BootArguments;\r
ea46ebbe	171	\r
	172	// If we are overwriting an existent Boot Option then we have to free previously allocated memory\r
	173	if (BootOption->LoadOption) {\r
90a44ec4	174	FreePool (BootOption->LoadOption);\r
ea46ebbe	175	}\r
ea46ebbe	176	\r
2ccfb71e	177	BootDescriptionSize = StrSize (BootDescription);\r
90a44ec4 OM	178	\r
90a44ec4 OM	179	// Fixup the size in case of entry specific to ArmPlatformPkg/Bds\r
2ccfb71e	180	if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) \|\| (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\r
90a44ec4	181	OptionalDataSize += sizeof(ARM_BDS_LOADER_OPTIONAL_DATA_HEADER);\r
2ccfb71e	182	}\r
ea46ebbe	183	\r
ea46ebbe	184	// Compute the size of the FilePath list\r
2ccfb71e	185	FilePathListLength = GetUnalignedDevicePathSize (DevicePath);\r
656416bc	186	\r
ea46ebbe	187	// Allocate the memory for the EFI Load Option\r
90a44ec4	188	EfiLoadOptionSize = sizeof(UINT32) + sizeof(UINT16) + BootDescriptionSize + FilePathListLength + OptionalDataSize;\r
ea46ebbe	189	EfiLoadOption = (EFI_LOAD_OPTION)AllocatePool(EfiLoadOptionSize);\r
	190	EfiLoadOptionPtr = EfiLoadOption;\r
	191	\r
	192	//\r
	193	// Populate the EFI Load Option and BDS Boot Option structures\r
	194	//\r
	195	\r
	196	// Attributes fields\r
	197	BootOption->Attributes = Attributes;\r
	198	(UINT32)EfiLoadOptionPtr = Attributes;\r
	199	EfiLoadOptionPtr += sizeof(UINT32);\r
	200	\r
	201	// FilePath List fields\r
	202	BootOption->FilePathListLength = FilePathListLength;\r
	203	(UINT16)EfiLoadOptionPtr = FilePathListLength;\r
	204	EfiLoadOptionPtr += sizeof(UINT16);\r
	205	\r
	206	// Boot description fields\r
	207	BootOption->Description = (CHAR16*)EfiLoadOptionPtr;\r
	208	CopyMem (EfiLoadOptionPtr, BootDescription, BootDescriptionSize);\r
	209	EfiLoadOptionPtr += BootDescriptionSize;\r
	210	\r
	211	// File path fields\r
	212	BootOption->FilePathList = (EFI_DEVICE_PATH_PROTOCOL*)EfiLoadOptionPtr;\r
2ccfb71e	213	CopyMem (EfiLoadOptionPtr, DevicePath, FilePathListLength);\r
2ccfb71e	214	EfiLoadOptionPtr += FilePathListLength;\r
ea46ebbe	215	\r
ea46ebbe	216	// Optional Data fields, Do unaligned writes\r
2ccfb71e	217	BootOption->OptionalData = EfiLoadOptionPtr;\r
ea46ebbe	218	\r
2ccfb71e	219	if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) \|\| (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\r
90a44ec4 OM	220	// Write the header\r
	221	WriteUnaligned32 ((UINT32 *)EfiLoadOptionPtr, ARM_BDS_OPTIONAL_DATA_SIGNATURE);\r
	222	WriteUnaligned32 ((UINT32 *)(EfiLoadOptionPtr + 4), BootType);\r
	223	\r
	224	BootArguments = (ARM_BDS_LOADER_ARGUMENTS*)OptionalData;\r
2ccfb71e	225	SrcLinuxArguments = &(BootArguments->LinuxArguments);\r
2ccfb71e	226	DestLinuxArguments = &((ARM_BDS_LOADER_OPTIONAL_DATA*)EfiLoadOptionPtr)->Arguments.LinuxArguments;\r
656416bc	227	\r
2ccfb71e	228	WriteUnaligned16 ((UINT16 *)&(DestLinuxArguments->CmdLineSize), SrcLinuxArguments->CmdLineSize);\r
2ccfb71e	229	WriteUnaligned16 ((UINT16 *)&(DestLinuxArguments->InitrdSize), SrcLinuxArguments->InitrdSize);\r
656416bc	230	\r
2ccfb71e	231	if (SrcLinuxArguments->CmdLineSize > 0) {\r
2ccfb71e	232	CopyMem ((VOID)(DestLinuxArguments + 1), (VOID)(SrcLinuxArguments + 1), SrcLinuxArguments->CmdLineSize);\r
2ccfb71e	233	}\r
656416bc	234	\r
2ccfb71e	235	if (SrcLinuxArguments->InitrdSize > 0) {\r
	236	InitrdPathListPtr = (UINT8*)((UINTN)(DestLinuxArguments + 1) + SrcLinuxArguments->CmdLineSize);\r
	237	CopyMem (InitrdPathListPtr, (VOID*)((UINTN)(SrcLinuxArguments + 1) + SrcLinuxArguments->CmdLineSize), SrcLinuxArguments->InitrdSize);\r
656416bc	238	}\r
90a44ec4 OM	239	} else {\r
90a44ec4 OM	240	CopyMem (BootOption->OptionalData, OptionalData, OptionalDataSize);\r
656416bc	241	}\r
2ccfb71e	242	BootOption->OptionalDataSize = OptionalDataSize;\r
2ccfb71e	243	\r
6bab33c7	244	// If this function is called at the creation of the Boot Device entry (not at the update) the\r
	245	// BootOption->LoadOptionSize must be zero then we get a new BootIndex for this entry\r
	246	if (BootOption->LoadOptionSize == 0) {\r
2ccfb71e	247	BootOption->LoadOptionIndex = BootOptionAllocateBootIndex ();\r
6bab33c7	248	}\r
6bab33c7	249	\r
ea46ebbe	250	// Fill the EFI Load option fields\r
ea46ebbe	251	BootOption->LoadOption = EfiLoadOption;\r
	252	BootOption->LoadOptionSize = EfiLoadOptionSize;\r
	253	\r
	254	return EFI_SUCCESS;\r
	255	}\r
	256	\r
	257	EFI_STATUS\r
	258	BootOptionCreate (\r
c60ea9a8	259	IN UINT32 Attributes,\r
c60ea9a8	260	IN CHAR16* BootDescription,\r
ea46ebbe	261	IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
2ccfb71e	262	IN ARM_BDS_LOADER_TYPE BootType,\r
90a44ec4 OM	263	IN UINT8* OptionalData,\r
90a44ec4 OM	264	IN UINTN OptionalDataSize,\r
a6e97d28	265	OUT BDS_LOAD_OPTION** BdsLoadOption\r
ea46ebbe	266	)\r
ea46ebbe	267	{\r
a6e97d28	268	EFI_STATUS Status;\r
	269	BDS_LOAD_OPTION_ENTRY* BootOptionEntry;\r
	270	BDS_LOAD_OPTION* BootOption;\r
	271	CHAR16 BootVariableName[9];\r
	272	UINT16* BootOrder;\r
	273	UINTN BootOrderSize;\r
ea46ebbe	274	\r
	275	//\r
	276	// Allocate and fill the memory for the BDS Load Option structure\r
	277	//\r
a6e97d28	278	BootOptionEntry = (BDS_LOAD_OPTION_ENTRY*)AllocatePool (sizeof (BDS_LOAD_OPTION_ENTRY));\r
	279	InitializeListHead (&BootOptionEntry->Link);\r
	280	BootOptionEntry->BdsLoadOption = (BDS_LOAD_OPTION*)AllocateZeroPool (sizeof(BDS_LOAD_OPTION));\r
ea46ebbe	281	\r
a6e97d28	282	BootOption = BootOptionEntry->BdsLoadOption;\r
90a44ec4	283	BootOptionSetFields (BootOption, Attributes, BootDescription, DevicePath, BootType, OptionalData, OptionalDataSize);\r
ea46ebbe	284	\r
	285	//\r
	286	// Set the related environment variables\r
	287	//\r
	288	\r
	289	// Create Boot#### environment variable\r
	290	UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BootOption->LoadOptionIndex);\r
	291	Status = gRT->SetVariable (\r
	292	BootVariableName,\r
	293	&gEfiGlobalVariableGuid,\r
	294	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
	295	BootOption->LoadOptionSize,\r
	296	BootOption->LoadOption\r
	297	);\r
	298	\r
	299	// Add the new Boot Index to the list\r
c0b2e477	300	Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
ea46ebbe	301	if (!EFI_ERROR(Status)) {\r
	302	BootOrder = ReallocatePool (BootOrderSize, BootOrderSize + sizeof(UINT16), BootOrder);\r
	303	// Add the new index at the end\r
	304	BootOrder[BootOrderSize / sizeof(UINT16)] = BootOption->LoadOptionIndex;\r
	305	BootOrderSize += sizeof(UINT16);\r
	306	} else {\r
	307	// BootOrder does not exist. Create it\r
	308	BootOrderSize = sizeof(UINT16);\r
	309	BootOrder = &(BootOption->LoadOptionIndex);\r
	310	}\r
	311	\r
	312	// Update (or Create) the BootOrder environment variable\r
	313	Status = gRT->SetVariable (\r
	314	L"BootOrder",\r
	315	&gEfiGlobalVariableGuid,\r
	316	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
	317	BootOrderSize,\r
	318	BootOrder\r
	319	);\r
	320	\r
b148591a	321	// We only free it if the UEFI Variable 'BootOrder' was already existing\r
	322	if (BootOrderSize > sizeof(UINT16)) {\r
	323	FreePool (BootOrder);\r
	324	}\r
	325	\r
ea46ebbe	326	*BdsLoadOption = BootOption;\r
	327	return Status;\r
	328	}\r
	329	\r
	330	EFI_STATUS\r
	331	BootOptionUpdate (\r
2ccfb71e	332	IN BDS_LOAD_OPTION* BdsLoadOption,\r
	333	IN UINT32 Attributes,\r
	334	IN CHAR16* BootDescription,\r
ea46ebbe	335	IN EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
2ccfb71e	336	IN ARM_BDS_LOADER_TYPE BootType,\r
90a44ec4 OM	337	IN UINT8* OptionalData,\r
90a44ec4 OM	338	IN UINTN OptionalDataSize\r
ea46ebbe	339	)\r
	340	{\r
	341	EFI_STATUS Status;\r
ea46ebbe	342	CHAR16 BootVariableName[9];\r
	343	\r
	344	// Update the BDS Load Option structure\r
90a44ec4	345	BootOptionSetFields (BdsLoadOption, Attributes, BootDescription, DevicePath, BootType, OptionalData, OptionalDataSize);\r
ea46ebbe	346	\r
ea46ebbe	347	// Update the related environment variables\r
6bab33c7	348	UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BdsLoadOption->LoadOptionIndex);\r
6bab33c7	349	\r
ea46ebbe	350	Status = gRT->SetVariable (\r
	351	BootVariableName,\r
	352	&gEfiGlobalVariableGuid,\r
	353	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
6bab33c7	354	BdsLoadOption->LoadOptionSize,\r
6bab33c7	355	BdsLoadOption->LoadOption\r
ea46ebbe	356	);\r
	357	\r
	358	return Status;\r
	359	}\r
	360	\r
	361	EFI_STATUS\r
	362	BootOptionDelete (\r
	363	IN BDS_LOAD_OPTION *BootOption\r
	364	)\r
	365	{\r
a6e97d28	366	UINTN Index;\r
	367	UINTN BootOrderSize;\r
	368	UINT16* BootOrder;\r
	369	UINTN BootOrderCount;\r
	370	EFI_STATUS Status;\r
ea46ebbe	371	\r
ea46ebbe	372	// Remove the entry from the BootOrder environment variable\r
c0b2e477	373	Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
ea46ebbe	374	if (!EFI_ERROR(Status)) {\r
	375	BootOrderCount = BootOrderSize / sizeof(UINT16);\r
	376	\r
	377	// Find the index of the removed entry\r
	378	for (Index = 0; Index < BootOrderCount; Index++) {\r
	379	if (BootOrder[Index] == BootOption->LoadOptionIndex) {\r
	380	// If it the last entry we do not need to rearrange the BootOrder list\r
	381	if (Index + 1 != BootOrderCount) {\r
9127a094	382	CopyMem (\r
	383	&BootOrder[Index],\r
	384	&BootOrder[Index + 1],\r
	385	(BootOrderCount - (Index + 1)) * sizeof(UINT16)\r
	386	);\r
ea46ebbe	387	}\r
	388	break;\r
	389	}\r
	390	}\r
	391	\r
	392	// Update the BootOrder environment variable\r
	393	Status = gRT->SetVariable (\r
	394	L"BootOrder",\r
	395	&gEfiGlobalVariableGuid,\r
	396	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
	397	BootOrderSize - sizeof(UINT16),\r
	398	BootOrder\r
	399	);\r
	400	}\r
	401	\r
b148591a	402	FreePool (BootOrder);\r
b148591a	403	\r
ea46ebbe	404	return EFI_SUCCESS;\r
ea46ebbe	405	}\r