MdePkg/Include/Ppi/SecPlatformInformation.h

   1 /** @file
   2   This file declares Sec Platform Information PPI.
   3
   4   Copyright (c) 2006, 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   Module Name:  SecPlatformInformation.h
  14
  15   @par Revision Reference:
  16   This PPI is defined in PEI CIS.
  17   Version 0.91.
  18
  19 **/
  20
  21 #ifndef __SEC_PLATFORM_INFORMATION_PPI_H__
  22 #define __SEC_PLATFORM_INFORMATION_PPI_H__
  23
  24 #define EFI_SEC_PLATFORM_INFORMATION_GUID \
  25   { \
  26     0x6f8c2b35, 0xfef4, 0x448d, {0x82, 0x56, 0xe1, 0x1b, 0x19, 0xd6, 0x10, 0x77 } \
  27   }
  28
  29 typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PPI;
  30
  31 extern EFI_GUID gEfiSecPlatformInformationPpiGuid;
  32
  33 typedef struct {
  34   UINTN BootPhase;      // entry r20 value
  35   UINTN UniqueId;       // PAL arbitration ID
  36   UINTN HealthStat;     // Health Status
  37   UINTN PALRetAddress;  // return address to PAL
  38 } IPF_HANDOFF_STATUS;
  39
  40 ///
  41 /// EFI_HEALTH_FLAGS
  42 ///
  43 typedef union {
  44   struct {
  45     UINT32   Status                   : 2;
  46     UINT32   Tested                   : 1;
  47     UINT32   Reserved1                :13;
  48     UINT32   VirtualMemoryUnavailable : 1;
  49     UINT32   Ia32ExecutionUnavailable : 1;
  50     UINT32   FloatingPointUnavailable : 1;
  51     UINT32   MiscFeaturesUnavailable  : 1;
  52     UINT32   Reserved2                :12;
  53   }                     Bits;
  54   UINT32                Uint32;
  55 } EFI_HEALTH_FLAGS;
  56
  57 typedef struct {
  58   EFI_HEALTH_FLAGS HealthFlags;
  59 } EFI_SEC_PLATFORM_INFORMATION_RECORD;
  60
  61 /**
  62   This interface conveys state information out of the Security (SEC) phase into PEI.
  63
  64   @param  PeiServices               Pointer to the PEI Services Table.
  65   @param  StructureSize             Pointer to the variable describing size of the input buffer.
  66   @param  PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
  67
  68   @retval EFI_SUCCESS           The data was successfully returned.
  69   @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.
  70
  71 **/
  72 typedef
  73 EFI_STATUS
  74 (EFIAPI *EFI_SEC_PLATFORM_INFORMATION) (
  75   IN EFI_PEI_SERVICES                      **PeiServices,
  76   IN OUT UINT64                            *StructureSize,
  77   OUT EFI_SEC_PLATFORM_INFORMATION_RECORD  *PlatformInformationRecord
  78   );
  79
  80 /**
  81   @par Ppi Description:
  82
  83   @param Name
  84
  85 **/
  86 struct _EFI_SEC_PLATFORM_INFORMATION_PPI {
  87   EFI_SEC_PLATFORM_INFORMATION  PlatformInformation;
  88 };
  89
  90 #endif