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