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