MdePkg/Include/Library/PeiPiLib.h

   1 /** @file
   2   MDE PI library functions and macros for PEI phase
   3
   4   Copyright (c) 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_PI_LIB_H__
  16 #define __PEI_PI_LIB_H__
  17
  18 /**
  19   Install a EFI_PEI_FIRMWARE_VOLUME_INFO PPI to inform PEI core about the existence of a new Firmware Volume.
  20
  21   The function allocate the EFI_PEI_PPI_DESCRIPTOR structure and update the fields accordingly to parameter passed
  22   in and install the PPI.
  23
  24   @param  FvFormat             Unique identifier of the format of the memory-mapped firmware volume.
  25                                If NULL is specified, EFI_FIRMWARE_FILE_SYSTEM2_GUID is used as the Format GUID.
  26   @param  FvInfo               Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to
  27                                process the volume. The format of this buffer is specific to the FvFormat. For
  28                                memory-mapped firmware volumes, this typically points to the first byte of the
  29                                firmware volume.
  30   @param  FvInfoSize           Size of the data provided by FvInfo. For memory-mapped firmware volumes, this is
  31                                typically the size of the firmware volume.
  32   @param  ParentFvName         If the firmware volume originally came from a firmware file, then these point to the
  33                                parent firmware volume name. If it did not originally come from a firmware file,
  34                                these should be NULL.
  35   @param  ParentFileName       If the firmware volume originally came from a firmware file, then these point to the
  36                                firmware volume file. If it did not originally come from a firmware file,
  37                                these should be NULL.
  38
  39 **/
  40 VOID
  41 EFIAPI
  42 PiLibInstallFvInfoPpi (
  43   IN CONST EFI_GUID                *FvFormat, OPTIONAL
  44   IN CONST VOID                    *FvInfo,
  45   IN       UINT32                  FvInfoSize,
  46   IN CONST EFI_GUID                *ParentFvName, OPTIONAL
  47   IN CONST EFI_GUID                *ParentFileName OPTIONAL
  48 );
  49
  50 #endif
  51