MdePkg/Include/Library/PeiServicesLib.h

   1 /** @file
   2   Header file for PEI Services Library.
   3
   4   Copyright (c) 2006 - 2007, 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 #ifndef __PEI_SERVICES_LIB_H__
  16 #define __PEI_SERVICES_LIB_H__
  17
  18 /**
  19   This service enables a given PEIM to register an interface into the PEI Foundation.
  20
  21   @param  PpiList               A pointer to the list of interfaces that the caller shall install.
  22
  23   @retval EFI_SUCCESS           The interface was successfully installed.
  24   @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL.
  25   @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the
  26                                 EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
  27   @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.
  28
  29 **/
  30 EFI_STATUS
  31 EFIAPI
  32 PeiServicesInstallPpi (
  33   IN CONST EFI_PEI_PPI_DESCRIPTOR     *PpiList
  34   );
  35
  36 /**
  37   This service enables PEIMs to replace an entry in the PPI database with an alternate entry.
  38
  39   @param  OldPpi                Pointer to the old PEI PPI Descriptors.
  40   @param  NewPpi                Pointer to the new PEI PPI Descriptors.
  41
  42   @retval EFI_SUCCESS           The interface was successfully installed.
  43   @retval EFI_INVALID_PARAMETER The OldPpi or NewPpi is NULL.
  44   @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the
  45                                 EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
  46   @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.
  47   @retval EFI_NOT_FOUND         The PPI for which the reinstallation was requested has not been
  48                                 installed.
  49
  50 **/
  51 EFI_STATUS
  52 EFIAPI
  53 PeiServicesReInstallPpi (
  54   IN CONST EFI_PEI_PPI_DESCRIPTOR     *OldPpi,
  55   IN CONST EFI_PEI_PPI_DESCRIPTOR     *NewPpi
  56   );
  57
  58 /**
  59   This service enables PEIMs to discover a given instance of an interface.
  60
  61   @param  Guid                  A pointer to the GUID whose corresponding interface needs to be
  62                                 found.
  63   @param  Instance              The N-th instance of the interface that is required.
  64   @param  PpiDescriptor         A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
  65   @param  Ppi                   A pointer to the instance of the interface.
  66
  67   @retval EFI_SUCCESS           The interface was successfully returned.
  68   @retval EFI_NOT_FOUND         The PPI descriptor is not found in the database.
  69
  70 **/
  71 EFI_STATUS
  72 EFIAPI
  73 PeiServicesLocatePpi (
  74   IN CONST EFI_GUID                   *Guid,
  75   IN UINTN                      Instance,
  76   IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,
  77   IN OUT VOID                   **Ppi
  78   );
  79
  80 /**
  81   This service enables PEIMs to register a given service to be invoked when another service is
  82   installed or reinstalled.
  83
  84   @param  NotifyList            A pointer to the list of notification interfaces that the caller
  85                                 shall install.
  86
  87   @retval EFI_SUCCESS           The interface was successfully installed.
  88   @retval EFI_INVALID_PARAMETER The NotifyList pointer is NULL.
  89   @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have the
  90                                 EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.
  91   @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.
  92
  93 **/
  94 EFI_STATUS
  95 EFIAPI
  96 PeiServicesNotifyPpi (
  97   IN CONST EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyList
  98   );
  99
 100 /**
 101   This service enables PEIMs to ascertain the present value of the boot mode.
 102
 103   @param  BootMode              A pointer to contain the value of the boot mode.
 104
 105   @retval EFI_SUCCESS           The boot mode was returned successfully.
 106   @retval EFI_INVALID_PARAMETER BootMode is NULL.
 107
 108 **/
 109 EFI_STATUS
 110 EFIAPI
 111 PeiServicesGetBootMode (
 112   OUT EFI_BOOT_MODE          *BootMode
 113   );
 114
 115 /**
 116   This service enables PEIMs to update the boot mode variable.
 117
 118   @param  BootMode              The value of the boot mode to set.
 119
 120   @retval EFI_SUCCESS           The value was successfully updated
 121
 122 **/
 123 EFI_STATUS
 124 EFIAPI
 125 PeiServicesSetBootMode (
 126   IN EFI_BOOT_MODE              BootMode
 127   );
 128
 129 /**
 130   This service enables a PEIM to ascertain the address of the list of HOBs in memory.
 131
 132   @param  HobList               A pointer to the list of HOBs that the PEI Foundation will initialize.
 133
 134   @retval EFI_SUCCESS           The list was successfully returned.
 135   @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.
 136
 137 **/
 138 EFI_STATUS
 139 EFIAPI
 140 PeiServicesGetHobList (
 141   OUT VOID                      **HobList
 142   );
 143
 144 /**
 145   This service enables PEIMs to create various types of HOBs.
 146
 147   @param  Type                  The type of HOB to be installed.
 148   @param  Length                The length of the HOB to be added.
 149   @param  Hob                   The address of a pointer that will contain the HOB header.
 150
 151   @retval EFI_SUCCESS           The HOB was successfully created.
 152   @retval EFI_OUT_OF_RESOURCES  There is no additional space for HOB creation.
 153
 154 **/
 155 EFI_STATUS
 156 EFIAPI
 157 PeiServicesCreateHob (
 158   IN UINT16                     Type,
 159   IN UINT16                     Length,
 160   OUT VOID                      **Hob
 161   );
 162
 163 /**
 164   This service enables PEIMs to discover additional firmware volumes.
 165
 166   @param  Instance              This instance of the firmware volume to find.  The value 0 is the
 167                                 Boot Firmware Volume (BFV).
 168   @param  FwVolHeader           Pointer to the firmware volume header of the volume to return.
 169
 170   @retval EFI_SUCCESS           The volume was found.
 171   @retval EFI_NOT_FOUND         The volume was not found.
 172   @retval EFI_INVALID_PARAMETER FwVolHeader is NULL.
 173
 174 **/
 175 EFI_STATUS
 176 EFIAPI
 177 PeiServicesFfsFindNextVolume (
 178   IN UINTN                          Instance,
 179   IN OUT EFI_PEI_FV_HANDLE          *VolumeHandle
 180   );
 181
 182 /**
 183   This service enables PEIMs to discover additional firmware files.
 184
 185   @param  SearchType            A filter to find files only of this type.
 186   @param  FwVolHeader           Pointer to the firmware volume header of the volume to search.
 187                                 This parameter must point to a valid FFS volume.
 188   @param  FileHeader            Pointer to the current file from which to begin searching.
 189
 190   @retval EFI_SUCCESS           The file was found.
 191   @retval EFI_NOT_FOUND         The file was not found.
 192   @retval EFI_NOT_FOUND         The header checksum was not zero.
 193
 194 **/
 195 EFI_STATUS
 196 EFIAPI
 197 PeiServicesFfsFindNextFile (
 198   IN EFI_FV_FILETYPE            SearchType,
 199   IN EFI_PEI_FV_HANDLE          VolumeHandle,
 200   IN OUT EFI_PEI_FILE_HANDLE    *FileHandle
 201   );
 202
 203 /**
 204   This service enables PEIMs to discover sections of a given type within a valid FFS file.
 205
 206   @param  SearchType            The value of the section type to find.
 207   @param  FfsFileHeader         A pointer to the file header that contains the set of sections to
 208                                 be searched.
 209   @param  SectionData           A pointer to the discovered section, if successful.
 210
 211   @retval EFI_SUCCESS           The section was found.
 212   @retval EFI_NOT_FOUND         The section was not found.
 213
 214 **/
 215 EFI_STATUS
 216 EFIAPI
 217 PeiServicesFfsFindSectionData (
 218   IN EFI_SECTION_TYPE           SectionType,
 219   IN EFI_PEI_FILE_HANDLE        FileHandle,
 220   OUT VOID                      **SectionData
 221   );
 222
 223 /**
 224   This service enables PEIMs to register the permanent memory configuration
 225   that has been initialized with the PEI Foundation.
 226
 227   @param  MemoryBegin           The value of a region of installed memory.
 228   @param  MemoryLength          The corresponding length of a region of installed memory.
 229
 230   @retval EFI_SUCCESS           The region was successfully installed in a HOB.
 231   @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.
 232   @retval EFI_OUT_OF_RESOURCES  There is no additional space for HOB creation.
 233
 234 **/
 235 EFI_STATUS
 236 EFIAPI
 237 PeiServicesInstallPeiMemory (
 238   IN EFI_PHYSICAL_ADDRESS       MemoryBegin,
 239   IN UINT64                     MemoryLength
 240   );
 241
 242 /**
 243   This service enables PEIMs to allocate memory after the permanent memory has been installed by a
 244   PEIM.
 245
 246   @param  MemoryType            Type of memory to allocate.
 247   @param  Pages                 Number of pages to allocate.
 248   @param  Memory                Pointer of memory allocated.
 249
 250   @retval EFI_SUCCESS           The memory range was successfully allocated.
 251   @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.
 252   @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available.
 253   @retval EFI_OUT_OF_RESOURCES  The pages could not be allocated.
 254
 255 **/
 256 EFI_STATUS
 257 EFIAPI
 258 PeiServicesAllocatePages (
 259   IN EFI_MEMORY_TYPE            MemoryType,
 260   IN UINTN                      Pages,
 261   OUT EFI_PHYSICAL_ADDRESS      *Memory
 262   );
 263
 264 /**
 265   This service allocates memory from the Hand-Off Block (HOB) heap.
 266
 267   @param  Size                  The number of bytes to allocate from the pool.
 268   @param  Buffer                If the call succeeds, a pointer to a pointer to the allocate
 269                                 buffer; undefined otherwise.
 270
 271   @retval EFI_SUCCESS           The allocation was successful
 272   @retval EFI_OUT_OF_RESOURCES  There is not enough heap to allocate the requested size.
 273
 274 **/
 275 EFI_STATUS
 276 EFIAPI
 277 PeiServicesAllocatePool (
 278   IN UINTN                      Size,
 279   OUT VOID                      **Buffer
 280   );
 281
 282 /**
 283   Resets the entire platform.
 284
 285   @param  VOID
 286
 287   @retval EFI_SUCCESS           The function completed successfully.
 288   @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.
 289
 290 **/
 291 EFI_STATUS
 292 EFIAPI
 293 PeiServicesResetSystem (
 294   VOID
 295   );
 296
 297
 298 /**
 299   This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services
 300   Table has been removed.  See the Platform Initialization Pre-EFI Initialization Core Interface
 301   Specification for details.
 302
 303   @param FileName       A pointer to the name of the file to
 304                         find within the firmware volume.
 305
 306   @param VolumeHandle   The firmware volume to search FileHandle
 307                         Upon exit, points to the found file's
 308                         handle or NULL if it could not be found.
 309
 310   @retval EFI_SUCCESS             File was found.
 311
 312   @retval EFI_NOT_FOUND           File was not found.
 313
 314   @retval EFI_INVALID_PARAMETER   VolumeHandle or FileHandle or
 315                                   FileName was NULL.
 316
 317 **/
 318 EFI_STATUS
 319 EFIAPI
 320 PeiServicesFfsFindByName (
 321   IN CONST  EFI_GUID            *FileName,
 322   IN CONST  EFI_PEI_FV_HANDLE   VolumeHandle,
 323   OUT       EFI_PEI_FILE_HANDLE *FileHandle
 324   );
 325
 326
 327 /**
 328   This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services
 329   Table has been removed.  See the Platform Initialization Pre-EFI Initialization Core Interface
 330   Specification for details.
 331
 332   @param FileHandle   Handle of the file.
 333
 334   @param FileInfo     Upon exit, points to the file's
 335                       information.
 336
 337   @retval EFI_SUCCESS             File information returned.
 338
 339   @retval EFI_INVALID_PARAMETER   If FileHandle does not
 340                                   represent a valid file.
 341
 342   @retval EFI_INVALID_PARAMETER   If FileInfo is NULL.
 343
 344 **/
 345 EFI_STATUS
 346 EFIAPI
 347 PeiServicesFfsGetFileInfo (
 348   IN CONST  EFI_PEI_FILE_HANDLE   FileHandle,
 349   OUT EFI_FV_FILE_INFO            *FileInfo
 350   );
 351
 352 /**
 353   This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services
 354   Table has been removed.  See the Platform Initialization Pre-EFI Initialization Core Interface
 355   Specification for details.
 356
 357   @param VolumeHandle   Handle of the volume.
 358
 359   @param VolumeInfo     Upon exit, points to the volume's
 360                         information.
 361
 362   @retval EFI_SUCCESS             File information returned.
 363
 364   @retval EFI_INVALID_PARAMETER   If FileHandle does not
 365                                   represent a valid file.
 366
 367   @retval EFI_INVALID_PARAMETER   If FileInfo is NULL.
 368
 369 **/
 370 EFI_STATUS
 371 EFIAPI
 372 PeiServicesFfsGetVolumeInfo (
 373   IN  EFI_PEI_FV_HANDLE       VolumeHandle,
 374   OUT EFI_FV_INFO             *VolumeInfo
 375   );
 376
 377
 378 /**
 379   This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services
 380   Table has been removed.  See the Platform Initialization Pre-EFI Initialization Core Interface
 381   Specification for details.
 382
 383   @param FileHandle   PEIM's file handle. Must be the currently
 384                       executing PEIM.
 385
 386   @retval EFI_SUCCESS   The PEIM was successfully registered for
 387                         shadowing.
 388
 389   @retval EFI_ALREADY_STARTED   The PEIM was previously
 390                                 registered for shadowing.
 391
 392   @retval EFI_NOT_FOUND   The FileHandle does not refer to a
 393                           valid file handle.
 394 **/
 395 EFI_STATUS
 396 EFIAPI
 397 PeiServicesRegisterForShadow (
 398   IN  EFI_PEI_FILE_HANDLE FileHandle
 399   );
 400
 401
 402 #endif