SecurityPkg/Include/Guid/PhysicalPresenceData.h

   1 /** @file
   2   Define the variable data structures used for TCG physical presence.
   3   The TPM request from firmware or OS is saved to variable. And it is
   4   cleared after it is processed in the next boot cycle. The TPM response
   5   is saved to variable.
   6
   7 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
   8 This program and the accompanying materials
   9 are licensed and made available under the terms and conditions of the BSD License
  10 which accompanies this distribution.  The full text of the license may be found at
  11 http://opensource.org/licenses/bsd-license.php
  12
  13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16 **/
  17
  18 #ifndef __PHYSICAL_PRESENCE_DATA_GUID_H__
  19 #define __PHYSICAL_PRESENCE_DATA_GUID_H__
  20
  21 #define EFI_PHYSICAL_PRESENCE_DATA_GUID \
  22   { \
  23     0xf6499b1, 0xe9ad, 0x493d, { 0xb9, 0xc2, 0x2f, 0x90, 0x81, 0x5c, 0x6c, 0xbc }\
  24   }
  25
  26 #define PHYSICAL_PRESENCE_VARIABLE  L"PhysicalPresence"
  27
  28 typedef struct {
  29   UINT8   PPRequest;      ///< Physical Presence request command.
  30   UINT8   LastPPRequest;
  31   UINT32  PPResponse;
  32   UINT8   Flags;
  33 } EFI_PHYSICAL_PRESENCE;
  34
  35 //
  36 // The definition bit of the flags
  37 //
  38 #define FLAG_NO_PPI_PROVISION                    BIT0
  39 #define FLAG_NO_PPI_CLEAR                        BIT1
  40 #define FLAG_NO_PPI_MAINTENANCE                  BIT2
  41 #define FLAG_RESET_TRACK                         BIT3
  42
  43 #define H2NS(x)        ((((x) << 8) | ((x) >> 8)) & 0xffff)
  44 #define H2NL(x)        (H2NS ((x) >> 16) | (H2NS ((x) & 0xffff) << 16))
  45
  46 //
  47 // The definition of physical presence operation actions
  48 //
  49 #define NO_ACTION                               0
  50 #define ENABLE                                  1
  51 #define DISABLE                                 2
  52 #define ACTIVATE                                3
  53 #define DEACTIVATE                              4
  54 #define CLEAR                                   5
  55 #define ENABLE_ACTIVATE                         6
  56 #define DEACTIVATE_DISABLE                      7
  57 #define SET_OWNER_INSTALL_TRUE                  8
  58 #define SET_OWNER_INSTALL_FALSE                 9
  59 #define ENABLE_ACTIVATE_OWNER_TRUE              10
  60 #define DEACTIVATE_DISABLE_OWNER_FALSE          11
  61 #define DEFERRED_PP_UNOWNERED_FIELD_UPGRADE     12
  62 #define SET_OPERATOR_AUTH                       13
  63 #define CLEAR_ENABLE_ACTIVATE                   14
  64 #define SET_NO_PPI_PROVISION_FALSE              15
  65 #define SET_NO_PPI_PROVISION_TRUE               16
  66 #define SET_NO_PPI_CLEAR_FALSE                  17
  67 #define SET_NO_PPI_CLEAR_TRUE                   18
  68 #define SET_NO_PPI_MAINTENANCE_FALSE            19
  69 #define SET_NO_PPI_MAINTENANCE_TRUE             20
  70 #define ENABLE_ACTIVATE_CLEAR                   21
  71 #define ENABLE_ACTIVATE_CLEAR_ENABLE_ACTIVATE   22
  72
  73 extern EFI_GUID  gEfiPhysicalPresenceGuid;
  74
  75 #endif
  76