tpm.c revision 1.19 1 1.19 riastrad /* $NetBSD: tpm.c,v 1.19 2021/01/04 18:26:59 riastradh Exp $ */
2 1.13 maxv
3 1.13 maxv /*
4 1.13 maxv * Copyright (c) 2019 The NetBSD Foundation, Inc.
5 1.13 maxv * All rights reserved.
6 1.13 maxv *
7 1.13 maxv * This code is derived from software contributed to The NetBSD Foundation
8 1.13 maxv * by Maxime Villard.
9 1.13 maxv *
10 1.13 maxv * Redistribution and use in source and binary forms, with or without
11 1.13 maxv * modification, are permitted provided that the following conditions
12 1.13 maxv * are met:
13 1.13 maxv * 1. Redistributions of source code must retain the above copyright
14 1.13 maxv * notice, this list of conditions and the following disclaimer.
15 1.13 maxv * 2. Redistributions in binary form must reproduce the above copyright
16 1.13 maxv * notice, this list of conditions and the following disclaimer in the
17 1.13 maxv * documentation and/or other materials provided with the distribution.
18 1.13 maxv *
19 1.13 maxv * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.13 maxv * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.13 maxv * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.13 maxv * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.13 maxv * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.13 maxv * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.13 maxv * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.13 maxv * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.13 maxv * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.13 maxv * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.13 maxv * POSSIBILITY OF SUCH DAMAGE.
30 1.13 maxv */
31 1.13 maxv
32 1.1 christos /*
33 1.1 christos * Copyright (c) 2008, 2009 Michael Shalayeff
34 1.13 maxv * Copyright (c) 2009, 2010 Hans-Joerg Hoexer
35 1.1 christos * All rights reserved.
36 1.1 christos *
37 1.1 christos * Permission to use, copy, modify, and distribute this software for any
38 1.1 christos * purpose with or without fee is hereby granted, provided that the above
39 1.1 christos * copyright notice and this permission notice appear in all copies.
40 1.1 christos *
41 1.1 christos * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
42 1.1 christos * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
43 1.1 christos * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
44 1.1 christos * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
45 1.1 christos * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN
46 1.1 christos * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
47 1.1 christos * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
48 1.1 christos */
49 1.1 christos
50 1.1 christos #include <sys/cdefs.h>
51 1.19 riastrad __KERNEL_RCSID(0, "$NetBSD: tpm.c,v 1.19 2021/01/04 18:26:59 riastradh Exp $");
52 1.1 christos
53 1.1 christos #include <sys/param.h>
54 1.17 riastrad #include <sys/types.h>
55 1.17 riastrad
56 1.19 riastrad #include <sys/atomic.h>
57 1.17 riastrad #include <sys/bus.h>
58 1.17 riastrad #include <sys/conf.h>
59 1.17 riastrad #include <sys/device.h>
60 1.1 christos #include <sys/kernel.h>
61 1.1 christos #include <sys/malloc.h>
62 1.17 riastrad #include <sys/pmf.h>
63 1.1 christos #include <sys/proc.h>
64 1.17 riastrad #include <sys/systm.h>
65 1.19 riastrad #include <sys/workqueue.h>
66 1.1 christos
67 1.1 christos #include <dev/ic/tpmreg.h>
68 1.1 christos #include <dev/ic/tpmvar.h>
69 1.1 christos
70 1.12 riastrad #include "ioconf.h"
71 1.12 riastrad
72 1.15 maxv CTASSERT(sizeof(struct tpm_header) == 10);
73 1.15 maxv
74 1.13 maxv #define TPM_BUFSIZ 1024
75 1.14 maxv
76 1.13 maxv #define TPM_PARAM_SIZE 0x0001 /* that's a flag */
77 1.13 maxv
78 1.13 maxv /* Timeouts. */
79 1.13 maxv #define TPM_ACCESS_TMO 2000 /* 2sec */
80 1.13 maxv #define TPM_READY_TMO 2000 /* 2sec */
81 1.13 maxv #define TPM_READ_TMO 2000 /* 2sec */
82 1.13 maxv #define TPM_BURST_TMO 2000 /* 2sec */
83 1.13 maxv
84 1.13 maxv #define TPM_CAPS_REQUIRED \
85 1.13 maxv (TPM_INTF_DATA_AVAIL_INT|TPM_INTF_LOCALITY_CHANGE_INT| \
86 1.13 maxv TPM_INTF_INT_LEVEL_LOW)
87 1.1 christos
88 1.13 maxv static inline int
89 1.13 maxv tpm_tmotohz(int tmo)
90 1.1 christos {
91 1.13 maxv struct timeval tv;
92 1.1 christos
93 1.13 maxv tv.tv_sec = tmo / 1000;
94 1.13 maxv tv.tv_usec = 1000 * (tmo % 1000);
95 1.1 christos
96 1.13 maxv return tvtohz(&tv);
97 1.1 christos }
98 1.1 christos
99 1.13 maxv static int
100 1.1 christos tpm_getburst(struct tpm_softc *sc)
101 1.1 christos {
102 1.1 christos int burst, to, rv;
103 1.1 christos
104 1.1 christos to = tpm_tmotohz(TPM_BURST_TMO);
105 1.1 christos
106 1.13 maxv while (to--) {
107 1.1 christos /*
108 1.13 maxv * Burst count is in bits 23:8, so read the two higher bytes.
109 1.1 christos */
110 1.1 christos burst = bus_space_read_1(sc->sc_bt, sc->sc_bh, TPM_STS + 1);
111 1.1 christos burst |= bus_space_read_1(sc->sc_bt, sc->sc_bh, TPM_STS + 2)
112 1.1 christos << 8;
113 1.13 maxv
114 1.1 christos if (burst)
115 1.1 christos return burst;
116 1.1 christos
117 1.14 maxv rv = tsleep(sc, PCATCH, "tpm_getburst", 1);
118 1.1 christos if (rv && rv != EWOULDBLOCK) {
119 1.1 christos return 0;
120 1.1 christos }
121 1.1 christos }
122 1.1 christos
123 1.1 christos return 0;
124 1.1 christos }
125 1.1 christos
126 1.13 maxv static inline uint8_t
127 1.1 christos tpm_status(struct tpm_softc *sc)
128 1.1 christos {
129 1.13 maxv return bus_space_read_1(sc->sc_bt, sc->sc_bh, TPM_STS) &
130 1.13 maxv TPM_STS_STATUS_BITS;
131 1.1 christos }
132 1.1 christos
133 1.13 maxv /* -------------------------------------------------------------------------- */
134 1.1 christos
135 1.15 maxv static bool
136 1.15 maxv tpm12_suspend(struct tpm_softc *sc)
137 1.15 maxv {
138 1.15 maxv static const uint8_t command[10] = {
139 1.15 maxv 0x00, 0xC1, /* TPM_TAG_RQU_COMMAND */
140 1.15 maxv 0x00, 0x00, 0x00, 10, /* Length in bytes */
141 1.15 maxv 0x00, 0x00, 0x00, 0x98 /* TPM_ORD_SaveState */
142 1.15 maxv };
143 1.15 maxv struct tpm_header response;
144 1.15 maxv
145 1.16 maxv if ((*sc->sc_intf->write)(sc, &command, sizeof(command)) != 0)
146 1.15 maxv return false;
147 1.16 maxv if ((*sc->sc_intf->read)(sc, &response, sizeof(response), NULL, 0) != 0)
148 1.15 maxv return false;
149 1.15 maxv if (TPM_BE32(response.code) != 0)
150 1.15 maxv return false;
151 1.15 maxv
152 1.15 maxv return true;
153 1.15 maxv }
154 1.1 christos
155 1.15 maxv static bool
156 1.15 maxv tpm20_suspend(struct tpm_softc *sc)
157 1.1 christos {
158 1.15 maxv static const uint8_t command[12] = {
159 1.15 maxv 0x80, 0x01, /* TPM_ST_NO_SESSIONS */
160 1.15 maxv 0x00, 0x00, 0x00, 12, /* Length in bytes */
161 1.15 maxv 0x00, 0x00, 0x01, 0x45, /* TPM_CC_Shutdown */
162 1.15 maxv 0x00, 0x01 /* TPM_SU_STATE */
163 1.1 christos };
164 1.15 maxv struct tpm_header response;
165 1.1 christos
166 1.16 maxv if ((*sc->sc_intf->write)(sc, &command, sizeof(command)) != 0)
167 1.15 maxv return false;
168 1.16 maxv if ((*sc->sc_intf->read)(sc, &response, sizeof(response), NULL, 0) != 0)
169 1.15 maxv return false;
170 1.15 maxv if (TPM_BE32(response.code) != 0)
171 1.15 maxv return false;
172 1.13 maxv
173 1.7 christos return true;
174 1.1 christos }
175 1.1 christos
176 1.1 christos bool
177 1.15 maxv tpm_suspend(device_t dev, const pmf_qual_t *qual)
178 1.1 christos {
179 1.15 maxv struct tpm_softc *sc = device_private(dev);
180 1.15 maxv
181 1.15 maxv switch (sc->sc_ver) {
182 1.15 maxv case TPM_1_2:
183 1.15 maxv return tpm12_suspend(sc);
184 1.15 maxv case TPM_2_0:
185 1.15 maxv return tpm20_suspend(sc);
186 1.15 maxv default:
187 1.15 maxv panic("%s: impossible", __func__);
188 1.15 maxv }
189 1.15 maxv }
190 1.15 maxv
191 1.15 maxv bool
192 1.15 maxv tpm_resume(device_t dev, const pmf_qual_t *qual)
193 1.15 maxv {
194 1.15 maxv /*
195 1.15 maxv * Don't do anything, the BIOS is supposed to restore the previously
196 1.15 maxv * saved state.
197 1.15 maxv */
198 1.7 christos return true;
199 1.1 christos }
200 1.1 christos
201 1.13 maxv /* -------------------------------------------------------------------------- */
202 1.13 maxv
203 1.13 maxv static int
204 1.14 maxv tpm_poll(struct tpm_softc *sc, uint8_t mask, int to, wchan_t chan)
205 1.1 christos {
206 1.1 christos int rv;
207 1.1 christos
208 1.13 maxv while (((sc->sc_status = tpm_status(sc)) & mask) != mask && to--) {
209 1.14 maxv rv = tsleep(chan, PCATCH, "tpm_poll", 1);
210 1.1 christos if (rv && rv != EWOULDBLOCK) {
211 1.1 christos return rv;
212 1.1 christos }
213 1.1 christos }
214 1.1 christos
215 1.1 christos return 0;
216 1.1 christos }
217 1.1 christos
218 1.13 maxv static int
219 1.13 maxv tpm_waitfor(struct tpm_softc *sc, uint8_t bits, int tmo, wchan_t chan)
220 1.1 christos {
221 1.13 maxv int retry, to, rv;
222 1.13 maxv uint8_t todo;
223 1.1 christos
224 1.14 maxv to = tpm_tmotohz(tmo);
225 1.13 maxv retry = 3;
226 1.13 maxv
227 1.1 christos restart:
228 1.14 maxv todo = bits;
229 1.14 maxv
230 1.1 christos /*
231 1.14 maxv * TPM_STS_VALID has priority over the others.
232 1.1 christos */
233 1.14 maxv if (todo & TPM_STS_VALID) {
234 1.14 maxv if ((rv = tpm_poll(sc, TPM_STS_VALID, to+1, chan)) != 0)
235 1.14 maxv return rv;
236 1.14 maxv todo &= ~TPM_STS_VALID;
237 1.14 maxv }
238 1.14 maxv
239 1.14 maxv if ((rv = tpm_poll(sc, todo, to, chan)) != 0)
240 1.1 christos return rv;
241 1.1 christos
242 1.13 maxv if ((todo & sc->sc_status) != todo) {
243 1.14 maxv if ((retry-- > 0) && (bits & TPM_STS_VALID)) {
244 1.1 christos bus_space_write_1(sc->sc_bt, sc->sc_bh, TPM_STS,
245 1.1 christos TPM_STS_RESP_RETRY);
246 1.1 christos goto restart;
247 1.1 christos }
248 1.1 christos return EIO;
249 1.1 christos }
250 1.1 christos
251 1.1 christos return 0;
252 1.1 christos }
253 1.1 christos
254 1.13 maxv /* -------------------------------------------------------------------------- */
255 1.13 maxv
256 1.13 maxv /*
257 1.16 maxv * TPM using the TIS 1.2 interface.
258 1.13 maxv */
259 1.13 maxv
260 1.16 maxv static int
261 1.16 maxv tpm12_request_locality(struct tpm_softc *sc, int l)
262 1.16 maxv {
263 1.16 maxv uint32_t r;
264 1.16 maxv int to, rv;
265 1.16 maxv
266 1.16 maxv if (l != 0)
267 1.16 maxv return EINVAL;
268 1.16 maxv
269 1.16 maxv if ((bus_space_read_1(sc->sc_bt, sc->sc_bh, TPM_ACCESS) &
270 1.16 maxv (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY)) ==
271 1.16 maxv (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY))
272 1.16 maxv return 0;
273 1.16 maxv
274 1.16 maxv bus_space_write_1(sc->sc_bt, sc->sc_bh, TPM_ACCESS,
275 1.16 maxv TPM_ACCESS_REQUEST_USE);
276 1.16 maxv
277 1.16 maxv to = tpm_tmotohz(TPM_ACCESS_TMO);
278 1.16 maxv
279 1.16 maxv while ((r = bus_space_read_1(sc->sc_bt, sc->sc_bh, TPM_ACCESS) &
280 1.16 maxv (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY)) !=
281 1.16 maxv (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY) && to--) {
282 1.16 maxv rv = tsleep(sc->sc_intf->init, PCATCH, "tpm_locality", 1);
283 1.16 maxv if (rv && rv != EWOULDBLOCK) {
284 1.16 maxv return rv;
285 1.16 maxv }
286 1.16 maxv }
287 1.16 maxv
288 1.16 maxv if ((r & (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY)) !=
289 1.16 maxv (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY)) {
290 1.16 maxv return EBUSY;
291 1.16 maxv }
292 1.16 maxv
293 1.16 maxv return 0;
294 1.16 maxv }
295 1.16 maxv
296 1.16 maxv static int
297 1.13 maxv tpm_tis12_probe(bus_space_tag_t bt, bus_space_handle_t bh)
298 1.13 maxv {
299 1.13 maxv uint32_t cap;
300 1.13 maxv uint8_t reg;
301 1.13 maxv int tmo;
302 1.13 maxv
303 1.13 maxv cap = bus_space_read_4(bt, bh, TPM_INTF_CAPABILITY);
304 1.13 maxv if (cap == 0xffffffff)
305 1.16 maxv return EINVAL;
306 1.13 maxv if ((cap & TPM_CAPS_REQUIRED) != TPM_CAPS_REQUIRED)
307 1.16 maxv return ENOTSUP;
308 1.13 maxv
309 1.13 maxv /* Request locality 0. */
310 1.13 maxv bus_space_write_1(bt, bh, TPM_ACCESS, TPM_ACCESS_REQUEST_USE);
311 1.13 maxv
312 1.13 maxv /* Wait for it to become active. */
313 1.13 maxv tmo = TPM_ACCESS_TMO; /* Milliseconds. */
314 1.13 maxv while ((reg = bus_space_read_1(bt, bh, TPM_ACCESS) &
315 1.13 maxv (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY)) !=
316 1.13 maxv (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY) && tmo--) {
317 1.13 maxv DELAY(1000); /* 1 millisecond. */
318 1.13 maxv }
319 1.13 maxv if ((reg & (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY)) !=
320 1.13 maxv (TPM_ACCESS_VALID | TPM_ACCESS_ACTIVE_LOCALITY)) {
321 1.16 maxv return ETIMEDOUT;
322 1.13 maxv }
323 1.13 maxv
324 1.13 maxv if (bus_space_read_4(bt, bh, TPM_ID) == 0xffffffff)
325 1.16 maxv return EINVAL;
326 1.13 maxv
327 1.16 maxv return 0;
328 1.13 maxv }
329 1.13 maxv
330 1.19 riastrad static void
331 1.19 riastrad tpm_tis12_rng_work(struct work *wk, void *cookie)
332 1.19 riastrad {
333 1.19 riastrad struct tpm_softc *sc = cookie;
334 1.19 riastrad /*
335 1.19 riastrad * TPM Specification Version 1.2, Main Part 3: Commands,
336 1.19 riastrad * Sec. 13.6 TPM_GetRandom
337 1.19 riastrad */
338 1.19 riastrad struct {
339 1.19 riastrad struct tpm_header hdr;
340 1.19 riastrad uint32_t bytesRequested;
341 1.19 riastrad } __packed command;
342 1.19 riastrad struct response {
343 1.19 riastrad struct tpm_header hdr;
344 1.19 riastrad uint32_t randomBytesSize;
345 1.19 riastrad uint8_t bytes[64];
346 1.19 riastrad } __packed response;
347 1.19 riastrad bool busy, endwrite = false, endread = false;
348 1.19 riastrad size_t nread;
349 1.19 riastrad uint16_t tag;
350 1.19 riastrad uint32_t pktlen, code, nbytes;
351 1.19 riastrad int rv;
352 1.19 riastrad
353 1.19 riastrad /* Acknowledge the request. */
354 1.19 riastrad sc->sc_rndpending = 0;
355 1.19 riastrad
356 1.19 riastrad /* Lock userland out of the tpm, or fail if it's already open. */
357 1.19 riastrad mutex_enter(&sc->sc_lock);
358 1.19 riastrad busy = sc->sc_busy;
359 1.19 riastrad sc->sc_busy = true;
360 1.19 riastrad mutex_exit(&sc->sc_lock);
361 1.19 riastrad if (busy) { /* tough */
362 1.19 riastrad aprint_debug_dev(sc->sc_dev, "%s: device in use\n", __func__);
363 1.19 riastrad return;
364 1.19 riastrad }
365 1.19 riastrad
366 1.19 riastrad /* Encode the command. */
367 1.19 riastrad memset(&command, 0, sizeof(command));
368 1.19 riastrad command.hdr.tag = htobe16(TPM_TAG_RQU_COMMAND);
369 1.19 riastrad command.hdr.length = htobe32(sizeof(command));
370 1.19 riastrad command.hdr.code = htobe32(TPM_ORD_GetRandom);
371 1.19 riastrad command.bytesRequested = htobe32(sizeof(response.bytes));
372 1.19 riastrad
373 1.19 riastrad /* Write the command. */
374 1.19 riastrad if ((rv = (*sc->sc_intf->start)(sc, UIO_WRITE)) != 0) {
375 1.19 riastrad device_printf(sc->sc_dev, "start write failed, error=%d\n",
376 1.19 riastrad rv);
377 1.19 riastrad goto out;
378 1.19 riastrad }
379 1.19 riastrad endwrite = true;
380 1.19 riastrad if ((rv = (*sc->sc_intf->write)(sc, &command, sizeof(command))) != 0) {
381 1.19 riastrad device_printf(sc->sc_dev, "write failed, error=%d\n", rv);
382 1.19 riastrad goto out;
383 1.19 riastrad }
384 1.19 riastrad rv = (*sc->sc_intf->end)(sc, UIO_WRITE, 0);
385 1.19 riastrad endwrite = false;
386 1.19 riastrad if (rv) {
387 1.19 riastrad device_printf(sc->sc_dev, "end write failed, error=%d\n", rv);
388 1.19 riastrad goto out;
389 1.19 riastrad }
390 1.19 riastrad
391 1.19 riastrad /* Read the response header. */
392 1.19 riastrad if ((rv = (*sc->sc_intf->start)(sc, UIO_READ)) != 0) {
393 1.19 riastrad device_printf(sc->sc_dev, "start write failed, error=%d\n",
394 1.19 riastrad rv);
395 1.19 riastrad goto out;
396 1.19 riastrad }
397 1.19 riastrad endread = true;
398 1.19 riastrad if ((rv = (*sc->sc_intf->read)(sc, &response.hdr, sizeof(response.hdr),
399 1.19 riastrad &nread, 0)) != 0) {
400 1.19 riastrad device_printf(sc->sc_dev, "read failed, error=%d\n", rv);
401 1.19 riastrad goto out;
402 1.19 riastrad }
403 1.19 riastrad
404 1.19 riastrad /* Verify the response header looks sensible. */
405 1.19 riastrad if (nread != sizeof(response.hdr)) {
406 1.19 riastrad device_printf(sc->sc_dev, "read %zu bytes, expected %zu",
407 1.19 riastrad nread, sizeof(response.hdr));
408 1.19 riastrad goto out;
409 1.19 riastrad }
410 1.19 riastrad tag = be16toh(response.hdr.tag);
411 1.19 riastrad pktlen = be32toh(response.hdr.length);
412 1.19 riastrad code = be32toh(response.hdr.code);
413 1.19 riastrad if (tag != TPM_TAG_RSP_COMMAND ||
414 1.19 riastrad pktlen < offsetof(struct response, bytes) ||
415 1.19 riastrad pktlen > sizeof(response) ||
416 1.19 riastrad code != 0) {
417 1.19 riastrad /*
418 1.19 riastrad * If the tpm itself is busy (e.g., it has yet to run a
419 1.19 riastrad * self-test, or it's in a timeout period to defend
420 1.19 riastrad * against brute force attacks), then we can try again
421 1.19 riastrad * later. Otherwise, give up.
422 1.19 riastrad */
423 1.19 riastrad if (code & TPM_NON_FATAL) {
424 1.19 riastrad aprint_debug_dev(sc->sc_dev, "%s: tpm busy, code=%u\n",
425 1.19 riastrad __func__, code & ~TPM_NON_FATAL);
426 1.19 riastrad rv = 0;
427 1.19 riastrad } else if (code == TPM_DEACTIVATED) {
428 1.19 riastrad device_printf(sc->sc_dev, "tpm is deactivated\n");
429 1.19 riastrad rv = ENXIO;
430 1.19 riastrad } else {
431 1.19 riastrad device_printf(sc->sc_dev, "bad tpm response:"
432 1.19 riastrad " tag=%u len=%u code=%u\n", tag, pktlen, code);
433 1.19 riastrad hexdump(aprint_debug, "tpm response header",
434 1.19 riastrad (const void *)&response.hdr,
435 1.19 riastrad sizeof(response.hdr));
436 1.19 riastrad rv = EIO;
437 1.19 riastrad }
438 1.19 riastrad goto out;
439 1.19 riastrad }
440 1.19 riastrad
441 1.19 riastrad /* Read the response payload. */
442 1.19 riastrad if ((rv = (*sc->sc_intf->read)(sc,
443 1.19 riastrad (char *)&response + nread, pktlen - nread,
444 1.19 riastrad NULL, TPM_PARAM_SIZE)) != 0) {
445 1.19 riastrad device_printf(sc->sc_dev, "read failed, error=%d\n", rv);
446 1.19 riastrad goto out;
447 1.19 riastrad }
448 1.19 riastrad endread = false;
449 1.19 riastrad if ((rv = (*sc->sc_intf->end)(sc, UIO_READ, 0)) != 0) {
450 1.19 riastrad device_printf(sc->sc_dev, "end read failed, error=%d\n", rv);
451 1.19 riastrad goto out;
452 1.19 riastrad }
453 1.19 riastrad
454 1.19 riastrad /* Verify the number of bytes read looks sensible. */
455 1.19 riastrad nbytes = be32toh(response.randomBytesSize);
456 1.19 riastrad if (nbytes > pktlen - offsetof(struct response, bytes)) {
457 1.19 riastrad device_printf(sc->sc_dev, "overlong GetRandom length:"
458 1.19 riastrad " %u, max %zu\n",
459 1.19 riastrad nbytes, pktlen - offsetof(struct response, bytes));
460 1.19 riastrad nbytes = pktlen - offsetof(struct response, bytes);
461 1.19 riastrad }
462 1.19 riastrad
463 1.19 riastrad /*
464 1.19 riastrad * Enter the data into the entropy pool. Conservatively (or,
465 1.19 riastrad * perhaps, cargocultily) estimate half a bit of entropy per
466 1.19 riastrad * bit of data.
467 1.19 riastrad */
468 1.19 riastrad rnd_add_data(&sc->sc_rnd, response.bytes, nbytes, (NBBY/2)*nbytes);
469 1.19 riastrad
470 1.19 riastrad out: /*
471 1.19 riastrad * If the tpm is busted, no sense in trying again -- most
472 1.19 riastrad * likely, it is deactivated, and by the spec it cannot be
473 1.19 riastrad * reactivated until after a reboot.
474 1.19 riastrad */
475 1.19 riastrad if (rv) {
476 1.19 riastrad device_printf(sc->sc_dev, "deactivating entropy source\n");
477 1.19 riastrad rnd_detach_source(&sc->sc_rnd);
478 1.19 riastrad /* XXX worker thread can't workqueue_destroy its own queue */
479 1.19 riastrad }
480 1.19 riastrad
481 1.19 riastrad /* End the read or write if still ongoing. */
482 1.19 riastrad if (endread)
483 1.19 riastrad rv = (*sc->sc_intf->end)(sc, UIO_READ, rv);
484 1.19 riastrad if (endwrite)
485 1.19 riastrad rv = (*sc->sc_intf->end)(sc, UIO_WRITE, rv);
486 1.19 riastrad
487 1.19 riastrad /* Relinquish the tpm back to userland. */
488 1.19 riastrad mutex_enter(&sc->sc_lock);
489 1.19 riastrad KASSERT(sc->sc_busy);
490 1.19 riastrad sc->sc_busy = false;
491 1.19 riastrad mutex_exit(&sc->sc_lock);
492 1.19 riastrad }
493 1.19 riastrad
494 1.19 riastrad static void
495 1.19 riastrad tpm_tis12_rng_get(size_t nbytes, void *cookie)
496 1.19 riastrad {
497 1.19 riastrad struct tpm_softc *sc = cookie;
498 1.19 riastrad
499 1.19 riastrad if (atomic_swap_uint(&sc->sc_rndpending, 1) == 0)
500 1.19 riastrad workqueue_enqueue(sc->sc_rndwq, &sc->sc_rndwk, NULL);
501 1.19 riastrad }
502 1.19 riastrad
503 1.16 maxv static int
504 1.14 maxv tpm_tis12_init(struct tpm_softc *sc)
505 1.13 maxv {
506 1.16 maxv int rv;
507 1.16 maxv
508 1.18 riastrad aprint_naive("\n");
509 1.18 riastrad aprint_normal("\n");
510 1.18 riastrad
511 1.14 maxv sc->sc_caps = bus_space_read_4(sc->sc_bt, sc->sc_bh,
512 1.13 maxv TPM_INTF_CAPABILITY);
513 1.13 maxv sc->sc_devid = bus_space_read_4(sc->sc_bt, sc->sc_bh, TPM_ID);
514 1.13 maxv sc->sc_rev = bus_space_read_1(sc->sc_bt, sc->sc_bh, TPM_REV);
515 1.13 maxv
516 1.14 maxv aprint_normal_dev(sc->sc_dev, "device 0x%08x rev 0x%x\n",
517 1.14 maxv sc->sc_devid, sc->sc_rev);
518 1.13 maxv
519 1.16 maxv if ((rv = tpm12_request_locality(sc, 0)) != 0)
520 1.16 maxv return rv;
521 1.13 maxv
522 1.13 maxv /* Abort whatever it thought it was doing. */
523 1.13 maxv bus_space_write_1(sc->sc_bt, sc->sc_bh, TPM_STS, TPM_STS_CMD_READY);
524 1.13 maxv
525 1.19 riastrad /* XXX Run this at higher priority? */
526 1.19 riastrad if ((rv = workqueue_create(&sc->sc_rndwq, device_xname(sc->sc_dev),
527 1.19 riastrad tpm_tis12_rng_work, sc, PRI_NONE, IPL_VM, WQ_MPSAFE)) != 0)
528 1.19 riastrad return rv;
529 1.19 riastrad rndsource_setcb(&sc->sc_rnd, tpm_tis12_rng_get, sc);
530 1.19 riastrad rnd_attach_source(&sc->sc_rnd, device_xname(sc->sc_dev),
531 1.19 riastrad RND_TYPE_RNG,
532 1.19 riastrad RND_FLAG_COLLECT_VALUE|RND_FLAG_ESTIMATE_VALUE|RND_FLAG_HASCB);
533 1.19 riastrad
534 1.13 maxv return 0;
535 1.13 maxv }
536 1.13 maxv
537 1.16 maxv static int
538 1.14 maxv tpm_tis12_start(struct tpm_softc *sc, int rw)
539 1.1 christos {
540 1.1 christos int rv;
541 1.1 christos
542 1.14 maxv if (rw == UIO_READ) {
543 1.1 christos rv = tpm_waitfor(sc, TPM_STS_DATA_AVAIL | TPM_STS_VALID,
544 1.16 maxv TPM_READ_TMO, sc->sc_intf->read);
545 1.1 christos return rv;
546 1.1 christos }
547 1.1 christos
548 1.13 maxv /* Request the 0th locality. */
549 1.16 maxv if ((rv = tpm12_request_locality(sc, 0)) != 0)
550 1.1 christos return rv;
551 1.1 christos
552 1.13 maxv sc->sc_status = tpm_status(sc);
553 1.13 maxv if (sc->sc_status & TPM_STS_CMD_READY)
554 1.1 christos return 0;
555 1.1 christos
556 1.1 christos /* Abort previous and restart. */
557 1.1 christos bus_space_write_1(sc->sc_bt, sc->sc_bh, TPM_STS, TPM_STS_CMD_READY);
558 1.16 maxv rv = tpm_waitfor(sc, TPM_STS_CMD_READY, TPM_READY_TMO, sc->sc_intf->write);
559 1.13 maxv if (rv)
560 1.1 christos return rv;
561 1.1 christos
562 1.1 christos return 0;
563 1.1 christos }
564 1.1 christos
565 1.16 maxv static int
566 1.3 christos tpm_tis12_read(struct tpm_softc *sc, void *buf, size_t len, size_t *count,
567 1.1 christos int flags)
568 1.1 christos {
569 1.1 christos uint8_t *p = buf;
570 1.1 christos size_t cnt;
571 1.14 maxv int rv, n;
572 1.1 christos
573 1.1 christos cnt = 0;
574 1.1 christos while (len > 0) {
575 1.13 maxv rv = tpm_waitfor(sc, TPM_STS_DATA_AVAIL | TPM_STS_VALID,
576 1.16 maxv TPM_READ_TMO, sc->sc_intf->read);
577 1.13 maxv if (rv)
578 1.1 christos return rv;
579 1.1 christos
580 1.14 maxv n = MIN(len, tpm_getburst(sc));
581 1.14 maxv while (n > 0) {
582 1.1 christos *p++ = bus_space_read_1(sc->sc_bt, sc->sc_bh, TPM_DATA);
583 1.1 christos cnt++;
584 1.14 maxv len--;
585 1.14 maxv n--;
586 1.1 christos }
587 1.1 christos
588 1.1 christos if ((flags & TPM_PARAM_SIZE) == 0 && cnt >= 6)
589 1.1 christos break;
590 1.1 christos }
591 1.1 christos
592 1.1 christos if (count)
593 1.1 christos *count = cnt;
594 1.1 christos
595 1.1 christos return 0;
596 1.1 christos }
597 1.1 christos
598 1.16 maxv static int
599 1.3 christos tpm_tis12_write(struct tpm_softc *sc, const void *buf, size_t len)
600 1.1 christos {
601 1.3 christos const uint8_t *p = buf;
602 1.1 christos size_t cnt;
603 1.1 christos int rv, r;
604 1.1 christos
605 1.3 christos if (len == 0)
606 1.3 christos return 0;
607 1.16 maxv if ((rv = tpm12_request_locality(sc, 0)) != 0)
608 1.1 christos return rv;
609 1.1 christos
610 1.1 christos cnt = 0;
611 1.1 christos while (cnt < len - 1) {
612 1.1 christos for (r = tpm_getburst(sc); r > 0 && cnt < len - 1; r--) {
613 1.1 christos bus_space_write_1(sc->sc_bt, sc->sc_bh, TPM_DATA, *p++);
614 1.1 christos cnt++;
615 1.1 christos }
616 1.1 christos if ((rv = tpm_waitfor(sc, TPM_STS_VALID, TPM_READ_TMO, sc))) {
617 1.1 christos return rv;
618 1.1 christos }
619 1.13 maxv sc->sc_status = tpm_status(sc);
620 1.13 maxv if (!(sc->sc_status & TPM_STS_DATA_EXPECT)) {
621 1.1 christos return EIO;
622 1.1 christos }
623 1.1 christos }
624 1.1 christos
625 1.1 christos bus_space_write_1(sc->sc_bt, sc->sc_bh, TPM_DATA, *p++);
626 1.1 christos cnt++;
627 1.1 christos
628 1.1 christos if ((rv = tpm_waitfor(sc, TPM_STS_VALID, TPM_READ_TMO, sc))) {
629 1.1 christos return rv;
630 1.1 christos }
631 1.13 maxv if ((sc->sc_status & TPM_STS_DATA_EXPECT) != 0) {
632 1.1 christos return EIO;
633 1.1 christos }
634 1.1 christos
635 1.1 christos return 0;
636 1.1 christos }
637 1.1 christos
638 1.16 maxv static int
639 1.14 maxv tpm_tis12_end(struct tpm_softc *sc, int rw, int err)
640 1.1 christos {
641 1.1 christos int rv = 0;
642 1.1 christos
643 1.14 maxv if (rw == UIO_READ) {
644 1.16 maxv rv = tpm_waitfor(sc, TPM_STS_VALID, TPM_READ_TMO, sc->sc_intf->read);
645 1.13 maxv if (rv)
646 1.1 christos return rv;
647 1.1 christos
648 1.1 christos /* Still more data? */
649 1.13 maxv sc->sc_status = tpm_status(sc);
650 1.14 maxv if (!err && (sc->sc_status & TPM_STS_DATA_AVAIL)) {
651 1.1 christos rv = EIO;
652 1.1 christos }
653 1.1 christos
654 1.1 christos bus_space_write_1(sc->sc_bt, sc->sc_bh, TPM_STS,
655 1.1 christos TPM_STS_CMD_READY);
656 1.1 christos
657 1.13 maxv /* Release the 0th locality. */
658 1.13 maxv bus_space_write_1(sc->sc_bt, sc->sc_bh, TPM_ACCESS,
659 1.1 christos TPM_ACCESS_ACTIVE_LOCALITY);
660 1.1 christos } else {
661 1.1 christos /* Hungry for more? */
662 1.13 maxv sc->sc_status = tpm_status(sc);
663 1.13 maxv if (!err && (sc->sc_status & TPM_STS_DATA_EXPECT)) {
664 1.1 christos rv = EIO;
665 1.1 christos }
666 1.1 christos
667 1.1 christos bus_space_write_1(sc->sc_bt, sc->sc_bh, TPM_STS,
668 1.1 christos err ? TPM_STS_CMD_READY : TPM_STS_GO);
669 1.1 christos }
670 1.1 christos
671 1.1 christos return rv;
672 1.1 christos }
673 1.1 christos
674 1.16 maxv const struct tpm_intf tpm_intf_tis12 = {
675 1.16 maxv .version = TIS_1_2,
676 1.16 maxv .probe = tpm_tis12_probe,
677 1.16 maxv .init = tpm_tis12_init,
678 1.16 maxv .start = tpm_tis12_start,
679 1.16 maxv .read = tpm_tis12_read,
680 1.16 maxv .write = tpm_tis12_write,
681 1.16 maxv .end = tpm_tis12_end
682 1.16 maxv };
683 1.16 maxv
684 1.13 maxv /* -------------------------------------------------------------------------- */
685 1.1 christos
686 1.13 maxv static dev_type_open(tpmopen);
687 1.13 maxv static dev_type_close(tpmclose);
688 1.13 maxv static dev_type_read(tpmread);
689 1.13 maxv static dev_type_write(tpmwrite);
690 1.13 maxv static dev_type_ioctl(tpmioctl);
691 1.1 christos
692 1.13 maxv const struct cdevsw tpm_cdevsw = {
693 1.13 maxv .d_open = tpmopen,
694 1.13 maxv .d_close = tpmclose,
695 1.13 maxv .d_read = tpmread,
696 1.13 maxv .d_write = tpmwrite,
697 1.13 maxv .d_ioctl = tpmioctl,
698 1.13 maxv .d_stop = nostop,
699 1.13 maxv .d_tty = notty,
700 1.13 maxv .d_poll = nopoll,
701 1.13 maxv .d_mmap = nommap,
702 1.13 maxv .d_kqfilter = nokqfilter,
703 1.13 maxv .d_discard = nodiscard,
704 1.14 maxv .d_flag = D_OTHER | D_MPSAFE,
705 1.13 maxv };
706 1.1 christos
707 1.13 maxv static int
708 1.1 christos tpmopen(dev_t dev, int flag, int mode, struct lwp *l)
709 1.1 christos {
710 1.14 maxv struct tpm_softc *sc = device_lookup_private(&tpm_cd, minor(dev));
711 1.14 maxv int ret = 0;
712 1.1 christos
713 1.13 maxv if (sc == NULL)
714 1.1 christos return ENXIO;
715 1.1 christos
716 1.14 maxv mutex_enter(&sc->sc_lock);
717 1.14 maxv if (sc->sc_busy) {
718 1.14 maxv ret = EBUSY;
719 1.14 maxv } else {
720 1.14 maxv sc->sc_busy = true;
721 1.14 maxv }
722 1.14 maxv mutex_exit(&sc->sc_lock);
723 1.1 christos
724 1.14 maxv return ret;
725 1.1 christos }
726 1.1 christos
727 1.13 maxv static int
728 1.1 christos tpmclose(dev_t dev, int flag, int mode, struct lwp *l)
729 1.1 christos {
730 1.14 maxv struct tpm_softc *sc = device_lookup_private(&tpm_cd, minor(dev));
731 1.14 maxv int ret = 0;
732 1.1 christos
733 1.13 maxv if (sc == NULL)
734 1.1 christos return ENXIO;
735 1.1 christos
736 1.14 maxv mutex_enter(&sc->sc_lock);
737 1.14 maxv if (!sc->sc_busy) {
738 1.14 maxv ret = EINVAL;
739 1.14 maxv } else {
740 1.14 maxv sc->sc_busy = false;
741 1.14 maxv }
742 1.14 maxv mutex_exit(&sc->sc_lock);
743 1.1 christos
744 1.14 maxv return ret;
745 1.1 christos }
746 1.1 christos
747 1.13 maxv static int
748 1.1 christos tpmread(dev_t dev, struct uio *uio, int flags)
749 1.1 christos {
750 1.14 maxv struct tpm_softc *sc = device_lookup_private(&tpm_cd, minor(dev));
751 1.15 maxv struct tpm_header hdr;
752 1.14 maxv uint8_t buf[TPM_BUFSIZ];
753 1.1 christos size_t cnt, len, n;
754 1.14 maxv int rv;
755 1.1 christos
756 1.13 maxv if (sc == NULL)
757 1.1 christos return ENXIO;
758 1.1 christos
759 1.16 maxv if ((rv = (*sc->sc_intf->start)(sc, UIO_READ)))
760 1.16 maxv return rv;
761 1.1 christos
762 1.14 maxv /* Get the header. */
763 1.16 maxv if ((rv = (*sc->sc_intf->read)(sc, &hdr, sizeof(hdr), &cnt, 0))) {
764 1.3 christos goto out;
765 1.1 christos }
766 1.15 maxv len = TPM_BE32(hdr.length);
767 1.14 maxv if (len > uio->uio_resid || len < cnt) {
768 1.1 christos rv = EIO;
769 1.3 christos goto out;
770 1.1 christos }
771 1.1 christos
772 1.14 maxv /* Copy out the header. */
773 1.15 maxv if ((rv = uiomove(&hdr, cnt, uio))) {
774 1.3 christos goto out;
775 1.1 christos }
776 1.1 christos
777 1.14 maxv /* Process the rest. */
778 1.14 maxv len -= cnt;
779 1.14 maxv while (len > 0) {
780 1.14 maxv n = MIN(sizeof(buf), len);
781 1.16 maxv if ((rv = (*sc->sc_intf->read)(sc, buf, n, NULL, TPM_PARAM_SIZE))) {
782 1.3 christos goto out;
783 1.1 christos }
784 1.14 maxv if ((rv = uiomove(buf, n, uio))) {
785 1.3 christos goto out;
786 1.1 christos }
787 1.14 maxv len -= n;
788 1.1 christos }
789 1.1 christos
790 1.3 christos out:
791 1.16 maxv rv = (*sc->sc_intf->end)(sc, UIO_READ, rv);
792 1.1 christos return rv;
793 1.1 christos }
794 1.1 christos
795 1.13 maxv static int
796 1.1 christos tpmwrite(dev_t dev, struct uio *uio, int flags)
797 1.1 christos {
798 1.14 maxv struct tpm_softc *sc = device_lookup_private(&tpm_cd, minor(dev));
799 1.1 christos uint8_t buf[TPM_BUFSIZ];
800 1.14 maxv int n, rv;
801 1.1 christos
802 1.13 maxv if (sc == NULL)
803 1.1 christos return ENXIO;
804 1.1 christos
805 1.1 christos n = MIN(sizeof(buf), uio->uio_resid);
806 1.1 christos if ((rv = uiomove(buf, n, uio))) {
807 1.13 maxv goto out;
808 1.1 christos }
809 1.16 maxv if ((rv = (*sc->sc_intf->start)(sc, UIO_WRITE))) {
810 1.13 maxv goto out;
811 1.1 christos }
812 1.16 maxv if ((rv = (*sc->sc_intf->write)(sc, buf, n))) {
813 1.13 maxv goto out;
814 1.1 christos }
815 1.1 christos
816 1.16 maxv rv = (*sc->sc_intf->end)(sc, UIO_WRITE, rv);
817 1.13 maxv out:
818 1.1 christos return rv;
819 1.1 christos }
820 1.1 christos
821 1.13 maxv static int
822 1.13 maxv tpmioctl(dev_t dev, u_long cmd, void *addr, int flag, struct lwp *l)
823 1.1 christos {
824 1.14 maxv struct tpm_softc *sc = device_lookup_private(&tpm_cd, minor(dev));
825 1.13 maxv struct tpm_ioc_getinfo *info;
826 1.13 maxv
827 1.13 maxv if (sc == NULL)
828 1.13 maxv return ENXIO;
829 1.13 maxv
830 1.13 maxv switch (cmd) {
831 1.13 maxv case TPM_IOC_GETINFO:
832 1.13 maxv info = addr;
833 1.13 maxv info->api_version = TPM_API_VERSION;
834 1.13 maxv info->tpm_version = sc->sc_ver;
835 1.16 maxv info->itf_version = sc->sc_intf->version;
836 1.13 maxv info->device_id = sc->sc_devid;
837 1.13 maxv info->device_rev = sc->sc_rev;
838 1.14 maxv info->device_caps = sc->sc_caps;
839 1.13 maxv return 0;
840 1.13 maxv default:
841 1.13 maxv break;
842 1.13 maxv }
843 1.13 maxv
844 1.1 christos return ENOTTY;
845 1.1 christos }
846