ArmPlatformPkg/Bds/BootMenu.c

   1 /** @file
   2 *
   3 *  Copyright (c) 2011 - 2014, ARM Limited. All rights reserved.
   4 *
   5 *  This program and the accompanying materials
   6 *  are licensed and made available under the terms and conditions of the BSD License
   7 *  which accompanies this distribution.  The full text of the license may be found at
   8 *  http://opensource.org/licenses/bsd-license.php
   9 *
  10 *  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 *  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 *
  13 **/
  14
  15 #include "BdsInternal.h"
  16
  17 #include <Guid/ArmGlobalVariableHob.h>
  18
  19 extern BDS_LOAD_OPTION_SUPPORT *BdsLoadOptionSupportList;
  20
  21 /**
  22   Worker function that displays the list of boot options that is passed in.
  23
  24   The function loops over the entries of the list of boot options that is passed
  25   in. For each entry, the boot option description is displayed on a single line
  26   along with the position of the option in the list. In debug mode, the UEFI
  27   device path and the arguments of the boot option are displayed as well in
  28   subsequent lines.
  29
  30   @param[in]  BootOptionsList  List of the boot options
  31
  32 **/
  33 STATIC
  34 VOID
  35 DisplayBootOptions (
  36   IN  LIST_ENTRY*   BootOptionsList
  37   )
  38 {
  39   EFI_STATUS        Status;
  40   UINTN             BootOptionCount;
  41   LIST_ENTRY       *Entry;
  42   BDS_LOAD_OPTION  *BdsLoadOption;
  43   BOOLEAN           IsUnicode;
  44
  45   BootOptionCount = 0 ;
  46   for (Entry = GetFirstNode (BootOptionsList);
  47        !IsNull (BootOptionsList, Entry);
  48        Entry = GetNextNode (BootOptionsList, Entry)
  49       ) {
  50
  51     BdsLoadOption = LOAD_OPTION_FROM_LINK (Entry);
  52     Print (L"[%d] %s\n", ++BootOptionCount, BdsLoadOption->Description);
  53
  54     DEBUG_CODE_BEGIN ();
  55       CHAR16*                           DevicePathTxt;
  56       EFI_DEVICE_PATH_TO_TEXT_PROTOCOL* DevicePathToTextProtocol;
  57       ARM_BDS_LOADER_TYPE               LoaderType;
  58       ARM_BDS_LOADER_OPTIONAL_DATA*     OptionalData;
  59
  60       Status = gBS->LocateProtocol (
  61                      &gEfiDevicePathToTextProtocolGuid,
  62                      NULL,
  63                      (VOID **)&DevicePathToTextProtocol
  64                      );
  65       ASSERT_EFI_ERROR (Status);
  66       DevicePathTxt = DevicePathToTextProtocol->ConvertDevicePathToText (
  67                                                   BdsLoadOption->FilePathList,
  68                                                   TRUE,
  69                                                   TRUE
  70                                                   );
  71       Print (L"\t- %s\n", DevicePathTxt);
  72
  73       OptionalData = BdsLoadOption->OptionalData;
  74       if (IS_ARM_BDS_BOOTENTRY (BdsLoadOption)) {
  75         LoaderType = (ARM_BDS_LOADER_TYPE)ReadUnaligned32 ((CONST UINT32*)&OptionalData->Header.LoaderType);
  76         if ((LoaderType == BDS_LOADER_KERNEL_LINUX_ATAG) ||
  77             (LoaderType == BDS_LOADER_KERNEL_LINUX_FDT )   ) {
  78           Print (L"\t- Arguments: %a\n", &OptionalData->Arguments.LinuxArguments + 1);
  79         }
  80       } else if (OptionalData != NULL) {
  81         if (IsPrintableString (OptionalData, &IsUnicode)) {
  82           if (IsUnicode) {
  83             Print (L"\t- Arguments: %s\n", OptionalData);
  84           } else {
  85             AsciiPrint ("\t- Arguments: %a\n", OptionalData);
  86           }
  87         }
  88       }
  89
  90       FreePool (DevicePathTxt);
  91     DEBUG_CODE_END ();
  92   }
  93 }
  94
  95 /**
  96   Worker function that asks for a boot option to be selected and returns a
  97   pointer to the structure describing the selected boot option.
  98
  99   @param[in]  BootOptionsList  List of the boot options
 100
 101   @retval     EFI_SUCCESS      Selection succeeded
 102   @retval     !EFI_SUCCESS     Input error or input cancelled
 103
 104 **/
 105 STATIC
 106 EFI_STATUS
 107 SelectBootOption (
 108   IN  LIST_ENTRY*               BootOptionsList,
 109   IN  CONST CHAR16*             InputStatement,
 110   OUT BDS_LOAD_OPTION_ENTRY**   BdsLoadOptionEntry
 111   )
 112 {
 113   EFI_STATUS                    Status;
 114   UINTN                         BootOptionCount;
 115   UINT16                       *BootOrder;
 116   LIST_ENTRY*                   Entry;
 117   UINTN                         BootOptionSelected;
 118   UINTN                         Index;
 119
 120   // Get the number of boot options
 121   Status = GetGlobalEnvironmentVariable (
 122             L"BootOrder", NULL, &BootOptionCount, (VOID**)&BootOrder
 123             );
 124   if (EFI_ERROR (Status)) {
 125     goto ErrorExit;
 126   }
 127   FreePool (BootOrder);
 128   BootOptionCount /= sizeof (UINT16);
 129
 130   // Check if a valid boot option(s) is found
 131   if (BootOptionCount == 0) {
 132     if (StrCmp (InputStatement, DELETE_BOOT_ENTRY) == 0) {
 133       Print (L"Nothing to remove!\n");
 134     } else if (StrCmp (InputStatement, UPDATE_BOOT_ENTRY) == 0) {
 135       Print (L"Nothing to update!\n");
 136     } else if (StrCmp (InputStatement, MOVE_BOOT_ENTRY) == 0) {
 137       Print (L"Nothing to move!\n");
 138     } else {
 139       Print (L"No supported Boot Entry.\n");
 140     }
 141     return EFI_NOT_FOUND;
 142   }
 143
 144   // Get the index of the boot device to delete
 145   BootOptionSelected = 0;
 146   while (BootOptionSelected == 0) {
 147     Print (InputStatement);
 148     Status = GetHIInputInteger (&BootOptionSelected);
 149     if (EFI_ERROR (Status)) {
 150       Print (L"\n");
 151       goto ErrorExit;
 152     } else if ((BootOptionSelected == 0) || (BootOptionSelected > BootOptionCount)) {
 153       Print (L"Invalid input (max %d)\n", BootOptionCount);
 154       BootOptionSelected = 0;
 155     }
 156   }
 157
 158   // Get the structure of the Boot device to delete
 159   Index = 1;
 160   for (Entry = GetFirstNode (BootOptionsList);
 161        !IsNull (BootOptionsList, Entry);
 162        Entry = GetNextNode (BootOptionsList,Entry)
 163        )
 164   {
 165     if (Index == BootOptionSelected) {
 166       *BdsLoadOptionEntry = LOAD_OPTION_ENTRY_FROM_LINK (Entry);
 167       break;
 168     }
 169     Index++;
 170   }
 171
 172 ErrorExit:
 173   return Status;
 174 }
 175
 176 STATIC
 177 EFI_STATUS
 178 SelectBootDevice (
 179   OUT BDS_SUPPORTED_DEVICE** SupportedBootDevice
 180   )
 181 {
 182   EFI_STATUS  Status;
 183   LIST_ENTRY  SupportedDeviceList;
 184   UINTN       SupportedDeviceCount;
 185   LIST_ENTRY* Entry;
 186   UINTN       SupportedDeviceSelected;
 187   UINTN       Index;
 188
 189   //
 190   // List the Boot Devices supported
 191   //
 192
 193   // Start all the drivers first
 194   BdsConnectAllDrivers ();
 195
 196   // List the supported devices
 197   Status = BootDeviceListSupportedInit (&SupportedDeviceList);
 198   ASSERT_EFI_ERROR(Status);
 199
 200   SupportedDeviceCount = 0;
 201   for (Entry = GetFirstNode (&SupportedDeviceList);
 202        !IsNull (&SupportedDeviceList,Entry);
 203        Entry = GetNextNode (&SupportedDeviceList,Entry)
 204        )
 205   {
 206     *SupportedBootDevice = SUPPORTED_BOOT_DEVICE_FROM_LINK(Entry);
 207     Print(L"[%d] %s\n",SupportedDeviceCount+1,(*SupportedBootDevice)->Description);
 208
 209     DEBUG_CODE_BEGIN();
 210       CHAR16*                           DevicePathTxt;
 211       EFI_DEVICE_PATH_TO_TEXT_PROTOCOL* DevicePathToTextProtocol;
 212
 213       Status = gBS->LocateProtocol (&gEfiDevicePathToTextProtocolGuid, NULL, (VOID **)&DevicePathToTextProtocol);
 214       ASSERT_EFI_ERROR(Status);
 215       DevicePathTxt = DevicePathToTextProtocol->ConvertDevicePathToText ((*SupportedBootDevice)->DevicePathProtocol,TRUE,TRUE);
 216
 217       Print(L"\t- %s\n",DevicePathTxt);
 218
 219       FreePool(DevicePathTxt);
 220     DEBUG_CODE_END();
 221
 222     SupportedDeviceCount++;
 223   }
 224
 225   if (SupportedDeviceCount == 0) {
 226     Print(L"There is no supported device.\n");
 227     Status = EFI_ABORTED;
 228     goto EXIT;
 229   }
 230
 231   //
 232   // Select the Boot Device
 233   //
 234   SupportedDeviceSelected = 0;
 235   while (SupportedDeviceSelected == 0) {
 236     Print(L"Select the Boot Device: ");
 237     Status = GetHIInputInteger (&SupportedDeviceSelected);
 238     if (EFI_ERROR(Status)) {
 239       Status = EFI_ABORTED;
 240       goto EXIT;
 241     } else if ((SupportedDeviceSelected == 0) || (SupportedDeviceSelected > SupportedDeviceCount)) {
 242       Print(L"Invalid input (max %d)\n",SupportedDeviceCount);
 243       SupportedDeviceSelected = 0;
 244     }
 245   }
 246
 247   //
 248   // Get the Device Path for the selected boot device
 249   //
 250   Index = 1;
 251   for (Entry = GetFirstNode (&SupportedDeviceList);
 252        !IsNull (&SupportedDeviceList,Entry);
 253        Entry = GetNextNode (&SupportedDeviceList,Entry)
 254        )
 255   {
 256     if (Index == SupportedDeviceSelected) {
 257       *SupportedBootDevice = SUPPORTED_BOOT_DEVICE_FROM_LINK(Entry);
 258       break;
 259     }
 260     Index++;
 261   }
 262
 263 EXIT:
 264   BootDeviceListSupportedFree (&SupportedDeviceList, *SupportedBootDevice);
 265   return Status;
 266 }
 267
 268 EFI_STATUS
 269 BootMenuAddBootOption (
 270   IN LIST_ENTRY *BootOptionsList
 271   )
 272 {
 273   EFI_STATUS                Status;
 274   BDS_SUPPORTED_DEVICE*     SupportedBootDevice;
 275   ARM_BDS_LOADER_ARGUMENTS* BootArguments;
 276   CHAR16                    BootDescription[BOOT_DEVICE_DESCRIPTION_MAX];
 277   CHAR8                     AsciiCmdLine[BOOT_DEVICE_OPTION_MAX];
 278   CHAR16                    CmdLine[BOOT_DEVICE_OPTION_MAX];
 279   UINT32                    Attributes;
 280   ARM_BDS_LOADER_TYPE       BootType;
 281   BDS_LOAD_OPTION_ENTRY     *BdsLoadOptionEntry;
 282   EFI_DEVICE_PATH           *DevicePath;
 283   EFI_DEVICE_PATH_PROTOCOL  *DevicePathNodes;
 284   EFI_DEVICE_PATH_PROTOCOL  *InitrdPathNodes;
 285   EFI_DEVICE_PATH_PROTOCOL  *InitrdPath;
 286   UINTN                     CmdLineSize;
 287   BOOLEAN                   InitrdSupport;
 288   UINTN                     InitrdSize;
 289   UINT8*                    OptionalData;
 290   UINTN                     OptionalDataSize;
 291
 292   Attributes                = 0;
 293   SupportedBootDevice = NULL;
 294
 295   // List the Boot Devices supported
 296   Status = SelectBootDevice (&SupportedBootDevice);
 297   if (EFI_ERROR(Status)) {
 298     Status = EFI_ABORTED;
 299     goto EXIT;
 300   }
 301
 302   // Create the specific device path node
 303   Status = SupportedBootDevice->Support->CreateDevicePathNode (L"EFI Application or the kernel", &DevicePathNodes);
 304   if (EFI_ERROR(Status)) {
 305     Status = EFI_ABORTED;
 306     goto EXIT;
 307   }
 308   // Append the Device Path to the selected device path
 309   DevicePath = AppendDevicePath (SupportedBootDevice->DevicePathProtocol, (CONST EFI_DEVICE_PATH_PROTOCOL *)DevicePathNodes);
 310   if (DevicePath == NULL) {
 311     Status = EFI_OUT_OF_RESOURCES;
 312     goto EXIT;
 313   }
 314
 315   if (SupportedBootDevice->Support->RequestBootType) {
 316     Status = BootDeviceGetType (DevicePath, &BootType, &Attributes);
 317     if (EFI_ERROR(Status)) {
 318       Status = EFI_ABORTED;
 319       goto EXIT;
 320     }
 321   } else {
 322     BootType = BDS_LOADER_EFI_APPLICATION;
 323   }
 324
 325   if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {
 326     Print(L"Add an initrd: ");
 327     Status = GetHIInputBoolean (&InitrdSupport);
 328     if (EFI_ERROR(Status)) {
 329       Status = EFI_ABORTED;
 330       goto EXIT;
 331     }
 332
 333     if (InitrdSupport) {
 334       // Create the specific device path node
 335       Status = SupportedBootDevice->Support->CreateDevicePathNode (L"initrd", &InitrdPathNodes);
 336       if (EFI_ERROR(Status) && Status != EFI_NOT_FOUND) { // EFI_NOT_FOUND is returned on empty input string, but we can boot without an initrd
 337         Status = EFI_ABORTED;
 338         goto EXIT;
 339       }
 340
 341       if (InitrdPathNodes != NULL) {
 342         // Append the Device Path to the selected device path
 343         InitrdPath = AppendDevicePath (SupportedBootDevice->DevicePathProtocol, (CONST EFI_DEVICE_PATH_PROTOCOL *)InitrdPathNodes);
 344         if (InitrdPath == NULL) {
 345           Status = EFI_OUT_OF_RESOURCES;
 346           goto EXIT;
 347         }
 348       } else {
 349         InitrdPath = NULL;
 350       }
 351     } else {
 352       InitrdPath = NULL;
 353     }
 354
 355     Print(L"Arguments to pass to the binary: ");
 356     Status = GetHIInputAscii (AsciiCmdLine, BOOT_DEVICE_OPTION_MAX);
 357     if (EFI_ERROR(Status)) {
 358       Status = EFI_ABORTED;
 359       goto FREE_DEVICE_PATH;
 360     }
 361
 362     CmdLineSize = AsciiStrSize (AsciiCmdLine);
 363     InitrdSize = GetDevicePathSize (InitrdPath);
 364
 365     OptionalDataSize = sizeof(ARM_BDS_LOADER_ARGUMENTS) + CmdLineSize + InitrdSize;
 366     BootArguments = (ARM_BDS_LOADER_ARGUMENTS*)AllocatePool (OptionalDataSize);
 367
 368     BootArguments->LinuxArguments.CmdLineSize = CmdLineSize;
 369     BootArguments->LinuxArguments.InitrdSize = InitrdSize;
 370     CopyMem ((VOID*)(&BootArguments->LinuxArguments + 1), AsciiCmdLine, CmdLineSize);
 371     CopyMem ((VOID*)((UINTN)(&BootArguments->LinuxArguments + 1) + CmdLineSize), InitrdPath, InitrdSize);
 372
 373     OptionalData = (UINT8*)BootArguments;
 374   } else {
 375     Print (L"Arguments to pass to the EFI Application: ");
 376     Status = GetHIInputStr (CmdLine, BOOT_DEVICE_OPTION_MAX);
 377     if (EFI_ERROR (Status)) {
 378       Status = EFI_ABORTED;
 379       goto EXIT;
 380     }
 381
 382     OptionalData = (UINT8*)CmdLine;
 383     OptionalDataSize = StrSize (CmdLine);
 384   }
 385
 386   Print(L"Description for this new Entry: ");
 387   Status = GetHIInputStr (BootDescription, BOOT_DEVICE_DESCRIPTION_MAX);
 388   if (EFI_ERROR(Status)) {
 389     Status = EFI_ABORTED;
 390     goto FREE_DEVICE_PATH;
 391   }
 392
 393   // Create new entry
 394   BdsLoadOptionEntry = (BDS_LOAD_OPTION_ENTRY*)AllocatePool (sizeof(BDS_LOAD_OPTION_ENTRY));
 395   Status = BootOptionCreate (Attributes, BootDescription, DevicePath, BootType, OptionalData, OptionalDataSize, &BdsLoadOptionEntry->BdsLoadOption);
 396   if (!EFI_ERROR(Status)) {
 397     InsertTailList (BootOptionsList, &BdsLoadOptionEntry->Link);
 398   }
 399
 400 FREE_DEVICE_PATH:
 401   FreePool (DevicePath);
 402
 403 EXIT:
 404   if (Status == EFI_ABORTED) {
 405     Print(L"\n");
 406   }
 407   FreePool(SupportedBootDevice);
 408   return Status;
 409 }
 410
 411 EFI_STATUS
 412 BootMenuRemoveBootOption (
 413   IN LIST_ENTRY *BootOptionsList
 414   )
 415 {
 416   EFI_STATUS                    Status;
 417   BDS_LOAD_OPTION_ENTRY*        BootOptionEntry;
 418
 419   DisplayBootOptions (BootOptionsList);
 420   Status = SelectBootOption (BootOptionsList, DELETE_BOOT_ENTRY, &BootOptionEntry);
 421   if (EFI_ERROR (Status)) {
 422     return Status;
 423   }
 424
 425   // If the Boot Option was attached to a list remove it
 426   if (!IsListEmpty (&BootOptionEntry->Link)) {
 427     // Remove the entry from the list
 428     RemoveEntryList (&BootOptionEntry->Link);
 429   }
 430
 431   // Delete the BDS Load option structures
 432   BootOptionDelete (BootOptionEntry->BdsLoadOption);
 433
 434   return EFI_SUCCESS;
 435 }
 436
 437 EFI_STATUS
 438 BootMenuUpdateBootOption (
 439   IN LIST_ENTRY *BootOptionsList
 440   )
 441 {
 442   EFI_STATUS                    Status;
 443   BDS_LOAD_OPTION_ENTRY         *BootOptionEntry;
 444   BDS_LOAD_OPTION               *BootOption;
 445   BDS_LOAD_OPTION_SUPPORT*      DeviceSupport;
 446   ARM_BDS_LOADER_ARGUMENTS*     BootArguments;
 447   CHAR16                        BootDescription[BOOT_DEVICE_DESCRIPTION_MAX];
 448   CHAR8                         CmdLine[BOOT_DEVICE_OPTION_MAX];
 449   CHAR16                        UnicodeCmdLine[BOOT_DEVICE_OPTION_MAX];
 450   EFI_DEVICE_PATH               *DevicePath;
 451   EFI_DEVICE_PATH               *TempInitrdPath;
 452   ARM_BDS_LOADER_TYPE           BootType;
 453   ARM_BDS_LOADER_OPTIONAL_DATA* LoaderOptionalData;
 454   ARM_BDS_LINUX_ARGUMENTS*      LinuxArguments;
 455   EFI_DEVICE_PATH               *InitrdPathNodes;
 456   EFI_DEVICE_PATH               *InitrdPath;
 457   UINTN                         InitrdSize;
 458   UINTN                         CmdLineSize;
 459   BOOLEAN                       InitrdSupport;
 460   UINT8*                        OptionalData;
 461   UINTN                         OptionalDataSize;
 462   BOOLEAN                       IsPrintable;
 463   BOOLEAN                       IsUnicode;
 464
 465   DisplayBootOptions (BootOptionsList);
 466   Status = SelectBootOption (BootOptionsList, UPDATE_BOOT_ENTRY, &BootOptionEntry);
 467   if (EFI_ERROR (Status)) {
 468     return Status;
 469   }
 470   BootOption = BootOptionEntry->BdsLoadOption;
 471
 472   // Get the device support for this Boot Option
 473   Status = BootDeviceGetDeviceSupport (BootOption->FilePathList, &DeviceSupport);
 474   if (EFI_ERROR(Status)) {
 475     Print(L"Not possible to retrieve the supported device for the update\n");
 476     return EFI_UNSUPPORTED;
 477   }
 478
 479   Status = DeviceSupport->UpdateDevicePathNode (BootOption->FilePathList, L"EFI Application or the kernel", &DevicePath);
 480   if (EFI_ERROR(Status)) {
 481     Status = EFI_ABORTED;
 482     goto EXIT;
 483   }
 484
 485   if (DeviceSupport->RequestBootType) {
 486     Status = BootDeviceGetType (DevicePath, &BootType, &BootOption->Attributes);
 487     if (EFI_ERROR(Status)) {
 488       Status = EFI_ABORTED;
 489       goto EXIT;
 490     }
 491   }
 492
 493   LoaderOptionalData = BootOption->OptionalData;
 494   if (LoaderOptionalData != NULL) {
 495     BootType = (ARM_BDS_LOADER_TYPE)ReadUnaligned32 ((UINT32 *)(&LoaderOptionalData->Header.LoaderType));
 496   } else {
 497     BootType = BDS_LOADER_EFI_APPLICATION;
 498   }
 499
 500   if ((BootType == BDS_LOADER_KERNEL_LINUX_ATAG) || (BootType == BDS_LOADER_KERNEL_LINUX_FDT)) {
 501     LinuxArguments = &LoaderOptionalData->Arguments.LinuxArguments;
 502
 503     CmdLineSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->CmdLineSize);
 504
 505     InitrdSize = ReadUnaligned16 ((CONST UINT16*)&LinuxArguments->InitrdSize);
 506     if (InitrdSize > 0) {
 507       Print(L"Keep the initrd: ");
 508     } else {
 509       Print(L"Add an initrd: ");
 510     }
 511     Status = GetHIInputBoolean (&InitrdSupport);
 512     if (EFI_ERROR(Status)) {
 513       Status = EFI_ABORTED;
 514       goto EXIT;
 515     }
 516
 517     if (InitrdSupport) {
 518       if (InitrdSize > 0) {
 519         // Case we update the initrd device path
 520         Status = DeviceSupport->UpdateDevicePathNode ((EFI_DEVICE_PATH*)((UINTN)(LinuxArguments + 1) + CmdLineSize), L"initrd", &InitrdPath);
 521         if (EFI_ERROR(Status) && Status != EFI_NOT_FOUND) {// EFI_NOT_FOUND is returned on empty input string, but we can boot without an initrd
 522           Status = EFI_ABORTED;
 523           goto EXIT;
 524         }
 525         InitrdSize = GetDevicePathSize (InitrdPath);
 526       } else {
 527         // Case we create the initrd device path
 528
 529         Status = DeviceSupport->CreateDevicePathNode (L"initrd", &InitrdPathNodes);
 530         if (EFI_ERROR(Status) && Status != EFI_NOT_FOUND) { // EFI_NOT_FOUND is returned on empty input string, but we can boot without an initrd
 531           Status = EFI_ABORTED;
 532           goto EXIT;
 533         }
 534
 535         if (InitrdPathNodes != NULL) {
 536           // Duplicate Linux kernel Device Path
 537           TempInitrdPath = DuplicateDevicePath (BootOption->FilePathList);
 538           // Replace Linux kernel Node by EndNode
 539           SetDevicePathEndNode (GetLastDevicePathNode (TempInitrdPath));
 540           // Append the Device Path to the selected device path
 541           InitrdPath = AppendDevicePath (TempInitrdPath, (CONST EFI_DEVICE_PATH_PROTOCOL *)InitrdPathNodes);
 542           FreePool (TempInitrdPath);
 543           if (InitrdPath == NULL) {
 544             Status = EFI_OUT_OF_RESOURCES;
 545             goto EXIT;
 546           }
 547           InitrdSize = GetDevicePathSize (InitrdPath);
 548         } else {
 549           InitrdPath = NULL;
 550         }
 551       }
 552     } else {
 553       InitrdSize = 0;
 554     }
 555
 556     Print(L"Arguments to pass to the binary: ");
 557     if (CmdLineSize > 0) {
 558       AsciiStrnCpy(CmdLine, (CONST CHAR8*)(LinuxArguments + 1), CmdLineSize);
 559     } else {
 560       CmdLine[0] = '\0';
 561     }
 562     Status = EditHIInputAscii (CmdLine, BOOT_DEVICE_OPTION_MAX);
 563     if (EFI_ERROR(Status)) {
 564       Status = EFI_ABORTED;
 565       goto FREE_DEVICE_PATH;
 566     }
 567
 568     CmdLineSize = AsciiStrSize (CmdLine);
 569
 570     OptionalDataSize = sizeof(ARM_BDS_LOADER_ARGUMENTS) + CmdLineSize + InitrdSize;
 571     BootArguments = (ARM_BDS_LOADER_ARGUMENTS*)AllocatePool (OptionalDataSize);
 572     BootArguments->LinuxArguments.CmdLineSize = CmdLineSize;
 573     BootArguments->LinuxArguments.InitrdSize = InitrdSize;
 574     CopyMem (&BootArguments->LinuxArguments + 1, CmdLine, CmdLineSize);
 575     CopyMem ((VOID*)((UINTN)(&BootArguments->LinuxArguments + 1) + CmdLineSize), InitrdPath, InitrdSize);
 576
 577     OptionalData = (UINT8*)BootArguments;
 578   } else {
 579     Print (L"Arguments to pass to the EFI Application: ");
 580
 581     if (BootOption->OptionalDataSize > 0) {
 582       IsPrintable = IsPrintableString (BootOption->OptionalData, &IsUnicode);
 583       if (IsPrintable) {
 584         if (IsUnicode) {
 585           StrnCpy (UnicodeCmdLine, BootOption->OptionalData, BootOption->OptionalDataSize / 2);
 586         } else {
 587           AsciiStrnCpy (CmdLine, BootOption->OptionalData, BootOption->OptionalDataSize);
 588         }
 589       }
 590     } else {
 591       UnicodeCmdLine[0] = L'\0';
 592       IsPrintable = TRUE;
 593       IsUnicode = TRUE;
 594     }
 595
 596     // We do not request arguments for OptionalData that cannot be printed
 597     if (IsPrintable) {
 598       if (IsUnicode) {
 599         Status = EditHIInputStr (UnicodeCmdLine, BOOT_DEVICE_OPTION_MAX);
 600         if (EFI_ERROR (Status)) {
 601           Status = EFI_ABORTED;
 602           goto FREE_DEVICE_PATH;
 603         }
 604
 605         OptionalData = (UINT8*)UnicodeCmdLine;
 606         OptionalDataSize = StrSize (UnicodeCmdLine);
 607       } else {
 608         Status = EditHIInputAscii (CmdLine, BOOT_DEVICE_OPTION_MAX);
 609         if (EFI_ERROR (Status)) {
 610           Status = EFI_ABORTED;
 611           goto FREE_DEVICE_PATH;
 612         }
 613
 614         OptionalData = (UINT8*)CmdLine;
 615         OptionalDataSize = AsciiStrSize (CmdLine);
 616       }
 617     } else {
 618       // We keep the former OptionalData
 619       OptionalData = BootOption->OptionalData;
 620       OptionalDataSize = BootOption->OptionalDataSize;
 621     }
 622   }
 623
 624   Print(L"Description for this new Entry: ");
 625   StrnCpy (BootDescription, BootOption->Description, BOOT_DEVICE_DESCRIPTION_MAX);
 626   Status = EditHIInputStr (BootDescription, BOOT_DEVICE_DESCRIPTION_MAX);
 627   if (EFI_ERROR(Status)) {
 628     Status = EFI_ABORTED;
 629     goto FREE_DEVICE_PATH;
 630   }
 631
 632   // Update the entry
 633   Status = BootOptionUpdate (BootOption, BootOption->Attributes, BootDescription, DevicePath, BootType, OptionalData, OptionalDataSize);
 634
 635 FREE_DEVICE_PATH:
 636   FreePool (DevicePath);
 637
 638 EXIT:
 639   if (Status == EFI_ABORTED) {
 640     Print(L"\n");
 641   }
 642   return Status;
 643 }
 644
 645 /**
 646   Reorder boot options
 647
 648   Ask for the boot option to move and then move it when up or down arrows
 649   are pressed. This function is called when the user selects the "Reorder Boot
 650   Device Entries" entry in the boot manager menu.
 651   The order of the boot options in BootOptionList and in the UEFI BootOrder
 652   global variable are kept coherent until the user confirm his reordering (ie:
 653   he does not exit by pressing escape).
 654
 655   @param[in]  BootOptionsList  List of the boot devices constructed in
 656                                BootMenuMain()
 657
 658   @retval  EFI_SUCCESS   No error encountered.
 659   @retval  !EFI_SUCCESS  An error has occured either in the selection of the
 660                          boot option to move or while interacting with the user.
 661
 662 **/
 663 STATIC
 664 EFI_STATUS
 665 BootMenuReorderBootOptions (
 666   IN LIST_ENTRY *BootOptionsList
 667   )
 668 {
 669   EFI_STATUS              Status;
 670   BDS_LOAD_OPTION_ENTRY  *BootOptionEntry;
 671   LIST_ENTRY             *SelectedEntry;
 672   LIST_ENTRY             *PrevEntry;
 673   BOOLEAN                 Move;
 674   BOOLEAN                 Save;
 675   BOOLEAN                 Cancel;
 676   UINTN                   WaitIndex;
 677   EFI_INPUT_KEY           Key;
 678   LIST_ENTRY             *SecondEntry;
 679   UINTN                   BootOrderSize;
 680   UINT16                 *BootOrder;
 681   LIST_ENTRY             *Entry;
 682   UINTN                   Index;
 683
 684   DisplayBootOptions (BootOptionsList);
 685
 686   // Ask to select the boot option to move
 687   while (TRUE) {
 688     Status = SelectBootOption (BootOptionsList, MOVE_BOOT_ENTRY, &BootOptionEntry);
 689     if (EFI_ERROR (Status)) {
 690       goto ErrorExit;
 691     }
 692
 693     SelectedEntry = &BootOptionEntry->Link;
 694     // Note down the previous entry in the list to be able to cancel changes
 695     PrevEntry = GetPreviousNode (BootOptionsList, SelectedEntry);
 696
 697     //  Start of interaction
 698     while (TRUE) {
 699       Print (
 700         L"* Use up/down arrows to move the entry '%s'",
 701         BootOptionEntry->BdsLoadOption->Description
 702         );
 703
 704       // Wait for a move, save or cancel request
 705       Move   = FALSE;
 706       Save   = FALSE;
 707       Cancel = FALSE;
 708       do {
 709         Status = gBS->WaitForEvent (1, &gST->ConIn->WaitForKey, &WaitIndex);
 710         if (!EFI_ERROR (Status)) {
 711           Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
 712         }
 713         if (EFI_ERROR (Status)) {
 714           Print (L"\n");
 715           goto ErrorExit;
 716         }
 717
 718         switch (Key.ScanCode) {
 719         case SCAN_NULL:
 720           Save = (Key.UnicodeChar == CHAR_LINEFEED)        ||
 721                  (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) ||
 722                  (Key.UnicodeChar == 0x7f);
 723           break;
 724
 725         case SCAN_UP:
 726           SecondEntry = GetPreviousNode (BootOptionsList, SelectedEntry);
 727           Move = SecondEntry != BootOptionsList;
 728           break;
 729
 730         case SCAN_DOWN:
 731           SecondEntry = GetNextNode (BootOptionsList, SelectedEntry);
 732           Move = SecondEntry != BootOptionsList;
 733           break;
 734
 735         case SCAN_ESC:
 736           Cancel = TRUE;
 737           break;
 738         }
 739       } while ((!Move) && (!Save) && (!Cancel));
 740
 741       if (Move) {
 742         SwapListEntries (SelectedEntry, SecondEntry);
 743       } else {
 744         if (Save) {
 745           Status = GetGlobalEnvironmentVariable (
 746                     L"BootOrder", NULL, &BootOrderSize, (VOID**)&BootOrder
 747                     );
 748           BootOrderSize /= sizeof (UINT16);
 749
 750           if (!EFI_ERROR (Status)) {
 751             // The order of the boot options in the 'BootOptionsList' is the
 752             // new order that has been just defined by the user. Save this new
 753             // order in "BootOrder" UEFI global variable.
 754             Entry = GetFirstNode (BootOptionsList);
 755             for (Index = 0; Index < BootOrderSize; Index++) {
 756               BootOrder[Index] = (LOAD_OPTION_FROM_LINK (Entry))->LoadOptionIndex;
 757               Entry = GetNextNode (BootOptionsList, Entry);
 758             }
 759             Status = gRT->SetVariable (
 760                            (CHAR16*)L"BootOrder",
 761                            &gEfiGlobalVariableGuid,
 762                            EFI_VARIABLE_NON_VOLATILE       |
 763                            EFI_VARIABLE_BOOTSERVICE_ACCESS |
 764                            EFI_VARIABLE_RUNTIME_ACCESS,
 765                            BootOrderSize * sizeof (UINT16),
 766                            BootOrder
 767                            );
 768             FreePool (BootOrder);
 769           }
 770
 771           if (EFI_ERROR (Status)) {
 772             Print (L"\nAn error occurred, move not completed!\n");
 773             Cancel = TRUE;
 774           }
 775         }
 776
 777         if (Cancel) {
 778           //
 779           // Restore initial position of the selected boot option
 780           //
 781           RemoveEntryList (SelectedEntry);
 782           InsertHeadList (PrevEntry, SelectedEntry);
 783         }
 784       }
 785
 786       Print (L"\n");
 787       DisplayBootOptions (BootOptionsList);
 788       // Saved or cancelled, back to the choice of boot option to move
 789       if (!Move) {
 790         break;
 791       }
 792     }
 793   }
 794
 795 ErrorExit:
 796   return Status ;
 797 }
 798
 799 EFI_STATUS
 800 UpdateFdtPath (
 801   IN LIST_ENTRY *BootOptionsList
 802   )
 803 {
 804   EFI_STATUS                Status;
 805   UINTN                     FdtDevicePathSize;
 806   BDS_SUPPORTED_DEVICE      *SupportedBootDevice;
 807   EFI_DEVICE_PATH_PROTOCOL  *FdtDevicePathNodes;
 808   EFI_DEVICE_PATH_PROTOCOL  *FdtDevicePath;
 809
 810   Status = SelectBootDevice (&SupportedBootDevice);
 811   if (EFI_ERROR(Status)) {
 812     Status = EFI_ABORTED;
 813     goto EXIT;
 814   }
 815
 816   // Create the specific device path node
 817   Status = SupportedBootDevice->Support->CreateDevicePathNode (L"FDT blob", &FdtDevicePathNodes);
 818   if (EFI_ERROR(Status)) {
 819     Status = EFI_ABORTED;
 820     goto EXIT;
 821   }
 822
 823   if (FdtDevicePathNodes != NULL) {
 824     // Append the Device Path node to the select device path
 825     FdtDevicePath = AppendDevicePath (SupportedBootDevice->DevicePathProtocol, FdtDevicePathNodes);
 826     FdtDevicePathSize = GetDevicePathSize (FdtDevicePath);
 827     Status = gRT->SetVariable (
 828                     (CHAR16*)L"Fdt",
 829                     &gArmGlobalVariableGuid,
 830                     EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
 831                     FdtDevicePathSize,
 832                     FdtDevicePath
 833                     );
 834     ASSERT_EFI_ERROR(Status);
 835   } else {
 836     gRT->SetVariable (
 837            (CHAR16*)L"Fdt",
 838            &gArmGlobalVariableGuid,
 839            EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
 840            0,
 841            NULL
 842            );
 843     ASSERT_EFI_ERROR(Status);
 844   }
 845
 846 EXIT:
 847   if (Status == EFI_ABORTED) {
 848     Print(L"\n");
 849   }
 850   FreePool(SupportedBootDevice);
 851   return Status;
 852 }
 853
 854 /**
 855   Set boot timeout
 856
 857   Ask for the boot timeout in seconds and if the input succeeds assign the
 858   input value to the UEFI global variable "Timeout". This function is called
 859   when the user selects the "Set Boot Timeout" of the boot manager menu.
 860
 861   @param[in]  BootOptionsList  List of the boot devices, not used here
 862
 863   @retval  EFI_SUCCESS   Boot timeout in second retrieved from the standard
 864                          input and assigned to the UEFI "Timeout" global
 865                          variable
 866   @retval  !EFI_SUCCESS  Either the input or the setting of the UEFI global
 867                          variable "Timeout" has failed.
 868 **/
 869 EFI_STATUS
 870 STATIC
 871 BootMenuSetBootTimeout (
 872   IN LIST_ENTRY *BootOptionsList
 873   )
 874 {
 875   EFI_STATUS  Status;
 876   UINTN       Input;
 877   UINT16      Timeout;
 878
 879   Print (L"Timeout duration (in seconds): ");
 880   Status = GetHIInputInteger (&Input);
 881   if (EFI_ERROR (Status)) {
 882     Print (L"\n");
 883     goto ErrorExit;
 884   }
 885
 886   Timeout = Input;
 887   Status = gRT->SetVariable (
 888                  (CHAR16*)L"Timeout",
 889                  &gEfiGlobalVariableGuid,
 890                  EFI_VARIABLE_NON_VOLATILE       |
 891                  EFI_VARIABLE_BOOTSERVICE_ACCESS |
 892                  EFI_VARIABLE_RUNTIME_ACCESS,
 893                  sizeof (UINT16),
 894                  &Timeout
 895                  );
 896   ASSERT_EFI_ERROR (Status);
 897
 898 ErrorExit:
 899   return Status;
 900 }
 901
 902 struct BOOT_MANAGER_ENTRY {
 903   CONST CHAR16* Description;
 904   EFI_STATUS (*Callback) (IN LIST_ENTRY *BootOptionsList);
 905 } BootManagerEntries[] = {
 906     { L"Add Boot Device Entry", BootMenuAddBootOption },
 907     { L"Update Boot Device Entry", BootMenuUpdateBootOption },
 908     { L"Remove Boot Device Entry", BootMenuRemoveBootOption },
 909     { L"Reorder Boot Device Entries", BootMenuReorderBootOptions },
 910     { L"Update FDT path", UpdateFdtPath },
 911     { L"Set Boot Timeout", BootMenuSetBootTimeout },
 912 };
 913
 914 EFI_STATUS
 915 BootMenuManager (
 916   IN LIST_ENTRY *BootOptionsList
 917   )
 918 {
 919   UINTN Index;
 920   UINTN OptionSelected;
 921   UINTN BootManagerEntryCount;
 922   EFI_STATUS Status;
 923
 924   BootManagerEntryCount = sizeof(BootManagerEntries) / sizeof(struct BOOT_MANAGER_ENTRY);
 925
 926   while (TRUE) {
 927     // Display Boot Manager menu
 928     for (Index = 0; Index < BootManagerEntryCount; Index++) {
 929       Print(L"[%d] %s\n",Index+1,BootManagerEntries[Index]);
 930     }
 931     Print(L"[%d] Return to main menu\n",Index+1);
 932
 933     // Select which entry to call
 934     Print(L"Choice: ");
 935     Status = GetHIInputInteger (&OptionSelected);
 936     if (EFI_ERROR(Status) || (OptionSelected == (BootManagerEntryCount+1))) {
 937       if (EFI_ERROR(Status)) {
 938         Print(L"\n");
 939       }
 940       return EFI_SUCCESS;
 941     } else if ((OptionSelected > 0) && (OptionSelected <= BootManagerEntryCount))  {
 942       BootManagerEntries[OptionSelected-1].Callback (BootOptionsList);
 943     }
 944   }
 945   // Should never go here
 946 }
 947
 948 EFI_STATUS
 949 BootShell (
 950   IN LIST_ENTRY *BootOptionsList
 951   )
 952 {
 953   EFI_STATUS Status;
 954
 955   // Start EFI Shell
 956   Status = BdsLoadApplication (gImageHandle, L"Shell", 0, NULL);
 957   if (Status == EFI_NOT_FOUND) {
 958     Print (L"Error: EFI Application not found.\n");
 959   } else if (EFI_ERROR(Status)) {
 960     Print (L"Error: Status Code: 0x%X\n",(UINT32)Status);
 961   }
 962
 963   return Status;
 964 }
 965
 966 struct BOOT_MAIN_ENTRY {
 967   CONST CHAR16* Description;
 968   EFI_STATUS (*Callback) (IN LIST_ENTRY *BootOptionsList);
 969 } BootMainEntries[] = {
 970     { L"Shell", BootShell },
 971     { L"Boot Manager", BootMenuManager },
 972 };
 973
 974
 975 EFI_STATUS
 976 BootMenuMain (
 977   VOID
 978   )
 979 {
 980   LIST_ENTRY                    BootOptionsList;
 981   UINTN                         OptionCount;
 982   UINTN                         BootOptionCount;
 983   EFI_STATUS                    Status;
 984   LIST_ENTRY*                   Entry;
 985   BDS_LOAD_OPTION*              BootOption;
 986   UINTN                         BootOptionSelected;
 987   UINTN                         Index;
 988   UINTN                         BootMainEntryCount;
 989   BOOLEAN                       IsUnicode;
 990
 991   BootOption         = NULL;
 992   BootMainEntryCount = sizeof(BootMainEntries) / sizeof(struct BOOT_MAIN_ENTRY);
 993
 994   while (TRUE) {
 995     // Get Boot#### list
 996     BootOptionList (&BootOptionsList);
 997
 998     OptionCount = 1;
 999
1000     // Display the Boot options
1001     for (Entry = GetFirstNode (&BootOptionsList);
1002          !IsNull (&BootOptionsList,Entry);
1003          Entry = GetNextNode (&BootOptionsList,Entry)
1004          )
1005     {
1006       BootOption = LOAD_OPTION_FROM_LINK(Entry);
1007
1008       Print(L"[%d] %s\n", OptionCount, BootOption->Description);
1009
1010       DEBUG_CODE_BEGIN();
1011         CHAR16*                           DevicePathTxt;
1012         EFI_DEVICE_PATH_TO_TEXT_PROTOCOL* DevicePathToTextProtocol;
1013         ARM_BDS_LOADER_OPTIONAL_DATA*     OptionalData;
1014         UINTN                             CmdLineSize;
1015         ARM_BDS_LOADER_TYPE               LoaderType;
1016
1017         Status = gBS->LocateProtocol (&gEfiDevicePathToTextProtocolGuid, NULL, (VOID **)&DevicePathToTextProtocol);
1018         if (EFI_ERROR(Status)) {
1019           // You must provide an implementation of DevicePathToTextProtocol in your firmware (eg: DevicePathDxe)
1020           DEBUG((EFI_D_ERROR,"Error: Bds requires DevicePathToTextProtocol\n"));
1021           return Status;
1022         }
1023         DevicePathTxt = DevicePathToTextProtocol->ConvertDevicePathToText (BootOption->FilePathList, TRUE, TRUE);
1024
1025         Print(L"\t- %s\n",DevicePathTxt);
1026
1027         // If it is a supported BootEntry then print its details
1028         if (IS_ARM_BDS_BOOTENTRY (BootOption)) {
1029           OptionalData = BootOption->OptionalData;
1030           LoaderType = (ARM_BDS_LOADER_TYPE)ReadUnaligned32 ((CONST UINT32*)&OptionalData->Header.LoaderType);
1031           if ((LoaderType == BDS_LOADER_KERNEL_LINUX_ATAG) || (LoaderType == BDS_LOADER_KERNEL_LINUX_FDT)) {
1032             if (ReadUnaligned16 (&OptionalData->Arguments.LinuxArguments.InitrdSize) > 0) {
1033               CmdLineSize = ReadUnaligned16 (&OptionalData->Arguments.LinuxArguments.CmdLineSize);
1034               DevicePathTxt = DevicePathToTextProtocol->ConvertDevicePathToText (
1035                   GetAlignedDevicePath ((EFI_DEVICE_PATH*)((UINTN)(&OptionalData->Arguments.LinuxArguments + 1) + CmdLineSize)), TRUE, TRUE);
1036               Print(L"\t- Initrd: %s\n", DevicePathTxt);
1037             }
1038             if (ReadUnaligned16 (&OptionalData->Arguments.LinuxArguments.CmdLineSize) > 0) {
1039               Print(L"\t- Arguments: %a\n", (&OptionalData->Arguments.LinuxArguments + 1));
1040             }
1041           }
1042
1043           switch (LoaderType) {
1044             case BDS_LOADER_EFI_APPLICATION:
1045               Print(L"\t- LoaderType: EFI Application\n");
1046               break;
1047
1048             case BDS_LOADER_KERNEL_LINUX_ATAG:
1049               Print(L"\t- LoaderType: Linux kernel with ATAG support\n");
1050               break;
1051
1052             case BDS_LOADER_KERNEL_LINUX_FDT:
1053               Print(L"\t- LoaderType: Linux kernel with FDT support\n");
1054               break;
1055
1056             default:
1057               Print(L"\t- LoaderType: Not recognized (%d)\n", LoaderType);
1058           }
1059         } else if (BootOption->OptionalData != NULL) {
1060           if (IsPrintableString (BootOption->OptionalData, &IsUnicode)) {
1061             if (IsUnicode) {
1062               Print (L"\t- Arguments: %s\n", BootOption->OptionalData);
1063             } else {
1064               AsciiPrint ("\t- Arguments: %a\n", BootOption->OptionalData);
1065             }
1066           }
1067         }
1068         FreePool(DevicePathTxt);
1069       DEBUG_CODE_END();
1070
1071       OptionCount++;
1072     }
1073     BootOptionCount = OptionCount-1;
1074
1075     // Display the hardcoded Boot entries
1076     for (Index = 0; Index < BootMainEntryCount; Index++) {
1077       Print(L"[%d] %s\n",OptionCount,BootMainEntries[Index]);
1078       OptionCount++;
1079     }
1080
1081     // Request the boot entry from the user
1082     BootOptionSelected = 0;
1083     while (BootOptionSelected == 0) {
1084       Print(L"Start: ");
1085       Status = GetHIInputInteger (&BootOptionSelected);
1086       if (EFI_ERROR(Status) || (BootOptionSelected == 0) || (BootOptionSelected > OptionCount)) {
1087         Print(L"Invalid input (max %d)\n",(OptionCount-1));
1088         BootOptionSelected = 0;
1089       }
1090     }
1091
1092     // Start the selected entry
1093     if (BootOptionSelected > BootOptionCount) {
1094       // Start the hardcoded entry
1095       Status = BootMainEntries[BootOptionSelected - BootOptionCount - 1].Callback (&BootOptionsList);
1096     } else {
1097       // Find the selected entry from the Boot#### list
1098       Index = 1;
1099       for (Entry = GetFirstNode (&BootOptionsList);
1100            !IsNull (&BootOptionsList,Entry);
1101            Entry = GetNextNode (&BootOptionsList,Entry)
1102            )
1103       {
1104         if (Index == BootOptionSelected) {
1105           BootOption = LOAD_OPTION_FROM_LINK(Entry);
1106           break;
1107         }
1108         Index++;
1109       }
1110
1111       Status = BootOptionStart (BootOption);
1112     }
1113   }
1114   // Should never go here
1115 }