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/miscdevice.h>
  27 #include <linux/platform_device.h>
  28 #include <linux/io.h>
  29 #include <linux/tpm.h>
  30
  31 enum tpm_const {
  32         TPM_MINOR = 224,        /* officially assigned */
  33         TPM_BUFSIZE = 4096,
  34         TPM_NUM_DEVICES = 256,
  35         TPM_RETRY = 50,         /* 5 seconds */
  36 };
  37
  38 enum tpm_timeout {
  39         TPM_TIMEOUT = 5,        /* msecs */
  40         TPM_TIMEOUT_RETRY = 100 /* msecs */
  41 };
  42
  43 /* TPM addresses */
  44 enum tpm_addr {
  45         TPM_SUPERIO_ADDR = 0x2E,
  46         TPM_ADDR = 0x4E,
  47 };
  48
  49 /* Indexes the duration array */
  50 enum tpm_duration {
  51         TPM_SHORT = 0,
  52         TPM_MEDIUM = 1,
  53         TPM_LONG = 2,
  54         TPM_UNDEFINED,
  55 };
  56
  57 #define TPM_WARN_RETRY          0x800
  58 #define TPM_WARN_DOING_SELFTEST 0x802
  59 #define TPM_ERR_DEACTIVATED     0x6
  60 #define TPM_ERR_DISABLED        0x7
  61 #define TPM_ERR_INVALID_POSTINIT 38
  62
  63 #define TPM_HEADER_SIZE         10
  64 struct tpm_chip;
  65
  66 struct tpm_vendor_specific {
  67         void __iomem *iobase;           /* ioremapped address */
  68         unsigned long base;             /* TPM base address */
  69
  70         int irq;
  71         int probed_irq;
  72
  73         int region_size;
  74         int have_region;
  75
  76         struct miscdevice miscdev;
  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 enum tpm_chip_flags {
  98         TPM_CHIP_FLAG_REGISTERED        = BIT(0),
  99 };
 100
 101 struct tpm_chip {
 102         struct device *dev;     /* Device stuff */
 103         const struct tpm_class_ops *ops;
 104         unsigned int flags;
 105
 106         int dev_num;            /* /dev/tpm# */
 107         char devname[7];
 108         unsigned long is_open;  /* only one allowed */
 109         int time_expired;
 110
 111         struct mutex tpm_mutex; /* tpm is processing */
 112
 113         struct tpm_vendor_specific vendor;
 114
 115         struct dentry **bios_dir;
 116
 117         struct list_head list;
 118 };
 119
 120 #define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
 121
 122 static inline void tpm_chip_put(struct tpm_chip *chip)
 123 {
 124         module_put(chip->dev->driver->owner);
 125 }
 126
 127 static inline int tpm_read_index(int base, int index)
 128 {
 129         outb(index, base);
 130         return inb(base+1) & 0xFF;
 131 }
 132
 133 static inline void tpm_write_index(int base, int index, int value)
 134 {
 135         outb(index, base);
 136         outb(value & 0xFF, base+1);
 137 }
 138 struct tpm_input_header {
 139         __be16  tag;
 140         __be32  length;
 141         __be32  ordinal;
 142 } __packed;
 143
 144 struct tpm_output_header {
 145         __be16  tag;
 146         __be32  length;
 147         __be32  return_code;
 148 } __packed;
 149
 150 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
 151
 152 struct  stclear_flags_t {
 153         __be16  tag;
 154         u8      deactivated;
 155         u8      disableForceClear;
 156         u8      physicalPresence;
 157         u8      physicalPresenceLock;
 158         u8      bGlobalLock;
 159 } __packed;
 160
 161 struct  tpm_version_t {
 162         u8      Major;
 163         u8      Minor;
 164         u8      revMajor;
 165         u8      revMinor;
 166 } __packed;
 167
 168 struct  tpm_version_1_2_t {
 169         __be16  tag;
 170         u8      Major;
 171         u8      Minor;
 172         u8      revMajor;
 173         u8      revMinor;
 174 } __packed;
 175
 176 struct  timeout_t {
 177         __be32  a;
 178         __be32  b;
 179         __be32  c;
 180         __be32  d;
 181 } __packed;
 182
 183 struct duration_t {
 184         __be32  tpm_short;
 185         __be32  tpm_medium;
 186         __be32  tpm_long;
 187 } __packed;
 188
 189 struct permanent_flags_t {
 190         __be16  tag;
 191         u8      disable;
 192         u8      ownership;
 193         u8      deactivated;
 194         u8      readPubek;
 195         u8      disableOwnerClear;
 196         u8      allowMaintenance;
 197         u8      physicalPresenceLifetimeLock;
 198         u8      physicalPresenceHWEnable;
 199         u8      physicalPresenceCMDEnable;
 200         u8      CEKPUsed;
 201         u8      TPMpost;
 202         u8      TPMpostLock;
 203         u8      FIPS;
 204         u8      operator;
 205         u8      enableRevokeEK;
 206         u8      nvLocked;
 207         u8      readSRKPub;
 208         u8      tpmEstablished;
 209         u8      maintenanceDone;
 210         u8      disableFullDALogicInfo;
 211 } __packed;
 212
 213 typedef union {
 214         struct  permanent_flags_t perm_flags;
 215         struct  stclear_flags_t stclear_flags;
 216         bool    owned;
 217         __be32  num_pcrs;
 218         struct  tpm_version_t   tpm_version;
 219         struct  tpm_version_1_2_t tpm_version_1_2;
 220         __be32  manufacturer_id;
 221         struct timeout_t  timeout;
 222         struct duration_t duration;
 223 } cap_t;
 224
 225 enum tpm_capabilities {
 226         TPM_CAP_FLAG = cpu_to_be32(4),
 227         TPM_CAP_PROP = cpu_to_be32(5),
 228         CAP_VERSION_1_1 = cpu_to_be32(0x06),
 229         CAP_VERSION_1_2 = cpu_to_be32(0x1A)
 230 };
 231
 232 enum tpm_sub_capabilities {
 233         TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
 234         TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
 235         TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
 236         TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
 237         TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
 238         TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
 239         TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
 240
 241 };
 242
 243 struct  tpm_getcap_params_in {
 244         __be32  cap;
 245         __be32  subcap_size;
 246         __be32  subcap;
 247 } __packed;
 248
 249 struct  tpm_getcap_params_out {
 250         __be32  cap_size;
 251         cap_t   cap;
 252 } __packed;
 253
 254 struct  tpm_readpubek_params_out {
 255         u8      algorithm[4];
 256         u8      encscheme[2];
 257         u8      sigscheme[2];
 258         __be32  paramsize;
 259         u8      parameters[12]; /*assuming RSA*/
 260         __be32  keysize;
 261         u8      modulus[256];
 262         u8      checksum[20];
 263 } __packed;
 264
 265 typedef union {
 266         struct  tpm_input_header in;
 267         struct  tpm_output_header out;
 268 } tpm_cmd_header;
 269
 270 struct tpm_pcrread_out {
 271         u8      pcr_result[TPM_DIGEST_SIZE];
 272 } __packed;
 273
 274 struct tpm_pcrread_in {
 275         __be32  pcr_idx;
 276 } __packed;
 277
 278 struct tpm_pcrextend_in {
 279         __be32  pcr_idx;
 280         u8      hash[TPM_DIGEST_SIZE];
 281 } __packed;
 282
 283 /* 128 bytes is an arbitrary cap. This could be as large as TPM_BUFSIZE - 18
 284  * bytes, but 128 is still a relatively large number of random bytes and
 285  * anything much bigger causes users of struct tpm_cmd_t to start getting
 286  * compiler warnings about stack frame size. */
 287 #define TPM_MAX_RNG_DATA        128
 288
 289 struct tpm_getrandom_out {
 290         __be32 rng_data_len;
 291         u8     rng_data[TPM_MAX_RNG_DATA];
 292 } __packed;
 293
 294 struct tpm_getrandom_in {
 295         __be32 num_bytes;
 296 } __packed;
 297
 298 struct tpm_startup_in {
 299         __be16  startup_type;
 300 } __packed;
 301
 302 typedef union {
 303         struct  tpm_getcap_params_out getcap_out;
 304         struct  tpm_readpubek_params_out readpubek_out;
 305         u8      readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
 306         struct  tpm_getcap_params_in getcap_in;
 307         struct  tpm_pcrread_in  pcrread_in;
 308         struct  tpm_pcrread_out pcrread_out;
 309         struct  tpm_pcrextend_in pcrextend_in;
 310         struct  tpm_getrandom_in getrandom_in;
 311         struct  tpm_getrandom_out getrandom_out;
 312         struct tpm_startup_in startup_in;
 313 } tpm_cmd_params;
 314
 315 struct tpm_cmd_t {
 316         tpm_cmd_header  header;
 317         tpm_cmd_params  params;
 318 } __packed;
 319
 320 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
 321 ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
 322                      size_t bufsiz);
 323 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, void *cmd, int len,
 324                          const char *desc);
 325 extern int tpm_get_timeouts(struct tpm_chip *);
 326 extern void tpm_gen_interrupt(struct tpm_chip *);
 327 extern int tpm_do_selftest(struct tpm_chip *);
 328 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
 329 extern int tpm_pm_suspend(struct device *);
 330 extern int tpm_pm_resume(struct device *);
 331 extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
 332                              wait_queue_head_t *, bool);
 333
 334 struct tpm_chip *tpm_chip_find_get(int chip_num);
 335 extern struct tpm_chip *tpmm_chip_alloc(struct device *dev,
 336                                        const struct tpm_class_ops *ops);
 337 extern int tpm_chip_register(struct tpm_chip *chip);
 338 extern void tpm_chip_unregister(struct tpm_chip *chip);
 339
 340 int tpm_dev_add_device(struct tpm_chip *chip);
 341 void tpm_dev_del_device(struct tpm_chip *chip);
 342 int tpm_sysfs_add_device(struct tpm_chip *chip);
 343 void tpm_sysfs_del_device(struct tpm_chip *chip);
 344
 345 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf);
 346
 347 #ifdef CONFIG_ACPI
 348 extern int tpm_add_ppi(struct kobject *);
 349 extern void tpm_remove_ppi(struct kobject *);
 350 #else
 351 static inline int tpm_add_ppi(struct kobject *parent)
 352 {
 353         return 0;
 354 }
 355
 356 static inline void tpm_remove_ppi(struct kobject *parent)
 357 {
 358 }
 359 #endif