INF module description added

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Tpm12.h

/** @file   \r
  TPM Specification data structures (TCG TPM Specification Version 1.2 Revision 94)\r
  See http://trustedcomputinggroup.org for latest specification updates\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation\r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
**/\r
\r
\r
#ifndef _TPM12_H_\r
#define _TPM12_H_\r
\r
///\r
/// The start of TPM return codes\r
///\r
#define TPM_BASE                    (EFI_MAX_BIT + (EFI_MAX_BIT >> 1))\r
\r
//\r
// All structures MUST be packed on a byte boundary.\r
//\r
\r
#pragma pack (1)\r
\r
//\r
// Part 2, section 2.2.3: Helper redefinitions\r
//\r
///\r
/// Indicates the conditions where it is required that authorization be presented\r
///\r
typedef UINT8                       TPM_AUTH_DATA_USAGE;\r
///\r
/// The information as to what the payload is in an encrypted structure\r
///\r
typedef UINT8                       TPM_PAYLOAD_TYPE;\r
///\r
/// The version info breakdown\r
///\r
typedef UINT8                       TPM_VERSION_BYTE;\r
///\r
/// The request or response authorization type\r
///\r
typedef UINT16                      TPM_TAG;\r
///\r
/// The protocol in use\r
///\r
typedef UINT16                      TPM_PROTOCOL_ID;\r
///\r
/// Indicates the start state\r
///\r
typedef UINT16                      TPM_STARTUP_TYPE;\r
///\r
/// The definition of the encryption scheme\r
///\r
typedef UINT16                      TPM_ENC_SCHEME;\r
///\r
/// The definition of the signature scheme\r
///\r
typedef UINT16                      TPM_SIG_SCHEME;\r
///\r
/// The definition of the migration scheme\r
///\r
typedef UINT16                      TPM_MIGRATE_SCHEME;\r
///\r
/// Sets the state of the physical presence mechanism\r
///\r
typedef UINT16                      TPM_PHYSICAL_PRESENCE;\r
///\r
/// Indicates the types of entity that are supported by the TPM\r
///\r
typedef UINT16                      TPM_ENTITY_TYPE;\r
///\r
/// Indicates the permitted usage of the key\r
///\r
typedef UINT16                      TPM_KEY_USAGE;\r
///\r
/// The type of asymmetric encrypted structure in use by the endorsement key\r
///\r
typedef UINT16                      TPM_EK_TYPE;\r
///\r
/// The tag for the structure\r
///\r
typedef UINT16                      TPM_STRUCTURE_TAG;\r
///\r
/// The platform specific spec to which the information relates to\r
///\r
typedef UINT16                      TPM_PLATFORM_SPECIFIC;\r
///\r
/// The command ordinal\r
///\r
typedef UINT32                      TPM_COMMAND_CODE;\r
///\r
/// Identifies a TPM capability area\r
///\r
typedef UINT32                      TPM_CAPABILITY_AREA;\r
///\r
/// Indicates information regarding a key\r
///\r
typedef UINT32                      TPM_KEY_FLAGS;\r
///\r
/// Indicates the type of algorithm\r
///\r
typedef UINT32                      TPM_ALGORITHM_ID;\r
///\r
/// The locality modifier\r
///\r
typedef UINT32                      TPM_MODIFIER_INDICATOR;\r
///\r
/// The actual number of a counter\r
///\r
typedef UINT32                      TPM_ACTUAL_COUNT;\r
///\r
/// Attributes that define what options are in use for a transport session\r
///\r
typedef UINT32                      TPM_TRANSPORT_ATTRIBUTES;\r
///\r
/// Handle to an authorization session\r
///\r
typedef UINT32                      TPM_AUTHHANDLE;\r
///\r
/// Index to a DIR register\r
///\r
typedef UINT32                      TPM_DIRINDEX;\r
///\r
/// The area where a key is held assigned by the TPM\r
///\r
typedef UINT32                      TPM_KEY_HANDLE;\r
///\r
/// Index to a PCR register\r
///\r
typedef UINT32                      TPM_PCRINDEX;\r
///\r
/// The return code from a function\r
///\r
typedef UINT32                      TPM_RESULT;\r
///\r
/// The types of resources that a TPM may have using internal resources\r
///\r
typedef UINT32                      TPM_RESOURCE_TYPE;\r
///\r
/// Allows for controlling of the key when loaded and how to handle TPM_Startup issues\r
///\r
typedef UINT32                      TPM_KEY_CONTROL;\r
///\r
/// The index into the NV storage area\r
///\r
typedef UINT32                      TPM_NV_INDEX;\r
///\r