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