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