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_timeout {
  32         TPM_TIMEOUT = 5,        /* msecs */
  33 };
  34
  35 /* TPM addresses */
  36 enum tpm_addr {
  37         TPM_SUPERIO_ADDR = 0x2E,
  38         TPM_ADDR = 0x4E,
  39 };
  40
  41 #define TPM_WARN_DOING_SELFTEST 0x802
  42 #define TPM_ERR_DEACTIVATED     0x6
  43 #define TPM_ERR_DISABLED        0x7
  44
  45 #define TPM_HEADER_SIZE         10
  46 extern ssize_t tpm_show_pubek(struct device *, struct device_attribute *attr,
  47                                 char *);
  48 extern ssize_t tpm_show_pcrs(struct device *, struct device_attribute *attr,
  49                                 char *);
  50 extern ssize_t tpm_show_caps(struct device *, struct device_attribute *attr,
  51                                 char *);
  52 extern ssize_t tpm_show_caps_1_2(struct device *, struct device_attribute *attr,
  53                                 char *);
  54 extern ssize_t tpm_store_cancel(struct device *, struct device_attribute *attr,
  55                                 const char *, size_t);
  56 extern ssize_t tpm_show_enabled(struct device *, struct device_attribute *attr,
  57                                 char *);
  58 extern ssize_t tpm_show_active(struct device *, struct device_attribute *attr,
  59                                 char *);
  60 extern ssize_t tpm_show_owned(struct device *, struct device_attribute *attr,
  61                                 char *);
  62 extern ssize_t tpm_show_temp_deactivated(struct device *,
  63                                          struct device_attribute *attr, char *);
  64 extern ssize_t tpm_show_durations(struct device *,
  65                                   struct device_attribute *attr, char *);
  66 extern ssize_t tpm_show_timeouts(struct device *,
  67                                  struct device_attribute *attr, char *);
  68
  69 struct tpm_chip;
  70
  71 struct tpm_vendor_specific {
  72         const u8 req_complete_mask;
  73         const u8 req_complete_val;
  74         const u8 req_canceled;
  75         void __iomem *iobase;           /* ioremapped address */
  76         unsigned long base;             /* TPM base address */
  77
  78         int irq;
  79         int probed_irq;
  80
  81         int region_size;
  82         int have_region;
  83
  84         int (*recv) (struct tpm_chip *, u8 *, size_t);
  85         int (*send) (struct tpm_chip *, u8 *, size_t);
  86         void (*cancel) (struct tpm_chip *);
  87         u8 (*status) (struct tpm_chip *);
  88         void (*release) (struct device *);
  89         struct miscdevice miscdev;
  90         struct attribute_group *attr_group;
  91         struct list_head list;
  92         int locality;
  93         unsigned long timeout_a, timeout_b, timeout_c, timeout_d; /* jiffies */
  94         bool timeout_adjusted;
  95         unsigned long duration[3]; /* jiffies */
  96         bool duration_adjusted;
  97
  98         wait_queue_head_t read_queue;
  99         wait_queue_head_t int_queue;
 100 };
 101
 102 struct tpm_chip {
 103         struct device *dev;     /* Device stuff */
 104
 105         int dev_num;            /* /dev/tpm# */
 106         unsigned long is_open;  /* only one allowed */
 107         int time_expired;
 108
 109         /* Data passed to and from the tpm via the read/write calls */
 110         u8 *data_buffer;
 111         atomic_t data_pending;
 112         struct mutex buffer_mutex;
 113
 114         struct timer_list user_read_timer;      /* user needs to claim result */
 115         struct work_struct work;
 116         struct mutex tpm_mutex; /* tpm is processing */
 117
 118         struct tpm_vendor_specific vendor;
 119
 120         struct dentry **bios_dir;
 121
 122         struct list_head list;
 123 #ifdef CONFIG_XEN
 124         void *priv;
 125 #endif
 126         void (*release) (struct device *);
 127 };
 128
 129 #define to_tpm_chip(n) container_of(n, struct tpm_chip, vendor)
 130
 131 static inline void tpm_chip_put(struct tpm_chip *chip)
 132 {
 133         module_put(chip->dev->driver->owner);
 134 }
 135
 136 static inline int tpm_read_index(int base, int index)
 137 {
 138         outb(index, base);
 139         return inb(base+1) & 0xFF;
 140 }
 141
 142 static inline void tpm_write_index(int base, int index, int value)
 143 {
 144         outb(index, base);
 145         outb(value & 0xFF, base+1);
 146 }
 147 struct tpm_input_header {
 148         __be16  tag;
 149         __be32  length;
 150         __be32  ordinal;
 151 }__attribute__((packed));
 152
 153 struct tpm_output_header {
 154         __be16  tag;
 155         __be32  length;
 156         __be32  return_code;
 157 }__attribute__((packed));
 158
 159 struct  stclear_flags_t {
 160         __be16  tag;
 161         u8      deactivated;
 162         u8      disableForceClear;
 163         u8      physicalPresence;
 164         u8      physicalPresenceLock;
 165         u8      bGlobalLock;
 166 }__attribute__((packed));
 167
 168 struct  tpm_version_t {
 169         u8      Major;
 170         u8      Minor;
 171         u8      revMajor;
 172         u8      revMinor;
 173 }__attribute__((packed));
 174
 175 struct  tpm_version_1_2_t {
 176         __be16  tag;
 177         u8      Major;
 178         u8      Minor;
 179         u8      revMajor;
 180         u8      revMinor;
 181 }__attribute__((packed));
 182
 183 struct  timeout_t {
 184         __be32  a;
 185         __be32  b;
 186         __be32  c;
 187         __be32  d;
 188 }__attribute__((packed));
 189
 190 struct duration_t {
 191         __be32  tpm_short;
 192         __be32  tpm_medium;
 193         __be32  tpm_long;
 194 }__attribute__((packed));
 195
 196 struct permanent_flags_t {
 197         __be16  tag;
 198         u8      disable;
 199         u8      ownership;
 200         u8      deactivated;
 201         u8      readPubek;
 202         u8      disableOwnerClear;
 203         u8      allowMaintenance;
 204         u8      physicalPresenceLifetimeLock;
 205         u8      physicalPresenceHWEnable;
 206         u8      physicalPresenceCMDEnable;
 207         u8      CEKPUsed;
 208         u8      TPMpost;
 209         u8      TPMpostLock;
 210         u8      FIPS;
 211         u8      operator;
 212         u8      enableRevokeEK;
 213         u8      nvLocked;
 214         u8      readSRKPub;
 215         u8      tpmEstablished;
 216         u8      maintenanceDone;
 217         u8      disableFullDALogicInfo;
 218 }__attribute__((packed));
 219
 220 typedef union {
 221         struct  permanent_flags_t perm_flags;
 222         struct  stclear_flags_t stclear_flags;
 223         bool    owned;
 224         __be32  num_pcrs;
 225         struct  tpm_version_t   tpm_version;
 226         struct  tpm_version_1_2_t tpm_version_1_2;
 227         __be32  manufacturer_id;
 228         struct timeout_t  timeout;
 229         struct duration_t duration;
 230 } cap_t;
 231
 232 struct  tpm_getcap_params_in {
 233         __be32  cap;
 234         __be32  subcap_size;
 235         __be32  subcap;
 236 }__attribute__((packed));
 237
 238 struct  tpm_getcap_params_out {
 239         __be32  cap_size;
 240         cap_t   cap;
 241 }__attribute__((packed));
 242
 243 struct  tpm_readpubek_params_out {
 244         u8      algorithm[4];
 245         u8      encscheme[2];
 246         u8      sigscheme[2];
 247         __be32  paramsize;
 248         u8      parameters[12]; /*assuming RSA*/
 249         __be32  keysize;
 250         u8      modulus[256];
 251         u8      checksum[20];
 252 }__attribute__((packed));
 253
 254 typedef union {
 255         struct  tpm_input_header in;
 256         struct  tpm_output_header out;
 257 } tpm_cmd_header;
 258
 259 #define TPM_DIGEST_SIZE 20
 260 struct tpm_pcrread_out {
 261         u8      pcr_result[TPM_DIGEST_SIZE];
 262 }__attribute__((packed));
 263
 264 struct tpm_pcrread_in {
 265         __be32  pcr_idx;
 266 }__attribute__((packed));
 267
 268 struct tpm_pcrextend_in {
 269         __be32  pcr_idx;
 270         u8      hash[TPM_DIGEST_SIZE];
 271 }__attribute__((packed));
 272
 273 typedef union {
 274         struct  tpm_getcap_params_out getcap_out;
 275         struct  tpm_readpubek_params_out readpubek_out;
 276         u8      readpubek_out_buffer[sizeof(struct tpm_readpubek_params_out)];
 277         struct  tpm_getcap_params_in getcap_in;
 278         struct  tpm_pcrread_in  pcrread_in;
 279         struct  tpm_pcrread_out pcrread_out;
 280         struct  tpm_pcrextend_in pcrextend_in;
 281 } tpm_cmd_params;
 282
 283 struct tpm_cmd_t {
 284         tpm_cmd_header  header;
 285         tpm_cmd_params  params;
 286 }__attribute__((packed));
 287
 288 ssize_t tpm_getcap(struct device *, __be32, cap_t *, const char *);
 289
 290 #ifdef CONFIG_XEN
 291 static inline void *chip_get_private(const struct tpm_chip *chip)
 292 {
 293         return chip->priv;
 294 }
 295
 296 static inline void chip_set_private(struct tpm_chip *chip, void *priv)
 297 {
 298         chip->priv = priv;
 299 }
 300 #endif
 301
 302 extern int tpm_get_timeouts(struct tpm_chip *);
 303 extern void tpm_gen_interrupt(struct tpm_chip *);
 304 extern int tpm_do_selftest(struct tpm_chip *);
 305 extern unsigned long tpm_calc_ordinal_duration(struct tpm_chip *, u32);
 306 extern struct tpm_chip* tpm_register_hardware(struct device *,
 307                                  const struct tpm_vendor_specific *);
 308 extern int tpm_open(struct inode *, struct file *);
 309 extern int tpm_release(struct inode *, struct file *);
 310 extern void tpm_dev_vendor_release(struct tpm_chip *);
 311 extern ssize_t tpm_write(struct file *, const char __user *, size_t,
 312                          loff_t *);
 313 extern ssize_t tpm_read(struct file *, char __user *, size_t, loff_t *);
 314 extern void tpm_remove_hardware(struct device *);
 315 extern int tpm_pm_suspend(struct device *, pm_message_t);
 316 extern int tpm_pm_resume(struct device *);
 317 extern int wait_for_tpm_stat(struct tpm_chip *, u8, unsigned long,
 318                              wait_queue_head_t *);
 319 #ifdef CONFIG_ACPI
 320 extern struct dentry ** tpm_bios_log_setup(char *);
 321 extern void tpm_bios_log_teardown(struct dentry **);
 322 #else
 323 static inline struct dentry ** tpm_bios_log_setup(char *name)
 324 {
 325         return NULL;
 326 }
 327 static inline void tpm_bios_log_teardown(struct dentry **dir)
 328 {
 329 }
 330 #endif