IntelFspWrapperPkg/Library/BaseFspPlatformInfoLibSample/FspPlatformInfoLibSample.c

   1 /** @file
   2   Sample to provide FSP platform information related function.
   3
   4   Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>
   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 <PiPei.h>
  16 #include <Library/PcdLib.h>
  17
  18 /**
  19   Get current boot mode.
  20
  21   @note At this point, memory is ready, PeiServices are NOT available to use.
  22   Platform can get some data from chipset register.
  23
  24   @return BootMode current boot mode.
  25 **/
  26 UINT32
  27 EFIAPI
  28 GetBootMode (
  29   VOID
  30   )
  31 {
  32   return BOOT_WITH_FULL_CONFIGURATION;
  33 }
  34
  35 /**
  36   Get NVS buffer parameter.
  37
  38   @note At this point, memory is NOT ready, PeiServices are available to use.
  39
  40   @return NvsBuffer NVS buffer parameter.
  41 **/
  42 VOID *
  43 EFIAPI
  44 GetNvsBuffer (
  45   VOID
  46   )
  47 {
  48   return NULL;
  49 }
  50
  51 /**
  52   Get UPD region size.
  53
  54   @note At this point, memory is NOT ready, PeiServices are available to use.
  55
  56   @return UPD region size.
  57 **/
  58 UINT32
  59 EFIAPI
  60 GetUpdRegionSize (
  61   VOID
  62   )
  63 {
  64   return 0;
  65 }
  66
  67 /**
  68   This function overrides the default configurations in the UPD data region.
  69
  70   @note At this point, memory is NOT ready, PeiServices are available to use.
  71
  72   @param[in,out] FspUpdRgnPtr   A pointer to the UPD data region data strcture.
  73
  74   @return  FspUpdRgnPtr   A pointer to the UPD data region data strcture.
  75 **/
  76 VOID *
  77 EFIAPI
  78 UpdateFspUpdConfigs (
  79   IN OUT VOID        *FspUpdRgnPtr
  80   )
  81 {
  82   return NULL;
  83 }
  84
  85 /**
  86   Get S3 PEI memory information.
  87
  88   @note At this point, memory is ready, and PeiServices are available to use.
  89   Platform can get some data from SMRAM directly.
  90
  91   @param[out] S3PeiMemSize  PEI memory size to be installed in S3 phase.
  92   @param[out] S3PeiMemBase  PEI memory base to be installed in S3 phase.
  93
  94   @return If S3 PEI memory information is got successfully.
  95 **/
  96 EFI_STATUS
  97 EFIAPI
  98 GetS3MemoryInfo (
  99   OUT UINT64               *S3PeiMemSize,
 100   OUT EFI_PHYSICAL_ADDRESS *S3PeiMemBase
 101   )
 102 {
 103   return EFI_UNSUPPORTED;
 104 }
 105
 106 /**
 107   Get stack information according to boot mode.
 108
 109   @note If BootMode is BOOT_ON_S3_RESUME or BOOT_ON_FLASH_UPDATE,
 110   this stack should be in some reserved memory space.
 111
 112   @note If FspInitDone is TRUE, memory is ready, but no PeiServices there.
 113   Platform can get some data from SMRAM directly.
 114   @note If FspInitDone is FALSE, memory is NOT ready, but PeiServices are available to use.
 115   Platform can get some data from variable via VariablePpi.
 116
 117   @param[in]  BootMode     Current boot mode.
 118   @param[in]  FspInitDone  If FspInit is called.
 119   @param[out] StackSize    Stack size to be used in PEI phase.
 120   @param[out] StackBase    Stack base to be used in PEI phase.
 121
 122   @return If Stack information is got successfully.
 123 **/
 124 EFI_STATUS
 125 EFIAPI
 126 GetStackInfo (
 127   IN  UINT32               BootMode,
 128   IN  BOOLEAN              FspInitDone,
 129   OUT UINT64               *StackSize,
 130   OUT EFI_PHYSICAL_ADDRESS *StackBase
 131   )
 132 {
 133   *StackBase = PcdGet32 (PcdTemporaryRamBase);
 134   *StackSize = PcdGet32 (PcdTemporaryRamSize);
 135
 136   if (BootMode == BOOT_ON_S3_RESUME) {
 137     if (!FspInitDone) {
 138     } else {
 139     }
 140   } else if (BootMode == BOOT_ON_FLASH_UPDATE) {
 141     if (!FspInitDone) {
 142     } else {
 143     }
 144   }
 145
 146   return EFI_SUCCESS;
 147 }