SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / Include / Ppi / LockPhysicalPresence.h

/** @file\r
  This file defines the lock physical Presence PPI. This PPI is\r
  produced by a platform specific PEIM and consumed by the TPM\r
  PEIM.\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __PEI_LOCK_PHYSICAL_PRESENCE_H__\r
#define __PEI_LOCK_PHYSICAL_PRESENCE_H__\r
\r
///\r
/// Global ID for the PEI_LOCK_PHYSICAL_PRESENCE_PPI_GUID.\r
///\r
#define PEI_LOCK_PHYSICAL_PRESENCE_PPI_GUID  \\r
  { \\r
    0xef9aefe5, 0x2bd3, 0x4031, { 0xaf, 0x7d, 0x5e, 0xfe, 0x5a, 0xbb, 0x9a, 0xd } \\r
  }\r
\r
///\r
/// Forward declaration for the PEI_LOCK_PHYSICAL_PRESENCE_PPI\r
///\r
typedef struct _PEI_LOCK_PHYSICAL_PRESENCE_PPI PEI_LOCK_PHYSICAL_PRESENCE_PPI;\r
\r
/**\r
  This interface returns whether TPM physical presence needs be locked.\r
\r
  @param[in]  PeiServices       The pointer to the PEI Services Table.\r
\r
  @retval     TRUE              The TPM physical presence should be locked.\r
  @retval     FALSE             The TPM physical presence cannot be locked.\r
\r
**/\r
typedef\r
BOOLEAN\r
(EFIAPI *PEI_LOCK_PHYSICAL_PRESENCE)(\r
  IN CONST  EFI_PEI_SERVICES                    **PeiServices\r
);\r
\r
///\r
/// This service abstracts TPM physical presence lock interface. It is necessary for\r
/// safety to convey this information to the TPM driver so that TPM physical presence\r
/// can be locked as early as possible. This PPI is produced by a platform specific\r
/// PEIM and consumed by the TPM PEIM.\r
///\r
struct _PEI_LOCK_PHYSICAL_PRESENCE_PPI {\r
  PEI_LOCK_PHYSICAL_PRESENCE  LockPhysicalPresence;\r
};\r
\r
extern EFI_GUID  gPeiLockPhysicalPresencePpiGuid;\r
\r
#endif  //  __PEI_LOCK_PHYSICAL_PRESENCE_H__\r