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 <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33
34 #include <sys/endian.h>
35 #include <sys/param.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/proc.h>
39 #include <sys/systm.h>
40
41 #include <sys/bus.h>
42 #include <sys/callout.h>
43 #include <sys/conf.h>
44 #include <sys/module.h>
45 #include <sys/rman.h>
46 #include <sys/sx.h>
47 #include <sys/uio.h>
48
49 #include <machine/bus.h>
50 #include <machine/md_var.h>
51 #include <machine/resource.h>
52
53 #include <contrib/dev/acpica/include/acpi.h>
54 #include <contrib/dev/acpica/include/accommon.h>
55 #include <dev/acpica/acpivar.h>
56 #include "opt_acpi.h"
57
58 #include "opt_tpm.h"
59
60 #define BIT(x) (1 << (x))
61
62 /* Timeouts in us */
63 #define TPM_TIMEOUT_A 750000
64 #define TPM_TIMEOUT_B 2000000
65 #define TPM_TIMEOUT_C 200000
66 #define TPM_TIMEOUT_D 30000
67
68 /*
69 * Generating RSA key pair takes ~(10-20s), which is significantly longer than
70 * any timeout defined in spec. Because of that we need a new one.
71 */
72 #define TPM_TIMEOUT_LONG 40000000
73
74 /* List of commands that require TPM_TIMEOUT_LONG time to complete */
75 #define TPM_CC_CreatePrimary 0x00000131
76 #define TPM_CC_Create 0x00000153
77 #define TPM_CC_CreateLoaded 0x00000191
78
79 /* List of commands that require only TPM_TIMEOUT_C time to complete */
80 #define TPM_CC_SequenceComplete 0x0000013e
81 #define TPM_CC_Startup 0x00000144
82 #define TPM_CC_SequenceUpdate 0x0000015c
83 #define TPM_CC_GetCapability 0x0000017a
84 #define TPM_CC_PCR_Extend 0x00000182
85 #define TPM_CC_EventSequenceComplete 0x00000185
86 #define TPM_CC_HashSequenceStart 0x00000186
87
88 /* Timeout before data in read buffer is discarded */
89 #define TPM_READ_TIMEOUT 500000
90
91 #define TPM_BUFSIZE 0x1000
92
93 #define TPM_HEADER_SIZE 10
94
95 #define TPM_CDEV_NAME "tpm0"
96 #define TPM_CDEV_PERM_FLAG 0600
97
98 #define TPM2_START_METHOD_ACPI 2
99 #define TPM2_START_METHOD_TIS 6
100 #define TPM2_START_METHOD_CRB 7
101 #define TPM2_START_METHOD_CRB_ACPI 8
102
103 struct tpm_sc {
104 device_t dev;
105
106 struct resource *mem_res;
107 struct resource *irq_res;
108 int mem_rid;
109 int irq_rid;
110
111 struct cdev *sc_cdev;
112
113 struct sx dev_lock;
114 struct cv buf_cv;
115
116 void *intr_cookie;
117 int intr_type; /* Current event type */
118 bool interrupts;
119
120 uint8_t *buf;
121 size_t pending_data_length;
122 lwpid_t owner_tid;
123
124 struct callout discard_buffer_callout;
125 #ifdef TPM_HARVEST
126 struct callout harvest_callout;
127 int harvest_ticks;
128 #endif
129
130 int (*transmit)(struct tpm_sc *, size_t);
131 };
132
133 int tpm20_suspend(device_t dev);
134 int tpm20_shutdown(device_t dev);
135 int32_t tpm20_get_timeout(uint32_t command);
136 int tpm20_init(struct tpm_sc *sc);
137 void tpm20_release(struct tpm_sc *sc);
138
139 /* Small helper routines for io ops */
140 static inline uint8_t
RD1(struct tpm_sc * sc,bus_size_t off)141 RD1(struct tpm_sc *sc, bus_size_t off)
142 {
143
144 return (bus_read_1(sc->mem_res, off));
145 }
146 static inline uint32_t
RD4(struct tpm_sc * sc,bus_size_t off)147 RD4(struct tpm_sc *sc, bus_size_t off)
148 {
149
150 return (bus_read_4(sc->mem_res, off));
151 }
152 #ifdef __amd64__
153 static inline uint64_t
RD8(struct tpm_sc * sc,bus_size_t off)154 RD8(struct tpm_sc *sc, bus_size_t off)
155 {
156
157 return (bus_read_8(sc->mem_res, off));
158 }
159 #endif
160 static inline void
WR1(struct tpm_sc * sc,bus_size_t off,uint8_t val)161 WR1(struct tpm_sc *sc, bus_size_t off, uint8_t val)
162 {
163
164 bus_write_1(sc->mem_res, off, val);
165 }
166 static inline void
WR4(struct tpm_sc * sc,bus_size_t off,uint32_t val)167 WR4(struct tpm_sc *sc, bus_size_t off, uint32_t val)
168 {
169
170 bus_write_4(sc->mem_res, off, val);
171 }
172 static inline void
AND4(struct tpm_sc * sc,bus_size_t off,uint32_t val)173 AND4(struct tpm_sc *sc, bus_size_t off, uint32_t val)
174 {
175
176 WR4(sc, off, RD4(sc, off) & val);
177 }
178 static inline void
OR1(struct tpm_sc * sc,bus_size_t off,uint8_t val)179 OR1(struct tpm_sc *sc, bus_size_t off, uint8_t val)
180 {
181
182 WR1(sc, off, RD1(sc, off) | val);
183 }
184 static inline void
OR4(struct tpm_sc * sc,bus_size_t off,uint32_t val)185 OR4(struct tpm_sc *sc, bus_size_t off, uint32_t val)
186 {
187
188 WR4(sc, off, RD4(sc, off) | val);
189 }
190 #endif /* _TPM20_H_ */
191