1 /*- 2 * Copyright (c) 2018 Stormshield. 3 * Copyright (c) 2018 Semihalf. 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 17 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 18 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 19 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 20 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 23 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 24 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25 * POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #ifndef _TPM20_H_ 29 #define _TPM20_H_ 30 31 #include "opt_acpi.h" 32 #include <sys/cdefs.h> 33 #include <sys/endian.h> 34 #include <sys/param.h> 35 #include <sys/kernel.h> 36 #include <sys/malloc.h> 37 #include <sys/proc.h> 38 #include <sys/systm.h> 39 40 #include <sys/bus.h> 41 #include <sys/callout.h> 42 #include <sys/conf.h> 43 #include <sys/lock.h> 44 #include <sys/module.h> 45 #include <sys/rman.h> 46 #include <sys/sx.h> 47 #include <sys/taskqueue.h> 48 #include <sys/uio.h> 49 50 #include <machine/bus.h> 51 #include <machine/md_var.h> 52 #include <machine/resource.h> 53 54 #ifdef DEV_ACPI 55 #include <contrib/dev/acpica/include/acpi.h> 56 #include <contrib/dev/acpica/include/accommon.h> 57 #include <dev/acpica/acpivar.h> 58 #endif 59 60 #include "opt_tpm.h" 61 #include "tpm_if.h" 62 63 #define BIT(x) (1 << (x)) 64 65 /* Timeouts in us */ 66 #define TPM_TIMEOUT_A 750000 67 #define TPM_TIMEOUT_B 2000000 68 #define TPM_TIMEOUT_C 200000 69 #define TPM_TIMEOUT_D 30000 70 71 /* 72 * Generating RSA key pair takes ~(10-20s), which is significantly longer than 73 * any timeout defined in spec. Because of that we need a new one. 74 */ 75 #define TPM_TIMEOUT_LONG 40000000 76 77 /* List of commands that require TPM_TIMEOUT_LONG time to complete */ 78 #define TPM_CC_CreatePrimary 0x00000131 79 #define TPM_CC_Create 0x00000153 80 #define TPM_CC_CreateLoaded 0x00000191 81 82 /* List of commands that require only TPM_TIMEOUT_C time to complete */ 83 #define TPM_CC_SequenceComplete 0x0000013e 84 #define TPM_CC_Startup 0x00000144 85 #define TPM_CC_SequenceUpdate 0x0000015c 86 #define TPM_CC_GetCapability 0x0000017a 87 #define TPM_CC_PCR_Extend 0x00000182 88 #define TPM_CC_EventSequenceComplete 0x00000185 89 #define TPM_CC_HashSequenceStart 0x00000186 90 91 /* Timeout before data in read buffer is discarded */ 92 #define TPM_READ_TIMEOUT 500000 93 94 #define TPM_BUFSIZE 0x1000 95 96 #define TPM_HEADER_SIZE 10 97 98 #define TPM_CDEV_NAME "tpm0" 99 #define TPM_CDEV_PERM_FLAG 0600 100 101 #define TPM2_START_METHOD_ACPI 2 102 #define TPM2_START_METHOD_TIS 6 103 #define TPM2_START_METHOD_CRB 7 104 #define TPM2_START_METHOD_CRB_ACPI 8 105 106 MALLOC_DECLARE(M_TPM20); 107 108 struct tpm_sc { 109 device_t dev; 110 111 struct resource *mem_res; 112 struct resource *irq_res; 113 int mem_rid; 114 int irq_rid; 115 116 struct cdev *sc_cdev; 117 118 struct sx dev_lock; 119 struct cv buf_cv; 120 121 void *intr_cookie; 122 int intr_type; /* Current event type */ 123 bool interrupts; 124 125 uint8_t *buf; 126 size_t pending_data_length; 127 size_t total_length; 128 lwpid_t owner_tid; 129 130 struct callout discard_buffer_callout; 131 #ifdef TPM_HARVEST 132 struct timeout_task harvest_task; 133 #endif 134 135 int (*transmit)(struct tpm_sc *, size_t); 136 }; 137 138 int tpm20_suspend(device_t dev); 139 int tpm20_shutdown(device_t dev); 140 int32_t tpm20_get_timeout(uint32_t command); 141 int tpm20_init(struct tpm_sc *sc); 142 void tpm20_release(struct tpm_sc *sc); 143 144 /* Mode driver types */ 145 DECLARE_CLASS(tpmtis_driver); 146 int tpmtis_attach(device_t dev); 147 148 DECLARE_CLASS(tpmcrb_driver); 149 150 /* Bus driver types */ 151 DECLARE_CLASS(tpm_bus_driver); 152 DECLARE_CLASS(tpm_spi_driver); 153 154 /* Small helper routines for io ops */ 155 static inline void 156 AND4(struct tpm_sc *sc, bus_size_t off, uint32_t val) 157 { 158 uint32_t v = TPM_READ_4(sc->dev, off); 159 160 TPM_WRITE_4(sc->dev, off, v & val); 161 } 162 static inline void 163 OR1(struct tpm_sc *sc, bus_size_t off, uint8_t val) 164 { 165 uint8_t v = TPM_READ_1(sc->dev, off); 166 167 TPM_WRITE_1(sc->dev, off, v | val); 168 } 169 static inline void 170 OR4(struct tpm_sc *sc, bus_size_t off, uint32_t val) 171 { 172 uint32_t v = TPM_READ_1(sc->dev, off); 173 174 TPM_WRITE_4(sc->dev, off, v | val); 175 } 176 #endif /* _TPM20_H_ */ 177