Loading...
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
39enum 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 */
49enum 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
66struct stclear_flags_t {
67 __be16 tag;
68 u8 deactivated;
69 u8 disableForceClear;
70 u8 physicalPresence;
71 u8 physicalPresenceLock;
72 u8 bGlobalLock;
73} __packed;
74
75struct tpm1_version {
76 u8 major;
77 u8 minor;
78 u8 rev_major;
79 u8 rev_minor;
80} __packed;
81
82struct tpm1_version2 {
83 __be16 tag;
84 struct tpm1_version version;
85} __packed;
86
87struct timeout_t {
88 __be32 a;
89 __be32 b;
90 __be32 c;
91 __be32 d;
92} __packed;
93
94struct duration_t {
95 __be32 tpm_short;
96 __be32 tpm_medium;
97 __be32 tpm_long;
98} __packed;
99
100struct 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
124typedef 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
136enum 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
143enum 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
153enum tpm2_pt_props {
154 TPM2_PT_NONE = 0x00000000,
155 TPM2_PT_GROUP = 0x00000100,
156 TPM2_PT_FIXED = TPM2_PT_GROUP * 1,
157 TPM2_PT_FAMILY_INDICATOR = TPM2_PT_FIXED + 0,
158 TPM2_PT_LEVEL = TPM2_PT_FIXED + 1,
159 TPM2_PT_REVISION = TPM2_PT_FIXED + 2,
160 TPM2_PT_DAY_OF_YEAR = TPM2_PT_FIXED + 3,
161 TPM2_PT_YEAR = TPM2_PT_FIXED + 4,
162 TPM2_PT_MANUFACTURER = TPM2_PT_FIXED + 5,
163 TPM2_PT_VENDOR_STRING_1 = TPM2_PT_FIXED + 6,
164 TPM2_PT_VENDOR_STRING_2 = TPM2_PT_FIXED + 7,
165 TPM2_PT_VENDOR_STRING_3 = TPM2_PT_FIXED + 8,
166 TPM2_PT_VENDOR_STRING_4 = TPM2_PT_FIXED + 9,
167 TPM2_PT_VENDOR_TPM_TYPE = TPM2_PT_FIXED + 10,
168 TPM2_PT_FIRMWARE_VERSION_1 = TPM2_PT_FIXED + 11,
169 TPM2_PT_FIRMWARE_VERSION_2 = TPM2_PT_FIXED + 12,
170 TPM2_PT_INPUT_BUFFER = TPM2_PT_FIXED + 13,
171 TPM2_PT_HR_TRANSIENT_MIN = TPM2_PT_FIXED + 14,
172 TPM2_PT_HR_PERSISTENT_MIN = TPM2_PT_FIXED + 15,
173 TPM2_PT_HR_LOADED_MIN = TPM2_PT_FIXED + 16,
174 TPM2_PT_ACTIVE_SESSIONS_MAX = TPM2_PT_FIXED + 17,
175 TPM2_PT_PCR_COUNT = TPM2_PT_FIXED + 18,
176 TPM2_PT_PCR_SELECT_MIN = TPM2_PT_FIXED + 19,
177 TPM2_PT_CONTEXT_GAP_MAX = TPM2_PT_FIXED + 20,
178 TPM2_PT_NV_COUNTERS_MAX = TPM2_PT_FIXED + 22,
179 TPM2_PT_NV_INDEX_MAX = TPM2_PT_FIXED + 23,
180 TPM2_PT_MEMORY = TPM2_PT_FIXED + 24,
181 TPM2_PT_CLOCK_UPDATE = TPM2_PT_FIXED + 25,
182 TPM2_PT_CONTEXT_HASH = TPM2_PT_FIXED + 26,
183 TPM2_PT_CONTEXT_SYM = TPM2_PT_FIXED + 27,
184 TPM2_PT_CONTEXT_SYM_SIZE = TPM2_PT_FIXED + 28,
185 TPM2_PT_ORDERLY_COUNT = TPM2_PT_FIXED + 29,
186 TPM2_PT_MAX_COMMAND_SIZE = TPM2_PT_FIXED + 30,
187 TPM2_PT_MAX_RESPONSE_SIZE = TPM2_PT_FIXED + 31,
188 TPM2_PT_MAX_DIGEST = TPM2_PT_FIXED + 32,
189 TPM2_PT_MAX_OBJECT_CONTEXT = TPM2_PT_FIXED + 33,
190 TPM2_PT_MAX_SESSION_CONTEXT = TPM2_PT_FIXED + 34,
191 TPM2_PT_PS_FAMILY_INDICATOR = TPM2_PT_FIXED + 35,
192 TPM2_PT_PS_LEVEL = TPM2_PT_FIXED + 36,
193 TPM2_PT_PS_REVISION = TPM2_PT_FIXED + 37,
194 TPM2_PT_PS_DAY_OF_YEAR = TPM2_PT_FIXED + 38,
195 TPM2_PT_PS_YEAR = TPM2_PT_FIXED + 39,
196 TPM2_PT_SPLIT_MAX = TPM2_PT_FIXED + 40,
197 TPM2_PT_TOTAL_COMMANDS = TPM2_PT_FIXED + 41,
198 TPM2_PT_LIBRARY_COMMANDS = TPM2_PT_FIXED + 42,
199 TPM2_PT_VENDOR_COMMANDS = TPM2_PT_FIXED + 43,
200 TPM2_PT_NV_BUFFER_MAX = TPM2_PT_FIXED + 44,
201 TPM2_PT_MODES = TPM2_PT_FIXED + 45,
202 TPM2_PT_MAX_CAP_BUFFER = TPM2_PT_FIXED + 46,
203 TPM2_PT_VAR = TPM2_PT_GROUP * 2,
204 TPM2_PT_PERMANENT = TPM2_PT_VAR + 0,
205 TPM2_PT_STARTUP_CLEAR = TPM2_PT_VAR + 1,
206 TPM2_PT_HR_NV_INDEX = TPM2_PT_VAR + 2,
207 TPM2_PT_HR_LOADED = TPM2_PT_VAR + 3,
208 TPM2_PT_HR_LOADED_AVAIL = TPM2_PT_VAR + 4,
209 TPM2_PT_HR_ACTIVE = TPM2_PT_VAR + 5,
210 TPM2_PT_HR_ACTIVE_AVAIL = TPM2_PT_VAR + 6,
211 TPM2_PT_HR_TRANSIENT_AVAIL = TPM2_PT_VAR + 7,
212 TPM2_PT_HR_PERSISTENT = TPM2_PT_VAR + 8,
213 TPM2_PT_HR_PERSISTENT_AVAIL = TPM2_PT_VAR + 9,
214 TPM2_PT_NV_COUNTERS = TPM2_PT_VAR + 10,
215 TPM2_PT_NV_COUNTERS_AVAIL = TPM2_PT_VAR + 11,
216 TPM2_PT_ALGORITHM_SET = TPM2_PT_VAR + 12,
217 TPM2_PT_LOADED_CURVES = TPM2_PT_VAR + 13,
218 TPM2_PT_LOCKOUT_COUNTER = TPM2_PT_VAR + 14,
219 TPM2_PT_MAX_AUTH_FAIL = TPM2_PT_VAR + 15,
220 TPM2_PT_LOCKOUT_INTERVAL = TPM2_PT_VAR + 16,
221 TPM2_PT_LOCKOUT_RECOVERY = TPM2_PT_VAR + 17,
222 TPM2_PT_NV_WRITE_RECOVERY = TPM2_PT_VAR + 18,
223 TPM2_PT_AUDIT_COUNTER_0 = TPM2_PT_VAR + 19,
224 TPM2_PT_AUDIT_COUNTER_1 = TPM2_PT_VAR + 20,
225};
226
227/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
228 * bytes, but 128 is still a relatively large number of random bytes and
229 * anything much bigger causes users of struct tpm_cmd_t to start getting
230 * compiler warnings about stack frame size. */
231#define TPM_MAX_RNG_DATA 128
232
233extern const struct class tpm_class;
234extern const struct class tpmrm_class;
235extern dev_t tpm_devt;
236extern const struct file_operations tpm_fops;
237extern const struct file_operations tpmrm_fops;
238extern struct idr dev_nums_idr;
239
240ssize_t tpm_transmit(struct tpm_chip *chip, u8 *buf, size_t bufsiz);
241int tpm_get_timeouts(struct tpm_chip *);
242int tpm_auto_startup(struct tpm_chip *chip);
243
244int tpm1_pm_suspend(struct tpm_chip *chip, u32 tpm_suspend_pcr);
245int tpm1_auto_startup(struct tpm_chip *chip);
246int tpm1_do_selftest(struct tpm_chip *chip);
247int tpm1_get_timeouts(struct tpm_chip *chip);
248unsigned long tpm1_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
249int tpm1_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, const u8 *hash,
250 const char *log_msg);
251int tpm1_pcr_read(struct tpm_chip *chip, u32 pcr_idx, u8 *res_buf);
252ssize_t tpm1_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
253 const char *desc, size_t min_cap_length);
254int tpm1_get_random(struct tpm_chip *chip, u8 *out, size_t max);
255int tpm1_get_pcr_allocation(struct tpm_chip *chip);
256unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
257int tpm_pm_suspend(struct device *dev);
258int tpm_pm_resume(struct device *dev);
259int tpm_class_shutdown(struct device *dev);
260
261static inline void tpm_msleep(unsigned int delay_msec)
262{
263 usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US,
264 delay_msec * 1000);
265};
266
267int tpm_chip_bootstrap(struct tpm_chip *chip);
268int tpm_chip_start(struct tpm_chip *chip);
269void tpm_chip_stop(struct tpm_chip *chip);
270struct tpm_chip *tpm_find_get_ops(struct tpm_chip *chip);
271
272struct tpm_chip *tpm_chip_alloc(struct device *dev,
273 const struct tpm_class_ops *ops);
274struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
275 const struct tpm_class_ops *ops);
276int tpm_chip_register(struct tpm_chip *chip);
277void tpm_chip_unregister(struct tpm_chip *chip);
278
279void tpm_sysfs_add_device(struct tpm_chip *chip);
280
281
282#ifdef CONFIG_ACPI
283extern void tpm_add_ppi(struct tpm_chip *chip);
284#else
285static inline void tpm_add_ppi(struct tpm_chip *chip)
286{
287}
288#endif
289
290int tpm2_get_timeouts(struct tpm_chip *chip);
291int tpm2_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
292 struct tpm_digest *digest, u16 *digest_size_ptr);
293int tpm2_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
294 struct tpm_digest *digests);
295int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max);
296ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
297 u32 *value, const char *desc);
298
299ssize_t tpm2_get_pcr_allocation(struct tpm_chip *chip);
300int tpm2_auto_startup(struct tpm_chip *chip);
301void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
302unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
303int tpm2_probe(struct tpm_chip *chip);
304int tpm2_get_cc_attrs_tbl(struct tpm_chip *chip);
305int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
306int tpm2_init_space(struct tpm_space *space, unsigned int buf_size);
307void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space);
308void tpm2_flush_space(struct tpm_chip *chip);
309int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u8 *cmd,
310 size_t cmdsiz);
311int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space, void *buf,
312 size_t *bufsiz);
313int tpm_devs_add(struct tpm_chip *chip);
314void tpm_devs_remove(struct tpm_chip *chip);
315
316void tpm_bios_log_setup(struct tpm_chip *chip);
317void tpm_bios_log_teardown(struct tpm_chip *chip);
318int tpm_dev_common_init(void);
319void tpm_dev_common_exit(void);
320#endif
1/*
2 * Copyright (C) 2004 IBM Corporation
3 * Copyright (C) 2015 Intel Corporation
4 *
5 * Authors:
6 * Leendert van Doorn <leendert@watson.ibm.com>
7 * Dave Safford <safford@watson.ibm.com>
8 * Reiner Sailer <sailer@watson.ibm.com>
9 * Kylene Hall <kjhall@us.ibm.com>
10 *
11 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
12 *
13 * Device driver for TCG/TCPA TPM (trusted platform module).
14 * Specifications at www.trustedcomputinggroup.org
15 *
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License as
18 * published by the Free Software Foundation, version 2 of the
19 * License.
20 *
21 */
22
23#ifndef __TPM_H__
24#define __TPM_H__
25
26#include <linux/module.h>
27#include <linux/delay.h>
28#include <linux/fs.h>
29#include <linux/hw_random.h>
30#include <linux/mutex.h>
31#include <linux/sched.h>
32#include <linux/platform_device.h>
33#include <linux/io.h>
34#include <linux/tpm.h>
35#include <linux/acpi.h>
36#include <linux/cdev.h>
37#include <linux/highmem.h>
38#include <linux/tpm_eventlog.h>
39#include <crypto/hash_info.h>
40
41#ifdef CONFIG_X86
42#include <asm/intel-family.h>
43#endif
44
45enum tpm_const {
46 TPM_MINOR = 224, /* officially assigned */
47 TPM_BUFSIZE = 4096,
48 TPM_NUM_DEVICES = 65536,
49 TPM_RETRY = 50, /* 5 seconds */
50 TPM_NUM_EVENT_LOG_FILES = 3,
51};
52
53enum tpm_timeout {
54 TPM_TIMEOUT = 5, /* msecs */
55 TPM_TIMEOUT_RETRY = 100, /* msecs */
56 TPM_TIMEOUT_RANGE_US = 300 /* usecs */
57};
58
59/* TPM addresses */
60enum tpm_addr {
61 TPM_SUPERIO_ADDR = 0x2E,
62 TPM_ADDR = 0x4E,
63};
64
65/* Indexes the duration array */
66enum tpm_duration {
67 TPM_SHORT = 0,
68 TPM_MEDIUM = 1,
69 TPM_LONG = 2,
70 TPM_LONG_LONG = 3,
71 TPM_UNDEFINED,
72 TPM_NUM_DURATIONS = TPM_UNDEFINED,
73};
74
75#define TPM_WARN_RETRY 0x800
76#define TPM_WARN_DOING_SELFTEST 0x802
77#define TPM_ERR_DEACTIVATED 0x6
78#define TPM_ERR_DISABLED 0x7
79#define TPM_ERR_INVALID_POSTINIT 38
80
81#define TPM_HEADER_SIZE 10
82
83enum tpm2_const {
84 TPM2_PLATFORM_PCR = 24,
85 TPM2_PCR_SELECT_MIN = ((TPM2_PLATFORM_PCR + 7) / 8),
86};
87
88enum tpm2_timeouts {
89 TPM2_TIMEOUT_A = 750,
90 TPM2_TIMEOUT_B = 2000,
91 TPM2_TIMEOUT_C = 200,
92 TPM2_TIMEOUT_D = 30,
93 TPM2_DURATION_SHORT = 20,
94 TPM2_DURATION_MEDIUM = 750,
95 TPM2_DURATION_LONG = 2000,
96 TPM2_DURATION_LONG_LONG = 300000,
97 TPM2_DURATION_DEFAULT = 120000,
98};
99
100enum tpm2_structures {
101 TPM2_ST_NO_SESSIONS = 0x8001,
102 TPM2_ST_SESSIONS = 0x8002,
103};
104
105/* Indicates from what layer of the software stack the error comes from */
106#define TSS2_RC_LAYER_SHIFT 16
107#define TSS2_RESMGR_TPM_RC_LAYER (11 << TSS2_RC_LAYER_SHIFT)
108
109enum tpm2_return_codes {
110 TPM2_RC_SUCCESS = 0x0000,
111 TPM2_RC_HASH = 0x0083, /* RC_FMT1 */
112 TPM2_RC_HANDLE = 0x008B,
113 TPM2_RC_INITIALIZE = 0x0100, /* RC_VER1 */
114 TPM2_RC_FAILURE = 0x0101,
115 TPM2_RC_DISABLED = 0x0120,
116 TPM2_RC_COMMAND_CODE = 0x0143,
117 TPM2_RC_TESTING = 0x090A, /* RC_WARN */
118 TPM2_RC_REFERENCE_H0 = 0x0910,
119 TPM2_RC_RETRY = 0x0922,
120};
121
122enum tpm2_algorithms {
123 TPM2_ALG_ERROR = 0x0000,
124 TPM2_ALG_SHA1 = 0x0004,
125 TPM2_ALG_KEYEDHASH = 0x0008,
126 TPM2_ALG_SHA256 = 0x000B,
127 TPM2_ALG_SHA384 = 0x000C,
128 TPM2_ALG_SHA512 = 0x000D,
129 TPM2_ALG_NULL = 0x0010,
130 TPM2_ALG_SM3_256 = 0x0012,
131};
132
133enum tpm2_command_codes {
134 TPM2_CC_FIRST = 0x011F,
135 TPM2_CC_CREATE_PRIMARY = 0x0131,
136 TPM2_CC_SELF_TEST = 0x0143,
137 TPM2_CC_STARTUP = 0x0144,
138 TPM2_CC_SHUTDOWN = 0x0145,
139 TPM2_CC_CREATE = 0x0153,
140 TPM2_CC_LOAD = 0x0157,
141 TPM2_CC_UNSEAL = 0x015E,
142 TPM2_CC_CONTEXT_LOAD = 0x0161,
143 TPM2_CC_CONTEXT_SAVE = 0x0162,
144 TPM2_CC_FLUSH_CONTEXT = 0x0165,
145 TPM2_CC_GET_CAPABILITY = 0x017A,
146 TPM2_CC_GET_RANDOM = 0x017B,
147 TPM2_CC_PCR_READ = 0x017E,
148 TPM2_CC_PCR_EXTEND = 0x0182,
149 TPM2_CC_LAST = 0x018F,
150};
151
152enum tpm2_permanent_handles {
153 TPM2_RS_PW = 0x40000009,
154};
155
156enum tpm2_capabilities {
157 TPM2_CAP_HANDLES = 1,
158 TPM2_CAP_COMMANDS = 2,
159 TPM2_CAP_PCRS = 5,
160 TPM2_CAP_TPM_PROPERTIES = 6,
161};
162
163enum tpm2_properties {
164 TPM_PT_TOTAL_COMMANDS = 0x0129,
165};
166
167enum tpm2_startup_types {
168 TPM2_SU_CLEAR = 0x0000,
169 TPM2_SU_STATE = 0x0001,
170};
171
172enum tpm2_cc_attrs {
173 TPM2_CC_ATTR_CHANDLES = 25,
174 TPM2_CC_ATTR_RHANDLE = 28,
175};
176
177#define TPM_VID_INTEL 0x8086
178#define TPM_VID_WINBOND 0x1050
179#define TPM_VID_STM 0x104A
180
181#define TPM_PPI_VERSION_LEN 3
182
183struct tpm_space {
184 u32 context_tbl[3];
185 u8 *context_buf;
186 u32 session_tbl[3];
187 u8 *session_buf;
188};
189
190enum tpm_chip_flags {
191 TPM_CHIP_FLAG_TPM2 = BIT(1),
192 TPM_CHIP_FLAG_IRQ = BIT(2),
193 TPM_CHIP_FLAG_VIRTUAL = BIT(3),
194 TPM_CHIP_FLAG_HAVE_TIMEOUTS = BIT(4),
195 TPM_CHIP_FLAG_ALWAYS_POWERED = BIT(5),
196};
197
198struct tpm_bios_log {
199 void *bios_event_log;
200 void *bios_event_log_end;
201};
202
203struct tpm_chip_seqops {
204 struct tpm_chip *chip;
205 const struct seq_operations *seqops;
206};
207
208struct tpm_chip {
209 struct device dev;
210 struct device devs;
211 struct cdev cdev;
212 struct cdev cdevs;
213
214 /* A driver callback under ops cannot be run unless ops_sem is held
215 * (sometimes implicitly, eg for the sysfs code). ops becomes null
216 * when the driver is unregistered, see tpm_try_get_ops.
217 */
218 struct rw_semaphore ops_sem;
219 const struct tpm_class_ops *ops;
220
221 struct tpm_bios_log log;
222 struct tpm_chip_seqops bin_log_seqops;
223 struct tpm_chip_seqops ascii_log_seqops;
224
225 unsigned int flags;
226
227 int dev_num; /* /dev/tpm# */
228 unsigned long is_open; /* only one allowed */
229
230 char hwrng_name[64];
231 struct hwrng hwrng;
232
233 struct mutex tpm_mutex; /* tpm is processing */
234
235 unsigned long timeout_a; /* jiffies */
236 unsigned long timeout_b; /* jiffies */
237 unsigned long timeout_c; /* jiffies */
238 unsigned long timeout_d; /* jiffies */
239 bool timeout_adjusted;
240 unsigned long duration[TPM_NUM_DURATIONS]; /* jiffies */
241 bool duration_adjusted;
242
243 struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];
244
245 const struct attribute_group *groups[3];
246 unsigned int groups_cnt;
247
248 u16 active_banks[7];
249#ifdef CONFIG_ACPI
250 acpi_handle acpi_dev_handle;
251 char ppi_version[TPM_PPI_VERSION_LEN + 1];
252#endif /* CONFIG_ACPI */
253
254 struct tpm_space work_space;
255 u32 nr_commands;
256 u32 *cc_attrs_tbl;
257
258 /* active locality */
259 int locality;
260};
261
262#define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
263
264struct tpm_input_header {
265 __be16 tag;
266 __be32 length;
267 __be32 ordinal;
268} __packed;
269
270struct tpm_output_header {
271 __be16 tag;
272 __be32 length;
273 __be32 return_code;
274} __packed;
275
276#define TPM_TAG_RQU_COMMAND 193
277
278struct stclear_flags_t {
279 __be16 tag;
280 u8 deactivated;
281 u8 disableForceClear;
282 u8 physicalPresence;
283 u8 physicalPresenceLock;
284 u8 bGlobalLock;
285} __packed;
286
287struct tpm_version_t {
288 u8 Major;
289 u8 Minor;
290 u8 revMajor;
291 u8 revMinor;
292} __packed;
293
294struct tpm_version_1_2_t {
295 __be16 tag;
296 u8 Major;
297 u8 Minor;
298 u8 revMajor;
299 u8 revMinor;
300} __packed;
301
302struct timeout_t {
303 __be32 a;
304 __be32 b;
305 __be32 c;
306 __be32 d;
307} __packed;
308
309struct duration_t {
310 __be32 tpm_short;
311 __be32 tpm_medium;
312 __be32 tpm_long;
313} __packed;
314
315struct permanent_flags_t {
316 __be16 tag;
317 u8 disable;
318 u8 ownership;
319 u8 deactivated;
320 u8 readPubek;
321 u8 disableOwnerClear;
322 u8 allowMaintenance;
323 u8 physicalPresenceLifetimeLock;
324 u8 physicalPresenceHWEnable;
325 u8 physicalPresenceCMDEnable;
326 u8 CEKPUsed;
327 u8 TPMpost;
328 u8 TPMpostLock;
329 u8 FIPS;
330 u8 operator;
331 u8 enableRevokeEK;
332 u8 nvLocked;
333 u8 readSRKPub;
334 u8 tpmEstablished;
335 u8 maintenanceDone;
336 u8 disableFullDALogicInfo;
337} __packed;
338
339typedef union {
340 struct permanent_flags_t perm_flags;
341 struct stclear_flags_t stclear_flags;
342 __u8 owned;
343 __be32 num_pcrs;
344 struct tpm_version_t tpm_version;
345 struct tpm_version_1_2_t tpm_version_1_2;
346 __be32 manufacturer_id;
347 struct timeout_t timeout;
348 struct duration_t duration;
349} cap_t;
350
351enum tpm_capabilities {
352 TPM_CAP_FLAG = 4,
353 TPM_CAP_PROP = 5,
354 TPM_CAP_VERSION_1_1 = 0x06,
355 TPM_CAP_VERSION_1_2 = 0x1A,
356};
357
358enum tpm_sub_capabilities {
359 TPM_CAP_PROP_PCR = 0x101,
360 TPM_CAP_PROP_MANUFACTURER = 0x103,
361 TPM_CAP_FLAG_PERM = 0x108,
362 TPM_CAP_FLAG_VOL = 0x109,
363 TPM_CAP_PROP_OWNER = 0x111,
364 TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
365 TPM_CAP_PROP_TIS_DURATION = 0x120,
366};
367
368typedef union {
369 struct tpm_input_header in;
370 struct tpm_output_header out;
371} tpm_cmd_header;
372
373struct tpm_pcrread_out {
374 u8 pcr_result[TPM_DIGEST_SIZE];
375} __packed;
376
377struct tpm_pcrread_in {
378 __be32 pcr_idx;
379} __packed;
380
381/* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
382 * bytes, but 128 is still a relatively large number of random bytes and
383 * anything much bigger causes users of struct tpm_cmd_t to start getting
384 * compiler warnings about stack frame size. */
385#define TPM_MAX_RNG_DATA 128
386
387struct tpm_getrandom_out {
388 __be32 rng_data_len;
389 u8 rng_data[TPM_MAX_RNG_DATA];
390} __packed;
391
392struct tpm_getrandom_in {
393 __be32 num_bytes;
394} __packed;
395
396typedef union {
397 struct tpm_pcrread_in pcrread_in;
398 struct tpm_pcrread_out pcrread_out;
399 struct tpm_getrandom_in getrandom_in;
400 struct tpm_getrandom_out getrandom_out;
401} tpm_cmd_params;
402
403struct tpm_cmd_t {
404 tpm_cmd_header header;
405 tpm_cmd_params params;
406} __packed;
407
408
409/* A string buffer type for constructing TPM commands. This is based on the
410 * ideas of string buffer code in security/keys/trusted.h but is heap based
411 * in order to keep the stack usage minimal.
412 */
413
414enum tpm_buf_flags {
415 TPM_BUF_OVERFLOW = BIT(0),
416};
417
418struct tpm_buf {
419 struct page *data_page;
420 unsigned int flags;
421 u8 *data;
422};
423
424static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
425{
426 struct tpm_input_header *head;
427
428 buf->data_page = alloc_page(GFP_HIGHUSER);
429 if (!buf->data_page)
430 return -ENOMEM;
431
432 buf->flags = 0;
433 buf->data = kmap(buf->data_page);
434
435 head = (struct tpm_input_header *) buf->data;
436
437 head->tag = cpu_to_be16(tag);
438 head->length = cpu_to_be32(sizeof(*head));
439 head->ordinal = cpu_to_be32(ordinal);
440
441 return 0;
442}
443
444static inline void tpm_buf_destroy(struct tpm_buf *buf)
445{
446 kunmap(buf->data_page);
447 __free_page(buf->data_page);
448}
449
450static inline u32 tpm_buf_length(struct tpm_buf *buf)
451{
452 struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
453
454 return be32_to_cpu(head->length);
455}
456
457static inline u16 tpm_buf_tag(struct tpm_buf *buf)
458{
459 struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
460
461 return be16_to_cpu(head->tag);
462}
463
464static inline void tpm_buf_append(struct tpm_buf *buf,
465 const unsigned char *new_data,
466 unsigned int new_len)
467{
468 struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
469 u32 len = tpm_buf_length(buf);
470
471 /* Return silently if overflow has already happened. */
472 if (buf->flags & TPM_BUF_OVERFLOW)
473 return;
474
475 if ((len + new_len) > PAGE_SIZE) {
476 WARN(1, "tpm_buf: overflow\n");
477 buf->flags |= TPM_BUF_OVERFLOW;
478 return;
479 }
480
481 memcpy(&buf->data[len], new_data, new_len);
482 head->length = cpu_to_be32(len + new_len);
483}
484
485static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
486{
487 tpm_buf_append(buf, &value, 1);
488}
489
490static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
491{
492 __be16 value2 = cpu_to_be16(value);
493
494 tpm_buf_append(buf, (u8 *) &value2, 2);
495}
496
497static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
498{
499 __be32 value2 = cpu_to_be32(value);
500
501 tpm_buf_append(buf, (u8 *) &value2, 4);
502}
503
504extern struct class *tpm_class;
505extern struct class *tpmrm_class;
506extern dev_t tpm_devt;
507extern const struct file_operations tpm_fops;
508extern const struct file_operations tpmrm_fops;
509extern struct idr dev_nums_idr;
510
511enum tpm_transmit_flags {
512 TPM_TRANSMIT_UNLOCKED = BIT(0),
513 TPM_TRANSMIT_RAW = BIT(1),
514};
515
516ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
517 u8 *buf, size_t bufsiz, unsigned int flags);
518ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space,
519 void *buf, size_t bufsiz,
520 size_t min_rsp_body_length, unsigned int flags,
521 const char *desc);
522int tpm_startup(struct tpm_chip *chip);
523ssize_t tpm_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
524 const char *desc, size_t min_cap_length);
525int tpm_get_timeouts(struct tpm_chip *);
526int tpm1_auto_startup(struct tpm_chip *chip);
527int tpm_do_selftest(struct tpm_chip *chip);
528unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
529int tpm_pm_suspend(struct device *dev);
530int tpm_pm_resume(struct device *dev);
531
532static inline void tpm_msleep(unsigned int delay_msec)
533{
534 usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US,
535 delay_msec * 1000);
536};
537
538struct tpm_chip *tpm_chip_find_get(struct tpm_chip *chip);
539__must_check int tpm_try_get_ops(struct tpm_chip *chip);
540void tpm_put_ops(struct tpm_chip *chip);
541
542struct tpm_chip *tpm_chip_alloc(struct device *dev,
543 const struct tpm_class_ops *ops);
544struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
545 const struct tpm_class_ops *ops);
546int tpm_chip_register(struct tpm_chip *chip);
547void tpm_chip_unregister(struct tpm_chip *chip);
548
549void tpm_sysfs_add_device(struct tpm_chip *chip);
550
551int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
552
553#ifdef CONFIG_ACPI
554extern void tpm_add_ppi(struct tpm_chip *chip);
555#else
556static inline void tpm_add_ppi(struct tpm_chip *chip)
557{
558}
559#endif
560
561static inline u32 tpm2_rc_value(u32 rc)
562{
563 return (rc & BIT(7)) ? rc & 0xff : rc;
564}
565
566int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
567int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, u32 count,
568 struct tpm2_digest *digests);
569int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max);
570void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
571 unsigned int flags);
572int tpm2_seal_trusted(struct tpm_chip *chip,
573 struct trusted_key_payload *payload,
574 struct trusted_key_options *options);
575int tpm2_unseal_trusted(struct tpm_chip *chip,
576 struct trusted_key_payload *payload,
577 struct trusted_key_options *options);
578ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
579 u32 *value, const char *desc);
580
581int tpm2_auto_startup(struct tpm_chip *chip);
582void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
583unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
584int tpm2_probe(struct tpm_chip *chip);
585int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
586int tpm2_init_space(struct tpm_space *space);
587void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space);
588int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u32 cc,
589 u8 *cmd);
590int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space,
591 u32 cc, u8 *buf, size_t *bufsiz);
592
593extern const struct seq_operations tpm2_binary_b_measurements_seqops;
594
595#if defined(CONFIG_ACPI)
596int tpm_read_log_acpi(struct tpm_chip *chip);
597#else
598static inline int tpm_read_log_acpi(struct tpm_chip *chip)
599{
600 return -ENODEV;
601}
602#endif
603#if defined(CONFIG_OF)
604int tpm_read_log_of(struct tpm_chip *chip);
605#else
606static inline int tpm_read_log_of(struct tpm_chip *chip)
607{
608 return -ENODEV;
609}
610#endif
611#if defined(CONFIG_EFI)
612int tpm_read_log_efi(struct tpm_chip *chip);
613#else
614static inline int tpm_read_log_efi(struct tpm_chip *chip)
615{
616 return -ENODEV;
617}
618#endif
619
620int tpm_bios_log_setup(struct tpm_chip *chip);
621void tpm_bios_log_teardown(struct tpm_chip *chip);
622#endif