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 ///
  34 /// EFI_HEALTH_FLAGS
  35 ///
  36 typedef union {
  37   struct {
  38     UINT32   Status                   : 2;
  39     UINT32   Tested                   : 1;
  40     UINT32   Reserved1                :13;
  41     UINT32   VirtualMemoryUnavailable : 1;
  42     UINT32   Ia32ExecutionUnavailable : 1;
  43     UINT32   FloatingPointUnavailable : 1;
  44     UINT32   MiscFeaturesUnavailable  : 1;
  45     UINT32   Reserved2                :12;
  46   }                     Bits;
  47   UINT32                Uint32;
  48 } EFI_HEALTH_FLAGS;
  49
  50 typedef struct {
  51   EFI_HEALTH_FLAGS HealthFlags;
  52 } EFI_SEC_PLATFORM_INFORMATION_RECORD;
  53
  54 /**
  55   This interface conveys state information out of the Security (SEC) phase into PEI.
  56
  57   @param  PeiServices Pointer to the PEI Services Table.
  58
  59   @param  StructureSize Pointer to the variable describing size of the input buffer.
  60
  61   @param  PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
  62
  63   @retval EFI_SUCCESS The data was successfully returned.
  64
  65   @retval EFI_BUFFER_TOO_SMALL The buffer was too small.
  66
  67 **/
  68 typedef
  69 EFI_STATUS
  70 (EFIAPI *EFI_SEC_PLATFORM_INFORMATION) (
  71   IN EFI_PEI_SERVICES                      **PeiServices,
  72   IN OUT UINT64                            *StructureSize,
  73   OUT EFI_SEC_PLATFORM_INFORMATION_RECORD  *PlatformInformationRecord
  74   );
  75
  76 /**
  77   @par Ppi Description:
  78
  79   @param Name
  80
  81 **/
  82 struct _EFI_SEC_PLATFORM_INFORMATION_PPI {
  83   EFI_SEC_PLATFORM_INFORMATION  PlatformInformation;
  84 };
  85
  86 #endif