1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2004 IBM Corporation
4  * Copyright (C) 2015 Intel Corporation
5  *
6  * Authors:
7  * Leendert van Doorn <leendert@watson.ibm.com>
8  * Dave Safford <safford@watson.ibm.com>
9  * Reiner Sailer <sailer@watson.ibm.com>
10  * Kylene Hall <kjhall@us.ibm.com>
11  *
12  * Maintained by: <tpmdd-devel@lists.sourceforge.net>
13  *
14  * Device driver for TCG/TCPA TPM (trusted platform module).
15  * Specifications at www.trustedcomputinggroup.org
16  */
17 
18 #ifndef __TPM_H__
19 #define __TPM_H__
20 
21 #include <linux/module.h>
22 #include <linux/delay.h>
23 #include <linux/mutex.h>
24 #include <linux/sched.h>
25 #include <linux/platform_device.h>
26 #include <linux/io.h>
27 #include <linux/tpm.h>
28 #include <linux/tpm_eventlog.h>
29 
30 #ifdef CONFIG_X86
31 #include <asm/intel-family.h>
32 #endif
33 
34 #define TPM_MINOR		224	/* officially assigned */
35 #define TPM_BUFSIZE		4096
36 #define TPM_NUM_DEVICES		65536
37 #define TPM_RETRY		50
38 
39 enum tpm_timeout {
40 	TPM_TIMEOUT = 5,	/* msecs */
41 	TPM_TIMEOUT_RETRY = 100, /* msecs */
42 	TPM_TIMEOUT_RANGE_US = 300,	/* usecs */
43 	TPM_TIMEOUT_POLL = 1,	/* msecs */
44 	TPM_TIMEOUT_USECS_MIN = 100,      /* usecs */
45 	TPM_TIMEOUT_USECS_MAX = 500      /* usecs */
46 };
47 
48 /* TPM addresses */
49 enum tpm_addr {
50 	TPM_SUPERIO_ADDR = 0x2E,
51 	TPM_ADDR = 0x4E,
52 };
53 
54 #define TPM_WARN_RETRY          0x800
55 #define TPM_WARN_DOING_SELFTEST 0x802
56 #define TPM_ERR_DEACTIVATED     0x6
57 #define TPM_ERR_DISABLED        0x7
58 #define TPM_ERR_FAILEDSELFTEST  0x1C
59 #define TPM_ERR_INVALID_POSTINIT 38
60 
61 #define TPM_TAG_RQU_COMMAND 193
62 
63 /* TPM2 specific constants. */
64 #define TPM2_SPACE_BUFFER_SIZE		16384 /* 16 kB */
65 
66 struct	stclear_flags_t {
67 	__be16	tag;
68 	u8	deactivated;
69 	u8	disableForceClear;
70 	u8	physicalPresence;
71 	u8	physicalPresenceLock;
72 	u8	bGlobalLock;
73 } __packed;
74 
75 struct tpm1_version {
76 	u8 major;
77 	u8 minor;
78 	u8 rev_major;
79 	u8 rev_minor;
80 } __packed;
81 
82 struct tpm1_version2 {
83 	__be16 tag;
84 	struct tpm1_version version;
85 } __packed;
86 
87 struct	timeout_t {
88 	__be32	a;
89 	__be32	b;
90 	__be32	c;
91 	__be32	d;
92 } __packed;
93 
94 struct duration_t {
95 	__be32	tpm_short;
96 	__be32	tpm_medium;
97 	__be32	tpm_long;
98 } __packed;
99 
100 struct permanent_flags_t {
101 	__be16	tag;
102 	u8	disable;
103 	u8	ownership;
104 	u8	deactivated;
105 	u8	readPubek;
106 	u8	disableOwnerClear;
107 	u8	allowMaintenance;
108 	u8	physicalPresenceLifetimeLock;
109 	u8	physicalPresenceHWEnable;
110 	u8	physicalPresenceCMDEnable;
111 	u8	CEKPUsed;
112 	u8	TPMpost;
113 	u8	TPMpostLock;
114 	u8	FIPS;
115 	u8	operator;
116 	u8	enableRevokeEK;
117 	u8	nvLocked;
118 	u8	readSRKPub;
119 	u8	tpmEstablished;
120 	u8	maintenanceDone;
121 	u8	disableFullDALogicInfo;
122 } __packed;
123 
124 typedef union {
125 	struct	permanent_flags_t perm_flags;
126 	struct	stclear_flags_t	stclear_flags;
127 	__u8	owned;
128 	__be32	num_pcrs;
129 	struct tpm1_version version1;
130 	struct tpm1_version2 version2;
131 	__be32	manufacturer_id;
132 	struct timeout_t  timeout;
133 	struct duration_t duration;
134 } cap_t;
135 
136 enum tpm_capabilities {
137 	TPM_CAP_FLAG = 4,
138 	TPM_CAP_PROP = 5,
139 	TPM_CAP_VERSION_1_1 = 0x06,
140 	TPM_CAP_VERSION_1_2 = 0x1A,
141 };
142 
143 enum tpm_sub_capabilities {
144 	TPM_CAP_PROP_PCR = 0x101,
145 	TPM_CAP_PROP_MANUFACTURER = 0x103,
146 	TPM_CAP_FLAG_PERM = 0x108,
147 	TPM_CAP_FLAG_VOL = 0x109,
148 	TPM_CAP_PROP_OWNER = 0x111,
149 	TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
150 	TPM_CAP_PROP_TIS_DURATION = 0x120,
151 };
152 
153 
154 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
155  * bytes, but 128 is still a relatively large number of random bytes and
156  * anything much bigger causes users of struct tpm_cmd_t to start getting
157  * compiler warnings about stack frame size. */
158 #define TPM_MAX_RNG_DATA	128
159 
160 extern struct class *tpm_class;
161 extern struct class *tpmrm_class;
162 extern dev_t tpm_devt;
163 extern const struct file_operations tpm_fops;
164 extern const struct file_operations tpmrm_fops;
165 extern struct idr dev_nums_idr;
166 
167 ssize_t tpm_transmit(struct tpm_chip *chip, u8 *buf, size_t bufsiz);
168 int tpm_get_timeouts(struct tpm_chip *);
169 int tpm_auto_startup(struct tpm_chip *chip);
170 
171 int tpm1_pm_suspend(struct tpm_chip *chip, u32 tpm_suspend_pcr);
172 int tpm1_auto_startup(struct tpm_chip *chip);
173 int tpm1_do_selftest(struct tpm_chip *chip);
174 int tpm1_get_timeouts(struct tpm_chip *chip);
175 unsigned long tpm1_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
176 int tpm1_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, const u8 *hash,
177 		    const char *log_msg);
178 int tpm1_pcr_read(struct tpm_chip *chip, u32 pcr_idx, u8 *res_buf);
179 ssize_t tpm1_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
180 		    const char *desc, size_t min_cap_length);
181 int tpm1_get_random(struct tpm_chip *chip, u8 *out, size_t max);
182 int tpm1_get_pcr_allocation(struct tpm_chip *chip);
183 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
184 int tpm_pm_suspend(struct device *dev);
185 int tpm_pm_resume(struct device *dev);
186 
tpm_msleep(unsigned int delay_msec)187 static inline void tpm_msleep(unsigned int delay_msec)
188 {
189 	usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US,
190 		     delay_msec * 1000);
191 };
192 
193 int tpm_chip_start(struct tpm_chip *chip);
194 void tpm_chip_stop(struct tpm_chip *chip);
195 struct tpm_chip *tpm_find_get_ops(struct tpm_chip *chip);
196 
197 struct tpm_chip *tpm_chip_alloc(struct device *dev,
198 				const struct tpm_class_ops *ops);
199 struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
200 				 const struct tpm_class_ops *ops);
201 int tpm_chip_register(struct tpm_chip *chip);
202 void tpm_chip_unregister(struct tpm_chip *chip);
203 
204 void tpm_sysfs_add_device(struct tpm_chip *chip);
205 
206 
207 #ifdef CONFIG_ACPI
208 extern void tpm_add_ppi(struct tpm_chip *chip);
209 #else
tpm_add_ppi(struct tpm_chip * chip)210 static inline void tpm_add_ppi(struct tpm_chip *chip)
211 {
212 }
213 #endif
214 
215 int tpm2_get_timeouts(struct tpm_chip *chip);
216 int tpm2_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
217 		  struct tpm_digest *digest, u16 *digest_size_ptr);
218 int tpm2_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
219 		    struct tpm_digest *digests);
220 int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max);
221 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
222 			u32 *value, const char *desc);
223 
224 ssize_t tpm2_get_pcr_allocation(struct tpm_chip *chip);
225 int tpm2_auto_startup(struct tpm_chip *chip);
226 void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
227 unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
228 int tpm2_probe(struct tpm_chip *chip);
229 int tpm2_get_cc_attrs_tbl(struct tpm_chip *chip);
230 int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
231 int tpm2_init_space(struct tpm_space *space, unsigned int buf_size);
232 void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space);
233 void tpm2_flush_space(struct tpm_chip *chip);
234 int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u8 *cmd,
235 		       size_t cmdsiz);
236 int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space, void *buf,
237 		      size_t *bufsiz);
238 int tpm_devs_add(struct tpm_chip *chip);
239 void tpm_devs_remove(struct tpm_chip *chip);
240 
241 void tpm_bios_log_setup(struct tpm_chip *chip);
242 void tpm_bios_log_teardown(struct tpm_chip *chip);
243 int tpm_dev_common_init(void);
244 void tpm_dev_common_exit(void);
245 #endif
246