| 1 | /* |
| 2 | * tpm.h - TPM ACPI definitions |
| 3 | * |
| 4 | * Copyright (C) 2014 IBM Corporation |
| 5 | * |
| 6 | * Authors: |
| 7 | * Stefan Berger <stefanb@us.ibm.com> |
| 8 | * |
| 9 | * This work is licensed under the terms of the GNU GPL, version 2 or later. |
| 10 | * See the COPYING file in the top-level directory. |
| 11 | * |
| 12 | * Implementation of the TIS interface according to specs found at |
| 13 | * http://www.trustedcomputinggroup.org |
| 14 | * |
| 15 | */ |
| 16 | #ifndef HW_ACPI_TPM_H |
| 17 | #define HW_ACPI_TPM_H |
| 18 | |
| 19 | #include "qemu/units.h" |
| 20 | #include "hw/core/registerfields.h" |
| 21 | #include "hw/acpi/aml-build.h" |
| 22 | #include "system/tpm.h" |
| 23 | #include "exec/hwaddr.h" |
| 24 | |
| 25 | #ifdef CONFIG_TPM |
| 26 | |
| 27 | #define TPM_TIS_ADDR_BASE 0xFED40000 |
| 28 | #define TPM_TIS_ADDR_SIZE 0x5000 |
| 29 | |
| 30 | #define TPM_TIS_IRQ 5 |
| 31 | |
| 32 | #define TPM_TIS_NUM_LOCALITIES 5 /* per spec */ |
| 33 | #define TPM_TIS_LOCALITY_SHIFT 12 |
| 34 | |
| 35 | /* tis registers */ |
| 36 | #define TPM_TIS_REG_ACCESS 0x00 |
| 37 | #define TPM_TIS_REG_INT_ENABLE 0x08 |
| 38 | #define TPM_TIS_REG_INT_VECTOR 0x0c |
| 39 | #define TPM_TIS_REG_INT_STATUS 0x10 |
| 40 | #define TPM_TIS_REG_INTF_CAPABILITY 0x14 |
| 41 | #define TPM_TIS_REG_STS 0x18 |
| 42 | #define TPM_TIS_REG_DATA_FIFO 0x24 |
| 43 | #define TPM_TIS_REG_INTERFACE_ID 0x30 |
| 44 | #define TPM_TIS_REG_DATA_XFIFO 0x80 |
| 45 | #define TPM_TIS_REG_DATA_XFIFO_END 0xbc |
| 46 | #define TPM_TIS_REG_DID_VID 0xf00 |
| 47 | #define TPM_TIS_REG_RID 0xf04 |
| 48 | |
| 49 | /* vendor-specific registers */ |
| 50 | #define TPM_TIS_REG_DEBUG 0xf90 |
| 51 | |
| 52 | #define TPM_TIS_STS_TPM_FAMILY_MASK (0x3 << 26)/* TPM 2.0 */ |
| 53 | #define TPM_TIS_STS_TPM_FAMILY1_2 (0 << 26) /* TPM 2.0 */ |
| 54 | #define TPM_TIS_STS_TPM_FAMILY2_0 (1 << 26) /* TPM 2.0 */ |
| 55 | #define TPM_TIS_STS_RESET_ESTABLISHMENT_BIT (1 << 25) /* TPM 2.0 */ |
| 56 | #define TPM_TIS_STS_COMMAND_CANCEL (1 << 24) /* TPM 2.0 */ |
| 57 | |
| 58 | #define TPM_TIS_STS_VALID (1 << 7) |
| 59 | #define TPM_TIS_STS_COMMAND_READY (1 << 6) |
| 60 | #define TPM_TIS_STS_TPM_GO (1 << 5) |
| 61 | #define TPM_TIS_STS_DATA_AVAILABLE (1 << 4) |
| 62 | #define TPM_TIS_STS_EXPECT (1 << 3) |
| 63 | #define TPM_TIS_STS_SELFTEST_DONE (1 << 2) |
| 64 | #define TPM_TIS_STS_RESPONSE_RETRY (1 << 1) |
| 65 | |
| 66 | #define TPM_TIS_BURST_COUNT_SHIFT 8 |
| 67 | #define TPM_TIS_BURST_COUNT(X) \ |
| 68 | ((X) << TPM_TIS_BURST_COUNT_SHIFT) |
| 69 | |
| 70 | #define TPM_TIS_ACCESS_TPM_REG_VALID_STS (1 << 7) |
| 71 | #define TPM_TIS_ACCESS_ACTIVE_LOCALITY (1 << 5) |
| 72 | #define TPM_TIS_ACCESS_BEEN_SEIZED (1 << 4) |
| 73 | #define TPM_TIS_ACCESS_SEIZE (1 << 3) |
| 74 | #define TPM_TIS_ACCESS_PENDING_REQUEST (1 << 2) |
| 75 | #define TPM_TIS_ACCESS_REQUEST_USE (1 << 1) |
| 76 | #define TPM_TIS_ACCESS_TPM_ESTABLISHMENT (1 << 0) |
| 77 | |
| 78 | #define TPM_TIS_INT_ENABLED (1 << 31) |
| 79 | #define TPM_TIS_INT_DATA_AVAILABLE (1 << 0) |
| 80 | #define TPM_TIS_INT_STS_VALID (1 << 1) |
| 81 | #define TPM_TIS_INT_LOCALITY_CHANGED (1 << 2) |
| 82 | #define TPM_TIS_INT_COMMAND_READY (1 << 7) |
| 83 | |
| 84 | #define TPM_TIS_INT_POLARITY_MASK (3 << 3) |
| 85 | #define TPM_TIS_INT_POLARITY_LOW_LEVEL (1 << 3) |
| 86 | |
| 87 | #define TPM_TIS_INTERRUPTS_SUPPORTED (TPM_TIS_INT_LOCALITY_CHANGED | \ |
| 88 | TPM_TIS_INT_DATA_AVAILABLE | \ |
| 89 | TPM_TIS_INT_STS_VALID | \ |
| 90 | TPM_TIS_INT_COMMAND_READY) |
| 91 | |
| 92 | #define TPM_TIS_CAP_INTERFACE_VERSION1_3 (2 << 28) |
| 93 | #define TPM_TIS_CAP_INTERFACE_VERSION1_3_FOR_TPM2_0 (3 << 28) |
| 94 | #define TPM_TIS_CAP_DATA_TRANSFER_64B (3 << 9) |
| 95 | #define TPM_TIS_CAP_DATA_TRANSFER_LEGACY (0 << 9) |
| 96 | #define TPM_TIS_CAP_BURST_COUNT_DYNAMIC (0 << 8) |
| 97 | #define TPM_TIS_CAP_BURST_COUNT_STATIC (1 << 8) |
| 98 | #define TPM_TIS_CAP_INTERRUPT_LOW_LEVEL (1 << 4) /* support is mandatory */ |
| 99 | #define TPM_TIS_CAPABILITIES_SUPPORTED1_3 \ |
| 100 | (TPM_TIS_CAP_INTERRUPT_LOW_LEVEL | \ |
| 101 | TPM_TIS_CAP_BURST_COUNT_DYNAMIC | \ |
| 102 | TPM_TIS_CAP_DATA_TRANSFER_64B | \ |
| 103 | TPM_TIS_CAP_INTERFACE_VERSION1_3 | \ |
| 104 | TPM_TIS_INTERRUPTS_SUPPORTED) |
| 105 | |
| 106 | #define TPM_TIS_CAPABILITIES_SUPPORTED2_0 \ |
| 107 | (TPM_TIS_CAP_INTERRUPT_LOW_LEVEL | \ |
| 108 | TPM_TIS_CAP_BURST_COUNT_DYNAMIC | \ |
| 109 | TPM_TIS_CAP_DATA_TRANSFER_64B | \ |
| 110 | TPM_TIS_CAP_INTERFACE_VERSION1_3_FOR_TPM2_0 | \ |
| 111 | TPM_TIS_INTERRUPTS_SUPPORTED) |
| 112 | |
| 113 | #define TPM_TIS_IFACE_ID_INTERFACE_TIS1_3 (0xf) /* TPM 2.0 */ |
| 114 | #define TPM_TIS_IFACE_ID_INTERFACE_FIFO (0x0) /* TPM 2.0 */ |
| 115 | #define TPM_TIS_IFACE_ID_INTERFACE_VER_FIFO (0 << 4) /* TPM 2.0 */ |
| 116 | #define TPM_TIS_IFACE_ID_CAP_5_LOCALITIES (1 << 8) /* TPM 2.0 */ |
| 117 | #define TPM_TIS_IFACE_ID_CAP_TIS_SUPPORTED (1 << 13) /* TPM 2.0 */ |
| 118 | #define TPM_TIS_IFACE_ID_INT_SEL_LOCK (1 << 19) /* TPM 2.0 */ |
| 119 | |
| 120 | #define TPM_TIS_IFACE_ID_SUPPORTED_FLAGS1_3 \ |
| 121 | (TPM_TIS_IFACE_ID_INTERFACE_TIS1_3 | \ |
| 122 | (~0u << 4)/* all of it is don't care */) |
| 123 | |
| 124 | /* if backend was a TPM 2.0: */ |
| 125 | #define TPM_TIS_IFACE_ID_SUPPORTED_FLAGS2_0 \ |
| 126 | (TPM_TIS_IFACE_ID_INTERFACE_FIFO | \ |
| 127 | TPM_TIS_IFACE_ID_INTERFACE_VER_FIFO | \ |
| 128 | TPM_TIS_IFACE_ID_CAP_5_LOCALITIES | \ |
| 129 | TPM_TIS_IFACE_ID_CAP_TIS_SUPPORTED) |
| 130 | |
| 131 | #define TPM_TIS_TPM_DID 0x0001 |
| 132 | #define TPM_TIS_TPM_VID PCI_VENDOR_ID_IBM |
| 133 | #define TPM_TIS_TPM_RID 0x0001 |
| 134 | |
| 135 | #define TPM_TIS_NO_DATA_BYTE 0xff |
| 136 | |
| 137 | |
| 138 | REG32(CRB_LOC_STATE, 0x00) |
| 139 | FIELD(CRB_LOC_STATE, tpmEstablished, 0, 1) |
| 140 | FIELD(CRB_LOC_STATE, locAssigned, 1, 1) |
| 141 | FIELD(CRB_LOC_STATE, activeLocality, 2, 3) |
| 142 | FIELD(CRB_LOC_STATE, reserved, 5, 2) |
| 143 | FIELD(CRB_LOC_STATE, tpmRegValidSts, 7, 1) |
| 144 | REG32(CRB_LOC_CTRL, 0x08) |
| 145 | REG32(CRB_LOC_STS, 0x0C) |
| 146 | FIELD(CRB_LOC_STS, Granted, 0, 1) |
| 147 | FIELD(CRB_LOC_STS, beenSeized, 1, 1) |
| 148 | REG32(CRB_INTF_ID, 0x30) |
| 149 | FIELD(CRB_INTF_ID, InterfaceType, 0, 4) |
| 150 | FIELD(CRB_INTF_ID, InterfaceVersion, 4, 4) |
| 151 | FIELD(CRB_INTF_ID, CapLocality, 8, 1) |
| 152 | FIELD(CRB_INTF_ID, CapCRBIdleBypass, 9, 1) |
| 153 | FIELD(CRB_INTF_ID, CapCRBChunk, 10, 1) |
| 154 | FIELD(CRB_INTF_ID, CapDataXferSizeSupport, 11, 2) |
| 155 | FIELD(CRB_INTF_ID, CapFIFO, 13, 1) |
| 156 | FIELD(CRB_INTF_ID, CapCRB, 14, 1) |
| 157 | FIELD(CRB_INTF_ID, CapIFRes, 15, 2) |
| 158 | FIELD(CRB_INTF_ID, InterfaceSelector, 17, 2) |
| 159 | FIELD(CRB_INTF_ID, IntfSelLock, 19, 1) |
| 160 | FIELD(CRB_INTF_ID, Reserved2, 20, 4) |
| 161 | FIELD(CRB_INTF_ID, RID, 24, 8) |
| 162 | REG32(CRB_INTF_ID2, 0x34) |
| 163 | FIELD(CRB_INTF_ID2, VID, 0, 16) |
| 164 | FIELD(CRB_INTF_ID2, DID, 16, 16) |
| 165 | REG32(CRB_CTRL_EXT, 0x38) |
| 166 | REG32(CRB_CTRL_REQ, 0x40) |
| 167 | REG32(CRB_CTRL_STS, 0x44) |
| 168 | FIELD(CRB_CTRL_STS, tpmSts, 0, 1) |
| 169 | FIELD(CRB_CTRL_STS, tpmIdle, 1, 1) |
| 170 | REG32(CRB_CTRL_CANCEL, 0x48) |
| 171 | REG32(CRB_CTRL_START, 0x4C) |
| 172 | FIELD(CRB_CTRL_START, Start, 0, 1) |
| 173 | FIELD(CRB_CTRL_START, crbRspRetry, 1, 1) |
| 174 | FIELD(CRB_CTRL_START, nextChunk, 2, 1) |
| 175 | REG32(CRB_INT_ENABLED, 0x50) |
| 176 | REG32(CRB_INT_STS, 0x54) |
| 177 | REG32(CRB_CTRL_CMD_SIZE, 0x58) |
| 178 | REG32(CRB_CTRL_CMD_LADDR, 0x5C) |
| 179 | REG32(CRB_CTRL_CMD_HADDR, 0x60) |
| 180 | REG32(CRB_CTRL_RSP_SIZE, 0x64) |
| 181 | REG32(CRB_CTRL_RSP_ADDR, 0x68) |
| 182 | REG32(CRB_DATA_BUFFER, 0x80) |
| 183 | |
| 184 | #define TPM_CRB_ADDR_BASE 0xFED40000 |
| 185 | #define TPM_CRB_ADDR_SIZE 0x1000 |
| 186 | #define TPM_CRB_ADDR_CTRL (TPM_CRB_ADDR_BASE + A_CRB_CTRL_REQ) |
| 187 | #define TPM_CRB_R_MAX R_CRB_DATA_BUFFER |
| 188 | |
| 189 | #define TPM_LOG_AREA_MINIMUM_SIZE (64 * KiB) |
| 190 | |
| 191 | #define TPM_TCPA_ACPI_CLASS_CLIENT 0 |
| 192 | #define TPM_TCPA_ACPI_CLASS_SERVER 1 |
| 193 | |
| 194 | #define TPM2_ACPI_CLASS_CLIENT 0 |
| 195 | #define TPM2_ACPI_CLASS_SERVER 1 |
| 196 | |
| 197 | #define TPM2_START_METHOD_MMIO 6 |
| 198 | #define TPM2_START_METHOD_CRB 7 |
| 199 | |
| 200 | /* |
| 201 | * Physical Presence Interface |
| 202 | */ |
| 203 | #define TPM_PPI_ADDR_SIZE 0x400 |
| 204 | #define TPM_PPI_ADDR_BASE 0xFED45000 |
| 205 | |
| 206 | #define TPM_PPI_VERSION_NONE 0 |
| 207 | #define TPM_PPI_VERSION_1_30 1 |
| 208 | |
| 209 | /* whether function is blocked by BIOS settings; bits 0, 1, 2 */ |
| 210 | #define TPM_PPI_FUNC_NOT_IMPLEMENTED (0 << 0) |
| 211 | #define TPM_PPI_FUNC_BIOS_ONLY (1 << 0) |
| 212 | #define TPM_PPI_FUNC_BLOCKED (2 << 0) |
| 213 | #define TPM_PPI_FUNC_ALLOWED_USR_REQ (3 << 0) |
| 214 | #define TPM_PPI_FUNC_ALLOWED_USR_NOT_REQ (4 << 0) |
| 215 | #define TPM_PPI_FUNC_MASK (7 << 0) |
| 216 | |
| 217 | /* TPM TIS I2C registers */ |
| 218 | #define TPM_I2C_REG_LOC_SEL 0x00 |
| 219 | #define TPM_I2C_REG_ACCESS 0x04 |
| 220 | #define TPM_I2C_REG_INT_ENABLE 0x08 |
| 221 | #define TPM_I2C_REG_INT_CAPABILITY 0x14 |
| 222 | #define TPM_I2C_REG_STS 0x18 |
| 223 | #define TPM_I2C_REG_DATA_FIFO 0x24 |
| 224 | #define TPM_I2C_REG_INTF_CAPABILITY 0x30 |
| 225 | #define TPM_I2C_REG_I2C_DEV_ADDRESS 0x38 |
| 226 | #define TPM_I2C_REG_DATA_CSUM_ENABLE 0x40 |
| 227 | #define TPM_I2C_REG_DATA_CSUM_GET 0x44 |
| 228 | #define TPM_I2C_REG_DID_VID 0x48 |
| 229 | #define TPM_I2C_REG_RID 0x4c |
| 230 | #define TPM_I2C_REG_UNKNOWN 0xff |
| 231 | |
| 232 | /* I2C specific interface capabilities */ |
| 233 | #define TPM_I2C_CAP_INTERFACE_TYPE (0x2 << 0) /* FIFO interface */ |
| 234 | #define TPM_I2C_CAP_INTERFACE_VER (0x0 << 4) /* TCG I2C intf 1.0 */ |
| 235 | #define TPM_I2C_CAP_TPM2_FAMILY (0x1 << 7) /* TPM 2.0 family. */ |
| 236 | #define TPM_I2C_CAP_DEV_ADDR_CHANGE (0x0 << 27) /* No dev addr chng */ |
| 237 | #define TPM_I2C_CAP_BURST_COUNT_STATIC (0x1 << 29) /* Burst count static */ |
| 238 | #define TPM_I2C_CAP_LOCALITY_CAP (0x1 << 25) /* 0-5 locality */ |
| 239 | #define TPM_I2C_CAP_BUS_SPEED (3 << 21) /* std and fast mode */ |
| 240 | |
| 241 | /* |
| 242 | * TPM_I2C_STS masks for read/writing bits from/to TIS |
| 243 | * TPM_STS mask for read bits 31:26 must be zero |
| 244 | */ |
| 245 | #define TPM_I2C_STS_READ_MASK 0x00ffffdd |
| 246 | #define TPM_I2C_STS_WRITE_MASK 0x03000062 |
| 247 | |
| 248 | /* Checksum enabled. */ |
| 249 | #define TPM_DATA_CSUM_ENABLED 0x1 |
| 250 | |
| 251 | /* |
| 252 | * TPM_I2C_INT_ENABLE mask. Linux kernel does not support |
| 253 | * interrupts hence setting it to 0. |
| 254 | */ |
| 255 | #define TPM_I2C_INT_ENABLE_MASK 0x0 |
| 256 | |
| 257 | void tpm_build_ppi_acpi(TPMIf *tpm, Aml *dev, hwaddr ppi_base); |
| 258 | |
| 259 | #endif /* CONFIG_TPM */ |
| 260 | |
| 261 | #endif /* HW_ACPI_TPM_H */ |