]> asedeno.scripts.mit.edu Git - linux.git/blob - drivers/char/tpm/tpm.h
1454ef19d2f49244b67013620709f1652f39e0f2
[linux.git] / drivers / char / tpm / tpm.h
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         TPM_TIMEOUT_POLL = 1,   /* msecs */
58         TPM_TIMEOUT_USECS_MIN = 100,      /* usecs */
59         TPM_TIMEOUT_USECS_MAX = 500      /* usecs */
60 };
61
62 /* TPM addresses */
63 enum tpm_addr {
64         TPM_SUPERIO_ADDR = 0x2E,
65         TPM_ADDR = 0x4E,
66 };
67
68 /* Indexes the duration array */
69 enum tpm_duration {
70         TPM_SHORT = 0,
71         TPM_MEDIUM = 1,
72         TPM_LONG = 2,
73         TPM_LONG_LONG = 3,
74         TPM_UNDEFINED,
75         TPM_NUM_DURATIONS = TPM_UNDEFINED,
76 };
77
78 #define TPM_WARN_RETRY          0x800
79 #define TPM_WARN_DOING_SELFTEST 0x802
80 #define TPM_ERR_DEACTIVATED     0x6
81 #define TPM_ERR_DISABLED        0x7
82 #define TPM_ERR_INVALID_POSTINIT 38
83
84 #define TPM_HEADER_SIZE         10
85
86 enum tpm2_const {
87         TPM2_PLATFORM_PCR       =     24,
88         TPM2_PCR_SELECT_MIN     = ((TPM2_PLATFORM_PCR + 7) / 8),
89 };
90
91 enum tpm2_timeouts {
92         TPM2_TIMEOUT_A          =    750,
93         TPM2_TIMEOUT_B          =   2000,
94         TPM2_TIMEOUT_C          =    200,
95         TPM2_TIMEOUT_D          =     30,
96         TPM2_DURATION_SHORT     =     20,
97         TPM2_DURATION_MEDIUM    =    750,
98         TPM2_DURATION_LONG      =   2000,
99         TPM2_DURATION_LONG_LONG = 300000,
100         TPM2_DURATION_DEFAULT   = 120000,
101 };
102
103 enum tpm2_structures {
104         TPM2_ST_NO_SESSIONS     = 0x8001,
105         TPM2_ST_SESSIONS        = 0x8002,
106 };
107
108 /* Indicates from what layer of the software stack the error comes from */
109 #define TSS2_RC_LAYER_SHIFT      16
110 #define TSS2_RESMGR_TPM_RC_LAYER (11 << TSS2_RC_LAYER_SHIFT)
111
112 enum tpm2_return_codes {
113         TPM2_RC_SUCCESS         = 0x0000,
114         TPM2_RC_HASH            = 0x0083, /* RC_FMT1 */
115         TPM2_RC_HANDLE          = 0x008B,
116         TPM2_RC_INITIALIZE      = 0x0100, /* RC_VER1 */
117         TPM2_RC_FAILURE         = 0x0101,
118         TPM2_RC_DISABLED        = 0x0120,
119         TPM2_RC_COMMAND_CODE    = 0x0143,
120         TPM2_RC_TESTING         = 0x090A, /* RC_WARN */
121         TPM2_RC_REFERENCE_H0    = 0x0910,
122         TPM2_RC_RETRY           = 0x0922,
123 };
124
125 enum tpm2_algorithms {
126         TPM2_ALG_ERROR          = 0x0000,
127         TPM2_ALG_SHA1           = 0x0004,
128         TPM2_ALG_KEYEDHASH      = 0x0008,
129         TPM2_ALG_SHA256         = 0x000B,
130         TPM2_ALG_SHA384         = 0x000C,
131         TPM2_ALG_SHA512         = 0x000D,
132         TPM2_ALG_NULL           = 0x0010,
133         TPM2_ALG_SM3_256        = 0x0012,
134 };
135
136 enum tpm2_command_codes {
137         TPM2_CC_FIRST                   = 0x011F,
138         TPM2_CC_HIERARCHY_CONTROL       = 0x0121,
139         TPM2_CC_HIERARCHY_CHANGE_AUTH   = 0x0129,
140         TPM2_CC_CREATE_PRIMARY          = 0x0131,
141         TPM2_CC_SEQUENCE_COMPLETE       = 0x013E,
142         TPM2_CC_SELF_TEST               = 0x0143,
143         TPM2_CC_STARTUP                 = 0x0144,
144         TPM2_CC_SHUTDOWN                = 0x0145,
145         TPM2_CC_NV_READ                 = 0x014E,
146         TPM2_CC_CREATE                  = 0x0153,
147         TPM2_CC_LOAD                    = 0x0157,
148         TPM2_CC_SEQUENCE_UPDATE         = 0x015C,
149         TPM2_CC_UNSEAL                  = 0x015E,
150         TPM2_CC_CONTEXT_LOAD            = 0x0161,
151         TPM2_CC_CONTEXT_SAVE            = 0x0162,
152         TPM2_CC_FLUSH_CONTEXT           = 0x0165,
153         TPM2_CC_VERIFY_SIGNATURE        = 0x0177,
154         TPM2_CC_GET_CAPABILITY          = 0x017A,
155         TPM2_CC_GET_RANDOM              = 0x017B,
156         TPM2_CC_PCR_READ                = 0x017E,
157         TPM2_CC_PCR_EXTEND              = 0x0182,
158         TPM2_CC_EVENT_SEQUENCE_COMPLETE = 0x0185,
159         TPM2_CC_HASH_SEQUENCE_START     = 0x0186,
160         TPM2_CC_CREATE_LOADED           = 0x0191,
161         TPM2_CC_LAST                    = 0x0193, /* Spec 1.36 */
162 };
163
164 enum tpm2_permanent_handles {
165         TPM2_RS_PW              = 0x40000009,
166 };
167
168 enum tpm2_capabilities {
169         TPM2_CAP_HANDLES        = 1,
170         TPM2_CAP_COMMANDS       = 2,
171         TPM2_CAP_PCRS           = 5,
172         TPM2_CAP_TPM_PROPERTIES = 6,
173 };
174
175 enum tpm2_properties {
176         TPM_PT_TOTAL_COMMANDS   = 0x0129,
177 };
178
179 enum tpm2_startup_types {
180         TPM2_SU_CLEAR   = 0x0000,
181         TPM2_SU_STATE   = 0x0001,
182 };
183
184 enum tpm2_cc_attrs {
185         TPM2_CC_ATTR_CHANDLES   = 25,
186         TPM2_CC_ATTR_RHANDLE    = 28,
187 };
188
189 #define TPM_VID_INTEL    0x8086
190 #define TPM_VID_WINBOND  0x1050
191 #define TPM_VID_STM      0x104A
192
193 #define TPM_PPI_VERSION_LEN             3
194
195 struct tpm_space {
196         u32 context_tbl[3];
197         u8 *context_buf;
198         u32 session_tbl[3];
199         u8 *session_buf;
200 };
201
202 enum tpm_chip_flags {
203         TPM_CHIP_FLAG_TPM2              = BIT(1),
204         TPM_CHIP_FLAG_IRQ               = BIT(2),
205         TPM_CHIP_FLAG_VIRTUAL           = BIT(3),
206         TPM_CHIP_FLAG_HAVE_TIMEOUTS     = BIT(4),
207         TPM_CHIP_FLAG_ALWAYS_POWERED    = BIT(5),
208 };
209
210 struct tpm_bios_log {
211         void *bios_event_log;
212         void *bios_event_log_end;
213 };
214
215 struct tpm_chip_seqops {
216         struct tpm_chip *chip;
217         const struct seq_operations *seqops;
218 };
219
220 struct tpm_chip {
221         struct device dev;
222         struct device devs;
223         struct cdev cdev;
224         struct cdev cdevs;
225
226         /* A driver callback under ops cannot be run unless ops_sem is held
227          * (sometimes implicitly, eg for the sysfs code). ops becomes null
228          * when the driver is unregistered, see tpm_try_get_ops.
229          */
230         struct rw_semaphore ops_sem;
231         const struct tpm_class_ops *ops;
232
233         struct tpm_bios_log log;
234         struct tpm_chip_seqops bin_log_seqops;
235         struct tpm_chip_seqops ascii_log_seqops;
236
237         unsigned int flags;
238
239         int dev_num;            /* /dev/tpm# */
240         unsigned long is_open;  /* only one allowed */
241
242         char hwrng_name[64];
243         struct hwrng hwrng;
244
245         struct mutex tpm_mutex; /* tpm is processing */
246
247         unsigned long timeout_a; /* jiffies */
248         unsigned long timeout_b; /* jiffies */
249         unsigned long timeout_c; /* jiffies */
250         unsigned long timeout_d; /* jiffies */
251         bool timeout_adjusted;
252         unsigned long duration[TPM_NUM_DURATIONS]; /* jiffies */
253         bool duration_adjusted;
254
255         struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];
256
257         const struct attribute_group *groups[3];
258         unsigned int groups_cnt;
259
260         u16 active_banks[7];
261 #ifdef CONFIG_ACPI
262         acpi_handle acpi_dev_handle;
263         char ppi_version[TPM_PPI_VERSION_LEN + 1];
264 #endif /* CONFIG_ACPI */
265
266         struct tpm_space work_space;
267         u32 nr_commands;
268         u32 *cc_attrs_tbl;
269
270         /* active locality */
271         int locality;
272 };
273
274 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
275
276 struct tpm_header {
277         __be16 tag;
278         __be32 length;
279         union {
280                 __be32 ordinal;
281                 __be32 return_code;
282         };
283 } __packed;
284
285 #define TPM_TAG_RQU_COMMAND 193
286
287 struct  stclear_flags_t {
288         __be16  tag;
289         u8      deactivated;
290         u8      disableForceClear;
291         u8      physicalPresence;
292         u8      physicalPresenceLock;
293         u8      bGlobalLock;
294 } __packed;
295
296 struct  tpm_version_t {
297         u8      Major;
298         u8      Minor;
299         u8      revMajor;
300         u8      revMinor;
301 } __packed;
302
303 struct  tpm_version_1_2_t {
304         __be16  tag;
305         u8      Major;
306         u8      Minor;
307         u8      revMajor;
308         u8      revMinor;
309 } __packed;
310
311 struct  timeout_t {
312         __be32  a;
313         __be32  b;
314         __be32  c;
315         __be32  d;
316 } __packed;
317
318 struct duration_t {
319         __be32  tpm_short;
320         __be32  tpm_medium;
321         __be32  tpm_long;
322 } __packed;
323
324 struct permanent_flags_t {
325         __be16  tag;
326         u8      disable;
327         u8      ownership;
328         u8      deactivated;
329         u8      readPubek;
330         u8      disableOwnerClear;
331         u8      allowMaintenance;
332         u8      physicalPresenceLifetimeLock;
333         u8      physicalPresenceHWEnable;
334         u8      physicalPresenceCMDEnable;
335         u8      CEKPUsed;
336         u8      TPMpost;
337         u8      TPMpostLock;
338         u8      FIPS;
339         u8      operator;
340         u8      enableRevokeEK;
341         u8      nvLocked;
342         u8      readSRKPub;
343         u8      tpmEstablished;
344         u8      maintenanceDone;
345         u8      disableFullDALogicInfo;
346 } __packed;
347
348 typedef union {
349         struct  permanent_flags_t perm_flags;
350         struct  stclear_flags_t stclear_flags;
351         __u8    owned;
352         __be32  num_pcrs;
353         struct  tpm_version_t   tpm_version;
354         struct  tpm_version_1_2_t tpm_version_1_2;
355         __be32  manufacturer_id;
356         struct timeout_t  timeout;
357         struct duration_t duration;
358 } cap_t;
359
360 enum tpm_capabilities {
361         TPM_CAP_FLAG = 4,
362         TPM_CAP_PROP = 5,
363         TPM_CAP_VERSION_1_1 = 0x06,
364         TPM_CAP_VERSION_1_2 = 0x1A,
365 };
366
367 enum tpm_sub_capabilities {
368         TPM_CAP_PROP_PCR = 0x101,
369         TPM_CAP_PROP_MANUFACTURER = 0x103,
370         TPM_CAP_FLAG_PERM = 0x108,
371         TPM_CAP_FLAG_VOL = 0x109,
372         TPM_CAP_PROP_OWNER = 0x111,
373         TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
374         TPM_CAP_PROP_TIS_DURATION = 0x120,
375 };
376
377
378 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
379  * bytes, but 128 is still a relatively large number of random bytes and
380  * anything much bigger causes users of struct tpm_cmd_t to start getting
381  * compiler warnings about stack frame size. */
382 #define TPM_MAX_RNG_DATA        128
383
384 /* A string buffer type for constructing TPM commands. This is based on the
385  * ideas of string buffer code in security/keys/trusted.h but is heap based
386  * in order to keep the stack usage minimal.
387  */
388
389 enum tpm_buf_flags {
390         TPM_BUF_OVERFLOW        = BIT(0),
391 };
392
393 struct tpm_buf {
394         struct page *data_page;
395         unsigned int flags;
396         u8 *data;
397 };
398
399 static inline void tpm_buf_reset(struct tpm_buf *buf, u16 tag, u32 ordinal)
400 {
401         struct tpm_header *head = (struct tpm_header *)buf->data;
402
403         head->tag = cpu_to_be16(tag);
404         head->length = cpu_to_be32(sizeof(*head));
405         head->ordinal = cpu_to_be32(ordinal);
406 }
407
408 static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
409 {
410         buf->data_page = alloc_page(GFP_HIGHUSER);
411         if (!buf->data_page)
412                 return -ENOMEM;
413
414         buf->flags = 0;
415         buf->data = kmap(buf->data_page);
416         tpm_buf_reset(buf, tag, ordinal);
417         return 0;
418 }
419
420 static inline void tpm_buf_destroy(struct tpm_buf *buf)
421 {
422         kunmap(buf->data_page);
423         __free_page(buf->data_page);
424 }
425
426 static inline u32 tpm_buf_length(struct tpm_buf *buf)
427 {
428         struct tpm_header *head = (struct tpm_header *)buf->data;
429
430         return be32_to_cpu(head->length);
431 }
432
433 static inline u16 tpm_buf_tag(struct tpm_buf *buf)
434 {
435         struct tpm_header *head = (struct tpm_header *)buf->data;
436
437         return be16_to_cpu(head->tag);
438 }
439
440 static inline void tpm_buf_append(struct tpm_buf *buf,
441                                   const unsigned char *new_data,
442                                   unsigned int new_len)
443 {
444         struct tpm_header *head = (struct tpm_header *)buf->data;
445         u32 len = tpm_buf_length(buf);
446
447         /* Return silently if overflow has already happened. */
448         if (buf->flags & TPM_BUF_OVERFLOW)
449                 return;
450
451         if ((len + new_len) > PAGE_SIZE) {
452                 WARN(1, "tpm_buf: overflow\n");
453                 buf->flags |= TPM_BUF_OVERFLOW;
454                 return;
455         }
456
457         memcpy(&buf->data[len], new_data, new_len);
458         head->length = cpu_to_be32(len + new_len);
459 }
460
461 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
462 {
463         tpm_buf_append(buf, &value, 1);
464 }
465
466 static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
467 {
468         __be16 value2 = cpu_to_be16(value);
469
470         tpm_buf_append(buf, (u8 *) &value2, 2);
471 }
472
473 static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
474 {
475         __be32 value2 = cpu_to_be32(value);
476
477         tpm_buf_append(buf, (u8 *) &value2, 4);
478 }
479
480 extern struct class *tpm_class;
481 extern struct class *tpmrm_class;
482 extern dev_t tpm_devt;
483 extern const struct file_operations tpm_fops;
484 extern const struct file_operations tpmrm_fops;
485 extern struct idr dev_nums_idr;
486
487 /**
488  * enum tpm_transmit_flags - flags for tpm_transmit()
489  *
490  * @TPM_TRANSMIT_UNLOCKED:      do not lock the chip
491  * @TPM_TRANSMIT_NESTED:        discard setup steps (power management,
492  *                              locality) including locking (i.e. implicit
493  *                              UNLOCKED)
494  */
495 enum tpm_transmit_flags {
496         TPM_TRANSMIT_UNLOCKED   = BIT(0),
497         TPM_TRANSMIT_NESTED      = BIT(1),
498 };
499
500 ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
501                      u8 *buf, size_t bufsiz, unsigned int flags);
502 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space,
503                          struct tpm_buf *buf, size_t min_rsp_body_length,
504                          unsigned int flags, const char *desc);
505 int tpm_get_timeouts(struct tpm_chip *);
506 int tpm_auto_startup(struct tpm_chip *chip);
507
508 int tpm1_pm_suspend(struct tpm_chip *chip, u32 tpm_suspend_pcr);
509 int tpm1_auto_startup(struct tpm_chip *chip);
510 int tpm1_do_selftest(struct tpm_chip *chip);
511 int tpm1_get_timeouts(struct tpm_chip *chip);
512 unsigned long tpm1_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
513 int tpm1_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, const u8 *hash,
514                     const char *log_msg);
515 int tpm1_pcr_read(struct tpm_chip *chip, u32 pcr_idx, u8 *res_buf);
516 ssize_t tpm1_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
517                     const char *desc, size_t min_cap_length);
518 int tpm1_get_random(struct tpm_chip *chip, u8 *out, size_t max);
519 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
520 int tpm_pm_suspend(struct device *dev);
521 int tpm_pm_resume(struct device *dev);
522
523 static inline void tpm_msleep(unsigned int delay_msec)
524 {
525         usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US,
526                      delay_msec * 1000);
527 };
528
529 struct tpm_chip *tpm_find_get_ops(struct tpm_chip *chip);
530 __must_check int tpm_try_get_ops(struct tpm_chip *chip);
531 void tpm_put_ops(struct tpm_chip *chip);
532
533 struct tpm_chip *tpm_chip_alloc(struct device *dev,
534                                 const struct tpm_class_ops *ops);
535 struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
536                                  const struct tpm_class_ops *ops);
537 int tpm_chip_register(struct tpm_chip *chip);
538 void tpm_chip_unregister(struct tpm_chip *chip);
539
540 void tpm_sysfs_add_device(struct tpm_chip *chip);
541
542
543 #ifdef CONFIG_ACPI
544 extern void tpm_add_ppi(struct tpm_chip *chip);
545 #else
546 static inline void tpm_add_ppi(struct tpm_chip *chip)
547 {
548 }
549 #endif
550
551 static inline u32 tpm2_rc_value(u32 rc)
552 {
553         return (rc & BIT(7)) ? rc & 0xff : rc;
554 }
555
556 int tpm2_get_timeouts(struct tpm_chip *chip);
557 int tpm2_pcr_read(struct tpm_chip *chip, u32 pcr_idx, u8 *res_buf);
558 int tpm2_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, u32 count,
559                     struct tpm2_digest *digests);
560 int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max);
561 void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
562                             unsigned int flags);
563 int tpm2_seal_trusted(struct tpm_chip *chip,
564                       struct trusted_key_payload *payload,
565                       struct trusted_key_options *options);
566 int tpm2_unseal_trusted(struct tpm_chip *chip,
567                         struct trusted_key_payload *payload,
568                         struct trusted_key_options *options);
569 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
570                         u32 *value, const char *desc);
571
572 int tpm2_auto_startup(struct tpm_chip *chip);
573 void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
574 unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
575 int tpm2_probe(struct tpm_chip *chip);
576 int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
577 int tpm2_init_space(struct tpm_space *space);
578 void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space);
579 int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u32 cc,
580                        u8 *cmd);
581 int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space,
582                       u32 cc, void *buf, size_t *bufsiz);
583
584 int tpm_bios_log_setup(struct tpm_chip *chip);
585 void tpm_bios_log_teardown(struct tpm_chip *chip);
586 int tpm_dev_common_init(void);
587 void tpm_dev_common_exit(void);
588 #endif