MdePkg/Include/Ppi/SecPlatformInformation.h

   1 /** @file
   2   This file declares Sec Platform Information PPI.
   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   @par Revision Reference:
  14   This PPI is defined in PI.
  15   Version 1.00.
  16
  17 **/
  18
  19 #ifndef __SEC_PLATFORM_INFORMATION_PPI_H__
  20 #define __SEC_PLATFORM_INFORMATION_PPI_H__
  21
  22 #define EFI_SEC_PLATFORM_INFORMATION_GUID \
  23   { \
  24     0x6f8c2b35, 0xfef4, 0x448d, {0x82, 0x56, 0xe1, 0x1b, 0x19, 0xd6, 0x10, 0x77 } \
  25   }
  26
  27 typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PPI;
  28
  29
  30 //
  31 // EFI_HEALTH_FLAGS
  32 //
  33 typedef union {
  34   struct {
  35     UINT32   Status                   : 2;
  36     UINT32   Tested                   : 1;
  37     UINT32   Reserved1                :13;
  38     UINT32   VirtualMemoryUnavailable : 1;
  39     UINT32   Ia32ExecutionUnavailable : 1;
  40     UINT32   FloatingPointUnavailable : 1;
  41     UINT32   MiscFeaturesUnavailable  : 1;
  42     UINT32   Reserved2                :12;
  43   } Bits;
  44   UINT32     Uint32;
  45 } EFI_HEALTH_FLAGS;
  46
  47
  48 /**
  49
  50   @param BootPhase  entry r20 value.
  51
  52   @param UniqueId   PAL arbitration ID.
  53
  54   @param HealthStat Health Status
  55
  56   @param PALRetAddress  Return address to PAL
  57
  58 **/
  59 /*
  60 typedef struct {
  61   UINTN BootPhase;
  62   UINTN UniqueId;
  63   UINTN HealthStat;
  64   UINTN PALRetAddress;
  65 } IPF_HANDOFF_STATUS;
  66 */
  67
  68 #define NORMAL_BOOT_CALL    0x0
  69 #define RECOVERY_CHECK_CALL 0x3
  70
  71 typedef struct {
  72   UINT8 BootPhase;
  73   UINT8 FWStatus;
  74   UINT16 Reserved1;
  75   UINT32 Reserved2;
  76
  77   UINT16 ProcId;
  78   UINT16 Reserved3;
  79   UINT8  IdMask;
  80   UINT8  EidMask;
  81   UINT16 Reserved4;
  82
  83   UINT64 PalCallAddress;
  84   UINT64 PalSpecialAddress;
  85   UINT64 SelfTestStatus;
  86   UINT64 SelfTestControl;
  87   UINT64 MemoryBufferRequired;
  88
  89 } IPF_HANDOFF_STATUS;
  90
  91
  92 typedef struct {
  93   EFI_HEALTH_FLAGS HealthFlags;
  94 } EFI_SEC_PLATFORM_INFORMATION_RECORD;
  95
  96
  97
  98 /**
  99   This interface conveys state information out of the Security (SEC) phase into PEI.
 100
 101   @param  PeiServices               Pointer to the PEI Services Table.
 102   @param  StructureSize             Pointer to the variable describing size of the input buffer.
 103   @param  PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
 104
 105   @retval EFI_SUCCESS           The data was successfully returned.
 106   @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.
 107
 108 **/
 109 typedef
 110 EFI_STATUS
 111 (EFIAPI *EFI_SEC_PLATFORM_INFORMATION)(
 112   IN CONST  EFI_PEI_SERVICES                    **PeiServices,
 113   IN OUT    UINT64                              *StructureSize,
 114   OUT       EFI_SEC_PLATFORM_INFORMATION_RECORD *PlatformInformationRecord
 115 );
 116
 117
 118 /**
 119   Ppi Description:
 120
 121   @param Name
 122
 123 **/
 124 struct _EFI_SEC_PLATFORM_INFORMATION_PPI {
 125   EFI_SEC_PLATFORM_INFORMATION  PlatformInformation;
 126 };
 127
 128
 129 extern EFI_GUID gEfiSecPlatformInformationPpiGuid;
 130
 131 #endif