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 struct tpm_chip;
  66
  67 struct tpm_vendor_specific {
  68         void __iomem *iobase;           /* ioremapped address */
  69         unsigned long base;             /* TPM base address */
  70
  71         int irq;
  72         int probed_irq;
  73
  74         int region_size;
  75         int have_region;
  76
  77         struct list_head list;
  78         int locality;
  79         unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
  80         bool timeout_adjusted;
  81         unsigned long duration[3]; /* jiffies */
  82         bool duration_adjusted;
  83         void *priv;
  84
  85         wait_queue_head_t read_queue;
  86         wait_queue_head_t int_queue;
  87
  88         u16 manufacturer_id;
  89 };
  90
  91 #define TPM_VPRIV(c)    (c)->vendor.priv
  92
  93 #define TPM_VID_INTEL    0x8086
  94 #define TPM_VID_WINBOND  0x1050
  95 #define TPM_VID_STM      0x104A
  96
  97 #define TPM_PPI_VERSION_LEN             3
  98
  99 enum tpm_chip_flags {
 100         TPM_CHIP_FLAG_REGISTERED        = BIT(0),
 101         TPM_CHIP_FLAG_PPI               = BIT(1),
 102 };
 103
 104 struct tpm_chip {
 105         struct device *pdev;    /* Device stuff */
 106         struct device dev;
 107         struct cdev cdev;
 108
 109         const struct tpm_class_ops *ops;
 110         unsigned int flags;
 111
 112         int dev_num;            /* /dev/tpm# */
 113         char devname[7];
 114         unsigned long is_open;  /* only one allowed */
 115         int time_expired;
 116
 117         struct mutex tpm_mutex; /* tpm is processing */
 118
 119         struct tpm_vendor_specific vendor;
 120
 121         struct dentry **bios_dir;
 122
 123 #ifdef CONFIG_ACPI
 124         acpi_handle acpi_dev_handle;
 125         char ppi_version[TPM_PPI_VERSION_LEN + 1];
 126 #endif /* CONFIG_ACPI */
 127
 128         struct list_head list;
 129 };
 130
 131 #define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
 132
 133 static inline void tpm_chip_put(struct tpm_chip *chip)
 134 {
 135         module_put(chip->pdev->driver->owner);
 136 }
 137
 138 static inline int tpm_read_index(int base, int index)
 139 {
 140         outb(index, base);
 141         return inb(base+1) & 0xFF;
 142 }
 143
 144 static inline void tpm_write_index(int base, int index, int value)
 145 {
 146         outb(index, base);
 147         outb(value & 0xFF, base+1);
 148 }
 149 struct tpm_input_header {
 150         __be16  tag;
 151         __be32  length;
 152         __be32  ordinal;
 153 } __packed;
 154
 155 struct tpm_output_header {
 156         __be16  tag;
 157         __be32  length;
 158         __be32  return_code;
 159 } __packed;
 160
 161 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
 162
 163 struct  stclear_flags_t {
 164         __be16  tag;
 165         u8      deactivated;
 166         u8      disableForceClear;
 167         u8      physicalPresence;
 168         u8      physicalPresenceLock;
 169         u8      bGlobalLock;
 170 } __packed;
 171
 172 struct  tpm_version_t {
 173         u8      Major;
 174         u8      Minor;
 175         u8      revMajor;
 176         u8      revMinor;
 177 } __packed;
 178
 179 struct  tpm_version_1_2_t {
 180         __be16  tag;
 181         u8      Major;
 182         u8      Minor;
 183         u8      revMajor;
 184         u8      revMinor;
 185 } __packed;
 186
 187 struct  timeout_t {
 188         __be32  a;
 189         __be32  b;
 190         __be32  c;
 191         __be32  d;
 192 } __packed;
 193
 194 struct duration_t {
 195         __be32  tpm_short;
 196         __be32  tpm_medium;
 197         __be32  tpm_long;
 198 } __packed;
 199
 200 struct permanent_flags_t {
 201         __be16  tag;
 202         u8      disable;
 203         u8      ownership;
 204         u8      deactivated;
 205         u8      readPubek;
 206         u8      disableOwnerClear;
 207         u8      allowMaintenance;
 208         u8      physicalPresenceLifetimeLock;
 209         u8      physicalPresenceHWEnable;
 210         u8      physicalPresenceCMDEnable;
 211         u8      CEKPUsed;
 212         u8      TPMpost;
 213         u8      TPMpostLock;
 214         u8      FIPS;
 215         u8      operator;
 216         u8      enableRevokeEK;
 217         u8      nvLocked;
 218         u8      readSRKPub;
 219         u8      tpmEstablished;
 220         u8      maintenanceDone;
 221         u8      disableFullDALogicInfo;
 222 } __packed;
 223
 224 typedef union {
 225         struct  permanent_flags_t perm_flags;
 226         struct  stclear_flags_t stclear_flags;
 227         bool    owned;
 228         __be32  num_pcrs;
 229         struct  tpm_version_t   tpm_version;
 230         struct  tpm_version_1_2_t tpm_version_1_2;
 231         __be32  manufacturer_id;
 232         struct timeout_t  timeout;
 233         struct duration_t duration;
 234 } cap_t;
 235
 236 enum tpm_capabilities {
 237         TPM_CAP_FLAG = cpu_to_be32(4),
 238         TPM_CAP_PROP = cpu_to_be32(5),
 239         CAP_VERSION_1_1 = cpu_to_be32(0x06),
 240         CAP_VERSION_1_2 = cpu_to_be32(0x1A)
 241 };
 242
 243 enum tpm_sub_capabilities {
 244         TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
 245         TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
 246         TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
 247         TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
 248         TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
 249         TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
 250         TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
 251
 252 };
 253
 254 struct  tpm_getcap_params_in {
 255         __be32  cap;
 256         __be32  subcap_size;
 257         __be32  subcap;
 258 } __packed;
 259
 260 struct  tpm_getcap_params_out {
 261         __be32  cap_size;
 262         cap_t   cap;
 263 } __packed;
 264
 265 struct  tpm_readpubek_params_out {
 266         u8      algorithm[4];
 267         u8      encscheme[2];
 268         u8      sigscheme[2];
 269         __be32  paramsize;
 270         u8      parameters[12]; /*assuming RSA*/
 271         __be32  keysize;
 272         u8      modulus[256];
 273         u8      checksum[20];
 274 } __packed;
 275
 276 typedef union {
 277         struct  tpm_input_header in;
 278         struct  tpm_output_header out;
 279 } tpm_cmd_header;
 280
 281 struct tpm_pcrread_out {
 282         u8      pcr_result[TPM_DIGEST_SIZE];
 283 } __packed;
 284
 285 struct tpm_pcrread_in {
 286         __be32  pcr_idx;
 287 } __packed;
 288
 289 struct tpm_pcrextend_in {
 290         __be32  pcr_idx;
 291         u8      hash[TPM_DIGEST_SIZE];
 292 } __packed;
 293
 294 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
 295  * bytes, but 128 is still a relatively large number of random bytes and
 296  * anything much bigger causes users of struct tpm_cmd_t to start getting
 297  * compiler warnings about stack frame size. */
 298 #define TPM_MAX_RNG_DATA        128
 299
 300 struct tpm_getrandom_out {
 301         __be32 rng_data_len;
 302         u8     rng_data[TPM_MAX_RNG_DATA];
 303 } __packed;
 304
 305 struct tpm_getrandom_in {
 306         __be32 num_bytes;
 307 } __packed;
 308
 309 struct tpm_startup_in {
 310         __be16  startup_type;
 311 } __packed;
 312
 313 typedef union {
 314         struct  tpm_getcap_params_out getcap_out;
 315         struct  tpm_readpubek_params_out readpubek_out;
 316         u8      readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
 317         struct  tpm_getcap_params_in getcap_in;
 318         struct  tpm_pcrread_in  pcrread_in;
 319         struct  tpm_pcrread_out pcrread_out;
 320         struct  tpm_pcrextend_in pcrextend_in;
 321         struct  tpm_getrandom_in getrandom_in;
 322         struct  tpm_getrandom_out getrandom_out;
 323         struct tpm_startup_in startup_in;
 324 } tpm_cmd_params;
 325
 326 struct tpm_cmd_t {
 327         tpm_cmd_header  header;
 328         tpm_cmd_params  params;
 329 } __packed;
 330
 331 extern struct class *tpm_class;
 332 extern dev_t tpm_devt;
 333 extern const struct file_operations tpm_fops;
 334
 335 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
 336 ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
 337                      size_t bufsiz);
 338 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd, int len,
 339                          const char *desc);
 340 extern int tpm_get_timeouts(struct tpm_chip *);
 341 extern void tpm_gen_interrupt(struct tpm_chip *);
 342 extern int tpm_do_selftest(struct tpm_chip *);
 343 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
 344 extern int tpm_pm_suspend(struct device *);
 345 extern int tpm_pm_resume(struct device *);
 346 extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
 347                              wait_queue_head_t *, bool);
 348
 349 struct tpm_chip *tpm_chip_find_get(int chip_num);
 350 extern struct tpm_chip *tpmm_chip_alloc(struct device *dev,
 351                                        const struct tpm_class_ops *ops);
 352 extern int tpm_chip_register(struct tpm_chip *chip);
 353 extern void tpm_chip_unregister(struct tpm_chip *chip);
 354
 355 int tpm_sysfs_add_device(struct tpm_chip *chip);
 356 void tpm_sysfs_del_device(struct tpm_chip *chip);
 357
 358 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
 359
 360 #ifdef CONFIG_ACPI
 361 extern int tpm_add_ppi(struct tpm_chip *chip);
 362 extern void tpm_remove_ppi(struct tpm_chip *chip);
 363 #else
 364 static inline int tpm_add_ppi(struct tpm_chip *chip)
 365 {
 366         return 0;
 367 }
 368
 369 static inline void tpm_remove_ppi(struct tpm_chip *chip)
 370 {
 371 }
 372 #endif