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/mutex.h>
30 #include <linux/sched.h>
31 #include <linux/platform_device.h>
32 #include <linux/io.h>
33 #include <linux/tpm.h>
34 #include <linux/acpi.h>
35 #include <linux/cdev.h>
36 #include <linux/highmem.h>
37 #include <crypto/hash_info.h>
38
39 #ifdef CONFIG_X86
40 #include <asm/intel-family.h>
41 #endif
42
43 enum tpm_const {
44 TPM_MINOR = 224, /* officially assigned */
45 TPM_BUFSIZE = 4096,
46 TPM_NUM_DEVICES = 65536,
47 TPM_RETRY = 50, /* 5 seconds */
48 TPM_NUM_EVENT_LOG_FILES = 3,
49 };
50
51 enum tpm_timeout {
52 TPM_TIMEOUT = 5, /* msecs */
53 TPM_TIMEOUT_RETRY = 100, /* msecs */
54 TPM_TIMEOUT_RANGE_US = 300 /* usecs */
55 };
56
57 /* TPM addresses */
58 enum tpm_addr {
59 TPM_SUPERIO_ADDR = 0x2E,
60 TPM_ADDR = 0x4E,
61 };
62
63 /* Indexes the duration array */
64 enum tpm_duration {
65 TPM_SHORT = 0,
66 TPM_MEDIUM = 1,
67 TPM_LONG = 2,
68 TPM_UNDEFINED,
69 };
70
71 #define TPM_WARN_RETRY 0x800
72 #define TPM_WARN_DOING_SELFTEST 0x802
73 #define TPM_ERR_DEACTIVATED 0x6
74 #define TPM_ERR_DISABLED 0x7
75 #define TPM_ERR_INVALID_POSTINIT 38
76
77 #define TPM_HEADER_SIZE 10
78
79 enum tpm2_const {
80 TPM2_PLATFORM_PCR = 24,
81 TPM2_PCR_SELECT_MIN = ((TPM2_PLATFORM_PCR + 7) / 8),
82 TPM2_TIMEOUT_A = 750,
83 TPM2_TIMEOUT_B = 2000,
84 TPM2_TIMEOUT_C = 200,
85 TPM2_TIMEOUT_D = 30,
86 TPM2_DURATION_SHORT = 20,
87 TPM2_DURATION_MEDIUM = 750,
88 TPM2_DURATION_LONG = 2000,
89 };
90
91 enum tpm2_structures {
92 TPM2_ST_NO_SESSIONS = 0x8001,
93 TPM2_ST_SESSIONS = 0x8002,
94 };
95
96 /* Indicates from what layer of the software stack the error comes from */
97 #define TSS2_RC_LAYER_SHIFT 16
98 #define TSS2_RESMGR_TPM_RC_LAYER (11 << TSS2_RC_LAYER_SHIFT)
99
100 enum tpm2_return_codes {
101 TPM2_RC_SUCCESS = 0x0000,
102 TPM2_RC_HASH = 0x0083, /* RC_FMT1 */
103 TPM2_RC_HANDLE = 0x008B,
104 TPM2_RC_INITIALIZE = 0x0100, /* RC_VER1 */
105 TPM2_RC_DISABLED = 0x0120,
106 TPM2_RC_COMMAND_CODE = 0x0143,
107 TPM2_RC_TESTING = 0x090A, /* RC_WARN */
108 TPM2_RC_REFERENCE_H0 = 0x0910,
109 TPM2_RC_RETRY = 0x0922,
110 };
111
112 enum tpm2_algorithms {
113 TPM2_ALG_ERROR = 0x0000,
114 TPM2_ALG_SHA1 = 0x0004,
115 TPM2_ALG_KEYEDHASH = 0x0008,
116 TPM2_ALG_SHA256 = 0x000B,
117 TPM2_ALG_SHA384 = 0x000C,
118 TPM2_ALG_SHA512 = 0x000D,
119 TPM2_ALG_NULL = 0x0010,
120 TPM2_ALG_SM3_256 = 0x0012,
121 };
122
123 enum tpm2_command_codes {
124 TPM2_CC_FIRST = 0x011F,
125 TPM2_CC_SELF_TEST = 0x0143,
126 TPM2_CC_STARTUP = 0x0144,
127 TPM2_CC_SHUTDOWN = 0x0145,
128 TPM2_CC_CREATE = 0x0153,
129 TPM2_CC_LOAD = 0x0157,
130 TPM2_CC_UNSEAL = 0x015E,
131 TPM2_CC_CONTEXT_LOAD = 0x0161,
132 TPM2_CC_CONTEXT_SAVE = 0x0162,
133 TPM2_CC_FLUSH_CONTEXT = 0x0165,
134 TPM2_CC_GET_CAPABILITY = 0x017A,
135 TPM2_CC_GET_RANDOM = 0x017B,
136 TPM2_CC_PCR_READ = 0x017E,
137 TPM2_CC_PCR_EXTEND = 0x0182,
138 TPM2_CC_LAST = 0x018F,
139 };
140
141 enum tpm2_permanent_handles {
142 TPM2_RS_PW = 0x40000009,
143 };
144
145 enum tpm2_capabilities {
146 TPM2_CAP_HANDLES = 1,
147 TPM2_CAP_COMMANDS = 2,
148 TPM2_CAP_PCRS = 5,
149 TPM2_CAP_TPM_PROPERTIES = 6,
150 };
151
152 enum tpm2_properties {
153 TPM_PT_TOTAL_COMMANDS = 0x0129,
154 };
155
156 enum tpm2_startup_types {
157 TPM2_SU_CLEAR = 0x0000,
158 TPM2_SU_STATE = 0x0001,
159 };
160
161 enum tpm2_cc_attrs {
162 TPM2_CC_ATTR_CHANDLES = 25,
163 TPM2_CC_ATTR_RHANDLE = 28,
164 };
165
166 #define TPM_VID_INTEL 0x8086
167 #define TPM_VID_WINBOND 0x1050
168 #define TPM_VID_STM 0x104A
169
170 #define TPM_PPI_VERSION_LEN 3
171
172 struct tpm_space {
173 u32 context_tbl[3];
174 u8 *context_buf;
175 u32 session_tbl[3];
176 u8 *session_buf;
177 };
178
179 enum tpm_chip_flags {
180 TPM_CHIP_FLAG_TPM2 = BIT(1),
181 TPM_CHIP_FLAG_IRQ = BIT(2),
182 TPM_CHIP_FLAG_VIRTUAL = BIT(3),
183 TPM_CHIP_FLAG_HAVE_TIMEOUTS = BIT(4),
184 TPM_CHIP_FLAG_ALWAYS_POWERED = BIT(5),
185 };
186
187 struct tpm_bios_log {
188 void *bios_event_log;
189 void *bios_event_log_end;
190 };
191
192 struct tpm_chip_seqops {
193 struct tpm_chip *chip;
194 const struct seq_operations *seqops;
195 };
196
197 struct tpm_chip {
198 struct device dev;
199 struct device devs;
200 struct cdev cdev;
201 struct cdev cdevs;
202
203 /* A driver callback under ops cannot be run unless ops_sem is held
204 * (sometimes implicitly, eg for the sysfs code). ops becomes null
205 * when the driver is unregistered, see tpm_try_get_ops.
206 */
207 struct rw_semaphore ops_sem;
208 const struct tpm_class_ops *ops;
209
210 struct tpm_bios_log log;
211 struct tpm_chip_seqops bin_log_seqops;
212 struct tpm_chip_seqops ascii_log_seqops;
213
214 unsigned int flags;
215
216 int dev_num; /* /dev/tpm# */
217 unsigned long is_open; /* only one allowed */
218
219 struct mutex tpm_mutex; /* tpm is processing */
220
221 unsigned long timeout_a; /* jiffies */
222 unsigned long timeout_b; /* jiffies */
223 unsigned long timeout_c; /* jiffies */
224 unsigned long timeout_d; /* jiffies */
225 bool timeout_adjusted;
226 unsigned long duration[3]; /* jiffies */
227 bool duration_adjusted;
228
229 struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];
230
231 const struct attribute_group *groups[3];
232 unsigned int groups_cnt;
233
234 u16 active_banks[7];
235 #ifdef CONFIG_ACPI
236 acpi_handle acpi_dev_handle;
237 char ppi_version[TPM_PPI_VERSION_LEN + 1];
238 #endif /* CONFIG_ACPI */
239
240 struct tpm_space work_space;
241 u32 nr_commands;
242 u32 *cc_attrs_tbl;
243
244 /* active locality */
245 int locality;
246 };
247
248 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
249
250 struct tpm_input_header {
251 __be16 tag;
252 __be32 length;
253 __be32 ordinal;
254 } __packed;
255
256 struct tpm_output_header {
257 __be16 tag;
258 __be32 length;
259 __be32 return_code;
260 } __packed;
261
262 #define TPM_TAG_RQU_COMMAND 193
263
264 struct stclear_flags_t {
265 __be16 tag;
266 u8 deactivated;
267 u8 disableForceClear;
268 u8 physicalPresence;
269 u8 physicalPresenceLock;
270 u8 bGlobalLock;
271 } __packed;
272
273 struct tpm_version_t {
274 u8 Major;
275 u8 Minor;
276 u8 revMajor;
277 u8 revMinor;
278 } __packed;
279
280 struct tpm_version_1_2_t {
281 __be16 tag;
282 u8 Major;
283 u8 Minor;
284 u8 revMajor;
285 u8 revMinor;
286 } __packed;
287
288 struct timeout_t {
289 __be32 a;
290 __be32 b;
291 __be32 c;
292 __be32 d;
293 } __packed;
294
295 struct duration_t {
296 __be32 tpm_short;
297 __be32 tpm_medium;
298 __be32 tpm_long;
299 } __packed;
300
301 struct permanent_flags_t {
302 __be16 tag;
303 u8 disable;
304 u8 ownership;
305 u8 deactivated;
306 u8 readPubek;
307 u8 disableOwnerClear;
308 u8 allowMaintenance;
309 u8 physicalPresenceLifetimeLock;
310 u8 physicalPresenceHWEnable;
311 u8 physicalPresenceCMDEnable;
312 u8 CEKPUsed;
313 u8 TPMpost;
314 u8 TPMpostLock;
315 u8 FIPS;
316 u8 operator;
317 u8 enableRevokeEK;
318 u8 nvLocked;
319 u8 readSRKPub;
320 u8 tpmEstablished;
321 u8 maintenanceDone;
322 u8 disableFullDALogicInfo;
323 } __packed;
324
325 typedef union {
326 struct permanent_flags_t perm_flags;
327 struct stclear_flags_t stclear_flags;
328 __u8 owned;
329 __be32 num_pcrs;
330 struct tpm_version_t tpm_version;
331 struct tpm_version_1_2_t tpm_version_1_2;
332 __be32 manufacturer_id;
333 struct timeout_t timeout;
334 struct duration_t duration;
335 } cap_t;
336
337 enum tpm_capabilities {
338 TPM_CAP_FLAG = 4,
339 TPM_CAP_PROP = 5,
340 TPM_CAP_VERSION_1_1 = 0x06,
341 TPM_CAP_VERSION_1_2 = 0x1A,
342 };
343
344 enum tpm_sub_capabilities {
345 TPM_CAP_PROP_PCR = 0x101,
346 TPM_CAP_PROP_MANUFACTURER = 0x103,
347 TPM_CAP_FLAG_PERM = 0x108,
348 TPM_CAP_FLAG_VOL = 0x109,
349 TPM_CAP_PROP_OWNER = 0x111,
350 TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
351 TPM_CAP_PROP_TIS_DURATION = 0x120,
352 };
353
354 typedef union {
355 struct tpm_input_header in;
356 struct tpm_output_header out;
357 } tpm_cmd_header;
358
359 struct tpm_pcrread_out {
360 u8 pcr_result[TPM_DIGEST_SIZE];
361 } __packed;
362
363 struct tpm_pcrread_in {
364 __be32 pcr_idx;
365 } __packed;
366
367 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
368 * bytes, but 128 is still a relatively large number of random bytes and
369 * anything much bigger causes users of struct tpm_cmd_t to start getting
370 * compiler warnings about stack frame size. */
371 #define TPM_MAX_RNG_DATA 128
372
373 struct tpm_getrandom_out {
374 __be32 rng_data_len;
375 u8 rng_data[TPM_MAX_RNG_DATA];
376 } __packed;
377
378 struct tpm_getrandom_in {
379 __be32 num_bytes;
380 } __packed;
381
382 typedef union {
383 struct tpm_pcrread_in pcrread_in;
384 struct tpm_pcrread_out pcrread_out;
385 struct tpm_getrandom_in getrandom_in;
386 struct tpm_getrandom_out getrandom_out;
387 } tpm_cmd_params;
388
389 struct tpm_cmd_t {
390 tpm_cmd_header header;
391 tpm_cmd_params params;
392 } __packed;
393
394 struct tpm2_digest {
395 u16 alg_id;
396 u8 digest[SHA512_DIGEST_SIZE];
397 } __packed;
398
399 /* A string buffer type for constructing TPM commands. This is based on the
400 * ideas of string buffer code in security/keys/trusted.h but is heap based
401 * in order to keep the stack usage minimal.
402 */
403
404 enum tpm_buf_flags {
405 TPM_BUF_OVERFLOW = BIT(0),
406 };
407
408 struct tpm_buf {
409 struct page *data_page;
410 unsigned int flags;
411 u8 *data;
412 };
413
tpm_buf_init(struct tpm_buf * buf,u16 tag,u32 ordinal)414 static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
415 {
416 struct tpm_input_header *head;
417
418 buf->data_page = alloc_page(GFP_HIGHUSER);
419 if (!buf->data_page)
420 return -ENOMEM;
421
422 buf->flags = 0;
423 buf->data = kmap(buf->data_page);
424
425 head = (struct tpm_input_header *) buf->data;
426
427 head->tag = cpu_to_be16(tag);
428 head->length = cpu_to_be32(sizeof(*head));
429 head->ordinal = cpu_to_be32(ordinal);
430
431 return 0;
432 }
433
tpm_buf_destroy(struct tpm_buf * buf)434 static inline void tpm_buf_destroy(struct tpm_buf *buf)
435 {
436 kunmap(buf->data_page);
437 __free_page(buf->data_page);
438 }
439
tpm_buf_length(struct tpm_buf * buf)440 static inline u32 tpm_buf_length(struct tpm_buf *buf)
441 {
442 struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
443
444 return be32_to_cpu(head->length);
445 }
446
tpm_buf_tag(struct tpm_buf * buf)447 static inline u16 tpm_buf_tag(struct tpm_buf *buf)
448 {
449 struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
450
451 return be16_to_cpu(head->tag);
452 }
453
tpm_buf_append(struct tpm_buf * buf,const unsigned char * new_data,unsigned int new_len)454 static inline void tpm_buf_append(struct tpm_buf *buf,
455 const unsigned char *new_data,
456 unsigned int new_len)
457 {
458 struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
459 u32 len = tpm_buf_length(buf);
460
461 /* Return silently if overflow has already happened. */
462 if (buf->flags & TPM_BUF_OVERFLOW)
463 return;
464
465 if ((len + new_len) > PAGE_SIZE) {
466 WARN(1, "tpm_buf: overflow\n");
467 buf->flags |= TPM_BUF_OVERFLOW;
468 return;
469 }
470
471 memcpy(&buf->data[len], new_data, new_len);
472 head->length = cpu_to_be32(len + new_len);
473 }
474
tpm_buf_append_u8(struct tpm_buf * buf,const u8 value)475 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
476 {
477 tpm_buf_append(buf, &value, 1);
478 }
479
tpm_buf_append_u16(struct tpm_buf * buf,const u16 value)480 static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
481 {
482 __be16 value2 = cpu_to_be16(value);
483
484 tpm_buf_append(buf, (u8 *) &value2, 2);
485 }
486
tpm_buf_append_u32(struct tpm_buf * buf,const u32 value)487 static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
488 {
489 __be32 value2 = cpu_to_be32(value);
490
491 tpm_buf_append(buf, (u8 *) &value2, 4);
492 }
493
494 extern struct class *tpm_class;
495 extern struct class *tpmrm_class;
496 extern dev_t tpm_devt;
497 extern const struct file_operations tpm_fops;
498 extern const struct file_operations tpmrm_fops;
499 extern struct idr dev_nums_idr;
500
501 /**
502 * enum tpm_transmit_flags
503 *
504 * @TPM_TRANSMIT_UNLOCKED: used to lock sequence of tpm_transmit calls.
505 * @TPM_TRANSMIT_RAW: prevent recursive calls into setup steps
506 * (go idle, locality,..). Always use with UNLOCKED
507 * as it will fail on double locking.
508 */
509 enum tpm_transmit_flags {
510 TPM_TRANSMIT_UNLOCKED = BIT(0),
511 TPM_TRANSMIT_RAW = BIT(1),
512 };
513
514 ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
515 u8 *buf, size_t bufsiz, unsigned int flags);
516 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space,
517 const void *buf, size_t bufsiz,
518 size_t min_rsp_body_length, unsigned int flags,
519 const char *desc);
520 int tpm_startup(struct tpm_chip *chip);
521 ssize_t tpm_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
522 const char *desc, size_t min_cap_length);
523 int tpm_get_timeouts(struct tpm_chip *);
524 int tpm1_auto_startup(struct tpm_chip *chip);
525 int tpm_do_selftest(struct tpm_chip *chip);
526 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
527 int tpm_pm_suspend(struct device *dev);
528 int tpm_pm_resume(struct device *dev);
529 int wait_for_tpm_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
530 wait_queue_head_t *queue, bool check_cancel);
531
tpm_msleep(unsigned int delay_msec)532 static inline void tpm_msleep(unsigned int delay_msec)
533 {
534 usleep_range(delay_msec * 1000,
535 (delay_msec * 1000) + TPM_TIMEOUT_RANGE_US);
536 };
537
538 struct tpm_chip *tpm_chip_find_get(int chip_num);
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
tpm_add_ppi(struct tpm_chip * chip)556 static inline void tpm_add_ppi(struct tpm_chip *chip)
557 {
558 }
559 #endif
560
tpm2_rc_value(u32 rc)561 static inline 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 #endif
593