]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ArmPlatformPkg/Bds/BootOption.c
MdeModulePkg: Convert HiiDatabaseDxe ConfigRouting ASSERT to return an error
[mirror_edk2.git] / ArmPlatformPkg / Bds / BootOption.c
index 6a5f010abe85467cbcf36a74e8c453c98b2c98e0..32a5679762f91f4328ea1ac4f0ede5434c6ecf14 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
 *\r
-*  Copyright (c) 2011, ARM Limited. All rights reserved.\r
+*  Copyright (c) 2011-2015, 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
 \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_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
-\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
-      // Need to connect every drivers to ensure no dependencies are missing for the application\r
-      BdsConnectAllDrivers();\r
-\r
-      Status = BdsStartEfiApplication (mImageHandle, 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 = BdsBootLinux (BootOption->FilePathList,\r
-                                 Initrd, // Initrd\r
-                                 (CHAR8*)(LinuxArguments + 1), // CmdLine\r
-                                 NULL);\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
+  EFI_STATUS Status;\r
+  UINT16     LoadOptionIndexSize;\r
 \r
-      // Get the FDT device path\r
-      FdtDevicePathSize = GetDevicePathSize (DefaultFdtDevicePath);\r
-      Status = GetEnvironmentVariable ((CHAR16 *)L"FDT", DefaultFdtDevicePath, &FdtDevicePathSize, (VOID **)&FdtDevicePath);\r
-      ASSERT_EFI_ERROR(Status);\r
-\r
-      Status = BdsBootLinux (BootOption->FilePathList,\r
-                                Initrd, // Initrd\r
-                                (CHAR8*)(LinuxArguments + 1),\r
-                                FdtDevicePath);\r
-    }\r
-  } else {\r
-    Status = BdsStartEfiApplication (mImageHandle, BootOption->FilePathList);\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
-  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
+  // 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
-  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
+  Status = BdsStartEfiApplication (gImageHandle, BootOption->FilePathList, BootOption->OptionalDataSize, BootOption->OptionalData);\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
+  // 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
   return Status;\r
 }\r
@@ -173,13 +59,13 @@ BootOptionList (
   InitializeListHead (BootOptionList);\r
 \r
   // Get the Boot Option Order from the environment variable\r
-  Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\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 = BootOptionFromLoadOptionVariable (BootOrder[Index],&BdsLoadOption);\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
@@ -187,39 +73,9 @@ BootOptionList (
     }\r
   }\r
 \r
-  return EFI_SUCCESS;\r
-}\r
+  FreePool (BootOrder);\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
+  return EFI_SUCCESS;\r
 }\r
 \r
 STATIC\r
@@ -229,39 +85,30 @@ BootOptionSetFields (
   IN UINT32                     Attributes,\r
   IN CHAR16*                    BootDescription,\r
   IN EFI_DEVICE_PATH_PROTOCOL*  DevicePath,\r
-  IN ARM_BDS_LOADER_TYPE        BootType,\r
-  IN ARM_BDS_LOADER_ARGUMENTS*  BootArguments\r
+  IN UINT8*                     OptionalData,\r
+  IN UINTN                      OptionalDataSize\r
   )\r
 {\r
-  EFI_LOAD_OPTION               EfiLoadOption;\r
+  EFI_LOAD_OPTION               *EfiLoadOption;\r
   UINTN                         EfiLoadOptionSize;\r
   UINTN                         BootDescriptionSize;\r
-  UINTN                         BootOptionalDataSize;\r
   UINT16                        FilePathListLength;\r
   UINT8*                        EfiLoadOptionPtr;\r
-  UINT8*                        InitrdPathListPtr;\r
-  UINTN                         OptionalDataSize;\r
-  ARM_BDS_LINUX_ARGUMENTS*      DestLinuxArguments;\r
-  ARM_BDS_LINUX_ARGUMENTS*      SrcLinuxArguments;\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
+    FreePool (BootOption->LoadOption);\r
   }\r
 \r
   BootDescriptionSize = StrSize (BootDescription);\r
-  BootOptionalDataSize = sizeof(ARM_BDS_LOADER_OPTIONAL_DATA_HEADER);\r
-  if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\r
-    BootOptionalDataSize += sizeof(ARM_BDS_LINUX_ARGUMENTS) + BootArguments->LinuxArguments.CmdLineSize + BootArguments->LinuxArguments.InitrdSize;\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 + BootOptionalDataSize;\r
-  EfiLoadOption = (EFI_LOAD_OPTION)AllocatePool(EfiLoadOptionSize);\r
-  EfiLoadOptionPtr = EfiLoadOption;\r
+  EfiLoadOptionSize = sizeof(UINT32) + sizeof(UINT16) + BootDescriptionSize + FilePathListLength + OptionalDataSize;\r
+  EfiLoadOption = (EFI_LOAD_OPTION *)AllocatePool(EfiLoadOptionSize);\r
+  EfiLoadOptionPtr = (UINT8 *)EfiLoadOption;\r
 \r
   //\r
   // Populate the EFI Load Option and BDS Boot Option structures\r
