drivers/char/tpm/tpm.h

   1 /*
   2  * Copyright (C) 2004 IBM Corporation
   3  *
   4  * Authors:
   5  * Leendert van Doorn <leendert@watson.ibm.com>
   6  * Dave Safford <safford@watson.ibm.com>
   7  * Reiner Sailer <sailer@watson.ibm.com>
   8  * Kylene Hall <kjhall@us.ibm.com>
   9  *
  10  * Maintained by: <tpmdd-devel@lists.sourceforge.net>
  11  *
  12  * Device driver for TCG/TCPA TPM (trusted platform module).
  13  * Specifications at www.trustedcomputinggroup.org
  14  *
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License as
  17  * published by the Free Software Foundation, version 2 of the
  18  * License.
  19  *
  20  */
  21 #include <linux/module.h>
  22 #include <linux/delay.h>
  23 #include <linux/fs.h>
  24 #include <linux/mutex.h>
  25 #include <linux/sched.h>
  26 #include <linux/platform_device.h>
  27 #include <linux/io.h>
  28 #include <linux/tpm.h>
  29 #include <linux/acpi.h>
  30 #include <linux/cdev.h>
  31
  32 enum tpm_const {
  33         TPM_MINOR = 224,        /* officially assigned */
  34         TPM_BUFSIZE = 4096,
  35         TPM_NUM_DEVICES = 256,
  36         TPM_RETRY = 50,         /* 5 seconds */
  37 };
  38
  39 enum tpm_timeout {
  40         TPM_TIMEOUT = 5,        /* msecs */
  41         TPM_TIMEOUT_RETRY = 100 /* msecs */
  42 };
  43
  44 /* TPM addresses */
  45 enum tpm_addr {
  46         TPM_SUPERIO_ADDR = 0x2E,
  47         TPM_ADDR = 0x4E,
  48 };
  49
  50 /* Indexes the duration array */
  51 enum tpm_duration {
  52         TPM_SHORT = 0,
  53         TPM_MEDIUM = 1,
  54         TPM_LONG = 2,
  55         TPM_UNDEFINED,
  56 };
  57
  58 #define TPM_WARN_RETRY          0x800
  59 #define TPM_WARN_DOING_SELFTEST 0x802
  60 #define TPM_ERR_DEACTIVATED     0x6
  61 #define TPM_ERR_DISABLED        0x7
  62 #define TPM_ERR_INVALID_POSTINIT 38
  63
  64 #define TPM_HEADER_SIZE         10
  65
  66 enum tpm2_const {
  67         TPM2_PLATFORM_PCR       = 24,
  68         TPM2_PCR_SELECT_MIN     = ((TPM2_PLATFORM_PCR + 7) / 8),
  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 };
  77
  78 enum tpm2_structures {
  79         TPM2_ST_NO_SESSIONS     = 0x8001,
  80         TPM2_ST_SESSIONS        = 0x8002,
  81 };
  82
  83 enum tpm2_return_codes {
  84         TPM2_RC_INITIALIZE      = 0x0100,
  85         TPM2_RC_TESTING         = 0x090A,
  86         TPM2_RC_DISABLED        = 0x0120,
  87 };
  88
  89 enum tpm2_algorithms {
  90         TPM2_ALG_SHA1           = 0x0004,
  91 };
  92
  93 enum tpm2_command_codes {
  94         TPM2_CC_FIRST           = 0x011F,
  95         TPM2_CC_SELF_TEST       = 0x0143,
  96         TPM2_CC_STARTUP         = 0x0144,
  97         TPM2_CC_SHUTDOWN        = 0x0145,
  98         TPM2_CC_GET_CAPABILITY  = 0x017A,
  99         TPM2_CC_GET_RANDOM      = 0x017B,
 100         TPM2_CC_PCR_READ        = 0x017E,
 101         TPM2_CC_PCR_EXTEND      = 0x0182,
 102         TPM2_CC_LAST            = 0x018F,
 103 };
 104
 105 enum tpm2_permanent_handles {
 106         TPM2_RS_PW              = 0x40000009,
 107 };
 108
 109 enum tpm2_capabilities {
 110         TPM2_CAP_TPM_PROPERTIES = 6,
 111 };
 112
 113 enum tpm2_startup_types {
 114         TPM2_SU_CLEAR   = 0x0000,
 115         TPM2_SU_STATE   = 0x0001,
 116 };
 117
 118 enum tpm2_start_method {
 119         TPM2_START_ACPI = 2,
 120         TPM2_START_FIFO = 6,
 121         TPM2_START_CRB = 7,
 122         TPM2_START_CRB_WITH_ACPI = 8,
 123 };
 124
 125 struct tpm_chip;
 126
 127 struct tpm_vendor_specific {
 128         void __iomem *iobase;           /* ioremapped address */
 129         unsigned long base;             /* TPM base address */
 130
 131         int irq;
 132         int probed_irq;
 133
 134         int region_size;
 135         int have_region;
 136
 137         struct list_head list;
 138         int locality;
 139         unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
 140         bool timeout_adjusted;
 141         unsigned long duration[3]; /* jiffies */
 142         bool duration_adjusted;
 143         void *priv;
 144
 145         wait_queue_head_t read_queue;
 146         wait_queue_head_t int_queue;
 147
 148         u16 manufacturer_id;
 149 };
 150
 151 #define TPM_VPRIV(c)     ((c)->vendor.priv)
 152
 153 #define TPM_VID_INTEL    0x8086
 154 #define TPM_VID_WINBOND  0x1050
 155 #define TPM_VID_STM      0x104A
 156
 157 #define TPM_PPI_VERSION_LEN             3
 158
 159 enum tpm_chip_flags {
 160         TPM_CHIP_FLAG_REGISTERED        = BIT(0),
 161         TPM_CHIP_FLAG_TPM2              = BIT(1),
 162 };
 163
 164 struct tpm_chip {
 165         struct device *pdev;    /* Device stuff */
 166         struct device dev;
 167         struct cdev cdev;
 168
 169         const struct tpm_class_ops *ops;
 170         unsigned int flags;
 171
 172         int dev_num;            /* /dev/tpm# */
 173         char devname[7];
 174         unsigned long is_open;  /* only one allowed */
 175         int time_expired;
 176
 177         struct mutex tpm_mutex; /* tpm is processing */
 178
 179         struct tpm_vendor_specific vendor;
 180
 181         struct dentry **bios_dir;
 182
 183 #ifdef CONFIG_ACPI
 184         const struct attribute_group *groups[2];
 185         unsigned int groups_cnt;
 186         acpi_handle acpi_dev_handle;
 187         char ppi_version[TPM_PPI_VERSION_LEN + 1];
 188 #endif /* CONFIG_ACPI */
 189
 190         struct list_head list;
 191 };
 192
 193 #define to_tpm_chip(d) container_of(d, struct tpm_chip, dev)
 194
 195 static inline void tpm_chip_put(struct tpm_chip *chip)
 196 {
 197         module_put(chip->pdev->driver->owner);
 198 }
 199
 200 static inline int tpm_read_index(int base, int index)
 201 {
 202         outb(index, base);
 203         return inb(base+1) & 0xFF;
 204 }
 205
 206 static inline void tpm_write_index(int base, int index, int value)
 207 {
 208         outb(index, base);
 209         outb(value & 0xFF, base+1);
 210 }
 211 struct tpm_input_header {
 212         __be16  tag;
 213         __be32  length;
 214         __be32  ordinal;
 215 } __packed;
 216
 217 struct tpm_output_header {
 218         __be16  tag;
 219         __be32  length;
 220         __be32  return_code;
 221 } __packed;
 222
 223 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
 224
 225 struct  stclear_flags_t {
 226         __be16  tag;
 227         u8      deactivated;
 228         u8      disableForceClear;
 229         u8      physicalPresence;
 230         u8      physicalPresenceLock;
 231         u8      bGlobalLock;
 232 } __packed;
 233
 234 struct  tpm_version_t {
 235         u8      Major;
 236         u8      Minor;
 237         u8      revMajor;
 238         u8      revMinor;
 239 } __packed;
 240
 241 struct  tpm_version_1_2_t {
 242         __be16  tag;
 243         u8      Major;
 244         u8      Minor;
 245         u8      revMajor;
 246         u8      revMinor;
 247 } __packed;
 248
 249 struct  timeout_t {
 250         __be32  a;
 251         __be32  b;
 252         __be32  c;
 253         __be32  d;
 254 } __packed;
 255
 256 struct duration_t {
 257         __be32  tpm_short;
 258         __be32  tpm_medium;
 259         __be32  tpm_long;
 260 } __packed;
 261
 262 struct permanent_flags_t {
 263         __be16  tag;
 264         u8      disable;
 265         u8      ownership;
 266         u8      deactivated;
 267         u8      readPubek;
 268         u8      disableOwnerClear;
 269         u8      allowMaintenance;
 270         u8      physicalPresenceLifetimeLock;
 271         u8      physicalPresenceHWEnable;
 272         u8      physicalPresenceCMDEnable;
 273         u8      CEKPUsed;
 274         u8      TPMpost;
 275         u8      TPMpostLock;
 276         u8      FIPS;
 277         u8      operator;
 278         u8      enableRevokeEK;
 279         u8      nvLocked;
 280         u8      readSRKPub;
 281         u8      tpmEstablished;
 282         u8      maintenanceDone;
 283         u8      disableFullDALogicInfo;
 284 } __packed;
 285
 286 typedef union {
 287         struct  permanent_flags_t perm_flags;
 288         struct  stclear_flags_t stclear_flags;
 289         bool    owned;
 290         __be32  num_pcrs;
 291         struct  tpm_version_t   tpm_version;
 292         struct  tpm_version_1_2_t tpm_version_1_2;
 293         __be32  manufacturer_id;
 294         struct timeout_t  timeout;
 295         struct duration_t duration;
 296 } cap_t;
 297
 298 enum tpm_capabilities {
 299         TPM_CAP_FLAG = cpu_to_be32(4),
 300         TPM_CAP_PROP = cpu_to_be32(5),
 301         CAP_VERSION_1_1 = cpu_to_be32(0x06),
 302         CAP_VERSION_1_2 = cpu_to_be32(0x1A)
 303 };
 304
 305 enum tpm_sub_capabilities {
 306         TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
 307         TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
 308         TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
 309         TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
 310         TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
 311         TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
 312         TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
 313
 314 };
 315
 316 struct  tpm_getcap_params_in {
 317         __be32  cap;
 318         __be32  subcap_size;
 319         __be32  subcap;
 320 } __packed;
 321
 322 struct  tpm_getcap_params_out {
 323         __be32  cap_size;
 324         cap_t   cap;
 325 } __packed;
 326
 327 struct  tpm_readpubek_params_out {
 328         u8      algorithm[4];
 329         u8      encscheme[2];
 330         u8      sigscheme[2];
 331         __be32  paramsize;
 332         u8      parameters[12]; /*assuming RSA*/
 333         __be32  keysize;
 334         u8      modulus[256];
 335         u8      checksum[20];
 336 } __packed;
 337
 338 typedef union {
 339         struct  tpm_input_header in;
 340         struct  tpm_output_header out;
 341 } tpm_cmd_header;
 342
 343 struct tpm_pcrread_out {
 344         u8      pcr_result[TPM_DIGEST_SIZE];
 345 } __packed;
 346
 347 struct tpm_pcrread_in {
 348         __be32  pcr_idx;
 349 } __packed;
 350
 351 struct tpm_pcrextend_in {
 352         __be32  pcr_idx;
 353         u8      hash[TPM_DIGEST_SIZE];
 354 } __packed;
 355
 356 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
 357  * bytes, but 128 is still a relatively large number of random bytes and
 358  * anything much bigger causes users of struct tpm_cmd_t to start getting
 359  * compiler warnings about stack frame size. */
 360 #define TPM_MAX_RNG_DATA        128
 361
 362 struct tpm_getrandom_out {
 363         __be32 rng_data_len;
 364         u8     rng_data[TPM_MAX_RNG_DATA];
 365 } __packed;
 366
 367 struct tpm_getrandom_in {
 368         __be32 num_bytes;
 369 } __packed;
 370
 371 struct tpm_startup_in {
 372         __be16  startup_type;
 373 } __packed;
 374
 375 typedef union {
 376         struct  tpm_getcap_params_out getcap_out;
 377         struct  tpm_readpubek_params_out readpubek_out;
 378         u8      readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
 379         struct  tpm_getcap_params_in getcap_in;
 380         struct  tpm_pcrread_in  pcrread_in;
 381         struct  tpm_pcrread_out pcrread_out;
 382         struct  tpm_pcrextend_in pcrextend_in;
 383         struct  tpm_getrandom_in getrandom_in;
 384         struct  tpm_getrandom_out getrandom_out;
 385         struct tpm_startup_in startup_in;
 386 } tpm_cmd_params;
 387
 388 struct tpm_cmd_t {
 389         tpm_cmd_header  header;
 390         tpm_cmd_params  params;
 391 } __packed;
 392
 393 extern struct class *tpm_class;
 394 extern dev_t tpm_devt;
 395 extern const struct file_operations tpm_fops;
 396
 397 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
 398 ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
 399                      size_t bufsiz);
 400 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd, int len,
 401                          const char *desc);
 402 extern int tpm_get_timeouts(struct tpm_chip *);
 403 extern void tpm_gen_interrupt(struct tpm_chip *);
 404 extern int tpm_do_selftest(struct tpm_chip *);
 405 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
 406 extern int tpm_pm_suspend(struct device *);
 407 extern int tpm_pm_resume(struct device *);
 408 extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
 409                              wait_queue_head_t *, bool);
 410
 411 struct tpm_chip *tpm_chip_find_get(int chip_num);
 412 extern struct tpm_chip *tpmm_chip_alloc(struct device *dev,
 413                                        const struct tpm_class_ops *ops);
 414 extern int tpm_chip_register(struct tpm_chip *chip);
 415 extern void tpm_chip_unregister(struct tpm_chip *chip);
 416
 417 int tpm_sysfs_add_device(struct tpm_chip *chip);
 418 void tpm_sysfs_del_device(struct tpm_chip *chip);
 419
 420 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
 421
 422 #ifdef CONFIG_ACPI
 423 extern void tpm_add_ppi(struct tpm_chip *chip);
 424 #else
 425 static inline void tpm_add_ppi(struct tpm_chip *chip)
 426 {
 427 }
 428 #endif
 429
 430 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
 431 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash);
 432 int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max);
 433 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id,
 434                         u32 *value, const char *desc);
 435
 436 extern int tpm2_startup(struct tpm_chip *chip, u16 startup_type);
 437 extern void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type);
 438 extern unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *, u32);
 439 extern int tpm2_do_selftest(struct tpm_chip *chip);
 440 extern int tpm2_gen_interrupt(struct tpm_chip *chip);
 441 extern int tpm2_probe(struct tpm_chip *chip);