MdeModulePkg/Core/Pei/Memory/MemoryServices.c

   1 /** @file
   2   EFI PEI Core memory services
   3
   4 Copyright (c) 2006 - 2010, Intel Corporation
   5 All rights reserved. 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 "PeiMain.h"
  16
  17 /**
  18
  19   Initialize the memory services.
  20
  21   @param PrivateData     Points to PeiCore's private instance data.
  22   @param SecCoreData     Points to a data structure containing information about the PEI core's operating
  23                          environment, such as the size and location of temporary RAM, the stack location and
  24                          the BFV location.
  25   @param OldCoreData     Pointer to the PEI Core data.
  26                          NULL if being run in non-permament memory mode.
  27
  28 **/
  29 VOID
  30 InitializeMemoryServices (
  31   IN PEI_CORE_INSTANCE           *PrivateData,
  32   IN CONST EFI_SEC_PEI_HAND_OFF  *SecCoreData,
  33   IN PEI_CORE_INSTANCE           *OldCoreData
  34   )
  35 {
  36
  37   PrivateData->SwitchStackSignal    = FALSE;
  38
  39   //
  40   // First entering PeiCore, following code will initialized some field
  41   // in PeiCore's private data according to hand off data from sec core.
  42   //
  43   if (OldCoreData == NULL) {
  44
  45     PrivateData->PeiMemoryInstalled = FALSE;
  46     PrivateData->HobList.Raw        = SecCoreData->PeiTemporaryRamBase;
  47
  48     PeiCoreBuildHobHandoffInfoTable (
  49       BOOT_WITH_FULL_CONFIGURATION,
  50       (EFI_PHYSICAL_ADDRESS) (UINTN) SecCoreData->PeiTemporaryRamBase,
  51       (UINTN) SecCoreData->PeiTemporaryRamSize
  52       );
  53
  54     //
  55     // Set Ps to point to ServiceTableShadow in Cache
  56     //
  57     PrivateData->Ps = &(PrivateData->ServiceTableShadow);
  58   }
  59
  60   return;
  61 }
  62
  63 /**
  64
  65   This function registers the found memory configuration with the PEI Foundation.
  66
  67   The usage model is that the PEIM that discovers the permanent memory shall invoke this service.
  68   This routine will hold discoveried memory information into PeiCore's private data,
  69   and set SwitchStackSignal flag. After PEIM who discovery memory is dispatched,
  70   PeiDispatcher will migrate temporary memory to permenement memory.
  71
  72   @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
  73   @param MemoryBegin        Start of memory address.
  74   @param MemoryLength       Length of memory.
  75
  76   @return EFI_SUCCESS Always success.
  77
  78 **/
  79 EFI_STATUS
  80 EFIAPI
  81 PeiInstallPeiMemory (
  82   IN CONST EFI_PEI_SERVICES  **PeiServices,
  83   IN EFI_PHYSICAL_ADDRESS    MemoryBegin,
  84   IN UINT64                  MemoryLength
  85   )
  86 {
  87   PEI_CORE_INSTANCE                     *PrivateData;
  88
  89   DEBUG ((EFI_D_INFO, "PeiInstallPeiMemory MemoryBegin 0x%LX, MemoryLength 0x%LX\n", MemoryBegin, MemoryLength));
  90   PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);
  91
  92   //
  93   // PEI_SERVICE.InstallPeiMemory should only be called one time during whole PEI phase.
  94   // If it is invoked more than one time, ASSERT information is given for developer debugging in debug tip and
  95   // simply return EFI_SUCESS in release tip to ignore it.
  96   //
  97   if (PrivateData->PeiMemoryInstalled) {
  98     DEBUG ((EFI_D_ERROR, "ERROR: PeiInstallPeiMemory is called more than once!\n"));
  99     ASSERT (PrivateData->PeiMemoryInstalled);
 100     return EFI_SUCCESS;
 101   }
 102
 103   PrivateData->PhysicalMemoryBegin   = MemoryBegin;
 104   PrivateData->PhysicalMemoryLength  = MemoryLength;
 105   PrivateData->FreePhysicalMemoryTop = MemoryBegin + MemoryLength;
 106
 107   PrivateData->SwitchStackSignal      = TRUE;
 108
 109   return EFI_SUCCESS;
 110 }
 111
 112 /**
 113
 114   Memory allocation service on permanent memory,
 115   not usable prior to the memory installation.
 116
 117
 118   @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
 119   @param MemoryType      Type of memory to allocate.
 120   @param Pages           Number of pages to allocate.
 121   @param Memory          Pointer of memory allocated.
 122
 123   @retval EFI_SUCCESS              The allocation was successful
 124   @retval EFI_NOT_AVAILABLE_YET    Called with permanent memory not available
 125   @retval EFI_OUT_OF_RESOURCES     There is not enough HOB heap to satisfy the requirement
 126                                    to allocate the number of pages.
 127
 128 **/
 129 EFI_STATUS
 130 EFIAPI
 131 PeiAllocatePages (
 132   IN CONST EFI_PEI_SERVICES     **PeiServices,
 133   IN       EFI_MEMORY_TYPE      MemoryType,
 134   IN       UINTN                Pages,
 135   OUT      EFI_PHYSICAL_ADDRESS *Memory
 136   )
 137 {
 138   PEI_CORE_INSTANCE                       *PrivateData;
 139   EFI_PEI_HOB_POINTERS                    Hob;
 140   EFI_PHYSICAL_ADDRESS                    *FreeMemoryTop;
 141   EFI_PHYSICAL_ADDRESS                    *FreeMemoryBottom;
 142   UINTN                                   RemainingPages;
 143
 144   PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);
 145   Hob.Raw     = PrivateData->HobList.Raw;
 146
 147   //
 148   // Check if Hob already available
 149   //
 150   if (!PrivateData->PeiMemoryInstalled) {
 151     //
 152     // When PeiInstallMemory is called but temporary memory has *not* been moved to temporary memory,
 153     // the AllocatePage will depend on the field of PEI_CORE_INSTANCE structure.
 154     //
 155     if (!PrivateData->SwitchStackSignal) {
 156       return EFI_NOT_AVAILABLE_YET;
 157     } else {
 158       FreeMemoryTop     = &(PrivateData->FreePhysicalMemoryTop);
 159       FreeMemoryBottom  = &(PrivateData->PhysicalMemoryBegin);
 160     }
 161   } else {
 162     FreeMemoryTop     = &(Hob.HandoffInformationTable->EfiFreeMemoryTop);
 163     FreeMemoryBottom  = &(Hob.HandoffInformationTable->EfiFreeMemoryBottom);
 164   }
 165
 166   //
 167   // Check to see if on 4k boundary, If not aligned, make the allocation aligned.
 168   //
 169   *(FreeMemoryTop) -= *(FreeMemoryTop) & 0xFFF;
 170
 171   //
 172   // Verify that there is sufficient memory to satisfy the allocation
 173   //
 174   RemainingPages = EFI_SIZE_TO_PAGES ((UINTN) (*FreeMemoryTop - *FreeMemoryBottom));
 175   //
 176   // For page allocation, the overhead sizeof (EFI_HOB_MEMORY_ALLOCATION) needs one extra page.
 177   // So the number of remaining pages needs to be greater than that of the request pages.
 178   //
 179   if (RemainingPages <= Pages) {
 180     DEBUG ((EFI_D_ERROR, "AllocatePages failed: No 0x%lx Pages is available.\n", (UINT64) Pages));
 181     DEBUG ((EFI_D_ERROR, "There is only left 0x%lx pages memory resource to be allocated.\n", (UINT64) RemainingPages));
 182     return  EFI_OUT_OF_RESOURCES;
 183   } else {
 184     //
 185     // Update the PHIT to reflect the memory usage
 186     //
 187     *(FreeMemoryTop) -= Pages * EFI_PAGE_SIZE;
 188
 189     //
 190     // Update the value for the caller
 191     //
 192     *Memory = *(FreeMemoryTop);
 193
 194     //
 195     // Create a memory allocation HOB.
 196     //
 197     BuildMemoryAllocationHob (
 198       *(FreeMemoryTop),
 199       Pages * EFI_PAGE_SIZE,
 200       MemoryType
 201       );
 202
 203     return EFI_SUCCESS;
 204   }
 205 }
 206
 207 /**
 208
 209   Pool allocation service. Before permenent memory is discoveried, the pool will
 210   be allocated the heap in the temporary memory. Genenrally, the size of heap in temporary
 211   memory does not exceed to 64K, so the biggest pool size could be allocated is
 212   64K.
 213
 214   @param PeiServices               An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
 215   @param Size                      Amount of memory required
 216   @param Buffer                    Address of pointer to the buffer
 217
 218   @retval EFI_SUCCESS              The allocation was successful
 219   @retval EFI_OUT_OF_RESOURCES     There is not enough heap to satisfy the requirement
 220                                    to allocate the requested size.
 221
 222 **/
 223 EFI_STATUS
 224 EFIAPI
 225 PeiAllocatePool (
 226   IN CONST EFI_PEI_SERVICES     **PeiServices,
 227   IN       UINTN                Size,
 228   OUT      VOID                 **Buffer
 229   )
 230 {
 231   EFI_STATUS               Status;
 232   EFI_HOB_MEMORY_POOL      *Hob;
 233
 234   //
 235   // If some "post-memory" PEIM wishes to allocate larger pool,
 236   // it should use AllocatePages service instead.
 237   //
 238
 239   //
 240   // Generally, the size of heap in temporary memory does not exceed to 64K,
 241   // so the maxmium size of pool is 0x10000 - sizeof (EFI_HOB_MEMORY_POOL)
 242   //
 243   if (Size >= (0x10000 - sizeof (EFI_HOB_MEMORY_POOL))) {
 244     return EFI_OUT_OF_RESOURCES;
 245   }
 246
 247   Status = PeiServicesCreateHob (
 248              EFI_HOB_TYPE_MEMORY_POOL,
 249              (UINT16)(sizeof (EFI_HOB_MEMORY_POOL) + Size),
 250              (VOID **)&Hob
 251              );
 252   *Buffer = Hob+1;
 253
 254   return Status;
 255 }