@@ -289,29 +136,11 @@ BootOptionSetFields (
 \r
   // Optional Data fields, Do unaligned writes\r
   BootOption->OptionalData = EfiLoadOptionPtr;\r
-  WriteUnaligned32 ((UINT32 *)EfiLoadOptionPtr, ARM_BDS_OPTIONAL_DATA_SIGNATURE);\r
-  WriteUnaligned32 ((UINT32 *)(EfiLoadOptionPtr + 4), BootType);\r
-\r
-  OptionalDataSize = sizeof(ARM_BDS_LOADER_OPTIONAL_DATA_HEADER);\r
-\r
-  if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {\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
-    OptionalDataSize += sizeof (ARM_BDS_LINUX_ARGUMENTS);\r
-\r
-    if (SrcLinuxArguments->CmdLineSize > 0) {\r
-      CopyMem ((VOID*)(DestLinuxArguments + 1), (VOID*)(SrcLinuxArguments + 1), SrcLinuxArguments->CmdLineSize);\r
-      OptionalDataSize += 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
+  if (OptionalData != NULL) {\r
+    CopyMem (BootOption->OptionalData, OptionalData, OptionalDataSize);\r
   }\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
@@ -332,8 +161,8 @@ BootOptionCreate (
   IN  UINT32                    Attributes,\r
   IN  CHAR16*                   BootDescription,\r
   IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
-  IN  ARM_BDS_LOADER_TYPE       BootType,\r
-  IN  ARM_BDS_LOADER_ARGUMENTS* BootArguments,\r
+  IN  UINT8*                    OptionalData,\r
+  IN  UINTN                     OptionalDataSize,\r
   OUT BDS_LOAD_OPTION**         BdsLoadOption\r
   )\r
 {\r
@@ -352,7 +181,7 @@ BootOptionCreate (
   BootOptionEntry->BdsLoadOption = (BDS_LOAD_OPTION*)AllocateZeroPool (sizeof(BDS_LOAD_OPTION));\r
 \r
   BootOption = BootOptionEntry->BdsLoadOption;\r
-  BootOptionSetFields (BootOption, Attributes, BootDescription, DevicePath, BootType, BootArguments);\r
+  BootOptionSetFields (BootOption, Attributes, BootDescription, DevicePath, OptionalData, OptionalDataSize);\r
 \r
   //\r
   // Set the related environment variables\r
@@ -369,7 +198,7 @@ BootOptionCreate (
       );\r
 \r
   // Add the new Boot Index to the list\r
-  Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\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
@@ -390,6 +219,11 @@ BootOptionCreate (
       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
@@ -400,15 +234,15 @@ BootOptionUpdate (
   IN  UINT32                    Attributes,\r
   IN  CHAR16*                   BootDescription,\r
   IN  EFI_DEVICE_PATH_PROTOCOL* DevicePath,\r
-  IN  ARM_BDS_LOADER_TYPE       BootType,\r
-  IN  ARM_BDS_LOADER_ARGUMENTS* BootArguments\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, BootArguments);\r
+  BootOptionSetFields (BdsLoadOption, Attributes, BootDescription, DevicePath, OptionalData, OptionalDataSize);\r
 \r
   // Update the related environment variables\r
   UnicodeSPrint (BootVariableName, 9 * sizeof(CHAR16), L"Boot%04X", BdsLoadOption->LoadOptionIndex);\r
@@ -433,10 +267,11 @@ BootOptionDelete (
   UINTN         BootOrderSize;\r
   UINT16*       BootOrder;\r
   UINTN         BootOrderCount;\r
+  CHAR16        BootVariableName[9];\r
   EFI_STATUS    Status;\r
 \r
   // Remove the entry from the BootOrder environment variable\r
-  Status = GetEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
+  Status = GetGlobalEnvironmentVariable (L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder);\r
   if (!EFI_ERROR(Status)) {\r
     BootOrderCount = BootOrderSize / sizeof(UINT16);\r
 \r
@@ -445,7 +280,11 @@ BootOptionDelete (
       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
+          CopyMem (\r
+            &BootOrder[Index],\r
+            &BootOrder[Index + 1],\r
+            (BootOrderCount - (Index + 1)) * sizeof(UINT16)\r
+            );\r
         }\r
         break;\r
       }\r
@@ -461,5 +300,17 @@ BootOptionDelete (
         );\r
   }\r
 \r
-  return EFI_SUCCESS;\r
+  // Delete 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
+      0,\r
+      NULL\r
+      );\r
+\r
+  FreePool (BootOrder);\r
+\r
+  return Status;\r
 }\r