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