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: stable/11/sys/dev/tpm/tpm20.h 346725 2019-04-26 01:58:36Z mw $");
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
99#define	TPM2_START_METHOD_ACPI		2
100#define	TPM2_START_METHOD_TIS		6
101#define	TPM2_START_METHOD_CRB		7
102#define	TPM2_START_METHOD_CRB_ACPI	8
103
104struct tpm_sc {
105	device_t	dev;
106
107	struct resource	*mem_res;
108	struct resource	*irq_res;
109	int		mem_rid;
110	int		irq_rid;
111
112	struct cdev	*sc_cdev;
113
114	struct sx 	dev_lock;
115	struct cv	buf_cv;
116
117	void 		*intr_cookie;
118	int 		intr_type;	/* Current event type */
119	bool 		interrupts;
120
121	uint8_t 	*buf;
122	size_t		pending_data_length;
123	lwpid_t		owner_tid;
124
125	struct callout 	discard_buffer_callout;
126#ifdef TPM_HARVEST
127	struct callout 	harvest_callout;
128	int		harvest_ticks;
129#endif
130
131	int		(*transmit)(struct tpm_sc *, size_t);
132};
133
134int tpm20_suspend(device_t dev);
135int tpm20_shutdown(device_t dev);
136int32_t tpm20_get_timeout(uint32_t command);
137int tpm20_init(struct tpm_sc *sc);
138void tpm20_release(struct tpm_sc *sc);
139
140/* Small helper routines for io ops */
141static inline uint8_t
142RD1(struct tpm_sc *sc, bus_size_t off)
143{
144
145	return (bus_read_1(sc->mem_res, off));
146}
147static inline uint32_t
148RD4(struct tpm_sc *sc, bus_size_t off)
149{
150
151	return (bus_read_4(sc->mem_res, off));
152}
153#ifdef __amd64__
154static inline uint64_t
155RD8(struct tpm_sc *sc, bus_size_t off)
156{
157
158	return (bus_read_8(sc->mem_res, off));
159}
160#endif
161static inline void
162WR1(struct tpm_sc *sc, bus_size_t off, uint8_t val)
163{
164
165	bus_write_1(sc->mem_res, off, val);
166}
167static inline void
168WR4(struct tpm_sc *sc, bus_size_t off, uint32_t val)
169{
170
171	bus_write_4(sc->mem_res, off, val);
172}
173static inline void
174AND4(struct tpm_sc *sc, bus_size_t off, uint32_t val)
175{
176
177	WR4(sc, off, RD4(sc, off) & val);
178}
179static inline void
180OR1(struct tpm_sc *sc, bus_size_t off, uint8_t val)
181{
182
183	WR1(sc, off, RD1(sc, off) | val);
184}
185static inline void
186OR4(struct tpm_sc *sc, bus_size_t off, uint32_t val)
187{
188
189	WR4(sc, off, RD4(sc, off) | val);
190}
191#endif	/* _TPM20_H_ */
192