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_INITIALIZE      = 0x0100,
  87         TPM2_RC_TESTING         = 0x090A,
  88         TPM2_RC_DISABLED        = 0x0120,
  89 };
  90
  91 enum tpm2_algorithms {
  92         TPM2_ALG_SHA1           = 0x0004,
  93         TPM2_ALG_KEYEDHASH      = 0x0008,
  94         TPM2_ALG_SHA256         = 0x000B,
  95         TPM2_ALG_NULL           = 0x0010
  96 };
  97
  98 enum tpm2_command_codes {
  99         TPM2_CC_FIRST           = 0x011F,
 100         TPM2_CC_SELF_TEST       = 0x0143,
 101         TPM2_CC_STARTUP         = 0x0144,
 102         TPM2_CC_SHUTDOWN        = 0x0145,
 103         TPM2_CC_CREATE          = 0x0153,
 104         TPM2_CC_LOAD            = 0x0157,
 105         TPM2_CC_UNSEAL          = 0x015E,
 106         TPM2_CC_FLUSH_CONTEXT   = 0x0165,
 107         TPM2_CC_GET_CAPABILITY  = 0x017A,
 108         TPM2_CC_GET_RANDOM      = 0x017B,
 109         TPM2_CC_PCR_READ        = 0x017E,
 110         TPM2_CC_PCR_EXTEND      = 0x0182,
 111         TPM2_CC_LAST            = 0x018F,
 112 };
 113
 114 enum tpm2_permanent_handles {
 115         TPM2_RS_PW              = 0x40000009,
 116 };
 117
 118 enum tpm2_capabilities {
 119         TPM2_CAP_TPM_PROPERTIES = 6,
 120 };
 121
 122 enum tpm2_startup_types {
 123         TPM2_SU_CLEAR   = 0x0000,
 124         TPM2_SU_STATE   = 0x0001,
 125 };
 126
 127 enum tpm2_start_method {
 128         TPM2_START_ACPI = 2,
 129         TPM2_START_FIFO = 6,
 130         TPM2_START_CRB = 7,
 131         TPM2_START_CRB_WITH_ACPI = 8,
 132 };
 133
 134 struct tpm_chip;
 135
 136 struct tpm_vendor_specific {
 137         void __iomem *iobase;           /* ioremapped address */
 138         unsigned long base;             /* TPM base address */
 139
 140         int irq;
 141         int probed_irq;
 142
 143         int region_size;
 144         int have_region;
 145
 146         struct list_head list;
 147         int locality;
 148         unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
 149         bool timeout_adjusted;
 150         unsigned long duration[3]; /* jiffies */
 151         bool duration_adjusted;
 152         void *priv;
 153
 154         wait_queue_head_t read_queue;
 155         wait_queue_head_t int_queue;
 156
 157         u16 manufacturer_id;
 158 };
 159
 160 #define TPM_VPRIV(c)     ((c)->vendor.priv)
 161
 162 #define TPM_VID_INTEL    0x8086
 163 #define TPM_VID_WINBOND  0x1050
 164 #define TPM_VID_STM      0x104A
 165
 166 #define TPM_PPI_VERSION_LEN             3
 167
 168 enum tpm_chip_flags {
 169         TPM_CHIP_FLAG_REGISTERED        = BIT(0),
 170         TPM_CHIP_FLAG_TPM2              = BIT(1),
 171         TPM_CHIP_FLAG_ALWAYS_POWERED    = BIT(5),
 172 };
 173
 174 struct tpm_chip {
 175         struct device dev;
 176         struct cdev cdev;
 177
 178         /* A driver callback under ops cannot be run unless ops_sem is held
 179          * (sometimes implicitly, eg for the sysfs code). ops becomes null
 180          * when the driver is unregistered, see tpm_try_get_ops.
 181          */
 182         struct rw_semaphore ops_sem;
 183         const struct tpm_class_ops *ops;
 184
 185         unsigned int flags;
 186
 187         int dev_num;            /* /dev/tpm# */
 188         char devname[7];
 189         unsigned long is_open;  /* only one allowed */
 190         int time_expired;
 191
 192         struct mutex tpm_mutex; /* tpm is processing */
 193
 194         struct tpm_vendor_specific vendor;
 195
 196         struct dentry **bios_dir;
 197
 198 #ifdef CONFIG_ACPI
 199         const struct attribute_group *groups[2];
 200         unsigned int groups_cnt;
 201         acpi_handle acpi_dev_handle;
 202         char ppi_version[TPM_PPI_VERSION_LEN + 1];
 203 #endif /* CONFIG_ACPI */
 204 };
 205
 206 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
 207
 208 static inline int tpm_read_index(int base, int index)
 209 {
 210         outb(index, base);
 211         return inb(base+1) & 0xFF;
 212 }
 213
 214 static inline void tpm_write_index(int base, int index, int value)
 215 {
 216         outb(index, base);
 217         outb(value & 0xFF, base+1);
 218 }
 219 struct tpm_input_header {
 220         __be16  tag;
 221         __be32  length;
 222         __be32  ordinal;
 223 } __packed;
 224
 225 struct tpm_output_header {
 226         __be16  tag;
 227         __be32  length;
 228         __be32  return_code;
 229 } __packed;
 230
 231 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
 232
 233 struct  stclear_flags_t {
 234         __be16  tag;
 235         u8      deactivated;
 236         u8      disableForceClear;
 237         u8      physicalPresence;
 238         u8      physicalPresenceLock;
 239         u8      bGlobalLock;
 240 } __packed;
 241
 242 struct  tpm_version_t {
 243         u8      Major;
 244         u8      Minor;
 245         u8      revMajor;
 246         u8      revMinor;
 247 } __packed;
 248
 249 struct  tpm_version_1_2_t {
 250         __be16  tag;
 251         u8      Major;
 252         u8      Minor;
 253         u8      revMajor;
 254         u8      revMinor;
 255 } __packed;
 256
 257 struct  timeout_t {
 258         __be32  a;
 259         __be32  b;
 260         __be32  c;
 261         __be32  d;
 262 } __packed;
 263
 264 struct duration_t {
 265         __be32  tpm_short;
 266         __be32  tpm_medium;
 267         __be32  tpm_long;
 268 } __packed;
 269
 270 struct permanent_flags_t {
 271         __be16  tag;
 272         u8      disable;
 273         u8      ownership;
 274         u8      deactivated;
 275         u8      readPubek;
 276         u8      disableOwnerClear;
 277         u8      allowMaintenance;
 278         u8      physicalPresenceLifetimeLock;
 279         u8      physicalPresenceHWEnable;
 280         u8      physicalPresenceCMDEnable;
 281         u8      CEKPUsed;
 282         u8      TPMpost;
 283         u8      TPMpostLock;
 284         u8      FIPS;
 285         u8      operator;
 286         u8      enableRevokeEK;
 287         u8      nvLocked;
 288         u8      readSRKPub;
 289         u8      tpmEstablished;
 290         u8      maintenanceDone;
 291         u8      disableFullDALogicInfo;
 292 } __packed;
 293
 294 typedef union {
 295         struct  permanent_flags_t perm_flags;
 296         struct  stclear_flags_t stclear_flags;
 297         bool    owned;
 298         __be32  num_pcrs;
 299         struct  tpm_version_t   tpm_version;
 300         struct  tpm_version_1_2_t tpm_version_1_2;
 301         __be32  manufacturer_id;
 302         struct timeout_t  timeout;
 303         struct duration_t duration;
 304 } cap_t;
 305
 306 enum tpm_capabilities {
 307         TPM_CAP_FLAG = cpu_to_be32(4),
 308         TPM_CAP_PROP = cpu_to_be32(5),
 309         CAP_VERSION_1_1 = cpu_to_be32(0x06),
 310         CAP_VERSION_1_2 = cpu_to_be32(0x1A)
 311 };
 312
 313 enum tpm_sub_capabilities {
 314         TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
 315         TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
 316         TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
 317         TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
 318         TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
 319         TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
 320         TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
 321
 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 /* A string buffer type for constructing TPM commands. This is based on the
 402  * ideas of string buffer code in security/keys/trusted.h but is heap based
 403  * in order to keep the stack usage minimal.
 404  */
 405
 406 enum tpm_buf_flags {
 407         TPM_BUF_OVERFLOW        = BIT(0),
 408 };
 409
 410 struct tpm_buf {
 411         struct page *data_page;
 412         unsigned int flags;
 413         u8 *data;
 414 };
 415
 416 static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
 417 {
 418         struct tpm_input_header *head;
 419
 420         buf->data_page = alloc_page(GFP_HIGHUSER);
 421         if (!buf->data_page)
 422                 return -ENOMEM;
 423
 424         buf->flags = 0;
 425         buf->data = kmap(buf->data_page);
 426
 427         head = (struct tpm_input_header *) buf->data;
 428
 429         head->tag = cpu_to_be16(tag);
 430         head->length = cpu_to_be32(sizeof(*head));
 431         head->ordinal = cpu_to_be32(ordinal);
 432
 433         return 0;
 434 }
 435
 436 static inline void tpm_buf_destroy(struct tpm_buf *buf)
 437 {
 438         kunmap(buf->data_page);
 439         __free_page(buf->data_page);
 440 }
 441
 442 static inline u32 tpm_buf_length(struct tpm_buf *buf)
 443 {
 444         struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
 445
 446         return be32_to_cpu(head->length);
 447 }
 448
 449 static inline u16 tpm_buf_tag(struct tpm_buf *buf)
 450 {
 451         struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
 452
 453         return be16_to_cpu(head->tag);
 454 }
 455
 456 static inline void tpm_buf_append(struct tpm_buf *buf,
 457                                   const unsigned char *new_data,
 458                                   unsigned int new_len)
 459 {
 460         struct tpm_input_header *head = (struct tpm_input_header *) buf->data;
 461         u32 len = tpm_buf_length(buf);
 462
 463         /* Return silently if overflow has already happened. */
 464         if (buf->flags & TPM_BUF_OVERFLOW)
 465                 return;
 466
 467         if ((len + new_len) > PAGE_SIZE) {
 468                 WARN(1, "tpm_buf: overflow\n");
 469                 buf->flags |= TPM_BUF_OVERFLOW;
 470                 return;
 471         }
 472
 473         memcpy(&buf->data[len], new_data, new_len);
 474         head->length = cpu_to_be32(len + new_len);
 475 }
 476
 477 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
 478 {
 479         tpm_buf_append(buf, &value, 1);
 480 }
 481
 482 static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
 483 {
 484         __be16 value2 = cpu_to_be16(value);
 485
 486         tpm_buf_append(buf, (u8 *) &value2, 2);
 487 }
 488
 489 static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
 490 {
 491         __be32 value2 = cpu_to_be32(value);
 492
 493         tpm_buf_append(buf, (u8 *) &value2, 4);
 494 }
 495
 496 extern struct class *tpm_class;
 497 extern dev_t tpm_devt;
 498 extern const struct file_operations tpm_fops;
 499 extern struct idr dev_nums_idr;
 500
 501 enum tpm_transmit_flags {
 502         TPM_TRANSMIT_UNLOCKED   = BIT(0),
 503 };
 504
 505 ssize_t tpm_transmit(struct tpm_chip *chip, const u8 *buf, size_t bufsiz,
 506                      unsigned int flags);
 507 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, const void *cmd, int len,
 508                          unsigned int flags, const char *desc);
 509 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
 510 extern int tpm_get_timeouts(struct tpm_chip *);
 511 extern void tpm_gen_interrupt(struct tpm_chip *);
 512 extern int tpm_do_selftest(struct tpm_chip *);
 513 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
 514 extern int tpm_pm_suspend(struct device *);
 515 extern int tpm_pm_resume(struct device *);
 516 extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
 517                              wait_queue_head_t *, bool);
 518
 519 struct tpm_chip *tpm_chip_find_get(int chip_num);
 520 __must_check int tpm_try_get_ops(struct tpm_chip *chip);
 521 void tpm_put_ops(struct tpm_chip *chip);
 522
 523 extern struct tpm_chip *tpmm_chip_alloc(struct device *dev,
 524                                        const struct tpm_class_ops *ops);
 525 extern int tpm_chip_register(struct tpm_chip *chip);
 526 extern void tpm_chip_unregister(struct tpm_chip *chip);
 527
 528 int tpm_sysfs_add_device(struct tpm_chip *chip);
 529 void tpm_sysfs_del_device(struct tpm_chip *chip);
 530
 531 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
 532
 533 #ifdef CONFIG_ACPI
 534 extern void tpm_add_ppi(struct tpm_chip *chip);
 535 #else
 536 static inline void tpm_add_ppi(struct tpm_chip *chip)
 537 {
 538 }
 539 #endif
 540
 541 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
 542 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash);
 543 int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max);
 544 int tpm2_seal_trusted(struct tpm_chip *chip,
 545                       struct trusted_key_payload *payload,
 546                       struct trusted_key_options *options);
 547 int tpm2_unseal_trusted(struct tpm_chip *chip,
 548                         struct trusted_key_payload *payload,
 549                         struct trusted_key_options *options);
 550 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
 551                         u32 *value, const char *desc);
 552
 553 extern int tpm2_startup(struct tpm_chip *chip, u16 startup_type);
 554 extern void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
 555 extern unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *, u32);
 556 extern int tpm2_do_selftest(struct tpm_chip *chip);
 557 extern int tpm2_gen_interrupt(struct tpm_chip *chip);
 558 extern int tpm2_probe(struct tpm_chip *chip);