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 <[email protected]>
   8  * Dave Safford <[email protected]>
   9  * Reiner Sailer <[email protected]>
  10  * Kylene Hall <[email protected]>
  11  *
  12  * Maintained by: <[email protected]>
  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/tpm_eventlog.h>
  29
  30 #ifdef CONFIG_X86
  31 #include <asm/intel-family.h>
  32 #endif
  33
  34 #define TPM_MINOR               224     /* officially assigned */
  35 #define TPM_BUFSIZE             4096
  36 #define TPM_NUM_DEVICES         65536
  37 #define TPM_RETRY               50
  38
  39 enum tpm_timeout {
  40         TPM_TIMEOUT = 5,        /* msecs */
  41         TPM_TIMEOUT_RETRY = 100, /* msecs */
  42         TPM_TIMEOUT_RANGE_US = 300,     /* usecs */
  43         TPM_TIMEOUT_POLL = 1,   /* msecs */
  44         TPM_TIMEOUT_USECS_MIN = 100,      /* usecs */
  45         TPM_TIMEOUT_USECS_MAX = 500      /* usecs */
  46 };
  47
  48 /* TPM addresses */
  49 enum tpm_addr {
  50         TPM_SUPERIO_ADDR = 0x2E,
  51         TPM_ADDR = 0x4E,
  52 };
  53
  54 #define TPM_WARN_RETRY          0x800
  55 #define TPM_WARN_DOING_SELFTEST 0x802
  56 #define TPM_ERR_DEACTIVATED     0x6
  57 #define TPM_ERR_DISABLED        0x7
  58 #define TPM_ERR_INVALID_POSTINIT 38
  59
  60 #define TPM_TAG_RQU_COMMAND 193
  61
  62 struct  stclear_flags_t {
  63         __be16  tag;
  64         u8      deactivated;
  65         u8      disableForceClear;
  66         u8      physicalPresence;
  67         u8      physicalPresenceLock;
  68         u8      bGlobalLock;
  69 } __packed;
  70
  71 struct tpm1_version {
  72         u8 major;
  73         u8 minor;
  74         u8 rev_major;
  75         u8 rev_minor;
  76 } __packed;
  77
  78 struct tpm1_version2 {
  79         __be16 tag;
  80         struct tpm1_version version;
  81 } __packed;
  82
  83 struct  timeout_t {
  84         __be32  a;
  85         __be32  b;
  86         __be32  c;
  87         __be32  d;
  88 } __packed;
  89
  90 struct duration_t {
  91         __be32  tpm_short;
  92         __be32  tpm_medium;
  93         __be32  tpm_long;
  94 } __packed;
  95
  96 struct permanent_flags_t {
  97         __be16  tag;
  98         u8      disable;
  99         u8      ownership;
 100         u8      deactivated;
 101         u8      readPubek;
 102         u8      disableOwnerClear;
 103         u8      allowMaintenance;
 104         u8      physicalPresenceLifetimeLock;
 105         u8      physicalPresenceHWEnable;
 106         u8      physicalPresenceCMDEnable;
 107         u8      CEKPUsed;
 108         u8      TPMpost;
 109         u8      TPMpostLock;
 110         u8      FIPS;
 111         u8      operator;
 112         u8      enableRevokeEK;
 113         u8      nvLocked;
 114         u8      readSRKPub;
 115         u8      tpmEstablished;
 116         u8      maintenanceDone;
 117         u8      disableFullDALogicInfo;
 118 } __packed;
 119
 120 typedef union {
 121         struct  permanent_flags_t perm_flags;
 122         struct  stclear_flags_t stclear_flags;
 123         __u8    owned;
 124         __be32  num_pcrs;
 125         struct tpm1_version version1;
 126         struct tpm1_version2 version2;
 127         __be32  manufacturer_id;
 128         struct timeout_t  timeout;
 129         struct duration_t duration;
 130 } cap_t;
 131
 132 enum tpm_capabilities {
 133         TPM_CAP_FLAG = 4,
 134         TPM_CAP_PROP = 5,
 135         TPM_CAP_VERSION_1_1 = 0x06,
 136         TPM_CAP_VERSION_1_2 = 0x1A,
 137 };
 138
 139 enum tpm_sub_capabilities {
 140         TPM_CAP_PROP_PCR = 0x101,
 141         TPM_CAP_PROP_MANUFACTURER = 0x103,
 142         TPM_CAP_FLAG_PERM = 0x108,
 143         TPM_CAP_FLAG_VOL = 0x109,
 144         TPM_CAP_PROP_OWNER = 0x111,
 145         TPM_CAP_PROP_TIS_TIMEOUT = 0x115,
 146         TPM_CAP_PROP_TIS_DURATION = 0x120,
 147 };
 148
 149
 150 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
 151  * bytes, but 128 is still a relatively large number of random bytes and
 152  * anything much bigger causes users of struct tpm_cmd_t to start getting
 153  * compiler warnings about stack frame size. */
 154 #define TPM_MAX_RNG_DATA        128
 155
 156 extern struct class *tpm_class;
 157 extern struct class *tpmrm_class;
 158 extern dev_t tpm_devt;
 159 extern const struct file_operations tpm_fops;
 160 extern const struct file_operations tpmrm_fops;
 161 extern struct idr dev_nums_idr;
 162
 163 ssize_t tpm_transmit(struct tpm_chip *chip, u8 *buf, size_t bufsiz);
 164 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_buf *buf,
 165                          size_t min_rsp_body_length, const char *desc);
 166 int tpm_get_timeouts(struct tpm_chip *);
 167 int tpm_auto_startup(struct tpm_chip *chip);
 168
 169 int tpm1_pm_suspend(struct tpm_chip *chip, u32 tpm_suspend_pcr);
 170 int tpm1_auto_startup(struct tpm_chip *chip);
 171 int tpm1_do_selftest(struct tpm_chip *chip);
 172 int tpm1_get_timeouts(struct tpm_chip *chip);
 173 unsigned long tpm1_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
 174 int tpm1_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, const u8 *hash,
 175                     const char *log_msg);
 176 int tpm1_pcr_read(struct tpm_chip *chip, u32 pcr_idx, u8 *res_buf);
 177 ssize_t tpm1_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
 178                     const char *desc, size_t min_cap_length);
 179 int tpm1_get_random(struct tpm_chip *chip, u8 *out, size_t max);
 180 int tpm1_get_pcr_allocation(struct tpm_chip *chip);
 181 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
 182 int tpm_pm_suspend(struct device *dev);
 183 int tpm_pm_resume(struct device *dev);
 184
 185 static inline void tpm_msleep(unsigned int delay_msec)
 186 {
 187         usleep_range((delay_msec * 1000) - TPM_TIMEOUT_RANGE_US,
 188                      delay_msec * 1000);
 189 };
 190
 191 int tpm_chip_start(struct tpm_chip *chip);
 192 void tpm_chip_stop(struct tpm_chip *chip);
 193 struct tpm_chip *tpm_find_get_ops(struct tpm_chip *chip);
 194 __must_check int tpm_try_get_ops(struct tpm_chip *chip);
 195 void tpm_put_ops(struct tpm_chip *chip);
 196
 197 struct tpm_chip *tpm_chip_alloc(struct device *dev,
 198                                 const struct tpm_class_ops *ops);
 199 struct tpm_chip *tpmm_chip_alloc(struct device *pdev,
 200                                  const struct tpm_class_ops *ops);
 201 int tpm_chip_register(struct tpm_chip *chip);
 202 void tpm_chip_unregister(struct tpm_chip *chip);
 203
 204 void tpm_sysfs_add_device(struct tpm_chip *chip);
 205
 206
 207 #ifdef CONFIG_ACPI
 208 extern void tpm_add_ppi(struct tpm_chip *chip);
 209 #else
 210 static inline void tpm_add_ppi(struct tpm_chip *chip)
 211 {
 212 }
 213 #endif
 214
 215 int tpm2_get_timeouts(struct tpm_chip *chip);
 216 int tpm2_pcr_read(struct tpm_chip *chip, u32 pcr_idx,
 217                   struct tpm_digest *digest, u16 *digest_size_ptr);
 218 int tpm2_pcr_extend(struct tpm_chip *chip, u32 pcr_idx,
 219                     struct tpm_digest *digests);
 220 int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max);
 221 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
 222                         u32 *value, const char *desc);
 223
 224 ssize_t tpm2_get_pcr_allocation(struct tpm_chip *chip);
 225 int tpm2_auto_startup(struct tpm_chip *chip);
 226 void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
 227 unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal);
 228 int tpm2_probe(struct tpm_chip *chip);
 229 int tpm2_find_cc(struct tpm_chip *chip, u32 cc);
 230 int tpm2_init_space(struct tpm_space *space);
 231 void tpm2_del_space(struct tpm_chip *chip, struct tpm_space *space);
 232 void tpm2_flush_space(struct tpm_chip *chip);
 233 int tpm2_prepare_space(struct tpm_chip *chip, struct tpm_space *space, u8 *cmd,
 234                        size_t cmdsiz);
 235 int tpm2_commit_space(struct tpm_chip *chip, struct tpm_space *space, void *buf,
 236                       size_t *bufsiz);
 237
 238 int tpm_bios_log_setup(struct tpm_chip *chip);
 239 void tpm_bios_log_teardown(struct tpm_chip *chip);
 240 int tpm_dev_common_init(void);
 241 void tpm_dev_common_exit(void);
 242 #endif