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 typedef struct {
  48   EFI_HEALTH_FLAGS HealthFlags;
  49 } EFI_SEC_PLATFORM_INFORMATION_RECORD;
  50
  51
  52
  53 /**
  54   This interface conveys state information out of the Security (SEC) phase into PEI.
  55
  56   @param  PeiServices               Pointer to the PEI Services Table.
  57   @param  StructureSize             Pointer to the variable describing size of the input buffer.
  58   @param  PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
  59
  60   @retval EFI_SUCCESS           The data was successfully returned.
  61   @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.
  62
  63 **/
  64 typedef
  65 EFI_STATUS
  66 (EFIAPI *EFI_SEC_PLATFORM_INFORMATION) (
  67   IN CONST  EFI_PEI_SERVICES                    **PeiServices,
  68   IN OUT    UINT64                              *StructureSize,
  69   OUT       EFI_SEC_PLATFORM_INFORMATION_RECORD *PlatformInformationRecord
  70 );
  71
  72
  73 /**
  74   Ppi Description:
  75
  76   @param Name
  77
  78 **/
  79 struct _EFI_SEC_PLATFORM_INFORMATION_PPI {
  80   EFI_SEC_PLATFORM_INFORMATION  PlatformInformation;
  81 };
  82
  83
  84 extern EFI_GUID gEfiSecPlatformInformationPpiGuid;
  85
  86 #endif