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