audk/ArmEbPkg/Sec/Sec.c

/** @file
  C Entry point for the SEC. First C code after the reset vector.

  Copyright (c) 2008-2009, Apple Inc. All rights reserved.
  
  All rights reserved. This program and the accompanying materials
  are licensed and made available under the terms and conditions of the BSD License
  which accompanies this distribution.  The full text of the license may be found at
  http://opensource.org/licenses/bsd-license.php

  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

**/

#include <PiPei.h>

#include <Library/DebugLib.h>
#include <Library/PrePiLib.h>
#include <Library/PcdLib.h>
#include <Library/IoLib.h>
#include <Library/ArmLib.h>
#include <Library/PeCoffGetEntryPointLib.h>

#include <Ppi/GuidedSectionExtraction.h>
#include <Guid/LzmaDecompress.h>

#include "LzmaDecompress.h"

VOID
EFIAPI 
_ModuleEntryPoint(
  VOID
  );

CHAR8 *
DeCygwinPathIfNeeded (
  IN  CHAR8   *Name
  );

RETURN_STATUS
EFIAPI
SerialPortInitialize (
  VOID
  );
  
  
VOID
UartInit (
  VOID
  )
{
  // SEC phase needs to run library constructors by hand.
  // This assumes we are linked agains the SerialLib
  // In non SEC modules the init call is in autogenerated code.
  SerialPortInitialize ();
}

VOID
InitCache (
  IN  UINT32  MemoryBase,
  IN  UINT32  MemoryLength
  );

EFI_STATUS
EFIAPI
ExtractGuidedSectionLibConstructor (
  VOID
  );

EFI_STATUS
EFIAPI
LzmaDecompressLibConstructor (
  VOID
  );

/**
  If the build is done on cygwin the paths are cygpaths. 
  /cygdrive/c/tmp.txt vs c:\tmp.txt so we need to convert
  them to work with RVD commands

  This is just code to help print out RVD symbol load command.
  If you build with cygwin paths aren't compatible with RVD.

  @param  Name  Path to convert if needed

**/
CHAR8 *
SecDeCygwinPathIfNeeded (
  IN  CHAR8   *Name
  )
{
  CHAR8   *Ptr;
  UINTN   Index;
  UINTN   Len;
  
  Ptr = AsciiStrStr (Name, "/cygdrive/");
  if (Ptr == NULL) {
    return Name;
  }
  
  Len = AsciiStrLen (Ptr);
  
  // convert "/cygdrive" to spaces
  for (Index = 0; Index < 9; Index++) {
    Ptr[Index] = ' ';
  }

  // convert /c to c:
  Ptr[9]  = Ptr[10];
  Ptr[10] = ':';
  
  // switch path seperators
  for (Index = 11; Index < Len; Index++) {
    if (Ptr[Index] == '/') {
      Ptr[Index] = '\\' ;
    }
  }

  return Name;
}


VOID
CEntryPoint (
  IN  VOID  *MemoryBase,
  IN  UINTN MemorySize,
  IN  VOID  *StackBase,
  IN  UINTN StackSize
  )
{
  VOID *HobBase;

  // Build a basic HOB list
  HobBase      = (VOID *)(UINTN)(FixedPcdGet32(PcdEmbeddedFdBaseAddress) + FixedPcdGet32(PcdEmbeddedFdSize));
  CreateHobList (MemoryBase, MemorySize, HobBase, StackBase);


  // Enable program flow prediction, if supported.
  ArmEnableBranchPrediction ();

  // Initialize CPU cache
  InitCache ((UINT32)MemoryBase, (UINT32)MemorySize);

  // Add memory allocation hob for relocated FD
  BuildMemoryAllocationHob (FixedPcdGet32(PcdEmbeddedFdBaseAddress), FixedPcdGet32(PcdEmbeddedFdSize), EfiBootServicesData);

  // Add the FVs to the hob list
  BuildFvHob (PcdGet32(PcdFlashFvMainBase), PcdGet32(PcdFlashFvMainSize));

  // Start talking
  UartInit ();
  DEBUG ((EFI_D_ERROR, "UART Enabled\n"));

  DEBUG_CODE_BEGIN ();
    //
    // On a debug build print out information about the SEC. This is really info about
    // the PE/COFF file we are currently running from. Useful for loading symbols in a
    // debugger. Remember our image is really part of the FV.
    //
    RETURN_STATUS       Status;
    EFI_PEI_FV_HANDLE   VolumeHandle;
    EFI_PEI_FILE_HANDLE FileHandle;
    VOID                *PeCoffImage;
    UINT32              Offset;
    CHAR8               *FilePath;
    FfsAnyFvFindFirstFile (EFI_FV_FILETYPE_SECURITY_CORE, &VolumeHandle, &FileHandle);
    Status = FfsFindSectionData (EFI_SECTION_TE, FileHandle, &PeCoffImage);
    if (EFI_ERROR (Status)) {
      // Usually is a TE (PI striped down PE/COFF), but could be a full PE/COFF
      Status = FfsFindSectionData (EFI_SECTION_PE32, FileHandle, &PeCoffImage);
    }
    if (!EFI_ERROR (Status)) {
      Offset = PeCoffGetSizeOfHeaders (PeCoffImage);
      FilePath = PeCoffLoaderGetPdbPointer (PeCoffImage);
      if (FilePath != NULL) {
      
        // 
        // In general you should never have to use #ifdef __CC_ARM in the code. It
        // is hidden in the away in the MdePkg. But here we would like to print differnt things
        // for different toolchains. 
        //
#ifdef __CC_ARM
        // Print out the command for the RVD debugger to load symbols for this image
        DEBUG ((EFI_D_ERROR, "load /a /ni /np %a &0x%08x\n", SecDeCygwinPathIfNeeded (FilePath), (CHAR8 *)PeCoffImage + Offset));
#elif __GNUC__
        // This may not work correctly if you generate PE/COFF directlyas then the Offset would not be required
        DEBUG ((EFI_D_ERROR, "add-symbol-file %a 0x%08x\n", FilePath, PeCoffImage + Offset));
#else
        DEBUG ((EFI_D_ERROR, "SEC starts at 0x%08x with an entry point at 0x%08x %a\n", PeCoffImage, _ModuleEntryPoint, FilePath));
#endif
      }
    }

   
  DEBUG_CODE_END ();


  // SEC phase needs to run library constructors by hand.
  ExtractGuidedSectionLibConstructor ();
  LzmaDecompressLibConstructor ();

  // Build HOBs to pass up our version of stuff the DXE Core needs to save space
  BuildPeCoffLoaderHob ();
  BuildExtractSectionHob (
    &gLzmaCustomDecompressGuid,
    LzmaGuidedSectionGetInfo,
    LzmaGuidedSectionExtraction
    );

  // Assume the FV that contains the SEC (our code) also contains a compressed FV.
  DecompressFirstFv ();

  // Load the DXE Core and transfer control to it
  LoadDxeCoreFromFv (NULL, 0);
  
  // DXE Core should always load and never return
  ASSERT (FALSE);
}