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