xref: /openbmc/linux/drivers/char/tpm/tpm.h (revision bdeeed09)
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 
45 enum 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 
53 enum 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 */
60 enum tpm_addr {
61 	TPM_SUPERIO_ADDR = 0x2E,
62 	TPM_ADDR = 0x4E,
63 };
64 
65 /* Indexes the duration array */
66 enum 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 
83 enum tpm2_const {
84 	TPM2_PLATFORM_PCR       =     24,
85 	TPM2_PCR_SELECT_MIN     = ((TPM2_PLATFORM_PCR + 7) / 8),
86 };
87 
88 enum 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 
100 enum 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 
109 enum 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 
122 enum 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 
133 enum 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 
152 enum tpm2_permanent_handles {
153 	TPM2_RS_PW		= 0x40000009,
154 };
155 
156 enum 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 
163 enum tpm2_properties {
164 	TPM_PT_TOTAL_COMMANDS	= 0x0129,
165 };
166 
167 enum tpm2_startup_types {
168 	TPM2_SU_CLEAR	= 0x0000,
169 	TPM2_SU_STATE	= 0x0001,
170 };
171 
172 enum 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 
183 struct tpm_space {
184 	u32 context_tbl[3];
185 	u8 *context_buf;
186 	u32 session_tbl[3];
187 	u8 *session_buf;
188 };
189 
190 enum 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 
198 struct tpm_bios_log {
199 	void *bios_event_log;
200 	void *bios_event_log_end;
201 };
202 
203 struct tpm_chip_seqops {
204 	struct tpm_chip *chip;
205 	const struct seq_operations *seqops;
206 };
207 
208 struct 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 
264 struct tpm_input_header {
265 	__be16	tag;
266 	__be32	length;
267 	__be32	ordinal;
268 } __packed;
269 
270 struct tpm_output_header {
271 	__be16	tag;
272 	__be32	length;
273 	__be32	return_code;
274 } __packed;
275 
276 #define TPM_TAG_RQU_COMMAND 193
277 
278 struct	stclear_flags_t {
279 	__be16	tag;
280 	u8	deactivated;
281 	u8	disableForceClear;
282 	u8	physicalPresence;
283 	u8	physicalPresenceLock;
284 	u8	bGlobalLock;
285 } __packed;
286 
287 struct	tpm_version_t {
288 	u8	Major;
289 	u8	Minor;
290 	u8	revMajor;
291 	u8	revMinor;
292 } __packed;
293 
294 struct	tpm_version_1_2_t {
295 	__be16	tag;
296 	u8	Major;
297 	u8	Minor;
298 	u8	revMajor;
299 	u8	revMinor;
300 } __packed;
301 
302 struct	timeout_t {
303 	__be32	a;
304 	__be32	b;
305 	__be32	c;
306 	__be32	d;
307 } __packed;
308 
309 struct duration_t {
310 	__be32	tpm_short;
311 	__be32	tpm_medium;
312 	__be32	tpm_long;
313 } __packed;
314 
315 struct 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 
339 typedef 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 
351 enum 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 
358 enum 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 
368 typedef union {
369 	struct	tpm_input_header in;
370 	struct	tpm_output_header out;
371 } tpm_cmd_header;
372 
373 struct tpm_pcrread_out {
374 	u8	pcr_result[TPM_DIGEST_SIZE];
375 } __packed;
376 
377 struct 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 
387 struct tpm_getrandom_out {
388 	__be32 rng_data_len;
389 	u8     rng_data[TPM_MAX_RNG_DATA];
390 } __packed;
391 
392 struct tpm_getrandom_in {
393 	__be32 num_bytes;
394 } __packed;
395 
396 typedef 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 
403 struct 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 
414 enum tpm_buf_flags {
415 	TPM_BUF_OVERFLOW	= BIT(0),
416 };
417 
418 struct tpm_buf {
419 	struct page *data_page;
420 	unsigned int flags;
421 	u8 *data;
422 };
423 
424 static 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 
444 static inline void tpm_buf_destroy(struct tpm_buf *buf)
445 {
446 	kunmap(buf->data_page);
447 	__free_page(buf->data_page);
448 }
449 
450 static 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 
457 static 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 
464 static 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 
485 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
486 {
487 	tpm_buf_append(buf, &value, 1);
488 }
489 
490 static 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 
497 static 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 
504 extern struct class *tpm_class;
505 extern struct class *tpmrm_class;
506 extern dev_t tpm_devt;
507 extern const struct file_operations tpm_fops;
508 extern const struct file_operations tpmrm_fops;
509 extern struct idr dev_nums_idr;
510 
511 enum tpm_transmit_flags {
512 	TPM_TRANSMIT_UNLOCKED	= BIT(0),
513 	TPM_TRANSMIT_RAW	= BIT(1),
514 };
515 
516 ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
517 		     u8 *buf, size_t bufsiz, unsigned int flags);
518 ssize_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);
522 int tpm_startup(struct tpm_chip *chip);
523 ssize_t tpm_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
524 		   const char *desc, size_t min_cap_length);
525 int tpm_get_timeouts(struct tpm_chip *);
526 int tpm1_auto_startup(struct tpm_chip *chip);
527 int tpm_do_selftest(struct tpm_chip *chip);
528 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
529 int tpm_pm_suspend(struct device *dev);
530 int tpm_pm_resume(struct device *dev);
531 
532 static 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 
538 struct tpm_chip *tpm_chip_find_get(struct tpm_chip *chip);
539 __must_check int tpm_try_get_ops(struct tpm_chip *chip);
540 void tpm_put_ops(struct tpm_chip *chip);
541 
542 struct tpm_chip *tpm_chip_alloc(struct device *dev,
543 				const struct tpm_class_ops *ops);
544 struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
545 				 const struct tpm_class_ops *ops);
546 int tpm_chip_register(struct tpm_chip *chip);
547 void tpm_chip_unregister(struct tpm_chip *chip);
548 
549 void tpm_sysfs_add_device(struct tpm_chip *chip);
550 
551 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
552 
553 #ifdef CONFIG_ACPI
554 extern void tpm_add_ppi(struct tpm_chip *chip);
555 #else
556 static inline void tpm_add_ppi(struct tpm_chip *chip)
557 {
558 }
559 #endif
560 
561 static inline u32 tpm2_rc_value(u32 rc)
562 {
563 	return (rc & BIT(7)) ? rc & 0xff : rc;
564 }
565 
566 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
567 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, u32 count,
568 		    struct tpm2_digest *digests);
569 int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max);
570 void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
571 			    unsigned int flags);
572 int tpm2_seal_trusted(struct tpm_chip *chip,
573 		      struct trusted_key_payload *payload,
574 		      struct trusted_key_options *options);
575 int tpm2_unseal_trusted(struct tpm_chip *chip,
576 			struct trusted_key_payload *payload,
577 			struct trusted_key_options *options);
578 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
579 			u32 *value, const char *desc);
580 
581 int tpm2_auto_startup(struct tpm_chip *chip);
582 void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
583 unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
584 int tpm2_probe(struct tpm_chip *chip);
585 int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
586 int tpm2_init_space(struct tpm_space *space);
587 void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space);
588 int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u32 cc,
589 		       u8 *cmd);
590 int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space,
591 		      u32 cc, u8 *buf, size_t *bufsiz);
592 
593 extern const struct seq_operations tpm2_binary_b_measurements_seqops;
594 
595 #if defined(CONFIG_ACPI)
596 int tpm_read_log_acpi(struct tpm_chip *chip);
597 #else
598 static inline int tpm_read_log_acpi(struct tpm_chip *chip)
599 {
600 	return -ENODEV;
601 }
602 #endif
603 #if defined(CONFIG_OF)
604 int tpm_read_log_of(struct tpm_chip *chip);
605 #else
606 static inline int tpm_read_log_of(struct tpm_chip *chip)
607 {
608 	return -ENODEV;
609 }
610 #endif
611 #if defined(CONFIG_EFI)
612 int tpm_read_log_efi(struct tpm_chip *chip);
613 #else
614 static inline int tpm_read_log_efi(struct tpm_chip *chip)
615 {
616 	return -ENODEV;
617 }
618 #endif
619 
620 int tpm_bios_log_setup(struct tpm_chip *chip);
621 void tpm_bios_log_teardown(struct tpm_chip *chip);
622 #endif
623