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