IntelFsp2Pkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFsp2Pkg / FspSecCore / SecFsp.c

/** @file\r
\r
  Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "SecFsp.h"\r
\r
/**\r
\r
  Calculate the FSP IDT gate descriptor.\r
\r
  @param[in] IdtEntryTemplate     IDT gate descriptor template.\r
\r
  @return                     FSP specific IDT gate descriptor.\r
\r
**/\r
UINT64\r
FspGetExceptionHandler(\r
  IN  UINT64  IdtEntryTemplate\r
  )\r
{\r
  UINT32                    Entry;\r
  UINT64                    ExceptionHandler;\r
  IA32_IDT_GATE_DESCRIPTOR *IdtGateDescriptor;\r
  FSP_INFO_HEADER          *FspInfoHeader;\r
\r
  FspInfoHeader     = (FSP_INFO_HEADER *)AsmGetFspInfoHeader();\r
  ExceptionHandler  = IdtEntryTemplate;\r
  IdtGateDescriptor = (IA32_IDT_GATE_DESCRIPTOR *)&ExceptionHandler;\r
  Entry = (IdtGateDescriptor->Bits.OffsetHigh << 16) | IdtGateDescriptor->Bits.OffsetLow;\r
  Entry = FspInfoHeader->ImageBase + FspInfoHeader->ImageSize - (~Entry + 1);\r
  IdtGateDescriptor->Bits.OffsetHigh = (UINT16)(Entry >> 16);\r
  IdtGateDescriptor->Bits.OffsetLow  = (UINT16)Entry;\r
\r
  return ExceptionHandler;\r
}\r
\r
/**\r
  This interface fills platform specific data.\r
\r
  @param[in,out]  FspData           Pointer to the FSP global data.\r
\r
**/\r
VOID\r
EFIAPI\r
SecGetPlatformData (\r
  IN OUT  FSP_GLOBAL_DATA    *FspData\r
  )\r
{\r
  FSP_PLAT_DATA    *FspPlatformData;\r
  UINT32            TopOfCar;\r
  UINT32           *StackPtr;\r
  UINT32            DwordSize;\r
\r
  FspPlatformData = &FspData->PlatformData;\r
\r
  //\r
  // The entries of platform information, together with the number of them,\r
  // reside in the bottom of stack, left untouched by normal stack operation.\r
  //\r
\r
  FspPlatformData->DataPtr   = NULL;\r
  FspPlatformData->MicrocodeRegionBase = 0;\r
  FspPlatformData->MicrocodeRegionSize = 0;\r
  FspPlatformData->CodeRegionBase      = 0;\r
  FspPlatformData->CodeRegionSize      = 0;\r
\r
  //\r
  // Pointer to the size field\r
  //\r
  TopOfCar = PcdGet32(PcdTemporaryRamBase) + PcdGet32(PcdTemporaryRamSize);\r
  StackPtr = (UINT32 *)(TopOfCar - sizeof (UINT32));\r
\r
  if (*(StackPtr - 1) == FSP_MCUD_SIGNATURE) {\r
    while (*StackPtr != 0) {\r
      if (*(StackPtr - 1) == FSP_MCUD_SIGNATURE) {\r
        //\r
        // This following data was pushed onto stack after TempRamInit API\r
        //\r
        DwordSize = 4;\r
        StackPtr  = StackPtr - 1 - DwordSize;\r
        CopyMem (&(FspPlatformData->MicrocodeRegionBase), StackPtr, (DwordSize << 2));\r
        StackPtr--;\r
      } else if (*(StackPtr - 1) == FSP_PER0_SIGNATURE) {\r
        //\r
        // This is the performance data for InitTempMemory API entry/exit\r
        //\r
        DwordSize = 4;\r
        StackPtr  = StackPtr - 1 - DwordSize;\r
        CopyMem (FspData->PerfData, StackPtr, (DwordSize << 2));\r
\r
        ((UINT8 *)(&FspData->PerfData[0]))[7] = FSP_PERF_ID_API_TEMP_RAM_INIT_ENTRY;\r
        ((UINT8 *)(&FspData->PerfData[1]))[7] = FSP_PERF_ID_API_TEMP_RAM_INIT_EXIT;\r
\r
        StackPtr--;\r
      } else {\r
        StackPtr -= (*StackPtr);\r
      }\r
    }\r
  }\r
}\r
\r
/**\r
\r
  Initialize the FSP global data region.\r
  It needs to be done as soon as possible after the stack is setup.\r
\r
  @param[in,out] PeiFspData             Pointer of the FSP global data.\r
  @param[in]     BootLoaderStack        BootLoader stack.\r
  @param[in]     ApiIdx                 The index of the FSP API.\r
\r
**/\r
VOID\r
FspGlobalDataInit (\r
  IN OUT  FSP_GLOBAL_DATA    *PeiFspData,\r
  IN UINT32                   BootLoaderStack,\r
  IN UINT8                    ApiIdx\r
  )\r
{\r
  VOID              *FspmUpdDataPtr;\r
  CHAR8              ImageId[9];\r
  UINTN              Idx;\r
\r
  //\r
  // Set FSP Global Data pointer\r
  //\r
  SetFspGlobalDataPointer    (PeiFspData);\r
  ZeroMem  ((VOID *)PeiFspData, sizeof(FSP_GLOBAL_DATA));\r
\r
  PeiFspData->Signature            = FSP_GLOBAL_DATA_SIGNATURE;\r
  PeiFspData->Version              = 0;\r
  PeiFspData->CoreStack            = BootLoaderStack;\r
  PeiFspData->PerfIdx              = 2;\r
  PeiFspData->PerfSig              = FSP_PERFORMANCE_DATA_SIGNATURE;\r
\r
  SetFspMeasurePoint (FSP_PERF_ID_API_FSP_MEMORY_INIT_ENTRY);\r
\r
  //\r
  // Get FSP Header offset\r
  // It may have multiple FVs, so look into the last one for FSP header\r
  //\r
  PeiFspData->FspInfoHeader      = (FSP_INFO_HEADER *)AsmGetFspInfoHeader();\r
  SecGetPlatformData (PeiFspData);\r
\r
  //\r
  // Set API calling mode\r
  //\r
  SetFspApiCallingIndex (ApiIdx);\r
\r
  //\r
  // Set UPD pointer\r
  //\r
  FspmUpdDataPtr = (VOID *) GetFspApiParameter ();\r
  if (FspmUpdDataPtr == NULL) {\r
    FspmUpdDataPtr = (VOID *)(PeiFspData->FspInfoHeader->ImageBase + PeiFspData->FspInfoHeader->CfgRegionOffset);\r
  }\r
  SetFspUpdDataPointer (FspmUpdDataPtr);\r
  SetFspMemoryInitUpdDataPointer (FspmUpdDataPtr);\r
  SetFspSiliconInitUpdDataPointer (NULL);\r
\r
  //\r
  // Initialize serial port\r
  // It might have been done in ProcessLibraryConstructorList(), however,\r
  // the FSP global data is not initialized at that time. So do it again\r
  // for safe.\r
  //\r
  SerialPortInitialize ();\r
\r
  //\r
  // Ensure the golbal data pointer is valid\r
  //\r
  ASSERT (GetFspGlobalDataPointer () == PeiFspData);\r
\r
  for (Idx = 0; Idx < 8; Idx++) {\r
    ImageId[Idx] = PeiFspData->FspInfoHeader->ImageId[Idx];\r
  }\r
  ImageId[Idx] = 0;\r
\r
  DEBUG ((DEBUG_INFO | DEBUG_INIT, "\n============= FSP Spec v%d.%d Header Revision v%x (%a v%x.%x.%x.%x) =============\n", \\r
         (PeiFspData->FspInfoHeader->SpecVersion >> 4) & 0xF, \\r
         PeiFspData->FspInfoHeader->SpecVersion & 0xF, \\r
         PeiFspData->FspInfoHeader->HeaderRevision, \\r
         ImageId, \\r
         (PeiFspData->FspInfoHeader->ImageRevision >> 24) & 0xFF, \\r
         (PeiFspData->FspInfoHeader->ImageRevision >> 16) & 0xFF, \\r
         (PeiFspData->FspInfoHeader->ImageRevision >> 8) & 0xFF, \\r
         PeiFspData->FspInfoHeader->ImageRevision & 0xFF));\r
}\r
\r
/**\r
\r
  Adjust the FSP data pointers after the stack is migrated to memory.\r
\r
  @param[in] OffsetGap             The offset gap between the old stack and the new stack.\r
\r
**/\r
VOID\r
FspDataPointerFixUp (\r
  IN UINT32   OffsetGap\r
  )\r
{\r
  FSP_GLOBAL_DATA  *NewFspData;\r
\r
  NewFspData = (FSP_GLOBAL_DATA *)((UINTN)GetFspGlobalDataPointer() + (UINTN)OffsetGap);\r
  SetFspGlobalDataPointer (NewFspData);\r
}\r