BeagleBoardPkg/Bds/BdsEntry.c

   1 /** @file
   2   The entry of the embedded BDS. This BDS does not follow the Boot Manager requirements
   3   of the UEFI specification as it is designed to implement an embedded systmes
   4   propriatary boot scheme.
   5
   6   This template assume a DXE driver produces a SerialIo protocol not using the EFI
   7   driver module and it will attempt to connect a console on top of this.
   8
   9   Copyright (c) 2008-2009, Apple Inc. All rights reserved.
  10
  11   All rights reserved. This program and the accompanying materials
  12   are licensed and made available under the terms and conditions of the BSD License
  13   which accompanies this distribution.  The full text of the license may be found at
  14   http://opensource.org/licenses/bsd-license.php
  15
  16   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  17   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  18
  19 **/
  20
  21 #include "BdsEntry.h"
  22
  23
  24 BOOLEAN     gConsolePresent = FALSE;
  25
  26
  27 EFI_HANDLE  mBdsImageHandle = NULL;
  28 EFI_BDS_ARCH_PROTOCOL  gBdsProtocol = {
  29   BdsEntry,
  30 };
  31
  32
  33
  34
  35 /**
  36   This function uses policy data from the platform to determine what operating
  37   system or system utility should be loaded and invoked.  This function call
  38   also optionally make the use of user input to determine the operating system
  39   or system utility to be loaded and invoked.  When the DXE Core has dispatched
  40   all the drivers on the dispatch queue, this function is called.  This
  41   function will attempt to connect the boot devices required to load and invoke
  42   the selected operating system or system utility.  During this process,
  43   additional firmware volumes may be discovered that may contain addition DXE
  44   drivers that can be dispatched by the DXE Core.   If a boot device cannot be
  45   fully connected, this function calls the DXE Service Dispatch() to allow the
  46   DXE drivers from any newly discovered firmware volumes to be dispatched.
  47   Then the boot device connection can be attempted again.  If the same boot
  48   device connection operation fails twice in a row, then that boot device has
  49   failed, and should be skipped.  This function should never return.
  50
  51   @param  This             The EFI_BDS_ARCH_PROTOCOL instance.
  52
  53   @return None.
  54
  55 **/
  56 VOID
  57 EFIAPI
  58 BdsEntry (
  59   IN EFI_BDS_ARCH_PROTOCOL  *This
  60   )
  61 {
  62   EFI_STATUS                Status;
  63   UINTN                     NoHandles;
  64   EFI_HANDLE                *Buffer;
  65   EFI_HANDLE                FvHandle;
  66   EFI_HANDLE                ImageHandle;
  67   EFI_HANDLE                UsbDeviceHandle;
  68   EFI_GUID                  NameGuid;
  69   UINTN                     Size;
  70   UINTN                     HandleCount;
  71   UINTN                     OldHandleCount;
  72   EFI_HANDLE                *HandleBuffer;
  73   UINTN                     Index;
  74   EFI_DEVICE_PATH_PROTOCOL  *LoadImageDevicePath;
  75   EFI_DEVICE_PATH_PROTOCOL  *FileSystemDevicePath;
  76
  77   //
  78   // Now do the EFI stuff
  79   //
  80   Size = 0x100;
  81   gST->FirmwareVendor = AllocateRuntimePool (Size);
  82   ASSERT (gST->FirmwareVendor != NULL);
  83
  84   UnicodeSPrint (gST->FirmwareVendor, Size, L"BeagleBoard EFI %a %a", __DATE__, __TIME__);
  85
  86   //
  87   // Now we need to setup the EFI System Table with information about the console devices.
  88   // This code is normally in the console spliter driver on platforms that support multiple
  89   // consoles at the same time
  90   //
  91   Status = gBS->LocateHandleBuffer (ByProtocol, &gEfiSimpleTextOutProtocolGuid, NULL, &NoHandles, &Buffer);
  92   if (!EFI_ERROR (Status)) {
  93     // Use the first SimpleTextOut we find and update the EFI System Table
  94     gST->ConsoleOutHandle = Buffer[0];
  95     gST->StandardErrorHandle = Buffer[0];
  96     Status = gBS->HandleProtocol (Buffer[0], &gEfiSimpleTextOutProtocolGuid, (VOID **)&gST->ConOut);
  97     ASSERT_EFI_ERROR (Status);
  98
  99     gST->StdErr = gST->ConOut;
 100
 101     gST->ConOut->OutputString (gST->ConOut, L"BDS: Console Started!!!!\n\r");
 102     FreePool (Buffer);
 103
 104     gConsolePresent = TRUE;
 105   }
 106
 107
 108   Status = gBS->LocateHandleBuffer (ByProtocol, &gEfiSimpleTextInProtocolGuid, NULL, &NoHandles, &Buffer);
 109   if (!EFI_ERROR (Status)) {
 110     // Use the first SimpleTextIn we find and update the EFI System Table
 111     gST->ConsoleInHandle = Buffer[0];
 112     Status = gBS->HandleProtocol (Buffer[0], &gEfiSimpleTextInProtocolGuid, (VOID **)&gST->ConIn);
 113     ASSERT_EFI_ERROR (Status);
 114
 115     FreePool (Buffer);
 116   }
 117
 118   //
 119   // We now have EFI Consoles up and running. Print () will work now. DEBUG () and ASSERT () worked
 120   // prior to this point as they were configured to use a more primative output scheme.
 121   //
 122
 123   //
 124   //Perform Connect
 125   //
 126   HandleCount = 0;
 127   while (1) {
 128     OldHandleCount = HandleCount;
 129     Status = gBS->LocateHandleBuffer (
 130                     AllHandles,
 131                     NULL,
 132                     NULL,
 133                     &HandleCount,
 134                     &HandleBuffer
 135                     );
 136     if (EFI_ERROR (Status)) {
 137       break;
 138     }
 139
 140     if (HandleCount == OldHandleCount) {
 141       break;
 142     }
 143
 144     for (Index = 0; Index < HandleCount; Index++) {
 145       gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);
 146     }
 147   }
 148
 149   //Locate handles for SimpleFileSystem protocol
 150   Status = gBS->LocateHandleBuffer (
 151                   ByProtocol,
 152                   &gEfiSimpleFileSystemProtocolGuid,
 153                   NULL,
 154                   &HandleCount,
 155                   &HandleBuffer
 156                   );
 157   if (!EFI_ERROR(Status)) {
 158     for (Index = 0; Index < HandleCount; Index++) {
 159       //Get the device path
 160       FileSystemDevicePath = DevicePathFromHandle(HandleBuffer[Index]);
 161       if (FileSystemDevicePath == NULL) {
 162         continue;
 163       }
 164
 165       //Check if UsbIo is on any handles in the device path.
 166       Status = gBS->LocateDevicePath(&gEfiUsbIoProtocolGuid, &FileSystemDevicePath, &UsbDeviceHandle);
 167       if (EFI_ERROR(Status)) {
 168         continue;
 169       }
 170
 171       //Check if Usb stick has a magic EBL file.
 172       LoadImageDevicePath = FileDevicePath(HandleBuffer[Index], L"Ebl.efi");
 173       Status = gBS->LoadImage (TRUE, gImageHandle, LoadImageDevicePath, NULL, 0, &ImageHandle);
 174       if (EFI_ERROR(Status)) {
 175         continue;
 176       }
 177
 178       //Boot to Shell on USB stick.
 179       Status = gBS->StartImage (ImageHandle, NULL, NULL);
 180       if (EFI_ERROR(Status)) {
 181         continue;
 182       }
 183     }
 184   }
 185
 186   //
 187   // Normal UEFI behavior is to process Globally Defined Variables as defined in Chapter 3
 188   // (Boot Manager) of the UEFI specification. For this embedded system we don't do this.
 189   //
 190
 191   //
 192   // Search all the FVs for an application with a UI Section of Ebl. A .FDF file can be used
 193   // to control the names of UI sections in an FV.
 194   //
 195   Status = FindApplicationMatchingUiSection (L"Ebl", &FvHandle, &NameGuid);
 196   if (!EFI_ERROR (Status)) {
 197
 198     //Boot to Shell.
 199     Status = LoadPeCoffSectionFromFv (FvHandle, &NameGuid);
 200
 201     if (EFI_ERROR(Status)) {
 202       DEBUG((EFI_D_ERROR, "Boot from Shell failed. Status: %r\n", Status));
 203     }
 204   }
 205
 206   //
 207   // EFI does not define the behaviour if all boot attemps fail and the last one returns.
 208   // So we make a policy choice to reset the system since this BDS does not have a UI.
 209   //
 210   gRT->ResetSystem (EfiResetShutdown, Status, 0, NULL);
 211
 212   return ;
 213 }
 214
 215
 216 EFI_STATUS
 217 EFIAPI
 218 BdsInitialize (
 219   IN EFI_HANDLE                            ImageHandle,
 220   IN EFI_SYSTEM_TABLE                      *SystemTable
 221   )
 222 {
 223   EFI_STATUS  Status;
 224
 225   mBdsImageHandle = ImageHandle;
 226
 227   //
 228   // Install protocol interface
 229   //
 230   Status = gBS->InstallMultipleProtocolInterfaces (
 231                   &mBdsImageHandle,
 232                   &gEfiBdsArchProtocolGuid, &gBdsProtocol,
 233                   NULL
 234                   );
 235   ASSERT_EFI_ERROR (Status);
 236
 237   return Status;
 238 }
 239
 240