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 struct tpm_chip;
 132
 133 struct tpm_vendor_specific {
 134         int locality;
 135         unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
 136         bool timeout_adjusted;
 137         unsigned long duration[3]; /* jiffies */
 138         bool duration_adjusted;
 139         void *priv;
 140
 141         wait_queue_head_t read_queue;
 142 };
 143
 144 #define TPM_VPRIV(c)     ((c)->vendor.priv)
 145
 146 #define TPM_VID_INTEL    0x8086
 147 #define TPM_VID_WINBOND  0x1050
 148 #define TPM_VID_STM      0x104A
 149
 150 #define TPM_PPI_VERSION_LEN             3
 151
 152 enum tpm_chip_flags {
 153         TPM_CHIP_FLAG_REGISTERED        = BIT(0),
 154         TPM_CHIP_FLAG_TPM2              = BIT(1),
 155         TPM_CHIP_FLAG_IRQ               = BIT(2),
 156 };
 157
 158 struct tpm_chip {
 159         struct device dev;
 160         struct cdev cdev;
 161
 162         /* A driver callback under ops cannot be run unless ops_sem is held
 163          * (sometimes implicitly, eg for the sysfs code). ops becomes null
 164          * when the driver is unregistered, see tpm_try_get_ops.
 165          */
 166         struct rw_semaphore ops_sem;
 167         const struct tpm_class_ops *ops;
 168
 169         unsigned int flags;
 170
 171         int dev_num;            /* /dev/tpm# */
 172         unsigned long is_open;  /* only one allowed */
 173
 174         struct mutex tpm_mutex; /* tpm is processing */
 175
 176         struct tpm_vendor_specific vendor;
 177
 178         struct dentry **bios_dir;
 179
 180 #ifdef CONFIG_ACPI
 181         const struct attribute_group *groups[2];
 182         unsigned int groups_cnt;
 183         acpi_handle acpi_dev_handle;
 184         char ppi_version[TPM_PPI_VERSION_LEN + 1];
 185 #endif /* CONFIG_ACPI */
 186 };
 187
 188 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
 189
 190 static inline int tpm_read_index(int base, int index)
 191 {
 192         outb(index, base);
 193         return inb(base+1) & 0xFF;
 194 }
 195
 196 static inline void tpm_write_index(int base, int index, int value)
 197 {
 198         outb(index, base);
 199         outb(value & 0xFF, base+1);
 200 }
 201 struct tpm_input_header {
 202         __be16  tag;
 203         __be32  length;
 204         __be32  ordinal;
 205 } __packed;
 206
 207 struct tpm_output_header {
 208         __be16  tag;
 209         __be32  length;
 210         __be32  return_code;
 211 } __packed;
 212
 213 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
 214
 215 struct  stclear_flags_t {
 216         __be16  tag;
 217         u8      deactivated;
 218         u8      disableForceClear;
 219         u8      physicalPresence;
 220         u8      physicalPresenceLock;
 221         u8      bGlobalLock;
 222 } __packed;
 223
 224 struct  tpm_version_t {
 225         u8      Major;
 226         u8      Minor;
 227         u8      revMajor;
 228         u8      revMinor;
 229 } __packed;
 230
 231 struct  tpm_version_1_2_t {
 232         __be16  tag;
 233         u8      Major;
 234         u8      Minor;
 235         u8      revMajor;
 236         u8      revMinor;
 237 } __packed;
 238
 239 struct  timeout_t {
 240         __be32  a;
 241         __be32  b;
 242         __be32  c;
 243         __be32  d;
 244 } __packed;
 245
 246 struct duration_t {
 247         __be32  tpm_short;
 248         __be32  tpm_medium;
 249         __be32  tpm_long;
 250 } __packed;
 251
 252 struct permanent_flags_t {
 253         __be16  tag;
 254         u8      disable;
 255         u8      ownership;
 256         u8      deactivated;
 257         u8      readPubek;
 258         u8      disableOwnerClear;
 259         u8      allowMaintenance;
 260         u8      physicalPresenceLifetimeLock;
 261         u8      physicalPresenceHWEnable;
 262         u8      physicalPresenceCMDEnable;
 263         u8      CEKPUsed;
 264         u8      TPMpost;
 265         u8      TPMpostLock;
 266         u8      FIPS;
 267         u8      operator;
 268         u8      enableRevokeEK;
 269         u8      nvLocked;
 270         u8      readSRKPub;
 271         u8      tpmEstablished;
 272         u8      maintenanceDone;
 273         u8      disableFullDALogicInfo;
 274 } __packed;
 275
 276 typedef union {
 277         struct  permanent_flags_t perm_flags;
 278         struct  stclear_flags_t stclear_flags;
 279         bool    owned;
 280         __be32  num_pcrs;
 281         struct  tpm_version_t   tpm_version;
 282         struct  tpm_version_1_2_t tpm_version_1_2;
 283         __be32  manufacturer_id;
 284         struct timeout_t  timeout;
 285         struct duration_t duration;
 286 } cap_t;
 287
 288 enum tpm_capabilities {
 289         TPM_CAP_FLAG = cpu_to_be32(4),
 290         TPM_CAP_PROP = cpu_to_be32(5),
 291         CAP_VERSION_1_1 = cpu_to_be32(0x06),
 292         CAP_VERSION_1_2 = cpu_to_be32(0x1A)
 293 };
 294
 295 enum tpm_sub_capabilities {
 296         TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
 297         TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
 298         TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
 299         TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
 300         TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
 301         TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
 302         TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
 303
 304 };
 305
 306 struct  tpm_getcap_params_in {
 307         __be32  cap;
 308         __be32  subcap_size;
 309         __be32  subcap;
 310 } __packed;
 311
 312 struct  tpm_getcap_params_out {
 313         __be32  cap_size;
 314         cap_t   cap;
 315 } __packed;
 316
 317 struct  tpm_readpubek_params_out {
 318         u8      algorithm[4];
 319         u8      encscheme[2];
 320         u8      sigscheme[2];
 321         __be32  paramsize;
 322         u8      parameters[12]; /*assuming RSA*/
 323         __be32  keysize;
 324         u8      modulus[256];
 325         u8      checksum[20];
 326 } __packed;
 327
 328 typedef union {
 329         struct  tpm_input_header in;
 330         struct  tpm_output_header out;
 331 } tpm_cmd_header;
 332
 333 struct tpm_pcrread_out {
 334         u8      pcr_result[TPM_DIGEST_SIZE];
 335 } __packed;
 336
 337 struct tpm_pcrread_in {
 338         __be32  pcr_idx;
 339 } __packed;
 340
 341 struct tpm_pcrextend_in {
 342         __be32  pcr_idx;
 343         u8      hash[TPM_DIGEST_SIZE];
 344 } __packed;
 345
 346 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
 347  * bytes, but 128 is still a relatively large number of random bytes and
 348  * anything much bigger causes users of struct tpm_cmd_t to start getting
 349  * compiler warnings about stack frame size. */
 350 #define TPM_MAX_RNG_DATA        128
 351
 352 struct tpm_getrandom_out {
 353         __be32 rng_data_len;
 354         u8     rng_data[TPM_MAX_RNG_DATA];
 355 } __packed;
 356
 357 struct tpm_getrandom_in {
 358         __be32 num_bytes;
 359 } __packed;
 360
 361 struct tpm_startup_in {
 362         __be16  startup_type;
 363 } __packed;
 364
 365 typedef union {
 366         struct  tpm_getcap_params_out getcap_out;
 367         struct  tpm_readpubek_params_out readpubek_out;
 368         u8      readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
 369         struct  tpm_getcap_params_in getcap_in;
 370         struct  tpm_pcrread_in  pcrread_in;
 371         struct  tpm_pcrread_out pcrread_out;
 372         struct  tpm_pcrextend_in pcrextend_in;
 373         struct  tpm_getrandom_in getrandom_in;
 374         struct  tpm_getrandom_out getrandom_out;
 375         struct tpm_startup_in startup_in;
 376 } tpm_cmd_params;
 377
 378 struct tpm_cmd_t {
 379         tpm_cmd_header  header;
 380         tpm_cmd_params  params;
 381 } __packed;
 382
 383 /* A string buffer type for constructing TPM commands. This is based on the
 384  * ideas of string buffer code in security/keys/trusted.h but is heap based
 385  * in order to keep the stack usage minimal.
 386  */
 387
 388 enum tpm_buf_flags {
 389         TPM_BUF_OVERFLOW        = BIT(0),
 390 };
 391
 392 struct tpm_buf {
 393         struct page *data_page;
 394         unsigned int flags;
 395         u8 *data;
 396 };
 397
 398 static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
 399 {
 400         struct tpm_input_header *head;
 401
 402         buf->data_page = alloc_page(GFP_HIGHUSER);
 403         if (!buf->data_page)
 404                 return -ENOMEM;
 405
 406         buf->flags = 0;
 407         buf->data = kmap(buf->data_page);
 408
 409         head = (struct tpm_input_header *) buf->data;
 410
 411         head->tag = cpu_to_be16(tag);
 412         head->length = cpu_to_be32(sizeof(*head));
 413         head->ordinal = cpu_to_be32(ordinal);
 414
 415         return 0;
 416 }
 417
 418 static inline void tpm_buf_destroy(struct tpm_buf *buf)
 419 {
 420         kunmap(buf->data_page);
 421         __free_page(buf->data_page);
 422 }
 423
 424 static inline u32 tpm_buf_length(struct tpm_buf *buf)
 425 {
 426         struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
 427
 428         return be32_to_cpu(head->length);
 429 }
 430
 431 static inline u16 tpm_buf_tag(struct tpm_buf *buf)
 432 {
 433         struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
 434
 435         return be16_to_cpu(head->tag);
 436 }
 437
 438 static inline void tpm_buf_append(struct tpm_buf *buf,
 439                                   const unsigned char *new_data,
 440                                   unsigned int new_len)
 441 {
 442         struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
 443         u32 len = tpm_buf_length(buf);
 444
 445         /* Return silently if overflow has already happened. */
 446         if (buf->flags & TPM_BUF_OVERFLOW)
 447                 return;
 448
 449         if ((len + new_len) > PAGE_SIZE) {
 450                 WARN(1, "tpm_buf: overflow\n");
 451                 buf->flags |= TPM_BUF_OVERFLOW;
 452                 return;
 453         }
 454
 455         memcpy(&buf->data[len], new_data, new_len);
 456         head->length = cpu_to_be32(len + new_len);
 457 }
 458
 459 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
 460 {
 461         tpm_buf_append(buf, &value, 1);
 462 }
 463
 464 static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
 465 {
 466         __be16 value2 = cpu_to_be16(value);
 467
 468         tpm_buf_append(buf, (u8 *) &value2, 2);
 469 }
 470
 471 static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
 472 {
 473         __be32 value2 = cpu_to_be32(value);
 474
 475         tpm_buf_append(buf, (u8 *) &value2, 4);
 476 }
 477
 478 extern struct class *tpm_class;
 479 extern dev_t tpm_devt;
 480 extern const struct file_operations tpm_fops;
 481 extern struct idr dev_nums_idr;
 482
 483 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
 484 ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
 485                      size_t bufsiz);
 486 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd, int len,
 487                          const char *desc);
 488 extern int tpm_get_timeouts(struct tpm_chip *);
 489 extern void tpm_gen_interrupt(struct tpm_chip *);
 490 extern int tpm_do_selftest(struct tpm_chip *);
 491 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
 492 extern int tpm_pm_suspend(struct device *);
 493 extern int tpm_pm_resume(struct device *);
 494 extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
 495                              wait_queue_head_t *, bool);
 496
 497 struct tpm_chip *tpm_chip_find_get(int chip_num);
 498 __must_check int tpm_try_get_ops(struct tpm_chip *chip);
 499 void tpm_put_ops(struct tpm_chip *chip);
 500
 501 extern struct tpm_chip *tpm_chip_alloc(struct device *dev,
 502                                        const struct tpm_class_ops *ops);
 503 extern struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
 504                                        const struct tpm_class_ops *ops);
 505 extern int tpm_chip_register(struct tpm_chip *chip);
 506 extern void tpm_chip_unregister(struct tpm_chip *chip);
 507
 508 int tpm_sysfs_add_device(struct tpm_chip *chip);
 509 void tpm_sysfs_del_device(struct tpm_chip *chip);
 510
 511 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
 512
 513 #ifdef CONFIG_ACPI
 514 extern void tpm_add_ppi(struct tpm_chip *chip);
 515 #else
 516 static inline void tpm_add_ppi(struct tpm_chip *chip)
 517 {
 518 }
 519 #endif
 520
 521 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
 522 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash);
 523 int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max);
 524 int tpm2_seal_trusted(struct tpm_chip *chip,
 525                       struct trusted_key_payload *payload,
 526                       struct trusted_key_options *options);
 527 int tpm2_unseal_trusted(struct tpm_chip *chip,
 528                         struct trusted_key_payload *payload,
 529                         struct trusted_key_options *options);
 530 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
 531                         u32 *value, const char *desc);
 532
 533 extern int tpm2_startup(struct tpm_chip *chip, u16 startup_type);
 534 extern void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
 535 extern unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *, u32);
 536 extern int tpm2_do_selftest(struct tpm_chip *chip);
 537 extern int tpm2_gen_interrupt(struct tpm_chip *chip);
 538 extern int tpm2_probe(struct tpm_chip *chip);