drivers/char/tpm/tpm.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2004 IBM Corporation
   4  * Copyright (C) 2015 Intel Corporation
   5  *
   6  * Authors:
   7  * Leendert van Doorn <leendert@watson.ibm.com>
   8  * Dave Safford <safford@watson.ibm.com>
   9  * Reiner Sailer <sailer@watson.ibm.com>
  10  * Kylene Hall <kjhall@us.ibm.com>
  11  *
  12  * Maintained by: <tpmdd-devel@lists.sourceforge.net>
  13  *
  14  * Device driver for TCG/TCPA TPM (trusted platform module).
  15  * Specifications at www.trustedcomputinggroup.org
  16  */
  17
  18 #ifndef __TPM_H__
  19 #define __TPM_H__
  20
  21 #include <linux/module.h>
  22 #include <linux/delay.h>
  23 #include <linux/mutex.h>
  24 #include <linux/sched.h>
  25 #include <linux/platform_device.h>
  26 #include <linux/io.h>
  27 #include <linux/tpm.h>
  28 #include <linux/highmem.h>
  29 #include <linux/tpm_eventlog.h>
  30
  31 #ifdef CONFIG_X86
  32 #include <asm/intel-family.h>
  33 #endif
  34
  35 #define TPM_MINOR               224     /* officially assigned */
  36 #define TPM_BUFSIZE             4096
  37 #define TPM_NUM_DEVICES         65536
  38 #define TPM_RETRY               50
  39
  40 enum tpm_timeout {
  41         TPM_TIMEOUT = 5,        /* msecs */
  42         TPM_TIMEOUT_RETRY = 100, /* msecs */
  43         TPM_TIMEOUT_RANGE_US = 300,     /* usecs */
  44         TPM_TIMEOUT_POLL = 1,   /* msecs */
  45         TPM_TIMEOUT_USECS_MIN = 100,      /* usecs */
  46         TPM_TIMEOUT_USECS_MAX = 500      /* usecs */
  47 };
  48
  49 /* TPM addresses */
  50 enum tpm_addr {
  51         TPM_SUPERIO_ADDR = 0x2E,
  52         TPM_ADDR = 0x4E,
  53 };
  54
  55 #define TPM_WARN_RETRY          0x800
  56 #define TPM_WARN_DOING_SELFTEST 0x802
  57 #define TPM_ERR_DEACTIVATED     0x6
  58 #define TPM_ERR_DISABLED        0x7
  59 #define TPM_ERR_INVALID_POSTINIT 38
  60
  61 #define TPM_HEADER_SIZE         10
  62
  63 enum tpm2_const {
  64         TPM2_PLATFORM_PCR       =     24,
  65         TPM2_PCR_SELECT_MIN     = ((TPM2_PLATFORM_PCR + 7) / 8),
  66 };
  67
  68 enum tpm2_timeouts {
  69         TPM2_TIMEOUT_A          =    750,
  70         TPM2_TIMEOUT_B          =   2000,
  71         TPM2_TIMEOUT_C          =    200,
  72         TPM2_TIMEOUT_D          =     30,
  73         TPM2_DURATION_SHORT     =     20,
  74         TPM2_DURATION_MEDIUM    =    750,
  75         TPM2_DURATION_LONG      =   2000,
  76         TPM2_DURATION_LONG_LONG = 300000,
  77         TPM2_DURATION_DEFAULT   = 120000,
  78 };
  79
  80 enum tpm2_structures {
  81         TPM2_ST_NO_SESSIONS     = 0x8001,
  82         TPM2_ST_SESSIONS        = 0x8002,
  83 };
  84
  85 /* Indicates from what layer of the software stack the error comes from */
  86 #define TSS2_RC_LAYER_SHIFT      16
  87 #define TSS2_RESMGR_TPM_RC_LAYER (11 << TSS2_RC_LAYER_SHIFT)
  88
  89 enum tpm2_return_codes {
  90         TPM2_RC_SUCCESS         = 0x0000,
  91         TPM2_RC_HASH            = 0x0083, /* RC_FMT1 */
  92         TPM2_RC_HANDLE          = 0x008B,
  93         TPM2_RC_INITIALIZE      = 0x0100, /* RC_VER1 */
  94         TPM2_RC_FAILURE         = 0x0101,
  95         TPM2_RC_DISABLED        = 0x0120,
  96         TPM2_RC_COMMAND_CODE    = 0x0143,
  97         TPM2_RC_TESTING         = 0x090A, /* RC_WARN */
  98         TPM2_RC_REFERENCE_H0    = 0x0910,
  99         TPM2_RC_RETRY           = 0x0922,
 100 };
 101
 102 enum tpm2_command_codes {
 103         TPM2_CC_FIRST                   = 0x011F,
 104         TPM2_CC_HIERARCHY_CONTROL       = 0x0121,
 105         TPM2_CC_HIERARCHY_CHANGE_AUTH   = 0x0129,
 106         TPM2_CC_CREATE_PRIMARY          = 0x0131,
 107         TPM2_CC_SEQUENCE_COMPLETE       = 0x013E,
 108         TPM2_CC_SELF_TEST               = 0x0143,
 109         TPM2_CC_STARTUP                 = 0x0144,
 110         TPM2_CC_SHUTDOWN                = 0x0145,
 111         TPM2_CC_NV_READ                 = 0x014E,
 112         TPM2_CC_CREATE                  = 0x0153,
 113         TPM2_CC_LOAD                    = 0x0157,
 114         TPM2_CC_SEQUENCE_UPDATE         = 0x015C,
 115         TPM2_CC_UNSEAL                  = 0x015E,
 116         TPM2_CC_CONTEXT_LOAD            = 0x0161,
 117         TPM2_CC_CONTEXT_SAVE            = 0x0162,
 118         TPM2_CC_FLUSH_CONTEXT           = 0x0165,
 119         TPM2_CC_VERIFY_SIGNATURE        = 0x0177,
 120         TPM2_CC_GET_CAPABILITY          = 0x017A,
 121         TPM2_CC_GET_RANDOM              = 0x017B,
 122         TPM2_CC_PCR_READ                = 0x017E,
 123         TPM2_CC_PCR_EXTEND              = 0x0182,
 124         TPM2_CC_EVENT_SEQUENCE_COMPLETE = 0x0185,
 125         TPM2_CC_HASH_SEQUENCE_START     = 0x0186,
 126         TPM2_CC_CREATE_LOADED           = 0x0191,
 127         TPM2_CC_LAST                    = 0x0193, /* Spec 1.36 */
 128 };
 129
 130 enum tpm2_permanent_handles {
 131         TPM2_RS_PW              = 0x40000009,
 132 };
 133
 134 enum tpm2_capabilities {
 135         TPM2_CAP_HANDLES        = 1,
 136         TPM2_CAP_COMMANDS       = 2,
 137         TPM2_CAP_PCRS           = 5,
 138         TPM2_CAP_TPM_PROPERTIES = 6,
 139 };
 140
 141 enum tpm2_properties {
 142         TPM_PT_TOTAL_COMMANDS   = 0x0129,
 143 };
 144
 145 enum tpm2_startup_types {
 146         TPM2_SU_CLEAR   = 0x0000,
 147         TPM2_SU_STATE   = 0x0001,
 148 };
 149
 150 enum tpm2_cc_attrs {
 151         TPM2_CC_ATTR_CHANDLES   = 25,
 152         TPM2_CC_ATTR_RHANDLE    = 28,
 153 };
 154
 155 #define TPM_VID_INTEL    0x8086
 156 #define TPM_VID_WINBOND  0x1050
 157 #define TPM_VID_STM      0x104A
 158
 159 enum tpm_chip_flags {
 160         TPM_CHIP_FLAG_TPM2              = BIT(1),
 161         TPM_CHIP_FLAG_IRQ               = BIT(2),
 162         TPM_CHIP_FLAG_VIRTUAL           = BIT(3),
 163         TPM_CHIP_FLAG_HAVE_TIMEOUTS     = BIT(4),
 164         TPM_CHIP_FLAG_ALWAYS_POWERED    = BIT(5),
 165 };
 166
 167 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
 168
 169 struct tpm_header {
 170         __be16 tag;
 171         __be32 length;
 172         union {
 173                 __be32 ordinal;
 174                 __be32 return_code;
 175         };
 176 } __packed;
 177
 178 #define TPM_TAG_RQU_COMMAND 193
 179
 180 struct  stclear_flags_t {
 181         __be16  tag;
 182         u8      deactivated;
 183         u8      disableForceClear;
 184         u8      physicalPresence;
 185         u8      physicalPresenceLock;
 186         u8      bGlobalLock;
 187 } __packed;
 188
 189 struct tpm1_version {
 190         u8 major;
 191         u8 minor;
 192         u8 rev_major;
 193         u8 rev_minor;
 194 } __packed;
 195
 196 struct tpm1_version2 {
 197         __be16 tag;
 198         struct tpm1_version version;
 199 } __packed;
 200
 201 struct  timeout_t {
 202         __be32  a;
 203         __be32  b;
 204         __be32  c;
 205         __be32  d;
 206 } __packed;
 207
 208 struct duration_t {
 209         __be32  tpm_short;
 210         __be32  tpm_medium;
 211         __be32  tpm_long;
 212 } __packed;
 213
 214 struct permanent_flags_t {
 215         __be16  tag;
 216         u8      disable;
 217         u8      ownership;
 218         u8      deactivated;
 219         u8      readPubek;
 220         u8      disableOwnerClear;
 221         u8      allowMaintenance;
 222         u8      physicalPresenceLifetimeLock;
 223         u8      physicalPresenceHWEnable;
 224         u8      physicalPresenceCMDEnable;
 225         u8      CEKPUsed;
 226         u8      TPMpost;
 227         u8      TPMpostLock;
 228         u8      FIPS;
 229         u8      operator;
 230         u8      enableRevokeEK;
 231         u8      nvLocked;
 232         u8      readSRKPub;
 233         u8      tpmEstablished;
 234         u8      maintenanceDone;
 235         u8      disableFullDALogicInfo;
 236 } __packed;
 237
 238 typedef union {
 239         struct  permanent_flags_t perm_flags;
 240         struct  stclear_flags_t stclear_flags;
 241         __u8    owned;
 242         __be32  num_pcrs;
 243         struct tpm1_version version1;
 244         struct tpm1_version2 version2;
 245         __be32  manufacturer_id;
 246         struct timeout_t  timeout;
 247         struct duration_t duration;
 248 } cap_t;
 249
 250 enum tpm_capabilities {
 251         TPM_CAP_FLAG = 4,
 252         TPM_CAP_PROP = 5,
 253         TPM_CAP_VERSION_1_1 = 0x06,
 254         TPM_CAP_VERSION_1_2 = 0x1A,
 255 };
 256
 257 enum tpm_sub_capabilities {
 258         TPM_CAP_PROP_PCR = 0x101,
 259         TPM_CAP_PROP_MANUFACTURER = 0x103,
 260         TPM_CAP_FLAG_PERM = 0x108,
 261         TPM_CAP_FLAG_VOL = 0x109,
 262         TPM_CAP_PROP_OWNER = 0x111,
 263         TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
 264         TPM_CAP_PROP_TIS_DURATION = 0x120,
 265 };
 266
 267
 268 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
 269  * bytes, but 128 is still a relatively large number of random bytes and
 270  * anything much bigger causes users of struct tpm_cmd_t to start getting
 271  * compiler warnings about stack frame size. */
 272 #define TPM_MAX_RNG_DATA        128
 273
 274 /* A string buffer type for constructing TPM commands. This is based on the
 275  * ideas of string buffer code in security/keys/trusted.h but is heap based
 276  * in order to keep the stack usage minimal.
 277  */
 278
 279 enum tpm_buf_flags {
 280         TPM_BUF_OVERFLOW        = BIT(0),
 281 };
 282
 283 struct tpm_buf {
 284         struct page *data_page;
 285         unsigned int flags;
 286         u8 *data;
 287 };
 288
 289 static inline void tpm_buf_reset(struct tpm_buf *buf, u16 tag, u32 ordinal)
 290 {
 291         struct tpm_header *head = (struct tpm_header *)buf->data;
 292
 293         head->tag = cpu_to_be16(tag);
 294         head->length = cpu_to_be32(sizeof(*head));
 295         head->ordinal = cpu_to_be32(ordinal);
 296 }
 297
 298 static inline int tpm_buf_init(struct tpm_buf *buf, u16 tag, u32 ordinal)
 299 {
 300         buf->data_page = alloc_page(GFP_HIGHUSER);
 301         if (!buf->data_page)
 302                 return -ENOMEM;
 303
 304         buf->flags = 0;
 305         buf->data = kmap(buf->data_page);
 306         tpm_buf_reset(buf, tag, ordinal);
 307         return 0;
 308 }
 309
 310 static inline void tpm_buf_destroy(struct tpm_buf *buf)
 311 {
 312         kunmap(buf->data_page);
 313         __free_page(buf->data_page);
 314 }
 315
 316 static inline u32 tpm_buf_length(struct tpm_buf *buf)
 317 {
 318         struct tpm_header *head = (struct tpm_header *)buf->data;
 319
 320         return be32_to_cpu(head->length);
 321 }
 322
 323 static inline u16 tpm_buf_tag(struct tpm_buf *buf)
 324 {
 325         struct tpm_header *head = (struct tpm_header *)buf->data;
 326
 327         return be16_to_cpu(head->tag);
 328 }
 329
 330 static inline void tpm_buf_append(struct tpm_buf *buf,
 331                                   const unsigned char *new_data,
 332                                   unsigned int new_len)
 333 {
 334         struct tpm_header *head = (struct tpm_header *)buf->data;
 335         u32 len = tpm_buf_length(buf);
 336
 337         /* Return silently if overflow has already happened. */
 338         if (buf->flags & TPM_BUF_OVERFLOW)
 339                 return;
 340
 341         if ((len + new_len) > PAGE_SIZE) {
 342                 WARN(1, "tpm_buf: overflow\n");
 343                 buf->flags |= TPM_BUF_OVERFLOW;
 344                 return;
 345         }
 346
 347         memcpy(&buf->data[len], new_data, new_len);
 348         head->length = cpu_to_be32(len + new_len);
 349 }
 350
 351 static inline void tpm_buf_append_u8(struct tpm_buf *buf, const u8 value)
 352 {
 353         tpm_buf_append(buf, &value, 1);
 354 }
 355
 356 static inline void tpm_buf_append_u16(struct tpm_buf *buf, const u16 value)
 357 {
 358         __be16 value2 = cpu_to_be16(value);
 359
 360         tpm_buf_append(buf, (u8 *) &value2, 2);
 361 }
 362
 363 static inline void tpm_buf_append_u32(struct tpm_buf *buf, const u32 value)
 364 {
 365         __be32 value2 = cpu_to_be32(value);
 366
 367         tpm_buf_append(buf, (u8 *) &value2, 4);
 368 }
 369
 370 extern struct class *tpm_class;
 371 extern struct class *tpmrm_class;
 372 extern dev_t tpm_devt;
 373 extern const struct file_operations tpm_fops;
 374 extern const struct file_operations tpmrm_fops;
 375 extern struct idr dev_nums_idr;
 376
 377 ssize_t tpm_transmit(struct tpm_chip *chip, u8 *buf, size_t bufsiz);
 378 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_buf *buf,
 379                          size_t min_rsp_body_length, const char *desc);
 380 int tpm_get_timeouts(struct tpm_chip *);
 381 int tpm_auto_startup(struct tpm_chip *chip);
 382
 383 int tpm1_pm_suspend(struct tpm_chip *chip, u32 tpm_suspend_pcr);
 384 int tpm1_auto_startup(struct tpm_chip *chip);
 385 int tpm1_do_selftest(struct tpm_chip *chip);
 386 int tpm1_get_timeouts(struct tpm_chip *chip);
 387 unsigned long tpm1_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
 388 int tpm1_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, const u8 *hash,
 389                     const char *log_msg);
 390 int tpm1_pcr_read(struct tpm_chip *chip, u32 pcr_idx, u8 *res_buf);
 391 ssize_t tpm1_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
 392                     const char *desc, size_t min_cap_length);
 393 int tpm1_get_random(struct tpm_chip *chip, u8 *out, size_t max);
 394 int tpm1_get_pcr_allocation(struct tpm_chip *chip);
 395 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
 396 int tpm_pm_suspend(struct device *dev);
 397 int tpm_pm_resume(struct device *dev);
 398
 399 static inline void tpm_msleep(unsigned int delay_msec)
 400 {
 401         usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US,
 402                      delay_msec * 1000);
 403 };
 404
 405 int tpm_chip_start(struct tpm_chip *chip);
 406 void tpm_chip_stop(struct tpm_chip *chip);
 407 struct tpm_chip *tpm_find_get_ops(struct tpm_chip *chip);
 408 __must_check int tpm_try_get_ops(struct tpm_chip *chip);
 409 void tpm_put_ops(struct tpm_chip *chip);
 410
 411 struct tpm_chip *tpm_chip_alloc(struct device *dev,
 412                                 const struct tpm_class_ops *ops);
 413 struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
 414                                  const struct tpm_class_ops *ops);
 415 int tpm_chip_register(struct tpm_chip *chip);
 416 void tpm_chip_unregister(struct tpm_chip *chip);
 417
 418 void tpm_sysfs_add_device(struct tpm_chip *chip);
 419
 420
 421 #ifdef CONFIG_ACPI
 422 extern void tpm_add_ppi(struct tpm_chip *chip);
 423 #else
 424 static inline void tpm_add_ppi(struct tpm_chip *chip)
 425 {
 426 }
 427 #endif
 428
 429 static inline u32 tpm2_rc_value(u32 rc)
 430 {
 431         return (rc & BIT(7)) ? rc & 0xff : rc;
 432 }
 433
 434 int tpm2_get_timeouts(struct tpm_chip *chip);
 435 int tpm2_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
 436                   struct tpm_digest *digest, u16 *digest_size_ptr);
 437 int tpm2_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
 438                     struct tpm_digest *digests);
 439 int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max);
 440 void tpm2_flush_context(struct tpm_chip *chip, u32 handle);
 441 int tpm2_seal_trusted(struct tpm_chip *chip,
 442                       struct trusted_key_payload *payload,
 443                       struct trusted_key_options *options);
 444 int tpm2_unseal_trusted(struct tpm_chip *chip,
 445                         struct trusted_key_payload *payload,
 446                         struct trusted_key_options *options);
 447 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
 448                         u32 *value, const char *desc);
 449
 450 ssize_t tpm2_get_pcr_allocation(struct tpm_chip *chip);
 451 int tpm2_auto_startup(struct tpm_chip *chip);
 452 void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
 453 unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
 454 int tpm2_probe(struct tpm_chip *chip);
 455 int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
 456 int tpm2_init_space(struct tpm_space *space);
 457 void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space);
 458 void tpm2_flush_space(struct tpm_chip *chip);
 459 int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u8 *cmd,
 460                        size_t cmdsiz);
 461 int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space, void *buf,
 462                       size_t *bufsiz);
 463
 464 int tpm_bios_log_setup(struct tpm_chip *chip);
 465 void tpm_bios_log_teardown(struct tpm_chip *chip);
 466 int tpm_dev_common_init(void);
 467 void tpm_dev_common_exit(void);
 468 #endif