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 This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __PLATFORM_SEC_LIB_H__
  17 #define __PLATFORM_SEC_LIB_H__
  18
  19 /**
  20   A developer supplied function to perform platform specific operations.
  21
  22   It's a developer supplied function to perform any operations appropriate to a
  23   given platform. It's invoked just before passing control to PEI core by SEC
  24   core. Platform developer may modify the SecCoreData passed to PEI Core.
  25   It returns a platform specific PPI list that platform wishes to pass to PEI core.
  26   The Generic SEC core module will merge this list to join the final list passed to
  27   PEI core.
  28
  29   @param  SecCoreData           The same parameter as passing to PEI core. It
  30                                 could be overridden by this function.
  31
  32   @return The platform specific PPI list to be passed to PEI core or
  33           NULL if there is no need of such platform specific PPI list.
  34
  35 **/
  36 EFI_PEI_PPI_DESCRIPTOR *
  37 EFIAPI
  38 SecPlatformMain (
  39   IN OUT   EFI_SEC_PEI_HAND_OFF        *SecCoreData
  40   );
  41
  42 /**
  43   This interface conveys state information out of the Security (SEC) phase into PEI.
  44
  45   @param  PeiServices               Pointer to the PEI Services Table.
  46   @param  StructureSize             Pointer to the variable describing size of the input buffer.
  47   @param  PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
  48
  49   @retval EFI_SUCCESS           The data was successfully returned.
  50   @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.
  51
  52 **/
  53 EFI_STATUS
  54 EFIAPI
  55 SecPlatformInformation (
  56   IN CONST EFI_PEI_SERVICES                     **PeiServices,
  57   IN OUT   UINT64                               *StructureSize,
  58      OUT   EFI_SEC_PLATFORM_INFORMATION_RECORD  *PlatformInformationRecord
  59   );
  60
  61 /**
  62   This interface disables temporary memory in SEC Phase.
  63 **/
  64 VOID
  65 EFIAPI
  66 SecPlatformDisableTemporaryMemory (
  67   VOID
  68   );
  69
  70 #endif