UefiCpuPkg/Include/Library/PlatformSecLib.h

   1 /** @file
   2 This library class defines interface for platform to perform platform
   3 specific initialization in SEC phase.
   4
   5 Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef __PLATFORM_SEC_LIB_H__
  11 #define __PLATFORM_SEC_LIB_H__
  12
  13 /**
  14   A developer supplied function to perform platform specific operations.
  15
  16   It's a developer supplied function to perform any operations appropriate to a
  17   given platform. It's invoked just before passing control to PEI core by SEC
  18   core. Platform developer may modify the SecCoreData passed to PEI Core.
  19   It returns a platform specific PPI list that platform wishes to pass to PEI core.
  20   The Generic SEC core module will merge this list to join the final list passed to
  21   PEI core.
  22
  23   @param  SecCoreData           The same parameter as passing to PEI core. It
  24                                 could be overridden by this function.
  25
  26   @return The platform specific PPI list to be passed to PEI core or
  27           NULL if there is no need of such platform specific PPI list.
  28
  29 **/
  30 EFI_PEI_PPI_DESCRIPTOR *
  31 EFIAPI
  32 SecPlatformMain (
  33   IN OUT   EFI_SEC_PEI_HAND_OFF        *SecCoreData
  34   );
  35
  36 /**
  37   This interface conveys state information out of the Security (SEC) phase into PEI.
  38
  39   @param  PeiServices               Pointer to the PEI Services Table.
  40   @param  StructureSize             Pointer to the variable describing size of the input buffer.
  41   @param  PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
  42
  43   @retval EFI_SUCCESS           The data was successfully returned.
  44   @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.
  45
  46 **/
  47 EFI_STATUS
  48 EFIAPI
  49 SecPlatformInformation (
  50   IN CONST EFI_PEI_SERVICES                     **PeiServices,
  51   IN OUT   UINT64                               *StructureSize,
  52      OUT   EFI_SEC_PLATFORM_INFORMATION_RECORD  *PlatformInformationRecord
  53   );
  54
  55 /**
  56   This interface disables temporary memory in SEC Phase.
  57 **/
  58 VOID
  59 EFIAPI
  60 SecPlatformDisableTemporaryMemory (
  61   VOID
  62   );
  63
  64 #endif