/* $NetBSD: tpmreg.h,v 1.12 2025/10/31 03:25:16 riastradh Exp $ */ /* * Copyright (c) 2019 The NetBSD Foundation, Inc. * All rights reserved. * * This code is derived from software contributed to The NetBSD Foundation * by Maxime Villard. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #ifndef DEV_IC_TPMREG_H #define DEV_IC_TPMREG_H #include #include #include /* * For TPM 1.2: * * [TPM12-MAIN] Trusted Computing Group, TPM 1.2 Main Specification * Level 2 Version 1.2, Revision 116, 2011-03-01 * https://trustedcomputinggroup.org/resource/tpm-main-specification/ * * Part 1: Design Principles * https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-1-Design-Principles_v1.2_rev116_01032011.pdf * https://web.archive.org/web/20250826195140/https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-1-Design-Principles_v1.2_rev116_01032011.pdf * * Part 2: Structures * https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-2-TPM-Structures_v1.2_rev116_01032011.pdf * https://web.archive.org/web/20250703130940/https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-2-TPM-Structures_v1.2_rev116_01032011.pdf * * Part 3: Commands * https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-3-Commands_v1.2_rev116_01032011.pdf * https://web.archive.org/web/20250525060937/https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-3-Commands_v1.2_rev116_01032011.pdf */ /* * For TPM 2.0: * * [TPM20-LIB] Trusted Platform Module Library Specification, Family * "2.0", Level 00, Revision 01.59, 2019-11-08 * https://trustedcomputinggroup.org/resource/tpm-library-specification/ * * Part 1: Architecture * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part1_Architecture_pub.pdf * https://web.archive.org/web/20250907234549/https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part1_Architecture_pub.pdf * * Part 2: Structures * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part2_Structures_pub.pdf * https://web.archive.org/web/20250828045221/https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part2_Structures_pub.pdf * * Part 3: Commands * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part3_Commands_pub.pdf * https://web.archive.org/web/20250912171331/https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part3_Commands_pub.pdf * * Part 3: Commands - Code * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part3_Commands_code_pub.pdf * https://web.archive.org/web/20250528214911/https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part3_Commands_code_pub.pdf * * Part 4: Supporting Routines * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part4_SuppRoutines_pub.pdf * https://web.archive.org/web/20250528222136/https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part4_SuppRoutines_pub.pdf * * Part 4: Supporting Routines - Code * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part4_SuppRoutines_code_pub.pdf * https://web.archive.org/web/20250528222555/https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part4_SuppRoutines_code_pub.pdf */ /* * TPM command response header. * * For TPM 1.2: * * [TPM12-MAIN], Part 2 `Structures', Sec. 16 `Return Codes', * pp. 118-119 * https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-2-TPM-Structures_v1.2_rev116_01032011.pdf#page=130 * * For TPM 2.0: * * [TPM20-LIB], Part 2 `Structures', Sec. 6.6 `TPM_RC (Response * Codes)', p. 35 * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part2_Structures_pub.pdf#page=51 */ struct tpm_header { uint16_t tag; uint32_t length; uint32_t code; } __packed; /* ------------------------------------------------------------------------- */ /* * TPM register space * * For TPM 1.2: * * [TPM12-TIS] Trusted Computing Group, TCG PC Client Specific TPM * Interface Specification (TIS), Version 1.2 Final, Revision 1.00, For * TPM Family 1.2; Level 2, 2005-07-11, Sec. 10 `TPM Register Space', * pp. 33-36. * https://trustedcomputinggroup.org/wp-content/uploads/TCG_PCClientTPMSpecification_1-20_1-00_FINAL.pdf#page=33 * https://web.archive.org/web/20250109145957/https://trustedcomputinggroup.org/wp-content/uploads/TCG_PCClientTPMSpecification_1-20_1-00_FINAL.pdf * * For TPM 2.0: * * [TPM20-TIS] Trusted Computing Group, TCG PC Client Specific TPM * Interface Specification (TIS), Specification Version 1.3, * 2013-03-21, Sec. 5.4 `TPM Register Space', pp. 37--44. * https://trustedcomputinggroup.org/wp-content/uploads/TCG_PCClientTPMInterfaceSpecification_TIS__1-3_27_03212013.pdf#page=37 * https://web.archive.org/web/20250523052753/https://trustedcomputinggroup.org/wp-content/uploads/TCG_PCClientTPMInterfaceSpecification_TIS__1-3_27_03212013.pdf */ #define TPM_ACCESS 0x0000 /* 8bit register */ #define TPM_ACCESS_VALID __BIT(7) #define TPM_ACCESS_ACTIVE_LOCALITY __BIT(5) #define TPM_ACCESS_BEEN_SEIZED __BIT(4) #define TPM_ACCESS_SEIZE __BIT(3) #define TPM_ACCESS_PENDING_REQUEST __BIT(2) #define TPM_ACCESS_REQUEST_USE __BIT(1) #define TPM_ACCESS_ESTABLISHMENT __BIT(0) #define TPM_INT_ENABLE 0x0008 /* 32bit register */ #define TPM_GLOBAL_INT_ENABLE __BIT(31) #define TPM_CMD_READY_INT __BIT(7) #define TPM_TYPE_POLARITY __BITS(4,3) #define TPM_INT_LEVEL_HIGH __SHIFTIN(0, TPM_TYPE_POLARITY) #define TPM_INT_LEVEL_LOW __SHIFTIN(1, TPM_TYPE_POLARITY) #define TPM_INT_EDGE_RISING __SHIFTIN(2, TPM_TYPE_POLARITY) #define TPM_INT_EDGE_FALLING __SHIFTIN(3, TPM_TYPE_POLARITY) #define TPM_LOCALITY_CHANGE_INT __BIT(2) #define TPM_STS_VALID_INT __BIT(1) #define TPM_DATA_AVAIL_INT __BIT(0) #define TPM_INT_VECTOR 0x000c /* 8bit register */ #define TPM_INT_STATUS 0x0010 /* 32bit register */ #define TPM_INTF_CAPABILITY 0x0014 /* 32bit register */ #define TPM_INTF_BURST_COUNT_STATIC __BIT(8) #define TPM_INTF_CMD_READY_INT __BIT(7) #define TPM_INTF_INT_EDGE_FALLING __BIT(6) #define TPM_INTF_INT_EDGE_RISING __BIT(5) #define TPM_INTF_INT_LEVEL_LOW __BIT(4) #define TPM_INTF_INT_LEVEL_HIGH __BIT(3) #define TPM_INTF_LOCALITY_CHANGE_INT __BIT(2) #define TPM_INTF_STS_VALID_INT __BIT(1) #define TPM_INTF_DATA_AVAIL_INT __BIT(0) #define TPM_INTF_CAPABILITY_BITS \ "\020\01IDRDY\02ISTSV\03ILOCH\04IHIGH\05ILOW\06IRISE\07IFALL\010IRDY\011BCST" #define TPM_STS 0x0018 /* 24bit register */ #define TPM_STS_BURST_COUNT __BITS(23,8) #define TPM_STS_STATUS_BITS __BITS(7,0) #define TPM_STS_VALID __BIT(7) #define TPM_STS_CMD_READY __BIT(6) #define TPM_STS_GO __BIT(5) #define TPM_STS_DATA_AVAIL __BIT(4) #define TPM_STS_DATA_EXPECT __BIT(3) #define TPM_STS_SELFTEST_DONE __BIT(2) #define TPM_STS_RESP_RETRY __BIT(1) #define TPM_DATA 0x0024 /* 32bit register */ #define TPM_ID 0x0f00 /* 32bit register */ #define TPM_REV 0x0f04 /* 8bit register */ /* * Five localities, 4K per locality. But we only use the registers for * the first locality, so this is 0x1000 rather than 0x5000. */ #define TPM_SPACE_SIZE 0x1000 /* ------------------------------------------------------------------------- */ /* * TPM 1.2 commands and responses */ /* * [TPM12-MAIN], Sec. 6 `TPM_TAG (Command and Response Tags)', p. 46 * https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-2-TPM-Structures_v1.2_rev116_01032011.pdf#page=46 */ #define TPM_TAG_RQU_COMMAND 0x00c1 #define TPM_TAG_RSP_COMMAND 0x00c4 /* * [TPM12-MAIN], Sec. 17 `Ordinals', pp. 136--132 * https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-2-TPM-Structures_v1.2_rev116_01032011.pdf#page=136 */ #define TPM_ORD_GetRandom 0x00000046 /* * TPM_RESULT return codes, from [TPM12-MAIN], Sec. 16 `Return Codes', * Table `TPM-defined fatal error codes', pp. 121--123 * https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-2-TPM-Structures_v1.2_rev116_01032011.pdf#page=133 */ #define TPM_AUTHFAIL 1 #define TPM_BADINDEX 2 #define TPM_BAD_PARAMETER 3 #define TPM_AUDITFAILURE 4 #define TPM_CLEAR_DISABLED 5 #define TPM_DEACTIVATED 6 #define TPM_DISABLED 7 #define TPM_DISABLED_CMD 8 #define TPM_FAIL 9 #define TPM_BAD_ORDINAL 10 /* ... */ /* * [TPM12-MAIN], Sec. 16 `Return Codes', Table `Mask Parameters', * p. 120 * https://trustedcomputinggroup.org/wp-content/uploads/TPM-Main-Part-2-TPM-Structures_v1.2_rev116_01032011.pdf#page=132 */ #define TPM_NON_FATAL 0x800 /* ------------------------------------------------------------------------- */ /* * TPM 2.0 commands and responses * * Where the TPM 2.0 spec names things TPM_* that don't obviously * coincide with the 1.2 things, we name them TPM2_*. */ /* * [TPM20-LIB], Part 2 `Structures`, Sec. 6.9 `TPM_ST (Structure * Tags)', pp. 44--46 * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part2_Structures_pub.pdf#page=60 */ #define TPM2_ST_RSP_COMMAND 0x00c4 #define TPM2_ST_NULL 0x8000 #define TPM2_ST_NO_SESSIONS 0x8001 #define TPM2_ST_SESSIONS 0x8002 /* ... */ /* * [TPM20-LIB], Part 2 `Structures', Sec. 6.5.2 `TPM_CC Listing', * pp. 31--34 * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part2_Structures_pub.pdf#page=49 */ #define TPM2_CC_GetRandom 0x0000017b /* * [TPM20-LIB], Part 3 `Structures', Sec. 6.6.3 `TPM_RC Values', * pp. 38--42 * https://trustedcomputinggroup.org/wp-content/uploads/TCG_TPM2_r1p59_Part2_Structures_pub.pdf#page=54 */ #define TPM2_RC_SUCCESS 0x000 #define TPM2_RC_BAD_TAG 0x01e #define TPM2_RC_VER1 0x100 #define TPM2_RC_FMT1 0x080 #define TPM2_RC_WARN 0x900 #define TPM2_RC_TESTING (TPM2_RC_WARN + 0x00a) #define TPM2_RC_RETRY (TPM2_RC_WARN + 0x022) #endif /* DEV_IC_TPMREG_H */