GNU Linux-libre 4.19.207-gnu1
[releases.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_CREATE_PRIMARY  = 0x0131,
139         TPM2_CC_SELF_TEST       = 0x0143,
140         TPM2_CC_STARTUP         = 0x0144,
141         TPM2_CC_SHUTDOWN        = 0x0145,
142         TPM2_CC_CREATE          = 0x0153,
143         TPM2_CC_LOAD            = 0x0157,
144         TPM2_CC_UNSEAL          = 0x015E,
145         TPM2_CC_CONTEXT_LOAD    = 0x0161,
146         TPM2_CC_CONTEXT_SAVE    = 0x0162,
147         TPM2_CC_FLUSH_CONTEXT   = 0x0165,
148         TPM2_CC_GET_CAPABILITY  = 0x017A,
149         TPM2_CC_GET_RANDOM      = 0x017B,
150         TPM2_CC_PCR_READ        = 0x017E,
151         TPM2_CC_PCR_EXTEND      = 0x0182,
152         TPM2_CC_LAST            = 0x018F,
153 };
154
155 enum tpm2_permanent_handles {
156         TPM2_RS_PW              = 0x40000009,
157 };
158
159 enum tpm2_capabilities {
160         TPM2_CAP_HANDLES        = 1,
161         TPM2_CAP_COMMANDS       = 2,
162         TPM2_CAP_PCRS           = 5,
163         TPM2_CAP_TPM_PROPERTIES = 6,
164 };
165
166 enum tpm2_properties {
167         TPM_PT_TOTAL_COMMANDS   = 0x0129,
168 };
169
170 enum tpm2_startup_types {
171         TPM2_SU_CLEAR   = 0x0000,
172         TPM2_SU_STATE   = 0x0001,
173 };
174
175 enum tpm2_cc_attrs {
176         TPM2_CC_ATTR_CHANDLES   = 25,
177         TPM2_CC_ATTR_RHANDLE    = 28,
178 };
179
180 #define TPM_VID_INTEL    0x8086
181 #define TPM_VID_WINBOND  0x1050
182 #define TPM_VID_STM      0x104A
183
184 #define TPM_PPI_VERSION_LEN             3
185
186 struct tpm_space {
187         u32 context_tbl[3];
188         u8 *context_buf;
189         u32 session_tbl[3];
190         u8 *session_buf;
191         u32 buf_size;
192 };
193
194 enum tpm_chip_flags {
195         TPM_CHIP_FLAG_TPM2              = BIT(1),
196         TPM_CHIP_FLAG_IRQ               = BIT(2),
197         TPM_CHIP_FLAG_VIRTUAL           = BIT(3),
198         TPM_CHIP_FLAG_HAVE_TIMEOUTS     = BIT(4),
199         TPM_CHIP_FLAG_ALWAYS_POWERED    = BIT(5),
200 };
201
202 struct tpm_bios_log {
203         void *bios_event_log;
204         void *bios_event_log_end;
205 };
206
207 struct tpm_chip_seqops {
208         struct tpm_chip *chip;
209         const struct seq_operations *seqops;
210 };
211
212 struct tpm_chip {
213         struct device dev;
214         struct device devs;
215         struct cdev cdev;
216         struct cdev cdevs;
217
218         /* A driver callback under ops cannot be run unless ops_sem is held
219          * (sometimes implicitly, eg for the sysfs code). ops becomes null
220          * when the driver is unregistered, see tpm_try_get_ops.
221          */
222         struct rw_semaphore ops_sem;
223         const struct tpm_class_ops *ops;
224
225         struct tpm_bios_log log;
226         struct tpm_chip_seqops bin_log_seqops;
227         struct tpm_chip_seqops ascii_log_seqops;
228
229         unsigned int flags;
230
231         int dev_num;            /* /dev/tpm# */
232         unsigned long is_open;  /* only one allowed */
233
234         char hwrng_name[64];
235         struct hwrng hwrng;
236
237         struct mutex tpm_mutex; /* tpm is processing */
238
239         unsigned long timeout_a; /* jiffies */
240         unsigned long timeout_b; /* jiffies */
241         unsigned long timeout_c; /* jiffies */
242         unsigned long timeout_d; /* jiffies */
243         bool timeout_adjusted;
244         unsigned long duration[TPM_NUM_DURATIONS]; /* jiffies */
245         bool duration_adjusted;
246
247         struct dentry *bios_dir[TPM_NUM_EVENT_LOG_FILES];
248
249         const struct attribute_group *groups[3];
250         unsigned int groups_cnt;
251
252         u16 active_banks[7];
253 #ifdef CONFIG_ACPI
254         acpi_handle acpi_dev_handle;
255         char ppi_version[TPM_PPI_VERSION_LEN + 1];
256 #endif /* CONFIG_ACPI */
257
258         struct tpm_space work_space;
259         u32 nr_commands;
260         u32 *cc_attrs_tbl;
261
262         /* active locality */
263         int locality;
264 };
265
266 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
267
268 struct tpm_input_header {
269         __be16  tag;
270         __be32  length;
271         __be32  ordinal;
272 } __packed;
273
274 struct tpm_output_header {
275         __be16  tag;
276         __be32  length;
277         __be32  return_code;
278 } __packed;
279
280 #define TPM_TAG_RQU_COMMAND 193
281
282 /* TPM2 specific constants. */
283 #define TPM2_SPACE_BUFFER_SIZE          16384 /* 16 kB */
284
285 struct  stclear_flags_t {
286         __be16  tag;
287         u8      deactivated;
288         u8      disableForceClear;
289         u8      physicalPresence;
290         u8      physicalPresenceLock;
291         u8      bGlobalLock;
292 } __packed;
293
294 struct  tpm_version_t {
295         u8      Major;
296         u8      Minor;
297         u8      revMajor;
298         u8      revMinor;
299 } __packed;
300
301 struct  tpm_version_1_2_t {
302         __be16  tag;
303         u8      Major;
304         u8      Minor;
305         u8      revMajor;
306         u8      revMinor;
307 } __packed;
308
309 struct  timeout_t {
310         __be32  a;
311         __be32  b;
312         __be32  c;
313         __be32  d;
314 } __packed;
315
316 struct duration_t {
317         __be32  tpm_short;
318         __be32  tpm_medium;
319         __be32  tpm_long;
320 } __packed;
321
322 struct permanent_flags_t {
323         __be16  tag;
324         u8      disable;
325         u8      ownership;
326         u8      deactivated;
327         u8      readPubek;
328         u8      disableOwnerClear;
329         u8      allowMaintenance;
330         u8      physicalPresenceLifetimeLock;
331         u8      physicalPresenceHWEnable;
332         u8      physicalPresenceCMDEnable;
333         u8      CEKPUsed;
334         u8      TPMpost;
335         u8      TPMpostLock;
336         u8      FIPS;
337         u8      operator;
338         u8      enableRevokeEK;
339         u8      nvLocked;
340         u8      readSRKPub;
341         u8      tpmEstablished;
342         u8      maintenanceDone;
343         u8      disableFullDALogicInfo;
344 } __packed;
345
346 typedef union {
347         struct  permanent_flags_t perm_flags;
348         struct  stclear_flags_t stclear_flags;
349         __u8    owned;
350         __be32  num_pcrs;
351         struct  tpm_version_t   tpm_version;
352         struct  tpm_version_1_2_t tpm_version_1_2;
353         __be32  manufacturer_id;
354         struct timeout_t  timeout;
355         struct duration_t duration;
356 } cap_t;
357
358 enum tpm_capabilities {
359         TPM_CAP_FLAG = 4,
360         TPM_CAP_PROP = 5,
361         TPM_CAP_VERSION_1_1 = 0x06,
362         TPM_CAP_VERSION_1_2 = 0x1A,
363 };
364
365 enum tpm_sub_capabilities {
366         TPM_CAP_PROP_PCR = 0x101,
367         TPM_CAP_PROP_MANUFACTURER = 0x103,
368         TPM_CAP_FLAG_PERM = 0x108,
369         TPM_CAP_FLAG_VOL = 0x109,
370         TPM_CAP_PROP_OWNER = 0x111,
371         TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
372         TPM_CAP_PROP_TIS_DURATION = 0x120,
373 };
374
375 typedef union {
376         struct  tpm_input_header in;
377         struct  tpm_output_header out;
378 } tpm_cmd_header;
379
380 struct tpm_pcrread_out {
381         u8      pcr_result[TPM_DIGEST_SIZE];
382 } __packed;
383
384 struct tpm_pcrread_in {
385         __be32  pcr_idx;
386 } __packed;
387
388 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
389  * bytes, but 128 is still a relatively large number of random bytes and
390  * anything much bigger causes users of struct tpm_cmd_t to start getting
391  * compiler warnings about stack frame size. */
392 #define TPM_MAX_RNG_DATA        128
393
394 struct tpm_getrandom_out {
395         __be32 rng_data_len;
396         u8     rng_data[TPM_MAX_RNG_DATA];
397 } __packed;
398
399 struct tpm_getrandom_in {
400         __be32 num_bytes;
401 } __packed;
402
403 typedef union {
404         struct  tpm_pcrread_in  pcrread_in;
405         struct  tpm_pcrread_out pcrread_out;
406         struct  tpm_getrandom_in getrandom_in;
407         struct  tpm_getrandom_out getrandom_out;
408 } tpm_cmd_params;
409
410 struct tpm_cmd_t {
411         tpm_cmd_header  header;
412         tpm_cmd_params  params;
413 } __packed;
414
415
416 /* A string buffer type for constructing TPM commands. This is based on the
417  * ideas of string buffer code in security/keys/trusted.h but is heap based
418  * in order to keep the stack usage minimal.
419  */
420
421 enum tpm_buf_flags {
422         TPM_BUF_OVERFLOW        = BIT(0),
423 };
424
425 struct tpm_buf {
426         struct page *data_page;
427         unsigned int flags;
428         u8 *data;
429 };
430
431 static inline void tpm_buf_reset(struct tpm_buf *buf, u16 tag, u32 ordinal)
432 {
433         struct tpm_input_header *head;
434         head = (struct tpm_input_header *)buf->data;
435         head->tag = cpu_to_be16(tag);
436         head->length = cpu_to_be32(sizeof(*head));
437         head->ordinal = cpu_to_be32(ordinal);
438 }
439
440 static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
441 {
442         buf->data_page = alloc_page(GFP_HIGHUSER);
443         if (!buf->data_page)
444                 return -ENOMEM;
445
446         buf->flags = 0;
447         buf->data = kmap(buf->data_page);
448         tpm_buf_reset(buf, tag, ordinal);
449         return 0;
450 }
451
452 static inline void tpm_buf_destroy(struct tpm_buf *buf)
453 {
454         kunmap(buf->data_page);
455         __free_page(buf->data_page);
456 }
457
458 static inline u32 tpm_buf_length(struct tpm_buf *buf)
459 {
460         struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
461
462         return be32_to_cpu(head->length);
463 }
464
465 static inline u16 tpm_buf_tag(struct tpm_buf *buf)
466 {
467         struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
468
469         return be16_to_cpu(head->tag);
470 }
471
472 static inline void tpm_buf_append(struct tpm_buf *buf,
473                                   const unsigned char *new_data,
474                                   unsigned int new_len)
475 {
476         struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
477         u32 len = tpm_buf_length(buf);
478
479         /* Return silently if overflow has already happened. */
480         if (buf->flags & TPM_BUF_OVERFLOW)
481                 return;
482
483         if ((len + new_len) > PAGE_SIZE) {
484                 WARN(1, "tpm_buf: overflow\n");
485                 buf->flags |= TPM_BUF_OVERFLOW;
486                 return;
487         }
488
489         memcpy(&buf->data[len], new_data, new_len);
490         head->length = cpu_to_be32(len + new_len);
491 }
492
493 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
494 {
495         tpm_buf_append(buf, &value, 1);
496 }
497
498 static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
499 {
500         __be16 value2 = cpu_to_be16(value);
501
502         tpm_buf_append(buf, (u8 *) &value2, 2);
503 }
504
505 static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
506 {
507         __be32 value2 = cpu_to_be32(value);
508
509         tpm_buf_append(buf, (u8 *) &value2, 4);
510 }
511
512 extern struct class *tpm_class;
513 extern struct class *tpmrm_class;
514 extern dev_t tpm_devt;
515 extern const struct file_operations tpm_fops;
516 extern const struct file_operations tpmrm_fops;
517 extern struct idr dev_nums_idr;
518
519 /**
520  * enum tpm_transmit_flags - flags for tpm_transmit()
521  *
522  * @TPM_TRANSMIT_UNLOCKED:      do not lock the chip
523  * @TPM_TRANSMIT_NESTED:        discard setup steps (power management,
524  *                              locality) including locking (i.e. implicit
525  *                              UNLOCKED)
526  */
527 enum tpm_transmit_flags {
528         TPM_TRANSMIT_UNLOCKED   = BIT(0),
529         TPM_TRANSMIT_NESTED      = BIT(1),
530 };
531
532 ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
533                      u8 *buf, size_t bufsiz, unsigned int flags);
534 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space,
535                          void *buf, size_t bufsiz,
536                          size_t min_rsp_body_length, unsigned int flags,
537                          const char *desc);
538 int tpm_startup(struct tpm_chip *chip);
539 ssize_t tpm_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
540                    const char *desc, size_t min_cap_length);
541 int tpm_get_timeouts(struct tpm_chip *);
542 int tpm1_auto_startup(struct tpm_chip *chip);
543 int tpm_do_selftest(struct tpm_chip *chip);
544 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
545 int tpm_pm_suspend(struct device *dev);
546 int tpm_pm_resume(struct device *dev);
547
548 static inline void tpm_msleep(unsigned int delay_msec)
549 {
550         usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US,
551                      delay_msec * 1000);
552 };
553
554 struct tpm_chip *tpm_find_get_ops(struct tpm_chip *chip);
555 __must_check int tpm_try_get_ops(struct tpm_chip *chip);
556 void tpm_put_ops(struct tpm_chip *chip);
557
558 struct tpm_chip *tpm_chip_alloc(struct device *dev,
559                                 const struct tpm_class_ops *ops);
560 struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
561                                  const struct tpm_class_ops *ops);
562 int tpm_chip_register(struct tpm_chip *chip);
563 void tpm_chip_unregister(struct tpm_chip *chip);
564
565 void tpm_sysfs_add_device(struct tpm_chip *chip);
566
567 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
568
569 #ifdef CONFIG_ACPI
570 extern void tpm_add_ppi(struct tpm_chip *chip);
571 #else
572 static inline void tpm_add_ppi(struct tpm_chip *chip)
573 {
574 }
575 #endif
576
577 static inline u32 tpm2_rc_value(u32 rc)
578 {
579         return (rc & BIT(7)) ? rc & 0xff : rc;
580 }
581
582 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
583 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, u32 count,
584                     struct tpm2_digest *digests);
585 int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max);
586 void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
587                             unsigned int flags);
588 int tpm2_seal_trusted(struct tpm_chip *chip,
589                       struct trusted_key_payload *payload,
590                       struct trusted_key_options *options);
591 int tpm2_unseal_trusted(struct tpm_chip *chip,
592                         struct trusted_key_payload *payload,
593                         struct trusted_key_options *options);
594 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
595                         u32 *value, const char *desc);
596
597 int tpm2_auto_startup(struct tpm_chip *chip);
598 void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
599 unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
600 int tpm2_probe(struct tpm_chip *chip);
601 int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
602 int tpm2_init_space(struct tpm_space *space, unsigned int buf_size);
603 void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space);
604 int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u32 cc,
605                        u8 *cmd);
606 int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space,
607                       u32 cc, u8 *buf, size_t *bufsiz);
608
609 void tpm_bios_log_setup(struct tpm_chip *chip);
610 void tpm_bios_log_teardown(struct tpm_chip *chip);
611 #endif